Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Implement vendor-specific cellular modem drivers using common chat, CMUX, PPP, and power-management support. More...

Topics

 Cellular modem driver definition macros
 Define device instances that use the cellular modem driver.

Files

file  modem_cellular.h
 Backend helpers for implementing cellular modem drivers.

Data Structures

struct  modem_cellular_data
 Runtime data for a cellular modem driver instance. More...
struct  modem_cellular_config_scripts
 Chat scripts for cellular modem. More...
struct  modem_cellular_vendor_config
 Vendor-specific cellular modem configuration. More...

Functions

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.

Detailed Description

Implement vendor-specific cellular modem drivers using common chat, CMUX, PPP, and power-management support.

Function Documentation

◆ modem_cellular_chat_callback_handler()

void modem_cellular_chat_callback_handler ( struct modem_chat * chat,
enum modem_chat_script_result result,
void * user_data )

#include <zephyr/drivers/modem/modem_cellular.h>

Handle completion of a modem chat script.

Use this as the callback for lifecycle scripts executed by the cellular modem state machine. The callback translates the chat result into the corresponding internal state-machine event.

Parameters
chatChat instance that completed the script. Must not be NULL.
resultScript completion result.
user_dataPointer to the associated modem_cellular_data object. Must not be NULL.