ota_os_interface.h

Go to the documentation of this file.

/*
 * AWS IoT Over-the-air Update v2.0.0 (Release Candidate)
 * Copyright (C) 2020 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * 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.
 */
 
#ifndef OTA_OS_INTERFACE_H
#define OTA_OS_INTERFACE_H
 
 
struct OtaEventContext;
 
typedef struct OtaEventContext   OtaEventContext_t;
 
struct OtaTimerContext;
 
typedef struct OtaTimerContext   OtaTimerContext_t;
 
typedef enum
{
    OtaRequestTimer = 0,
    OtaSelfTestTimer,
    OtaNumOfTimers
} OtaTimerId_t;
 
typedef enum OtaOsStatus
{
    OtaOsSuccess = 0,                    
    OtaOsEventQueueCreateFailed = 0x80U, 
    OtaOsEventQueueSendFailed,           
    OtaOsEventQueueReceiveFailed,        
    OtaOsEventQueueDeleteFailed,         
    OtaOsTimerCreateFailed,              
    OtaOsTimerStartFailed,               
    OtaOsTimerRestartFailed,             
    OtaOsTimerStopFailed,                
    OtaOsTimerDeleteFailed               
} OtaOsStatus_t;
 
typedef OtaOsStatus_t ( * OtaInitEvent_t ) ( OtaEventContext_t * pEventCtx );
 
typedef OtaOsStatus_t ( * OtaSendEvent_t )( OtaEventContext_t * pEventCtx,
                                            const void * pEventMsg,
                                            unsigned int timeout );
 
typedef OtaOsStatus_t ( * OtaReceiveEvent_t )( OtaEventContext_t * pEventCtx,
                                               void * pEventMsg,
                                               uint32_t timeout );
 
typedef OtaOsStatus_t ( * OtaDeinitEvent_t )( OtaEventContext_t * pEventCtx );
 
typedef void ( * OtaTimerCallback_t )( OtaTimerId_t otaTimerId );
 
typedef OtaOsStatus_t ( * OtaStartTimer_t ) ( OtaTimerId_t otaTimerId,
                                              const char * const pTimerName,
                                              const uint32_t timeout,
                                              OtaTimerCallback_t callback );
 
typedef OtaOsStatus_t ( * OtaStopTimer_t ) ( OtaTimerId_t otaTimerId );
 
typedef OtaOsStatus_t ( * OtaDeleteTimer_t ) ( OtaTimerId_t otaTimerId );
 
typedef void * ( * OtaMalloc_t ) ( size_t size );
 
typedef void ( * OtaFree_t ) ( void * ptr );
 
typedef struct OtaEventInterface
{
    OtaInitEvent_t init;               
    OtaSendEvent_t send;               
    OtaReceiveEvent_t recv;            
    OtaDeinitEvent_t deinit;           
    OtaEventContext_t * pEventContext; 
} OtaEventInterface_t;
 
typedef struct OtaTimerInterface
{
    OtaStartTimer_t start;   
    OtaStopTimer_t stop;     
    OtaDeleteTimer_t delete; 
} OtaTimerInterface_t;
 
typedef struct OtaMallocInterface
{
    /* MISRA rule 21.3 prohibits the use of malloc and free from stdlib.h, however, we're only
     * defining the interface here. On FreeRTOS this is implemented with pvPortMalloc and vPortFree,
     * and on Linux it's implemented with standard C malloc and free. This is a false positive. */
    /* coverity[misra_c_2012_rule_21_3_violation] */
    OtaMalloc_t malloc; 
    /* coverity[misra_c_2012_rule_21_3_violation] */
    OtaFree_t free;     
} OtaMallocInterface_t;
 
typedef struct OtaOSInterface
{
    OtaEventInterface_t event; 
    OtaTimerInterface_t timer; 
    OtaMallocInterface_t mem;  
} OtaOSInterface_t;
 
#endif /* ifndef OTA_OS_INTERFACE_H */