blob: bf6bfe7c5cfe139f252f768b1756f6e240679b74 [file] [log] [blame]
Thomas Gleixner2874c5f2019-05-27 08:55:01 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Wolfram Sang22c78d12017-05-23 12:27:17 +02002/*
3 * Linux I2C core SMBus and SMBus emulation code
4 *
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
Keyur Patela23ff372020-06-12 17:26:35 -04007 * (e.g. smbalert) are handled in a separate i2c-smbus module.
Wolfram Sang22c78d12017-05-23 12:27:17 +02008 *
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>
Wolfram Sang22c78d12017-05-23 12:27:17 +020012 */
13#include <linux/device.h>
14#include <linux/err.h>
15#include <linux/i2c.h>
Phil Reid3c0a60b2017-08-24 17:31:02 +080016#include <linux/i2c-smbus.h>
Wolfram Sang8a778212017-11-04 21:20:06 +010017#include <linux/slab.h>
Wolfram Sang22c78d12017-05-23 12:27:17 +020018
Wolfram Sang83c42212019-04-03 14:40:09 +020019#include "i2c-core.h"
20
Wolfram Sang22c78d12017-05-23 12:27:17 +020021#define CREATE_TRACE_POINTS
22#include <trace/events/smbus.h>
23
24
25/* The SMBus parts */
26
27#define POLY (0x1070U << 3)
28static u8 crc8(u16 data)
29{
30 int i;
31
32 for (i = 0; i < 8; i++) {
33 if (data & 0x8000)
34 data = data ^ POLY;
35 data = data << 1;
36 }
37 return (u8)(data >> 8);
38}
39
40/* Incremental CRC8 over count bytes in the array pointed to by p */
41static u8 i2c_smbus_pec(u8 crc, u8 *p, size_t count)
42{
43 int i;
44
45 for (i = 0; i < count; i++)
46 crc = crc8((crc ^ p[i]) << 8);
47 return crc;
48}
49
50/* Assume a 7-bit address, which is reasonable for SMBus */
51static u8 i2c_smbus_msg_pec(u8 pec, struct i2c_msg *msg)
52{
53 /* The address will be sent first */
54 u8 addr = i2c_8bit_addr_from_msg(msg);
55 pec = i2c_smbus_pec(pec, &addr, 1);
56
57 /* The data buffer follows */
58 return i2c_smbus_pec(pec, msg->buf, msg->len);
59}
60
61/* Used for write only transactions */
62static inline void i2c_smbus_add_pec(struct i2c_msg *msg)
63{
64 msg->buf[msg->len] = i2c_smbus_msg_pec(0, msg);
65 msg->len++;
66}
67
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). */
73static int i2c_smbus_check_pec(u8 cpec, struct i2c_msg *msg)
74{
75 u8 rpec = msg->buf[--msg->len];
76 cpec = i2c_smbus_msg_pec(cpec, msg);
77
78 if (rpec != cpec) {
79 pr_debug("Bad PEC 0x%02x vs. 0x%02x\n",
80 rpec, cpec);
81 return -EBADMSG;
82 }
83 return 0;
84}
85
86/**
87 * i2c_smbus_read_byte - SMBus "receive byte" protocol
88 * @client: Handle to slave device
89 *
90 * This executes the SMBus "receive byte" protocol, returning negative errno
91 * else the byte received from the device.
92 */
93s32 i2c_smbus_read_byte(const struct i2c_client *client)
94{
95 union i2c_smbus_data data;
96 int status;
97
98 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
99 I2C_SMBUS_READ, 0,
100 I2C_SMBUS_BYTE, &data);
101 return (status < 0) ? status : data.byte;
102}
103EXPORT_SYMBOL(i2c_smbus_read_byte);
104
105/**
106 * i2c_smbus_write_byte - SMBus "send byte" protocol
107 * @client: Handle to slave device
108 * @value: Byte to be sent
109 *
110 * This executes the SMBus "send byte" protocol, returning negative errno
111 * else zero on success.
112 */
113s32 i2c_smbus_write_byte(const struct i2c_client *client, u8 value)
114{
115 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
116 I2C_SMBUS_WRITE, value, I2C_SMBUS_BYTE, NULL);
117}
118EXPORT_SYMBOL(i2c_smbus_write_byte);
119
120/**
121 * i2c_smbus_read_byte_data - SMBus "read byte" protocol
122 * @client: Handle to slave device
123 * @command: Byte interpreted by slave
124 *
125 * This executes the SMBus "read byte" protocol, returning negative errno
126 * else a data byte received from the device.
127 */
128s32 i2c_smbus_read_byte_data(const struct i2c_client *client, u8 command)
129{
130 union i2c_smbus_data data;
131 int status;
132
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;
137}
138EXPORT_SYMBOL(i2c_smbus_read_byte_data);
139
140/**
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
145 *
146 * This executes the SMBus "write byte" protocol, returning negative errno
147 * else zero on success.
148 */
149s32 i2c_smbus_write_byte_data(const struct i2c_client *client, u8 command,
150 u8 value)
151{
152 union i2c_smbus_data data;
153 data.byte = value;
154 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
155 I2C_SMBUS_WRITE, command,
156 I2C_SMBUS_BYTE_DATA, &data);
157}
158EXPORT_SYMBOL(i2c_smbus_write_byte_data);
159
160/**
161 * i2c_smbus_read_word_data - SMBus "read word" protocol
162 * @client: Handle to slave device
163 * @command: Byte interpreted by slave
164 *
165 * This executes the SMBus "read word" protocol, returning negative errno
166 * else a 16-bit unsigned "word" received from the device.
167 */
168s32 i2c_smbus_read_word_data(const struct i2c_client *client, u8 command)
169{
170 union i2c_smbus_data data;
171 int status;
172
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;
177}
178EXPORT_SYMBOL(i2c_smbus_read_word_data);
179
180/**
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
185 *
186 * This executes the SMBus "write word" protocol, returning negative errno
187 * else zero on success.
188 */
189s32 i2c_smbus_write_word_data(const struct i2c_client *client, u8 command,
190 u16 value)
191{
192 union i2c_smbus_data data;
193 data.word = value;
194 return i2c_smbus_xfer(client->adapter, client->addr, client->flags,
195 I2C_SMBUS_WRITE, command,
196 I2C_SMBUS_WORD_DATA, &data);
197}
198EXPORT_SYMBOL(i2c_smbus_write_word_data);
199
200/**
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.
206 *
207 * This executes the SMBus "block read" protocol, returning negative errno
208 * else the number of data bytes in the slave's response.
209 *
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.
214 */
215s32 i2c_smbus_read_block_data(const struct i2c_client *client, u8 command,
216 u8 *values)
217{
218 union i2c_smbus_data data;
219 int status;
220
221 status = i2c_smbus_xfer(client->adapter, client->addr, client->flags,
222 I2C_SMBUS_READ, command,
223 I2C_SMBUS_BLOCK_DATA, &data);
224 if (status)
225 return status;
226
227 memcpy(values, &data.block[1], data.block[0]);
228 return data.block[0];
229}
230EXPORT_SYMBOL(i2c_smbus_read_block_data);
231
232/**
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.
238 *
239 * This executes the SMBus "block write" protocol, returning negative errno
240 * else zero on success.
241 */
242s32 i2c_smbus_write_block_data(const struct i2c_client *client, u8 command,
243 u8 length, const u8 *values)
244{
245 union i2c_smbus_data data;
246
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);
254}
255EXPORT_SYMBOL(i2c_smbus_write_block_data);
256
257/* Returns the number of read bytes */
258s32 i2c_smbus_read_i2c_block_data(const struct i2c_client *client, u8 command,
259 u8 length, u8 *values)
260{
261 union i2c_smbus_data data;
262 int status;
263
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);
270 if (status < 0)
271 return status;
272
273 memcpy(values, &data.block[1], data.block[0]);
274 return data.block[0];
275}
276EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data);
277
278s32 i2c_smbus_write_i2c_block_data(const struct i2c_client *client, u8 command,
279 u8 length, const u8 *values)
280{
281 union i2c_smbus_data data;
282
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);
290}
291EXPORT_SYMBOL(i2c_smbus_write_i2c_block_data);
292
Wolfram Sang8a778212017-11-04 21:20:06 +0100293static void i2c_smbus_try_get_dmabuf(struct i2c_msg *msg, u8 init_val)
294{
295 bool is_read = msg->flags & I2C_M_RD;
296 unsigned char *dma_buf;
297
298 dma_buf = kzalloc(I2C_SMBUS_BLOCK_MAX + (is_read ? 2 : 3), GFP_KERNEL);
299 if (!dma_buf)
300 return;
301
302 msg->buf = dma_buf;
303 msg->flags |= I2C_M_DMA_SAFE;
304
305 if (init_val)
306 msg->buf[0] = init_val;
307}
308
Wolfram Sangbe5b9282018-02-26 22:17:53 +0100309/*
310 * Simulate a SMBus command using the I2C protocol.
311 * No checking of parameters is done!
312 */
Wolfram Sang22c78d12017-05-23 12:27:17 +0200313static 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)
317{
Wolfram Sangbe5b9282018-02-26 22:17:53 +0100318 /*
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
322 * somewhat simpler.
323 */
Wolfram Sang22c78d12017-05-23 12:27:17 +0200324 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;
327 int i;
328 u8 partial_pec = 0;
329 int status;
330 struct i2c_msg msg[2] = {
331 {
332 .addr = addr,
333 .flags = flags,
334 .len = 1,
335 .buf = msgbuf0,
336 }, {
337 .addr = addr,
338 .flags = flags | I2C_M_RD,
339 .len = 0,
340 .buf = msgbuf1,
341 },
342 };
343
344 msgbuf0[0] = command;
345 switch (size) {
346 case I2C_SMBUS_QUICK:
347 msg[0].len = 0;
348 /* Special case: The read/write field is used as data */
349 msg[0].flags = flags | (read_write == I2C_SMBUS_READ ?
350 I2C_M_RD : 0);
351 num = 1;
352 break;
353 case I2C_SMBUS_BYTE:
354 if (read_write == I2C_SMBUS_READ) {
355 /* Special case: only a read! */
356 msg[0].flags = I2C_M_RD | flags;
357 num = 1;
358 }
359 break;
360 case I2C_SMBUS_BYTE_DATA:
361 if (read_write == I2C_SMBUS_READ)
362 msg[1].len = 1;
363 else {
364 msg[0].len = 2;
365 msgbuf0[1] = data->byte;
366 }
367 break;
368 case I2C_SMBUS_WORD_DATA:
369 if (read_write == I2C_SMBUS_READ)
370 msg[1].len = 2;
371 else {
372 msg[0].len = 3;
373 msgbuf0[1] = data->word & 0xff;
374 msgbuf0[2] = data->word >> 8;
375 }
376 break;
377 case I2C_SMBUS_PROC_CALL:
378 num = 2; /* Special case */
379 read_write = I2C_SMBUS_READ;
380 msg[0].len = 3;
381 msg[1].len = 2;
382 msgbuf0[1] = data->word & 0xff;
383 msgbuf0[2] = data->word >> 8;
384 break;
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 */
Wolfram Sang8a778212017-11-04 21:20:06 +0100390 i2c_smbus_try_get_dmabuf(&msg[1], 0);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200391 } else {
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",
396 data->block[0]);
397 return -EINVAL;
398 }
Wolfram Sang8a778212017-11-04 21:20:06 +0100399
400 i2c_smbus_try_get_dmabuf(&msg[0], command);
Dmitry Torokhovf0535df02021-01-11 21:40:38 +0100401 memcpy(msg[0].buf + 1, data->block, msg[0].len - 1);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200402 }
403 break;
404 case I2C_SMBUS_BLOCK_PROC_CALL:
405 num = 2; /* Another special case */
406 read_write = I2C_SMBUS_READ;
407 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
408 dev_err(&adapter->dev,
409 "Invalid block write size %d\n",
410 data->block[0]);
411 return -EINVAL;
412 }
Wolfram Sang8a778212017-11-04 21:20:06 +0100413
Wolfram Sang22c78d12017-05-23 12:27:17 +0200414 msg[0].len = data->block[0] + 2;
Wolfram Sang8a778212017-11-04 21:20:06 +0100415 i2c_smbus_try_get_dmabuf(&msg[0], command);
Dmitry Torokhovf0535df02021-01-11 21:40:38 +0100416 memcpy(msg[0].buf + 1, data->block, msg[0].len - 1);
Wolfram Sang8a778212017-11-04 21:20:06 +0100417
Wolfram Sang22c78d12017-05-23 12:27:17 +0200418 msg[1].flags |= I2C_M_RECV_LEN;
419 msg[1].len = 1; /* block length will be added by
420 the underlying bus driver */
Wolfram Sang8a778212017-11-04 21:20:06 +0100421 i2c_smbus_try_get_dmabuf(&msg[1], 0);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200422 break;
423 case I2C_SMBUS_I2C_BLOCK_DATA:
Jeremy Compostella89c6efa2017-11-15 12:31:44 -0700424 if (data->block[0] > I2C_SMBUS_BLOCK_MAX) {
425 dev_err(&adapter->dev, "Invalid block %s size %d\n",
426 read_write == I2C_SMBUS_READ ? "read" : "write",
427 data->block[0]);
428 return -EINVAL;
429 }
430
Wolfram Sang22c78d12017-05-23 12:27:17 +0200431 if (read_write == I2C_SMBUS_READ) {
432 msg[1].len = data->block[0];
Wolfram Sang8a778212017-11-04 21:20:06 +0100433 i2c_smbus_try_get_dmabuf(&msg[1], 0);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200434 } else {
435 msg[0].len = data->block[0] + 1;
Wolfram Sang8a778212017-11-04 21:20:06 +0100436
437 i2c_smbus_try_get_dmabuf(&msg[0], command);
Dmitry Torokhovf0535df02021-01-11 21:40:38 +0100438 memcpy(msg[0].buf + 1, data->block + 1, data->block[0]);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200439 }
440 break;
441 default:
442 dev_err(&adapter->dev, "Unsupported transaction %d\n", size);
443 return -EOPNOTSUPP;
444 }
445
446 i = ((flags & I2C_CLIENT_PEC) && size != I2C_SMBUS_QUICK
447 && size != I2C_SMBUS_I2C_BLOCK_DATA);
448 if (i) {
449 /* Compute PEC if first message is a write */
450 if (!(msg[0].flags & I2C_M_RD)) {
451 if (num == 1) /* Write only */
452 i2c_smbus_add_pec(&msg[0]);
453 else /* Write followed by read */
454 partial_pec = i2c_smbus_msg_pec(0, &msg[0]);
455 }
456 /* Ask for PEC if last message is a read */
457 if (msg[num-1].flags & I2C_M_RD)
458 msg[num-1].len++;
459 }
460
Peter Rosineef5ba12018-06-20 10:51:53 +0200461 status = __i2c_transfer(adapter, msg, num);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200462 if (status < 0)
Peter Rosin9aa61362018-06-20 11:43:23 +0200463 goto cleanup;
464 if (status != num) {
465 status = -EIO;
466 goto cleanup;
467 }
468 status = 0;
Wolfram Sang22c78d12017-05-23 12:27:17 +0200469
470 /* Check PEC if last message is a read */
471 if (i && (msg[num-1].flags & I2C_M_RD)) {
472 status = i2c_smbus_check_pec(partial_pec, &msg[num-1]);
473 if (status < 0)
Peter Rosin9aa61362018-06-20 11:43:23 +0200474 goto cleanup;
Wolfram Sang22c78d12017-05-23 12:27:17 +0200475 }
476
477 if (read_write == I2C_SMBUS_READ)
478 switch (size) {
479 case I2C_SMBUS_BYTE:
480 data->byte = msgbuf0[0];
481 break;
482 case I2C_SMBUS_BYTE_DATA:
483 data->byte = msgbuf1[0];
484 break;
485 case I2C_SMBUS_WORD_DATA:
486 case I2C_SMBUS_PROC_CALL:
487 data->word = msgbuf1[0] | (msgbuf1[1] << 8);
488 break;
489 case I2C_SMBUS_I2C_BLOCK_DATA:
Dmitry Torokhovf0535df02021-01-11 21:40:38 +0100490 memcpy(data->block + 1, msg[1].buf, data->block[0]);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200491 break;
492 case I2C_SMBUS_BLOCK_DATA:
493 case I2C_SMBUS_BLOCK_PROC_CALL:
Mans Rullgard40e05202020-06-13 11:41:09 +0100494 if (msg[1].buf[0] > I2C_SMBUS_BLOCK_MAX) {
495 dev_err(&adapter->dev,
496 "Invalid block size returned: %d\n",
497 msg[1].buf[0]);
498 status = -EPROTO;
499 goto cleanup;
500 }
Dmitry Torokhovf0535df02021-01-11 21:40:38 +0100501 memcpy(data->block, msg[1].buf, msg[1].buf[0] + 1);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200502 break;
503 }
Wolfram Sang8a778212017-11-04 21:20:06 +0100504
Peter Rosin9aa61362018-06-20 11:43:23 +0200505cleanup:
Wolfram Sang8a778212017-11-04 21:20:06 +0100506 if (msg[0].flags & I2C_M_DMA_SAFE)
507 kfree(msg[0].buf);
508 if (msg[1].flags & I2C_M_DMA_SAFE)
509 kfree(msg[1].buf);
510
Peter Rosin9aa61362018-06-20 11:43:23 +0200511 return status;
Wolfram Sang22c78d12017-05-23 12:27:17 +0200512}
513
514/**
515 * i2c_smbus_xfer - execute SMBus protocol operations
516 * @adapter: Handle to I2C bus
517 * @addr: Address of SMBus slave on that bus
518 * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
519 * @read_write: I2C_SMBUS_READ or I2C_SMBUS_WRITE
520 * @command: Byte interpreted by slave, for protocols which use such bytes
521 * @protocol: SMBus protocol operation to execute, such as I2C_SMBUS_PROC_CALL
522 * @data: Data to be read or written
523 *
524 * This executes an SMBus protocol operation, and returns a negative
525 * errno code else zero on success.
526 */
Peter Rosineef5ba12018-06-20 10:51:53 +0200527s32 i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
528 unsigned short flags, char read_write,
529 u8 command, int protocol, union i2c_smbus_data *data)
530{
531 s32 res;
532
Wolfram Sang83c42212019-04-03 14:40:09 +0200533 res = __i2c_lock_bus_helper(adapter);
534 if (res)
535 return res;
536
Peter Rosineef5ba12018-06-20 10:51:53 +0200537 res = __i2c_smbus_xfer(adapter, addr, flags, read_write,
538 command, protocol, data);
539 i2c_unlock_bus(adapter, I2C_LOCK_SEGMENT);
540
541 return res;
542}
543EXPORT_SYMBOL(i2c_smbus_xfer);
544
545s32 __i2c_smbus_xfer(struct i2c_adapter *adapter, u16 addr,
546 unsigned short flags, char read_write,
547 u8 command, int protocol, union i2c_smbus_data *data)
Wolfram Sang22c78d12017-05-23 12:27:17 +0200548{
Wolfram Sang63b96982019-04-03 14:40:10 +0200549 int (*xfer_func)(struct i2c_adapter *adap, u16 addr,
550 unsigned short flags, char read_write,
551 u8 command, int size, union i2c_smbus_data *data);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200552 unsigned long orig_jiffies;
553 int try;
554 s32 res;
555
Wolfram Sang5d756112019-04-25 16:19:48 +0200556 res = __i2c_check_suspended(adapter);
557 if (res)
558 return res;
559
Wolfram Sang22c78d12017-05-23 12:27:17 +0200560 /* If enabled, the following two tracepoints are conditional on
561 * read_write and protocol.
562 */
563 trace_smbus_write(adapter, addr, flags, read_write,
564 command, protocol, data);
565 trace_smbus_read(adapter, addr, flags, read_write,
566 command, protocol);
567
568 flags &= I2C_M_TEN | I2C_CLIENT_PEC | I2C_CLIENT_SCCB;
569
Wolfram Sang63b96982019-04-03 14:40:10 +0200570 xfer_func = adapter->algo->smbus_xfer;
571 if (i2c_in_atomic_xfer_mode()) {
572 if (adapter->algo->smbus_xfer_atomic)
573 xfer_func = adapter->algo->smbus_xfer_atomic;
574 else if (adapter->algo->master_xfer_atomic)
575 xfer_func = NULL; /* fallback to I2C emulation */
576 }
577
578 if (xfer_func) {
Wolfram Sang22c78d12017-05-23 12:27:17 +0200579 /* Retry automatically on arbitration loss */
580 orig_jiffies = jiffies;
581 for (res = 0, try = 0; try <= adapter->retries; try++) {
Wolfram Sang63b96982019-04-03 14:40:10 +0200582 res = xfer_func(adapter, addr, flags, read_write,
583 command, protocol, data);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200584 if (res != -EAGAIN)
585 break;
586 if (time_after(jiffies,
587 orig_jiffies + adapter->timeout))
588 break;
589 }
Wolfram Sang22c78d12017-05-23 12:27:17 +0200590
591 if (res != -EOPNOTSUPP || !adapter->algo->master_xfer)
592 goto trace;
593 /*
594 * Fall back to i2c_smbus_xfer_emulated if the adapter doesn't
595 * implement native support for the SMBus operation.
596 */
597 }
598
599 res = i2c_smbus_xfer_emulated(adapter, addr, flags, read_write,
600 command, protocol, data);
601
602trace:
603 /* If enabled, the reply tracepoint is conditional on read_write. */
604 trace_smbus_reply(adapter, addr, flags, read_write,
John Sperbeckd8434c32019-02-12 19:40:57 -0800605 command, protocol, data, res);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200606 trace_smbus_result(adapter, addr, flags, read_write,
607 command, protocol, res);
608
609 return res;
610}
Peter Rosineef5ba12018-06-20 10:51:53 +0200611EXPORT_SYMBOL(__i2c_smbus_xfer);
Wolfram Sang22c78d12017-05-23 12:27:17 +0200612
613/**
614 * i2c_smbus_read_i2c_block_data_or_emulated - read block or emulate
615 * @client: Handle to slave device
616 * @command: Byte interpreted by slave
617 * @length: Size of data block; SMBus allows at most I2C_SMBUS_BLOCK_MAX bytes
618 * @values: Byte array into which data will be read; big enough to hold
619 * the data returned by the slave. SMBus allows at most
620 * I2C_SMBUS_BLOCK_MAX bytes.
621 *
622 * This executes the SMBus "block read" protocol if supported by the adapter.
623 * If block read is not supported, it emulates it using either word or byte
624 * read protocols depending on availability.
625 *
626 * The addresses of the I2C slave device that are accessed with this function
627 * must be mapped to a linear region, so that a block read will have the same
628 * effect as a byte read. Before using this function you must double-check
629 * if the I2C slave does support exchanging a block transfer with a byte
630 * transfer.
631 */
632s32 i2c_smbus_read_i2c_block_data_or_emulated(const struct i2c_client *client,
633 u8 command, u8 length, u8 *values)
634{
635 u8 i = 0;
636 int status;
637
638 if (length > I2C_SMBUS_BLOCK_MAX)
639 length = I2C_SMBUS_BLOCK_MAX;
640
641 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_I2C_BLOCK))
642 return i2c_smbus_read_i2c_block_data(client, command, length, values);
643
644 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_BYTE_DATA))
645 return -EOPNOTSUPP;
646
647 if (i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_READ_WORD_DATA)) {
648 while ((i + 2) <= length) {
649 status = i2c_smbus_read_word_data(client, command + i);
650 if (status < 0)
651 return status;
652 values[i] = status & 0xff;
653 values[i + 1] = status >> 8;
654 i += 2;
655 }
656 }
657
658 while (i < length) {
659 status = i2c_smbus_read_byte_data(client, command + i);
660 if (status < 0)
661 return status;
662 values[i] = status;
663 i++;
664 }
665
666 return i;
667}
668EXPORT_SYMBOL(i2c_smbus_read_i2c_block_data_or_emulated);
Phil Reid3c0a60b2017-08-24 17:31:02 +0800669
670/**
Wolfram Sanged680522020-02-28 18:12:20 +0100671 * i2c_new_smbus_alert_device - get ara client for SMBus alert support
Phil Reid3c0a60b2017-08-24 17:31:02 +0800672 * @adapter: the target adapter
673 * @setup: setup data for the SMBus alert handler
674 * Context: can sleep
675 *
676 * Setup handling of the SMBus alert protocol on a given I2C bus segment.
677 *
678 * Handling can be done either through our IRQ handler, or by the
679 * adapter (from its handler, periodic polling, or whatever).
680 *
Phil Reid3c0a60b2017-08-24 17:31:02 +0800681 * This returns the ara client, which should be saved for later use with
Wolfram Sanged680522020-02-28 18:12:20 +0100682 * i2c_handle_smbus_alert() and ultimately i2c_unregister_device(); or an
683 * ERRPTR to indicate an error.
Phil Reid3c0a60b2017-08-24 17:31:02 +0800684 */
Wolfram Sanged680522020-02-28 18:12:20 +0100685struct i2c_client *i2c_new_smbus_alert_device(struct i2c_adapter *adapter,
686 struct i2c_smbus_alert_setup *setup)
Phil Reid3c0a60b2017-08-24 17:31:02 +0800687{
688 struct i2c_board_info ara_board_info = {
689 I2C_BOARD_INFO("smbus_alert", 0x0c),
690 .platform_data = setup,
691 };
692
Wolfram Sanged680522020-02-28 18:12:20 +0100693 return i2c_new_client_device(adapter, &ara_board_info);
Phil Reid3c0a60b2017-08-24 17:31:02 +0800694}
Wolfram Sanged680522020-02-28 18:12:20 +0100695EXPORT_SYMBOL_GPL(i2c_new_smbus_alert_device);
Phil Reid69d17242017-08-24 17:31:03 +0800696
697#if IS_ENABLED(CONFIG_I2C_SMBUS) && IS_ENABLED(CONFIG_OF)
698int of_i2c_setup_smbus_alert(struct i2c_adapter *adapter)
699{
Phil Reid69d17242017-08-24 17:31:03 +0800700 int irq;
701
702 irq = of_property_match_string(adapter->dev.of_node, "interrupt-names",
703 "smbus_alert");
704 if (irq == -EINVAL || irq == -ENODATA)
705 return 0;
706 else if (irq < 0)
707 return irq;
708
Wolfram Sanged680522020-02-28 18:12:20 +0100709 return PTR_ERR_OR_ZERO(i2c_new_smbus_alert_device(adapter, NULL));
Phil Reid69d17242017-08-24 17:31:03 +0800710}
711EXPORT_SYMBOL_GPL(of_i2c_setup_smbus_alert);
712#endif