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.
9 * All SMBus-related things are written by Frodo Looijaard <frodol@dds.nl>
10 * SMBus 2.0 support by Mark Studebaker <mdsxyz123@yahoo.com> and
11 * Jean Delvare <jdelvare@suse.de>
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);
40 /* Incremental CRC8 over count bytes in the array pointed to by p */
41 static u8
i2c_smbus_pec(u8 crc
, u8
*p
, size_t count
)
45 for (i
= 0; i
< count
; i
++)
46 crc
= crc8((crc
^ p
[i
]) << 8);
50 /* Assume a 7-bit address, which is reasonable for SMBus */
51 static u8
i2c_smbus_msg_pec(u8 pec
, struct i2c_msg
*msg
)
53 /* The address will be sent first */
54 u8 addr
= i2c_8bit_addr_from_msg(msg
);
55 pec
= i2c_smbus_pec(pec
, &addr
, 1);
57 /* The data buffer follows */
58 return i2c_smbus_pec(pec
, msg
->buf
, msg
->len
);
61 /* Used for write only transactions */
62 static inline void i2c_smbus_add_pec(struct i2c_msg
*msg
)
64 msg
->buf
[msg
->len
] = i2c_smbus_msg_pec(0, msg
);
68 /* Return <0 on CRC error
69 If there was a write before this read (most cases) we need to take the
70 partial CRC from the write part into account.
71 Note that this function does modify the message (we need to decrease the
72 message length to hide the CRC byte from the caller). */
73 static int i2c_smbus_check_pec(u8 cpec
, struct i2c_msg
*msg
)
75 u8 rpec
= msg
->buf
[--msg
->len
];
76 cpec
= i2c_smbus_msg_pec(cpec
, msg
);
79 pr_debug("Bad PEC 0x%02x vs. 0x%02x\n",
87 * i2c_smbus_read_byte - SMBus "receive byte" protocol
88 * @client: Handle to slave device
90 * This executes the SMBus "receive byte" protocol, returning negative errno
91 * else the byte received from the device.
93 s32
i2c_smbus_read_byte(const struct i2c_client
*client
)
95 union i2c_smbus_data data
;
98 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
100 I2C_SMBUS_BYTE
, &data
);
101 return (status
< 0) ? status
: data
.byte
;
103 EXPORT_SYMBOL(i2c_smbus_read_byte
);
106 * i2c_smbus_write_byte - SMBus "send byte" protocol
107 * @client: Handle to slave device
108 * @value: Byte to be sent
110 * This executes the SMBus "send byte" protocol, returning negative errno
111 * else zero on success.
113 s32
i2c_smbus_write_byte(const struct i2c_client
*client
, u8 value
)
115 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
116 I2C_SMBUS_WRITE
, value
, I2C_SMBUS_BYTE
, NULL
);
118 EXPORT_SYMBOL(i2c_smbus_write_byte
);
121 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
122 * @client: Handle to slave device
123 * @command: Byte interpreted by slave
125 * This executes the SMBus "read byte" protocol, returning negative errno
126 * else a data byte received from the device.
128 s32
i2c_smbus_read_byte_data(const struct i2c_client
*client
, u8 command
)
130 union i2c_smbus_data data
;
133 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
134 I2C_SMBUS_READ
, command
,
135 I2C_SMBUS_BYTE_DATA
, &data
);
136 return (status
< 0) ? status
: data
.byte
;
138 EXPORT_SYMBOL(i2c_smbus_read_byte_data
);
141 * i2c_smbus_write_byte_data - SMBus "write byte" protocol
142 * @client: Handle to slave device
143 * @command: Byte interpreted by slave
144 * @value: Byte being written
146 * This executes the SMBus "write byte" protocol, returning negative errno
147 * else zero on success.
149 s32
i2c_smbus_write_byte_data(const struct i2c_client
*client
, u8 command
,
152 union i2c_smbus_data data
;
154 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
155 I2C_SMBUS_WRITE
, command
,
156 I2C_SMBUS_BYTE_DATA
, &data
);
158 EXPORT_SYMBOL(i2c_smbus_write_byte_data
);
161 * i2c_smbus_read_word_data - SMBus "read word" protocol
162 * @client: Handle to slave device
163 * @command: Byte interpreted by slave
165 * This executes the SMBus "read word" protocol, returning negative errno
166 * else a 16-bit unsigned "word" received from the device.
168 s32
i2c_smbus_read_word_data(const struct i2c_client
*client
, u8 command
)
170 union i2c_smbus_data data
;
173 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
174 I2C_SMBUS_READ
, command
,
175 I2C_SMBUS_WORD_DATA
, &data
);
176 return (status
< 0) ? status
: data
.word
;
178 EXPORT_SYMBOL(i2c_smbus_read_word_data
);
181 * i2c_smbus_write_word_data - SMBus "write word" protocol
182 * @client: Handle to slave device
183 * @command: Byte interpreted by slave
184 * @value: 16-bit "word" being written
186 * This executes the SMBus "write word" protocol, returning negative errno
187 * else zero on success.
189 s32
i2c_smbus_write_word_data(const struct i2c_client
*client
, u8 command
,
192 union i2c_smbus_data data
;
194 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
195 I2C_SMBUS_WRITE
, command
,
196 I2C_SMBUS_WORD_DATA
, &data
);
198 EXPORT_SYMBOL(i2c_smbus_write_word_data
);
201 * i2c_smbus_read_block_data - SMBus "block read" protocol
202 * @client: Handle to slave device
203 * @command: Byte interpreted by slave
204 * @values: Byte array into which data will be read; big enough to hold
205 * the data returned by the slave. SMBus allows at most 32 bytes.
207 * This executes the SMBus "block read" protocol, returning negative errno
208 * else the number of data bytes in the slave's response.
210 * Note that using this function requires that the client's adapter support
211 * the I2C_FUNC_SMBUS_READ_BLOCK_DATA functionality. Not all adapter drivers
212 * support this; its emulation through I2C messaging relies on a specific
213 * mechanism (I2C_M_RECV_LEN) which may not be implemented.
215 s32
i2c_smbus_read_block_data(const struct i2c_client
*client
, u8 command
,
218 union i2c_smbus_data data
;
221 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
222 I2C_SMBUS_READ
, command
,
223 I2C_SMBUS_BLOCK_DATA
, &data
);
227 memcpy(values
, &data
.block
[1], data
.block
[0]);
228 return data
.block
[0];
230 EXPORT_SYMBOL(i2c_smbus_read_block_data
);
233 * i2c_smbus_write_block_data - SMBus "block write" protocol
234 * @client: Handle to slave device
235 * @command: Byte interpreted by slave
236 * @length: Size of data block; SMBus allows at most 32 bytes
237 * @values: Byte array which will be written.
239 * This executes the SMBus "block write" protocol, returning negative errno
240 * else zero on success.
242 s32
i2c_smbus_write_block_data(const struct i2c_client
*client
, u8 command
,
243 u8 length
, const u8
*values
)
245 union i2c_smbus_data data
;
247 if (length
> I2C_SMBUS_BLOCK_MAX
)
248 length
= I2C_SMBUS_BLOCK_MAX
;
249 data
.block
[0] = length
;
250 memcpy(&data
.block
[1], values
, length
);
251 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
252 I2C_SMBUS_WRITE
, command
,
253 I2C_SMBUS_BLOCK_DATA
, &data
);
255 EXPORT_SYMBOL(i2c_smbus_write_block_data
);
257 /* Returns the number of read bytes */
258 s32
i2c_smbus_read_i2c_block_data(const struct i2c_client
*client
, u8 command
,
259 u8 length
, u8
*values
)
261 union i2c_smbus_data data
;
264 if (length
> I2C_SMBUS_BLOCK_MAX
)
265 length
= I2C_SMBUS_BLOCK_MAX
;
266 data
.block
[0] = length
;
267 status
= i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
268 I2C_SMBUS_READ
, command
,
269 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
273 memcpy(values
, &data
.block
[1], data
.block
[0]);
274 return data
.block
[0];
276 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data
);
278 s32
i2c_smbus_write_i2c_block_data(const struct i2c_client
*client
, u8 command
,
279 u8 length
, const u8
*values
)
281 union i2c_smbus_data data
;
283 if (length
> I2C_SMBUS_BLOCK_MAX
)
284 length
= I2C_SMBUS_BLOCK_MAX
;
285 data
.block
[0] = length
;
286 memcpy(data
.block
+ 1, values
, length
);
287 return i2c_smbus_xfer(client
->adapter
, client
->addr
, client
->flags
,
288 I2C_SMBUS_WRITE
, command
,
289 I2C_SMBUS_I2C_BLOCK_DATA
, &data
);
291 EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data
);
293 static void i2c_smbus_try_get_dmabuf(struct i2c_msg
*msg
, u8 init_val
)
295 bool is_read
= msg
->flags
& I2C_M_RD
;
296 unsigned char *dma_buf
;
298 dma_buf
= kzalloc(I2C_SMBUS_BLOCK_MAX
+ (is_read
? 2 : 3), GFP_KERNEL
);
303 msg
->flags
|= I2C_M_DMA_SAFE
;
306 msg
->buf
[0] = init_val
;
310 * Simulate a SMBus command using the I2C protocol.
311 * No checking of parameters is done!
313 static s32
i2c_smbus_xfer_emulated(struct i2c_adapter
*adapter
, u16 addr
,
314 unsigned short flags
,
315 char read_write
, u8 command
, int size
,
316 union i2c_smbus_data
*data
)
319 * So we need to generate a series of msgs. In the case of writing, we
320 * need to use only one message; when reading, we need two. We
321 * initialize most things with sane defaults, to keep the code below
324 unsigned char msgbuf0
[I2C_SMBUS_BLOCK_MAX
+3];
325 unsigned char msgbuf1
[I2C_SMBUS_BLOCK_MAX
+2];
326 int num
= read_write
== I2C_SMBUS_READ
? 2 : 1;
330 struct i2c_msg msg
[2] = {
338 .flags
= flags
| I2C_M_RD
,
344 msgbuf0
[0] = command
;
346 case I2C_SMBUS_QUICK
:
348 /* Special case: The read/write field is used as data */
349 msg
[0].flags
= flags
| (read_write
== I2C_SMBUS_READ
?
354 if (read_write
== I2C_SMBUS_READ
) {
355 /* Special case: only a read! */
356 msg
[0].flags
= I2C_M_RD
| flags
;
360 case I2C_SMBUS_BYTE_DATA
:
361 if (read_write
== I2C_SMBUS_READ
)
365 msgbuf0
[1] = data
->byte
;
368 case I2C_SMBUS_WORD_DATA
:
369 if (read_write
== I2C_SMBUS_READ
)
373 msgbuf0
[1] = data
->word
& 0xff;
374 msgbuf0
[2] = data
->word
>> 8;
377 case I2C_SMBUS_PROC_CALL
:
378 num
= 2; /* Special case */
379 read_write
= I2C_SMBUS_READ
;
382 msgbuf0
[1] = data
->word
& 0xff;
383 msgbuf0
[2] = data
->word
>> 8;
385 case I2C_SMBUS_BLOCK_DATA
:
386 if (read_write
== I2C_SMBUS_READ
) {
387 msg
[1].flags
|= I2C_M_RECV_LEN
;
388 msg
[1].len
= 1; /* block length will be added by
389 the underlying bus driver */
390 i2c_smbus_try_get_dmabuf(&msg
[1], 0);
392 msg
[0].len
= data
->block
[0] + 2;
393 if (msg
[0].len
> I2C_SMBUS_BLOCK_MAX
+ 2) {
394 dev_err(&adapter
->dev
,
395 "Invalid block write size %d\n",
400 i2c_smbus_try_get_dmabuf(&msg
[0], command
);
401 for (i
= 1; i
< msg
[0].len
; i
++)
402 msg
[0].buf
[i
] = data
->block
[i
- 1];
405 case I2C_SMBUS_BLOCK_PROC_CALL
:
406 num
= 2; /* Another special case */
407 read_write
= I2C_SMBUS_READ
;
408 if (data
->block
[0] > I2C_SMBUS_BLOCK_MAX
) {
409 dev_err(&adapter
->dev
,
410 "Invalid block write size %d\n",
415 msg
[0].len
= data
->block
[0] + 2;
416 i2c_smbus_try_get_dmabuf(&msg
[0], command
);
417 for (i
= 1; i
< msg
[0].len
; i
++)
418 msg
[0].buf
[i
] = data
->block
[i
- 1];
420 msg
[1].flags
|= I2C_M_RECV_LEN
;
421 msg
[1].len
= 1; /* block length will be added by
422 the underlying bus driver */
423 i2c_smbus_try_get_dmabuf(&msg
[1], 0);
425 case I2C_SMBUS_I2C_BLOCK_DATA
:
426 if (data
->block
[0] > I2C_SMBUS_BLOCK_MAX
) {
427 dev_err(&adapter
->dev
, "Invalid block %s size %d\n",
428 read_write
== I2C_SMBUS_READ
? "read" : "write",
433 if (read_write
== I2C_SMBUS_READ
) {
434 msg
[1].len
= data
->block
[0];
435 i2c_smbus_try_get_dmabuf(&msg
[1], 0);
437 msg
[0].len
= data
->block
[0] + 1;
439 i2c_smbus_try_get_dmabuf(&msg
[0], command
);
440 for (i
= 1; i
<= data
->block
[0]; i
++)
441 msg
[0].buf
[i
] = data
->block
[i
];
445 dev_err(&adapter
->dev
, "Unsupported transaction %d\n", size
);
449 i
= ((flags
& I2C_CLIENT_PEC
) && size
!= I2C_SMBUS_QUICK
450 && size
!= I2C_SMBUS_I2C_BLOCK_DATA
);
452 /* Compute PEC if first message is a write */
453 if (!(msg
[0].flags
& I2C_M_RD
)) {
454 if (num
== 1) /* Write only */
455 i2c_smbus_add_pec(&msg
[0]);
456 else /* Write followed by read */
457 partial_pec
= i2c_smbus_msg_pec(0, &msg
[0]);
459 /* Ask for PEC if last message is a read */
460 if (msg
[num
-1].flags
& I2C_M_RD
)
464 status
= __i2c_transfer(adapter
, msg
, num
);
473 /* Check PEC if last message is a read */
474 if (i
&& (msg
[num
-1].flags
& I2C_M_RD
)) {
475 status
= i2c_smbus_check_pec(partial_pec
, &msg
[num
-1]);
480 if (read_write
== I2C_SMBUS_READ
)
483 data
->byte
= msgbuf0
[0];
485 case I2C_SMBUS_BYTE_DATA
:
486 data
->byte
= msgbuf1
[0];
488 case I2C_SMBUS_WORD_DATA
:
489 case I2C_SMBUS_PROC_CALL
:
490 data
->word
= msgbuf1
[0] | (msgbuf1
[1] << 8);
492 case I2C_SMBUS_I2C_BLOCK_DATA
:
493 for (i
= 0; i
< data
->block
[0]; i
++)
494 data
->block
[i
+ 1] = msg
[1].buf
[i
];
496 case I2C_SMBUS_BLOCK_DATA
:
497 case I2C_SMBUS_BLOCK_PROC_CALL
:
498 if (msg
[1].buf
[0] > I2C_SMBUS_BLOCK_MAX
) {
499 dev_err(&adapter
->dev
,
500 "Invalid block size returned: %d\n",
505 for (i
= 0; i
< msg
[1].buf
[0] + 1; i
++)
506 data
->block
[i
] = msg
[1].buf
[i
];
511 if (msg
[0].flags
& I2C_M_DMA_SAFE
)
513 if (msg
[1].flags
& I2C_M_DMA_SAFE
)
520 * i2c_smbus_xfer - execute SMBus protocol operations
521 * @adapter: Handle to I2C bus
522 * @addr: Address of SMBus slave on that bus
523 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
524 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
525 * @command: Byte interpreted by slave, for protocols which use such bytes
526 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
527 * @data: Data to be read or written
529 * This executes an SMBus protocol operation, and returns a negative
530 * errno code else zero on success.
532 s32
i2c_smbus_xfer(struct i2c_adapter
*adapter
, u16 addr
,
533 unsigned short flags
, char read_write
,
534 u8 command
, int protocol
, union i2c_smbus_data
*data
)
538 res
= __i2c_lock_bus_helper(adapter
);
542 res
= __i2c_smbus_xfer(adapter
, addr
, flags
, read_write
,
543 command
, protocol
, data
);
544 i2c_unlock_bus(adapter
, I2C_LOCK_SEGMENT
);
548 EXPORT_SYMBOL(i2c_smbus_xfer
);
550 s32
__i2c_smbus_xfer(struct i2c_adapter
*adapter
, u16 addr
,
551 unsigned short flags
, char read_write
,
552 u8 command
, int protocol
, union i2c_smbus_data
*data
)
554 int (*xfer_func
)(struct i2c_adapter
*adap
, u16 addr
,
555 unsigned short flags
, char read_write
,
556 u8 command
, int size
, union i2c_smbus_data
*data
);
557 unsigned long orig_jiffies
;
561 res
= __i2c_check_suspended(adapter
);
565 /* If enabled, the following two tracepoints are conditional on
566 * read_write and protocol.
568 trace_smbus_write(adapter
, addr
, flags
, read_write
,
569 command
, protocol
, data
);
570 trace_smbus_read(adapter
, addr
, flags
, read_write
,
573 flags
&= I2C_M_TEN
| I2C_CLIENT_PEC
| I2C_CLIENT_SCCB
;
575 xfer_func
= adapter
->algo
->smbus_xfer
;
576 if (i2c_in_atomic_xfer_mode()) {
577 if (adapter
->algo
->smbus_xfer_atomic
)
578 xfer_func
= adapter
->algo
->smbus_xfer_atomic
;
579 else if (adapter
->algo
->master_xfer_atomic
)
580 xfer_func
= NULL
; /* fallback to I2C emulation */
584 /* Retry automatically on arbitration loss */
585 orig_jiffies
= jiffies
;
586 for (res
= 0, try = 0; try <= adapter
->retries
; try++) {
587 res
= xfer_func(adapter
, addr
, flags
, read_write
,
588 command
, protocol
, data
);
591 if (time_after(jiffies
,
592 orig_jiffies
+ adapter
->timeout
))
596 if (res
!= -EOPNOTSUPP
|| !adapter
->algo
->master_xfer
)
599 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
600 * implement native support for the SMBus operation.
604 res
= i2c_smbus_xfer_emulated(adapter
, addr
, flags
, read_write
,
605 command
, protocol
, data
);
608 /* If enabled, the reply tracepoint is conditional on read_write. */
609 trace_smbus_reply(adapter
, addr
, flags
, read_write
,
610 command
, protocol
, data
, res
);
611 trace_smbus_result(adapter
, addr
, flags
, read_write
,
612 command
, protocol
, res
);
616 EXPORT_SYMBOL(__i2c_smbus_xfer
);
619 * i2c_smbus_read_i2c_block_data_or_emulated - read block or emulate
620 * @client: Handle to slave device
621 * @command: Byte interpreted by slave
622 * @length: Size of data block; SMBus allows at most I2C_SMBUS_BLOCK_MAX bytes
623 * @values: Byte array into which data will be read; big enough to hold
624 * the data returned by the slave. SMBus allows at most
625 * I2C_SMBUS_BLOCK_MAX bytes.
627 * This executes the SMBus "block read" protocol if supported by the adapter.
628 * If block read is not supported, it emulates it using either word or byte
629 * read protocols depending on availability.
631 * The addresses of the I2C slave device that are accessed with this function
632 * must be mapped to a linear region, so that a block read will have the same
633 * effect as a byte read. Before using this function you must double-check
634 * if the I2C slave does support exchanging a block transfer with a byte
637 s32
i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client
*client
,
638 u8 command
, u8 length
, u8
*values
)
643 if (length
> I2C_SMBUS_BLOCK_MAX
)
644 length
= I2C_SMBUS_BLOCK_MAX
;
646 if (i2c_check_functionality(client
->adapter
, I2C_FUNC_SMBUS_READ_I2C_BLOCK
))
647 return i2c_smbus_read_i2c_block_data(client
, command
, length
, values
);
649 if (!i2c_check_functionality(client
->adapter
, I2C_FUNC_SMBUS_READ_BYTE_DATA
))
652 if (i2c_check_functionality(client
->adapter
, I2C_FUNC_SMBUS_READ_WORD_DATA
)) {
653 while ((i
+ 2) <= length
) {
654 status
= i2c_smbus_read_word_data(client
, command
+ i
);
657 values
[i
] = status
& 0xff;
658 values
[i
+ 1] = status
>> 8;
664 status
= i2c_smbus_read_byte_data(client
, command
+ i
);
673 EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data_or_emulated
);
676 * i2c_new_smbus_alert_device - get ara client for SMBus alert support
677 * @adapter: the target adapter
678 * @setup: setup data for the SMBus alert handler
681 * Setup handling of the SMBus alert protocol on a given I2C bus segment.
683 * Handling can be done either through our IRQ handler, or by the
684 * adapter (from its handler, periodic polling, or whatever).
686 * This returns the ara client, which should be saved for later use with
687 * i2c_handle_smbus_alert() and ultimately i2c_unregister_device(); or an
688 * ERRPTR to indicate an error.
690 struct i2c_client
*i2c_new_smbus_alert_device(struct i2c_adapter
*adapter
,
691 struct i2c_smbus_alert_setup
*setup
)
693 struct i2c_board_info ara_board_info
= {
694 I2C_BOARD_INFO("smbus_alert", 0x0c),
695 .platform_data
= setup
,
698 return i2c_new_client_device(adapter
, &ara_board_info
);
700 EXPORT_SYMBOL_GPL(i2c_new_smbus_alert_device
);
702 #if IS_ENABLED(CONFIG_I2C_SMBUS) && IS_ENABLED(CONFIG_OF)
703 int of_i2c_setup_smbus_alert(struct i2c_adapter
*adapter
)
707 irq
= of_property_match_string(adapter
->dev
.of_node
, "interrupt-names",
709 if (irq
== -EINVAL
|| irq
== -ENODATA
)
714 return PTR_ERR_OR_ZERO(i2c_new_smbus_alert_device(adapter
, NULL
));
716 EXPORT_SYMBOL_GPL(of_i2c_setup_smbus_alert
);