ota.h

/*
 * Copyright (c) 2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef __OTA_H__
#define __OTA_H__

#ifdef    __cplusplus
extern "C" {
#endif

#include <stdint.h>

#define OTA_LIB_VERSION    "OTA_LIB_2.0.0.7"

/* Configurable numbers */
#define MAX_CONSECUTIVE_OTA_ERRORS           5


/* !Not Configurable numbers */
#define MAX_URL_SIZE            512
#define NET_BUF_SIZE            1440

/* check in sl_OtaInit if this buffer is enough for OTA lib */
#define OTA_BLOCK_SIZE 7800

typedef struct
{
    uint8_t Buff[OTA_BLOCK_SIZE];
}OTA_memBlock;

typedef enum
{
    OTA_RUN_NON_BLOCKING/* not supported , OTA_RUN_BLOCKING */
} OTA_runningMode;

typedef void (*OTA_eventHandler) (void *);

#define MAX_SERVER_NAME         64
#define MAX_VENDOR_TOKEN_SIZE   96
#define VERSION_STR_SIZE        14      /* sizeof "YYYYMMDDHHMMSS"    */

/******************************************************************************
 * Server info Structure
******************************************************************************/
typedef struct  
{
    uint32_t  IpAddress;                            /* 0x0 – no, ip address, use server name */
    uint32_t  SecuredConnection;                    /* 1 - secured, use port 443  0 - not secured, use port 80 */
    uint8_t   ServerName[MAX_SERVER_NAME];
    uint8_t   VendorToken[MAX_VENDOR_TOKEN_SIZE];
} Ota_optServerInfo;

typedef struct  
{
    uint8_t   CurrentVersion[VERSION_STR_SIZE+1];
    uint8_t   NewVersion[VERSION_STR_SIZE+1];
} Ota_optVersionsInfo;

/******************************************************************************
 * Enumerations
******************************************************************************/
typedef enum
{
    EXTLIB_OTA_SET_OPT_SERVER_INFO = 0,  /* see Ota_optServerInfo   */
    EXTLIB_OTA_SET_OPT_FILE_SERVER_URL,
    EXTLIB_OTA_SET_OPT_VENDOR_ID,                    
    EXTLIB_OTA_SET_OPT_ACCEPT_UPDATE,
    EXTLIB_OTA_SET_OPT_DECLINE_UPDATE,
    EXTLIB_OTA_SET_OPT_IMAGE_COMMIT,
    EXTLIB_OTA_SET_OPT_IMAGE_ROLLBACK,
    EXTLIB_OTA_GET_OPT_IS_ACTIVE,  
    EXTLIB_OTA_GET_OPT_VERSIONS,  
    EXTLIB_OTA_GET_OPT_IS_PENDING_COMMIT
} OTA_option;

/******************************************************************************
 * Macros
******************************************************************************/
/* sl_OtaRun error codes */
#define OTA_RUN_STATUS_DOWNLOAD_DONE                                (104L)
#define OTA_RUN_STATUS_CHECK_OLDER_VERSION                          (103L)
#define OTA_RUN_STATUS_CHECK_NEWER_VERSION                          (102L)
#define OTA_RUN_STATUS_NO_UPDATES                                   (101L)
#define OTA_RUN_STATUS_OK                                           (0L)

#define OTA_RUN_STATUS_CONTINUE                                     (+20001L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_CONNECT_OTA_SERVER   (+20002L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_RECV_APPEND          (+20003L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_REQ_OTA_DIR          (+20004L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_REQ_FILE_URL         (+20005L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_CONNECT_FILE_SERVER  (+20006L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_REQ_FILE_CONTENT     (+20007L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_FILE_HDR             (+20008L)
#define OTA_RUN_STATUS_CONTINUE_WARNING_FAILED_DOWNLOAD_AND_SAVE    (+20009L)

#define OTA_RUN_ERROR_NO_SERVER_NO_VENDOR                           (-21001L)
#define OTA_RUN_ERROR_UNEXPECTED_STATE                              (-21002L)
#define OTA_RUN_ERROR_CONSECUTIVE_OTA_ERRORS                        (-21003L)
#define OTA_RUN_ERROR_SECURITY_ALERT                                (-21004L)

/* sl_OtaGet error codes */
#define OTA_STATUS_OK                                        (0L)
#define OTA_OPT_ERROR_WRONG_STATE                       (-20601L)
#define OTA_OPT_ERROR_COMMIT                            (-20602L)
#define OTA_OPT_ERROR_ROLLBACK                          (-20603L)
#define OTA_OPT_ERROR_OPTION_CODE                       (-20604L)
#define OTA_OPT_ERROR_VENDOR_DIR_SIZE                   (-20605L)
#define OTA_INIT_ERROR                                  (-20701L)

/*****************************************************************************
 *   API Prototypes
 *****************************************************************************/

int16_t OTA_init(OTA_runningMode runningMode, OTA_memBlock* pMemBlock, OTA_eventHandler eventHandler);

int16_t OTA_run();

int16_t OTA_set(OTA_option option, int32_t optionLen, uint8_t *pOptionVal, int32_t flags);

int16_t OTA_get(OTA_option option, int32_t *pOptionLen, uint8_t *pOptionVal);

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __OTA_H__ */