SF CELLULAR NSAL Framework Interface

RTOS-integrated SF CELLULAR NSAL Framework Interface. More...

Data Structures
struct	sf_cellular_nsal_cfg_t

Functions
ssp_err_t	sf_cellular_deinit (NX_IP_DRIVER *driver_req_ptr, sf_cellular_instance_t const *p_cellular_instance, sf_cellular_nsal_cfg_t *p_cellular_nsal_cfg)
	De-initialize the Cellular NSAL, deletes PPP interface, disconnect the network and close cellular framework. More...

Detailed Description

RTOS-integrated SF CELLULAR NSAL Framework Interface.

Summary

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

Function Documentation

sf_cellular_deinit()

ssp_err_t sf_cellular_deinit	(	NX_IP_DRIVER *	p_driver_req_ptr,
		sf_cellular_instance_t const *	p_cellular_instance,
		sf_cellular_nsal_cfg_t *	p_cellular_nsal_cfg
	)

De-initialize the Cellular NSAL, deletes PPP interface, disconnect the network and close cellular framework.

Function Prototypes

Parameters

[in]	p_driver_req_ptr	Pointer to NetX IP driver
[in]	p_cellular_instance	Pointer to Cellular Framework instance
[in]	p_cellular_nsal_cfg	Pointer to Cellular NSAL configuration structure

Return values

SSP_SUCCESS	Successfully de-initialized the cellular NSAL connection
SSP_ERR_CELLULAR_FAILED	Failed to de-init Cellular Framework or terminate the network connection
SSP_ERR_NOT_OPEN	Cellular driver is not opened
SSP_ERR_ASSERTION	Argument NULL is passed
SSP_ERR_IN_USE	Device already in use
SSP_ERR_CELLULAR_INVALID_STATE	Module in Data mode can't send AT command

Wait for the PPP Link down event, LCP Terminate ACK should have been received

Disconnect Network

Close Cellular Driver

Return an error to NetX.