/****************************************************************************************************************************************** stm32_eeprom.hpp For STM32 using Flash emulated-EEPROM The FlashStorage_STM32 library aims to provide a convenient way to store and retrieve user's data using the non-volatile flash memory of STM32F/L/H/G/WB/MP1. It's using the buffered read and write to minimize the access to Flash. It now supports writing and reading the whole object, not just byte-and-byte. Inspired by Cristian Maglie's FlashStorage (https://github.com/cmaglie/FlashStorage) Built by Khoi Hoang https://github.com/khoih-prog/FlashStorage_STM32 Licensed under MIT license Version: 1.2.0 Version Modified By Date Comments ------- ----------- ---------- ----------- 1.0.0 K Hoang 26/01/2021 Initial coding to support STM32F/L/H/G/WB/MP1 using emulated-EEPROM 1.0.1 K Hoang 23/02/2021 Fix compiler warnings. 1.1.0 K Hoang 26/04/2021 Add support to new STM32 core v2.0.0 and new STM32L5 boards. 1.2.0 K Hoang 25/01/2022 Fix `multiple-definitions` linker error ******************************************************************************************************************************************/ /** ****************************************************************************** * @file stm32_eeprom.h * @brief Header for eeprom module ****************************************************************************** * @attention * *

© COPYRIGHT(c) 2016 STMicroelectronics

* * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. 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. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * 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. * ****************************************************************************** */ // The .hpp contains only definitions, and can be included as many times as necessary, without `Multiple Definitions` Linker Error // The .h contains implementations, and can be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error /* Define to prevent recursive inclusion -------------------------------------*/ #ifndef __STM32_EEPROM_HPP #define __STM32_EEPROM_HPP /* Includes ------------------------------------------------------------------*/ #include "stm32_def.h" #ifdef __cplusplus extern "C" { #endif /* Exported types ------------------------------------------------------------*/ /* Exported constants --------------------------------------------------------*/ #if defined(STM32MP1xx) /* Note for STM32MP1xx devices: * Those devices do not have non-volatile memory. The emulation is done * in RETRAM. Therefore data will be preserved *only* when VBAT is supplied * (e.g. A coin battery is connected to CN3 on STM32MP157A_DK1) and * the coprocessor is waken up from STANBY mode. * The data won't be preserved from cold boot, even if VBAT is connected. * See: https://community.st.com/s/question/0D50X0000B44pHUSQY/doesnt-the-mcu-coprocessor-have-nonvolatile-memory */ #define EEPROM_RETRAM_MODE /* 4kB is the same size as EEPROM size of ATMega2560. */ #ifndef EEPROM_RETRAM_MODE_SIZE #define EEPROM_RETRAM_MODE_SIZE ((uint32_t)(4*1024)) #endif /* RETRAM start address is 0x00000000 (retset entry) and end address is * 0x00020000 (64kB in total). The by default, ldscript.ld for STM32MP1xx * does not define address between 0x00000298 (end of ISR Vector) and 0x00020000. * So it is okay to use in this address range. Make sure ldscript.ld does not * overrap the following address range. */ #ifndef EEPROM_RETRAM_START_ADDRESS #define EEPROM_RETRAM_START_ADDRESS (0x00000400UL) #endif #define E2END (EEPROM_RETRAM_MODE_SIZE - 1) #else // defined(STM32MP1xx) #ifndef FLASH_PAGE_SIZE /* * FLASH_PAGE_SIZE is not defined for STM32F2xx, STM32F4xx and STM32F7xx * Could be redefined in variant.h or using build_opt.h * Warning: This is not the sector size, only the size used for EEPROM * emulation. Anyway, all the sector size will be erased. * So pay attention to not use this sector for other stuff. */ #define FLASH_PAGE_SIZE ((uint32_t)(16*1024)) /* 16kB page */ #endif // FLASH_PAGE_SIZE #if defined(DATA_EEPROM_BASE) || defined(FLASH_EEPROM_BASE) #if defined (DATA_EEPROM_END) #define E2END (DATA_EEPROM_END - DATA_EEPROM_BASE) #elif defined (DATA_EEPROM_BANK2_END) /* assuming two contiguous banks */ #define DATA_EEPROM_END DATA_EEPROM_BANK2_END #define E2END (DATA_EEPROM_BANK2_END - DATA_EEPROM_BASE) #elif defined (FLASH_EEPROM_END) #define DATA_EEPROM_BASE FLASH_EEPROM_BASE #define DATA_EEPROM_END FLASH_EEPROM_END #define E2END (DATA_EEPROM_END - DATA_EEPROM_BASE) #endif // defined (DATA_EEPROM_END) #else /* _EEPROM_BASE */ #define E2END (FLASH_PAGE_SIZE - 1) #endif // defined(DATA_EEPROM_BASE) || defined(FLASH_EEPROM_BASE) #endif // defined(STM32MP1xx) /* Exported macro ------------------------------------------------------------*/ /* Exported functions ------------------------------------------------------- */ uint8_t eeprom_read_byte(const uint32_t& pos); void eeprom_write_byte(const uint32_t& pos, const uint8_t& value); #if !defined(DATA_EEPROM_BASE) void eeprom_buffer_fill(); void eeprom_buffer_flush(); uint8_t eeprom_buffered_read_byte(const uint32_t& pos); void eeprom_buffered_write_byte(const uint32_t& pos, const uint8_t& value); #endif /* ! DATA_EEPROM_BASE */ #ifdef __cplusplus } #endif #endif /* __STM32_EEPROM_HPP */ /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/