cellular_common_internal.h

/*
 * 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_INTERNAL_H__
#define __CELLULAR_COMMON_INTERNAL_H__
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* Cellular includes. */
 
#include "cellular_platform.h"
#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_pkthandler_internal.h"
#include "cellular_at_core.h"
#include "cellular_pktio_internal.h"
 
/*-----------------------------------------------------------*/
 
#define PKTIO_READ_BUFFER_SIZE     ( CELLULAR_CONFIG_PKTIO_READ_BUFFER_SIZE )
#define PKTIO_WRITE_BUFFER_SIZE    ( CELLULAR_AT_CMD_MAX_SIZE )
 
/*-----------------------------------------------------------*/
 
typedef enum CellularNetworkRegType
{
    CELLULAR_REG_TYPE_CREG = 0, 
    CELLULAR_REG_TYPE_CGREG,    
    CELLULAR_REG_TYPE_CEREG,    
    CELLULAR_REG_TYPE_MAX,      
    CELLULAR_REG_TYPE_UNKNOWN   
} CellularNetworkRegType_t;
 
typedef struct _callbackEvents
{
    CellularUrcNetworkRegistrationCallback_t networkRegistrationCallback;     
    void * pNetworkRegistrationCallbackContext;                               
    CellularUrcPdnEventCallback_t pdnEventCallback;                           
    void * pPdnEventCallbackContext;                                          
    CellularUrcSignalStrengthChangedCallback_t signalStrengthChangedCallback; 
    void * pSignalStrengthChangedCallbackContext;                             
    CellularUrcGenericCallback_t genericCallback;                             
    void * pGenericCallbackContext;                                           
    CellularModemEventCallback_t modemEventCallback;                          
    void * pModemEventCallbackContext;                                        
} _callbackEvents_t;
 
typedef struct cellularAtData
{
    CellularRat_t rat;                               
    CellularNetworkRegistrationStatus_t csRegStatus; 
    CellularNetworkRegistrationStatus_t psRegStatus; 
    uint8_t csRejectType;                            
    uint8_t csRejCause;                              
    uint8_t psRejectType;                            
    uint8_t psRejCause;                              
    uint32_t cellId;                                 
    uint16_t lac;                                    
    uint16_t rac;                                    
    uint16_t tac;                                    
} cellularAtData_t;
 
struct CellularContext
{
    const CellularCommInterface_t * pCommIntf; 
    /* Common library. */
    bool bLibOpened;                 
    bool bLibShutdown;               
    bool bLibClosing;                
    PlatformMutex_t libStatusMutex;  
    PlatformMutex_t libAtDataMutex;  
    _callbackEvents_t cbEvents;      
    cellularAtData_t libAtData;      
    CellularTokenTable_t tokenTable; 
    /* Packet handler. */
    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;                                      
    /* Packet IO. */
    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;                          
    /* PktIo data handling. */
    uint32_t dataLength;                                              
    uint32_t partialDataRcvdLen;                                      
    CellularSocketContext_t * pSocketData[ CELLULAR_NUM_SOCKET_MAX ]; 
    void * pModuleContext;                                            
};
 
/*-----------------------------------------------------------*/
 
CellularPktStatus_t _Cellular_ParseRegStatus( CellularContext_t * pContext,
                                              char * pRegPayload,
                                              bool isUrc,
                                              CellularNetworkRegType_t regType );
 
void _Cellular_InitAtData( CellularContext_t * pContext,
                           uint32_t mode );
 
bool _Cellular_CreateAtDataMutex( CellularContext_t * pContext );
 
void _Cellular_DestroyAtDataMutex( CellularContext_t * pContext );
 
 
void _Cellular_LockAtDataMutex( CellularContext_t * pContext );
 
void _Cellular_UnlockAtDataMutex( CellularContext_t * pContext );
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef __CELLULAR_COMMON_INTERNAL_H__ */