1）实验平台：正点原子Linux开发板

2）摘自《正点原子I.MX6U嵌入式Linux驱动开发指南》

关注官方微信号公众号，获取更多资料：正点原子

第六十一章Linux I2C驱动实验

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

61.1 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设备而编写的驱动。

61.1.1 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文件中，结构体内容如下：

示例代码61.1.1.1 i2c_adapter结构体

498struct i2c_adapter {

499struct module *owner;

500unsignedint class;/* classes to allow probing for */

501conststruct i2c_algorithm *algo;/* 总线访问算法 */

502void*algo_data;

503

504/* data fields that are valid for all devices */

505struct rt_mutex bus_lock;

506

507int timeout;/* in jiffies */

508int retries;

509struct device dev;/* the adapter device */

510

511int nr;

512char name[48];

513struct completion dev_released;

514

515struct mutex userspace_clients_lock;

516struct list_head userspace_clients;

517

518struct i2c_bus_recovery_info *bus_recovery_info;

519conststruct i2c_adapter_quirks *quirks;

520};

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

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

示例代码61.1.1.2 i2c_algorithm结构体

391struct i2c_algorithm {

......

398int(*master_xfer)(struct i2c_adapter *adap,

struct i2c_msg *msgs,

399int num);

400int(*smbus_xfer)(struct i2c_adapter *adap, u16 addr,

401unsignedshort 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适配器驱动。

61.1.2 I2C设备驱动

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

1、i2c_client结构体

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

示例代码61.1.2.1 i2c_client结构体

217struct i2c_client {

218unsignedshort flags; /* 标志 */

219unsignedshort addr; /* 芯片地址，7位，存在低7位 */

......

222char name[I2C_NAME_SIZE]; /* 名字 */

223struct i2c_adapter *adapter; /* 对应的I2C适配器 */

224struct device dev; /* 设备结构体 */

225int irq; /* 中断 */

226struct list_head detected;

......

230};

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

2、i2c_driver结构体

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

示例代码61.1.2.2 i2c_driver结构体

161struct i2c_driver {

162unsignedint 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 */

167int(*attach_adapter)(struct i2c_adapter *) __deprecated;

168

169/* Standard driver model interfaces */

170int(*probe)(struct i2c_client *,conststruct i2c_device_id *);

171int(*remove)(struct i2c_client *);

172

173/* driver model interfaces that don&39;t relate to enumeration */

174void(*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&39;s low bit (&34;event

180 flag&34;). */

181void(*alert)(struct i2c_client *,unsignedint data);

182

183/* a ioctl like command that can be used to perform specific

184 * functions with the device.

185 */

186int(*command)(struct i2c_client *client,unsignedint cmd,

void*arg);

187

188struct device_driver driver;

189conststruct i2c_device_id *id_table;

190

191/* Device detection callback for automatic device creation */

192int(*detect)(struct i2c_client *,struct i2c_board_info *);

193constunsignedshort*address_list;

194struct 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是一个宏，定义如下：

示例代码61.1.2.3 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的注册示例代码如下：

示例代码61.1.2.4 i2c_driver注册流程

1 /* i2c驱动的probe函数 */

2staticint xxx_probe(struct i2c_client *client,

conststruct i2c_device_id *id)

3{

4 /* 函数具体程序 */

5 return0;

6}

7

8/* i2c驱动的remove函数 */

9staticint ap3216c_remove(struct i2c_client *client)

10{

11 /* 函数具体程序 */

12 return0;

13}

14

15/* 传统匹配方式ID列表 */

16staticconststruct i2c_device_id xxx_id[]={

17 {&34;xxx&34;,0},

18 {}

19};

20

21/* 设备树匹配列表 */

22staticconststruct of_device_id xxx_of_match[]={

23 {.compatible =&34;xxx&34;},

24 {/* Sentinel */}

25};

26

27/* i2c驱动结构体 */

28staticstruct i2c_driver xxx_driver ={

29 .probe = xxx_probe,

30 .remove = xxx_remove,

31 .driver ={

32 .owner = THIS_MODULE,

33 .name =&34;xxx&34;,

34 .of_match_table = xxx_of_match,

35 },

36 .id_table = xxx_id,

37 };

38

39/* 驱动入口函数 */

40staticint __init xxx_init(void)

41{

42 int ret =0;

43

44 ret = i2c_add_driver(&xxx_driver);

45 return ret;

46}

47

48/* 驱动出口函数 */

49staticvoid __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函数里面基本就是标准的字符设备驱动那一套了。

61.1.3 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内容如下：

示例代码61.1.2.5 i2c_bus_type总线

736struct bus_type i2c_bus_type ={

737.name =&34;i2c&34;,

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这个函数，此函数内容如下：

示例代码61.1.2.6 i2c_device_match函数

457staticint i2c_device_match(struct device *dev,struct device_driver *drv)

458{

459struct i2c_client *client = i2c_verify_client(dev);

460struct i2c_driver *driver;

461

462if(!client)

463return0;

464

465/* Attempt an OF style match */

466if(of_driver_match_device(dev, drv))

467return1;

468

469/* Then ACPI style match */

470if(acpi_driver_match_device(dev, drv))

471return1;

472

473 driver = to_i2c_driver(drv);

474/* match on an id table if there is one */

475if(driver->id_table)

476return i2c_match_id(driver->id_table, client)!=NULL;

477

478return0;

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设备和驱动匹配。

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

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

示例代码61.2.1 I2C1控制器节点

1 i2c1: i2c@021a0000 {

2 address-cells =<1>;

3 size-cells =<0>;

4 compatible =&34;fsl,imx6ul-i2c&34;,&34;fsl,imx21-i2c&34;;

5 reg =<0x021a00000x4000>;

6 interrupts =<GIC_SPI 36 IRQ_TYPE_LEVEL_HIGH>;

7 clocks =<&clks IMX6UL_CLK_I2C1>;

8 status =&34;disabled&34;;

9};

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

示例代码61.2.2 i2c-imx.c文件代码段

244staticstruct platform_device_id imx_i2c_devtype[]={

245{

246.name =&34;imx1-i2c&34;,

247.driver_data =(kernel_ulong_t)&imx1_i2c_hwdata,

248},{

249.name =&34;imx21-i2c&34;,

250.driver_data =(kernel_ulong_t)&imx21_i2c_hwdata,

251},{

252/* sentinel */

253}

254};

255 MODULE_DEVICE_TABLE(platform, imx_i2c_devtype);

256

257staticconststruct of_device_id i2c_imx_dt_ids[]={

258{.compatible =&34;fsl,imx1-i2c&34;,.data =&imx1_i2c_hwdata,},

259{.compatible =&34;fsl,imx21-i2c&34;,.data =&imx21_i2c_hwdata,},

260{.compatible =&34;fsl,vf610-i2c&34;,.data =&vf610_i2c_hwdata,},

261{/* sentinel */}

262};

263 MODULE_DEVICE_TABLE(of, i2c_imx_dt_ids);

......

1119staticstruct 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

1131staticint __init i2c_adap_imx_init(void)

1132{

1133return platform_driver_register(&i2c_imx_driver);

1134}

1135 subsys_initcall(i2c_adap_imx_init);

1136

1137staticvoid __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行，&34;fsl,imx21-i2c&34;属性值，设备树中 i2c1节点的compatible属性值就是与此匹配上的。因此i2c-imx.c文件就是I.MX6U的I2C适配器驱动文件。

第1120行，当设备和驱动匹配成功以后i2c_imx_probe函数就会执行，i2c_imx_probe函数就会完成I2C适配器初始化工作。

i2c_imx_probe函数内容如下所示(有省略)：

示例代码61.2.3 i2c_imx_probe函数代码段

971staticint i2c_imx_probe(struct platform_device *pdev)

972{

973conststruct of_device_id *of_id =

974 of_match_device(i2c_imx_dt_ids,&pdev->dev);

975struct imx_i2c_struct *i2c_imx;

976struct resource *res;

977struct imxi2c_platform_data *pdata =

dev_get_platdata(&pdev->dev);

978void __iomem *base;

979int irq, ret;

980 dma_addr_t phy_addr;

981

982 dev_dbg(&pdev->dev,&34;<%s>\n&34;, __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);

992if(IS_ERR(base))

993return PTR_ERR(base);

994

995 phy_addr =(dma_addr_t)res->start;

996 i2c_imx = devm_kzalloc(&pdev->dev,sizeof(*i2c_imx),

GFP_KERNEL);

997if(!i2c_imx)

998return-ENOMEM;

999

1000if(of_id)

1001 i2c_imx->hwdata = of_id->data;

1002else

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&34;clock-frequency&34;,&i2c_imx->bitrate);

1045if(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);

1055if(ret <0){

1056 dev_err(&pdev->dev,&34;registration failed\n&34;);

1057goto 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

1073return0;/* Return OK */

1074

1075 clk_disable:

1076 clk_disable_unprepare(i2c_imx->clk);

1077return ret;

1078}

第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，如果设备树节点设置了&34;clock-frequency&34;属性的话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结构体定义如下：

示例代码61.2.4 i2c_imx_algo结构体

966staticstruct 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函数内容如下：

示例代码61.2.5 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设备通信的，此函数内容如下(有省略)：

示例代码61.2.6 i2c_imx_xfer函数

888staticint i2c_imx_xfer(struct i2c_adapter *adapter,

889struct i2c_msg *msgs,int num)

890{

891unsignedint i, temp;

892int result;

893bool is_lastmsg = false;

894struct imx_i2c_struct *i2c_imx = i2c_get_adapdata(adapter);

895

896 dev_dbg(&i2c_imx->adapter.dev,&34;<%s>\n&34;, __func__);

897

898/* Start I2C transfer */

899 result = i2c_imx_start(i2c_imx);

900if(result)

901goto fail0;

902

903/* read/write data */

904for(i =0; i < num; i++){

905if(i == num -1)

906 is_lastmsg = true;

907

908if(i){

909 dev_dbg(&i2c_imx->adapter.dev,

910&34;<%s> repeated start\n&34;, __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);

915if(result)

916goto fail0;

917}

918 dev_dbg(&i2c_imx->adapter.dev,

919&34;<%s> transfer message: %d\n&34;, __func__, i);

920/* write/read data */

......

938if(msgs[i].flags & I2C_M_RD)

939 result = i2c_imx_read(i2c_imx,&msgs[i], is_lastmsg);

940else{

941if(i2c_imx->dma && msgs[i].len >= DMA_THRESHOLD)

942 result = i2c_imx_dma_write(i2c_imx,&msgs[i]);

943else

944 result = i2c_imx_write(i2c_imx,&msgs[i]);

945}

946if(result)

947goto fail0;

948}

949

950 fail0:

951/* Stop I2C transfer */

952 i2c_imx_stop(i2c_imx);

953

954 dev_dbg(&i2c_imx->adapter.dev,&34;<%s> exit with: %s: %d\n&34;, __func__,

955(result <0)?&34;error&34;:&34;success msg&34;,

956(result <0)? result : num);

957return(result <0)? result : num;

958}

第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驱动一样，这里我们就不详细的分析了，大家可以对照着第二十六章实验自行分析。

61.3 I2C设备驱动编写流程

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

61.3.1 I2C设备信息描述

1、未使用设备树的时候

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

示例代码61.3.1.1 i2c_board_info结构体

295struct i2c_board_info {

296char type[I2C_NAME_SIZE]; /* I2C设备名字 */

297unsignedshort flags; /* 标志 */

298unsignedshort addr; /* I2C器件地址 */

299void*platform_data;

300struct dev_archdata *archdata;

301struct device_node *of_node;

302struct fwnode_handle *fwnode;

303int irq;

304};

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

示例代码61.3.1.2 OV2640的I2C设备信息

392staticstruct i2c_board_info mx27_3ds_i2c_camera ={

393 I2C_BOARD_INFO(&34;ov2640&34;,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这个设备树文件，然后找到如下内容：

示例代码61.3.1.4 mag3110子节点

1&i2c1 {

2 clock-frequency =<100000>;

3 pinctrl-names =&34;default&34;;

4 pinctrl-0=<&pinctrl_i2c1>;

5 status =&34;okay&34;;

6

7 mag3110@0e {

8 compatible =&34;fsl,mag3110&34;;

9 reg =<0x0e>;

10 position =<2>;

11};

......

20};

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