Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
modem_cellular.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2026 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
11
12 #ifndef ZEPHYR_INCLUDE_DRIVERS_CELLULAR_INTERNAL_H_
13 #define ZEPHYR_INCLUDE_DRIVERS_CELLULAR_INTERNAL_H_
14
15#include <zephyr/drivers/cellular.h>
16#include <zephyr/modem/backend/uart.h>
17#include <zephyr/drivers/uart.h>
18#include <zephyr/drivers/gpio.h>
19#include <zephyr/pm/device.h>
20#include <zephyr/modem/chat.h>
21#include <zephyr/modem/cmux.h>
22#include <zephyr/modem/pipe.h>
23#include <zephyr/modem/pipelink.h>
24#include <zephyr/modem/ppp.h>
25
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
45
46#define MODEM_CELLULAR_DATA_IMEI_LEN (16)
47#define MODEM_CELLULAR_DATA_MODEL_ID_LEN (65)
48#define MODEM_CELLULAR_DATA_IMSI_LEN (23)
49#define MODEM_CELLULAR_DATA_ICCID_LEN (22)
50#define MODEM_CELLULAR_DATA_MANUFACTURER_LEN (65)
51#define MODEM_CELLULAR_DATA_FW_VERSION_LEN (65)
52#define MODEM_CELLULAR_DATA_APN_LEN (32)
53#define MODEM_CELLULAR_MAX_APN_CMDS (2)
54#define MODEM_CELLULAR_APN_BUF_SIZE (64)
55
56/* Zephyr networking interface states:
57 * NET_IF_LOWER_UP: Carrier is on in AWAIT_REGISTERED and REGISTERED
58 * NET_IF_DORMANT: Interface is dormant in every state except REGISTERED
59 */
60enum modem_cellular_state {
61 MODEM_CELLULAR_STATE_IDLE = 0,
62 MODEM_CELLULAR_STATE_RESET_PULSE,
63 MODEM_CELLULAR_STATE_AWAIT_RESET,
64 MODEM_CELLULAR_STATE_POWER_ON_PULSE,
65 MODEM_CELLULAR_STATE_AWAIT_POWER_ON,
66 MODEM_CELLULAR_STATE_SET_BAUDRATE,
67 MODEM_CELLULAR_STATE_RUN_INIT_SCRIPT,
68 MODEM_CELLULAR_STATE_CONNECT_CMUX,
69 MODEM_CELLULAR_STATE_OPEN_DLCI1,
70 MODEM_CELLULAR_STATE_OPEN_DLCI2,
71 MODEM_CELLULAR_STATE_WAIT_FOR_APN,
72 MODEM_CELLULAR_STATE_RUN_APN_SCRIPT,
73 MODEM_CELLULAR_STATE_RUN_DIAL_SCRIPT,
74 MODEM_CELLULAR_STATE_AWAIT_REGISTERED,
75 MODEM_CELLULAR_STATE_REGISTERED,
76 MODEM_CELLULAR_STATE_AWAIT_PPP_DEAD,
77 MODEM_CELLULAR_STATE_INIT_POWER_OFF,
78 MODEM_CELLULAR_STATE_RUN_SHUTDOWN_SCRIPT,
79 MODEM_CELLULAR_STATE_POWER_OFF_PULSE,
80 MODEM_CELLULAR_STATE_AWAIT_POWER_OFF,
81};
82
83enum modem_cellular_event {
84 MODEM_CELLULAR_EVENT_RESUME = 0,
85 MODEM_CELLULAR_EVENT_SUSPEND,
86 MODEM_CELLULAR_EVENT_SCRIPT_SUCCESS,
87 MODEM_CELLULAR_EVENT_SCRIPT_FAILED,
88 MODEM_CELLULAR_EVENT_CMUX_CONNECTED,
89 MODEM_CELLULAR_EVENT_CMUX_DISCONNECTED,
90 MODEM_CELLULAR_EVENT_DLCI1_OPENED,
91 MODEM_CELLULAR_EVENT_DLCI2_OPENED,
92 MODEM_CELLULAR_EVENT_TIMEOUT,
93 MODEM_CELLULAR_EVENT_REGISTERED,
94 MODEM_CELLULAR_EVENT_DEREGISTERED,
95 MODEM_CELLULAR_EVENT_BUS_OPENED,
96 MODEM_CELLULAR_EVENT_BUS_CLOSED,
97 MODEM_CELLULAR_EVENT_PPP_DEAD,
98 MODEM_CELLULAR_EVENT_MODEM_READY,
99 MODEM_CELLULAR_EVENT_APN_SET,
100 MODEM_CELLULAR_EVENT_RING,
101};
102
103struct modem_cellular_event_cb {
104 cellular_event_mask_t mask;
105 cellular_event_cb_t fn;
106 void *user_data;
107};
108
109struct modem_cellular_data {
110 /* UART backend */
111 struct modem_pipe *uart_pipe;
112 struct modem_backend_uart uart_backend;
113 uint8_t uart_backend_receive_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
114 uint8_t uart_backend_transmit_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
115 uint32_t original_baudrate;
116
117 /* CMUX */
118 struct modem_cmux cmux;
119 uint8_t cmux_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
120 uint8_t cmux_transmit_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
121
122 struct modem_cmux_dlci dlci1;
123 struct modem_cmux_dlci dlci2;
124 struct modem_pipe *dlci1_pipe;
125 struct modem_pipe *dlci2_pipe;
126 /* Points to dlci1_pipe or NULL. Used for shutdown script if not NULL */
127 struct modem_pipe *cmd_pipe;
128 uint8_t dlci1_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
129 /* DLCI 2 is only used for chat scripts. */
130 uint8_t dlci2_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
131
132 /* Modem chat */
133 struct modem_chat chat;
134 uint8_t chat_receive_buf[CONFIG_MODEM_CELLULAR_CHAT_BUFFER_SIZE];
135 uint8_t *chat_delimiter;
136 uint8_t *chat_filter;
137 uint8_t *chat_argv[32];
138 uint8_t script_failure_counter;
139
140 /* Status */
141 enum cellular_registration_status registration_status_gsm;
142 enum cellular_registration_status registration_status_gprs;
143 enum cellular_registration_status registration_status_lte;
144 uint8_t rssi;
145 uint8_t rsrp;
146 uint8_t rsrq;
147 uint8_t imei[MODEM_CELLULAR_DATA_IMEI_LEN];
148 uint8_t model_id[MODEM_CELLULAR_DATA_MODEL_ID_LEN];
149 uint8_t imsi[MODEM_CELLULAR_DATA_IMSI_LEN];
150 uint8_t iccid[MODEM_CELLULAR_DATA_ICCID_LEN];
151 uint8_t manufacturer[MODEM_CELLULAR_DATA_MANUFACTURER_LEN];
152 uint8_t fw_version[MODEM_CELLULAR_DATA_FW_VERSION_LEN];
153 uint8_t apn[MODEM_CELLULAR_DATA_APN_LEN];
154
155 struct modem_chat_script_chat apn_chats[MODEM_CELLULAR_MAX_APN_CMDS];
156 struct modem_chat_script apn_script;
157 char apn_buf[MODEM_CELLULAR_MAX_APN_CMDS][MODEM_CELLULAR_APN_BUF_SIZE];
158
159 /* PPP */
160 struct modem_ppp *ppp;
161 struct net_mgmt_event_callback net_mgmt_event_callback;
162
163 enum modem_cellular_state state;
164 const struct device *dev;
165 struct k_work_delayable timeout_work;
166
167 /* Power management */
168 struct k_sem suspended_sem;
169
170 /* Event dispatcher */
171 struct k_work event_dispatch_work;
172 uint8_t event_buf[8];
173 struct k_pipe event_pipe;
174
175 struct k_mutex api_lock;
176 struct modem_cellular_event_cb cb;
177
178 /* Ring interrupt */
179 struct gpio_callback ring_gpio_cb;
180};
181
182struct modem_cellular_user_pipe {
183 struct modem_cmux_dlci dlci;
184 uint8_t dlci_address;
185 uint8_t *dlci_receive_buf;
186 uint16_t dlci_receive_buf_size;
187 struct modem_pipe *pipe;
188 struct modem_pipelink *pipelink;
189};
190
191struct modem_cellular_config {
192 const struct device *uart;
193 struct gpio_dt_spec power_gpio;
194 struct gpio_dt_spec reset_gpio;
195 struct gpio_dt_spec wake_gpio;
196 struct gpio_dt_spec ring_gpio;
197 struct gpio_dt_spec dtr_gpio;
198 uint16_t power_pulse_duration_ms;
199 uint16_t reset_pulse_duration_ms;
200 uint16_t startup_time_ms;
201 uint16_t shutdown_time_ms;
202 bool autostarts;
203 bool hold_reset_on_suspend;
204 bool reset_on_resume;
205 bool reset_on_recovery;
206 bool cmux_enable_runtime_power_save;
207 bool cmux_close_pipe_on_power_save;
208 bool use_default_pdp_context;
209 bool use_default_apn;
210 k_timeout_t cmux_idle_timeout;
211 const struct modem_chat_script *init_chat_script;
212 const struct modem_chat_script *dial_chat_script;
213 const struct modem_chat_script *periodic_chat_script;
214 const struct modem_chat_script *shutdown_chat_script;
215 const struct modem_chat_script *set_baudrate_chat_script;
216 struct modem_cellular_user_pipe *user_pipes;
217 uint8_t user_pipes_size;
218};
219
223int modem_cellular_init(const struct device *dev);
224
225int modem_cellular_pm_action(const struct device *dev, enum pm_device_action action);
226
227extern const struct cellular_driver_api modem_cellular_api;
228
229void modem_cellular_chat_callback_handler(struct modem_chat *chat,
230 enum modem_chat_script_result result,
231 void *user_data);
233
242
243#define MODEM_CELLULAR_INST_NAME(name, inst) \
244 CONCAT(name, _, DT_DRV_COMPAT, inst)
245
246#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, name, size) \
247 MODEM_PIPELINK_DT_INST_DEFINE(inst, name); \
248 static uint8_t MODEM_CELLULAR_INST_NAME(name, inst)[size] \
249
250#define MODEM_CELLULAR_INIT_USER_PIPE(_inst, _name, _dlci_address) \
251 { \
252 .dlci_address = _dlci_address, \
253 .dlci_receive_buf = MODEM_CELLULAR_INST_NAME(_name, _inst), \
254 .dlci_receive_buf_size = sizeof(MODEM_CELLULAR_INST_NAME(_name, _inst)), \
255 .pipelink = MODEM_PIPELINK_DT_INST_GET(_inst, _name), \
256 }
257
258#define MODEM_CELLULAR_DEFINE_USER_PIPES(inst, ...) \
259 static struct modem_cellular_user_pipe MODEM_CELLULAR_INST_NAME(user_pipes, inst)[] = { \
260 __VA_ARGS__ \
261 }
262
263#define MODEM_CELLULAR_GET_USER_PIPES(inst) \
264 MODEM_CELLULAR_INST_NAME(user_pipes, inst)
265
266/* Extract the first argument (pipe name) from a pair */
267#define MODEM_CELLULAR_GET_PIPE_NAME_ARG(arg1, ...) arg1
268
269/* Extract the second argument (DLCI address) from a pair */
270#define MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG(arg1, arg2, ...) arg2
271
272/* Define user pipe data using instance and extracted pipe name */
273#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER(_args, inst) \
274 MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, \
275 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
276 CONFIG_MODEM_CELLULAR_USER_PIPE_BUFFER_SIZES)
277
278/* Initialize user pipe using instance, extracted pipe name, and DLCI address */
279#define MODEM_CELLULAR_INIT_USER_PIPE_HELPER(_args, inst) \
280 MODEM_CELLULAR_INIT_USER_PIPE(inst, \
281 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
282 MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG _args)
283
284/*
285 * Define and initialize user pipes dynamically
286 * Takes an instance and pairs of (pipe name, DLCI address)
287 */
288#define MODEM_CELLULAR_DEFINE_AND_INIT_USER_PIPES(inst, ...) \
289 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER, \
290 (;), inst, __VA_ARGS__); \
291 MODEM_CELLULAR_DEFINE_USER_PIPES( \
292 inst, \
293 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_INIT_USER_PIPE_HELPER, \
294 (,), inst, __VA_ARGS__) \
295 );
296
297/* Helper to define modem instance */
298#define MODEM_CELLULAR_DEFINE_INSTANCE(inst, power_ms, reset_ms, startup_ms, shutdown_ms, start, \
299 set_baudrate_script, init_script, dial_script, \
300 periodic_script, shutdown_script) \
301 static const struct modem_cellular_config MODEM_CELLULAR_INST_NAME(config, inst) = { \
302 .uart = DEVICE_DT_GET(DT_INST_BUS(inst)), \
303 .power_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_power_gpios, {}), \
304 .reset_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_reset_gpios, {}), \
305 .wake_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_wake_gpios, {}), \
306 .ring_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_ring_gpios, {}), \
307 .dtr_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_dtr_gpios, {}), \
308 .power_pulse_duration_ms = (power_ms), \
309 .reset_pulse_duration_ms = (reset_ms), \
310 .startup_time_ms = (startup_ms), \
311 .shutdown_time_ms = (shutdown_ms), \
312 .autostarts = DT_INST_PROP_OR(inst, autostarts, (start)), \
313 .hold_reset_on_suspend = \
314 DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, hold_on_suspend), \
315 .reset_on_resume = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
316 toggle_on_resume), \
317 .reset_on_recovery = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
318 toggle_on_recovery), \
319 .cmux_enable_runtime_power_save = \
320 DT_INST_PROP_OR(inst, cmux_enable_runtime_power_save, 0), \
321 .cmux_close_pipe_on_power_save = \
322 DT_INST_PROP_OR(inst, cmux_close_pipe_on_power_save, 0), \
323 .use_default_pdp_context = DT_INST_PROP_OR(inst, zephyr_use_default_pdp_ctx, 0), \
324 .use_default_apn = DT_INST_PROP_OR(inst, zephyr_use_default_apn, 0), \
325 .cmux_idle_timeout = K_MSEC(DT_INST_PROP_OR(inst, cmux_idle_timeout_ms, 0)), \
326 .set_baudrate_chat_script = (set_baudrate_script), \
327 .init_chat_script = (init_script), \
328 .dial_chat_script = (dial_script), \
329 .periodic_chat_script = (periodic_script), \
330 .shutdown_chat_script = (shutdown_script), \
331 .user_pipes = MODEM_CELLULAR_GET_USER_PIPES(inst), \
332 .user_pipes_size = ARRAY_SIZE(MODEM_CELLULAR_GET_USER_PIPES(inst)), \
333 }; \
334 \
335 PM_DEVICE_DT_INST_DEFINE(inst, modem_cellular_pm_action); \
336 \
337 DEVICE_DT_INST_DEFINE(inst, modem_cellular_init, PM_DEVICE_DT_INST_GET(inst), \
338 &MODEM_CELLULAR_INST_NAME(data, inst), \
339 &MODEM_CELLULAR_INST_NAME(config, inst), POST_KERNEL, \
340 CONFIG_MODEM_CELLULAR_INIT_PRIORITY, &modem_cellular_api);
341
343
344#ifdef __cplusplus
345}
346#endif
347
349
350#endif /* ZEPHYR_INCLUDE_DRIVERS_CELLULAR_INTERNAL_H_ */
cellular.h
Main header file for cellular modem driver API.
gpio.h
Main header file for GPIO driver API.
uart.h
Main header file for UART driver API.
cellular_registration_status
cellular_registration_status
Cellular registration status (3GPP TS 27.007).
Definition cellular.h:109
cellular_event_mask_t
uint32_t cellular_event_mask_t
Definition cellular.h:147
cellular_event_cb_t
void(* cellular_event_cb_t)(const struct device *dev, enum cellular_event event, const void *payload, void *user_data)
Prototype for cellular event callbacks.
Definition cellular.h:176
modem_chat_script_result
modem_chat_script_result
Definition chat.h:156
pm_device_action
pm_device_action
Device PM actions.
Definition device.h:144
state
state
Definition parser_state.h:29
uint32_t
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
uint8_t
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
uint16_t
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
cellular_driver_api
Cellular driver API.
Definition cellular.h:211
device
Runtime device structure (in ROM) per driver instance.
Definition device.h:513
modem_chat
Chat instance internal context.
Definition chat.h:223