fota_agent.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  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 __FOTAAgent__H_
#define __FOTAAgent__H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdio.h>
#include <kernel/dpl/DebugP.h>
#include <stdlib.h>
#include <string.h>
#include <drivers/flsopskd.h>
#include <middleware/tiELFuParser/tielfup32.h>
#include <drivers/spinlock.h>
 
/* ========================================================================== */
/*                             Macros & Typedefs                              */
/* ========================================================================== */
 
#define FOTAAGENT_WRITEOFFSET_DNC (0U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    size_t programHeaderCnt;
    ELFUP_ELFPH *pProgramHeader;
    uint8_t * pProcessingBuffer;
    FLSOPSKD_Params flsopsParams;
}FOTAAgent_Params;
 
typedef struct
{
    char doFlashSegments;
    uint32_t BufferManager_lastAddress;
    uint32_t pProcessingBuffer_len;
    uint32_t filePointer;
    uint32_t flashWritePointer;
    uint32_t wrOffset;
    FLSOPSKD_Handle flopsHandle;
    ELFUP_Handle elfupHandle;
    FOTAAgent_Params params;
} FOTAAgent_Handle;
 
int32_t FOTAAgent_Params_init(FOTAAgent_Params *params);
 
int32_t FOTAAgent_init(FOTAAgent_Handle *pHandle, FOTAAgent_Params *params);
 
int32_t FOTAAgent_writeStart(FOTAAgent_Handle *pHandle, uint32_t wrOffset, char doFlashSegments);
 
int32_t FOTAAgent_writeUpdate(FOTAAgent_Handle *pHandle, uint8_t *buf, uint32_t size);
 
int32_t FOTAAgent_writeEnd(FOTAAgent_Handle *pHandle);
 
int32_t FOTAAgent_getFLSOPSKDHandle(FOTAAgent_Handle *pHandle, FLSOPSKD_Handle* flsopskdHandle);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __FOTAAgent__H_ */