RTC_Exported_Functions_Group5

Macros
#define	HAL_PBR0_FORCE1_ENABLE()   (hwp_rtc->PBR0R |= RTC_PBR0R_FORCE1)
#define	HAL_PBR0_FORCE1_DISABLE()   (hwp_rtc->PBR0R &= ~RTC_PBR0R_FORCE1)

Functions
HAL_RTCStateTypeDef	HAL_RTC_GetState (RTC_HandleTypeDef *hrtc)
	Returns the RTC state. More...
void	HAL_RTC_set_backup (RTC_HandleTypeDef *hrtc, uint8_t idx, uint32_t value)
	Set the RTC backup register. More...
uint32_t	HAL_RTC_get_backup (RTC_HandleTypeDef *hrtc, uint8_t idx)
	get the RTC backup register value. More...
void	HAL_RTC_RegCallback (RTC_HandleTypeDef *hrtc, RTC_cb cbk)
	Register call back functions for RTC module. More...
HAL_StatusTypeDef	HAL_PBR_ConfigMode (uint8_t pin, bool output_en)
	config PBR pin mode More...
int8_t	HAL_PBR_ReadPin (uint8_t pin)
	Read PBR pin state. More...
HAL_StatusTypeDef	HAL_PBR_WritePin (uint8_t pin, uint8_t state)
	Set PBR pin state. More...
HAL_StatusTypeDef	HAL_PBR_GetMode (uint8_t pin, bool *output_en)
	Get PBR pin mode. More...

Detailed Description

Function Documentation

HAL_PBR_ConfigMode()

HAL_StatusTypeDef HAL_PBR_ConfigMode	(	uint8_t	pin,
		bool	output_en
	)

config PBR pin mode

Parameters

[in]	pin	PBR pin index, starting from 0
[in]	output_en	true: output mode, false: input mode

Return values

HAL

status

HAL_PBR_GetMode()

HAL_StatusTypeDef HAL_PBR_GetMode	(	uint8_t	pin,
		bool *	output_en
	)

Get PBR pin mode.

Parameters

[in]	pin	PBR pin index, starting from 0
[in,out]	output_en	pointer to pin mode, true: output mode, false: input mode

Return values

HAL

status

HAL_PBR_ReadPin()

int8_t HAL_PBR_ReadPin

(

uint8_t

pin

)

Read PBR pin state.

Parameters

[in]

pin

PBR pin index, starting from 0

Return values

0	and 1 are valid value, if less than 0, some error happens, e.g. pin is invalid

HAL_PBR_WritePin()

HAL_StatusTypeDef HAL_PBR_WritePin	(	uint8_t	pin,
		uint8_t	state
	)

Set PBR pin state.

Parameters

[in]	pin	PBR pin index, starting from 0
[in]	state	pin state, 0 and 1 are valid vallue

Return values

HAL

status

HAL_RTC_get_backup()

uint32_t HAL_RTC_get_backup	(	RTC_HandleTypeDef *	hrtc,
		uint8_t	idx
	)

get the RTC backup register value.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
idx	index of backup register

Return values

value

saved in the backup register

HAL_RTC_GetState()

HAL_RTCStateTypeDef HAL_RTC_GetState

(

RTC_HandleTypeDef *

hrtc

)

Returns the RTC state.

Parameters

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

Return values

HAL

state

HAL_RTC_RegCallback()

void HAL_RTC_RegCallback	(	RTC_HandleTypeDef *	hrtc,
		RTC_cb	cbk
	)

Register call back functions for RTC module.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
cbk	callback function to be registered.

Return values

None

HAL_RTC_set_backup()

void HAL_RTC_set_backup	(	RTC_HandleTypeDef *	hrtc,
		uint8_t	idx,
		uint32_t	value
	)

Set the RTC backup register.

Parameters

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
idx	index of backup register
value	value to set into backup register

Return values

None