Class FlashMemory

FlashMemoryClass Class

Syntax

class FlashMemoryClass

Members

Public Constructors
FlashMemoryClass::FlashMemoryClass	Constructs a FlashMemoryClass object
Public Methods
FlashMemoryClass::begin	Initialize/Re-initialize the base address and size
FlashMemoryClass::end	Free the buf set by begin, deinit flash memory process
FlashMemoryClass::read	Read content (stream of word) from flash memory to buffer. Able to set address with specific offset.
FlashMemoryClass::write	Write the content in the buffer back to the flash memory. Able to set address with specific offset.
FlashMemoryClass::readWord	Read word (4 bytes) from flash memory based on the new base address with specific offset.
FlashMemoryClass::writeWord	Write word to flash memory based on the new base address with specific offset.
FlashMemoryClass::eraseSector	Erase flash memory by sector (4K bytes)
FlashMemoryClass::eraseWord	Erase flash memory by word
FlashMemoryClass::buf_size	The buf size regarded as work size
FlashMemoryClass::buf	The buf to be operated

FlashMemoryClass::FlashMemoryClass

Syntax

FlashMemoryClass(void);

Example Code

Example: ReadWriteWord

Note

“FlashMemory.h” must be included to use the class function.

FlashMemoryClass::begin

Description

Initialize/Re-initialize the base address and size. The default usable flash memory size is 0x3000.

Syntax

void begin(unsigned int flash_base_address, unsigned int flash_buf_size);

Parameters

flash_base_address: The starting location/position of the flash memory.

flash_buf_size: The desired buffer size.

Example Code

Example: ReadWriteWord

Note

“FlashMemory.h” must be included to use the class function.

FlashMemoryClass::end

Description

Free the buf set by begin, deinit flash memory process.

Syntax

void end(void);

Example Code

NA

Note

“FlashMemory.h” must be included to use the class function.

Read from the flash memory and copy into a buffer. All modification of the contents will be done in the buffer before updating the flash memory. The default length of the buf is buf_size with 0x3000. Update buf and buf_size by function “begin()”. Indicate the starting address by “offset”.

Syntax

void read(unsigned int offset = 0);

Parameters

offset: offset to the base address.

Returns

NA

Example Code

Example: ReadWriteStream

Note

“FlashMemory.h” must be included to use the class function.

FlashMemoryClass::write

Description

Write buf back to flash memory. Indicate the starting address by “offset”. The default length of the buf is buf_size with 0x3000. Update buf and buf_size by function “begin()”

Syntax

void write(unsigned int offset = 0);

Parameters

offset: offset to the base address.

Returns

NA

Example Code

Example: ReadWriteStream

Note

“FlashMemory.h” must be included to use the class function.

FlashMemoryClass::readWord

Description

Read 4 bytes data (a word) from a flash address, based on the new base address with specific offset.

Syntax

unsigned int readWord(unsigned int offset);

Parameters

offset: offset to the base address.

Returns

This function returns the 4 bytes read data. The return type is “unsigned int”.

Example Code

Example: ReadWriteWord

Note

“FlashMemory.h” must be included to use the class function.

FlashMemoryClass::writeWord

Description

Write 4 bytes data (a word) to a flash address, based on the new base address with specific offset. Then read data from the address and compare with the original data. If there is difference. Buffer a flash sector from the new base address, then erase the sector from the flash. Replace the correct data back into buffer. Then rewrite the buffer into the flash.

Syntax

void writeWord(unsigned int offset, unsigned int data);

“FlashMemory.h” must be included to use the class function.

void eraseSector(unsigned int sector_offset);

“FlashMemory.h” must be included to use the class function.

void eraseWord(unsigned int offset);

“FlashMemory.h” must be included to use the class function.

unsigned int buf_size;

“FlashMemory.h” must be included to use the class function.

unsigned char *buf;

“FlashMemory.h” must be included to use the class function.