Driver Operations Cellular driver operations More...

#include <zephyr/drivers/cellular.h>

Data Fields
cellular_api_configure_networks	configure_networks
	OPT Configure cellular networks for the device.
cellular_api_get_supported_networks	get_supported_networks
	OPT Get supported cellular networks for the device.
cellular_api_get_signal	get_signal
	OPT Get signal for the device.
cellular_api_get_modem_info	get_modem_info
	OPT Get modem info for the device.
cellular_api_get_registration_status	get_registration_status
	OPT Get network registration status for the device.
cellular_api_set_apn	set_apn
	OPT Set the APN used for PDP context.
cellular_api_set_callback	set_callback
	OPT Subscribe to asynchronous cellular events.
cellular_api_get_stats	get_stats
	OPT Read operational statistics from the cellular device.

Detailed Description

Driver Operations Cellular driver operations

This is the driver API structure any Cellular driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ configure_networks

cellular_api_configure_networks cellular_driver_api::configure_networks

OPT Configure cellular networks for the device.

◆ get_modem_info

cellular_api_get_modem_info cellular_driver_api::get_modem_info

OPT Get modem info for the device.

◆ get_registration_status

cellular_api_get_registration_status cellular_driver_api::get_registration_status

OPT Get network registration status for the device.

◆ get_signal

cellular_api_get_signal cellular_driver_api::get_signal

OPT Get signal for the device.

◆ get_stats

cellular_api_get_stats cellular_driver_api::get_stats

OPT Read operational statistics from the cellular device.

◆ get_supported_networks

cellular_api_get_supported_networks cellular_driver_api::get_supported_networks

OPT Get supported cellular networks for the device.

◆ set_apn

cellular_api_set_apn cellular_driver_api::set_apn

OPT Set the APN used for PDP context.

◆ set_callback

cellular_api_set_callback cellular_driver_api::set_callback

OPT Subscribe to asynchronous cellular events.

The documentation for this struct was generated from the following file:

zephyr/drivers/cellular.h

Data Fields