flash.h

Go to the documentation of this file.

#ifndef NEXUS_FLASH_H
#define NEXUS_FLASH_H
 
#include "nexus/core/time.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct nx_flash_port nx_flash_port_t;
typedef struct {
    uint32_t offset;
    uint32_t size;
} nx_flash_sector_t;

typedef struct {
    uint32_t base_address;
    uint32_t size;
    uint32_t program_unit;
    const nx_flash_sector_t* sectors;
    size_t sector_count;
} nx_flash_geometry_t;

typedef struct {
    const nx_flash_port_t* port;
    uint32_t offset;
    uint32_t size;
    bool writable;
} nx_flash_region_t;

typedef struct {
    const nx_flash_geometry_t* (*geometry)(const void* context);
    nx_result_t (*read)(const void* context, uint32_t offset, void* data,
                        size_t length);
    nx_result_t (*program)(void* context, uint32_t offset, const void* data,
                           size_t length, nx_time_us_t deadline);
    nx_result_t (*erase)(void* context, uint32_t offset, size_t length,
                         nx_time_us_t deadline);
} nx_flash_ops_t;

struct nx_flash_port {
    const nx_flash_ops_t* ops;
    void* context;
};

const nx_flash_geometry_t* nx_flash_port_geometry(const nx_flash_port_t* port);
nx_result_t nx_flash_port_read(const nx_flash_port_t* port, uint32_t offset,
                               void* data, size_t length);
nx_result_t nx_flash_port_program(const nx_flash_port_t* port, uint32_t offset,
                                  const void* data, size_t length,
                                  nx_time_us_t deadline);
nx_result_t nx_flash_port_erase(const nx_flash_port_t* port, uint32_t offset,
                                size_t length, nx_time_us_t deadline);
nx_result_t nx_flash_region_validate(const nx_flash_region_t* region);
nx_result_t nx_flash_region_read(const nx_flash_region_t* region,
                                 uint32_t offset, void* data, size_t length);
nx_result_t nx_flash_region_program(const nx_flash_region_t* region,
                                    uint32_t offset, const void* data,
                                    size_t length, nx_time_us_t deadline);
nx_result_t nx_flash_region_erase(const nx_flash_region_t* region,
                                  uint32_t offset, size_t length,
                                  nx_time_us_t deadline);
#ifdef __cplusplus
}
#endif
 
#endif