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

Dependencies:   IAP mbed

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).

config.cpp

Committer:
BogdanL
Date:
2017-09-01
Revision:
0:697a3b20c1d1

File content as of revision 0:697a3b20c1d1:

/**    Hibernus Library
 *	   University of Southampton 2017
 *
 *		Open-source liberary that enable any of your Mbed project work with transient enegy sources.
 *		In order to use this library include the "hibernus.h" header file, and use the "Hibernus()" method at the beginning of you main funtion.
 *		For more details and example see the "main.cpp" exampe file, and the attached documnetation
 *
 *
 *     Released under the MIT License: http://mbed.org/license/mit
 */
#include "config.h"
#include "hibernus.h"

IAP iap;
Serial pc1(USBTX, USBRX);

void Enter_LLS(){
	configure_VR_gpio_interrupt();
	
	LPC_PMU->PCON |= 0x1;
	LPC_SYSCON->PINTSEL[0] = 0x02;												//configure pin P0_2 as interupt source 
	LPC_SYSCON->PDRUNCFG &= ~(1<<1);
	LPC_SYSCON->STARTERP0 |= (1<<0);											//Config chanel as wake up interrupt
	LPC_SYSCON->PDAWAKECFG &= ~((1<<0)|(1<<1)|(1<<2)|(1<<5)|(1<<7));	//wake up all needed modules after recovering from deepslep mode
	NVIC_SetPriority(FLEX_INT0_IRQn,0);
	NVIC_EnableIRQ(FLEX_INT0_IRQn);
	NVIC_SetPriority(FLEX_INT0_IRQn,0);
	
	//Go to deep Sleep mode ---->
	SCB->SCR |= SCB_SCR_SLEEPDEEP_Msk;										//choose Deep Sleep as power mode
	__WFI();    																					// Stop executing instructions and enter Deep Sleep mode
}

//if there is no internal Coomparator define 2 GPIO interrupts to wake up and sleep

void configure_VR_gpio_interrupt(){
	LPC_GPIO->DIR[0] |= 1<<2;										//set pin P0_2 as input	//generate interrupt for VR

	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<6);	
	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<16);
	LPC_IOCON->PIO0_2 = (0x0|(0x2<<3));					//enable pullup
	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<19); 			//System enable peripheral clock		
	LPC_SYSCON->PINTSEL[0] = 0x2;								//configure interrupt chanel for the GPIO pin is syscon block

	LPC_GPIO_PIN_INT->ISEL &= ~(1<<0);					//set the interrupt mode for the pin0 to be Level Sensitive
	LPC_GPIO_PIN_INT->IENF |= (1<<0);						//enable the level sensitive interrupt on pin P0_2
		
	LPC_SYSCON->STARTERP0 |= (1<<0);						//config chanel as wake up interrupt is Syscon block
		
	__enable_irq();
	NVIC_EnableIRQ(FLEX_INT0_IRQn);
	NVIC_SetPriority(FLEX_INT0_IRQn,0);					//Set a higher prioroty for wake up interrupt, to be able to interrupt the sleep interrupt
}

void configure_VH_gpio_interrupt(){
	LPC_GPIO->DIR[0] |= 1<<8;										//set pin P0_8 as input //generate interrupt for VH
	
	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<6);	
	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<16);
	LPC_IOCON->PIO0_8 = (0x0|(0x2<<3));					//choose first pin function and enable pullup
	LPC_SYSCON->SYSAHBCLKCTRL |= (1<<19); 			//System enable peripheral clock		
	LPC_SYSCON->PINTSEL[1] = (uint32_t)8;				//configure interrupt chanel for the GPIO pin is syscon block
	
	LPC_GPIO_PIN_INT->ISEL &= ~(1<<1);					//set the interrupt mode for the pin1 to be Level Sensitive
	LPC_GPIO_PIN_INT->IENF |= (1<<1);						//enable the level sensitive interrupt on pin P0_8
	
	__enable_irq();
	NVIC_EnableIRQ(FLEX_INT1_IRQn);
	NVIC_SetPriority(FLEX_INT1_IRQn,2);					//Set a lower priority for the sleep interrupt, in order to be possible for the wake up interrupt to interrupt it
}

//the interrupt triggered by the GPIO/INternal Comparator where the snapshot is saved
extern "C" void FLEX_INT1_IRQHandler(){   //To make sure the compiler sees handler, need to declare it as extern (https://developer.mbed.org/forum/mbed/topic/419/?page=1#comment-2126)
	pc1.printf(" ",isFlagSet(getFlag_1()),isFlagSet(getFlag_2()),isFlagSet(getFlag_3()),isFlagSet(getFlag_4())); 

  if(isFlagSet(getFlag_2())&& isFlagSet(getFlag_3()) && isFlagSet(getFlag_4()))  // Enter this only after complete shut down
	{
    erase_flags_memory();	
		setFlag(getFlag_1());
		setFlag(getFlag_4());
   }
		if(isFlagSet(getFlag_2()))
    { // Hibernate procedure           
      __disable_irq();
			
      unsigned int regs = *(unsigned int*)(_SP+0x1C);
			volatile unsigned int sp1=(_SP+0x40), lr1= *(unsigned int*)(_SP+0x34), pc1=*(unsigned int*)(_SP+0x38);
			// Save previous SP value from main // 0x40 for hibernate function 38 otherwsie
      *getCore_SP() = sp1;                        
    
      // Save previous LR value from main// 34 for hibernate function 2C otherwise
			*getCore_LR() = lr1;
			
      // Save previous PC value from main // 38 for hibernate function 30 otherwise
			*getCore_PC() = pc1;

			setFlag(getFlag_3());
			setFlag(getFlag_4());
			
      Save_RAM_Regs();
			
			configure_VR_gpio_interrupt();
			
			__enable_irq();
			
      Enter_LLS();        // Enter LLS mode
    }
		
		//clear interupt status register
		LPC_GPIO_PIN_INT->IST |=((1<<0)|(1<<1));
		//delete any sleep interupts that came during the sleep
		NVIC_ClearPendingIRQ(FLEX_INT1_IRQn);
}

//ISR for wakeing up the core and seting the interrupt for Hibernate procedure 
extern "C" void FLEX_INT0_IRQHandler(){   //To make sure the compiler sees handler, need to declare it as extern (https://developer.mbed.org/forum/mbed/topic/419/?page=1#comment-2126)
	NVIC_ClearPendingIRQ(FLEX_INT0_IRQn);
	if(isFlagSet(getFlag_3()))   // Enter after hibernation with no power loss
  {
		configure_VH_gpio_interrupt();
		erase_flags_memory();   
		setFlag(getFlag_2());
    __enable_irq();     // Enable interrupts
  }
	
	//clear interupt status register
	LPC_GPIO_PIN_INT->IST |= (1<<0);
}

//used to restore the flags values from Flash to RAM
void restore_flags(){
	if(!SaveFlagsInFlash){
		*getFlag_1() = *(unsigned int*)(flash_ramSection_start+Fixed_Add_Vars_Offset);
		*getFlag_2() = *(unsigned int*)(flash_ramSection_start+Fixed_Add_Vars_Offset+0x4);
		*getFlag_3() = *(unsigned int*)(flash_ramSection_start+Fixed_Add_Vars_Offset+0x8);
		*getFlag_4() = *(unsigned int*)(flash_ramSection_start+Fixed_Add_Vars_Offset+0xC);
	}
}

//copy the whole content of RAM into the flash
void copyRamToFlash(){
	// Erase flash sectors o save the RAM content
	int g3=iap.prepare(6,7);
	int g4=iap.erase(6,7);
	
  // Copy all the RAM to flash
  int g0 = iap.prepare(6,7);
	int g1=iap.write((char*)RAM_1_Address,(char*)flash_ramSection_start,RAM_Size/2);
			g1+=iap.write((char*)RAM_1_Address+(RAM_Size/2),(char*)flash_ramSection_start+(RAM_Size/2),(RAM_Size/2));
}

//Clear the memory area where the flags are saved
void erase_flags_memory(){
	if(!SaveFlagsInFlash) {
    *getFlag_1() = Flag_erase;
    *getFlag_2() = Flag_erase;
    *getFlag_3() = Flag_erase;
    *getFlag_4() = Flag_erase;
	}
}

//mark a flag as "SET"
void setFlag(volatile unsigned int* add){
	*add = Flag_set;
}

//check if a flag is SET or CLEAR
bool isFlagSet(volatile unsigned int* add){
	if(*add == Flag_set ) return true;
	return false;
}