Linux--IIC驱动编程实验

对于 I2C 主机驱动，一旦编写完成就不需要再做修改，其他的 I2C 设备直接调用主机驱动提供的 API 函数完成读写操作即可。这个正好符合 Linux 的驱动分离与分层的思想，因此 Linux内核也将 I2C 驱动分为两部分：

①、 I2C 总线驱动， I2C 总线驱动就是 SOC 的 I2C 控制器驱动，也叫做 I2C 适配器驱动。

②、 I2C 设备驱动， I2C 设备驱动就是针对具体的 I2C 设备而编写的驱动。

总的来说，IIC的驱动分为IIC控制器（主机）的驱动和IIC设备驱动（从机），一般控制器的驱动芯片原厂已经写好，我们要做的就是根据自己要用的IIC设备写设备驱动。

一、I2C 设备驱动

I2C 设备驱动重点关注两个数据结构： i2c_client 和 i2c_driver ，根据总线、设备和驱动模型。还剩下设备和驱动， i2c_client 就是描述设备信息的， i2c_driver 描述驱动内容，类似于platform_driver。

1.1 i2c_client 结构体

i2c_client 结构体定义在 include/linux/i2c.h 文件中，内容如下：

一个设备对应一个 i2c_client ，每检测到一个 I2C 设备就会给这个 I2C 设备分配一个i2c_client。

1.2 i2c_driver 结构体

i2c_driver 类似 platform_driver ，是我们编写 I2C 设备驱动重点要处理的内容， i2c_driver 结构体定义在 include/linux/i2c.h 文件中，内容如下：

示例代码 61.1.2.2 i2c_driver 结构体
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) 属性。

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

二、I2C设备驱动编写流程

2.1 I2C 设备信息描述，此处主要叙述使用设备树的时候

使用设备树的时候 I2C 设备信息通过创建相应的节点就行了，比如 NXP 官方的 EVK 开发板在 I2C1 上接了 mag3110 这个磁力计芯片，因此必须在 i2c1 节点下创建 mag3110 子节点，然后在这个子节点内描述 mag3110 这个芯片的相关信息。

示例代码 61.3.1.4 mag3110 子节点
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 属性的设置，一个用于匹配驱动，一个用于设置器件地址。

2.2 I2C 设备数据收发处理流程

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_transfer 函数发送数据之前要先构建好 i2c_msg

三、实验程序编写(以AP3216C为例)

3.1 修改设备树

IO 修改或添加（配置要用到的总线的IO口）

首先肯定是要修改 IO ， AP3216C 用到了 I2C1 接口， I.MX6U-ALPHA 开发板上的 I2C1 接口使用到了 UART4_TXD 和 UART4_RXD

示例代码 61.5.1.1 pinctrl_i2c1 子节点
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 };