5.23 RTC Guide

name    RTC_DeInit.
fun     Deinitializes the RTC registers to their default reset values.
param   none
return  ErrorStatus
            - SUCCESS: RTC registers are deinitialized
            - ERROR: RTC registers are not deinitialized

name    RTC_Init.
fun     RTC_InitStruct pointer to a RTC_InitType structure that contains
        the configuration information for the RTC peripheral
param   RTC_InitStruct
            - RTC_HourFormat
                - RTC_24HOUR_FORMAT
                - RTC_12HOUR_FORMAT
            - RTC_AsynchPrediv  the value must lower than 0x7F
            - RTC_SynchPrediv   the value must lower than 0x7FFF
return  ErrorStatus
            - SUCCESS: RTC registers are deinitialized
            - ERROR: RTC registers are not deinitialized

name    RTC_StructInit.
fun     Fills each RTC_InitStruct member with its default value.
param   RTC_InitStruct :    RTC_InitStruct pointer to a RTC_InitType structure which will beinitialized.
            - RTC_HourFormat
                - RTC_24HOUR_FORMAT
                - RTC_12HOUR_FORMAT
            - RTC_AsynchPrediv  the value must lower than 0x7F
            - RTC_SynchPrediv   the value must lower than 0x7FFF
return  none

name    RTC_EnableWriteProtection.
fun     Enable or disable the RTC registers write protection.
param  Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_EnterInitMode.
fun     Enters the RTC Initialization mode.
param   none
return   ErrorStatus
            - SUCCESS: RTC is in Init mode
            - ERROR: RTC is not in Init mode

name    RTC_ExitInitMode.
fun     When the initialization sequence is complete, the calendar restarts counting after 4 RTCCLK cycles.
param   none
return  none

name    RTC_WaitForSynchro.
fun     Waits until the RTC Time and Date registers (RTC_TSH and RTC_DATE) are synchronized with RTC APB clock.
param   none
return  ErrorStatus :
            - SUCCESS:  RTC registers are synchronised
            - ERROR:    RTC registers are not synchronised

name    RTC_EnableRefClock.
fun     Enables or disables the RTC reference clock detection.
param  Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_EnableBypassShadow.
fun     When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter
param  Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_TimeStructInit.
fun     Fills each RTC_TimeStruct member with its default value
        (Time = 00h:00 min:00sec).
param   RTC_TimeStruct : RTC_TimeStruct pointer to a RTC_TimeType structure that contains
                         the time configuration information for the RTC.
            - Hours
                - if RTC_AM_H12 is select the value in the 0-23 range
                - if RTC_PM_H12 is select the value in the 1-12 range
            - Minutes  the value set in the 0-59 range
            - Seconds  the value set in the 0-59 range
            - H12
                - RTC_AM_H12
                - RTC_PM_H12
return  none

name    RTC_ConfigTime.
fun     Calendar value read from Shadow register.
param  RTC_Format :
          - RTC_FORMAT_BIN
          - RTC_FORMAT_BCD
param   RTC_TimeStruct : RTC_TimeStruct pointer to a RTC_TimeType structure that contains
        the time configuration information for the RTC.When the user does not need to configure this
        parameter, note that NULL can be passed in.
            - Hours
                - if RTC_AM_H12 is select the value in the 0-23 range
                - if RTC_PM_H12 is select the value in the 1-12 range
            - Minutes  the value set in the 0-59 range
            - Seconds  the value set in the 0-59 range
            - H12
                - RTC_AM_H12
                - RTC_PM_H12
return  none

name    RTC_GetTime.
fun     Get the RTC current Time.
param   RTC_Format : specifies the format of the returned parameters.
            - RTC_FORMAT_BIN
            - RTC_FORMAT_BCD
param   RTC_TimeStruct : RTC_TimeStruct pointer to a RTC_TimeType structure.
return  none

name    RTC_GetSubSecond.
fun     Gets the RTC current Calendar Subseconds value.
return  RTC current Calendar Subseconds value.

name    RTC_DateStructInit.
fun     Fills each RTC_DateStruct member with its default value (Monday, January 01 xx00).
param   RTC_DateStruct : RTC_DateStruct pointer to a RTC_DateType structure that contains
                       the date configuration information for the RTC.
            - WeekDay
                - RTC_WEEKDAY_MONDAY
                - RTC_WEEKDAY_TUESDAY
                - RTC_WEEKDAY_WEDNESDAY
                - RTC_WEEKDAY_THURSDAY
                - RTC_WEEKDAY_FRIDAY
                - RTC_WEEKDAY_SATURDAY
                - RTC_WEEKDAY_SUNDAY
            - Month
                - RTC_MONTH_JANUARY
                - RTC_MONTH_FEBRURY
                - RTC_MONTH_MARCH
                - RTC_MONTH_APRIL
                - RTC_MONTH_MAY
                - RTC_MONTH_JUNE
                - RTC_MONTH_JULY
                - RTC_MONTH_AUGUST
                - RTC_MONTH_SEPTEMBER
                - RTC_MONTH_OCTOBER
                - RTC_MONTH_NOVEMBER
                - RTC_MONTH_DECEMBER
            - Date    the value in the 1-31 range
            - Year    the value in the 0-99 range
return  none

name    RTC_SetDate.
fun     Set RTC Calendar current date.
param   RTC_Format : specifies the format of the returned parameters.
          - RTC_FORMAT_BIN
          - RTC_FORMAT_BCD
param   RTC_DateStruct : RTC_DateStruct pointer to a RTC_DateType structure that contains
        the date configuration information for the RTC,note that NULL can be passed in.
            - WeekDay
                - RTC_WEEKDAY_MONDAY
                - RTC_WEEKDAY_TUESDAY
                - RTC_WEEKDAY_WEDNESDAY
                - RTC_WEEKDAY_THURSDAY
                - RTC_WEEKDAY_FRIDAY
                - RTC_WEEKDAY_SATURDAY
                - RTC_WEEKDAY_SUNDAY
            - Month
                - RTC_MONTH_JANUARY
                - RTC_MONTH_FEBRURY
                - RTC_MONTH_MARCH
                - RTC_MONTH_APRIL
                - RTC_MONTH_MAY
                - RTC_MONTH_JUNE
                - RTC_MONTH_JULY
                - RTC_MONTH_AUGUST
                - RTC_MONTH_SEPTEMBER
                - RTC_MONTH_OCTOBER
                - RTC_MONTH_NOVEMBER
                - RTC_MONTH_DECEMBER
            - Date    the value in the 1-31 range
            - Year    the value in the 0-99 range
return  ErrorStatus
            - SUCCESS:  RTC Date register is configured
            - ERROR:    RTCDate register is not configured

name    RTC_GetDate.
fun     Get the RTC current date.
param   RTC_Format : specifies the format of the returned parameters.
            - RTC_FORMAT_BIN
            - RTC_FORMAT_BCD
param   RTC_DateType : RTC_DateStruct pointer to a RTC_DateType structure that will
                       contain the returned current date configuration.
return  none

name    RTC_ConfigOutputType
fun     Configures the RTC Output Pin mode.
param   RTC_OutputType : specifies the RTC Output (PC13) pin mode.
            - RTC_OUTPUT_OPENDRAIN : RTC Output (PC13) is configured in  Open Drain mode.
            - RTC_OUTPUT_PUSHPULL : RTC Output (PC13) is configured in Push Pull mode.
return  none

name    RTC_SetAlarm.
fun     Set the specified RTC Alarm.
param   RTC_Format : specifies the format of the returned parameters.
            - RTC_FORMAT_BIN
            - RTC_FORMAT_BCD
param   RTC_Alarm : RTC_Alarm specifies the alarm to be configured.
            - RTC_A_ALARM
            - RTC_B_ALARM
param   RTC_AlarmStruct : RTC_AlarmStruct pointer to a RTC_AlarmType structure that
                          contains the alarm configuration parameters.
            - AlarmTime   RTC_TimeStruct pointer to a RTC_TimeType structure that contains
                         the time configuration information for the RTC.
            - Hours
                - if RTC_AM_H12 is select the value in the 0-23 range
                - if RTC_PM_H12 is select the value in the 1-12 range
            - Minutes  the value set in the 0-59 range
            - Seconds  the value set in the 0-59 range
            - H12
                - RTC_AM_H12
                - RTC_PM_H12
            - AlarmMask
                - RTC_ALARMMASK_NONE
                - RTC_ALARMMASK_WEEKDAY
                - RTC_ALARMMASK_HOURS
                - RTC_ALARMMASK_MINUTES
                - RTC_ALARMMASK_SECONDS
                - RTC_ALARMMASK_ALL
            - DateWeekMode
                - RTC_ALARM_SEL_WEEKDAY_DATE
                - RTC_ALARM_SEL_WEEKDAY_WEEKDAY
            - DateWeekValue
                - RTC_WEEKDAY_MONDAY
                - RTC_WEEKDAY_TUESDAY
                - RTC_WEEKDAY_WEDNESDAY
                - RTC_WEEKDAY_THURSDAY
                - RTC_WEEKDAY_FRIDAY
                - RTC_WEEKDAY_SATURDAY
                - RTC_WEEKDAY_SUNDAY
return  none

name    RTC_AlarmStructInit.
fun     Fills each RTC_AlarmStruct member with its default value
        (Time = 00h:00mn:00sec / Date = 1st day of the month/Mask =
        all fields are masked).
param   RTC_AlarmStruct : RTC_AlarmStruct pointer to a RTC_AlarmType structure that
                          contains the alarm configuration parameters.
            - AlarmTime   RTC_TimeStruct pointer to a RTC_TimeType structure that contains
                         the time configuration information for the RTC.
            - Hours
                - if RTC_AM_H12 is select the value in the 0-23 range
                - if RTC_PM_H12 is select the value in the 1-12 range
            - Minutes  the value set in the 0-59 range
            - Seconds  the value set in the 0-59 range
            - H12
                - RTC_AM_H12
                - RTC_PM_H12
            - AlarmMask
                - RTC_ALARMMASK_NONE
                - RTC_ALARMMASK_WEEKDAY
                - RTC_ALARMMASK_HOURS
                - RTC_ALARMMASK_MINUTES
                - RTC_ALARMMASK_SECONDS
                - RTC_ALARMMASK_ALL
            - DateWeekMode
                - RTC_ALARM_SEL_WEEKDAY_DATE
                - RTC_ALARM_SEL_WEEKDAY_WEEKDAY
            - DateWeekValue
                - RTC_WEEKDAY_MONDAY
                - RTC_WEEKDAY_TUESDAY
                - RTC_WEEKDAY_WEDNESDAY
                - RTC_WEEKDAY_THURSDAY
                - RTC_WEEKDAY_FRIDAY
                - RTC_WEEKDAY_SATURDAY
                - RTC_WEEKDAY_SUNDAY
return  none

name    RTC_GetAlarm.
fun     Get the RTC Alarm value and masks.
param   RTC_Format : specifies the format of the output parameters.
            - RTC_FORMAT_BIN
            - RTC_FORMAT_BCD
param   RTC_Alarm : specifies the alarm to be read.
            - RTC_A_ALARM
            - RTC_B_ALARM
param   RTC_AlarmStruct : pointer to a RTC_AlarmType structure that will
        contains the output alarm configuration values.

return  none

name    RTC_EnableAlarm.
fun     Enables or disables the specified RTC Alarm.
param   RTC_Alarm : specifies the alarm to be configured.
            - RTC_A_ALARM
            - RTC_B_ALARM
param  Cmd :
          - ENABLE
          - DISABLE
return  ErrorStatus :
            - SUCCESS: RTC Alarm set succeed
            - ERROR:   RTC Alarm set failed

name    RTC_ConfigAlarmSubSecond.
fun     Configure the RTC AlarmA/B Subseconds value and mask
param   RTC_Alarm : specifies the alarm to be configured.
            - RTC_A_ALARM : select Alarm A.
            - RTC_B_ALARM : select Alarm B.
param   RTC_AlarmSubSecondValue : specifies the Subseconds value, the value in the 0-0x00007FFF range
param   RTC_AlarmSubSecondMask : specifies the Subseconds Mask.
            - RTC_SUBS_MASK_ALL     : Alarm SS fields are masked There is no comparison on sub seconds for Alarm.
            - RTC_SUBS_MASK_SS14_1  : SS[14:1] are don't care in Alarm comparison Only SS[0] is compared
            - RTC_SUBS_MASK_SS14_2  : SS[14:2] are don't care in Alarm comparison Only SS[1:0] are compared
            - RTC_SUBS_MASK_SS14_3  : SS[14:3] are don't care in Alarm comparison Only SS[2:0] are compared
            - RTC_SUBS_MASK_SS14_4  : SS[14:4] are don't care in Alarm comparison Only SS[3:0] are compared
            - RTC_SUBS_MASK_SS14_5  : SS[14:5] are don't care in Alarm comparison Only SS[4:0] are compared
            - RTC_SUBS_MASK_SS14_6  : SS[14:6] are don't care in Alarm comparison Only SS[5:0] are compared
            - RTC_SUBS_MASK_SS14_7  : SS[14:7] are don't care in Alarm comparison Only SS[6:0] are compared
            - RTC_SUBS_MASK_SS14_8  : SS[14:8] are don't care in Alarm comparison Only SS[7:0] are compared
            - RTC_SUBS_MASK_SS14_9  : SS[14:9] are don't care in Alarm comparison Only SS[8:0] are compared
            - RTC_SUBS_MASK_SS14_10 : SS[14:10] are don't care in Alarm comparison Only SS[9:0] are compared
            - RTC_SUBS_MASK_SS14_11 : SS[14:11] are don't care in Alarm comparison Only SS[10:0] are compared
            - RTC_SUBS_MASK_SS14_12 : SS[14:12] are don't care in Alarm comparison Only SS[11:0] are compared
            - RTC_SUBS_MASK_SS14_13 : SS[14:13] are don't care in Alarm comparison Only SS[12:0] are compared
            - RTC_SUBS_MASK_SS14_14 : SS[14] is don't care in Alarm comparison Only SS[13:0] are compared.
            - RTC_SUBS_MASK_NONE    : SS[14:0] are compared and must match to activate alarm.
return  None

name    RTC_GetAlarmSubSecond.
fun     Gets the RTC Alarm Subseconds value.
param   RTC_Alarm : specifies the alarm to be read.
            - RTC_A_ALARM : select Alarm A.
            - RTC_B_ALARM : select Alarm B.
return  RTC Alarm Subseconds value.

name    RTC_ConfigWakeUpClock.
fun     Configures the RTC Wakeup clock source.
param   RTC_WakeUpClock : RTC_WakeUpClock Wakeup Clock source.
            - RTC_WKUPCLK_RTCCLK_DIV16 : RTC Wakeup Counter Clock = RTCCLK/16.
            - RTC_WKUPCLK_RTCCLK_DIV8 : RTC Wakeup Counter Clock = RTCCLK/8.
            - RTC_WKUPCLK_RTCCLK_DIV4 : RTC Wakeup Counter Clock = RTCCLK/4.
            - RTC_WKUPCLK_RTCCLK_DIV2 : RTC Wakeup Counter Clock = RTCCLK/2.
            - RTC_WKUPCLK_CK_SPRE_16BITS : RTC Wakeup Counter Clock = CK_SPRE.
            - RTC_WKUPCLK_CK_SPRE_17BITS : RTC Wakeup Counter Clock = CK_SPRE,and wakeup timer count is 2^16.
return  none

name    RTC_SetWakeUpCounter.
fun     Configures the RTC Wakeup counter.
param   RTC_WakeUpCounter : specifies the WakeUp counter, the value in the 0-0xFFFF range
return  none

name    RTC_GetWakeUpCounter.
fun     Returns the RTC WakeUp timer counter value.
param   none
return  The RTC WakeUp Counter value.

name    RTC_EnableWakeUp
fun     Enables or disables the RTC WakeUp timer.
param  Cmd :
          - ENABLE
          - DISABLE
return  ErrorStatus :
            - SUCCESS: RTC wakeup configured succeed
            - ERROR:   RTC wakeup configured failed

name    RTC_ConfigDayLightSaving
fun     Adds or substract one hour from the current time.
param   RTC_DayLightSaving : the value of hour adjustment.
            - RTC_DAYLIGHT_SAVING_SUB1H : Substract one hour (winter time).
            - RTC_DAYLIGHT_SAVING_ADD1H : Add one hour (summer time).
param   RTC_StoreOperation : Specifies the value to be written in the BCK bit
        in CTRL register to store the operation.
            - RTC_STORE_OPERATION_RESET :  BCK Bit Reset.
            - RTC_STORE_OPERATION_SET : BCK Bit Set.
return  none

name    RTC_GetStoreOperation
fun     Returns the RTC Day Light Saving stored operation.
return  RTC Day Light Saving stored operation.
            - RTC_STORE_OPERATION_RESET
            - RTC_STORE_OPERATION_SET

name    RTC_ConfigOutput
fun     Configures the RTC output source.
param   RTC_Output : RTC_Output Specifies which signal will be routed to the RTC output.
            - RTC_OUTPUT_DIS : No output selected
            - RTC_OUTPUT_ALA : signal of AlarmA mapped to output.
            - RTC_OUTPUT_ALB : signal of AlarmB mapped to output.
            - RTC_OUTPUT_WKUP: signal of WakeUp mapped to output.
param   RTC_OutputPolarity : Specifies the polarity of the output signal.
            - RTC_OUTPOL_HIGH: The output pin is high when the ALRAF/ALRBF/WUTF is high (depending on OSEL).
            - RTC_OUTPOL_LOW : The output pin is low when the ALRAF/ALRBF/WUTF is high (depending on OSEL).
return  none

name    RTC_EnableOutput2
fun     Enable or disable the RTC output2 .
param   Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_EnableTampOutput
fun     Enable or disable the RTC tamper output .
param   Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_EnableCalibOutput
fun     Enable or disable the RTC calibration clock to be output through the relative pin.
param   Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_ConfigCalibOutput
fun     Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 256Hz).
param   RTC_CalibOutput Select the Calibration output Selection .
            - RTC_CALIB_OUTPUT_256HZ : A signal has a regular waveform at 256Hz.
            - RTC_CALIB_OUTPUT_1HZ   : A signal has a regular waveform at 1Hz.
return  none

name    RTC_ConfigSmoothCalib
fun     Configures the Smooth Calibration Settings.
param   RTC_SmoothCalibPeriod : RTC_SmoothCalibPeriod Select the Smooth Calibration Period.
            - SMOOTH_CALIB_32SEC : The smooth calibration periode is 32s.
            - SMOOTH_CALIB_16SEC : The smooth calibration periode is 16s.
            - SMOOTH_CALIB_8SEC  : The smooth calibartion periode is 8s.
param   RTC_SmoothCalibPlusPulses : Set or reset the CALP bit.
            - RTC_SMOOTH_CALIB_PLUS_PULSES_SET : Add one RTCCLK puls every 2**11 pulses.
            - RTC_SMOOTH_CALIB_PLUS_PULSES_RESET : No RTCCLK pulses are added.
param   RTC_SmouthCalibMinusPulsesValue : Set the value of CALM[8:0] bits, the value in the 0-0x000001FF range
return  ErrorStatus
            - SUCCESS : RTC Calib registers are configured
            - ERROR   : RTC Calib registers are not configured

name    RTC_EnableTimeStamp
fun     Enables or disables the RTC TimeStamp functionality with the specified time stamp pin stimulating edge.
param   RTC_TimeStampEdge : Specifies the pin edge on which the TimeStamp is activated.
            - RTC_TIMESTAMP_EDGE_RISING : the Time stamp event occurs on the rising edge of the related pin.
            - RTC_TIMESTAMP_EDGE_FALLING : the Time stamp event occurs on the falling edge of the related pin.
param  Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_GetTimeStamp
fun     Get the RTC TimeStamp value and masks.
param   RTC_Format : specifies the format of the output parameters.
            - RTC_FORMAT_BIN : Binary data format
            - RTC_FORMAT_BCD : BCD data format
param   RTC_StampTimeStruct : pointer to a RTC_TimeType structure that will
        contains the TimeStamp time values.
param   RTC_StampDateStruct : pointer to a RTC_DateType structure that will
        contains the TimeStamp date values.
return  none

name    RTC_GetTimeStampSubSecond
fun     Get the RTC timestamp Subseconds value.
param   none
return  RTC current timestamp Subseconds value.

name    RTC_ConfigSynchroShift
fun     Configures the Synchronization Shift Control Settings.
param   RTC_ShiftAdd1S : Select to add or not 1 second to the time Calendar.
            - RTC_SHIFT_SUB1S_DISABLE : Add one second to the clock calendar.
            - RTC_SHIFT_SUB1S_ENABLE : No effect.
param   RTC_ShiftSubFS : Select the number of Second Fractions to Substitute.
          This parameter can be one any value from 0 to 0x7FFF.
return  ErrorStatus :
            - SUCCESS : RTC Shift registers are configured
            - ERROR : RTC Shift registers are not configured

name    RTC_ConfigInt
fun     Enables or disables the specified RTC interrupts.
param   RTC_INT : specifies the RTC interrupt sources to be enabled .
            - RTC_INT_TS  : TimeStamp interrupt mask.
            - RTC_INT_WUT : WakeUp Timer interrupt mask.
            - RTC_INT_ALRB : Alarm B interrupt mask.
            - RTC_INT_ALRA : Alarm A interrupt mask.
param  Cmd :
          - ENABLE
          - DISABLE
return  none

name    RTC_GetFlagStatus
fun     Checks whether the specified RTC flag is set or not.
param   RTC_FLAG : specifies the flag to check.
          - RTC_FLAG_RECPF  : RECALPF event flag.
          - RTC_FLAG_TAMP3F  : Tamp3 detect flag.
          - RTC_FLAG_TAMP2F  : Tamp2 detect flag.
          - RTC_FLAG_TAMP1F  : Tamp1 detect flag.
          - RTC_FLAG_TISOVF : Time Stamp OverFlow flag.
          - RTC_FLAG_TISF   : Time Stamp event flag.
          - RTC_FLAG_WTF    : WakeUp Timer flag.
          - RTC_FLAG_ALBF   : Alarm B flag.
          - RTC_FLAG_ALAF   : Alarm A flag.
          - RTC_FLAG_INITF  : Initialization mode flag.
          - RTC_FLAG_RSYF   : Registers Synchronized flag.
          - RTC_FLAG_INITSF : Registers Configured flag.
          - RTC_FLAG_SHOPF  : Shift operation pending flag.
          - RTC_FLAG_WTWF   : WakeUp Timer Write flag.
          - RTC_FLAG_ALBWF  : Alarm B Write flag.
          - RTC_FLAG_ALAWF  : Alarm A write flag.
return  FlagStatus
          - SET   : the flag is set
          - RESET : the flag is reset

name    RTC_ClrFlag
fun     Clears the RTC's flags.
param   RTC_FLAG : RTC_FLAG specifies the RTC flag to clear.
          - RTC_FLAG_TAMP3F  : Tamp3 detect flag.
          - RTC_FLAG_TAMP2F  : Tamp2 detect flag.
          - RTC_FLAG_TAMP1F  : Tamp1 detect flag.
          - RTC_FLAG_TISOVF  : Time Stamp Overflow flag.
          - RTC_FLAG_TISF    : Time Stamp event flag.
          - RTC_FLAG_WTF     : WakeUp Timer flag
          - RTC_FLAG_ALBF    : Alarm B flag.
          - RTC_FLAG_ALAF    : Alarm A flag.
          - RTC_FLAG_RSYF    : Registers Synchronized flag.
return  none

name    RTC_GetITStatus
fun     Checks whether the specified RTC interrupt has occurred or not.
param   RTC_INT : specifies the RTC interrupt source to check.
          - RTC_INT_TAMP3 : Tamper3 interrupt.
          - RTC_INT_TAMP2 : Tamper2 interrupt.
          - RTC_INT_TAMP1 : Tamper1 interrupt.
          - RTC_INT_TS    : Timestamp interrupt.
          - RTC_INT_WUT   : WakeUp Timer interrupt.
          - RTC_INT_ALRB  : Alarm B interrupt.
          - RTC_INT_ALRA  : Alarm A interrupt.
return  INTStatus
          - SET   : the flag is set
          - RESET : the flag is reset

name    RTC_ClrIntPendingBit
fun     Clears the RTC's interrupt pending bits.
param   RTC_INT : specifies the RTC interrupt pending bit to clear.
          - RTC_INT_TAMP3 : Tamper3 interrupt.
          - RTC_INT_TAMP2 : Tamper2 interrupt.
          - RTC_INT_TAMP1 : Tamper1 interrupt.
          - RTC_INT_TS    : Timestamp interrupt.
          - RTC_INT_WUT   : WakeUp Timer interrupt
          - RTC_INT_ALRB  : Alarm B interrupt
          - RTC_INT_ALRA  : Alarm A interrupt
return  none

name    RTC_TamperTriggerConfig
fun     Configures the select Tamper pin edge.
param   RTC_Tamper: Selected tamper pin.
          - RTC_TAMPER_1: Select Tamper 1.
          - RTC_TAMPER_2: Select Tamper 2.
          - RTC_TAMPER_3: Select Tamper 3.
param   RTC_TamperTrigger: Specifies the trigger on the tamper pin that stimulates tamper event.
          - RTC_TamperTrigger_RisingEdge: Rising Edge of the tamper pin causes tamper event.
          - RTC_TamperTrigger_FallingEdge: Falling Edge of the tamper pin causes tamper event.
          - RTC_TamperTrigger_LowLevel: Low Level of the tamper pin causes tamper event.
          - RTC_TamperTrigger_HighLevel: High Level of the tamper pin causes tamper event.
return  none

name    RTC_TamperCmd
fun     Enables or disables the specified Tamper detection.
param   RTC_Tamper: Selected tamper pin.
          - RTC_TAMPER_1: Select Tamper 1.
          - RTC_TAMPER_2: Select Tamper 2.
          - RTC_TAMPER_3: Select Tamper 3.
param  NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_TamperFilterConfig
fun     Configures the Tampers Filter.
param   RTC_TamperFilter: Selected tamper pin.
            - RTC_TamperFilter_Disable: Tamper filter is disabled.
            - RTC_TamperFilter_2Sample: Tamper is activated after 2 consecutive samples at the active level.
            - RTC_TamperFilter_4Sample: Tamper is activated after 4 consecutive samples at the active level.
            - RTC_TamperFilter_8Sample: Tamper is activated after 8 consecutive samples at the active level.
return  none

name    RTC_TamperSamplingFreqConfig
fun     Configures the Tampers Sampling Frequency.
param   RTC_TamperSamplingFreq: Selected tamper pin.
            - RTC_TamperSamplingFreq_RTCCLK_Div32768
            - RTC_TamperSamplingFreq_RTCCLK_Div16384
            - RTC_TamperSamplingFreq_RTCCLK_Div8192
            - RTC_TamperSamplingFreq_RTCCLK_Div4096
            - RTC_TamperSamplingFreq_RTCCLK_Div2048
            - RTC_TamperSamplingFreq_RTCCLK_Div1024
            - RTC_TamperSamplingFreq_RTCCLK_Div512
            - RTC_TamperSamplingFreq_RTCCLK_Div256
return  none

name    RTC_TamperPinsPrechargeDuration
fun     Configures the Tampers Pins input Precharge Duration.
param   RTC_TamperPrechargeDuration: Selected tamper pin.
            - RTC_TamperPrechargeDuration_1RTCCLK
            - RTC_TamperPrechargeDuration_2RTCCLK
            - RTC_TamperPrechargeDuration_4RTCCLK
            - RTC_TamperPrechargeDuration_8RTCCLK
return  none

name    RTC_TimeStampOnTamperDetectionCmd
fun     The timestamp is valid or invalid even the TSEN bit in tamper control register is reset.
param   NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_TamperPullUpCmd
fun     Enables or disables the Precharge of Tamper pin.
param   NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_TamperIECmd
fun     Enables or disables the Tamper interrupt.
param   TAMPxIE: Selected tamper number.
            - RTC_TAMPER1_INT
            - RTC_TAMPER2_INT
            - RTC_TAMPER3_INT
param  NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_TamperTAMPTSCmd
fun     The timestamp is valid or invalid even the TSEN bit in tamper control register is reset.
param   NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_EnableTampErase
fun     Enables or disables the tamper event erase backup register.
param   RTC_Tamper: Selected tamper pin.
          - RTC_TAMPER_ERASE_1: Select Tamper 1 erase backup register.
          - RTC_TAMPER_ERASE_2: Select Tamper 2 erase backup register.
          - RTC_TAMPER_ERASE_3: Select Tamper 3 erase backup register.
param  NewState :
          - ENABLE
          - DISABLE
return  none

name    RTC_BKUPRgWrite
fun     Write data to backup register.
param   register_num: register_num value can be from 1 to 20
param   Data : Data write to backup register
return  none

name    RTC_BKUPRgRead
fun     Read data from backup register.
param   register_num: register_num value can be from 1 to 20
param   Data : Data write to backup register
return  none