cascoda_external_flash.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021, Cascoda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDERS 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 CASCODA_EXTERNAL_FLASH_H
#define CASCODA_EXTERNAL_FLASH_H
 
#include "cascoda-bm/cascoda_ota_upgrade.h"
#include "cascoda-bm/cascoda_types.h"
#include "ca821x_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if CASCODA_EXTERNAL_FLASHCHIP_PRESENT
/****** External Erase Type ******/
typedef enum
{
    ERASE_CHIP = 0, 
    ERASE_64KB,     
    ERASE_32KB,     
    ERASE_4KB,      
} ExternalEraseType;
 
/****** Information used for erase procedure ******/
typedef struct
{
    u32_t               startAddress;     
    u32_t               eraseLength;      
    u32_t               endAddress;       
    ExtFlashAPICallback otaCallback;      
    ExtFlashAPICallback upstreamCallback; 
} ExtFlashEraseInfo;
 
/****** Information used for writing procedure ******/
typedef struct
{
    u32_t               startAddress;     
    u32_t               writeLength;      
    u32_t               writeLimit;       
    u16_t               pageSize;         
    ExtFlashAPICallback otaCallback;      
    ExtFlashAPICallback upstreamCallback; 
    u8_t               *data;             
} ExtFlashWriteInfo;
 
/****** Information used for reading and checking procedures ******/
typedef struct
{
    u32_t               startAddress;     
    u32_t               checklen;         
    u32_t               checksum;         
    u32_t               readLimit;        
    ExtFlashAPICallback upstreamCallback; 
} ExtFlashCheckInfo;
 
/****** Union of all external flash info structs ******/
union ExtFlashInfoStructs
{
    ExtFlashEraseInfo eraseInfo;
    ExtFlashWriteInfo writeInfo;
    ExtFlashCheckInfo checkInfo;
};
 
ca_error external_flash_evbme_send_upstream(void *aContext);
 
ca_error external_flash_erase_helper(void *aContext);
 
ca_error external_flash_write_helper(void *aContext);
 
ca_error external_flash_check_helper(void *aContext);
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* CASCODA_EXTERNAL_FLASH_H */