Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
i2c_msg Struct Reference

#include <i2c.h>

Data Fields

__u16 addr
__u16 flags
__u16 len

Detailed Description

struct i2c_msg - an I2C transaction segment beginning with START : Slave address, either seven or ten bits. When this is a ten bit address, I2C_M_TEN must be set in and the adapter must support I2C_FUNC_10BIT_ADDR. : 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(). : Number of data bytes in 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. : 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 () procedure, to userspace from i2c-dev, and to I2C adapter drivers through the .() 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 transaction segment, beginning with a (repeated) START.

Alternatively, when the adapter supports I2C_FUNC_PROTOCOL_MANGLING then passing certain 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).

Definition at line 68 of file i2c.h.

Field Documentation

__u16 addr

Definition at line 69 of file i2c.h.

Definition at line 80 of file i2c.h.

__u16 flags

Definition at line 70 of file i2c.h.

__u16 len

Definition at line 79 of file i2c.h.

The documentation for this struct was generated from the following file: