ota_interface_private.h

Go to the documentation of this file.

/*
 * AWS IoT Over-the-air Update v3.4.1
 * 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_INTERFACE_PRIVATE_H
#define OTA_INTERFACE_PRIVATE_H
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    extern "C" {
#endif
/* *INDENT-ON* */
 
/* OTA includes. */
#include "ota.h"
#include "ota_private.h"
 
/* General Constants. */
 
/* OTA control protocol constants. */
#define OTA_CONTROL_OVER_MQTT     0x00000001 
/* OTA data protocol constants. */
#define OTA_DATA_OVER_MQTT        0x00000001 
#define OTA_DATA_OVER_HTTP        0x00000002 
#define OTA_DATA_NUM_PROTOCOLS    ( 2U )     
typedef struct
{
    OtaErr_t ( * requestJob )( const OtaAgentContext_t * pAgentCtx ); 
    OtaErr_t ( * updateJobStatus )( const OtaAgentContext_t * pAgentCtx,
                                    OtaJobStatus_t status,
                                    int32_t reason,
                                    int32_t subReason );           
    OtaErr_t ( * cleanup )( const OtaAgentContext_t * pAgentCtx ); 
} OtaControlInterface_t;
 
typedef struct
{
    OtaErr_t ( * initFileTransfer )( const OtaAgentContext_t * pAgentCtx ); 
    OtaErr_t ( * requestFileBlock )( OtaAgentContext_t * pAgentCtx );       
    OtaErr_t ( * decodeFileBlock )( const uint8_t * pMessageBuffer,
                                    size_t messageSize,
                                    int32_t * pFileId,
                                    int32_t * pBlockId,
                                    int32_t * pBlockSize,
                                    uint8_t * const * pPayload,
                                    size_t * pPayloadSize );       
    OtaErr_t ( * cleanup )( const OtaAgentContext_t * pAgentCtx ); 
} OtaDataInterface_t;
 
void setControlInterface( OtaControlInterface_t * pControlInterface );
 
OtaErr_t setDataInterface( OtaDataInterface_t * pDataInterface,
                           const uint8_t * pProtocol );
 
/* *INDENT-OFF* */
#ifdef __cplusplus
    }
#endif
/* *INDENT-ON* */
 
#endif /* ifndef OTA_INTERFACE_PRIVATE_H */