blob: 21067b4185366b419a6c7af504ff1a711642457b [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;
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041/* --- General options ------------------------------------------------ */
42
43struct i2c_msg;
44struct i2c_algorithm;
45struct i2c_adapter;
46struct i2c_client;
47struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070048union i2c_smbus_data;
Jean Delvare4735c982008-07-14 22:38:36 +020049struct i2c_board_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Jean Delvare23af8402009-06-19 16:58:20 +020051#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
53 * The master routines are the ones normally used to transmit data to devices
David Brownell438d6c22006-12-10 21:21:31 +010054 * 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 Torvalds1da177e2005-04-16 15:20:36 -070056 * transmit an arbitrary number of messages without interruption.
Zhangfei Gao0c43ea52010-03-02 12:23:49 +010057 * @count must be be less than 64k since msg.len is u16.
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020059extern int i2c_master_send(struct i2c_client *client, const char *buf,
60 int count);
61extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/* Transfer num messages.
64 */
Jean Delvare3ae70de2008-10-22 20:21:32 +020065extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
66 int num);
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
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 Brownell438d6c22006-12-10 21:21:31 +010070 and probably just as fast.
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 Note that we use i2c_adapter here, because you do not need a specific
72 smbus adapter to call this function. */
Jean Delvare3ae70de2008-10-22 20:21:32 +020073extern 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 Torvalds1da177e2005-04-16 15:20:36 -070076
77/* Now follow the 'nice' access routines. These also document the calling
Jean Delvareae7193f2008-07-14 22:38:24 +020078 conventions of i2c_smbus_xfer. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Jean Delvare3ae70de2008-10-22 20:21:32 +020080extern s32 i2c_smbus_read_byte(struct i2c_client *client);
81extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
82extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
83extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
84 u8 command, u8 value);
85extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
86extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
87 u8 command, u16 value);
Jean Delvareb86a1bc2007-05-01 23:26:34 +020088/* Returns the number of read bytes */
89extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
90 u8 command, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020091extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
92 u8 command, u8 length, const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +020093/* Returns the number of read bytes */
Jean Delvare3ae70de2008-10-22 20:21:32 +020094extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
Jean Delvare4b2643d2007-07-12 14:12:29 +020095 u8 command, u8 length, u8 *values);
Jean Delvare3ae70de2008-10-22 20:21:32 +020096extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
Jean Delvare21bbd692006-01-09 15:19:18 +110097 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +020098 const u8 *values);
Jean Delvare23af8402009-06-19 16:58:20 +020099#endif /* I2C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Jean Delvare4735c982008-07-14 22:38:36 +0200101/**
102 * struct i2c_driver - represent an I2C device driver
103 * @class: What kind of i2c device we instantiate (for detect)
Jean Delvare96e21e42008-08-28 08:33:23 +0200104 * @attach_adapter: Callback for bus addition (for legacy drivers)
105 * @detach_adapter: Callback for bus removal (for legacy drivers)
Jean Delvare729d6dd2009-06-19 16:58:18 +0200106 * @probe: Callback for device binding
107 * @remove: Callback for device unbinding
Jean Delvare96e21e42008-08-28 08:33:23 +0200108 * @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 Delvare4735c982008-07-14 22:38:36 +0200114 * @detect: Callback for device detection
Jean Delvarec3813d62009-12-14 21:17:25 +0100115 * @address_list: The I2C addresses to probe (for detect)
Jean Delvare4735c982008-07-14 22:38:36 +0200116 * @clients: List of detected clients we created (for i2c-core use only)
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100117 *
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 Delvare4735c982008-07-14 22:38:36 +0200120 *
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 Torvalds1da177e2005-04-16 15:20:36 -0700137 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Jean Delvare729d6dd2009-06-19 16:58:18 +0200141 /* 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 Torvalds1da177e2005-04-16 15:20:36 -0700144 */
145 int (*attach_adapter)(struct i2c_adapter *);
146 int (*detach_adapter)(struct i2c_adapter *);
147
Jean Delvare729d6dd2009-06-19 16:58:18 +0200148 /* Standard driver model interfaces */
Jean Delvared2653e92008-04-29 23:11:39 +0200149 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
David Brownella1d9e6e2007-05-01 23:26:30 +0200150 int (*remove)(struct i2c_client *);
David Brownell7b4fbc52007-05-01 23:26:30 +0200151
David Brownellf37dd802007-02-13 22:09:00 +0100152 /* 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 Delvareb5527a72010-03-02 12:23:42 +0100157 /* 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 Torvalds1da177e2005-04-16 15:20:36 -0700164 /* a ioctl like command that can be used to perform specific functions
165 * with the device.
166 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200167 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
169 struct device_driver driver;
Jean Delvared2653e92008-04-29 23:11:39 +0200170 const struct i2c_device_id *id_table;
Jean Delvare4735c982008-07-14 22:38:36 +0200171
172 /* Device detection callback for automatic device creation */
Jean Delvare310ec792009-12-14 21:17:23 +0100173 int (*detect)(struct i2c_client *, struct i2c_board_info *);
Jean Delvarec3813d62009-12-14 21:17:25 +0100174 const unsigned short *address_list;
Jean Delvare4735c982008-07-14 22:38:36 +0200175 struct list_head clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176};
177#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
178
David Brownell2096b952007-05-01 23:26:28 +0200179/**
180 * struct i2c_client - represent an I2C slave device
David Brownelld64f73b2007-07-12 14:12:28 +0200181 * @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 Brownell2096b952007-05-01 23:26:28 +0200183 * @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 Brownelld64f73b2007-07-12 14:12:28 +0200186 * @adapter: manages the bus segment hosting this I2C device
Randy Dunlapaa3481d2007-07-31 00:39:02 -0700187 * @driver: device's driver, hence pointer to access routines
David Brownell2096b952007-05-01 23:26:28 +0200188 * @dev: Driver model device node for the slave.
David Brownelld64f73b2007-07-12 14:12:28 +0200189 * @irq: indicates the IRQ generated by this device (if any)
Jean Delvare99cd8e22009-06-19 16:58:20 +0200190 * @detected: member of an i2c_driver.clients list or i2c-core's
191 * userspace_devices list
David Brownell2096b952007-05-01 23:26:28 +0200192 *
193 * An i2c_client identifies a single device (i.e. chip) connected to an
David Brownelld64f73b2007-07-12 14:12:28 +0200194 * i2c bus. The behaviour exposed to Linux is defined by the driver
195 * managing the device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 */
197struct i2c_client {
David Brownell2096b952007-05-01 23:26:28 +0200198 unsigned short flags; /* div., see below */
David Brownell438d6c22006-12-10 21:21:31 +0100199 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200201 /* _LOWER_ 7 bits */
David Brownell2096b952007-05-01 23:26:28 +0200202 char name[I2C_NAME_SIZE];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 struct i2c_adapter *adapter; /* the adapter we sit on */
204 struct i2c_driver *driver; /* and our access routines */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 struct device dev; /* the device structure */
Wolfram Sang8e29da92008-07-01 22:38:18 +0200206 int irq; /* irq issued by device */
Jean Delvare4735c982008-07-14 22:38:36 +0200207 struct list_head detected;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208};
209#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
210
David Brownell9b766b82008-01-27 18:14:51 +0100211extern struct i2c_client *i2c_verify_client(struct device *dev);
212
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500213static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
214{
Mark M. Hoffmand75d53c2007-07-12 14:12:28 +0200215 struct device * const dev = container_of(kobj, struct device, kobj);
216 return to_i2c_client(dev);
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500217}
218
Jean Delvare7d1d8992008-10-22 20:21:31 +0200219static inline void *i2c_get_clientdata(const struct i2c_client *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200221 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222}
223
Jean Delvare3ae70de2008-10-22 20:21:32 +0200224static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200226 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227}
228
David Brownell9c1600e2007-05-01 23:26:31 +0200229/**
230 * struct i2c_board_info - template for device creation
Jean Delvareeb8a7902008-05-18 20:49:41 +0200231 * @type: chip type, to initialize i2c_client.name
David Brownell9c1600e2007-05-01 23:26:31 +0200232 * @flags: to initialize i2c_client.flags
233 * @addr: stored in i2c_client.addr
234 * @platform_data: stored in i2c_client.dev.platform_data
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200235 * @archdata: copied into i2c_client.dev.archdata
David Brownell9c1600e2007-05-01 23:26:31 +0200236 * @irq: stored in i2c_client.irq
David Brownelld64f73b2007-07-12 14:12:28 +0200237 *
David Brownell9c1600e2007-05-01 23:26:31 +0200238 * 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 Delvare729d6dd2009-06-19 16:58:18 +0200244 * 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 Brownell9c1600e2007-05-01 23:26:31 +0200248 */
249struct i2c_board_info {
David Brownell9c1600e2007-05-01 23:26:31 +0200250 char type[I2C_NAME_SIZE];
251 unsigned short flags;
252 unsigned short addr;
253 void *platform_data;
Anton Vorontsov11f1f2a2008-10-22 20:21:33 +0200254 struct dev_archdata *archdata;
Grant Likelyd12d42f2010-04-13 16:12:28 -0700255#ifdef CONFIG_OF
256 struct device_node *of_node;
257#endif
David Brownell9c1600e2007-05-01 23:26:31 +0200258 int irq;
259};
260
261/**
Jean Delvare3760f732008-04-29 23:11:40 +0200262 * I2C_BOARD_INFO - macro used to list an i2c device and its address
263 * @dev_type: identifies the device type
David Brownell9c1600e2007-05-01 23:26:31 +0200264 * @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 Delvare3760f732008-04-29 23:11:40 +0200268 * fields (such as associated irq, or device-specific platform_data)
269 * are provided using conventional syntax.
David Brownell9c1600e2007-05-01 23:26:31 +0200270 */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200271#define I2C_BOARD_INFO(dev_type, dev_addr) \
Ben Hutchingsc758e8c2009-04-13 17:02:14 +0200272 .type = dev_type, .addr = (dev_addr)
David Brownell9c1600e2007-05-01 23:26:31 +0200273
274
Jean Delvare23af8402009-06-19 16:58:20 +0200275#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
David Brownell9c1600e2007-05-01 23:26:31 +0200276/* 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 */
280extern struct i2c_client *
281i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
282
Jean Delvare12b5053a2007-05-01 23:26:31 +0200283/* 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 */
287extern struct i2c_client *
288i2c_new_probed_device(struct i2c_adapter *adap,
289 struct i2c_board_info *info,
290 unsigned short const *addr_list);
291
David Brownelle9f13732008-01-27 18:14:52 +0100292/* For devices that use several addresses, use i2c_new_dummy() to make
293 * client handles for the extra addresses.
294 */
295extern struct i2c_client *
Jean Delvare60b129d2008-05-11 20:37:06 +0200296i2c_new_dummy(struct i2c_adapter *adap, u16 address);
David Brownelle9f13732008-01-27 18:14:52 +0100297
David Brownell9c1600e2007-05-01 23:26:31 +0200298extern void i2c_unregister_device(struct i2c_client *);
Jean Delvare23af8402009-06-19 16:58:20 +0200299#endif /* I2C */
David Brownell9c1600e2007-05-01 23:26:31 +0200300
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 Brownell26386762008-02-24 20:03:42 +0100305#ifdef CONFIG_I2C_BOARDINFO
David Brownell9c1600e2007-05-01 23:26:31 +0200306extern int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200307i2c_register_board_info(int busnum, struct i2c_board_info const *info,
308 unsigned n);
David Brownell26386762008-02-24 20:03:42 +0100309#else
310static inline int
Jean Delvare3ae70de2008-10-22 20:21:32 +0200311i2c_register_board_info(int busnum, struct i2c_board_info const *info,
312 unsigned n)
David Brownell26386762008-02-24 20:03:42 +0100313{
314 return 0;
315}
Jean Delvare23af8402009-06-19 16:58:20 +0200316#endif /* I2C_BOARDINFO */
David Brownell9c1600e2007-05-01 23:26:31 +0200317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318/*
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 */
324struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 /* If an adapter algorithm can't do I2C-level access, set master_xfer
David Brownell438d6c22006-12-10 21:21:31 +0100326 to NULL. If an adapter algorithm can do SMBus access, set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 smbus_xfer. If set to NULL, the SMBus protocol is simulated
328 using common I2C messages */
Jean Delvare8ced8ee2006-07-01 17:12:53 +0200329 /* master_xfer should return the number of messages successfully
330 processed, or a negative value on error */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200331 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
332 int num);
David Brownell438d6c22006-12-10 21:21:31 +0100333 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
Jean Delvare3ae70de2008-10-22 20:21:32 +0200334 unsigned short flags, char read_write,
335 u8 command, int size, union i2c_smbus_data *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 /* 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 */
345struct i2c_adapter {
346 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200347 unsigned int id;
Wolfram Sang14f55f72008-10-22 20:21:30 +0200348 unsigned int class; /* classes to allow probing for */
David Brownellaf71ff62006-09-03 22:37:11 +0200349 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 void *algo_data;
351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 /* data fields that are valid for all devices */
Mika Kuoppala194684e2009-12-06 17:06:22 +0100353 struct rt_mutex bus_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Jean Delvarecd97f392009-02-24 19:19:49 +0100355 int timeout; /* in jiffies */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 int retries;
357 struct device dev; /* the adapter device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 int nr;
David Brownell2096b952007-05-01 23:26:28 +0200360 char name[48];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 struct completion dev_released;
Jean Delvare6629dcf2010-05-04 11:09:28 +0200362
363 struct list_head userspace_clients;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364};
David Brownellef2c83212007-05-01 23:26:28 +0200365#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Jean Delvare7d1d8992008-10-22 20:21:31 +0200367static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200369 return dev_get_drvdata(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370}
371
Jean Delvare3ae70de2008-10-22 20:21:32 +0200372static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373{
Jean Delvare3ae70de2008-10-22 20:21:32 +0200374 dev_set_drvdata(&dev->dev, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375}
376
Jean Delvareafa08972009-11-07 13:10:46 +0100377/**
378 * i2c_lock_adapter - Prevent access to an I2C bus segment
379 * @adapter: Target I2C bus segment
380 */
381static inline void i2c_lock_adapter(struct i2c_adapter *adapter)
382{
Mika Kuoppala194684e2009-12-06 17:06:22 +0100383 rt_mutex_lock(&adapter->bus_lock);
Jean Delvareafa08972009-11-07 13:10:46 +0100384}
385
386/**
387 * i2c_unlock_adapter - Reauthorize access to an I2C bus segment
388 * @adapter: Target I2C bus segment
389 */
390static inline void i2c_unlock_adapter(struct i2c_adapter *adapter)
391{
Mika Kuoppala194684e2009-12-06 17:06:22 +0100392 rt_mutex_unlock(&adapter->bus_lock);
Jean Delvareafa08972009-11-07 13:10:46 +0100393}
394
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395/*flags for the client struct: */
David Brownell3bbb8352007-10-13 23:56:29 +0200396#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 Torvalds1da177e2005-04-16 15:20:36 -0700400
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 Delvarec1b6b4f2008-07-14 22:38:28 +0200405#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
Jean Delvare3401b2f2008-07-14 22:38:29 +0200406#define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/* Internal numbers to terminate lists */
409#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411/* The numbers to use to set I2C bus address */
412#define ANY_I2C_BUS 0xffff
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Hans Verkuilc7036672009-06-19 16:58:21 +0200414/* 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 Torvalds1da177e2005-04-16 15:20:36 -0700418
419/* ----- functions exported by i2c.o */
420
421/* administration...
422 */
Jean Delvare23af8402009-06-19 16:58:20 +0200423#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424extern int i2c_add_adapter(struct i2c_adapter *);
425extern int i2c_del_adapter(struct i2c_adapter *);
David Brownell6e13e642007-05-01 23:26:31 +0200426extern int i2c_add_numbered_adapter(struct i2c_adapter *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800428extern int i2c_register_driver(struct module *, struct i2c_driver *);
Jean Delvareb3e82092007-05-01 23:26:32 +0200429extern void i2c_del_driver(struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800431static inline int i2c_add_driver(struct i2c_driver *driver)
432{
433 return i2c_register_driver(THIS_MODULE, driver);
434}
435
Jean Delvaree48d3312008-01-27 18:14:48 +0100436extern struct i2c_client *i2c_use_client(struct i2c_client *client);
437extern void i2c_release_client(struct i2c_client *client);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439/* call the i2c_client->command() of all attached clients with
440 * the given arguments */
441extern void i2c_clients_command(struct i2c_adapter *adap,
442 unsigned int cmd, void *arg);
443
Jean Delvare3ae70de2008-10-22 20:21:32 +0200444extern struct i2c_adapter *i2c_get_adapter(int id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445extern void i2c_put_adapter(struct i2c_adapter *adap);
446
447
448/* Return the functionality mask */
449static 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. */
455static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
456{
457 return (func & i2c_get_functionality(adap)) == func;
458}
459
Jean Delvare3ae70de2008-10-22 20:21:32 +0200460/* Return the adapter number for a specific adapter */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200461static inline int i2c_adapter_id(struct i2c_adapter *adap)
462{
463 return adap->nr;
464}
Jean Delvare23af8402009-06-19 16:58:20 +0200465#endif /* I2C */
David Woodhousea1b92982006-04-25 14:14:52 +0100466#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200467
David Brownella64ec072007-10-13 23:56:31 +0200468/**
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 Torvalds1da177e2005-04-16 15:20:36 -0700503 */
504struct i2c_msg {
505 __u16 addr; /* slave address */
David Brownell438d6c22006-12-10 21:21:31 +0100506 __u16 flags;
David Brownella64ec072007-10-13 23:56:31 +0200507#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 Brownell438d6c22006-12-10 21:21:31 +0100514 __u16 len; /* msg length */
515 __u8 *buf; /* pointer to msg data */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516};
517
518/* To determine what functionality is present */
519
520#define I2C_FUNC_I2C 0x00000001
521#define I2C_FUNC_10BIT_ADDR 0x00000002
Jean Delvare3ae70de2008-10-22 20:21:32 +0200522#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
David Brownell6662cbb2007-10-13 23:56:33 +0200523#define I2C_FUNC_SMBUS_PEC 0x00000008
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
David Brownell438d6c22006-12-10 21:21:31 +0100525#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 Torvalds1da177e2005-04-16 15:20:36 -0700535#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 Torvalds1da177e2005-04-16 15:20:36 -0700537
Jean Delvare3ae70de2008-10-22 20:21:32 +0200538#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 Torvalds1da177e2005-04-16 15:20:36 -0700548
Jean Delvare3ae70de2008-10-22 20:21:32 +0200549#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 Torvalds1da177e2005-04-16 15:20:36 -0700557
David Brownell438d6c22006-12-10 21:21:31 +0100558/*
559 * Data for SMBus Messages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 */
David Brownell438d6c22006-12-10 21:21:31 +0100561#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562union i2c_smbus_data {
563 __u8 byte;
564 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200565 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare3ae70de2008-10-22 20:21:32 +0200566 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567};
568
Jean Delvareae7193f2008-07-14 22:38:24 +0200569/* i2c_smbus_xfer read or write markers */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570#define I2C_SMBUS_READ 1
571#define I2C_SMBUS_WRITE 0
572
David Brownell438d6c22006-12-10 21:21:31 +0100573/* SMBus transaction types (size parameter in the above functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
575#define I2C_SMBUS_QUICK 0
576#define I2C_SMBUS_BYTE 1
David Brownell438d6c22006-12-10 21:21:31 +0100577#define I2C_SMBUS_BYTE_DATA 2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578#define I2C_SMBUS_WORD_DATA 3
579#define I2C_SMBUS_PROC_CALL 4
580#define I2C_SMBUS_BLOCK_DATA 5
Jean Delvare4b2643d2007-07-12 14:12:29 +0200581#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Jean Delvare4b2643d2007-07-12 14:12:29 +0200583#define I2C_SMBUS_I2C_BLOCK_DATA 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585#endif /* _LINUX_I2C_H */