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