執行個體解析linux核心I2C體繫結構（1）

一、概述

談到在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 <lht@farsight.com.cn>
        */
        #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）分享一些項目中遇到的問題
        希望大家多提意見，多多交流。
（作者：劉洪濤,華清遠見嵌入式學院講師。）