cellular_comm_interface.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_COMM_INTERFACE_H__
#define __CELLULAR_COMM_INTERFACE_H__
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
#include "cellular_types.h"
 
/* Standard includes. */
#include <stdint.h>
 
typedef enum CellularCommInterfaceError
{
    IOT_COMM_INTERFACE_SUCCESS = 0,   
    IOT_COMM_INTERFACE_FAILURE,       
    IOT_COMM_INTERFACE_BAD_PARAMETER, 
    IOT_COMM_INTERFACE_NO_MEMORY,     
    IOT_COMM_INTERFACE_TIMEOUT,       
    IOT_COMM_INTERFACE_DRIVER_ERROR,  
    IOT_COMM_INTERFACE_BUSY           
} CellularCommInterfaceError_t;
 
struct CellularCommInterfaceContext;
 
typedef struct CellularCommInterfaceContext * CellularCommInterfaceHandle_t;
 
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceReceiveCallback_t )( void * pUserData,
                                                                                   CellularCommInterfaceHandle_t commInterfaceHandle );
 
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceOpen_t )( CellularCommInterfaceReceiveCallback_t receiveCallback,
                                                                        void * pUserData,
                                                                        CellularCommInterfaceHandle_t * pCommInterfaceHandle );
 
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceSend_t )( CellularCommInterfaceHandle_t commInterfaceHandle,
                                                                        const uint8_t * pData,
                                                                        uint32_t dataLength,
                                                                        uint32_t timeoutMilliseconds,
                                                                        uint32_t * pDataSentLength );
 
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceRecv_t )( CellularCommInterfaceHandle_t commInterfaceHandle,
                                                                        uint8_t * pBuffer,
                                                                        uint32_t bufferLength,
                                                                        uint32_t timeoutMilliseconds,
                                                                        uint32_t * pDataReceivedLength );
 
typedef CellularCommInterfaceError_t ( * CellularCommInterfaceClose_t )( CellularCommInterfaceHandle_t commInterfaceHandle );
 
typedef struct CellularCommInterface
{
    CellularCommInterfaceOpen_t open;   
    CellularCommInterfaceSend_t send;   
    CellularCommInterfaceRecv_t recv;   
    CellularCommInterfaceClose_t close; 
} CellularCommInterface_t;
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* __CELLULAR_COMM_INTERFACE_H__ */