Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* ------------------------------------------------------------------------- */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 2 | /* */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | /* i2c.h - definitions for the i2c-bus interface */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 4 | /* */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 5 | /* ------------------------------------------------------------------------- */ |
| 6 | /* Copyright (C) 1995-2000 Simon G. Vogl |
| 7 | |
| 8 | This program is free software; you can redistribute it and/or modify |
| 9 | it under the terms of the GNU General Public License as published by |
| 10 | the Free Software Foundation; either version 2 of the License, or |
| 11 | (at your option) any later version. |
| 12 | |
| 13 | This program is distributed in the hope that it will be useful, |
| 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | GNU General Public License for more details. |
| 17 | |
| 18 | You should have received a copy of the GNU General Public License |
| 19 | along with this program; if not, write to the Free Software |
| 20 | Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ |
| 21 | /* ------------------------------------------------------------------------- */ |
| 22 | |
David Woodhouse | a1b9298 | 2006-04-25 14:14:52 +0100 | [diff] [blame] | 23 | /* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | Frodo Looijaard <frodol@dds.nl> */ |
| 25 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 26 | #ifndef _LINUX_I2C_H |
| 27 | #define _LINUX_I2C_H |
| 28 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 29 | #include <linux/types.h> |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 30 | #ifdef __KERNEL__ |
David Woodhouse | a1b9298 | 2006-04-25 14:14:52 +0100 | [diff] [blame] | 31 | #include <linux/module.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | #include <linux/i2c-id.h> |
Greg Kroah-Hartman | a9d1b24 | 2005-10-22 00:23:27 +0200 | [diff] [blame] | 33 | #include <linux/mod_devicetable.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | #include <linux/device.h> /* for struct device */ |
Tim Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 35 | #include <linux/sched.h> /* for completion */ |
Ingo Molnar | 5c085d3 | 2006-01-18 23:16:04 +0100 | [diff] [blame] | 36 | #include <linux/mutex.h> |
Grant Likely | d12d42f | 2010-04-13 16:12:28 -0700 | [diff] [blame] | 37 | #include <linux/of.h> /* for struct device_node */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 38 | |
Jon Smirl | e9ca9eb | 2008-07-14 22:38:35 +0200 | [diff] [blame] | 39 | extern struct bus_type i2c_bus_type; |
Michael Lawnick | 0826374 | 2010-08-11 18:21:02 +0200 | [diff] [blame] | 40 | extern struct device_type i2c_adapter_type; |
Jon Smirl | e9ca9eb | 2008-07-14 22:38:35 +0200 | [diff] [blame] | 41 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | /* --- General options ------------------------------------------------ */ |
| 43 | |
| 44 | struct i2c_msg; |
| 45 | struct i2c_algorithm; |
| 46 | struct i2c_adapter; |
| 47 | struct i2c_client; |
| 48 | struct i2c_driver; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | union i2c_smbus_data; |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 50 | struct i2c_board_info; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 52 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | /* |
| 54 | * The master routines are the ones normally used to transmit data to devices |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 55 | * on a bus (or read from them). Apart from two basic transfer functions to |
| 56 | * transmit one message at a time, a more complex version can be used to |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | * transmit an arbitrary number of messages without interruption. |
Zhangfei Gao | 0c43ea5 | 2010-03-02 12:23:49 +0100 | [diff] [blame] | 58 | * @count must be be less than 64k since msg.len is u16. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 59 | */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 60 | extern int i2c_master_send(struct i2c_client *client, const char *buf, |
| 61 | int count); |
| 62 | extern int i2c_master_recv(struct i2c_client *client, char *buf, int count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | |
| 64 | /* Transfer num messages. |
| 65 | */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 66 | extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, |
| 67 | int num); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 68 | |
| 69 | /* This is the very generalized SMBus access routine. You probably do not |
| 70 | want to use this, though; one of the functions below may be much easier, |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 71 | and probably just as fast. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 72 | Note that we use i2c_adapter here, because you do not need a specific |
| 73 | smbus adapter to call this function. */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 74 | extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr, |
| 75 | unsigned short flags, char read_write, u8 command, |
| 76 | int size, union i2c_smbus_data *data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | |
| 78 | /* Now follow the 'nice' access routines. These also document the calling |
Jean Delvare | ae7193f | 2008-07-14 22:38:24 +0200 | [diff] [blame] | 79 | conventions of i2c_smbus_xfer. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 81 | extern s32 i2c_smbus_read_byte(struct i2c_client *client); |
| 82 | extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value); |
| 83 | extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command); |
| 84 | extern s32 i2c_smbus_write_byte_data(struct i2c_client *client, |
| 85 | u8 command, u8 value); |
| 86 | extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command); |
| 87 | extern s32 i2c_smbus_write_word_data(struct i2c_client *client, |
| 88 | u8 command, u16 value); |
Jean Delvare | b86a1bc | 2007-05-01 23:26:34 +0200 | [diff] [blame] | 89 | /* Returns the number of read bytes */ |
| 90 | extern s32 i2c_smbus_read_block_data(struct i2c_client *client, |
| 91 | u8 command, u8 *values); |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 92 | extern s32 i2c_smbus_write_block_data(struct i2c_client *client, |
| 93 | u8 command, u8 length, const u8 *values); |
Jean Delvare | 31ec5bc | 2005-10-08 00:04:13 +0200 | [diff] [blame] | 94 | /* Returns the number of read bytes */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 95 | extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client, |
Jean Delvare | 4b2643d | 2007-07-12 14:12:29 +0200 | [diff] [blame] | 96 | u8 command, u8 length, u8 *values); |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 97 | extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client, |
Jean Delvare | 21bbd69 | 2006-01-09 15:19:18 +1100 | [diff] [blame] | 98 | u8 command, u8 length, |
Krzysztof Halasa | 46f5ed7 | 2006-06-12 21:42:20 +0200 | [diff] [blame] | 99 | const u8 *values); |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 100 | #endif /* I2C */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 102 | /** |
| 103 | * struct i2c_driver - represent an I2C device driver |
| 104 | * @class: What kind of i2c device we instantiate (for detect) |
Jean Delvare | 96e21e4 | 2008-08-28 08:33:23 +0200 | [diff] [blame] | 105 | * @attach_adapter: Callback for bus addition (for legacy drivers) |
| 106 | * @detach_adapter: Callback for bus removal (for legacy drivers) |
Jean Delvare | 729d6dd | 2009-06-19 16:58:18 +0200 | [diff] [blame] | 107 | * @probe: Callback for device binding |
| 108 | * @remove: Callback for device unbinding |
Jean Delvare | 96e21e4 | 2008-08-28 08:33:23 +0200 | [diff] [blame] | 109 | * @shutdown: Callback for device shutdown |
| 110 | * @suspend: Callback for device suspend |
| 111 | * @resume: Callback for device resume |
Randy Dunlap | 72d2e9f | 2010-08-09 16:37:16 -0700 | [diff] [blame] | 112 | * @alert: Alert callback, for example for the SMBus alert protocol |
Jean Delvare | 96e21e4 | 2008-08-28 08:33:23 +0200 | [diff] [blame] | 113 | * @command: Callback for bus-wide signaling (optional) |
| 114 | * @driver: Device driver model driver |
| 115 | * @id_table: List of I2C devices supported by this driver |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 116 | * @detect: Callback for device detection |
Jean Delvare | c3813d6 | 2009-12-14 21:17:25 +0100 | [diff] [blame] | 117 | * @address_list: The I2C addresses to probe (for detect) |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 118 | * @clients: List of detected clients we created (for i2c-core use only) |
Laurent Riffard | 35d8b2e | 2005-11-26 20:34:05 +0100 | [diff] [blame] | 119 | * |
| 120 | * The driver.owner field should be set to the module owner of this driver. |
| 121 | * The driver.name field should be set to the name of this driver. |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 122 | * |
| 123 | * For automatic device detection, both @detect and @address_data must |
| 124 | * be defined. @class should also be set, otherwise only devices forced |
| 125 | * with module parameters will be created. The detect function must |
| 126 | * fill at least the name field of the i2c_board_info structure it is |
| 127 | * handed upon successful detection, and possibly also the flags field. |
| 128 | * |
| 129 | * If @detect is missing, the driver will still work fine for enumerated |
| 130 | * devices. Detected devices simply won't be supported. This is expected |
| 131 | * for the many I2C/SMBus devices which can't be detected reliably, and |
| 132 | * the ones which can always be enumerated in practice. |
| 133 | * |
| 134 | * The i2c_client structure which is handed to the @detect callback is |
| 135 | * not a real i2c_client. It is initialized just enough so that you can |
| 136 | * call i2c_smbus_read_byte_data and friends on it. Don't do anything |
| 137 | * else with it. In particular, calling dev_dbg and friends on it is |
| 138 | * not allowed. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 139 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | struct i2c_driver { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 141 | unsigned int class; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | |
Jean Delvare | 729d6dd | 2009-06-19 16:58:18 +0200 | [diff] [blame] | 143 | /* Notifies the driver that a new bus has appeared or is about to be |
| 144 | * removed. You should avoid using this if you can, it will probably |
| 145 | * be removed in a near future. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | */ |
| 147 | int (*attach_adapter)(struct i2c_adapter *); |
| 148 | int (*detach_adapter)(struct i2c_adapter *); |
| 149 | |
Jean Delvare | 729d6dd | 2009-06-19 16:58:18 +0200 | [diff] [blame] | 150 | /* Standard driver model interfaces */ |
Jean Delvare | d2653e9 | 2008-04-29 23:11:39 +0200 | [diff] [blame] | 151 | int (*probe)(struct i2c_client *, const struct i2c_device_id *); |
David Brownell | a1d9e6e | 2007-05-01 23:26:30 +0200 | [diff] [blame] | 152 | int (*remove)(struct i2c_client *); |
David Brownell | 7b4fbc5 | 2007-05-01 23:26:30 +0200 | [diff] [blame] | 153 | |
David Brownell | f37dd80 | 2007-02-13 22:09:00 +0100 | [diff] [blame] | 154 | /* driver model interfaces that don't relate to enumeration */ |
| 155 | void (*shutdown)(struct i2c_client *); |
| 156 | int (*suspend)(struct i2c_client *, pm_message_t mesg); |
| 157 | int (*resume)(struct i2c_client *); |
| 158 | |
Jean Delvare | b5527a7 | 2010-03-02 12:23:42 +0100 | [diff] [blame] | 159 | /* Alert callback, for example for the SMBus alert protocol. |
| 160 | * The format and meaning of the data value depends on the protocol. |
| 161 | * For the SMBus alert protocol, there is a single bit of data passed |
| 162 | * as the alert response's low bit ("event flag"). |
| 163 | */ |
| 164 | void (*alert)(struct i2c_client *, unsigned int data); |
| 165 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | /* a ioctl like command that can be used to perform specific functions |
| 167 | * with the device. |
| 168 | */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 169 | int (*command)(struct i2c_client *client, unsigned int cmd, void *arg); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | |
| 171 | struct device_driver driver; |
Jean Delvare | d2653e9 | 2008-04-29 23:11:39 +0200 | [diff] [blame] | 172 | const struct i2c_device_id *id_table; |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 173 | |
| 174 | /* Device detection callback for automatic device creation */ |
Jean Delvare | 310ec79 | 2009-12-14 21:17:23 +0100 | [diff] [blame] | 175 | int (*detect)(struct i2c_client *, struct i2c_board_info *); |
Jean Delvare | c3813d6 | 2009-12-14 21:17:25 +0100 | [diff] [blame] | 176 | const unsigned short *address_list; |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 177 | struct list_head clients; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 178 | }; |
| 179 | #define to_i2c_driver(d) container_of(d, struct i2c_driver, driver) |
| 180 | |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 181 | /** |
| 182 | * struct i2c_client - represent an I2C slave device |
David Brownell | d64f73b | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 183 | * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address; |
| 184 | * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 185 | * @addr: Address used on the I2C bus connected to the parent adapter. |
| 186 | * @name: Indicates the type of the device, usually a chip name that's |
| 187 | * generic enough to hide second-sourcing and compatible revisions. |
David Brownell | d64f73b | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 188 | * @adapter: manages the bus segment hosting this I2C device |
Randy Dunlap | aa3481d | 2007-07-31 00:39:02 -0700 | [diff] [blame] | 189 | * @driver: device's driver, hence pointer to access routines |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 190 | * @dev: Driver model device node for the slave. |
David Brownell | d64f73b | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 191 | * @irq: indicates the IRQ generated by this device (if any) |
Jean Delvare | 99cd8e2 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 192 | * @detected: member of an i2c_driver.clients list or i2c-core's |
| 193 | * userspace_devices list |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 194 | * |
| 195 | * An i2c_client identifies a single device (i.e. chip) connected to an |
David Brownell | d64f73b | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 196 | * i2c bus. The behaviour exposed to Linux is defined by the driver |
| 197 | * managing the device. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 198 | */ |
| 199 | struct i2c_client { |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 200 | unsigned short flags; /* div., see below */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 201 | unsigned short addr; /* chip address - NOTE: 7bit */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | /* addresses are stored in the */ |
Jean Delvare | 5071860 | 2005-07-20 00:02:32 +0200 | [diff] [blame] | 203 | /* _LOWER_ 7 bits */ |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 204 | char name[I2C_NAME_SIZE]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 205 | struct i2c_adapter *adapter; /* the adapter we sit on */ |
| 206 | struct i2c_driver *driver; /* and our access routines */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | struct device dev; /* the device structure */ |
Wolfram Sang | 8e29da9 | 2008-07-01 22:38:18 +0200 | [diff] [blame] | 208 | int irq; /* irq issued by device */ |
Jean Delvare | 4735c98 | 2008-07-14 22:38:36 +0200 | [diff] [blame] | 209 | struct list_head detected; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 210 | }; |
| 211 | #define to_i2c_client(d) container_of(d, struct i2c_client, dev) |
| 212 | |
David Brownell | 9b766b8 | 2008-01-27 18:14:51 +0100 | [diff] [blame] | 213 | extern struct i2c_client *i2c_verify_client(struct device *dev); |
| 214 | |
bgardner@wabtec.com | a61fc68 | 2005-07-27 12:43:03 -0500 | [diff] [blame] | 215 | static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj) |
| 216 | { |
Mark M. Hoffman | d75d53c | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 217 | struct device * const dev = container_of(kobj, struct device, kobj); |
| 218 | return to_i2c_client(dev); |
bgardner@wabtec.com | a61fc68 | 2005-07-27 12:43:03 -0500 | [diff] [blame] | 219 | } |
| 220 | |
Jean Delvare | 7d1d899 | 2008-10-22 20:21:31 +0200 | [diff] [blame] | 221 | static inline void *i2c_get_clientdata(const struct i2c_client *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 222 | { |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 223 | return dev_get_drvdata(&dev->dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 224 | } |
| 225 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 226 | static inline void i2c_set_clientdata(struct i2c_client *dev, void *data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 227 | { |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 228 | dev_set_drvdata(&dev->dev, data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 229 | } |
| 230 | |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 231 | /** |
| 232 | * struct i2c_board_info - template for device creation |
Jean Delvare | eb8a790 | 2008-05-18 20:49:41 +0200 | [diff] [blame] | 233 | * @type: chip type, to initialize i2c_client.name |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 234 | * @flags: to initialize i2c_client.flags |
| 235 | * @addr: stored in i2c_client.addr |
| 236 | * @platform_data: stored in i2c_client.dev.platform_data |
Anton Vorontsov | 11f1f2a | 2008-10-22 20:21:33 +0200 | [diff] [blame] | 237 | * @archdata: copied into i2c_client.dev.archdata |
Randy Dunlap | 72d2e9f | 2010-08-09 16:37:16 -0700 | [diff] [blame] | 238 | * @of_node: pointer to OpenFirmware device node |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 239 | * @irq: stored in i2c_client.irq |
David Brownell | d64f73b | 2007-07-12 14:12:28 +0200 | [diff] [blame] | 240 | * |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 241 | * I2C doesn't actually support hardware probing, although controllers and |
| 242 | * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's |
| 243 | * a device at a given address. Drivers commonly need more information than |
| 244 | * that, such as chip type, configuration, associated IRQ, and so on. |
| 245 | * |
| 246 | * i2c_board_info is used to build tables of information listing I2C devices |
Jean Delvare | 729d6dd | 2009-06-19 16:58:18 +0200 | [diff] [blame] | 247 | * that are present. This information is used to grow the driver model tree. |
| 248 | * For mainboards this is done statically using i2c_register_board_info(); |
| 249 | * bus numbers identify adapters that aren't yet available. For add-on boards, |
| 250 | * i2c_new_device() does this dynamically with the adapter already known. |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 251 | */ |
| 252 | struct i2c_board_info { |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 253 | char type[I2C_NAME_SIZE]; |
| 254 | unsigned short flags; |
| 255 | unsigned short addr; |
| 256 | void *platform_data; |
Anton Vorontsov | 11f1f2a | 2008-10-22 20:21:33 +0200 | [diff] [blame] | 257 | struct dev_archdata *archdata; |
Grant Likely | d12d42f | 2010-04-13 16:12:28 -0700 | [diff] [blame] | 258 | #ifdef CONFIG_OF |
| 259 | struct device_node *of_node; |
| 260 | #endif |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 261 | int irq; |
| 262 | }; |
| 263 | |
| 264 | /** |
Jean Delvare | 3760f73 | 2008-04-29 23:11:40 +0200 | [diff] [blame] | 265 | * I2C_BOARD_INFO - macro used to list an i2c device and its address |
| 266 | * @dev_type: identifies the device type |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 267 | * @dev_addr: the device's address on the bus. |
| 268 | * |
| 269 | * This macro initializes essential fields of a struct i2c_board_info, |
| 270 | * declaring what has been provided on a particular board. Optional |
Jean Delvare | 3760f73 | 2008-04-29 23:11:40 +0200 | [diff] [blame] | 271 | * fields (such as associated irq, or device-specific platform_data) |
| 272 | * are provided using conventional syntax. |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 273 | */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 274 | #define I2C_BOARD_INFO(dev_type, dev_addr) \ |
Ben Hutchings | c758e8c | 2009-04-13 17:02:14 +0200 | [diff] [blame] | 275 | .type = dev_type, .addr = (dev_addr) |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 276 | |
| 277 | |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 278 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 279 | /* Add-on boards should register/unregister their devices; e.g. a board |
| 280 | * with integrated I2C, a config eeprom, sensors, and a codec that's |
| 281 | * used in conjunction with the primary hardware. |
| 282 | */ |
| 283 | extern struct i2c_client * |
| 284 | i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info); |
| 285 | |
Jean Delvare | 12b5053a | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 286 | /* If you don't know the exact address of an I2C device, use this variant |
| 287 | * instead, which can probe for device presence in a list of possible |
Jean Delvare | 9a94241 | 2010-08-11 18:20:56 +0200 | [diff] [blame] | 288 | * addresses. The "probe" callback function is optional. If it is provided, |
| 289 | * it must return 1 on successful probe, 0 otherwise. If it is not provided, |
| 290 | * a default probing method is used. |
Jean Delvare | 12b5053a | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 291 | */ |
| 292 | extern struct i2c_client * |
| 293 | i2c_new_probed_device(struct i2c_adapter *adap, |
| 294 | struct i2c_board_info *info, |
Jean Delvare | 9a94241 | 2010-08-11 18:20:56 +0200 | [diff] [blame] | 295 | unsigned short const *addr_list, |
| 296 | int (*probe)(struct i2c_adapter *, unsigned short addr)); |
Jean Delvare | 12b5053a | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 297 | |
Jean Delvare | d44f19d | 2010-08-11 18:20:57 +0200 | [diff] [blame] | 298 | /* Common custom probe functions */ |
| 299 | extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr); |
| 300 | |
David Brownell | e9f1373 | 2008-01-27 18:14:52 +0100 | [diff] [blame] | 301 | /* For devices that use several addresses, use i2c_new_dummy() to make |
| 302 | * client handles for the extra addresses. |
| 303 | */ |
| 304 | extern struct i2c_client * |
Jean Delvare | 60b129d | 2008-05-11 20:37:06 +0200 | [diff] [blame] | 305 | i2c_new_dummy(struct i2c_adapter *adap, u16 address); |
David Brownell | e9f1373 | 2008-01-27 18:14:52 +0100 | [diff] [blame] | 306 | |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 307 | extern void i2c_unregister_device(struct i2c_client *); |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 308 | #endif /* I2C */ |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 309 | |
| 310 | /* Mainboard arch_initcall() code should register all its I2C devices. |
| 311 | * This is done at arch_initcall time, before declaring any i2c adapters. |
| 312 | * Modules for add-on boards must use other calls. |
| 313 | */ |
David Brownell | 2638676 | 2008-02-24 20:03:42 +0100 | [diff] [blame] | 314 | #ifdef CONFIG_I2C_BOARDINFO |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 315 | extern int |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 316 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
| 317 | unsigned n); |
David Brownell | 2638676 | 2008-02-24 20:03:42 +0100 | [diff] [blame] | 318 | #else |
| 319 | static inline int |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 320 | i2c_register_board_info(int busnum, struct i2c_board_info const *info, |
| 321 | unsigned n) |
David Brownell | 2638676 | 2008-02-24 20:03:42 +0100 | [diff] [blame] | 322 | { |
| 323 | return 0; |
| 324 | } |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 325 | #endif /* I2C_BOARDINFO */ |
David Brownell | 9c1600e | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 326 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 327 | /* |
| 328 | * The following structs are for those who like to implement new bus drivers: |
| 329 | * i2c_algorithm is the interface to a class of hardware solutions which can |
| 330 | * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584 |
| 331 | * to name two of the most common. |
| 332 | */ |
| 333 | struct i2c_algorithm { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 334 | /* If an adapter algorithm can't do I2C-level access, set master_xfer |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 335 | to NULL. If an adapter algorithm can do SMBus access, set |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 336 | smbus_xfer. If set to NULL, the SMBus protocol is simulated |
| 337 | using common I2C messages */ |
Jean Delvare | 8ced8ee | 2006-07-01 17:12:53 +0200 | [diff] [blame] | 338 | /* master_xfer should return the number of messages successfully |
| 339 | processed, or a negative value on error */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 340 | int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs, |
| 341 | int num); |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 342 | int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr, |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 343 | unsigned short flags, char read_write, |
| 344 | u8 command, int size, union i2c_smbus_data *data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 345 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 346 | /* To determine what the adapter supports */ |
| 347 | u32 (*functionality) (struct i2c_adapter *); |
| 348 | }; |
| 349 | |
| 350 | /* |
| 351 | * i2c_adapter is the structure used to identify a physical i2c bus along |
| 352 | * with the access algorithms necessary to access it. |
| 353 | */ |
| 354 | struct i2c_adapter { |
| 355 | struct module *owner; |
Jean Delvare | 020789e | 2005-08-13 13:04:32 +0200 | [diff] [blame] | 356 | unsigned int id; |
Wolfram Sang | 14f55f7 | 2008-10-22 20:21:30 +0200 | [diff] [blame] | 357 | unsigned int class; /* classes to allow probing for */ |
David Brownell | af71ff6 | 2006-09-03 22:37:11 +0200 | [diff] [blame] | 358 | const struct i2c_algorithm *algo; /* the algorithm to access the bus */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 359 | void *algo_data; |
| 360 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 361 | /* data fields that are valid for all devices */ |
Mika Kuoppala | 194684e | 2009-12-06 17:06:22 +0100 | [diff] [blame] | 362 | struct rt_mutex bus_lock; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 363 | |
Jean Delvare | cd97f39 | 2009-02-24 19:19:49 +0100 | [diff] [blame] | 364 | int timeout; /* in jiffies */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | int retries; |
| 366 | struct device dev; /* the adapter device */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 367 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | int nr; |
David Brownell | 2096b95 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 369 | char name[48]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 370 | struct completion dev_released; |
Jean Delvare | 6629dcf | 2010-05-04 11:09:28 +0200 | [diff] [blame] | 371 | |
Jean Delvare | dafc50d | 2010-08-11 18:21:01 +0200 | [diff] [blame] | 372 | struct mutex userspace_clients_lock; |
Jean Delvare | 6629dcf | 2010-05-04 11:09:28 +0200 | [diff] [blame] | 373 | struct list_head userspace_clients; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 374 | }; |
David Brownell | ef2c8321 | 2007-05-01 23:26:28 +0200 | [diff] [blame] | 375 | #define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 376 | |
Jean Delvare | 7d1d899 | 2008-10-22 20:21:31 +0200 | [diff] [blame] | 377 | static inline void *i2c_get_adapdata(const struct i2c_adapter *dev) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 378 | { |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 379 | return dev_get_drvdata(&dev->dev); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 380 | } |
| 381 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 382 | static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 383 | { |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 384 | dev_set_drvdata(&dev->dev, data); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 385 | } |
| 386 | |
Jean Delvare | 97cc4d4 | 2010-10-24 18:16:57 +0200 | [diff] [blame] | 387 | static inline struct i2c_adapter * |
| 388 | i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter) |
Michael Lawnick | 0826374 | 2010-08-11 18:21:02 +0200 | [diff] [blame] | 389 | { |
Jean Delvare | 97cc4d4 | 2010-10-24 18:16:57 +0200 | [diff] [blame] | 390 | struct device *parent = adapter->dev.parent; |
| 391 | |
| 392 | if (parent != NULL && parent->type == &i2c_adapter_type) |
| 393 | return to_i2c_adapter(parent); |
| 394 | else |
| 395 | return NULL; |
Michael Lawnick | 0826374 | 2010-08-11 18:21:02 +0200 | [diff] [blame] | 396 | } |
| 397 | |
Jean Delvare | fe61e07 | 2010-08-11 18:20:58 +0200 | [diff] [blame] | 398 | /* Adapter locking functions, exported for shared pin cases */ |
| 399 | void i2c_lock_adapter(struct i2c_adapter *); |
| 400 | void i2c_unlock_adapter(struct i2c_adapter *); |
Jean Delvare | afa0897 | 2009-11-07 13:10:46 +0100 | [diff] [blame] | 401 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 402 | /*flags for the client struct: */ |
David Brownell | 3bbb835 | 2007-10-13 23:56:29 +0200 | [diff] [blame] | 403 | #define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */ |
| 404 | #define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */ |
| 405 | /* Must equal I2C_M_TEN below */ |
| 406 | #define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 407 | |
| 408 | /* i2c adapter classes (bitmask) */ |
| 409 | #define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */ |
| 410 | #define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */ |
| 411 | #define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */ |
Jean Delvare | c1b6b4f | 2008-07-14 22:38:28 +0200 | [diff] [blame] | 412 | #define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */ |
Jean Delvare | 3401b2f | 2008-07-14 22:38:29 +0200 | [diff] [blame] | 413 | #define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 414 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 415 | /* Internal numbers to terminate lists */ |
| 416 | #define I2C_CLIENT_END 0xfffeU |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 417 | |
| 418 | /* The numbers to use to set I2C bus address */ |
| 419 | #define ANY_I2C_BUS 0xffff |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 420 | |
Hans Verkuil | c703667 | 2009-06-19 16:58:21 +0200 | [diff] [blame] | 421 | /* Construct an I2C_CLIENT_END-terminated array of i2c addresses */ |
| 422 | #define I2C_ADDRS(addr, addrs...) \ |
| 423 | ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END }) |
| 424 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 425 | |
| 426 | /* ----- functions exported by i2c.o */ |
| 427 | |
| 428 | /* administration... |
| 429 | */ |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 430 | #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 431 | extern int i2c_add_adapter(struct i2c_adapter *); |
| 432 | extern int i2c_del_adapter(struct i2c_adapter *); |
David Brownell | 6e13e64 | 2007-05-01 23:26:31 +0200 | [diff] [blame] | 433 | extern int i2c_add_numbered_adapter(struct i2c_adapter *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 434 | |
Greg Kroah-Hartman | de59cf9 | 2005-12-06 15:33:15 -0800 | [diff] [blame] | 435 | extern int i2c_register_driver(struct module *, struct i2c_driver *); |
Jean Delvare | b3e8209 | 2007-05-01 23:26:32 +0200 | [diff] [blame] | 436 | extern void i2c_del_driver(struct i2c_driver *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 437 | |
Greg Kroah-Hartman | de59cf9 | 2005-12-06 15:33:15 -0800 | [diff] [blame] | 438 | static inline int i2c_add_driver(struct i2c_driver *driver) |
| 439 | { |
| 440 | return i2c_register_driver(THIS_MODULE, driver); |
| 441 | } |
| 442 | |
Jean Delvare | e48d331 | 2008-01-27 18:14:48 +0100 | [diff] [blame] | 443 | extern struct i2c_client *i2c_use_client(struct i2c_client *client); |
| 444 | extern void i2c_release_client(struct i2c_client *client); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 445 | |
| 446 | /* call the i2c_client->command() of all attached clients with |
| 447 | * the given arguments */ |
| 448 | extern void i2c_clients_command(struct i2c_adapter *adap, |
| 449 | unsigned int cmd, void *arg); |
| 450 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 451 | extern struct i2c_adapter *i2c_get_adapter(int id); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 452 | extern void i2c_put_adapter(struct i2c_adapter *adap); |
| 453 | |
| 454 | |
| 455 | /* Return the functionality mask */ |
| 456 | static inline u32 i2c_get_functionality(struct i2c_adapter *adap) |
| 457 | { |
| 458 | return adap->algo->functionality(adap); |
| 459 | } |
| 460 | |
| 461 | /* Return 1 if adapter supports everything we need, 0 if not. */ |
| 462 | static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func) |
| 463 | { |
| 464 | return (func & i2c_get_functionality(adap)) == func; |
| 465 | } |
| 466 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 467 | /* Return the adapter number for a specific adapter */ |
Jean Delvare | cdcb192 | 2005-07-28 23:09:40 +0200 | [diff] [blame] | 468 | static inline int i2c_adapter_id(struct i2c_adapter *adap) |
| 469 | { |
| 470 | return adap->nr; |
| 471 | } |
Jean Delvare | 23af840 | 2009-06-19 16:58:20 +0200 | [diff] [blame] | 472 | #endif /* I2C */ |
David Woodhouse | a1b9298 | 2006-04-25 14:14:52 +0100 | [diff] [blame] | 473 | #endif /* __KERNEL__ */ |
Jean Delvare | cdcb192 | 2005-07-28 23:09:40 +0200 | [diff] [blame] | 474 | |
David Brownell | a64ec07 | 2007-10-13 23:56:31 +0200 | [diff] [blame] | 475 | /** |
| 476 | * struct i2c_msg - an I2C transaction segment beginning with START |
| 477 | * @addr: Slave address, either seven or ten bits. When this is a ten |
| 478 | * bit address, I2C_M_TEN must be set in @flags and the adapter |
| 479 | * must support I2C_FUNC_10BIT_ADDR. |
| 480 | * @flags: I2C_M_RD is handled by all adapters. No other flags may be |
| 481 | * provided unless the adapter exported the relevant I2C_FUNC_* |
| 482 | * flags through i2c_check_functionality(). |
| 483 | * @len: Number of data bytes in @buf being read from or written to the |
| 484 | * I2C slave address. For read transactions where I2C_M_RECV_LEN |
| 485 | * is set, the caller guarantees that this buffer can hold up to |
| 486 | * 32 bytes in addition to the initial length byte sent by the |
| 487 | * slave (plus, if used, the SMBus PEC); and this value will be |
| 488 | * incremented by the number of block data bytes received. |
| 489 | * @buf: The buffer into which data is read, or from which it's written. |
| 490 | * |
| 491 | * An i2c_msg is the low level representation of one segment of an I2C |
| 492 | * transaction. It is visible to drivers in the @i2c_transfer() procedure, |
| 493 | * to userspace from i2c-dev, and to I2C adapter drivers through the |
| 494 | * @i2c_adapter.@master_xfer() method. |
| 495 | * |
| 496 | * Except when I2C "protocol mangling" is used, all I2C adapters implement |
| 497 | * the standard rules for I2C transactions. Each transaction begins with a |
| 498 | * START. That is followed by the slave address, and a bit encoding read |
| 499 | * versus write. Then follow all the data bytes, possibly including a byte |
| 500 | * with SMBus PEC. The transfer terminates with a NAK, or when all those |
| 501 | * bytes have been transferred and ACKed. If this is the last message in a |
| 502 | * group, it is followed by a STOP. Otherwise it is followed by the next |
| 503 | * @i2c_msg transaction segment, beginning with a (repeated) START. |
| 504 | * |
| 505 | * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then |
| 506 | * passing certain @flags may have changed those standard protocol behaviors. |
| 507 | * Those flags are only for use with broken/nonconforming slaves, and with |
| 508 | * adapters which are known to support the specific mangling options they |
| 509 | * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 510 | */ |
| 511 | struct i2c_msg { |
| 512 | __u16 addr; /* slave address */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 513 | __u16 flags; |
David Brownell | a64ec07 | 2007-10-13 23:56:31 +0200 | [diff] [blame] | 514 | #define I2C_M_TEN 0x0010 /* this is a ten bit chip address */ |
| 515 | #define I2C_M_RD 0x0001 /* read data, from slave to master */ |
| 516 | #define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */ |
| 517 | #define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */ |
| 518 | #define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */ |
| 519 | #define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */ |
| 520 | #define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 521 | __u16 len; /* msg length */ |
| 522 | __u8 *buf; /* pointer to msg data */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 523 | }; |
| 524 | |
| 525 | /* To determine what functionality is present */ |
| 526 | |
| 527 | #define I2C_FUNC_I2C 0x00000001 |
| 528 | #define I2C_FUNC_10BIT_ADDR 0x00000002 |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 529 | #define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */ |
David Brownell | 6662cbb | 2007-10-13 23:56:33 +0200 | [diff] [blame] | 530 | #define I2C_FUNC_SMBUS_PEC 0x00000008 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 531 | #define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 532 | #define I2C_FUNC_SMBUS_QUICK 0x00010000 |
| 533 | #define I2C_FUNC_SMBUS_READ_BYTE 0x00020000 |
| 534 | #define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000 |
| 535 | #define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000 |
| 536 | #define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000 |
| 537 | #define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000 |
| 538 | #define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000 |
| 539 | #define I2C_FUNC_SMBUS_PROC_CALL 0x00800000 |
| 540 | #define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000 |
| 541 | #define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 542 | #define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */ |
| 543 | #define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 544 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 545 | #define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \ |
| 546 | I2C_FUNC_SMBUS_WRITE_BYTE) |
| 547 | #define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \ |
| 548 | I2C_FUNC_SMBUS_WRITE_BYTE_DATA) |
| 549 | #define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \ |
| 550 | I2C_FUNC_SMBUS_WRITE_WORD_DATA) |
| 551 | #define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \ |
| 552 | I2C_FUNC_SMBUS_WRITE_BLOCK_DATA) |
| 553 | #define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \ |
| 554 | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 555 | |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 556 | #define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \ |
| 557 | I2C_FUNC_SMBUS_BYTE | \ |
| 558 | I2C_FUNC_SMBUS_BYTE_DATA | \ |
| 559 | I2C_FUNC_SMBUS_WORD_DATA | \ |
| 560 | I2C_FUNC_SMBUS_PROC_CALL | \ |
| 561 | I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \ |
| 562 | I2C_FUNC_SMBUS_I2C_BLOCK | \ |
| 563 | I2C_FUNC_SMBUS_PEC) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 564 | |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 565 | /* |
| 566 | * Data for SMBus Messages |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 567 | */ |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 568 | #define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 569 | union i2c_smbus_data { |
| 570 | __u8 byte; |
| 571 | __u16 word; |
Hideki Iwamoto | 332bf92 | 2005-09-25 16:56:43 +0200 | [diff] [blame] | 572 | __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */ |
Jean Delvare | 3ae70de | 2008-10-22 20:21:32 +0200 | [diff] [blame] | 573 | /* and one more for user-space compatibility */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 574 | }; |
| 575 | |
Jean Delvare | ae7193f | 2008-07-14 22:38:24 +0200 | [diff] [blame] | 576 | /* i2c_smbus_xfer read or write markers */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 577 | #define I2C_SMBUS_READ 1 |
| 578 | #define I2C_SMBUS_WRITE 0 |
| 579 | |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 580 | /* SMBus transaction types (size parameter in the above functions) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 581 | Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */ |
| 582 | #define I2C_SMBUS_QUICK 0 |
| 583 | #define I2C_SMBUS_BYTE 1 |
David Brownell | 438d6c2 | 2006-12-10 21:21:31 +0100 | [diff] [blame] | 584 | #define I2C_SMBUS_BYTE_DATA 2 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 585 | #define I2C_SMBUS_WORD_DATA 3 |
| 586 | #define I2C_SMBUS_PROC_CALL 4 |
| 587 | #define I2C_SMBUS_BLOCK_DATA 5 |
Jean Delvare | 4b2643d | 2007-07-12 14:12:29 +0200 | [diff] [blame] | 588 | #define I2C_SMBUS_I2C_BLOCK_BROKEN 6 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 589 | #define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */ |
Jean Delvare | 4b2643d | 2007-07-12 14:12:29 +0200 | [diff] [blame] | 590 | #define I2C_SMBUS_I2C_BLOCK_DATA 8 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 591 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 592 | #endif /* _LINUX_I2C_H */ |