【正点原子MP157连载】第三十五章设备树下的platform驱动编写-摘自【正点原子】STM32MP1嵌入式Linux驱动开发指南V1.7

1）实验平台：正点原子STM32MP157开发板
2）购买链接:https://item.taobao.com/item.htm?&id=629270721801
3）全套实验源码+手册+视频下载地址：http://www.openedv.com/thread-318813-1-1.html
4）正点原子官方B站：https://space.bilibili.com/394620890
5）正点原子STM32MP157技术交流群：691905614

第三十五章设备树下的platform驱动编写

上一章我们详细的讲解了Linux下的驱动分离与分层，以及总线、设备和驱动这样的驱动框架。基于总线、设备和驱动这样的驱动框架，Linux内核提出来platform这个虚拟总线，相应的也有platform设备和platform驱动。上一章我们讲解了传统的、未采用设备树的platform设备和驱动编写方法。最新的Linux内核已经支持了设备树，因此在设备树下如何编写platform驱动就显得尤为重要，本章我们就来学习一下如何在设备树下编写platform驱动。

35.1 设备树下的platform驱动简介
platform驱动框架分为总线、设备和驱动，其中总线不需要我们这些驱动程序员去管理，这个是Linux内核提供的，我们在编写驱动的时候只要关注于设备和驱动的具体实现即可。在没有设备树的Linux内核下，我们需要分别编写并注册platform_device和platform_driver，分别代表设备和驱动。在使用设备树的时候，设备的描述被放到了设备树中，因此platform_device就不需要我们去编写了，我们只需要实现platform_driver即可。
35.1.1 修改pinctrl-stm32.c文件
在前面第25章的时候我们详细的讲解了pinctrl，但是在后续的实验中却一直没有使用pinctrl。按道理来讲，在我们使用某个引脚的时候需要先配置其电气属性，比如复用、输入还是输入、默认上下拉等！但是在前面的实验中均没有配置引脚的电气属性，也就是引脚的pinctrl配置。这是因为ST针对STM32MP1提供的Linux系统中，其pinctrl配置的电气属性只能在platform平台下被引用，前面的实验都没用到platform，所以pinctrl配置是不起作用的！
笔者在使用NXP的I.MX6ULL芯片的时候，Linux系统启动运行过程中会自动解析设备树下的pinctrl配置，然后初始化引脚的电气属性，不需要platform驱动框架。所以pinctrl什么时候有效，不同的芯片厂商有不同的处理费方法，一切以实际所使用的芯片为准！
对于STM32MP1来说，在使用pinctrl的时候需要修改一下pinctrl-stm32.c这个文件，否则当某个引脚用作GPIO的时候会提示此引脚无法申请到，如图35.1.1.1所示：

图35.1.1.1 IO申请失败
从图35.1.1.1可以看出，提示PI0这个IO已经被其他外设申请走了，不能再申请。打开pinctrl-stm32.c这个文件，找到如下所示代码：

示例代码35.1.1.1 stm32_pmx_ops结构体
1 static const struct pinmux_ops stm32_pmx_ops = {2       .get_functions_count    = stm32_pmx_get_funcs_cnt,
3       .get_function_name  = stm32_pmx_get_func_name,
4       .get_function_groups    = stm32_pmx_get_func_groups,
5       .set_mux        = stm32_pmx_set_mux,
6       .gpio_set_direction = stm32_pmx_gpio_set_direction,
7       .strict         = true,
8 };

第7行的strict成员变量默认为true，我们需要将其改为false，改完以后如图35.1.1.2所示：

图35.1.1.2 修改后的stm32_pmx_ops结构体
修改完成以后使用如下命令重新编译Linux内核：
make uImage LOADADDR=0XC2000040 -j16 //编译内核
编译完成以后使用新的uImage启动即可。
35.1.2 创建设备的pinctrl节点
上面已经说了，在platform驱动框架下必须使用pinctrl来配置引脚复用功能。我们以本章实验需要用到的LED0为例，编写LED0引脚的 pinctrl配置。打开stm32mp15-pinctrl.dtsi文件，STM32MP1的所有引脚pinctrl配置都是在这个文件里面完成的，在pinctrl节点下添加如下所示内容：

示例代码35.1.2.1 GPIO的pinctrl配置
1 led_pins_a: gpioled-0 {2       pins {3               pinmux = <STM32_PINMUX('I', 0, GPIO)>;
4               drive-push-pull;
5               bias-pull-up;
6               output-high;
7               slew-rate = <0>;
8       };
9 };

示例代码35.1.2.1中的gpio_pins_a节点就是LED的pinctrl配置，把PI0端口复用为GPIO功能，同时设置PI0的电气特性。我们已经在25.1.1小节详细的讲解过如何配置STM32MP1的电气属性，大家可以回过头去看一下，这里我们就简单介绍一下LED0的配置：
第3行，设置PI0复用为GPIO功能。
第4行，设置PI0为推挽输出。
第5行，设置PI0内部上拉。
第6行，设置PI0默认输出高电平。
第7行，设置PI0的速度为0档，也就是最慢。
添加完成以后如图35.1.2.1所示：

图35.1.2.1 led对应的pinctrl节点
35.1.3 在设备树中创建设备节点
接下来要在设备树中创建设备节点来描述设备信息，重点是要设置好compatible属性的值，因为platform总线需要通过设备节点的compatible属性值来匹配驱动！这点要切记。修改25.4.1.2小节中我们创建的gpioled节点，修改以后的内容如下：
示例代码35.1.3.1 gpioled设备节点

1 gpioled {2       compatible = "alientek,led";
3       pinctrl-names = "default";
4       status = "okay";
5       pinctrl-0 = <&led_pins_a>;
6       led-gpio = <&gpioi 0 GPIO_ACTIVE_LOW>;
7 };

第2行的compatible属性值为“alientek,led”，因此一会在编写platform驱动的时候of_match_table属性表中要有“alientek,led”。
第5行里，pinctrl-0属性设置LED的PIN对应的pinctrl节点，也就是我们在示例代码35.1.1中编写的led_pins_a。
35.1.4 编写platform驱动的时候要注意兼容属性
上一章已经详细的讲解过了，在使用设备树的时候platform驱动会通过of_match_table来保存兼容性值，也就是表明此驱动兼容哪些设备。所以，of_match_table将会尤为重要，比如本例程的platform驱动中platform_driver就可以按照如下所示设置：

示例代码35.1.4.1 of_match_table匹配表的设置
1   static const struct of_device_id led_of_match[] = {2       { .compatible = "alientek,led" },  /* 兼容属性 */
3       { /* Sentinel */ }
4   };
5
6   MODULE_DEVICE_TABLE(of, led_of_match);
7
8   static struct platform_driver led_platform_driver = {9       .driver = {10          .name       = "stm32mp1-led",
11          .of_match_table = led_of_match,
12      },
13      .probe          = led_probe,
14      .remove         = led_remove,
15  };

第1~4行，of_device_id表，也就是驱动的兼容表，是一个数组，每个数组元素为of_device_id类型。每个数组元素都是一个兼容属性，表示兼容的设备，一个驱动可以跟多个设备匹配。这里我们仅仅匹配了一个设备，那就是示例代码35.1.2中创建的gpioled这个设备。第2行的compatible值为“alientek,led”，驱动中的compatible属性和设备中的compatible属性相匹配，因此驱动中对应的probe函数就会执行。注意第3行是一个空元素，在编写of_device_id的时候最后一个元素一定要为空！
第6行，通过MODULE_DEVICE_TABLE声明一下led_of_match这个设备匹配表。
第11行，设置platform_driver中的of_match_table匹配表为上面创建的leds_of_match，至此我们就设置好了platform驱动的匹配表了。
最后就是编写驱动程序，基于设备树的platform驱动和上一章无设备树的platform驱动基本一样，都是当驱动和设备匹配成功以后先根据设备树里的pinctrl属性设置PIN的电气特性再去执行probe函数。我们需要在probe函数里面执行字符设备驱动那一套，当注销驱动模块的时候remove函数就会执行，都是大同小异的。

35.2 检查引脚复用配置
35.2.1 检查引脚pinctrl配置
STM32MP1的一个引脚可以复用为多种功能，比如PI0可以作为GPIO、TIM5_CH4、SPI2_NSS、DCMI_D13、LCD_G5等。我们在做STM32单片机开发的时候，一个IO可以被多个外设使用，比如PI0同时作为TIM5_CH4、LCD_G5，但是同一时刻只能用做一个功能，比如做LCD_G5的时候就不能做TIM5_CH4！在嵌入式Linux下，我们要严格按照一个引脚对应一个功能来设计硬件，比如PI0现在要用作GPIO来驱动LED灯，那么就不能将PI0作为其他功能，比如你在设计硬件的时候就不能再将PI0作为LCD_G5。
正点原子STM32MP1开发板上将PI0连接到了LED0上，也就是将其用作普通的GPIO，对应的pinctrl配置就是示例代码35.1.2.1。但是stm32mp15-pinctrl.dtsi是ST根据自己官方EVK开发板编写的，因此PI0就可能被ST官方用作其他功能，大家在stm32mp15-pinctrl.dtsi里面找到如下所示代码：

图35.2.1.1 ltdc_pins_a节点
从图35.2.1.1可以看出，ST官方默认将PI0复用为LCD_G5，前面说了，一个IO只能复用为一个功能，因此我们需要将图35.2.1.1中的“<STM32_PINMUX(‘I’, 0, AF14)>”屏蔽掉，因为我们现在要将PI0用作GPIO。同样的，继续在stm32mp15-pinctrl.dtsi文件里面查找，会发现如图35.2.1.2所示的地方也将PI0复用为了LCD_G5：

图35.2.1.2 ltdc_pins_sleep_a节点
图35.2.1.2中的ltdc_pins_sleep_a节点也将PI0复用为LCD_G5，将这行代码也屏蔽掉。确保所使用的设备树中，一个引脚只复用为一个功能！
35.2.2 检查GPIO占用
上一小节只是检查了一下，PI0这个引脚有没有被复用为多个设备，本节我们将PI0复用为GPIO。因为我们是在ST官方提供的设备树上修改的，因此还要检查一下当PI0作为GPIO的时候，ST官方有没有将这个GPIO分配给其他设备。其实对于PI0这个引脚来说不会的，因为ST官方将其复用为了LCD_G5，所以也就不存在说将其在作为GPIO分配给其他设备。但是我们在实际开发中要考虑到这一点，说不定其他的引脚就会被分配给某个设备做GPIO，而我们没有检查，导致两个设备都用这一个GPIO，那么肯定有一个因为申请不到GPIO而导致驱动无法工作。
所以当我们将一个引脚用作GPIO的时候，一定要检查一下当前设备树里面是否有其他设备也使用到了这个GPIO，保证设备树中只有一个设备树在使用这个GPIO。
35.3 硬件原理图分析
本实验的硬件原理参考21.2小节即可。
35.4 实验程序编写
本实验对应的例程路径为：开发板光盘 1、程序源码2、Linux驱动例程18_dtsplatform。
本章实验我们编写基于设备树的platform驱动，所以需要在设备树中添加设备节点，然后我们只需要编写platform驱动即可。
35.4.1 修改设备树文件
首先修改设备树文件，加上我们需要的设备信息，本章我们就使用到一个LED0。需要创建LED0引脚的pinctrl节点，这个直接使用示例代码35.1.2.1中的led_pins_a节点。另外也要创建一个LED0设备节点，这个直接使用示例代码35.1.3.1中的 gpioled设备节点。
35.4.2 platform驱动程序编写
设备已经准备好了，接下来就要编写相应的platform驱动了，新建名为“18_dtsplatform”的文件夹，然后在18_dtsplatform文件夹里面创建vscode工程，工作区命名为“dtsplatform”。新建名为leddriver.c的驱动文件，在leddriver.c中输入如下所示内容：

示例代码35.4.2.1 leddriver.c文件代码段
1   #include <linux/types.h>
2   #include <linux/kernel.h>
3   #include <linux/delay.h>
4   #include <linux/ide.h>
5   #include <linux/init.h>
6   #include <linux/module.h>
7   #include <linux/errno.h>
8   #include <linux/gpio.h>
9   #include <linux/cdev.h>
10  #include <linux/device.h>
11  #include <linux/of_gpio.h>
12  #include <linux/semaphore.h>
13  #include <linux/timer.h>
14  #include <linux/irq.h>
15  #include <linux/wait.h>
16  #include <linux/poll.h>
17  #include <linux/fs.h>
18  #include <linux/fcntl.h>
19  #include <linux/platform_device.h>
20  #include <asm/mach/map.h>
21  #include <asm/uaccess.h>
22  #include <asm/io.h>
23
24  #define LEDDEV_CNT      1                       /* 设备号长度    */
25  #define LEDDEV_NAME     "dtsplatled"      /* 设备名字     */
26  #define LEDOFF          0
27  #define LEDON           1
28
29  /* leddev设备结构体 */
30  struct leddev_dev{31      dev_t devid;                            /* 设备号          */
32      struct cdev cdev;                   /* cdev             */
33      struct class *class;                    /* 类                */
34      struct device *device;                  /* 设备               */
35      struct device_node *node;               /* LED设备节点      */
36      int gpio_led;                           /* LED灯GPIO标号   */
37  };
38
39  struct leddev_dev leddev;                   /* led设备        */
40
41  /*
42   * @description    : LED打开/关闭
43   * @param - sta    : LEDON(0) 打开LED，LEDOFF(1) 关闭LED
44   * @return         : 无
45   */
46  void led_switch(u8 sta)
47  {48      if (sta == LEDON )
49          gpio_set_value(leddev.gpio_led, 0);
50      else if (sta == LEDOFF)
51          gpio_set_value(leddev.gpio_led, 1);
52  }
53
54  static int led_gpio_init(struct device_node *nd)
55  {56      int ret;
57
58      /* 从设备树中获取GPIO */
59      leddev.gpio_led = of_get_named_gpio(nd, "led-gpio", 0);
60      if(!gpio_is_valid(leddev.gpio_led)) {61          printk(KERN_ERR "leddev: Failed to get led-gpio\n");
62          return -EINVAL;
63      }
64
65      /* 申请使用GPIO */
66      ret = gpio_request(leddev.gpio_led, "LED0");
67      if (ret) {68          printk(KERN_ERR "led: Failed to request led-gpio\n");
69          return ret;
70      }
71
72      /* 将GPIO设置为输出模式并设置GPIO初始电平状态 */
73      gpio_direction_output(leddev.gpio_led,1);
74
75      return 0;
76  }
77
78  /*
79   * @description    : 打开设备
80   * @param – inode  : 传递给驱动的inode
81   * @param - filp   : 设备文件，file结构体有个叫做private_data的成员变量
82   *                    一般在open的时候将private_data指向设备结构体。
83   * @return         : 0 成功;其他 失败
84   */
85  static int led_open(struct inode *inode, struct file *filp)
86  {87      return 0;
88  }
89
90  /*
91   * @description    : 向设备写数据
92   * @param – filp   : 设备文件，表示打开的文件描述符
93   * @param - buf    : 要写给设备写入的数据
94   * @param - cnt    : 要写入的数据长度
95   * @param – offt   : 相对于文件首地址的偏移
96   * @return         : 写入的字节数，如果为负值，表示写入失败
97   */
98  static ssize_t led_write(struct file *filp, const char __user *buf,
size_t cnt, loff_t *offt)
99  {100     int retvalue;
101     unsigned char databuf[1];
102     unsigned char ledstat;
103
104     retvalue = copy_from_user(databuf, buf, cnt);
105     if(retvalue < 0) {106         printk("kernel write failed!\r\n");
107         return -EFAULT;
108     }
109
110     ledstat = databuf[0];
111     if (ledstat == LEDON) {112         led_switch(LEDON);
113     } else if (ledstat == LEDOFF) {114         led_switch(LEDOFF);
115     }
116     return 0;
117 }
118
119 /* 设备操作函数 */
120 static struct file_operations led_fops = {121     .owner = THIS_MODULE,
122     .open = led_open,
123     .write = led_write,
124 };
125
126 /*
127  * @description    : flatform驱动的probe函数，当驱动与设备匹配以后此函数
128  *                     就会执行
129  * @param - dev    : platform设备
130  * @return         : 0，成功;其他负值,失败
131  */
132 static int led_probe(struct platform_device *pdev)
133 {
134     int ret;
135
136     printk("led driver and device was matched!\r\n");
137
138     /* 初始化 LED */
139     ret = led_gpio_init(pdev->dev.of_node);
140     if(ret < 0)
141         return ret;
142
143     /* 1、设置设备号 */
144     ret = alloc_chrdev_region(&leddev.devid, 0, LEDDEV_CNT,
LEDDEV_NAME);
145     if(ret < 0) {146         pr_err("%s Couldn't alloc_chrdev_region, ret=%d\r\n",
LEDDEV_NAME, ret);
147         goto free_gpio;
148     }
149
150     /* 2、初始化cdev  */
151     leddev.cdev.owner = THIS_MODULE;
152     cdev_init(&leddev.cdev, &led_fops);
153
154     /* 3、添加一个cdev */
155     ret = cdev_add(&leddev.cdev, leddev.devid, LEDDEV_CNT);
156     if(ret < 0)
157         goto del_unregister;
158
159     /* 4、创建类      */
160     leddev.class = class_create(THIS_MODULE, LEDDEV_NAME);
161     if (IS_ERR(leddev.class)) {162         goto del_cdev;
163     }
164
165     /* 5、创建设备 */
166     leddev.device = device_create(leddev.class, NULL, leddev.devid,
NULL, LEDDEV_NAME);
167     if (IS_ERR(leddev.device)) {168         goto destroy_class;
169     }
170
171     return 0;
172 destroy_class:
173     class_destroy(leddev.class);
174 del_cdev:
175     cdev_del(&leddev.cdev);
176 del_unregister:
177     unregister_chrdev_region(leddev.devid, LEDDEV_CNT);
178 free_gpio:
179     gpio_free(leddev.gpio_led);
180     return -EIO;
181 }
182
183 /*
184  * @description    : platform驱动的remove函数
185  * @param - dev    : platform设备
186  * @return         : 0，成功;其他负值,失败
187  */
188 static int led_remove(struct platform_device *dev)
189 {190     gpio_set_value(leddev.gpio_led, 1); /* 卸载驱动的时候关闭LED */
191     gpio_free(leddev.gpio_led);             /* 注销GPIO */
192     cdev_del(&leddev.cdev);                     /*  删除cdev */
193     unregister_chrdev_region(leddev.devid, LEDDEV_CNT);
194     device_destroy(leddev.class, leddev.devid);     /* 注销设备     */
195     class_destroy(leddev.class);                    /* 注销类  */
196     return 0;
197 }
198
199 /* 匹配列表 */
200 static const struct of_device_id led_of_match[] = {201     { .compatible = "alientek,led" },
202     { /* Sentinel */ }
203 };
204
205 MODULE_DEVICE_TABLE(of, led_of_match);
206
207 /* platform驱动结构体 */
208 static struct platform_driver led_driver = {209     .driver     = {210         .name   = "stm32mp1-led",            /* 驱动名字，用于和设备匹配 */
211         .of_match_table = led_of_match,    /* 设备树匹配表        */
212     },
213     .probe      = led_probe,
214     .remove     = led_remove,
215 };
216
217 /*
218  * @description    : 驱动模块加载函数
219  * @param          : 无
220  * @return         : 无
221  */
222 static int __init leddriver_init(void)
223 {224     return platform_driver_register(&led_driver);
225 }
226
227 /*
228  * @description    : 驱动模块卸载函数
229  * @param          : 无
230  * @return         : 无
231  */
232 static void __exit leddriver_exit(void)
233 {234     platform_driver_unregister(&led_driver);
235 }
236
237 module_init(leddriver_init);
238 module_exit(leddriver_exit);
239 MODULE_LICENSE("GPL");
240 MODULE_AUTHOR("ALIENTEK");
241 MODULE_INFO(intree, "Y");

代码中以前讲过的知识点这里就不再重述了！
第54~76行，自定义函数led_gpio_init，该函数的参数是struct device_node类型的指针，也就是led对应的设备节点，当调用函数的时候传递进来。
第132~181行，platform下的 probe函数：led_probe，当设备树中的设备节点与驱动之间匹配成功会先去初始化pinctrl里面配置的IO，也就是根据示例代码35.1.2.1中的属性进行配置，然后再执行probe函数，第139行调用led_gpio_init函数时，将pdev->dev.of_node作为参数传递到函数中，platform_device结构体中内置了一个device结构体类型的成员变量dev。在device结构体中定义了一个device_node类型的指针变量of_node，使用设备树的情况下，当匹配成功之后，of_node会指向设备树中定义的节点，所以在这里我们不需要通过调用of_find_node_by_path("/gpioled")函数得到led的节点。我们原来在驱动加载函数里面做的工作现在全部放到probe函数里面完成。
第188~197行，platform下的remove函数：led_remove，当platform驱动模块被卸载时此函数就会执行。在此函数里面释放内存、注销字符设备等，也就是将原来驱动卸载函数里面的工作全部都放到remove函数中完成。
第200~203行，匹配表，描述了此驱动都和什么样的设备匹配，第201行添加了一条值为"alientek,led"的compatible属性值，当设备树中某个设备节点的compatible属性值也为“alientek,led”的时候就会与此驱动匹配。
第208~215行，platform_driver驱动结构体变量led_driver，210行设置这个platform驱动的名字为“stm32mp1-led”，因此，当驱动加载成功以后就会在/sys/bus/platform/drivers/目录下存在一个名为“stm32mp1-led”的文件。第211行绑定platform驱动的of_match_table表。
第222~225行，platform驱动模块入口函数，在此函数里面通过platform_driver_register向Linux内核注册一个platform驱动led_driver。
第232~235行，platform驱动驱动模块出口函数，在此函数里面通过platform_driver_unregister从Linux内核卸载一个platform驱动led_driver。
35.4.3 编写测试APP
测试APP就直接使用上一章34.4.2小节编写的ledApp.c即可。
35.5 运行测试
35.5.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件，本章实验的Makefile文件和第四十章实验基本一样，只是将obj-m变量的值改为“leddriver.o”，Makefile内容如下所示：
示例代码35.5.1.1 Makefile文件

1  KERNELDIR := /home/zuozhongkai/linux/my_linux/linux-5.4.31
......
4  obj-m := leddriver.o
......
11 clean:
12  $(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean

第4行，设置obj-m变量的值为“leddriver.o”。
输入如下命令编译出驱动模块文件：

make -j32
编译成功以后就会生成一个名为“leddriver.o”的驱动模块文件。
2、编译测试APP
测试APP直接使用上一章的ledApp这个测试软件即可。
35.5.2 运行测试
将上一小节编译出来leddriver.ko拷贝到rootfs/lib/modules/5.4.31目录中，重启开发板，进入到目录lib/modules/5.4.31中，输入如下命令加载leddriver.ko这个驱动模块。
depmod //第一次加载驱动的时候需要运行此命令
modprobe leddriver.ko //加载驱动模块
驱动模块加载完成以后到/sys/bus/platform/drivers/目录下查看驱动是否存在，我们在leddriver.c中设置name字段为“stm32mp1-led”，因此会在/sys/bus/platform/drivers/目录下存在名为“stm32mp1-led”这个文件，结果如图35.5.2.1所示：

图35.5.2.1 stm32mp1-led驱动
同理，在/sys/bus/platform/devices/目录下也存在led的设备文件，也就是设备树中gpioled这个节点，如图35.5.2.2所示：

图35.5.2.2 gpioled设备
驱动和模块都存在，当驱动和设备匹配成功以后就会输出如图35.5.2.3所示一行语句：

图35.5.2.3 驱动和设备匹配成功
驱动和设备匹配成功以后就可以测试LED灯驱动了，输入如下命令打开LED灯：
./ledApp /dev/dtsplatled 1 //打开LED灯
在输入如下命令关闭LED灯：
./ledApp /dev/dtsplatled 0 //关闭LED灯
观察一下LED灯能否打开和关闭，如果可以的话就说明驱动工作正常，如果要卸载驱动的话输入如下命令即可：
rmmod leddriver.ko