Zephyr API Documentation 4.1.99
A Scalable Open Source RTOS
 4.1.99
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
i2c.h
Go to the documentation of this file.
1
7/*
8 * Copyright (c) 2015 Intel Corporation
9 *
10 * SPDX-License-Identifier: Apache-2.0
11 */
12#ifndef ZEPHYR_INCLUDE_DRIVERS_I2C_H_
13#define ZEPHYR_INCLUDE_DRIVERS_I2C_H_
14
24#include <errno.h>
25
26#include <zephyr/types.h>
27#include <zephyr/device.h>
28#include <zephyr/kernel.h>
29#include <zephyr/sys/slist.h>
30#include <zephyr/rtio/rtio.h>
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36/*
37 * The following #defines are used to configure the I2C controller.
38 */
39
41#define I2C_SPEED_STANDARD (0x1U)
42
44#define I2C_SPEED_FAST (0x2U)
45
47#define I2C_SPEED_FAST_PLUS (0x3U)
48
50#define I2C_SPEED_HIGH (0x4U)
51
53#define I2C_SPEED_ULTRA (0x5U)
54
56#define I2C_SPEED_DT (0x7U)
57
58#define I2C_SPEED_SHIFT (1U)
59#define I2C_SPEED_SET(speed) (((speed) << I2C_SPEED_SHIFT) \
60 & I2C_SPEED_MASK)
61#define I2C_SPEED_MASK (0x7U << I2C_SPEED_SHIFT) /* 3 bits */
62#define I2C_SPEED_GET(cfg) (((cfg) & I2C_SPEED_MASK) \
63 >> I2C_SPEED_SHIFT)
64
66#define I2C_ADDR_10_BITS BIT(0)
67
69#define I2C_MODE_CONTROLLER BIT(4)
70
78 const struct device *bus;
80};
81
92#define I2C_DT_SPEC_GET_ON_I3C(node_id) \
93 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
94 .addr = DT_PROP_BY_IDX(node_id, reg, 0)
95
106#define I2C_DT_SPEC_GET_ON_I2C(node_id) \
107 .bus = DEVICE_DT_GET(DT_BUS(node_id)), \
108 .addr = DT_REG_ADDR(node_id)
109
120#define I2C_DT_SPEC_GET(node_id) \
121 { \
122 COND_CODE_1(DT_ON_BUS(node_id, i3c), \
123 (I2C_DT_SPEC_GET_ON_I3C(node_id)), \
124 (I2C_DT_SPEC_GET_ON_I2C(node_id))) \
125 }
126
135#define I2C_DT_SPEC_INST_GET(inst) \
136 I2C_DT_SPEC_GET(DT_DRV_INST(inst))
137
138
139/*
140 * I2C_MSG_* are I2C Message flags.
141 */
142
144#define I2C_MSG_WRITE (0U << 0U)
145
147#define I2C_MSG_READ BIT(0)
148
150#define I2C_MSG_RW_MASK BIT(0)
154#define I2C_MSG_STOP BIT(1)
155
163#define I2C_MSG_RESTART BIT(2)
164
168#define I2C_MSG_ADDR_10_BITS BIT(3)
169
194
202typedef void (*i2c_callback_t)(const struct device *dev, int result, void *data);
203
210struct i2c_target_config;
211
212typedef int (*i2c_api_configure_t)(const struct device *dev,
213 uint32_t dev_config);
214typedef int (*i2c_api_get_config_t)(const struct device *dev,
215 uint32_t *dev_config);
216typedef int (*i2c_api_full_io_t)(const struct device *dev,
217 struct i2c_msg *msgs,
218 uint8_t num_msgs,
219 uint16_t addr);
220typedef int (*i2c_api_target_register_t)(const struct device *dev,
221 struct i2c_target_config *cfg);
222typedef int (*i2c_api_target_unregister_t)(const struct device *dev,
223 struct i2c_target_config *cfg);
224#ifdef CONFIG_I2C_CALLBACK
225typedef int (*i2c_api_transfer_cb_t)(const struct device *dev,
226 struct i2c_msg *msgs,
227 uint8_t num_msgs,
228 uint16_t addr,
230 void *userdata);
231#endif /* CONFIG_I2C_CALLBACK */
232#if defined(CONFIG_I2C_RTIO) || defined(__DOXYGEN__)
233
238typedef void (*i2c_api_iodev_submit)(const struct device *dev,
239 struct rtio_iodev_sqe *iodev_sqe);
240#endif /* CONFIG_I2C_RTIO */
241
242typedef int (*i2c_api_recover_bus_t)(const struct device *dev);
243
244__subsystem struct i2c_driver_api {
245 i2c_api_configure_t configure;
246 i2c_api_get_config_t get_config;
247 i2c_api_full_io_t transfer;
248 i2c_api_target_register_t target_register;
249 i2c_api_target_unregister_t target_unregister;
250#ifdef CONFIG_I2C_CALLBACK
251 i2c_api_transfer_cb_t transfer_cb;
252#endif
253#ifdef CONFIG_I2C_RTIO
254 i2c_api_iodev_submit iodev_submit;
255#endif
256 i2c_api_recover_bus_t recover_bus;
257};
258
259typedef int (*i2c_target_api_register_t)(const struct device *dev);
260typedef int (*i2c_target_api_unregister_t)(const struct device *dev);
261
262__subsystem struct i2c_target_driver_api {
263 i2c_target_api_register_t driver_register;
264 i2c_target_api_unregister_t driver_unregister;
265};
266
272#define I2C_TARGET_FLAGS_ADDR_10_BITS BIT(0)
273
290 struct i2c_target_config *config);
291
311 struct i2c_target_config *config, uint8_t val);
312
333 struct i2c_target_config *config, uint8_t *val);
334
355 struct i2c_target_config *config, uint8_t *val);
356
357#ifdef CONFIG_I2C_TARGET_BUFFER_MODE
371typedef void (*i2c_target_buf_write_received_cb_t)(
372 struct i2c_target_config *config, uint8_t *ptr, uint32_t len);
373
396typedef int (*i2c_target_buf_read_requested_cb_t)(
397 struct i2c_target_config *config, uint8_t **ptr, uint32_t *len);
398#endif
399
414typedef int (*i2c_target_stop_cb_t)(struct i2c_target_config *config);
415
427#ifdef CONFIG_I2C_TARGET_BUFFER_MODE
428 i2c_target_buf_write_received_cb_t buf_write_received;
429 i2c_target_buf_read_requested_cb_t buf_read_requested;
430#endif
432};
433
458
467static inline bool i2c_is_ready_dt(const struct i2c_dt_spec *spec)
468{
469 /* Validate bus is ready */
470 return device_is_ready(spec->bus);
471}
472
480static inline bool i2c_is_read_op(const struct i2c_msg *msg)
481{
482 return (msg->flags & I2C_MSG_READ) == I2C_MSG_READ;
483}
484
492static inline bool i2c_is_stop_op(const struct i2c_msg *msg)
493{
494 return (msg->flags & I2C_MSG_STOP) == I2C_MSG_STOP;
495}
496
523void i2c_dump_msgs_rw(const struct device *dev, const struct i2c_msg *msgs, uint8_t num_msgs,
524 uint16_t addr, bool dump_read);
525
540static inline void i2c_dump_msgs(const struct device *dev, const struct i2c_msg *msgs,
541 uint8_t num_msgs, uint16_t addr)
542{
543 i2c_dump_msgs_rw(dev, msgs, num_msgs, addr, false);
544}
545
546#if defined(CONFIG_I2C_STATS) || defined(__DOXYGEN__)
547
548#include <zephyr/stats/stats.h>
549
553STATS_SECT_ENTRY32(bytes_read)
554STATS_SECT_ENTRY32(bytes_written)
555STATS_SECT_ENTRY32(message_count)
556STATS_SECT_ENTRY32(transfer_call_count)
558
560STATS_NAME(i2c, bytes_read)
561STATS_NAME(i2c, bytes_written)
562STATS_NAME(i2c, message_count)
563STATS_NAME(i2c, transfer_call_count)
564STATS_NAME_END(i2c);
565
574 struct stats_i2c stats;
575};
576
584static inline void i2c_xfer_stats(const struct device *dev, struct i2c_msg *msgs,
585 uint8_t num_msgs)
586{
587 struct i2c_device_state *state =
589 uint32_t bytes_read = 0U;
590 uint32_t bytes_written = 0U;
591
592 STATS_INC(state->stats, transfer_call_count);
593 STATS_INCN(state->stats, message_count, num_msgs);
594 for (uint8_t i = 0U; i < num_msgs; i++) {
595 if (msgs[i].flags & I2C_MSG_READ) {
596 bytes_read += msgs[i].len;
597 } else {
598 bytes_written += msgs[i].len;
599 }
600 }
601 STATS_INCN(state->stats, bytes_read, bytes_read);
602 STATS_INCN(state->stats, bytes_written, bytes_written);
603}
604
610#define Z_I2C_DEVICE_STATE_DEFINE(dev_id) \
611 static struct i2c_device_state Z_DEVICE_STATE_NAME(dev_id) \
612 __attribute__((__section__(".z_devstate")))
613
620#define Z_I2C_INIT_FN(dev_id, init_fn) \
621 static inline int UTIL_CAT(dev_id, _init)(const struct device *dev) \
622 { \
623 struct i2c_device_state *state = \
624 CONTAINER_OF(dev->state, struct i2c_device_state, devstate); \
625 stats_init(&state->stats.s_hdr, STATS_SIZE_32, 4, \
626 STATS_NAME_INIT_PARMS(i2c)); \
627 stats_register(dev->name, &(state->stats.s_hdr)); \
628 if (!is_null_no_warn(init_fn)) { \
629 return init_fn(dev); \
630 } \
631 \
632 return 0; \
633 }
634
664#define I2C_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
665 prio, api, ...) \
666 Z_I2C_DEVICE_STATE_DEFINE(Z_DEVICE_DT_DEV_ID(node_id)); \
667 Z_I2C_INIT_FN(Z_DEVICE_DT_DEV_ID(node_id), init_fn) \
668 Z_DEVICE_DEFINE(node_id, Z_DEVICE_DT_DEV_ID(node_id), \
669 DEVICE_DT_NAME(node_id), \
670 &UTIL_CAT(Z_DEVICE_DT_DEV_ID(node_id), _init), \
671 NULL, Z_DEVICE_DT_FLAGS(node_id), pm, data, \
672 config, level, prio, api, \
673 &(Z_DEVICE_STATE_NAME(Z_DEVICE_DT_DEV_ID(node_id)).devstate), \
674 __VA_ARGS__)
675
676#else /* CONFIG_I2C_STATS */
677
678static inline void i2c_xfer_stats(const struct device *dev, struct i2c_msg *msgs,
679 uint8_t num_msgs)
680{
681 ARG_UNUSED(dev);
682 ARG_UNUSED(msgs);
683 ARG_UNUSED(num_msgs);
684}
685
686#define I2C_DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
687 prio, api, ...) \
688 DEVICE_DT_DEFINE(node_id, init_fn, pm, data, config, level, \
689 prio, api, __VA_ARGS__)
690
691#endif /* CONFIG_I2C_STATS */
692
701#define I2C_DEVICE_DT_INST_DEFINE(inst, ...) \
702 I2C_DEVICE_DT_DEFINE(DT_DRV_INST(inst), __VA_ARGS__)
703
704
715__syscall int i2c_configure(const struct device *dev, uint32_t dev_config);
716
717static inline int z_impl_i2c_configure(const struct device *dev,
718 uint32_t dev_config)
719{
720 const struct i2c_driver_api *api =
721 (const struct i2c_driver_api *)dev->api;
722
723 return api->configure(dev, dev_config);
724}
725
746__syscall int i2c_get_config(const struct device *dev, uint32_t *dev_config);
747
748static inline int z_impl_i2c_get_config(const struct device *dev, uint32_t *dev_config)
749{
750 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
751
752 if (api->get_config == NULL) {
753 return -ENOSYS;
754 }
755
756 return api->get_config(dev, dev_config);
757}
758
790__syscall int i2c_transfer(const struct device *dev,
791 struct i2c_msg *msgs, uint8_t num_msgs,
792 uint16_t addr);
793
794static inline int z_impl_i2c_transfer(const struct device *dev,
795 struct i2c_msg *msgs, uint8_t num_msgs,
796 uint16_t addr)
797{
798 const struct i2c_driver_api *api =
799 (const struct i2c_driver_api *)dev->api;
800
801 if (!num_msgs) {
802 return 0;
803 }
804
805 if (!IS_ENABLED(CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS)) {
806 msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
807 }
808
809 int res = api->transfer(dev, msgs, num_msgs, addr);
810
811 i2c_xfer_stats(dev, msgs, num_msgs);
812
813 if (IS_ENABLED(CONFIG_I2C_DUMP_MESSAGES)) {
814 i2c_dump_msgs_rw(dev, msgs, num_msgs, addr, true);
815 }
816
817 return res;
818}
819
820#if defined(CONFIG_I2C_CALLBACK) || defined(__DOXYGEN__)
821
844static inline int i2c_transfer_cb(const struct device *dev,
845 struct i2c_msg *msgs,
846 uint8_t num_msgs,
847 uint16_t addr,
849 void *userdata)
850{
851 const struct i2c_driver_api *api =
852 (const struct i2c_driver_api *)dev->api;
853
854 if (api->transfer_cb == NULL) {
855 return -ENOSYS;
856 }
857
858 if (!num_msgs) {
859 cb(dev, 0, userdata);
860 return 0;
861 }
862
863 if (!IS_ENABLED(CONFIG_I2C_ALLOW_NO_STOP_TRANSACTIONS)) {
864 msgs[num_msgs - 1].flags |= I2C_MSG_STOP;
865 }
866
867 return api->transfer_cb(dev, msgs, num_msgs, addr, cb, userdata);
868}
869
885static inline int i2c_transfer_cb_dt(const struct i2c_dt_spec *spec,
886 struct i2c_msg *msgs,
887 uint8_t num_msgs,
889 void *userdata)
890{
891 return i2c_transfer_cb(spec->bus, msgs, num_msgs, spec->addr, cb, userdata);
892}
893
917static inline int i2c_write_read_cb(const struct device *dev, struct i2c_msg *msgs,
918 uint8_t num_msgs, uint16_t addr, const void *write_buf,
919 size_t num_write, void *read_buf, size_t num_read,
920 i2c_callback_t cb, void *userdata)
921{
922 if ((msgs == NULL) || (num_msgs != 2)) {
923 return -EINVAL;
924 }
925
926 msgs[0].buf = (uint8_t *)write_buf;
927 msgs[0].len = num_write;
928 msgs[0].flags = I2C_MSG_WRITE;
929
930 msgs[1].buf = (uint8_t *)read_buf;
931 msgs[1].len = num_read;
933
934 return i2c_transfer_cb(dev, msgs, num_msgs, addr, cb, userdata);
935}
936
958static inline int i2c_write_read_cb_dt(const struct i2c_dt_spec *spec, struct i2c_msg *msgs,
959 uint8_t num_msgs, const void *write_buf, size_t num_write,
960 void *read_buf, size_t num_read, i2c_callback_t cb,
961 void *userdata)
962{
963 return i2c_write_read_cb(spec->bus, msgs, num_msgs, spec->addr, write_buf, num_write,
964 read_buf, num_read, cb, userdata);
965}
966
967#if defined(CONFIG_POLL) || defined(__DOXYGEN__)
968
970void z_i2c_transfer_signal_cb(const struct device *dev, int result, void *userdata);
994static inline int i2c_transfer_signal(const struct device *dev,
995 struct i2c_msg *msgs,
996 uint8_t num_msgs,
997 uint16_t addr,
998 struct k_poll_signal *sig)
999{
1000 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
1001
1002 if (api->transfer_cb == NULL) {
1003 return -ENOSYS;
1004 }
1005
1006 return api->transfer_cb(dev, msgs, num_msgs, addr, z_i2c_transfer_signal_cb, sig);
1007}
1008
1009#endif /* CONFIG_POLL */
1010
1011#endif /* CONFIG_I2C_CALLBACK */
1012
1013
1014#if defined(CONFIG_I2C_RTIO) || defined(__DOXYGEN__)
1015
1026void i2c_iodev_submit_fallback(const struct device *dev, struct rtio_iodev_sqe *iodev_sqe);
1027
1034static inline void i2c_iodev_submit(struct rtio_iodev_sqe *iodev_sqe)
1035{
1036 const struct i2c_dt_spec *dt_spec = (const struct i2c_dt_spec *)iodev_sqe->sqe.iodev->data;
1037 const struct device *dev = dt_spec->bus;
1038 const struct i2c_driver_api *api = (const struct i2c_driver_api *)dev->api;
1039
1040 if (api->iodev_submit == NULL) {
1041 rtio_iodev_sqe_err(iodev_sqe, -ENOSYS);
1042 return;
1043 }
1044 api->iodev_submit(dt_spec->bus, iodev_sqe);
1045}
1046
1047extern const struct rtio_iodev_api i2c_iodev_api;
1048
1058#define I2C_DT_IODEV_DEFINE(name, node_id) \
1059 const struct i2c_dt_spec _i2c_dt_spec_##name = \
1060 I2C_DT_SPEC_GET(node_id); \
1061 RTIO_IODEV_DEFINE(name, &i2c_iodev_api, (void *)&_i2c_dt_spec_##name)
1062
1073#define I2C_IODEV_DEFINE(name, _bus, _addr) \
1074 const struct i2c_dt_spec _i2c_dt_spec_##name = { \
1075 .bus = DEVICE_DT_GET(_bus), \
1076 .addr = _addr, \
1077 }; \
1078 RTIO_IODEV_DEFINE(name, &i2c_iodev_api, (void *)&_i2c_dt_spec_##name)
1079
1092 struct rtio_iodev *iodev,
1093 const struct i2c_msg *msgs,
1094 uint8_t num_msgs);
1095
1108 uint8_t reg_addr, uint8_t data);
1109
1123 uint8_t start_addr, void *buf, size_t num_bytes);
1124
1125#endif /* CONFIG_I2C_RTIO */
1126
1140static inline int i2c_transfer_dt(const struct i2c_dt_spec *spec,
1141 struct i2c_msg *msgs, uint8_t num_msgs)
1142{
1143 return i2c_transfer(spec->bus, msgs, num_msgs, spec->addr);
1144}
1145
1158__syscall int i2c_recover_bus(const struct device *dev);
1159
1160static inline int z_impl_i2c_recover_bus(const struct device *dev)
1161{
1162 const struct i2c_driver_api *api =
1163 (const struct i2c_driver_api *)dev->api;
1164
1165 if (api->recover_bus == NULL) {
1166 return -ENOSYS;
1167 }
1168
1169 return api->recover_bus(dev);
1170}
1171
1196static inline int i2c_target_register(const struct device *dev,
1197 struct i2c_target_config *cfg)
1198{
1199 const struct i2c_driver_api *api =
1200 (const struct i2c_driver_api *)dev->api;
1201
1202 if (api->target_register == NULL) {
1203 return -ENOSYS;
1204 }
1205
1206 return api->target_register(dev, cfg);
1207}
1208
1225static inline int i2c_target_unregister(const struct device *dev,
1226 struct i2c_target_config *cfg)
1227{
1228 const struct i2c_driver_api *api =
1229 (const struct i2c_driver_api *)dev->api;
1230
1231 if (api->target_unregister == NULL) {
1232 return -ENOSYS;
1233 }
1234
1235 return api->target_unregister(dev, cfg);
1236}
1237
1251__syscall int i2c_target_driver_register(const struct device *dev);
1252
1253static inline int z_impl_i2c_target_driver_register(const struct device *dev)
1254{
1255 const struct i2c_target_driver_api *api =
1256 (const struct i2c_target_driver_api *)dev->api;
1257
1258 return api->driver_register(dev);
1259}
1260
1274__syscall int i2c_target_driver_unregister(const struct device *dev);
1275
1276static inline int z_impl_i2c_target_driver_unregister(const struct device *dev)
1277{
1278 const struct i2c_target_driver_api *api =
1279 (const struct i2c_target_driver_api *)dev->api;
1280
1281 return api->driver_unregister(dev);
1282}
1283
1284/*
1285 * Derived i2c APIs -- all implemented in terms of i2c_transfer()
1286 */
1287
1302static inline int i2c_write(const struct device *dev, const uint8_t *buf,
1303 uint32_t num_bytes, uint16_t addr)
1304{
1305 struct i2c_msg msg;
1306
1307 msg.buf = (uint8_t *)buf;
1308 msg.len = num_bytes;
1310
1311 return i2c_transfer(dev, &msg, 1, addr);
1312}
1313
1327static inline int i2c_write_dt(const struct i2c_dt_spec *spec,
1328 const uint8_t *buf, uint32_t num_bytes)
1329{
1330 return i2c_write(spec->bus, buf, num_bytes, spec->addr);
1331}
1332
1347static inline int i2c_read(const struct device *dev, uint8_t *buf,
1348 uint32_t num_bytes, uint16_t addr)
1349{
1350 struct i2c_msg msg;
1351
1352 msg.buf = buf;
1353 msg.len = num_bytes;
1355
1356 return i2c_transfer(dev, &msg, 1, addr);
1357}
1358
1372static inline int i2c_read_dt(const struct i2c_dt_spec *spec,
1373 uint8_t *buf, uint32_t num_bytes)
1374{
1375 return i2c_read(spec->bus, buf, num_bytes, spec->addr);
1376}
1377
1396static inline int i2c_write_read(const struct device *dev, uint16_t addr,
1397 const void *write_buf, size_t num_write,
1398 void *read_buf, size_t num_read)
1399{
1400 struct i2c_msg msg[2];
1401
1402 msg[0].buf = (uint8_t *)write_buf;
1403 msg[0].len = num_write;
1404 msg[0].flags = I2C_MSG_WRITE;
1405
1406 msg[1].buf = (uint8_t *)read_buf;
1407 msg[1].len = num_read;
1409
1410 return i2c_transfer(dev, msg, 2, addr);
1411}
1412
1430static inline int i2c_write_read_dt(const struct i2c_dt_spec *spec,
1431 const void *write_buf, size_t num_write,
1432 void *read_buf, size_t num_read)
1433{
1434 return i2c_write_read(spec->bus, spec->addr,
1435 write_buf, num_write,
1436 read_buf, num_read);
1437}
1438
1457static inline int i2c_burst_read(const struct device *dev,
1458 uint16_t dev_addr,
1459 uint8_t start_addr,
1460 uint8_t *buf,
1461 uint32_t num_bytes)
1462{
1463 return i2c_write_read(dev, dev_addr,
1464 &start_addr, sizeof(start_addr),
1465 buf, num_bytes);
1466}
1467
1482static inline int i2c_burst_read_dt(const struct i2c_dt_spec *spec,
1483 uint8_t start_addr,
1484 uint8_t *buf,
1485 uint32_t num_bytes)
1486{
1487 return i2c_burst_read(spec->bus, spec->addr,
1488 start_addr, buf, num_bytes);
1489}
1490
1512static inline int i2c_burst_write(const struct device *dev,
1513 uint16_t dev_addr,
1514 uint8_t start_addr,
1515 const uint8_t *buf,
1516 uint32_t num_bytes)
1517{
1518 struct i2c_msg msg[2];
1519
1520 msg[0].buf = &start_addr;
1521 msg[0].len = 1U;
1522 msg[0].flags = I2C_MSG_WRITE;
1523
1524 msg[1].buf = (uint8_t *)buf;
1525 msg[1].len = num_bytes;
1526 msg[1].flags = I2C_MSG_WRITE | I2C_MSG_STOP;
1527
1528 return i2c_transfer(dev, msg, 2, dev_addr);
1529}
1530
1545static inline int i2c_burst_write_dt(const struct i2c_dt_spec *spec,
1546 uint8_t start_addr,
1547 const uint8_t *buf,
1548 uint32_t num_bytes)
1549{
1550 return i2c_burst_write(spec->bus, spec->addr,
1551 start_addr, buf, num_bytes);
1552}
1553
1569static inline int i2c_reg_read_byte(const struct device *dev,
1570 uint16_t dev_addr,
1571 uint8_t reg_addr, uint8_t *value)
1572{
1573 return i2c_write_read(dev, dev_addr,
1574 &reg_addr, sizeof(reg_addr),
1575 value, sizeof(*value));
1576}
1577
1591static inline int i2c_reg_read_byte_dt(const struct i2c_dt_spec *spec,
1592 uint8_t reg_addr, uint8_t *value)
1593{
1594 return i2c_reg_read_byte(spec->bus, spec->addr, reg_addr, value);
1595}
1596
1615static inline int i2c_reg_write_byte(const struct device *dev,
1616 uint16_t dev_addr,
1617 uint8_t reg_addr, uint8_t value)
1618{
1619 uint8_t tx_buf[2] = {reg_addr, value};
1620
1621 return i2c_write(dev, tx_buf, 2, dev_addr);
1622}
1623
1637static inline int i2c_reg_write_byte_dt(const struct i2c_dt_spec *spec,
1638 uint8_t reg_addr, uint8_t value)
1639{
1640 return i2c_reg_write_byte(spec->bus, spec->addr, reg_addr, value);
1641}
1642
1662static inline int i2c_reg_update_byte(const struct device *dev,
1663 uint8_t dev_addr,
1664 uint8_t reg_addr, uint8_t mask,
1665 uint8_t value)
1666{
1667 uint8_t old_value, new_value;
1668 int rc;
1669
1670 rc = i2c_reg_read_byte(dev, dev_addr, reg_addr, &old_value);
1671 if (rc != 0) {
1672 return rc;
1673 }
1674
1675 new_value = (old_value & ~mask) | (value & mask);
1676 if (new_value == old_value) {
1677 return 0;
1678 }
1679
1680 return i2c_reg_write_byte(dev, dev_addr, reg_addr, new_value);
1681}
1682
1697static inline int i2c_reg_update_byte_dt(const struct i2c_dt_spec *spec,
1698 uint8_t reg_addr, uint8_t mask,
1699 uint8_t value)
1700{
1701 return i2c_reg_update_byte(spec->bus, spec->addr,
1702 reg_addr, mask, value);
1703}
1704
1705#ifdef __cplusplus
1706}
1707#endif
1708
1713#include <zephyr/syscalls/i2c.h>
1714
1715#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:885
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:1545
static int i2c_target_unregister(const struct device *dev, struct i2c_target_config *cfg)
Unregisters the provided config as Target device.
Definition i2c.h:1225
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:1396
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:1034
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:332
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:1302
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:1327
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:1430
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:917
static bool i2c_is_stop_op(const struct i2c_msg *msg)
Check if the current message includes a stop.
Definition i2c.h:492
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:414
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:1457
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:354
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:289
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:1697
void(* i2c_callback_t)(const struct device *dev, int result, void *data)
I2C callback for asynchronous transfer requests.
Definition i2c.h:202
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:1372
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:310
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:1637
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:1615
#define I2C_MSG_READ
Read message from I2C bus.
Definition i2c.h:147
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:1591
int i2c_configure(const struct device *dev, uint32_t dev_config)
Configure operation of a host controller.
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:958
#define I2C_MSG_RESTART
RESTART I2C transaction for this message.
Definition i2c.h:163
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:1140
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:1347
static bool i2c_is_read_op(const struct i2c_msg *msg)
Check if the current message is a read operation.
Definition i2c.h:480
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:1482
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:1196
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:844
#define I2C_MSG_STOP
Send STOP after this message.
Definition i2c.h:154
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:584
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:540
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:994
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:1662
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:144
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:1569
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:1512
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:467
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:1233
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:284
#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:451
Runtime device structure (in ROM) per driver instance.
Definition device.h:504
void * data
Address of the device instance private data.
Definition device.h:514
const void * api
Address of the API structure exposed by the device instance.
Definition device.h:510
struct device_state * state
Address of the common device state.
Definition device.h:512
I2C specific device state which allows for i2c device class specific additions.
Definition i2c.h:572
struct stats_i2c stats
Definition i2c.h:574
struct device_state devstate
Definition i2c.h:573
Complete I2C DT information.
Definition i2c.h:77
const struct device * bus
Definition i2c.h:78
uint16_t addr
Definition i2c.h:79
One I2C Message.
Definition i2c.h:184
uint8_t * buf
Data buffer in bytes.
Definition i2c.h:186
uint32_t len
Length of buffer in bytes.
Definition i2c.h:189
uint8_t flags
Flags for this message.
Definition i2c.h:192
Structure providing callbacks to be implemented for devices that supports the I2C target API.
Definition i2c.h:422
i2c_target_read_requested_cb_t read_requested
Definition i2c.h:424
i2c_target_write_received_cb_t write_received
Definition i2c.h:425
i2c_target_read_processed_cb_t read_processed
Definition i2c.h:426
i2c_target_write_requested_cb_t write_requested
Definition i2c.h:423
i2c_target_stop_cb_t stop
Definition i2c.h:431
Structure describing a device that supports the I2C target API.
Definition i2c.h:445
uint8_t flags
Flags for the target device defined by I2C_TARGET_FLAGS_* constants.
Definition i2c.h:450
uint16_t address
Address for this target device.
Definition i2c.h:453
sys_snode_t node
Private, do not modify.
Definition i2c.h:447
const struct i2c_target_callbacks * callbacks
Callback functions.
Definition i2c.h:456
Definition kernel.h:5965
API that an RTIO IO device should implement.
Definition rtio.h:502
Compute the mempool block index for a given pointer.
Definition rtio.h:492
struct rtio_sqe sqe
Definition rtio.h:493
An IO device with a function table for submitting requests.
Definition rtio.h:517
void * data
Definition rtio.h:522
A submission queue event.
Definition rtio.h:286
const struct rtio_iodev * iodev
Device to operation on.
Definition rtio.h:295
const uint8_t * buf
Buffer to write from.
Definition rtio.h:311
An RTIO context containing what can be viewed as a pair of queues.
Definition rtio.h:396