一、概述
談到在linux系統下編寫I2C驅動，目前主要有兩種方式，一種是把I2C設備當作一個 普通的字符設備來處理，另一種是利用linux I2C驅動體系結構來完成。下面比較下這兩種驅動。
第一種方法的好處（對應第二種方法的劣勢）有：
● 思路比較直接，不需要花時間去了解linux內核中複雜的I2C子系統的操作方法。
第一種方法問題（對應第二種方法的好處）有：
● 要求工程師不僅要對I2C設備的操作熟悉，而且要熟悉I2C的適配器操作；
● 要求工程師對I2C的設備器及I2C的設備操作方法都比較熟悉，最重要的是寫出的程序可移植性差；
● 對內核的資源無法直接使用。因爲內核提供的所有I2C設備器及設備驅動都是基於I2C子系統的格式。I2C適配器的操作簡單還
好，如果遇到複雜的I2C適配器（如：基於PCI的I2C適配器），工作量就會大很多。
本文針對的對象是熟悉I2C協議，並且想使用linux內核子系統的開發人員。
網絡和一些書籍上有介紹I2C子系統的源碼結構。但發現很多開發人員看了這些文章後，還是 不清楚自己究竟該做些什麼。究其原因還是沒弄清楚I2C子系統爲我們做了些什麼，以及我們怎樣利用I2C子系統。本文首先要解決是如何利用現有內核支持的 I2C適配器，完成對I2C設備的操作，然後再過度到適配器代碼的編寫。本文主要從解決問題的角度去寫，不會涉及特別詳細的代碼跟蹤。
二、I2C設備驅動程序編寫
首先要明確適配器驅動的作用是讓我們能夠通過它發出符合I2C標準協議的時序。
在Linux內核源代碼中的drivers/i2c/busses目錄下包含着一些適配器 的驅動。如S3C2410的驅動i2c-s3c2410.c。當適配器加載到內核後，接下來的工作就要針對具體的設備編寫設備驅動了。
編寫I2C設備驅動也有兩種方法。一種是利用系統給我們提供的i2c-dev.c來實現一 個i2c適配器的設備文件。然後通過在應用層操作i2c適配器來控制i2c設備。另一種是爲i2c設備，獨立編寫一個設備驅動。注意：在後一種情況下，是 不需要使用i2c-dev.c的。
1、利用i2c-dev.c操作適配器，進而控制i2c設備
i2c-dev.c並沒有針對特定的設備而設計，只是提供了通用的read()、 write()和ioctl()等接口，應用層可以借用這些接口訪問掛接在適配器上的i2c設備的存儲空間或寄存器，並控制I2C設備的工作方式。
需要特別注意的是：i2c-dev.c的read()、write()方法都只適合於如下 方式的數據格式（可查看內核相關源碼）
圖1 單開始信號時序
所以不具有太強的通用性，如下面這種情況就不適用（通常出現在讀目標時）。
圖2 多開始信號時序
而且read()、write()方法只適用用於適配器支持i2c算法的情況，如：
static const struct i2c_algorithm
s3c24xx_i2c_algorithm = {
.master_xfer = s3c24xx_i2c_xfer,
.functionality = s3c24xx_i2c_func,
};
而不適合適配器只支持smbus算法的情況，如：
static const struct i2c_algorithm
smbus_algorithm = {
.smbus_xfer = i801_access,
.functionality = i801_func,
};
基於上面幾個原因，所以一般都不會使用i2c-dev.c的read()、write() 方法。最常用的是ioctl()方法。ioctl()方法可以實現上面所有的情況（兩種數據格式、以及I2C算法和smbus算法）。
針對i2c的算法，需要熟悉struct i2c_rdwr_ioctl_data
、struct i2c_msg。使用的命令是I2C_RDWR。
struct i2c_rdwr_ioctl_data {
struct i2c_msg __user *msgs; /* pointers to
i2c_msgs */
__u32 nmsgs; /* number of i2c_msgs */
};
struct i2c_msg {
_ _u16 addr; /* slave address */
_ _u16 flags; /* 標誌（讀、寫） */
_ _u16 len; /* msg length */
_ _u8 *buf; /* pointer to msg data */
};
針對smbus算法，需要熟悉struct
i2c_smbus_ioctl_data。使用的命令是I2C_SMBUS。對於smbus算法，不需要考慮“多開始信號時序”問題。
struct i2c_smbus_ioctl_data {
__u8 read_write; //讀、寫
__u8 command; //命令
__u32 size; //數據長度標識
union i2c_smbus_data __user *data; //數據
};
下面以一個實例講解操作的具體過程。通過S3C2410操作AT24C02 e2prom。實現在AT24C02中任意位置的讀、寫功能。
首先在內核中已經包含了對s3c2410
中的i2c控制器驅動的支持。提供了i2c算法（非smbus類型的，所以後面的ioctl的命令是I2C_RDWR）
static const struct i2c_algorithm
s3c24xx_i2c_algorithm = {
.master_xfer = s3c24xx_i2c_xfer,
.functionality = s3c24xx_i2c_func,
};
另外一方面需要確定爲了實現對AT24C02 e2prom的操作，需要確定AT24C02的地址及讀寫訪問時序。
● AT24C02地址的確定
原理圖上將A2、A1、A0都接地了，所以地址是0x50。
● AT24C02任意地址字節寫的時序
可見此時序符合前面提到的“單開始信號時序”
● AT24C02任意地址字節讀的時序
可見此時序符合前面提到的“多開始信號時序”
下面開始具體代碼的分析（代碼在2.6.22內核上測試通過）：
/*i2c_test.c
* hongtao_liu <[email protected]>
*/
#include <stdio.h>
#include <linux/types.h>
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/ioctl.h>
#include <errno.h>
#define I2C_RETRIES 0x0701
#define I2C_TIMEOUT 0x0702
#define I2C_RDWR 0x0707
/*********定義struct i2c_rdwr_ioctl_data和struct
i2c_msg，要和內核一致*******/
struct i2c_msg
{
unsigned short addr;
unsigned short flags;
#define I2C_M_TEN 0x0010
#define I2C_M_RD 0x0001
unsigned short len;
unsigned char *buf;
};
struct i2c_rdwr_ioctl_data
{
struct i2c_msg *msgs;
int nmsgs;
/* nmsgs這個數量決定了有多少開始信號，對於“單開始時序”，取1*/
};
/***********主程序***********/
int main()
{
int fd,ret;
struct i2c_rdwr_ioctl_data e2prom_data;
fd=open("/dev/i2c-0",O_RDWR);
/*
*/dev/i2c-0是在註冊i2c-dev.c後產生的，代表一個可操作的適配器。如果不使用i2c-dev.c
*的方式，就沒有，也不需要這個節點。
*/
if(fd<0)
{
perror("open error");
}
e2prom_data.nmsgs=2;
/*
*因爲操作時序中，最多是用到2個開始信號（字節讀操作中），所以此將
*e2prom_data.nmsgs配置爲2
*/
e2prom_data.msgs=(struct
i2c_msg*)malloc(e2prom_data.nmsgs*sizeof(struct i2c_msg));
if(!e2prom_data.msgs)
{
perror("malloc error");
exit(1);
}
ioctl(fd,I2C_TIMEOUT,1);/*超時時間*/
ioctl(fd,I2C_RETRIES,2);/*重複次數*/
/***write data to e2prom**/
e2prom_data.nmsgs=1;
(e2prom_data.msgs[0]).len=2; //1個
e2prom 寫入目標的地址和1個數據
(e2prom_data.msgs[0]).addr=0x50;//e2prom
設備地址
(e2prom_data.msgs[0]).flags=0; //write
(e2prom_data.msgs[0]).buf=(unsigned
char*)malloc(2);
(e2prom_data.msgs[0]).buf[0]=0x10;//
e2prom 寫入目標的地址
(e2prom_data.msgs[0]).buf[1]=0x58;//the
data to write
ret=ioctl(fd,I2C_RDWR,(unsigned
long)&e2prom_data);
if(ret<0)
{
perror("ioctl error1");
}
sleep(1);
/******read data from e2prom*******/
e2prom_data.nmsgs=2;
(e2prom_data.msgs[0]).len=1; //e2prom
目標數據的地址
(e2prom_data.msgs[0]).addr=0x50; //
e2prom 設備地址
(e2prom_data.msgs[0]).flags=0;//write
(e2prom_data.msgs[0]).buf[0]=0x10;//e2prom數據地址
(e2prom_data.msgs[1]).len=1;//讀出的數據
(e2prom_data.msgs[1]).addr=0x50;//
e2prom 設備地址
(e2prom_data.msgs[1]).flags=I2C_M_RD;//read
(e2prom_data.msgs[1]).buf=(unsigned
char*)malloc(1);//存放返回值的地址。
(e2prom_data.msgs[1]).buf[0]=0;//初始化讀緩衝
ret=ioctl(fd,I2C_RDWR,(unsigned
long)&e2prom_data);
if(ret<0)
{
perror("ioctl error2");
}
printf("buff[0]=%x/n",(e2prom_data.msgs[1]).buf[0]);
/***打印讀出的值，沒錯的話，就應該是前面寫的0x58了***/
close(fd);
return 0;
}
以上講述了一種比較常用的利用i2c-dev.c操作i2c設備的方法，這種方法可以說是
在應用層完成了對具體i2c設備的驅動工作。
計劃下一篇總結以下幾點：
（1）在內核裏寫i2c設備驅動的兩種方式：
● Probe方式（new style），如：
static struct i2c_driver pca953x_driver =
{
.driver = {
.name = "pca953x",
},
.probe = pca953x_probe,
.remove = pca953x_remove,
.id_table = pca953x_id,
};
● Adapter方式（LEGACY），如：
static struct i2c_driver pcf8575_driver =
{
.driver = {
.owner = THIS_MODULE,
.name = "pcf8575",
},
.attach_adapter =
pcf8575_attach_adapter,
.detach_client =
pcf8575_detach_client,
};
（2）適配器驅動編寫方法
（3）分享一些項目中遇到的問題
四、在內核裏寫i2c設備驅動的兩種方式
前文介紹了利用/dev/i2c-0在應用層完成對i2c設備的操作，但很多時候我們還是 習慣爲i2c設備在內核層編寫驅動程序。目前內核支持兩種編寫i2c驅動程序的方式。下面分別介紹這兩種方式的實現。這裏分別稱這兩種方式爲 “Adapter方式（LEGACY）”和“Probe方式（new style）”。
（1） Adapter方式（LEGACY）
（下面的實例代碼是在2.6.27內核的pca953x.c基礎上修改的，原始代碼採用的 是本文將要討論的第2種方式，即Probe方式）
● 構建i2c_driver
static struct i2c_driver pca953x_driver = {
.driver = {
.name= "pca953x", //名稱
},
.id= ID_PCA9555,//id號
.attach_adapter= pca953x_attach_adapter, //調用適配器連接設備
.detach_client= pca953x_detach_client,//讓設備脫離適配器
};
● 註冊i2c_driver
static int __init pca953x_init(void)
{
return i2c_add_driver(&pca953x_driver);
}
module_init(pca953x_init);
● attach_adapter動作
執行i2c_add_driver(&pca953x_driver)後會，如果 內核中已經註冊了i2c適配器，則順序調用這些適配器來連接我們的i2c設備。此過程是通過調用i2c_driver中的attach_adapter方 法完成的。具體實現形式如下：
static int pca953x_attach_adapter(struct
i2c_adapter *adapter)
{
return i2c_probe(adapter, &addr_data,
pca953x_detect);
/*
adapter:適配器
addr_data:地址信息
pca953x_detect：探測到設備後調用的函數
*/
}
地址信息addr_data是由下面代碼指定的。
/* Addresses to scan */
static unsigned short normal_i2c[] =
{0x20,0x21,0x22,0x23,0x24,0x25,0x26,0x27,I2C_CLIENT_END};
I2C_CLIENT_INSMOD;
注意：normal_i2c裏的地址必須是你i2c芯片的地址。否則將無法正確探測到設 備。而I2C_ CLIENT_INSMOD是一個宏，它會利用normal_i2c構建addr_data。
● 構建i2c_client，並註冊字符設備驅動
i2c_probe在探測到目標設備後，後調用pca953x_detect，並把當時的 探測地址address作爲參數傳入。
static int pca953x_detect(struct
i2c_adapter *adapter, int address, int kind)
{
struct i2c_client *new_client;
struct pca953x_chip *chip; //設備結構體
int err = 0,result;
dev_t
pca953x_dev=MKDEV(pca953x_major,0);//構建設備號，根據具體情況設定，這裏我只考慮了normal_i2c中只有
一個地址匹配的情況。
if (!i2c_check_functionality(adapter,
I2C_FUNC_SMBUS_BYTE_DATA| I2C_FUNC_SMBUS_WORD_DATA))//判定適配器能力
goto exit;
if (!(chip = kzalloc(sizeof(struct
pca953x_chip), GFP_KERNEL))) {
err = -ENOMEM;
goto exit;
}
/****構建i2c-client****/
chip->client=kzalloc(sizeof(struct
i2c_client),GFP_KERNEL);
new_client = chip->client;
i2c_set_clientdata(new_client, chip);
new_client->addr = address;
new_client->adapter = adapter;
new_client->driver =
&pca953x_driver;
new_client->flags = 0;
strlcpy(new_client->name, "pca953x",
I2C_NAME_SIZE);
if ((err =
i2c_attach_client(new_client)))//註冊i2c_client
goto exit_kfree;
if (err)
goto exit_detach;
if(pca953x_major)
{
result=register_chrdev_region(pca953x_dev,1,"pca953x");
}
else{
result=alloc_chrdev_region(&pca953x_dev,0,1,"pca953x");
pca953x_major=MAJOR(pca953x_dev);
}
if (result < 0) {
printk(KERN_NOTICE "Unable to
get pca953x region, error %d/n", result);
return result;
}
pca953x_setup_cdev(chip,0);
//註冊字符設備，此處不詳解
return 0;
exit_detach:
i2c_detach_client(new_client);
exit_kfree:
kfree(chip);
exit:
return err;
}
i2c_check_functionality用來判定設配器的能力，這一點非常重要。 你也可以直接查看對應設配器的能力，如
static const struct i2c_algorithm
smbus_algorithm = {
.smbus_xfer= i801_access,
.functionality= i801_func,
};
static u32 i801_func(struct i2c_adapter
*adapter)
{
return I2C_FUNC_SMBUS_QUICK |
I2C_FUNC_SMBUS_BYTE |
I2C_FUNC_SMBUS_BYTE_DATA |
I2C_FUNC_SMBUS_WORD_DATA |
I2C_FUNC_SMBUS_BLOCK_DATA |
I2C_FUNC_SMBUS_WRITE_I2C_BLOCK
| (isich4 ?
I2C_FUNC_SMBUS_HWPEC_CALC : 0);
}
● 字符驅動的具體實現
struct file_operations pca953x_fops = {
.owner = THIS_MODULE,
.ioctl= pca953x_ioctl,
.open= pca953x_open,
.release =pca953x_release,
};
字符設備驅動本身沒有什麼好說的，這裏主要想說一下，如何在驅動中調用i2c設配器幫我們 完成數據傳輸。
目前設配器主要支持兩種傳輸方法：smbus_xfer和master_xfer。一般來 說，如果設配器支持了master_xfer那麼它也可以模擬支持smbus的傳輸。但如果只實現smbus_xfer，則不支持一些i2c的傳輸。
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);
master_xfer中的參數設置，和前面的用戶空間編程一致。現在只是要在驅動中構建 相關的參數然後調用i2c_transfer來完成傳輸既可。
int i2c_transfer(struct i2c_adapter * adap, struct i2c_msg *msgs, int num)
smbus_xfer中的參數設置及調用方法如下：
static int pca953x_write_reg(struct
pca953x_chip *chip, int reg, uint16_t val)
{
int ret;
ret =
i2c_smbus_write_word_data(chip->client, reg << 1, val);
if (ret < 0) {
dev_err(&chip->client->dev,
"failed writing register/n");
return -EIO;
}
return 0;
}
上面函數完成向芯片的地址爲reg的寄存器寫一個16bit的數據。 i2c_smbus_write_word_data的實現如下：
s32 i2c_smbus_write_word_data(struct
i2c_client *client, u8 command, u16 value)
{
union i2c_smbus_data data;
data.word = value;
return
i2c_smbus_xfer(client->adapter,client->addr,client->flags,
I2C_SMBUS_WRITE,command,
I2C_SMBUS_WORD_DATA,&data);
}
從中可以看出smbus傳輸一個16位數據的方法。其它操作如：字符寫、字符讀、字讀、塊 操作等，可以參考內核的i2c-core.c中提供的方法。
● 註銷i2c_driver
static void __exit pca953x_exit(void)
{
i2c_del_driver(&pca953x_driver);
}
module_exit(pca953x_exit);
● detach_client動作
順序調用內核中註冊的適配器來斷開我們註冊過的i2c設備。此過程通過調用 i2c_driver中的attach_adapter方法完成的。具體實現形式如下：
static int pca953x_detach_client(struct
i2c_client *client)
{
int err;
struct pca953x_chip *data;
if ((err =
i2c_detach_client(client)))//斷開i2c_client
return err;
data=i2c_get_clientdata(client);
cdev_del(&(data->cdev));
unregister_chrdev_region(MKDEV(pca953x_major, 0), 1);
kfree(data->client);
kfree(data);
return 0;
}
（2） Probe方式（new style）
● 構建i2c_driver
和LEGACY方式一樣，也需要構建i2c_driver，但是內容有所不同。
static struct i2c_driver pca953x_driver = {
.driver = {
.name= "pca953x",
},
.probe= pca953x_probe,
//當有i2c_client和i2c_driver匹配時調用
.remove= pca953x_remove,//註銷時調用
.id_table= pca953x_id,//匹配規則
};
● 註冊i2c_driver
static int __init pca953x_init(void)
{
return
i2c_add_driver(&pca953x_driver);
}
module_init(pca953x_init);
在註冊i2c_driver的過程中，是將driver註冊到了i2c_bus_type 的總線上。此總線的匹配規則是：
static const struct i2c_device_id
*i2c_match_id(const struct i2c_device_id *id,
const
struct i2c_client *client)
{
while (id->name[0]) {
if (strcmp(client->name,
id->name) == 0)
return id;
id++;
}
return NULL;
}
可以看出是利用i2c_client的名稱和id_table中的名稱做匹配的。本驅動中 的id_table爲
static const struct i2c_device_id
pca953x_id[] = {
{ "pca9534", 8, },
{ "pca9535", 16, },
{ "pca9536", 4, },
{ "pca9537", 4, },
{ "pca9538", 8, },
{ "pca9539", 16, },
{ "pca9554", 8, },
{ "pca9555", 16, },
{ "pca9557", 8, },
{ "max7310", 8, },
{ }
};
看到現在我們應該會有這樣的疑問，在Adapter模式中，i2c_client是我們自 己構造出來的，而現在的i2c_client是從哪來的呢？看看下面的解釋
● 註冊i2c_board_info
對於Probe模式，通常在平臺代碼中要完成i2c_board_info的註冊。方法如 下：
static struct i2c_board_info __initdata
test_i2c_devices[] = {
{
I2C_BOARD_INFO("pca9555",
0x27),//pca9555爲芯片名稱，0x27爲芯片地址
.platform_data =
&pca9555_data,
}, {
I2C_BOARD_INFO("mt9v022", 0x48),
.platform_data = &iclink[0],
/* With extender */
}, {
I2C_BOARD_INFO("mt9m001", 0x5d),
.platform_data = &iclink[0],
/* With extender */
},
};
i2c_register_board_info(0,
test_i2c_devices,ARRAY_SIZE(test_i2c_devices)); //註冊
i2c_client就是在註冊過程中構建的。但有一點需要注意的是 i2c_register_board_info並沒有EXPORT_SYMBOL給模塊使用。
● 字符驅動註冊
在Probe方式下，添加字符驅動的位置在pca953x_probe中。
static int __devinit pca953x_probe(struct
i2c_client *client,const struct i2c_device_id *id)
{
……
/****字符設備驅動註冊位置****/
……
return 0;
}
● 註銷i2c_driver
static void __exit pca953x_exit(void)
{
i2c_del_driver(&pca953x_driver);
}
module_exit(pca953x_exit);
● 註銷字符設備驅動
在Probe方式下，註銷字符驅動的位置在pca953x_remove中。
static int __devinit pca953x_remove
(struct i2c_client *client)
{
……
/****字符設備驅動註銷的位置****/
……
return 0;
}
● I2C設備的數據交互方法(即：調用適配器操作設備的方法)和Adapter方 式下相同。