i2c的设备树是如何匹配以及何时调用probe的

 

一、粉丝提问

i2c的设备树和驱动是如何匹配以及何时调用probe的？粉丝手里的I2C外设是ov5640，一个摄像头。粉丝提问，一口君必须安排。

 

二、问题分析

设备树信息如下：

ov5640： ov5640＠3c ｛
 compatible ＝ ＂ovti，ov5640＂；
 reg ＝ ＜0x3c＞；
 pinctrl－names ＝ ＂default＂；
 pinctrl－0 ＝ ＜＆pinctrl＿csi1
                            ＆csi＿pwn＿rst＞；
 clocks ＝ ＜＆clks IMX6UL＿CLK＿CSI＞；
 clock－names ＝ ＂csi＿mclk＂；
 pwn－gpios ＝ ＜＆gpio1 4 1＞；
 rst－gpios ＝ ＜＆gpio1 2 0＞；
 csi＿id ＝ ＜0＞；
 mclk ＝ ＜24000000＞；
 mclk＿source ＝ ＜0＞；
 status ＝ ＂okay＂；
 port ｛
  ov5640＿ep： endpoint ｛
   remote－endpoint ＝ ＜＆csi1＿ep＞；
  ｝；
 ｝；
｝；

驱动最重要的结构体如下：

 

ov5640＿i2c＿driver

要搞懂这个问题，我们需要有一些基础知识：

1．内核如何维护i2c总线

Linux内核维护很多总线，platform、usb、i2c、spi、pci等等，这个总线的架构在内核中都支持的很完善，内核通过以下结构体来维护总线：

struct bus＿type ｛
const char  ＊name；
const char  ＊dev＿name；
struct device  ＊dev＿root；
struct device＿attribute ＊dev＿attrs；  use dev＿groups instead
const struct attribute＿group ＊＊bus＿groups；
const struct attribute＿group ＊＊dev＿groups；
const struct attribute＿group ＊＊drv＿groups；
int （＊match）（struct device ＊dev， struct device＿driver ＊drv）；
int （＊uevent）（struct device ＊dev， struct kobj＿uevent＿env ＊env）；
int （＊probe）（struct device ＊dev）；
int （＊remove）（struct device ＊dev）；
void （＊shutdown）（struct device ＊dev）；
int （＊online）（struct device ＊dev）；
int （＊offline）（struct device ＊dev）；
int （＊suspend）（struct device ＊dev， pm＿message＿t state）；
int （＊resume）（struct device ＊dev）；
const struct dev＿pm＿ops ＊pm；
struct iommu＿ops ＊iommu＿ops；
struct subsys＿private ＊p；
struct lock＿class＿key lock＿key；
｝；

i2c对应总线结构体变量为i2c＿bus＿type，定义如下：

drivers／i2c／I2c－core．c
struct bus＿type i2c＿bus＿type ＝ ｛
．name  ＝ ＂i2c＂，
．match  ＝ i2c＿device＿match，
．probe  ＝ i2c＿device＿probe，
．remove  ＝ i2c＿device＿remove，
．shutdown ＝ i2c＿device＿shutdown，
．pm  ＝ ＆i2c＿device＿pm＿ops，
｝；

其中：

i2c＿device＿match（），匹配总线维护的驱动链表和设备信息链表，如果其中名字完全相同，则返回true，否则false；i2c＿device＿probe（），当我们注册一个i2c＿drive或者i2c＿client结构体时，会从对应的链表中查找节点，并通过i2c＿device＿match函数比较，如果匹配成功，则调用i2c＿drive中定义的probe函数，即ov5640的ov5640＿probe（）函数；remove：如果卸载i2c＿drive或者i2c＿client结构体，会调用该函数卸载对应的资源；shutdown、pm是电源管理的接口，在此不讨论。

该结构体变量在函数i2c＿init（）中初始化：

static int ＿＿init i2c＿init（void）
｛
…………
retval ＝ bus＿register（＆i2c＿bus＿type）；
…………
｝

i2c架构是通用架构，可支持多种不同的i2c控制器驱动。

2． i2c架构如何如何管理硬件信息和驱动？

不论哪一种总线，一定会维护两个链表，一个是驱动链表，一个是硬件信息链表。链表如下：

 

i2c总线的两个节点信息如下：

「struct i2c＿driver」

struct i2c＿driver ｛
unsigned int class；
 Notifies the driver that a new bus has appeared． You should avoid
 ＊ using this， it will be removed in a near future．
 
int （＊attach＿adapter）（struct i2c＿adapter ＊） ＿＿deprecated；
 Standard driver model interfaces
int （＊probe）（struct i2c＿client ＊， const struct i2c＿device＿id ＊）；
int （＊remove）（struct i2c＿client ＊）；
 driver model interfaces that don＇t relate to enumeration  
void （＊shutdown）（struct i2c＿client ＊）；
int （＊suspend）（struct i2c＿client ＊， pm＿message＿t mesg）；
int （＊resume）（struct i2c＿client ＊）；
 Alert callback， for example for the SMBus alert protocol．
 ＊ The format and meaning of the data value depends on the protocol．
 ＊ For the SMBus alert protocol， there is a single bit of data passed
 ＊ as the alert response＇s low bit （＂event flag＂）．
 
void （＊alert）（struct i2c＿client ＊， unsigned int data）；
 a ioctl like command that can be used to perform specific functions
 ＊ with the device．
 
int （＊command）（struct i2c＿client ＊client， unsigned int cmd， void ＊arg）；
struct device＿driver driver；
const struct i2c＿device＿id ＊id＿table；
 Device detection callback for automatic device creation
int （＊detect）（struct i2c＿client ＊， struct i2c＿board＿info ＊）；
const unsigned short ＊address＿list；
struct list＿head clients；
｝；
当总线匹配驱动和硬件信息成功后就会调用其中的probe（）函数；struct device＿driver driver，内核中注册的驱动模块，必须包含该类型的结构体成员。

「struct i2c＿client」

成员含义unsigned short flags从设备地址长度unsigned short addr从设备地址char name［I2C＿NAME＿SIZE］从设备地址名称struct i2c＿adapter ＊adapter从设备地址对应的控制器驱动地址struct device dev注册到内核的每一个设备模块都需要先定义一个该结构体变量，对应struct device＿driver driverint irq从设备地址往往会有一根中断线连接到SOC的中断控制器struct list＿head detected链表3． i2c＿driver和i2c＿client1） i2c＿driver如何注册

i2c＿driver结构需要我们自己定义，然后通过函数i2c＿register＿driver（）注册，将该结构体变量注册到i2c＿driver链表，同时从i2c＿client链表中查找是否有匹配的节点：

设备树情况下，会比较i2c＿drive－＞driver－＞of＿match＿table－＞compatible和i2c＿client－＞name，对应例子中的of＿ov5640＿id：

 

非设备树比较i2c＿drive－＞id＿table－＞name和i2c＿client－＞name，对应例子中的ov5640＿id：

 

代码中并没有直接调用函数i2c＿register＿driver（）注册，而是使用了下面的这个宏：

 

该宏定义如下：

include／linux／I2c．h

 

 

该宏其实自动帮我生成了insmod和rmmod会用到宏module＿init和module＿exit，以及注册和注销i2c＿driver结构体的代码。

如果看不明白宏，可以编写测试文件：test．c

＃define module＿i2c＿driver（＿＿i2c＿driver）
module＿driver（＿＿i2c＿driver， i2c＿add＿driver，
  i2c＿del＿driver）
 
＃define module＿driver（＿＿driver， ＿＿register， ＿＿unregister， ．．．）
static int ＿＿init ＿＿driver＃＃＿init（void）
｛
return ＿＿register（＆（＿＿driver） ， ＃＃＿＿VA＿ARGS＿＿）；
｝
module＿init（＿＿driver＃＃＿init）；
static void ＿＿exit ＿＿driver＃＃＿exit（void）
｛
＿＿unregister（＆（＿＿driver） ， ＃＃＿＿VA＿ARGS＿＿）；
｝
module＿exit（＿＿driver＃＃＿exit）；
module＿i2c＿drive（ov5640＿i2c＿driver）；

预编译：

gcc －E test．c

得到宏替换后的结果：

static int ＿＿init ov5640＿i2c＿driver＿init（void）
｛
 return i2c＿add＿driver（＆（ov5640＿i2c＿driver））；
｝
module＿init（ov5640＿i2c＿driver＿init）；
static void ＿＿exit ov5640＿i2c＿driver＿exit（void）
｛
i2c＿del＿driver（＆（ov5640＿i2c＿driver））；
｝
module＿exit（ov5640＿i2c＿driver＿exit）；；

内核中有大量的高效简洁的宏定义，Linux内核就是个宝库，里面有大量的优秀的代码，想提高自己的编程能力，就一定要多看代码，代码读百遍，其义自见。

一口君认为，如果Linux代码都看不太明白，就不要自称精通C语言，充其量是会用C语言。

2）i2c＿client如何生成（只讨论有设备树的情况）

在有设备树的情况下，i2c＿client的生成是要在控制器驱动adapter注册情况下从设备树中枚举出来的。

i2c控制器有很多种，不同的厂家都会设计自己特有的i2c控制器，但是不论哪一个控制器，最终都会调用i2c＿register＿adapter（）注册控制器驱动。

i2c＿client生成流程如下：

 

i2c＿client三、 i2c的设备树和驱动是如何匹配以及何时调用probe？1．  i2c的设备树和驱动是如何match，何时调用probe？

从第二章第3节可知，驱动程序中 module＿i2c＿drive（）这个宏其实最终是调用 i2c＿add＿driver（＆（ov5640＿i2c＿driver））；注册ov5640＿i2c＿driver结构体；当我们insmod加载驱动模块文件时，会调用i2c＿add＿driver（）。

该函数定义如下：

＃define i2c＿add＿driver（driver）
i2c＿register＿driver（THIS＿MODULE， driver）

下面我们来追踪i2c＿register＿driver（）这个函数：

 

其中drv－＞bus就是我们之前所说的i2c＿bus＿type，上图中，分别调用了．match、．probe：

struct bus＿type i2c＿bus＿type ＝ ｛
．name  ＝ ＂i2c＂，
．match  ＝ i2c＿device＿match，
．probe  ＝ i2c＿device＿probe，
．remove  ＝ i2c＿device＿remove，
．shutdown ＝ i2c＿device＿shutdown，
．pm  ＝ ＆i2c＿device＿pm＿ops，
｝；

下面我们来追一追这两个函数

2． i2c＿device＿match（）

 

i2c＿device＿match3． i2c＿device＿probe

如下图所示，通过driver－＞probe（）调用到我们定义的struct i2c＿driver ov5640＿i2c＿driver结构体变量中的ov5640＿probe（）函数：

 

i2c＿device＿probe

【注意】内核代码中大量使用到driver ＝ to＿i2c＿driver（dev－＞driver）；通过通用的结构体变量成员struct device＿driver ＊driver来查找自己注册的xx＿driver地址。

审核编辑：符乾江