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

(a649ec5)

SENSOR_CTRL 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_sensor_ctrl
 A handle to sensor_ctrl. More...
 

Typedefs

typedef struct dif_sensor_ctrl dif_sensor_ctrl_t
 A handle to sensor_ctrl. More...
 
typedef enum dif_sensor_ctrl_alert dif_sensor_ctrl_alert_t
 A sensor_ctrl alert type.
 
typedef enum dif_sensor_ctrl_irq dif_sensor_ctrl_irq_t
 A sensor_ctrl interrupt request type.
 
typedef uint32_t dif_sensor_ctrl_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_sensor_ctrl_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_sensor_ctrl_alert {
  kDifSensorCtrlAlertRecovAlert = 0,
  kDifSensorCtrlAlertFatalAlert = 1
}
 A sensor_ctrl alert type. More...
 
enum  dif_sensor_ctrl_irq {
  kDifSensorCtrlIrqIoStatusChange = 0,
  kDifSensorCtrlIrqInitStatusChange = 1
}
 A sensor_ctrl interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_init (mmio_region_t base_addr, dif_sensor_ctrl_t *sensor_ctrl)
 Creates a new handle for a(n) sensor_ctrl peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_alert_force (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_get_type (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_get_state (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_is_pending (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_acknowledge_state (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_acknowledge_all (const dif_sensor_ctrl_t *sensor_ctrl)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_acknowledge (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_force (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_get_enabled (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_set_enabled (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_disable_all (const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_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_sensor_ctrl_irq_restore_all (const dif_sensor_ctrl_t *sensor_ctrl, const dif_sensor_ctrl_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

SENSOR_CTRL Device Interface Functions

Definition in file dif_sensor_ctrl_autogen.h.


Data Structure Documentation

◆ dif_sensor_ctrl

struct dif_sensor_ctrl

A handle to sensor_ctrl.

This type should be treated as opaque by users.

Definition at line 33 of file dif_sensor_ctrl_autogen.h.

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

Typedef Documentation

◆ dif_sensor_ctrl_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_sensor_ctrl_irq_disable_all() and dif_sensor_ctrl_irq_restore_all() functions.

Definition at line 196 of file dif_sensor_ctrl_autogen.h.

◆ dif_sensor_ctrl_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_sensor_ctrl_irq_get_state() and dif_sensor_ctrl_irq_acknowledge_state() functions.

Definition at line 99 of file dif_sensor_ctrl_autogen.h.

◆ dif_sensor_ctrl_t

A handle to sensor_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_sensor_ctrl_alert

A sensor_ctrl alert type.

Enumerator
kDifSensorCtrlAlertRecovAlert 

Recoverable sensor_ctrl alerts.

kDifSensorCtrlAlertFatalAlert 

Fatal sensor_ctrl alerts.

Definition at line 56 of file dif_sensor_ctrl_autogen.h.

◆ dif_sensor_ctrl_irq

A sensor_ctrl interrupt request type.

Enumerator
kDifSensorCtrlIrqIoStatusChange 

Io power status has changed.

kDifSensorCtrlIrqInitStatusChange 

Ast init status has changed.

Definition at line 82 of file dif_sensor_ctrl_autogen.h.

Function Documentation

◆ dif_sensor_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_alert_force ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_alert_t  alert 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 28 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_init ( mmio_region_t  base_addr,
dif_sensor_ctrl_t sensor_ctrl 
)

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

This function does not actuate the hardware.

Parameters
base_addrThe MMIO base address of the sensor_ctrl peripheral.
[out]sensor_ctrlOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 17 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_acknowledge ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 156 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_acknowledge_all ( const dif_sensor_ctrl_t sensor_ctrl)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
Returns
The result of the operation.

Definition at line 142 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_acknowledge_state ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_state_snapshot_t  snapshot 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 107 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_disable_all ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_enable_snapshot_t snapshot 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 245 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_force ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq,
const bool  val 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 177 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_get_enabled ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 198 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_get_state ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_state_snapshot_t snapshot 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 93 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_get_type ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq,
dif_irq_type_t type 
)

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

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 79 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_is_pending ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 121 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_restore_all ( const dif_sensor_ctrl_t sensor_ctrl,
const dif_sensor_ctrl_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
sensor_ctrlA sensor_ctrl handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 266 of file dif_sensor_ctrl_autogen.c.

◆ dif_sensor_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_sensor_ctrl_irq_set_enabled ( const dif_sensor_ctrl_t sensor_ctrl,
dif_sensor_ctrl_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

Parameters
sensor_ctrlA sensor_ctrl handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 220 of file dif_sensor_ctrl_autogen.c.