Parameters involved in maintaining the context for the modem. More...

#include <cellular_common_internal.h>

Data Fields
const CellularCommInterface_t *	pCommIntf

bool	bLibOpened

bool	bLibShutdown

bool	bLibClosing

PlatformMutex_t	libStatusMutex

PlatformMutex_t	libAtDataMutex

_callbackEvents_t	cbEvents

cellularAtData_t	libAtData

CellularTokenTable_t	tokenTable

PlatformMutex_t	pktRequestMutex

PlatformMutex_t	PktRespMutex

PlatformQueueHandle_t	pktRespQueue

CellularATCommandResponseReceivedCallback_t	pktRespCB

CellularATCommandDataPrefixCallback_t	pktDataPrefixCB

void *	pDataPrefixCBContext

CellularATCommandDataSendPrefixCallback_t	pktDataSendPrefixCB

void *	pDataSendPrefixCBContext

void *	pPktUsrData

uint16_t	PktUsrDataLen

const char *	pCurrentCmd

bool	bPktioUp

CellularCommInterfaceHandle_t	hPktioCommIntf

PlatformEventGroupHandle_t	pPktioCommEvent

_pPktioShutdownCallback_t	pPktioShutdownCB

_pPktioHandlePacketCallback_t	pPktioHandlepktCB

char	pktioSendBuf [PKTIO_WRITE_BUFFER_SIZE+1]

char	pktioReadBuf [PKTIO_READ_BUFFER_SIZE+1]

char *	pPktioReadPtr

const char *	pRespPrefix

char	pktRespPrefixBuf [CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH]

CellularATCommandType_t	PktioAtCmdType

_atRespType_t	recvdMsgType

CellularUndefinedRespCallback_t	undefinedRespCallback

void *	pUndefinedRespCBContext

CellularInputBufferCallback_t	inputBufferCallback

void *	pInputBufferCallbackContext

CellularATCommandResponse_t *	pAtCmdResp

uint32_t	dataLength

uint32_t	partialDataRcvdLen

CellularSocketContext_t *	pSocketData [CELLULAR_NUM_SOCKET_MAX]

void *	pModuleContext

Detailed Description

Parameters involved in maintaining the context for the modem.

Opaque Cellular handle.

Opaque Cellular context structure type.

Field Documentation

◆ pCommIntf

const CellularCommInterface_t* CellularHandle_t::pCommIntf

Communication interface for target specific.

◆ bLibOpened

bool CellularHandle_t::bLibOpened

CellularLib is currently open.

◆ bLibShutdown

bool CellularHandle_t::bLibShutdown

CellularLib prematurely shut down.

◆ bLibClosing

bool CellularHandle_t::bLibClosing

Graceful shutdown in progress.

◆ libStatusMutex

PlatformMutex_t CellularHandle_t::libStatusMutex

The mutex for changing lib status.

◆ libAtDataMutex

PlatformMutex_t CellularHandle_t::libAtDataMutex

The mutex for AT data in cellular context.

◆ cbEvents

_callbackEvents_t CellularHandle_t::cbEvents

Call back functions registered to report events.

◆ libAtData

cellularAtData_t CellularHandle_t::libAtData

Global variables.

◆ tokenTable

CellularTokenTable_t CellularHandle_t::tokenTable

Token table to config pkthandler and pktio.

◆ pktRequestMutex

PlatformMutex_t CellularHandle_t::pktRequestMutex

The mutex for sending request.

◆ PktRespMutex

PlatformMutex_t CellularHandle_t::PktRespMutex

The mutex for parsing the response from modem.

◆ pktRespQueue

PlatformQueueHandle_t CellularHandle_t::pktRespQueue

Message queue to send/receive response.

◆ pktRespCB

CellularATCommandResponseReceivedCallback_t CellularHandle_t::pktRespCB

Callback used to inform about the response of an AT command sent using Cellular_ATCommandRaw API.

◆ pktDataPrefixCB

CellularATCommandDataPrefixCallback_t CellularHandle_t::pktDataPrefixCB

Data prefix callback function for socket receive function.

◆ pDataPrefixCBContext

void* CellularHandle_t::pDataPrefixCBContext

The pCallbackContext passed to CellularATCommandDataPrefixCallback_t.

◆ pktDataSendPrefixCB

CellularATCommandDataSendPrefixCallback_t CellularHandle_t::pktDataSendPrefixCB

Data prefix callback function for socket send function.

◆ pDataSendPrefixCBContext

void* CellularHandle_t::pDataSendPrefixCBContext

The pCallbackContext passed to CellularATCommandDataSendPrefixCallback_t.

◆ pPktUsrData

void* CellularHandle_t::pPktUsrData

The pData passed to CellularATCommandResponseReceivedCallback_t.

◆ PktUsrDataLen

uint16_t CellularHandle_t::PktUsrDataLen

The dataLen passed to CellularATCommandResponseReceivedCallback_t.

◆ pCurrentCmd

const char* CellularHandle_t::pCurrentCmd

Debug purpose.

◆ bPktioUp

bool CellularHandle_t::bPktioUp

A flag to indicate if packet IO up.

◆ hPktioCommIntf

CellularCommInterfaceHandle_t CellularHandle_t::hPktioCommIntf

Opaque handle to comm interface.

◆ pPktioCommEvent

PlatformEventGroupHandle_t CellularHandle_t::pPktioCommEvent

Event group handler for common event in packet IO.

◆ pPktioShutdownCB

_pPktioShutdownCallback_t CellularHandle_t::pPktioShutdownCB

Callback used to inform packet IO thread shutdown.

◆ pPktioHandlepktCB

_pPktioHandlePacketCallback_t CellularHandle_t::pPktioHandlepktCB

Callback used to inform packet received.

◆ pktioSendBuf

char CellularHandle_t::pktioSendBuf[PKTIO_WRITE_BUFFER_SIZE+1]

Buffer to send AT command to cellular devices.

◆ pktioReadBuf

char CellularHandle_t::pktioReadBuf[PKTIO_READ_BUFFER_SIZE+1]

Buffer to receive messages from cellular devices.

◆ pPktioReadPtr

char* CellularHandle_t::pPktioReadPtr

Pointer points to unhandled read buffer.

◆ pRespPrefix

const char* CellularHandle_t::pRespPrefix

The prefix to check in the response message.

◆ pktRespPrefixBuf

char CellularHandle_t::pktRespPrefixBuf[CELLULAR_CONFIG_MAX_PREFIX_STRING_LENGTH]

Buffer to store prefix string.

◆ PktioAtCmdType

CellularATCommandType_t CellularHandle_t::PktioAtCmdType

Represents AT Command type.

◆ recvdMsgType

_atRespType_t CellularHandle_t::recvdMsgType

The received AT response type.

◆ undefinedRespCallback

CellularUndefinedRespCallback_t CellularHandle_t::undefinedRespCallback

Undefined response callback function.

◆ pUndefinedRespCBContext

void* CellularHandle_t::pUndefinedRespCBContext

The pCallbackContext passed to CellularUndefinedRespCallback_t.

◆ inputBufferCallback

CellularInputBufferCallback_t CellularHandle_t::inputBufferCallback

URC data preprocess callback function.

◆ pInputBufferCallbackContext

void* CellularHandle_t::pInputBufferCallbackContext

The callback context passed to inputBufferCallback.

◆ pAtCmdResp

CellularATCommandResponse_t* CellularHandle_t::pAtCmdResp

The AT command response pointer.

◆ dataLength

uint32_t CellularHandle_t::dataLength

The data length in pLine.

◆ partialDataRcvdLen

uint32_t CellularHandle_t::partialDataRcvdLen

The valid data length need to be handled.

◆ pSocketData

CellularSocketContext_t* CellularHandle_t::pSocketData[CELLULAR_NUM_SOCKET_MAX]

All socket related information.

◆ pModuleContext

void* CellularHandle_t::pModuleContext

Module Context.

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

cellular_common_internal.h

Data Fields