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

(a649ec5)

OTP_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_otp_ctrl
 A handle to otp_ctrl. More...
 

Typedefs

typedef struct dif_otp_ctrl dif_otp_ctrl_t
 A handle to otp_ctrl. More...
 
typedef enum dif_otp_ctrl_alert dif_otp_ctrl_alert_t
 A otp_ctrl alert type.
 
typedef enum dif_otp_ctrl_irq dif_otp_ctrl_irq_t
 A otp_ctrl interrupt request type.
 
typedef uint32_t dif_otp_ctrl_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_otp_ctrl_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_otp_ctrl_alert {
  kDifOtpCtrlAlertFatalMacroError = 0,
  kDifOtpCtrlAlertFatalCheckError = 1,
  kDifOtpCtrlAlertFatalBusIntegError = 2,
  kDifOtpCtrlAlertFatalPrimOtpAlert = 3,
  kDifOtpCtrlAlertRecovPrimOtpAlert = 4
}
 A otp_ctrl alert type. More...
 
enum  dif_otp_ctrl_irq {
  kDifOtpCtrlIrqOtpOperationDone = 0,
  kDifOtpCtrlIrqOtpError = 1
}
 A otp_ctrl interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_init (mmio_region_t base_addr, dif_otp_ctrl_t *otp_ctrl)
 Creates a new handle for a(n) otp_ctrl peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_alert_force (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_get_type (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_get_state (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_is_pending (const dif_otp_ctrl_t *otp_ctrl, dif_otp_ctrl_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge_state (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_acknowledge_all (const dif_otp_ctrl_t *otp_ctrl)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_force (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_get_enabled (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_set_enabled (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_disable_all (const dif_otp_ctrl_t *otp_ctrl, dif_otp_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_otp_ctrl_irq_restore_all (const dif_otp_ctrl_t *otp_ctrl, const dif_otp_ctrl_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

OTP_CTRL Device Interface Functions

Definition in file dif_otp_ctrl_autogen.h.


Data Structure Documentation

◆ dif_otp_ctrl

struct dif_otp_ctrl

A handle to otp_ctrl.

This type should be treated as opaque by users.

Definition at line 33 of file dif_otp_ctrl_autogen.h.

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

Typedef Documentation

◆ dif_otp_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_otp_ctrl_irq_disable_all() and dif_otp_ctrl_irq_restore_all() functions.

Definition at line 210 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_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_otp_ctrl_irq_get_state() and dif_otp_ctrl_irq_acknowledge_state() functions.

Definition at line 116 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_ctrl_t

typedef struct dif_otp_ctrl dif_otp_ctrl_t

A handle to otp_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_otp_ctrl_alert

A otp_ctrl alert type.

Enumerator
kDifOtpCtrlAlertFatalMacroError 

This alert triggers if hardware detects an uncorrectable error during an OTP transaction, for example an uncorrectable ECC error in the OTP array.

kDifOtpCtrlAlertFatalCheckError 

This alert triggers if any of the background checks fails.

This includes the digest checks and concurrent ECC checks in the buffer registers.

kDifOtpCtrlAlertFatalBusIntegError 

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

kDifOtpCtrlAlertFatalPrimOtpAlert 

Fatal alert triggered inside the OTP primitive, including fatal TL-UL bus integrity faults of the test interface.

kDifOtpCtrlAlertRecovPrimOtpAlert 

Recoverable alert triggered inside the OTP primitive.

Definition at line 56 of file dif_otp_ctrl_autogen.h.

◆ dif_otp_ctrl_irq

A otp_ctrl interrupt request type.

Enumerator
kDifOtpCtrlIrqOtpOperationDone 

A direct access command or digest calculation operation has completed.

kDifOtpCtrlIrqOtpError 

An error has occurred in the OTP controller.

Check the !!ERR_CODE register to get more information.

Definition at line 98 of file dif_otp_ctrl_autogen.h.

Function Documentation

◆ dif_otp_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_alert_force ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_alert_t  alert 
)

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

Parameters
otp_ctrlA otp_ctrl handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 28 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_init ( mmio_region_t  base_addr,
dif_otp_ctrl_t otp_ctrl 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_t  irq 
)

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

Parameters
otp_ctrlA otp_ctrl handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 163 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge_all ( const dif_otp_ctrl_t otp_ctrl)

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

Parameters
otp_ctrlA otp_ctrl handle.
Returns
The result of the operation.

Definition at line 150 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_acknowledge_state ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_state_snapshot_t  snapshot 
)

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

Parameters
otp_ctrlA otp_ctrl handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 115 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_disable_all ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_enable_snapshot_t snapshot 
)

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

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

Definition at line 250 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_force ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_t  irq,
const bool  val 
)

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

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

Definition at line 184 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_enabled ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

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

Definition at line 203 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_state ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_state_snapshot_t snapshot 
)

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

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

Definition at line 101 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_get_type ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_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
otp_ctrlA otp_ctrl handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 88 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_is_pending ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

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

Definition at line 129 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_restore_all ( const dif_otp_ctrl_t otp_ctrl,
const dif_otp_ctrl_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
otp_ctrlA otp_ctrl handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 271 of file dif_otp_ctrl_autogen.c.

◆ dif_otp_ctrl_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_otp_ctrl_irq_set_enabled ( const dif_otp_ctrl_t otp_ctrl,
dif_otp_ctrl_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

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

Definition at line 225 of file dif_otp_ctrl_autogen.c.