blob: 526ddc8eecfbf899b67ad0587fcf573e152d9021 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------------------- */
2/* */
3/* i2c.h - definitions for the i2c-bus interface */
4/* */
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
David Woodhousea1b92982006-04-25 14:14:52 +010023/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 Frodo Looijaard <frodol@dds.nl> */
25
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#ifndef _LINUX_I2C_H
27#define _LINUX_I2C_H
28
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/types.h>
David Woodhousea1b92982006-04-25 14:14:52 +010030#ifdef __KERNEL__
31#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/i2c-id.h>
Greg Kroah-Hartmana9d1b242005-10-22 00:23:27 +020033#include <linux/mod_devicetable.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/device.h> /* for struct device */
Tim Schmielau4e57b682005-10-30 15:03:48 -080035#include <linux/sched.h> /* for completion */
Ingo Molnar5c085d32006-01-18 23:16:04 +010036#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
Jean Delvareefde7232005-07-20 23:03:50 +020038/* --- For i2c-isa ---------------------------------------------------- */
39
40extern void i2c_adapter_dev_release(struct device *dev);
41extern struct device_driver i2c_adapter_driver;
42extern struct class i2c_adapter_class;
43extern struct bus_type i2c_bus_type;
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045/* --- General options ------------------------------------------------ */
46
47struct i2c_msg;
48struct i2c_algorithm;
49struct i2c_adapter;
50struct i2c_client;
51struct i2c_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -070052union i2c_smbus_data;
53
54/*
55 * The master routines are the ones normally used to transmit data to devices
56 * on a bus (or read from them). Apart from two basic transfer functions to
57 * transmit one message at a time, a more complex version can be used to
58 * transmit an arbitrary number of messages without interruption.
59 */
60extern int i2c_master_send(struct i2c_client *,const char* ,int);
61extern int i2c_master_recv(struct i2c_client *,char* ,int);
62
63/* Transfer num messages.
64 */
65extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
66
67/*
68 * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
69 * This is not tested/implemented yet and will change in the future.
70 */
71extern int i2c_slave_send(struct i2c_client *,char*,int);
72extern int i2c_slave_recv(struct i2c_client *,char*,int);
73
74
75
76/* This is the very generalized SMBus access routine. You probably do not
77 want to use this, though; one of the functions below may be much easier,
78 and probably just as fast.
79 Note that we use i2c_adapter here, because you do not need a specific
80 smbus adapter to call this function. */
81extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
82 unsigned short flags,
83 char read_write, u8 command, int size,
84 union i2c_smbus_data * data);
85
86/* Now follow the 'nice' access routines. These also document the calling
87 conventions of smbus_access. */
88
89extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
90extern s32 i2c_smbus_read_byte(struct i2c_client * client);
91extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
92extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
93extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
94 u8 command, u8 value);
95extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
96extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
97 u8 command, u16 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070098extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
99 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +0200100 const u8 *values);
Jean Delvare31ec5bc2005-10-08 00:04:13 +0200101/* Returns the number of read bytes */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
103 u8 command, u8 *values);
Jean Delvare21bbd692006-01-09 15:19:18 +1100104extern s32 i2c_smbus_write_i2c_block_data(struct i2c_client * client,
105 u8 command, u8 length,
Krzysztof Halasa46f5ed72006-06-12 21:42:20 +0200106 const u8 *values);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108/*
109 * A driver is capable of handling one or more physical devices present on
110 * I2C adapters. This information is used to inform the driver of adapter
111 * events.
Laurent Riffard35d8b2e2005-11-26 20:34:05 +0100112 *
113 * The driver.owner field should be set to the module owner of this driver.
114 * The driver.name field should be set to the name of this driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 */
116
117struct i2c_driver {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 int id;
119 unsigned int class;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 /* Notifies the driver that a new bus has appeared. This routine
122 * can be used by the driver to test if the bus meets its conditions
123 * & seek for the presence of the chip(s) it supports. If found, it
124 * registers the client(s) that are on the bus to the i2c admin. via
125 * i2c_attach_client.
126 */
127 int (*attach_adapter)(struct i2c_adapter *);
128 int (*detach_adapter)(struct i2c_adapter *);
129
130 /* tells the driver that a client is about to be deleted & gives it
131 * the chance to remove its private data. Also, if the client struct
132 * has been dynamically allocated by the driver in the function above,
133 * it must be freed here.
134 */
135 int (*detach_client)(struct i2c_client *);
136
137 /* a ioctl like command that can be used to perform specific functions
138 * with the device.
139 */
140 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
141
142 struct device_driver driver;
143 struct list_head list;
144};
145#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
146
147#define I2C_NAME_SIZE 50
148
149/*
150 * i2c_client identifies a single device (i.e. chip) that is connected to an
151 * i2c bus. The behaviour is defined by the routines of the driver. This
152 * function is mainly used for lookup & other admin. functions.
153 */
154struct i2c_client {
155 unsigned int flags; /* div., see below */
Jean Delvare50718602005-07-20 00:02:32 +0200156 unsigned short addr; /* chip address - NOTE: 7bit */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 /* addresses are stored in the */
Jean Delvare50718602005-07-20 00:02:32 +0200158 /* _LOWER_ 7 bits */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 struct i2c_adapter *adapter; /* the adapter we sit on */
160 struct i2c_driver *driver; /* and our access routines */
161 int usage_count; /* How many accesses currently */
162 /* to the client */
163 struct device dev; /* the device structure */
164 struct list_head list;
165 char name[I2C_NAME_SIZE];
166 struct completion released;
167};
168#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
169
bgardner@wabtec.coma61fc682005-07-27 12:43:03 -0500170static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
171{
172 return to_i2c_client(container_of(kobj, struct device, kobj));
173}
174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175static inline void *i2c_get_clientdata (struct i2c_client *dev)
176{
177 return dev_get_drvdata (&dev->dev);
178}
179
180static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
181{
182 dev_set_drvdata (&dev->dev, data);
183}
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/*
186 * The following structs are for those who like to implement new bus drivers:
187 * i2c_algorithm is the interface to a class of hardware solutions which can
188 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
189 * to name two of the most common.
190 */
191struct i2c_algorithm {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 /* If an adapter algorithm can't do I2C-level access, set master_xfer
193 to NULL. If an adapter algorithm can do SMBus access, set
194 smbus_xfer. If set to NULL, the SMBus protocol is simulated
195 using common I2C messages */
196 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
197 int num);
198 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
199 unsigned short flags, char read_write,
200 u8 command, int size, union i2c_smbus_data * data);
201
202 /* --- these optional/future use for some adapter types.*/
203 int (*slave_send)(struct i2c_adapter *,char*,int);
204 int (*slave_recv)(struct i2c_adapter *,char*,int);
205
206 /* --- ioctl like call to set div. parameters. */
207 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
208
209 /* To determine what the adapter supports */
210 u32 (*functionality) (struct i2c_adapter *);
211};
212
213/*
214 * i2c_adapter is the structure used to identify a physical i2c bus along
215 * with the access algorithms necessary to access it.
216 */
217struct i2c_adapter {
218 struct module *owner;
Jean Delvare020789e2005-08-13 13:04:32 +0200219 unsigned int id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 unsigned int class;
221 struct i2c_algorithm *algo;/* the algorithm to access the bus */
222 void *algo_data;
223
224 /* --- administration stuff. */
225 int (*client_register)(struct i2c_client *);
226 int (*client_unregister)(struct i2c_client *);
227
228 /* data fields that are valid for all devices */
Ingo Molnar5c085d32006-01-18 23:16:04 +0100229 struct mutex bus_lock;
230 struct mutex clist_lock;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 int timeout;
233 int retries;
234 struct device dev; /* the adapter device */
235 struct class_device class_dev; /* the class device */
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 int nr;
238 struct list_head clients;
239 struct list_head list;
240 char name[I2C_NAME_SIZE];
241 struct completion dev_released;
242 struct completion class_dev_released;
243};
244#define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
245#define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
246
247static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
248{
249 return dev_get_drvdata (&dev->dev);
250}
251
252static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
253{
254 dev_set_drvdata (&dev->dev, data);
255}
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257/*flags for the client struct: */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
259#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
260 /* Must equal I2C_M_TEN below */
261
262/* i2c adapter classes (bitmask) */
263#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
264#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
265#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
266#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
267#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
268#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
269#define I2C_CLASS_SOUND (1<<6) /* sound devices */
270#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
271
272/* i2c_client_address_data is the struct for holding default client
273 * addresses for a driver and for the parameters supplied on the
274 * command line
275 */
276struct i2c_client_address_data {
277 unsigned short *normal_i2c;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 unsigned short *probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 unsigned short *ignore;
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200280 unsigned short **forces;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281};
282
283/* Internal numbers to terminate lists */
284#define I2C_CLIENT_END 0xfffeU
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286/* The numbers to use to set I2C bus address */
287#define ANY_I2C_BUS 0xffff
288#define ANY_I2C_ISA_BUS 9191
289
290
291/* ----- functions exported by i2c.o */
292
293/* administration...
294 */
295extern int i2c_add_adapter(struct i2c_adapter *);
296extern int i2c_del_adapter(struct i2c_adapter *);
297
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800298extern int i2c_register_driver(struct module *, struct i2c_driver *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299extern int i2c_del_driver(struct i2c_driver *);
300
Greg Kroah-Hartmande59cf92005-12-06 15:33:15 -0800301static inline int i2c_add_driver(struct i2c_driver *driver)
302{
303 return i2c_register_driver(THIS_MODULE, driver);
304}
305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306extern int i2c_attach_client(struct i2c_client *);
307extern int i2c_detach_client(struct i2c_client *);
308
Jean Delvare482c7882005-11-26 21:06:08 +0100309/* Should be used to make sure that client-struct is valid and that it
310 is okay to access the i2c-client.
Jean Delvarecf02df72005-11-26 21:03:41 +0100311 returns -ENODEV if client has gone in the meantime */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312extern int i2c_use_client(struct i2c_client *);
313extern int i2c_release_client(struct i2c_client *);
314
315/* call the i2c_client->command() of all attached clients with
316 * the given arguments */
317extern void i2c_clients_command(struct i2c_adapter *adap,
318 unsigned int cmd, void *arg);
319
320/* returns -EBUSY if address has been taken, 0 if not. Note that the only
321 other place at which this is called is within i2c_attach_client; so
322 you can cheat by simply not registering. Not recommended, of course! */
323extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
324
325/* Detect function. It iterates over all possible addresses itself.
326 * It will only call found_proc if some client is connected at the
327 * specific address (unless a 'force' matched);
328 */
329extern int i2c_probe(struct i2c_adapter *adapter,
330 struct i2c_client_address_data *address_data,
331 int (*found_proc) (struct i2c_adapter *, int, int));
332
333/* An ioctl like call to set div. parameters of the adapter.
334 */
335extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
336
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337extern struct i2c_adapter* i2c_get_adapter(int id);
338extern void i2c_put_adapter(struct i2c_adapter *adap);
339
340
341/* Return the functionality mask */
342static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
343{
344 return adap->algo->functionality(adap);
345}
346
347/* Return 1 if adapter supports everything we need, 0 if not. */
348static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
349{
350 return (func & i2c_get_functionality(adap)) == func;
351}
352
Jean Delvarecdcb1922005-07-28 23:09:40 +0200353/* Return id number for a specific adapter */
354static inline int i2c_adapter_id(struct i2c_adapter *adap)
355{
356 return adap->nr;
357}
David Woodhousea1b92982006-04-25 14:14:52 +0100358#endif /* __KERNEL__ */
Jean Delvarecdcb1922005-07-28 23:09:40 +0200359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/*
361 * I2C Message - used for pure i2c transaction, also from /dev interface
362 */
363struct i2c_msg {
364 __u16 addr; /* slave address */
365 __u16 flags;
366#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
367#define I2C_M_RD 0x01
368#define I2C_M_NOSTART 0x4000
369#define I2C_M_REV_DIR_ADDR 0x2000
370#define I2C_M_IGNORE_NAK 0x1000
371#define I2C_M_NO_RD_ACK 0x0800
372 __u16 len; /* msg length */
373 __u8 *buf; /* pointer to msg data */
374};
375
376/* To determine what functionality is present */
377
378#define I2C_FUNC_I2C 0x00000001
379#define I2C_FUNC_10BIT_ADDR 0x00000002
380#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
381#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
383#define I2C_FUNC_SMBUS_QUICK 0x00010000
384#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
385#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
386#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
387#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
388#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
389#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
390#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
391#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
392#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
393#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
394#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
395#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
396#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
399 I2C_FUNC_SMBUS_WRITE_BYTE)
400#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
401 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
402#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
403 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
404#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
405 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
406#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
407 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
408#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
409 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
412 I2C_FUNC_SMBUS_BYTE | \
413 I2C_FUNC_SMBUS_BYTE_DATA | \
414 I2C_FUNC_SMBUS_WORD_DATA | \
415 I2C_FUNC_SMBUS_PROC_CALL | \
416 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 I2C_FUNC_SMBUS_I2C_BLOCK)
418
419/*
420 * Data for SMBus Messages
421 */
422#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423union i2c_smbus_data {
424 __u8 byte;
425 __u16 word;
Hideki Iwamoto332bf922005-09-25 16:56:43 +0200426 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
Jean Delvare421ef472005-10-26 21:28:55 +0200427 /* and one more for user-space compatibility */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428};
429
430/* smbus_access read or write markers */
431#define I2C_SMBUS_READ 1
432#define I2C_SMBUS_WRITE 0
433
434/* SMBus transaction types (size parameter in the above functions)
435 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
436#define I2C_SMBUS_QUICK 0
437#define I2C_SMBUS_BYTE 1
438#define I2C_SMBUS_BYTE_DATA 2
439#define I2C_SMBUS_WORD_DATA 3
440#define I2C_SMBUS_PROC_CALL 4
441#define I2C_SMBUS_BLOCK_DATA 5
442#define I2C_SMBUS_I2C_BLOCK_DATA 6
443#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445
446/* ----- commands for the ioctl like i2c_command call:
447 * note that additional calls are defined in the algorithm and hw
448 * dependent layers - these can be listed here, or see the
449 * corresponding header files.
450 */
451 /* -> bit-adapter specific ioctls */
452#define I2C_RETRIES 0x0701 /* number of times a device address */
453 /* should be polled when not */
454 /* acknowledging */
455#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
456
457
458/* this is for i2c-dev.c */
459#define I2C_SLAVE 0x0703 /* Change slave address */
460 /* Attn.: Slave address is 7 or 10 bits */
461#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
462 /* Attn.: Slave address is 7 or 10 bits */
463 /* This changes the address, even if it */
464 /* is already taken! */
465#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
466
467#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
468#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
469#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
471#define I2C_SMBUS 0x0720 /* SMBus-level access */
472
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473/* ----- I2C-DEV: char device interface stuff ------------------------- */
David Woodhousea1b92982006-04-25 14:14:52 +0100474#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475
476#define I2C_MAJOR 89 /* Device major number */
477
478/* These defines are used for probing i2c client addresses */
479/* The length of the option lists */
480#define I2C_CLIENT_MAX_OPTS 48
481
482/* Default fill of many variables */
483#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
484 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
485 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
486 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
487 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
488 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
489 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
490 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
491 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
492 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
493 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
494 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
495 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
496 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
497 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
498 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
499
500/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
501 module header */
502
503#define I2C_CLIENT_MODULE_PARM(var,desc) \
504 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
505 static unsigned int var##_num; \
506 module_param_array(var, short, &var##_num, 0); \
507 MODULE_PARM_DESC(var,desc)
508
Jean Delvaref4b50262005-07-31 21:49:03 +0200509#define I2C_CLIENT_MODULE_PARM_FORCE(name) \
510I2C_CLIENT_MODULE_PARM(force_##name, \
511 "List of adapter,address pairs which are " \
512 "unquestionably assumed to contain a `" \
513 # name "' chip")
514
515
516#define I2C_CLIENT_INSMOD_COMMON \
517I2C_CLIENT_MODULE_PARM(probe, "List of adapter,address pairs to scan " \
518 "additionally"); \
519I2C_CLIENT_MODULE_PARM(ignore, "List of adapter,address pairs not to " \
520 "scan"); \
521static struct i2c_client_address_data addr_data = { \
522 .normal_i2c = normal_i2c, \
523 .probe = probe, \
524 .ignore = ignore, \
525 .forces = forces, \
526}
527
528/* These are the ones you want to use in your own drivers. Pick the one
529 which matches the number of devices the driver differenciates between. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530#define I2C_CLIENT_INSMOD \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 I2C_CLIENT_MODULE_PARM(force, \
532 "List of adapter,address pairs to boldly assume " \
533 "to be present"); \
Jean Delvaref4b50262005-07-31 21:49:03 +0200534 static unsigned short *forces[] = { \
Jean Delvare9fc6adf2005-07-31 21:20:43 +0200535 force, \
536 NULL \
537 }; \
Jean Delvaref4b50262005-07-31 21:49:03 +0200538I2C_CLIENT_INSMOD_COMMON
539
540#define I2C_CLIENT_INSMOD_1(chip1) \
541enum chips { any_chip, chip1 }; \
542I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
543 "boldly assume to be present"); \
544I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
545static unsigned short *forces[] = { force, force_##chip1, NULL }; \
546I2C_CLIENT_INSMOD_COMMON
547
548#define I2C_CLIENT_INSMOD_2(chip1, chip2) \
549enum chips { any_chip, chip1, chip2 }; \
550I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
551 "boldly assume to be present"); \
552I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
553I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
554static unsigned short *forces[] = { force, force_##chip1, \
555 force_##chip2, NULL }; \
556I2C_CLIENT_INSMOD_COMMON
557
558#define I2C_CLIENT_INSMOD_3(chip1, chip2, chip3) \
559enum chips { any_chip, chip1, chip2, chip3 }; \
560I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
561 "boldly assume to be present"); \
562I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
563I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
564I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
565static unsigned short *forces[] = { force, force_##chip1, \
566 force_##chip2, force_##chip3, \
567 NULL }; \
568I2C_CLIENT_INSMOD_COMMON
569
570#define I2C_CLIENT_INSMOD_4(chip1, chip2, chip3, chip4) \
571enum chips { any_chip, chip1, chip2, chip3, chip4 }; \
572I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
573 "boldly assume to be present"); \
574I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
575I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
576I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
577I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
578static unsigned short *forces[] = { force, force_##chip1, \
579 force_##chip2, force_##chip3, \
580 force_##chip4, NULL}; \
581I2C_CLIENT_INSMOD_COMMON
582
583#define I2C_CLIENT_INSMOD_5(chip1, chip2, chip3, chip4, chip5) \
584enum chips { any_chip, chip1, chip2, chip3, chip4, chip5 }; \
585I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
586 "boldly assume to be present"); \
587I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
588I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
589I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
590I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
591I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
592static unsigned short *forces[] = { force, force_##chip1, \
593 force_##chip2, force_##chip3, \
594 force_##chip4, force_##chip5, \
595 NULL }; \
596I2C_CLIENT_INSMOD_COMMON
597
598#define I2C_CLIENT_INSMOD_6(chip1, chip2, chip3, chip4, chip5, chip6) \
599enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6 }; \
600I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
601 "boldly assume to be present"); \
602I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
603I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
604I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
605I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
606I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
607I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
608static unsigned short *forces[] = { force, force_##chip1, \
609 force_##chip2, force_##chip3, \
610 force_##chip4, force_##chip5, \
611 force_##chip6, NULL }; \
612I2C_CLIENT_INSMOD_COMMON
613
614#define I2C_CLIENT_INSMOD_7(chip1, chip2, chip3, chip4, chip5, chip6, chip7) \
615enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
616 chip7 }; \
617I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
618 "boldly assume to be present"); \
619I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
620I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
621I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
622I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
623I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
624I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
625I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
626static unsigned short *forces[] = { force, force_##chip1, \
627 force_##chip2, force_##chip3, \
628 force_##chip4, force_##chip5, \
629 force_##chip6, force_##chip7, \
630 NULL }; \
631I2C_CLIENT_INSMOD_COMMON
632
633#define I2C_CLIENT_INSMOD_8(chip1, chip2, chip3, chip4, chip5, chip6, chip7, chip8) \
634enum chips { any_chip, chip1, chip2, chip3, chip4, chip5, chip6, \
635 chip7, chip8 }; \
636I2C_CLIENT_MODULE_PARM(force, "List of adapter,address pairs to " \
637 "boldly assume to be present"); \
638I2C_CLIENT_MODULE_PARM_FORCE(chip1); \
639I2C_CLIENT_MODULE_PARM_FORCE(chip2); \
640I2C_CLIENT_MODULE_PARM_FORCE(chip3); \
641I2C_CLIENT_MODULE_PARM_FORCE(chip4); \
642I2C_CLIENT_MODULE_PARM_FORCE(chip5); \
643I2C_CLIENT_MODULE_PARM_FORCE(chip6); \
644I2C_CLIENT_MODULE_PARM_FORCE(chip7); \
645I2C_CLIENT_MODULE_PARM_FORCE(chip8); \
646static unsigned short *forces[] = { force, force_##chip1, \
647 force_##chip2, force_##chip3, \
648 force_##chip4, force_##chip5, \
649 force_##chip6, force_##chip7, \
650 force_##chip8, NULL }; \
651I2C_CLIENT_INSMOD_COMMON
David Woodhousea1b92982006-04-25 14:14:52 +0100652#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653#endif /* _LINUX_I2C_H */