projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Add LZO1X algorithm to the kernel
[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
efde723f
JD		 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
74 conventions of smbus_access. */
75
76extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
77extern s32 i2c_smbus_read_byte(struct i2c_client * client);
78extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
79extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
80extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
81 u8 command, u8 value);
82extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
83extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
84 u8 command, u16 value);
b86a1bc8
JD		 85/* Returns the number of read bytes */
86extern s32 i2c_smbus_read_block_data(struct i2c_client *client,
87 u8 command, u8 *values);
1da177e4
LT		 88extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
89 u8 command, u8 length,
46f5ed75 90 const u8 *values);
31ec5bc5 91/* Returns the number of read bytes */
1da177e4
LT		 92extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
93 u8 command, u8 *values);
21bbd691
JD		 94extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
95 u8 command, u8 length,
46f5ed75 96 const u8 *values);
1da177e4
LT		 97
98/*
99 * A driver is capable of handling one or more physical devices present on
100 * I2C adapters. This information is used to inform the driver of adapter
101 * events.
35d8b2e6
LR		 102 *
103 * The driver.owner field should be set to the module owner of this driver.
104 * The driver.name field should be set to the name of this driver.
1da177e4
LT		 105 */
106
107struct i2c_driver {
1da177e4
LT		 108 int id;
109 unsigned int class;
1da177e4
LT		 110
111 /* Notifies the driver that a new bus has appeared. This routine
112 * can be used by the driver to test if the bus meets its conditions
438d6c2c 113 * & seek for the presence of the chip(s) it supports. If found, it
1da177e4 114 * registers the client(s) that are on the bus to the i2c admin. via
7b4fbc50 115 * i2c_attach_client. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT		 116 */
117 int (*attach_adapter)(struct i2c_adapter *);
118 int (*detach_adapter)(struct i2c_adapter *);
119
438d6c2c 120 /* tells the driver that a client is about to be deleted & gives it
1da177e4
LT		 121 * the chance to remove its private data. Also, if the client struct
122 * has been dynamically allocated by the driver in the function above,
7b4fbc50 123 * it must be freed here. (LEGACY I2C DRIVERS ONLY)
1da177e4
LT		 124 */
125 int (*detach_client)(struct i2c_client *);
f37dd80a 126
7b4fbc50
DB		 127 /* Standard driver model interfaces, for "new style" i2c drivers.
128 * With the driver model, device enumeration is NEVER done by drivers;
129 * it's done by infrastructure. (NEW STYLE DRIVERS ONLY)
130 */
131 int (*probe)(struct i2c_client *);
a1d9e6e4 132 int (*remove)(struct i2c_client *);
7b4fbc50 133
f37dd80a
DB		 134 /* driver model interfaces that don't relate to enumeration */
135 void (*shutdown)(struct i2c_client *);
136 int (*suspend)(struct i2c_client *, pm_message_t mesg);
137 int (*resume)(struct i2c_client *);
138
1da177e4
LT		 139 /* a ioctl like command that can be used to perform specific functions
140 * with the device.
141 */
142 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
143
144 struct device_driver driver;
145 struct list_head list;
146};
147#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
148
2096b956
DB		 149#define I2C_NAME_SIZE 20
150
151/**
152 * struct i2c_client - represent an I2C slave device
153 * @addr: Address used on the I2C bus connected to the parent adapter.
154 * @name: Indicates the type of the device, usually a chip name that's
155 * generic enough to hide second-sourcing and compatible revisions.
156 * @dev: Driver model device node for the slave.
7b4fbc50
DB		 157 * @driver_name: Identifies new-style driver used with this device; also
158 * used as the module name for hotplug/coldplug modprobe support.
2096b956
DB		 159 *
160 * An i2c_client identifies a single device (i.e. chip) connected to an
161 * i2c bus. The behaviour is defined by the routines of the driver.
1da177e4
LT		 162 */
163struct i2c_client {
2096b956 164 unsigned short flags; /* div., see below */
438d6c2c 165 unsigned short addr; /* chip address - NOTE: 7bit */
1da177e4 166 /* addresses are stored in the */
5071860a 167 /* _LOWER_ 7 bits */
2096b956 168 char name[I2C_NAME_SIZE];
1da177e4
LT		 169 struct i2c_adapter *adapter; /* the adapter we sit on */
170 struct i2c_driver *driver; /* and our access routines */
171 int usage_count; /* How many accesses currently */
172 /* to the client */
173 struct device dev; /* the device structure */
9c1600ed 174 int irq; /* irq issued by device (or -1) */
7b4fbc50 175 char driver_name[KOBJ_NAME_LEN];
1da177e4 176 struct list_head list;
1da177e4
LT		 177 struct completion released;
178};
179#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
180
a61fc683 181static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
182{
183 return to_i2c_client(container_of(kobj, struct device, kobj));
184}
185
1da177e4
LT		 186static inline void *i2c_get_clientdata (struct i2c_client *dev)
187{
188 return dev_get_drvdata (&dev->dev);
189}
190
191static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
192{
193 dev_set_drvdata (&dev->dev, data);
194}
195
9c1600ed
DB		 196/**
197 * struct i2c_board_info - template for device creation
198 * @driver_name: identifies the driver to be bound to the device
199 * @type: optional chip type information, to initialize i2c_client.name
200 * @flags: to initialize i2c_client.flags
201 * @addr: stored in i2c_client.addr
202 * @platform_data: stored in i2c_client.dev.platform_data
203 * @irq: stored in i2c_client.irq
204
205 * I2C doesn't actually support hardware probing, although controllers and
206 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
207 * a device at a given address. Drivers commonly need more information than
208 * that, such as chip type, configuration, associated IRQ, and so on.
209 *
210 * i2c_board_info is used to build tables of information listing I2C devices
211 * that are present. This information is used to grow the driver model tree
212 * for "new style" I2C drivers. For mainboards this is done statically using
213 * i2c_register_board_info(), where @bus_num represents an adapter that isn't
214 * yet available. For add-on boards, i2c_new_device() does this dynamically
215 * with the adapter already known.
216 */
217struct i2c_board_info {
218 char driver_name[KOBJ_NAME_LEN];
219 char type[I2C_NAME_SIZE];
220 unsigned short flags;
221 unsigned short addr;
222 void *platform_data;
223 int irq;
224};
225
226/**
227 * I2C_BOARD_INFO - macro used to list an i2c device and its driver
228 * @driver: identifies the driver to use with the device
229 * @dev_addr: the device's address on the bus.
230 *
231 * This macro initializes essential fields of a struct i2c_board_info,
232 * declaring what has been provided on a particular board. Optional
233 * fields (such as the chip type, its associated irq, or device-specific
234 * platform_data) are provided using conventional syntax.
235 */
236#define I2C_BOARD_INFO(driver,dev_addr) \
237 .driver_name = (driver), .addr = (dev_addr)
238
239
240/* Add-on boards should register/unregister their devices; e.g. a board
241 * with integrated I2C, a config eeprom, sensors, and a codec that's
242 * used in conjunction with the primary hardware.
243 */
244extern struct i2c_client *
245i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
246
12b5053a
JD		 247/* If you don't know the exact address of an I2C device, use this variant
248 * instead, which can probe for device presence in a list of possible
249 * addresses.
250 */
251extern struct i2c_client *
252i2c_new_probed_device(struct i2c_adapter *adap,
253 struct i2c_board_info *info,
254 unsigned short const *addr_list);
255
9c1600ed
DB		 256extern void i2c_unregister_device(struct i2c_client *);
257
258/* Mainboard arch_initcall() code should register all its I2C devices.
259 * This is done at arch_initcall time, before declaring any i2c adapters.
260 * Modules for add-on boards must use other calls.
261 */
262extern int
263i2c_register_board_info(int busnum, struct i2c_board_info const *info, unsigned n);
264
265
1da177e4
LT		 266/*
267 * The following structs are for those who like to implement new bus drivers:
268 * i2c_algorithm is the interface to a class of hardware solutions which can
269 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
270 * to name two of the most common.
271 */
272struct i2c_algorithm {
1da177e4 273 /* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c 274 to NULL. If an adapter algorithm can do SMBus access, set
1da177e4
LT		 275 smbus_xfer. If set to NULL, the SMBus protocol is simulated
276 using common I2C messages */
8ced8eee
JD		 277 /* master_xfer should return the number of messages successfully
278 processed, or a negative value on error */
438d6c2c 279 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
1da177e4 280 int num);
438d6c2c 281 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
1da177e4
LT		 282 unsigned short flags, char read_write,
283 u8 command, int size, union i2c_smbus_data * data);
284
1da177e4
LT		 285 /* --- ioctl like call to set div. parameters. */
286 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
287
288 /* To determine what the adapter supports */
289 u32 (*functionality) (struct i2c_adapter *);
290};
291
292/*
293 * i2c_adapter is the structure used to identify a physical i2c bus along
294 * with the access algorithms necessary to access it.
295 */
296struct i2c_adapter {
297 struct module *owner;
020789e9 298 unsigned int id;
1da177e4 299 unsigned int class;
af71ff69 300 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4
LT		 301 void *algo_data;
302
303 /* --- administration stuff. */
304 int (*client_register)(struct i2c_client *);
305 int (*client_unregister)(struct i2c_client *);
306
307 /* data fields that are valid for all devices */
6ea23039 308 u8 level; /* nesting level for lockdep */
5c085d36
IM		 309 struct mutex bus_lock;
310 struct mutex clist_lock;
1da177e4
LT		 311
312 int timeout;
313 int retries;
314 struct device dev; /* the adapter device */
1da177e4 315
1da177e4
LT		 316 int nr;
317 struct list_head clients;
318 struct list_head list;
2096b956 319 char name[48];
1da177e4 320 struct completion dev_released;
1da177e4 321};
ef2c8321 322#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4
LT		 323
324static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
325{
326 return dev_get_drvdata (&dev->dev);
327}
328
329static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
330{
331 dev_set_drvdata (&dev->dev, data);
332}
333
1da177e4 334/*flags for the client struct: */
1da177e4
LT		 335#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
336#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
337 /* Must equal I2C_M_TEN below */
338
339/* i2c adapter classes (bitmask) */
340#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
341#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
342#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
343#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
344#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
345#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
346#define I2C_CLASS_SOUND (1<<6) /* sound devices */
347#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
348
349/* i2c_client_address_data is the struct for holding default client
350 * addresses for a driver and for the parameters supplied on the
351 * command line
352 */
353struct i2c_client_address_data {
354 unsigned short *normal_i2c;
1da177e4 355 unsigned short *probe;
1da177e4 356 unsigned short *ignore;
9fc6adfa 357 unsigned short **forces;
1da177e4
LT		 358};
359
360/* Internal numbers to terminate lists */
361#define I2C_CLIENT_END 0xfffeU
1da177e4
LT		 362
363/* The numbers to use to set I2C bus address */
364#define ANY_I2C_BUS 0xffff
365#define ANY_I2C_ISA_BUS 9191
366
367
368/* ----- functions exported by i2c.o */
369
370/* administration...
371 */
372extern int i2c_add_adapter(struct i2c_adapter *);
373extern int i2c_del_adapter(struct i2c_adapter *);
6e13e641 374extern int i2c_add_numbered_adapter(struct i2c_adapter *);
1da177e4 375
de59cf9e 376extern int i2c_register_driver(struct module *, struct i2c_driver *);
b3e82096 377extern void i2c_del_driver(struct i2c_driver *);
1da177e4 378
de59cf9e
GKH		 379static inline int i2c_add_driver(struct i2c_driver *driver)
380{
381 return i2c_register_driver(THIS_MODULE, driver);
382}
383
1da177e4
LT		 384extern int i2c_attach_client(struct i2c_client *);
385extern int i2c_detach_client(struct i2c_client *);
386
482c788d
JD		 387/* Should be used to make sure that client-struct is valid and that it
388 is okay to access the i2c-client.
cf02df77 389 returns -ENODEV if client has gone in the meantime */
1da177e4
LT		 390extern int i2c_use_client(struct i2c_client *);
391extern int i2c_release_client(struct i2c_client *);
392
393/* call the i2c_client->command() of all attached clients with
394 * the given arguments */
395extern void i2c_clients_command(struct i2c_adapter *adap,
396 unsigned int cmd, void *arg);
397
398/* returns -EBUSY if address has been taken, 0 if not. Note that the only
399 other place at which this is called is within i2c_attach_client; so
400 you can cheat by simply not registering. Not recommended, of course! */
401extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
402
403/* Detect function. It iterates over all possible addresses itself.
404 * It will only call found_proc if some client is connected at the
405 * specific address (unless a 'force' matched);
406 */
438d6c2c 407extern int i2c_probe(struct i2c_adapter *adapter,
1da177e4
LT		 408 struct i2c_client_address_data *address_data,
409 int (*found_proc) (struct i2c_adapter *, int, int));
410
411/* An ioctl like call to set div. parameters of the adapter.
412 */
413extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
414
1da177e4
LT		 415extern struct i2c_adapter* i2c_get_adapter(int id);
416extern void i2c_put_adapter(struct i2c_adapter *adap);
417
418
419/* Return the functionality mask */
420static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
421{
422 return adap->algo->functionality(adap);
423}
424
425/* Return 1 if adapter supports everything we need, 0 if not. */
426static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
427{
428 return (func & i2c_get_functionality(adap)) == func;
429}
430
cdcb1921
JD		 431/* Return id number for a specific adapter */
432static inline int i2c_adapter_id(struct i2c_adapter *adap)
433{
434 return adap->nr;
435}
a1b9298e 436#endif /* __KERNEL__ */
cdcb1921 437
1da177e4
LT		 438/*
439 * I2C Message - used for pure i2c transaction, also from /dev interface
440 */
441struct i2c_msg {
442 __u16 addr; /* slave address */
438d6c2c 443 __u16 flags;
1da177e4
LT		 444#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
445#define I2C_M_RD 0x01
446#define I2C_M_NOSTART 0x4000
447#define I2C_M_REV_DIR_ADDR 0x2000
448#define I2C_M_IGNORE_NAK 0x1000
449#define I2C_M_NO_RD_ACK 0x0800
209d27c3 450#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
438d6c2c
DB		 451 __u16 len; /* msg length */
452 __u8 *buf; /* pointer to msg data */
1da177e4
LT		 453};
454
455/* To determine what functionality is present */
456
457#define I2C_FUNC_I2C 0x00000001
458#define I2C_FUNC_10BIT_ADDR 0x00000002
459#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
460#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
1da177e4 461#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
438d6c2c
DB		 462#define I2C_FUNC_SMBUS_QUICK 0x00010000
463#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
464#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
465#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
466#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
467#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
468#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
469#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
470#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
471#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4
LT		 472#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
473#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
474#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
475#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
1da177e4
LT		 476
477#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
478 I2C_FUNC_SMBUS_WRITE_BYTE)
479#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
480 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
481#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
482 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
483#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
484 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
485#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
486 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
487#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
488 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
1da177e4
LT		 489
490#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
491 I2C_FUNC_SMBUS_BYTE | \
492 I2C_FUNC_SMBUS_BYTE_DATA | \
493 I2C_FUNC_SMBUS_WORD_DATA | \
494 I2C_FUNC_SMBUS_PROC_CALL | \
495 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
1da177e4
LT		 496 I2C_FUNC_SMBUS_I2C_BLOCK)
497
438d6c2c
DB		 498/*
499 * Data for SMBus Messages
1da177e4 500 */
438d6c2c 501#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
1da177e4
LT		 502union i2c_smbus_data {
503 __u8 byte;
504 __u16 word;
332bf92b 505 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
421ef47b 506 /* and one more for user-space compatibility */
1da177e4
LT		 507};
508
509/* smbus_access read or write markers */
510#define I2C_SMBUS_READ 1
511#define I2C_SMBUS_WRITE 0
512
438d6c2c 513/* SMBus transaction types (size parameter in the above functions)
1da177e4
LT		 514 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
515#define I2C_SMBUS_QUICK 0
516#define I2C_SMBUS_BYTE 1
438d6c2c 517#define I2C_SMBUS_BYTE_DATA 2
1da177e4
LT		 518#define I2C_SMBUS_WORD_DATA 3
519#define I2C_SMBUS_PROC_CALL 4
520#define I2C_SMBUS_BLOCK_DATA 5
521#define I2C_SMBUS_I2C_BLOCK_DATA 6
522#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
1da177e4
LT		 523
524
525/* ----- commands for the ioctl like i2c_command call:
438d6c2c
DB		 526 * note that additional calls are defined in the algorithm and hw
527 * dependent layers - these can be listed here, or see the
1da177e4
LT		 528 * corresponding header files.
529 */
530 /* -> bit-adapter specific ioctls */
531#define I2C_RETRIES 0x0701 /* number of times a device address */
532 /* should be polled when not */
438d6c2c
DB		 533 /* acknowledging */
534#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
1da177e4
LT		 535
536
537/* this is for i2c-dev.c */
538#define I2C_SLAVE 0x0703 /* Change slave address */
539 /* Attn.: Slave address is 7 or 10 bits */
540#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
541 /* Attn.: Slave address is 7 or 10 bits */
542 /* This changes the address, even if it */
543 /* is already taken! */
544#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
545
546#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
547#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
548#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
1da177e4
LT		 549
550#define I2C_SMBUS 0x0720 /* SMBus-level access */
551
1da177e4 552/* ----- I2C-DEV: char device interface stuff ------------------------- */
a1b9298e 553#ifdef __KERNEL__
1da177e4
LT		 554
555#define I2C_MAJOR 89 /* Device major number */
556
557/* These defines are used for probing i2c client addresses */
558/* The length of the option lists */
559#define I2C_CLIENT_MAX_OPTS 48
560
561/* Default fill of many variables */
562#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
563 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
564 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
565 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
566 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
579/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
580 module header */
581
582#define I2C_CLIENT_MODULE_PARM(var,desc) \
583 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
584 static unsigned int var##_num; \
585 module_param_array(var, short, &var##_num, 0); \
586 MODULE_PARM_DESC(var,desc)
587
f4b50261
JD		 588#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
589I2C_CLIENT_MODULE_PARM(force_##name, \
590 "List of adapter,address pairs which are " \
591 "unquestionably assumed to contain a `" \
592 # name "' chip")
593
594
595#define I2C_CLIENT_INSMOD_COMMON \
596I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
597 "additionally"); \
598I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
599 "scan"); \
600static struct i2c_client_address_data addr_data = { \
601 .normal_i2c = normal_i2c, \
602 .probe = probe, \
603 .ignore = ignore, \
604 .forces = forces, \
605}
606
607/* These are the ones you want to use in your own drivers. Pick the one
608 which matches the number of devices the driver differenciates between. */
1da177e4 609#define I2C_CLIENT_INSMOD \
1da177e4
LT		 610 I2C_CLIENT_MODULE_PARM(force, \
611 "List of adapter,address pairs to boldly assume " \
612 "to be present"); \
f4b50261 613 static unsigned short *forces[] = { \
9fc6adfa
JD		 614 force, \
615 NULL \
616 }; \
f4b50261
JD		 617I2C_CLIENT_INSMOD_COMMON
618
619#define I2C_CLIENT_INSMOD_1(chip1) \
620enum chips { any_chip, chip1 }; \
621I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
622 "boldly assume to be present"); \
623I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
624static unsigned short *forces[] = { force, force_##chip1, NULL }; \
625I2C_CLIENT_INSMOD_COMMON
626
627#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
628enum chips { any_chip, chip1, chip2 }; \
629I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
630 "boldly assume to be present"); \
631I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
632I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
633static unsigned short *forces[] = { force, force_##chip1, \
634 force_##chip2, NULL }; \
635I2C_CLIENT_INSMOD_COMMON
636
637#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
638enum chips { any_chip, chip1, chip2, chip3 }; \
639I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
640 "boldly assume to be present"); \
641I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
642I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
643I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
644static unsigned short *forces[] = { force, force_##chip1, \
645 force_##chip2, force_##chip3, \
646 NULL }; \
647I2C_CLIENT_INSMOD_COMMON
648
649#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
650enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
651I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
652 "boldly assume to be present"); \
653I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
654I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
655I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
656I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
657static unsigned short *forces[] = { force, force_##chip1, \
658 force_##chip2, force_##chip3, \
659 force_##chip4, NULL}; \
660I2C_CLIENT_INSMOD_COMMON
661
662#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
663enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
664I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
665 "boldly assume to be present"); \
666I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
667I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
668I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
669I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
670I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
671static unsigned short *forces[] = { force, force_##chip1, \
672 force_##chip2, force_##chip3, \
673 force_##chip4, force_##chip5, \
674 NULL }; \
675I2C_CLIENT_INSMOD_COMMON
676
677#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
678enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
679I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
680 "boldly assume to be present"); \
681I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
682I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
683I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
684I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
685I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
686I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
687static unsigned short *forces[] = { force, force_##chip1, \
688 force_##chip2, force_##chip3, \
689 force_##chip4, force_##chip5, \
690 force_##chip6, NULL }; \
691I2C_CLIENT_INSMOD_COMMON
692
693#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
694enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
695 chip7 }; \
696I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
697 "boldly assume to be present"); \
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); \
705static unsigned short *forces[] = { force, force_##chip1, \
706 force_##chip2, force_##chip3, \
707 force_##chip4, force_##chip5, \
708 force_##chip6, force_##chip7, \
709 NULL }; \
710I2C_CLIENT_INSMOD_COMMON
711
712#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
713enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
714 chip7, chip8 }; \
715I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
716 "boldly assume to be present"); \
717I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
718I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
719I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
720I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
721I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
722I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
723I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
724I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
725static unsigned short *forces[] = { force, force_##chip1, \
726 force_##chip2, force_##chip3, \
727 force_##chip4, force_##chip5, \
728 force_##chip6, force_##chip7, \
729 force_##chip8, NULL }; \
730I2C_CLIENT_INSMOD_COMMON
a1b9298e 731#endif /* __KERNEL__ */
1da177e4 732#endif /* _LINUX_I2C_H */
Linux kernel - Deliverables
This page took 0.376024 seconds and 5 git commands to generate.