Linux i2c体系结构分析

    前面几篇文章简单地跟了一下Linux设备驱动模型的代码，比较概况，但是足以了解驱动模型几个重要数据结构之间的大概的关系，有了前面的基础，现在我们试着分析一下Linux下的i2c驱动相关的代码。

   

    Linux的i2c体系结构由三个组成部分：i2c核心、i2c总线驱动和i2c设备驱动。

i2c核心

    i2c核心提供了i2c总线驱动和设备驱动的注册、注销方法，i2c algorithm、与具体适配器无关的代码以及探测设备、检测设备地址的上层代码等，主要由drivers/i2c/i2c-core.c文件实现；

 

i2c总线驱动

    i2c总线驱动是对i2c硬件体系结构中适配器端的实现，主要包含了i2c适配器数据结构i2c_adapter、i2c_algorithm和控制i2c适配器产生通信信号的函数。经由i2c总线驱动的代码，我们可以控制i2c适配器以主控方式产生开始位、停止位、读写周期，以及以从设备方式被读写、产生ACK等。i2c总线驱动的代码在drivers/i2c/buses文件夹下，如s3c2410的i2c控制器驱动为i2c-s3c2410.c；

 

i2c设备驱动

    i2c设备驱动是对i2c硬件体系结构中设备端的实现，i2c设备通过i2c总线（适配器）与CPU进行通信。i2c设备驱动主要包含数据结构i2c_driver和i2c_client，我们根据具体设备实现其中的成员函数。i2c设备驱动的代码在drivers/i2c/chips目录下，每个文件都对应一个不同的i2c设备驱动。

 

    此外，i2c.h中对i2c_driver、i2c_client、i2c_adapter和i2c_algorithm等数据结构进行了定义，这四个数据结构是理解Linux的i2c体系结构的关键，因此下面我们将详细分析这四个数据结构及它们之间的关系。

struct i2c_adapter {
 struct module *owner;
 unsigned int id;
 unsigned int class;    /* classes to allow probing for */
 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
 void *algo_data;

 /* --- administration stuff. */
 int (*client_register)(struct i2c_client *) __deprecated;
 int (*client_unregister)(struct i2c_client *) __deprecated;

 /* data fields that are valid for all devices */
 u8 level;    /* nesting level for lockdep */
 struct mutex bus_lock;
 struct mutex clist_lock;

 int timeout;   /* in jiffies */
 int retries;
 struct device dev;  /* the adapter device */

 int nr;//总线编号
 struct list_head clients; /* DEPRECATED */
 char name[48];
 struct completion dev_released;
};

    i2c_adapter对应于物理上的一个i2c总线控制器

 

 

/*
 * The following structs are for those who like to implement new bus drivers:
 * i2c_algorithm is the interface to a class of hardware solutions which can
 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 * to name two of the most common.
 */
struct i2c_algorithm {
 /* If an adapter algorithm can't do I2C-level access, set master_xfer
    to NULL. If an adapter algorithm can do SMBus access, set
    smbus_xfer. If set to NULL, the SMBus protocol is simulated
    using common I2C messages */
 /* master_xfer should return the number of messages successfully
    processed, or a negative value on error */
 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);

 /* To determine what the adapter supports */
 u32 (*functionality) (struct i2c_adapter *);
};

 

 

/**
 * struct i2c_client - represent an I2C slave device
 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
 * @addr: Address used on the I2C bus connected to the parent adapter.
 * @name: Indicates the type of the device, usually a chip name that's
 * generic enough to hide second-sourcing and compatible revisions.
 * @adapter: manages the bus segment hosting this I2C device
 * @driver: device's driver, hence pointer to access routines
 * @dev: Driver model device node for the slave.
 * @irq: indicates the IRQ generated by this device (if any)
 * @list: list of active/busy clients (DEPRECATED)
 * @detected: member of an i2c_driver.clients list
 * @released: used to synchronize client releases & detaches and references
 *
 * An i2c_client identifies a single device (i.e. chip) connected to an
 * i2c bus. The behaviour exposed to Linux is defined by the driver
 * managing the device.
 */
struct i2c_client {
 unsigned short flags;  /* div., see below  */
 unsigned short addr;  /* chip address - NOTE: 7bit */
     /* addresses are stored in the */
     /* _LOWER_ 7 bits  */
 char name[I2C_NAME_SIZE];
 struct i2c_adapter *adapter; /* the adapter we sit on */
 struct i2c_driver *driver; /* and our access routines */
 struct device dev;  /* the device structure  */
 int irq;   /* irq issued by device  */
 struct list_head list;  /* DEPRECATED */
 struct list_head detected;
 struct completion released;
};

 

 

/**
 * struct i2c_driver - represent an I2C device driver
 * @id: Unique driver ID (optional)
 * @class: What kind of i2c device we instantiate (for detect)
 * @attach_adapter: Callback for bus addition (for legacy drivers)
 * @detach_adapter: Callback for bus removal (for legacy drivers)
 * @detach_client: Callback for device removal (for legacy drivers)
 * @probe: Callback for device binding (new-style drivers)
 * @remove: Callback for device unbinding (new-style drivers)
 * @shutdown: Callback for device shutdown
 * @suspend: Callback for device suspend
 * @resume: Callback for device resume
 * @command: Callback for bus-wide signaling (optional)
 * @driver: Device driver model driver
 * @id_table: List of I2C devices supported by this driver
 * @detect: Callback for device detection
 * @address_data: The I2C addresses to probe, ignore or force (for detect)
 * @clients: List of detected clients we created (for i2c-core use only)
 *
 * The driver.owner field should be set to the module owner of this driver.
 * The driver.name field should be set to the name of this driver.
 *
 * For automatic device detection, both @detect and @address_data must
 * be defined. @class should also be set, otherwise only devices forced
 * with module parameters will be created. The detect function must
 * fill at least the name field of the i2c_board_info structure it is
 * handed upon successful detection, and possibly also the flags field.
 *
 * If @detect is missing, the driver will still work fine for enumerated
 * devices. Detected devices simply won't be supported. This is expected
 * for the many I2C/SMBus devices which can't be detected reliably, and
 * the ones which can always be enumerated in practice.
 *
 * The i2c_client structure which is handed to the @detect callback is
 * not a real i2c_client. It is initialized just enough so that you can
 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
 * else with it. In particular, calling dev_dbg and friends on it is
 * not allowed.
 */
struct i2c_driver {
 int id;
 unsigned int class;

 /* Notifies the driver that a new bus has appeared. This routine
  * can be used by the driver to test if the bus meets its conditions
  * & seek for the presence of the chip(s) it supports. If found, it
  * registers the client(s) that are on the bus to the i2c admin. via
  * i2c_attach_client.  (LEGACY I2C DRIVERS ONLY)
  */
 int (*attach_adapter)(struct i2c_adapter *);
 int (*detach_adapter)(struct i2c_adapter *);

 /* tells the driver that a client is about to be deleted & gives it
  * the chance to remove its private data. Also, if the client struct
  * has been dynamically allocated by the driver in the function above,
  * it must be freed here.  (LEGACY I2C DRIVERS ONLY)
  */
 int (*detach_client)(struct i2c_client *) __deprecated;

 /* Standard driver model interfaces, for "new style" i2c drivers.
  * With the driver model, device enumeration is NEVER done by drivers;
  * it's done by infrastructure.  (NEW STYLE DRIVERS ONLY)
  */
 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
 int (*remove)(struct i2c_client *);

 /* driver model interfaces that don't relate to enumeration  */
 void (*shutdown)(struct i2c_client *);
 int (*suspend)(struct i2c_client *, pm_message_t mesg);
 int (*resume)(struct i2c_client *);

 /* a ioctl like command that can be used to perform specific functions
  * with the device.
  */
 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);

 struct device_driver driver;
 const struct i2c_device_id *id_table;

 /* Device detection callback for automatic device creation */
 int (*detect)(struct i2c_client *, int kind, struct i2c_board_info *);
 const struct i2c_client_address_data *address_data;
 struct list_head clients;
};

 

---------------------------------------------------------------------------------------------------------------------------------------------------

 

二、Linux i2c核心

    作为i2c总线驱动和i2c设备驱动之间的纽带，i2c核心（drivers/i2c/i2c-core.c）中提供了一组不依赖于硬件平台的接口函数，我大致把这些接口分为5大类：操作i2c适配器的接口、操作i2c驱动的接口、操作i2c设备的接口、探测i2c设备的接口以及数据交互接口。