Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
EEPROMEmulation.hxx File Reference
#include "EEPROM.hxx"

Go to the source code of this file.

Classes

class  EEPROMEmulation
 Emulates EEPROM in FLASH for the Tiva, LPC17xx and LPC40xx platforms. More...
 

Macros

#define EEPROMEMU_FLASH_SIZE   ((uintptr_t)(&__eeprom_end - &__eeprom_start))
 Total FLASH memory size to use for EEPROM Emulation.
 

Variables

const char __eeprom_start
 Linker-defined symbol where in the memory space (flash) the eeprom emulation data starts.
 
const char __eeprom_end
 Linker-defined symbol where in the memory space (flash) the eeprom emulation data ends.
 

Detailed Description

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This file implements a generic EEPROM emulation in FLASH.

Author
Stuart W. Baker
Date
24 June 2015

Definition in file EEPROMEmulation.hxx.

Macro Definition Documentation

◆ EEPROMEMU_FLASH_SIZE

#define EEPROMEMU_FLASH_SIZE   ((uintptr_t)(&__eeprom_end - &__eeprom_start))

Total FLASH memory size to use for EEPROM Emulation.

Must be at least 2 sectors large and at least 4x the total amount of EEPROM address space that will be emulated. Larger sizes will result in greater endurance. must be a macro in order to calculate from link time constants.

Definition at line 187 of file EEPROMEmulation.hxx.