SF CELLULAR Framework Interface

RTOS-integrated SF CELUULAR Framework Interface. More...

Data Structures
struct	sf_cellular_provisioning_t
struct	sf_cellular_cmd_resp_t
struct	sf_cellular_ctrl_t
struct	sf_cellular_stats_t
struct	sf_cellular_info_t
struct	sf_cellular_network_status_t
struct	sf_cellular_command_parameters_info_t
struct	sf_cellular_callback_args_t
struct	sf_cellular_op_t
struct	sf_cellular_at_cmd_set_t
struct	sf_cellular_sim_pin_info_t
struct	sf_cellular_cfg_t
struct	sf_cellular_api_t
struct	sf_cellular_instance_t

Macros
#define	SF_CELLULAR_API_VERSION_MAJOR   (2U)
#define	SF_CELLULAR_API_VERSION_MINOR   (0U)
#define	SF_CELLULAR_ACESS_TECH_NAME_LEN   (64U)
	Maximum length for Access Technology name.
#define	SF_CELLULAR_MAX_OPERATOR_NAME_LEN   (32U)
	Maximum length for Operator name.
#define	SF_CELLULAR_MAX_PREFFERED_OPERATOR_COUNT   (5U)
	Maximum number of preferred operator.
#define	SF_CELLULAR_IMEI_LEN   (32U)
	Maximum length of IMEI number.
#define	SF_CELLULAR_FWVERSION_LEN   (32U)
	Maximum length of Firmware Version.
#define	SF_CELLULAR_MAX_STRING_LEN   (32U)
	Maximum string length.
#define	SF_CELLULAR_CHIPSET_LEN   (16U)
	Maximum length of Chipset info.
#define	SF_CELLULAR_MFG_NAME_LEN   (16U)
	Maximum length of manufacturer.
#define	SF_CELLULAR_CID_LEN   (16U)
	Maximum length of CID.
#define	SF_CELLULAR_IMSI_LEN   (24U)
	Maximum length of IMSI.
#define	SF_CELLULAR_IP_ADDR_LEN   (128U)
	Maximum lenfth of IP address.
#define	SF_CELLULAR_TRUE   (1U)
#define	SF_CELLULAR_FALSE   (0U)

Enumerations
enum	sf_cellular_op_select_mode_t { SF_CELLULAR_OP_SELECT_MODE_AUTO = 0, SF_CELLULAR_OP_SELECT_MODE_MANUAL = 1, SF_CELLULAR_OP_SELECT_MODE_DEREGISTER = 2, SF_CELLULAR_OP_SELECT_MODE_MANUAL_FALLBACK = 4 }
enum	sf_cellular_network_reg_status_t {   SF_CELLULAR_NETWORK_REG_STATUS_NOT_REGISTERED_NO_SEARCH = 0, SF_CELLULAR_NETWORK_REG_STATUS_REGISTERED_HOME_NETWORK = 1, SF_CELLULAR_NETWORK_REG_STATUS_NOT_REGISTERED_SEARCHING = 2, SF_CELLULAR_NETWORK_REG_STATUS_REGISTRATION_DENIED = 3,   SF_CELLULAR_NETWORK_REG_STATUS_UNKNOWN = 4, SF_CELLULAR_NETWORK_REG_STATUS_REGISTERED_ROAMING = 5 }
enum	sf_cellular_timezone_update_mode_t { SF_CELLULAR_TIMEZONE_UPDATE_AUTO_DISABLE, SF_CELLULAR_TIMEZONE_UPDATE_AUTO_ENABLE }
enum	sf_cellular_event_t { SF_CELLULAR_EVENT_RX, SF_CELLULAR_EVENT_PROVISIONSET }
enum	sf_cellular_reset_type_t { SF_CELLULAR_RESET_TYPE_SOFT, SF_CELLULAR_RESET_TYPE_HARD }
enum	sf_cellular_airplane_mode_t { SF_CELLULAR_AIRPLANE_MODE_OFF, SF_CELLULAR_AIRPLANE_MODE_ON }
enum	sf_cellular_pdp_type_t { SF_CELLULAR_PDP_TYPE_IP, SF_CELLULAR_PDP_TYPE_PPP, SF_CELLULAR_PDP_TYPE_IPV6, SF_CELLULAR_PDP_TYPE_IPV4V6 }
enum	sf_cellular_op_name_format_t { SF_CELLULAR_OP_NAME_FORMAT_LONG, SF_CELLULAR_OP_NAME_FORMAT_SHORT, SF_CELLULAR_OP_NAME_FORMAT_NUMERIC }
enum	sf_cellular_auth_type_t { SF_CELLULAR_AUTH_TYPE_NONE, SF_CELLULAR_AUTH_TYPE_PAP, SF_CELLULAR_AUTH_TYPE_CHAP }
enum	sf_cellular_at_cmd_index_t {   SF_CELLULAR_AT_CMD_INDEX_AT = 0, SF_CELLULAR_AT_CMD_INDEX_ATZ0, SF_CELLULAR_AT_CMD_INDEX_AT_CREG_SET_0, SF_CELLULAR_AT_CMD_INDEX_AT_CMEE_SET_0,   SF_CELLULAR_AT_CMD_INDEX_AT_ECHO, SF_CELLULAR_AT_CMD_INDEX_AT_SAVE, SF_CELLULAR_AT_CMD_INDEX_AT_ENTER_CPIN, SF_CELLULAR_AT_CMD_INDEX_AT_CPIN_SET,   SF_CELLULAR_AT_CMD_INDEX_AT_CGDCONT_SET, SF_CELLULAR_AT_CMD_INDEX_AT_CPOL_SET, SF_CELLULAR_AT_CMD_INDEX_AT_COPS_GET, SF_CELLULAR_AT_CMD_INDEX_AT_AIRPLANE_OFF,   SF_CELLULAR_AT_CMD_INDEX_AT_AIRPLANE_ON, SF_CELLULAR_AT_CMD_INDEX_AT_CONTEXT_ACTIVE, SF_CELLULAR_AT_CMD_INDEX_AT_CONTEXT_DEACTIVE, SF_CELLULAR_AT_CMD_INDEX_AT_CGDATA_ACTIVE,   SF_CELLULAR_AT_CMD_INDEX_AT_CGDATA_DEACTIVE, SF_CELLULAR_AT_CMD_INDEX_AT_CSQ_GET, SF_CELLULAR_AT_CMD_INDEX_AT_VER_GET, SF_CELLULAR_AT_CMD_INDEX_AT_CHIPSET_GET,   SF_CELLULAR_AT_CMD_INDEX_AT_IMEI_GET, SF_CELLULAR_AT_CMD_INDEX_AT_MANF_NAME_GET, SF_CELLULAR_AT_CMD_INDEX_AT_SIMID_GET, SF_CELLULAR_AT_CMD_INDEX_AT_NET_TYPE_STATUS_GET,   SF_CELLULAR_AT_CMD_INDEX_AT_NET_STATUS_GET, SF_CELLULAR_AT_CMD_INDEX_AT_DETACH, SF_CELLULAR_AT_CMD_INDEX_AT_LOCK_SIM, SF_CELLULAR_AT_CMD_INDEX_AT_UNLOCK_SIM,   SF_CELLULAR_AT_CMD_INDEX_AT_ENTER_DATA_MODE, SF_CELLULAR_AT_CMD_INDEX_AT_EXIT_DATA_MODE, SF_CELLULAR_AT_CMD_INDEX_AT_USERNAME_SET, SF_CELLULAR_AT_CMD_INDEX_AT_PASSWORD_SET,   SF_CELLULAR_AT_CMD_INDEX_AT_AUTH_TYPE_SET, SF_CELLULAR_AT_CMD_INDEX_AT_AUTO_TIME_UPDATE_ENABLE_SET, SF_CELLULAR_AT_CMD_INDEX_AT_AUTO_TIME_UPDATE_DISABLE_SET, SF_CELLULAR_AT_CMD_INDEX_AT_EMPTY_APN_SET,   SF_CELLULAR_AT_CMD_INDEX_AT_GET_IP_ADDR, SF_CELLULAR_AT_CMD_INDEX_AT_NWSCANSEQ_SET, SF_CELLULAR_AT_CMD_INDEX_AT_NWSCANMODE_SET, SF_CELLULAR_AT_CMD_INDEX_AT_IOTOPMODE_SET,   SF_CELLULAR_AT_CMD_INDEX_AT_SWITCH_BACK_TO_DATA_MODE, SF_CELLULAR_AT_CMD_INDEX_AT_GET_IMSI, SF_CELLULAR_AT_CMD_INDEX_AT_IPR_SET, SF_CELLULAR_AT_CMD_INDEX_AT_BAUD_CHECK,   SF_CELLULAR_AT_CMD_INDEX_AT_SIM_EFFECT_SET }
enum	sf_cellular_config_at_cmd_index_t {   SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CREG, SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CEREG, SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_COPS_AUTO_SET, SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_COPS_MANUAL_SET,   SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CPIN_STATUS_GET }
enum	sf_cellular_sim_status_t { SF_CELLULAR_SIM_STATUS_READY, SF_CELLULAR_SIM_STATUS_PIN_REQUIRED, SF_CELLULAR_SIM_STATUS_PIN_PUK_REQUIRED }
enum	sf_cellular_log_buffer_type_t { SF_CELLULAR_LOG_BUFFER_TYPE_COMMAND, SF_CELLULAR_LOG_BUFFER_TYPE_RESPONSE_RECEIVED, SF_CELLULAR_LOG_BUFFER_TYPE_RESPONSE_RECEIVED_WITH_TIMEOUT }

Detailed Description

RTOS-integrated SF CELUULAR Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF CELLULAR Framework.

Macro Definition Documentation

SF_CELLULAR_API_VERSION_MAJOR

#define SF_CELLULAR_API_VERSION_MAJOR   (2U)

Major Version of the API defined in this file

SF_CELLULAR_API_VERSION_MINOR

#define SF_CELLULAR_API_VERSION_MINOR   (0U)

Minor Version of the API defined in this file

SF_CELLULAR_FALSE

#define SF_CELLULAR_FALSE   (0U)

Logical Value FALSE for Cellular

SF_CELLULAR_TRUE

#define SF_CELLULAR_TRUE   (1U)

Logical Value TRUE for Cellular

Enumeration Type Documentation

sf_cellular_airplane_mode_t

enum sf_cellular_airplane_mode_t

Airplane mode

Enumerator
SF_CELLULAR_AIRPLANE_MODE_OFF	Airplane mode disabled.
SF_CELLULAR_AIRPLANE_MODE_ON	Airplane mode enabled.

sf_cellular_at_cmd_index_t

enum sf_cellular_at_cmd_index_t

Enumeration for AT command index

Enumerator
SF_CELLULAR_AT_CMD_INDEX_AT	Index for Command AT.
SF_CELLULAR_AT_CMD_INDEX_ATZ0	Index for Command ATZ0.
SF_CELLULAR_AT_CMD_INDEX_AT_CREG_SET_0	Index for Command to set AT+CREG.
SF_CELLULAR_AT_CMD_INDEX_AT_CMEE_SET_0	Index for Command to set AT+CMEE.
SF_CELLULAR_AT_CMD_INDEX_AT_ECHO	Index for Command ATE.
SF_CELLULAR_AT_CMD_INDEX_AT_SAVE	Index for Command AT&W.
SF_CELLULAR_AT_CMD_INDEX_AT_ENTER_CPIN	Index for Command to unlock SIM.
SF_CELLULAR_AT_CMD_INDEX_AT_CPIN_SET	Index for Command to set SIM PIN.
SF_CELLULAR_AT_CMD_INDEX_AT_CGDCONT_SET	Index for Command to set AT+CGDCOND.
SF_CELLULAR_AT_CMD_INDEX_AT_CPOL_SET	Index for Command to set AT+CPOL.
SF_CELLULAR_AT_CMD_INDEX_AT_COPS_GET	Index for Command to get current operator details.
SF_CELLULAR_AT_CMD_INDEX_AT_AIRPLANE_OFF	Index for Command to set Airplane mode OFF.
SF_CELLULAR_AT_CMD_INDEX_AT_AIRPLANE_ON	Index for Command to set Airplane mode ON.
SF_CELLULAR_AT_CMD_INDEX_AT_CONTEXT_ACTIVE	Index for Command to activate context.
SF_CELLULAR_AT_CMD_INDEX_AT_CONTEXT_DEACTIVE	Index for Command to deactivate context.
SF_CELLULAR_AT_CMD_INDEX_AT_CGDATA_ACTIVE	Index for Command to activate Data mode.
SF_CELLULAR_AT_CMD_INDEX_AT_CGDATA_DEACTIVE	Index for Command to deactivate Data mode.
SF_CELLULAR_AT_CMD_INDEX_AT_CSQ_GET	Index for Command to get signal quality.
SF_CELLULAR_AT_CMD_INDEX_AT_VER_GET	Index for Command to get Modem stack Version.
SF_CELLULAR_AT_CMD_INDEX_AT_CHIPSET_GET	Index for Command to get chipset details.
SF_CELLULAR_AT_CMD_INDEX_AT_IMEI_GET	Index for Command to get IMEI number.
SF_CELLULAR_AT_CMD_INDEX_AT_MANF_NAME_GET	Index for Command to get manufacturer name.
SF_CELLULAR_AT_CMD_INDEX_AT_SIMID_GET	Index for Command to get SIM Card ID.
SF_CELLULAR_AT_CMD_INDEX_AT_NET_TYPE_STATUS_GET	Index for Command to get network type information.
SF_CELLULAR_AT_CMD_INDEX_AT_NET_STATUS_GET	Index for Command to get network status information.
SF_CELLULAR_AT_CMD_INDEX_AT_DETACH	Index for Command to detach the MT.
SF_CELLULAR_AT_CMD_INDEX_AT_LOCK_SIM	Index for Command to lock SIM card.
SF_CELLULAR_AT_CMD_INDEX_AT_UNLOCK_SIM	Index for Command to unlock SIM card.
SF_CELLULAR_AT_CMD_INDEX_AT_ENTER_DATA_MODE	Index for Command to enter data mode.
SF_CELLULAR_AT_CMD_INDEX_AT_EXIT_DATA_MODE	Index for Command to exit data mode.
SF_CELLULAR_AT_CMD_INDEX_AT_USERNAME_SET	Index for Command to set username.
SF_CELLULAR_AT_CMD_INDEX_AT_PASSWORD_SET	Index for Command to set password.
SF_CELLULAR_AT_CMD_INDEX_AT_AUTH_TYPE_SET	Index for Command to set authorisation type.
SF_CELLULAR_AT_CMD_INDEX_AT_AUTO_TIME_UPDATE_ENABLE_SET	Index for Command to enable auto time update.
SF_CELLULAR_AT_CMD_INDEX_AT_AUTO_TIME_UPDATE_DISABLE_SET	Index for Command to disable auto time update.
SF_CELLULAR_AT_CMD_INDEX_AT_EMPTY_APN_SET	Index for Command to set empty APN.
SF_CELLULAR_AT_CMD_INDEX_AT_GET_IP_ADDR	Index for Command to get IP address.
SF_CELLULAR_AT_CMD_INDEX_AT_NWSCANSEQ_SET	Index for Command to set network fallback sequence.
SF_CELLULAR_AT_CMD_INDEX_AT_NWSCANMODE_SET	Index for Command to set network scan mode.
SF_CELLULAR_AT_CMD_INDEX_AT_IOTOPMODE_SET	Index for Command to Configure Network Category to be Searched under LTE.
SF_CELLULAR_AT_CMD_INDEX_AT_SWITCH_BACK_TO_DATA_MODE	Index for Command to switch back to Data mode.
SF_CELLULAR_AT_CMD_INDEX_AT_GET_IMSI	Index for Command to get IMSI ID.
SF_CELLULAR_AT_CMD_INDEX_AT_IPR_SET	Index for Command to set baud rate of modem.
SF_CELLULAR_AT_CMD_INDEX_AT_BAUD_CHECK	Index for Command to check whether modem is responding after baud update.
SF_CELLULAR_AT_CMD_INDEX_AT_SIM_EFFECT_SET	Index for Command to set SIM priority effect.

sf_cellular_auth_type_t

enum sf_cellular_auth_type_t

Cellular authentication type

Enumerator
SF_CELLULAR_AUTH_TYPE_NONE	No authentication.
SF_CELLULAR_AUTH_TYPE_PAP	PAP.
SF_CELLULAR_AUTH_TYPE_CHAP	CHAP.

sf_cellular_config_at_cmd_index_t

enum sf_cellular_config_at_cmd_index_t

Enumeration for configurable AT command index

Enumerator
SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CREG	Index for Command AT+CREG.
SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CEREG	Index for Command AT+CEREG.
SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_COPS_AUTO_SET	Index for Command to set AUTO AT+COPS.
SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_COPS_MANUAL_SET	Index for Command to set Manual AT+COPS.
SF_CELLULAR_CONFIG_AT_CMD_INDEX_AT_CPIN_STATUS_GET	Index for Command to get status of SIM lock.

sf_cellular_event_t

enum sf_cellular_event_t

Cellular Framework event codes

Enumerator
SF_CELLULAR_EVENT_RX	Packet received event.
SF_CELLULAR_EVENT_PROVISIONSET	Provisioning Set event.

sf_cellular_log_buffer_type_t

enum sf_cellular_log_buffer_type_t

Command Buffer type specifies the type of data in debug log buffer

Enumerator
SF_CELLULAR_LOG_BUFFER_TYPE_COMMAND	Data in logging buffer is an AT command.
SF_CELLULAR_LOG_BUFFER_TYPE_RESPONSE_RECEIVED	Data in logging buffer is complete response received from modem.
SF_CELLULAR_LOG_BUFFER_TYPE_RESPONSE_RECEIVED_WITH_TIMEOUT	Data in logging buffer is response received from modem with timeout.

sf_cellular_network_reg_status_t

enum sf_cellular_network_reg_status_t

Cellular Network Registration Status

Enumerator
SF_CELLULAR_NETWORK_REG_STATUS_NOT_REGISTERED_NO_SEARCH	not registered, MT is not currently searching a new operator to register to
SF_CELLULAR_NETWORK_REG_STATUS_REGISTERED_HOME_NETWORK	registered, home network
SF_CELLULAR_NETWORK_REG_STATUS_NOT_REGISTERED_SEARCHING	not registered, but MT is currently searching a new operator to register to
SF_CELLULAR_NETWORK_REG_STATUS_REGISTRATION_DENIED	registration denied
SF_CELLULAR_NETWORK_REG_STATUS_UNKNOWN	registration status unknown
SF_CELLULAR_NETWORK_REG_STATUS_REGISTERED_ROAMING	Registered, roaming.

sf_cellular_op_name_format_t

enum sf_cellular_op_name_format_t

Cellular operator name format

Enumerator
SF_CELLULAR_OP_NAME_FORMAT_LONG	Long alphanumeric.
SF_CELLULAR_OP_NAME_FORMAT_SHORT	Short alphanumeric.
SF_CELLULAR_OP_NAME_FORMAT_NUMERIC	Numeric.

sf_cellular_op_select_mode_t

enum sf_cellular_op_select_mode_t

Operator selection mode

Enumerator
SF_CELLULAR_OP_SELECT_MODE_AUTO	Automatic Operator selection.
SF_CELLULAR_OP_SELECT_MODE_MANUAL	Manual Operator selection.
SF_CELLULAR_OP_SELECT_MODE_DEREGISTER	De-register from the network.
SF_CELLULAR_OP_SELECT_MODE_MANUAL_FALLBACK	Manual with fallback to automatic.

sf_cellular_pdp_type_t

enum sf_cellular_pdp_type_t

PDP type

Enumerator
SF_CELLULAR_PDP_TYPE_IP	Internet protocol.
SF_CELLULAR_PDP_TYPE_PPP	Point to point protocol.
SF_CELLULAR_PDP_TYPE_IPV6	Internet protocol, version 6.
SF_CELLULAR_PDP_TYPE_IPV4V6	Virtual introduced to handle dual stack UE capability.

sf_cellular_reset_type_t

enum sf_cellular_reset_type_t

Cellular Module reset type

Enumerator
SF_CELLULAR_RESET_TYPE_SOFT	Soft reset module using AT command.
SF_CELLULAR_RESET_TYPE_HARD	Hard reset module by toggling Reset Pin.

sf_cellular_sim_status_t

enum sf_cellular_sim_status_t

Enumeration for SIM lock status

Enumerator
SF_CELLULAR_SIM_STATUS_READY	SIM in Cellular modem is not pending for any password.
SF_CELLULAR_SIM_STATUS_PIN_REQUIRED	SIM in Cellular modem is lock and waiting for (U)SIM PIN to be given.
SF_CELLULAR_SIM_STATUS_PIN_PUK_REQUIRED	SIM in Cellular modem is lock and waiting for (U)SIM PIN and PUK to be given.

sf_cellular_timezone_update_mode_t

enum sf_cellular_timezone_update_mode_t

Timezone update mode

Enumerator
SF_CELLULAR_TIMEZONE_UPDATE_AUTO_DISABLE	Disable automatic time zone update.
SF_CELLULAR_TIMEZONE_UPDATE_AUTO_ENABLE	Enable automatic time zone update.