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_SN_LEN (CONFIG_MODEM_CELLULAR_SERIAL_NUMBER_MAX_SIZE + 1)
45#define MODEM_CELLULAR_DATA_MODEL_ID_LEN (65)
46#define MODEM_CELLULAR_DATA_IMSI_LEN (23)
47#define MODEM_CELLULAR_DATA_ICCID_LEN (22)
48#define MODEM_CELLULAR_DATA_MANUFACTURER_LEN (65)
49#define MODEM_CELLULAR_DATA_FW_VERSION_LEN (65)
50#define MODEM_CELLULAR_DATA_APN_LEN (32)
51#define MODEM_CELLULAR_MAX_APN_CMDS (2)
52#define MODEM_CELLULAR_APN_BUF_SIZE (64)
53
54/* Zephyr networking interface states:
55 * NET_IF_LOWER_UP: Carrier is on in AWAIT_REGISTERED and REGISTERED
56 * NET_IF_DORMANT: Interface is dormant in every state except REGISTERED
57 */
58enum modem_cellular_state {
59 MODEM_CELLULAR_STATE_IDLE = 0,
60 MODEM_CELLULAR_STATE_RECOVERY,
61 MODEM_CELLULAR_STATE_RESET_PULSE,
62 MODEM_CELLULAR_STATE_AWAIT_RESET,
63 MODEM_CELLULAR_STATE_POWER_ON_PULSE,
64 MODEM_CELLULAR_STATE_AWAIT_POWER_ON,
65 MODEM_CELLULAR_STATE_SET_BAUDRATE,
66 MODEM_CELLULAR_STATE_RUN_INIT_SCRIPT,
67 MODEM_CELLULAR_STATE_CONNECT_CMUX,
68 MODEM_CELLULAR_STATE_OPEN_DLCI1,
69 MODEM_CELLULAR_STATE_OPEN_DLCI2,
70 MODEM_CELLULAR_STATE_RUN_BOARD_INIT_SCRIPT,
71 MODEM_CELLULAR_STATE_WAIT_FOR_APN,
72 MODEM_CELLULAR_STATE_RUN_APN_SCRIPT,
73 MODEM_CELLULAR_STATE_RUN_NETWORK_SCRIPT,
74 MODEM_CELLULAR_STATE_RUN_DIAL_SCRIPT,
75 MODEM_CELLULAR_STATE_AWAIT_REGISTERED,
76 MODEM_CELLULAR_STATE_REGISTERED,
77 MODEM_CELLULAR_STATE_AWAIT_PPP_DEAD,
78 MODEM_CELLULAR_STATE_INIT_POWER_OFF,
79 MODEM_CELLULAR_STATE_RUN_SHUTDOWN_SCRIPT,
80 MODEM_CELLULAR_STATE_POWER_OFF_PULSE,
81 MODEM_CELLULAR_STATE_AWAIT_POWER_OFF,
82 MODEM_CELLULAR_STATE_AWAIT_DIAL,
83};
84
85enum modem_cellular_event {
86 MODEM_CELLULAR_EVENT_RESUME = 0,
87 MODEM_CELLULAR_EVENT_SUSPEND,
88 MODEM_CELLULAR_EVENT_SCRIPT_SUCCESS,
89 MODEM_CELLULAR_EVENT_SCRIPT_FAILED,
90 MODEM_CELLULAR_EVENT_CMUX_CONNECTED,
91 MODEM_CELLULAR_EVENT_CMUX_DISCONNECTED,
92 MODEM_CELLULAR_EVENT_DLCI1_OPENED,
93 MODEM_CELLULAR_EVENT_DLCI2_OPENED,
94 MODEM_CELLULAR_EVENT_TIMEOUT,
95 MODEM_CELLULAR_EVENT_REGISTERED,
96 MODEM_CELLULAR_EVENT_DEREGISTERED,
97 MODEM_CELLULAR_EVENT_BUS_OPENED,
98 MODEM_CELLULAR_EVENT_BUS_CLOSED,
99 MODEM_CELLULAR_EVENT_PPP_DEAD,
100 MODEM_CELLULAR_EVENT_MODEM_READY,
101 MODEM_CELLULAR_EVENT_APN_SET,
102 MODEM_CELLULAR_EVENT_RING,
103 MODEM_CELLULAR_EVENT_PERIODIC_KICK,
104 MODEM_CELLULAR_EVENT_DIAL,
105 MODEM_CELLULAR_EVENT_HANGUP,
106};
107
108struct modem_cellular_event_cb {
109 cellular_event_mask_t mask;
110 cellular_event_cb_t fn;
111 void *user_data;
112};
113
115
124struct modem_cellular_data {
126 /* UART backend */
127 struct modem_pipe *uart_pipe;
128 struct modem_backend_uart uart_backend;
129 uint8_t uart_backend_receive_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
130 uint8_t uart_backend_transmit_buf[CONFIG_MODEM_CELLULAR_UART_BUFFER_SIZES];
131 uint32_t original_baudrate;
132
133 /* CMUX */
134 struct modem_cmux cmux;
135 uint8_t cmux_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
136 uint8_t cmux_transmit_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
137
138 struct modem_cmux_dlci dlci1;
139 struct modem_cmux_dlci dlci2;
140 struct modem_pipe *dlci1_pipe;
141 struct modem_pipe *dlci2_pipe;
142 /* Points to dlci1_pipe or NULL. Used for shutdown script if not NULL */
143 struct modem_pipe *cmd_pipe;
144 uint8_t dlci1_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
145 /* DLCI 2 is only used for chat scripts. */
146 uint8_t dlci2_receive_buf[MODEM_CMUX_WORK_BUFFER_SIZE];
147
148 /* Modem chat */
149 struct modem_chat chat;
150 uint8_t chat_receive_buf[CONFIG_MODEM_CELLULAR_CHAT_BUFFER_SIZE];
151 uint8_t *chat_argv[32];
152 uint8_t script_failure_counter;
153 uint8_t recovery_count;
154
155 /* Status */
156 enum cellular_registration_status registration_status_gsm;
157 enum cellular_registration_status registration_status_gprs;
158 enum cellular_registration_status registration_status_lte;
159 enum cellular_registration_status registration_status_5g;
160 enum cellular_access_technology access_tech;
161 uint8_t rssi;
162 uint8_t rsrp;
163 uint8_t rsrq;
164 struct cellular_evt_network_status network_status;
165 bool network_status_valid;
166 uint8_t imei[MODEM_CELLULAR_DATA_IMEI_LEN];
167 uint8_t sn[MODEM_CELLULAR_DATA_SN_LEN];
168 uint8_t model_id[MODEM_CELLULAR_DATA_MODEL_ID_LEN];
169 uint8_t imsi[MODEM_CELLULAR_DATA_IMSI_LEN];
170 uint8_t iccid[MODEM_CELLULAR_DATA_ICCID_LEN];
171 uint8_t manufacturer[MODEM_CELLULAR_DATA_MANUFACTURER_LEN];
172 uint8_t fw_version[MODEM_CELLULAR_DATA_FW_VERSION_LEN];
173 uint8_t apn[MODEM_CELLULAR_DATA_APN_LEN];
174
175 struct modem_chat_script_chat apn_chats[MODEM_CELLULAR_MAX_APN_CMDS];
176 struct modem_chat_script apn_script;
177 char apn_buf[MODEM_CELLULAR_MAX_APN_CMDS][MODEM_CELLULAR_APN_BUF_SIZE];
178
179 struct modem_chat_script board_init_script;
180
181 struct net_mgmt_event_callback net_mgmt_event_callback;
182#if defined(CONFIG_MODEM_CELLULAR_ON_DEMAND_CONNECT)
183 struct net_mgmt_event_callback if_event_callback;
184#endif
185
186 enum modem_cellular_state state;
187 const struct device *dev;
188 struct k_work_delayable timeout_work;
189
190 /* Power management */
191 struct k_sem suspended_sem;
192
193 /* Event dispatcher */
194 struct k_work event_dispatch_work;
195 uint8_t event_buf[8];
196 struct k_pipe event_pipe;
197
198 struct k_mutex api_lock;
199 struct modem_cellular_event_cb cb;
200
201 /* Ring interrupt */
202 struct gpio_callback ring_gpio_cb;
203
205 atomic_t periodic_paused;
207 bool periodic_timeout_skipped;
211 bool power_on_skipped;
212
213#if defined(CONFIG_MODEM_CELLULAR_STATS)
215 struct cellular_stats stats;
217 uint32_t stats_outage_start_ms;
218#endif
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
264
310
312
313struct modem_cellular_config {
314 const struct device *uart;
315 const struct modem_cellular_vendor_config *vendor;
316 const void *vendor_specific;
317 struct modem_ppp *ppp;
318 struct gpio_dt_spec power_gpio;
319 struct gpio_dt_spec reset_gpio;
320 struct gpio_dt_spec wake_gpio;
321 struct gpio_dt_spec ring_gpio;
322 struct gpio_dt_spec dtr_gpio;
323 struct gpio_dt_spec status_gpio;
324 bool autostarts;
325 bool hold_reset_on_suspend;
326 bool reset_on_resume;
327 bool reset_on_recovery;
328 bool cmux_enable_runtime_power_save;
329 bool cmux_close_pipe_on_power_save;
330 bool cmux_no_powersave_handshake;
331 bool use_default_pdp_context;
332 bool use_default_apn;
333 k_timeout_t cmux_idle_timeout;
334 struct modem_cellular_user_pipe *user_pipes;
335 uint8_t user_pipes_size;
336};
337
341int modem_cellular_init(const struct device *dev);
342
343int modem_cellular_pm_action(const struct device *dev, enum pm_device_action action);
344
345extern const struct cellular_driver_api modem_cellular_api;
346
347void modem_cellular_emit_event(struct modem_cellular_data *data, enum cellular_event evt,
348 const void *payload);
349
350/*
351 * Store the latest serving-cell status and emit CELLULAR_EVENT_NETWORK_STATUS_CHANGED
352 * only when it changed, ignoring signal quality (rsrp/rsrq) so periodic polls do not
353 * re-fire the event on signal fluctuation.
354 */
355void modem_cellular_emit_network_status(struct modem_cellular_data *data,
356 const struct cellular_evt_network_status *status);
357
358void modem_cellular_chat_on_imei(struct modem_chat *chat, char **argv, uint16_t argc,
359 void *user_data);
360void modem_cellular_chat_on_cgsn_sn(struct modem_chat *chat, char **argv, uint16_t argc,
361 void *user_data);
362void modem_cellular_chat_on_cgsn_imei(struct modem_chat *chat, char **argv, uint16_t argc,
363 void *user_data);
364void modem_cellular_chat_on_cgmm(struct modem_chat *chat, char **argv, uint16_t argc,
365 void *user_data);
366void modem_cellular_chat_on_csq(struct modem_chat *chat, char **argv, uint16_t argc,
367 void *user_data);
368void modem_cellular_chat_on_cesq(struct modem_chat *chat, char **argv, uint16_t argc,
369 void *user_data);
370void modem_cellular_chat_on_iccid(struct modem_chat *chat, char **argv, uint16_t argc,
371 void *user_data);
372void modem_cellular_chat_on_imsi(struct modem_chat *chat, char **argv, uint16_t argc,
373 void *user_data);
374void modem_cellular_chat_on_cgmi(struct modem_chat *chat, char **argv, uint16_t argc,
375 void *user_data);
376void modem_cellular_chat_on_cgmr(struct modem_chat *chat, char **argv, uint16_t argc,
377 void *user_data);
378void modem_cellular_chat_on_cxreg(struct modem_chat *chat, char **argv, uint16_t argc,
379 void *user_data);
380void modem_cellular_chat_on_cgev(struct modem_chat *chat, char **argv, uint16_t argc,
381 void *user_data);
382void modem_cellular_chat_on_modem_ready(struct modem_chat *chat, char **argv, uint16_t argc,
383 void *user_data);
384
386
398void modem_cellular_chat_callback_handler(struct modem_chat *chat,
399 enum modem_chat_script_result result,
400 const struct modem_chat_script_completion_info *info,
401 void *user_data);
402
412
421#define MODEM_CELLULAR_INST_NAME(name, inst) \
422 CONCAT(name, _, DT_DRV_COMPAT, inst)
423
425
426#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, name, size) \
427 MODEM_PIPELINK_DT_INST_DEFINE(inst, name); \
428 static uint8_t MODEM_CELLULAR_INST_NAME(name, inst)[size] \
429
430#define MODEM_CELLULAR_INIT_USER_PIPE(_inst, _name, _dlci_address) \
431 { \
432 .dlci_address = _dlci_address, \
433 .dlci_receive_buf = MODEM_CELLULAR_INST_NAME(_name, _inst), \
434 .dlci_receive_buf_size = sizeof(MODEM_CELLULAR_INST_NAME(_name, _inst)), \
435 .pipelink = MODEM_PIPELINK_DT_INST_GET(_inst, _name), \
436 }
437
438#define MODEM_CELLULAR_DEFINE_USER_PIPES(inst, ...) \
439 static struct modem_cellular_user_pipe MODEM_CELLULAR_INST_NAME(user_pipes, inst)[] = { \
440 __VA_ARGS__ \
441 }
442
443#define MODEM_CELLULAR_GET_USER_PIPES(inst) \
444 MODEM_CELLULAR_INST_NAME(user_pipes, inst)
445
446/* Extract the first argument (pipe name) from a pair */
447#define MODEM_CELLULAR_GET_PIPE_NAME_ARG(arg1, ...) arg1
448
449/* Extract the second argument (DLCI address) from a pair */
450#define MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG(arg1, arg2, ...) arg2
451
452/* Define user pipe data using instance and extracted pipe name */
453#define MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER(_args, inst) \
454 MODEM_CELLULAR_DEFINE_USER_PIPE_DATA(inst, \
455 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
456 CONFIG_MODEM_CELLULAR_USER_PIPE_BUFFER_SIZES)
457
458/* Initialize user pipe using instance, extracted pipe name, and DLCI address */
459#define MODEM_CELLULAR_INIT_USER_PIPE_HELPER(_args, inst) \
460 MODEM_CELLULAR_INIT_USER_PIPE(inst, \
461 MODEM_CELLULAR_GET_PIPE_NAME_ARG _args, \
462 MODEM_CELLULAR_GET_DLCI_ADDRESS_ARG _args)
463
465
476#define MODEM_CELLULAR_DEFINE_AND_INIT_USER_PIPES(inst, ...) \
477 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_DEFINE_USER_PIPE_DATA_HELPER, \
478 (;), inst, __VA_ARGS__); \
479 MODEM_CELLULAR_DEFINE_USER_PIPES( \
480 inst, \
481 FOR_EACH_FIXED_ARG(MODEM_CELLULAR_INIT_USER_PIPE_HELPER, \
482 (,), inst, __VA_ARGS__) \
483 );
484
495#define MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(_sym, _match, _separators, _callback) \
496 MODEM_CHAT_MATCHES_DEFINE(_sym, \
497 MODEM_CHAT_MATCH_INITIALIZER(_match, _separators, _callback, false, true), \
498 MODEM_CHAT_MATCH("OK", "", NULL))
499
507#define MODEM_CELLULAR_COMMON_CHAT_MATCHES() \
508 MODEM_CHAT_MATCH_DEFINE(ok_match, "OK", "", NULL); \
509 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused allow_match, \
510 MODEM_CHAT_MATCH("OK", "", NULL), \
511 MODEM_CHAT_MATCH("ERROR", "", NULL)); \
512 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused imei_match, \
513 "", "", modem_cellular_chat_on_imei); \
514 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cgsn_sn_match, \
515 "", "", modem_cellular_chat_on_cgsn_sn); \
516 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cgsn_imei_match, \
517 "+CGSN: ", "", modem_cellular_chat_on_cgsn_imei); \
518 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cgmm_match, \
519 "", "", modem_cellular_chat_on_cgmm); \
520 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused csq_match, \
521 "+CSQ: ", ",", modem_cellular_chat_on_csq); \
522 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cesq_match, \
523 "+CESQ: ", ",", modem_cellular_chat_on_cesq); \
524 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused qccid_match, \
525 "+QCCID: ", "", modem_cellular_chat_on_iccid); \
526 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused iccid_match, \
527 "+ICCID: ", "", modem_cellular_chat_on_iccid); \
528 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused ccid_match, \
529 "+CCID: ", "", modem_cellular_chat_on_iccid); \
530 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cimi_match, \
531 "", "", modem_cellular_chat_on_imsi); \
532 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cgmi_match, \
533 "", "", modem_cellular_chat_on_cgmi); \
534 MODEM_CELLULAR_OK_CHAT_MATCH_DEFINE(__maybe_unused cgmr_match, \
535 "", "", modem_cellular_chat_on_cgmr); \
536 MODEM_CHAT_MATCH_DEFINE(connect_match __maybe_unused, \
537 "CONNECT", "", NULL); \
538 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused abort_matches, \
539 MODEM_CHAT_MATCH("ERROR", "", NULL)); \
540 MODEM_CHAT_MATCHES_DEFINE(__maybe_unused dial_abort_matches, \
541 MODEM_CHAT_MATCH("ERROR", "", NULL), \
542 MODEM_CHAT_MATCH("BUSY", "", NULL), \
543 MODEM_CHAT_MATCH("NO ANSWER", "", NULL), \
544 MODEM_CHAT_MATCH("NO CARRIER", "", NULL), \
545 MODEM_CHAT_MATCH("NO DIALTONE", "", NULL))
546
553#define MODEM_CELLULAR_COMMON_UNSOL_MATCHES \
554 MODEM_CHAT_MATCH("+CREG: ", ",", modem_cellular_chat_on_cxreg), \
555 MODEM_CHAT_MATCH("+CEREG: ", ",", modem_cellular_chat_on_cxreg), \
556 MODEM_CHAT_MATCH("+CGREG: ", ",", modem_cellular_chat_on_cxreg), \
557 MODEM_CHAT_MATCH("+CGEV: ", ",", modem_cellular_chat_on_cgev), \
558 MODEM_CHAT_MATCH("APP RDY", "", modem_cellular_chat_on_modem_ready), \
559 MODEM_CHAT_MATCH("Ready", "", modem_cellular_chat_on_modem_ready)
560
574#define MODEM_CELLULAR_DEFINE_INSTANCE(inst, vendor_config, _vendor_specific) \
575 BUILD_ASSERT(vendor_config != NULL, "vendor_config must be non-NULL"); \
576 static const struct modem_cellular_config MODEM_CELLULAR_INST_NAME(config, inst) = { \
577 .uart = DEVICE_DT_GET(DT_INST_BUS(inst)), \
578 .vendor = vendor_config, \
579 .vendor_specific = _vendor_specific, \
580 .ppp = &MODEM_CELLULAR_INST_NAME(ppp, inst), \
581 .power_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_power_gpios, {}), \
582 .reset_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_reset_gpios, {}), \
583 .wake_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_wake_gpios, {}), \
584 .ring_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_ring_gpios, {}), \
585 .dtr_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_dtr_gpios, {}), \
586 .status_gpio = GPIO_DT_SPEC_INST_GET_OR(inst, mdm_status_gpios, {}), \
587 .autostarts = DT_INST_PROP(inst, autostarts), \
588 .hold_reset_on_suspend = \
589 DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, hold_on_suspend), \
590 .reset_on_resume = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
591 toggle_on_resume), \
592 .reset_on_recovery = DT_INST_ENUM_HAS_VALUE(inst, zephyr_mdm_reset_behavior, \
593 toggle_on_recovery), \
594 .cmux_enable_runtime_power_save = \
595 DT_INST_PROP_OR(inst, cmux_enable_runtime_power_save, 0), \
596 .cmux_close_pipe_on_power_save = \
597 DT_INST_PROP_OR(inst, cmux_close_pipe_on_power_save, 0), \
598 .cmux_no_powersave_handshake = \
599 DT_INST_PROP_OR(inst, cmux_no_powersave_handshake, 0), \
600 .use_default_pdp_context = DT_INST_PROP_OR(inst, zephyr_use_default_pdp_ctx, 0), \
601 .use_default_apn = DT_INST_PROP_OR(inst, zephyr_use_default_apn, 0), \
602 .cmux_idle_timeout = K_MSEC(DT_INST_PROP_OR(inst, cmux_idle_timeout_ms, 0)), \
603 .user_pipes = MODEM_CELLULAR_GET_USER_PIPES(inst), \
604 .user_pipes_size = ARRAY_SIZE(MODEM_CELLULAR_GET_USER_PIPES(inst)), \
605 }; \
606 \
607 PM_DEVICE_DT_INST_DEFINE(inst, modem_cellular_pm_action); \
608 \
609 DEVICE_DT_INST_DEFINE(inst, modem_cellular_init, PM_DEVICE_DT_INST_GET(inst), \
610 &MODEM_CELLULAR_INST_NAME(data, inst), \
611 &MODEM_CELLULAR_INST_NAME(config, inst), POST_KERNEL, \
612 CONFIG_MODEM_CELLULAR_INIT_PRIORITY, &modem_cellular_api);
613
619struct modem_cellular_board_init {
620 const struct device *dev;
621 const struct modem_chat_script *script;
622};
623
636#if defined(CONFIG_MODEM_CELLULAR)
637#define MODEM_CELLULAR_BOARD_INIT_DEFINE(node_id, _script) \
638 static const STRUCT_SECTION_ITERABLE( \
639 modem_cellular_board_init, \
640 CONCAT(modem_cellular_board_init_, DT_DEP_ORD(node_id))) = { \
641 .dev = DEVICE_DT_GET(node_id), \
642 .script = (_script), \
643 }
644#else
645#define MODEM_CELLULAR_BOARD_INIT_DEFINE(node_id, _script)
646#endif
647
649
651
656
673int cellular_modem_pause_periodic_script(const struct device *dev);
674
690int cellular_modem_resume_periodic_script(const struct device *dev);
691
693
694#ifdef __cplusplus
695}
696#endif
697
698#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:39
cellular_event
cellular_event
Events emitted asynchronously by a cellular driver.
Definition cellular.h:145
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:117
cellular_event_mask_t
uint32_t cellular_event_mask_t
Definition cellular.h:159
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:234
modem_cellular_chat_callback_handler
void modem_cellular_chat_callback_handler(struct modem_chat *chat, enum modem_chat_script_result result, const struct modem_chat_script_completion_info *info, void *user_data)
Handle completion of a modem chat script.
modem_chat_script_result
modem_chat_script_result
Definition chat.h:250
pm_device_action
pm_device_action
Device PM actions.
Definition device.h:154
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:284
cellular_evt_network_status
Payload for CELLULAR_EVENT_NETWORK_STATUS_CHANGED.
Definition cellular.h:182
cellular_stats
Cellular link operational statistics.
Definition cellular.h:205
device
Runtime device structure (in ROM) per driver instance.
Definition device.h:543
gpio_callback
GPIO callback structure.
Definition gpio.h:771
gpio_dt_spec
Container for GPIO pin information specified in devicetree.
Definition gpio.h:296
k_mutex
Kernel mutex structure.
Definition kernel.h:3504
k_pipe
Kernel pipe structure.
Definition kernel.h:5835
k_sem
Semaphore structure.
Definition kernel.h:3738
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:4693
k_work
A structure used to submit work.
Definition kernel.h:4651
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:619
modem_cellular_board_init::script
const struct modem_chat_script * script
Definition modem_cellular.h:621
modem_cellular_board_init::dev
const struct device * dev
Definition modem_cellular.h:620
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_config_scripts::dlci_setup
const struct modem_chat_script * dlci_setup
Optional script for configuring DLCI channels after opening.
Definition modem_cellular.h:262
modem_cellular_data
Runtime data for a cellular modem driver instance.
Definition modem_cellular.h:124
modem_cellular_vendor_config
Vendor-specific cellular modem configuration.
Definition modem_cellular.h:271
modem_cellular_vendor_config::shutdown_time_ms
uint16_t shutdown_time_ms
Maximum modem shutdown delay, in milliseconds.
Definition modem_cellular.h:306
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:297
modem_cellular_vendor_config::force_autostart
bool force_autostart
Force autostart regardless of the devicetree autostarts property.
Definition modem_cellular.h:308
modem_cellular_vendor_config::chat_delimiter
const char * chat_delimiter
Command delimiter used by the modem, as a NULL-terminated string.
Definition modem_cellular.h:286
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:273
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:277
modem_cellular_vendor_config::size
uint16_t size
Number of elements in matches.
Definition modem_cellular.h:279
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:295
modem_cellular_vendor_config::chat_filter
const char * chat_filter
Characters filtered from modem responses, as a NULL-terminated string.
Definition modem_cellular.h:293
modem_cellular_vendor_config::cmux_disconnect_timeout_ms
uint16_t cmux_disconnect_timeout_ms
Timeout for the modem to revert from CMUX to AT mode after a CMUX disconnect, in milliseconds.
Definition modem_cellular.h:302
modem_cellular_vendor_config::startup_time_ms
uint16_t startup_time_ms
Maximum modem startup delay, in milliseconds.
Definition modem_cellular.h:304
modem_chat_match
Modem chat match.
Definition chat.h:58
modem_chat_script_chat
Modem chat script chat.
Definition chat.h:125
modem_chat_script_completion_info
Extra information about the script that completed.
Definition chat.h:259
modem_chat_script
Modem chat script.
Definition chat.h:287
modem_chat
Chat instance internal context.
Definition chat.h:333
net_mgmt_event_callback
Network Management event callback structure Used to register a callback into the network management e...
Definition net_mgmt.h:164
atomic.h
Header file for the Atomic operations API.
iterable_sections.h
Iterable sections helpers.