TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

Extended Peripheral Control functions
Functions

Extended Peripheral Control functions
[RTCEx Exported Functions]

Extended Peripheral Control functions. More...

Functions

void HAL_RTCEx_BKUPWrite (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister, uint32_t Data)
 Write a data in a specified RTC Backup data register.
uint32_t HAL_RTCEx_BKUPRead (RTC_HandleTypeDef *hrtc, uint32_t BackupRegister)
 Read data from the specified RTC Backup data Register.
HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib (RTC_HandleTypeDef *hrtc, uint32_t SmoothCalibPeriod, uint32_t SmoothCalibPlusPulses, uint32_t SmoothCalibMinusPulsesValue)
 Set the Smooth calibration parameters.
HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift (RTC_HandleTypeDef *hrtc, uint32_t ShiftAdd1S, uint32_t ShiftSubFS)
 Configure the Synchronization Shift Control Settings.
HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut (RTC_HandleTypeDef *hrtc, uint32_t CalibOutput)
 Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef HAL_RTCEx_DeactivateCalibrationOutPut (RTC_HandleTypeDef *hrtc)
 Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
HAL_StatusTypeDef HAL_RTCEx_SetRefClock (RTC_HandleTypeDef *hrtc)
 Enable the RTC reference clock detection.
HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock (RTC_HandleTypeDef *hrtc)
 Disable the RTC reference clock detection.
HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow (RTC_HandleTypeDef *hrtc)
 Enable the Bypass Shadow feature.
HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow (RTC_HandleTypeDef *hrtc)
 Disable the Bypass Shadow feature.

Detailed Description

Extended Peripheral Control functions. 

 ===============================================================================
              ##### Extended Peripheral Control functions #####
 ===============================================================================  
    [..]
    This subsection provides functions allowing to
      (+) Write a data in a specified RTC Backup data register
      (+) Read a data in a specified RTC Backup data register
      (+) Set the Coarse calibration parameters.
      (+) Deactivate the Coarse calibration parameters
      (+) Set the Smooth calibration parameters.
      (+) Configure the Synchronization Shift Control Settings.
      (+) Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
      (+) Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).
      (+) Enable the RTC reference clock detection.
      (+) Disable the RTC reference clock detection.
      (+) Enable the Bypass Shadow feature.
      (+) Disable the Bypass Shadow feature.

Function Documentation

uint32_t HAL_RTCEx_BKUPRead ( RTC_HandleTypeDef *  hrtc,
uint32_t  BackupRegister 
)

Read data from the specified RTC Backup data Register.

Parameters:
hrtc,:RTC handle
BackupRegister,:RTC Backup data Register number. This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to specify the register.
Return values:
Readvalue

Definition at line 1376 of file stm32l4xx_hal_rtc_ex.c.

void HAL_RTCEx_BKUPWrite ( RTC_HandleTypeDef *  hrtc,
uint32_t  BackupRegister,
uint32_t  Data 
)

Write a data in a specified RTC Backup data register.

Parameters:
hrtc,:RTC handle
BackupRegister,:RTC Backup data Register number. This parameter can be: RTC_BKP_DRx where x can be from 0 to 19 to specify the register.
Data,:Data to be written in the specified RTC Backup data register.
Return values:
None

Definition at line 1354 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_DeactivateCalibrationOutPut ( RTC_HandleTypeDef *  hrtc )

Deactivate the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).

Parameters:
hrtc,:RTC handle
Return values:
HALstatus

Definition at line 1608 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_DeactivateRefClock ( RTC_HandleTypeDef *  hrtc )

Disable the RTC reference clock detection.

Parameters:
hrtc,:RTC handle
Return values:
HALstatus

Definition at line 1686 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_DisableBypassShadow ( RTC_HandleTypeDef *  hrtc )

Disable the Bypass Shadow feature.

Parameters:
hrtc,:RTC handle
Note:
When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter.
Return values:
HALstatus

Definition at line 1769 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_EnableBypassShadow ( RTC_HandleTypeDef *  hrtc )

Enable the Bypass Shadow feature.

Parameters:
hrtc,:RTC handle
Note:
When the Bypass Shadow is enabled the calendar value are taken directly from the Calendar counter.
Return values:
HALstatus

Definition at line 1737 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetCalibrationOutPut ( RTC_HandleTypeDef *  hrtc,
uint32_t  CalibOutput 
)

Configure the Calibration Pinout (RTC_CALIB) Selection (1Hz or 512Hz).

Parameters:
hrtc,:RTC handle
CalibOutput: Select the Calibration output Selection . This parameter can be one of the following values:

  • RTC_CALIBOUTPUT_512HZ: A signal has a regular waveform at 512Hz.
  • RTC_CALIBOUTPUT_1HZ: A signal has a regular waveform at 1Hz.
Return values:
HALstatus

Definition at line 1570 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetRefClock ( RTC_HandleTypeDef *  hrtc )

Enable the RTC reference clock detection.

Parameters:
hrtc,:RTC handle
Return values:
HALstatus

Definition at line 1637 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetSmoothCalib ( RTC_HandleTypeDef *  hrtc,
uint32_t  SmoothCalibPeriod,
uint32_t  SmoothCalibPlusPulses,
uint32_t  SmoothCalibMinusPulsesValue 
)

Set the Smooth calibration parameters.

Parameters:
hrtc,:RTC handle
SmoothCalibPeriod,:Select the Smooth Calibration Period. This parameter can be can be one of the following values :

  • RTC_SMOOTHCALIB_PERIOD_32SEC: The smooth calibration period is 32s.
  • RTC_SMOOTHCALIB_PERIOD_16SEC: The smooth calibration period is 16s.
  • RTC_SMOOTHCALIB_PERIOD_8SEC: The smooth calibration period is 8s.
SmoothCalibPlusPulses,:Select to Set or reset the CALP bit. This parameter can be one of the following values:

  • RTC_SMOOTHCALIB_PLUSPULSES_SET: Add one RTCCLK pulse every 2*11 pulses.
  • RTC_SMOOTHCALIB_PLUSPULSES_RESET: No RTCCLK pulses are added.
SmoothCalibMinusPulsesValue,:Select the value of CALM[8:0] bits. This parameter can be one any value from 0 to 0x000001FF.
Note:
To deactivate the smooth calibration, the field SmoothCalibPlusPulses must be equal to SMOOTHCALIB_PLUSPULSES_RESET and the field SmoothCalibMinusPulsesValue must be equal to 0.
Return values:
HALstatus

Definition at line 1409 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetSynchroShift ( RTC_HandleTypeDef *  hrtc,
uint32_t  ShiftAdd1S,
uint32_t  ShiftSubFS 
)

Configure the Synchronization Shift Control Settings.

Note:
When REFCKON is set, firmware must not write to Shift control register.
Parameters:
hrtc,:RTC handle
ShiftAdd1S,:Select to add or not 1 second to the time calendar. This parameter can be one of the following values :

  • RTC_SHIFTADD1S_SET: Add one second to the clock calendar.
  • RTC_SHIFTADD1S_RESET: No effect.
ShiftSubFS,:Select the number of Second Fractions to substitute. This parameter can be one any value from 0 to 0x7FFF.
Return values:
HALstatus

Definition at line 1477 of file stm32l4xx_hal_rtc_ex.c.

Generated on Tue Jul 12 2022 17:38:54 by  doxygen 1.7.2