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