PWRMGR Device Interface Functions More...

#include <stdbool.h>
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "dt/dt_pwrmgr.h"

Go to the source code of this file.

Data Structures
struct	dif_pwrmgr
	A handle to pwrmgr. More...

Macros
#define	kDifPwrmgrIrqWakeup kDtPwrmgrIrqWakeup
	A pwrmgr interrupt request type.

Typedefs
typedef struct dif_pwrmgr	dif_pwrmgr_t
	A handle to pwrmgr.

typedef enum dif_pwrmgr_alert	dif_pwrmgr_alert_t
	A pwrmgr alert type.

Enumerations
enum	dif_pwrmgr_alert { kDifPwrmgrAlertFatalFault = 0 }
	A pwrmgr alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_init (mmio_region_t base_addr, dif_pwrmgr_t *pwrmgr)
	Creates a new handle for a(n) pwrmgr peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_init_from_dt (dt_pwrmgr_t dt, dif_pwrmgr_t *pwrmgr)
	Creates a new handle for a(n) pwrmgr peripheral.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_get_dt (const dif_pwrmgr_t pwrmgr, dt_pwrmgr_t dt)
	Get the DT handle from this DIF.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_alert_force (const dif_pwrmgr_t *pwrmgr, dif_pwrmgr_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_get_type (const dif_pwrmgr_t pwrmgr, dif_pwrmgr_irq_t, dif_irq_type_t type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_get_state (const dif_pwrmgr_t pwrmgr, dif_pwrmgr_irq_state_snapshot_t snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_is_pending (const dif_pwrmgr_t pwrmgr, dif_pwrmgr_irq_t, bool is_pending)
	Returns whether a particular interrupt is currently pending.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_acknowledge_state (const dif_pwrmgr_t *pwrmgr, dif_pwrmgr_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_acknowledge_all (const dif_pwrmgr_t *pwrmgr)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_acknowledge (const dif_pwrmgr_t *pwrmgr, dif_pwrmgr_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_force (const dif_pwrmgr_t *pwrmgr, dif_pwrmgr_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_get_enabled (const dif_pwrmgr_t pwrmgr, dif_pwrmgr_irq_t, dif_toggle_t state)
	Checks whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_set_enabled (const dif_pwrmgr_t *pwrmgr, dif_pwrmgr_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_disable_all (const dif_pwrmgr_t pwrmgr, dif_pwrmgr_irq_enable_snapshot_t snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.

OT_WARN_UNUSED_RESULT dif_result_t	dif_pwrmgr_irq_restore_all (const dif_pwrmgr_t pwrmgr, const dif_pwrmgr_irq_enable_snapshot_t snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

PWRMGR Device Interface Functions

Definition in file dif_pwrmgr_autogen.h.

Data Structure Documentation

◆ dif_pwrmgr

struct dif_pwrmgr

A handle to pwrmgr.

This type should be treated as opaque by users.

Definition at line 38 of file dif_pwrmgr_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the pwrmgr hardware registers.
dt_pwrmgr_t	dt	The instance, set to `kDtPwrmgrCount` if not initialized through `dif_pwrmgr_init_from_dt`.

Macro Definition Documentation

◆ kDifPwrmgrIrqWakeup

#define kDifPwrmgrIrqWakeup kDtPwrmgrIrqWakeup

A pwrmgr interrupt request type.

DEPRECATED Use dt_pwrmgr_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. Wake from low power state. See wake info for more details

Definition at line 135 of file dif_pwrmgr_autogen.h.

Typedef Documentation

◆ dif_pwrmgr_t

typedef struct dif_pwrmgr dif_pwrmgr_t

A handle to pwrmgr.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_pwrmgr_alert

enum dif_pwrmgr_alert

A pwrmgr alert type.

Enumerator
kDifPwrmgrAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 99 of file dif_pwrmgr_autogen.h.

Function Documentation

◆ dif_pwrmgr_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_alert_force	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_alert_t	alert )

Forces a particular alert, causing it to be escalated as if the hardware had raised it.

Parameters

pwrmgr	A pwrmgr handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 63 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_get_dt	(	const dif_pwrmgr_t *	pwrmgr,
		dt_pwrmgr_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_pwrmgr_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	pwrmgr	A pwrmgr handle.
[out]	dt	DT handle.

Returns: kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 53 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_init	(	mmio_region_t	base_addr,
		dif_pwrmgr_t *	pwrmgr )

Creates a new handle for a(n) pwrmgr peripheral.

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the pwrmgr peripheral.
[out]	pwrmgr	Out param for the initialized handle.

Returns: The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 26 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_init_from_dt	(	dt_pwrmgr_t	dt,
		dif_pwrmgr_t *	pwrmgr )

Creates a new handle for a(n) pwrmgr peripheral.

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	pwrmgr	Out param for the initialized handle.

Returns: The result of the operation.

Definition at line 40 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_acknowledge	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq )

Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

Parameters

pwrmgr	A pwrmgr handle.
irq	An interrupt request.

Returns: The result of the operation.

Definition at line 210 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_acknowledge_all ( const dif_pwrmgr_t * pwrmgr )

Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

Parameters

pwrmgr A pwrmgr handle.

Returns: The result of the operation.

Definition at line 191 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_acknowledge_state	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_state_snapshot_t	snapshot )

Acknowledges all interrupts that were pending at the time of the state snapshot.

Parameters

pwrmgr	A pwrmgr handle.
snapshot	Interrupt state snapshot.

Returns: The result of the operation.

Definition at line 149 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_disable_all	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_enable_snapshot_t *	snapshot )

Disables all interrupts, optionally snapshotting all enable states for later restoration.

Parameters

	pwrmgr	A pwrmgr handle.
[out]	snapshot	Out-param for the snapshot; may be `NULL`.

Returns: The result of the operation.

Definition at line 318 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_force	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq,
		const bool	val )

Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Parameters

pwrmgr	A pwrmgr handle.
irq	An interrupt request.
val	Value to be set.

Returns: The result of the operation.

Definition at line 235 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_get_enabled	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	pwrmgr	A pwrmgr handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns: The result of the operation.

Definition at line 260 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_get_state	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_state_snapshot_t *	snapshot )

Returns the state of all interrupts (i.e., pending or not) for this IP.

Parameters

	pwrmgr	A pwrmgr handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns: The result of the operation.

Definition at line 132 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_get_type	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq,
		dif_irq_type_t *	type )

Returns the type of a given interrupt (i.e., event or status) for this IP.

Parameters

	pwrmgr	A pwrmgr handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns: The result of the operation.

Definition at line 113 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_is_pending	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	pwrmgr	A pwrmgr handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns: The result of the operation.

Definition at line 166 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_restore_all	(	const dif_pwrmgr_t *	pwrmgr,
		const dif_pwrmgr_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

pwrmgr	A pwrmgr handle.
snapshot	A snapshot to restore from.

Returns: The result of the operation.

Definition at line 345 of file dif_pwrmgr_autogen.c.

◆ dif_pwrmgr_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_pwrmgr_irq_set_enabled	(	const dif_pwrmgr_t *	pwrmgr,
		dif_pwrmgr_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

pwrmgr	A pwrmgr handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns: The result of the operation.

Definition at line 287 of file dif_pwrmgr_autogen.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Data Structure Documentation

◆ dif_pwrmgr

Macro Definition Documentation

◆ kDifPwrmgrIrqWakeup

Typedef Documentation

◆ dif_pwrmgr_t

Enumeration Type Documentation

◆ dif_pwrmgr_alert

Function Documentation

◆ dif_pwrmgr_alert_force()

◆ dif_pwrmgr_get_dt()

◆ dif_pwrmgr_init()

◆ dif_pwrmgr_init_from_dt()

◆ dif_pwrmgr_irq_acknowledge()

◆ dif_pwrmgr_irq_acknowledge_all()

◆ dif_pwrmgr_irq_acknowledge_state()

◆ dif_pwrmgr_irq_disable_all()

◆ dif_pwrmgr_irq_force()

◆ dif_pwrmgr_irq_get_enabled()

◆ dif_pwrmgr_irq_get_state()

◆ dif_pwrmgr_irq_get_type()

◆ dif_pwrmgr_irq_is_pending()

◆ dif_pwrmgr_irq_restore_all()

◆ dif_pwrmgr_irq_set_enabled()