上一章我们详细的讲解了 Linux 下的驱动分离与分层,以及总线、设备和驱动这样的驱动 框架。基于总线、设备和驱动这样的驱动框架,Linux 内核提出来 platform 这个虚拟总线,相应 的也有 platform 设备和 platform 驱动。上一章我们讲解了传统的、未采用设备树的 platform 设 备和驱动编写方法。最新的 Linux 内核已经支持了设备树,因此在设备树下如何编写 platform 驱动就显得尤为重要,本章我们就来学习一下如何在设备树下编写 platform 驱动。
1:设备树下的 platform 驱动简介
platform 驱动框架分为总线、设备和驱动,其中总线不需要我们这些驱动程序员去管理,这 个是 Linux 内核提供的,我们在编写驱动的时候只要关注于设备和驱动的具体实现即可。在没 有设备树的 Linux 内核下,我们需要分别编写并注册 platform_device 和 platform_driver,分别代 表设备和驱动。在使用设备树的时候,设备的描述被放到了设备树中,因此 platform_device 就 不需要我们去编写了,我们只需要实现 platform_driver 即可。在编写基于设备树的 platform 驱 动的时候我们需要注意一下几点:
1.1:在设备树中创建设备节点
毫无疑问,肯定要先在设备树中创建设备节点来描述设备信息,重点是要设置好 compatible 属性的值,因为 platform 总线需要通过设备节点的 compatible 属性值来匹配驱动!这点要切记。 比如,我们可以编写如下所示的设备节点来描述我们本章实验要用到的 LED 这个设备:
gpioled {
#address-cells = <1>;
#size-cells = <1>;
compatible = "atkalpha-gpioled";
pinctrl-names = "default";
pinctrl-0 = <&pinctrl_led>;
led-gpio = <&gpio1 3 GPIO_ACTIVE_LOW>;
status = "okay";
};
示例 55.1.1 中的 gpioled 节点其实就是 45.4.1.2 小节中创建的 gpioled 设备节点,我们可以 直接拿过来用。注意第 4 行的 compatible 属性值为“atkalpha-gpioled”,因此一会在编写 platform 驱动的时候 of_match_table 属性表中要有“atkalpha-gpioled”。
1.2:编写 platform 驱动的时候要注意兼容属性
上一章已经详细的讲解过了,在使用设备树的时候 platform 驱动会通过 of_match_table 来 保存兼容性值,也就是表明此驱动兼容哪些设备。所以,of_match_table 将会尤为重要,比如本 例程的 platform 驱动中 platform_driver 就可以按照如下所示设置:
static const struct of_device_id leds_of_match[] = {
{ .compatible = "atkalpha-gpioled" }, /* 兼容属性 */
{ /* Sentinel */ }
};
MODULE_DEVICE_TABLE(of, leds_of_match);
static struct platform_driver leds_platform_driver = {
.driver = {
.name = "imx6ul-led",
.of_match_table = leds_of_match,
},
.probe = leds_probe,
.remove = leds_remove,
};
第 1~4 行,of_device_id 表,也就是驱动的兼容表,是一个数组,每个数组元素为 of_device_id 类型。每个数组元素都是一个兼容属性,表示兼容的设备,一个驱动可以跟多个设备匹配。这 里我们仅仅匹配了一个设备,那就是 55.1.1 中创建的 gpioled 这个设备。
第 2 行的 compatible 值 为“atkalpha-gpioled”,驱动中的 compatible 属性和设备中的 compatible 属性相匹配,因此驱动 中对应的 probe 函数就会执行。注意第 3 行是一个空元素,在编写 of_device_id 的时候最后一个 元素一定要为空!
第 6 行,通过 MODULE_DEVICE_TABLE 声明一下 leds_of_match 这个设备匹配表。
第 11 行,设置 platform_driver 中的 of_match_table 匹配表为上面创建的 leds_of_match,至 此我们就设置好了 platform 驱动的匹配表了。
1.3:编写 platform 驱动
基于设备树的 platform 驱动和上一章无设备树的 platform 驱动基本一样,都是当驱动和设 备匹配成功以后就会执行 probe 函数。我们需要在 probe 函数里面执行字符设备驱动那一套, 当注销驱动模块的时候 remove 函数就会执行,都是大同小异的。
2:实验程序编写
本章实验我们编写基于设备树的 platform 驱动,所以需要在设备树中添加设备节点,然后 我们只需要编写 platform 驱动即可。
2.1:修改设备树文件
首先修改设备树文件,加上我们需要的设备信息,本章我们就使用到一个 LED 灯,因此可 以直接使用 45.4.1 小节编写的 gpioled 子节点即可,不需要再重复添加。
2.2:platform 驱动程序编写
设备已经准备好了,接下来就要编写相应的 platform 驱动了,新建名为“18_dtsplatform” 的文件夹,然后在 18_dtsplatform 文件夹里面创建 vscode 工程,工作区命名为“dtsplatform”。 新建名为 leddriver.c 的驱动文件,在 leddriver.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_gpio.h>
#include <linux/semaphore.h>
#include <linux/timer.h>
#include <linux/irq.h>
#include <linux/wait.h>
#include <linux/poll.h>
#include <linux/fs.h>
#include <linux/fcntl.h>
#include <linux/platform_device.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名 : leddriver.c
作者 : 左忠凯
版本 : V1.0
描述 : 设备树下的platform驱动
其他 : 无
论坛 : www.openedv.com
日志 : 初版V1.0 2019/8/13 左忠凯创建
***************************************************************/
#define LEDDEV_CNT 1 /* 设备号长度 */
#define LEDDEV_NAME "dtsplatled" /* 设备名字 */
#define LEDOFF 0
#define LEDON 1
/* leddev设备结构体 */
struct leddev_dev{
dev_t devid; /* 设备号 */
struct cdev cdev; /* cdev */
struct class *class; /* 类 */
struct device *device; /* 设备 */
int major; /* 主设备号 */
struct device_node *node; /* LED设备节点 */
int led0; /* LED灯GPIO标号 */
};
struct leddev_dev leddev; /* led设备 */
/*
* @description : LED打开/关闭
* @param - sta : LEDON(0) 打开LED,LEDOFF(1) 关闭LED
* @return : 无
*/
void led0_switch(u8 sta)
{
if (sta == LEDON )
gpio_set_value(leddev.led0, 0);
else if (sta == LEDOFF)
gpio_set_value(leddev.led0, 1);
}
/*
* @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 = &leddev; /* 设置私有数据 */
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[2];
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) {
led0_switch(LEDON);
} else if (ledstat == LEDOFF) {
led0_switch(LEDOFF);
}
return 0;
}
/* 设备操作函数 */
static struct file_operations led_fops = {
.owner = THIS_MODULE,
.open = led_open,
.write = led_write,
};
/*
* @description : flatform驱动的probe函数,当驱动与
* 设备匹配以后此函数就会执行
* @param - dev : platform设备
* @return : 0,成功;其他负值,失败
*/
static int led_probe(struct platform_device *dev)
{
printk("led driver and device was matched!\r\n");
/* 1、设置设备号 */
if (leddev.major) {
leddev.devid = MKDEV(leddev.major, 0);
register_chrdev_region(leddev.devid, LEDDEV_CNT, LEDDEV_NAME);
} else {
alloc_chrdev_region(&leddev.devid, 0, LEDDEV_CNT, LEDDEV_NAME);
leddev.major = MAJOR(leddev.devid);
}
/* 2、注册设备 */
cdev_init(&leddev.cdev, &led_fops);
cdev_add(&leddev.cdev, leddev.devid, LEDDEV_CNT);
/* 3、创建类 */
leddev.class = class_create(THIS_MODULE, LEDDEV_NAME);
if (IS_ERR(leddev.class)) {
return PTR_ERR(leddev.class);
}
/* 4、创建设备 */
leddev.device = device_create(leddev.class, NULL, leddev.devid, NULL, LEDDEV_NAME);
if (IS_ERR(leddev.device)) {
return PTR_ERR(leddev.device);
}
/* 5、初始化IO */
leddev.node = of_find_node_by_path("/gpioled");
if (leddev.node == NULL){
printk("gpioled node nost find!\r\n");
return -EINVAL;
}
leddev.led0 = of_get_named_gpio(leddev.node, "led-gpio", 0);
if (leddev.led0 < 0) {
printk("can't get led-gpio\r\n");
return -EINVAL;
}
gpio_request(leddev.led0, "led0");
gpio_direction_output(leddev.led0, 1); /* led0 IO设置为输出,默认高电平 */
return 0;
}
/*
* @description : platform驱动的remove函数,移除platform驱动的时候此函数会执行
* @param - dev : platform设备
* @return : 0,成功;其他负值,失败
*/
static int led_remove(struct platform_device *dev)
{
gpio_set_value(leddev.led0, 1); /* 卸载驱动的时候关闭LED */
gpio_free(leddev.led0); /* 释放IO */
cdev_del(&leddev.cdev); /* 删除cdev */
unregister_chrdev_region(leddev.devid, LEDDEV_CNT); /* 注销设备号 */
device_destroy(leddev.class, leddev.devid);
class_destroy(leddev.class);
return 0;
}
/* 匹配列表 */
static const struct of_device_id led_of_match[] = {
{ .compatible = "atkalpha-gpioled" },
{ /* Sentinel */ }
};
/* platform驱动结构体 */
static struct platform_driver led_driver = {
.driver = {
.name = "imx6ul-led", /* 驱动名字,用于和设备匹配 */
.of_match_table = led_of_match, /* 设备树匹配表 */
},
.probe = led_probe,
.remove = led_remove,
};
/*
* @description : 驱动模块加载函数
* @param : 无
* @return : 无
*/
static int __init leddriver_init(void)
{
return platform_driver_register(&led_driver);
}
/*
* @description : 驱动模块卸载函数
* @param : 无
* @return : 无
*/
static void __exit leddriver_exit(void)
{
platform_driver_unregister(&led_driver);
}
module_init(leddriver_init);
module_exit(leddriver_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("zuozhongkai");
感觉跟之前写的设备树led区别就是把注册都放进probe里了,然后多了个平台驱动的结构体
设备匹配平台
第 33~112 行,传统的字符设备驱动,没什么要说的。
第 120~164 行,platform 驱动的 probe 函数,当设备树中的设备节点与驱动之间匹配成功 以后此函数就会执行,原来在驱动加载函数里面做的工作现在全部放到 probe 函数里面完成。
第 171~180 行,remobe 函数,当卸载 platform 驱动的时候此函数就会执行。在此函数里面 释放内存、注销字符设备等,也就是将原来驱动卸载函数里面的工作全部都放到 remove 函数中 完成。
第 183~186 行,匹配表,描述了此驱动都和什么样的设备匹配,第
184 行添加了一条值为 "atkalpha-gpioled"的 compatible 属性值,当设备树中某个设备节点的 compatible 属性值也为 “atkalpha-gpioled”的时候就会与此驱动匹配。
第 189~196 行,platform_driver 驱动结构体,191 行设置这个 platform 驱动的名字为“imx6ul-led”,因此,当驱动加载成功以后就会在/sys/bus/platform/drivers/目录下存在一个名为“imx6u-led”的文件。
第 192 行设置 of_match_table 为上面的 led_of_match。
第 203~206 行,驱动模块加载函数,在此函数里面通过 platform_driver_register 向 Linux 内 核注册 led_driver 驱动。
第 213~216 行,驱动模块卸载函数,在此函数里面通过 platform_driver_unregister 从 Linux 内核卸载 led_driver 驱动。
2.3:编写测试 APP
测试 APP 直接使用上一章的 ledApp 这个测试软件即可。
3:Makefile文件编写
KERNELDIR :=/home/zhulinux/linux/alientek_linux/linux
CURRENT_PATH := $(shell pwd)
obj-m := leddriver.o
build: kernel_modules
kernel_modules:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) modules
clean:
$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean
4:编译测试 APP
在名为Compiletest.sh的shell脚本内 ,将fun改变为 "leddriver"即可,并把driver改为false运行shell脚本
#!/bin/bash
#把dts编译的dtb文件拷贝到 tftpboot目录下
cp -r ~/linux/alientek_linux/linux/arch/arm/boot/dts/imx6ull_alientek_emmc.dtb ~/linux/tftpboot/ -f
driver=false
fun="leddriver"
funko="${fun}.ko"
funoApp="${fun}App"
funcApp="${fun}App.c"
if [[ $driver == true ]]; then
fundeviceko="${fun}device.ko"
fundriverko="${fun}driver.ko"
fi
if [ -f "./$funoApp" ]; then
echo "文件存在,正在删除..."
rm "./$funoApp"
echo "文件已删除"
else
echo "文件不存在,不执行删除操作。"
fi
arm-linux-gnueabihf-gcc $funcApp -o $funoApp
if [[ $driver == true ]];then
sudo cp $fundeviceko $fundriverko $funoApp ~/linux/nfs/rootfs/lib/modules/4.1.15/ -f
else
sudo cp $funko $funoApp ~/linux/nfs/rootfs/lib/modules/4.1.15/ -f
fi
5:运行测试
本文仅在记录学习正点原子imx6ull-mini开发板的过程,不做他用。