i2c.h 22.9 KB
Newer Older
L
Linus Torvalds 已提交
1
/* ------------------------------------------------------------------------- */
D
David Brownell 已提交
2
/*									     */
L
Linus Torvalds 已提交
3
/* i2c.h - definitions for the i2c-bus interface			     */
D
David Brownell 已提交
4
/*									     */
L
Linus Torvalds 已提交
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/* ------------------------------------------------------------------------- */
/*   Copyright (C) 1995-2000 Simon G. Vogl

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.		     */
/* ------------------------------------------------------------------------- */

23
/* With some changes from Kyösti Mälkki <kmalkki@cc.hut.fi> and
L
Linus Torvalds 已提交
24 25 26 27 28 29
   Frodo Looijaard <frodol@dds.nl> */

#ifndef _LINUX_I2C_H
#define _LINUX_I2C_H

#include <linux/types.h>
D
David Brownell 已提交
30
#ifdef __KERNEL__
31
#include <linux/module.h>
32
#include <linux/mod_devicetable.h>
L
Linus Torvalds 已提交
33
#include <linux/device.h>	/* for struct device */
T
Tim Schmielau 已提交
34
#include <linux/sched.h>	/* for completion */
35
#include <linux/mutex.h>
36
#include <linux/of.h>		/* for struct device_node */
37
#include <linux/swab.h>		/* for swab16 */
L
Linus Torvalds 已提交
38

J
Jon Smirl 已提交
39
extern struct bus_type i2c_bus_type;
40
extern struct device_type i2c_adapter_type;
J
Jon Smirl 已提交
41

L
Linus Torvalds 已提交
42 43 44 45 46 47 48 49
/* --- General options ------------------------------------------------	*/

struct i2c_msg;
struct i2c_algorithm;
struct i2c_adapter;
struct i2c_client;
struct i2c_driver;
union i2c_smbus_data;
50
struct i2c_board_info;
L
Linus Torvalds 已提交
51

52
#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
L
Linus Torvalds 已提交
53 54
/*
 * The master routines are the ones normally used to transmit data to devices
D
David Brownell 已提交
55 56
 * on a bus (or read from them). Apart from two basic transfer functions to
 * transmit one message at a time, a more complex version can be used to
L
Linus Torvalds 已提交
57
 * transmit an arbitrary number of messages without interruption.
58
 * @count must be be less than 64k since msg.len is u16.
L
Linus Torvalds 已提交
59
 */
60 61 62
extern int i2c_master_send(const struct i2c_client *client, const char *buf,
			   int count);
extern int i2c_master_recv(const struct i2c_client *client, char *buf,
J
Jean Delvare 已提交
63
			   int count);
L
Linus Torvalds 已提交
64 65 66

/* Transfer num messages.
 */
J
Jean Delvare 已提交
67 68
extern int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs,
			int num);
L
Linus Torvalds 已提交
69 70 71

/* This is the very generalized SMBus access routine. You probably do not
   want to use this, though; one of the functions below may be much easier,
D
David Brownell 已提交
72
   and probably just as fast.
L
Linus Torvalds 已提交
73 74
   Note that we use i2c_adapter here, because you do not need a specific
   smbus adapter to call this function. */
J
Jean Delvare 已提交
75 76 77
extern s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
			  unsigned short flags, char read_write, u8 command,
			  int size, union i2c_smbus_data *data);
L
Linus Torvalds 已提交
78 79

/* Now follow the 'nice' access routines. These also document the calling
80
   conventions of i2c_smbus_xfer. */
L
Linus Torvalds 已提交
81

82 83 84 85 86
extern s32 i2c_smbus_read_byte(const struct i2c_client *client);
extern s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value);
extern s32 i2c_smbus_read_byte_data(const struct i2c_client *client,
				    u8 command);
extern s32 i2c_smbus_write_byte_data(const struct i2c_client *client,
J
Jean Delvare 已提交
87
				     u8 command, u8 value);
88 89 90
extern s32 i2c_smbus_read_word_data(const struct i2c_client *client,
				    u8 command);
extern s32 i2c_smbus_write_word_data(const struct i2c_client *client,
J
Jean Delvare 已提交
91
				     u8 command, u16 value);
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

static inline s32
i2c_smbus_read_word_swapped(const struct i2c_client *client, u8 command)
{
	s32 value = i2c_smbus_read_word_data(client, command);

	return (value < 0) ? value : swab16(value);
}

static inline s32
i2c_smbus_write_word_swapped(const struct i2c_client *client,
			     u8 command, u16 value)
{
	return i2c_smbus_write_word_data(client, command, swab16(value));
}

108
/* Returns the number of read bytes */
109
extern s32 i2c_smbus_read_block_data(const struct i2c_client *client,
110
				     u8 command, u8 *values);
111
extern s32 i2c_smbus_write_block_data(const struct i2c_client *client,
J
Jean Delvare 已提交
112
				      u8 command, u8 length, const u8 *values);
113
/* Returns the number of read bytes */
114
extern s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client,
115
					 u8 command, u8 length, u8 *values);
116
extern s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client,
117
					  u8 command, u8 length,
118
					  const u8 *values);
119
#endif /* I2C */
L
Linus Torvalds 已提交
120

121 122 123
/**
 * struct i2c_driver - represent an I2C device driver
 * @class: What kind of i2c device we instantiate (for detect)
124 125
 * @attach_adapter: Callback for bus addition (deprecated)
 * @detach_adapter: Callback for bus removal (deprecated)
126 127
 * @probe: Callback for device binding
 * @remove: Callback for device unbinding
128 129 130
 * @shutdown: Callback for device shutdown
 * @suspend: Callback for device suspend
 * @resume: Callback for device resume
R
Randy Dunlap 已提交
131
 * @alert: Alert callback, for example for the SMBus alert protocol
132 133 134
 * @command: Callback for bus-wide signaling (optional)
 * @driver: Device driver model driver
 * @id_table: List of I2C devices supported by this driver
135
 * @detect: Callback for device detection
136
 * @address_list: The I2C addresses to probe (for detect)
137
 * @clients: List of detected clients we created (for i2c-core use only)
138 139 140
 *
 * The driver.owner field should be set to the module owner of this driver.
 * The driver.name field should be set to the name of this driver.
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
 *
 * For automatic device detection, both @detect and @address_data must
 * be defined. @class should also be set, otherwise only devices forced
 * with module parameters will be created. The detect function must
 * fill at least the name field of the i2c_board_info structure it is
 * handed upon successful detection, and possibly also the flags field.
 *
 * If @detect is missing, the driver will still work fine for enumerated
 * devices. Detected devices simply won't be supported. This is expected
 * for the many I2C/SMBus devices which can't be detected reliably, and
 * the ones which can always be enumerated in practice.
 *
 * The i2c_client structure which is handed to the @detect callback is
 * not a real i2c_client. It is initialized just enough so that you can
 * call i2c_smbus_read_byte_data and friends on it. Don't do anything
 * else with it. In particular, calling dev_dbg and friends on it is
 * not allowed.
L
Linus Torvalds 已提交
158 159 160 161
 */
struct i2c_driver {
	unsigned int class;

162
	/* Notifies the driver that a new bus has appeared or is about to be
163 164
	 * removed. You should avoid using this, it will be removed in a
	 * near future.
L
Linus Torvalds 已提交
165
	 */
166 167
	int (*attach_adapter)(struct i2c_adapter *) __deprecated;
	int (*detach_adapter)(struct i2c_adapter *) __deprecated;
L
Linus Torvalds 已提交
168

169
	/* Standard driver model interfaces */
170
	int (*probe)(struct i2c_client *, const struct i2c_device_id *);
D
David Brownell 已提交
171
	int (*remove)(struct i2c_client *);
D
David Brownell 已提交
172

173 174 175 176 177
	/* driver model interfaces that don't relate to enumeration  */
	void (*shutdown)(struct i2c_client *);
	int (*suspend)(struct i2c_client *, pm_message_t mesg);
	int (*resume)(struct i2c_client *);

J
Jean Delvare 已提交
178 179 180 181 182 183 184
	/* Alert callback, for example for the SMBus alert protocol.
	 * The format and meaning of the data value depends on the protocol.
	 * For the SMBus alert protocol, there is a single bit of data passed
	 * as the alert response's low bit ("event flag").
	 */
	void (*alert)(struct i2c_client *, unsigned int data);

L
Linus Torvalds 已提交
185 186 187
	/* a ioctl like command that can be used to perform specific functions
	 * with the device.
	 */
J
Jean Delvare 已提交
188
	int (*command)(struct i2c_client *client, unsigned int cmd, void *arg);
L
Linus Torvalds 已提交
189 190

	struct device_driver driver;
191
	const struct i2c_device_id *id_table;
192 193

	/* Device detection callback for automatic device creation */
194
	int (*detect)(struct i2c_client *, struct i2c_board_info *);
195
	const unsigned short *address_list;
196
	struct list_head clients;
L
Linus Torvalds 已提交
197 198 199
};
#define to_i2c_driver(d) container_of(d, struct i2c_driver, driver)

D
David Brownell 已提交
200 201
/**
 * struct i2c_client - represent an I2C slave device
D
David Brownell 已提交
202 203
 * @flags: I2C_CLIENT_TEN indicates the device uses a ten bit chip address;
 *	I2C_CLIENT_PEC indicates it uses SMBus Packet Error Checking
D
David Brownell 已提交
204 205 206
 * @addr: Address used on the I2C bus connected to the parent adapter.
 * @name: Indicates the type of the device, usually a chip name that's
 *	generic enough to hide second-sourcing and compatible revisions.
D
David Brownell 已提交
207
 * @adapter: manages the bus segment hosting this I2C device
R
Randy Dunlap 已提交
208
 * @driver: device's driver, hence pointer to access routines
D
David Brownell 已提交
209
 * @dev: Driver model device node for the slave.
D
David Brownell 已提交
210
 * @irq: indicates the IRQ generated by this device (if any)
211 212
 * @detected: member of an i2c_driver.clients list or i2c-core's
 *	userspace_devices list
D
David Brownell 已提交
213 214
 *
 * An i2c_client identifies a single device (i.e. chip) connected to an
D
David Brownell 已提交
215 216
 * i2c bus. The behaviour exposed to Linux is defined by the driver
 * managing the device.
L
Linus Torvalds 已提交
217 218
 */
struct i2c_client {
D
David Brownell 已提交
219
	unsigned short flags;		/* div., see below		*/
D
David Brownell 已提交
220
	unsigned short addr;		/* chip address - NOTE: 7bit	*/
L
Linus Torvalds 已提交
221
					/* addresses are stored in the	*/
222
					/* _LOWER_ 7 bits		*/
D
David Brownell 已提交
223
	char name[I2C_NAME_SIZE];
L
Linus Torvalds 已提交
224 225 226
	struct i2c_adapter *adapter;	/* the adapter we sit on	*/
	struct i2c_driver *driver;	/* and our access routines	*/
	struct device dev;		/* the device structure		*/
227
	int irq;			/* irq issued by device		*/
228
	struct list_head detected;
L
Linus Torvalds 已提交
229 230 231
};
#define to_i2c_client(d) container_of(d, struct i2c_client, dev)

232 233
extern struct i2c_client *i2c_verify_client(struct device *dev);

234 235
static inline struct i2c_client *kobj_to_i2c_client(struct kobject *kobj)
{
236 237
	struct device * const dev = container_of(kobj, struct device, kobj);
	return to_i2c_client(dev);
238 239
}

240
static inline void *i2c_get_clientdata(const struct i2c_client *dev)
L
Linus Torvalds 已提交
241
{
J
Jean Delvare 已提交
242
	return dev_get_drvdata(&dev->dev);
L
Linus Torvalds 已提交
243 244
}

J
Jean Delvare 已提交
245
static inline void i2c_set_clientdata(struct i2c_client *dev, void *data)
L
Linus Torvalds 已提交
246
{
J
Jean Delvare 已提交
247
	dev_set_drvdata(&dev->dev, data);
L
Linus Torvalds 已提交
248 249
}

250 251
/**
 * struct i2c_board_info - template for device creation
252
 * @type: chip type, to initialize i2c_client.name
253 254 255
 * @flags: to initialize i2c_client.flags
 * @addr: stored in i2c_client.addr
 * @platform_data: stored in i2c_client.dev.platform_data
A
Anton Vorontsov 已提交
256
 * @archdata: copied into i2c_client.dev.archdata
R
Randy Dunlap 已提交
257
 * @of_node: pointer to OpenFirmware device node
258
 * @irq: stored in i2c_client.irq
D
David Brownell 已提交
259
 *
260 261 262 263 264 265
 * I2C doesn't actually support hardware probing, although controllers and
 * devices may be able to use I2C_SMBUS_QUICK to tell whether or not there's
 * a device at a given address.  Drivers commonly need more information than
 * that, such as chip type, configuration, associated IRQ, and so on.
 *
 * i2c_board_info is used to build tables of information listing I2C devices
266 267 268 269
 * that are present.  This information is used to grow the driver model tree.
 * For mainboards this is done statically using i2c_register_board_info();
 * bus numbers identify adapters that aren't yet available.  For add-on boards,
 * i2c_new_device() does this dynamically with the adapter already known.
270 271 272 273 274 275
 */
struct i2c_board_info {
	char		type[I2C_NAME_SIZE];
	unsigned short	flags;
	unsigned short	addr;
	void		*platform_data;
A
Anton Vorontsov 已提交
276
	struct dev_archdata	*archdata;
277
	struct device_node *of_node;
278 279 280 281
	int		irq;
};

/**
282 283
 * I2C_BOARD_INFO - macro used to list an i2c device and its address
 * @dev_type: identifies the device type
284 285 286 287
 * @dev_addr: the device's address on the bus.
 *
 * This macro initializes essential fields of a struct i2c_board_info,
 * declaring what has been provided on a particular board.  Optional
288 289
 * fields (such as associated irq, or device-specific platform_data)
 * are provided using conventional syntax.
290
 */
J
Jean Delvare 已提交
291
#define I2C_BOARD_INFO(dev_type, dev_addr) \
292
	.type = dev_type, .addr = (dev_addr)
293 294


295
#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
296 297 298 299 300 301 302
/* Add-on boards should register/unregister their devices; e.g. a board
 * with integrated I2C, a config eeprom, sensors, and a codec that's
 * used in conjunction with the primary hardware.
 */
extern struct i2c_client *
i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);

J
Jean Delvare 已提交
303 304
/* If you don't know the exact address of an I2C device, use this variant
 * instead, which can probe for device presence in a list of possible
305 306 307
 * addresses. The "probe" callback function is optional. If it is provided,
 * it must return 1 on successful probe, 0 otherwise. If it is not provided,
 * a default probing method is used.
J
Jean Delvare 已提交
308 309 310 311
 */
extern struct i2c_client *
i2c_new_probed_device(struct i2c_adapter *adap,
		      struct i2c_board_info *info,
312 313
		      unsigned short const *addr_list,
		      int (*probe)(struct i2c_adapter *, unsigned short addr));
J
Jean Delvare 已提交
314

315 316 317
/* Common custom probe functions */
extern int i2c_probe_func_quick_read(struct i2c_adapter *, unsigned short addr);

318 319 320 321
/* For devices that use several addresses, use i2c_new_dummy() to make
 * client handles for the extra addresses.
 */
extern struct i2c_client *
J
Jean Delvare 已提交
322
i2c_new_dummy(struct i2c_adapter *adap, u16 address);
323

324
extern void i2c_unregister_device(struct i2c_client *);
325
#endif /* I2C */
326 327 328 329 330

/* Mainboard arch_initcall() code should register all its I2C devices.
 * This is done at arch_initcall time, before declaring any i2c adapters.
 * Modules for add-on boards must use other calls.
 */
331
#ifdef CONFIG_I2C_BOARDINFO
332
extern int
J
Jean Delvare 已提交
333 334
i2c_register_board_info(int busnum, struct i2c_board_info const *info,
			unsigned n);
335 336
#else
static inline int
J
Jean Delvare 已提交
337 338
i2c_register_board_info(int busnum, struct i2c_board_info const *info,
			unsigned n)
339 340 341
{
	return 0;
}
342
#endif /* I2C_BOARDINFO */
343

L
Linus Torvalds 已提交
344 345 346 347 348 349 350 351
/*
 * The following structs are for those who like to implement new bus drivers:
 * i2c_algorithm is the interface to a class of hardware solutions which can
 * be addressed using the same bus algorithms - i.e. bit-banging or the PCF8584
 * to name two of the most common.
 */
struct i2c_algorithm {
	/* If an adapter algorithm can't do I2C-level access, set master_xfer
D
David Brownell 已提交
352
	   to NULL. If an adapter algorithm can do SMBus access, set
L
Linus Torvalds 已提交
353 354
	   smbus_xfer. If set to NULL, the SMBus protocol is simulated
	   using common I2C messages */
355 356
	/* master_xfer should return the number of messages successfully
	   processed, or a negative value on error */
J
Jean Delvare 已提交
357 358
	int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
			   int num);
D
David Brownell 已提交
359
	int (*smbus_xfer) (struct i2c_adapter *adap, u16 addr,
J
Jean Delvare 已提交
360 361
			   unsigned short flags, char read_write,
			   u8 command, int size, union i2c_smbus_data *data);
L
Linus Torvalds 已提交
362 363 364 365 366 367 368 369 370 371 372

	/* To determine what the adapter supports */
	u32 (*functionality) (struct i2c_adapter *);
};

/*
 * i2c_adapter is the structure used to identify a physical i2c bus along
 * with the access algorithms necessary to access it.
 */
struct i2c_adapter {
	struct module *owner;
373
	unsigned int class;		  /* classes to allow probing for */
374
	const struct i2c_algorithm *algo; /* the algorithm to access the bus */
L
Linus Torvalds 已提交
375 376 377
	void *algo_data;

	/* data fields that are valid for all devices	*/
378
	struct rt_mutex bus_lock;
L
Linus Torvalds 已提交
379

380
	int timeout;			/* in jiffies */
L
Linus Torvalds 已提交
381 382 383 384
	int retries;
	struct device dev;		/* the adapter device */

	int nr;
D
David Brownell 已提交
385
	char name[48];
L
Linus Torvalds 已提交
386
	struct completion dev_released;
387

388
	struct mutex userspace_clients_lock;
389
	struct list_head userspace_clients;
L
Linus Torvalds 已提交
390
};
391
#define to_i2c_adapter(d) container_of(d, struct i2c_adapter, dev)
L
Linus Torvalds 已提交
392

393
static inline void *i2c_get_adapdata(const struct i2c_adapter *dev)
L
Linus Torvalds 已提交
394
{
J
Jean Delvare 已提交
395
	return dev_get_drvdata(&dev->dev);
L
Linus Torvalds 已提交
396 397
}

J
Jean Delvare 已提交
398
static inline void i2c_set_adapdata(struct i2c_adapter *dev, void *data)
L
Linus Torvalds 已提交
399
{
J
Jean Delvare 已提交
400
	dev_set_drvdata(&dev->dev, data);
L
Linus Torvalds 已提交
401 402
}

403 404
static inline struct i2c_adapter *
i2c_parent_is_i2c_adapter(const struct i2c_adapter *adapter)
405
{
406 407 408 409 410 411
	struct device *parent = adapter->dev.parent;

	if (parent != NULL && parent->type == &i2c_adapter_type)
		return to_i2c_adapter(parent);
	else
		return NULL;
412 413
}

J
Jean Delvare 已提交
414 415
int i2c_for_each_dev(void *data, int (*fn)(struct device *, void *));

416 417 418
/* Adapter locking functions, exported for shared pin cases */
void i2c_lock_adapter(struct i2c_adapter *);
void i2c_unlock_adapter(struct i2c_adapter *);
419

L
Linus Torvalds 已提交
420
/*flags for the client struct: */
421 422 423 424
#define I2C_CLIENT_PEC	0x04		/* Use Packet Error Checking */
#define I2C_CLIENT_TEN	0x10		/* we have a ten bit chip address */
					/* Must equal I2C_M_TEN below */
#define I2C_CLIENT_WAKE	0x80		/* for board_info; true iff can wake */
L
Linus Torvalds 已提交
425 426 427

/* i2c adapter classes (bitmask) */
#define I2C_CLASS_HWMON		(1<<0)	/* lm_sensors, ... */
428
#define I2C_CLASS_DDC		(1<<3)	/* DDC bus on graphics adapters */
429
#define I2C_CLASS_SPD		(1<<7)	/* Memory modules */
L
Linus Torvalds 已提交
430 431 432 433 434 435 436

/* Internal numbers to terminate lists */
#define I2C_CLIENT_END		0xfffeU

/* The numbers to use to set I2C bus address */
#define ANY_I2C_BUS		0xffff

437 438 439 440
/* Construct an I2C_CLIENT_END-terminated array of i2c addresses */
#define I2C_ADDRS(addr, addrs...) \
	((const unsigned short []){ addr, ## addrs, I2C_CLIENT_END })

L
Linus Torvalds 已提交
441 442 443 444 445

/* ----- functions exported by i2c.o */

/* administration...
 */
446
#if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
L
Linus Torvalds 已提交
447 448
extern int i2c_add_adapter(struct i2c_adapter *);
extern int i2c_del_adapter(struct i2c_adapter *);
449
extern int i2c_add_numbered_adapter(struct i2c_adapter *);
L
Linus Torvalds 已提交
450

451
extern int i2c_register_driver(struct module *, struct i2c_driver *);
452
extern void i2c_del_driver(struct i2c_driver *);
L
Linus Torvalds 已提交
453

454 455 456 457 458
static inline int i2c_add_driver(struct i2c_driver *driver)
{
	return i2c_register_driver(THIS_MODULE, driver);
}

459 460
extern struct i2c_client *i2c_use_client(struct i2c_client *client);
extern void i2c_release_client(struct i2c_client *client);
L
Linus Torvalds 已提交
461 462 463 464 465 466

/* call the i2c_client->command() of all attached clients with
 * the given arguments */
extern void i2c_clients_command(struct i2c_adapter *adap,
				unsigned int cmd, void *arg);

467
extern struct i2c_adapter *i2c_get_adapter(int nr);
L
Linus Torvalds 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
extern void i2c_put_adapter(struct i2c_adapter *adap);


/* Return the functionality mask */
static inline u32 i2c_get_functionality(struct i2c_adapter *adap)
{
	return adap->algo->functionality(adap);
}

/* Return 1 if adapter supports everything we need, 0 if not. */
static inline int i2c_check_functionality(struct i2c_adapter *adap, u32 func)
{
	return (func & i2c_get_functionality(adap)) == func;
}

J
Jean Delvare 已提交
483
/* Return the adapter number for a specific adapter */
484 485 486 487
static inline int i2c_adapter_id(struct i2c_adapter *adap)
{
	return adap->nr;
}
488
#endif /* I2C */
489
#endif /* __KERNEL__ */
490

D
David Brownell 已提交
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
/**
 * struct i2c_msg - an I2C transaction segment beginning with START
 * @addr: Slave address, either seven or ten bits.  When this is a ten
 *	bit address, I2C_M_TEN must be set in @flags and the adapter
 *	must support I2C_FUNC_10BIT_ADDR.
 * @flags: I2C_M_RD is handled by all adapters.  No other flags may be
 *	provided unless the adapter exported the relevant I2C_FUNC_*
 *	flags through i2c_check_functionality().
 * @len: Number of data bytes in @buf being read from or written to the
 *	I2C slave address.  For read transactions where I2C_M_RECV_LEN
 *	is set, the caller guarantees that this buffer can hold up to
 *	32 bytes in addition to the initial length byte sent by the
 *	slave (plus, if used, the SMBus PEC); and this value will be
 *	incremented by the number of block data bytes received.
 * @buf: The buffer into which data is read, or from which it's written.
 *
 * An i2c_msg is the low level representation of one segment of an I2C
 * transaction.  It is visible to drivers in the @i2c_transfer() procedure,
 * to userspace from i2c-dev, and to I2C adapter drivers through the
 * @i2c_adapter.@master_xfer() method.
 *
 * Except when I2C "protocol mangling" is used, all I2C adapters implement
 * the standard rules for I2C transactions.  Each transaction begins with a
 * START.  That is followed by the slave address, and a bit encoding read
 * versus write.  Then follow all the data bytes, possibly including a byte
 * with SMBus PEC.  The transfer terminates with a NAK, or when all those
 * bytes have been transferred and ACKed.  If this is the last message in a
 * group, it is followed by a STOP.  Otherwise it is followed by the next
 * @i2c_msg transaction segment, beginning with a (repeated) START.
 *
 * Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then
 * passing certain @flags may have changed those standard protocol behaviors.
 * Those flags are only for use with broken/nonconforming slaves, and with
 * adapters which are known to support the specific mangling options they
 * need (one or more of IGNORE_NAK, NO_RD_ACK, NOSTART, and REV_DIR_ADDR).
L
Linus Torvalds 已提交
526 527 528
 */
struct i2c_msg {
	__u16 addr;	/* slave address			*/
D
David Brownell 已提交
529
	__u16 flags;
D
David Brownell 已提交
530 531 532 533 534 535 536
#define I2C_M_TEN		0x0010	/* this is a ten bit chip address */
#define I2C_M_RD		0x0001	/* read data, from slave to master */
#define I2C_M_NOSTART		0x4000	/* if I2C_FUNC_PROTOCOL_MANGLING */
#define I2C_M_REV_DIR_ADDR	0x2000	/* if I2C_FUNC_PROTOCOL_MANGLING */
#define I2C_M_IGNORE_NAK	0x1000	/* if I2C_FUNC_PROTOCOL_MANGLING */
#define I2C_M_NO_RD_ACK		0x0800	/* if I2C_FUNC_PROTOCOL_MANGLING */
#define I2C_M_RECV_LEN		0x0400	/* length will be first received byte */
D
David Brownell 已提交
537 538
	__u16 len;		/* msg length				*/
	__u8 *buf;		/* pointer to msg data			*/
L
Linus Torvalds 已提交
539 540 541 542 543 544
};

/* To determine what functionality is present */

#define I2C_FUNC_I2C			0x00000001
#define I2C_FUNC_10BIT_ADDR		0x00000002
J
Jean Delvare 已提交
545
#define I2C_FUNC_PROTOCOL_MANGLING	0x00000004 /* I2C_M_NOSTART etc. */
546
#define I2C_FUNC_SMBUS_PEC		0x00000008
L
Linus Torvalds 已提交
547
#define I2C_FUNC_SMBUS_BLOCK_PROC_CALL	0x00008000 /* SMBus 2.0 */
D
David Brownell 已提交
548 549 550 551 552 553 554 555 556 557
#define I2C_FUNC_SMBUS_QUICK		0x00010000
#define I2C_FUNC_SMBUS_READ_BYTE	0x00020000
#define I2C_FUNC_SMBUS_WRITE_BYTE	0x00040000
#define I2C_FUNC_SMBUS_READ_BYTE_DATA	0x00080000
#define I2C_FUNC_SMBUS_WRITE_BYTE_DATA	0x00100000
#define I2C_FUNC_SMBUS_READ_WORD_DATA	0x00200000
#define I2C_FUNC_SMBUS_WRITE_WORD_DATA	0x00400000
#define I2C_FUNC_SMBUS_PROC_CALL	0x00800000
#define I2C_FUNC_SMBUS_READ_BLOCK_DATA	0x01000000
#define I2C_FUNC_SMBUS_WRITE_BLOCK_DATA 0x02000000
L
Linus Torvalds 已提交
558 559 560
#define I2C_FUNC_SMBUS_READ_I2C_BLOCK	0x04000000 /* I2C-like block xfer  */
#define I2C_FUNC_SMBUS_WRITE_I2C_BLOCK	0x08000000 /* w/ 1-byte reg. addr. */

J
Jean Delvare 已提交
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
#define I2C_FUNC_SMBUS_BYTE		(I2C_FUNC_SMBUS_READ_BYTE | \
					 I2C_FUNC_SMBUS_WRITE_BYTE)
#define I2C_FUNC_SMBUS_BYTE_DATA	(I2C_FUNC_SMBUS_READ_BYTE_DATA | \
					 I2C_FUNC_SMBUS_WRITE_BYTE_DATA)
#define I2C_FUNC_SMBUS_WORD_DATA	(I2C_FUNC_SMBUS_READ_WORD_DATA | \
					 I2C_FUNC_SMBUS_WRITE_WORD_DATA)
#define I2C_FUNC_SMBUS_BLOCK_DATA	(I2C_FUNC_SMBUS_READ_BLOCK_DATA | \
					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA)
#define I2C_FUNC_SMBUS_I2C_BLOCK	(I2C_FUNC_SMBUS_READ_I2C_BLOCK | \
					 I2C_FUNC_SMBUS_WRITE_I2C_BLOCK)

#define I2C_FUNC_SMBUS_EMUL		(I2C_FUNC_SMBUS_QUICK | \
					 I2C_FUNC_SMBUS_BYTE | \
					 I2C_FUNC_SMBUS_BYTE_DATA | \
					 I2C_FUNC_SMBUS_WORD_DATA | \
					 I2C_FUNC_SMBUS_PROC_CALL | \
					 I2C_FUNC_SMBUS_WRITE_BLOCK_DATA | \
					 I2C_FUNC_SMBUS_I2C_BLOCK | \
					 I2C_FUNC_SMBUS_PEC)
L
Linus Torvalds 已提交
580

D
David Brownell 已提交
581 582
/*
 * Data for SMBus Messages
L
Linus Torvalds 已提交
583
 */
D
David Brownell 已提交
584
#define I2C_SMBUS_BLOCK_MAX	32	/* As specified in SMBus standard */
L
Linus Torvalds 已提交
585 586 587
union i2c_smbus_data {
	__u8 byte;
	__u16 word;
588
	__u8 block[I2C_SMBUS_BLOCK_MAX + 2]; /* block[0] is used for length */
J
Jean Delvare 已提交
589
			       /* and one more for user-space compatibility */
L
Linus Torvalds 已提交
590 591
};

592
/* i2c_smbus_xfer read or write markers */
L
Linus Torvalds 已提交
593 594 595
#define I2C_SMBUS_READ	1
#define I2C_SMBUS_WRITE	0

D
David Brownell 已提交
596
/* SMBus transaction types (size parameter in the above functions)
L
Linus Torvalds 已提交
597 598 599
   Note: these no longer correspond to the (arbitrary) PIIX4 internal codes! */
#define I2C_SMBUS_QUICK		    0
#define I2C_SMBUS_BYTE		    1
D
David Brownell 已提交
600
#define I2C_SMBUS_BYTE_DATA	    2
L
Linus Torvalds 已提交
601 602 603
#define I2C_SMBUS_WORD_DATA	    3
#define I2C_SMBUS_PROC_CALL	    4
#define I2C_SMBUS_BLOCK_DATA	    5
604
#define I2C_SMBUS_I2C_BLOCK_BROKEN  6
L
Linus Torvalds 已提交
605
#define I2C_SMBUS_BLOCK_PROC_CALL   7		/* SMBus 2.0 */
606
#define I2C_SMBUS_I2C_BLOCK_DATA    8
L
Linus Torvalds 已提交
607 608

#endif /* _LINUX_I2C_H */