LowPower.h

Go to the documentation of this file.

/*
 *  LowPower.h - Spresense Arduino Low Power library
 *  Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef _LOW_POWER_H_
#define _LOW_POWER_H_
 
#ifdef SUBCORE
#error "LowPower library is NOT supported by SubCore."
#endif
 
#include <Arduino.h>
#include <arch/chip/pm.h>
 
typedef enum {
  POR_SUPPLY      = 0,  
  WDT_REBOOT      = 1,  
  WDT_RESET       = 2,  
  DEEP_WKUPL      = 3,  
  DEEP_WKUPS      = 4,  
  DEEP_RTC        = 5,  
  DEEP_USB_ATTACH = 6,  
  DEEP_OTHERS     = 7,  
  COLD_SCU_INT    = 8,  
  COLD_RTC_ALM0   = 9,  
  COLD_RTC_ALM1   = 10, 
  COLD_RTC_ALM2   = 11, 
  COLD_RTC_ALMERR = 12, 
  COLD_GPIO_IRQ36 = 16, 
  COLD_GPIO_IRQ37 = 17, 
  COLD_GPIO_IRQ38 = 18, 
  COLD_GPIO_IRQ39 = 19, 
  COLD_GPIO_IRQ40 = 20, 
  COLD_GPIO_IRQ41 = 21, 
  COLD_GPIO_IRQ42 = 22, 
  COLD_GPIO_IRQ43 = 23, 
  COLD_GPIO_IRQ44 = 24, 
  COLD_GPIO_IRQ45 = 25, 
  COLD_GPIO_IRQ46 = 26, 
  COLD_GPIO_IRQ47 = 27, 
  COLD_SEN_INT    = 28, 
  COLD_PMIC_INT   = 29, 
  COLD_USB_DETACH = 30, 
  COLD_USB_ATTACH = 31, 
  POR_NORMAL      = 32, 
} bootcause_e;
 
typedef enum {
  CLOCK_MODE_156MHz = 0, 
  CLOCK_MODE_32MHz  = 1, 
  CLOCK_MODE_8MHz   = 2, 
} clockmode_e;
 
class LowPowerClass
{
public:
 
  LowPowerClass() : isInitialized(false), isEnabledDVFS(false) {
    hvlock.count = 0;
    hvlock.info = PM_CPUFREQLOCK_TAG('L', 'P', 0);
    hvlock.flag = PM_CPUFREQLOCK_FLAG_HV;
 
    lvlock.count = 0;
    lvlock.info = PM_CPUFREQLOCK_TAG('L', 'P', 1);
    lvlock.flag = PM_CPUFREQLOCK_FLAG_LV;
  }
 
  void begin();
 
  void end();
 
  void sleep(uint32_t seconds);
 
  void coldSleep();
 
  void coldSleep(uint32_t seconds);
 
  void deepSleep();
 
  void deepSleep(uint32_t seconds);
 
  void reboot();
 
  bootcause_e bootCause();
 
  bool isEnabledBootCause(bootcause_e bc);
 
  bool isEnabledBootCause(uint8_t pin);
 
  void enableBootCause(bootcause_e bc);
 
  void enableBootCause(uint8_t pin);
 
  void disableBootCause(bootcause_e bc);
 
  void disableBootCause(uint8_t pin);
 
  uint8_t getWakeupPin(bootcause_e bc);
 
  void clockMode(clockmode_e mode);
 
  clockmode_e getClockMode();
 
  int getVoltage(void);
 
  int getCurrent(void);
 
private:
  bootcause_e pin2bootcause(uint8_t pin);
  bool isInitialized;
  bool isEnabledDVFS;
  struct pm_cpu_freqlock_s hvlock;
  struct pm_cpu_freqlock_s lvlock;
};
 
extern LowPowerClass LowPower;
 
#endif