hal_flash.h File Reference

Generic flash driver class header. More...

Go to the source code of this file.

Data Structures
struct	flash_sector_descriptor_t
	Flash sector descriptor. More...
struct	flash_descriptor_t
	Type of a flash device descriptor. More...
struct	BaseFlashVMT
	BaseFlash virtual methods table. More...
struct	BaseFlash
	Base flash class. More...

Macros
#define	_base_flash_methods_alone
	BaseFlash specific methods. More...
#define	_base_flash_methods
	BaseFlash specific methods with inherited ones. More...
#define	_base_flash_data
	BaseFlash specific data. More...
Flash attributes
#define	FLASH_ATTR_ERASED_IS_ONE   0x00000001
#define	FLASH_ATTR_MEMORY_MAPPED   0x00000002
#define	FLASH_ATTR_REWRITABLE   0x00000004
#define	FLASH_ATTR_READ_ECC_CAPABLE   0x00000008
#define	FLASH_ATTR_SUSPEND_ERASE_CAPABLE   0x00000010
Macro Functions (BaseFlash)
#define	getBaseFlash(ip)   ((BaseFlash *)&(ip)->vmt)
	Instance getter. More...
#define	flashGetDescriptor(ip)   (ip)->vmt->get_descriptor(ip)
	Gets the flash descriptor structure. More...
#define	flashRead(ip, offset, n, rp)   (ip)->vmt->read(ip, offset, n, rp)
	Read operation. More...
#define	flashProgram(ip, offset, n, pp)   (ip)->vmt->program(ip, offset, n, pp)
	Program operation. More...
#define	flashStartEraseAll(ip)   (ip)->vmt->start_erase_all(ip)
	Starts a whole-device erase operation. More...
#define	flashStartEraseSector(ip, sector)   (ip)->vmt->start_erase_sector(ip, sector)
	Starts an sector erase operation. More...
#define	flashQueryErase(ip, msec)   (ip)->vmt->query_erase(ip, msec)
	Queries the driver for erase operation progress. More...
#define	flashVerifyErase(ip, sector)   (ip)->vmt->verify_erase(ip, sector)
	Returns the erase state of a sector. More...

Typedefs
typedef uint32_t	flash_offset_t
	Type of a flash offset. More...
typedef uint32_t	flash_sector_t
	Type of a flash sector number. More...

Enumerations

Functions
flash_error_t	flashWaitErase (BaseFlash *devp)
	Waits until the current erase operation is finished. More...
flash_offset_t	flashGetSectorOffset (BaseFlash *devp, flash_sector_t sector)
	Returns the offset of a sector. More...
uint32_t	flashGetSectorSize (BaseFlash *devp, flash_sector_t sector)
	Returns the size of a sector. More...

Detailed Description

Generic flash driver class header.

Definition in file hal_flash.h.