上一章我们详细的讲解了设备树语法以及在驱动开发中常用的OF 函数,本章我们就开始第一个基于设备树的Linux 驱动实验。本章在第四十二章实验的基础上完成,只是将驱动开发改为设备树形式而已。
设备树LED驱动原理
在《第四十二章新字符设备驱动实验》中,我们直接在驱动文件newchrled.c 中定义有关寄存器物理地址,然后使用io_remap 函数进行内存映射,得到对应的虚拟地址,最后操作寄存器对应的虚拟地址完成对GPIO 的初始化。
本章我们在第四十二章实验基础上完成,本章我们使用设备树来向Linux 内核传递相关的寄存器物理地址,Linux 驱动文件使用上一章讲解的OF函数从设备树中获取所需的属性值,然后使用获取到的属性值来初始化相关的IO。本章实验还是比较简单的,本章实验重点内容如下:
- ①、在imx6ull-alientek-emmc.dts 文件中创建设备节点。
- ②、编写驱动程序(在第四十二章实验基础上完成),获取设备树的属性值。
- ③、使用获取到的有关属性值来初始化LED 所使用的GPIO。
硬件原理图分析
本章实验硬件原理图参考8.3 小节即可。
实验程序编写
本实验对应的例程路径为:开发板光盘-> 2、Linux 驱动例程-> 4_dtsled。
本章实验在四十二章实验的基础上完成,重点是将驱动改为基于设备树的.
修改设备树文件(根节点下添加好区分)
在根节点“/”下创建一个名为“alphaled”的子节点,打开imx6ull-alientek-emmc.dts 文件,在根节点“/”最后面输入如下所示内容:
1 alphaled {
2 #address-cells = <1>;
3 #size-cells = <1>;
4 compatible = "atkalpha-led";
5 status = "okay";
6 reg = < 0X020C406C 0X04 /* CCM_CCGR1_BASE */
7 0X020E0068 0X04 /* SW_MUX_GPIO1_IO03_BASE */
8 0X020E02F4 0X04 /* SW_PAD_GPIO1_IO03_BASE */
9 0X0209C000 0X04 /* GPIO1_DR_BASE */
10 0X0209C004 0X04 >; /* GPIO1_GDIR_BASE */
11 };
- 第2、3 行,属性#address-cells 和#size-cells 都为1,表示reg 属性中起始地址占用一个字长(cell),地址长度也占用一个字长(cell)。
- 第4 行,属性compatbile 设置alphaled 节点兼容性为“atkalpha-led”。
- 第5 行,属性status 设置状态为“okay”。
- 第6~10 行,reg 属性,非常重要!reg 属性设置了驱动里面所要使用的寄存器物理地址,比如第6 行的“0X020C406C 0X04”表示I.MX6ULL 的CCM_CCGR1 寄存器,其中寄存器首地址为0X020C406C,长度为4 个字节。
设备树修改完成以后输入如下命令重新编译一下imx6ull-alientek-emmc.dts:
make dtbs
编译完成以后得到imx6ull-alientek-emmc.dtb,使用新的imx6ull-alientek-emmc.dtb 启动Linux 内核。Linux 启动成功以后进入到/proc/device-tree/目录中查看是否有“alphaled”这个节点,结果如图44.3.1.1 所示:
如果没有“alphaled”节点的话请重点查看下面两点:
①、检查设备树修改是否成功,也就是alphaled 节点是否为根节点“/”的子节点。
②、检查是否使用新的设备树启动的Linux 内核。
可以进入到图44.3.1 中的alphaled 目录中,查看一下都有哪些属性文件,结果如图44.3.1.2所示:
大家可以查看一下compatible、status 等属性值是否和我们设置的一致。
LED灯驱动程序编写
设备树准备好以后就可以编写驱动程序了,本章实验在第四十二章实验驱动文件newchrled.c 的基础上修改而来。新建名为“4_dtsled”文件夹,然后在4_dtsled 文件夹里面创建vscode 工程,工作区命名为“dtsled”。工程创建好以后新建dtsled.c 文件,在dtsled.c 里面输入如下内容:
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ide.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/errno.h>
#include <linux/gpio.h>
#include <linux/cdev.h>
#include <linux/device.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名 : dtsled.c
作者 : 左忠凯
版本 : V1.0
描述 : LED驱动文件。
其他 : 无
论坛 : www.openedv.com
日志 : 初版V1.0 2019/7/9 左忠凯创建
***************************************************************/
#define DTSLED_CNT 1 /* 设备号个数 */
#define DTSLED_NAME "dtsled" /* 名字 */
#define LEDOFF 0 /* 关灯 */
#define LEDON 1 /* 开灯 */
/* 映射后的寄存器虚拟地址指针 */
static void __iomem *IMX6U_CCM_CCGR1;
static void __iomem *SW_MUX_GPIO1_IO03;
static void __iomem *SW_PAD_GPIO1_IO03;
static void __iomem *GPIO1_DR;
static void __iomem *GPIO1_GDIR;
/* dtsled设备结构体 */
struct dtsled_dev{
dev_t devid; /* 设备号 */
struct cdev cdev; /* cdev */
struct class *class; /* 类 */
struct device *device; /* 设备 */
int major; /* 主设备号 */
int minor; /* 次设备号 */
struct device_node *nd; /* 设备节点 */
};
struct dtsled_dev dtsled; /* led设备 */
/*
* @description : LED打开/关闭
* @param - sta : LEDON(0) 打开LED,LEDOFF(1) 关闭LED
* @return : 无
*/
void led_switch(u8 sta)
{
u32 val = 0;
if(sta == LEDON) {
val = readl(GPIO1_DR);
val &= ~(1 << 3);
writel(val, GPIO1_DR);
}else if(sta == LEDOFF) {
val = readl(GPIO1_DR);
val|= (1 << 3);
writel(val, GPIO1_DR);
}
}
/*
* @description : 打开设备
* @param - inode : 传递给驱动的inode
* @param - filp : 设备文件,file结构体有个叫做private_data的成员变量
* 一般在open的时候将private_data指向设备结构体。
* @return : 0 成功;其他 失败
*/
static int led_open(struct inode *inode, struct file *filp)
{
filp->private_data = &dtsled; /* 设置私有数据 */
return 0;
}
/*
* @description : 从设备读取数据
* @param - filp : 要打开的设备文件(文件描述符)
* @param - buf : 返回给用户空间的数据缓冲区
* @param - cnt : 要读取的数据长度
* @param - offt : 相对于文件首地址的偏移
* @return : 读取的字节数,如果为负值,表示读取失败
*/
static ssize_t led_read(struct file *filp, char __user *buf, size_t cnt, loff_t *offt)
{
return 0;
}
/*
* @description : 向设备写数据
* @param - filp : 设备文件,表示打开的文件描述符
* @param - buf : 要写给设备写入的数据
* @param - cnt : 要写入的数据长度
* @param - offt : 相对于文件首地址的偏移
* @return : 写入的字节数,如果为负值,表示写入失败
*/
static ssize_t led_write(struct file *filp, const char __user *buf, size_t cnt, loff_t *offt)
{
int retvalue;
unsigned char databuf[1];
unsigned char ledstat;
retvalue = copy_from_user(databuf, buf, cnt);
if(retvalue < 0) {
printk("kernel write failed!\r\n");
return -EFAULT;
}
ledstat = databuf[0]; /* 获取状态值 */
if(ledstat == LEDON) {
led_switch(LEDON); /* 打开LED灯 */
} else if(ledstat == LEDOFF) {
led_switch(LEDOFF); /* 关闭LED灯 */
}
return 0;
}
/*
* @description : 关闭/释放设备
* @param - filp : 要关闭的设备文件(文件描述符)
* @return : 0 成功;其他 失败
*/
static int led_release(struct inode *inode, struct file *filp)
{
return 0;
}
/* 字符设备操作函数集合 */
static struct file_operations dtsled_fops = {
.owner = THIS_MODULE,
.open = led_open,
.read = led_read,
.write = led_write,
.release = led_release,
};
/*
* @description : 驱动入口函数
* @param : 无
* @return : 无
*/
static int __init led_init(void)
{
u32 val = 0;
int ret;
u32 regdata[14];
const char *str;
struct property *proper;
/* 获取设备树中的属性数据 */
/* 1、获取设备节点:alphaled */
dtsled.nd = of_find_node_by_path("/alphaled");
if(dtsled.nd == NULL) {
printk("alphaled node nost find!\r\n");
return -EINVAL;
} else {
printk("alphaled node find!\r\n");
}
/* 2、获取compatible属性内容 */
proper = of_find_property(dtsled.nd, "compatible", NULL);
if(proper == NULL) {
printk("compatible property find failed\r\n");
} else {
printk("compatible = %s\r\n", (char*)proper->value);
}
/* 3、获取status属性内容 */
ret = of_property_read_string(dtsled.nd, "status", &str);
if(ret < 0){
printk("status read failed!\r\n");
} else {
printk("status = %s\r\n",str);
}
/* 4、获取reg属性内容 也就是寄存器地址 最重要!*/ //保存在数组里
ret = of_property_read_u32_array(dtsled.nd, "reg", regdata, 10);
if(ret < 0) { //数组大小
printk("reg property read failed!\r\n");
} else {
u8 i = 0;
printk("reg data:\r\n");
for(i = 0; i < 10; i++)
printk("%#X ", regdata[i]);
printk("\r\n");
}
/* 初始化LED */
#if 0
/* 1、寄存器地址映射 */
IMX6U_CCM_CCGR1 = ioremap(regdata[0], regdata[1]);
SW_MUX_GPIO1_IO03 = ioremap(regdata[2], regdata[3]);
SW_PAD_GPIO1_IO03 = ioremap(regdata[4], regdata[5]);
GPIO1_DR = ioremap(regdata[6], regdata[7]);
GPIO1_GDIR = ioremap(regdata[8], regdata[9]);
#else //另一种方式地址映射
IMX6U_CCM_CCGR1 = of_iomap(dtsled.nd, 0);
SW_MUX_GPIO1_IO03 = of_iomap(dtsled.nd, 1);
SW_PAD_GPIO1_IO03 = of_iomap(dtsled.nd, 2);
GPIO1_DR = of_iomap(dtsled.nd, 3);
GPIO1_GDIR = of_iomap(dtsled.nd, 4);
#endif
/* 2、使能GPIO1时钟 */
val = readl(IMX6U_CCM_CCGR1);
val &= ~(3 << 26); /* 清楚以前的设置 */
val |= (3 << 26); /* 设置新值 */
writel(val, IMX6U_CCM_CCGR1);
/* 3、设置GPIO1_IO03的复用功能,将其复用为
* GPIO1_IO03,最后设置IO属性。
*/
writel(5, SW_MUX_GPIO1_IO03);
/*寄存器SW_PAD_GPIO1_IO03设置IO属性
*bit 16:0 HYS关闭
*bit [15:14]: 00 默认下拉
*bit [13]: 0 kepper功能
*bit [12]: 1 pull/keeper使能
*bit [11]: 0 关闭开路输出
*bit [7:6]: 10 速度100Mhz
*bit [5:3]: 110 R0/6驱动能力
*bit [0]: 0 低转换率
*/
writel(0x10B0, SW_PAD_GPIO1_IO03);
/* 4、设置GPIO1_IO03为输出功能 */
val = readl(GPIO1_GDIR);
val &= ~(1 << 3); /* 清除以前的设置 */
val |= (1 << 3); /* 设置为输出 */
writel(val, GPIO1_GDIR);
/* 5、默认关闭LED */
val = readl(GPIO1_DR);
val |= (1 << 3);
writel(val, GPIO1_DR);
/* 注册字符设备驱动到内核 */
/* 1、创建设备号 */
if (dtsled.major) { /* 定义了设备号 */
dtsled.devid = MKDEV(dtsled.major, 0);
register_chrdev_region(dtsled.devid, DTSLED_CNT, DTSLED_NAME);
} else { /* 没有定义设备号 */
alloc_chrdev_region(&dtsled.devid, 0, DTSLED_CNT, DTSLED_NAME); /* 申请设备号 */
dtsled.major = MAJOR(dtsled.devid); /* 获取分配号的主设备号 */
dtsled.minor = MINOR(dtsled.devid); /* 获取分配号的次设备号 */
}
printk("dtsled major=%d,minor=%d\r\n",dtsled.major, dtsled.minor);
/* 2、初始化cdev */
dtsled.cdev.owner = THIS_MODULE;
cdev_init(&dtsled.cdev, &dtsled_fops);
/*3、添加一个字符设备cdev到内核 */
cdev_add(&dtsled.cdev, dtsled.devid, DTSLED_CNT);
/* 4、自动创建设备节点 创建类class */
dtsled.class = class_create(THIS_MODULE, DTSLED_NAME);
if (IS_ERR(dtsled.class)) {
return PTR_ERR(dtsled.class);
}
/* 5、自动创建设备节点 创建设备device */
dtsled.device = device_create(dtsled.class, NULL, dtsled.devid, NULL, DTSLED_NAME);
if (IS_ERR(dtsled.device)) {
return PTR_ERR(dtsled.device);
}
return 0;
}
/*
* @description : 驱动出口函数
* @param : 无
* @return : 无
*/
static void __exit led_exit(void)
{
/* 取消映射 */
iounmap(IMX6U_CCM_CCGR1);
iounmap(SW_MUX_GPIO1_IO03);
iounmap(SW_PAD_GPIO1_IO03);
iounmap(GPIO1_DR);
iounmap(GPIO1_GDIR);
/* 注销字符设备驱动 */
cdev_del(&dtsled.cdev);/* 删除字符设备cdev */
unregister_chrdev_region(dtsled.devid, DTSLED_CNT); /* 注销设备号 */
device_destroy(dtsled.class, dtsled.devid);//摧毁设备
class_destroy(dtsled.class);//摧毁类
}
module_init(led_init);
module_exit(led_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("zuozhongkai");
dtsled.c 文件中的内容和第四十二章的newchrled.c 文件中的内容基本一样,只是dtsled.c 中包含了处理设备树的代码,我们重点来看一下这部分代码。
第46 行,在设备结构体dtsled_dev 中添加了成员变量nd,nd 是device_node 结构体类型指针,表示设备节点。如果我们要读取设备树某个节点的属性值,首先要先得到这个节点,一般在设备结构体中添加device_node 指针变量来存放这个节点。
第160~166 行,通过of_find_node_by_path 函数得到alphaled 节点,后续其他的OF 函数要使用device_node。
第169~174 行,通过of_find_property 函数获取alphaled 节点的compatible 属性,返回值为property 结构体类型指针变量,property 的成员变量value 表示属性值。
第177~182 行,通过of_property_read_string 函数获取alphaled 节点的status 属性值。
第185~194 行,通过of_property_read_u32_array 函数获取alphaled 节点的reg 属性所有值,并且将获取到的值都存放到regdata 数组中。第192 行将获取到的reg 属性值依次输出到终端上。
第199~203 行,使用“古老”的ioremap 函数完成内存映射,将获取到的regdata 数组中的寄存器物理地址转换为虚拟地址。
第205~209 行,使用of_iomap 函数一次性完成读取reg 属性以及内存映射,of_iomap 函数是设备树推荐使用的OF 函数。
编写测试APP
本章直接使用第四十二章的测试APP,将上一章的ledApp.c 文件复制到本章实验工程下即可。
运行测试
编译驱动程序和测试APP
1、编译驱动程序
编写Makefile 文件,本章实验的Makefile 文件和第四十章实验基本一样,只是将obj-m 变量的值改为dtsled.o,Makefile 内容如下所示:
KERNELDIR := /home/zuozhongkai/linux/IMX6ULL/linux/temp/linux-imx-rel_imx_4.1.15_2.1.0_ga_alientek
CURRENT_PATH := $(shell pwd)
obj-m := dtsled.o
build: kernel_modules
kernel_modules:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) modules
clean:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean
第4 行,设置obj-m 变量的值为dtsled.o。
输入如下命令编译出驱动模块文件:
make -j32
编译成功以后就会生成一个名为“dtsled.ko”的驱动模块文件。
2、编译测试APP
输入如下命令编译测试ledApp.c 这个测试程序:
arm-linux-gnueabihf-gcc ledApp.c -o ledApp
编译成功以后就会生成ledApp 这个应用程序。
运行测试
将上一小节编译出来的dtsled.ko 和ledApp 这两个文件拷贝到rootfs/lib/modules/4.1.15 目录中,重启开发板,进入到目录lib/modules/4.1.15 中,输入如下命令加载dtsled.ko 驱动模块:
depmod //第一次加载驱动的时候需要运行此命令
modprobe dtsled.ko //加载驱动
驱动加载成功以后会在终端中输出一些信息,如图44.4.2.1 所示:
从图44.4.2.1 可以看出,alpahled 这个节点找到了,并且compatible 属性值为“atkalpha-led”,status 属性值为“okay”,reg 属性的值为“0X20C406C 0X4 0X20E0068 0X4 0X20E02F4 0X4 0X209C000 0X4 0X209C004 0X4”,这些都和我们设置的设备树一致。
驱动加载成功以后就可以使用ledApp 软件来测试驱动是否工作正常,输入如下命令打开LED 灯:
./ledApp /dev/dtsled 1 //打开LED 灯
输入上述命令以后观察I.MX6U-ALPHA 开发板上的红色LED 灯是否点亮,如果点亮的话说明驱动工作正常。在输入如下命令关闭LED 灯:
./ledApp /dev/dtsled 0 //关闭LED 灯
输入上述命令以后观察I.MX6U-ALPHA 开发板上的红色LED 灯是否熄灭。如果要卸载驱动的话输入如下命令即可:
rmmod dtsled.ko