BPOR driver APIs

BPOR driver APIs. More...

Enumerations
enum	bpor_power_on_cause_t {   bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 ,   bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 ,   bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 ,   bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 }
	Define BPOR power on cause. More...
enum	bpor_power_on_cause_t {   bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 ,   bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 ,   bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 ,   bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 }
	Define BPOR power on cause. More...
enum	bpor_power_on_cause_t {   bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 ,   bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 , bpor_power_on_cause_rtc_0 = 1 << 2 ,   bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 , bpor_power_on_cause_wbutn = 1 << 0 , bpor_power_on_cause_safety_violation = 1 << 1 ,   bpor_power_on_cause_rtc_0 = 1 << 2 , bpor_power_on_cause_rtc_1 = 1 << 3 , bpor_power_on_cause_gpio = 1 << 4 }
	Define BPOR power on cause. More...

Functions
static uint32_t	bpor_get_power_on_cause (BPOR_Type *ptr)
	Get power on cause. More...
static void	bpor_clear_power_on_cause (BPOR_Type *ptr, uint8_t mask)
	Clear power on cause. More...
static void	bpor_enable_power_on_cause (BPOR_Type *ptr, bpor_power_on_cause_t cause)
	enable power on cause More...
static void	bpor_disable_power_on_cause (BPOR_Type *ptr, bpor_power_on_cause_t cause)
	disable power on cause More...
static void	bpor_set_power_on_cause (BPOR_Type *ptr, uint8_t cause)
	Set power on cause. More...
static void	bpor_enable_reg_value_retention (BPOR_Type *ptr)
	Enable register value retention when power down occurs. More...
static void	bpor_disable_reg_value_retention (BPOR_Type *ptr)
	Disable register value retention when power down occurs. More...
static void	bpor_set_power_down_counter (BPOR_Type *ptr, uint16_t counter)
	Set power down counter. More...

Detailed Description

BPOR driver APIs.

Enumeration Type Documentation

bpor_power_on_cause_t [1/3]

enum bpor_power_on_cause_t

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Define BPOR power on cause.

Enumerator
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio

bpor_power_on_cause_t [2/3]

enum bpor_power_on_cause_t

#include <soc/HPM6300/HPM6360/hpm_bpor_drv.h>

Define BPOR power on cause.

Enumerator
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio

bpor_power_on_cause_t [3/3]

enum bpor_power_on_cause_t

#include <soc/HPM6700/HPM6750/hpm_bpor_drv.h>

Define BPOR power on cause.

Enumerator
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio
bpor_power_on_cause_wbutn
bpor_power_on_cause_safety_violation
bpor_power_on_cause_rtc_0
bpor_power_on_cause_rtc_1
bpor_power_on_cause_gpio

Function Documentation

bpor_clear_power_on_cause()

static void bpor_clear_power_on_cause ( BPOR_Type *  ptr, uint8_t  mask  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Clear power on cause.

Parameters

[in]	ptr	BPOR base address
[in]	mask	cause status to be cleared

bpor_disable_power_on_cause()

static void bpor_disable_power_on_cause ( BPOR_Type *  ptr, bpor_power_on_cause_t  cause  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

disable power on cause

Parameters

[in]	ptr	BPOR base address
[in]	cause	wake up cause to be disabled

bpor_disable_reg_value_retention()

static void bpor_disable_reg_value_retention ( BPOR_Type *  ptr )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Disable register value retention when power down occurs.

Parameters

[in]

ptr

BPOR base address

bpor_enable_power_on_cause()

static void bpor_enable_power_on_cause ( BPOR_Type *  ptr, bpor_power_on_cause_t  cause  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

enable power on cause

Parameters

[in]	ptr	BPOR base address
[in]	cause	wake up cause to be enabled

bpor_enable_reg_value_retention()

static void bpor_enable_reg_value_retention ( BPOR_Type *  ptr )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Enable register value retention when power down occurs.

Parameters

[in]

ptr

BPOR base address

bpor_get_power_on_cause()

static uint32_t bpor_get_power_on_cause ( BPOR_Type *  ptr )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Get power on cause.

Parameters

[in]

ptr

BPOR base address

Return values

POR_CAUSE

register value

bpor_set_power_down_counter()

static void bpor_set_power_down_counter ( BPOR_Type *  ptr, uint16_t  counter  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Set power down counter.

Parameters

[in]	ptr	BPOR base address
[in]	counter	counter value

bpor_set_power_on_cause()

static void bpor_set_power_on_cause ( BPOR_Type *  ptr, uint8_t  cause  )

inlinestatic

#include <soc/HPM6200/HPM6280/hpm_bpor_drv.h>

Set power on cause.

Parameters

[in]	ptr	BPOR base address
[in]	cause	wake up cause to be used