Documentation/i2c/smbus-protocol.rst

   1 ==================
   2 The SMBus Protocol
   3 ==================
   4
   5 The following is a summary of the SMBus protocol. It applies to
   6 all revisions of the protocol (1.0, 1.1, and 2.0).
   7 Certain protocol features which are not supported by
   8 this package are briefly described at the end of this document.
   9
  10 Some adapters understand only the SMBus (System Management Bus) protocol,
  11 which is a subset from the I2C protocol. Fortunately, many devices use
  12 only the same subset, which makes it possible to put them on an SMBus.
  13
  14 If you write a driver for some I2C device, please try to use the SMBus
  15 commands if at all possible (if the device uses only that subset of the
  16 I2C protocol). This makes it possible to use the device driver on both
  17 SMBus adapters and I2C adapters (the SMBus command set is automatically
  18 translated to I2C on I2C adapters, but plain I2C commands can not be
  19 handled at all on most pure SMBus adapters).
  20
  21 Below is a list of SMBus protocol operations, and the functions executing
  22 them.  Note that the names used in the SMBus protocol specifications usually
  23 don't match these function names.  For some of the operations which pass a
  24 single data byte, the functions using SMBus protocol operation names execute
  25 a different protocol operation entirely.
  26
  27 Each transaction type corresponds to a functionality flag. Before calling a
  28 transaction function, a device driver should always check (just once) for
  29 the corresponding functionality flag to ensure that the underlying I2C
  30 adapter supports the transaction in question. See :doc:`functionality` for
  31 the details.
  32
  33
  34 Key to symbols
  35 ==============
  36
  37 =============== =============================================================
  38 S               Start condition
  39 P               Stop condition
  40 Rd/Wr (1 bit)   Read/Write bit. Rd equals 1, Wr equals 0.
  41 A, NA (1 bit)   Acknowledge (ACK) and Not Acknowledge (NACK) bit
  42 Addr  (7 bits)  I2C 7 bit address. Note that this can be expanded as usual to
  43                 get a 10 bit I2C address.
  44 Comm  (8 bits)  Command byte, a data byte which often selects a register on
  45                 the device.
  46 Data  (8 bits)  A plain data byte. Sometimes, I write DataLow, DataHigh
  47                 for 16 bit data.
  48 Count (8 bits)  A data byte containing the length of a block operation.
  49
  50 [..]            Data sent by I2C device, as opposed to data sent by the host
  51                 adapter.
  52 =============== =============================================================
  53
  54
  55 SMBus Quick Command
  56 ===================
  57
  58 This sends a single bit to the device, at the place of the Rd/Wr bit::
  59
  60   S Addr Rd/Wr [A] P
  61
  62 Functionality flag: I2C_FUNC_SMBUS_QUICK
  63
  64
  65 SMBus Receive Byte
  66 ==================
  67
  68 Implemented by i2c_smbus_read_byte()
  69
  70 This reads a single byte from a device, without specifying a device
  71 register. Some devices are so simple that this interface is enough; for
  72 others, it is a shorthand if you want to read the same register as in
  73 the previous SMBus command::
  74
  75   S Addr Rd [A] [Data] NA P
  76
  77 Functionality flag: I2C_FUNC_SMBUS_READ_BYTE
  78
  79
  80 SMBus Send Byte
  81 ===============
  82
  83 Implemented by i2c_smbus_write_byte()
  84
  85 This operation is the reverse of Receive Byte: it sends a single byte
  86 to a device.  See Receive Byte for more information.
  87
  88 ::
  89
  90   S Addr Wr [A] Data [A] P
  91
  92 Functionality flag: I2C_FUNC_SMBUS_WRITE_BYTE
  93
  94
  95 SMBus Read Byte
  96 ===============
  97
  98 Implemented by i2c_smbus_read_byte_data()
  99
 100 This reads a single byte from a device, from a designated register.
 101 The register is specified through the Comm byte::
 102
 103   S Addr Wr [A] Comm [A] S Addr Rd [A] [Data] NA P
 104
 105 Functionality flag: I2C_FUNC_SMBUS_READ_BYTE_DATA
 106
 107
 108 SMBus Read Word
 109 ===============
 110
 111 Implemented by i2c_smbus_read_word_data()
 112
 113 This operation is very like Read Byte; again, data is read from a
 114 device, from a designated register that is specified through the Comm
 115 byte. But this time, the data is a complete word (16 bits)::
 116
 117   S Addr Wr [A] Comm [A] S Addr Rd [A] [DataLow] A [DataHigh] NA P
 118
 119 Functionality flag: I2C_FUNC_SMBUS_READ_WORD_DATA
 120
 121 Note the convenience function i2c_smbus_read_word_swapped() is
 122 available for reads where the two data bytes are the other way
 123 around (not SMBus compliant, but very popular.)
 124
 125
 126 SMBus Write Byte
 127 ================
 128
 129 Implemented by i2c_smbus_write_byte_data()
 130
 131 This writes a single byte to a device, to a designated register. The
 132 register is specified through the Comm byte. This is the opposite of
 133 the Read Byte operation.
 134
 135 ::
 136
 137   S Addr Wr [A] Comm [A] Data [A] P
 138
 139 Functionality flag: I2C_FUNC_SMBUS_WRITE_BYTE_DATA
 140
 141
 142 SMBus Write Word
 143 ================
 144
 145 Implemented by i2c_smbus_write_word_data()
 146
 147 This is the opposite of the Read Word operation. 16 bits
 148 of data are written to a device, to the designated register that is
 149 specified through the Comm byte::
 150
 151   S Addr Wr [A] Comm [A] DataLow [A] DataHigh [A] P
 152
 153 Functionality flag: I2C_FUNC_SMBUS_WRITE_WORD_DATA
 154
 155 Note the convenience function i2c_smbus_write_word_swapped() is
 156 available for writes where the two data bytes are the other way
 157 around (not SMBus compliant, but very popular.)
 158
 159
 160 SMBus Process Call
 161 ==================
 162
 163 This command selects a device register (through the Comm byte), sends
 164 16 bits of data to it, and reads 16 bits of data in return::
 165
 166   S Addr Wr [A] Comm [A] DataLow [A] DataHigh [A]
 167                                S Addr Rd [A] [DataLow] A [DataHigh] NA P
 168
 169 Functionality flag: I2C_FUNC_SMBUS_PROC_CALL
 170
 171
 172 SMBus Block Read
 173 ================
 174
 175 Implemented by i2c_smbus_read_block_data()
 176
 177 This command reads a block of up to 32 bytes from a device, from a
 178 designated register that is specified through the Comm byte. The amount
 179 of data is specified by the device in the Count byte.
 180
 181 ::
 182
 183   S Addr Wr [A] Comm [A]
 184              S Addr Rd [A] [Count] A [Data] A [Data] A ... A [Data] NA P
 185
 186 Functionality flag: I2C_FUNC_SMBUS_READ_BLOCK_DATA
 187
 188
 189 SMBus Block Write
 190 =================
 191
 192 Implemented by i2c_smbus_write_block_data()
 193
 194 The opposite of the Block Read command, this writes up to 32 bytes to
 195 a device, to a designated register that is specified through the
 196 Comm byte. The amount of data is specified in the Count byte.
 197
 198 ::
 199
 200   S Addr Wr [A] Comm [A] Count [A] Data [A] Data [A] ... [A] Data [A] P
 201
 202 Functionality flag: I2C_FUNC_SMBUS_WRITE_BLOCK_DATA
 203
 204
 205 SMBus Block Write - Block Read Process Call
 206 ===========================================
 207
 208 SMBus Block Write - Block Read Process Call was introduced in
 209 Revision 2.0 of the specification.
 210
 211 This command selects a device register (through the Comm byte), sends
 212 1 to 31 bytes of data to it, and reads 1 to 31 bytes of data in return::
 213
 214   S Addr Wr [A] Comm [A] Count [A] Data [A] ...
 215                                S Addr Rd [A] [Count] A [Data] ... A P
 216
 217 Functionality flag: I2C_FUNC_SMBUS_BLOCK_PROC_CALL
 218
 219
 220 SMBus Host Notify
 221 =================
 222
 223 This command is sent from a SMBus device acting as a master to the
 224 SMBus host acting as a slave.
 225 It is the same form as Write Word, with the command code replaced by the
 226 alerting device's address.
 227
 228 ::
 229
 230   [S] [HostAddr] [Wr] A [DevAddr] A [DataLow] A [DataHigh] A [P]
 231
 232 This is implemented in the following way in the Linux kernel:
 233
 234 * I2C bus drivers which support SMBus Host Notify should report
 235   I2C_FUNC_SMBUS_HOST_NOTIFY.
 236 * I2C bus drivers trigger SMBus Host Notify by a call to
 237   i2c_handle_smbus_host_notify().
 238 * I2C drivers for devices which can trigger SMBus Host Notify will have
 239   client->irq assigned to a Host Notify IRQ if noone else specified an other.
 240
 241 There is currently no way to retrieve the data parameter from the client.
 242
 243
 244 Packet Error Checking (PEC)
 245 ===========================
 246
 247 Packet Error Checking was introduced in Revision 1.1 of the specification.
 248
 249 PEC adds a CRC-8 error-checking byte to transfers using it, immediately
 250 before the terminating STOP.
 251
 252
 253 Address Resolution Protocol (ARP)
 254 =================================
 255
 256 The Address Resolution Protocol was introduced in Revision 2.0 of
 257 the specification. It is a higher-layer protocol which uses the
 258 messages above.
 259
 260 ARP adds device enumeration and dynamic address assignment to
 261 the protocol. All ARP communications use slave address 0x61 and
 262 require PEC checksums.
 263
 264
 265 SMBus Alert
 266 ===========
 267
 268 SMBus Alert was introduced in Revision 1.0 of the specification.
 269
 270 The SMBus alert protocol allows several SMBus slave devices to share a
 271 single interrupt pin on the SMBus master, while still allowing the master
 272 to know which slave triggered the interrupt.
 273
 274 This is implemented the following way in the Linux kernel:
 275
 276 * I2C bus drivers which support SMBus alert should call
 277   i2c_new_smbus_alert_device() to install SMBus alert support.
 278 * I2C drivers for devices which can trigger SMBus alerts should implement
 279   the optional alert() callback.
 280
 281
 282 I2C Block Transactions
 283 ======================
 284
 285 The following I2C block transactions are similar to the SMBus Block Read
 286 and Write operations, except these do not have a Count byte. They are
 287 supported by the SMBus layer and are described here for completeness, but
 288 they are *NOT* defined by the SMBus specification.
 289
 290 I2C block transactions do not limit the number of bytes transferred
 291 but the SMBus layer places a limit of 32 bytes.
 292
 293
 294 I2C Block Read
 295 ==============
 296
 297 Implemented by i2c_smbus_read_i2c_block_data()
 298
 299 This command reads a block of bytes from a device, from a
 300 designated register that is specified through the Comm byte::
 301
 302   S Addr Wr [A] Comm [A]
 303              S Addr Rd [A] [Data] A [Data] A ... A [Data] NA P
 304
 305 Functionality flag: I2C_FUNC_SMBUS_READ_I2C_BLOCK
 306
 307
 308 I2C Block Write
 309 ===============
 310
 311 Implemented by i2c_smbus_write_i2c_block_data()
 312
 313 The opposite of the Block Read command, this writes bytes to
 314 a device, to a designated register that is specified through the
 315 Comm byte. Note that command lengths of 0, 2, or more bytes are
 316 supported as they are indistinguishable from data.
 317
 318 ::
 319
 320   S Addr Wr [A] Comm [A] Data [A] Data [A] ... [A] Data [A] P
 321
 322 Functionality flag: I2C_FUNC_SMBUS_WRITE_I2C_BLOCK