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