Linux I2C 驱动实验

I2C 是很常用的一个串行通信接口，用于连接各种外设、传感器等器件，在裸机篇已经对I.MX6U 的I2C 接口做了详细的讲解。本章我们来学习一下如何在Linux 下开发I2C 接口器件驱动，重点是学习Linux 下的I2C 驱动框架，按照指定的框架去编写I2C 设备驱动。本章同样以I.MX6U-ALPHA 开发板上的AP3216C 这个三合一环境光传感器为例，通过AP3216C 讲解一下如何编写Linux 下的I2C 设备驱动程序。

Linux I2C 驱动框架简介

回想一下我们在裸机篇中是怎么编写AP3216C 驱动的，我们编写了四个文件：bsp_i2c.c、bsp_i2c.h、bsp_ap3216c.c 和bsp_ap3216c.h。其中前两个是I.MX6U 的IIC 接口驱动，后两个文件是AP3216C 这个I2C 设备驱动文件。相当于有两部分驱动：
①、I2C 主机驱动。
②、I2C 设备驱动。
对于I2C 主机驱动，一旦编写完成就不需要再做修改，其他的I2C 设备直接调用主机驱动提供的API 函数完成读写操作即可。这个正好符合Linux 的驱动分离与分层的思想，因此Linux内核也将I2C 驱动分为两部分：
①、I2C 总线驱动，I2C 总线驱动就是SOC 的I2C 控制器驱动，也叫做I2C 适配器驱动。
②、I2C 设备驱动，I2C 设备驱动就是针对具体的I2C 设备而编写的驱动。

I2C 总线驱动

首先来看一下I2C 总线，在讲platform 的时候就说过，platform 是虚拟出来的一条总线，目的是为了实现总线、设备、驱动框架。对于I2C 而言，不需要虚拟出一条总线，直接使用I2C总线即可。I2C 总线驱动重点是I2C 适配器(也就是SOC 的I2C 接口控制器)驱动，这里要用到两个重要的数据结构：i2c_adapter 和i2c_algorithm，Linux 内核将SOC 的I2C 适配器(控制器)
抽象成i2c_adapter，i2c_adapter 结构体定义在include/linux/i2c.h 文件中，结构体内容如下：

498 struct i2c_adapter {
499 struct module *owner;
500 unsigned int class; /* classes to allow probing for */
501 const struct i2c_algorithm *algo; /* 总线访问算法*/
502 void *algo_data;
503
504 /* data fields that are valid for all devices */
505 struct rt_mutex bus_lock;
506
507 int timeout; /* in jiffies */
508 int retries;
509 struct device dev; /* the adapter device */
510
511 int nr;
512 char name[48];
513 struct completion dev_released;
514
515 struct mutex userspace_clients_lock;
516 struct list_head userspace_clients;
517
518 struct i2c_bus_recovery_info *bus_recovery_info;
519 const struct i2c_adapter_quirks *quirks;
520 };

第501 行，i2c_algorithm 类型的指针变量algo，对于一个I2C 适配器，肯定要对外提供读写API 函数，设备驱动程序可以使用这些API 函数来完成读写操作。i2c_algorithm 就是I2C 适配器与IIC 设备进行通信的方法。

i2c_algorithm 结构体定义在include/linux/i2c.h 文件中，内容如下(删除条件编译)：

391 struct i2c_algorithm {
......
398 int (*master_xfer)(struct i2c_adapter *adap,
struct i2c_msg *msgs,
399 int num);
400 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
401 unsigned short flags, char read_write,
402 u8 command, int size, union i2c_smbus_data *data);
403
404 /* To determine what the adapter supports */
405 u32 (*functionality) (struct i2c_adapter *);
......
411 };

第398 行，master_xfer 就是I2C 适配器的传输函数，可以通过此函数来完成与IIC 设备之间的通信。
第400 行，smbus_xfer 就是SMBUS 总线的传输函数。

综上所述，I2C 总线驱动，或者说I2C 适配器驱动的主要工作就是初始化i2c_adapter 结构体变量，然后设置i2c_algorithm 中的master_xfer 函数。完成以后通过i2c_add_numbered_adapter或i2c_add_adapter 这两个函数向系统注册设置好的i2c_adapter，这两个函数的原型如下：

int i2c_add_adapter(struct i2c_adapter *adapter)
int i2c_add_numbered_adapter(struct i2c_adapter *adap)

这两个函数的区别在于i2c_add_adapter 使用动态的总线号，而i2c_add_numbered_adapter使用静态总线号。函数参数和返回值含义如下：
adapter 或adap：要添加到Linux 内核中的i2c_adapter，也就是I2C 适配器。
返回值：0，成功；负值，失败。
如果要删除I2C 适配器的话使用i2c_del_adapter 函数即可，函数原型如下：

void i2c_del_adapter(struct i2c_adapter * adap)

函数参数和返回值含义如下：
adap：要删除的I2C 适配器。
返回值：无。
关于I2C 的总线(控制器或适配器)驱动就讲解到这里，一般SOC 的I2C 总线驱动都是由半导体厂商编写的，比如I.MX6U 的I2C 适配器驱动NXP 已经编写好了，这个不需要用户去编写。因此I2C 总线驱动对我们这些SOC 使用者来说是被屏蔽掉的，我们只要专注于I2C 设备驱动即可。除非你是在半导体公司上班，工作内容就是写I2C 适配器驱动。

I2C 设备驱动

I2C 设备驱动重点关注两个数据结构：i2c_client 和i2c_driver，根据总线、设备和驱动模型，I2C 总线上一小节已经讲了。还剩下设备和驱动，i2c_client 就是描述设备信息的，i2c_driver 描述驱动内容，类似于platform_driver。
1、i2c_client 结构体
i2c_client 结构体定义在include/linux/i2c.h 文件中，内容如下：

217 struct i2c_client {
218 unsigned short flags; /* 标志*/
219 unsigned short addr; /* 芯片地址，7位，存在低7位*/
......
222 char name[I2C_NAME_SIZE]; /* 名字*/
223 struct i2c_adapter *adapter; /* 对应的I2C适配器*/
224 struct device dev; /* 设备结构体*/
225 int irq; /* 中断*/
226 struct list_head detected;
......
230 };

一个设备对应一个i2c_client，每检测到一个I2C 设备就会给这个I2C 设备分配一个i2c_client。
2、i2c_driver 结构体
i2c_driver 类似platform_driver，是我们编写I2C 设备驱动重点要处理的内容，i2c_driver 结构体定义在include/linux/i2c.h 文件中，内容如下：

161 struct i2c_driver {
162 unsigned int class;
163
164 /* Notifies the driver that a new bus has appeared. You should
165 * avoid using this, it will be removed in a near future.
166 */
167 int (*attach_adapter)(struct i2c_adapter *) __deprecated;
168
169 /* Standard driver model interfaces */
170 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
171 int (*remove)(struct i2c_client *);
172
173 /* driver model interfaces that don't relate to enumeration */
174 void (*shutdown)(struct i2c_client *);
175
176 /* Alert callback, for example for the SMBus alert protocol.
177 * The format and meaning of the data value depends on the
178 * protocol.For the SMBus alert protocol, there is a single bit
179 * of data passed as the alert response's low bit ("event
180 flag"). */
181 void (*alert)(struct i2c_client *, unsigned int data);
182
183 /* a ioctl like command that can be used to perform specific
184 * functions with the device.
185 */
186 int (*command)(struct i2c_client *client, unsigned int cmd,
void *arg);
187
188 struct device_driver driver;
189 const struct i2c_device_id *id_table;
190
191 /* Device detection callback for automatic device creation */
192 int (*detect)(struct i2c_client *, struct i2c_board_info *);
193 const unsigned short *address_list;
194 struct list_head clients;
195 };

第170 行，当I2C 设备和驱动匹配成功以后probe 函数就会执行，和platform 驱动一样。

第188 行，device_driver 驱动结构体，如果使用设备树的话，需要设置device_driver 的of_match_table 成员变量，也就是驱动的兼容(compatible)属性。

第189 行，id_table 是传统的、未使用设备树的设备匹配ID 表。

对于我们I2C 设备驱动编写人来说，重点工作就是构建i2c_driver，构建完成以后需要向Linux 内核注册这个i2c_driver。i2c_driver 注册函数为int i2c_register_driver，此函数原型如下：

int i2c_register_driver(struct module *owner,
struct i2c_driver *driver)

函数参数和返回值含义如下：
owner：一般为THIS_MODULE。
driver：要注册的i2c_driver。
返回值：0，成功；负值，失败。

另外i2c_add_driver 也常常用于注册i2c_driver，i2c_add_driver 是一个宏，定义如下：

587 #define i2c_add_driver(driver) \
588 i2c_register_driver(THIS_MODULE, driver)

i2c_add_driver 就是对i2c_register_driver 做了一个简单的封装，只有一个参数，就是要注册的i2c_driver。
注销I2C 设备驱动的时候需要将前面注册的i2c_driver 从Linux 内核中注销掉，需要用到i2c_del_driver 函数，此函数原型如下：

void i2c_del_driver(struct i2c_driver *driver)

函数参数和返回值含义如下：
driver：要注销的i2c_driver。
返回值：无。
i2c_driver 的注册示例代码如下：

1 /* i2c驱动的probe函数*/
2 static int xxx_probe(struct i2c_client *client,
const struct i2c_device_id *id)
3 {
4 /* 函数具体程序*/
5 return 0;
6 }
7
8 /* i2c驱动的remove函数*/
9 static int xxx_remove(struct i2c_client *client)
10 {
11 /* 函数具体程序*/
12 return 0;
13 }
14
15 /* 传统匹配方式ID列表*/
16 static const struct i2c_device_id xxx_id[] = {
17 {"xxx", 0},
18 {}
19 };
20
21 /* 设备树匹配列表*/
22 static const struct of_device_id xxx_of_match[] = {
23 { .compatible = "xxx" },
24 { /* Sentinel */ }
25 };
26
27 /* i2c驱动结构体*/
28 static struct i2c_driver xxx_driver = {
29 .probe = xxx_probe,
30 .remove = xxx_remove,
31 .driver = {
32 .owner = THIS_MODULE,
33 .name = "xxx",
34 .of_match_table = xxx_of_match,
35 },
36 .id_table = xxx_id,
37 };
38
39 /* 驱动入口函数*/
40 static int __init xxx_init(void)
41 {
42 int ret = 0;
43
44 ret = i2c_add_driver(&xxx_driver);
45 return ret;
46 }
47
48 /* 驱动出口函数*/
49 static void __exit xxx_exit(void)
50 {
51 i2c_del_driver(&xxx_driver);
52 }
53
54 module_init(xxx_init);
55 module_exit(xxx_exit);

第16~19 行，i2c_device_id，无设备树的时候匹配ID 表。
第22~25 行，of_device_id，设备树所使用的匹配表。
第28~37 行，i2c_driver，当I2C 设备和I2C 驱动匹配成功以后probe 函数就会执行，这些和platform 驱动一样，probe 函数里面基本就是标准的字符设备驱动那一套了。

I2C 设备和驱动匹配过程

I2C 设备和驱动的匹配过程是由I2C 核心来完成的，drivers/i2c/i2c-core.c 就是I2C 的核心部分，I2C 核心提供了一些与具体硬件无关的API 函数，比如前面讲过的：

1、i2c_adapter 注册/注销函数
int i2c_add_adapter(struct i2c_adapter *adapter)
int i2c_add_numbered_adapter(struct i2c_adapter *adap)
void i2c_del_adapter(struct i2c_adapter * adap)

2、i2c_driver 注册/注销函数
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
int i2c_add_driver (struct i2c_driver *driver)
void i2c_del_driver(struct i2c_driver *driver)
设备和驱动的匹配过程也是由I2C 总线完成的，I2C 总线的数据结构为i2c_bus_type，定义在drivers/i2c/i2c-core.c 文件，i2c_bus_type 内容如下：

736 struct bus_type i2c_bus_type = {
737 .name = "i2c",
738 .match = i2c_device_match,
739 .probe = i2c_device_probe,
740 .remove = i2c_device_remove,
741 .shutdown = i2c_device_shutdown,
742 };

.match 就是I2C 总线的设备和驱动匹配函数，在这里就是i2c_device_match 这个函数，此函数内容如下：

457 static int i2c_device_match(struct device *dev, struct device_driver *drv)
458 {
459 struct i2c_client *client = i2c_verify_client(dev);
460 struct i2c_driver *driver;
461
462 if (!client)
463 return 0;
464
465 /* Attempt an OF style match */
466 if (of_driver_match_device(dev, drv))
467 return 1;
468
469 /* Then ACPI style match */
470 if (acpi_driver_match_device(dev, drv))
471 return 1;
472
473 driver = to_i2c_driver(drv);
474 /* match on an id table if there is one */
475 if (driver->id_table)
476 return i2c_match_id(driver->id_table, client) != NULL;
477
478 return 0;
479 }

第466 行，of_driver_match_device 函数用于完成设备树设备和驱动匹配。比较I2C 设备节点的compatible 属性和of_device_id 中的compatible 属性是否相等，如果相当的话就表示I2C设备和驱动匹配。
第470 行，acpi_driver_match_device 函数用于ACPI 形式的匹配。
第476 行，i2c_match_id 函数用于传统的、无设备树的I2C 设备和驱动匹配过程。比较I2C设备名字和i2c_device_id 的name 字段是否相等，相等的话就说明I2C 设备和驱动匹配。

I.MX6U 的I2C 适配器驱动分析

上一小节我们讲解了Linux 下的I2C 驱动框架，重点分为I2C 适配器驱动和I2C 设备驱动，其中I2C 适配器驱动就是SOC 的I2C 控制器驱动。I2C 设备驱动是需要用户根据不同的I2C 设备去编写，而I2C 适配器驱动一般都是SOC 厂商去编写的，比如NXP 就编写好了I.MX6U 的I2C 适配器驱动。在imx6ull.dtsi 文件中找到I.MX6U 的I2C1 控制器节点，节点内容如下所示：

1 i2c1: i2c@021a0000 {
2 #address-cells = <1>;
3 #size-cells = <0>;
4 compatible = "fsl,imx6ul-i2c", "fsl,imx21-i2c";
5 reg = <0x021a0000 0x4000>;
6 interrupts = <GIC_SPI 36 IRQ_TYPE_LEVEL_HIGH>;
7 clocks = <&clks IMX6UL_CLK_I2C1>;
8 status = "disabled";
9 };

重点关注i2c1 节点的compatible 属性值，因为通过compatible 属性值可以在Linux 源码里面找到对应的驱动文件。这里i2c1 节点的compatible 属性值有两个：“fsl,imx6ul-i2c”和“fsl,imx21-
i2c”，在Linux 源码中搜索这两个字符串即可找到对应的驱动文件。I.MX6U 的I2C 适配器驱动驱动文件为drivers/i2c/busses/i2c-imx.c，在此文件中有如下内容：

244 static struct platform_device_id imx_i2c_devtype[] = {
245 {
246 .name = "imx1-i2c",
247 .driver_data = (kernel_ulong_t)&imx1_i2c_hwdata,
248 }, {
249 .name = "imx21-i2c",
250 .driver_data = (kernel_ulong_t)&imx21_i2c_hwdata,
251 }, {
252 /* sentinel */
253 }
254 };
255 MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);
256
257 static const struct of_device_id i2c_imx_dt_ids[] = {
258 { .compatible = "fsl,imx1-i2c", .data = &imx1_i2c_hwdata, },
259 { .compatible = "fsl,imx21-i2c", .data = &imx21_i2c_hwdata, },
260 { .compatible = "fsl,vf610-i2c", .data = &vf610_i2c_hwdata, },
261 { /* sentinel */ }
262 };
263 MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);
......
1119 static struct platform_driver i2c_imx_driver = {
1120 .probe = i2c_imx_probe,
1121 .remove = i2c_imx_remove,
1122 .driver = {
1123 .name = DRIVER_NAME,
1124 .owner = THIS_MODULE,
1125 .of_match_table = i2c_imx_dt_ids,
1126 .pm = IMX_I2C_PM,
1127 },
1128 .id_table = imx_i2c_devtype,
1129 };
1130
1131 static int __init i2c_adap_imx_init(void)
1132 {
1133 return platform_driver_register(&i2c_imx_driver);
1134 }
1135 subsys_initcall(i2c_adap_imx_init);
1136
1137 static void __exit i2c_adap_imx_exit(void)
1138 {
1139 platform_driver_unregister(&i2c_imx_driver);
1140 }
1141 module_exit(i2c_adap_imx_exit);

从示例代码61.2.2 可以看出，I.MX6U 的I2C 适配器驱动是个标准的platform 驱动，由此可以看出，虽然I2C 总线为别的设备提供了一种总线驱动框架，但是I2C 适配器却是platform驱动。就像你的部门老大是你的领导，你是他的下属，但是放到整个公司，你的部门老大却也是老板的下属。

第259 行，“fsl,imx21-i2c”属性值，设备树中i2c1 节点的compatible 属性值就是与此匹配上的。因此i2c-imx.c 文件就是I.MX6U 的I2C 适配器驱动文件。

第1120 行，当设备和驱动匹配成功以后i2c_imx_probe 函数就会执行，i2c_imx_probe 函数就会完成I2C 适配器初始化工作。
i2c_imx_probe 函数内容如下所示(有省略)：

971 static int i2c_imx_probe(struct platform_device *pdev)
972 {
973 const struct of_device_id *of_id =
974 of_match_device(i2c_imx_dt_ids, &pdev->dev);
975 struct imx_i2c_struct *i2c_imx;
976 struct resource *res;
977 struct imxi2c_platform_data *pdata =
dev_get_platdata(&pdev->dev);
978 void __iomem *base;
979 int irq, ret;
980 dma_addr_t phy_addr;
981
982 dev_dbg(&pdev->dev, "<%s>\n", __func__);
983
984 irq = platform_get_irq(pdev, 0);
......
990 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
991 base = devm_ioremap_resource(&pdev->dev, res);
992 if (IS_ERR(base))
993 return PTR_ERR(base);
994
995 phy_addr = (dma_addr_t)res->start;
996 i2c_imx = devm_kzalloc(&pdev->dev, sizeof(*i2c_imx),
GFP_KERNEL);
997 if (!i2c_imx)
998 return -ENOMEM;
999
1000 if (of_id)
1001 i2c_imx->hwdata = of_id->data;
1002 else
1003 i2c_imx->hwdata = (struct imx_i2c_hwdata *)
1004 platform_get_device_id(pdev)->driver_data;
1005
1006 /* Setup i2c_imx driver structure */
1007 strlcpy(i2c_imx->adapter.name, pdev->name,
sizeof(i2c_imx->adapter.name));
1008 i2c_imx->adapter.owner = THIS_MODULE;
1009 i2c_imx->adapter.algo = &i2c_imx_algo;
1010 i2c_imx->adapter.dev.parent = &pdev->dev;
1011 i2c_imx->adapter.nr = pdev->id;
1012 i2c_imx->adapter.dev.of_node = pdev->dev.of_node;
1013 i2c_imx->base = base;
1014
1015 /* Get I2C clock */
1016 i2c_imx->clk = devm_clk_get(&pdev->dev, NULL);
......
1022 ret = clk_prepare_enable(i2c_imx->clk);
......
1027 /* Request IRQ */
1028 ret = devm_request_irq(&pdev->dev, irq, i2c_imx_isr,
1029 IRQF_NO_SUSPEND, pdev->name, i2c_imx);
......
1035 /* Init queue */
1036 init_waitqueue_head(&i2c_imx->queue);
1037
1038 /* Set up adapter data */
1039 i2c_set_adapdata(&i2c_imx->adapter, i2c_imx);
1040
1041 /* Set up clock divider */
1042 i2c_imx->bitrate = IMX_I2C_BIT_RATE;
1043 ret = of_property_read_u32(pdev->dev.of_node,
1044 "clock-frequency", &i2c_imx->bitrate);
1045 if (ret < 0 && pdata && pdata->bitrate)
1046 i2c_imx->bitrate = pdata->bitrate;
1047
1048 /* Set up chip registers to defaults */
1049 imx_i2c_write_reg(i2c_imx->hwdata->i2cr_ien_opcode ^ I2CR_IEN,
1050 i2c_imx, IMX_I2C_I2CR);
1051 imx_i2c_write_reg(i2c_imx->hwdata->i2sr_clr_opcode, i2c_imx,

第984 行，调用platform_get_irq 函数获取中断号。
第990~991 行，调用platform_get_resource 函数从设备树中获取I2C1 控制器寄存器物理基地址，也就是0X021A0000。获取到寄存器基地址以后使用devm_ioremap_resource 函数对其进行内存映射，得到可以在Linux 内核中使用的虚拟地址。
第996 行，NXP 使用imx_i2c_struct 结构体来表示I.MX 系列SOC 的I2C 控制器，这里使用devm_kzalloc 函数来申请内存。
第1008~1013 行，imx_i2c_struct 结构体要有个叫做adapter 的成员变量，adapter 就是i2c_adapter，这里初始化i2c_adapter。第1009 行设置i2c_adapter 的algo 成员变量为i2c_imx_algo，也就是设置i2c_algorithm。
第1028~1029 行，注册I2C 控制器中断，中断服务函数为i2c_imx_isr。
第1042~1044 行，设置I2C 频率默认为IMX_I2C_BIT_RATE=100KHz，如果设备树节点设置了“clock-frequency”属性的话I2C 频率就使用clock-frequency 属性值。
第1049~1051 行，设置I2C1 控制的I2CR 和I2SR 寄存器。
第1054 行，调用i2c_add_numbered_adapter 函数向Linux 内核注册i2c_adapter。
第1071 行，申请DMA，看来I.MX 的I2C 适配器驱动采用了DMA 方式。
i2c_imx_probe 函数主要的工作就是一下两点：
①、初始化i2c_adapter，设置i2c_algorithm 为i2c_imx_algo，最后向Linux 内核注册i2c_adapter。
②、初始化I2C1 控制器的相关寄存器。
i2c_imx_algo 包含I2C1 适配器与I2C 设备的通信函数master_xfer，i2c_imx_algo 结构体定义如下：

966 static struct i2c_algorithm i2c_imx_algo = {
967 .master_xfer = i2c_imx_xfer,
968 .functionality = i2c_imx_func,
969 };

我们先来看一下. functionality，functionality用于返回此I2C适配器支持什么样的通信协议，在这里functionality 就是i2c_imx_func 函数，i2c_imx_func 函数内容如下：

static u32 i2c_imx_func(struct i2c_adapter *adapter)
{
return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL
| I2C_FUNC_SMBUS_READ_BLOCK_DATA;
}

重点来看一下i2c_imx_xfer 函数，因为最终就是通过此函数来完成与I2C 设备通信的，此函数内容如下(有省略)：

888 static int i2c_imx_xfer(struct i2c_adapter *adapter,
889 struct i2c_msg *msgs, int num)
890 {
891 unsigned int i, temp;
892 int result;
893 bool is_lastmsg = false;
894 struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);
895
896 dev_dbg(&i2c_imx->adapter.dev, "<%s>\n", __func__);
897
898 /* Start I2C transfer */
899 result = i2c_imx_start(i2c_imx);
900 if (result)
901 goto fail0;
902
903 /* read/write data */
904 for (i = 0; i < num; i++) {
905 if (i == num - 1)
906 is_lastmsg = true;
907
908 if (i) {
909 dev_dbg(&i2c_imx->adapter.dev,
910 "<%s> repeated start\n", __func__);
911 temp = imx_i2c_read_reg(i2c_imx, IMX_I2C_I2CR);
912 temp |= I2CR_RSTA;
913 imx_i2c_write_reg(temp, i2c_imx, IMX_I2C_I2CR);
914 result = i2c_imx_bus_busy(i2c_imx, 1);

第899 行，调用i2c_imx_start 函数开启I2C 通信。
第939 行，如果是从I2C 设备读数据的话就调用i2c_imx_read 函数。
第941~945 行，向I2C 设备写数据，如果要用DMA 的话就使用i2c_imx_dma_write 函数来完成写数据。如果不使用DMA 的话就使用i2c_imx_write 函数完成写数据。
第952 行，I2C 通信完成以后调用i2c_imx_stop 函数停止I2C 通信。
i2c_imx_start、i2c_imx_read、i2c_imx_write 和i2c_imx_stop 这些函数就是I2C 寄存器的具体操作函数，函数内容基本和我们裸机篇中讲的I2C 驱动一样，这里我们就不详细的分析了，大家可以对照着第二十六章实验自行分析。

I2C 设备驱动编写流程

I2C 适配器驱动SOC 厂商已经替我们编写好了，我们需要做的就是编写具体的设备驱动，本小节我们就来学习一下I2C 设备驱动的详细编写流程。

I2C 设备信息描述

1、未使用设备树的时候
首先肯定要描述I2C 设备节点信息，先来看一下没有使用设备树的时候是如何在BSP 里面描述I2C 设备信息的，在未使用设备树的时候需要在BSP 里面使用i2c_board_info 结构体来描述一个具体的I2C 设备。i2c_board_info 结构体如下：

295 struct i2c_board_info {
296 char type[I2C_NAME_SIZE]; /* I2C设备名字*/
297 unsigned short flags; /* 标志*/
298 unsigned short addr; /* I2C器件地址*/
299 void *platform_data;
300 struct dev_archdata *archdata;
301 struct device_node *of_node;
302 struct fwnode_handle *fwnode;
303 int irq;
304 };

type 和addr 这两个成员变量是必须要设置的，一个是I2C 设备的名字，一个是I2C 设备的器件地址。打开arch/arm/mach-imx/mach-mx27_3ds.c 文件，此文件中关于OV2640 的I2C 设备信息描述如下：

392 static struct i2c_board_info mx27_3ds_i2c_camera = {
393 I2C_BOARD_INFO("ov2640", 0x30),
394 };

示例代码61.3.1.2 中使用I2C_BOARD_INFO 来完成mx27_3ds_i2c_camera 的初始化工作，I2C_BOARD_INFO 是一个宏，定义如下：
示例代码61.3.1.3 I2C_BOARD_INFO 宏

316 #define I2C_BOARD_INFO(dev_type, dev_addr) \
317 .type = dev_type, .addr = (dev_addr)

可以看出，I2C_BOARD_INFO 宏其实就是设置i2c_board_info 的type 和addr 这两个成员变量，因此示例代码61.3.1.2 的主要工作就是设置I2C 设备名字为ov2640，ov2640 的器件地址为0X30。
大家可以在Linux 源码里面全局搜索i2c_board_info，会找到大量以i2c_board_info 定义的I2C 设备信息，这些就是未使用设备树的时候I2C 设备的描述方式，当采用了设备树以后就不会再使用i2c_board_info 来描述I2C 设备了。

2、使用设备树的时候
使用设备树的时候I2C 设备信息通过创建相应的节点就行了，比如NXP 官方的EVK 开发板在I2C1 上接了mag3110 这个磁力计芯片，因此必须在i2c1 节点下创建mag3110 子节点，然后在这个子节点内描述mag3110 这个芯片的相关信息。打开imx6ull-14x14-evk.dts 这个设备树文件，然后找到如下内容：

1 &i2c1 {
2 clock-frequency = <100000>;
3 pinctrl-names = "default";
4 pinctrl-0 = <&pinctrl_i2c1>;
5 status = "okay";
6
7 mag3110@0e {
8 compatible = "fsl,mag3110";
9 reg = <0x0e>;
10 position = <2>;
11 };
......
20 };

第7~11 行，向i2c1 添加mag3110 子节点，第7 行“mag3110@0e”是子节点名字，“@”后面的“0e”就是mag3110 的I2C 器件地址。第8 行设置compatible 属性值为“fsl,mag3110”。
第9 行的reg 属性也是设置mag3110 的器件地址的，因此值为0x0e。I2C 设备节点的创建重点是compatible 属性和reg 属性的设置，一个用于匹配驱动，一个用于设置器件地址。

I2C 设备数据收发处理流程

在61.1.2 小节已经说过了，I2C 设备驱动首先要做的就是初始化i2c_driver 并向Linux 内核注册。当设备和驱动匹配以后i2c_driver 里面的probe 函数就会执行，probe 函数里面所做的就是字符设备驱动那一套了。一般需要在probe 函数里面初始化I2C 设备，要初始化I2C 设备就必须能够对I2C 设备寄存器进行读写操作，这里就要用到i2c_transfer 函数了。i2c_transfer 函数
最终会调用I2C 适配器中i2c_algorithm 里面的master_xfer 函数，对于I.MX6U 而言就是i2c_imx_xfer 这个函数。i2c_transfer 函数原型如下：

int i2c_transfer(struct i2c_adapter *adap,
struct i2c_msg *msgs,
int num)

函数参数和返回值含义如下：
adap：所使用的I2C 适配器，i2c_client 会保存其对应的i2c_adapter。
msgs：I2C 要发送的一个或多个消息。
num：消息数量，也就是msgs 的数量。
返回值：负值，失败，其他非负值，发送的msgs 数量。

我们重点来看一下msgs 这个参数，这是一个i2c_msg 类型的指针参数，I2C 进行数据收发说白了就是消息的传递，Linux 内核使用i2c_msg 结构体来描述一个消息。i2c_msg 结构体定义在include/uapi/linux/i2c.h 文件中，结构体内容如下：

68 struct i2c_msg {
69 __u16 addr; /* 从机地址*/
70 __u16 flags; /* 标志*/
71 #define I2C_M_TEN 0x0010
72 #define I2C_M_RD 0x0001
73 #define I2C_M_STOP 0x8000
74 #define I2C_M_NOSTART 0x4000
75 #define I2C_M_REV_DIR_ADDR 0x2000
76 #define I2C_M_IGNORE_NAK 0x1000
77 #define I2C_M_NO_RD_ACK 0x0800
78 #define I2C_M_RECV_LEN 0x0400
79 __u16 len; /* 消息(本msg)长度*/
80 __u8 *buf; /* 消息数据*/
81 };

使用i2c_transfer 函数发送数据之前要先构建好i2c_msg，使用i2c_transfer 进行I2C 数据收发的示例代码如下：

1 /* 设备结构体*/
2 struct xxx_dev {
3 ......
4 void *private_data; /* 私有数据，一般会设置为i2c_client */
5 };
6
7 /*
8 * @description : 读取I2C设备多个寄存器数据
9 * @param – dev : I2C设备
10 * @param – reg : 要读取的寄存器首地址
11 * @param – val : 读取到的数据
12 * @param – len : 要读取的数据长度
13 * @return : 操作结果
14 */
15 static int xxx_read_regs(struct xxx_dev *dev, u8 reg, void *val,
int len)
16 {
17 int ret;
18 struct i2c_msg msg[2];
19 struct i2c_client *client = (struct i2c_client *)
dev->private_data;
20
21 /* msg[0]，第一条写消息，发送要读取的寄存器首地址*/
22 msg[0].addr = client->addr; /* I2C器件地址*/
23 msg[0].flags = 0; /* 标记为发送数据*/
24 msg[0].buf = ® /* 读取的首地址*/
25 msg[0].len = 1; /* reg长度*/
26
27 /* msg[1]，第二条读消息，读取寄存器数据*/
28 msg[1].addr = client->addr; /* I2C器件地址*/
29 msg[1].flags = I2C_M_RD; /* 标记为读取数据*/
30 msg[1].buf = val; /* 读取数据缓冲区*/
31 msg[1].len = len; /* 要读取的数据长度*/
32
33 ret = i2c_transfer(client->adapter, msg, 2);
34 if(ret == 2) {
35 ret = 0;
36 } else {
37 ret = -EREMOTEIO;
38 }
39 return ret;
40 }
41
42 /*
43 * @description : 向I2C设备多个寄存器写入数据
44 * @param – dev : 要写入的设备结构体
45 * @param – reg : 要写入的寄存器首地址
46 * @param – buf : 要写入的数据缓冲区
47 * @param – len : 要写入的数据长度
48 * @return : 操作结果
49 */
50 static s32 xxx_write_regs(struct xxx_dev *dev, u8 reg, u8 *buf,
u8 len)
51 {
52 u8 b[256];
53 struct i2c_msg msg;
54 struct i2c_client *client = (struct i2c_client *)
dev->private_data;
55
56 b[0] = reg; /* 寄存器首地址*/
57 memcpy(&b[1],buf,len); /* 将要发送的数据拷贝到数组b里面*/
58
59 msg.addr = client->addr; /* I2C器件地址*/
60 msg.flags = 0; /* 标记为写数据*/
61
62 msg.buf = b; /* 要发送的数据缓冲区*/
63 msg.len = len + 1; /* 要发送的数据长度*/
64
65 return i2c_transfer(client->adapter, &msg, 1);
66 }

第2~5 行，设备结构体，在设备结构体里面添加一个执行void 的指针成员变量private_data，此成员变量用于保存设备的私有数据。在I2C 设备驱动中我们一般将其指向I2C 设备对应的i2c_client。

第15~40 行，xxx_read_regs 函数用于读取I2C 设备多个寄存器数据。第18 行定义了一个i2c_msg 数组，2 个数组元素，因为I2C 读取数据的时候要先发送要读取的寄存器地址，然后再读取数据，所以需要准备两个i2c_msg。一个用于发送寄存器地址，一个用于读取寄存器值。对于msg[0]，将flags 设置为0，表示写数据。msg[0]的addr 是I2C 设备的器件地址，msg[0]的buf
成员变量就是要读取的寄存器地址。对于msg[1]，将flags 设置为I2C_M_RD，表示读取数据。
msg[1]的buf 成员变量用于保存读取到的数据，len 成员变量就是要读取的数据长度。调用
i2c_transfer 函数完成I2C 数据读操作。

第50~66 行，xxx_write_regs 函数用于向I2C 设备多个寄存器写数据，I2C 写操作要比读操作简单一点，因此一个i2c_msg 即可。数组b 用于存放寄存器首地址和要发送的数据，第59 行设置msg 的addr 为I2C 器件地址。第60 行设置msg 的flags 为0，也就是写数据。第62 行设置要发送的数据，也就是数组b。第63 行设置msg 的len 为len+1，因为要加上一个字节的寄存器地址。最后通过i2c_transfer 函数完成向I2C 设备的写操作。

另外还有两个API函数分别用于I2C 数据的收发操作，这两个函数最终都会调用i2c_transfer。首先来看一下I2C 数据发送函数i2c_master_send，函数原型如下：

int i2c_master_send(const struct i2c_client *client,
const char *buf,
int count)

函数参数和返回值含义如下：
client：I2C 设备对应的i2c_client。
buf：要发送的数据。
count：要发送的数据字节数，要小于64KB，以为i2c_msg 的len 成员变量是一个u16(无符号16 位)类型的数据。
返回值：负值，失败，其他非负值，发送的字节数。
I2C 数据接收函数为i2c_master_recv，函数原型如下：

int i2c_master_recv(const struct i2c_client *client,
char *buf,
int count)

函数参数和返回值含义如下：
client：I2C 设备对应的i2c_client。
buf：要接收的数据。
count：要接收的数据字节数，要小于64KB，以为i2c_msg 的len 成员变量是一个u16(无符号16 位)类型的数据。
返回值：负值，失败，其他非负值，发送的字节数。
关于Linux 下I2C 设备驱动的编写流程就讲解到这里，重点就是i2c_msg 的构建和i2c_transfer 函数的调用，接下来我们就编写AP3216C 这个I2C 设备的Linux 驱动。

硬件原理图分析

本章实验硬件原理图参考26.2 小节即可。

实验程序编写

本实验对应的例程路径为：开发板光盘-> 2、Linux 驱动例程-> 21_iic。

修改设备树

1、IO 修改或添加

首先肯定是要修改IO，AP3216C 用到了I2C1 接口，I.MX6U-ALPHA 开发板上的I2C1 接口使用到了UART4_TXD 和UART4_RXD，因此肯定要在设备树里面设置这两个IO。如果要用到AP3216C 的中断功能的话还需要初始化AP_INT 对应的GIO1_IO01 这个IO，本章实验我们不使用中断功能。因此只需要设置UART4_TXD 和UART4_RXD 这两个IO，NXP 其实已经将他这两个IO 设置好了，打开imx6ull-alientek-emmc.dts，然后找到如下内容：

1 pinctrl_i2c1: i2c1grp {
2 fsl,pins = <
3 MX6UL_PAD_UART4_TX_DATA__I2C1_SCL 0x4001b8b0
4 MX6UL_PAD_UART4_RX_DATA__I2C1_SDA 0x4001b8b0
5 >;
6 };

pinctrl_i2c1 就是I2C1 的IO 节点，这里将UART4_TXD 和UART4_RXD 这两个IO 分别复用为I2C1_SCL 和I2C1_SDA，电气属性都设置为0x4001b8b0。

2、在i2c1 节点追加ap3216c 子节点
AP3216C 是连接到I2C1 上的，因此需要在i2c1 节点下添加ap3216c 的设备子节点，在imx6ull-alientek-emmc.dts 文件中找到i2c1 节点，此节点默认内容如下：

1 &i2c1 {
2 clock-frequency = <100000>;
3 pinctrl-names = "default";
4 pinctrl-0 = <&pinctrl_i2c1>;
5 status = "okay";
6
7 mag3110@0e {
8 compatible = "fsl,mag3110";
9 reg = <0x0e>;
10 position = <2>;
11 };
12
13 fxls8471@1e {
14 compatible = "fsl,fxls8471";
15 reg = <0x1e>;
16 position = <0>;
17 interrupt-parent = <&gpio5>;
18 interrupts = <0 8>;
19 };
20 };

第2 行，clock-frequency 属性为I2C 频率，这里设置为100KHz。
第4 行，pinctrl-0 属性指定I2C 所使用的IO 为示例代码61.5.1.1 中的pinctrl_i2c1 子节点。

第7~11 行，mag3110 是个磁力计，NXP 官方的EVK 开发板上接了mag3110，因此NXP在i2c1 节点下添加了mag3110 这个子节点。正点原子的I.MX6U-ALPHA 开发板上没有用到mag3110，因此需要将此节点删除掉。

第13~19 行，NXP 官方EVK 开发板也接了一个fxls8471，正点原子的I.MX6U-ALPHA开发板同样没有此器件，所以也要将其删除掉。

将i2c1 节点里面原有的mag3110 和fxls8471 这两个I2C 子节点删除，然后添加ap3216c子节点信息，完成以后的i2c1 节点内容如下所示：

1 &i2c1 {
2 clock-frequency = <100000>;
3 pinctrl-names = "default";
4 pinctrl-0 = <&pinctrl_i2c1>;
5 status = "okay";
6
7 ap3216c@1e {
8 compatible = "alientek,ap3216c";
9 reg = <0x1e>;
10 };
11 };

第7 行，ap3216c 子节点，@后面的“1e”是ap3216c 的器件地址。
第8 行，设置compatible 值为“alientek,ap3216c”。
第9 行，reg 属性也是设置ap3216c 器件地址的，因此reg 设置为0x1e。

设备树修改完成以后使用“make dtbs”重新编译一下，然后使用新的设备树启动Linux 内核。/sys/bus/i2c/devices 目录下存放着所有I2C 设备，如果设备树修改正确的话，会在/sys/bus/i2c/devices 目录下看到一个名为“0-001e”的子目录，如图61.5.1.1 所示：

图61.5.1.1 中的“0-001e”就是ap3216c 的设备目录，“1e”就是ap3216c 器件地址。进入0-001e 目录，可以看到“name”文件，name 问价就保存着此设备名字，在这里就是“ap3216c”，如图61.5.1.2 所示：

AP3216C 驱动编写

新建名为“21_iic”的文件夹，然后在21_iic 文件夹里面创建vscode 工程，工作区命名为“iic”。工程创建好以后新建ap3216c.c 和ap3216creg.h 这两个文件，ap3216c.c 为AP3216C 的驱动代码，ap3216creg.h 是AP3216C 寄存器头文件。先在ap3216creg.h 中定义好AP3216C 的寄存器，输入如下内容，

#ifndef AP3216C_H
#define AP3216C_H
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名		: ap3216creg.h
作者	  	: 左忠凯
版本	   	: V1.0
描述	   	: AP3216C寄存器地址描述头文件
其他	   	: 无
论坛 	   	: www.openedv.com
日志	   	: 初版V1.0 2019/9/2 左忠凯创建
***************************************************************/

#define AP3216C_ADDR    	0X1E	/* AP3216C器件地址  */

/* AP3316C寄存器 */
#define AP3216C_SYSTEMCONG	0x00	/* 配置寄存器       */
#define AP3216C_INTSTATUS	0X01	/* 中断状态寄存器   */
#define AP3216C_INTCLEAR	0X02	/* 中断清除寄存器   */
#define AP3216C_IRDATALOW	0x0A	/* IR数据低字节     */
#define AP3216C_IRDATAHIGH	0x0B	/* IR数据高字节     */
#define AP3216C_ALSDATALOW	0x0C	/* ALS数据低字节    */
#define AP3216C_ALSDATAHIGH	0X0D	/* ALS数据高字节    */
#define AP3216C_PSDATALOW	0X0E	/* PS数据低字节     */
#define AP3216C_PSDATAHIGH	0X0F	/* PS数据高字节     */

#endif

ap3216creg.h 没什么好讲的，就是一些寄存器宏定义。然后在ap3216c.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/i2c.h>
#include <asm/mach/map.h>
#include <asm/uaccess.h>
#include <asm/io.h>
#include "ap3216creg.h"
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名		: ap3216c.c
作者	  	: 左忠凯
版本	   	: V1.0
描述	   	: AP3216C驱动程序
其他	   	: 无
论坛 	   	: www.openedv.com
日志	   	: 初版V1.0 2019/9/2 左忠凯创建
***************************************************************/
#define AP3216C_CNT	1
#define AP3216C_NAME	"ap3216c"

struct ap3216c_dev {
	dev_t devid;			/* 设备号 	 */
	struct cdev cdev;		/* cdev 	*/
	struct class *class;	/* 类 		*/
	struct device *device;	/* 设备 	 */
	struct device_node	*nd; /* 设备节点 */
	int major;			/* 主设备号 */
	void *private_data;	/* 私有数据 */
	unsigned short ir, als, ps;		/* 三个光传感器数据 */
};

static struct ap3216c_dev ap3216cdev;

/*
 * @description	: 从ap3216c读取多个寄存器数据
 * @param - dev:  ap3216c设备
 * @param - reg:  要读取的寄存器首地址
 * @param - val:  读取到的数据
 * @param - len:  要读取的数据长度
 * @return 		: 操作结果
 */
static int ap3216c_read_regs(struct ap3216c_dev *dev, u8 reg, void *val, int len)
{
	int ret;
	struct i2c_msg msg[2];
	struct i2c_client *client = (struct i2c_client *)dev->private_data;

	/* msg[0]为发送要读取的首地址 */
	msg[0].addr = client->addr;			/* ap3216c地址 */
	msg[0].flags = 0;					/* 标记为发送数据 */
	msg[0].buf = &reg;					/* 读取的首地址 */
	msg[0].len = 1;						/* reg长度*/

	/* msg[1]读取数据 */
	msg[1].addr = client->addr;			/* ap3216c地址 */
	msg[1].flags = I2C_M_RD;			/* 标记为读取数据*/
	msg[1].buf = val;					/* 读取数据缓冲区 */
	msg[1].len = len;					/* 要读取的数据长度*/

	ret = i2c_transfer(client->adapter, msg, 2);
	if(ret == 2) {
		ret = 0;
	} else {
		printk("i2c rd failed=%d reg=%06x len=%d\n",ret, reg, len);
		ret = -EREMOTEIO;
	}
	return ret;
}

/*
 * @description	: 向ap3216c多个寄存器写入数据
 * @param - dev:  ap3216c设备
 * @param - reg:  要写入的寄存器首地址
 * @param - val:  要写入的数据缓冲区
 * @param - len:  要写入的数据长度
 * @return 	  :   操作结果
 */
static s32 ap3216c_write_regs(struct ap3216c_dev *dev, u8 reg, u8 *buf, u8 len)
{
	u8 b[256];
	struct i2c_msg msg;
	struct i2c_client *client = (struct i2c_client *)dev->private_data;
	
	b[0] = reg;					/* 寄存器首地址 */
	memcpy(&b[1],buf,len);		/* 将要写入的数据拷贝到数组b里面 */
		
	msg.addr = client->addr;	/* ap3216c地址 */
	msg.flags = 0;				/* 标记为写数据 */

	msg.buf = b;				/* 要写入的数据缓冲区 */
	msg.len = len + 1;			/* 要写入的数据长度 */

	return i2c_transfer(client->adapter, &msg, 1);
}

/*
 * @description	: 读取ap3216c指定寄存器值，读取一个寄存器
 * @param - dev:  ap3216c设备
 * @param - reg:  要读取的寄存器
 * @return 	  :   读取到的寄存器值
 */
static unsigned char ap3216c_read_reg(struct ap3216c_dev *dev, u8 reg)
{
	u8 data = 0;

	ap3216c_read_regs(dev, reg, &data, 1);
	return data;

#if 0
	struct i2c_client *client = (struct i2c_client *)dev->private_data;
	return i2c_smbus_read_byte_data(client, reg);
#endif
}

/*
 * @description	: 向ap3216c指定寄存器写入指定的值，写一个寄存器
 * @param - dev:  ap3216c设备
 * @param - reg:  要写的寄存器
 * @param - data: 要写入的值
 * @return   :    无
 */
static void ap3216c_write_reg(struct ap3216c_dev *dev, u8 reg, u8 data)
{
	u8 buf = 0;
	buf = data;
	ap3216c_write_regs(dev, reg, &buf, 1);
}

/*
 * @description	: 读取AP3216C的数据，读取原始数据，包括ALS,PS和IR, 注意！
 *				: 如果同时打开ALS,IR+PS的话两次数据读取的时间间隔要大于112.5ms
 * @param - ir	: ir数据
 * @param - ps 	: ps数据
 * @param - ps 	: als数据 
 * @return 		: 无。
 */
void ap3216c_readdata(struct ap3216c_dev *dev)
{
	unsigned char i =0;
    unsigned char buf[6];
	
	/* 循环读取所有传感器数据 */
    for(i = 0; i < 6; i++)	
    {
        buf[i] = ap3216c_read_reg(dev, AP3216C_IRDATALOW + i);	
    }

    if(buf[0] & 0X80) 	/* IR_OF位为1,则数据无效 */
		dev->ir = 0;					
	else 				/* 读取IR传感器的数据   		*/
		dev->ir = ((unsigned short)buf[1] << 2) | (buf[0] & 0X03); 			
	
	dev->als = ((unsigned short)buf[3] << 8) | buf[2];	/* 读取ALS传感器的数据 			 */  
	
    if(buf[4] & 0x40)	/* IR_OF位为1,则数据无效 			*/
		dev->ps = 0;    													
	else 				/* 读取PS传感器的数据    */
		dev->ps = ((unsigned short)(buf[5] & 0X3F) << 4) | (buf[4] & 0X0F); 
}

/*
 * @description		: 打开设备
 * @param - inode 	: 传递给驱动的inode
 * @param - filp 	: 设备文件，file结构体有个叫做private_data的成员变量
 * 					  一般在open的时候将private_data指向设备结构体。
 * @return 			: 0 成功;其他 失败
 */
static int ap3216c_open(struct inode *inode, struct file *filp)
{
	filp->private_data = &ap3216cdev;

	/* 初始化AP3216C */
	ap3216c_write_reg(&ap3216cdev, AP3216C_SYSTEMCONG, 0x04);		/* 复位AP3216C 			*/
	mdelay(50);														/* AP3216C复位最少10ms 	*/
	ap3216c_write_reg(&ap3216cdev, AP3216C_SYSTEMCONG, 0X03);		/* 开启ALS、PS+IR 		*/
	return 0;
}

/*
 * @description		: 从设备读取数据 
 * @param - filp 	: 要打开的设备文件(文件描述符)
 * @param - buf 	: 返回给用户空间的数据缓冲区
 * @param - cnt 	: 要读取的数据长度
 * @param - offt 	: 相对于文件首地址的偏移
 * @return 			: 读取的字节数，如果为负值，表示读取失败
 */
static ssize_t ap3216c_read(struct file *filp, char __user *buf, size_t cnt, loff_t *off)
{
	short data[3];
	long err = 0;

	struct ap3216c_dev *dev = (struct ap3216c_dev *)filp->private_data;
	
	ap3216c_readdata(dev);

	data[0] = dev->ir;
	data[1] = dev->als;
	data[2] = dev->ps;
	err = copy_to_user(buf, data, sizeof(data));
	return 0;
}

/*
 * @description		: 关闭/释放设备
 * @param - filp 	: 要关闭的设备文件(文件描述符)
 * @return 			: 0 成功;其他 失败
 */
static int ap3216c_release(struct inode *inode, struct file *filp)
{
	return 0;
}

/* AP3216C操作函数 */
static const struct file_operations ap3216c_ops = {
	.owner = THIS_MODULE,
	.open = ap3216c_open,
	.read = ap3216c_read,
	.release = ap3216c_release,
};

 /*
  * @description     : i2c驱动的probe函数，当驱动与
  *                    设备匹配以后此函数就会执行
  * @param - client  : i2c设备
  * @param - id      : i2c设备ID
  * @return          : 0，成功;其他负值,失败
  */
static int ap3216c_probe(struct i2c_client *client, const struct i2c_device_id *id)
{
	/* 1、构建设备号 */
	if (ap3216cdev.major) {
		ap3216cdev.devid = MKDEV(ap3216cdev.major, 0);
		register_chrdev_region(ap3216cdev.devid, AP3216C_CNT, AP3216C_NAME);
	} else {
		alloc_chrdev_region(&ap3216cdev.devid, 0, AP3216C_CNT, AP3216C_NAME);
		ap3216cdev.major = MAJOR(ap3216cdev.devid);
	}

	/* 2、注册设备 */
	cdev_init(&ap3216cdev.cdev, &ap3216c_ops);
	cdev_add(&ap3216cdev.cdev, ap3216cdev.devid, AP3216C_CNT);

	/* 3、创建类 */
	ap3216cdev.class = class_create(THIS_MODULE, AP3216C_NAME);
	if (IS_ERR(ap3216cdev.class)) {
		return PTR_ERR(ap3216cdev.class);
	}

	/* 4、创建设备 */
	ap3216cdev.device = device_create(ap3216cdev.class, NULL, ap3216cdev.devid, NULL, AP3216C_NAME);
	if (IS_ERR(ap3216cdev.device)) {
		return PTR_ERR(ap3216cdev.device);
	}

	ap3216cdev.private_data = client;

	return 0;
}

/*
 * @description     : i2c驱动的remove函数，移除i2c驱动的时候此函数会执行
 * @param - client 	: i2c设备
 * @return          : 0，成功;其他负值,失败
 */
static int ap3216c_remove(struct i2c_client *client)
{
	/* 删除设备 */
	cdev_del(&ap3216cdev.cdev);
	unregister_chrdev_region(ap3216cdev.devid, AP3216C_CNT);

	/* 注销掉类和设备 */
	device_destroy(ap3216cdev.class, ap3216cdev.devid);
	class_destroy(ap3216cdev.class);
	return 0;
}

/* 传统匹配方式ID列表 */
static const struct i2c_device_id ap3216c_id[] = {
	{"alientek,ap3216c", 0},  
	{}
};

/* 设备树匹配列表 */
static const struct of_device_id ap3216c_of_match[] = {
	{ .compatible = "alientek,ap3216c" },
	{ /* Sentinel */ }
};

/* i2c驱动结构体 */	
static struct i2c_driver ap3216c_driver = {
	.probe = ap3216c_probe,
	.remove = ap3216c_remove,
	.driver = {
			.owner = THIS_MODULE,
		   	.name = "ap3216c",
		   	.of_match_table = ap3216c_of_match, 
		   },
	.id_table = ap3216c_id,
};
		   
/*
 * @description	: 驱动入口函数
 * @param 		: 无
 * @return 		: 无
 */
static int __init ap3216c_init(void)
{
	int ret = 0;

	ret = i2c_add_driver(&ap3216c_driver);
	return ret;
}

/*
 * @description	: 驱动出口函数
 * @param 		: 无
 * @return 		: 无
 */
static void __exit ap3216c_exit(void)
{
	i2c_del_driver(&ap3216c_driver);
}

/* module_i2c_driver(ap3216c_driver) */

module_init(ap3216c_init);
module_exit(ap3216c_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("zuozhongkai");

第32~41 行，ap3216c 设备结构体，第39 行的private_data 成员变量用于存放ap3216c 对应的i2c_client。第40 行的ir、als 和ps 分别存储AP3216C 的IR、ALS 和PS 数据。
第43 行，定义一个ap3216c_dev 类型的设备结构体变量ap3216cdev。
第53~79 行，ap3216c_read_regs 函数实现多字节读取，但是AP3216C 好像不支持连续多字节读取，此函数在测试其他I2C 设备的时候可以实现多给字节连续读取，但是在AP3216C 上不能连续读取多个字节。不过读取一个字节没有问题的。
第89~105 行，ap3216c_write_regs 函数实现连续多字节写操作。

第113~124 行，ap3216c_read_reg 函数用于读取AP3216C 的指定寄存器数据，用于一个寄存器的数据读取。
第133~138 行，ap3216c_write_reg 函数用于向AP3216C 的指定寄存器写入数据，用于一个寄存器的数据写操作。
第148~170 行，读取AP3216C 的PS、ALS 和IR 等传感器原始数据值。
第179~230 行，标准的字符设备驱动框架。
第239~269 行，ap3216c_probe 函数，当I2C 设备和驱动匹配成功以后此函数就会执行，和platform 驱动框架一样。此函数前面都是标准的字符设备注册代码，最后面会将此函数的第一个参数client 传递给ap3216cdev 的private_data 成员变量。
第289~292 行，ap3216c_id 匹配表，i2c_device_id 类型。用于传统的设备和驱动匹配，也就是没有使用设备树的时候。
第295~298 行，ap3216c_of_match 匹配表，of_device_id 类型，用于设备树设备和驱动匹配。这里只写了一个compatible 属性，值为“alientek,ap3216c”。
第301~310 行，ap3216c_driver 结构体变量，i2c_driver 类型。
第317~323 行，驱动入口函数ap3216c_init，此函数通过调用i2c_add_driver 来向Linux 内核注册i2c_driver，也就是ap3216c_driver。
第330~333 行，驱动出口函数ap3216c_exit，此函数通过调用i2c_del_driver 来注销掉前面注册的ap3216c_driver。

编写测试APP

新建ap3216cApp.c 文件，然后在里面输入如下所示内容：

#include "stdio.h"
#include "unistd.h"
#include "sys/types.h"
#include "sys/stat.h"
#include "sys/ioctl.h"
#include "fcntl.h"
#include "stdlib.h"
#include "string.h"
#include <poll.h>
#include <sys/select.h>
#include <sys/time.h>
#include <signal.h>
#include <fcntl.h>
/***************************************************************
Copyright © ALIENTEK Co., Ltd. 1998-2029. All rights reserved.
文件名		: ap3216cApp.c
作者	  	: 左忠凯
版本	   	: V1.0
描述	   	: ap3216c设备测试APP。
其他	   	: 无
使用方法	 ：./ap3216cApp /dev/ap3216c
论坛 	   	: www.openedv.com
日志	   	: 初版V1.0 2019/9/20 左忠凯创建
***************************************************************/

/*
 * @description		: main主程序
 * @param - argc 	: argv数组元素个数
 * @param - argv 	: 具体参数
 * @return 			: 0 成功;其他 失败
 */
int main(int argc, char *argv[])
{
	int fd;
	char *filename;
	unsigned short databuf[3];
	unsigned short ir, als, ps;
	int ret = 0;

	if (argc != 2) {
		printf("Error Usage!\r\n");
		return -1;
	}

	filename = argv[1];
	fd = open(filename, O_RDWR);
	if(fd < 0) {
		printf("can't open file %s\r\n", filename);
		return -1;
	}

	while (1) {
		ret = read(fd, databuf, sizeof(databuf));
		if(ret == 0) { 			/* 数据读取成功 */
			ir =  databuf[0]; 	/* ir传感器数据 */
			als = databuf[1]; 	/* als传感器数据 */
			ps =  databuf[2]; 	/* ps传感器数据 */
			printf("ir = %d, als = %d, ps = %d\r\n", ir, als, ps);
		}
		usleep(200000); /*100ms */
	}
	close(fd);	/* 关闭文件 */	
	return 0;
}

ap3216cApp.c 文件内容很简单，就是在while 循环中不断的读取AP3216C 的设备文件，从而得到ir、als 和ps 这三个数据值，然后将其输出到终端上。

运行测试

编译驱动程序和测试APP

1、编译驱动程序
编写Makefile 文件，本章实验的Makefile 文件和第四十章实验基本一样，只是将obj-m 变量的值改为“ap3216c.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 := ap3216c.o

build: kernel_modules

kernel_modules:
	$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) modules

clean:
	$(MAKE) -C $(KERNELDIR) M=$(CURRENT_PATH) clean

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

make -j32

编译成功以后就会生成一个名为“ap3216c.ko”的驱动模块文件。

2、编译测试APP
输入如下命令编译ap3216cApp.c 这个测试程序：

arm-linux-gnueabihf-gcc ap3216cApp.c -o ap3216cApp

编译成功以后就会生成ap3216cApp 这个应用程序。

运行测试

将上一小节编译出来ap3216c.ko 和ap3216cApp 这两个文件拷贝到rootfs/lib/modules/4.1.15目录中，重启开发板，进入到目录lib/modules/4.1.15 中。输入如下命令加载ap3216c.ko 这个驱动模块。

depmod //第一次加载驱动的时候需要运行此命令
modprobe ap3216c.ko //加载驱动模块

当驱动模块加载成功以后使用ap3216cApp 来测试，输入如下命令：

./ap3216cApp /dev/ap3216c

测试APP 会不断的从AP3216C 中读取数据，然后输出到终端上，如图61.6.2.1 所示：

大家可以用手电筒照一下AP3216C，或者手指靠近AP3216C 来观察传感器数据有没有变化。