Martin Johnson / STM32F3-Discovery

Dependents:   Space_Invaders_Demo neopixels gpio_test_stm32f3_discovery gpio_test_systimer ... more

Embed: (wiki syntax)

« Back to documentation index

WakeUp Timer configuration functions

WakeUp Timer configuration functions
[RTC_Private_Functions]

WakeUp Timer configuration functions. More...

Functions

void RTC_WakeUpClockConfig (uint32_t RTC_WakeUpClock)
 Configures the RTC Wakeup clock source.
void RTC_SetWakeUpCounter (uint32_t RTC_WakeUpCounter)
 Configures the RTC Wakeup counter.
uint32_t RTC_GetWakeUpCounter (void)
 Returns the RTC WakeUp timer counter value.
ErrorStatus RTC_WakeUpCmd (FunctionalState NewState)
 Enables or Disables the RTC WakeUp timer.

Detailed Description

WakeUp Timer configuration functions.

 ===============================================================================
                ##### WakeUp Timer configuration functions #####
 ===============================================================================  
    [..] This section provide functions allowing to program and read the RTC WakeUp.


Function Documentation

uint32_t RTC_GetWakeUpCounter ( void   )

Returns the RTC WakeUp timer counter value.

Parameters:
None
Return values:
TheRTC WakeUp Counter value.

Definition at line 1503 of file stm32f30x_rtc.c.

void RTC_SetWakeUpCounter ( uint32_t  RTC_WakeUpCounter )

Configures the RTC Wakeup counter.

Note:
The RTC WakeUp counter can only be written when the RTC WakeUp is disabled (Use the RTC_WakeUpCmd(DISABLE)).
Parameters:
RTC_WakeUpCounter,:specifies the WakeUp counter. This parameter can be a value from 0x0000 to 0xFFFF.
Return values:
None

Definition at line 1482 of file stm32f30x_rtc.c.

void RTC_WakeUpClockConfig ( uint32_t  RTC_WakeUpClock )

Configures the RTC Wakeup clock source.

Note:
The WakeUp Clock source can only be changed when the RTC WakeUp is disabled (Use the RTC_WakeUpCmd(DISABLE)).
Parameters:
RTC_WakeUpClock,:Wakeup Clock source. This parameter can be one of the following values:

  • RTC_WakeUpClock_RTCCLK_Div16: RTC Wakeup Counter Clock = RTCCLK/16
  • RTC_WakeUpClock_RTCCLK_Div8: RTC Wakeup Counter Clock = RTCCLK/8
  • RTC_WakeUpClock_RTCCLK_Div4: RTC Wakeup Counter Clock = RTCCLK/4
  • RTC_WakeUpClock_RTCCLK_Div2: RTC Wakeup Counter Clock = RTCCLK/2
  • RTC_WakeUpClock_CK_SPRE_16bits: RTC Wakeup Counter Clock = CK_SPRE
  • RTC_WakeUpClock_CK_SPRE_17bits: RTC Wakeup Counter Clock = CK_SPRE
Return values:
None

Definition at line 1455 of file stm32f30x_rtc.c.

ErrorStatus RTC_WakeUpCmd ( FunctionalState  NewState )

Enables or Disables the RTC WakeUp timer.

Parameters:
NewState,:new state of the WakeUp timer. This parameter can be: ENABLE or DISABLE.
Return values:
None

Definition at line 1515 of file stm32f30x_rtc.c.