RTC TimeStamp and Tamper functions. More...

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp (RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin)
	Set TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_SetTimeStamp_IT (RTC_HandleTypeDef *hrtc, uint32_t TimeStampEdge, uint32_t RTC_TimeStampPin)
	Set TimeStamp with Interrupt.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTimeStamp (RTC_HandleTypeDef *hrtc)
	Deactivate TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_SetInternalTimeStamp (RTC_HandleTypeDef *hrtc)
	Set Internal TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateInternalTimeStamp (RTC_HandleTypeDef *hrtc)
	Deactivate Internal TimeStamp.
HAL_StatusTypeDef	HAL_RTCEx_GetTimeStamp (RTC_HandleTypeDef hrtc, RTC_TimeTypeDef sTimeStamp, RTC_DateTypeDef *sTimeStampDate, uint32_t Format)
	Get the RTC TimeStamp value.
HAL_StatusTypeDef	HAL_RTCEx_SetTamper (RTC_HandleTypeDef hrtc, RTC_TamperTypeDef sTamper)
	Set Tamper.
HAL_StatusTypeDef	HAL_RTCEx_SetTamper_IT (RTC_HandleTypeDef hrtc, RTC_TamperTypeDef sTamper)
	Set Tamper with interrupt.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateTamper (RTC_HandleTypeDef *hrtc, uint32_t Tamper)
	Deactivate Tamper.
void	HAL_RTCEx_TamperTimeStampIRQHandler (RTC_HandleTypeDef *hrtc)
	Handle TimeStamp interrupt request.
__weak void	HAL_RTCEx_TimeStampEventCallback (RTC_HandleTypeDef *hrtc)
	TimeStamp callback.
__weak void	HAL_RTCEx_Tamper1EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 1 callback.
__weak void	HAL_RTCEx_Tamper2EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 2 callback.
__weak void	HAL_RTCEx_Tamper3EventCallback (RTC_HandleTypeDef *hrtc)
	Tamper 3 callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForTimeStampEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handle TimeStamp polling request.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper1Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handle Tamper 1 Polling.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper2Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handle Tamper 2 Polling.
HAL_StatusTypeDef	HAL_RTCEx_PollForTamper3Event (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handle Tamper 3 Polling.

Detailed Description

RTC TimeStamp and Tamper functions.

 ===============================================================================
                 ##### RTC TimeStamp and Tamper functions #####
 ===============================================================================
 
 [..] This section provide functions allowing to configure TimeStamp feature

Function Documentation

HAL_StatusTypeDef HAL_RTCEx_DeactivateInternalTimeStamp ( RTC_HandleTypeDef * hrtc )

Deactivate Internal TimeStamp.

Parameters:

hrtc,: pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 381 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_DeactivateTamper	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Tamper
	)

Deactivate Tamper.

Parameters:

hrtc,:	RTC handle
Tamper,:	Selected tamper pin. This parameter can be any combination of RTC_TAMPER_1, RTC_TAMPER_2 and RTC_TAMPER_3.

Return values:

HAL status

Definition at line 656 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_DeactivateTimeStamp ( RTC_HandleTypeDef * hrtc )

Deactivate TimeStamp.

Parameters:

hrtc,: RTC handle

Return values:

HAL status

Definition at line 311 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_GetTimeStamp	(	RTC_HandleTypeDef *	hrtc,
		RTC_TimeTypeDef *	sTimeStamp,
		RTC_DateTypeDef *	sTimeStampDate,
		uint32_t	Format
	)

Get the RTC TimeStamp value.

Parameters:

hrtc,:	RTC handle
sTimeStamp,:	Pointer to Time structure
sTimeStampDate,:	Pointer to Date structure
Format,:	specifies the format of the entered parameters. This parameter can be one of the following values: RTC_FORMAT_BIN: Binary data format RTC_FORMAT_BCD: BCD data format

Return values:

HAL status

Definition at line 416 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper1Event	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handle Tamper 1 Polling.

Parameters:

hrtc,:	RTC handle
Timeout,:	Timeout duration

Return values:

HAL status

Definition at line 880 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper2Event	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handle Tamper 2 Polling.

Parameters:

hrtc,:	RTC handle
Timeout,:	Timeout duration

Return values:

HAL status

Definition at line 913 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_PollForTamper3Event	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handle Tamper 3 Polling.

Parameters:

hrtc,:	RTC handle
Timeout,:	Timeout duration

Return values:

HAL status

Definition at line 946 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_PollForTimeStampEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handle TimeStamp polling request.

Parameters:

hrtc,:	RTC handle
Timeout,:	Timeout duration

Return values:

HAL status

Definition at line 840 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetInternalTimeStamp ( RTC_HandleTypeDef * hrtc )

Set Internal TimeStamp.

Note:: This API must be called before enabling the internal TimeStamp feature.

Parameters:

hrtc,: pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL status

Definition at line 350 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetTamper	(	RTC_HandleTypeDef *	hrtc,
		RTC_TamperTypeDef *	sTamper
	)

Set Tamper.

Note:: By calling this API we disable the tamper interrupt for all tampers.

Parameters:

hrtc,:	RTC handle
sTamper,:	Pointer to Tamper Structure.

Return values:

HAL status

Definition at line 468 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetTamper_IT	(	RTC_HandleTypeDef *	hrtc,
		RTC_TamperTypeDef *	sTamper
	)

Set Tamper with interrupt.

Note:: By calling this API we force the tamper interrupt for all tampers.

Parameters:

hrtc,:	RTC handle
sTamper,:	Pointer to RTC Tamper.

Return values:

HAL status

Definition at line 559 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	TimeStampEdge,
		uint32_t	RTC_TimeStampPin
	)

Set TimeStamp.

Note:: This API must be called before enabling the TimeStamp feature.

Parameters:

hrtc,: RTC handle

TimeStampEdge,:

Specifies the pin edge on which the TimeStamp is activated. This parameter can be one of the following values:

RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the rising edge of the related pin.
RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the falling edge of the related pin.

RTC_TimeStampPin,:

specifies the RTC TimeStamp Pin. This parameter can be one of the following values:

RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. The RTC TimeStamp Pin is per default PC13, but for reasons of compatibility, this parameter is required.

Return values:

HAL status

Definition at line 205 of file stm32l4xx_hal_rtc_ex.c.

HAL_StatusTypeDef HAL_RTCEx_SetTimeStamp_IT	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	TimeStampEdge,
		uint32_t	RTC_TimeStampPin
	)

Set TimeStamp with Interrupt.

Parameters:

hrtc,: RTC handle

Note:: This API must be called before enabling the TimeStamp feature.

Parameters:

TimeStampEdge,:

Specifies the pin edge on which the TimeStamp is activated. This parameter can be one of the following values:

RTC_TIMESTAMPEDGE_RISING: the Time stamp event occurs on the rising edge of the related pin.
RTC_TIMESTAMPEDGE_FALLING: the Time stamp event occurs on the falling edge of the related pin.

RTC_TimeStampPin,:

Specifies the RTC TimeStamp Pin. This parameter can be one of the following values:

RTC_TIMESTAMPPIN_DEFAULT: PC13 is selected as RTC TimeStamp Pin. The RTC TimeStamp Pin is per default PC13, but for reasons of compatibility, this parameter is required.

Return values:

HAL status

Definition at line 261 of file stm32l4xx_hal_rtc_ex.c.

__weak void HAL_RTCEx_Tamper1EventCallback ( RTC_HandleTypeDef * hrtc )

Tamper 1 callback.

Parameters:

hrtc,: RTC handle

Return values:

None

Definition at line 791 of file stm32l4xx_hal_rtc_ex.c.

__weak void HAL_RTCEx_Tamper2EventCallback ( RTC_HandleTypeDef * hrtc )

Tamper 2 callback.

Parameters:

hrtc,: RTC handle

Return values:

None

Definition at line 807 of file stm32l4xx_hal_rtc_ex.c.

__weak void HAL_RTCEx_Tamper3EventCallback ( RTC_HandleTypeDef * hrtc )

Tamper 3 callback.

Parameters:

hrtc,: RTC handle

Return values:

None

Definition at line 823 of file stm32l4xx_hal_rtc_ex.c.

void HAL_RTCEx_TamperTimeStampIRQHandler ( RTC_HandleTypeDef * hrtc )

Handle TimeStamp interrupt request.

Parameters:

hrtc,: RTC handle

Return values:

None

Definition at line 701 of file stm32l4xx_hal_rtc_ex.c.

__weak void HAL_RTCEx_TimeStampEventCallback ( RTC_HandleTypeDef * hrtc )

TimeStamp callback.

Parameters:

hrtc,: RTC handle

Return values:

None

Definition at line 775 of file stm32l4xx_hal_rtc_ex.c.

Type:	Program
Created:	24 Feb 2017
Imports:	19
Forks:	0
Commits:	7
Dependents:	0
Dependencies:	0
Followers:	10

Important changes to repositories hosted on mbed.com

RTC TimeStamp and Tamper functions
[RTCEx Exported Functions]

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Important changes to repositories hosted on mbed.com

RTC TimeStamp and Tamper functions [RTCEx Exported Functions]

Functions

Detailed Description

Function Documentation

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning

RTC TimeStamp and Tamper functions
[RTCEx Exported Functions]