This library allows any user to use their Mbed project with a transient energy source( e.g. windturbine, solar power).

Dependencies:   mbed

Fork of Hibernus by Bogdan Lazarescu

This library allows any user to use their Mbed project with a transient energy source( e.g. windturbine, solar power). You can do this by simply import the "hibernus.h" header file, and call the "Hibernus()" method at the beginning of you main program. In case of a power loss the state of your programm will be saved to the nonvolatile memory and it will be resumed from the same point as soon as there is enough power for the board to run properly. If the power drops down, the internal capacitance of the system is used to save a snapshot of your program into the flash memory, and the board goes in a low power mode (sleep or deepsleep). In order to detect a power loss, the library uses an analog comparator which can be internal (eg Freescale KL 05Z has an internal comparator which can be used ), or external (on LPC11U24 there is no internal comparator) via a GPIO interrupt. For more details see the code comments and the attached example main.cpp file.

This library use "IAP" library, in order to write the required data to the flash nonvolatile memory.

The library can be easily adapted to work with other boards, from different manufactures, which have support for Mbed. In order to adapt this library and use it on your board, the write to flash methods have to be changed. Some changes listed below are required because of the platform dependent parameters of each board. All required changes have to be applied to the "config.h" and "config.cpp" files.

  • The "erase_flags_memory()", "copyRamToFlash()", "restore_flags()", "setFlag()" and " isFlagSet()" methods have to be modified in order to use the right Flash IAP of your board.
  • The wake up and hibernate interrupts have to be modified in order to be trigghered when the voltage drops down or rise. If you use an internal comparator, it should trigger and interrupt whenever the power drops(e.g see CMP0_IRQHandler() method writtend for KL05Z at https://developer.mbed.org/users/BogdanL/code/Hibernus-KL05Z/ ) . At that time a snapshot have to be saved and the board sent to sleep. Another interrupt have to be triggered when the power comes back(see "LLW_IRQHandler()" at https://developer.mbed.org/users/BogdanL/code/Hibernus-KL05Z ) . This have to wake up the board and resume de computation. In you use an external comparator two GPIO interrupts are used. One of them (for LPC11U24 see "FLEX_INT1_IRQHandler()" ) is used to save the snapshot when the power drops down, and the other one (for LPC11U24 see "FLEX_INT0_IRQHandler()" ) is used to wake up the board.
  • For each board, the right Sleep mode have to be chosen. Also the interrups and the comparator have to be properly set, in order to be triggered as desired. For a good example see "configure_VR_gpio_interrupt()" and "configure_VH_gpio_interrupt()" that are used to set up the Restore and Hibernate interrupts on LPC11U24 board, that uses an external comparator.
  • In the "config.h" file, the two arrays, "REG_Addresses_4B[]" and "REG_Addresses_4B[]" have to be populated with the addresses of the 1 Byte and 4Bytes peripheral registers that are used by your project. Different boards have different modules that use different peripheral registers. The addresses of the registers can be found in the Reference Manual of each board, and will be used in order to save and later restore the content of the registers. Also the number of used registers, "No_Of_4B_Peripheral_Reg", No_Of_1B_Peripheral_Reg, have to be updated with the correct number of used registers.
  • At the top of "config.h" header file, specific board parameters have to be fixed: RAM start address(RAM_1_Address), Flash start address(FLASH_Start), RAM size(RAM_Size), Flash size(flash_Size) and the flash sector size(sector_Size).
Committer:
BogdanL
Date:
Fri Sep 08 18:01:22 2017 +0000
Revision:
0:f9a13d4b41f3
First Version of Hibernus Library;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
BogdanL 0:f9a13d4b41f3 1 /** Hibernus Library
BogdanL 0:f9a13d4b41f3 2 * University of Southampton 2017
BogdanL 0:f9a13d4b41f3 3 *
BogdanL 0:f9a13d4b41f3 4 * Open-source liberary that enable any of your Mbed project work with transient enegy sources.
BogdanL 0:f9a13d4b41f3 5 * In order to use this library include the "hibernus.h" header file, and use the "Hibernus()" method at the beginning of you main funtion.
BogdanL 0:f9a13d4b41f3 6 * For more details and example see the "main.cpp" exampe file, and the attached documnetation
BogdanL 0:f9a13d4b41f3 7 *
BogdanL 0:f9a13d4b41f3 8 *
BogdanL 0:f9a13d4b41f3 9 * Released under the MIT License: http://mbed.org/license/mit
BogdanL 0:f9a13d4b41f3 10 */
BogdanL 0:f9a13d4b41f3 11 #ifndef HIBERNUS_H_
BogdanL 0:f9a13d4b41f3 12 #define HIBERNUS_H_
BogdanL 0:f9a13d4b41f3 13
BogdanL 0:f9a13d4b41f3 14 #define Fixed_Add_Vars_Offset 0x40 //the Offset added to the first address of RAM, in order to compute the address of first fixed Add variable
BogdanL 0:f9a13d4b41f3 15 #define Fixed_Add_Vars_Size 0x28 //size of the all fixed address variables (0x28 = 44(dec) = 4Bytes*(4 flags+3CoreReg+4LoopVar))
BogdanL 0:f9a13d4b41f3 16 #define flash_end (FLASH_Start + flash_Size)
BogdanL 0:f9a13d4b41f3 17 #define ramToFlash_sectors_number (RAM_Size / sector_Size) //how many flash sectors do we have to erase, before saving the RAM content to flash
BogdanL 0:f9a13d4b41f3 18 #define flash_ramSection_start (flash_end - RAM_Size-SaveFlagsInFlash *sector_Size)
BogdanL 0:f9a13d4b41f3 19
BogdanL 0:f9a13d4b41f3 20 // Declare register integers for the SP, LR, and PC
BogdanL 0:f9a13d4b41f3 21 register volatile unsigned int _SP __asm("r13");
BogdanL 0:f9a13d4b41f3 22 register volatile unsigned int _LR __asm("r14");
BogdanL 0:f9a13d4b41f3 23 register volatile unsigned int _PC __asm("r15");
BogdanL 0:f9a13d4b41f3 24
BogdanL 0:f9a13d4b41f3 25 // Value written to non-volatile flags to indicate that they are set or not
BogdanL 0:f9a13d4b41f3 26 #define Flag_set 0xFFFF0000
BogdanL 0:f9a13d4b41f3 27 #define Flag_erase 0xFFFFFFFF
BogdanL 0:f9a13d4b41f3 28
BogdanL 0:f9a13d4b41f3 29 // Declare external assembly language function (in a *.s file)
BogdanL 0:f9a13d4b41f3 30 extern "C" void asm_restore(void);
BogdanL 0:f9a13d4b41f3 31 extern "C" volatile unsigned int* getFlag_1(void);
BogdanL 0:f9a13d4b41f3 32 extern "C" volatile unsigned int* getFlag_2(void);
BogdanL 0:f9a13d4b41f3 33 extern "C" volatile unsigned int* getFlag_3(void);
BogdanL 0:f9a13d4b41f3 34 extern "C" volatile unsigned int* getFlag_4(void);
BogdanL 0:f9a13d4b41f3 35
BogdanL 0:f9a13d4b41f3 36 void Hibernus(void);
BogdanL 0:f9a13d4b41f3 37 void Save_RAM_Regs(void);
BogdanL 0:f9a13d4b41f3 38 void Restore_Regs(void);
BogdanL 0:f9a13d4b41f3 39 void restore(void);
BogdanL 0:f9a13d4b41f3 40 void hibernate(volatile unsigned int sp, volatile unsigned int lr, volatile unsigned int pc);
BogdanL 0:f9a13d4b41f3 41 void recovery_no_power_loss(void);
BogdanL 0:f9a13d4b41f3 42
BogdanL 0:f9a13d4b41f3 43 #endif