msm7227平臺linux I2C驅動分析(2.6.29)

Revision History
 
Date Issue Description Author    
<08/07/2010> <1.0> Msm7227平臺I2C驅動分析 滕景東    
       
     
目錄
1. 摘要 3
2. 簡介 3
3. I2C架構 3
4. I2C總線初始化 4
5. I2C適配器驅動 5
6. I2C設備驅動 9
7. 用戶空間驅動支持 12
8. 數據傳輸框架 16
9. References 16

 

1. 摘要
主要介紹Msm7227平臺上I2C驅動原理，多數部分是29內核標準架構。
2. 簡介
I2C只有兩條線,一條串行數據線:SDA,一條是時鐘線SCL。I2C是一種多主機控制總線，同一總線上可容許多個master. 
i2c總線適配器（adapter）就是一條i2c總線的控制器，在物理鏈接上若干i2c設備。在linux驅動中，每種處理器平臺有本身的適配器驅動。
3. I2C架構

內核中i2c相關代碼能夠分爲三個層次：
i2c框架層：i2c.h和i2c-core.c爲其主體框架代碼，提供了核心數據結構的定義、i2c適配器驅動和設備驅動的註冊、註銷管理等；i2c-dev.c用於建立i2c適配器的/dev/i2c-%d設備節點，提供i2c設備的用戶空間訪問方法等。
i2c總線適配器驅動：i2c/busses/目錄下，如i2c-msm.c。定義描述具體i2c總線適配器的i2c_adapter數據結構、實如今具體i2c適配器上的i2c總線通訊的具體實現，並由i2c_algorithm數據結構描述與i2c設備通訊的方法。
i2c設備驅動：定義描述具體設備的i2c_client和可能的私有數據結構。

                     
 
 上圖展現了內核I2C結構大總體框架，如下根據內核加載順序介紹I2C總線初始化，I2C總線適配器驅動，I2C設備驅動和用戶空間驅動支持及數據傳輸框架五部分介紹。
4. I2C總線初始化
 
該過程主要完成了sysfs總線結構，最終造成以下結構：
/sys/bus/i2c/
|-- devices
|-- drivers
|   |-- dummy
|      |-- bind
|      |-- uevent
|      `-- unbind
|-- drivers_autoprobe
|-- drivers_probe
`-- uevent
和
/sys/class/i2c-adapter/
dummy_driver僅僅是註冊了一個空的設備驅動，註冊驅動時會遍歷加載/sys/class/i2c-adapter/中的全部設備，該過程在初始話總線過程當中完成，/sys/class/i2c-adapter/基本爲空，因此我認爲這裏的驅動註冊只是驗證i2c總線結構的完整性考慮的。
5. I2C適配器驅動

Linux內核的全部適配器驅動程序都在driver/i2c/busses/目錄下，當前高通的驅動是i2c-msm.c,適配器驅動的註冊過程以下：

 
在kernel中提供了兩個adapter註冊接口,分別爲i2c_add_adapter()和i2c_add_numbered_adapter().因爲在系統中可能存在多個adapter，由於將每一條I2C總線對應一個編號,下文中稱爲I2C總線號。對於i2c_add_adapter()而言,它使用的是動態總線號,即由系統給其分配一個總線號，而i2c_add_numbered_adapter()則是本身指定總線號，若是這個總線號非法或者是被佔用，就會註冊失敗。高通的adapter驅動使用了i2c_add_numbered_adapter()註冊，總線號最初保存在platform_data中。
I2C adapter以platform_device方式註冊進系統，在proble函數中初始化了struct i2c_adapter結構：

[cpp]  view plain copy

1. struct i2c_adapter {  
2.  struct module *owner;  
3.  unsigned int id;  
4.  unsigned int class;    /* classes to allow probing for */  
5.  const struct i2c_algorithm *algo; /* the algorithm to access the bus */  
6.  void *algo_data;  
7.   
8.  /* --- administration stuff. */  
9.  int (*client_register)(struct i2c_client *);  
10.  int (*client_unregister)(struct i2c_client *);  
11.   
12.  /* data fields that are valid for all devices */  
13.  u8 level;    /* nesting level for lockdep */  
14.  struct mutex bus_lock;  
15.  struct mutex clist_lock;  
16.   
17.  int timeout;   /* in jiffies */  
18.  int retries;  
19.  struct device dev;  /* the adapter device */  
20.   
21.  int nr; /*該成員描述了總線號*/  
22.  struct list_head clients; /* i2c_client結構鏈表，該結構包含device，driver和 
23. adapter結構*/  
24.  char name[48];  
25.  struct completion dev_released;  
26. };  

其中nr的值是在arch/arm/mach-msm/devices.c中定義的：

[c-sharp]  view plain copy

1. struct platform_device msm_device_i2c = {  
2.  .name  = "msm_i2c",  
3.  .id  = 0,  
4.  .num_resources = ARRAY_SIZE(resources_i2c),  
5.  .resource = resources_i2c,  
6. };  
7. struct platform_device msm_device_i2c_2 = {  
8.  .name  = "msm_i2c",  
9.  .id  = 2,  
10.  .num_resources = ARRAY_SIZE(resources_i2c_2),  
11.  .resource = resources_i2c_2,  
12. };  

該結構以參數形式傳進i2c_add_numbered_adapter()，下一步將進入

[c-sharp]  view plain copy

1. static int i2c_register_adapter(struct i2c_adapter *adap)  
2. {  
3.  int res = 0, dummy;  
4.   
5.  /* Can't register until after driver model init */  
6.  if (unlikely(WARN_ON(!i2c_bus_type.p)))  
7.   return -EAGAIN;  
8.   
9.  mutex_init(&adap->bus_lock);  
10.  mutex_init(&adap->clist_lock);  
11.  INIT_LIST_HEAD(&adap->clients);/*初始化設備鏈表*/  
12.   
13.  mutex_lock(&core_lock);  
14.   
15.  /* Add the adapter to the driver core. 
16.   * If the parent pointer is not set up, 
17.   * we add this adapter to the host bus. 
18.   */  
19.  if (adap->dev.parent == NULL) {  
20.   adap->dev.parent = &platform_bus;/*父設備是platform_bus*/  
21.   pr_debug("I2C adapter driver [%s] forgot to specify "  
22.     "physical device/n", adap->name);  
23.  }  
24.  dev_set_name(&adap->dev, "i2c-%d", adap->nr);/*設備節點名字*/  
25.  adap->dev.release = &i2c_adapter_dev_release;  
26.  adap->dev.class = &i2c_adapter_class;  
27.  res = device_register(&adap->dev); /*註冊adapter這個設備自己*/  
28.  if (res)  
29.   goto out_list;  
30.   
31.  dev_dbg(&adap->dev, "adapter [%s] registered/n", adap->name);  
32.   
33.  /*如下部分完成i2c設備和驅動的註冊*/  
34.  if (adap->nr < __i2c_first_dynamic_bus_num)/*主板初始化時的動態總線號，該值已導出符號表*/  
35.   i2c_scan_static_board_info(adap);/*完成新類型i2c設備的註冊，通常只在主板初始化時*/  
36.   
37.  /* Notify drivers */  
38.  dummy = bus_for_each_drv(&i2c_bus_type, NULL, adap,  
39.      i2c_do_add_adapter);  /*探測總線上的全部i2c設備驅動，同時完成client、driver、device、adapter的綁定，但driver->address_data非空的狀況下有用，而這又意味着只對舊的i2c機制有效*/  
40.   
41. out_unlock:  
42.  mutex_unlock(&core_lock);  
43.  return res;  
44.   
45. out_list:  
46.  idr_remove(&i2c_adapter_idr, adap->nr);  
47.  goto out_unlock;  
48. }  

i2c_scan_static_board_info對應的初始化過程在board-msm7x27.c中完成，
i2c_register_board_info(0, i2c_devices, ARRAY_SIZE(i2c_devices));
6. I2C設備7. 驅動
驅動的編寫方法已在《msm7227-I2C設備驅動實現要點.doc》中介紹，此節分析驅動和設備的註冊過程。
 
本還想詳細分析代碼，但發現，這張圖已經足夠說明i2c驅動的註冊過程了，下面對我看代碼時碰到的一些問題簡要分析。
設備和驅動的關聯
你們知道，對於一個驅動程序有兩個元素不可或缺，即設備和驅動，通常驅動都是經過設備名和驅動名的匹配創建關係的，我從i2c/chips/裏看到的示例代碼了只能發現驅動的註冊，卻不見設備註冊的蹤跡，使人疑惑，跟蹤發現，在i2c adapter註冊時會遍歷i2c_board_info這樣一個結構，而這個結構在29之前或更早的內核裏是不存在的，該數據結構在board-msm7x27.c中初始化了i2c設備名及設備地址，這便解決了驅動與設備的匹配問題，同時器件地址的提供也有所改變，舊的內核是在驅動中使用一個normal_i2c數組保存地址的。
名字匹配
一個i2c驅動是能夠有多個名字的，即一個驅動程序能夠支持多個設備，該機制是經過 struct i2c_device_id實現的，驅動中創建這麼一個結構體數組，i2c架構層便會掃描該數組，與設備名去匹配，匹配成功的都會進入相應probe函數。
進入probe
該過程困惑了我一段時間，其實要進入本身驅動的probe首先須要進入總線的probe，而進入總線probe的前提是與總線的match成功，具體實現你們能夠根據上面的圖看一下相應代碼便知。
設備模型
I2C的架構充分利用的設備模型的原理及sysfs的實現，我認爲理解i2C架構前先了解一下設備模型是頗有必要的。這裏將個人我的理解總結一下：
 Kobject是設備模型的最小單位，kset是對kobject的集合，struct driver_private、struct device等結構都內嵌了kobject，kset也內嵌kobject用於表徵本身。相同特性的kset的合集又構成了subsys，舉個不太恰當的類比：
kobject之於設備或驅動；kset之於某一類設備，如i2c；subsys之於子系統，如輸入子系統。其實在29內核中subsys就是一個kset結構，貼兩張圖理解一下：
  
8. 用戶空間驅動支持
這部分在i2c-dev.c中實現，這部份內容簡單的說就是經過內嵌一個具備file_operations的標準字符設備驅動來虛擬i2c設備，這樣，就能夠在用戶空間直接操做i2c設備了。
流程以下圖：
 
餘下的就是常規file_operation了，open操做：

[c-sharp]  view plain copy

1. static int i2cdev_open(struct inode *inode, struct file *file)  
2. {  
3.  unsigned int minor = iminor(inode);  
4.  struct i2c_client *client;  
5.  struct i2c_adapter *adap;  
6.  struct i2c_dev *i2c_dev;  
7.  int ret = 0;  
8.   
9.  lock_kernel();/*內核上鎖，通常只在多cpu是有用*/  
10.  i2c_dev = i2c_dev_get_by_minor(minor);/*由於有兩個adapter，同一個主設備號*/  
11.  if (!i2c_dev) {  
12.   ret = -ENODEV;  
13.   goto out;  
14.  }  
15.   
16.  adap = i2c_get_adapter(i2c_dev->adap->nr);  
17.  if (!adap) {  
18.   ret = -ENODEV;  
19.   goto out;  
20.  }  
21.   
22.  /* This creates an anonymous i2c_client, which may later be 
23.   * pointed to some address using I2C_SLAVE or I2C_SLAVE_FORCE. 
24.   * 
25.   * This client is ** NEVER REGISTERED ** with the driver model 
26.   * or I2C core code!!  It just holds private copies of addressing 
27.   * information and maybe a PEC flag. 
28.   */  
29.  client = kzalloc(sizeof(*client), GFP_KERNEL);  
30.  if (!client) {  
31.   i2c_put_adapter(adap);  
32.   ret = -ENOMEM;  
33.   goto out;  
34.  }  
35.  snprintf(client->name, I2C_NAME_SIZE, "i2c-dev %d", adap->nr);  
36.  client->driver = &i2cdev_driver;/*綁定字符設備驅動*/  
37.   
38.  client->adapter = adap;  
39.  file->private_data = client;  
40.   
41. out:  
42.  unlock_kernel();  
43.  return ret;  
44. }  

注意這裏分配並初始化了一個struct i2c_client結構.可是沒有註冊這個clinet.此外,這個函數中還有一個比較奇怪的操做.不是在前面已經將i2c_dev->adap指向要操做的adapter麼?爲何還要以adapter->nr爲關鍵字從i2c_adapter_idr去找這個操做的adapter呢?注意了,調用i2c_get_adapter()從總線號nr找到操做的adapter的時候,還會增長module的引用計數.這樣能夠防止模塊意外被釋放掉.也許有人會有這樣的疑問,那 i2c_dev->adap->nr操做,若是i2c_dev->adap被釋放掉的話,不是同樣會引發系統崩潰麼?這裏由於,在i2cdev_attach_adapter()間接的增長了一次adapter的一次引用計數.以下:

[c-sharp]  view plain copy

1. static int i2cdev_attach_adapter(struct i2c_adapter *adap)  
2. {  
3. ．．．．．．  
4. i2c_dev->dev = device_create(i2c_dev_class, &adap->dev,  
5.                      MKDEV(I2C_MAJOR, adap->nr),  
6.                      "i2c-%d", adap->nr);  
7. ．．．．．．  
8. }  

看到了麼，i2c_dev內嵌的device是以adap->dev爲父結點,在device_create()中會增次adap->dev的一次引用計數.
好了,open()操做到此就完成了.
使用方法：（參考kernel-test/i2c-msm-test.c）
一、構造struct i2c_msg

[c-sharp]  view plain copy

1. [讀] struct i2c_msg msgs[] = {  
2.   [0] = {  
3.    .addr = slave_address,  
4.    .flags = 0,  
5.    .buf = (void *)offset_data,  
6.    .len = ARRAY_SIZE(offset_data),  
7.   },  
8.   [1] = {  
9.    .addr = slave_address,  
10.    .flags = I2C_M_RD,  
11.    .buf = (void *)buf,  
12.    .len = count,  
13.   },  
14.  };  
15. [寫] struct i2c_msg msgs[] = {  
16.   [0] = {  
17.    .addr = slave_address,  
18.    .flags = 0,  
19.    .buf = (void *)data,  
20.    .len = (2 + len) * sizeof(*data),  
21.   },  
22.   }  

二、經過ioctl操做設備

[c-sharp]  view plain copy

1. static int do_rdwr(int fd, struct i2c_msg *msgs, int nmsgs)  
2. {  
3.  struct i2c_rdwr_ioctl_data msgset = {  
4.   .msgs = msgs,  
5.   .nmsgs = nmsgs,  /* msgs 個數*/  
6.  };  
7.   
8.  if (msgs == NULL || nmsgs <= 0)  
9.   return -1;  
10.   
11.  if (ioctl(fd, I2C_RDWR, &msgset) < 0)  
12.   return -1;  
13.   
14.  return 0;  
15. }  

三、ioctl命令字：

[c-sharp]  view plain copy

1. #define I2C_SMBUS_READ 1  
2. #define I2C_SMBUS_WRITE 0  
3.  
4. #define I2C_SMBUS_QUICK 0  
5. #define I2C_SMBUS_BYTE 1  
6. #define I2C_SMBUS_BYTE_DATA 2   
7. #define I2C_SMBUS_WORD_DATA 3  
8. #define I2C_SMBUS_PROC_CALL 4  
9. #define I2C_SMBUS_BLOCK_DATA 5  
10. #define I2C_SMBUS_I2C_BLOCK_DATA 6  
11. #define I2C_SMBUS_BLOCK_PROC_CALL 7    
12.  
13. #define I2C_RETRIES 0x0701    
14. #define I2C_TIMEOUT 0x0702    
15. #define I2C_SLAVE 0x0703    
16. #define I2C_SLAVE_FORCE 0x0706    
17. #define I2C_TENBIT 0x0704    
18. #define I2C_FUNCS 0x0705    
19. #define I2C_RDWR 0x0707    
20. #define I2C_PEC 0x0708    
21. #define I2C_SMBUS 0x0720    

9. 數據傳輸框架
I2C架構的讀寫支持兩種類型，默認實現的操做是smbus協議，該協議與i2c協議相似，若是控制器不支持smbus，框架層能夠用i2c_transfer模擬smbus的實現，系統默認的i2c傳輸函數通常都是基於i2c模擬的smbus方法傳輸的，如i2c_smbus_write_byte_data，i2c_smbus_read_byte_data等。
I2C協議的總線實現應該是I2C控制器，而不是SMBUS控制器, I2C協議和SMBUS協議不完成等同,SMBUS是I2C的子集，smbus由I2C衍生而來。smbus總線上傳輸的數據必定是I2C的格式的，可是SMBUS上傳輸的數據不必定能知足具體某個I2C從設備的通訊要求(數據序列)。
下圖以i2c_smbus_write_byte_data介紹數據流程：
 
10. References
[1]. http://blog.chinaunix.net/u1/51562/showart_1403925.html
[2]. 《msm7227-I2C設備驅動實現要點.doc》 滕景東