Linux I2C 驱动实验

目录

1 Linux I2C 驱动框架简介  

2 I2C总线驱动

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

4 I2C 设备驱动

1 Linux I2C 驱动框架简介  

Linux 的驱动分离与分层的思想，因此 Linux 内核也将 I2C 驱动分为两部分：

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

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

2 I2C总线驱动

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适配器编写人员实现。

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 适配器。

返回值： 无。

一般 SOC 的 I2C 总线驱动都是由半 导体厂商编写的，比如 I.MX6U 的 I2C 适配器驱动 NXP 已经编写好了，这个不需要用户去编写。因此 I2C 总线驱动对我们这些 SOC 使用者来说是被屏蔽的，我们只要专注于 I2C 设备驱动即可。

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

在 imx6ull.dtsi 文件中找到 I.MX6U 的 I2C1 控制器节点，节点内容如下所示：

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

重点关注 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,
IMX_I2C_I2SR);
1052
1053 /* Add I2C adapter */
1054 ret = i2c_add_numbered_adapter(&i2c_imx->adapter);
1055 if (ret < 0) {
1056 dev_err(&pdev->dev, "registration failed\n");
1057 goto clk_disable;
1058 }
1059
1060 /* Set up platform driver data */
1061 platform_set_drvdata(pdev, i2c_imx);
1062 clk_disable_unprepare(i2c_imx->clk);
......
1070 /* Init DMA config if supported */
1071 i2c_imx_dma_request(i2c_imx, phy_addr);
1072
1073 return 0; /* Return OK */
1074
1075 clk_disable:
1076 clk_disable_unprepare(i2c_imx->clk);
1077 return ret;
1078 }

struct imx_i2c_struct {
	struct i2c_adapter	adapter;
	struct clk		*clk;
	void __iomem		*base;
	wait_queue_head_t	queue;
	unsigned long		i2csr;
	unsigned int		disable_delay;
	int			stopped;
	unsigned int		ifdr; /* IMX_I2C_IFDR */
	unsigned int		cur_clk;
	unsigned int		bitrate;
	const struct imx_i2c_hwdata	*hwdata;

	struct imx_i2c_dma	*dma;
};

第 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 };

4 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。

i2c_client：表示I2C设备，不需要我们自己创建i2c_client，我们一般在设备树里面添加具体的I2C芯片，比如fxls8471，系统在解析设备树的时候就会知道有这个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 。

返回值： 无。