flash.h

Go to the documentation of this file.

#ifndef __FLASH_H__
#define __FLASH_H__

// I usually include stdint.h, but SGDK defines some stdint types here:
#include "types.h"

// Maximum number of flash regions. CFI standard allows up to 4
#define FLASH_REGION_MAX 4

struct flash_region {
        uint32_t start_addr;    //< Sector start address
        uint16_t num_sectors;   //< Number of sectors
        uint16_t sector_len;    //< Sector length in 256 byte units
};
struct flash_chip {
        uint32_t len;                  //< Length of chip in bytes
        uint16_t num_regions;          //< Number of regions in chip
        struct flash_region region[FLASH_REGION_MAX]; //< Region data array
};
int16_t flash_init(void);

void flash_deinit(void);

const struct flash_chip *flash_metadata_get(void);

uint32_t flash_sector_erase(uint32_t addr);

uint16_t flash_program(uint32_t addr, const uint8_t *data, uint16_t len);

int16_t flash_read(uint32_t addr, uint8_t *data, uint16_t len);

int16_t flash_copy(uint32_t dst, uint32_t src, uint16_t len);

int16_t flash_sector_limits(uint32_t addr, uint32_t *start, uint32_t *next);

#endif