Software APIs
Data Structures | Typedefs | Enumerations | Functions
dif_pwrmgr_autogen.h File Reference

(a649ec5)

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"

Go to the source code of this file.

Data Structures

struct  dif_pwrmgr
 A handle to pwrmgr. More...
 

Typedefs

typedef struct dif_pwrmgr dif_pwrmgr_t
 A handle to pwrmgr. More...
 
typedef enum dif_pwrmgr_alert dif_pwrmgr_alert_t
 A pwrmgr alert type.
 
typedef enum dif_pwrmgr_irq dif_pwrmgr_irq_t
 A pwrmgr interrupt request type.
 
typedef uint32_t dif_pwrmgr_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_pwrmgr_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_pwrmgr_alert { kDifPwrmgrAlertFatalFault = 0 }
 A pwrmgr alert type. More...
 
enum  dif_pwrmgr_irq { kDifPwrmgrIrqWakeup = 0 }
 A pwrmgr interrupt request 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 

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 32 of file dif_pwrmgr_autogen.h.

Data Fields
mmio_region_t base_addr The base address for the pwrmgr hardware registers.

Typedef Documentation

◆ dif_pwrmgr_irq_enable_snapshot_t

A snapshot of the enablement state of the interrupts for this IP.

This is an opaque type, to be used with the dif_pwrmgr_irq_disable_all() and dif_pwrmgr_irq_restore_all() functions.

Definition at line 182 of file dif_pwrmgr_autogen.h.

◆ dif_pwrmgr_irq_state_snapshot_t

A snapshot of the state of the interrupts for this IP.

This is an opaque type, to be used with the dif_pwrmgr_irq_get_state() and dif_pwrmgr_irq_acknowledge_state() functions.

Definition at line 90 of file dif_pwrmgr_autogen.h.

◆ 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

A pwrmgr alert type.

Enumerator
kDifPwrmgrAlertFatalFault 

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

Definition at line 54 of file dif_pwrmgr_autogen.h.

◆ dif_pwrmgr_irq

A pwrmgr interrupt request type.

Enumerator
kDifPwrmgrIrqWakeup 

Wake from low power state.

See wake info for more details

Definition at line 77 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
pwrmgrA pwrmgr handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 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_addrThe MMIO base address of the pwrmgr peripheral.
[out]pwrmgrOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 17 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 142 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
pwrmgrA pwrmgr handle.
Returns
The result of the operation.

Definition at line 129 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
pwrmgrA pwrmgr handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 96 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
pwrmgrA pwrmgr handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 228 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 162 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 181 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
pwrmgrA pwrmgr handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 83 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 70 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 109 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
pwrmgrA pwrmgr handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 248 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
pwrmgrA pwrmgr handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 203 of file dif_pwrmgr_autogen.c.