linux驅動中i2c驅動架構
![]()
上圖完整的描述了Linux i2c驅動架構，雖然I2C硬件體系結構比較簡單，但是i2c體系結構在linux中的實現卻相當複雜。
那麼我們如何編寫特定i2c接口器件的驅動程序？就是說上述架構中的那些部分需要我們完成，而哪些是linux內核已經完善的或者是芯片提供商已經提供的？
架構層次分類
第一層：提供i2c adapter的硬件驅動，探測、初始化i2c adapter（如申請i2c的io地址和中斷號），驅動soc控制的i2c
adapter在硬件上產生信號（start、stop、ack）以及處理i2c中斷。覆蓋圖中的硬件實現層
第二層：提供i2c adapter的algorithm，用具體適配器的xxx_xferf()函數來填充i2c_algorithm的master_xfer函數指針，並把賦值後的i2c_algorithm再賦值給i2c_adapter的algo指針。覆蓋圖中的訪問抽象層、i2c核心層
第三層：實現i2c設備驅動中的i2c_driver接口，用具體的i2c device設備的attach_adapter()、detach_adapter()方法賦值給i2c_driver的成員函數指針。實現設備device與總線（或者叫adapter）的掛接。覆蓋圖中的driver驅動層
第四層：實現i2c設備所對應的具體device的驅動，i2c_driver只是實現設備與總線的掛接，而掛接在總線上的設備則是千差萬別的，所以要實現具體設備device的write()、read()、ioctl()等方法，賦值給file_operations，然後註冊字符設備（多數是字符設備）。覆蓋圖中的driver驅動層
第一層和第二層又叫i2c總線驅動(bus)，第三第四屬於i2c設備驅動(device driver)。
在linux驅動架構中，幾乎不需要驅動開發人員再添加bus，因爲linux內核幾乎集成所有總線bus，如usb、pci、i2c等等。並且總線bus中的(與特定硬件相關的代碼)已由芯片提供商編寫完成，例如三星的s3c-2440平臺i2c總線bus爲/drivers/i2c/buses/i2c-s3c2410.c
第三第四層與特定device相干的就需要驅動工程師來實現了。
Linux下I2C體系文件構架
在Linux內核源代碼中的driver目錄下包含一個i2c目錄
![]()
i2c-core.c這個文件實現了I2C核心的功能以及/proc/bus/i2c*接口。
i2c-dev.c實現了I2C適配器設備文件的功能，每一個I2C適配器都被分配一個設備。通過適配器訪設備時的主設備號都爲89，次設備號爲0-255。I2c-dev.c並沒有針對特定的設備而設計，只是提供了通用的read(),write(),和ioctl()等接口，應用層可以借用這些接口訪問掛接在適配器上的I2C設備的存儲空間或寄存器，並控制I2C設備的工作方式。
busses文件夾這個文件中包含了一些I2C總線的驅動，如針對S3C2410，S3C2440，S3C6410等處理器的I2C控制器驅動爲i2c-s3c2410.c.
algos文件夾實現了一些I2C總線適配器的algorithm.
重要的結構體
-
struct i2c_driver {
-
unsigned int class;
-
int (*attach_adapter)(struct i2c_adapter *);
-
int (*detach_adapter)(struct i2c_adapter *);
-
int (*probe)(struct i2c_client *, const struct i2c_device_id *);
-
int (*remove)(struct i2c_client *);
-
void (*shutdown)(struct i2c_client *);
-
int (*suspend)(struct i2c_client *, pm_message_t mesg);
-
int (*resume)(struct i2c_client *);
-
void (*alert)(struct i2c_client *, unsigned int data);
-
int (*command)(struct i2c_client *client, unsigned int cmd, void*arg);
-
struct device_driver driver;
-
const struct i2c_device_id *id_table;
-
int (*detect)(struct i2c_client *, struct i2c_board_info *);
-
const unsigned short *address_list;
-
struct list_head clients;
-
};
i2c_client
-
struct i2c_client {
-
unsigned short flags；
-
unsigned short addr;
-
char name[I2C_NAME_SIZE];
-
struct i2c_adapter *adapter;
-
struct i2c_driver *driver;
-
struct device dev;
-
int irq;
-
struct list_head detected;
-
};
i2c_adapter
-
struct i2c_adapter {
-
struct module *owner;
-
unsigned int id;
-
unsigned int class;
-
const struct i2c_algorithm *algo;
-
void *algo_data;
-
struct rt_mutex bus_lock;
-
int timeout;
-
int retries;
-
struct device dev;
-
int nr;
-
char name[48];
-
struct completion dev_released;
-
struct list_head userspace_clients;
-
};
i2c_algorithm
-
struct i2c_algorithm {
-
int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
-
int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,unsigned short flags, char read_write,u8 command, int size, union
-
i2c_smbus_data *data);
-
u32 (*functionality) (struct i2c_adapter *);
-
};
各結構體的作用與它們之間的關係
i2c_adapter與i2c_algorithm
i2c_adapter對應與物理上的一個適配器，而i2c_algorithm對應一套通信方法，一個i2c適配器需要i2c_algorithm中提供的（i2c_algorithm中的又是更下層與硬件相關的代碼提供）通信函數來控制適配器上產生特定的訪問週期。缺少i2c_algorithm的i2c_adapter什麼也做不了，因此i2c_adapter中包含其使用i2c_algorithm的指針。
i2c_algorithm中的關鍵函數master_xfer()用於產生i2c訪問週期需要的start stop ack信號，以i2c_msg（即i2c消息）爲單位發送和接收通信數據。
i2c_msg也非常關鍵，調用驅動中的發送接收函數需要填充該結構體
-
struct i2c_msg {
-
__u16 addr;
-
__u16 flags;
-
__u16 len;
-
__u8 *buf;
-
};
i2c_driver和i2c_client
i2c_driver對應一套驅動方法，其主要函數是attach_adapter()和detach_client()
i2c_client對應真實的i2c物理設備device，每個i2c設備都需要一個i2c_client來描述
i2c_driver與i2c_client的關係是一對多。一個i2c_driver上可以支持多個同等類型的i2c_client.
i2c_adapter和i2c_client
i2c_adapter和i2c_client的關係與i2c硬件體系中適配器和設備的關係一致，即i2c_client依附於i2c_adapter,由於一個適配器上可以連接多個i2c設備，所以i2c_adapter中包含依附於它的i2c_client的鏈表。
從i2c驅動架構圖中可以看出，linux內核對i2c架構抽象了一個叫核心層core的中間件，它分離了設備驅動device driver和硬件控制的實現細節（如操作i2c的寄存器），core層不但爲上面的設備驅動提供封裝後的內核註冊函數，而且還爲小面的硬件事件提供註冊接口（也就是i2c總線註冊接口），可以說core層起到了承上啓下的作用。
具體分析
先看一下i2c-core爲外部提供的核心函數（選取部分），i2c-core對應的源文件爲i2c-core.c，位於內核目錄/driver/i2c/i2c-core.c
-
EXPORT_SYMBOL(i2c_add_adapter);
-
EXPORT_SYMBOL(i2c_del_adapter);
-
EXPORT_SYMBOL(i2c_del_driver);
-
EXPORT_SYMBOL(i2c_attach_client);
-
EXPORT_SYMBOL(i2c_detach_client);
-
-
EXPORT_SYMBOL(i2c_transfer);
i2c_transfer()函數：i2c_transfer()函數本身並不具備驅動適配器物理硬件完成消息交互的能力，它只是尋找到i2c_adapter對應的i2c_algorithm，並使用i2c_algorithm的master_xfer()函數真正的驅動硬件流程，代碼清單如下，不重要的已刪除。
-
int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
-
{
-
int ret;
-
if (adap->algo->master_xfer) {
-
ret = adap->algo->master_xfer(adap,msgs,num);
-
return ret;
-
} else {
-
return -ENOSYS;
-
}
-
}
當一個具體的client被偵測到並被關聯的時候，設備和sysfs文件將被註冊。
相反的，在client被取消關聯的時候，sysfs文件和設備也被註銷，驅動開發人員在開發i2c設備驅動時，需要調用下列函數。程序清單如下
-
int i2c_attach_client(struct i2c_client *client)
-
{
-
...
-
device_register(&client->dev);
-
device_create_file(&client->dev, &dev_attr_client_name);
-
...
-
return 0;
-
}
-
-
-
[cpp] view plaincopy
-
int i2c_detach_client(struct i2c_client *client)
-
{
-
...
-
device_remove_file(&client->dev, &dev_attr_client_name);
-
device_unregister(&client->dev);
-
...
-
return res;
-
}
i2c_add_adapter()函數和i2c_del_adapter()在i2c-davinci.c中有調用，稍後分析
-
int i2c_add_adapter(struct i2c_adapter *adap)
-
{
-
...
-
device_register(&adap->dev);
-
device_create_file(&adap->dev, &dev_attr_name);
-
...
-
-
list_for_each(item,&drivers) {
-
driver = list_entry(item, struct i2c_driver, list);
-
if (driver->attach_adapter)
-
-
driver->attach_adapter(adap);
-
}
-
...
-
}
-
-
-
-
int i2c_del_adapter(struct i2c_adapter *adap)
-
{
-
...
-
list_for_each(item,&drivers) {
-
driver = list_entry(item, struct i2c_driver, list);
-
if (driver->detach_adapter)
-
if ((res = driver->detach_adapter(adap))) {
-
}
-
}
-
...
-
list_for_each_safe(item, _n, &adap->clients) {
-
client = list_entry(item, struct i2c_client, list);
-
-
if ((res=client->driver->detach_client(client))) {
-
-
}
-
}
-
...
-
device_remove_file(&adap->dev, &dev_attr_name);
-
device_unregister(&adap->dev);
-
-
}
i2c-davinci.c是實現與硬件相關功能的代碼集合，這部分是與平臺相關的，也叫做i2c總線驅動，這部分代碼是這樣添加到系統中的
-
static struct platform_driver davinci_i2c_driver = {
-
.probe = davinci_i2c_probe,
-
.remove = davinci_i2c_remove,
-
.driver = {
-
.name = "i2c_davinci",
-
.owner = THIS_MODULE,
-
},
-
};
-
-
-
static int __init davinci_i2c_init_driver(void)
-
{
-
return platform_driver_register(&davinci_i2c_driver);
-
}
-
subsys_initcall(davinci_i2c_init_driver);
-
-
static void __exit davinci_i2c_exit_driver(void)
-
{
-
platform_driver_unregister(&davinci_i2c_driver);
-
}
-
module_exit(davinci_i2c_exit_driver);
並且，i2c適配器控制硬件發送接收數據的函數在這裏賦值給i2c-algorithm，i2c_davinci_xfer稍加修改就可以在裸機中控制i2c適配器
-
static struct i2c_algorithm i2c_davinci_algo = {
-
.master_xfer = i2c_davinci_xfer,
-
.functionality = i2c_davinci_func,
-
};
然後在davinci_i2c_probe函數中，將i2c_davinci_algo添加到添加到algorithm系統中
-
adap->algo = &i2c_davinci_algo;
適配器驅動程序分析
在linux系統中，適配器驅動位於linux目錄下的\drivers\i2c\busses下，不同的處理器的適配器驅動程序設計有差異，但是總體思路不變。
在適配器的驅動中，實現兩個結構體非常關鍵，也是整個適配器驅動的靈魂。
下面以某個適配器的驅動程序爲例進行說明：
-
static struct platform_driver tcc_i2c_driver = {
-
.probe = tcc_i2c_probe,
-
.remove = tcc_i2c_remove,
-
.suspend = tcc_i2c_suspend_late,
-
.resume = tcc_i2c_resume_early,
-
.driver = {
-
.owner = THIS_MODULE,
-
.name = "tcc-i2c",
-
},
-
};
以上說明這個驅動是基於平臺總線的，這樣實現的目的是與CPU緊緊聯繫起來。
-
static const struct i2c_algorithm tcc_i2c_algorithm = {
-
.master_xfer = tcc_i2c_xfer,
-
.functionality = tcc_i2c_func,
-
};
這個結構體也是非常的關鍵，這個結構體裏面的函數tcc_i2c_xfer是適配器算法的實現，這個函數實現了適配器與I2C
CORE的連接。
tcc_i2c_func是指該適配器所支持的功能。
tcc_i2c_xfer這個函數實質是實現I2C數據的發送與接收的處理過程。不同的處理器實現的方法不同，主要表現在寄存器的設置與中斷的處理方法上。
把握上面的兩點去分析適配器程序就簡單多了。
I2C-core驅動程序分析
在I2C-core.c這個函數中，把握下面的幾個關鍵函數就可以了。
-
-
int i2c_add_adapter(struct i2c_adapter *adapter)
-
int i2c_del_adapter(struct i2c_adapter *adap)
-
-
-
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
-
void i2c_del_driver(struct i2c_driver *driver)
-
-
-
int i2c_attach_client(struct i2c_client *client)
-
-
-
int i2c_register_driver(struct module *owner, struct i2c_driver *driver)
-
void i2c_del_driver(struct i2c_driver *driver)
-
-
-
int i2c_attach_client(struct i2c_client *client)
-
int i2c_detach_client(struct i2c_client *client)
-
-
-
int i2c_master_send(struct i2c_client *client,const char *buf ,int count)
-
int i2c_master_recv(struct i2c_client *client, char *buf ,int count)
-
int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num)
I2c_transfer這個函數實現了core與adapter的聯繫。
代碼調用層次圖
有時候代碼比任何文字描述都來得直接，但是過多的代碼展示反而讓人覺得枯燥。這個時候，需要一幅圖來梳理一下上面的內容
![]()
上面這些代碼的展示是告訴我們：linux內核和芯片提供商爲我們的的驅動程序提供了 i2c驅動的框架，以及框架底層與硬件相關的代碼的實現。
剩下的就是針對掛載在i2c兩線上的i2c設備了device，而編寫的即具體設備驅動了，這裏的設備就是硬件接口外掛載的設備，而非硬件接口本身（soc硬件接口本身的驅動可以理解爲總線驅動）
編寫驅動需要完成的工作
編寫具體的I2C驅動時，工程師需要處理的主要工作如下：
1).提供I2C適配器的硬件驅動，探測，初始化I2C適配器(如申請I2C的I/O地址和中斷號)，驅動CPU控制的I2C適配器從硬件上產生。
2).提供I2C控制的algorithm, 用具體適配器的xxx_xfer()函數填充i2c_algorithm的master_xfer指針，並把i2c_algorithm指針賦給i2c_adapter的algo指針。
3).實現I2C設備驅動中的i2c_driver接口，用具體yyy的yyy_probe()，yyy_remove()，yyy_suspend(),yyy_resume()函數指針和i2c_device_id設備ID表賦給i2c_driver的probe,remove,suspend,resume和id_table指針。
4).實現I2C設備所對應類型的具體驅動，i2c_driver只是實現設備與總線的掛接。
上面的工作中前兩個屬於I2C總線驅動，後面兩個屬於I2C設備驅動。
