1 /*
2 * Copyright (c) 2018, Nordic Semiconductor ASA
3 * Copyright (c) 2024, Croxel Inc
4 * Copyright (c) 2024, Embeint Inc
5 *
6 * SPDX-License-Identifier: Apache-2.0
7 */
8
9 #include <zephyr/drivers/i2c.h>
10 #include <zephyr/drivers/i2c/rtio.h>
11 #include <zephyr/dt-bindings/i2c/i2c.h>
12 #include <zephyr/logging/log.h>
13 #include <zephyr/pm/device.h>
14 #include <zephyr/pm/device_runtime.h>
15 #include <zephyr/drivers/pinctrl.h>
16 #include <soc.h>
17 #include <nrfx_twim.h>
18 #include <zephyr/linker/devicetree_regions.h>
19
20 #include "i2c_nrfx_twim_common.h"
21
22 LOG_MODULE_REGISTER(i2c_nrfx_twim, CONFIG_I2C_LOG_LEVEL);
23
24 struct i2c_nrfx_twim_rtio_config {
25 struct i2c_nrfx_twim_common_config common;
26 struct i2c_rtio *ctx;
27 };
28
29 struct i2c_nrfx_twim_rtio_data {
30 uint8_t *user_rx_buf;
31 uint16_t user_rx_buf_size;
32 };
33
i2c_nrfx_twim_rtio_msg_start(const struct device * dev,uint8_t flags,uint8_t * buf,size_t buf_len,uint16_t i2c_addr)34 static bool i2c_nrfx_twim_rtio_msg_start(const struct device *dev, uint8_t flags, uint8_t *buf,
35 size_t buf_len, uint16_t i2c_addr)
36 {
37 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
38 struct i2c_rtio *ctx = config->ctx;
39 int ret = 0;
40
41 ret = i2c_nrfx_twim_msg_transfer(dev, flags, buf, buf_len, i2c_addr);
42 if (ret != 0) {
43 return i2c_rtio_complete(ctx, ret);
44 }
45
46 return false;
47 }
48
49 static void i2c_nrfx_twim_rtio_complete(const struct device *dev, int status);
50
i2c_nrfx_twim_rtio_sqe_signaled(struct rtio_iodev_sqe * iodev_sqe,void * userdata)51 static void i2c_nrfx_twim_rtio_sqe_signaled(struct rtio_iodev_sqe *iodev_sqe, void *userdata)
52 {
53 const struct device *dev = userdata;
54
55 (void)i2c_nrfx_twim_rtio_complete(dev, 0);
56 }
57
i2c_nrfx_twim_rtio_start(const struct device * dev)58 static bool i2c_nrfx_twim_rtio_start(const struct device *dev)
59 {
60 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
61 struct i2c_nrfx_twim_rtio_data *data = dev->data;
62 struct i2c_rtio *ctx = config->ctx;
63 struct rtio_sqe *sqe = &ctx->txn_curr->sqe;
64 struct i2c_dt_spec *dt_spec = sqe->iodev->data;
65 struct rtio_iodev_sqe *iodev_sqe;
66
67 switch (sqe->op) {
68 case RTIO_OP_RX:
69 if (!nrf_dma_accessible_check(&config->common.twim, sqe->rx.buf)) {
70 if (sqe->rx.buf_len > config->common.msg_buf_size) {
71 return i2c_rtio_complete(ctx, -ENOSPC);
72 }
73
74 data->user_rx_buf = sqe->rx.buf;
75 data->user_rx_buf_size = sqe->rx.buf_len;
76 return i2c_nrfx_twim_rtio_msg_start(dev,
77 I2C_MSG_READ | sqe->iodev_flags,
78 config->common.msg_buf,
79 data->user_rx_buf_size,
80 dt_spec->addr);
81 }
82
83 data->user_rx_buf = NULL;
84 return i2c_nrfx_twim_rtio_msg_start(dev, I2C_MSG_READ | sqe->iodev_flags,
85 sqe->rx.buf, sqe->rx.buf_len, dt_spec->addr);
86 case RTIO_OP_TINY_TX:
87 return i2c_nrfx_twim_rtio_msg_start(dev, I2C_MSG_WRITE | sqe->iodev_flags,
88 sqe->tiny_tx.buf, sqe->tiny_tx.buf_len,
89 dt_spec->addr);
90 case RTIO_OP_TX:
91 /* If buffer is not accessible by DMA, copy it into the internal driver buffer */
92 if (!nrf_dma_accessible_check(&config->common.twim, sqe->tx.buf)) {
93 /* Validate buffer will fit */
94 if (sqe->tx.buf_len > config->common.msg_buf_size) {
95 LOG_ERR("Need to use the internal driver "
96 "buffer but its size is insufficient "
97 "(%u > %u). "
98 "Adjust the zephyr,concat-buf-size or "
99 "zephyr,flash-buf-max-size property "
100 "(the one with greater value) in the "
101 "\"%s\"' node.",
102 sqe->tx.buf_len, config->common.msg_buf_size, dev->name);
103 return i2c_rtio_complete(ctx, -ENOSPC);
104 }
105 memcpy(config->common.msg_buf, sqe->tx.buf, sqe->tx.buf_len);
106 sqe->tx.buf = config->common.msg_buf;
107 }
108 return i2c_nrfx_twim_rtio_msg_start(dev, I2C_MSG_WRITE | sqe->iodev_flags,
109 (uint8_t *)sqe->tx.buf, sqe->tx.buf_len,
110 dt_spec->addr);
111 case RTIO_OP_I2C_CONFIGURE:
112 (void)i2c_nrfx_twim_configure(dev, sqe->i2c_config);
113 /** This request will not generate an event therefore, this
114 * code immediately submits a CQE in order to unblock
115 * i2c_rtio_configure.
116 */
117 return i2c_rtio_complete(ctx, 0);
118 case RTIO_OP_I2C_RECOVER:
119 (void)i2c_nrfx_twim_recover_bus(dev);
120 return false;
121 case RTIO_OP_AWAIT:
122 iodev_sqe = CONTAINER_OF(sqe, struct rtio_iodev_sqe, sqe);
123 rtio_iodev_sqe_await_signal(iodev_sqe, i2c_nrfx_twim_rtio_sqe_signaled,
124 (void *)dev);
125 return false;
126 default:
127 LOG_ERR("Invalid op code %d for submission %p\n", sqe->op, (void *)sqe);
128 return i2c_rtio_complete(ctx, -EINVAL);
129 }
130 }
131
i2c_nrfx_twim_rtio_complete(const struct device * dev,int status)132 static void i2c_nrfx_twim_rtio_complete(const struct device *dev, int status)
133 {
134 /** Finalize if there are no more pending xfers */
135 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
136 struct i2c_rtio *ctx = config->ctx;
137
138 if (i2c_rtio_complete(ctx, status)) {
139 (void)i2c_nrfx_twim_rtio_start(dev);
140 } else {
141 /* Release bus on completion */
142 pm_device_runtime_put(dev);
143 }
144 }
145
i2c_nrfx_twim_rtio_configure(const struct device * dev,uint32_t i2c_config)146 static int i2c_nrfx_twim_rtio_configure(const struct device *dev, uint32_t i2c_config)
147 {
148 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
149 struct i2c_rtio *ctx = config->ctx;
150
151 return i2c_rtio_configure(ctx, i2c_config);
152 }
153
i2c_nrfx_twim_rtio_transfer(const struct device * dev,struct i2c_msg * msgs,uint8_t num_msgs,uint16_t addr)154 static int i2c_nrfx_twim_rtio_transfer(const struct device *dev, struct i2c_msg *msgs,
155 uint8_t num_msgs, uint16_t addr)
156 {
157 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
158 struct i2c_rtio *ctx = config->ctx;
159
160 return i2c_rtio_transfer(ctx, msgs, num_msgs, addr);
161 }
162
i2c_nrfx_twim_rtio_recover_bus(const struct device * dev)163 static int i2c_nrfx_twim_rtio_recover_bus(const struct device *dev)
164 {
165 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
166 struct i2c_rtio *ctx = config->ctx;
167
168 return i2c_rtio_recover(ctx);
169 }
170
i2c_nrfx_twim_rtio_submit(const struct device * dev,struct rtio_iodev_sqe * iodev_seq)171 static void i2c_nrfx_twim_rtio_submit(const struct device *dev, struct rtio_iodev_sqe *iodev_seq)
172 {
173 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
174 struct i2c_rtio *ctx = config->ctx;
175
176 if (i2c_rtio_submit(ctx, iodev_seq)) {
177 if (pm_device_runtime_get(dev) < 0) {
178 (void)i2c_rtio_complete(ctx, -EINVAL);
179 } else {
180 (void)i2c_nrfx_twim_rtio_start(dev);
181 }
182 }
183 }
184
event_handler(nrfx_twim_evt_t const * p_event,void * p_context)185 static void event_handler(nrfx_twim_evt_t const *p_event, void *p_context)
186 {
187 const struct device *dev = p_context;
188 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
189 struct i2c_nrfx_twim_rtio_data *data = dev->data;
190 int status = p_event->type == NRFX_TWIM_EVT_DONE ? 0 : -EIO;
191
192 if (data->user_rx_buf) {
193 memcpy(data->user_rx_buf, config->common.msg_buf, data->user_rx_buf_size);
194 }
195
196 i2c_nrfx_twim_rtio_complete(dev, status);
197 }
198
199 static DEVICE_API(i2c, i2c_nrfx_twim_driver_api) = {
200 .configure = i2c_nrfx_twim_rtio_configure,
201 .transfer = i2c_nrfx_twim_rtio_transfer,
202 .recover_bus = i2c_nrfx_twim_rtio_recover_bus,
203 .iodev_submit = i2c_nrfx_twim_rtio_submit,
204 };
205
i2c_nrfx_twim_rtio_init(const struct device * dev)206 static int i2c_nrfx_twim_rtio_init(const struct device *dev)
207 {
208 const struct i2c_nrfx_twim_rtio_config *config = dev->config;
209
210 i2c_rtio_init(config->ctx, dev);
211 return i2c_nrfx_twim_common_init(dev);
212 }
213
i2c_nrfx_twim_rtio_deinit(const struct device * dev)214 static int i2c_nrfx_twim_rtio_deinit(const struct device *dev)
215 {
216 return i2c_nrfx_twim_common_deinit(dev);
217 }
218
219 #define CONCAT_BUF_SIZE(idx) \
220 COND_CODE_1(DT_NODE_HAS_PROP(I2C(idx), zephyr_concat_buf_size), \
221 (DT_PROP(I2C(idx), zephyr_concat_buf_size)), (0))
222 #define FLASH_BUF_MAX_SIZE(idx) \
223 COND_CODE_1(DT_NODE_HAS_PROP(I2C(idx), zephyr_flash_buf_max_size), \
224 (DT_PROP(I2C(idx), zephyr_flash_buf_max_size)), (0))
225
226 #define USES_MSG_BUF(idx) \
227 COND_CODE_0(CONCAT_BUF_SIZE(idx), (COND_CODE_0(FLASH_BUF_MAX_SIZE(idx), (0), (1))), (1))
228 #define MSG_BUF_SIZE(idx) MAX(CONCAT_BUF_SIZE(idx), FLASH_BUF_MAX_SIZE(idx))
229
230 #define MSG_BUF_HAS_MEMORY_REGIONS(idx) \
231 DT_NODE_HAS_PROP(I2C(idx), memory_regions)
232
233 #define MSG_BUF_LINKER_REGION_NAME(idx) \
234 LINKER_DT_NODE_REGION_NAME(DT_PHANDLE(I2C(idx), memory_regions))
235
236 #define MSG_BUF_ATTR_SECTION(idx) \
237 __attribute__((__section__(MSG_BUF_LINKER_REGION_NAME(idx))))
238
239 #define MSG_BUF_ATTR(idx) \
240 COND_CODE_1( \
241 MSG_BUF_HAS_MEMORY_REGIONS(idx), \
242 (MSG_BUF_ATTR_SECTION(idx)), \
243 () \
244 )
245
246 #define MSG_BUF_SYM(idx) \
247 _CONCAT_3(twim_, idx, _msg_buf)
248
249 #define MSG_BUF_DEFINE(idx) \
250 static uint8_t MSG_BUF_SYM(idx)[MSG_BUF_SIZE(idx)] MSG_BUF_ATTR(idx)
251
252 #define MAX_TRANSFER_SIZE(idx) \
253 BIT_MASK(DT_PROP(I2C(idx), easydma_maxcnt_bits))
254
255 #define I2C_NRFX_TWIM_RTIO_DEVICE(idx) \
256 NRF_DT_CHECK_NODE_HAS_PINCTRL_SLEEP(I2C(idx)); \
257 NRF_DT_CHECK_NODE_HAS_REQUIRED_MEMORY_REGIONS(I2C(idx)); \
258 BUILD_ASSERT(I2C_FREQUENCY(idx) != I2C_NRFX_TWIM_INVALID_FREQUENCY, \
259 "Wrong I2C " #idx " frequency setting in dts"); \
260 static void irq_connect##idx(void) \
261 { \
262 IRQ_CONNECT(DT_IRQN(I2C(idx)), DT_IRQ(I2C(idx), priority), nrfx_isr, \
263 nrfx_twim_##idx##_irq_handler, 0); \
264 } \
265 IF_ENABLED(USES_MSG_BUF(idx), (MSG_BUF_DEFINE(idx);)) \
266 I2C_RTIO_DEFINE(_i2c##idx##_twim_rtio, \
267 DT_INST_PROP_OR(n, sq_size, CONFIG_I2C_RTIO_SQ_SIZE), \
268 DT_INST_PROP_OR(n, cq_size, CONFIG_I2C_RTIO_CQ_SIZE)); \
269 PINCTRL_DT_DEFINE(I2C(idx)); \
270 static struct i2c_nrfx_twim_rtio_data twim_##idx##z_data; \
271 static const struct i2c_nrfx_twim_rtio_config twim_##idx##z_config = { \
272 .common = \
273 { \
274 .twim = NRFX_TWIM_INSTANCE(idx), \
275 .twim_config = \
276 { \
277 .skip_gpio_cfg = true, \
278 .skip_psel_cfg = true, \
279 .frequency = I2C_FREQUENCY(idx), \
280 }, \
281 .event_handler = event_handler, \
282 .msg_buf_size = MSG_BUF_SIZE(idx), \
283 .irq_connect = irq_connect##idx, \
284 .pcfg = PINCTRL_DT_DEV_CONFIG_GET(I2C(idx)), \
285 IF_ENABLED(USES_MSG_BUF(idx), (.msg_buf = MSG_BUF_SYM(idx),)) \
286 .max_transfer_size = MAX_TRANSFER_SIZE(idx), \
287 }, \
288 .ctx = &_i2c##idx##_twim_rtio, \
289 }; \
290 PM_DEVICE_DT_DEFINE(I2C(idx), twim_nrfx_pm_action, PM_DEVICE_ISR_SAFE); \
291 I2C_DEVICE_DT_DEINIT_DEFINE(I2C(idx), i2c_nrfx_twim_rtio_init, i2c_nrfx_twim_rtio_deinit, \
292 PM_DEVICE_DT_GET(I2C(idx)), &twim_##idx##z_data, \
293 &twim_##idx##z_config, POST_KERNEL, CONFIG_I2C_INIT_PRIORITY, \
294 &i2c_nrfx_twim_driver_api);
295
296 #ifdef CONFIG_HAS_HW_NRF_TWIM0
297 I2C_NRFX_TWIM_RTIO_DEVICE(0);
298 #endif
299
300 #ifdef CONFIG_HAS_HW_NRF_TWIM1
301 I2C_NRFX_TWIM_RTIO_DEVICE(1);
302 #endif
303
304 #ifdef CONFIG_HAS_HW_NRF_TWIM2
305 I2C_NRFX_TWIM_RTIO_DEVICE(2);
306 #endif
307
308 #ifdef CONFIG_HAS_HW_NRF_TWIM3
309 I2C_NRFX_TWIM_RTIO_DEVICE(3);
310 #endif
311
312 #ifdef CONFIG_HAS_HW_NRF_TWIM20
313 I2C_NRFX_TWIM_RTIO_DEVICE(20);
314 #endif
315
316 #ifdef CONFIG_HAS_HW_NRF_TWIM21
317 I2C_NRFX_TWIM_RTIO_DEVICE(21);
318 #endif
319
320 #ifdef CONFIG_HAS_HW_NRF_TWIM22
321 I2C_NRFX_TWIM_RTIO_DEVICE(22);
322 #endif
323
324 #ifdef CONFIG_HAS_HW_NRF_TWIM23
325 I2C_NRFX_TWIM_RTIO_DEVICE(23);
326 #endif
327
328 #ifdef CONFIG_HAS_HW_NRF_TWIM24
329 I2C_NRFX_TWIM_RTIO_DEVICE(24);
330 #endif
331
332 #ifdef CONFIG_HAS_HW_NRF_TWIM30
333 I2C_NRFX_TWIM_RTIO_DEVICE(30);
334 #endif
335
336 #ifdef CONFIG_HAS_HW_NRF_TWIM120
337 I2C_NRFX_TWIM_RTIO_DEVICE(120);
338 #endif
339
340 #ifdef CONFIG_HAS_HW_NRF_TWIM130
341 I2C_NRFX_TWIM_RTIO_DEVICE(130);
342 #endif
343
344 #ifdef CONFIG_HAS_HW_NRF_TWIM131
345 I2C_NRFX_TWIM_RTIO_DEVICE(131);
346 #endif
347
348 #ifdef CONFIG_HAS_HW_NRF_TWIM132
349 I2C_NRFX_TWIM_RTIO_DEVICE(132);
350 #endif
351
352 #ifdef CONFIG_HAS_HW_NRF_TWIM133
353 I2C_NRFX_TWIM_RTIO_DEVICE(133);
354 #endif
355
356 #ifdef CONFIG_HAS_HW_NRF_TWIM134
357 I2C_NRFX_TWIM_RTIO_DEVICE(134);
358 #endif
359
360 #ifdef CONFIG_HAS_HW_NRF_TWIM135
361 I2C_NRFX_TWIM_RTIO_DEVICE(135);
362 #endif
363
364 #ifdef CONFIG_HAS_HW_NRF_TWIM136
365 I2C_NRFX_TWIM_RTIO_DEVICE(136);
366 #endif
367
368 #ifdef CONFIG_HAS_HW_NRF_TWIM137
369 I2C_NRFX_TWIM_RTIO_DEVICE(137);
370 #endif
371