ota_platform_interface.h

Go to the documentation of this file.

/*
 * AWS IoT Over-the-air Update v3.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.
 */
 
#ifndef OTA_PLATFORM_INTERFACE
#define OTA_PLATFORM_INTERFACE
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
#include "ota_private.h"
 
typedef uint32_t   OtaPalStatus_t;
 
typedef uint32_t   OtaPalSubStatus_t;
 
typedef uint32_t   OtaPalMainStatus_t;
#define    OtaPalSuccess                 0x0U   
#define    OtaPalUninitialized           0xe0U  
#define    OtaPalOutOfMemory             0xe1U  
#define    OtaPalNullFileContext         0xe2U  
#define    OtaPalSignatureCheckFailed    0xe3U  
#define    OtaPalRxFileCreateFailed      0xe4U  
#define    OtaPalRxFileTooLarge          0xe5U  
#define    OtaPalBootInfoCreateFailed    0xe6U  
#define    OtaPalBadSignerCert           0xe7U  
#define    OtaPalBadImageState           0xe8U  
#define    OtaPalAbortFailed             0xe9U  
#define    OtaPalRejectFailed            0xeaU  
#define    OtaPalCommitFailed            0xebU  
#define    OtaPalActivateFailed          0xecU  
#define    OtaPalFileAbort               0xedU  
#define    OtaPalFileClose               0xeeU  
/* @[define_ota_err_code_helpers] */
#define OTA_PAL_ERR_MASK    0xffffffUL                                                                                                           
#define OTA_PAL_SUB_BITS    24U                                                                                                                  
#define OTA_PAL_MAIN_ERR( err )             ( ( OtaPalMainStatus_t ) ( uint32_t ) ( ( uint32_t ) ( err ) >> ( uint32_t ) OTA_PAL_SUB_BITS ) )    
#define OTA_PAL_SUB_ERR( err )              ( ( ( uint32_t ) ( err ) ) & ( ( uint32_t ) OTA_PAL_ERR_MASK ) )                                     
#define OTA_PAL_COMBINE_ERR( main, sub )    ( ( ( uint32_t ) ( main ) << ( uint32_t ) OTA_PAL_SUB_BITS ) | ( uint32_t ) OTA_PAL_SUB_ERR( sub ) ) 
/* @[define_ota_err_code_helpers] */
 
typedef OtaPalStatus_t ( * OtaPalAbort_t )( OtaFileContext_t * const pFileContext );
 
typedef OtaPalStatus_t (* OtaPalCreateFileForRx_t)( OtaFileContext_t * const pFileContext );
 
typedef OtaPalStatus_t ( * OtaPalCloseFile_t )( OtaFileContext_t * const pFileContext );
 
typedef int16_t ( * OtaPalWriteBlock_t ) ( OtaFileContext_t * const pFileContext,
                                           uint32_t offset,
                                           uint8_t * const pData,
                                           uint32_t blockSize );
 
typedef OtaPalStatus_t ( * OtaPalActivateNewImage_t )( OtaFileContext_t * const pFileContext );
 
typedef OtaPalStatus_t ( * OtaPalResetDevice_t ) ( OtaFileContext_t * const pFileContext );
 
typedef OtaPalStatus_t ( * OtaPalSetPlatformImageState_t )( OtaFileContext_t * const pFileContext,
                                                            OtaImageState_t eState );
 
typedef OtaPalImageState_t ( * OtaPalGetPlatformImageState_t ) ( OtaFileContext_t * const pFileContext );
 
typedef struct OtaPalInterface
{
    /* MISRA rule 21.8 prohibits the use of abort from stdlib.h. However, this is merely one of the
     * OTA platform abstraction layer interfaces, which is used to abort an OTA update. So it's a
     * false positive. */
    /* MISRA Ref 21.8.1 [Standard library includes] */
    /* More details at: https://github.com/aws/ota-for-aws-iot-embedded-sdk/blob/main/MISRA.md#rule-101 */
    /* coverity[misra_c_2012_rule_21_8_violation] */
    OtaPalAbort_t abort;                                 
    OtaPalCreateFileForRx_t createFile;                  
    OtaPalCloseFile_t closeFile;                         
    OtaPalWriteBlock_t writeBlock;                       
    OtaPalActivateNewImage_t activate;                   
    OtaPalResetDevice_t reset;                           
    OtaPalSetPlatformImageState_t setPlatformImageState; 
    OtaPalGetPlatformImageState_t getPlatformImageState; 
} OtaPalInterface_t;
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef OTA_PLATFORM_INTERFACE */