Gitiles
Code Review Sign In
gerrit-public.fairphone.software / kernel / msm-4.19 / 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 / . / include / linux / i2c.h
blob: ebcd745f4cd6f730702b5f00821d5d6448ce12e6 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700[diff] [blame^]1/* ------------------------------------------------------------------------- */
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
23/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
24 Frodo Looijaard <frodol@dds.nl> */
25
26/* $Id: i2c.h,v 1.68 2003/01/21 08:08:16 kmalkki Exp $ */
27
28#ifndef _LINUX_I2C_H
29#define _LINUX_I2C_H
30
31#include <linux/module.h>
32#include <linux/types.h>
33#include <linux/i2c-id.h>
34#include <linux/device.h> /* for struct device */
35#include <asm/semaphore.h>
36
37/* --- General options ------------------------------------------------ */
38
39struct i2c_msg;
40struct i2c_algorithm;
41struct i2c_adapter;
42struct i2c_client;
43struct i2c_driver;
44struct i2c_client_address_data;
45union i2c_smbus_data;
46
47/*
48 * The master routines are the ones normally used to transmit data to devices
49 * on a bus (or read from them). Apart from two basic transfer functions to
50 * transmit one message at a time, a more complex version can be used to
51 * transmit an arbitrary number of messages without interruption.
52 */
53extern int i2c_master_send(struct i2c_client *,const char* ,int);
54extern int i2c_master_recv(struct i2c_client *,char* ,int);
55
56/* Transfer num messages.
57 */
58extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
59
60/*
61 * Some adapter types (i.e. PCF 8584 based ones) may support slave behaviuor.
62 * This is not tested/implemented yet and will change in the future.
63 */
64extern int i2c_slave_send(struct i2c_client *,char*,int);
65extern int i2c_slave_recv(struct i2c_client *,char*,int);
66
67
68
69/* This is the very generalized SMBus access routine. You probably do not
70 want to use this, though; one of the functions below may be much easier,
71 and probably just as fast.
72 Note that we use i2c_adapter here, because you do not need a specific
73 smbus adapter to call this function. */
74extern s32 i2c_smbus_xfer (struct i2c_adapter * adapter, u16 addr,
75 unsigned short flags,
76 char read_write, u8 command, int size,
77 union i2c_smbus_data * data);
78
79/* Now follow the 'nice' access routines. These also document the calling
80 conventions of smbus_access. */
81
82extern s32 i2c_smbus_write_quick(struct i2c_client * client, u8 value);
83extern s32 i2c_smbus_read_byte(struct i2c_client * client);
84extern s32 i2c_smbus_write_byte(struct i2c_client * client, u8 value);
85extern s32 i2c_smbus_read_byte_data(struct i2c_client * client, u8 command);
86extern s32 i2c_smbus_write_byte_data(struct i2c_client * client,
87 u8 command, u8 value);
88extern s32 i2c_smbus_read_word_data(struct i2c_client * client, u8 command);
89extern s32 i2c_smbus_write_word_data(struct i2c_client * client,
90 u8 command, u16 value);
91/* Returns the number of bytes transferred */
92extern s32 i2c_smbus_write_block_data(struct i2c_client * client,
93 u8 command, u8 length,
94 u8 *values);
95extern s32 i2c_smbus_read_i2c_block_data(struct i2c_client * client,
96 u8 command, u8 *values);
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.
102 */
103
104struct i2c_driver {
105 struct module *owner;
106 char name[32];
107 int id;
108 unsigned int class;
109 unsigned int flags; /* div., see below */
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
113 * & seek for the presence of the chip(s) it supports. If found, it
114 * registers the client(s) that are on the bus to the i2c admin. via
115 * i2c_attach_client.
116 */
117 int (*attach_adapter)(struct i2c_adapter *);
118 int (*detach_adapter)(struct i2c_adapter *);
119
120 /* tells the driver that a client is about to be deleted & gives it
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,
123 * it must be freed here.
124 */
125 int (*detach_client)(struct i2c_client *);
126
127 /* a ioctl like command that can be used to perform specific functions
128 * with the device.
129 */
130 int (*command)(struct i2c_client *client,unsigned int cmd, void *arg);
131
132 struct device_driver driver;
133 struct list_head list;
134};
135#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
136
137#define I2C_NAME_SIZE 50
138
139/*
140 * i2c_client identifies a single device (i.e. chip) that is connected to an
141 * i2c bus. The behaviour is defined by the routines of the driver. This
142 * function is mainly used for lookup & other admin. functions.
143 */
144struct i2c_client {
145 unsigned int flags; /* div., see below */
146 unsigned int addr; /* chip address - NOTE: 7bit */
147 /* addresses are stored in the */
148 /* _LOWER_ 7 bits of this char */
149 /* addr: unsigned int to make lm_sensors i2c-isa adapter work
150 more cleanly. It does not take any more memory space, due to
151 alignment considerations */
152 struct i2c_adapter *adapter; /* the adapter we sit on */
153 struct i2c_driver *driver; /* and our access routines */
154 int usage_count; /* How many accesses currently */
155 /* to the client */
156 struct device dev; /* the device structure */
157 struct list_head list;
158 char name[I2C_NAME_SIZE];
159 struct completion released;
160};
161#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
162
163static inline void *i2c_get_clientdata (struct i2c_client *dev)
164{
165 return dev_get_drvdata (&dev->dev);
166}
167
168static inline void i2c_set_clientdata (struct i2c_client *dev, void *data)
169{
170 dev_set_drvdata (&dev->dev, data);
171}
172
173#define I2C_DEVNAME(str) .name = str
174
175static inline char *i2c_clientname(struct i2c_client *c)
176{
177 return &c->name[0];
178}
179
180/*
181 * The following structs are for those who like to implement new bus drivers:
182 * i2c_algorithm is the interface to a class of hardware solutions which can
183 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
184 * to name two of the most common.
185 */
186struct i2c_algorithm {
187 char name[32]; /* textual description */
188 unsigned int id;
189
190 /* If an adapter algorithm can't do I2C-level access, set master_xfer
191 to NULL. If an adapter algorithm can do SMBus access, set
192 smbus_xfer. If set to NULL, the SMBus protocol is simulated
193 using common I2C messages */
194 int (*master_xfer)(struct i2c_adapter *adap,struct i2c_msg *msgs,
195 int num);
196 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
197 unsigned short flags, char read_write,
198 u8 command, int size, union i2c_smbus_data * data);
199
200 /* --- these optional/future use for some adapter types.*/
201 int (*slave_send)(struct i2c_adapter *,char*,int);
202 int (*slave_recv)(struct i2c_adapter *,char*,int);
203
204 /* --- ioctl like call to set div. parameters. */
205 int (*algo_control)(struct i2c_adapter *, unsigned int, unsigned long);
206
207 /* To determine what the adapter supports */
208 u32 (*functionality) (struct i2c_adapter *);
209};
210
211/*
212 * i2c_adapter is the structure used to identify a physical i2c bus along
213 * with the access algorithms necessary to access it.
214 */
215struct i2c_adapter {
216 struct module *owner;
217 unsigned int id;/* == is algo->id | hwdep.struct->id, */
218 /* for registered values see below */
219 unsigned int class;
220 struct i2c_algorithm *algo;/* the algorithm to access the bus */
221 void *algo_data;
222
223 /* --- administration stuff. */
224 int (*client_register)(struct i2c_client *);
225 int (*client_unregister)(struct i2c_client *);
226
227 /* data fields that are valid for all devices */
228 struct semaphore bus_lock;
229 struct semaphore clist_lock;
230
231 int timeout;
232 int retries;
233 struct device dev; /* the adapter device */
234 struct class_device class_dev; /* the class device */
235
236#ifdef CONFIG_PROC_FS
237 /* No need to set this when you initialize the adapter */
238 int inode;
239#endif /* def CONFIG_PROC_FS */
240
241 int nr;
242 struct list_head clients;
243 struct list_head list;
244 char name[I2C_NAME_SIZE];
245 struct completion dev_released;
246 struct completion class_dev_released;
247};
248#define dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
249#define class_dev_to_i2c_adapter(d) container_of(d, struct i2c_adapter, class_dev)
250
251static inline void *i2c_get_adapdata (struct i2c_adapter *dev)
252{
253 return dev_get_drvdata (&dev->dev);
254}
255
256static inline void i2c_set_adapdata (struct i2c_adapter *dev, void *data)
257{
258 dev_set_drvdata (&dev->dev, data);
259}
260
261/*flags for the driver struct: */
262#define I2C_DF_NOTIFY 0x01 /* notify on bus (de/a)ttaches */
263#if 0
264/* this flag is gone -- there is a (optional) driver->detach_adapter
265 * callback now which can be used instead */
266# define I2C_DF_DUMMY 0x02
267#endif
268
269/*flags for the client struct: */
270#define I2C_CLIENT_ALLOW_USE 0x01 /* Client allows access */
271#define I2C_CLIENT_ALLOW_MULTIPLE_USE 0x02 /* Allow multiple access-locks */
272 /* on an i2c_client */
273#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
274#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
275 /* Must equal I2C_M_TEN below */
276
277/* i2c adapter classes (bitmask) */
278#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
279#define I2C_CLASS_TV_ANALOG (1<<1) /* bttv + friends */
280#define I2C_CLASS_TV_DIGITAL (1<<2) /* dvb cards */
281#define I2C_CLASS_DDC (1<<3) /* i2c-matroxfb ? */
282#define I2C_CLASS_CAM_ANALOG (1<<4) /* camera with analog CCD */
283#define I2C_CLASS_CAM_DIGITAL (1<<5) /* most webcams */
284#define I2C_CLASS_SOUND (1<<6) /* sound devices */
285#define I2C_CLASS_ALL (UINT_MAX) /* all of the above */
286
287/* i2c_client_address_data is the struct for holding default client
288 * addresses for a driver and for the parameters supplied on the
289 * command line
290 */
291struct i2c_client_address_data {
292 unsigned short *normal_i2c;
293 unsigned short *normal_i2c_range;
294 unsigned short *probe;
295 unsigned short *probe_range;
296 unsigned short *ignore;
297 unsigned short *ignore_range;
298 unsigned short *force;
299};
300
301/* Internal numbers to terminate lists */
302#define I2C_CLIENT_END 0xfffeU
303#define I2C_CLIENT_ISA_END 0xfffefffeU
304
305/* The numbers to use to set I2C bus address */
306#define ANY_I2C_BUS 0xffff
307#define ANY_I2C_ISA_BUS 9191
308
309
310/* ----- functions exported by i2c.o */
311
312/* administration...
313 */
314extern int i2c_add_adapter(struct i2c_adapter *);
315extern int i2c_del_adapter(struct i2c_adapter *);
316
317extern int i2c_add_driver(struct i2c_driver *);
318extern int i2c_del_driver(struct i2c_driver *);
319
320extern int i2c_attach_client(struct i2c_client *);
321extern int i2c_detach_client(struct i2c_client *);
322
323/* New function: This is to get an i2c_client-struct for controlling the
324 client either by using i2c_control-function or having the
325 client-module export functions that can be used with the i2c_client
326 -struct. */
327extern struct i2c_client *i2c_get_client(int driver_id, int adapter_id,
328 struct i2c_client *prev);
329
330/* Should be used with new function
331 extern struct i2c_client *i2c_get_client(int,int,struct i2c_client *);
332 to make sure that client-struct is valid and that it is okay to access
333 the i2c-client.
334 returns -EACCES if client doesn't allow use (default)
335 returns -EBUSY if client doesn't allow multiple use (default) and
336 usage_count >0 */
337extern int i2c_use_client(struct i2c_client *);
338extern int i2c_release_client(struct i2c_client *);
339
340/* call the i2c_client->command() of all attached clients with
341 * the given arguments */
342extern void i2c_clients_command(struct i2c_adapter *adap,
343 unsigned int cmd, void *arg);
344
345/* returns -EBUSY if address has been taken, 0 if not. Note that the only
346 other place at which this is called is within i2c_attach_client; so
347 you can cheat by simply not registering. Not recommended, of course! */
348extern int i2c_check_addr (struct i2c_adapter *adapter, int addr);
349
350/* Detect function. It iterates over all possible addresses itself.
351 * It will only call found_proc if some client is connected at the
352 * specific address (unless a 'force' matched);
353 */
354extern int i2c_probe(struct i2c_adapter *adapter,
355 struct i2c_client_address_data *address_data,
356 int (*found_proc) (struct i2c_adapter *, int, int));
357
358/* An ioctl like call to set div. parameters of the adapter.
359 */
360extern int i2c_control(struct i2c_client *,unsigned int, unsigned long);
361
362/* This call returns a unique low identifier for each registered adapter,
363 * or -1 if the adapter was not registered.
364 */
365extern int i2c_adapter_id(struct i2c_adapter *adap);
366extern struct i2c_adapter* i2c_get_adapter(int id);
367extern void i2c_put_adapter(struct i2c_adapter *adap);
368
369
370/* Return the functionality mask */
371static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
372{
373 return adap->algo->functionality(adap);
374}
375
376/* Return 1 if adapter supports everything we need, 0 if not. */
377static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
378{
379 return (func & i2c_get_functionality(adap)) == func;
380}
381
382/*
383 * I2C Message - used for pure i2c transaction, also from /dev interface
384 */
385struct i2c_msg {
386 __u16 addr; /* slave address */
387 __u16 flags;
388#define I2C_M_TEN 0x10 /* we have a ten bit chip address */
389#define I2C_M_RD 0x01
390#define I2C_M_NOSTART 0x4000
391#define I2C_M_REV_DIR_ADDR 0x2000
392#define I2C_M_IGNORE_NAK 0x1000
393#define I2C_M_NO_RD_ACK 0x0800
394 __u16 len; /* msg length */
395 __u8 *buf; /* pointer to msg data */
396};
397
398/* To determine what functionality is present */
399
400#define I2C_FUNC_I2C 0x00000001
401#define I2C_FUNC_10BIT_ADDR 0x00000002
402#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_{REV_DIR_ADDR,NOSTART,..} */
403#define I2C_FUNC_SMBUS_HWPEC_CALC 0x00000008 /* SMBus 2.0 */
404#define I2C_FUNC_SMBUS_READ_WORD_DATA_PEC 0x00000800 /* SMBus 2.0 */
405#define I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC 0x00001000 /* SMBus 2.0 */
406#define I2C_FUNC_SMBUS_PROC_CALL_PEC 0x00002000 /* SMBus 2.0 */
407#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL_PEC 0x00004000 /* SMBus 2.0 */
408#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
409#define I2C_FUNC_SMBUS_QUICK 0x00010000
410#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
411#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
412#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
413#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
414#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
415#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
416#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
417#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
418#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
419#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
420#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
421#define I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 0x10000000 /* I2C-like block xfer */
422#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2 0x20000000 /* w/ 2-byte reg. addr. */
423#define I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC 0x40000000 /* SMBus 2.0 */
424#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC 0x80000000 /* SMBus 2.0 */
425
426#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
427 I2C_FUNC_SMBUS_WRITE_BYTE)
428#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
429 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
430#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
431 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
432#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
433 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
434#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
435 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
436#define I2C_FUNC_SMBUS_I2C_BLOCK_2 (I2C_FUNC_SMBUS_READ_I2C_BLOCK_2 | \
437 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK_2)
438#define I2C_FUNC_SMBUS_BLOCK_DATA_PEC (I2C_FUNC_SMBUS_READ_BLOCK_DATA_PEC | \
439 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC)
440#define I2C_FUNC_SMBUS_WORD_DATA_PEC (I2C_FUNC_SMBUS_READ_WORD_DATA_PEC | \
441 I2C_FUNC_SMBUS_WRITE_WORD_DATA_PEC)
442
443#define I2C_FUNC_SMBUS_READ_BYTE_PEC I2C_FUNC_SMBUS_READ_BYTE_DATA
444#define I2C_FUNC_SMBUS_WRITE_BYTE_PEC I2C_FUNC_SMBUS_WRITE_BYTE_DATA
445#define I2C_FUNC_SMBUS_READ_BYTE_DATA_PEC I2C_FUNC_SMBUS_READ_WORD_DATA
446#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA_PEC I2C_FUNC_SMBUS_WRITE_WORD_DATA
447#define I2C_FUNC_SMBUS_BYTE_PEC I2C_FUNC_SMBUS_BYTE_DATA
448#define I2C_FUNC_SMBUS_BYTE_DATA_PEC I2C_FUNC_SMBUS_WORD_DATA
449
450#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
451 I2C_FUNC_SMBUS_BYTE | \
452 I2C_FUNC_SMBUS_BYTE_DATA | \
453 I2C_FUNC_SMBUS_WORD_DATA | \
454 I2C_FUNC_SMBUS_PROC_CALL | \
455 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
456 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA_PEC | \
457 I2C_FUNC_SMBUS_I2C_BLOCK)
458
459/*
460 * Data for SMBus Messages
461 */
462#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
463#define I2C_SMBUS_I2C_BLOCK_MAX 32 /* Not specified but we use same structure */
464union i2c_smbus_data {
465 __u8 byte;
466 __u16 word;
467 __u8 block[I2C_SMBUS_BLOCK_MAX + 3]; /* block[0] is used for length */
468 /* one more for read length in block process call */
469 /* and one more for PEC */
470};
471
472/* smbus_access read or write markers */
473#define I2C_SMBUS_READ 1
474#define I2C_SMBUS_WRITE 0
475
476/* SMBus transaction types (size parameter in the above functions)
477 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
478#define I2C_SMBUS_QUICK 0
479#define I2C_SMBUS_BYTE 1
480#define I2C_SMBUS_BYTE_DATA 2
481#define I2C_SMBUS_WORD_DATA 3
482#define I2C_SMBUS_PROC_CALL 4
483#define I2C_SMBUS_BLOCK_DATA 5
484#define I2C_SMBUS_I2C_BLOCK_DATA 6
485#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
486#define I2C_SMBUS_BLOCK_DATA_PEC 8 /* SMBus 2.0 */
487#define I2C_SMBUS_PROC_CALL_PEC 9 /* SMBus 2.0 */
488#define I2C_SMBUS_BLOCK_PROC_CALL_PEC 10 /* SMBus 2.0 */
489#define I2C_SMBUS_WORD_DATA_PEC 11 /* SMBus 2.0 */
490
491
492/* ----- commands for the ioctl like i2c_command call:
493 * note that additional calls are defined in the algorithm and hw
494 * dependent layers - these can be listed here, or see the
495 * corresponding header files.
496 */
497 /* -> bit-adapter specific ioctls */
498#define I2C_RETRIES 0x0701 /* number of times a device address */
499 /* should be polled when not */
500 /* acknowledging */
501#define I2C_TIMEOUT 0x0702 /* set timeout - call with int */
502
503
504/* this is for i2c-dev.c */
505#define I2C_SLAVE 0x0703 /* Change slave address */
506 /* Attn.: Slave address is 7 or 10 bits */
507#define I2C_SLAVE_FORCE 0x0706 /* Change slave address */
508 /* Attn.: Slave address is 7 or 10 bits */
509 /* This changes the address, even if it */
510 /* is already taken! */
511#define I2C_TENBIT 0x0704 /* 0 for 7 bit addrs, != 0 for 10 bit */
512
513#define I2C_FUNCS 0x0705 /* Get the adapter functionality */
514#define I2C_RDWR 0x0707 /* Combined R/W transfer (one stop only)*/
515#define I2C_PEC 0x0708 /* != 0 for SMBus PEC */
516#if 0
517#define I2C_ACK_TEST 0x0710 /* See if a slave is at a specific address */
518#endif
519
520#define I2C_SMBUS 0x0720 /* SMBus-level access */
521
522/* ... algo-bit.c recognizes */
523#define I2C_UDELAY 0x0705 /* set delay in microsecs between each */
524 /* written byte (except address) */
525#define I2C_MDELAY 0x0706 /* millisec delay between written bytes */
526
527/* ----- I2C-DEV: char device interface stuff ------------------------- */
528
529#define I2C_MAJOR 89 /* Device major number */
530
531/* These defines are used for probing i2c client addresses */
532/* The length of the option lists */
533#define I2C_CLIENT_MAX_OPTS 48
534
535/* Default fill of many variables */
536#define I2C_CLIENT_DEFAULTS {I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
537 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
538 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
539 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
540 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
541 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
542 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
543 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
544 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
545 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
546 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
547 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
548 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
549 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
550 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END, \
551 I2C_CLIENT_END, I2C_CLIENT_END, I2C_CLIENT_END}
552
553/* I2C_CLIENT_MODULE_PARM creates a module parameter, and puts it in the
554 module header */
555
556#define I2C_CLIENT_MODULE_PARM(var,desc) \
557 static unsigned short var[I2C_CLIENT_MAX_OPTS] = I2C_CLIENT_DEFAULTS; \
558 static unsigned int var##_num; \
559 module_param_array(var, short, &var##_num, 0); \
560 MODULE_PARM_DESC(var,desc)
561
562/* This is the one you want to use in your own modules */
563#define I2C_CLIENT_INSMOD \
564 I2C_CLIENT_MODULE_PARM(probe, \
565 "List of adapter,address pairs to scan additionally"); \
566 I2C_CLIENT_MODULE_PARM(probe_range, \
567 "List of adapter,start-addr,end-addr triples to scan " \
568 "additionally"); \
569 I2C_CLIENT_MODULE_PARM(ignore, \
570 "List of adapter,address pairs not to scan"); \
571 I2C_CLIENT_MODULE_PARM(ignore_range, \
572 "List of adapter,start-addr,end-addr triples not to " \
573 "scan"); \
574 I2C_CLIENT_MODULE_PARM(force, \
575 "List of adapter,address pairs to boldly assume " \
576 "to be present"); \
577 static struct i2c_client_address_data addr_data = { \
578 .normal_i2c = normal_i2c, \
579 .normal_i2c_range = normal_i2c_range, \
580 .probe = probe, \
581 .probe_range = probe_range, \
582 .ignore = ignore, \
583 .ignore_range = ignore_range, \
584 .force = force, \
585 }
586
587/* Detect whether we are on the isa bus. If this returns true, all i2c
588 access will fail! */
589#define i2c_is_isa_client(clientptr) \
590 ((clientptr)->adapter->algo->id == I2C_ALGO_ISA)
591#define i2c_is_isa_adapter(adapptr) \
592 ((adapptr)->algo->id == I2C_ALGO_ISA)
593
594#endif /* _LINUX_I2C_H */