IIC设备驱动程序
IIC設備是一種通過IIC總線連接的設備，由于其簡單性，被廣泛引用于電子系統中。在現代電子系統中，有很多的IIC設備需要進行相互之間通信
IIC總線是由PHILIPS公司開發的兩線式串行總線，用于連接微處理器和外部IIC設備。IIC設備產生于20世紀80年代，最初專用與音頻和視頻設備，現在在各種電子設備中都廣泛應用
IIC總線有兩條總線線路，一條是串行數據線（SDA），一條是串行時鐘線（SCL）。SDA負責數據傳輸，SCL負責數據傳輸的時鐘同步。IIC設備通過這兩條總線連接到處理器的IIC總線控制器上。一種典型的設備連接如圖：
與其他總線相比，IIC總線有很多重要的特點。在選擇一種設備來完成特定功能時，這些特點是選擇IIC設備的重要依據。
主要特點：
1，每一個連接到總線的設備都可以通過唯一的設備地址單獨訪問
2，串行的8位雙向數據傳輸，位速率在標準模式下可達到100kb/s;快速模式下可以達到400kb/s;告訴模式下可以達到3.4Mb/s
3，總線長度最長7.6m左右
4，片上濾波器可以增加抗干擾能力，保證數據的完成傳輸
5，連接到一條IIC總線上的設備數量只受到最大電容400pF的限制
6，它是一個多主機系統，在一條總線上可以同時有多個主機存在，通過沖突檢測方式和延時等待防止數據不被破壞。同一時間只能有一個主機占用總線
?
IIC總線在傳輸數據的過程中有3種類型的信號：開始信號、結束信號、和應答信號
>>開始信號(S): 當SCL為高電平時，SDA由高電平向低電平跳變，表示將要開始傳輸數據
>>結束信號(P):當SCL為高電平時，SDA由低電平向高電平跳變，表示結束傳輸數據
>>響應信號(ACK): 從機接收到8位數據后，在第9個周期，拉低SDA電平，表示已經收到數據。這個信號稱為應答信號
開始信號和結束信號的波形如下圖：
主機：IIC總線中發送命令的設備，對于ARM處理器來說，主機就是IIC控制器
從機：接受命令的設備
?
主機向從機發送數據：
主機通過數據線SDA向從機發送數據。當總線空閑時，SDA和SCL信號都處于高電平。主機向從機發送數據的過程：
1，當主機檢測到總線空閑時，主機發出開始信號
2，主機發送8位數據。這8位數據的前7位表示從機地址，第8位表示數據的傳輸方向。這時，第8位為0，表示向從機發送數據
3，被選中的從機發出響應信號ACK
4，從機傳輸一系列的字節和響應位
5，主機接受這些數據，并發出結束信號P，完成本次數據傳輸
?
由上圖可知，IIC控制器主要是由4個寄存器來完成所有的IIC操作的。
IICCON：控制是否發出ACK信號，是否開啟IIC中斷
IICSTAT：
IICADD：掛載到總線上的從機地址。該寄存器的[7:1]表示從機地址。IICADD寄存器在串行輸出使能位IICSTAT[4]為0時，才可以寫入；在任何時候可以讀出
IICDS：保存將要發送或者接收到的數據。IICCDS在串行輸出使能IICSTAT[4]為1時，才可以寫入；在任何時間都可以讀出
?
因為IIC設備種類太多，如果每一個IIC設備寫一個驅動程序，那么顯得內核非常大。不符合軟件工程代碼復用，所以對其層次話：
這里簡單的將IIC設備驅動分為設備層、總線層。理解這兩個層次的重點是理解4個數據結構，這4個數據結構是i2c_driver、i2c_client、i2c_algorithm、i2c_adapter。i2c_driver、i2c_client屬于設備層；i2c_algorithm、i2c_adapter屬于總線型。如下圖：
設備層關系到實際的IIC設備，如芯片AT24C08就是一個IIC設備。總線層包括CPU中的IIC總線控制器和控制總線通信的方法。
值得注意的是：一個系統中可能有很多個總線層，也就是包含多個總線控制器；也可能有多個設備層，包含不同的IIC設備
由IIC總線規范可知，IIC總線由兩條物理線路組成，這兩條物理線路是SDA和SCL。只要連接到SDA和SCL總線上的設備都可以叫做IIC設備。一個IIC設備由i2c_client數據結構進行描述：
struct? i2c_client
{
unsigned short? flags;??????????????????????? //標志位
????? unsigned short? addr; ? //設備的地址，低7位為芯片地址
char name[I2C_NAME_SIZE]; ?? //設備的名稱，最大為20個字節
struct? i2c_adapter *adapter; //依附的適配器i2c_adapter，適配器指明所屬的總線
struct? i2c_driver *driver; //指向設備對應的驅動程序
struct device? dev; //設備結構體
int irq; //設備申請的中斷號
struct list_head? list; //連接到總線上的所有設備
struct list_head detected; //已經被發現的設備鏈表
struct completion released; //是否已經釋放的完成量
};
?
設備結構體i2c_client中addr的低8位表示設備地址。設備地址由讀寫位、器件類型和自定義地址組成，如下圖：
第7位是R/W位，0表示寫，2表示讀，所以I2C設備通常有兩個地址，即讀地址和寫地址
類型器件由中間4位組成，這是由半導體公司生產的時候就已經固化了。
自定義類型由低3位組成。由用戶自己設置，通常的做法如EEPROM這些器件是由外部I芯片的3個引腳所組合電平決定的（A0,A1,A2）。A0,A1,A2 就是自定義的地址碼。自定義的地址碼只能表示8個地址，所以同一IIC總線上同一型號的芯片最多只能掛載8個。
AT24C08的自定義地址碼如圖：A0,A1,A2接低電平，所以自定義地址碼為0；
如果在兩個不同IIC總線上掛接了兩塊類型和地址相同的芯片，那么這兩塊芯片的地址相同。這顯然是地址沖突，解決的辦法是為總線適配器指定一個ID號，那么新的芯片地址就由總線適配器的ID和設備地址組成
除了地址之外，IIC設備還有一些重要的注意事項：
1，i2c_client數據結構是描述IIC設備的“模板”，驅動程序的設備結構中應包含該結構
2，adapter指向設備連接的總線適配器，系統可能有多個總線適配器。內核中靜態指針數組adapters記錄所有已經注冊的總線適配器設備
3，driver是指向設備驅動程序，這個驅動程序是在系統檢測到設備存在時賦值的
?
IIC設備驅動???? i2c_driver:
struct? i2c_driver
{
int id;???????????????????????? //驅動標識ID
unsigned int class;?????????????? //驅動的類型
int (*attach_adapter)(struct i2c_adapter *);???????????? //當檢測到適配器時調用的函數
?????? int (*detach_adapter)(struct i2c_adapter*);????????????? //卸載適配器時調用的函數
int (*detach_client)(struct i2c_client *)?? __deprecated;???????????? //卸載設備時調用的函數
?????? //以下是一種新類型驅動需要的函數，這些函數支持IIC設備動態插入和拔出。如果不想支持只實現上面3個。要不實現上面3個。要么實現下面5個。不能同時定義
?????? int? (*probe)(struct i2c_client *,const struct? i2c_device_id *);????????????? //新類型設備探測函數
?????? int (*remove)(struct i2c_client *);?????????????????? //新類型設備的移除函數
?????? void (*shutdown)(struct i2c_client *);????????????? //關閉IIC設備
??????? int (*suspend)(struct? i2c_client *,pm_messge_t mesg);?????????? //掛起IIC設備
??????? int (*resume)(struct? i2c_client *);?????????????????????????????? //恢復IIC設備
??????? int (*command)(struct i2c_client *client,unsigned int cmd,void *arg);??????? //使用命令使設備完成特殊的功能。類似ioctl（）函數
??????? struct devcie_driver? driver;???????????????????????? //設備驅動結構體
???????? const struct? i2c_device_id *id_table;?????????????????????? //設備ID表
????????? int (*detect)(struct i2c_client *,int? kind,struct? i2c_board_info *);????????? //自動探測設備的回調函數
???????? const? struct i2c_client_address_data????????? *address_data;???????????????? //設備所在的地址范圍
???????? struct? list_head??? clients;??????????????????? //指向驅動支持的設備
};
結構體i2c_driver和i2c_client的關系較為簡單，其中i2c_driver表示一個IIC設備驅動，i2c_client表示一個IIC設備。關系如下圖：
IIC總線適配器就是一個IIC總線控制器，在物理上連接若干個IIC設備。IIC總線適配器本質上是一個物理設備，其主要功能是完成IIC總線控制器相關的數據通信：
struct i2c_adapter
{
??????? struct module *owner;??????????????????????? //模塊計數
??????? unsigned? int id;????????????????????????????????? //alogorithm的類型，定義于i2c_id.h中
??????? unsigned?? int? class;?????????????????????????? //允許探測的驅動類型
??????? const struct i2c_algorithm *algo;???????? //指向適配器的驅動程序
??????? void *algo_data;????????????????????????????????? //指向適配器的私有數據，根據不同的情況使用方法不同
??????? int (*client_register)(struct? i2c_client *);????????? //設備client注冊時調用
??????? int (*client_unregister(struct? i2c_client *);?????? //設備client注銷時調用
??????? u8 level;?????????????????????????????????????????????????????????
??????? struct? mutex? bus_lock;???????????????????????????? //對總線進行操作時，將獲得總線鎖
??????? struct? mutex? clist_lock ;??????????????????????????? //鏈表操作的互斥鎖
??????? int timeout;????????????????????????????????????????????????? //超時
int retries;???????????????????????????????????????????????????? //重試次數
?????? struct device dev;????????????????????????????????????????? //指向 適配器的設備結構體
?????? int? nr ;??????????????????????????????????????????????????????????
?????? struct? list_head????? clients;??????????????????????????? //連接總線上的設備的鏈表
??????? char name[48];????????????????????????????????????????????? //適配器名稱
??????? struct completion???? dev_released;?????????????? //用于同步的完成量
};
每一個適配器對應一個驅動程序，該驅動程序描述了適配器與設備之間的通信方法:
struct? i2c_algorithm
{
???????? int? (*master_xfer)(struct? i2c_adapter *adap,? struct? i2c_msg *msg, int num);????????????? //傳輸函數指針，指向實現IIC總線通信協議的函數，用來確定適配器支持那些傳輸類型
???????? int? (*smbus_xfer)(struct? i2c_adapter *adap, u16? addr, unsigned? short flags, char? read_write, u8 command, int size, union? i2c_smbus_data? *data);??? //smbus方式傳輸函數指針，指向實現SMBus總線通信協議的函數。SMBus和IIC之間可以通過軟件方式兼容，所以這里提供了一個函數，但是一般都賦值為NULL
???????? u32? (*functionality)(struct? i2c_adapter *);?????????????????? //返回適配器支持的功能
};
?
IIC設備驅動程序大致可以分為設備層和總線層。設備層包括一個重要的數據結構，i2c_client?？偩€層包括兩個重要的數據結構，分別是i2c_adapter和i2c_algorithm。一個i2c_algorithm結構表示適配器對應的傳輸數據方法。3個數據結構關系：
?
IIC設備層次結構較為簡單，但是寫IIC設備驅動程序卻相當復雜。
IIC設備驅動程序的步驟：
IIC子系統：
IIC子系統是作為模塊加載到系統中的。
初始化函數：
static int __init i2c_init(void)
{
?? ?int retval;??????????? //返回值，成功0，錯誤返回負值
?? ?retval = bus_register(&i2c_bus_type);?????? //注冊一條IIC的BUS總線
?? ?if (retval)
?? ??? ?return retval;
?? ?retval = class_register(&i2c_adapter_class);?????? //注冊適配器類，用于實現sys文件系統的部分功能
?? ?if (retval)
?? ??? ?goto bus_err;
?? ?retval = i2c_add_driver(&dummy_driver);?????????????? //將一個空驅動程序注冊到IIC總線中
?? ?if (retval)
?? ??? ?goto class_err;
?? ?return 0;
class_err:
?? ?class_unregister(&i2c_adapter_class);??????????????????????????????? //類注銷
bus_err:
?? ?bus_unregister(&i2c_bus_type);????????????????????????????????????????? //總線注銷
?? ?return retval;
}
?
struct bus_type i2c_bus_type = {
?? ?.name?? ??? ?= "i2c",
?? ?.dev_attrs?? ?= i2c_dev_attrs,
?? ?.match?? ??? ?= i2c_device_match,
?? ?.uevent?? ??? ?= i2c_device_uevent,
?? ?.probe?? ??? ?= i2c_device_probe,
?? ?.remove?? ??? ?= i2c_device_remove,
?? ?.shutdown?? ?= i2c_device_shutdown,
?? ?.suspend?? ?= i2c_device_suspend,
?? ?.resume?? ??? ?= i2c_device_resume,
};
static struct class i2c_adapter_class = {
?? ?.owner?? ??? ??? ?= THIS_MODULE,
?? ?.name?? ??? ??? ?= "i2c-adapter",
?? ?.dev_attrs?? ??? ?= i2c_adapter_attrs,
};
static struct i2c_driver dummy_driver = {
?? ?.driver.name?? ?= "dummy",
?? ?.probe?? ??? ?= dummy_probe,
?? ?.remove?? ??? ?= dummy_remove,
?? ?.id_table?? ?= dummy_id,
};
?
IIC子系統退出函數：
static void __exit i2c_exit(void)
{
?? ?i2c_del_driver(&dummy_driver);??????? //注銷IIC設備驅動程序，主要功能是去掉總線中的該設備驅動程序
?? ?class_unregister(&i2c_adapter_class);????????????? //注銷適配器類
?? ?bus_unregister(&i2c_bus_type);?????????????????????? //注銷I2C總線
}
?
適配器驅動程序是IIC設備驅動程序需要實現的主要驅動程序，這個驅動程序需要根據具體的適配器硬件來編寫。
I2c_adapter結構體為描述各種IIC適配器提供了“模板",它定義了注冊總線上所有設備的clients鏈表、指向具體IIC適配器的總線通信方法I2c_algorithm的algo指針、實現i2c總線的操作原子性的lock信號量。但i2c_adapter結構體只是所有適配器的共有屬性，并不能代表所有類型的適配器
?
s3c2440對應的適配器為：
struct s3c24xx_i2c {
?? ?spinlock_t?? ??? ?lock;?????????? //lock自旋鎖
?? ?wait_queue_head_t?? ?wait;?????? //等待隊列頭。由于IIC設備是低速設備，所以可以采取“阻塞-中斷”的驅動模型，即讀寫i2c設備的用戶程序在IIC設備操作期間進入阻塞狀態，待IIC操作完成后，總線適配器將引發中斷，再將相應的中斷處理函數中喚醒受阻的用戶進程。該隊列用來放阻塞的進程
?? ?unsigned int?? ??? ?suspended:1;???????? //設備是否掛起
?? ?struct i2c_msg?? ??? ?*msg;?????? //從適配器到設備一次傳輸的單位，用這個結構體將數據包裝起來便于操作 ，
?? ?unsigned int?? ??? ?msg_num;?????? //表示消息的個數
?? ?unsigned int?? ??? ?msg_idx;??????????? //表示第幾個消息。當完成一個消息后，該值增加
?? ?unsigned int?? ??? ?msg_ptr;??????????? //總是指向當前交互中要傳送、接受的下一個字節，在i2c_msg.buf中的偏移量位置
?? ?unsigned int?? ??? ?tx_setup;?????????? //表示寫IIC設備寄存器的一個時間，這里被設置為50ms
?? ?unsigned int?? ??? ?irq;???????????????????????? //適配器申請的中斷號
?? ?enum s3c24xx_i2c_state?? ?state;????? //表示IIC設備目前的狀態
?? ?unsigned long?? ??? ?clkrate;???????????? //時鐘速率
?? ?void __iomem?? ??? ?*regs;??????????? //IIC設備寄存器地址
?? ?struct clk?? ??? ?*clk;?????????????????????? //對應的時鐘
?? ?struct device?? ??? ?*dev;???????????????? //適配器對應的設備結構體
?? ?struct resource?? ??? ?*ioarea;??????????? //適配器的資源
?? ?struct i2c_adapter?? ?adap;????????????????? //適配器主體結構體
#ifdef CONFIG_CPU_FREQ
?? ?struct notifier_block?? ?freq_transition;
#endif
};
enum s3c24xx_i2c_state {
?? ?STATE_IDLE,
?? ?STATE_START,
?? ?STATE_READ,
?? ?STATE_WRITE,
?? ?STATE_STOP
};
?
struct? i2c_msg
{
???????? __u16?? addr;??????????????????????????????? //IIC設備地址。 這個字段說明一個適配器在獲得總線控制權后，可以與多個IIC設備進行交互。
???????? __u16?? flags;??????????????????????????????? //消息類型標志 。??????
#define? I2C_M_TEN???????? 0x0010??????? //這是有10位地址芯片
#define? I2C_M_RD??????????? 0x0001?????? //表示從 從機到主機讀數據
#define? I2C_M_NOSTART?????? 0x4000????????????????? // FUNC_PROTOCOL_MANLING協議的相關標志
#define? I2C_M_REV_DIR_ADDR?? 0x2000????????? //FUNC_PROTOCOL_MANLING協議的相關標志
#define? I2C_M_IGNORE_NAK???????? 0x1000???????? //FUNC_PROTOCOL_MANLING協議的相關標志
#define? I2C_M_NO_RD_ACK?????????? 0x0800???????? //FUNC_PROTOCOL_MANLING協議的相關標志
#define? I2C_M_RECV_LEN??????????? 0x0400????????? //第一次接收的字節長度
??????? __u16??? len;????????????????????????????????????????????????? //消息字節長度
??????? __u8?????? * buf;?????????????????????????????????????????????? //指向消息數據的緩沖區
};
?
當拿到一塊新的電路板，并研究了響應的IIC適配器之后，就應該使用內核提供的框架函數向IIC子系統添加一個新的適配器
過程：
1，分配一個IIC適配器，并初始化相應的變量
2，使用i2c_add_adapter()函數向IIC子系統添加適配器結構體i2c_adapter。這個結構體已經在第一步初始化了：
int i2c_add_adapter(struct i2c_adapter *adapter)
{
?? ?int?? ?id, res = 0;
retry:
?? ?if (idr_pre_get(&i2c_adapter_idr, GFP_KERNEL) == 0)?????????? //存放分配ID號的內存
?? ??? ?return -ENOMEM;?????????????????????????? //內存分配失敗
?? ?mutex_lock(&core_lock);?????????? //鎖定內核鎖
?? ?/* "above" here means "above or equal to", sigh */
?? ?res = idr_get_new_above(&i2c_adapter_idr, adapter,
?? ??? ??? ??? ?__i2c_first_dynamic_bus_num, &id);??????????? //分配ID號，并將ID號和指針關聯
?? ?mutex_unlock(&core_lock);?????????? //釋放內核鎖
?? ?if (res < 0) {
?? ??? ?if (res == -EAGAIN)
?? ??? ??? ?goto retry;???????????????????????????????????????????????????????????????????? //分配失敗，重試
?? ??? ?return res;
?? ?}
?? ?adapter->nr = id;
?? ?return i2c_register_adapter(adapter);?????????????????????? // 注冊適配器設備
}
?
關于IDR機制，請參考：http://www.cnblogs.com/lfsblack/archive/2012/09/15/2686557.html
static DEFINE_IDR(i2c_adapter_idr);
通過ID號獲得適配器指針：
struct i2c_adapter* i2c_get_adapter(int id)
{
?? ?struct i2c_adapter *adapter;????????????????? //適配器指針
?? ?mutex_lock(&core_lock);?????????? //鎖定內核鎖
?? ?adapter = (struct i2c_adapter *)idr_find(&i2c_adapter_idr, id);????????? //通過ID號，查詢適配器指針
?? ?if (adapter && !try_module_get(adapter->owner))????????????? //適配器引用計數+1
?? ??? ?adapter = NULL;
?? ?mutex_unlock(&core_lock);??????????????????????????? //釋放內核鎖
?? ?return adapter;
}
適配器卸載函數：
主要任務：注銷適配器的數據結構，刪除總線上的所有設備的I2c_client數據結構和對應的i2c_driver驅動程序，并減少其代表總線上所有設備的相應驅動程序數據結構的引用計數（如果到達0，則卸載設備驅動程序）：
int i2c_del_adapter(struct i2c_adapter *adap)
{
?? ?struct i2c_client *client, *_n;
?? ?int res = 0;
?? ?mutex_lock(&core_lock);
?? ?/* First make sure that this adapter was ever added */
?? ?if (idr_find(&i2c_adapter_idr, adap->nr) != adap) {????????????????????????? //查找要卸載的適配器
?? ??? ?pr_debug("i2c-core: attempting to delete unregistered "
?? ??? ??? ? "adapter [%s]\n", adap->name);
?? ??? ?res = -EINVAL;
?? ??? ?goto out_unlock;
?? ?}
?? ?/* Tell drivers about this removal */
?? ?res = bus_for_each_drv(&i2c_bus_type, NULL, adap,
?? ??? ??? ??????? i2c_do_del_adapter);
?? ?if (res)
?? ??? ?goto out_unlock;
?? ?/* detach any active clients. This must be done first, because
?? ? * it can fail; in which case we give up. */
?? ?list_for_each_entry_safe_reverse(client, _n, &adap->clients, list) {
?? ??? ?struct i2c_driver?? ?*driver;
?? ??? ?driver = client->driver;
?? ??? ?/* new style, follow standard driver model */
?? ??? ?if (!driver || is_newstyle_driver(driver)) {
?? ??? ??? ?i2c_unregister_device(client);
?? ??? ??? ?continue;
?? ??? ?}
?? ??? ?/* legacy drivers create and remove clients themselves */
?? ??? ?if ((res = driver->detach_client(client))) {
?? ??? ??? ?dev_err(&adap->dev, "detach_client failed for client "
?? ??? ??? ??? ?"[%s] at address 0x%02x\n", client->name,
?? ??? ??? ??? ?client->addr);
?? ??? ??? ?goto out_unlock;
?? ??? ?}
?? ?}
?? ?/* clean up the sysfs representation */
?? ?init_completion(&adap->dev_released);
?? ?device_unregister(&adap->dev);???????????????????????????? 設備注銷
?? ?/* wait for sysfs to drop all references */
?? ?wait_for_completion(&adap->dev_released);
?? ?/* free bus id */
?? ?idr_remove(&i2c_adapter_idr, adap->nr);????????????????????? //刪除IDR，ID號
?? ?dev_dbg(&adap->dev, "adapter [%s] unregistered\n", adap->name);
?? ?/* Clear the device structure in case this adapter is ever going to be
?? ??? added again */
?? ?memset(&adap->dev, 0, sizeof(adap->dev));
?out_unlock:
?? ?mutex_unlock(&core_lock);
?? ?return res;
}
IIC總線通信方法s3c24xx_i2c_algorithm結構體：
static const struct i2c_algorithm s3c24xx_i2c_algorithm = {
?? ?.master_xfer?? ??? ?= s3c24xx_i2c_xfer,
?? ?.functionality?? ??? ?= s3c24xx_i2c_func,
};
這里只實現了IIC總線通信協議
通信方法因不同的適配器有所不同，要跟據具體的硬件來實現
協議支持函數s3c24xx_i2c_func()
該函數返回總線支持的協議，如I2C_FUNC_I2C、I2C_FUNC_SMBUS_EMUL、I2C_FUNC_PROTOCOL_MANGLING協議：
static u32 s3c24xx_i2c_func(struct i2c_adapter *adap)
{
?? ?return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL | I2C_FUNC_PROTOCOL_MANGLING;
}
傳輸函數s3c24xx_i2c_xfer():
static int s3c24xx_i2c_xfer(struct i2c_adapter *adap,
?? ??? ??? ?struct i2c_msg *msgs, int num)
{
?? ?struct s3c24xx_i2c *i2c = (struct s3c24xx_i2c *)adap->algo_data;??? //從適配器的私有數據中獲得適配器s3c24xx_i2c結構體
?? ?int retry;???????????????????????????????????????????????????????????????????????????????????????????? //傳輸錯誤重發次數
?? ?int ret;??????????????????????????????????????????????????????????????????????????????????????????????? //返回值
?? ?for (retry = 0; retry < adap->retries; retry++) {
?? ??? ?ret = s3c24xx_i2c_doxfer(i2c, msgs, num);?????????????????????????????????????? //傳輸到IIC設備的具體函數
?? ??? ?if (ret != -EAGAIN)
?? ??? ??? ?return ret;
?? ??? ?dev_dbg(i2c->dev, "Retrying transmission (%d)\n", retry);??????????????? //重試信息
?? ??? ?udelay(100);??????????????????????????????????????????????????????????????????????????????????? //延時100us
?? ?}
?? ?return -EREMOTEIO;?????????????????????????????????????????????????????????????????????? // I/O錯誤
}
真正的傳輸函數：
static int s3c24xx_i2c_doxfer(struct s3c24xx_i2c *i2c,
?? ??? ??? ?????? struct i2c_msg *msgs, int num)
{
?? ?unsigned long timeout;??????????????????????????????????????????????????????????????????????????????? //定義一個傳輸超時時間
?? ?int ret;????????????????????????????????????????????????????????????????????????????????????????????????????????? //返回值，傳輸消息的個數
?? ?if (i2c->suspended)????????????????????????????????????????????????????????????????????????????????????? //如果適配器處于掛起省電狀態，則返回
?? ??? ?return -EIO;
?? ?ret = s3c24xx_i2c_set_master(i2c);????????????????????????????????????????????????????????????? //將適配器設為主機發送狀態，判斷總線忙閑狀態
?? ?if (ret != 0) {????????????????????????????????????????????????????????????????????????????????????????????????? //如果總線繁忙，則傳輸失敗
?? ??? ?dev_err(i2c->dev, "cannot get bus (error %d)\n", ret);
?? ??? ?ret = -EAGAIN;
?? ??? ?goto out;
?? ?}
?? ?spin_lock_irq(&i2c->lock);???????????????????????????????????????????? //操作適配器的自旋鎖鎖定，每次只允許一個進程傳輸數據，其他進程無法獲得總線
?? ?i2c->msg???? = msgs;???????????????????????????????????????????????????? //傳輸的消息指針
?? ?i2c->msg_num = num;???????????????????????????????????????????????? //傳輸的消息個數
?? ?i2c->msg_ptr = 0;???????????????????????????????????????????????????????? //當前要傳輸的字節在消息中的偏移
?? ?i2c->msg_idx = 0;???????????????????????????????????????????????????????? //消息數組的索引
?? ?i2c->state?? = STATE_START;
?? ?s3c24xx_i2c_enable_irq(i2c);????????????????????????????????????? //啟動適配器中斷信號，允許適配器發出中斷
?? ?s3c24xx_i2c_message_start(i2c, msgs);???????????????????? //當調用該函數啟動 數據發送后，當前進程進入睡眠狀態，等待中斷到來，所以通過wait_event_timeout()函數將自己掛起到s3c24xx_i2c.wait等待隊列上，直到等待的條件"i2c->msg_num == 0"為真，或者5s超時后才能喚醒。注意一次i2c操作可能要涉及多個字節，只有第一個字節發送是在當前進程的文件系統操作執行流中進行的，該字節操作的完成及后繼字節的寫入都由中斷處理程序來完成。在此期間當前進程掛起在s3c24xx_i2c.wait等待隊列上
?? ?spin_unlock_irq(&i2c->lock);
?? ?timeout = wait_event_timeout(i2c->wait, i2c->msg_num == 0, HZ * 5);
?? ?ret = i2c->msg_idx;
?? ?/* having these next two as dev_err() makes life very
?? ? * noisy when doing an i2cdetect */
?? ?if (timeout == 0)????????????????????????????????????????????????????????????????? //在規定的時間內，沒有成功的寫入數據
?? ??? ?dev_dbg(i2c->dev, "timeout\n");
?? ?else if (ret != num)?????????????????????????????????????????????????????????????? //未寫完規定的消息個數，則失敗
?? ??? ?dev_dbg(i2c->dev, "incomplete xfer (%d)\n", ret);
?? ?/* ensure the stop has been through the bus */
?? ?msleep(1);????????????????????????????????????????????????????????????????????????? //睡眠1ms，使總線停止
?out:
?? ?return ret;
}
?
enum s3c24xx_i2c_state {
?? ?STATE_IDLE,??????????????????? //總線空閑狀態
?? ?STATE_START,??????????????? //總線開始狀態
?? ?STATE_READ,????????????????? //總線寫數據狀態
?? ?STATE_WRITE,??????????????? //總線讀書據狀態
?? ?STATE_STOP?????????????????? //總線停止狀態
};
?
判斷總線閑忙狀態s3c24xx_i2c_set_master()：
在適配器發送數據以前，需要判斷總線的忙閑狀態。讀取IICSTAT寄存器的[5]位，可以判斷總線的忙閑狀態。當為0時，總線空閑；當為1時總線繁忙：
static int s3c24xx_i2c_set_master(struct s3c24xx_i2c *i2c)
{
?? ?unsigned long iicstat;?????????????????????????????????? //用于存儲IICSTAT的狀態
?? ?int timeout = 400;???????????????????????????????????????? //嘗試400次，獲得總線
?? ?while (timeout-- > 0) {
?? ??? ?iicstat = readl(i2c->regs + S3C2410_IICSTAT);??????????????????? //讀取寄存器IICSTAT的值
?? ??? ?if (!(iicstat & S3C2410_IICSTAT_BUSBUSY))???????????????????????????????? //檢查第5位是否為0
?? ??? ??? ?return 0;
?? ??? ?msleep(1);???????????????????????????????????????????????????????????????????????????????? //等待1ms
?? ?}
?? ?return -ETIMEDOUT;
}
?
適配器使能函數s3c24xx_i2c_enable_irq()
IIC設備是一種慢速設備，所以在讀寫數據的過程中，內核進程需要睡眠等待。當數據發送完后，會從總線發送一個中斷信號，喚醒睡眠中的進程，所以適配器應該使能中斷。中斷使能由IICCON寄存器的[5]位設置，該位為0表示Tx/Rx中斷禁止；該位為1表示Tx/Rx中斷使能。s3c24xx_i2c_enable_irq（）函數用來使中斷使能。所以向IICCON寄存器的位[5]寫1：
static inline void s3c24xx_i2c_enable_irq(struct s3c24xx_i2c *i2c)
{
?? ?unsigned long tmp;?????????????????????? //寄存器緩存變量
?? ?tmp = readl(i2c->regs + S3C2410_IICCON);???????????? //讀IICCON寄存器
?? ?writel(tmp | S3C2410_IICCON_IRQEN, i2c->regs + S3C2410_IICCON);??????? //將IICCON的第5位置1
}
?
啟動適配器消息傳輸函數s3c24xx_i2c_message_start():
s3c24xx_i2c_message_start（）函數寫s3c2440適配器對應的寄存器，向IIC設備傳遞開始位和IIC設備地址。主要功能：
1，s3c2440的適配器對應的IICON和IICSTAT寄存器
2，寫從設備地址，并發出開始信號S
static void s3c24xx_i2c_message_start(struct s3c24xx_i2c *i2c,
?? ??? ??? ??? ?????? struct i2c_msg *msg)
{
?? ?unsigned int addr = (msg->addr & 0x7f) << 1;???????????????? //取從設備的低7位地址，并向前移動一位。設置設備地址，前7位表示設備地址，最后一位表示讀寫，0寫1讀
?? ?unsigned long stat;?????????????????????????????????????????????????????????? //緩存IICSTAT寄存器
?? ?unsigned long iiccon;??????????????????????????????????????????????????????? //緩存IICCO寄存器
?? ?stat = 0;???????????????????????????????????????????????????????????????????????????? //狀態初始化為0
?? ?stat |=? S3C2410_IICSTAT_TXRXEN;?????????????????????????????? //使能接收和發送功能，是適配器可以收發數據
?? ?if (msg->flags & I2C_M_RD) {????????????????????????????????????????? //如果消息類型是從IIC設備到適配器讀數據
?? ??? ?stat |= S3C2410_IICSTAT_MASTER_RX;?????????????????? //將適配器設置為主機接收器
?? ??? ?addr |= 1;??????????????????????????????????????????????????????????????????? //將地址的最低位置1表示讀操作
?? ?} else??????????????????????????????????????????????????????????????? //否則
?? ??? ?stat |= S3C2410_IICSTAT_MASTER_TX;?????????????????? //將適配器設置為主機發送器
?? ?if (msg->flags & I2C_M_REV_DIR_ADDR)??????????????????? 一種新的擴展協議，沒有設置該標志
?? ??? ?addr ^= 1;
?? ?/* todo - check for wether ack wanted or not */
?? ?s3c24xx_i2c_enable_ack(i2c);?????????????????????????????????? //使能ACK響應信號
?? ?iiccon = readl(i2c->regs + S3C2410_IICCON);????????????? //讀出IICCON寄存器的值
?? ?writel(stat, i2c->regs + S3C2410_IICSTAT);????????????????????????????? //設置IICSTAT的值，使其為主機發送器，接收使能
?? ?dev_dbg(i2c->dev, "START: %08lx to IICSTAT, %02x to DS\n", stat, addr);????????? //打印調試信息
?? ?writeb(addr, i2c->regs + S3C2410_IICDS);????????????????????????????????????????????????? //寫地址寄存器的值。將IIC設備地址寫入IICDS寄存器中，寄存器值[7:1]表示設備地址。IICADD寄存器必須在輸出使能為IICSTAT[4]為0時，才可以寫入，所以上面的writel函數設置使能為輸出使能為IISTAT[4]。
?? ?/* delay here to ensure the data byte has gotten onto the bus
?? ? * before the transaction is started */
?? ?ndelay(i2c->tx_setup);???????????????????????????????????????????????????? //延時，以使數據寫入寄存器中
?? ?dev_dbg(i2c->dev, "iiccon, %08lx\n", iiccon);
?? ?writel(iiccon, i2c->regs + S3C2410_IICCON);????????????????????????????????? //寫IICCON寄存器的值
?? ?stat |= S3C2410_IICSTAT_START;??????????????????????????????? //設置為啟動狀態
?? ?writel(stat, i2c->regs + S3C2410_IICSTAT);????????????????????? //發出S開始信號，當S信號發出后,IICDS寄存器的數據將自動發出到總線上
}
static inline void s3c24xx_i2c_enable_ack(struct s3c24xx_i2c *i2c)??? //使能ACK響應信號
{
?? ?unsigned long tmp;???????????????????????????? //暫存IICCON寄存器
?? ?tmp = readl(i2c->regs + S3C2410_IICCON);???????????? //取出IICCON寄存器的值
?? ?writel(tmp | S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);? 寫IICCON，使能ACK
}
適配器中斷處理函數：s3c24xx_i2c_irq()
順著通信函數s3c24xx_i2c_xfer()的執行流程分析，函數最終會返回，但并沒有傳輸數據。傳輸數據的過程被交到了中斷處理函數中。這是因為IIC設備的讀寫是非常慢的，需要使用中斷的方法提高處理器的效率，這在操作系統的過程中非常常見。
通過s3c24xx_i2c_algorithm通信方法中函數的調用關系，數據通信的過程如下：
1，傳輸數據時，調用s3c24xx_i2c_algorithm結構體中的數據傳輸函數s3c24xx_i2c_xfer()
2，s3c24xx_i2c_xfer()中會調用s3c24xx_i2c_doxfer()進行數據的傳輸
3，s3c24xx_i2c_doxfer（）中向總線 發送IIC設備地址和開始信號S后，便會調用wati_event_timeout()函數進入等待狀態
4，將數據準備好發送時，將產生中斷，并調用實現注冊的中斷處理函數s3c24xx_i2c_irq()
5，s3c24xx_i2c_irq()調用下一個字節傳輸函數i2s_s3c_irq_nextbyte()來傳輸數據
6，當數據傳輸完成后，會調用 s3c24xx_i2c_stop().
7，最后調用wake_up()喚醒等待隊列，完成數據的傳輸過程
?
當s3c2440的IIC適配器處于主機模式時，IIC操作的第一步總是向IIC總線寫入設備的地址及開始信號。這步由s3c24xx_i2c_set_master()和s3c24xx_i2c_message_start()完成。而收發數據的后繼操作在IIC中斷處理程序s3c24xx_i2c_irq()中完成的
中斷處理函數：
IIC中斷的產生有3種情況：
1，當總線仲裁失敗時產生中斷
2，當發送/接受完一個字節的數據（包括響應位）時產生中斷
3，當發出地址信息或接收到一個IIC設備地址并且吻合時產生中斷
在這3種情況下都觸發中斷，由于當發送/接收完一個字節后會產生中斷，所以可以在中斷處理函數中處理數據的傳輸：
static irqreturn_t s3c24xx_i2c_irq(int irqno, void *dev_id)
{
?? ?struct s3c24xx_i2c *i2c = dev_id;???????????????????????????????
?? ?unsigned long status;????????????????????????????????? //緩存IICSTAT
?? ?unsigned long tmp;???????????????????????????????????? //緩存寄存器
?? ?status = readl(i2c->regs + S3C2410_IICSTAT);???????????????????? //讀取IICSTAT的值
?? ?if (status & S3C2410_IICSTAT_ARBITR) {?????????????? //因仲裁失敗引發的中斷，IICSTAT[3]為0，表示仲裁成功，為1，表示失敗
?? ??? ?/* deal with arbitration loss */
?? ??? ?dev_err(i2c->dev, "deal with arbitration loss\n");
?? ?}
?? ?if (i2c->state == STATE_IDLE) {?????? 當總線為空閑狀態時，由于非讀寫引起的中斷，將會執行下面的分支清除中斷信號，繼續傳輸數據。這種中斷一般由總線仲裁引起，不會涉及數據的發送，所以清除中斷標志后，直接跳出。IICCON[4]為1表示發生中斷，總線上的數據傳輸停止。要使繼續傳輸數據，需要寫入0清除
?? ??? ?dev_dbg(i2c->dev, "IRQ: error i2c->state == IDLE\n");
?? ??? ?tmp = readl(i2c->regs + S3C2410_IICCON);?????????????????????? //讀IICCON寄存器
?? ??? ?tmp &= ~S3C2410_IICCON_IRQPEND;???????????????????????????? //將 IICCON的位[4]清零，表示清除中斷
?? ??? ?writel(tmp, i2c->regs +? S3C2410_IICCON);???????????????????????? //寫IICCON寄存器
?? ??? ?goto out;?????????????????????????????????????????????????????????????????????????????? //跳到退出直接返回
?? ?}
?? ?/* pretty much this leaves us with the fact that we've
?? ? * transmitted or received whatever byte we last sent */
?? ?i2s_s3c_irq_nextbyte(i2c, status);????????????????????? //傳輸或者接收下一個字節
?out:
?? ?return IRQ_HANDLED;
}
字節傳輸函數：i2s_s3c_irq_nextbyte():
static int i2s_s3c_irq_nextbyte(struct s3c24xx_i2c *i2c, unsigned long iicstat)
{
?? ?unsigned long tmp;????????????????????????????????????????? //寄存器緩存
?? ?unsigned char byte;???????????????????????????????????????? //寄存器緩存
?? ?int ret = 0;
?? ?switch (i2c->state) {??????????????????????????????????
?? ?case STATE_IDLE:???????????????????????????????????????????? //總線上沒有數據傳輸，則立即返回
?? ??? ?dev_err(i2c->dev, "%s: called in STATE_IDLE\n", __func__);
?? ??? ?goto out;
?? ??? ?break;
?? ?case STATE_STOP:???????????????????????????????????????????? //發出停止信號P ，IIC設備處于停止狀態，發送一個停止信號給IIC適配器。這是即使有數據產生，也不會產生中斷信號
?? ??? ?dev_err(i2c->dev, "%s: called in STATE_STOP\n", __func__);
?? ??? ?s3c24xx_i2c_disable_irq(i2c);????????????????????????? //接收和發送數據時，將不會產生中斷
?? ??? ?goto out_ack;
?? ?case STATE_START:??????????????????????????????????????????? //發出開始信號S
?? ??? ?/* last thing we did was send a start condition on the
?? ??? ? * bus, or started a new i2c message
?? ??? ? */
?? ??? ?if (iicstat & S3C2410_IICSTAT_LASTBIT &&
?? ??? ???? !(i2c->msg->flags & I2C_M_IGNORE_NAK)) {??? //當沒有接收到IIC設備的應答ACK信號，說明對應地址的IIC設備不存在，停止總線工作
?? ??? ??? ?/* ack was not received... */
?? ??? ??? ?dev_dbg(i2c->dev, "ack was not received\n");
?? ??? ??? ?s3c24xx_i2c_stop(i2c, -ENXIO);?????????????????? //停止總線工作，發出P信號
?? ??? ??? ?goto out_ack;
?? ??? ?}
?? ??? ?if (i2c->msg->flags & I2C_M_RD)????????????????????? //一個讀信息
?? ??? ??? ?i2c->state = STATE_READ;
?? ??? ?else
?? ??? ??? ?i2c->state = STATE_WRITE;???????????????????????? 一個寫消息
?? ??? ?/* terminate the transfer if there is nothing to do
?? ??? ? * as this is used by the i2c probe to find devices. */
?? ??? ?if (is_lastmsg(i2c) && i2c->msg->len == 0) {????????? //is_lastmsg()判斷是否只有一條消息，如果這條消息為0字節，那么發送停止信號P。0長度信息用于設備探測probe（）時檢測設備
?? ??? ??? ?s3c24xx_i2c_stop(i2c, 0);
?? ??? ??? ?goto out_ack;
?? ??? ?}
?? ??? ?if (i2c->state == STATE_READ)
?? ??? ??? ?goto prepare_read;???????????????????????????? //直接跳到讀命令去
?? ??? ?/* fall through to the write state, as we will need to
?? ??? ? * send a byte as well */
?? ?case STATE_WRITE:
?? ??? ?/* we are writing data to the device... check for the
?? ??? ? * end of the message, and if so, work out what to do
?? ??? ? */
?? ??? ?if (!(i2c->msg->flags & I2C_M_IGNORE_NAK)) {????? //沒有接收到IIC設備的ACK信號，表示出錯，停止總線傳輸
?? ??? ??? ?if (iicstat & S3C2410_IICSTAT_LASTBIT) {??????????? //
?? ??? ??? ??? ?dev_dbg(i2c->dev, "WRITE: No Ack\n");
?? ??? ??? ??? ?s3c24xx_i2c_stop(i2c, -ECONNREFUSED);
?? ??? ??? ??? ?goto out_ack;
?? ??? ??? ?}
?? ??? ?}
?retry_write:
判斷一個消息是否結束，如果沒有，則執行下面的分支
?? ??? ?if (!is_msgend(i2c)) {
?? ??? ??? ?byte = i2c->msg->buf[i2c->msg_ptr++];???????? //讀出緩沖區中的數據，并增加偏移
?? ??? ??? ?writeb(byte, i2c->regs + S3C2410_IICDS);??? //將一個字節的數據寫到IICDS中
?? ??? ??? ?/* delay after writing the byte to allow the
?? ??? ??? ? * data setup time on the bus, as writing the
?? ??? ??? ? * data to the register causes the first bit
?? ??? ??? ? * to appear on SDA, and SCL will change as
?? ??? ??? ? * soon as the interrupt is acknowledged */
?? ??? ??? ?ndelay(i2c->tx_setup);??????????? //等待數據發送到總線
?? ??? ?} else if (!is_lastmsg(i2c)) {?????????????????? //如果不是最后一個消息，則移向下一個消息
?? ??? ??? ?/* we need to go to the next i2c message */
?? ??? ??? ?dev_dbg(i2c->dev, "WRITE: Next Message\n");
?? ??? ??? ?i2c->msg_ptr = 0;
?? ??? ??? ?i2c->msg_idx++;
?? ??? ??? ?i2c->msg++;
?? ??? ??? ?/* check to see if we need to do another message */
?? ??? ??? ?if (i2c->msg->flags & I2C_M_NOSTART) {????? //不處理這種新類型的消息，直接停止
?? ??? ??? ??? ?if (i2c->msg->flags & I2C_M_RD) {
?? ??? ??? ??? ??? ?/* cannot do this, the controller
?? ??? ??? ??? ??? ? * forces us to send a new START
?? ??? ??? ??? ??? ? * when we change direction */
?? ??? ??? ??? ??? ?s3c24xx_i2c_stop(i2c, -EINVAL);
?? ??? ??? ??? ?}
?? ??? ??? ??? ?goto retry_write;
?? ??? ??? ?} else {???????????? //開始傳輸消息，將IICDS的數據發到總線上
?? ??? ??? ??? ?/* send the new start */
?? ??? ??? ??? ?s3c24xx_i2c_message_start(i2c, i2c->msg);??????????
?? ??? ??? ??? ?i2c->state = STATE_START;?????????????? //置開始狀態
?? ??? ??? ?}
?? ??? ?} else {
?? ??? ??? ?/* send stop */
?? ??? ??? ?s3c24xx_i2c_stop(i2c, 0);????????????? //所有消息傳遞結束，停止總線
?? ??? ?}
?? ??? ?break;
?? ?case STATE_READ:????????????????????????????????? //讀數據
?? ??? ?/* we have a byte of data in the data register, do
?? ??? ? * something with it, and then work out wether we are
?? ??? ? * going to do any more read/write
?? ??? ? */
?? ??? ?byte = readb(i2c->regs + S3C2410_IICDS);?????????????? //從數據寄存器讀出數據
?? ??? ?i2c->msg->buf[i2c->msg_ptr++] = byte;?????????????????????? //放到緩沖區
?prepare_read:
?? ??? ?if (is_msglast(i2c)) {???????????????????????????????? //一個消息的最后一個字節
?? ??? ??? ?/* last byte of buffer */
?? ??? ??? ?if (is_lastmsg(i2c))?????????????????????????????? //最后一個消息
?? ??? ??? ??? ?s3c24xx_i2c_disable_ack(i2c);???????????? //禁止ACK信號
?? ??? ?} else if (is_msgend(i2c)) {?????????????????????????????? //讀完一個消息
?? ??? ??? ?/* ok, we've read the entire buffer, see if there
?? ??? ??? ? * is anything else we need to do */
?? ??? ??? ?if (is_lastmsg(i2c)) {?????????????????????????????? //最后一個消息
?? ??? ??? ??? ?/* last message, send stop and complete */
?? ??? ??? ??? ?dev_dbg(i2c->dev, "READ: Send Stop\n");
?? ??? ??? ??? ?s3c24xx_i2c_stop(i2c, 0);??????? //發出停止信號，并喚醒對立
?? ??? ??? ?} else {????????? //傳輸下一個消息
?? ??? ??? ??? ?/* go to the next transfer */
?? ??? ??? ??? ?dev_dbg(i2c->dev, "READ: Next Transfer\n");
?? ??? ??? ??? ?i2c->msg_ptr = 0;
?? ??? ??? ??? ?i2c->msg_idx++;???????????????????????????? //移到下一個消息索引
?? ??? ??? ??? ?i2c->msg++;?????????????????????????????????? //移到下一個消息
?? ??? ??? ?}
?? ??? ?}
?? ??? ?break;
?? ?}
?? ?/* acknowlegde the IRQ and get back on with the work */
?out_ack:?????????????????????? //清除中斷，不然重復執行該中斷函數
?? ?tmp = readl(i2c->regs + S3C2410_IICCON);
?? ?tmp &= ~S3C2410_IICCON_IRQPEND;
?? ?writel(tmp, i2c->regs + S3C2410_IICCON);
?out:
?? ?return ret;
}
適配器傳輸停止函數：s3c24xx_i2c_stop()
主要完成以下功能：
1，向總線發出結束P信號
2，喚醒等待在隊列s3c24xx_i2c->wait中的進程，一次傳輸完畢
3，禁止中斷 ，適配器中不產生中斷信號
static inline void s3c24xx_i2c_stop(struct s3c24xx_i2c *i2c, int ret)
{
?? ?unsigned long iicstat = readl(i2c->regs + S3C2410_IICSTAT);???????????????? //讀IICSTAT寄存器
?? ?dev_dbg(i2c->dev, "STOP\n");
?? ?/* stop the transfer */
?? ?iicstat &= ~S3C2410_IICSTAT_START;??????????????????????????????????????? //寫IICSTAT[5]為0，則放出P信號
?? ?writel(iicstat, i2c->regs + S3C2410_IICSTAT);
?? ?i2c->state = STATE_STOP;???????????????????????????????????????????????????????? //設置適配器為停止狀態
?? ?s3c24xx_i2c_master_complete(i2c, ret);?????????????????????????????????????? //喚醒傳輸等待隊列中的進程
?? ?s3c24xx_i2c_disable_irq(i2c);?????????????????????????????????????????????????????? //禁止中斷
}
?
static inline void s3c24xx_i2c_master_complete(struct s3c24xx_i2c *i2c, int ret)
{
?? ?dev_dbg(i2c->dev, "master_complete %d\n", ret);
?? ?i2c->msg_ptr = 0;
?? ?i2c->msg = NULL;
?? ?i2c->msg_idx++;
?? ?i2c->msg_num = 0;??????????? //表示適配器中已經沒有待傳輸的消息
?? ?if (ret)
?? ??? ?i2c->msg_idx = ret;
?? ?wake_up(&i2c->wait);???????????? //喚醒等待隊列中的進程
}
幾個小函數：
static inline int is_lastmsg(struct s3c24xx_i2c *i2c)???????????????? //用來判斷當前處理的消息是否為最后一個消息
{
?? ?return i2c->msg_idx >= (i2c->msg_num - 1);
}
static inline int is_msgend(struct s3c24xx_i2c *i2c)???????? //判斷當前消息是否已經傳輸完所有字節
{
?? ?return i2c->msg_ptr >= i2c->msg->len;
}
static inline int is_msglast(struct s3c24xx_i2c *i2c)???????????? //判斷當前是否正在處理當前消息的最后一個字節
{
?? ?return i2c->msg_ptr == i2c->msg->len-1;
}
static inline void s3c24xx_i2c_disable_ack(struct s3c24xx_i2c *i2c)???????????? //禁止適配器發出應答信號
{
?? ?unsigned long tmp;
?? ?tmp = readl(i2c->regs + S3C2410_IICCON);????????????????? //?? IICCON[7]為0，表示不發出ACK信號
?? ?writel(tmp & ~S3C2410_IICCON_ACKEN, i2c->regs + S3C2410_IICCON);
}
?
IIC設備層驅動程序：
IIC設備驅動被作為一個單獨的模塊加入進內核，在模塊的加載和卸載函數中需要注冊和注銷一個平臺驅動結構體platform_driver。
static int __init i2c_adap_s3c_init(void)
{
?? ?int ret;???????????????????????????????????????????????????????????????? //返回值
?? ?ret = platform_driver_register(&s3c2410_i2c_driver);??? //注冊驅動程序 。該函數將平臺驅動添加到虛擬的總線上，以便與設備進行關聯。platform_driver_register()函數中會調用s3c2410_i2c_driver中定義的s3c24xx_i2c_probe()函數進行設備探測，從而將驅動和設備都加入總線中 ?????????
?? ?if (ret == 0) {
?? ??? ?ret = platform_driver_register(&s3c2440_i2c_driver);?????????????? //再次注冊
?? ??? ?if (ret)
?? ??? ??? ?platform_driver_unregister(&s3c2410_i2c_driver);?????????????? //注銷驅動程序
?? ?}
?? ?return ret;
}
初始化函數為什么兩次調用platform_driver_register()函數，這是因為第一個返回0，表示驅動注冊成功，但并不表示探測函數s3c24xx_i2c_probe()探測IIC設備成功，有可能第一次注冊時因為硬件被占用而探測函數失敗，所以為了保證探測的成功率，又一次注冊并探測了一次設備。同樣卸載也要兩次
static void __exit i2c_adap_s3c_exit(void)
{
?? ?platform_driver_unregister(&s3c2410_i2c_driver);??????????? //注銷平臺驅動
?? ?platform_driver_unregister(&s3c2440_i2c_driver);
}
static struct platform_driver s3c2440_i2c_driver = {
?? ?.probe?? ??? ?= s3c24xx_i2c_probe,
?? ?.remove?? ??? ?= s3c24xx_i2c_remove,
?? ?.suspend_late?? ?= s3c24xx_i2c_suspend_late,
?? ?.resume?? ??? ?= s3c24xx_i2c_resume,
?? ?.driver?? ??? ?= {
?? ??? ?.owner?? ?= THIS_MODULE,
?? ??? ?.name?? ?= "s3c2440-i2c",
?? ?},
};
?
探測函數：s3c24xx_i2c_probe()
在該函數中將初始化適配器、IIC等硬件設備。主要完成如下功能：
1，申請一個適配器結構體I2c，并對其賦初值
2，獲得I2c時鐘資源
3，將適配器的寄存器資源映射到虛擬內存中
4，申請中斷處理函數
5，初始化IIC控制器
6，添加適配器I2c到內核
static int s3c24xx_i2c_probe(struct platform_device *pdev)
{
?? ?struct s3c24xx_i2c *i2c;????????????????? //適配器指針
?? ?struct s3c2410_platform_i2c *pdata;?????????????????????????????? //IIC平臺設備相關的數據
?? ?struct resource *res;????????????????????????????????? //指向資源
?? ?int ret;??????????????????????????????????????????????????????????????????? //返回值
?? ?pdata = pdev->dev.platform_data;??????????????????????????????? //獲得平臺設備數據結構指針
?? ?if (!pdata) {???????????????????????????????????????????????? //如果沒有數據，則出錯返回
?? ??? ?dev_err(&pdev->dev, "no platform data\n");
?? ??? ?return -EINVAL;
?? ?}
?? ?i2c = kzalloc(sizeof(struct s3c24xx_i2c), GFP_KERNEL);?????????????? //動態分配一個適配器數據結構，并對其動態賦值
?? ?if (!i2c) {?????????????????????????????????????????????????????????????????????????????????????????????? //內存不足，失敗
?? ??? ?dev_err(&pdev->dev, "no memory for state\n");
?? ??? ?return -ENOMEM;
?? ?}
?? ?strlcpy(i2c->adap.name, "s3c2410-i2c", sizeof(i2c->adap.name));??????????????????? //給適配器起名為s3c2410-i2c
?? ?i2c->adap.owner?? = THIS_MODULE;???????????????????????????????????????????????????? //模塊指針
?? ?i2c->adap.algo??? = &s3c24xx_i2c_algorithm;??????????????????????????? //給適配器的一個通信方法
?? ?i2c->adap.retries = 2;???????????????????????????? //2次總線仲裁嘗試
?? ?i2c->adap.class?? = I2C_CLASS_HWMON | I2C_CLASS_SPD;???????????????????????????? //定義適配器類
?? ?i2c->tx_setup???? = 50;???????????????????? //數據從適配器傳輸到總線的時間為50ns
?? ?spin_lock_init(&i2c->lock);?????????????????????? //初始化自旋鎖
?? ?init_waitqueue_head(&i2c->wait);????????????????????? //初始化等待隊列頭部
?? ?/* find the clock and enable it */????? //以下代碼找到i2c的時鐘，并且調用clk_enable()函數啟動它
?? ?i2c->dev = &pdev->dev;?????????????
?? ?i2c->clk = clk_get(&pdev->dev, "i2c");
?? ?if (IS_ERR(i2c->clk)) {
?? ??? ?dev_err(&pdev->dev, "cannot get clock\n");
?? ??? ?ret = -ENOENT;
?? ??? ?goto err_noclk;
?? ?}
?? ?dev_dbg(&pdev->dev, "clock source %p\n", i2c->clk);
?? ?clk_enable(i2c->clk);????????????????????????????? //啟動時鐘
?? ?/* map the registers */
?? ?res = platform_get_resource(pdev, IORESOURCE_MEM, 0);??????????????????????????????? //獲得適配器的寄存器資源
?? ?if (res == NULL) {??????????????????????????????????????????????????????????????????????????????????????????????????? //獲取資源失敗則退出
?? ??? ?dev_err(&pdev->dev, "cannot find IO resource\n");
?? ??? ?ret = -ENOENT;
?? ??? ?goto err_clk;
?? ?}
?? ?i2c->ioarea = request_mem_region(res->start, (res->end-res->start)+1,
?? ??? ??? ??? ??? ? pdev->name);?????????????????????????????????????????????????????????????????????????????????????????????????????????????? //申請一塊I/O內存，對應適配器的幾個寄存器
?? ?if (i2c->ioarea == NULL) {???????????????????????????????????????????????????????????????????????????????????????????????????????? //? I/O內存獲取失敗則退出
?? ??? ?dev_err(&pdev->dev, "cannot request IO\n");
?? ??? ?ret = -ENXIO;
?? ??? ?goto err_clk;
?? ?}
?? ?i2c->regs = ioremap(res->start, (res->end-res->start)+1);????????????????????????????????? //將設備內存映射到虛擬地址空間，這樣可以使用函數訪問
?? ?if (i2c->regs == NULL) {?????????????????????????????????????????????????????????????????????????????????????? //映射內存失敗則退出
?? ??? ?dev_err(&pdev->dev, "cannot map IO\n");
?? ??? ?ret = -ENXIO;
?? ??? ?goto err_ioarea;
?? ?}
?? ?dev_dbg(&pdev->dev, "registers %p (%p, %p)\n",
?? ??? ?i2c->regs, i2c->ioarea, res);???????????????????????????????????????????????????????????????????????????????? //輸出映射基地址，調試時用
?? ?/* setup info block for the i2c core */
?? ?i2c->adap.algo_data = i2c;??????????????????????????????????????????????????????????????????????????????????????????? //將私有數據指向適配器結構體
?? ?i2c->adap.dev.parent = &pdev->dev;???????????????????????????????????????????????????????????????????????????? //組織設備模型
?? ?/* initialise the i2c controller */
?? ?ret = s3c24xx_i2c_init(i2c);??????????????????????????????????????????????? //初始化IIC控制器
?? ?if (ret != 0)???????????????????????????? //初始化失敗
?? ??? ?goto err_iomap;
?? ?/* find the IRQ for this unit (note, this relies on the init call to
?? ? * ensure no current IRQs pending
?? ? */
?? ?i2c->irq = ret = platform_get_irq(pdev, 0);??????????????????????????????????? //獲得平臺設備的第一個中斷號
?? ?if (ret <= 0) {
?? ??? ?dev_err(&pdev->dev, "cannot find IRQ\n");
?? ??? ?goto err_iomap;
?? ?}
?? ?ret = request_irq(i2c->irq, s3c24xx_i2c_irq, IRQF_DISABLED,
?? ??? ??? ?? dev_name(&pdev->dev), i2c);???????????????????????????? //申請一個中斷處理函數，前面介紹過這個函數
?? ?if (ret != 0) {
?? ??? ?dev_err(&pdev->dev, "cannot claim IRQ %d\n", i2c->irq);
?? ??? ?goto err_iomap;
?? ?}
?? ?ret = s3c24xx_i2c_register_cpufreq(i2c);?????????????????????????????????? //在內核中注冊一個適配器使用的時鐘
?? ?if (ret < 0) {
?? ??? ?dev_err(&pdev->dev, "failed to register cpufreq notifier\n");
?? ??? ?goto err_irq;
?? ?}
?? ?/* Note, previous versions of the driver used i2c_add_adapter()
?? ? * to add the bus at any number. We now pass the bus number via
?? ? * the platform data, so if unset it will now default to always
?? ? * being bus 0.
?? ? */
?? ?i2c->adap.nr = pdata->bus_num;????????????????????????? //適配器的總線編號
?? ?ret = i2c_add_numbered_adapter(&i2c->adap);?????????????? //指定一個最好總線編號，向內核添加該適配器
?? ?if (ret < 0) {
?? ??? ?dev_err(&pdev->dev, "failed to add bus to i2c core\n");
?? ??? ?goto err_cpufreq;
?? ?}
?? ?platform_set_drvdata(pdev, i2c);?????????????? //設置平臺設備的私有數據為i2c適配器
?? ?dev_info(&pdev->dev, "%s: S3C I2C adapter\n", dev_name(&i2c->adap.dev));
?? ?return 0;????????????????????? //成功返回0
?err_cpufreq:
?? ?s3c24xx_i2c_deregister_cpufreq(i2c);??????????????????????????? //頻率注冊失敗
?err_irq:
?? ?free_irq(i2c->irq, i2c);?????????????????????????????????????????????????????? //中斷申請失敗
?err_iomap:
?? ?iounmap(i2c->regs);????????????????????????????????????????????????????????? //內存映射失敗
?err_ioarea:
?? ?release_resource(i2c->ioarea);????????????????????????????????????????? //清除資源
?? ?kfree(i2c->ioarea);
?err_clk:
?? ?clk_disable(i2c->clk);
?? ?clk_put(i2c->clk);
?err_noclk:
?? ?kfree(i2c);????????????????????????????????????????????????????????????????? //釋放i2c適配器結構體資源
?? ?return ret;
}
與s3c24xx_i2c_probe()函數相反功能的函數是移除函數：s3c24xx_i2c_remove()。它在模塊卸載函數調用platform_driver_unregister()函數時通過platform_driver的remove指針被調用。
static int s3c24xx_i2c_remove(struct platform_device *pdev)
{
?? ?struct s3c24xx_i2c *i2c = platform_get_drvdata(pdev);?????????????????????????????????? //得到適配器結構體指針
?? ?s3c24xx_i2c_deregister_cpufreq(i2c);???????????????????????????????????????????????????????????? //刪除內核維護的與適配器時鐘頻率有關的數據結構
?? ?i2c_del_adapter(&i2c->adap);???????????????????????????????????????????????????????????????????????????? //將適配器從系統中刪除
?? ?free_irq(i2c->irq, i2c);????????????????????????????????????????????????????????????????????????????????????? //關閉中斷
?? ?clk_disable(i2c->clk);???????????????????????????????????????????????????????????????????????????????????????? //關閉時鐘
?? ?clk_put(i2c->clk);??????????????????????????????????????????????????????????????????????????????????????????? //減少時鐘引用計數
?? ?iounmap(i2c->regs);????????????????????????????????????????????????????????????????????????????????????????? //關閉內存映射
?? ?release_resource(i2c->ioarea);????????????????????????????????????????????????????????????????????????? //釋放I/O資源
?? ?kfree(i2c->ioarea);?????????????????????????????????????????????????????????????????????????????????????????????? //釋放資源所占用的內存
?? ?kfree(i2c);???????????????????????????????????????????????????????????????????????????????????????????????????????? //釋放適配器的內存
?? ?return 0;
}
?
控制器初始化函數：s3c24xx_i2c_init()
static int s3c24xx_i2c_init(struct s3c24xx_i2c *i2c)
{
?? ?unsigned long iicon = S3C2410_IICCON_IRQEN | S3C2410_IICCON_ACKEN;? //設置IICCON[5]為1，表示發送和接收數據時，會引發中斷。設置[7]為1，表示需要發出ACK信號
?? ?struct s3c2410_platform_i2c *pdata;?????????? //平臺設備數據指針
?? ?unsigned int freq;???????????????????????????????????????? //控制器工作的頻率
?? ?/* get the plafrom data */
?? ?pdata = i2c->dev->platform_data;????????????????????? //得到平臺設備的數據
?? ?/* inititalise the gpio */
?? ?if (pdata->cfg_gpio)????????????????????????????????????????????? //初始化gpio引腳
?? ??? ?pdata->cfg_gpio(to_platform_device(i2c->dev));
?? ?/* write slave address */
?? ?writeb(pdata->slave_addr, i2c->regs + S3C2410_IICADD);??????????????? //向IICADD寫入IIC設備地址，IICADD的位[7:1]表示IIC設備地址
?? ?dev_info(i2c->dev, "slave address 0x%02x\n", pdata->slave_addr);????????????? //打印地址信息
?? ?writel(iicon, i2c->regs + S3C2410_IICCON);?????????????????????????????????????? //初始化IICCON寄存器，只允許ACK信號和中斷使能，其他為0
?? ?/* we need to work out the divisors for the clock... */
?? ?if (s3c24xx_i2c_clockrate(i2c, &freq) != 0) {????????????????????????????????????????? //設置時鐘源和時鐘頻率
?? ??? ?writel(0, i2c->regs + S3C2410_IICCON);??????????????????????????????????????? //失敗，則設置為0
?? ??? ?dev_err(i2c->dev, "cannot meet bus frequency required\n");
?? ??? ?return -EINVAL;
?? ?}
?? ?/* todo - check that the i2c lines aren't being dragged anywhere */
?? ?dev_info(i2c->dev, "bus frequency set to %d KHz\n", freq);????????????????????????? //打印頻率信息
?? ?dev_dbg(i2c->dev, "S3C2410_IICCON=0x%02lx\n", iicon);????????????????????????? //打印IICCON寄存器
?? ?/* check for s3c2440 i2c controller? */
?? ?if (s3c24xx_i2c_is2440(i2c)) {???????????????????????????????????????????????????????????????? //如果處理器是s3c2440,則設置IICLC寄存器為SDA延時時間
?? ??? ?dev_dbg(i2c->dev, "S3C2440_IICLC=%08x\n", pdata->sda_delay);
?? ??? ?writel(pdata->sda_delay, i2c->regs + S3C2440_IICLC);
?? ?}
?? ?return 0;
}
設置控制器數據發送頻率函數s3c24xx_i2c_clockrate()
在控制器初始化函數s3c24xx_i2c_init(),調用s3c24xx_i2c_clockrate()函數設置數據發送頻率。此發送頻率由IICCON寄存器控制。發送頻率可以由一個公式得到：
發送頻率 =? IICCLK? /? (IICCON[3:0] + 1)
IICCLK = PCLK / 16?? (當IICCON[6] == 0)
活IICCLK = PCLK / 512? (當IICCON[6] == 1)
PCLK是由clk_get_rate()函數獲得適配器的時鐘頻率。
第一個參數是適配器指針，第二個參數是返回的發送頻率：
static int s3c24xx_i2c_clockrate(struct s3c24xx_i2c *i2c, unsigned int *got)
{
?? ?struct s3c2410_platform_i2c *pdata = i2c->dev->platform_data;?????????????????? //得到平臺設備數據
?? ?unsigned long clkin = clk_get_rate(i2c->clk);????????????????????????????????????????????????? //獲得PCLK時鐘頻率
?? ?unsigned int divs, div1;
?? ?u32 iiccon;??????????????????????????????????????????????????????????????????????????????????????????????????????? //緩存IICCON
?? ?int freq;???????????????????????????????????????????????????????????????????????????????????????????????????????????? //計算的頻率
?? ?int start, end;???????????????????????????? //開始和結束頻率，用于尋找一個合適的頻率
?? ?i2c->clkrate = clkin;???????????????????????
?? ?clkin /= 1000;?? ??? ?/* clkin now in KHz */???????????? //將單位轉化為KH
?? ?dev_dbg(i2c->dev, "pdata %p, freq %lu %lu..%lu\n",
?? ??? ? pdata, pdata->bus_freq, pdata->min_freq, pdata->max_freq);????????????????????????? //打印總線，最大、最小頻率
?? ?if (pdata->bus_freq != 0) {
?? ??? ?freq = s3c24xx_i2c_calcdivisor(clkin, pdata->bus_freq/1000,
?? ??? ??? ??? ??? ??????? &div1, &divs);
?? ??? ?if (freq_acceptable(freq, pdata->bus_freq/1000))
?? ??? ??? ?goto found;
?? ?}
?? ?/* ok, we may have to search for something suitable... */
?? ?start = (pdata->max_freq == 0) ? pdata->bus_freq : pdata->max_freq;
?? ?end = pdata->min_freq;
?? ?start /= 1000;
?? ?end /= 1000;
?? ?/* search loop... */
?? ?for (; start > end; start--) {
?? ??? ?freq = s3c24xx_i2c_calcdivisor(clkin, start, &div1, &divs);
?? ??? ?if (freq_acceptable(freq, start))
?? ??? ??? ?goto found;
?? ?}
?? ?/* cannot find frequency spec */
?? ?return -EINVAL;?????????????????????????????? //不能找到一個合適的分配方式，返回錯誤
?found:??????????????????????????????????????????????? //找到一個合適的發送頻率，則寫IICCON寄存器中與時鐘相關的位
?? ?*got = freq;????????????????????????????????????? //got為從參數返回的頻率值
?? ?iiccon = readl(i2c->regs + S3C2410_IICCON);???????????????????????????????????? //讀出IICCON的值
?? ?iiccon &= ~(S3C2410_IICCON_SCALEMASK | S3C2410_IICCON_TXDIV_512);?????????????????? //將IICCON的[6]和[3:0]清零，以避免以前分頻系數的影響
?? ?iiccon |= (divs-1);????????????????????????????????????????????????????????????????????????????????????????????????????????????? //設置位[3:0]的分頻系數，divs的值 < 16
?? ?if (div1 == 512)??????????????????????????????????????????????????????????????????????????????????????????????????????????? //如果IICCLK為PCLK / 512 ，那么設置位[6]為1
?? ??? ?iiccon |= S3C2410_IICCON_TXDIV_512;
?? ?writel(iiccon, i2c->regs + S3C2410_IICCON);??????????????????????????????????????????????????? //重新寫IICCON寄存器的值
?? ?return 0;
}
?
static int s3c24xx_i2c_calcdivisor(unsigned long clkin, unsigned int wanted,
?? ??? ??? ??? ??? unsigned int *div1, unsigned int *divs)??????????????????????? //用來計算分頻系數
{
?? ?unsigned int calc_divs = clkin / wanted;????????????? //clkin表示輸入頻率，wanted表示想要分頻的系數
?? ?unsigned int calc_div1;
?? ?if (calc_divs > (16*16))??????????????????????????? //如果分頻系數大于256，那么就設置為512，為了2的冪次數
?? ??? ?calc_div1 = 512;
?? ?else
?? ??? ?calc_div1 = 16;
?? ?calc_divs += calc_div1-1;???????????????????? ? //按前面公式計算分頻系數
?? ?calc_divs /= calc_div1;
?? ?if (calc_divs == 0)????????????? //如果分頻系數不合法，調整合法
?? ??? ?calc_divs = 1;
?? ?if (calc_divs > 17)
?? ??? ?calc_divs = 17;
?? ?*divs = calc_divs;?????????????????????????????? //計算兩個分頻數
?? ?*div1 = calc_div1;
?? ?return clkin / (calc_divs * calc_div1);?????????????????????????? 得到最終的分頻系數，這個系數將寫入寄存器
}
轉載于:https://www.cnblogs.com/wanghuaijun/p/7189741.html
總結
- 上一篇： android 自己定义水平和圆形pro
- 下一篇： SimpliciTI简介