Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
i2c.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
13#ifndef ZEPHYR_INCLUDE_DRIVERS_I2C_H_
14#define ZEPHYR_INCLUDE_DRIVERS_I2C_H_
15
25#include <errno.h>
26
27#include <zephyr/types.h>
28#include <zephyr/device.h>
29#include <zephyr/kernel.h>
30#include <zephyr/sys/slist.h>
31#include <zephyr/rtio/rtio.h>
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/*
38 * The following #defines are used to configure the I2C controller.
39 */
40
42#define I2C_SPEED_STANDARD (0x1U)
43
45#define I2C_SPEED_FAST (0x2U)
46
48#define I2C_SPEED_FAST_PLUS (0x3U)
49
51#define I2C_SPEED_HIGH (0x4U)
52
54#define I2C_SPEED_ULTRA (0x5U)
55
57#define I2C_SPEED_DT (0x7U)
58
59#define I2C_SPEED_SHIFT (1U)
60#define I2C_SPEED_SET(speed) (((speed) << I2C_SPEED_SHIFT) \
61 & I2C_SPEED_MASK)
62#define I2C_SPEED_MASK (0x7U << I2C_SPEED_SHIFT) /* 3 bits */
63#define I2C_SPEED_GET(cfg) (((cfg) & I2C_SPEED_MASK) \
64 >> I2C_SPEED_SHIFT)
65
67#define I2C_ADDR_10_BITS BIT(0)
68
70#define I2C_MODE_CONTROLLER BIT(4)
71
79 const struct device *bus;
81};
82
93#define I2C_DT_SPEC_GET_ON_I3C(node_id) \
94 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
95 .addr = DT_PROP_BY_IDX(node_id, reg, 0)
96
107#define I2C_DT_SPEC_GET_ON_I2C(node_id) \
108 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
109 .addr = DT_REG_ADDR(node_id)
110
121#define I2C_DT_SPEC_GET(node_id) \
122 { \
123 COND_CODE_1(DT_ON_BUS(node_id, i3c), \
124 (I2C_DT_SPEC_GET_ON_I3C(node_id)), \
125 (I2C_DT_SPEC_GET_ON_I2C(node_id))) \
126 }
127
136#define I2C_DT_SPEC_INST_GET(inst) \
137 I2C_DT_SPEC_GET(DT_DRV_INST(inst))
138
139
140/*
141 * I2C_MSG_* are I2C Message flags.
142 */
143
145#define I2C_MSG_WRITE (0U << 0U)
146
148#define I2C_MSG_READ BIT(0)
149
151#define I2C_MSG_RW_MASK BIT(0)
155#define I2C_MSG_STOP BIT(1)
156
164#define I2C_MSG_RESTART BIT(2)
165
169#define I2C_MSG_ADDR_10_BITS BIT(3)
170
195
203typedef void (*i2c_callback_t)(const struct device *dev, int result, void *data);
204
211struct i2c_target_config;
212
213typedef int (*i2c_api_configure_t)(const struct device *dev,
214 uint32_t dev_config);
215typedef int (*i2c_api_get_config_t)(const struct device *dev,
216 uint32_t *dev_config);
217typedef int (*i2c_api_full_io_t)(const struct device *dev,
218 struct i2c_msg *msgs,
219 uint8_t num_msgs,
220 uint16_t addr);
221typedef int (*i2c_api_target_register_t)(const struct device *dev,
222 struct i2c_target_config *cfg);
223typedef int (*i2c_api_target_unregister_t)(const struct device *dev,
224 struct i2c_target_config *cfg);
225#ifdef CONFIG_I2C_CALLBACK
226typedef int (*i2c_api_transfer_cb_t)(const struct device *dev,
227 struct i2c_msg *msgs,
228 uint8_t num_msgs,
229 uint16_t addr,
231 void *userdata);
232#endif /* CONFIG_I2C_CALLBACK */
233#if defined(CONFIG_I2C_RTIO) || defined(__DOXYGEN__)
234
239typedef void (*i2c_api_iodev_submit)(const struct device *dev,
240 struct rtio_iodev_sqe *iodev_sqe);
241#endif /* CONFIG_I2C_RTIO */
242
243typedef int (*i2c_api_recover_bus_t)(const struct device *dev);
244
245__subsystem struct i2c_driver_api {
246 i2c_api_configure_t configure;
247 i2c_api_get_config_t get_config;
248 i2c_api_full_io_t transfer;
249 i2c_api_target_register_t target_register;
250 i2c_api_target_unregister_t target_unregister;
251#ifdef CONFIG_I2C_CALLBACK
252 i2c_api_transfer_cb_t transfer_cb;
253#endif
254#ifdef CONFIG_I2C_RTIO
255 i2c_api_iodev_submit iodev_submit;
256#endif
257 i2c_api_recover_bus_t recover_bus;
258};
259
260typedef int (*i2c_target_api_register_t)(const struct device *dev);
261typedef int (*i2c_target_api_unregister_t)(const struct device *dev);
262
263__subsystem struct i2c_target_driver_api {
264 i2c_target_api_register_t driver_register;
265 i2c_target_api_unregister_t driver_unregister;
266};
267
273#define I2C_TARGET_FLAGS_ADDR_10_BITS BIT(0)
274
291 struct i2c_target_config *config);
292
312 struct i2c_target_config *config, uint8_t val);
313
334 struct i2c_target_config *config, uint8_t *val);
335
356 struct i2c_target_config *config, uint8_t *val);
357
358#ifdef CONFIG_I2C_TARGET_BUFFER_MODE
372typedef void (*i2c_target_buf_write_received_cb_t)(
373 struct i2c_target_config *config, uint8_t *ptr, uint32_t len);
374
397typedef int (*i2c_target_buf_read_requested_cb_t)(
398 struct i2c_target_config *config, uint8_t **ptr, uint32_t *len);
399#endif
400
415typedef int (*i2c_target_stop_cb_t)(struct i2c_target_config *config);
416
428#ifdef CONFIG_I2C_TARGET_BUFFER_MODE
429 i2c_target_buf_write_received_cb_t buf_write_received;
430 i2c_target_buf_read_requested_cb_t buf_read_requested;
431#endif
433};
434
459
468static inline bool i2c_is_ready_dt(const struct i2c_dt_spec *spec)
469{
470 /* Validate bus is ready */
471 return device_is_ready(spec->bus);
472}
473
481static inline bool i2c_is_read_op(const struct i2c_msg *msg)
482{
483 return (msg->flags & I2C_MSG_READ) == I2C_MSG_READ;
484}
485
493static inline bool i2c_is_stop_op(const struct i2c_msg *msg)
494{
495 return (msg->flags & I2C_MSG_STOP) == I2C_MSG_STOP;
496}
497
524void i2c_dump_msgs_rw(const struct device *dev, const struct i2c_msg *msgs, uint8_t num_msgs,
525 uint16_t addr, bool dump_read);
526
541static inline void i2c_dump_msgs(const struct device *dev, const struct i2c_msg *msgs,
542 uint8_t num_msgs, uint16_t addr)
543{
544 i2c_dump_msgs_rw(dev, msgs, num_msgs, addr, false);
545}
546
547#if defined(CONFIG_I2C_STATS) || defined(__DOXYGEN__)
548
549#include <zephyr/stats/stats.h>
550
554STATS_SECT_ENTRY32(bytes_read)
555STATS_SECT_ENTRY32(bytes_written)
556STATS_SECT_ENTRY32(message_count)
557STATS_SECT_ENTRY32(transfer_call_count)
559
561STATS_NAME(i2c, bytes_read)
562STATS_NAME(i2c, bytes_written)
563STATS_NAME(i2c, message_count)
564STATS_NAME(i2c, transfer_call_count)
565STATS_NAME_END(i2c);
566
575 struct stats_i2c stats;
576};
577
585static inline void i2c_xfer_stats(const struct device *dev, struct i2c_msg *msgs,
586 uint8_t num_msgs)
587{
588 struct i2c_device_state *state =
590 uint32_t bytes_read = 0U;
591 uint32_t bytes_written = 0U;
592
593 STATS_INC(state->stats, transfer_call_count);
594 STATS_INCN(state->stats, message_count, num_msgs);
595 for (uint8_t i = 0U; i < num_msgs; i++) {
596 if (msgs[i].flags & I2C_MSG_READ) {
597 bytes_read += msgs[i].len;
598 } else {
599 bytes_written += msgs[i].len;
600 }
601 }
602 STATS_INCN(state->stats, bytes_read, bytes_read);
603 STATS_INCN(state->stats, bytes_written, bytes_written);
604}
605
611#define Z_I2C_DEVICE_STATE_DEFINE(dev_id) \
612 static struct i2c_device_state Z_DEVICE_STATE_NAME(dev_id) \
613 __attribute__((__section__(".z_devstate")))
614
621#define Z_I2C_INIT_FN(dev_id, init_fn) \
622 static inline int UTIL_CAT(dev_id, _init)(const struct device *dev) \
623 { \
624 struct i2c_device_state *state = \
625 CONTAINER_OF(dev->state, struct i2c_device_state, devstate); \
626 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 4, \
627 STATS_NAME_INIT_PARMS(i2c)); \
628 stats_register(dev->name, &(state->stats.s_hdr)); \
629 if (!is_null_no_warn(init_fn)) { \
630 return init_fn(dev); \
631 } \
632 \
633 return 0; \
634 }
635
667#define I2C_DEVICE_DT_DEINIT_DEFINE(node_id, init_fn, deinit_fn, pm, \
668 data, config, level, prio, api, ...)\
669 Z_I2C_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
670 Z_I2C_INIT_FN(Z_DEVICE_DT_DEV_ID(node_id), init_fn) \
671 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
672 DEVICE_DT_NAME(node_id), \
673 &UTIL_CAT(Z_DEVICE_DT_DEV_ID(node_id), _init), \
674 deinit_fn, Z_DEVICE_DT_FLAGS(node_id), pm, data,\
675 config, level, prio, api, \
676 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)).devstate), \
677 __VA_ARGS__)
678
679#else /* CONFIG_I2C_STATS */
680
681static inline void i2c_xfer_stats(const struct device *dev, struct i2c_msg *msgs,
682 uint8_t num_msgs)
683{
684 ARG_UNUSED(dev);
685 ARG_UNUSED(msgs);
686 ARG_UNUSED(num_msgs);
687}
688
689#define I2C_DEVICE_DT_DEINIT_DEFINE(node_id, init_fn, deinit_fn, pm, \
690 data, config, level, prio, api, ...)\
691 DEVICE_DT_DEINIT_DEFINE(node_id, init_fn, deinit_fn, pm, data, \
692 config, level, prio, api, __VA_ARGS__)
693
694#endif /* CONFIG_I2C_STATS */
695
699#define I2C_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
700 prio, api, ...) \
701 I2C_DEVICE_DT_DEINIT_DEFINE(node_id, init_fn, NULL, pm, data, \
702 config, level, prio, api, \
703 __VA_ARGS__)
704
713#define I2C_DEVICE_DT_INST_DEINIT_DEFINE(inst, ...) \
714 I2C_DEVICE_DT_DEINIT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
715
724#define I2C_DEVICE_DT_INST_DEFINE(inst, ...) \
725 I2C_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
726
737__syscall int i2c_configure(const struct device *dev, uint32_t dev_config);
738
739static inline int z_impl_i2c_configure(const struct device *dev,
740 uint32_t dev_config)
741{
742 const struct i2c_driver_api *api =
743 (const struct i2c_driver_api *)dev->api;
744
745 return api->configure(dev, dev_config);
746}
747
761static inline int i2c_configure_dt(const struct i2c_dt_spec *spec,
762 uint32_t dev_config)
763{
764 return i2c_configure(spec->bus, dev_config);
765}
766
787__syscall int i2c_get_config(const struct device *dev, uint32_t *dev_config);
788
789static inline int z_impl_i2c_get_config(const struct device *dev, uint32_t *dev_config)
790{
791 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
792
793 if (api->get_config == NULL) {
794 return -ENOSYS;
795 }
796
797 return api->get_config(dev, dev_config);
798}
799
831__syscall int i2c_transfer(const struct device *dev,
832 struct i2c_msg *msgs, uint8_t num_msgs,
833 uint16_t addr);
834
835static inline int z_impl_i2c_transfer(const struct device *dev,
836 struct i2c_msg *msgs, uint8_t num_msgs,
837 uint16_t addr)
838{
839 const struct i2c_driver_api *api =
840 (const struct i2c_driver_api *)dev->api;
841
842 if (!num_msgs) {
843 return 0;
844 }
845
846 if (!IS_ENABLED(CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS)) {
847 msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
848 }
849
850 int res = api->transfer(dev, msgs, num_msgs, addr);
851
852 i2c_xfer_stats(dev, msgs, num_msgs);
853
854 if (IS_ENABLED(CONFIG_I2C_DUMP_MESSAGES)) {
855 i2c_dump_msgs_rw(dev, msgs, num_msgs, addr, true);
856 }
857
858 return res;
859}
860
861#if defined(CONFIG_I2C_CALLBACK) || defined(__DOXYGEN__)
862
885static inline int i2c_transfer_cb(const struct device *dev,
886 struct i2c_msg *msgs,
887 uint8_t num_msgs,
888 uint16_t addr,
890 void *userdata)
891{
892 const struct i2c_driver_api *api =
893 (const struct i2c_driver_api *)dev->api;
894
895 if (api->transfer_cb == NULL) {
896 return -ENOSYS;
897 }
898
899 if (!num_msgs) {
900 cb(dev, 0, userdata);
901 return 0;
902 }
903
904 if (!IS_ENABLED(CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS)) {
905 msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
906 }
907
908 return api->transfer_cb(dev, msgs, num_msgs, addr, cb, userdata);
909}
910
926static inline int i2c_transfer_cb_dt(const struct i2c_dt_spec *spec,
927 struct i2c_msg *msgs,
928 uint8_t num_msgs,
930 void *userdata)
931{
932 return i2c_transfer_cb(spec->bus, msgs, num_msgs, spec->addr, cb, userdata);
933}
934
958static inline int i2c_write_read_cb(const struct device *dev, struct i2c_msg *msgs,
959 uint8_t num_msgs, uint16_t addr, const void *write_buf,
960 size_t num_write, void *read_buf, size_t num_read,
961 i2c_callback_t cb, void *userdata)
962{
963 if ((msgs == NULL) || (num_msgs != 2)) {
964 return -EINVAL;
965 }
966
967 msgs[0].buf = (uint8_t *)write_buf;
968 msgs[0].len = num_write;
969 msgs[0].flags = I2C_MSG_WRITE;
970
971 msgs[1].buf = (uint8_t *)read_buf;
972 msgs[1].len = num_read;
974
975 return i2c_transfer_cb(dev, msgs, num_msgs, addr, cb, userdata);
976}
977
999static inline int i2c_write_read_cb_dt(const struct i2c_dt_spec *spec, struct i2c_msg *msgs,
1000 uint8_t num_msgs, const void *write_buf, size_t num_write,
1001 void *read_buf, size_t num_read, i2c_callback_t cb,
1002 void *userdata)
1003{
1004 return i2c_write_read_cb(spec->bus, msgs, num_msgs, spec->addr, write_buf, num_write,
1005 read_buf, num_read, cb, userdata);
1006}
1007
1008#if defined(CONFIG_POLL) || defined(__DOXYGEN__)
1009
1011void z_i2c_transfer_signal_cb(const struct device *dev, int result, void *userdata);
1035static inline int i2c_transfer_signal(const struct device *dev,
1036 struct i2c_msg *msgs,
1037 uint8_t num_msgs,
1038 uint16_t addr,
1039 struct k_poll_signal *sig)
1040{
1041 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
1042
1043 if (api->transfer_cb == NULL) {
1044 return -ENOSYS;
1045 }
1046
1047 return api->transfer_cb(dev, msgs, num_msgs, addr, z_i2c_transfer_signal_cb, sig);
1048}
1049
1050#endif /* CONFIG_POLL */
1051
1052#endif /* CONFIG_I2C_CALLBACK */
1053
1054
1055#if defined(CONFIG_I2C_RTIO) || defined(__DOXYGEN__)
1056
1067void i2c_iodev_submit_fallback(const struct device *dev, struct rtio_iodev_sqe *iodev_sqe);
1068
1075static inline void i2c_iodev_submit(struct rtio_iodev_sqe *iodev_sqe)
1076{
1077 const struct i2c_dt_spec *dt_spec = (const struct i2c_dt_spec *)iodev_sqe->sqe.iodev->data;
1078 const struct device *dev = dt_spec->bus;
1079 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
1080
1081 if (api->iodev_submit == NULL) {
1082 rtio_iodev_sqe_err(iodev_sqe, -ENOSYS);
1083 return;
1084 }
1085 api->iodev_submit(dt_spec->bus, iodev_sqe);
1086}
1087
1088extern const struct rtio_iodev_api i2c_iodev_api;
1089
1090#define I2C_CAT2(x, y) x ## y
1091
1101#define I2C_DT_IODEV_DEFINE(name, node_id) \
1102 const struct i2c_dt_spec _i2c_dt_spec_##name = \
1103 I2C_DT_SPEC_GET(node_id); \
1104 RTIO_IODEV_DEFINE(name, &i2c_iodev_api, (void *)&_i2c_dt_spec_##name)
1105
1116#define I2C_IODEV_DEFINE(name, _bus, _addr) \
1117 const struct i2c_dt_spec I2C_CAT2(_i2c_dt_spec_, name) = { \
1118 .bus = DEVICE_DT_GET(_bus), \
1119 .addr = _addr, \
1120 }; \
1121 RTIO_IODEV_DEFINE(name, &i2c_iodev_api, (void *)&I2C_CAT2(_i2c_dt_spec_, name))
1122
1131static inline bool i2c_is_ready_iodev(const struct rtio_iodev *i2c_iodev)
1132{
1133 struct i2c_dt_spec *spec = (struct i2c_dt_spec *)i2c_iodev->data;
1134
1135 return i2c_is_ready_dt(spec);
1136}
1137
1150 struct rtio_iodev *iodev,
1151 const struct i2c_msg *msgs,
1152 uint8_t num_msgs);
1153
1166 uint8_t reg_addr, uint8_t data);
1167
1181 uint8_t start_addr, void *buf, size_t num_bytes);
1182
1183#endif /* CONFIG_I2C_RTIO */
1184
1198static inline int i2c_transfer_dt(const struct i2c_dt_spec *spec,
1199 struct i2c_msg *msgs, uint8_t num_msgs)
1200{
1201 return i2c_transfer(spec->bus, msgs, num_msgs, spec->addr);
1202}
1203
1216__syscall int i2c_recover_bus(const struct device *dev);
1217
1218static inline int z_impl_i2c_recover_bus(const struct device *dev)
1219{
1220 const struct i2c_driver_api *api =
1221 (const struct i2c_driver_api *)dev->api;
1222
1223 if (api->recover_bus == NULL) {
1224 return -ENOSYS;
1225 }
1226
1227 return api->recover_bus(dev);
1228}
1229
1254static inline int i2c_target_register(const struct device *dev,
1255 struct i2c_target_config *cfg)
1256{
1257 const struct i2c_driver_api *api =
1258 (const struct i2c_driver_api *)dev->api;
1259
1260 if (api->target_register == NULL) {
1261 return -ENOSYS;
1262 }
1263
1264 return api->target_register(dev, cfg);
1265}
1266
1283static inline int i2c_target_unregister(const struct device *dev,
1284 struct i2c_target_config *cfg)
1285{
1286 const struct i2c_driver_api *api =
1287 (const struct i2c_driver_api *)dev->api;
1288
1289 if (api->target_unregister == NULL) {
1290 return -ENOSYS;
1291 }
1292
1293 return api->target_unregister(dev, cfg);
1294}
1295
1309__syscall int i2c_target_driver_register(const struct device *dev);
1310
1311static inline int z_impl_i2c_target_driver_register(const struct device *dev)
1312{
1313 const struct i2c_target_driver_api *api =
1314 (const struct i2c_target_driver_api *)dev->api;
1315
1316 return api->driver_register(dev);
1317}
1318
1332__syscall int i2c_target_driver_unregister(const struct device *dev);
1333
1334static inline int z_impl_i2c_target_driver_unregister(const struct device *dev)
1335{
1336 const struct i2c_target_driver_api *api =
1337 (const struct i2c_target_driver_api *)dev->api;
1338
1339 return api->driver_unregister(dev);
1340}
1341
1342/*
1343 * Derived i2c APIs -- all implemented in terms of i2c_transfer()
1344 */
1345
1360static inline int i2c_write(const struct device *dev, const uint8_t *buf,
1361 uint32_t num_bytes, uint16_t addr)
1362{
1363 struct i2c_msg msg;
1364
1365 msg.buf = (uint8_t *)buf;
1366 msg.len = num_bytes;
1368
1369 return i2c_transfer(dev, &msg, 1, addr);
1370}
1371
1385static inline int i2c_write_dt(const struct i2c_dt_spec *spec,
1386 const uint8_t *buf, uint32_t num_bytes)
1387{
1388 return i2c_write(spec->bus, buf, num_bytes, spec->addr);
1389}
1390
1405static inline int i2c_read(const struct device *dev, uint8_t *buf,
1406 uint32_t num_bytes, uint16_t addr)
1407{
1408 struct i2c_msg msg;
1409
1410 msg.buf = buf;
1411 msg.len = num_bytes;
1413
1414 return i2c_transfer(dev, &msg, 1, addr);
1415}
1416
1430static inline int i2c_read_dt(const struct i2c_dt_spec *spec,
1431 uint8_t *buf, uint32_t num_bytes)
1432{
1433 return i2c_read(spec->bus, buf, num_bytes, spec->addr);
1434}
1435
1454static inline int i2c_write_read(const struct device *dev, uint16_t addr,
1455 const void *write_buf, size_t num_write,
1456 void *read_buf, size_t num_read)
1457{
1458 struct i2c_msg msg[2];
1459
1460 msg[0].buf = (uint8_t *)write_buf;
1461 msg[0].len = num_write;
1462 msg[0].flags = I2C_MSG_WRITE;
1463
1464 msg[1].buf = (uint8_t *)read_buf;
1465 msg[1].len = num_read;
1467
1468 return i2c_transfer(dev, msg, 2, addr);
1469}
1470
1488static inline int i2c_write_read_dt(const struct i2c_dt_spec *spec,
1489 const void *write_buf, size_t num_write,
1490 void *read_buf, size_t num_read)
1491{
1492 return i2c_write_read(spec->bus, spec->addr,
1493 write_buf, num_write,
1494 read_buf, num_read);
1495}
1496
1515static inline int i2c_burst_read(const struct device *dev,
1516 uint16_t dev_addr,
1517 uint8_t start_addr,
1518 uint8_t *buf,
1519 uint32_t num_bytes)
1520{
1521 return i2c_write_read(dev, dev_addr,
1522 &start_addr, sizeof(start_addr),
1523 buf, num_bytes);
1524}
1525
1540static inline int i2c_burst_read_dt(const struct i2c_dt_spec *spec,
1541 uint8_t start_addr,
1542 uint8_t *buf,
1543 uint32_t num_bytes)
1544{
1545 return i2c_burst_read(spec->bus, spec->addr,
1546 start_addr, buf, num_bytes);
1547}
1548
1570static inline int i2c_burst_write(const struct device *dev,
1571 uint16_t dev_addr,
1572 uint8_t start_addr,
1573 const uint8_t *buf,
1574 uint32_t num_bytes)
1575{
1576 struct i2c_msg msg[2];
1577
1578 msg[0].buf = &start_addr;
1579 msg[0].len = 1U;
1580 msg[0].flags = I2C_MSG_WRITE;
1581
1582 msg[1].buf = (uint8_t *)buf;
1583 msg[1].len = num_bytes;
1584 msg[1].flags = I2C_MSG_WRITE | I2C_MSG_STOP;
1585
1586 return i2c_transfer(dev, msg, 2, dev_addr);
1587}
1588
1603static inline int i2c_burst_write_dt(const struct i2c_dt_spec *spec,
1604 uint8_t start_addr,
1605 const uint8_t *buf,
1606 uint32_t num_bytes)
1607{
1608 return i2c_burst_write(spec->bus, spec->addr,
1609 start_addr, buf, num_bytes);
1610}
1611
1627static inline int i2c_reg_read_byte(const struct device *dev,
1628 uint16_t dev_addr,
1629 uint8_t reg_addr, uint8_t *value)
1630{
1631 return i2c_write_read(dev, dev_addr,
1632 &reg_addr, sizeof(reg_addr),
1633 value, sizeof(*value));
1634}
1635
1649static inline int i2c_reg_read_byte_dt(const struct i2c_dt_spec *spec,
1650 uint8_t reg_addr, uint8_t *value)
1651{
1652 return i2c_reg_read_byte(spec->bus, spec->addr, reg_addr, value);
1653}
1654
1673static inline int i2c_reg_write_byte(const struct device *dev,
1674 uint16_t dev_addr,
1675 uint8_t reg_addr, uint8_t value)
1676{
1677 uint8_t tx_buf[2] = {reg_addr, value};
1678
1679 return i2c_write(dev, tx_buf, 2, dev_addr);
1680}
1681
1695static inline int i2c_reg_write_byte_dt(const struct i2c_dt_spec *spec,
1696 uint8_t reg_addr, uint8_t value)
1697{
1698 return i2c_reg_write_byte(spec->bus, spec->addr, reg_addr, value);
1699}
1700
1720static inline int i2c_reg_update_byte(const struct device *dev,
1721 uint8_t dev_addr,
1722 uint8_t reg_addr, uint8_t mask,
1723 uint8_t value)
1724{
1725 uint8_t old_value, new_value;
1726 int rc;
1727
1728 rc = i2c_reg_read_byte(dev, dev_addr, reg_addr, &old_value);
1729 if (rc != 0) {
1730 return rc;
1731 }
1732
1733 new_value = (old_value & ~mask) | (value & mask);
1734 if (new_value == old_value) {
1735 return 0;
1736 }
1737
1738 return i2c_reg_write_byte(dev, dev_addr, reg_addr, new_value);
1739}
1740
1755static inline int i2c_reg_update_byte_dt(const struct i2c_dt_spec *spec,
1756 uint8_t reg_addr, uint8_t mask,
1757 uint8_t value)
1758{
1759 return i2c_reg_update_byte(spec->bus, spec->addr,
1760 reg_addr, mask, value);
1761}
1762
1763#ifdef __cplusplus
1764}
1765#endif
1766
1771#include <zephyr/syscalls/i2c.h>
1772
1773#endif /* ZEPHYR_INCLUDE_DRIVERS_I2C_H_ */
workaround assembler barfing for ST r
Definition asm-macro-32-bit-gnu.h:24
System error numbers.
bool device_is_ready(const struct device *dev)
Verify that a device is ready for use.
static int i2c_transfer_cb_dt(const struct i2c_dt_spec *spec, struct i2c_msg *msgs, uint8_t num_msgs, i2c_callback_t cb, void *userdata)
Perform data transfer to another I2C device in master mode asynchronously.
Definition i2c.h:926
int i2c_target_driver_unregister(const struct device *dev)
Instructs the I2C Target device to unregister itself from the I2C Controller.
static int i2c_burst_write_dt(const struct i2c_dt_spec *spec, uint8_t start_addr, const uint8_t *buf, uint32_t num_bytes)
Write multiple bytes to an internal address of an I2C device.
Definition i2c.h:1603
static int i2c_target_unregister(const struct device *dev, struct i2c_target_config *cfg)
Unregisters the provided config as Target device.
Definition i2c.h:1283
static int i2c_write_read(const struct device *dev, uint16_t addr, const void *write_buf, size_t num_write, void *read_buf, size_t num_read)
Write then read data from an I2C device.
Definition i2c.h:1454
int i2c_target_driver_register(const struct device *dev)
Instructs the I2C Target device to register itself to the I2C Controller.
static void i2c_iodev_submit(struct rtio_iodev_sqe *iodev_sqe)
Submit request(s) to an I2C device with RTIO.
Definition i2c.h:1075
struct rtio_sqe * i2c_rtio_copy(struct rtio *r, struct rtio_iodev *iodev, const struct i2c_msg *msgs, uint8_t num_msgs)
Copy the i2c_msgs into a set of RTIO requests.
void i2c_dump_msgs_rw(const struct device *dev, const struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr, bool dump_read)
Dump out an I2C message.
int(* i2c_target_read_requested_cb_t)(struct i2c_target_config *config, uint8_t *val)
Function called when a read from the device is initiated.
Definition i2c.h:333
int i2c_transfer(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr)
Perform data transfer to another I2C device in controller mode.
static int i2c_write(const struct device *dev, const uint8_t *buf, uint32_t num_bytes, uint16_t addr)
Write a set amount of data to an I2C device.
Definition i2c.h:1360
static int i2c_write_dt(const struct i2c_dt_spec *spec, const uint8_t *buf, uint32_t num_bytes)
Write a set amount of data to an I2C device.
Definition i2c.h:1385
static int i2c_write_read_dt(const struct i2c_dt_spec *spec, const void *write_buf, size_t num_write, void *read_buf, size_t num_read)
Write then read data from an I2C device.
Definition i2c.h:1488
static int i2c_write_read_cb(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr, const void *write_buf, size_t num_write, void *read_buf, size_t num_read, i2c_callback_t cb, void *userdata)
Write then read data from an I2C device asynchronously.
Definition i2c.h:958
static bool i2c_is_stop_op(const struct i2c_msg *msg)
Check if the current message includes a stop.
Definition i2c.h:493
int(* i2c_target_stop_cb_t)(struct i2c_target_config *config)
Function called when a stop condition is observed after a start condition addressed to a particular d...
Definition i2c.h:415
static bool i2c_is_ready_iodev(const struct rtio_iodev *i2c_iodev)
Validate that I2C bus is ready.
Definition i2c.h:1131
static int i2c_burst_read(const struct device *dev, uint16_t dev_addr, uint8_t start_addr, uint8_t *buf, uint32_t num_bytes)
Read multiple bytes from an internal address of an I2C device.
Definition i2c.h:1515
int(* i2c_target_read_processed_cb_t)(struct i2c_target_config *config, uint8_t *val)
Function called when a read from the device is continued.
Definition i2c.h:355
int(* i2c_target_write_requested_cb_t)(struct i2c_target_config *config)
Function called when a write to the device is initiated.
Definition i2c.h:290
void i2c_iodev_submit_fallback(const struct device *dev, struct rtio_iodev_sqe *iodev_sqe)
Fallback submit implementation.
static int i2c_reg_update_byte_dt(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint8_t mask, uint8_t value)
Update internal register of an I2C device.
Definition i2c.h:1755
void(* i2c_callback_t)(const struct device *dev, int result, void *data)
I2C callback for asynchronous transfer requests.
Definition i2c.h:203
static int i2c_read_dt(const struct i2c_dt_spec *spec, uint8_t *buf, uint32_t num_bytes)
Read a set amount of data from an I2C device.
Definition i2c.h:1430
int(* i2c_target_write_received_cb_t)(struct i2c_target_config *config, uint8_t val)
Function called when a write to the device is continued.
Definition i2c.h:311
static int i2c_reg_write_byte_dt(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint8_t value)
Write internal register of an I2C device.
Definition i2c.h:1695
int i2c_get_config(const struct device *dev, uint32_t *dev_config)
Get configuration of a host controller.
static int i2c_reg_write_byte(const struct device *dev, uint16_t dev_addr, uint8_t reg_addr, uint8_t value)
Write internal register of an I2C device.
Definition i2c.h:1673
#define I2C_MSG_READ
Read message from I2C bus.
Definition i2c.h:148
static int i2c_reg_read_byte_dt(const struct i2c_dt_spec *spec, uint8_t reg_addr, uint8_t *value)
Read internal register of an I2C device.
Definition i2c.h:1649
int i2c_configure(const struct device *dev, uint32_t dev_config)
Configure operation of a host controller.
static int i2c_configure_dt(const struct i2c_dt_spec *spec, uint32_t dev_config)
Configure operation of a host controller.
Definition i2c.h:761
static int i2c_write_read_cb_dt(const struct i2c_dt_spec *spec, struct i2c_msg *msgs, uint8_t num_msgs, const void *write_buf, size_t num_write, void *read_buf, size_t num_read, i2c_callback_t cb, void *userdata)
Write then read data from an I2C device asynchronously.
Definition i2c.h:999
#define I2C_MSG_RESTART
RESTART I2C transaction for this message.
Definition i2c.h:164
static int i2c_transfer_dt(const struct i2c_dt_spec *spec, struct i2c_msg *msgs, uint8_t num_msgs)
Perform data transfer to another I2C device in controller mode.
Definition i2c.h:1198
int i2c_recover_bus(const struct device *dev)
Recover the I2C bus.
static int i2c_read(const struct device *dev, uint8_t *buf, uint32_t num_bytes, uint16_t addr)
Read a set amount of data from an I2C device.
Definition i2c.h:1405
static bool i2c_is_read_op(const struct i2c_msg *msg)
Check if the current message is a read operation.
Definition i2c.h:481
static int i2c_burst_read_dt(const struct i2c_dt_spec *spec, uint8_t start_addr, uint8_t *buf, uint32_t num_bytes)
Read multiple bytes from an internal address of an I2C device.
Definition i2c.h:1540
static int i2c_target_register(const struct device *dev, struct i2c_target_config *cfg)
Registers the provided config as Target device of a controller.
Definition i2c.h:1254
static int i2c_transfer_cb(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr, i2c_callback_t cb, void *userdata)
Perform data transfer to another I2C device in controller mode.
Definition i2c.h:885
#define I2C_MSG_STOP
Send STOP after this message.
Definition i2c.h:155
static void i2c_xfer_stats(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs)
Updates the i2c stats for i2c transfers.
Definition i2c.h:585
static void i2c_dump_msgs(const struct device *dev, const struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr)
Dump out an I2C message, before it is executed.
Definition i2c.h:541
static int i2c_transfer_signal(const struct device *dev, struct i2c_msg *msgs, uint8_t num_msgs, uint16_t addr, struct k_poll_signal *sig)
Perform data transfer to another I2C device in controller mode.
Definition i2c.h:1035
static int i2c_reg_update_byte(const struct device *dev, uint8_t dev_addr, uint8_t reg_addr, uint8_t mask, uint8_t value)
Update internal register of an I2C device.
Definition i2c.h:1720
const struct rtio_iodev_api i2c_iodev_api
struct rtio_sqe * i2c_rtio_copy_reg_write_byte(struct rtio *r, struct rtio_iodev *iodev, uint8_t reg_addr, uint8_t data)
Copy the register address and data to a SQE.
#define I2C_MSG_WRITE
Write message to I2C bus.
Definition i2c.h:145
static int i2c_reg_read_byte(const struct device *dev, uint16_t dev_addr, uint8_t reg_addr, uint8_t *value)
Read internal register of an I2C device.
Definition i2c.h:1627
static int i2c_burst_write(const struct device *dev, uint16_t dev_addr, uint8_t start_addr, const uint8_t *buf, uint32_t num_bytes)
Write multiple bytes to an internal address of an I2C device.
Definition i2c.h:1570
struct rtio_sqe * i2c_rtio_copy_reg_burst_read(struct rtio *r, struct rtio_iodev *iodev, uint8_t start_addr, void *buf, size_t num_bytes)
acquire and configure a i2c burst read transmission
static bool i2c_is_ready_dt(const struct i2c_dt_spec *spec)
Validate that I2C bus is ready.
Definition i2c.h:468
static void rtio_iodev_sqe_err(struct rtio_iodev_sqe *iodev_sqe, int result)
Inform the executor of a submissions completion with error.
Definition rtio.h:1358
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:148
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:285
#define EINVAL
Invalid argument.
Definition errno.h:60
#define ENOSYS
Function not implemented.
Definition errno.h:82
#define NULL
Definition iar_missing_defs.h:20
Public kernel APIs.
flags
Definition parser.h:97
state
Definition parser_state.h:29
Real-Time IO device API for moving bytes with low effort.
Statistics.
#define STATS_NAME_END(name__)
Definition stats.h:391
#define STATS_NAME(name__, entry__)
Definition stats.h:390
#define STATS_SECT_END
Ends a stats group struct definition.
Definition stats.h:89
#define STATS_SECT_ENTRY32(var__)
Definition stats.h:359
#define STATS_INC(group__, var__)
Definition stats.h:364
#define STATS_NAME_START(name__)
Definition stats.h:389
#define STATS_INCN(group__, var__, n__)
Definition stats.h:363
#define STATS_SECT_START(group__)
Definition stats.h:354
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Runtime device dynamic structure (in RAM) per driver instance.
Definition device.h:455
Runtime device structure (in ROM) per driver instance.
Definition device.h:510
void * data
Address of the device instance private data.
Definition device.h:520
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:516
struct device_state * state
Address of the common device state.
Definition device.h:518
I2C specific device state which allows for i2c device class specific additions.
Definition i2c.h:573
struct stats_i2c stats
Definition i2c.h:575
struct device_state devstate
Definition i2c.h:574
Complete I2C DT information.
Definition i2c.h:78
const struct device * bus
Definition i2c.h:79
uint16_t addr
Definition i2c.h:80
One I2C Message.
Definition i2c.h:185
uint8_t * buf
Data buffer in bytes.
Definition i2c.h:187
uint32_t len
Length of buffer in bytes.
Definition i2c.h:190
uint8_t flags
Flags for this message.
Definition i2c.h:193
Structure providing callbacks to be implemented for devices that supports the I2C target API.
Definition i2c.h:423
i2c_target_read_requested_cb_t read_requested
Definition i2c.h:425
i2c_target_write_received_cb_t write_received
Definition i2c.h:426
i2c_target_read_processed_cb_t read_processed
Definition i2c.h:427
i2c_target_write_requested_cb_t write_requested
Definition i2c.h:424
i2c_target_stop_cb_t stop
Definition i2c.h:432
Structure describing a device that supports the I2C target API.
Definition i2c.h:446
uint8_t flags
Flags for the target device defined by I2C_TARGET_FLAGS_* constants.
Definition i2c.h:451
uint16_t address
Address for this target device.
Definition i2c.h:454
sys_snode_t node
Private, do not modify.
Definition i2c.h:448
const struct i2c_target_callbacks * callbacks
Callback functions.
Definition i2c.h:457
Definition kernel.h:6127
API that an RTIO IO device should implement.
Definition rtio.h:524
Compute the mempool block index for a given pointer.
Definition rtio.h:514
struct rtio_sqe sqe
Definition rtio.h:515
An IO device with a function table for submitting requests.
Definition rtio.h:539
void * data
Definition rtio.h:544
A submission queue event.
Definition rtio.h:295
const struct rtio_iodev * iodev
Device to operation on.
Definition rtio.h:304
const uint8_t * buf
Buffer to write from.
Definition rtio.h:320
An RTIO context containing what can be viewed as a pair of queues.
Definition rtio.h:418