wms_memory_area.h

Go to the documentation of this file.

/* Copyright 2018 Wirepas Ltd. All Rights Reserved.
 *
 * See file LICENSE.txt for full license details.
 *
 */
 
#ifndef APP_LIB_MEMORY_AREA_H_
#define APP_LIB_MEMORY_AREA_H_
 
#include <stdlib.h>
#include <stdint.h>
#include <stdbool.h>
 
#include "wms_app.h"
 
#define APP_LIB_MEMORY_AREA_NAME 0x01fd3b49
 
#define APP_LIB_MEMORY_AREA_VERSION 0x200
 
typedef enum
{
    APP_LIB_MEM_AREA_RES_OK        = 0,
    APP_LIB_MEM_AREA_RES_ERROR     = 1,
    APP_LIB_MEM_AREA_RES_BUSY      = 2,
    APP_LIB_MEM_AREA_RES_NODRIVER  = 3,
    APP_LIB_MEM_AREA_RES_PARAM     = 4,
    APP_LIB_MEM_AREA_RES_INVALID_AREA  = 5,
} app_lib_mem_area_res_e;
 
#define APP_LIB_MEM_AREA_MAX_AREAS    8
 
typedef uint32_t app_lib_mem_area_id_t;
 
typedef enum
{
    APP_LIB_MEM_AREA_TYPE_APPLICATION = 0,
    APP_LIB_MEM_AREA_TYPE_USER        = 1,
} app_lib_mem_area_type_e;
 
typedef struct
{
    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;
} app_lib_mem_area_flash_info_t;
 
typedef struct
{
    app_lib_mem_area_id_t area_id;
    size_t area_size;
    app_lib_mem_area_flash_info_t flash;
    bool external_flash;
    app_lib_mem_area_type_e type;
} app_lib_mem_area_info_t;
 
 
typedef app_lib_mem_area_res_e
    (*app_lib_mem_area_startRead_f)(app_lib_mem_area_id_t id,
                                    void * to,
                                    uint32_t from,
                                    size_t amount);
 
typedef app_lib_mem_area_res_e
    (*app_lib_mem_area_startWrite_f)(app_lib_mem_area_id_t id,
                                     uint32_t to,
                                     const void * from,
                                     size_t amount);
 
typedef app_lib_mem_area_res_e
    (*app_lib_mem_area_startErase_f)(app_lib_mem_area_id_t id,
                                     uint32_t * sector_base,
                                     size_t * number_of_sector);
 
typedef bool
    (*app_lib_mem_area_isBusy_f)(app_lib_mem_area_id_t id);
 
typedef app_lib_mem_area_res_e
    (*app_lib_mem_area_getAreaInfo_f)(app_lib_mem_area_id_t id,
                                      app_lib_mem_area_info_t * info);
 
typedef void
  (*app_lib_mem_area_getAreaList_f)(app_lib_mem_area_id_t * list,
                                    uint8_t * num_areas);
 
 typedef struct
 {
     app_lib_mem_area_startRead_f      startRead;
     app_lib_mem_area_startWrite_f     startWrite;
     app_lib_mem_area_startErase_f     startErase;
     app_lib_mem_area_isBusy_f         isBusy;
     app_lib_mem_area_getAreaInfo_f    getAreaInfo;
     app_lib_mem_area_getAreaList_f    getAreaList;
} app_lib_memory_area_t;
 
#endif /* APP_LIB_MEMORY_AREA_H_ */