cellular_common.h

Go to the documentation of this file.

/*
 * FreeRTOS-Cellular-Interface v1.4.0
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * https://www.FreeRTOS.org
 * https://github.com/FreeRTOS
 */
 
#ifndef __CELLULAR_COMMON_H__
#define __CELLULAR_COMMON_H__
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* Standard includes. */
#include <stdbool.h>
 
/* Cellular includes. */
#ifndef CELLULAR_DO_NOT_USE_CUSTOM_CONFIG
    /* Include custom config file before other headers. */
    #include "cellular_config.h"
#endif
#include "cellular_config_defaults.h"
#include "cellular_platform.h"
#include "cellular_comm_interface.h"
#include "cellular_types.h"
#include "cellular_at_core.h"
 
/*-----------------------------------------------------------*/
 
typedef struct CellularAtReq
{
    const char * pAtCmd;                                      
    CellularATCommandType_t atCmdType;                        
    const char * pAtRspPrefix;                                
    CellularATCommandResponseReceivedCallback_t respCallback; 
    void * pData;                                             
    uint16_t dataLen;                                         
} CellularAtReq_t;
 
typedef struct CellularAtDataReq
{
    const uint8_t * pData;       
    uint32_t dataLen;            
    uint32_t * pSentDataLength;  
    const uint8_t * pEndPattern; 
    uint32_t endPatternLen;      
} CellularAtDataReq_t;
 
typedef void ( * CellularAtParseTokenHandler_t )( CellularContext_t * pContext,
                                                  char * pInputStr );
 
typedef struct CellularAtParseTokenMap
{
    const char * pStrValue;                   
    CellularAtParseTokenHandler_t parserFunc; 
} CellularAtParseTokenMap_t;
 
typedef enum CellularSocketState
{
    SOCKETSTATE_ALLOCATED = 0, 
    SOCKETSTATE_CONNECTING,    
    SOCKETSTATE_CONNECTED,     
    SOCKETSTATE_DISCONNECTED   
} CellularSocketState_t;
 
typedef struct CellularSocketContext
{
    uint8_t contextId;                       
    uint32_t socketId;                       
    CellularSocketState_t socketState;       
    CellularSocketType_t socketType;         
    CellularSocketDomain_t socketDomain;     
    CellularSocketProtocol_t socketProtocol; 
    CellularIPAddress_t localIpAddress;      
    uint16_t localPort;                      
    CellularSocketAccessMode_t dataMode;     
    /* Set using socket options. */
    uint32_t sendTimeoutMs; 
    uint32_t recvTimeoutMs; 
    /* Set during socket connect. */
    CellularSocketAddress_t remoteSocketAddress; 
    /* Callback functions. */
    CellularSocketDataReadyCallback_t dataReadyCallback; 
    void * pDataReadyCallbackContext;                    
    CellularSocketOpenCallback_t openCallback;           
    void * pOpenCallbackContext;                         
    CellularSocketClosedCallback_t closedCallback;       
    void * pClosedCallbackContext;                       
    /* Modem data. */
    void * pModemData; 
} CellularSocketContext_t;
 
typedef struct CellularTokenTable
{
    /* URC handler mapping table. */
    CellularAtParseTokenMap_t * pCellularUrcHandlerTable; 
    uint32_t cellularPrefixToParserMapSize;               
    /* Table to decide AT command respone status. */
    const char ** pCellularSrcTokenErrorTable;   
    uint32_t cellularSrcTokenErrorTableSize;     
    const char ** pCellularSrcTokenSuccessTable; 
    uint32_t cellularSrcTokenSuccessTableSize;   
    /* Table to URC with prefix Token. */
    const char ** pCellularUrcTokenWoPrefixTable; 
    uint32_t cellularUrcTokenWoPrefixTableSize;   
    /* Extra success token for specific AT command. */
    const char ** pCellularSrcExtraTokenSuccessTable; 
    uint32_t cellularSrcExtraTokenSuccessTableSize;   
} CellularTokenTable_t;
 
typedef CellularPktStatus_t ( * CellularATCommandDataPrefixCallback_t ) ( void * pCallbackContext,
                                                                          char * pLine,
                                                                          uint32_t lineLength,
                                                                          char ** pDataStart,
                                                                          uint32_t * pDataLength );
 
typedef CellularPktStatus_t ( * CellularATCommandDataSendPrefixCallback_t ) ( void * pCallbackContext,
                                                                              char * pLine,
                                                                              uint32_t * pBytesRead );
 
typedef CellularPktStatus_t ( * CellularUndefinedRespCallback_t )( void * pCallbackContext,
                                                                   const char * pLine );
 
typedef CellularPktStatus_t ( * CellularInputBufferCallback_t ) ( void * pInputBufferCallbackContext,
                                                                  char * pBuffer,
                                                                  uint32_t bufferLength,
                                                                  uint32_t * pBufferLengthHandled );
 
/*-----------------------------------------------------------*/
 
CellularError_t _Cellular_LibInit( CellularHandle_t * pCellularHandle,
                                   const CellularCommInterface_t * pCommInterface,
                                   const CellularTokenTable_t * pTokenTable );
 
CellularError_t _Cellular_LibCleanup( CellularHandle_t cellularHandle );
 
void _Cellular_NetworkRegistrationCallback( const CellularContext_t * pContext,
                                            CellularUrcEvent_t urcEvent,
                                            const CellularServiceStatus_t * pServiceStatus );
 
void _Cellular_PdnEventCallback( const CellularContext_t * pContext,
                                 CellularUrcEvent_t urcEvent,
                                 uint8_t contextId );
 
void _Cellular_SignalStrengthChangedCallback( const CellularContext_t * pContext,
                                              CellularUrcEvent_t urcEvent,
                                              const CellularSignalInfo_t * pSignalInfo );
 
void _Cellular_GenericCallback( const CellularContext_t * pContext,
                                const char * pRawData );
 
void _Cellular_ModemEventCallback( const CellularContext_t * pContext,
                                   CellularModemEvent_t modemEvent );
 
CellularError_t _Cellular_CheckLibraryStatus( CellularContext_t * pContext );
 
CellularError_t _Cellular_TranslatePktStatus( CellularPktStatus_t status );
 
CellularPktStatus_t _Cellular_TranslateAtCoreStatus( CellularATError_t status );
 
CellularError_t _Cellular_CreateSocketData( CellularContext_t * pContext,
                                            uint8_t contextId,
                                            CellularSocketDomain_t socketDomain,
                                            CellularSocketType_t socketType,
                                            CellularSocketProtocol_t socketProtocol,
                                            CellularSocketHandle_t * pSocketHandle );
 
CellularError_t _Cellular_RemoveSocketData( CellularContext_t * pContext,
                                            CellularSocketHandle_t socketHandle );
 
CellularError_t _Cellular_IsValidSocket( const CellularContext_t * pContext,
                                         uint32_t sockIndex );
 
CellularSocketContext_t * _Cellular_GetSocketData( const CellularContext_t * pContext,
                                                   uint32_t sockIndex );
 
CellularError_t _Cellular_IsValidPdn( uint8_t contextId );
 
CellularError_t _Cellular_ConvertCsqSignalRssi( int16_t csqRssi,
                                                int16_t * pRssiValue );
 
CellularError_t _Cellular_ConvertCsqSignalBer( int16_t csqBer,
                                               int16_t * pBerValue );
 
CellularError_t _Cellular_GetModuleContext( const CellularContext_t * pContext,
                                            void ** ppModuleContext );
 
CellularError_t _Cellular_ComputeSignalBars( CellularRat_t rat,
                                             CellularSignalInfo_t * pSignalInfo );
 
CellularError_t _Cellular_GetCurrentRat( CellularContext_t * pContext,
                                         CellularRat_t * pRat );
 
CellularPktStatus_t _Cellular_AtcmdRequestWithCallback( CellularContext_t * pContext,
                                                        CellularAtReq_t atReq );
 
CellularPktStatus_t _Cellular_TimeoutAtcmdRequestWithCallback( CellularContext_t * pContext,
                                                               CellularAtReq_t atReq,
                                                               uint32_t timeoutMS );
 
CellularPktStatus_t _Cellular_AtcmdRequestSuccessToken( CellularContext_t * pContext,
                                                        CellularAtReq_t atReq,
                                                        uint32_t atTimeoutMS,
                                                        const char ** pCellularSrcTokenSuccessTable,
                                                        uint32_t cellularSrcTokenSuccessTableSize );
 
CellularPktStatus_t _Cellular_TimeoutAtcmdDataRecvRequestWithCallback( CellularContext_t * pContext,
                                                                       CellularAtReq_t atReq,
                                                                       uint32_t timeoutMS,
                                                                       CellularATCommandDataPrefixCallback_t pktDataPrefixCallback,
                                                                       void * pCallbackContext );
 
CellularPktStatus_t _Cellular_TimeoutAtcmdDataSendRequestWithCallback( CellularContext_t * pContext,
                                                                       CellularAtReq_t atReq,
                                                                       CellularAtDataReq_t dataReq,
                                                                       uint32_t atTimeoutMS,
                                                                       uint32_t dataTimeoutMS );
 
CellularPktStatus_t _Cellular_AtcmdDataSend( CellularContext_t * pContext,
                                             CellularAtReq_t atReq,
                                             CellularAtDataReq_t dataReq,
                                             CellularATCommandDataSendPrefixCallback_t pktDataSendPrefixCallback,
                                             void * pCallbackContext,
                                             uint32_t atTimeoutMS,
                                             uint32_t dataTimeoutMS,
                                             uint32_t interDelayMS );
 
CellularPktStatus_t _Cellular_TimeoutAtcmdDataSendSuccessToken( CellularContext_t * pContext,
                                                                CellularAtReq_t atReq,
                                                                CellularAtDataReq_t dataReq,
                                                                uint32_t atTimeoutMS,
                                                                uint32_t dataTimeoutMS,
                                                                const char ** pCellularSrcTokenSuccessTable,
                                                                uint32_t cellularSrcTokenSuccessTableSize );
 
CellularError_t _Cellular_RegisterUndefinedRespCallback( CellularContext_t * pContext,
                                                         CellularUndefinedRespCallback_t undefinedRespCallback,
                                                         void * pCallbackContext );
 
CellularError_t _Cellular_RegisterInputBufferCallback( CellularContext_t * pContext,
                                                       CellularInputBufferCallback_t inputBufferCallback,
                                                       void * pInputBufferCallbackContext );
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* __CELLULAR_COMMON_H__ */