]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/i2c.h
Merge branch 'upstream-linus' of git://github.com/jgarzik/libata-dev
[mirror_ubuntu-artful-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__
a9d1b24d 31#include <linux/mod_devicetable.h>
1da177e4 32#include <linux/device.h> /* for struct device */
4e57b681 33#include <linux/sched.h> /* for completion */
5c085d36 34#include <linux/mutex.h>
d12d42f7 35#include <linux/of.h> /* for struct device_node */
06a67848 36#include <linux/swab.h> /* for swab16 */
1da177e4 37
e9ca9eb9 38extern struct bus_type i2c_bus_type;
0826374b 39extern struct device_type i2c_adapter_type;
e9ca9eb9 40
1da177e4
LT
41/* --- General options ------------------------------------------------ */
42
43struct i2c_msg;
44struct i2c_algorithm;
45struct i2c_adapter;
46struct i2c_client;
47struct i2c_driver;
1da177e4 48union i2c_smbus_data;
4735c98f 49struct i2c_board_info;
1da177e4 50
de477254
PG
51struct module;
52
23af8400 53#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4
LT
54/*
55 * The master routines are the ones normally used to transmit data to devices
438d6c2c
DB
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
1da177e4 58 * transmit an arbitrary number of messages without interruption.
0c43ea54 59 * @count must be be less than 64k since msg.len is u16.
1da177e4 60 */
0cc43a18
JD
61extern int i2c_master_send(const struct i2c_client *client, const char *buf,
62 int count);
63extern int i2c_master_recv(const struct i2c_client *client, char *buf,
3ae70dee 64 int count);
1da177e4
LT
65
66/* Transfer num messages.
67 */
3ae70dee
JD
68extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
69 int num);
1da177e4
LT
70
71/* This is the very generalized SMBus access routine. You probably do not
72 want to use this, though; one of the functions below may be much easier,
438d6c2c 73 and probably just as fast.
1da177e4
LT
74 Note that we use i2c_adapter here, because you do not need a specific
75 smbus adapter to call this function. */
3ae70dee
JD
76extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
77 unsigned short flags, char read_write, u8 command,
78 int size, union i2c_smbus_data *data);
1da177e4
LT
79
80/* Now follow the 'nice' access routines. These also document the calling
ae7193f7 81 conventions of i2c_smbus_xfer. */
1da177e4 82
0cc43a18
JD
83extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
84extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
85extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
86 u8 command);
87extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
3ae70dee 88 u8 command, u8 value);
0cc43a18
JD
89extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
90 u8 command);
91extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
3ae70dee 92 u8 command, u16 value);
06a67848
JC
93
94static inline s32
95i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
96{
97 s32 value = i2c_smbus_read_word_data(client, command);
98
99 return (value < 0) ? value : swab16(value);
100}
101
102static inline s32
103i2c_smbus_write_word_swapped(const struct i2c_client *client,
104 u8 command, u16 value)
105{
106 return i2c_smbus_write_word_data(client, command, swab16(value));
107}
108
b86a1bc8 109/* Returns the number of read bytes */
0cc43a18 110extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
b86a1bc8 111 u8 command, u8 *values);
0cc43a18 112extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
3ae70dee 113 u8 command, u8 length, const u8 *values);
31ec5bc5 114/* Returns the number of read bytes */
0cc43a18 115extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
4b2643d7 116 u8 command, u8 length, u8 *values);
0cc43a18 117extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
21bbd691 118 u8 command, u8 length,
46f5ed75 119 const u8 *values);
23af8400 120#endif /* I2C */
1da177e4 121
4735c98f
JD
122/**
123 * struct i2c_driver - represent an I2C device driver
124 * @class: What kind of i2c device we instantiate (for detect)
fe6fc258
JD
125 * @attach_adapter: Callback for bus addition (deprecated)
126 * @detach_adapter: Callback for bus removal (deprecated)
729d6dd5
JD
127 * @probe: Callback for device binding
128 * @remove: Callback for device unbinding
96e21e4f
JD
129 * @shutdown: Callback for device shutdown
130 * @suspend: Callback for device suspend
131 * @resume: Callback for device resume
72d2e9f9 132 * @alert: Alert callback, for example for the SMBus alert protocol
96e21e4f
JD
133 * @command: Callback for bus-wide signaling (optional)
134 * @driver: Device driver model driver
135 * @id_table: List of I2C devices supported by this driver
4735c98f 136 * @detect: Callback for device detection
c3813d6a 137 * @address_list: The I2C addresses to probe (for detect)
4735c98f 138 * @clients: List of detected clients we created (for i2c-core use only)
35d8b2e6
LR
139 *
140 * The driver.owner field should be set to the module owner of this driver.
141 * The driver.name field should be set to the name of this driver.
4735c98f
JD
142 *
143 * For automatic device detection, both @detect and @address_data must
144 * be defined. @class should also be set, otherwise only devices forced
145 * with module parameters will be created. The detect function must
146 * fill at least the name field of the i2c_board_info structure it is
147 * handed upon successful detection, and possibly also the flags field.
148 *
149 * If @detect is missing, the driver will still work fine for enumerated
150 * devices. Detected devices simply won't be supported. This is expected
151 * for the many I2C/SMBus devices which can't be detected reliably, and
152 * the ones which can always be enumerated in practice.
153 *
154 * The i2c_client structure which is handed to the @detect callback is
155 * not a real i2c_client. It is initialized just enough so that you can
156 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
157 * else with it. In particular, calling dev_dbg and friends on it is
158 * not allowed.
1da177e4 159 */
1da177e4 160struct i2c_driver {
1da177e4 161 unsigned int class;
1da177e4 162
729d6dd5 163 /* Notifies the driver that a new bus has appeared or is about to be
fe6fc258
JD
164 * removed. You should avoid using this, it will be removed in a
165 * near future.
1da177e4 166 */
fe6fc258
JD
167 int (*attach_adapter)(struct i2c_adapter *) __deprecated;
168 int (*detach_adapter)(struct i2c_adapter *) __deprecated;
1da177e4 169
729d6dd5 170 /* Standard driver model interfaces */
d2653e92 171 int (*probe)(struct i2c_client *, const struct i2c_device_id *);
a1d9e6e4 172 int (*remove)(struct i2c_client *);
7b4fbc50 173
f37dd80a
DB
174 /* driver model interfaces that don't relate to enumeration */
175 void (*shutdown)(struct i2c_client *);
176 int (*suspend)(struct i2c_client *, pm_message_t mesg);
177 int (*resume)(struct i2c_client *);
178
b5527a77
JD
179 /* Alert callback, for example for the SMBus alert protocol.
180 * The format and meaning of the data value depends on the protocol.
181 * For the SMBus alert protocol, there is a single bit of data passed
182 * as the alert response's low bit ("event flag").
183 */
184 void (*alert)(struct i2c_client *, unsigned int data);
185
1da177e4
LT
186 /* a ioctl like command that can be used to perform specific functions
187 * with the device.
188 */
3ae70dee 189 int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
1da177e4
LT
190
191 struct device_driver driver;
d2653e92 192 const struct i2c_device_id *id_table;
4735c98f
JD
193
194 /* Device detection callback for automatic device creation */
310ec792 195 int (*detect)(struct i2c_client *, struct i2c_board_info *);
c3813d6a 196 const unsigned short *address_list;
4735c98f 197 struct list_head clients;
1da177e4
LT
198};
199#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)
200
2096b956
DB
201/**
202 * struct i2c_client - represent an I2C slave device
d64f73be
DB
203 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
204 * I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
2096b956
DB
205 * @addr: Address used on the I2C bus connected to the parent adapter.
206 * @name: Indicates the type of the device, usually a chip name that's
207 * generic enough to hide second-sourcing and compatible revisions.
d64f73be 208 * @adapter: manages the bus segment hosting this I2C device
aa3481d5 209 * @driver: device's driver, hence pointer to access routines
2096b956 210 * @dev: Driver model device node for the slave.
d64f73be 211 * @irq: indicates the IRQ generated by this device (if any)
99cd8e25
JD
212 * @detected: member of an i2c_driver.clients list or i2c-core's
213 * userspace_devices list
2096b956
DB
214 *
215 * An i2c_client identifies a single device (i.e. chip) connected to an
d64f73be
DB
216 * i2c bus. The behaviour exposed to Linux is defined by the driver
217 * managing the device.
1da177e4
LT
218 */
219struct i2c_client {
2096b956 220 unsigned short flags; /* div., see below */
438d6c2c 221 unsigned short addr; /* chip address - NOTE: 7bit */
1da177e4 222 /* addresses are stored in the */
5071860a 223 /* _LOWER_ 7 bits */
2096b956 224 char name[I2C_NAME_SIZE];
1da177e4
LT
225 struct i2c_adapter *adapter; /* the adapter we sit on */
226 struct i2c_driver *driver; /* and our access routines */
1da177e4 227 struct device dev; /* the device structure */
8e29da9e 228 int irq; /* irq issued by device */
4735c98f 229 struct list_head detected;
1da177e4
LT
230};
231#define to_i2c_client(d) container_of(d, struct i2c_client, dev)
232
9b766b81
DB
233extern struct i2c_client *i2c_verify_client(struct device *dev);
234
a61fc683
BG
235static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
236{
d75d53cd
MH
237 struct device * const dev = container_of(kobj, struct device, kobj);
238 return to_i2c_client(dev);
a61fc683
BG
239}
240
7d1d8999 241static inline void *i2c_get_clientdata(const struct i2c_client *dev)
1da177e4 242{
3ae70dee 243 return dev_get_drvdata(&dev->dev);
1da177e4
LT
244}
245
3ae70dee 246static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
1da177e4 247{
3ae70dee 248 dev_set_drvdata(&dev->dev, data);
1da177e4
LT
249}
250
9c1600ed
DB
251/**
252 * struct i2c_board_info - template for device creation
eb8a7908 253 * @type: chip type, to initialize i2c_client.name
9c1600ed
DB
254 * @flags: to initialize i2c_client.flags
255 * @addr: stored in i2c_client.addr
256 * @platform_data: stored in i2c_client.dev.platform_data
11f1f2af 257 * @archdata: copied into i2c_client.dev.archdata
72d2e9f9 258 * @of_node: pointer to OpenFirmware device node
9c1600ed 259 * @irq: stored in i2c_client.irq
d64f73be 260 *
9c1600ed
DB
261 * I2C doesn't actually support hardware probing, although controllers and
262 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
263 * a device at a given address. Drivers commonly need more information than
264 * that, such as chip type, configuration, associated IRQ, and so on.
265 *
266 * i2c_board_info is used to build tables of information listing I2C devices
729d6dd5
JD
267 * that are present. This information is used to grow the driver model tree.
268 * For mainboards this is done statically using i2c_register_board_info();
269 * bus numbers identify adapters that aren't yet available. For add-on boards,
270 * i2c_new_device() does this dynamically with the adapter already known.
9c1600ed
DB
271 */
272struct i2c_board_info {
9c1600ed
DB
273 char type[I2C_NAME_SIZE];
274 unsigned short flags;
275 unsigned short addr;
276 void *platform_data;
11f1f2af 277 struct dev_archdata *archdata;
d12d42f7 278 struct device_node *of_node;
9c1600ed
DB
279 int irq;
280};
281
282/**
3760f736
JD
283 * I2C_BOARD_INFO - macro used to list an i2c device and its address
284 * @dev_type: identifies the device type
9c1600ed
DB
285 * @dev_addr: the device's address on the bus.
286 *
287 * This macro initializes essential fields of a struct i2c_board_info,
288 * declaring what has been provided on a particular board. Optional
3760f736
JD
289 * fields (such as associated irq, or device-specific platform_data)
290 * are provided using conventional syntax.
9c1600ed 291 */
3ae70dee 292#define I2C_BOARD_INFO(dev_type, dev_addr) \
c758e8cf 293 .type = dev_type, .addr = (dev_addr)
9c1600ed
DB
294
295
23af8400 296#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
9c1600ed
DB
297/* Add-on boards should register/unregister their devices; e.g. a board
298 * with integrated I2C, a config eeprom, sensors, and a codec that's
299 * used in conjunction with the primary hardware.
300 */
301extern struct i2c_client *
302i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
303
12b5053a
JD
304/* If you don't know the exact address of an I2C device, use this variant
305 * instead, which can probe for device presence in a list of possible
9a94241a
JD
306 * addresses. The "probe" callback function is optional. If it is provided,
307 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
308 * a default probing method is used.
12b5053a
JD
309 */
310extern struct i2c_client *
311i2c_new_probed_device(struct i2c_adapter *adap,
312 struct i2c_board_info *info,
9a94241a
JD
313 unsigned short const *addr_list,
314 int (*probe)(struct i2c_adapter *, unsigned short addr));
12b5053a 315
d44f19d5
JD
316/* Common custom probe functions */
317extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);
318
e9f1373b
DB
319/* For devices that use several addresses, use i2c_new_dummy() to make
320 * client handles for the extra addresses.
321 */
322extern struct i2c_client *
60b129d7 323i2c_new_dummy(struct i2c_adapter *adap, u16 address);
e9f1373b 324
9c1600ed 325extern void i2c_unregister_device(struct i2c_client *);
23af8400 326#endif /* I2C */
9c1600ed
DB
327
328/* Mainboard arch_initcall() code should register all its I2C devices.
329 * This is done at arch_initcall time, before declaring any i2c adapters.
330 * Modules for add-on boards must use other calls.
331 */
26386763 332#ifdef CONFIG_I2C_BOARDINFO
9c1600ed 333extern int
3ae70dee
JD
334i2c_register_board_info(int busnum, struct i2c_board_info const *info,
335 unsigned n);
26386763
DB
336#else
337static inline int
3ae70dee
JD
338i2c_register_board_info(int busnum, struct i2c_board_info const *info,
339 unsigned n)
26386763
DB
340{
341 return 0;
342}
23af8400 343#endif /* I2C_BOARDINFO */
9c1600ed 344
1da177e4
LT
345/*
346 * The following structs are for those who like to implement new bus drivers:
347 * i2c_algorithm is the interface to a class of hardware solutions which can
348 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
349 * to name two of the most common.
350 */
351struct i2c_algorithm {
1da177e4 352 /* If an adapter algorithm can't do I2C-level access, set master_xfer
438d6c2c 353 to NULL. If an adapter algorithm can do SMBus access, set
1da177e4
LT
354 smbus_xfer. If set to NULL, the SMBus protocol is simulated
355 using common I2C messages */
8ced8eee
JD
356 /* master_xfer should return the number of messages successfully
357 processed, or a negative value on error */
3ae70dee
JD
358 int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
359 int num);
438d6c2c 360 int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
3ae70dee
JD
361 unsigned short flags, char read_write,
362 u8 command, int size, union i2c_smbus_data *data);
1da177e4 363
1da177e4
LT
364 /* To determine what the adapter supports */
365 u32 (*functionality) (struct i2c_adapter *);
366};
367
368/*
369 * i2c_adapter is the structure used to identify a physical i2c bus along
370 * with the access algorithms necessary to access it.
371 */
372struct i2c_adapter {
373 struct module *owner;
14f55f7a 374 unsigned int class; /* classes to allow probing for */
af71ff69 375 const struct i2c_algorithm *algo; /* the algorithm to access the bus */
1da177e4
LT
376 void *algo_data;
377
1da177e4 378 /* data fields that are valid for all devices */
194684e5 379 struct rt_mutex bus_lock;
1da177e4 380
cd97f39b 381 int timeout; /* in jiffies */
1da177e4
LT
382 int retries;
383 struct device dev; /* the adapter device */
1da177e4 384
1da177e4 385 int nr;
2096b956 386 char name[48];
1da177e4 387 struct completion dev_released;
6629dcff 388
dafc50d1 389 struct mutex userspace_clients_lock;
6629dcff 390 struct list_head userspace_clients;
1da177e4 391};
ef2c8321 392#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
1da177e4 393
7d1d8999 394static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
1da177e4 395{
3ae70dee 396 return dev_get_drvdata(&dev->dev);
1da177e4
LT
397}
398
3ae70dee 399static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
1da177e4 400{
3ae70dee 401 dev_set_drvdata(&dev->dev, data);
1da177e4
LT
402}
403
97cc4d49
JD
404static inline struct i2c_adapter *
405i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
0826374b 406{
97cc4d49
JD
407 struct device *parent = adapter->dev.parent;
408
409 if (parent != NULL && parent->type == &i2c_adapter_type)
410 return to_i2c_adapter(parent);
411 else
412 return NULL;
0826374b
ML
413}
414
7ae31482
JD
415int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));
416
fe61e07e
JD
417/* Adapter locking functions, exported for shared pin cases */
418void i2c_lock_adapter(struct i2c_adapter *);
419void i2c_unlock_adapter(struct i2c_adapter *);
afa08974 420
1da177e4 421/*flags for the client struct: */
3bbb835d
DB
422#define I2C_CLIENT_PEC 0x04 /* Use Packet Error Checking */
423#define I2C_CLIENT_TEN 0x10 /* we have a ten bit chip address */
424 /* Must equal I2C_M_TEN below */
425#define I2C_CLIENT_WAKE 0x80 /* for board_info; true iff can wake */
1da177e4
LT
426
427/* i2c adapter classes (bitmask) */
428#define I2C_CLASS_HWMON (1<<0) /* lm_sensors, ... */
c1b6b4f2 429#define I2C_CLASS_DDC (1<<3) /* DDC bus on graphics adapters */
774466ad 430#define I2C_CLASS_SPD (1<<7) /* Memory modules */
1da177e4 431
1da177e4
LT
432/* Internal numbers to terminate lists */
433#define I2C_CLIENT_END 0xfffeU
1da177e4
LT
434
435/* The numbers to use to set I2C bus address */
436#define ANY_I2C_BUS 0xffff
1da177e4 437
c7036673
HV
438/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
439#define I2C_ADDRS(addr, addrs...) \
440 ((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })
441
1da177e4
LT
442
443/* ----- functions exported by i2c.o */
444
445/* administration...
446 */
23af8400 447#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
1da177e4
LT
448extern int i2c_add_adapter(struct i2c_adapter *);
449extern int i2c_del_adapter(struct i2c_adapter *);
6e13e641 450extern int i2c_add_numbered_adapter(struct i2c_adapter *);
1da177e4 451
de59cf9e 452extern int i2c_register_driver(struct module *, struct i2c_driver *);
b3e82096 453extern void i2c_del_driver(struct i2c_driver *);
1da177e4 454
eb5589a8
PG
455/* use a define to avoid include chaining to get THIS_MODULE */
456#define i2c_add_driver(driver) \
457 i2c_register_driver(THIS_MODULE, driver)
de59cf9e 458
e48d3319
JD
459extern struct i2c_client *i2c_use_client(struct i2c_client *client);
460extern void i2c_release_client(struct i2c_client *client);
1da177e4
LT
461
462/* call the i2c_client->command() of all attached clients with
463 * the given arguments */
464extern void i2c_clients_command(struct i2c_adapter *adap,
465 unsigned int cmd, void *arg);
466
d735b34d 467extern struct i2c_adapter *i2c_get_adapter(int nr);
1da177e4
LT
468extern void i2c_put_adapter(struct i2c_adapter *adap);
469
470
471/* Return the functionality mask */
472static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
473{
474 return adap->algo->functionality(adap);
475}
476
477/* Return 1 if adapter supports everything we need, 0 if not. */
478static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
479{
480 return (func & i2c_get_functionality(adap)) == func;
481}
482
3ae70dee 483/* Return the adapter number for a specific adapter */
cdcb1921
JD
484static inline int i2c_adapter_id(struct i2c_adapter *adap)
485{
486 return adap->nr;
487}
23af8400 488#endif /* I2C */
a1b9298e 489#endif /* __KERNEL__ */
cdcb1921 490
a64ec07d
DB
491/**
492 * struct i2c_msg - an I2C transaction segment beginning with START
493 * @addr: Slave address, either seven or ten bits. When this is a ten
494 * bit address, I2C_M_TEN must be set in @flags and the adapter
495 * must support I2C_FUNC_10BIT_ADDR.
496 * @flags: I2C_M_RD is handled by all adapters. No other flags may be
497 * provided unless the adapter exported the relevant I2C_FUNC_*
498 * flags through i2c_check_functionality().
499 * @len: Number of data bytes in @buf being read from or written to the
500 * I2C slave address. For read transactions where I2C_M_RECV_LEN
501 * is set, the caller guarantees that this buffer can hold up to
502 * 32 bytes in addition to the initial length byte sent by the
503 * slave (plus, if used, the SMBus PEC); and this value will be
504 * incremented by the number of block data bytes received.
505 * @buf: The buffer into which data is read, or from which it's written.
506 *
507 * An i2c_msg is the low level representation of one segment of an I2C
508 * transaction. It is visible to drivers in the @i2c_transfer() procedure,
509 * to userspace from i2c-dev, and to I2C adapter drivers through the
510 * @i2c_adapter.@master_xfer() method.
511 *
512 * Except when I2C "protocol mangling" is used, all I2C adapters implement
513 * the standard rules for I2C transactions. Each transaction begins with a
514 * START. That is followed by the slave address, and a bit encoding read
515 * versus write. Then follow all the data bytes, possibly including a byte
516 * with SMBus PEC. The transfer terminates with a NAK, or when all those
517 * bytes have been transferred and ACKed. If this is the last message in a
518 * group, it is followed by a STOP. Otherwise it is followed by the next
519 * @i2c_msg transaction segment, beginning with a (repeated) START.
520 *
521 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
522 * passing certain @flags may have changed those standard protocol behaviors.
523 * Those flags are only for use with broken/nonconforming slaves, and with
524 * adapters which are known to support the specific mangling options they
525 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
1da177e4
LT
526 */
527struct i2c_msg {
528 __u16 addr; /* slave address */
438d6c2c 529 __u16 flags;
a64ec07d
DB
530#define I2C_M_TEN 0x0010 /* this is a ten bit chip address */
531#define I2C_M_RD 0x0001 /* read data, from slave to master */
532#define I2C_M_NOSTART 0x4000 /* if I2C_FUNC_PROTOCOL_MANGLING */
533#define I2C_M_REV_DIR_ADDR 0x2000 /* if I2C_FUNC_PROTOCOL_MANGLING */
534#define I2C_M_IGNORE_NAK 0x1000 /* if I2C_FUNC_PROTOCOL_MANGLING */
535#define I2C_M_NO_RD_ACK 0x0800 /* if I2C_FUNC_PROTOCOL_MANGLING */
536#define I2C_M_RECV_LEN 0x0400 /* length will be first received byte */
438d6c2c
DB
537 __u16 len; /* msg length */
538 __u8 *buf; /* pointer to msg data */
1da177e4
LT
539};
540
541/* To determine what functionality is present */
542
543#define I2C_FUNC_I2C 0x00000001
544#define I2C_FUNC_10BIT_ADDR 0x00000002
3ae70dee 545#define I2C_FUNC_PROTOCOL_MANGLING 0x00000004 /* I2C_M_NOSTART etc. */
6662cbb9 546#define I2C_FUNC_SMBUS_PEC 0x00000008
1da177e4 547#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL 0x00008000 /* SMBus 2.0 */
438d6c2c
DB
548#define I2C_FUNC_SMBUS_QUICK 0x00010000
549#define I2C_FUNC_SMBUS_READ_BYTE 0x00020000
550#define I2C_FUNC_SMBUS_WRITE_BYTE 0x00040000
551#define I2C_FUNC_SMBUS_READ_BYTE_DATA 0x00080000
552#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA 0x00100000
553#define I2C_FUNC_SMBUS_READ_WORD_DATA 0x00200000
554#define I2C_FUNC_SMBUS_WRITE_WORD_DATA 0x00400000
555#define I2C_FUNC_SMBUS_PROC_CALL 0x00800000
556#define I2C_FUNC_SMBUS_READ_BLOCK_DATA 0x01000000
557#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
1da177e4
LT
558#define I2C_FUNC_SMBUS_READ_I2C_BLOCK 0x04000000 /* I2C-like block xfer */
559#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK 0x08000000 /* w/ 1-byte reg. addr. */
1da177e4 560
3ae70dee
JD
561#define I2C_FUNC_SMBUS_BYTE (I2C_FUNC_SMBUS_READ_BYTE | \
562 I2C_FUNC_SMBUS_WRITE_BYTE)
563#define I2C_FUNC_SMBUS_BYTE_DATA (I2C_FUNC_SMBUS_READ_BYTE_DATA | \
564 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
565#define I2C_FUNC_SMBUS_WORD_DATA (I2C_FUNC_SMBUS_READ_WORD_DATA | \
566 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
567#define I2C_FUNC_SMBUS_BLOCK_DATA (I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
568 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
569#define I2C_FUNC_SMBUS_I2C_BLOCK (I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
570 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)
571
572#define I2C_FUNC_SMBUS_EMUL (I2C_FUNC_SMBUS_QUICK | \
573 I2C_FUNC_SMBUS_BYTE | \
574 I2C_FUNC_SMBUS_BYTE_DATA | \
575 I2C_FUNC_SMBUS_WORD_DATA | \
576 I2C_FUNC_SMBUS_PROC_CALL | \
577 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
578 I2C_FUNC_SMBUS_I2C_BLOCK | \
579 I2C_FUNC_SMBUS_PEC)
1da177e4 580
438d6c2c
DB
581/*
582 * Data for SMBus Messages
1da177e4 583 */
438d6c2c 584#define I2C_SMBUS_BLOCK_MAX 32 /* As specified in SMBus standard */
1da177e4
LT
585union i2c_smbus_data {
586 __u8 byte;
587 __u16 word;
332bf92b 588 __u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
3ae70dee 589 /* and one more for user-space compatibility */
1da177e4
LT
590};
591
ae7193f7 592/* i2c_smbus_xfer read or write markers */
1da177e4
LT
593#define I2C_SMBUS_READ 1
594#define I2C_SMBUS_WRITE 0
595
438d6c2c 596/* SMBus transaction types (size parameter in the above functions)
1da177e4
LT
597 Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
598#define I2C_SMBUS_QUICK 0
599#define I2C_SMBUS_BYTE 1
438d6c2c 600#define I2C_SMBUS_BYTE_DATA 2
1da177e4
LT
601#define I2C_SMBUS_WORD_DATA 3
602#define I2C_SMBUS_PROC_CALL 4
603#define I2C_SMBUS_BLOCK_DATA 5
4b2643d7 604#define I2C_SMBUS_I2C_BLOCK_BROKEN 6
1da177e4 605#define I2C_SMBUS_BLOCK_PROC_CALL 7 /* SMBus 2.0 */
4b2643d7 606#define I2C_SMBUS_I2C_BLOCK_DATA 8
1da177e4 607
1da177e4 608#endif /* _LINUX_I2C_H */