modem_cellular.h File Reference

Backend helpers for implementing cellular modem drivers. More...

#include <zephyr/drivers/cellular.h>
#include <zephyr/modem/backend/uart.h>
#include <zephyr/drivers/uart.h>
#include <zephyr/drivers/gpio.h>
#include <zephyr/pm/device.h>
#include <zephyr/modem/chat.h>
#include <zephyr/modem/cmux.h>
#include <zephyr/modem/pipe.h>
#include <zephyr/modem/pipelink.h>
#include <zephyr/modem/ppp.h>
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/sys/atomic.h>

Go to the source code of this file.

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...
struct	modem_cellular_board_init
	Descriptor binding a board-supplied init script to a modem instance. More...

Macros
#define	MODEM_CELLULAR_INST_NAME(name, inst)
	Generate a unique C identifier for a modem instance object.
#define	MODEM_CELLULAR_DEFINE_AND_INIT_USER_PIPES(inst, ...)
	Define additional CMUX user pipes for a modem instance.
#define	MODEM_CELLULAR_COMMON_CHAT_MATCHES()
	Define common chat matches used by cellular modem scripts.
#define	MODEM_CELLULAR_COMMON_UNSOL_MATCHES
	Expand to the common unsolicited response matches.
#define	MODEM_CELLULAR_DEFINE_INSTANCE(inst, vendor_config)
	Define a cellular modem device instance.
#define	MODEM_CELLULAR_BOARD_INIT_DEFINE(node_id, _script)
	Register a board-specific init script for a modem instance.

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.
int	cellular_modem_pause_periodic_script (const struct device *dev)
	Pause the cellular_modem driver's periodic chat script.
int	cellular_modem_resume_periodic_script (const struct device *dev)
	Resume the cellular_modem driver's periodic chat script.

Detailed Description

Backend helpers for implementing cellular modem drivers.