实例解析linux内核I2C体系结构.doc

实例解析linux内核I2C体系结构
作者：刘洪涛,华清远见嵌入式学院讲师。
一、概述
谈到在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;
             __u32 nmsgs;
         };
         struct i2c_msg {
             _ _u16 addr;
             _ _u16 flags;
             _ _u16 len;
             _ _u8 *buf;
         };
针对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内核上测试通过）： 
         #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_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;

         };

         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;

                 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);

                 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);

                 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]);

                 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）分享一些项目中遇到的问题
         希望大家多提意见，多多交流。
2. Linux I2C 结构分析
2.1 层次分析
1. I2C Core
I2C Core用于维护Linux的I2C核心部分，其中维护了两个静态的List，分别记录系统中的I2C driver结构和I2C adapter结构。
static LIST_HEAD(adapters);
static LIST_HEAD(drivers);
I2C core提供接口函数，允许一个I2C adatper，I2C driver和I2C client初始化时在I2C core中进行注册，以及退出时进行注销。具体可以参见i2c_core.c代码。
同时还提供了I2C总线读写访问的一般接口（具体的实现在与I2C控制器相关的I2C adapter中实现），主要应用在I2C设备驱动中。
常用的主要是
i2c_master_send()
i2c_master_recv()
i2c_transfer()
2. I2C bus driver
总线驱动的职责，是为系统中每个I2C总线增加相应的读写方法。但是总线驱动本身并不会进行任何的通讯，它只是存在在那里，等待设备驱动调用其函数。
在系统开机时，首先装载的是I2C总线驱动。一个总线驱动用于支持一条特定的I2C总线的读写。一个总线驱动通常需要两个模块，一个struct i2c_adapter和一个struct i2c_algorithm来描述：
在 buses目录下的i2c-pxa.c中实现了PXA的I2C总线适配器，I2C adapter 构造一个对I2C core层接口的数据结构，并通过接口函数向I2C core注册一个控制器。I2C adapter主要实现对I2C总线访问的算法，iic_xfer() 函数就是I2C adapter底层对I2C总线读写方法的实现。同时I2C adpter 中还实现了对I2C控制器中断的处理函数。
1) i2c-pxa.c定义了i2c_algorithm，并且实现了master的发送函数i2c_pxa_xfer()，以及设备查询总线的模式的函数i2c_pxa_functionality()
static const struct i2c_algorithm i2c_pxa_algorithm = {
.master_xfer = i2c_pxa_xfer,
.functionality = i2c_pxa_functionality,
};
2) i2c-pxa.c中，实现了i2c_adapter，主要是在定义pxa-i2c时进行初始化，并且i2c_pxa_probe()中进行填充parent指针，并且调用ret = i2c_add_adapter(&i2c->adap);进行添加。
static struct pxa_i2c i2c_pxa = {

.lock = SPIN_LOCK_UNLOCKED,
.adap = {
   .owner   = THIS_MODULE,
   .algo   = &i2c_pxa_algorithm,
   .name   = "pxa2xx-i2c.0",
   .retries = 5,
},
};
总的来说，在i2c-pxa中，使用platform驱动模型，完成了i2c的总线两种模块struct i2c_adapter和struct i2c_algorithm
3. I2C device driver
I2C只有总线驱动是不够的，必须有设备才能工作。这就是I2C device driver的必要性。I2C的device是有两个模块来描述的，struct i2c_driver和struct i2c_client。
在介绍chips目录下的device driver前有必要介绍一下i2c-dev.c文件。
      i2c-dev.c中提供了一个通用的I2C设备的驱动程序，实现了字符类型设备的访问接口，对设备的具体访问是通过I2C adapter来实现的。构造一个对I2C core层接口的数据结构，通过接口函数向 I2C Core注册一个I2C设备驱动。同时构造一个对用户层接口的数据结构，并通过接口函数向内核注册为一个主设备号为89的字符类型设备。
static struct i2c_driver i2cdev_driver = {
.driver = {
   .name = "dev_driver",
},
.id   = I2C_DRIVERID_I2CDEV,
.attach_adapter = i2cdev_attach_adapter,
.detach_adapter = i2cdev_detach_adapter,
.detach_client = i2cdev_detach_client,
};
struct i2c_dev {
struct list_head list;
struct i2c_adapter *adap;
struct device *dev;
};

该文件提供了用户层对I2C设备的访问，包括open，read，write，ioctl，release等常规文件操作，我们可以通过open函数打开 I2C的设备文件，通过ioctl函数设定要访问从设备的地址，然后就可以通过 read和write函数完成对I2C设备的读写操作。

static const struct file_operations i2cdev_fops = {

.owner   = THIS_MODULE,
.llseek   = no_llseek,
.read   = i2cdev_read,
.write   = i2cdev_write,
.ioctl   = i2cdev_ioctl,
.open   = i2cdev_open,
.release = i2cdev_release,
};

      注：通过I2C driver提供的通用方法可以访问任何一个I2C的设备，但是其中实现的read，write及ioctl等功能完全是基于一般设备的实现，所有的操作 数据都是基于字节流，没有明确的格式和意义。为了更方便和有效地使用I2C设备，我们可以为一个具体的I2C设备开发特定的I2C设备驱动程序，在驱动中 完成对特定的数据格式的解释以及实现一些专用的功能。
在chips目录下包含着各种device 的driver，完成各种从设备的注册。作为一般的I2C设备，使用i2c-dev.c里的操作足够完成操作了。
当然如果不能完成，则需要独立完成该驱动，这就是chips目录下的代码。因为i2c-dev.c已经实现了I2C设备的文件操作接口，所以只要实现struct i2c_driver就可以了。对于某些特殊的操作，可以使用command接口进行控制。 当然，对于i2接口的fm芯片，则将struct i2c_driver放在i2c的chips目录