tmk_core/common/chibios/eeprom_stm32.h

   1 /*
   2  * This software is experimental and a work in progress.
   3  * Under no circumstances should these files be used in relation to any critical system(s).
   4  * Use of these files is at your own risk.
   5  *
   6  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
   7  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
   8  * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
   9  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  10  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  11  * DEALINGS IN THE SOFTWARE.
  12  *
  13  * This files are free to use from http://engsta.com/stm32-flash-memory-eeprom-emulator/ by
  14  * Artur F.
  15  *
  16  * Modifications for QMK and STM32F303 by Yiancar
  17  *
  18  * This library assumes 8-bit data locations. To add a new MCU, please provide the flash
  19  * page size and the total flash size in Kb. The number of available pages must be a multiple
  20  * of 2. Only half of the pages account for the total EEPROM size.
  21  * This library also assumes that the pages are not used by the firmware.
  22  */
  23
  24 #ifndef __EEPROM_H
  25 #define __EEPROM_H
  26
  27 #include "ch.h"
  28 #include "hal.h"
  29 #include "flash_stm32.h"
  30
  31 // HACK ALERT. This definition may not match your processor
  32 // To Do. Work out correct value for EEPROM_PAGE_SIZE on the STM32F103CT6 etc
  33 #if defined(EEPROM_EMU_STM32F303xC)
  34   #define MCU_STM32F303CC
  35 #elif defined(EEPROM_EMU_STM32F103xB)
  36   #define MCU_STM32F103RB
  37 #elif defined(EEPROM_EMU_STM32F072xB)
  38   #define MCU_STM32F072CB
  39 #else
  40   #error "not implemented."
  41 #endif
  42
  43 #ifndef EEPROM_PAGE_SIZE
  44     #if defined (MCU_STM32F103RB)
  45         #define FEE_PAGE_SIZE    (uint16_t)0x400 // Page size = 1KByte
  46         #define FEE_DENSITY_PAGES          2     // How many pages are used
  47     #elif defined (MCU_STM32F103ZE) || defined (MCU_STM32F103RE) || defined (MCU_STM32F103RD) || defined (MCU_STM32F303CC) || defined(MCU_STM32F072CB)
  48         #define FEE_PAGE_SIZE    (uint16_t)0x800 // Page size = 2KByte
  49         #define FEE_DENSITY_PAGES          4     // How many pages are used
  50     #else
  51         #error  "No MCU type specified. Add something like -DMCU_STM32F103RB to your compiler arguments (probably in a Makefile)."
  52     #endif
  53 #endif
  54
  55 #ifndef EEPROM_START_ADDRESS
  56     #if defined (MCU_STM32F103RB) || defined(MCU_STM32F072CB)
  57         #define FEE_MCU_FLASH_SIZE  128     // Size in Kb
  58     #elif defined (MCU_STM32F103ZE) || defined (MCU_STM32F103RE)
  59         #define FEE_MCU_FLASH_SIZE  512     // Size in Kb
  60     #elif defined (MCU_STM32F103RD)
  61         #define FEE_MCU_FLASH_SIZE  384     // Size in Kb
  62     #elif defined (MCU_STM32F303CC)
  63         #define FEE_MCU_FLASH_SIZE  256     // Size in Kb
  64     #else
  65         #error  "No MCU type specified. Add something like -DMCU_STM32F103RB to your compiler arguments (probably in a Makefile)."
  66     #endif
  67 #endif
  68
  69 // DONT CHANGE
  70 // Choose location for the first EEPROM Page address on the top of flash
  71 #define FEE_PAGE_BASE_ADDRESS ((uint32_t)(0x8000000 + FEE_MCU_FLASH_SIZE * 1024 - FEE_DENSITY_PAGES * FEE_PAGE_SIZE))
  72 #define FEE_DENSITY_BYTES       ((FEE_PAGE_SIZE / 2) * FEE_DENSITY_PAGES - 1)
  73 #define FEE_LAST_PAGE_ADDRESS   (FEE_PAGE_BASE_ADDRESS + (FEE_PAGE_SIZE * FEE_DENSITY_PAGES))
  74 #define FEE_EMPTY_WORD          ((uint16_t)0xFFFF)
  75 #define FEE_ADDR_OFFSET(Address)(Address * 2) // 1Byte per Word will be saved to preserve Flash
  76
  77 // Use this function to initialize the functionality
  78 uint16_t EEPROM_Init(void);
  79 void EEPROM_Erase (void);
  80 uint16_t EEPROM_WriteDataByte (uint16_t Address, uint8_t DataByte);
  81 uint8_t EEPROM_ReadDataByte (uint16_t Address);
  82
  83 #endif  /* __EEPROM_H */