Zephyr Project API 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
12
13#ifndef ZEPHYR_INCLUDE_DRIVERS_CELLULAR_INTERNAL_H_
14#define ZEPHYR_INCLUDE_DRIVERS_CELLULAR_INTERNAL_H_
15
16#include <zephyr/drivers/cellular.h>
17#include <zephyr/modem/backend/uart.h>
18#include <zephyr/drivers/uart.h>
19#include <zephyr/drivers/gpio.h>
20#include <zephyr/pm/device.h>
21#include <zephyr/modem/chat.h>
22#include <zephyr/modem/cmux.h>
23#include <zephyr/modem/pipe.h>
24#include <zephyr/modem/pipelink.h>
25#include <zephyr/modem/ppp.h>
26#include <zephyr/sys/iterable_sections.h>
27#include <zephyr/sys/atomic.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
40
42
43#define MODEM_CELLULAR_DATA_IMEI_LEN (16)
44#define MODEM_CELLULAR_DATA_MODEL_ID_LEN (65)
45#define MODEM_CELLULAR_DATA_IMSI_LEN (23)
46#define MODEM_CELLULAR_DATA_ICCID_LEN (22)
47#define MODEM_CELLULAR_DATA_MANUFACTURER_LEN (65)
48#define MODEM_CELLULAR_DATA_FW_VERSION_LEN (65)
49#define MODEM_CELLULAR_DATA_APN_LEN (32)
50#define MODEM_CELLULAR_MAX_APN_CMDS (2)
51#define MODEM_CELLULAR_APN_BUF_SIZE (64)
52
53/* Zephyr networking interface states:
54 * NET_IF_LOWER_UP: Carrier is on in AWAIT_REGISTERED and REGISTERED
55 * NET_IF_DORMANT: Interface is dormant in every state except REGISTERED
56 */
57enum modem_cellular_state {
58 MODEM_CELLULAR_STATE_IDLE = 0,
59 MODEM_CELLULAR_STATE_RESET_PULSE,
60 MODEM_CELLULAR_STATE_AWAIT_RESET,
61 MODEM_CELLULAR_STATE_POWER_ON_PULSE,
62 MODEM_CELLULAR_STATE_AWAIT_POWER_ON,
63 MODEM_CELLULAR_STATE_SET_BAUDRATE,
64 MODEM_CELLULAR_STATE_RUN_INIT_SCRIPT,
65 MODEM_CELLULAR_STATE_CONNECT_CMUX,
66 MODEM_CELLULAR_STATE_OPEN_DLCI1,
67 MODEM_CELLULAR_STATE_OPEN_DLCI2,
68 MODEM_CELLULAR_STATE_RUN_BOARD_INIT_SCRIPT,
69 MODEM_CELLULAR_STATE_WAIT_FOR_APN,
70 MODEM_CELLULAR_STATE_RUN_APN_SCRIPT,
71 MODEM_CELLULAR_STATE_RUN_NETWORK_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 MODEM_CELLULAR_EVENT_PERIODIC_KICK,
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
110
119struct modem_cellular_data {
121 /* UART backend */
122 struct modem_pipe *uart_pipe;
123 struct modem_backend_uart uart_backend;
124 uint8_t uart_backend_receive_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
125 uint8_t uart_backend_transmit_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
126 uint32_t original_baudrate;
127
128 /* CMUX */
129 struct modem_cmux cmux;
130 uint8_t cmux_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
131 uint8_t cmux_transmit_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
132
133 struct modem_cmux_dlci dlci1;
134 struct modem_cmux_dlci dlci2;
135 struct modem_pipe *dlci1_pipe;
136 struct modem_pipe *dlci2_pipe;
137 /* Points to dlci1_pipe or NULL. Used for shutdown script if not NULL */
138 struct modem_pipe *cmd_pipe;
139 uint8_t dlci1_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
140 /* DLCI 2 is only used for chat scripts. */
141 uint8_t dlci2_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
142
143 /* Modem chat */
144 struct modem_chat chat;
145 uint8_t chat_receive_buf[CONFIG_MODEM_CELLULAR_CHAT_BUFFER_SIZE];
147
153 uint8_t *chat_delimiter;
160 uint8_t *chat_filter;
161
163 uint8_t *chat_argv[32];
164 uint8_t script_failure_counter;
165
166 /* Status */
167 enum cellular_registration_status registration_status_gsm;
168 enum cellular_registration_status registration_status_gprs;
169 enum cellular_registration_status registration_status_lte;
170 enum cellular_access_technology access_tech;
171 uint8_t rssi;
172 uint8_t rsrp;
173 uint8_t rsrq;
174 uint8_t imei[MODEM_CELLULAR_DATA_IMEI_LEN];
175 uint8_t model_id[MODEM_CELLULAR_DATA_MODEL_ID_LEN];
176 uint8_t imsi[MODEM_CELLULAR_DATA_IMSI_LEN];
177 uint8_t iccid[MODEM_CELLULAR_DATA_ICCID_LEN];
178 uint8_t manufacturer[MODEM_CELLULAR_DATA_MANUFACTURER_LEN];
179 uint8_t fw_version[MODEM_CELLULAR_DATA_FW_VERSION_LEN];
180 uint8_t apn[MODEM_CELLULAR_DATA_APN_LEN];
181
182 struct modem_chat_script_chat apn_chats[MODEM_CELLULAR_MAX_APN_CMDS];
183 struct modem_chat_script apn_script;
184 char apn_buf[MODEM_CELLULAR_MAX_APN_CMDS][MODEM_CELLULAR_APN_BUF_SIZE];
185
186 struct modem_chat_script board_init_script;
187
188 /* PPP */
190
192 struct modem_ppp *ppp;
193
195 struct net_mgmt_event_callback net_mgmt_event_callback;
196
197 enum modem_cellular_state state;
198 const struct device *dev;
199 struct k_work_delayable timeout_work;
200
201 /* Power management */
202 struct k_sem suspended_sem;
203
204 /* Event dispatcher */
205 struct k_work event_dispatch_work;
206 uint8_t event_buf[8];
207 struct k_pipe event_pipe;
208
209 struct k_mutex api_lock;
210 struct modem_cellular_event_cb cb;
211
212 /* Ring interrupt */
213 struct gpio_callback ring_gpio_cb;
214
216 atomic_t periodic_paused;
218 bool periodic_timeout_skipped;
220};
221
223
224struct modem_cellular_user_pipe {
225 struct modem_cmux_dlci dlci;
226 uint8_t dlci_address;
227 uint8_t *dlci_receive_buf;
228 uint16_t dlci_receive_buf_size;
229 struct modem_pipe *pipe;
230 struct modem_pipelink *pipelink;
231};
232
234
262
290
292
293struct modem_cellular_config {
294 const struct device *uart;
295 const struct modem_cellular_vendor_config *vendor;
296 struct gpio_dt_spec power_gpio;
297 struct gpio_dt_spec reset_gpio;
298 struct gpio_dt_spec wake_gpio;
299 struct gpio_dt_spec ring_gpio;
300 struct gpio_dt_spec dtr_gpio;
301 bool autostarts;
302 bool hold_reset_on_suspend;
303 bool reset_on_resume;
304 bool reset_on_recovery;
305 bool cmux_enable_runtime_power_save;
306 bool cmux_close_pipe_on_power_save;
307 bool cmux_no_powersave_handshake;
308 bool use_default_pdp_context;
309 bool use_default_apn;
310 k_timeout_t cmux_idle_timeout;
311 struct modem_cellular_user_pipe *user_pipes;
312 uint8_t user_pipes_size;
313};
314
318int modem_cellular_init(const struct device *dev);
319
320int modem_cellular_pm_action(const struct device *dev, enum pm_device_action action);
321
322extern const struct cellular_driver_api modem_cellular_api;
323
324void modem_cellular_emit_event(struct modem_cellular_data *data, enum cellular_event evt,
325 const void *payload);
326
327void modem_cellular_chat_on_imei(struct modem_chat *chat, char **argv, uint16_t argc,
328 void *user_data);
329void modem_cellular_chat_on_cgmm(struct modem_chat *chat, char **argv, uint16_t argc,
330 void *user_data);
331void modem_cellular_chat_on_csq(struct modem_chat *chat, char **argv, uint16_t argc,
332 void *user_data);
333void modem_cellular_chat_on_cesq(struct modem_chat *chat, char **argv, uint16_t argc,
334 void *user_data);
335void modem_cellular_chat_on_iccid(struct modem_chat *chat, char **argv, uint16_t argc,
336 void *user_data);
337void modem_cellular_chat_on_imsi(struct modem_chat *chat, char **argv, uint16_t argc,
338 void *user_data);
339void modem_cellular_chat_on_cgmi(struct modem_chat *chat, char **argv, uint16_t argc,
340 void *user_data);
341void modem_cellular_chat_on_cgmr(struct modem_chat *chat, char **argv, uint16_t argc,
342 void *user_data);
343void modem_cellular_chat_on_cxreg(struct modem_chat *chat, char **argv, uint16_t argc,
344 void *user_data);
345void modem_cellular_chat_on_cgev(struct modem_chat *chat, char **argv, uint16_t argc,
346 void *user_data);
347void modem_cellular_chat_on_modem_ready(struct modem_chat *chat, char **argv, uint16_t argc,
348 void *user_data);
349
351
362void modem_cellular_chat_callback_handler(struct modem_chat *chat,
363 enum modem_chat_script_result result, void *user_data);
364
374
383#define MODEM_CELLULAR_INST_NAME(name, inst) \
384 CONCAT(name, _, DT_DRV_COMPAT, inst)
385
387
388#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, name, size) \
389 MODEM_PIPELINK_DT_INST_DEFINE(inst, name); \
390 static uint8_t MODEM_CELLULAR_INST_NAME(name, inst)[size] \
391
392#define MODEM_CELLULAR_INIT_USER_PIPE(_inst, _name, _dlci_address) \
393 { \
394 .dlci_address = _dlci_address, \
395 .dlci_receive_buf = MODEM_CELLULAR_INST_NAME(_name, _inst), \
396 .dlci_receive_buf_size = sizeof(MODEM_CELLULAR_INST_NAME(_name, _inst)), \
397 .pipelink = MODEM_PIPELINK_DT_INST_GET(_inst, _name), \
398 }
399
400#define MODEM_CELLULAR_DEFINE_USER_PIPES(inst, ...) \
401 static struct modem_cellular_user_pipe MODEM_CELLULAR_INST_NAME(user_pipes, inst)[] = { \
402 __VA_ARGS__ \
403 }
404
405#define MODEM_CELLULAR_GET_USER_PIPES(inst) \
406 MODEM_CELLULAR_INST_NAME(user_pipes, inst)
407
408/* Extract the first argument (pipe name) from a pair */
409#define MODEM_CELLULAR_GET_PIPE_NAME_ARG(arg1, ...) arg1
410
411/* Extract the second argument (DLCI address) from a pair */
412#define MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG(arg1, arg2, ...) arg2
413
414/* Define user pipe data using instance and extracted pipe name */
415#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER(_args, inst) \
416 MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, \
417 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
418 CONFIG_MODEM_CELLULAR_USER_PIPE_BUFFER_SIZES)
419
420/* Initialize user pipe using instance, extracted pipe name, and DLCI address */
421#define MODEM_CELLULAR_INIT_USER_PIPE_HELPER(_args, inst) \
422 MODEM_CELLULAR_INIT_USER_PIPE(inst, \
423 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
424 MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG _args)
425
427
438#define MODEM_CELLULAR_DEFINE_AND_INIT_USER_PIPES(inst, ...) \
439 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER, \
440 (;), inst, __VA_ARGS__); \
441 MODEM_CELLULAR_DEFINE_USER_PIPES( \
442 inst, \
443 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_INIT_USER_PIPE_HELPER, \
444 (,), inst, __VA_ARGS__) \
445 );
446
454#define MODEM_CELLULAR_COMMON_CHAT_MATCHES() \
455 MODEM_CHAT_MATCH_DEFINE(ok_match, "OK", "", NULL); \
456 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused allow_match, \
457 MODEM_CHAT_MATCH("OK", "", NULL), \
458 MODEM_CHAT_MATCH("ERROR", "", NULL)); \
459 MODEM_CHAT_MATCH_DEFINE(imei_match __maybe_unused, \
460 "", "", modem_cellular_chat_on_imei); \
461 MODEM_CHAT_MATCH_DEFINE(cgmm_match __maybe_unused, \
462 "", "", modem_cellular_chat_on_cgmm); \
463 MODEM_CHAT_MATCH_DEFINE(csq_match __maybe_unused, \
464 "+CSQ: ", ",", modem_cellular_chat_on_csq); \
465 MODEM_CHAT_MATCH_DEFINE(cesq_match __maybe_unused, \
466 "+CESQ: ", ",", modem_cellular_chat_on_cesq); \
467 MODEM_CHAT_MATCH_DEFINE(qccid_match __maybe_unused, \
468 "+QCCID: ", "", modem_cellular_chat_on_iccid); \
469 MODEM_CHAT_MATCH_DEFINE(iccid_match __maybe_unused, \
470 "+ICCID: ", "", modem_cellular_chat_on_iccid); \
471 MODEM_CHAT_MATCH_DEFINE(ccid_match __maybe_unused, \
472 "+CCID: ", "", modem_cellular_chat_on_iccid); \
473 MODEM_CHAT_MATCH_DEFINE(cimi_match __maybe_unused, \
474 "", "", modem_cellular_chat_on_imsi); \
475 MODEM_CHAT_MATCH_DEFINE(cgmi_match __maybe_unused, \
476 "", "", modem_cellular_chat_on_cgmi); \
477 MODEM_CHAT_MATCH_DEFINE(cgmr_match __maybe_unused, \
478 "", "", modem_cellular_chat_on_cgmr); \
479 MODEM_CHAT_MATCH_DEFINE(connect_match __maybe_unused, \
480 "CONNECT", "", NULL); \
481 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused abort_matches, \
482 MODEM_CHAT_MATCH("ERROR", "", NULL)); \
483 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused dial_abort_matches, \
484 MODEM_CHAT_MATCH("ERROR", "", NULL), \
485 MODEM_CHAT_MATCH("BUSY", "", NULL), \
486 MODEM_CHAT_MATCH("NO ANSWER", "", NULL), \
487 MODEM_CHAT_MATCH("NO CARRIER", "", NULL), \
488 MODEM_CHAT_MATCH("NO DIALTONE", "", NULL))
489
496#define MODEM_CELLULAR_COMMON_UNSOL_MATCHES \
497 MODEM_CHAT_MATCH("+CREG: ", ",", modem_cellular_chat_on_cxreg), \
498 MODEM_CHAT_MATCH("+CEREG: ", ",", modem_cellular_chat_on_cxreg), \
499 MODEM_CHAT_MATCH("+CGREG: ", ",", modem_cellular_chat_on_cxreg), \
500 MODEM_CHAT_MATCH("+CGEV: ", ",", modem_cellular_chat_on_cgev), \
501 MODEM_CHAT_MATCH("APP RDY", "", modem_cellular_chat_on_modem_ready), \
502 MODEM_CHAT_MATCH("Ready", "", modem_cellular_chat_on_modem_ready)
503
515#define MODEM_CELLULAR_DEFINE_INSTANCE(inst, vendor_config) \
516 BUILD_ASSERT(vendor_config != NULL, "vendor_config must be non-NULL"); \
517 static const struct modem_cellular_config MODEM_CELLULAR_INST_NAME(config, inst) = { \
518 .uart = DEVICE_DT_GET(DT_INST_BUS(inst)), \
519 .vendor = vendor_config, \
520 .power_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_power_gpios, {}), \
521 .reset_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_reset_gpios, {}), \
522 .wake_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_wake_gpios, {}), \
523 .ring_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_ring_gpios, {}), \
524 .dtr_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_dtr_gpios, {}), \
525 .autostarts = DT_INST_PROP(inst, autostarts), \
526 .hold_reset_on_suspend = \
527 DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, hold_on_suspend), \
528 .reset_on_resume = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
529 toggle_on_resume), \
530 .reset_on_recovery = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
531 toggle_on_recovery), \
532 .cmux_enable_runtime_power_save = \
533 DT_INST_PROP_OR(inst, cmux_enable_runtime_power_save, 0), \
534 .cmux_close_pipe_on_power_save = \
535 DT_INST_PROP_OR(inst, cmux_close_pipe_on_power_save, 0), \
536 .cmux_no_powersave_handshake = \
537 DT_INST_PROP_OR(inst, cmux_no_powersave_handshake, 0), \
538 .use_default_pdp_context = DT_INST_PROP_OR(inst, zephyr_use_default_pdp_ctx, 0), \
539 .use_default_apn = DT_INST_PROP_OR(inst, zephyr_use_default_apn, 0), \
540 .cmux_idle_timeout = K_MSEC(DT_INST_PROP_OR(inst, cmux_idle_timeout_ms, 0)), \
541 .user_pipes = MODEM_CELLULAR_GET_USER_PIPES(inst), \
542 .user_pipes_size = ARRAY_SIZE(MODEM_CELLULAR_GET_USER_PIPES(inst)), \
543 }; \
544 \
545 PM_DEVICE_DT_INST_DEFINE(inst, modem_cellular_pm_action); \
546 \
547 DEVICE_DT_INST_DEFINE(inst, modem_cellular_init, PM_DEVICE_DT_INST_GET(inst), \
548 &MODEM_CELLULAR_INST_NAME(data, inst), \
549 &MODEM_CELLULAR_INST_NAME(config, inst), POST_KERNEL, \
550 CONFIG_MODEM_CELLULAR_INIT_PRIORITY, &modem_cellular_api);
551
557struct modem_cellular_board_init {
558 const struct device *dev;
559 const struct modem_chat_script *script;
560};
561
574#if defined(CONFIG_MODEM_CELLULAR)
575#define MODEM_CELLULAR_BOARD_INIT_DEFINE(node_id, _script) \
576 static const STRUCT_SECTION_ITERABLE( \
577 modem_cellular_board_init, \
578 CONCAT(modem_cellular_board_init_, DT_DEP_ORD(node_id))) = { \
579 .dev = DEVICE_DT_GET(node_id), \
580 .script = (_script), \
581 }
582#else
583#define MODEM_CELLULAR_BOARD_INIT_DEFINE(node_id, _script)
584#endif
585
587
589
594
611int cellular_modem_pause_periodic_script(const struct device *dev);
612
628int cellular_modem_resume_periodic_script(const struct device *dev);
629
631
632#ifdef __cplusplus
633}
634#endif
635
636#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.
atomic_t
long atomic_t
Atomic integer variable.
Definition atomic_types.h:31
cellular_access_technology
cellular_access_technology
Cellular access technologies (3GPP TS 27.007 AcT).
Definition cellular.h:33
cellular_event
cellular_event
Events emitted asynchronously by a cellular driver.
Definition cellular.h:137
cellular_modem_pause_periodic_script
int cellular_modem_pause_periodic_script(const struct device *dev)
Pause the cellular_modem driver's periodic chat script.
cellular_modem_resume_periodic_script
int cellular_modem_resume_periodic_script(const struct device *dev)
Resume the cellular_modem driver's periodic chat script.
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:149
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:202
modem_cellular_chat_callback_handler
void modem_cellular_chat_callback_handler(struct modem_chat *chat, enum modem_chat_script_result result, void *user_data)
Handle completion of a modem chat script.
modem_chat_script_result
modem_chat_script_result
Definition chat.h:156
pm_device_action
pm_device_action
Device PM actions.
Definition device.h:150
state
state
Definition parser_state.h:29
device.h
Header file for the Device Power Management API.
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
@driver_ops{Cellular}
Definition cellular.h:245
device
Runtime device structure (in ROM) per driver instance.
Definition device.h:513
gpio_callback
GPIO callback structure.
Definition gpio.h:747
gpio_dt_spec
Container for GPIO pin information specified in devicetree.
Definition gpio.h:296
k_mutex
Kernel mutex structure.
Definition kernel.h:3477
k_pipe
Kernel pipe structure.
Definition kernel.h:5717
k_sem
Semaphore structure.
Definition kernel.h:3703
k_timeout_t
Kernel timeout type.
Definition clock.h:65
k_work_delayable
A structure used to submit work after a delay.
Definition kernel.h:4643
k_work
A structure used to submit work.
Definition kernel.h:4601
modem_backend_uart
Definition uart.h:69
modem_cellular_board_init
Descriptor binding a board-supplied init script to a modem instance.
Definition modem_cellular.h:557
modem_cellular_board_init::script
const struct modem_chat_script * script
Definition modem_cellular.h:559
modem_cellular_board_init::dev
const struct device * dev
Definition modem_cellular.h:558
modem_cellular_config_scripts
Chat scripts for cellular modem.
Definition modem_cellular.h:248
modem_cellular_config_scripts::periodic
const struct modem_chat_script * periodic
Optional script that periodically polls modem state while registered.
Definition modem_cellular.h:258
modem_cellular_config_scripts::dial
const struct modem_chat_script * dial
Script that starts the PPP data connection.
Definition modem_cellular.h:256
modem_cellular_config_scripts::network
const struct modem_chat_script * network
Optional script that waits for network registration before dialing.
Definition modem_cellular.h:254
modem_cellular_config_scripts::set_baudrate
const struct modem_chat_script * set_baudrate
Optional script that configures the modem's UART baud rate.
Definition modem_cellular.h:250
modem_cellular_config_scripts::shutdown
const struct modem_chat_script * shutdown
Optional script that prepares the modem for power-off.
Definition modem_cellular.h:260
modem_cellular_config_scripts::init
const struct modem_chat_script * init
Script that initializes the modem and enables CMUX.
Definition modem_cellular.h:252
modem_cellular_data
Runtime data for a cellular modem driver instance.
Definition modem_cellular.h:119
modem_cellular_data::chat_delimiter
uint8_t * chat_delimiter
Command delimiter used by the modem, as a NULL-terminated string.
Definition modem_cellular.h:153
modem_cellular_data::ppp
struct modem_ppp * ppp
PPP context used for the modem data connection.
Definition modem_cellular.h:192
modem_cellular_data::chat_filter
uint8_t * chat_filter
Characters filtered from modem responses, as a NULL-terminated string.
Definition modem_cellular.h:160
modem_cellular_vendor_config
Vendor-specific cellular modem configuration.
Definition modem_cellular.h:269
modem_cellular_vendor_config::shutdown_time_ms
uint16_t shutdown_time_ms
Maximum modem shutdown delay, in milliseconds.
Definition modem_cellular.h:286
modem_cellular_vendor_config::reset_pulse_duration_ms
uint16_t reset_pulse_duration_ms
Duration of the modem reset pulse, in milliseconds.
Definition modem_cellular.h:282
modem_cellular_vendor_config::force_autostart
bool force_autostart
Force autostart regardless of the devicetree autostarts property.
Definition modem_cellular.h:288
modem_cellular_vendor_config::unsol_matches
struct modem_cellular_vendor_config::@125173161324242306355007001312260252170162237167 unsol_matches
Unsolicited modem response matches.
modem_cellular_vendor_config::scripts
struct modem_cellular_config_scripts scripts
Chat scripts implementing the modem lifecycle.
Definition modem_cellular.h:271
modem_cellular_vendor_config::matches
const struct modem_chat_match * matches
Array of unsolicited response matches, or NULL when size is zero.
Definition modem_cellular.h:275
modem_cellular_vendor_config::size
uint16_t size
Number of elements in matches.
Definition modem_cellular.h:277
modem_cellular_vendor_config::power_pulse_duration_ms
uint16_t power_pulse_duration_ms
Duration of the modem power-key pulse, in milliseconds.
Definition modem_cellular.h:280
modem_cellular_vendor_config::startup_time_ms
uint16_t startup_time_ms
Maximum modem startup delay, in milliseconds.
Definition modem_cellular.h:284
modem_chat_match
Modem chat match.
Definition chat.h:47
modem_chat_script_chat
Modem chat script chat.
Definition chat.h:110
modem_chat_script
Modem chat script.
Definition chat.h:175
modem_chat
Chat instance internal context.
Definition chat.h:223
net_mgmt_event_callback
Network Management event callback structure Used to register a callback into the network management e...
Definition net_mgmt.h:163
atomic.h
Header file for the Atomic operations API.
iterable_sections.h
Iterable sections helpers.