hal_pwr.h File Reference

Interface of module hal_pwr. More...

#include "hal_common.h"

Go to the source code of this file.

Enumerations
enum	hal_pwr_regulator_t { HAL_PWR_REGULATOR_MAIN = 0u, HAL_PWR_REGULATOR_LOWPOWER = 1u }
	Defines the available voltage regulators.
enum	hal_pwr_lp_entry_t { HAL_PWR_LP_ENTRY_WFI = 0u, HAL_PWR_LP_ENTRY_WFE = 1u }
	Defines the method used to enter/leave the low power modes.

Functions
void	hal_pwr_reset (void) __attribute__((deprecated("Please use PWR_RESET().")))
	Resets the periphery to default values.
hal_bool_t	hal_pwr_set_backup_domain (hal_bool_t status)
	Enables/disables the backup domain (RTC, backup sram/registers). More...
void	hal_pwr_set_backup_access (hal_bool_t status)
	Enables/Disables write access to backup domain. More...
void	hal_pwr_set_wakeup_pin (hal_bool_t status)
	Enables/Disables the wakeup pin. More...
void	hal_pwr_set_flash_powerdown (hal_bool_t status)
	Enables/Disables the flash powerdown mode. More...
hal_bool_t	hal_pwr_set_overdrive (hal_bool_t status)
	Enables/Disables the voltage regulator overdrive mode. More...
hal_bool_t	hal_pwr_set_underdrive (hal_bool_t status)
	Enables/Disables the voltage regulator underdrive mode. More...

Detailed Description

Interface of module hal_pwr.

The hardware abstraction layer for the power control unit.

$Id$

Function Documentation

hal_pwr_set_backup_access()

void hal_pwr_set_backup_access

(

hal_bool_t

status

)

Enables/Disables write access to backup domain.

Parameters

status

: Either ENABLE or DISABLE.

hal_pwr_set_backup_domain()

hal_bool_t hal_pwr_set_backup_domain

(

hal_bool_t

status

)

Enables/disables the backup domain (RTC, backup sram/registers).

Parameters

status

: Either ENABLE or DISABLE.

Returns

If successful ENABLED, else DISABLED.

hal_pwr_set_flash_powerdown()

void hal_pwr_set_flash_powerdown

(

hal_bool_t

status

)

Enables/Disables the flash powerdown mode.

Parameters

status

: Either ENABLE or DISABLE.

hal_pwr_set_overdrive()

hal_bool_t hal_pwr_set_overdrive

(

hal_bool_t

status

)

Enables/Disables the voltage regulator overdrive mode.

Parameters

status

: Either ENABLE or DISABLE.

Returns

If successful ENABLED, else DISABLED.

hal_pwr_set_underdrive()

hal_bool_t hal_pwr_set_underdrive

(

hal_bool_t

status

)

Enables/Disables the voltage regulator underdrive mode.

Parameters

status

: Either ENABLE or DISABLE.

Returns

If successful ENABLED, else DISABLED.

hal_pwr_set_wakeup_pin()

void hal_pwr_set_wakeup_pin

(

hal_bool_t

status

)

Enables/Disables the wakeup pin.

Parameters

status

: Either ENABLE or DISABLE.