30#ifndef __CELLULAR_COMMON_API_H__
31#define __CELLULAR_COMMON_API_H__
65 void * pCallbackContext );
73 void * pCallbackContext );
81 void * pCallbackContext );
89 void * pCallbackContext );
97 void * pCallbackContext );
104 const char * pATCommandPrefix,
105 const char * pATCommandPayload,
116 uint8_t pdnContextId,
130 const uint8_t * pOptionValue,
131 uint32_t optionValueLength );
140 void * pCallbackContext );
149 void * pCallbackContext );
158 void * pCallbackContext );
179 uint32_t bufferLength );
CellularError_t Cellular_CommonSetPdnConfig(CellularHandle_t cellularHandle, uint8_t contextId, const CellularPdnConfig_t *pPdnConfig)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetSe...
CellularError_t Cellular_CommonSocketRegisterClosedCallback(CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketClosedCallback_t closedCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Socke...
CellularError_t Cellular_CommonCleanup(CellularHandle_t cellularHandle)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Clean...
CellularError_t Cellular_CommonRegisterModemEventCallback(CellularHandle_t cellularHandle, CellularModemEventCallback_t modemEventCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Regis...
CellularError_t Cellular_CommonSetEidrxSettings(CellularHandle_t cellularHandle, const CellularEidrxSettings_t *pEidrxSettings)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_SetEi...
CellularError_t Cellular_CommonCreateSocket(CellularHandle_t cellularHandle, uint8_t pdnContextId, CellularSocketDomain_t socketDomain, CellularSocketType_t socketType, CellularSocketProtocol_t socketProtocol, CellularSocketHandle_t *pSocketHandle)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Creat...
CellularError_t Cellular_CommonRfOn(CellularHandle_t cellularHandle)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RfOn ...
CellularError_t Cellular_CommonGetPsmSettings(CellularHandle_t cellularHandle, CellularPsmSettings_t *pPsmSettings)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetSe...
CellularError_t Cellular_CommonRegisterUrcSignalStrengthChangedCallback(CellularHandle_t cellularHandle, CellularUrcSignalStrengthChangedCallback_t signalStrengthChangedCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Regis...
CellularError_t Cellular_CommonGetServiceStatus(CellularHandle_t cellularHandle, CellularServiceStatus_t *pServiceStatus)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetSe...
CellularPktStatus_t Cellular_CommonUrcProcessCereg(CellularContext_t *pContext, char *pInputLine)
3GPP URC AT+CEREG handler for FreeRTOS Cellular Library.
CellularError_t Cellular_CommonGetRegisteredNetwork(CellularHandle_t cellularHandle, CellularPlmnInfo_t *pNetworkInfo)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetRe...
CellularError_t Cellular_CommonATCommandRaw(CellularHandle_t cellularHandle, const char *pATCommandPrefix, const char *pATCommandPayload, CellularATCommandType_t atCommandType, CellularATCommandResponseReceivedCallback_t responseReceivedCallback, void *pData, uint16_t dataLen)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_ATCom...
CellularError_t Cellular_CommonRfOff(CellularHandle_t cellularHandle)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_RfOff...
CellularPktStatus_t Cellular_CommonUrcProcessCreg(CellularContext_t *pContext, char *pInputLine)
3GPP URC AT+CREG handler for FreeRTOS Cellular Library.
CellularError_t Cellular_CommonGetEidrxSettings(CellularHandle_t cellularHandle, CellularEidrxSettingsList_t *pEidrxSettingsList)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetEi...
CellularError_t Cellular_CommonGetModemInfo(CellularHandle_t cellularHandle, CellularModemInfo_t *pModemInfo)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetMo...
CellularError_t Cellular_CommonRegisterUrcPdnEventCallback(CellularHandle_t cellularHandle, CellularUrcPdnEventCallback_t pdnEventCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Regis...
CellularPktStatus_t Cellular_CommonUrcProcessCgreg(CellularContext_t *pContext, char *pInputLine)
3GPP URC AT+CGREG handler for FreeRTOS Cellular Library.
CellularError_t Cellular_CommonGetIPAddress(CellularHandle_t cellularHandle, uint8_t contextId, char *pBuffer, uint32_t bufferLength)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetIP...
CellularError_t Cellular_CommonSocketRegisterDataReadyCallback(CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketDataReadyCallback_t dataReadyCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Socke...
CellularError_t Cellular_CommonSocketRegisterSocketOpenCallback(CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketOpenCallback_t socketOpenCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Socke...
CellularError_t Cellular_CommonInit(CellularHandle_t *pCellularHandle, const CellularCommInterface_t *pCommInterface, const CellularTokenTable_t *pTokenTable)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Init ...
CellularError_t Cellular_CommonGetSimCardInfo(CellularHandle_t cellularHandle, CellularSimCardInfo_t *pSimCardInfo)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetSe...
CellularError_t Cellular_CommonGetNetworkTime(CellularHandle_t cellularHandle, CellularTime_t *pNetworkTime)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetNe...
CellularError_t Cellular_CommonSetPsmSettings(CellularHandle_t cellularHandle, const CellularPsmSettings_t *pPsmSettings)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_GetSe...
CellularError_t Cellular_CommonRegisterUrcNetworkRegistrationEventCallback(CellularHandle_t cellularHandle, CellularUrcNetworkRegistrationCallback_t networkRegistrationCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Regis...
CellularError_t Cellular_CommonSocketSetSockOpt(CellularHandle_t cellularHandle, CellularSocketHandle_t socketHandle, CellularSocketOptionLevel_t optionLevel, CellularSocketOption_t option, const uint8_t *pOptionValue, uint32_t optionValueLength)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Socke...
CellularError_t Cellular_CommonRegisterUrcGenericCallback(CellularHandle_t cellularHandle, CellularUrcGenericCallback_t genericCallback, void *pCallbackContext)
This function is the common implementation of FreeRTOS Cellular Library API. Reference Cellular_Regis...
CellularError_t Cellular_CommonGetSimCardLockStatus(CellularHandle_t cellularHandle, CellularSimCardStatus_t *pSimCardStatus)
Get SIM card lock status.
CellularPktStatus_t
packet Status Names.
Definition: cellular_types.h:336
CellularATCommandType_t
Represents AT Command type.
Definition: cellular_types.h:358
CellularSocketType_t
Represents socket type.
Definition: cellular_types.h:271
CellularSocketOption_t
Socket option names.
Definition: cellular_types.h:323
CellularSocketOptionLevel_t
Represents socket option level.
Definition: cellular_types.h:313
CellularError_t
Status code returns from APIs.
Definition: cellular_types.h:86
CellularSocketDomain_t
Represents socket domain.
Definition: cellular_types.h:261
CellularSocketProtocol_t
Represents socket protocol.
Definition: cellular_types.h:281
void(* CellularModemEventCallback_t)(CellularModemEvent_t modemEvent, void *pCallbackContext)
Callback used to inform about modem events.
Definition: cellular_types.h:785
void(* CellularUrcSignalStrengthChangedCallback_t)(CellularUrcEvent_t urcEvent, const CellularSignalInfo_t *pSignalInfo, void *pCallbackContext)
Callback used to inform about signal strength changed URC event.
Definition: cellular_types.h:762
void(* CellularSocketClosedCallback_t)(CellularSocketHandle_t socketHandle, void *pCallbackContext)
Callback used to inform that remote end closed the connection for a connected socket.
Definition: cellular_types.h:822
void(* CellularUrcPdnEventCallback_t)(CellularUrcEvent_t urcEvent, uint8_t contextId, void *pCallbackContext)
Callback used to inform about PDN URC events.
Definition: cellular_types.h:749
void(* CellularUrcNetworkRegistrationCallback_t)(CellularUrcEvent_t urcEvent, const CellularServiceStatus_t *pServiceStatus, void *pCallbackContext)
Callback used to inform about a Network Registration URC event.
Definition: cellular_types.h:736
void(* CellularSocketDataReadyCallback_t)(CellularSocketHandle_t socketHandle, void *pCallbackContext)
Callback used to inform that data is ready for reading on a socket.
Definition: cellular_types.h:809
void(* CellularSocketOpenCallback_t)(CellularUrcEvent_t urcEvent, CellularSocketHandle_t socketHandle, void *pCallbackContext)
Callback used to inform about the status of socket open.
Definition: cellular_types.h:797
CellularPktStatus_t(* CellularATCommandResponseReceivedCallback_t)(CellularHandle_t cellularHandle, const CellularATCommandResponse_t *pAtResp, void *pData, uint16_t dataLen)
Callback used to inform about the response of an AT command sent using Cellular_ATCommandRaw API.
Definition: cellular_types.h:722
void(* CellularUrcGenericCallback_t)(const char *pRawData, void *pCallbackContext)
Generic callback used to inform all other URC events.
Definition: cellular_types.h:774
struct CellularSocketContext * CellularSocketHandle_t
Opaque socket handle.
Definition: cellular_types.h:79
struct CellularContext CellularContext_t
Opaque Cellular context structure type.
Definition: cellular_types.h:65
struct CellularContext * CellularHandle_t
Opaque Cellular handle.
Definition: cellular_types.h:71
Represents the functions of a comm interface.
Definition: cellular_comm_interface.h:158
Represents e-I-DRX settings.
Definition: cellular_types.h:568
Cellular Represents e-I-DRX settings Lists.
Definition: cellular_types.h:659
Modem information.
Definition: cellular_types.h:404
Represents a PDN config.
Definition: cellular_types.h:679
Public Land Mobile Network (PLMN) information.
Definition: cellular_types.h:383
Represents PSM settings.
Definition: cellular_types.h:489
Represents network service status.
Definition: cellular_types.h:450
SIM Card information.
Definition: cellular_types.h:393
SIM Card status.
Definition: cellular_types.h:373
Represents time.
Definition: cellular_types.h:418
Parameters to setup pktio and pkthandler token tables.
Definition: cellular_common.h:156