FlashStorage Class Reference

#include <FlashStorage.h>

Inheritance diagram for FlashStorage:

Collaboration diagram for FlashStorage:

Public Member Functions
	FlashStorage ()
	Constructs a new FlashStorage object.
bool	verify () override
	Verifies the flash connection and prepares for data storage.
void	store (String) override
	Stores a string in flash memory, appending a newline at the end.
void	storePacket (uint8_t *) override
	Stores a packet of bytes in flash memory.
void	dump ()
	Dumps the contents of flash memory to the serial monitor. [DEPRECIATED].
bool	reinitFlash ()
void	erase ()
	Erases all data stored in flash memory.
void	downloadFile (int)
	Downloads data from flash memory with progress tracking.
void	getStatus ()
	Prints the current status of the flash storage.
void	atomicStore (String data)
	Writes a string to flash atomically.
void	removeFile (uint32_t file_number)
	Deletes a file by erasing the sectors it occupies.
void	checkFreeSpaceWarnings ()
	Checks available flash space and logs warnings when thresholds are reached.
Public Member Functions inherited from Storage
	Storage (String storage_name)
Public Member Functions inherited from Device
	Device (String device_name)
	Default constructor, sets a max_attempt of 1 (device recovery won't be attempted)
	Device (String device_name, int max_attempts, int wait_factor)
const String &	getDeviceName ()
bool	getVerified ()
	Get if the Device is Verified.
void	recoveryConfig (int max_attempts, int wait_factor)
	Set recovery config (used keep default constructor)
void	setWaitFactor (int wait_factor)
	Set wait_factor.
void	setMaxAttempts (int max_attempts)
	Set max_attempts.
bool	attemptConnection ()
	If the sensor is verified, return true, if not and it has been long enough since the last attempt (decided by wait_factor and attempt_number), attempt to reverify (reinitialize) it.

Private Member Functions
void	indexFlash ()
	Locates the next available file block & tracks existing files.
void	loadAddress ()
	Locates the next available write address in flash.
bool	isSectorEmpty ()
	Determines if the current sector is empty.
bool	readFileHeader ()
	Determines if the first 4 bytes of a sector are a file header.
void	writeFileHeader ()
	Writes the file header to the start of a new sector.

Private Attributes
std::vector< FileHeader >	file_data
SFE_SPI_FLASH	flash
uint32_t	address = 0
bool	active_file = false

Static Private Attributes
static const uint32_t	FILE_HEADER = 0xDEADBEEF
static const uint32_t	MAX_SIZE
static const uint32_t	SECTOR_SIZE = 4'096
static const uint32_t	START_ADDRESS = 0

Additional Inherited Members
Protected Attributes inherited from Device
bool	verified
String	device_name

Constructor & Destructor Documentation

FlashStorage()

FlashStorage::FlashStorage

(

)

Constructs a new FlashStorage object.

Initializes the internal write address to 0 and sets the storage name to "Flash Storage."

Member Function Documentation

atomicStore()

void FlashStorage::atomicStore

(

String

data

)

Writes a string to flash atomically.

This function creates a new file entry by first writing a header; then it writes a marker (0xAA) indicating that the file is in progress and reserves one byte for a checksum. It then writes the given data (with a trailing newline) while computing a simple checksum. Once data writing completes, it updates the checksum and changes the marker to 0xBB (complete).

Here is the call graph for this function:

checkFreeSpaceWarnings()

void FlashStorage::checkFreeSpaceWarnings

(

)

Checks available flash space and logs warnings when thresholds are reached.

Thresholds: 64KB, 16KB, 4KB, and 0 bytes.

downloadFile()

void FlashStorage::downloadFile

(

int

file_number

)

Downloads data from flash memory with progress tracking.

This function provides a more user-friendly way to download data from flash memory. It includes:

• Progress tracking
• File-by-file transfer
• Visual feedback
• Transfer statistics

Here is the caller graph for this function:

dump()

void FlashStorage::dump

(

)

Dumps the contents of flash memory to the serial monitor. [DEPRECIATED].

Reads each byte of flash memory starting from the beginning and prints it to the serial monitor. The process continues until the end of the memory or the end code (0xFF) is reached.

erase()

void FlashStorage::erase

(

)

Erases all data stored in flash memory.

Erases all data stored in flash memory by calling the flash erase function and resetting the internal write address to 0.

Here is the caller graph for this function:

getStatus()

void FlashStorage::getStatus

(

)

Prints the current status of the flash storage.

Prints the current address, remaining storage, and stored files.

Here is the caller graph for this function:

indexFlash()

void FlashStorage::indexFlash ( )

private

Locates the next available file block & tracks existing files.

Reads 4KB blocks from flash starting at 0 and increments through memory until finding a free (0xFF) location or reaching the max size. Furthermore, checking for file headers to record their locations as variables for quick reference.

Here is the call graph for this function:

Here is the caller graph for this function:

isSectorEmpty()

bool FlashStorage::isSectorEmpty ( )

private

Determines if the current sector is empty.

Checks the next 16 bytes for 0xFF to determine if the sector is empty.

Returns

true - Sector is empty

false - Sector is not empty

Here is the caller graph for this function:

loadAddress()

void FlashStorage::loadAddress ( )

private

Locates the next available write address in flash.

Reads bytes from flash starting at the current address and increments through memory until finding a free (0xFF) location or reaching the max size.

readFileHeader()

bool FlashStorage::readFileHeader ( )

private

Determines if the first 4 bytes of a sector are a file header.

Returns

true - File header is present

false - File header is not present

Here is the caller graph for this function:

reinitFlash()

bool FlashStorage::reinitFlash

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

removeFile()

void FlashStorage::removeFile

(

uint32_t

file_number

)

Deletes a file by erasing the sectors it occupies.

This function locates the specified file in the file_data vector. It then calculates the range of sectors affected (using the sector size) and erases them. For every sector erased, a log is produced.

Parameters

file_number

The number identifying the file to delete.

Here is the call graph for this function:

Here is the caller graph for this function:

store()

void FlashStorage::store ( String  data )

overridevirtual

Stores a string in flash memory, appending a newline at the end.

Iterates through each character of the string and writes it to flash. The internal write address is then advanced accordingly.

Parameters

data	- The string to be stored in flash.

Implements Storage.

Here is the caller graph for this function:

storePacket()

void FlashStorage::storePacket ( uint8_t *  packet )

overridevirtual

Stores a packet of bytes in flash memory.

Iterates through each byte of the packet and writes it to flash. Takes into account initial header bytes, consisting of sync(4), presence(4), and length fields(2).

Parameters

packet

- Pointer to the byte array containing the packet.

Reimplemented from Storage.

verify()

bool FlashStorage::verify ( )

overridevirtual

Verifies the flash connection and prepares for data storage.

Attempts to initialize the flash memory. If successful, resets the internal write address to 0, locates the next free address, and returns true. Returns false otherwise.

Returns

true - Flash initialization is successful

false - Flash initialization failed

Implements Storage.

Here is the call graph for this function:

writeFileHeader()

void FlashStorage::writeFileHeader ( )

private

Writes the file header to the start of a new sector.

Write a file header (0xDEADBEEF) to indicate the start of a new file at the beginning of a sector. Then, store the file number, along with the start and end address in a data structure.

Here is the caller graph for this function:

Member Data Documentation

active_file

bool FlashStorage::active_file = false

private

address

uint32_t FlashStorage::address = 0

private

file_data

std::vector<FileHeader> FlashStorage::file_data

private

FILE_HEADER

const uint32_t FlashStorage::FILE_HEADER = 0xDEADBEEF

inlinestaticprivate

flash

SFE_SPI_FLASH FlashStorage::flash

private

MAX_SIZE

const uint32_t FlashStorage::MAX_SIZE

inlinestaticprivate

Initial value:

=
      15'000'000

SECTOR_SIZE

const uint32_t FlashStorage::SECTOR_SIZE = 4'096

inlinestaticprivate

START_ADDRESS

const uint32_t FlashStorage::START_ADDRESS = 0

inlinestaticprivate

---

The documentation for this class was generated from the following files:

• FlashStorage.h
• FlashStorage.cpp