1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Linux I2C core SMBus and SMBus emulation code
5 * This file contains the SMBus functions which are always included in the I2C
6 * core because they can be emulated via I2C. SMBus specific extensions
7 * (e.g. smbalert) are handled in a separate i2c-smbus module.
13 #include <linux/device.h>
14 #include <linux/err.h>
15 #include <linux/i2c.h>
16 #include <linux/i2c-smbus.h>
17 #include <linux/slab.h>
21 #define CREATE_TRACE_POINTS
22 #include <trace/events/smbus.h>
27 #define POLY (0x1070U << 3)
28 static u8 crc8(u16 data)
32 for (i = 0; i < 8; i++) {
37 return (u8)(data >> 8);
41 * i2c_smbus_pec - Incremental CRC8 over the given input data array
42 * @crc: previous return crc8 value
43 * @p: pointer to data buffer.
44 * @count: number of bytes in data buffer.
46 * Incremental CRC8 over count bytes in the array pointed to by p
48 u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
52 for (i = 0; i < count; i++)
53 crc = crc8((crc ^ p[i]) << 8);
56 EXPORT_SYMBOL(i2c_smbus_pec);
58 /* Assume a 7-bit address, which is reasonable for SMBus */
59 static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
61 /* The address will be sent first */
62 u8 addr = i2c_8bit_addr_from_msg(msg);
63 pec = i2c_smbus_pec(pec, &addr, 1);
65 /* The data buffer follows */
66 return i2c_smbus_pec(pec, msg->buf, msg->len);
69 /* Used for write only transactions */
70 static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
72 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
76 /* Return <0 on CRC error
77 If there was a write before this read (most cases) we need to take the
78 partial CRC from the write part into account.
79 Note that this function does modify the message (we need to decrease the
80 message length to hide the CRC byte from the caller). */
81 static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
83 u8 rpec = msg->buf[--msg->len];
84 cpec = i2c_smbus_msg_pec(cpec, msg);
87 pr_debug("Bad PEC 0x%02x vs. 0x%02x\n",
95 * i2c_smbus_read_byte - SMBus "receive byte" protocol
96 * @client: Handle to slave device
98 * This executes the SMBus "receive byte" protocol, returning negative errno
99 * else the byte received from the device.
101 s32 i2c_smbus_read_byte(const struct i2c_client *client)
103 union i2c_smbus_data data;
106 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
108 I2C_SMBUS_BYTE, &data);
109 return (status < 0) ? status : data.byte;
111 EXPORT_SYMBOL(i2c_smbus_read_byte);
114 * i2c_smbus_write_byte - SMBus "send byte" protocol
115 * @client: Handle to slave device
116 * @value: Byte to be sent
118 * This executes the SMBus "send byte" protocol, returning negative errno
119 * else zero on success.
121 s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
123 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
124 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
126 EXPORT_SYMBOL(i2c_smbus_write_byte);
129 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
130 * @client: Handle to slave device
131 * @command: Byte interpreted by slave
133 * This executes the SMBus "read byte" protocol, returning negative errno
134 * else a data byte received from the device.
136 s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
138 union i2c_smbus_data data;
141 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
142 I2C_SMBUS_READ, command,
143 I2C_SMBUS_BYTE_DATA, &data);
144 return (status < 0) ? status : data.byte;
146 EXPORT_SYMBOL(i2c_smbus_read_byte_data);
149 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
150 * @client: Handle to slave device
151 * @command: Byte interpreted by slave
152 * @value: Byte being written
154 * This executes the SMBus "write byte" protocol, returning negative errno
155 * else zero on success.
157 s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
160 union i2c_smbus_data data;
162 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
163 I2C_SMBUS_WRITE, command,
164 I2C_SMBUS_BYTE_DATA, &data);
166 EXPORT_SYMBOL(i2c_smbus_write_byte_data);
169 * i2c_smbus_read_word_data - SMBus "read word" protocol
170 * @client: Handle to slave device
171 * @command: Byte interpreted by slave
173 * This executes the SMBus "read word" protocol, returning negative errno
174 * else a 16-bit unsigned "word" received from the device.
176 s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
178 union i2c_smbus_data data;
181 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
182 I2C_SMBUS_READ, command,
183 I2C_SMBUS_WORD_DATA, &data);
184 return (status < 0) ? status : data.word;
186 EXPORT_SYMBOL(i2c_smbus_read_word_data);
189 * i2c_smbus_write_word_data - SMBus "write word" protocol
190 * @client: Handle to slave device
191 * @command: Byte interpreted by slave
192 * @value: 16-bit "word" being written
194 * This executes the SMBus "write word" protocol, returning negative errno
195 * else zero on success.
197 s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
200 union i2c_smbus_data data;
202 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
203 I2C_SMBUS_WRITE, command,
204 I2C_SMBUS_WORD_DATA, &data);
206 EXPORT_SYMBOL(i2c_smbus_write_word_data);
209 * i2c_smbus_read_block_data - SMBus "block read" protocol
210 * @client: Handle to slave device
211 * @command: Byte interpreted by slave
212 * @values: Byte array into which data will be read; big enough to hold
213 * the data returned by the slave. SMBus allows at most 32 bytes.
215 * This executes the SMBus "block read" protocol, returning negative errno
216 * else the number of data bytes in the slave's response.
218 * Note that using this function requires that the client's adapter support
219 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
220 * support this; its emulation through I2C messaging relies on a specific
221 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
223 s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
226 union i2c_smbus_data data;
229 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
230 I2C_SMBUS_READ, command,
231 I2C_SMBUS_BLOCK_DATA, &data);
235 memcpy(values, &data.block[1], data.block[0]);
236 return data.block[0];
238 EXPORT_SYMBOL(i2c_smbus_read_block_data);
241 * i2c_smbus_write_block_data - SMBus "block write" protocol
242 * @client: Handle to slave device
243 * @command: Byte interpreted by slave
244 * @length: Size of data block; SMBus allows at most 32 bytes
245 * @values: Byte array which will be written.
247 * This executes the SMBus "block write" protocol, returning negative errno
248 * else zero on success.
250 s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
251 u8 length, const u8 *values)
253 union i2c_smbus_data data;
255 if (length > I2C_SMBUS_BLOCK_MAX)
256 length = I2C_SMBUS_BLOCK_MAX;
257 data.block[0] = length;
258 memcpy(&data.block[1], values, length);
259 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
260 I2C_SMBUS_WRITE, command,
261 I2C_SMBUS_BLOCK_DATA, &data);
263 EXPORT_SYMBOL(i2c_smbus_write_block_data);
265 /* Returns the number of read bytes */
266 s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
267 u8 length, u8 *values)
269 union i2c_smbus_data data;
272 if (length > I2C_SMBUS_BLOCK_MAX)
273 length = I2C_SMBUS_BLOCK_MAX;
274 data.block[0] = length;
275 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
276 I2C_SMBUS_READ, command,
277 I2C_SMBUS_I2C_BLOCK_DATA, &data);
281 memcpy(values, &data.block[1], data.block[0]);
282 return data.block[0];
284 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
286 s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
287 u8 length, const u8 *values)
289 union i2c_smbus_data data;
291 if (length > I2C_SMBUS_BLOCK_MAX)
292 length = I2C_SMBUS_BLOCK_MAX;
293 data.block[0] = length;
294 memcpy(data.block + 1, values, length);
295 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
296 I2C_SMBUS_WRITE, command,
297 I2C_SMBUS_I2C_BLOCK_DATA, &data);
299 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
301 static void i2c_smbus_try_get_dmabuf(struct i2c_msg *msg, u8 init_val)
303 bool is_read = msg->flags & I2C_M_RD;
304 unsigned char *dma_buf;
306 dma_buf = kzalloc(I2C_SMBUS_BLOCK_MAX + (is_read ? 2 : 3), GFP_KERNEL);
311 msg->flags |= I2C_M_DMA_SAFE;
314 msg->buf[0] = init_val;
318 * Simulate a SMBus command using the I2C protocol.
319 * No checking of parameters is done!
321 static s32 i2c_smbus_xfer_emulated(struct i2c_adapter *adapter, u16 addr,
322 unsigned short flags,
323 char read_write, u8 command, int size,
324 union i2c_smbus_data *data)
327 * So we need to generate a series of msgs. In the case of writing, we
328 * need to use only one message; when reading, we need two. We
329 * initialize most things with sane defaults, to keep the code below
332 unsigned char msgbuf0[I2C_SMBUS_BLOCK_MAX+3];
333 unsigned char msgbuf1[I2C_SMBUS_BLOCK_MAX+2];
334 int nmsgs = read_write == I2C_SMBUS_READ ? 2 : 1;
337 struct i2c_msg msg[2] = {
345 .flags = flags | I2C_M_RD,
350 bool wants_pec = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
351 && size != I2C_SMBUS_I2C_BLOCK_DATA);
353 msgbuf0[0] = command;
355 case I2C_SMBUS_QUICK:
357 /* Special case: The read/write field is used as data */
358 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
363 if (read_write == I2C_SMBUS_READ) {
364 /* Special case: only a read! */
365 msg[0].flags = I2C_M_RD | flags;
369 case I2C_SMBUS_BYTE_DATA:
370 if (read_write == I2C_SMBUS_READ)
374 msgbuf0[1] = data->byte;
377 case I2C_SMBUS_WORD_DATA:
378 if (read_write == I2C_SMBUS_READ)
382 msgbuf0[1] = data->word & 0xff;
383 msgbuf0[2] = data->word >> 8;
386 case I2C_SMBUS_PROC_CALL:
387 nmsgs = 2; /* Special case */
388 read_write = I2C_SMBUS_READ;
391 msgbuf0[1] = data->word & 0xff;
392 msgbuf0[2] = data->word >> 8;
394 case I2C_SMBUS_BLOCK_DATA:
395 if (read_write == I2C_SMBUS_READ) {
396 msg[1].flags |= I2C_M_RECV_LEN;
397 msg[1].len = 1; /* block length will be added by
398 the underlying bus driver */
399 i2c_smbus_try_get_dmabuf(&msg[1], 0);
401 msg[0].len = data->block[0] + 2;
402 if (msg[0].len > I2C_SMBUS_BLOCK_MAX + 2) {
403 dev_err(&adapter->dev,
404 "Invalid block write size %d\n",
409 i2c_smbus_try_get_dmabuf(&msg[0], command);
410 memcpy(msg[0].buf + 1, data->block, msg[0].len - 1);
413 case I2C_SMBUS_BLOCK_PROC_CALL:
414 nmsgs = 2; /* Another special case */
415 read_write = I2C_SMBUS_READ;
416 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
417 dev_err(&adapter->dev,
418 "Invalid block write size %d\n",
423 msg[0].len = data->block[0] + 2;
424 i2c_smbus_try_get_dmabuf(&msg[0], command);
425 memcpy(msg[0].buf + 1, data->block, msg[0].len - 1);
427 msg[1].flags |= I2C_M_RECV_LEN;
428 msg[1].len = 1; /* block length will be added by
429 the underlying bus driver */
430 i2c_smbus_try_get_dmabuf(&msg[1], 0);
432 case I2C_SMBUS_I2C_BLOCK_DATA:
433 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
434 dev_err(&adapter->dev, "Invalid block %s size %d\n",
435 read_write == I2C_SMBUS_READ ? "read" : "write",
440 if (read_write == I2C_SMBUS_READ) {
441 msg[1].len = data->block[0];
442 i2c_smbus_try_get_dmabuf(&msg[1], 0);
444 msg[0].len = data->block[0] + 1;
446 i2c_smbus_try_get_dmabuf(&msg[0], command);
447 memcpy(msg[0].buf + 1, data->block + 1, data->block[0]);
451 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
456 /* Compute PEC if first message is a write */
457 if (!(msg[0].flags & I2C_M_RD)) {
458 if (nmsgs == 1) /* Write only */
459 i2c_smbus_add_pec(&msg[0]);
460 else /* Write followed by read */
461 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
463 /* Ask for PEC if last message is a read */
464 if (msg[nmsgs - 1].flags & I2C_M_RD)
465 msg[nmsgs - 1].len++;
468 status = __i2c_transfer(adapter, msg, nmsgs);
471 if (status != nmsgs) {
477 /* Check PEC if last message is a read */
478 if (wants_pec && (msg[nmsgs - 1].flags & I2C_M_RD)) {
479 status = i2c_smbus_check_pec(partial_pec, &msg[nmsgs - 1]);
484 if (read_write == I2C_SMBUS_READ)
487 data->byte = msgbuf0[0];
489 case I2C_SMBUS_BYTE_DATA:
490 data->byte = msgbuf1[0];
492 case I2C_SMBUS_WORD_DATA:
493 case I2C_SMBUS_PROC_CALL:
494 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
496 case I2C_SMBUS_I2C_BLOCK_DATA:
497 memcpy(data->block + 1, msg[1].buf, data->block[0]);
499 case I2C_SMBUS_BLOCK_DATA:
500 case I2C_SMBUS_BLOCK_PROC_CALL:
501 if (msg[1].buf[0] > I2C_SMBUS_BLOCK_MAX) {
502 dev_err(&adapter->dev,
503 "Invalid block size returned: %d\n",
508 memcpy(data->block, msg[1].buf, msg[1].buf[0] + 1);
513 if (msg[0].flags & I2C_M_DMA_SAFE)
515 if (msg[1].flags & I2C_M_DMA_SAFE)
522 * i2c_smbus_xfer - execute SMBus protocol operations
523 * @adapter: Handle to I2C bus
524 * @addr: Address of SMBus slave on that bus
525 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
526 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
527 * @command: Byte interpreted by slave, for protocols which use such bytes
528 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
529 * @data: Data to be read or written
531 * This executes an SMBus protocol operation, and returns a negative
532 * errno code else zero on success.
534 s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
535 unsigned short flags, char read_write,
536 u8 command, int protocol, union i2c_smbus_data *data)
540 res = __i2c_lock_bus_helper(adapter);
544 res = __i2c_smbus_xfer(adapter, addr, flags, read_write,
545 command, protocol, data);
546 i2c_unlock_bus(adapter, I2C_LOCK_SEGMENT);
550 EXPORT_SYMBOL(i2c_smbus_xfer);
552 s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
553 unsigned short flags, char read_write,
554 u8 command, int protocol, union i2c_smbus_data *data)
556 int (*xfer_func)(struct i2c_adapter *adap, u16 addr,
557 unsigned short flags, char read_write,
558 u8 command, int size, union i2c_smbus_data *data);
559 unsigned long orig_jiffies;
563 res = __i2c_check_suspended(adapter);
567 /* If enabled, the following two tracepoints are conditional on
568 * read_write and protocol.
570 trace_smbus_write(adapter, addr, flags, read_write,
571 command, protocol, data);
572 trace_smbus_read(adapter, addr, flags, read_write,
575 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
577 xfer_func = adapter->algo->smbus_xfer;
578 if (i2c_in_atomic_xfer_mode()) {
579 if (adapter->algo->smbus_xfer_atomic)
580 xfer_func = adapter->algo->smbus_xfer_atomic;
581 else if (adapter->algo->master_xfer_atomic)
582 xfer_func = NULL; /* fallback to I2C emulation */
586 /* Retry automatically on arbitration loss */
587 orig_jiffies = jiffies;
588 for (res = 0, try = 0; try <= adapter->retries; try++) {
589 res = xfer_func(adapter, addr, flags, read_write,
590 command, protocol, data);
593 if (time_after(jiffies,
594 orig_jiffies + adapter->timeout))
598 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
601 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
602 * implement native support for the SMBus operation.
606 res = i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
607 command, protocol, data);
610 /* If enabled, the reply tracepoint is conditional on read_write. */
611 trace_smbus_reply(adapter, addr, flags, read_write,
612 command, protocol, data, res);
613 trace_smbus_result(adapter, addr, flags, read_write,
614 command, protocol, res);
618 EXPORT_SYMBOL(__i2c_smbus_xfer);
621 * i2c_smbus_read_i2c_block_data_or_emulated - read block or emulate
622 * @client: Handle to slave device
623 * @command: Byte interpreted by slave
624 * @length: Size of data block; SMBus allows at most I2C_SMBUS_BLOCK_MAX bytes
625 * @values: Byte array into which data will be read; big enough to hold
626 * the data returned by the slave. SMBus allows at most
627 * I2C_SMBUS_BLOCK_MAX bytes.
629 * This executes the SMBus "block read" protocol if supported by the adapter.
630 * If block read is not supported, it emulates it using either word or byte
631 * read protocols depending on availability.
633 * The addresses of the I2C slave device that are accessed with this function
634 * must be mapped to a linear region, so that a block read will have the same
635 * effect as a byte read. Before using this function you must double-check
636 * if the I2C slave does support exchanging a block transfer with a byte
639 s32 i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client,
640 u8 command, u8 length, u8 *values)
645 if (length > I2C_SMBUS_BLOCK_MAX)
646 length = I2C_SMBUS_BLOCK_MAX;
648 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
649 return i2c_smbus_read_i2c_block_data(client, command, length, values);
651 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA))
654 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_WORD_DATA)) {
655 while ((i + 2) <= length) {
656 status = i2c_smbus_read_word_data(client, command + i);
659 values[i] = status & 0xff;
660 values[i + 1] = status >> 8;
666 status = i2c_smbus_read_byte_data(client, command + i);
675 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data_or_emulated);
678 * i2c_new_smbus_alert_device - get ara client for SMBus alert support
679 * @adapter: the target adapter
680 * @setup: setup data for the SMBus alert handler
683 * Setup handling of the SMBus alert protocol on a given I2C bus segment.
685 * Handling can be done either through our IRQ handler, or by the
686 * adapter (from its handler, periodic polling, or whatever).
688 * This returns the ara client, which should be saved for later use with
689 * i2c_handle_smbus_alert() and ultimately i2c_unregister_device(); or an
690 * ERRPTR to indicate an error.
692 struct i2c_client *i2c_new_smbus_alert_device(struct i2c_adapter *adapter,
693 struct i2c_smbus_alert_setup *setup)
695 struct i2c_board_info ara_board_info = {
696 I2C_BOARD_INFO("smbus_alert", 0x0c),
697 .platform_data = setup,
700 return i2c_new_client_device(adapter, &ara_board_info);
702 EXPORT_SYMBOL_GPL(i2c_new_smbus_alert_device);
704 #if IS_ENABLED(CONFIG_I2C_SMBUS) && IS_ENABLED(CONFIG_OF)
705 int of_i2c_setup_smbus_alert(struct i2c_adapter *adapter)
709 irq = of_property_match_string(adapter->dev.of_node, "interrupt-names",
711 if (irq == -EINVAL || irq == -ENODATA)
716 return PTR_ERR_OR_ZERO(i2c_new_smbus_alert_device(adapter, NULL));
718 EXPORT_SYMBOL_GPL(of_i2c_setup_smbus_alert);