《STM32MP157嵌入式Linux驱动开发指南》第二十一章嵌入式Linux LED驱动开发实验

正点原子运营 · 发表于 2021-6-23 17:11:27

本帖最后由正点原子运营于 2021-6-23 17:12 编辑

1）实验平台：正点原子STM32MP157开发板
2) 章节摘自【正点原子】《STM32MP157嵌入式Linux驱动开发指南》
3）购买链接:https://item.taobao.com/item.htm?&id=629270721801
4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/arm-linux/zdyzmp157.html
5）正点原子官方B站：https://space.bilibili.com/394620890
6）正点原子STM32MP157技术交流群：691905614

第二十一章嵌入式Linux LED驱动开发实验

上一章我们详细的讲解了字符设备驱动开发步骤，并且用一个虚拟的chrdevbase设备为例带领大家完成了第一个字符设备驱动的开发。本章我们就开始编写第一个真正的Linux字符设备驱动。在正点原子STM32MP157开发板上有一个LED灯，本章我们就来学习一下如何编写Linux下的LED灯驱动。

21.1 Linux下LED灯驱动原理
      Linux下的任何外设驱动，最终都是要配置相应的硬件寄存器。所以本章的LED灯驱动最终也是对STM32MP157的IO口进行配置，与裸机实验不同的是，在Linux下编写驱动要符合Linux的驱动框架。开发板上的LED0连接到STM32MP157的PI0这个引脚上，因此本章实验的重点就是编写Linux下STM32MP157引脚控制驱动。
21.1.1 地址映射
      在编写驱动之前，我们需要先简单了解一下MMU这个神器，MMU全称叫做Memory Manage Unit，也就是内存管理单元。在老版本的Linux中要求处理器必须有MMU，但是现在Linux内核已经支持无MMU的处理器了。MMU主要完成的功能如下：
      ①、完成虚拟空间到物理空间的映射。
      ②、内存保护，设置存储器的访问权限，设置虚拟存储空间的缓冲特性。
      我们重点来看一下第①点，也就是虚拟空间到物理空间的映射，也叫做地址映射。首先了解两个地址概念：虚拟地址(VA,Virtual Address)、物理地址(PA，Physcical Address)。对于32位的处理器来说，虚拟地址范围是2^32=4GB，我们的开发板上有1GB的DDR3，这1GB的内存就是物理内存，经过MMU可以将其映射到整个4GB的虚拟空间，如图21.1.2所示：

图21.1.2 内存映射

物理内存只有1GB，虚拟内存有4GB，那么肯定存在多个虚拟地址映射到同一个物理地址上去，虚拟地址范围比物理地址范围大的问题处理器自会处理，这里我们不要去深究，因为MMU是很复杂的一个东西，后续有时间的话正点原子Linux团队会专门做MMU专题教程。
Linux内核启动的时候会初始化MMU，设置好内存映射，设置好以后CPU访问的都是虚拟地址。比如STM32MP157的PI0引脚的端口模式寄存器GPIOI_MODER物理地址为0x5000A000。如果没有开启MMU的话直接向0x5000A000这个寄存器地址写入数据就可以配置PI0的引脚功能(输入、输出、复用或模拟等)。现在开启了MMU，并且设置了内存映射，因此就不能直接向0x5000A000这个地址写入数据了。我们必须得到0x5000A000这个物理地址在Linux系统里面对应的虚拟地址，这里就涉及到了物理内存和虚拟内存之间的转换，需要用到两个函数：ioremap和iounmap。
1、ioremap函数
ioremap函数用于获取指定物理地址空间对应的虚拟地址空间，定义在arch/arm/include/asm/io.h文件中，定义如下：
示例代码21.1.1.1 ioremap函数声明

393 void __iomem *ioremap(resource_size_t res_cookie, size_t size);

复制代码

函数的实现是在arch/arm/mm/ioremap.c文件中，实现如下：
示例代码21.1.1.2 ioremap函数实现

377 void __iomem *ioremap(resource_size_t res_cookie, size_t size)
378 {
379 return arch_ioremap_caller(res_cookie, size, MT_DEVICE,
380 __builtin_return_address(0));
381 }

复制代码

ioremap有两个参数：res_cookie和size，真正起作用的是函数arch_ioremap_caller。ioremap函数有两个参数和一个返回值，这些参数和返回值的含义如下：
      res_cookie：要映射的物理起始地址。
      size：要映射的内存空间大小。
      返回值：__iomem类型的指针，指向映射后的虚拟空间首地址。
      假如我们要获取STM32MP157-ATK的GPIOI_MODER寄存器对应的虚拟地址，使用如下代码即可：

#define GPIOI_MODER (0X5000A000)
static void __iomem* GPIO_MODER_PI;
GPIO_MODER_PI = ioremap(GPIOI_MODER, 4);

复制代码

宏GPIOI_MODER是寄存器物理地址，GPIO_MODER_PI是映射后的虚拟地址。对于STMP32MP157来说一个寄存器是4字节(32位)，因此映射的内存长度为4。映射完成以后直接对GPIO_MODER_PI进行读写操作即可。
2、iounmap函数
卸载驱动的时候需要使用iounmap函数释放掉ioremap函数所做的映射，iounmap函数原型如下：
示例代码41.1.1.3 iounmap函数原型

413 void iounmap (volatile void __iomem *addr)

复制代码

iounmap只有一个参数addr，此参数就是要取消映射的虚拟地址空间首地址。假如我们现在要取消掉GPIO_MODER_PI寄存器的地址映射，使用如下代码即可：

iounmap(GPIO_MODER_PI);

复制代码

21.1.2 I/O内存访问函数
      这里说的I/O是输入/输出的意思，并不是我们学习单片机的时候讲的GPIO引脚。这里涉及到两个概念：I/O端口和I/O内存。当外部寄存器或内存映射到IO空间时，称为I/O端口。当外部寄存器或内存映射到内存空间时，称为I/O内存。但是对于ARM来说没有I/O空间这个概念，因此ARM体系下只有I/O内存(可以直接理解为内存)。使用ioremap函数将寄存器的物理地址映射到虚拟地址以后，我们就可以直接通过指针访问这些地址，但是Linux内核不建议这么做，而是推荐使用一组操作函数来对映射后的内存进行读写操作。
      1、读操作函数
      读操作函数有如下几个：
示例代码21.1.2.1 读操作函数

1 u8 readb(const volatile void __iomem *addr)
2 u16 readw(const volatile void __iomem *addr)
3 u32 readl(const volatile void __iomem *addr)

复制代码

readb、readw和readl这三个函数分别对应8bit、16bit和32bit读操作，参数addr就是要读取写内存地址，返回值就是读取到的数据。
2、写操作函数
写操作函数有如下几个：
示例代码21.1.2.2 写操作函数

1 void writeb(u8 value, volatile void __iomem *addr)
2 void writew(u16 value, volatile void __iomem *addr)
3 void writel(u32 value, volatile void __iomem *addr)

复制代码

writeb、writew和writel这三个函数分别对应8bit、16bit和32bit写操作，参数value是要写入的数值，addr是要写入的地址。
21.2 硬件原理图分析
我们先进行LED的硬件原理分析，打开开发板底板原理图，底板原理图和核心板原理图都放到了开发板光盘中，路径为:开发板光盘2、开发板原理图STM32MP15x底板原理图V1.X。开发板上有一个LED0，原理如图21.1.1所示：

图21.2.1 LED原理图

从图 21.2.1 可以看出，LED0 接到了PI0上，PI0 就是GPIOI组的第0个引脚，当 PI0输出低电平(0)的时候发光二极管 LED0 就会导通点亮，当 PI0 输出高电平(1)的时候发光二极管 LED0 不会导通，因此 LED0 也就不会点亮。所以 LED0 的亮灭取决于 PI0的输出电平，输出 0 就亮，输出 1 就灭。
21.3 实验程序编写
      本实验对应的例程路径为：开发板光盘-> 1、Linux驱动例程-> 2_led。
      本章实验编写Linux下的LED灯驱动，可以通过应用程序对开发板上的LED0进行开关操作。
21.3.1 LED灯驱动程序编写
      新建名为“2_led”文件夹，然后在2_led文件夹里面创建VSCode工程，工作区命名为“led”。工程创建好以后新建led.c文件，此文件就是led的驱动文件，在led.c里面输入如下内容：
示例代码21.3.1.1 led.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 <asm/mach/map.h>
10 #include <asm/uaccess.h>
11 #include <asm/io.h>
12 /***************************************************************
13 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
14 文件名 : led.c
15 作者 : 正点原子
16 版本 : V1.0
17 描述 : LED驱动文件。
18 其他 : 无
19 论坛 : <a href="www.openedv.com" target="_blank">www.openedv.com</a>
20 日志 : 初版V1.0 2021/1/8 正点原子团队创建
21 ***************************************************************/
22 #define LED_MAJOR 200 /* 主设备号 */
23 #define LED_NAME "led" /* 设备名字 */
24
25 #define LEDOFF 0 /* 关灯 */
26 #define LEDON 1 /* 开灯 */
27
28 /* 寄存器物理地址 */
29 #define PERIPH_BASE (0x40000000)
30 #define MPU_AHB4_PERIPH_BASE (PERIPH_BASE + 0x10000000)
31 #define RCC_BASE (MPU_AHB4_PERIPH_BASE + 0x0000)
32 #define RCC_MP_AHB4ENSETR (RCC_BASE + 0XA28)
33 #define GPIOI_BASE (MPU_AHB4_PERIPH_BASE + 0xA000)
34 #define GPIOI_MODER (GPIOI_BASE + 0x0000)
35 #define GPIOI_OTYPER (GPIOI_BASE + 0x0004)
36 #define GPIOI_OSPEEDR (GPIOI_BASE + 0x0008)
37 #define GPIOI_PUPDR (GPIOI_BASE + 0x000C)
38 #define GPIOI_BSRR (GPIOI_BASE + 0x0018)
39
40
41 /* 映射后的寄存器虚拟地址指针 */
42 static void __iomem *MPU_AHB4_PERIPH_RCC_PI;
43 static void __iomem *GPIOI_MODER_PI;
44 static void __iomem *GPIOI_OTYPER_PI;
45 static void __iomem *GPIOI_OSPEEDR_PI;
46 static void __iomem *GPIOI_PUPDR_PI;
47 static void __iomem *GPIOI_BSRR_PI;
48
49 /*
50 * @description : LED打开/关闭
51 * [url=home.php?mod=space&uid=271674]@param[/url] - sta : LEDON(0) 打开LED，LEDOFF(1) 关闭LED
52 * @return : 无
53 */
54 void led_switch(u8 sta)
55 {
56 u32 val = 0;
57 if(sta == LEDON) {
58 val = readl(GPIOI_BSRR_PI);
59 val |= (1 << 16);
60 writel(val, GPIOI_BSRR_PI);
61 }else if(sta == LEDOFF) {
62 val = readl(GPIOI_BSRR_PI);
63 val|= (1 << 0);
64 writel(val, GPIOI_BSRR_PI);
65 }
66 }
67
68 /*
69 * @description : 取消映射
70 * @return : 无
71 */
72 void led_unmap(void)
73 {
74 /* 取消映射 */
75 iounmap(MPU_AHB4_PERIPH_RCC_PI);
76 iounmap(GPIOI_MODER_PI);
77 iounmap(GPIOI_OTYPER_PI);
78 iounmap(GPIOI_OSPEEDR_PI);
79 iounmap(GPIOI_PUPDR_PI);
80 iounmap(GPIOI_BSRR_PI);
81 }
82
83 /*
84 * @description : 打开设备
85 * @param - inod : 传递给驱动的inode
86 * @param - filp : 设备文件，file结构体有个叫做private_data的成员变量
87 * 一般在open的时候将private_data指向设备结构体。
88 * @return : 0 成功;其他失败
89 */
90 static int led_open(struct inode *inode, struct file *filp)
91 {
92 return 0;
93 }
94
95 /*
96 * @description : 从设备读取数据
97 * @param - filp : 要打开的设备文件(文件描述符)
98 * @param - buf : 返回给用户空间的数据缓冲区
99 * @param - cnt : 要读取的数据长度
100 * @param - offt : 相对于文件首地址的偏移
101 * @return : 读取的字节数，如果为负值，表示读取失败
102 */
103 static ssize_t led_read(struct file *filp, char __user *buf,
size_t cnt, loff_t *offt)
104 {
105 return 0;
106 }
107
108 /*
109 * @description : 向设备写数据
110 * @param - filp : 设备文件，表示打开的文件描述符
111 * @param - buf : 要写给设备写入的数据
112 * @param - cnt : 要写入的数据长度
113 * @param - offt : 相对于文件首地址的偏移
114 * @return : 写入的字节数，如果为负值，表示写入失败
115 */
116 static ssize_t led_write(struct file *filp, const char __user *buf,
size_t cnt, loff_t *offt)
117 {
118 int retvalue;
119 unsigned char databuf[1];
120 unsigned char ledstat;
121
122 retvalue = copy_from_user(databuf, buf, cnt);
123 if(retvalue < 0) {
124 printk("kernel write failed!\r\n");
125 return -EFAULT;
126 }
127
128 ledstat = databuf[0]; /* 获取状态值 */
129
130 if(ledstat == LEDON) {
131 led_switch(LEDON); /* 打开LED灯 */
132 } else if(ledstat == LEDOFF) {
133 led_switch(LEDOFF); /* 关闭LED灯 */
134 }
135 return 0;
136 }
137
138 /*
139 * @description : 关闭/释放设备
140 * @param - filp : 要关闭的设备文件(文件描述符)
141 * @return : 0 成功;其他失败
142 */
143 static int led_release(struct inode *inode, struct file *filp)
144 {
145 return 0;
146 }
147
148 /* 设备操作函数 */
149 static struct file_operations led_fops = {
150 .owner = THIS_MODULE,
151 .open = led_open,
152 .read = led_read,
153 .write = led_write,
154 .release = led_release,
155 };
156
157 /*
158 * @description : 驱动出口函数
159 * @param : 无
160 * @return : 无
161 */
162 static int __init led_init(void)
163 {
164 int retvalue = 0;
165 u32 val = 0;
166
167 /* 初始化LED */
168 /* 1、寄存器地址映射 */
169 MPU_AHB4_PERIPH_RCC_PI = ioremap(RCC_MP_AHB4ENSETR, 4);
170 GPIOI_MODER_PI = ioremap(GPIOI_MODER, 4);
171 GPIOI_OTYPER_PI = ioremap(GPIOI_OTYPER, 4);
172 GPIOI_OSPEEDR_PI = ioremap(GPIOI_OSPEEDR, 4);
173 GPIOI_PUPDR_PI = ioremap(GPIOI_PUPDR, 4);
174 GPIOI_BSRR_PI = ioremap(GPIOI_BSRR, 4);
175
176 /* 2、使能PI时钟 */
177 val = readl(MPU_AHB4_PERIPH_RCC_PI);
178 val &= ~(0X1 << 8); /* 清除以前的设置 */
179 val |= (0X1 << 8); /* 设置新值 */
180 writel(val, MPU_AHB4_PERIPH_RCC_PI);
181
182 /* 3、设置PI0通用的输出模式。*/
183 val = readl(GPIOI_MODER_PI);
184 val &= ~(0X3 << 0); /* bit0:1清零 */
185 val |= (0X1 << 0); /* bit0:1设置01 */
186 writel(val, GPIOI_MODER_PI);
187
188 /* 3、设置PI0为推挽模式。*/
189 val = readl(GPIOI_OTYPER_PI);
190 val &= ~(0X1 << 0); /* bit0清零，设置为上拉*/
191 writel(val, GPIOI_OTYPER_PI);
192
193 /* 4、设置PI0为高速。*/
194 val = readl(GPIOI_OSPEEDR_PI);
195 val &= ~(0X3 << 0); /* bit0:1 清零 */
196 val |= (0x2 << 0); /* bit0:1 设置为10 */
197 writel(val, GPIOI_OSPEEDR_PI);
198
199 /* 5、设置PI0为上拉。*/
200 val = readl(GPIOI_PUPDR_PI);
201 val &= ~(0X3 << 0); /* bit0:1 清零 */
202 val |= (0x1 << 0); /*bit0:1 设置为01 */
203 writel(val,GPIOI_PUPDR_PI);
204
205 /* 6、默认关闭LED */
206 val = readl(GPIOI_BSRR_PI);
207 val |= (0x1 << 0);
208 writel(val, GPIOI_BSRR_PI);
209
210 /* 6、注册字符设备驱动 */
211 retvalue = register_chrdev(LED_MAJOR, LED_NAME, &led_fops);
212 if(retvalue < 0){
213 printk("register chrdev failed!\r\n");
214 goto fail_map;
215 }
216 return 0;
217
218 fail_map:
219 led_unmap();
220 return -EIO;
221 }
222
223 /*
224 * @description : 驱动出口函数
225 * @param : 无
226 * @return : 无
227 */
228 static void __exit led_exit(void)
229 {
230 /* 取消映射 */
231 led_unmap();
232
233 /* 注销字符设备驱动 */
234 unregister_chrdev(LED_MAJOR, LED_NAME);
235 }
236
237 module_init(led_init);
238 module_exit(led_exit);
239 MODULE_LICENSE("GPL");
240 MODULE_AUTHOR("ALIENTEK");
241 MODULE_INFO(intree, "Y");

复制代码

第22~26行，定义了一些宏，包括主设备号、设备名字、LED开/关宏。
      第29~38行，本实验要用到的寄存器宏定义。
      第42~47行，经过内存映射以后的寄存器地址指针。
      第54~66行，led_switch函数，用于控制开发板上的LED灯亮灭，当参数sta为LEDON(0)的时候打开LED灯，sta为LEDOFF(1)的时候关闭LED灯。
      第72~81行，led_unmap函数，取消所有物理寄存器映射，回收对应的资源。当程序出错退出或者卸载驱动模块的时候需要调用此函数，用来取消此前所做的寄存器映射。
      第90~93行，led_open函数，为空函数，可以自行在此函数中添加相关内容，一般在此函数中将设备结构体作为参数filp的私有数据(filp->private_data)，后面实验会讲解如何添加私有数据。
      第103~106行，led_read函数，为空函数，如果想在应用程序中读取LED的状态，那么就可以在此函数中添加相应的代码。
      第116~136行，led_write函数，实现对LED灯的开关操作，当应用程序调用write函数向led设备写数据的时候此函数就会执行。首先通过函数copy_from_user获取应用程序发送过来的操作信息(打开还是关闭LED)，最后根据应用程序的操作信息来打开或关闭LED灯。
      第143~146行，led_release函数，为空函数，可以自行在此函数中添加相关内容，一般关闭设备的时候会释放掉led_open函数中添加的私有数据。
      第149~155行，设备文件操作结构体led_fops的定义和初始化。
      第162~221行，驱动入口函数led_init，此函数实现了LED的初始化工作，169~174行通过ioremap函数获取物理寄存器地址映射后的虚拟地址，得到寄存器对应的虚拟地址以后就可以完成相关初始化工作了。比如使能GPIOI时钟、设置PI0复用功能、配置PI0的属性等等。最后，最重要的一步！使用register_chrdev函数注册led这个字符设备。
      第218~220 行，如果在第6步注册字符设备失败，就要回收以前注册成功的资源。
      第228~235行，驱动出口函数led_exit，首先使用函数iounmap取消内存映射，最后使用函数unregister_chrdev注销led这个字符设备。
      第237~238行，使用module_init和module_exit这两个函数指定led设备驱动加载和卸载函数。
      第239~240行，添加LICENSE和作者信息。
      第241行，告诉内核这个驱动也是intree模块驱动。
21.3.2 编写测试APP
      编写测试APP，led驱动加载成功以后手动创建/dev/led节点，应用程序(APP)通过操作/dev/led文件来完成对LED设备的控制。向/dev/led文件写0表示关闭LED灯，写1表示打开LED灯。新建ledApp.c文件，在里面输入如下内容：
示例代码21.3.2.1 ledApp.c文件代码

1 #include "stdio.h"
2 #include "unistd.h"
3 #include "sys/types.h"
4 #include "sys/stat.h"
5 #include "fcntl.h"
6 #include "stdlib.h"
7 #include "string.h"
8 /***************************************************************
9 Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
10 文件名 : ledApp.c
11 作者 : 正点原子
12 版本 : V1.0
13 描述 : led测试APP。
14 其他 : 无
15 使用方法：./ledtest /dev/led 0 关闭LED
16 ./ledtest /dev/led 1 打开LED
17 论坛 : <a href="www.openedv.com" target="_blank">www.openedv.com</a>
18 日志 : 初版V1.0 2021/11/23 正点原子团队创建
19 ***************************************************************/
20
21 #define LEDOFF 0
22 #define LEDON 1
23
24 /*
25 * @description : main主程序
26 * @param - argc : argv数组元素个数
27 * @param - argv : 具体参数
28 * @return : 0 成功;其他失败
29 */
30 int main(int argc, char *argv[])
31 {
32 int fd, retvalue;
33 char *filename;
34 unsigned char databuf[1];
35
36 if(argc != 3){
37 printf("Error Usage!\r\n");
38 return -1;
39 }
40
41 filename = argv[1];
42
43 /* 打开led驱动 */
44 fd = open(filename, O_RDWR);
45 if(fd < 0){
46 printf("file %s open failed!\r\n", argv[1]);
47 return -1;
48 }
49
50 databuf[0] = atoi(argv[2]); /* 要执行的操作：打开或关闭 */
51
52 /* 向/dev/led文件写入数据 */
53 retvalue = write(fd, databuf, sizeof(databuf));
54 if(retvalue < 0){
55 printf("LED Control Failed!\r\n");
56 close(fd);
57 return -1;
58 }
59
60 retvalue = close(fd); /* 关闭文件 */
61 if(retvalue < 0){
62 printf("file %s close failed!\r\n", argv[1]);
63 return -1;
64 }
65 return 0;
66 }

复制代码

ledApp.c的内容还是很简单的，就是对led的驱动文件进行最基本的打开、关闭、写操作等。
21.4 运行测试
21.4.1 编译驱动程序和测试APP
1、编译驱动程序
编写Makefile文件，本章实验的Makefile文件和第二十章实验基本一样，只是将obj-m变量的值改为led.o，Makefile内容如下所示：
示例代码21.4.1.1 Makefile文件