EEPROMClass Class Reference

#include <EEPROM.h>

Public Member Functions
	EEPROMClass (uint32_t sector)
	EEPROMClass (void)
void	begin (size_t size)
uint8_t	read (int const address)
void	write (int const address, uint8_t const value)
bool	commit ()
bool	end ()
uint8_t *	getDataPtr ()
const uint8_t *	getConstDataPtr () const
template<typename T >
T &	get (int const address, T &t)
template<typename T >
const T &	put (int const address, const T &t)
size_t	length ()
uint8_t &	operator[] (int const address)
const uint8_t &	operator[] (int const address) const

Static Public Member Functions
static uint32_t	writeToFlash (uint32_t pageIndex, uint8_t bank, const uint8_t *data, uint32_t dataLenght)
static bool	readFromFlash (uint32_t pageIndex, uint32_t offset, uint8_t bank, uint8_t *data, uint32_t dataLenght)

Protected Attributes
uint32_t	page_address
const uint16_t	page_index
uint8_t *	_data = nullptr
size_t	_size = 0
bool	_dirty = false

Constructor & Destructor Documentation

EEPROMClass() [1/2]

EEPROMClass::EEPROMClass

(

uint32_t

sector

)

EEPROMClass() [2/2]

EEPROMClass::EEPROMClass

(

void

)

Member Function Documentation

begin()

void EEPROMClass::begin

(

size_t

size

)

Note

Parameters

Here is the call graph for this function:

read()

uint8_t EEPROMClass::read

(

int const

address

)

Note

Parameters

write()

void EEPROMClass::write	(	int const	address,
		uint8_t const	value
	)

Note

Parameters

commit()

bool EEPROMClass::commit

(

)

Note

Parameters

Here is the call graph for this function:

end()

bool EEPROMClass::end

(

)

Note

Parameters

Here is the call graph for this function:

writeToFlash()

uint32_t EEPROMClass::writeToFlash ( uint32_t  pageIndex, uint8_t  bank, const uint8_t *  data, uint32_t  dataLenght  )

static

Note

Parameters

readFromFlash()

bool EEPROMClass::readFromFlash ( uint32_t  pageIndex, uint32_t  offset, uint8_t  bank, uint8_t *  data, uint32_t  dataLenght  )

static

Note

Parameters

getDataPtr()

uint8_t * EEPROMClass::getDataPtr

(

)

Note

Parameters

getConstDataPtr()

const uint8_t * EEPROMClass::getConstDataPtr

(

)

const

get()

template<typename T >

T& EEPROMClass::get ( int const  address, T &  t  )

inline

put()

template<typename T >

const T& EEPROMClass::put ( int const  address, const T &  t  )

inline

length()

size_t EEPROMClass::length ( )

inline

operator[]() [1/2]

uint8_t& EEPROMClass::operator[] ( int const  address )

inline

Here is the call graph for this function:

operator[]() [2/2]

const uint8_t& EEPROMClass::operator[] ( int const  address ) const

inline

Here is the call graph for this function:

Member Data Documentation

page_address

uint32_t EEPROMClass::page_address

protected

page_index

const uint16_t EEPROMClass::page_index

protected

_data

uint8_t* EEPROMClass::_data = nullptr

protected

_size

size_t EEPROMClass::_size = 0

protected

_dirty

bool EEPROMClass::_dirty = false

protected

---

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

• src/Drivers/Inc/EEPROM.h
• src/Drivers/Src/EEPROM.cpp