projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge branch 'hwpoison' of git://git.kernel.org/pub/scm/linux/kernel/git/ak/linux...
[deliverable/linux.git] / include / linux / i2c.h
CommitLineData
1da177e4 1/* ------------------------------------------------------------------------- */
438d6c2c 2/* */
1da177e4 3/* i2c.h - definitions for the i2c-bus interface */
438d6c2c 4/* */
1da177e4
LT		 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
a1b9298e 23/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
1da177e4
LT		 24 Frodo Looijaard <frodol@dds.nl> */
25
1da177e4
LT		 26#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
1da177e4 29#include <linux/types.h>
438d6c2c 30#ifdef __KERNEL__
a1b9298e 31#include <linux/module.h>
1da177e4 32#include <linux/i2c-id.h>
a9d1b24d 33#include <linux/mod_devicetable.h>
1da177e4 34#include <linux/device.h> /* for struct device */
4e57b681 35#include <linux/sched.h> /* for completion */
5c085d36 36#include <linux/mutex.h>
1da177e4 37
e9ca9eb9
JS		 38extern struct bus_type i2c_bus_type;
39
1da177e4
LT		 40/* --- General options ------------------------------------------------ */
41
42struct i2c_msg;
43struct i2c_algorithm;
44struct i2c_adapter;
45struct i2c_client;
46struct i2c_driver;
1da177e4 47union i2c_smbus_data;
4735c98f 48struct i2c_board_info;
1da177e4 49
23af8400 50#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4
LT		 51/*
52 * The master routines are the ones normally used to transmit data to devices
438d6c2c
DB		 53 * on a bus (or read from them). Apart from two basic transfer functions to
54 * transmit one message at a time, a more complex version can be used to
1da177e4
LT		 55 * transmit an arbitrary number of messages without interruption.
56 */
3ae70dee
JD		 57extern int i2c_master_send(struct i2c_client *client, const char *buf,
58 int count);
59extern int i2c_master_recv(struct i2c_client *client, char *buf, int count);
1da177e4
LT		 60
61/* Transfer num messages.
62 */
3ae70dee
JD		 63extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
64 int num);
1da177e4
LT		 65
66/* This is the very generalized SMBus access routine. You probably do not
67 want to use this, though; one of the functions below may be much easier,
438d6c2c 68 and probably just as fast.
1da177e4
LT		 69 Note that we use i2c_adapter here, because you do not need a specific
70 smbus adapter to call this function. */
3ae70dee
JD		 71extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
72 unsigned short flags, char read_write, u8 command,
73 int size, union i2c_smbus_data *data);
1da177e4
LT		 74
75/* Now follow the 'nice' access routines. These also document the calling
ae7193f7 76 conventions of i2c_smbus_xfer. */
1da177e4 77
3ae70dee
JD		 78extern s32 i2c_smbus_read_byte(struct i2c_client *client);
79extern s32 i2c_smbus_write_byte(struct i2c_client *client, u8 value);
80extern s32 i2c_smbus_read_byte_data(struct i2c_client *client, u8 command);
81extern s32 i2c_smbus_write_byte_data(struct i2c_client *client,
82 u8 command, u8 value);
83extern s32 i2c_smbus_read_word_data(struct i2c_client *client, u8 command);
84extern s32 i2c_smbus_write_word_data(struct i2c_client *client,
85 u8 command, u16 value);
b86a1bc8
JD		 86/* Returns the number of read bytes */
87extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
88 u8 command, u8 *values);
3ae70dee
JD		 89extern s32 i2c_smbus_write_block_data(struct i2c_client *client,
90 u8 command, u8 length, const u8 *values);
31ec5bc5 91/* Returns the number of read bytes */
3ae70dee 92extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client *client,
4b2643d7 93 u8 command, u8 length, u8 *values);
3ae70dee 94extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client *client,
21bbd691 95 u8 command, u8 length,
46f5ed75 96 const u8 *values);
23af8400 97#endif /* I2C */
1da177e4 98
4735c98f
JD		 99/**
100 * struct i2c_driver - represent an I2C device driver
101 * @class: What kind of i2c device we instantiate (for detect)
96e21e4f
JD		 102 * @attach_adapter: Callback for bus addition (for legacy drivers)
103 * @detach_adapter: Callback for bus removal (for legacy drivers)
729d6dd5
JD		 104 * @probe: Callback for device binding
105 * @remove: Callback for device unbinding
96e21e4f
JD		 106 * @shutdown: Callback for device shutdown
107 * @suspend: Callback for device suspend
108 * @resume: Callback for device resume
109 * @command: Callback for bus-wide signaling (optional)
110 * @driver: Device driver model driver
111 * @id_table: List of I2C devices supported by this driver
4735c98f
JD		 112 * @detect: Callback for device detection
113 * @address_data: The I2C addresses to probe, ignore or force (for detect)
114 * @clients: List of detected clients we created (for i2c-core use only)
35d8b2e6
LR		 115 *
116 * The driver.owner field should be set to the module owner of this driver.
117 * The driver.name field should be set to the name of this driver.
4735c98f
JD		 118 *
119 * For automatic device detection, both @detect and @address_data must
120 * be defined. @class should also be set, otherwise only devices forced
121 * with module parameters will be created. The detect function must
122 * fill at least the name field of the i2c_board_info structure it is
123 * handed upon successful detection, and possibly also the flags field.
124 *
125 * If @detect is missing, the driver will still work fine for enumerated
126 * devices. Detected devices simply won't be supported. This is expected
127 * for the many I2C/SMBus devices which can't be detected reliably, and
128 * the ones which can always be enumerated in practice.
129 *
130 * The i2c_client structure which is handed to the @detect callback is
131 * not a real i2c_client. It is initialized just enough so that you can
132 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
133 * else with it. In particular, calling dev_dbg and friends on it is
134 * not allowed.
1da177e4 135 */
1da177e4 136struct i2c_driver {
1da177e4 137 unsigned int class;
1da177e4 138
729d6dd5
JD		 139 /* Notifies the driver that a new bus has appeared or is about to be
140 * removed. You should avoid using this if you can, it will probably
141 * be removed in a near future.
1da177e4
LT		 142 */
143 int (*attach_adapter)(struct i2c_adapter *);
144 int (*detach_adapter)(struct i2c_adapter *);
145
729d6dd5 146 /* Standard driver model interfaces */
d2653e92 147 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
a1d9e6e4 148 int (*remove)(struct i2c_client *);
7b4fbc50 149
f37dd80a
DB		 150 /* driver model interfaces that don't relate to enumeration */
151 void (*shutdown)(struct i2c_client *);
152 int (*suspend)(struct i2c_client *, pm_message_t mesg);
153 int (*resume)(struct i2c_client *);
154
1da177e4
LT		 155 /* a ioctl like command that can be used to perform specific functions
156 * with the device.
157 */
3ae70dee 158 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
1da177e4
LT		 159
160 struct device_driver driver;
d2653e92 161 const struct i2c_device_id *id_table;
4735c98f
JD		 162
163 /* Device detection callback for automatic device creation */
164 int (*detect)(struct i2c_client *, int kind, struct i2c_board_info *);
165 const struct i2c_client_address_data *address_data;
166 struct list_head clients;
1da177e4
LT		 167};
168#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
169
2096b956
DB		 170/**
171 * struct i2c_client - represent an I2C slave device
d64f73be
DB		 172 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
173 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
2096b956
DB		 174 * @addr: Address used on the I2C bus connected to the parent adapter.
175 * @name: Indicates the type of the device, usually a chip name that's
176 * generic enough to hide second-sourcing and compatible revisions.
d64f73be 177 * @adapter: manages the bus segment hosting this I2C device
aa3481d5 178 * @driver: device's driver, hence pointer to access routines
2096b956 179 * @dev: Driver model device node for the slave.
d64f73be 180 * @irq: indicates the IRQ generated by this device (if any)
99cd8e25
JD		 181 * @detected: member of an i2c_driver.clients list or i2c-core's
182 * userspace_devices list
2096b956
DB		 183 *
184 * An i2c_client identifies a single device (i.e. chip) connected to an
d64f73be
DB		 185 * i2c bus. The behaviour exposed to Linux is defined by the driver
186 * managing the device.
1da177e4
LT		 187 */
188struct i2c_client {
2096b956 189 unsigned short flags; /* div., see below */
438d6c2c 190 unsigned short addr; /* chip address - NOTE: 7bit */
1da177e4 191 /* addresses are stored in the */
5071860a 192 /* _LOWER_ 7 bits */
2096b956 193 char name[I2C_NAME_SIZE];
1da177e4
LT		 194 struct i2c_adapter *adapter; /* the adapter we sit on */
195 struct i2c_driver *driver; /* and our access routines */
1da177e4 196 struct device dev; /* the device structure */
8e29da9e 197 int irq; /* irq issued by device */
4735c98f 198 struct list_head detected;
1da177e4
LT		 199};
200#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
201
9b766b81
DB		 202extern struct i2c_client *i2c_verify_client(struct device *dev);
203
a61fc683 204static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
205{
d75d53cd
MH		 206 struct device * const dev = container_of(kobj, struct device, kobj);
207 return to_i2c_client(dev);
a61fc683 208}
209
7d1d8999 210static inline void *i2c_get_clientdata(const struct i2c_client *dev)
1da177e4 211{
3ae70dee 212 return dev_get_drvdata(&dev->dev);
1da177e4
LT		 213}
214
3ae70dee 215static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
1da177e4 216{
3ae70dee 217 dev_set_drvdata(&dev->dev, data);
1da177e4
LT		 218}
219
9c1600ed
DB		 220/**
221 * struct i2c_board_info - template for device creation
eb8a7908 222 * @type: chip type, to initialize i2c_client.name
9c1600ed
DB		 223 * @flags: to initialize i2c_client.flags
224 * @addr: stored in i2c_client.addr
225 * @platform_data: stored in i2c_client.dev.platform_data
11f1f2af 226 * @archdata: copied into i2c_client.dev.archdata
9c1600ed 227 * @irq: stored in i2c_client.irq
d64f73be 228 *
9c1600ed
DB		 229 * I2C doesn't actually support hardware probing, although controllers and
230 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
231 * a device at a given address. Drivers commonly need more information than
232 * that, such as chip type, configuration, associated IRQ, and so on.
233 *
234 * i2c_board_info is used to build tables of information listing I2C devices
729d6dd5
JD		 235 * that are present. This information is used to grow the driver model tree.
236 * For mainboards this is done statically using i2c_register_board_info();
237 * bus numbers identify adapters that aren't yet available. For add-on boards,
238 * i2c_new_device() does this dynamically with the adapter already known.
9c1600ed
DB		 239 */
240struct i2c_board_info {
9c1600ed
DB		 241 char type[I2C_NAME_SIZE];
242 unsigned short flags;
243 unsigned short addr;
244 void *platform_data;
11f1f2af 245 struct dev_archdata *archdata;
9c1600ed
DB		 246 int irq;
247};
248
249/**
3760f736
JD		 250 * I2C_BOARD_INFO - macro used to list an i2c device and its address
251 * @dev_type: identifies the device type
9c1600ed
DB		 252 * @dev_addr: the device's address on the bus.
253 *
254 * This macro initializes essential fields of a struct i2c_board_info,
255 * declaring what has been provided on a particular board. Optional
3760f736
JD		 256 * fields (such as associated irq, or device-specific platform_data)
257 * are provided using conventional syntax.
9c1600ed 258 */
3ae70dee 259#define I2C_BOARD_INFO(dev_type, dev_addr) \
c758e8cf 260 .type = dev_type, .addr = (dev_addr)
9c1600ed
DB		 261
262
23af8400 263#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
9c1600ed
DB		 264/* Add-on boards should register/unregister their devices; e.g. a board
265 * with integrated I2C, a config eeprom, sensors, and a codec that's
266 * used in conjunction with the primary hardware.
267 */
268extern struct i2c_client *
269i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
270
12b5053a
JD		 271/* If you don't know the exact address of an I2C device, use this variant
272 * instead, which can probe for device presence in a list of possible
273 * addresses.
274 */
275extern struct i2c_client *
276i2c_new_probed_device(struct i2c_adapter *adap,
277 struct i2c_board_info *info,
278 unsigned short const *addr_list);
279
e9f1373b
DB		 280/* For devices that use several addresses, use i2c_new_dummy() to make
281 * client handles for the extra addresses.
282 */
283extern struct i2c_client *
60b129d7 284i2c_new_dummy(struct i2c_adapter *adap, u16 address);
e9f1373b 285
9c1600ed 286extern void i2c_unregister_device(struct i2c_client *);
23af8400 287#endif /* I2C */
9c1600ed
DB		 288
289/* Mainboard arch_initcall() code should register all its I2C devices.
290 * This is done at arch_initcall time, before declaring any i2c adapters.
291 * Modules for add-on boards must use other calls.
292 */
26386763 293#ifdef CONFIG_I2C_BOARDINFO
9c1600ed 294extern int
3ae70dee
JD		 295i2c_register_board_info(int busnum, struct i2c_board_info const *info,
296 unsigned n);
26386763
DB		 297#else
298static inline int
3ae70dee
JD		 299i2c_register_board_info(int busnum, struct i2c_board_info const *info,
300 unsigned n)
26386763
DB		 301{
302 return 0;
303}
23af8400 304#endif /* I2C_BOARDINFO */
9c1600ed 305
1da177e4
LT		 306/*
307 * The following structs are for those who like to implement new bus drivers:
308 * i2c_algorithm is the interface to a class of hardware solutions which can
309 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
310 * to name two of the most common.
311 */
312struct i2c_algorithm {
1da177e4 313 /* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c 314 to NULL. If an adapter algorithm can do SMBus access, set
1da177e4
LT		 315 smbus_xfer. If set to NULL, the SMBus protocol is simulated
316 using common I2C messages */
8ced8eee
JD		 317 /* master_xfer should return the number of messages successfully
318 processed, or a negative value on error */
3ae70dee
JD		 319 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
320 int num);
438d6c2c 321 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
3ae70dee
JD		 322 unsigned short flags, char read_write,
323 u8 command, int size, union i2c_smbus_data *data);
1da177e4 324
1da177e4
LT		 325 /* To determine what the adapter supports */
326 u32 (*functionality) (struct i2c_adapter *);
327};
328
329/*
330 * i2c_adapter is the structure used to identify a physical i2c bus along
331 * with the access algorithms necessary to access it.
332 */
333struct i2c_adapter {
334 struct module *owner;
020789e9 335 unsigned int id;
14f55f7a 336 unsigned int class; /* classes to allow probing for */
af71ff69 337 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4
LT		 338 void *algo_data;
339
1da177e4 340 /* data fields that are valid for all devices */
6ea23039 341 u8 level; /* nesting level for lockdep */
5c085d36 342 struct mutex bus_lock;
1da177e4 343
cd97f39b 344 int timeout; /* in jiffies */
1da177e4
LT		 345 int retries;
346 struct device dev; /* the adapter device */
1da177e4 347
1da177e4 348 int nr;
2096b956 349 char name[48];
1da177e4 350 struct completion dev_released;
1da177e4 351};
ef2c8321 352#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4 353
7d1d8999 354static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
1da177e4 355{
3ae70dee 356 return dev_get_drvdata(&dev->dev);
1da177e4
LT		 357}
358
3ae70dee 359static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
1da177e4 360{
3ae70dee 361 dev_set_drvdata(&dev->dev, data);
1da177e4
LT		 362}
363
1da177e4 364/*flags for the client struct: */
3bbb835d
DB		 365#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
366#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
367 /* Must equal I2C_M_TEN below */
368#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
1da177e4
LT		 369
370/* i2c adapter classes (bitmask) */
371#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
372#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
373#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
c1b6b4f2 374#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
3401b2ff 375#define I2C_CLASS_SPD (1<<7) /* SPD EEPROMs and similar */
1da177e4
LT		 376
377/* i2c_client_address_data is the struct for holding default client
378 * addresses for a driver and for the parameters supplied on the
379 * command line
380 */
381struct i2c_client_address_data {
bfb6df24
MH		 382 const unsigned short *normal_i2c;
383 const unsigned short *probe;
384 const unsigned short *ignore;
385 const unsigned short * const *forces;
1da177e4
LT		 386};
387
388/* Internal numbers to terminate lists */
389#define I2C_CLIENT_END 0xfffeU
1da177e4
LT		 390
391/* The numbers to use to set I2C bus address */
392#define ANY_I2C_BUS 0xffff
1da177e4 393
c7036673
HV		 394/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
395#define I2C_ADDRS(addr, addrs...) \
396 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
397
1da177e4
LT		 398
399/* ----- functions exported by i2c.o */
400
401/* administration...
402 */
23af8400 403#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4
LT		 404extern int i2c_add_adapter(struct i2c_adapter *);
405extern int i2c_del_adapter(struct i2c_adapter *);
6e13e641 406extern int i2c_add_numbered_adapter(struct i2c_adapter *);
1da177e4 407
de59cf9e 408extern int i2c_register_driver(struct module *, struct i2c_driver *);
b3e82096 409extern void i2c_del_driver(struct i2c_driver *);
1da177e4 410
de59cf9e
GKH		 411static inline int i2c_add_driver(struct i2c_driver *driver)
412{
413 return i2c_register_driver(THIS_MODULE, driver);
414}
415
e48d3319
JD		 416extern struct i2c_client *i2c_use_client(struct i2c_client *client);
417extern void i2c_release_client(struct i2c_client *client);
1da177e4
LT		 418
419/* call the i2c_client->command() of all attached clients with
420 * the given arguments */
421extern void i2c_clients_command(struct i2c_adapter *adap,
422 unsigned int cmd, void *arg);
423
3ae70dee 424extern struct i2c_adapter *i2c_get_adapter(int id);
1da177e4
LT		 425extern void i2c_put_adapter(struct i2c_adapter *adap);
426
427
428/* Return the functionality mask */
429static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
430{
431 return adap->algo->functionality(adap);
432}
433
434/* Return 1 if adapter supports everything we need, 0 if not. */
435static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
436{
437 return (func & i2c_get_functionality(adap)) == func;
438}
439
3ae70dee 440/* Return the adapter number for a specific adapter */
cdcb1921
JD		 441static inline int i2c_adapter_id(struct i2c_adapter *adap)
442{
443 return adap->nr;
444}
23af8400 445#endif /* I2C */
a1b9298e 446#endif /* __KERNEL__ */
cdcb1921 447
a64ec07d
DB		 448/**
449 * struct i2c_msg - an I2C transaction segment beginning with START
450 * @addr: Slave address, either seven or ten bits. When this is a ten
451 * bit address, I2C_M_TEN must be set in @flags and the adapter
452 * must support I2C_FUNC_10BIT_ADDR.
453 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
454 * provided unless the adapter exported the relevant I2C_FUNC_*
455 * flags through i2c_check_functionality().
456 * @len: Number of data bytes in @buf being read from or written to the
457 * I2C slave address. For read transactions where I2C_M_RECV_LEN
458 * is set, the caller guarantees that this buffer can hold up to
459 * 32 bytes in addition to the initial length byte sent by the
460 * slave (plus, if used, the SMBus PEC); and this value will be
461 * incremented by the number of block data bytes received.
462 * @buf: The buffer into which data is read, or from which it's written.
463 *
464 * An i2c_msg is the low level representation of one segment of an I2C
465 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
466 * to userspace from i2c-dev, and to I2C adapter drivers through the
467 * @i2c_adapter.@master_xfer() method.
468 *
469 * Except when I2C "protocol mangling" is used, all I2C adapters implement
470 * the standard rules for I2C transactions. Each transaction begins with a
471 * START. That is followed by the slave address, and a bit encoding read
472 * versus write. Then follow all the data bytes, possibly including a byte
473 * with SMBus PEC. The transfer terminates with a NAK, or when all those
474 * bytes have been transferred and ACKed. If this is the last message in a
475 * group, it is followed by a STOP. Otherwise it is followed by the next
476 * @i2c_msg transaction segment, beginning with a (repeated) START.
477 *
478 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
479 * passing certain @flags may have changed those standard protocol behaviors.
480 * Those flags are only for use with broken/nonconforming slaves, and with
481 * adapters which are known to support the specific mangling options they
482 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
1da177e4
LT		 483 */
484struct i2c_msg {
485 __u16 addr; /* slave address */
438d6c2c 486 __u16 flags;
a64ec07d
DB		 487#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
488#define I2C_M_RD 0x0001 /* read data, from slave to master */
489#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
490#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
491#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
492#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
493#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
438d6c2c
DB		 494 __u16 len; /* msg length */
495 __u8 *buf; /* pointer to msg data */
1da177e4
LT		 496};
497
498/* To determine what functionality is present */
499
500#define I2C_FUNC_I2C 0x00000001
501#define I2C_FUNC_10BIT_ADDR 0x00000002
3ae70dee 502#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
6662cbb9 503#define I2C_FUNC_SMBUS_PEC 0x00000008
1da177e4 504#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
438d6c2c
DB		 505#define I2C_FUNC_SMBUS_QUICK 0x00010000
506#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
507#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
508#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
509#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
510#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
511#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
512#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
513#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
514#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4
LT		 515#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
516#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
1da177e4 517
3ae70dee
JD		 518#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
519 I2C_FUNC_SMBUS_WRITE_BYTE)
520#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
521 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
522#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
523 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
524#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
525 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
526#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
527 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
528
529#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
530 I2C_FUNC_SMBUS_BYTE | \
531 I2C_FUNC_SMBUS_BYTE_DATA | \
532 I2C_FUNC_SMBUS_WORD_DATA | \
533 I2C_FUNC_SMBUS_PROC_CALL | \
534 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
535 I2C_FUNC_SMBUS_I2C_BLOCK | \
536 I2C_FUNC_SMBUS_PEC)
1da177e4 537
438d6c2c
DB		 538/*
539 * Data for SMBus Messages
1da177e4 540 */
438d6c2c 541#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
1da177e4
LT		 542union i2c_smbus_data {
543 __u8 byte;
544 __u16 word;
332bf92b 545 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
3ae70dee 546 /* and one more for user-space compatibility */
1da177e4
LT		 547};
548
ae7193f7 549/* i2c_smbus_xfer read or write markers */
1da177e4
LT		 550#define I2C_SMBUS_READ 1
551#define I2C_SMBUS_WRITE 0
552
438d6c2c 553/* SMBus transaction types (size parameter in the above functions)
1da177e4
LT		 554 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
555#define I2C_SMBUS_QUICK 0
556#define I2C_SMBUS_BYTE 1
438d6c2c 557#define I2C_SMBUS_BYTE_DATA 2
1da177e4
LT		 558#define I2C_SMBUS_WORD_DATA 3
559#define I2C_SMBUS_PROC_CALL 4
560#define I2C_SMBUS_BLOCK_DATA 5
4b2643d7 561#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
1da177e4 562#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
4b2643d7 563#define I2C_SMBUS_I2C_BLOCK_DATA 8
1da177e4
LT		 564
565
a1b9298e 566#ifdef __KERNEL__
1da177e4 567
1da177e4
LT		 568/* These defines are used for probing i2c client addresses */
569/* The length of the option lists */
570#define I2C_CLIENT_MAX_OPTS 48
571
572/* Default fill of many variables */
573#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
3ae70dee
JD		 574 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
575 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
576 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
577 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
578 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
579 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
580 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
581 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
582 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
583 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
584 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
585 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
586 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
587 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
588 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
1da177e4
LT		 589
590/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
591 module header */
592
593#define I2C_CLIENT_MODULE_PARM(var,desc) \
594 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
595 static unsigned int var##_num; \
596 module_param_array(var, short, &var##_num, 0); \
3ae70dee 597 MODULE_PARM_DESC(var, desc)
1da177e4 598
f4b50261
JD		 599#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
600I2C_CLIENT_MODULE_PARM(force_##name, \
601 "List of adapter,address pairs which are " \
602 "unquestionably assumed to contain a `" \
603 # name "' chip")
604
605
606#define I2C_CLIENT_INSMOD_COMMON \
607I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
608 "additionally"); \
609I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
610 "scan"); \
305183fc 611static const struct i2c_client_address_data addr_data = { \
f4b50261
JD		 612 .normal_i2c = normal_i2c, \
613 .probe = probe, \
614 .ignore = ignore, \
615 .forces = forces, \
616}
617
bfb6df24
MH		 618#define I2C_CLIENT_FORCE_TEXT \
619 "List of adapter,address pairs to boldly assume to be present"
620
f4b50261
JD		 621/* These are the ones you want to use in your own drivers. Pick the one
622 which matches the number of devices the driver differenciates between. */
bfb6df24
MH		 623#define I2C_CLIENT_INSMOD \
624I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
625static const unsigned short * const forces[] = { force, NULL }; \
f4b50261
JD		 626I2C_CLIENT_INSMOD_COMMON
627
628#define I2C_CLIENT_INSMOD_1(chip1) \
629enum chips { any_chip, chip1 }; \
bfb6df24 630I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261 631I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
bfb6df24
MH		 632static const unsigned short * const forces[] = { force, \
633 force_##chip1, NULL }; \
f4b50261
JD		 634I2C_CLIENT_INSMOD_COMMON
635
636#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
637enum chips { any_chip, chip1, chip2 }; \
bfb6df24 638I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 639I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
640I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
bfb6df24
MH		 641static const unsigned short * const forces[] = { force, \
642 force_##chip1, force_##chip2, NULL }; \
f4b50261
JD		 643I2C_CLIENT_INSMOD_COMMON
644
645#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
646enum chips { any_chip, chip1, chip2, chip3 }; \
bfb6df24 647I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 648I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
649I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
650I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
bfb6df24
MH		 651static const unsigned short * const forces[] = { force, \
652 force_##chip1, force_##chip2, force_##chip3, NULL }; \
f4b50261
JD		 653I2C_CLIENT_INSMOD_COMMON
654
655#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
656enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
bfb6df24 657I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 658I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
659I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
660I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
661I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
bfb6df24
MH		 662static const unsigned short * const forces[] = { force, \
663 force_##chip1, force_##chip2, force_##chip3, \
664 force_##chip4, NULL}; \
f4b50261
JD		 665I2C_CLIENT_INSMOD_COMMON
666
667#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
668enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
bfb6df24 669I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 670I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
671I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
672I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
673I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
674I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
bfb6df24
MH		 675static const unsigned short * const forces[] = { force, \
676 force_##chip1, force_##chip2, force_##chip3, \
677 force_##chip4, force_##chip5, NULL }; \
f4b50261
JD		 678I2C_CLIENT_INSMOD_COMMON
679
680#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
681enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
bfb6df24 682I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 683I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
684I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
685I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
686I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
687I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
688I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
bfb6df24
MH		 689static const unsigned short * const forces[] = { force, \
690 force_##chip1, force_##chip2, force_##chip3, \
691 force_##chip4, force_##chip5, force_##chip6, NULL }; \
f4b50261
JD		 692I2C_CLIENT_INSMOD_COMMON
693
694#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
695enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
696 chip7 }; \
bfb6df24 697I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 698I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
699I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
700I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
701I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
702I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
703I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
704I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
bfb6df24
MH		 705static const unsigned short * const forces[] = { force, \
706 force_##chip1, force_##chip2, force_##chip3, \
707 force_##chip4, force_##chip5, force_##chip6, \
708 force_##chip7, NULL }; \
f4b50261
JD		 709I2C_CLIENT_INSMOD_COMMON
710
711#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
712enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
713 chip7, chip8 }; \
bfb6df24 714I2C_CLIENT_MODULE_PARM(force, I2C_CLIENT_FORCE_TEXT); \
f4b50261
JD		 715I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
716I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
717I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
718I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
719I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
720I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
721I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
722I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
bfb6df24
MH		 723static const unsigned short * const forces[] = { force, \
724 force_##chip1, force_##chip2, force_##chip3, \
725 force_##chip4, force_##chip5, force_##chip6, \
726 force_##chip7, force_##chip8, NULL }; \
f4b50261 727I2C_CLIENT_INSMOD_COMMON
a1b9298e 728#endif /* __KERNEL__ */
1da177e4 729#endif /* _LINUX_I2C_H */
Linux kernel - Deliverables
This page took 0.639586 seconds and 5 git commands to generate.