1. LED驱动程序框架

注意：如果做实验安装驱动时提示version magic不匹配，请看本文档最后的“常见问题”。

1.1 回顾字符设备驱动程序框架

在这里插入图片描述

1.确定主设备号
2.定义自己的file_operations结构体
3.实现对应的drv_open/drv_read/drv_write等函数，填入file_operations结构体
4.把file_operations结构体告诉内核：register_chrdev
5.谁来注册驱动程序啊？得有一个入口函数，安装驱动程序时，就会调用这个入口函数。
6.有入口函数就应该有出口函数，出口函数调用unregister_chrdev
7.其他完善：提供设备信息，自动创建设备结点：class_create,device_create

1.2 对于LED驱动，我们想要什么样的接口？

在这里插入图片描述

1.3 LED驱动要怎么写，才能支持多个板子？分层。

把驱动拆分为通用的框架(leddrv.c)、具体的硬件操作(board_X.c)：

在这里插入图片描述

以面向对象的思想，改进代码：抽象出一个结构体：

在这里插入图片描述

每个单板相关的board_X.c实现自己的led_operations结构体，供上层的leddrv.c调用：

在这里插入图片描述

1.4 写代码

使用GIT下载所有源码后，本节源码位于如下目录：

01_all_series_quickstart\
05_嵌入式Linux驱动开发基础知识\source\02_led_drv\01_led_drv_template

1.4.1 驱动程序

驱动程序分为上下两层：leddrv.c、board_demo.c。
leddrv.c负责注册file_operations结构体，它的open/write成员会调用board_demo.c中提供的硬件led_opr中的对应函数。

1.4.1.1 把LED的操作抽象出一个led_operations结构体

首先看看led_opr.h，它定义了一个led_operations结构体，把LED的操作抽象为这个结构体：

01 #ifndef _LED_OPR_H
02 #define _LED_OPR_H
03
04 struct led_operations {
05      int (*init) (int which); /* 初始化LED, which-哪个LED */
06      int (*ctl) (int which, char status); /* 控制LED, which-哪个LED, status:1-亮,0-灭 */
07 };
08
09 struct led_operations *get_board_led_opr(void);
10
11
12 #endif
13

看到上面定义的头文件，可以立马把对应的board_demo.c的框架给写出来，内部的具体功能根据情况再自己定义，头文件部分依旧是两个原则，一个是根据linux内核代码中别人类似的驱动程序去编写头文件，还有一种就是根据其中对应的函数，打开虚拟机中的系统，利用open命令去参考手册。代码如下：

//裸机部分的硬件操作
#include <linux/module.h>

#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/miscdevice.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/mutex.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/stat.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/kmod.h>
#include <linux/gfp.h>
#include "led_opr.h"

static int board_demo_led_init (int which) /* 初始化LED, which-哪个LED */	   
{
	
	//printk("%s %s line %d, led %d\n", __FILE__, __FUNCTION__, __LINE__, which);
	//return 0;
	//使能啊等等
}

static int board_demo_led_ctl (int which, char status) /* 控制LED, which-哪个LED, status:1-亮,0-灭 */
{
	//printk("%s %s line %d, led %d, %s\n", __FILE__, __FUNCTION__, __LINE__, which, status ? "on" : "off");
	//return 0;
	//输出信号啊
}

static struct led_operations board_demo_led_opr = {
	.init = board_demo_led_init,
	.ctl  = board_demo_led_ctl,
};

struct led_operations *get_board_led_opr(void)
{
	//return &board_demo_led_opr;
}//指针那块不是很了解，要去了解一下。

1.4.1.2 驱动程序的上层：file_operations结构体

上层是leddrv.c，它的核心是file_operations结构体，入口函数代码如下：

80 /* 4. 把file_operations结构体告诉内核：注册驱动程序 */
81 /* 5. 谁来注册驱动程序啊？得有一个入口函数：安装驱动程序时，就会去调用这个入口函数 */
82 static int __init led_init(void)//入口函数
83 {
84      int err;//
85      int i;
86
87      printk(“%s %s line %d\n”, __FILE__, __FUNCTION__, __LINE__);
88      major = register_chrdev(0, “100ask_led”, &led_drv);  /* /dev/led *///注册驱动函数
89
90
91      led_class = class_create(THIS_MODULE, “100ask_led_class”);//创建类
92      err = PTR_ERR(led_class);//如果led_class出现错误，返回错误码
93      if (IS_ERR(led_class)) {//如果出现错误，比如内存地址空间不够
94              printk(“%s %s line %d\n”, __FILE__, __FUNCTION__, __LINE__);//打印相关的内核信息
95              unregister_chrdev(major, “100ask_led”);//卸载驱动
96              return -1;//返回-1
97      }
98
99      for (i = 0; i < LED_NUM; i++)//一切没有问题，注册设备驱动，会得到设备驱动的次设备号
100             device_create(led_class, NULL, MKDEV(major, i), NULL, “100ask_led%d”, i); /* /dev/100ask_led0,1,… */
101
102     p_led_opr = get_board_led_opr();//这地方是上下层的接口处，上层驱动调用下层板级驱动
103
104     return 0;
105 }

第88行向内核注册一个file_operations结构体。
第102行从底层硬件相关的代码board_demo.c中获得led_operaions结构体。

再来看看leddrv.c中file_operations结构体的成员函数：

37 /* write(fd, &val, 1); */
38 static ssize_t led_drv_write (struct file *file, const char __user *buf, size_t size, loff_t *offset)
39 {
40      int err;
41      char status;
42      struct inode *inode = file_inode(file);//回头解决
43      int minor = iminor(inode);//回头解决，大致上得到一个LED
44
45      printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
46      err = copy_from_user(&status, buf, 1);
47
48      /* 根据次设备号和status控制LED */
49      p_led_opr->ctl(minor, status);
50
51      return 1;
52 }
53
54 static int led_drv_open (struct inode *node, struct file *file)
55 {
56      int minor = iminor(node);
57
58      printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
59      /* 根据次设备号初始化LED */
60      p_led_opr->init(minor);
61
62      return 0;
63 }
64
65 static int led_drv_close (struct inode *node, struct file *file)
66 {
67      printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
68      return 0;
69 }
70
71 /* 2. 定义自己的file_operations结构体 */ 
72 static struct file_operations led_drv = {
73      .owner   = THIS_MODULE,
74      .open    = led_drv_open,
75      .read    = led_drv_read,
76      .write   = led_drv_write,
77      .release = led_drv_close,
78 };

第49行、第60行，会调用led_operations结构体中对应的函数。
整体代码如下：

#include <linux/module.h>

#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/miscdevice.h>
#include <linux/kernel.h>
#include <linux/major.h>
#include <linux/mutex.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/stat.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/tty.h>
#include <linux/kmod.h>
#include <linux/gfp.h>

#include "led_opr.h"//包含当前文件的头文件

#define LED_NUM 2

/* 1. 确定主设备号                                                                 */
static int major = 0;
static struct class *led_class;
struct led_operations *p_led_opr; //定义一个指针，指向单板自己所需要的硬件操作。裸机部分的操控。

#define MIN(a, b) (a < b ? a : b)

/* 3. 实现对应的open/read/write等函数，填入file_operations结构体                   */
static ssize_t led_drv_read (struct file *file, char __user *buf, size_t size, loff_t *offset)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	return 0;
}

/* write(fd, &val, 1); */
static ssize_t led_drv_write (struct file *file, const char __user *buf, size_t size, loff_t *offset)
{
	int err;
	char status;
	struct inode *inode = file_inode(file);
	int minor = iminor(inode);
	
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	err = copy_from_user(&status, buf, 1);

	/* 根据次设备号和status控制LED */
	p_led_opr->ctl(minor, status);
	
	return 1;
}

static int led_drv_open (struct inode *node, struct file *file)
{
	int minor = iminor(node);
	
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	/* 根据次设备号初始化LED */
	p_led_opr->init(minor);
	
	return 0;
}

static int led_drv_close (struct inode *node, struct file *file)
{
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
	return 0;
}

/* 2. 定义自己的file_operations结构体                                              */
static struct file_operations led_drv = {
	.owner	 = THIS_MODULE,
	.open    = led_drv_open,
	.read    = led_drv_read,
	.write   = led_drv_write,
	.release = led_drv_close,
};

/* 4. 把file_operations结构体告诉内核：注册驱动程序                                */
/* 5. 谁来注册驱动程序啊？得有一个入口函数：安装驱动程序时，就会去调用这个入口函数 */
static int __init led_init(void)
{
	int err;
	int i;
	
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);//打印内核信息
	major = register_chrdev(0, "100ask_led", &led_drv);  /* /dev/led *///注册内核设备名字就是100ask_led


	led_class = class_create(THIS_MODULE, "100ask_led_class");//创建类
	err = PTR_ERR(led_class);
	if (IS_ERR(led_class)) {
		printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);
		unregister_chrdev(major, "100ask_led");
		return -1;
	}

	for (i = 0; i < LED_NUM; i++)
		device_create(led_class, NULL, MKDEV(major, i), NULL, "100ask_led%d", i); /* /dev/100ask_led0,1,... */

	p_led_opr = get_board_led_opr();
	
	return 0;
}

/* 6. 有入口函数就应该有出口函数：卸载驱动程序时，就会去调用这个出口函数           */
static void __exit led_exit(void)
{
	int i;
	printk("%s %s line %d\n", __FILE__, __FUNCTION__, __LINE__);

	for (i = 0; i < LED_NUM; i++)
		device_destroy(led_class, MKDEV(major, i)); /* /dev/100ask_led0,1,... */

	device_destroy(led_class, MKDEV(major, 0));
	class_destroy(led_class);
	unregister_chrdev(major, "100ask_led");
}


/* 7. 其他完善：提供设备信息，自动创建设备节点                                     */

module_init(led_init);
module_exit(led_exit);

MODULE_LICENSE("GPL");

1.4.2 测试程序

测试程序为ledtest.c：

01
02 #include <sys/types.h>
03 #include <sys/stat.h>
04 #include <fcntl.h>
05 #include <unistd.h>
06 #include <stdio.h>
07 #include <string.h>
08
09 /*
10  * ./ledtest /dev/100ask_led0 on
11  * ./ledtest /dev/100ask_led0 off
12  */
13 int main(int argc, char **argv)
14 {
15      int fd;
16      char status;
17
18      /* 1. 判断参数 */
19      if (argc != 3)
20      {
21              printf("Usage: %s <dev> <on | off>\n", argv[0]);
22              return -1;
23      }
24
25      /* 2. 打开文件 */
26      fd = open(argv[1], O_RDWR);
27      if (fd == -1)
28      {
29              printf("can not open file %s\n", argv[1]);
30              return -1;
31      }
32
33      /* 3. 写文件 */
34      if (0 == strcmp(argv[2], "on"))
35      {
36              status = 1;
37              write(fd, &status, 1);
38      }
39      else
40      {
41              status = 0;
42              write(fd, &status, 1);
43      }
44
45      close(fd);
46
47      return 0;
48 }
49

第26行打开设备节点。如果用户想点亮LED，第37行会把值“1”通过write函数写入驱动程序。
如果用户想熄灭LED，第42行会把值“0”通过write函数写入驱动程序。

1.4.3 上机测试

这只是一个示例程序，还没有真正操作硬件。测试程序操作驱动程序时，只会导致驱动程序中打印信息。
首先设置交叉工具链，修改驱动Makefile中内核的源码路径，编译驱动和测试程序。
启动开发板后，通过NFS访问编译好驱动程序、测试程序，就可以在开发板上如下操作了：
makefile如下：

   
# 1. 使用不同的开发板内核时, 一定要修改KERN_DIR
# 2. KERN_DIR中的内核要事先配置、编译, 为了能编译内核, 要先设置下列环境变量:
# 2.1 ARCH,          比如: export ARCH=arm64
# 2.2 CROSS_COMPILE, 比如: export CROSS_COMPILE=aarch64-linux-gnu-
# 2.3 PATH,          比如: export PATH=$PATH:/home/book/100ask_roc-rk3399-pc/ToolChain-6.3.1/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin 
# 注意: 不同的开发板不同的编译器上述3个环境变量不一定相同,
#       请参考各开发板的高级用户使用手册

KERN_DIR = /home/book/100ask_roc-rk3399-pc/linux-4.4

all:
	make -C $(KERN_DIR) M=`pwd` modules 
	$(CROSS_COMPILE)gcc -o ledtest ledtest.c 

clean:
	make -C $(KERN_DIR) M=`pwd` modules clean
	rm -rf modules.order
	rm -f ledtest

# 参考内核源码drivers/char/ipmi/Makefile
# 要想把a.c, b.c编译成ab.ko, 可以这样指定:
# ab-y := a.o b.o
# obj-m += ab.o

# leddrv.c board_demo.c 编译成 100ask.ko
100ask_led-y := leddrv.o board_demo.o
obj-m	+= 100ask_led.o

# insmod 100ask_led.ko   // 装载驱动程序
[13449.134044] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_init line 87
# ls /dev/100ask_led* -l   // 可以得到2个设备节点
crw-------    1 root     root      235,   0 Jan 18 12:34 /dev/100ask_led0
crw-------    1 root     root      235,   1 Jan 18 12:34 /dev/100ask_led1
# ./ledtest /dev/100ask_led0 on    // 点亮LED
[13463.176987] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_open line 58
[13463.197877] /home/book/source/02_led_drv/01_led_drv_template/board_demo.c board_demo_led_init line 22, led 0
[13463.216232] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_write line 45
[13463.232889] /home/book/source/02_led_drv/01_led_drv_template/board_demo.c board_demo_led_ctl line 28, led 0, on   // 可以看到这句“on”打印
[13463.247977] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_close line 67
# ./ledtest /dev/100ask_led0 off     // 熄灭LED
[13464.540637] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_open line 58
[13464.554380] /home/book/source/02_led_drv/01_led_drv_template/board_demo.c board_demo_led_init line 22, led 0
[13464.569671] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_write line 45
[13464.580615] /home/book/source/02_led_drv/01_led_drv_template/board_demo.c board_demo_led_ctl line 28, led 0, off    // 可以看到这句“off”打印
[13464.593397] /home/book/source/02_led_drv/01_led_drv_template/leddrv.c led_drv_close line 67