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