(4877b48)

LC_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_lc_ctrl
	A handle to lc_ctrl. More...

Typedefs
typedef struct dif_lc_ctrl	dif_lc_ctrl_t
	A handle to lc_ctrl. More...

typedef enum dif_lc_ctrl_alert	dif_lc_ctrl_alert_t
	A lc_ctrl alert type.

Enumerations
enum	dif_lc_ctrl_alert { kDifLcCtrlAlertFatalProgError = 0, kDifLcCtrlAlertFatalStateError = 1, kDifLcCtrlAlertFatalBusIntegError = 2 }
	A lc_ctrl alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_lc_ctrl_init (mmio_region_t base_addr, dif_lc_ctrl_t *lc_ctrl)
	Creates a new handle for a(n) lc_ctrl peripheral. More...

OT_WARN_UNUSED_RESULT dif_result_t	dif_lc_ctrl_alert_force (const dif_lc_ctrl_t *lc_ctrl, dif_lc_ctrl_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...

Detailed Description

LC_CTRL Device Interface Functions

Definition in file dif_lc_ctrl_autogen.h.

Data Structure Documentation

◆ dif_lc_ctrl

struct dif_lc_ctrl

A handle to lc_ctrl.

This type should be treated as opaque by users.

Definition at line 32 of file dif_lc_ctrl_autogen.h.

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

Typedef Documentation

◆ dif_lc_ctrl_t

typedef struct dif_lc_ctrl dif_lc_ctrl_t

A handle to lc_ctrl.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_lc_ctrl_alert

enum dif_lc_ctrl_alert

A lc_ctrl alert type.

Enumerator
kDifLcCtrlAlertFatalProgError	This alert triggers if an error occurred during an OTP programming operation.
kDifLcCtrlAlertFatalStateError	This alert triggers if an error in the life cycle state or life cycle controller FSM is detected.
kDifLcCtrlAlertFatalBusIntegError	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 54 of file dif_lc_ctrl_autogen.h.

Function Documentation

◆ dif_lc_ctrl_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_lc_ctrl_alert_force	(	const dif_lc_ctrl_t *	lc_ctrl,
		dif_lc_ctrl_alert_t	alert
	)

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

Parameters

lc_ctrl	A lc_ctrl handle.
alert	The alert to force.

Returns: The result of the operation.

Definition at line 27 of file dif_lc_ctrl_autogen.c.

◆ dif_lc_ctrl_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_lc_ctrl_init	(	mmio_region_t	base_addr,
		dif_lc_ctrl_t *	lc_ctrl
	)

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

This function does not actuate the hardware.