i2c.h
上传用户:aoeyumen
上传日期:2007-01-06
资源大小:3329k
文件大小:6k
源码类别:

DVD

开发平台:

Unix_Linux

  1. #ifndef I2C_H
  2. #define I2C_H
  3. /*
  4.  * linux i2c interface.  Works a little bit like the scsi subsystem.
  5.  * There are:
  6.  *
  7.  *     i2c          the basic control module        (like scsi_mod)
  8.  *     bus driver   a driver with a i2c bus         (hostadapter driver)
  9.  *     chip driver  a driver for a chip connected
  10.  *                  to a i2c bus                    (cdrom/hd driver)
  11.  *
  12.  * A device will be attached to one bus and one chip driver.  Every chip
  13.  * driver gets a unique ID.
  14.  *
  15.  * A chip driver can provide a ioctl-like callback for the
  16.  * communication with other parts of the kernel (not every i2c chip is
  17.  * useful without other devices, a TV card tuner for example). 
  18.  *
  19.  * "i2c internal" parts of the structs: only the i2c module is allowed to
  20.  * write to them, for others they are read-only.
  21.  *
  22.  */
  23. #define I2C_BUS_MAX       4    /* max # of bus drivers  */
  24. #define I2C_DRIVER_MAX    8    /* max # of chip drivers */
  25. #define I2C_DEVICE_MAX    8    /* max # if devices per bus/driver */
  26. struct i2c_bus;
  27. struct i2c_driver;
  28. struct i2c_device;
  29. #define I2C_DRIVERID_MSP3400     1
  30. #define I2C_DRIVERID_TUNER       2
  31. #define I2C_DRIVERID_VIDEOTEXT  3
  32. #define I2C_DRIVERID_KS0127  4
  33. #define I2C_DRIVERID_MAVEN  5
  34. #define I2C_BUSID_BT848 1 /* I2C bus on a BT848 */
  35. #define I2C_BUSID_MGA 2 /* I2C bus on a Matrox G-series */
  36. /*
  37.  * struct for a driver for a i2c chip (tuner, soundprocessor,
  38.  * videotext, ... ).
  39.  *
  40.  * a driver will register within the i2c module.  The i2c module will
  41.  * callback the driver (i2c_attach) for every device it finds on a i2c
  42.  * bus at the specified address.  If the driver decides to "accept"
  43.  * the, device, it must return a struct i2c_device, and NULL
  44.  * otherwise.
  45.  *
  46.  * i2c_detach = i2c_attach ** -1
  47.  * 
  48.  * i2c_command will be used to pass commands to the driver in a
  49.  * ioctl-line manner.
  50.  *
  51.  */
  52. struct i2c_driver 
  53. {
  54.     char           name[32];         /* some useful label         */
  55.     int            id;               /* device type ID            */
  56.     unsigned char  addr_l, addr_h;   /* address range of the chip */
  57.     int (*attach)(struct i2c_device *device);
  58.     int (*detach)(struct i2c_device *device);
  59.     int (*command)(struct i2c_device *device,unsigned int cmd, void *arg);
  60.     /* i2c internal */
  61.     struct i2c_device   *devices[I2C_DEVICE_MAX];
  62.     int                 devcount;
  63. };
  64. /*
  65.  * this holds the informations about a i2c bus available in the system.
  66.  * 
  67.  * a chip with a i2c bus interface (like bt848) registers the bus within
  68.  * the i2c module. This struct provides functions to access the i2c bus.
  69.  * 
  70.  * One must hold the spinlock to access the i2c bus (XXX: is the irqsave
  71.  * required? Maybe better use a semaphore?). 
  72.  * [-AC-] having a spinlock_irqsave is only needed if we have drivers wishing
  73.  *   to bang their i2c bus from an interrupt.
  74.  * 
  75.  * attach/detach_inform is a callback to inform the bus driver about
  76.  * attached chip drivers.
  77.  *
  78.  */
  79. /* needed: unsigned long flags */
  80. #if LINUX_VERSION_CODE >= 0x020100
  81. # if 0
  82. #  define LOCK_FLAGS unsigned long flags;
  83. #  define LOCK_I2C_BUS(bus)    spin_lock_irqsave(&(bus->bus_lock),flags);
  84. #  define UNLOCK_I2C_BUS(bus)  spin_unlock_irqrestore(&(bus->bus_lock),flags);
  85. # else
  86. #  define LOCK_FLAGS
  87. #  define LOCK_I2C_BUS(bus)    spin_lock(&(bus->bus_lock));
  88. #  define UNLOCK_I2C_BUS(bus)  spin_unlock(&(bus->bus_lock));
  89. # endif
  90. #else
  91. # define LOCK_FLAGS unsigned long flags;
  92. # define LOCK_I2C_BUS(bus)    { save_flags(flags); cli(); }
  93. # define UNLOCK_I2C_BUS(bus)  { restore_flags(flags);     }
  94. #endif
  95. struct i2c_bus 
  96. {
  97. char  name[32];         /* some useful label */
  98. int   id;
  99. void  *data;            /* free for use by the bus driver */
  100. #if LINUX_VERSION_CODE >= 0x020100
  101. spinlock_t bus_lock;
  102. #endif
  103. /* attach/detach inform callbacks */
  104. void    (*attach_inform)(struct i2c_bus *bus, int id);
  105. void    (*detach_inform)(struct i2c_bus *bus, int id);
  106. /* Software I2C */
  107. void    (*i2c_setlines)(struct i2c_bus *bus, int ctrl, int data);
  108. int     (*i2c_getdataline)(struct i2c_bus *bus);
  109. /* Hardware I2C */
  110. int     (*i2c_read)(struct i2c_bus *bus, unsigned char addr);
  111. int     (*i2c_write)(struct i2c_bus *bus, unsigned char addr,
  112.  unsigned char b1, unsigned char b2, int both);
  113. /* internal data for i2c module */
  114. struct i2c_device   *devices[I2C_DEVICE_MAX];
  115. int                 devcount;
  116. };
  117. /*
  118.  * This holds per-device data for a i2c device
  119.  */
  120. struct i2c_device 
  121. {
  122. char           name[32];         /* some useful label */
  123. void           *data;            /* free for use by the chip driver */
  124. unsigned char  addr;             /* chip addr */
  125. /* i2c internal */
  126. struct i2c_bus     *bus;
  127. struct i2c_driver  *driver;
  128. };
  129. /* ------------------------------------------------------------------- */
  130. /* i2c module functions                                                */
  131. /* register/unregister a i2c bus */
  132. int i2c_register_bus(struct i2c_bus *bus);
  133. int i2c_unregister_bus(struct i2c_bus *bus);
  134. /* register/unregister a chip driver */
  135. int i2c_register_driver(struct i2c_driver *driver);
  136. int i2c_unregister_driver(struct i2c_driver *driver);
  137. /* send a command to a chip using the ioctl-like callback interface */
  138. int i2c_control_device(struct i2c_bus *bus, int id,
  139.        unsigned int cmd, void *arg);
  140. /* i2c bus access functions */
  141. void    i2c_start(struct i2c_bus *bus);
  142. void    i2c_stop(struct i2c_bus *bus);
  143. void    i2c_one(struct i2c_bus *bus);
  144. void    i2c_zero(struct i2c_bus *bus);
  145. int     i2c_ack(struct i2c_bus *bus);
  146. int     i2c_sendbyte(struct i2c_bus *bus,unsigned char data,int wait_for_ack);
  147. unsigned char i2c_readbyte(struct i2c_bus *bus,int last);
  148. /* i2c (maybe) hardware functions */
  149. int     i2c_read(struct i2c_bus *bus, unsigned char addr);
  150. int     i2c_write(struct i2c_bus *bus, unsigned char addr,
  151.   unsigned char b1, unsigned char b2, int both);
  152. int i2c_init(void);
  153. #endif /* I2C_H */