Device Tables (DT) for IP pwrmgr and top earlgrey. More...

#include "dt/dt_pwrmgr.h"
#include "dt_sysrst_ctrl.h"
#include "dt_adc_ctrl.h"
#include "dt_pinmux.h"
#include "dt_aon_timer.h"
#include "dt_sensor_ctrl.h"

Data Structures
struct	dt_desc_pwrmgr
	Description of instances. More...

struct	dt_desc_pwrmgr.ext

Macros
#define	TRY_GET_DT(dt, default)
	Return a pointer to the `dt_pwrmgr_desc_t` structure of the requested `dt` if it's a valid index.

Typedefs
typedef struct dt_desc_pwrmgr	dt_desc_pwrmgr_t
	Description of instances.

Functions
dt_pwrmgr_t	dt_pwrmgr_from_instance_id (dt_instance_id_t inst_id)
	Get the pwrmgr instance from an instance ID.

dt_instance_id_t	dt_pwrmgr_instance_id (dt_pwrmgr_t dt)
	Get the instance ID of an instance.

uint32_t	dt_pwrmgr_reg_block (dt_pwrmgr_t dt, dt_pwrmgr_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_pwrmgr_irq_to_plic_id (dt_pwrmgr_t dt, dt_pwrmgr_irq_t irq)
	Get the PLIC ID of a pwrmgr IRQ for a given instance.

dt_pwrmgr_irq_t	dt_pwrmgr_irq_from_plic_id (dt_pwrmgr_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local pwrmgr IRQ type.

dt_alert_id_t	dt_pwrmgr_alert_to_alert_id (dt_pwrmgr_t dt, dt_pwrmgr_alert_t alert)
	Get the alert ID of a pwrmgr alert for a given instance.

dt_pwrmgr_alert_t	dt_pwrmgr_alert_from_alert_id (dt_pwrmgr_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local pwrmgr alert type.

dt_clock_t	dt_pwrmgr_clock (dt_pwrmgr_t dt, dt_pwrmgr_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_pwrmgr_reset (dt_pwrmgr_t dt, dt_pwrmgr_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

size_t	dt_pwrmgr_wakeup_src_count (dt_pwrmgr_t dt)
	Get the number of wakeup sources.

dt_pwrmgr_wakeup_src_t	dt_pwrmgr_wakeup_src (dt_pwrmgr_t dt, size_t idx)
	Get the description of a wakeup source.

size_t	dt_pwrmgr_reset_request_src_count (dt_pwrmgr_t dt)
	Get the number of peripheral reset requests.

dt_pwrmgr_reset_req_src_t	dt_pwrmgr_reset_request_src (dt_pwrmgr_t dt, size_t idx)
	Get the description of a reset request.

Detailed Description

Device Tables (DT) for IP pwrmgr and top earlgrey.

Definition in file dt_pwrmgr.c.

Data Structure Documentation

◆ dt_desc_pwrmgr

struct dt_desc_pwrmgr

Description of instances.

Definition at line 24 of file dt_pwrmgr.c.

Data Fields
uint32_t	base_addr[kDtPwrmgrRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtPwrmgrClockCount]	Clock signal connected to each clock port.
struct dt_desc_pwrmgr	ext	Extension.
struct dt_desc_pwrmgr	ext	Extension.
struct dt_desc_pwrmgr.ext	ext	Extension.
top_darjeeling_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_earlgrey_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_darjeeling_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
top_earlgrey_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
top_englishbreakfast_plic_irq_id_t	first_irq	PLIC ID of the first IRQ of this instance. This can be `kDtPlicIrqIdNone` if the block is not connected to the PLIC.
dt_instance_id_t	inst_id	Instance ID.
dt_reset_t	reset[kDtPwrmgrResetCount]	Reset signal connected to each reset port.

◆ dt_desc_pwrmgr.ext

struct dt_desc_pwrmgr.ext

Definition at line 32 of file dt_pwrmgr.c.

Data Fields
dt_pwrmgr_reset_req_src_t	rst_reqs[1]	List of reset requests, in the order of the register fields.
dt_pwrmgr_reset_req_src_t	rst_reqs[2]	List of reset requests, in the order of the register fields.
dt_pwrmgr_reset_req_src_t	rst_reqs[2]	List of reset requests, in the order of the register fields.
dt_pwrmgr_wakeup_src_t	wakeup_src[3]	List of wakeup sources, in the order of the register fields.
dt_pwrmgr_wakeup_src_t	wakeup_src[4]	List of wakeup sources, in the order of the register fields.
dt_pwrmgr_wakeup_src_t	wakeup_src[6]	List of wakeup sources, in the order of the register fields.

Macro Definition Documentation

◆ TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({ if ((dt) < (dt_pwrmgr_t)0 || (dt) >= kDtPwrmgrCount) return (default); &pwrmgr_desc[dt]; })

Return a pointer to the dt_pwrmgr_desc_t structure of the requested dt if it's a valid index.

Otherwise, this macro will return (i.e. exit the function) with the provided default value.

Definition at line 117 of file dt_pwrmgr.c.

Function Documentation

◆ dt_pwrmgr_alert_from_alert_id()

dt_pwrmgr_alert_t dt_pwrmgr_alert_from_alert_id	(	dt_pwrmgr_t	dt,
		dt_alert_id_t	alert )

Convert a global alert ID to a local pwrmgr alert type.

Parameters

dt	Instance of pwrmgr.
alert	A global alert ID that belongs to this instance.

Returns: The pwrmgr alert, or kDtPwrmgrAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of pwrmgr passed in parameter. In other words, it must be the case that dt_pwrmgr_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtPwrmgrAlertCount.

Definition at line 169 of file dt_pwrmgr.c.

◆ dt_pwrmgr_alert_to_alert_id()

dt_alert_id_t dt_pwrmgr_alert_to_alert_id	(	dt_pwrmgr_t	dt,
		dt_pwrmgr_alert_t	alert )

Get the alert ID of a pwrmgr alert for a given instance.

Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.

Parameters

dt	Instance of pwrmgr.
alert	A pwrmgr alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 163 of file dt_pwrmgr.c.

◆ dt_pwrmgr_clock()

dt_clock_t dt_pwrmgr_clock	(	dt_pwrmgr_t	dt,
		dt_pwrmgr_clock_t	clk )

Get the clock signal connected to a clock port of an instance.

Parameters

dt	Instance of pwrmgr.
clk	Clock port.

Returns: Clock signal.

Definition at line 181 of file dt_pwrmgr.c.

◆ dt_pwrmgr_from_instance_id()

dt_pwrmgr_t dt_pwrmgr_from_instance_id ( dt_instance_id_t inst_id )

Get the pwrmgr instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A pwrmgr instance.

Note: This function only makes sense if the instance ID has device type pwrmgr, otherwise the returned value is unspecified.

Definition at line 119 of file dt_pwrmgr.c.

◆ dt_pwrmgr_instance_id()

dt_instance_id_t dt_pwrmgr_instance_id ( dt_pwrmgr_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of pwrmgr.

Returns: The instance ID of that instance.

Definition at line 126 of file dt_pwrmgr.c.

◆ dt_pwrmgr_irq_from_plic_id()

dt_pwrmgr_irq_t dt_pwrmgr_irq_from_plic_id	(	dt_pwrmgr_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local pwrmgr IRQ type.

Parameters

dt	Instance of pwrmgr.
irq	A PLIC ID that belongs to this instance.

Returns: The pwrmgr IRQ, or kDtPwrmgrIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of pwrmgr passed in parameter. In other words, it must be the case that dt_pwrmgr_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtPwrmgrIrqCount.

Definition at line 148 of file dt_pwrmgr.c.

◆ dt_pwrmgr_irq_to_plic_id()

dt_plic_irq_id_t dt_pwrmgr_irq_to_plic_id	(	dt_pwrmgr_t	dt,
		dt_pwrmgr_irq_t	irq )

Get the PLIC ID of a pwrmgr IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of pwrmgr.
irq	A pwrmgr IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 138 of file dt_pwrmgr.c.

◆ dt_pwrmgr_reg_block()

uint32_t dt_pwrmgr_reg_block	(	dt_pwrmgr_t	dt,
		dt_pwrmgr_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of pwrmgr.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 131 of file dt_pwrmgr.c.

◆ dt_pwrmgr_reset()

dt_reset_t dt_pwrmgr_reset	(	dt_pwrmgr_t	dt,
		dt_pwrmgr_reset_t	rst )

Get the reset signal connected to a reset port of an instance.

Parameters

dt	Instance of pwrmgr.
rst	Reset port.

Returns: Reset signal.

Definition at line 188 of file dt_pwrmgr.c.

◆ dt_pwrmgr_reset_request_src()

dt_pwrmgr_reset_req_src_t dt_pwrmgr_reset_request_src	(	dt_pwrmgr_t	dt,
		size_t	idx )

Get the description of a reset request.

The reset requests are ordered as they appear in the registers.

Parameters

dt	Instance of pwrmgr.
idx	Index of the reset request source, between 0 and `dt_pwrmgr_reset_request_src_count(dt)-1`.

Returns: Description of the reset.

Definition at line 212 of file dt_pwrmgr.c.

◆ dt_pwrmgr_reset_request_src_count()

size_t dt_pwrmgr_reset_request_src_count ( dt_pwrmgr_t dt )

Get the number of peripheral reset requests.

Parameters

dt	Instance of pwrmgr.

Returns: Number of reset requests.

Definition at line 208 of file dt_pwrmgr.c.

◆ dt_pwrmgr_wakeup_src()

dt_pwrmgr_wakeup_src_t dt_pwrmgr_wakeup_src	(	dt_pwrmgr_t	dt,
		size_t	idx )

Get the description of a wakeup source.

The wakeup sources are ordered as they appear in the registers.

Parameters

dt	Instance of pwrmgr.
idx	Index of the wakeup source, between 0 and `dt_pwrmgr_wakeup_src_count(dt)-1`.

Returns: Description of the source.

Definition at line 203 of file dt_pwrmgr.c.

◆ dt_pwrmgr_wakeup_src_count()

size_t dt_pwrmgr_wakeup_src_count ( dt_pwrmgr_t dt )

Get the number of wakeup sources.

Parameters

dt	Instance of pwrmgr.

Returns: Number of wakeup sources.

Definition at line 199 of file dt_pwrmgr.c.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Data Structure Documentation

◆ dt_desc_pwrmgr

◆ dt_desc_pwrmgr.ext

Macro Definition Documentation

◆ TRY_GET_DT

Function Documentation

◆ dt_pwrmgr_alert_from_alert_id()

◆ dt_pwrmgr_alert_to_alert_id()

◆ dt_pwrmgr_clock()

◆ dt_pwrmgr_from_instance_id()

◆ dt_pwrmgr_instance_id()

◆ dt_pwrmgr_irq_from_plic_id()

◆ dt_pwrmgr_irq_to_plic_id()

◆ dt_pwrmgr_reg_block()

◆ dt_pwrmgr_reset()

◆ dt_pwrmgr_reset_request_src()

◆ dt_pwrmgr_reset_request_src_count()

◆ dt_pwrmgr_wakeup_src()

◆ dt_pwrmgr_wakeup_src_count()