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

(a649ec5)

PINMUX 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_pinmux
 A handle to pinmux. More...
 

Typedefs

typedef struct dif_pinmux dif_pinmux_t
 A handle to pinmux. More...
 
typedef enum dif_pinmux_alert dif_pinmux_alert_t
 A pinmux alert type.
 

Enumerations

enum  dif_pinmux_alert { kDifPinmuxAlertFatalFault = 0 }
 A pinmux alert type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_pinmux_init (mmio_region_t base_addr, dif_pinmux_t *pinmux)
 Creates a new handle for a(n) pinmux peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_pinmux_alert_force (const dif_pinmux_t *pinmux, dif_pinmux_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 

Detailed Description

PINMUX Device Interface Functions

Definition in file dif_pinmux_autogen.h.


Data Structure Documentation

◆ dif_pinmux

struct dif_pinmux

A handle to pinmux.

This type should be treated as opaque by users.

Definition at line 32 of file dif_pinmux_autogen.h.

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

Typedef Documentation

◆ dif_pinmux_t

typedef struct dif_pinmux dif_pinmux_t

A handle to pinmux.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_pinmux_alert

A pinmux alert type.

Enumerator
kDifPinmuxAlertFatalFault 

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

Definition at line 54 of file dif_pinmux_autogen.h.

Function Documentation

◆ dif_pinmux_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_pinmux_alert_force ( const dif_pinmux_t pinmux,
dif_pinmux_alert_t  alert 
)

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

Parameters
pinmuxA pinmux handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_pinmux_autogen.c.

◆ dif_pinmux_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_pinmux_init ( mmio_region_t  base_addr,
dif_pinmux_t pinmux 
)

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

This function does not actuate the hardware.

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

Definition at line 17 of file dif_pinmux_autogen.c.