blob: 903576df88dcd6df2b4690991cf88df0b00195f0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------------------- */
David Brownell438d6c22006-12-10 21:21:31 +01002/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003/* i2c.h - definitions for the i2c-bus interface */
David Brownell438d6c22006-12-10 21:21:31 +01004/* */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005/* ------------------------------------------------------------------------- */
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 Woodhousea1b92982006-04-25 14:14:52 +010023/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 Frodo Looijaard <frodol@dds.nl> */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/types.h>
David Brownell438d6c22006-12-10 21:21:31 +010030#ifdef __KERNEL__
David Woodhousea1b92982006-04-25 14:14:52 +010031#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/i2c-id.h>
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020033#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080035#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010036#include <linux/mutex.h>
Grant Likelyd12d42f2010-04-13 16:12:28 -070037#include <linux/of.h> /* for struct device_node */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Jon Smirle9ca9eb2008-07-14 22:38:35 +020039extern struct bus_type i2c_bus_type;
Michael Lawnick08263742010-08-11 18:21:02 +020040extern struct device_type i2c_adapter_type;
Jon Smirle9ca9eb2008-07-14 22:38:35 +020041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* --- General options ------------------------------------------------ */
43
44struct i2c_msg;
45struct i2c_algorithm;
46struct i2c_adapter;
47struct i2c_client;
48struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070049union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020050struct i2c_board_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Jean Delvare23af8402009-06-19 16:58:20 +020052#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070053/*
54 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010055 * on a bus (or read from them). Apart from two basic transfer functions to
56 * transmit one message at a time, a more complex version can be used to
Linus Torvalds1da177e2005-04-16 15:20:36 -070057 * transmit an arbitrary number of messages without interruption.
Zhangfei Gao0c43ea52010-03-02 12:23:49 +010058 * @count must be be less than 64k since msg.len is u16.
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 */
Jean Delvare0cc43a12011-01-10 22:11:23 +010060extern int i2c_master_send(const struct i2c_client *client, const char *buf,
Jean Delvare3ae70de2008-10-22 20:21:32 +020061 int count);
Jean Delvare0cc43a12011-01-10 22:11:23 +010062extern int i2c_master_recv(const struct i2c_client *client, char *buf,
63 int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/* Transfer num messages.
66 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020067extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
68 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70/* This is the very generalized SMBus access routine. You probably do not
71 want to use this, though; one of the functions below may be much easier,
David Brownell438d6c22006-12-10 21:21:31 +010072 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 Note that we use i2c_adapter here, because you do not need a specific
74 smbus adapter to call this function. */
Jean Delvare3ae70de2008-10-22 20:21:32 +020075extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
76 unsigned short flags, char read_write, u8 command,
77 int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +020080 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Jean Delvare0cc43a12011-01-10 22:11:23 +010082extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
83extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
84extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
85 u8 command);
86extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +020087 u8 command, u8 value);
Jean Delvare0cc43a12011-01-10 22:11:23 +010088extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
89 u8 command);
90extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +020091 u8 command, u16 value);
Jean Delvareb86a1bc2007-05-01 23:26:34 +020092/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +010093extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
Jean Delvareb86a1bc2007-05-01 23:26:34 +020094 u8 command, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +010095extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
Jean Delvare3ae70de2008-10-22 20:21:32 +020096 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +020097/* Returns the number of read bytes */
Jean Delvare0cc43a12011-01-10 22:11:23 +010098extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +020099 u8 command, u8 length, u8 *values);
Jean Delvare0cc43a12011-01-10 22:11:23 +0100100extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +1100101 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +0200102 const u8 *values);
Jean Delvare23af8402009-06-19 16:58:20 +0200103#endif /* I2C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
Jean Delvare4735c982008-07-14 22:38:36 +0200105/**
106 * struct i2c_driver - represent an I2C device driver
107 * @class: What kind of i2c device we instantiate (for detect)
Jean Delvare96e21e42008-08-28 08:33:23 +0200108 * @attach_adapter: Callback for bus addition (for legacy drivers)
109 * @detach_adapter: Callback for bus removal (for legacy drivers)
Jean Delvare729d6dd2009-06-19 16:58:18 +0200110 * @probe: Callback for device binding
111 * @remove: Callback for device unbinding
Jean Delvare96e21e42008-08-28 08:33:23 +0200112 * @shutdown: Callback for device shutdown
113 * @suspend: Callback for device suspend
114 * @resume: Callback for device resume
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700115 * @alert: Alert callback, for example for the SMBus alert protocol
Jean Delvare96e21e42008-08-28 08:33:23 +0200116 * @command: Callback for bus-wide signaling (optional)
117 * @driver: Device driver model driver
118 * @id_table: List of I2C devices supported by this driver
Jean Delvare4735c982008-07-14 22:38:36 +0200119 * @detect: Callback for device detection
Jean Delvarec3813d62009-12-14 21:17:25 +0100120 * @address_list: The I2C addresses to probe (for detect)
Jean Delvare4735c982008-07-14 22:38:36 +0200121 * @clients: List of detected clients we created (for i2c-core use only)
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100122 *
123 * The driver.owner field should be set to the module owner of this driver.
124 * The driver.name field should be set to the name of this driver.
Jean Delvare4735c982008-07-14 22:38:36 +0200125 *
126 * For automatic device detection, both @detect and @address_data must
127 * be defined. @class should also be set, otherwise only devices forced
128 * with module parameters will be created. The detect function must
129 * fill at least the name field of the i2c_board_info structure it is
130 * handed upon successful detection, and possibly also the flags field.
131 *
132 * If @detect is missing, the driver will still work fine for enumerated
133 * devices. Detected devices simply won't be supported. This is expected
134 * for the many I2C/SMBus devices which can't be detected reliably, and
135 * the ones which can always be enumerated in practice.
136 *
137 * The i2c_client structure which is handed to the @detect callback is
138 * not a real i2c_client. It is initialized just enough so that you can
139 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
140 * else with it. In particular, calling dev_dbg and friends on it is
141 * not allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Jean Delvare729d6dd2009-06-19 16:58:18 +0200146 /* Notifies the driver that a new bus has appeared or is about to be
147 * removed. You should avoid using this if you can, it will probably
148 * be removed in a near future.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 */
150 int (*attach_adapter)(struct i2c_adapter *);
151 int (*detach_adapter)(struct i2c_adapter *);
152
Jean Delvare729d6dd2009-06-19 16:58:18 +0200153 /* Standard driver model interfaces */
Jean Delvared2653e92008-04-29 23:11:39 +0200154 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200155 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200156
David Brownellf37dd802007-02-13 22:09:00 +0100157 /* driver model interfaces that don't relate to enumeration */
158 void (*shutdown)(struct i2c_client *);
159 int (*suspend)(struct i2c_client *, pm_message_t mesg);
160 int (*resume)(struct i2c_client *);
161
Jean Delvareb5527a72010-03-02 12:23:42 +0100162 /* Alert callback, for example for the SMBus alert protocol.
163 * The format and meaning of the data value depends on the protocol.
164 * For the SMBus alert protocol, there is a single bit of data passed
165 * as the alert response's low bit ("event flag").
166 */
167 void (*alert)(struct i2c_client *, unsigned int data);
168
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 /* a ioctl like command that can be used to perform specific functions
170 * with the device.
171 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200172 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200175 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200176
177 /* Device detection callback for automatic device creation */
Jean Delvare310ec792009-12-14 21:17:23 +0100178 int (*detect)(struct i2c_client *, struct i2c_board_info *);
Jean Delvarec3813d62009-12-14 21:17:25 +0100179 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +0200180 struct list_head clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
183
David Brownell2096b952007-05-01 23:26:28 +0200184/**
185 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200186 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
187 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
David Brownell2096b952007-05-01 23:26:28 +0200188 * @addr: Address used on the I2C bus connected to the parent adapter.
189 * @name: Indicates the type of the device, usually a chip name that's
190 * generic enough to hide second-sourcing and compatible revisions.
David Brownelld64f73b2007-07-12 14:12:28 +0200191 * @adapter: manages the bus segment hosting this I2C device
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700192 * @driver: device's driver, hence pointer to access routines
David Brownell2096b952007-05-01 23:26:28 +0200193 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200194 * @irq: indicates the IRQ generated by this device (if any)
Jean Delvare99cd8e22009-06-19 16:58:20 +0200195 * @detected: member of an i2c_driver.clients list or i2c-core's
196 * userspace_devices list
David Brownell2096b952007-05-01 23:26:28 +0200197 *
198 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200199 * i2c bus. The behaviour exposed to Linux is defined by the driver
200 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 */
202struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200203 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100204 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200206 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200207 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 struct i2c_adapter *adapter; /* the adapter we sit on */
209 struct i2c_driver *driver; /* and our access routines */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200211 int irq; /* irq issued by device */
Jean Delvare4735c982008-07-14 22:38:36 +0200212 struct list_head detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213};
214#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
215
David Brownell9b766b82008-01-27 18:14:51 +0100216extern struct i2c_client *i2c_verify_client(struct device *dev);
217
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500218static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
219{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200220 struct device * const dev = container_of(kobj, struct device, kobj);
221 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500222}
223
Jean Delvare7d1d8992008-10-22 20:21:31 +0200224static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200226 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227}
228
Jean Delvare3ae70de2008-10-22 20:21:32 +0200229static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200231 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
David Brownell9c1600e2007-05-01 23:26:31 +0200234/**
235 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200236 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200237 * @flags: to initialize i2c_client.flags
238 * @addr: stored in i2c_client.addr
239 * @platform_data: stored in i2c_client.dev.platform_data
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200240 * @archdata: copied into i2c_client.dev.archdata
Randy Dunlap72d2e9f2010-08-09 16:37:16 -0700241 * @of_node: pointer to OpenFirmware device node
David Brownell9c1600e2007-05-01 23:26:31 +0200242 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200243 *
David Brownell9c1600e2007-05-01 23:26:31 +0200244 * I2C doesn't actually support hardware probing, although controllers and
245 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
246 * a device at a given address. Drivers commonly need more information than
247 * that, such as chip type, configuration, associated IRQ, and so on.
248 *
249 * i2c_board_info is used to build tables of information listing I2C devices
Jean Delvare729d6dd2009-06-19 16:58:18 +0200250 * that are present. This information is used to grow the driver model tree.
251 * For mainboards this is done statically using i2c_register_board_info();
252 * bus numbers identify adapters that aren't yet available. For add-on boards,
253 * i2c_new_device() does this dynamically with the adapter already known.
David Brownell9c1600e2007-05-01 23:26:31 +0200254 */
255struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200256 char type[I2C_NAME_SIZE];
257 unsigned short flags;
258 unsigned short addr;
259 void *platform_data;
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200260 struct dev_archdata *archdata;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700261#ifdef CONFIG_OF
262 struct device_node *of_node;
263#endif
David Brownell9c1600e2007-05-01 23:26:31 +0200264 int irq;
265};
266
267/**
Jean Delvare3760f732008-04-29 23:11:40 +0200268 * I2C_BOARD_INFO - macro used to list an i2c device and its address
269 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200270 * @dev_addr: the device's address on the bus.
271 *
272 * This macro initializes essential fields of a struct i2c_board_info,
273 * declaring what has been provided on a particular board. Optional
Jean Delvare3760f732008-04-29 23:11:40 +0200274 * fields (such as associated irq, or device-specific platform_data)
275 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200276 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200277#define I2C_BOARD_INFO(dev_type, dev_addr) \
Ben Hutchingsc758e8c2009-04-13 17:02:14 +0200278 .type = dev_type, .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200279
280
Jean Delvare23af8402009-06-19 16:58:20 +0200281#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
David Brownell9c1600e2007-05-01 23:26:31 +0200282/* Add-on boards should register/unregister their devices; e.g. a board
283 * with integrated I2C, a config eeprom, sensors, and a codec that's
284 * used in conjunction with the primary hardware.
285 */
286extern struct i2c_client *
287i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
288
Jean Delvare12b5053a2007-05-01 23:26:31 +0200289/* If you don't know the exact address of an I2C device, use this variant
290 * instead, which can probe for device presence in a list of possible
Jean Delvare9a942412010-08-11 18:20:56 +0200291 * addresses. The "probe" callback function is optional. If it is provided,
292 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
293 * a default probing method is used.
Jean Delvare12b5053a2007-05-01 23:26:31 +0200294 */
295extern struct i2c_client *
296i2c_new_probed_device(struct i2c_adapter *adap,
297 struct i2c_board_info *info,
Jean Delvare9a942412010-08-11 18:20:56 +0200298 unsigned short const *addr_list,
299 int (*probe)(struct i2c_adapter *, unsigned short addr));
Jean Delvare12b5053a2007-05-01 23:26:31 +0200300
Jean Delvared44f19d2010-08-11 18:20:57 +0200301/* Common custom probe functions */
302extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
303
David Brownelle9f13732008-01-27 18:14:52 +0100304/* For devices that use several addresses, use i2c_new_dummy() to make
305 * client handles for the extra addresses.
306 */
307extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200308i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100309
David Brownell9c1600e2007-05-01 23:26:31 +0200310extern void i2c_unregister_device(struct i2c_client *);
Jean Delvare23af8402009-06-19 16:58:20 +0200311#endif /* I2C */
David Brownell9c1600e2007-05-01 23:26:31 +0200312
313/* Mainboard arch_initcall() code should register all its I2C devices.
314 * This is done at arch_initcall time, before declaring any i2c adapters.
315 * Modules for add-on boards must use other calls.
316 */
David Brownell26386762008-02-24 20:03:42 +0100317#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200318extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200319i2c_register_board_info(int busnum, struct i2c_board_info const *info,
320 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100321#else
322static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200323i2c_register_board_info(int busnum, struct i2c_board_info const *info,
324 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100325{
326 return 0;
327}
Jean Delvare23af8402009-06-19 16:58:20 +0200328#endif /* I2C_BOARDINFO */
David Brownell9c1600e2007-05-01 23:26:31 +0200329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330/*
331 * The following structs are for those who like to implement new bus drivers:
332 * i2c_algorithm is the interface to a class of hardware solutions which can
333 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
334 * to name two of the most common.
335 */
336struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100338 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 smbus_xfer. If set to NULL, the SMBus protocol is simulated
340 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200341 /* master_xfer should return the number of messages successfully
342 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200343 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
344 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100345 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200346 unsigned short flags, char read_write,
347 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349 /* To determine what the adapter supports */
350 u32 (*functionality) (struct i2c_adapter *);
351};
352
353/*
354 * i2c_adapter is the structure used to identify a physical i2c bus along
355 * with the access algorithms necessary to access it.
356 */
357struct i2c_adapter {
358 struct module *owner;
Jean Delvaree1e18ee2010-11-15 22:40:38 +0100359 unsigned int id __deprecated;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200360 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200361 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 void *algo_data;
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 /* data fields that are valid for all devices */
Mika Kuoppala194684e2009-12-06 17:06:22 +0100365 struct rt_mutex bus_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Jean Delvarecd97f392009-02-24 19:19:49 +0100367 int timeout; /* in jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 int retries;
369 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 int nr;
David Brownell2096b952007-05-01 23:26:28 +0200372 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 struct completion dev_released;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200374
Jean Delvaredafc50d2010-08-11 18:21:01 +0200375 struct mutex userspace_clients_lock;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200376 struct list_head userspace_clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377};
David Brownellef2c83212007-05-01 23:26:28 +0200378#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379
Jean Delvare7d1d8992008-10-22 20:21:31 +0200380static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200382 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383}
384
Jean Delvare3ae70de2008-10-22 20:21:32 +0200385static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200387 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388}
389
Jean Delvare97cc4d42010-10-24 18:16:57 +0200390static inline struct i2c_adapter *
391i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
Michael Lawnick08263742010-08-11 18:21:02 +0200392{
Jean Delvare97cc4d42010-10-24 18:16:57 +0200393 struct device *parent = adapter->dev.parent;
394
395 if (parent != NULL && parent->type == &i2c_adapter_type)
396 return to_i2c_adapter(parent);
397 else
398 return NULL;
Michael Lawnick08263742010-08-11 18:21:02 +0200399}
400
Jean Delvarefe61e072010-08-11 18:20:58 +0200401/* Adapter locking functions, exported for shared pin cases */
402void i2c_lock_adapter(struct i2c_adapter *);
403void i2c_unlock_adapter(struct i2c_adapter *);
Jean Delvareafa08972009-11-07 13:10:46 +0100404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405/*flags for the client struct: */
David Brownell3bbb8352007-10-13 23:56:29 +0200406#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
407#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
408 /* Must equal I2C_M_TEN below */
409#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411/* i2c adapter classes (bitmask) */
412#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
Jean Delvarec1b6b4f2008-07-14 22:38:28 +0200413#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Jean Delvare3401b2f2008-07-14 22:38:29 +0200414#define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416/* Internal numbers to terminate lists */
417#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
419/* The numbers to use to set I2C bus address */
420#define ANY_I2C_BUS 0xffff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Hans Verkuilc7036672009-06-19 16:58:21 +0200422/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
423#define I2C_ADDRS(addr, addrs...) \
424 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427/* ----- functions exported by i2c.o */
428
429/* administration...
430 */
Jean Delvare23af8402009-06-19 16:58:20 +0200431#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432extern int i2c_add_adapter(struct i2c_adapter *);
433extern int i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200434extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800436extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200437extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800439static inline int i2c_add_driver(struct i2c_driver *driver)
440{
441 return i2c_register_driver(THIS_MODULE, driver);
442}
443
Jean Delvaree48d3312008-01-27 18:14:48 +0100444extern struct i2c_client *i2c_use_client(struct i2c_client *client);
445extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447/* call the i2c_client->command() of all attached clients with
448 * the given arguments */
449extern void i2c_clients_command(struct i2c_adapter *adap,
450 unsigned int cmd, void *arg);
451
Jean Delvare3ae70de2008-10-22 20:21:32 +0200452extern struct i2c_adapter *i2c_get_adapter(int id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453extern void i2c_put_adapter(struct i2c_adapter *adap);
454
455
456/* Return the functionality mask */
457static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
458{
459 return adap->algo->functionality(adap);
460}
461
462/* Return 1 if adapter supports everything we need, 0 if not. */
463static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
464{
465 return (func & i2c_get_functionality(adap)) == func;
466}
467
Jean Delvare3ae70de2008-10-22 20:21:32 +0200468/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200469static inline int i2c_adapter_id(struct i2c_adapter *adap)
470{
471 return adap->nr;
472}
Jean Delvare23af8402009-06-19 16:58:20 +0200473#endif /* I2C */
David Woodhousea1b92982006-04-25 14:14:52 +0100474#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200475
David Brownella64ec072007-10-13 23:56:31 +0200476/**
477 * struct i2c_msg - an I2C transaction segment beginning with START
478 * @addr: Slave address, either seven or ten bits. When this is a ten
479 * bit address, I2C_M_TEN must be set in @flags and the adapter
480 * must support I2C_FUNC_10BIT_ADDR.
481 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
482 * provided unless the adapter exported the relevant I2C_FUNC_*
483 * flags through i2c_check_functionality().
484 * @len: Number of data bytes in @buf being read from or written to the
485 * I2C slave address. For read transactions where I2C_M_RECV_LEN
486 * is set, the caller guarantees that this buffer can hold up to
487 * 32 bytes in addition to the initial length byte sent by the
488 * slave (plus, if used, the SMBus PEC); and this value will be
489 * incremented by the number of block data bytes received.
490 * @buf: The buffer into which data is read, or from which it's written.
491 *
492 * An i2c_msg is the low level representation of one segment of an I2C
493 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
494 * to userspace from i2c-dev, and to I2C adapter drivers through the
495 * @i2c_adapter.@master_xfer() method.
496 *
497 * Except when I2C "protocol mangling" is used, all I2C adapters implement
498 * the standard rules for I2C transactions. Each transaction begins with a
499 * START. That is followed by the slave address, and a bit encoding read
500 * versus write. Then follow all the data bytes, possibly including a byte
501 * with SMBus PEC. The transfer terminates with a NAK, or when all those
502 * bytes have been transferred and ACKed. If this is the last message in a
503 * group, it is followed by a STOP. Otherwise it is followed by the next
504 * @i2c_msg transaction segment, beginning with a (repeated) START.
505 *
506 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
507 * passing certain @flags may have changed those standard protocol behaviors.
508 * Those flags are only for use with broken/nonconforming slaves, and with
509 * adapters which are known to support the specific mangling options they
510 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 */
512struct i2c_msg {
513 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100514 __u16 flags;
David Brownella64ec072007-10-13 23:56:31 +0200515#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
516#define I2C_M_RD 0x0001 /* read data, from slave to master */
517#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
518#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
519#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
520#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
521#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
David Brownell438d6c22006-12-10 21:21:31 +0100522 __u16 len; /* msg length */
523 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524};
525
526/* To determine what functionality is present */
527
528#define I2C_FUNC_I2C 0x00000001
529#define I2C_FUNC_10BIT_ADDR 0x00000002
Jean Delvare3ae70de2008-10-22 20:21:32 +0200530#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
David Brownell6662cbb2007-10-13 23:56:33 +0200531#define I2C_FUNC_SMBUS_PEC 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100533#define I2C_FUNC_SMBUS_QUICK 0x00010000
534#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
535#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
536#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
537#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
538#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
539#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
540#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
541#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
542#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
544#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Jean Delvare3ae70de2008-10-22 20:21:32 +0200546#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
547 I2C_FUNC_SMBUS_WRITE_BYTE)
548#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
549 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
550#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
551 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
552#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
553 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
554#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
555 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Jean Delvare3ae70de2008-10-22 20:21:32 +0200557#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
558 I2C_FUNC_SMBUS_BYTE | \
559 I2C_FUNC_SMBUS_BYTE_DATA | \
560 I2C_FUNC_SMBUS_WORD_DATA | \
561 I2C_FUNC_SMBUS_PROC_CALL | \
562 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
563 I2C_FUNC_SMBUS_I2C_BLOCK | \
564 I2C_FUNC_SMBUS_PEC)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
David Brownell438d6c22006-12-10 21:21:31 +0100566/*
567 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 */
David Brownell438d6c22006-12-10 21:21:31 +0100569#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570union i2c_smbus_data {
571 __u8 byte;
572 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200573 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200574 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575};
576
Jean Delvareae7193f2008-07-14 22:38:24 +0200577/* i2c_smbus_xfer read or write markers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578#define I2C_SMBUS_READ 1
579#define I2C_SMBUS_WRITE 0
580
David Brownell438d6c22006-12-10 21:21:31 +0100581/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
583#define I2C_SMBUS_QUICK 0
584#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100585#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586#define I2C_SMBUS_WORD_DATA 3
587#define I2C_SMBUS_PROC_CALL 4
588#define I2C_SMBUS_BLOCK_DATA 5
Jean Delvare4b2643d2007-07-12 14:12:29 +0200589#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Jean Delvare4b2643d2007-07-12 14:12:29 +0200591#define I2C_SMBUS_I2C_BLOCK_DATA 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593#endif /* _LINUX_I2C_H */