DolphinV4 API  1.6.1.0
Power structures and constants
Collaboration diagram for Power structures and constants:

Macros

#define SEC   1000000
 Time unit 'second' measured in microseconds.
#define MSEC   1000
 Time unit 'millisecond' measured in microseconds.
#define USEC   1
 Time unit 'microsecond' measured in microseconds.
#define SHORT_TERM_CALIB_CONST   2048
 Shortterm calibration constant - it is used to avoid using floating point value for shortterm calibration.
#define WATCHDOG_CALIB_CONST   2048
 Watchdog calibration constant - it is used to avoid using floating point value for watchdog calibration.

Enumerations

enum  SLEEP_TIMER_TYPE { WATCHDOG_TIMER = 0, FLYWHEEL_TIMER, SHORT_TERM_TIMER }
 Low power timers. More...
enum  SLEEP_TIMER_CLK_TYPE { WATCHDOG_CLK = (10000 * USEC), FLYWHEEL_CLK = (976 * USEC), SHORT_TERM_CLK = (10 * USEC) }
 Low power timers clock period (includes post scaler) used for CONV_COUNTER_TO_TIME and CONV_TIME_TO_COUNTER macros. More...
enum  SHORT_TERM_TYPE { SHORT_TERM_CONT = 0, SHORT_TERM_ONE }
 Short term timer modes. More...
enum  RESET_TYPE { VDD_RESET = 0, PIN_RESET, WATCHDOG_RESET, FLYWHEEL_RESET, BIST_RESET, PARITY_RESET, ADDRESS_RESET, WAKE_PIN0_RESET, WAKE_PIN1_RESET, NO_RESET_DETECTED }
 Reset causes. More...
enum  WAKE_TYPE { PIN_WAKE0_WAKE = 0, PIN_WAKE1_WAKE, SHORT_TERM_WAKE, RX_RADIO_TEL_WAKE, TX_RADIO_TEL_WAKE, PIN_EXT_WAKE, TIMER0_WAKE, VDD_FAIL, NOT_VALID_WAKEUP, RX_RADIO_ERROR_WAKE }
 Make sure to read the chapter Wakeup, Reset Sources. More...
enum  WAKE_CFG_TYPE { NO_WAKE_FLAG = 0x0, WAKE0_PIN_CFG_WAKE_FLAG = 0x1, WAKE1_PIN_CFG_WAKE_FLAG = 0x2, TIMER0_WAKE_FLAG = 0x4 }
 Configuration flags for external events that wake the CPU from sleep. Make sure to read Wakeup, Reset Sources. More...
enum  XTAL_DIVIDER_TYPE { DEFAULT_DELAY = 0x3, SECOND_SUBTEL_DELAY = 0x5 }
 Divider type of XTAL stable delay. More...

Detailed Description

Structures that are used in POWER module


Enumeration Type Documentation

Low power timers.

Enumerator:
WATCHDOG_TIMER 

WatchdogTimer

FLYWHEEL_TIMER 

FlywheelTimer

SHORT_TERM_TIMER 

ShortTermTimer

Low power timers clock period (includes post scaler) used for CONV_COUNTER_TO_TIME and CONV_TIME_TO_COUNTER macros.

Enumerator:
WATCHDOG_CLK 

WDT timer counter incremented every 10ms. For more information see SLEEP_TIMER_TYPE.

FLYWHEEL_CLK 

Flywheel timer counter incremented every ~1 ms (1/1024s). For more information see SLEEP_TIMER_TYPE.

SHORT_TERM_CLK 

Short term timer counter incremented every 10 us. For more information see SLEEP_TIMER_TYPE.

Short term timer modes.

Enumerator:
SHORT_TERM_CONT 

Continuous mode: the timer counter restarts when reaching the period value.

SHORT_TERM_ONE 

One shoot mode: the timer counter stops when reaching the period value.

enum RESET_TYPE

Reset causes.

Enumerator:
VDD_RESET 

PowerOnReset queried using pwr_getSystemReset function

PIN_RESET 

PinReset (is set also after downloading the program with the programmer)

WATCHDOG_RESET 

WatchdogReset

FLYWHEEL_RESET 

FlywheelReset

BIST_RESET 

Parity error.

PARITY_RESET 

HW Parity error in the Internal or External Memory.

ADDRESS_RESET 

A memory request from the CPU core does not correspond to any valid memory location. This error may be caused by a S/W malfunction.

WAKE_PIN0_RESET 

Wake-up pin 0 activated.

WAKE_PIN1_RESET 

Wake-up pin 1 activated.

NO_RESET_DETECTED 

Unknown reset source - reset reason couldn't be detected.

enum WAKE_TYPE

Make sure to read the chapter Wakeup, Reset Sources.

Enumerator:
PIN_WAKE0_WAKE 

Wake-up pin 0 was activated.

PIN_WAKE1_WAKE 

Wake-up pin 1 was activated.

SHORT_TERM_WAKE 

Short-term timer counter reach period.

RX_RADIO_TEL_WAKE 

Radio telegram received.

TX_RADIO_TEL_WAKE 

Radio telegram transmission finished.

PIN_EXT_WAKE 

External pin activated.

TIMER0_WAKE 

Timer0 scheduler interrupt.

VDD_FAIL 

VDDFAIL interrupt - VDD crossed the VON threshold interrupt.

NOT_VALID_WAKEUP 

Wake-up source is unknown.

RX_RADIO_ERROR_WAKE 

Wake up by radio RX error.

Configuration flags for external events that wake the CPU from sleep. Make sure to read Wakeup, Reset Sources.

Enumerator:
NO_WAKE_FLAG 

Don't use any of the listed wake events.

WAKE0_PIN_CFG_WAKE_FLAG 

The wake0 pin event wakes the CPU from standby.

WAKE1_PIN_CFG_WAKE_FLAG 

The wake1 pin event wakes the CPU from standby.

TIMER0_WAKE_FLAG 

The scheduler (timer0) event wakes the CPU from standby.

Divider type of XTAL stable delay.

Enumerator:
DEFAULT_DELAY 

2.50 ms

SECOND_SUBTEL_DELAY 

0.64