Flash_Adapter

Overview

Modules
	Nand Flash Component
	Nor Flash Component

Data Structures
struct	flash_config_t
	Flash config structure. More...
struct	flash_transfer_t
	Flash transfer structure. More...
struct	flash_handle_t
	Flash handle. More...

Enumerations
enum	flash_err_t
	Flash error code structure. More...
enum	flash_op_code_t {   kNorFlash_WriteEnable = 0x0,   kNorFlash_Write = 0x1,   kNorFlash_Read = 0x2,   kNorFlash_ReadStatus = 0x3,   kNorFlash_EraseSector = 0x4,   kNorFlash_EraseChip = 0x5 }
	Flash operation code structure. More...

---

Data Structure Documentation

struct flash_config_t

Data Fields
uint32_t	totalSize
	Total flash size. More...
uint32_t	pageSize
	Page size. More...
uint32_t	sectorSize
	Sector size. More...
bool	needWriteEnable
	Need do write enable before write/erase operation. More...
uint8_t	statusValueSize
	Status value size in bytes. More...
uint32_t	statusBusyMask
	Status busy mask. More...
uint8_t	statusBusyValue
	Status busy value. More...

Field Documentation

uint32_t flash_config_t::totalSize

uint32_t flash_config_t::pageSize

uint32_t flash_config_t::sectorSize

bool flash_config_t::needWriteEnable

uint8_t flash_config_t::statusValueSize

uint32_t flash_config_t::statusBusyMask

uint8_t flash_config_t::statusBusyValue

struct flash_transfer_t

Data Fields
flash_op_code_t	opCode
	Operation code. More...
uint8_t	address
	Program/write address. More...
uint8_t *	data
	Data buffer pointer for program buffer or store buffer. More...
uint32_t	dataSize
	Data buffer size. More...

Field Documentation

flash_op_code_t flash_transfer_t::opCode

uint8_t flash_transfer_t::address

uint8_t* flash_transfer_t::data

uint32_t flash_transfer_t::dataSize

struct flash_handle_t

Data Fields
flash_err_t(*	executeCommand )(void *resource, flash_transfer_t *xfer)
	Execute command function. More...
void *	resource
	Pointer for resource, resource mean the SPI adapter resource. More...
uint32_t	totalSize
	Flash total size. More...
uint32_t	pageSize
	Flash page size. More...
uint32_t	sectorSize
	Flash sector size. More...
bool	needWriteEnable
	Need do write enable before write/erase operation. More...
uint8_t	statusValueSize
	Status value size in bytes. More...
uint32_t	statusBusyMask
	Status busy mask. More...
uint8_t	statusBusyValue
	Status busy value. More...

Field Documentation

flash_err_t(* flash_handle_t::executeCommand)(void *resource, flash_transfer_t *xfer)

void* flash_handle_t::resource

uint32_t flash_handle_t::totalSize

uint32_t flash_handle_t::pageSize

uint32_t flash_handle_t::sectorSize

bool flash_handle_t::needWriteEnable

uint8_t flash_handle_t::statusValueSize

uint32_t flash_handle_t::statusBusyMask

uint8_t flash_handle_t::statusBusyValue

Enumeration Type Documentation

enum flash_err_t

enum flash_op_code_t

Enumerator
kNorFlash_WriteEnable	Operation code: WREN.
kNorFlash_Write	Operation code: Page Program.
kNorFlash_Read	Operation code: Read Data.
kNorFlash_ReadStatus	Operation code: Read Status Register.
kNorFlash_EraseSector	Operation code: Erase sector.
kNorFlash_EraseChip	Operation code: Erase whole chip.