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_WAIT_FOR_APN,
71 MODEM_CELLULAR_STATE_RUN_APN_SCRIPT,
72 MODEM_CELLULAR_STATE_RUN_DIAL_SCRIPT,
73 MODEM_CELLULAR_STATE_AWAIT_REGISTERED,
74 MODEM_CELLULAR_STATE_REGISTERED,
75 MODEM_CELLULAR_STATE_AWAIT_PPP_DEAD,
76 MODEM_CELLULAR_STATE_INIT_POWER_OFF,
77 MODEM_CELLULAR_STATE_RUN_SHUTDOWN_SCRIPT,
78 MODEM_CELLULAR_STATE_POWER_OFF_PULSE,
79 MODEM_CELLULAR_STATE_AWAIT_POWER_OFF,
80};
81
82enum modem_cellular_event {
83 MODEM_CELLULAR_EVENT_RESUME = 0,
84 MODEM_CELLULAR_EVENT_SUSPEND,
85 MODEM_CELLULAR_EVENT_SCRIPT_SUCCESS,
86 MODEM_CELLULAR_EVENT_SCRIPT_FAILED,
87 MODEM_CELLULAR_EVENT_CMUX_CONNECTED,
88 MODEM_CELLULAR_EVENT_CMUX_DISCONNECTED,
89 MODEM_CELLULAR_EVENT_DLCI1_OPENED,
90 MODEM_CELLULAR_EVENT_DLCI2_OPENED,
91 MODEM_CELLULAR_EVENT_TIMEOUT,
92 MODEM_CELLULAR_EVENT_REGISTERED,
93 MODEM_CELLULAR_EVENT_DEREGISTERED,
94 MODEM_CELLULAR_EVENT_BUS_OPENED,
95 MODEM_CELLULAR_EVENT_BUS_CLOSED,
96 MODEM_CELLULAR_EVENT_PPP_DEAD,
97 MODEM_CELLULAR_EVENT_MODEM_READY,
98 MODEM_CELLULAR_EVENT_APN_SET,
99 MODEM_CELLULAR_EVENT_RING,
100};
101
102struct modem_cellular_event_cb {
103 cellular_event_mask_t mask;
104 cellular_event_cb_t fn;
105 void *user_data;
106};
107
108struct modem_cellular_data {
109 /* UART backend */
110 struct modem_pipe *uart_pipe;
111 struct modem_backend_uart uart_backend;
112 uint8_t uart_backend_receive_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
113 uint8_t uart_backend_transmit_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
114 uint32_t original_baudrate;
115
116 /* CMUX */
117 struct modem_cmux cmux;
118 uint8_t cmux_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
119 uint8_t cmux_transmit_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
120
121 struct modem_cmux_dlci dlci1;
122 struct modem_cmux_dlci dlci2;
123 struct modem_pipe *dlci1_pipe;
124 struct modem_pipe *dlci2_pipe;
125 /* Points to dlci2_pipe or NULL. Used for shutdown script if not NULL */
126 struct modem_pipe *cmd_pipe;
127 uint8_t dlci1_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
128 /* DLCI 2 is only used for chat scripts. */
129 uint8_t dlci2_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
130
131 /* Modem chat */
132 struct modem_chat chat;
133 uint8_t chat_receive_buf[CONFIG_MODEM_CELLULAR_CHAT_BUFFER_SIZE];
134 uint8_t *chat_delimiter;
135 uint8_t *chat_filter;
136 uint8_t *chat_argv[32];
137 uint8_t script_failure_counter;
138
139 /* Status */
140 enum cellular_registration_status registration_status_gsm;
141 enum cellular_registration_status registration_status_gprs;
142 enum cellular_registration_status registration_status_lte;
143 uint8_t rssi;
144 uint8_t rsrp;
145 uint8_t rsrq;
146 uint8_t imei[MODEM_CELLULAR_DATA_IMEI_LEN];
147 uint8_t model_id[MODEM_CELLULAR_DATA_MODEL_ID_LEN];
148 uint8_t imsi[MODEM_CELLULAR_DATA_IMSI_LEN];
149 uint8_t iccid[MODEM_CELLULAR_DATA_ICCID_LEN];
150 uint8_t manufacturer[MODEM_CELLULAR_DATA_MANUFACTURER_LEN];
151 uint8_t fw_version[MODEM_CELLULAR_DATA_FW_VERSION_LEN];
152 uint8_t apn[MODEM_CELLULAR_DATA_APN_LEN];
153
154 struct modem_chat_script_chat apn_chats[MODEM_CELLULAR_MAX_APN_CMDS];
155 struct modem_chat_script apn_script;
156 char apn_buf[MODEM_CELLULAR_MAX_APN_CMDS][MODEM_CELLULAR_APN_BUF_SIZE];
157
158 /* PPP */
159 struct modem_ppp *ppp;
160 struct net_mgmt_event_callback net_mgmt_event_callback;
161
162 enum modem_cellular_state state;
163 const struct device *dev;
164 struct k_work_delayable timeout_work;
165
166 /* Power management */
167 struct k_sem suspended_sem;
168
169 /* Event dispatcher */
170 struct k_work event_dispatch_work;
171 uint8_t event_buf[8];
172 struct k_pipe event_pipe;
173
174 struct k_mutex api_lock;
175 struct modem_cellular_event_cb cb;
176
177 /* Ring interrupt */
178 struct gpio_callback ring_gpio_cb;
179};
180
181struct modem_cellular_user_pipe {
182 struct modem_cmux_dlci dlci;
183 uint8_t dlci_address;
184 uint8_t *dlci_receive_buf;
185 uint16_t dlci_receive_buf_size;
186 struct modem_pipe *pipe;
187 struct modem_pipelink *pipelink;
188};
189
190struct modem_cellular_config {
191 const struct device *uart;
192 struct gpio_dt_spec power_gpio;
193 struct gpio_dt_spec reset_gpio;
194 struct gpio_dt_spec wake_gpio;
195 struct gpio_dt_spec ring_gpio;
196 struct gpio_dt_spec dtr_gpio;
197 uint16_t power_pulse_duration_ms;
198 uint16_t reset_pulse_duration_ms;
199 uint16_t startup_time_ms;
200 uint16_t shutdown_time_ms;
201 bool autostarts;
202 bool hold_reset_on_suspend;
203 bool reset_on_resume;
204 bool reset_on_recovery;
205 bool cmux_enable_runtime_power_save;
206 bool cmux_close_pipe_on_power_save;
207 bool use_default_pdp_context;
208 bool use_default_apn;
209 k_timeout_t cmux_idle_timeout;
210 const struct modem_chat_script *init_chat_script;
211 const struct modem_chat_script *dial_chat_script;
212 const struct modem_chat_script *periodic_chat_script;
213 const struct modem_chat_script *shutdown_chat_script;
214 const struct modem_chat_script *set_baudrate_chat_script;
215 struct modem_cellular_user_pipe *user_pipes;
216 uint8_t user_pipes_size;
217};
218
222int modem_cellular_init(const struct device *dev);
223
224int modem_cellular_pm_action(const struct device *dev, enum pm_device_action action);
225
226extern const struct cellular_driver_api modem_cellular_api;
227
228void modem_cellular_chat_callback_handler(struct modem_chat *chat,
229 enum modem_chat_script_result result,
230 void *user_data);
232
241
242#define MODEM_CELLULAR_INST_NAME(name, inst) \
243 CONCAT(name, _, DT_DRV_COMPAT, inst)
244
245#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, name, size) \
246 MODEM_PIPELINK_DT_INST_DEFINE(inst, name); \
247 static uint8_t MODEM_CELLULAR_INST_NAME(name, inst)[size] \
248
249#define MODEM_CELLULAR_INIT_USER_PIPE(_inst, _name, _dlci_address) \
250 { \
251 .dlci_address = _dlci_address, \
252 .dlci_receive_buf = MODEM_CELLULAR_INST_NAME(_name, _inst), \
253 .dlci_receive_buf_size = sizeof(MODEM_CELLULAR_INST_NAME(_name, _inst)), \
254 .pipelink = MODEM_PIPELINK_DT_INST_GET(_inst, _name), \
255 }
256
257#define MODEM_CELLULAR_DEFINE_USER_PIPES(inst, ...) \
258 static struct modem_cellular_user_pipe MODEM_CELLULAR_INST_NAME(user_pipes, inst)[] = { \
259 __VA_ARGS__ \
260 }
261
262#define MODEM_CELLULAR_GET_USER_PIPES(inst) \
263 MODEM_CELLULAR_INST_NAME(user_pipes, inst)
264
265/* Extract the first argument (pipe name) from a pair */
266#define MODEM_CELLULAR_GET_PIPE_NAME_ARG(arg1, ...) arg1
267
268/* Extract the second argument (DLCI address) from a pair */
269#define MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG(arg1, arg2, ...) arg2
270
271/* Define user pipe data using instance and extracted pipe name */
272#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER(_args, inst) \
273 MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, \
274 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
275 CONFIG_MODEM_CELLULAR_USER_PIPE_BUFFER_SIZES)
276
277/* Initialize user pipe using instance, extracted pipe name, and DLCI address */
278#define MODEM_CELLULAR_INIT_USER_PIPE_HELPER(_args, inst) \
279 MODEM_CELLULAR_INIT_USER_PIPE(inst, \
280 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
281 MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG _args)
282
283/*
284 * Define and initialize user pipes dynamically
285 * Takes an instance and pairs of (pipe name, DLCI address)
286 */
287#define MODEM_CELLULAR_DEFINE_AND_INIT_USER_PIPES(inst, ...) \
288 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER, \
289 (;), inst, __VA_ARGS__); \
290 MODEM_CELLULAR_DEFINE_USER_PIPES( \
291 inst, \
292 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_INIT_USER_PIPE_HELPER, \
293 (,), inst, __VA_ARGS__) \
294 );
295
296/* Helper to define modem instance */
297#define MODEM_CELLULAR_DEFINE_INSTANCE(inst, power_ms, reset_ms, startup_ms, shutdown_ms, start, \
298 set_baudrate_script, init_script, dial_script, \
299 periodic_script, shutdown_script) \
300 static const struct modem_cellular_config MODEM_CELLULAR_INST_NAME(config, inst) = { \
301 .uart = DEVICE_DT_GET(DT_INST_BUS(inst)), \
302 .power_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_power_gpios, {}), \
303 .reset_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_reset_gpios, {}), \
304 .wake_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_wake_gpios, {}), \
305 .ring_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_ring_gpios, {}), \
306 .dtr_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_dtr_gpios, {}), \
307 .power_pulse_duration_ms = (power_ms), \
308 .reset_pulse_duration_ms = (reset_ms), \
309 .startup_time_ms = (startup_ms), \
310 .shutdown_time_ms = (shutdown_ms), \
311 .autostarts = DT_INST_PROP_OR(inst, autostarts, (start)), \
312 .hold_reset_on_suspend = \
313 DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, hold_on_suspend), \
314 .reset_on_resume = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
315 toggle_on_resume), \
316 .reset_on_recovery = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
317 toggle_on_recovery), \
318 .cmux_enable_runtime_power_save = \
319 DT_INST_PROP_OR(inst, cmux_enable_runtime_power_save, 0), \
320 .cmux_close_pipe_on_power_save = \
321 DT_INST_PROP_OR(inst, cmux_close_pipe_on_power_save, 0), \
322 .use_default_pdp_context = DT_INST_PROP_OR(inst, zephyr_use_default_pdp_ctx, 0), \
323 .use_default_apn = DT_INST_PROP_OR(inst, zephyr_use_default_apn, 0), \
324 .cmux_idle_timeout = K_MSEC(DT_INST_PROP_OR(inst, cmux_idle_timeout_ms, 0)), \
325 .set_baudrate_chat_script = (set_baudrate_script), \
326 .init_chat_script = (init_script), \
327 .dial_chat_script = (dial_script), \
328 .periodic_chat_script = (periodic_script), \
329 .shutdown_chat_script = (shutdown_script), \
330 .user_pipes = MODEM_CELLULAR_GET_USER_PIPES(inst), \
331 .user_pipes_size = ARRAY_SIZE(MODEM_CELLULAR_GET_USER_PIPES(inst)), \
332 }; \
333 \
334 PM_DEVICE_DT_INST_DEFINE(inst, modem_cellular_pm_action); \
335 \
336 DEVICE_DT_INST_DEFINE(inst, modem_cellular_init, PM_DEVICE_DT_INST_GET(inst), \
337 &MODEM_CELLULAR_INST_NAME(data, inst), \
338 &MODEM_CELLULAR_INST_NAME(config, inst), POST_KERNEL, \
339 CONFIG_MODEM_CELLULAR_INIT_PRIORITY, &modem_cellular_api);
340
342
343#ifdef __cplusplus
344}
345#endif
346
348
349#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