external_flash.h

Go to the documentation of this file.

/* Copyright 2018 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef EXTERNAL_FLASH_H_
#define EXTERNAL_FLASH_H_
 
#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>
 
 
typedef enum
{
    EXTFLASH_RES_OK       = 0, /* Operation is successful */
    EXTFLASH_RES_ERROR    = 1, /* Error during operation */
    EXTFLASH_RES_BUSY     = 2, /* Flash driver is busy */
    EXTFLASH_RES_NODRIVER = 3, /* Flash driver not implemented */
    EXTFLASH_RES_PARAM    = 4  /* Invalid parameters */
} extFlash_res_e;
 
typedef struct
{
    size_t flash_size;
    size_t write_page_size;
    size_t erase_sector_size;
    size_t write_alignment;
    uint32_t byte_write_time;
    uint32_t page_write_time;
    uint32_t sector_erase_time;
    uint32_t byte_write_call_time;
    uint32_t page_write_call_time;
    uint32_t sector_erase_call_time;
    uint32_t is_busy_call_time;
} flash_info_t;
 
 
extFlash_res_e externalFlash_init(void);
 
extFlash_res_e externalFlash_startRead(void * to, const void * from,
                                       size_t amount);
extFlash_res_e externalFlash_startWrite(void * to, const void * from,
                                        size_t amount);
 
extFlash_res_e externalFlash_startErase(size_t * sector_base,
                                        size_t * number_of_sector);
 
bool externalFlash_isBusy(void);
 
 extFlash_res_e externalFlash_getInfo(flash_info_t * info);
 
#endif //EXTERNAL_FLASH_H__