dif_soc_proxy_autogen.h File Reference

SOC_PROXY 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"
#include "dt/dt_soc_proxy.h"

Go to the source code of this file.

Data Structures
struct	dif_soc_proxy
	A handle to soc_proxy. More...

Macros
#define	kDifSocProxyIrqExternal0   kDtSocProxyIrqExternal0
	A soc_proxy interrupt request type.
#define	kDifSocProxyIrqExternal1   kDtSocProxyIrqExternal1
#define	kDifSocProxyIrqExternal2   kDtSocProxyIrqExternal2
#define	kDifSocProxyIrqExternal3   kDtSocProxyIrqExternal3
#define	kDifSocProxyIrqExternal4   kDtSocProxyIrqExternal4
#define	kDifSocProxyIrqExternal5   kDtSocProxyIrqExternal5
#define	kDifSocProxyIrqExternal6   kDtSocProxyIrqExternal6
#define	kDifSocProxyIrqExternal7   kDtSocProxyIrqExternal7
#define	kDifSocProxyIrqExternal8   kDtSocProxyIrqExternal8
#define	kDifSocProxyIrqExternal9   kDtSocProxyIrqExternal9
#define	kDifSocProxyIrqExternal10   kDtSocProxyIrqExternal10
#define	kDifSocProxyIrqExternal11   kDtSocProxyIrqExternal11
#define	kDifSocProxyIrqExternal12   kDtSocProxyIrqExternal12
#define	kDifSocProxyIrqExternal13   kDtSocProxyIrqExternal13
#define	kDifSocProxyIrqExternal14   kDtSocProxyIrqExternal14
#define	kDifSocProxyIrqExternal15   kDtSocProxyIrqExternal15
#define	kDifSocProxyIrqExternal16   kDtSocProxyIrqExternal16
#define	kDifSocProxyIrqExternal17   kDtSocProxyIrqExternal17
#define	kDifSocProxyIrqExternal18   kDtSocProxyIrqExternal18
#define	kDifSocProxyIrqExternal19   kDtSocProxyIrqExternal19
#define	kDifSocProxyIrqExternal20   kDtSocProxyIrqExternal20
#define	kDifSocProxyIrqExternal21   kDtSocProxyIrqExternal21
#define	kDifSocProxyIrqExternal22   kDtSocProxyIrqExternal22
#define	kDifSocProxyIrqExternal23   kDtSocProxyIrqExternal23
#define	kDifSocProxyIrqExternal24   kDtSocProxyIrqExternal24
#define	kDifSocProxyIrqExternal25   kDtSocProxyIrqExternal25
#define	kDifSocProxyIrqExternal26   kDtSocProxyIrqExternal26
#define	kDifSocProxyIrqExternal27   kDtSocProxyIrqExternal27
#define	kDifSocProxyIrqExternal28   kDtSocProxyIrqExternal28
#define	kDifSocProxyIrqExternal29   kDtSocProxyIrqExternal29
#define	kDifSocProxyIrqExternal30   kDtSocProxyIrqExternal30
#define	kDifSocProxyIrqExternal31   kDtSocProxyIrqExternal31

Typedefs
typedef struct dif_soc_proxy	dif_soc_proxy_t
	A handle to soc_proxy.
typedef enum dif_soc_proxy_alert	dif_soc_proxy_alert_t
	A soc_proxy alert type.
typedef dt_soc_proxy_irq_t	dif_soc_proxy_irq_t
typedef uint32_t	dif_soc_proxy_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP.
typedef uint32_t	dif_soc_proxy_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP.

Enumerations
enum	dif_soc_proxy_alert {   kDifSocProxyAlertFatalAlertIntg = 0 ,   kDifSocProxyAlertFatalAlertExternal0 = 1 ,   kDifSocProxyAlertFatalAlertExternal1 = 2 ,   kDifSocProxyAlertFatalAlertExternal2 = 3 ,   kDifSocProxyAlertFatalAlertExternal3 = 4 ,   kDifSocProxyAlertFatalAlertExternal4 = 5 ,   kDifSocProxyAlertFatalAlertExternal5 = 6 ,   kDifSocProxyAlertFatalAlertExternal6 = 7 ,   kDifSocProxyAlertFatalAlertExternal7 = 8 ,   kDifSocProxyAlertFatalAlertExternal8 = 9 ,   kDifSocProxyAlertFatalAlertExternal9 = 10 ,   kDifSocProxyAlertFatalAlertExternal10 = 11 ,   kDifSocProxyAlertFatalAlertExternal11 = 12 ,   kDifSocProxyAlertFatalAlertExternal12 = 13 ,   kDifSocProxyAlertFatalAlertExternal13 = 14 ,   kDifSocProxyAlertFatalAlertExternal14 = 15 ,   kDifSocProxyAlertFatalAlertExternal15 = 16 ,   kDifSocProxyAlertFatalAlertExternal16 = 17 ,   kDifSocProxyAlertFatalAlertExternal17 = 18 ,   kDifSocProxyAlertFatalAlertExternal18 = 19 ,   kDifSocProxyAlertFatalAlertExternal19 = 20 ,   kDifSocProxyAlertFatalAlertExternal20 = 21 ,   kDifSocProxyAlertFatalAlertExternal21 = 22 ,   kDifSocProxyAlertFatalAlertExternal22 = 23 ,   kDifSocProxyAlertFatalAlertExternal23 = 24 ,   kDifSocProxyAlertRecovAlertExternal0 = 25 ,   kDifSocProxyAlertRecovAlertExternal1 = 26 ,   kDifSocProxyAlertRecovAlertExternal2 = 27 ,   kDifSocProxyAlertRecovAlertExternal3 = 28 }
	A soc_proxy alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_init (mmio_region_t base_addr, dif_soc_proxy_t *soc_proxy)
	Creates a new handle for a(n) soc_proxy peripheral.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_init_from_dt (dt_soc_proxy_t dt, dif_soc_proxy_t *soc_proxy)
	Creates a new handle for a(n) soc_proxy peripheral.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_get_dt (const dif_soc_proxy_t *soc_proxy, dt_soc_proxy_t *dt)
	Get the DT handle from this DIF.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_alert_force (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_alert_t alert)
	Forces a particular alert, causing it to be escalated as if the hardware had raised it.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_get_type (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t, dif_irq_type_t *type)
	Returns the type of a given interrupt (i.e., event or status) for this IP.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_get_state (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_state_snapshot_t *snapshot)
	Returns the state of all interrupts (i.e., pending or not) for this IP.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_is_pending (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t, bool *is_pending)
	Returns whether a particular interrupt is currently pending.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_acknowledge_state (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_state_snapshot_t snapshot)
	Acknowledges all interrupts that were pending at the time of the state snapshot.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_acknowledge_all (const dif_soc_proxy_t *soc_proxy)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_acknowledge (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_force (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t, const bool val)
	Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_get_enabled (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t, dif_toggle_t *state)
	Checks whether a particular interrupt is currently enabled or disabled.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_set_enabled (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_disable_all (const dif_soc_proxy_t *soc_proxy, dif_soc_proxy_irq_enable_snapshot_t *snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.
OT_WARN_UNUSED_RESULT dif_result_t	dif_soc_proxy_irq_restore_all (const dif_soc_proxy_t *soc_proxy, const dif_soc_proxy_irq_enable_snapshot_t *snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

SOC_PROXY Device Interface Functions

Definition in file dif_soc_proxy_autogen.h.

---

Data Structure Documentation

dif_soc_proxy

struct dif_soc_proxy

A handle to soc_proxy.

This type should be treated as opaque by users.

Definition at line 38 of file dif_soc_proxy_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the soc_proxy hardware registers.
dt_soc_proxy_t	dt	The instance, set to kDtSocProxyCount if not initialized through dif_soc_proxy_init_from_dt.

Macro Definition Documentation

kDifSocProxyIrqExternal0

#define kDifSocProxyIrqExternal0   kDtSocProxyIrqExternal0

A soc_proxy interrupt request type.

DEPRECATED Use dt_soc_proxy_irq_t instead. This enumeration exists solely for the transition to dt-based interrupt numbers and will be removed in the future.

The following are defines to keep the types consistent with DT. External interrupt request

Definition at line 247 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal1

#define kDifSocProxyIrqExternal1   kDtSocProxyIrqExternal1

Definition at line 248 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal10

#define kDifSocProxyIrqExternal10   kDtSocProxyIrqExternal10

Definition at line 257 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal11

#define kDifSocProxyIrqExternal11   kDtSocProxyIrqExternal11

Definition at line 258 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal12

#define kDifSocProxyIrqExternal12   kDtSocProxyIrqExternal12

Definition at line 259 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal13

#define kDifSocProxyIrqExternal13   kDtSocProxyIrqExternal13

Definition at line 260 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal14

#define kDifSocProxyIrqExternal14   kDtSocProxyIrqExternal14

Definition at line 261 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal15

#define kDifSocProxyIrqExternal15   kDtSocProxyIrqExternal15

Definition at line 262 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal16

#define kDifSocProxyIrqExternal16   kDtSocProxyIrqExternal16

Definition at line 263 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal17

#define kDifSocProxyIrqExternal17   kDtSocProxyIrqExternal17

Definition at line 264 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal18

#define kDifSocProxyIrqExternal18   kDtSocProxyIrqExternal18

Definition at line 265 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal19

#define kDifSocProxyIrqExternal19   kDtSocProxyIrqExternal19

Definition at line 266 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal2

#define kDifSocProxyIrqExternal2   kDtSocProxyIrqExternal2

Definition at line 249 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal20

#define kDifSocProxyIrqExternal20   kDtSocProxyIrqExternal20

Definition at line 267 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal21

#define kDifSocProxyIrqExternal21   kDtSocProxyIrqExternal21

Definition at line 268 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal22

#define kDifSocProxyIrqExternal22   kDtSocProxyIrqExternal22

Definition at line 269 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal23

#define kDifSocProxyIrqExternal23   kDtSocProxyIrqExternal23

Definition at line 270 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal24

#define kDifSocProxyIrqExternal24   kDtSocProxyIrqExternal24

Definition at line 271 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal25

#define kDifSocProxyIrqExternal25   kDtSocProxyIrqExternal25

Definition at line 272 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal26

#define kDifSocProxyIrqExternal26   kDtSocProxyIrqExternal26

Definition at line 273 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal27

#define kDifSocProxyIrqExternal27   kDtSocProxyIrqExternal27

Definition at line 274 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal28

#define kDifSocProxyIrqExternal28   kDtSocProxyIrqExternal28

Definition at line 275 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal29

#define kDifSocProxyIrqExternal29   kDtSocProxyIrqExternal29

Definition at line 276 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal3

#define kDifSocProxyIrqExternal3   kDtSocProxyIrqExternal3

Definition at line 250 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal30

#define kDifSocProxyIrqExternal30   kDtSocProxyIrqExternal30

Definition at line 277 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal31

#define kDifSocProxyIrqExternal31   kDtSocProxyIrqExternal31

Definition at line 278 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal4

#define kDifSocProxyIrqExternal4   kDtSocProxyIrqExternal4

Definition at line 251 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal5

#define kDifSocProxyIrqExternal5   kDtSocProxyIrqExternal5

Definition at line 252 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal6

#define kDifSocProxyIrqExternal6   kDtSocProxyIrqExternal6

Definition at line 253 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal7

#define kDifSocProxyIrqExternal7   kDtSocProxyIrqExternal7

Definition at line 254 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal8

#define kDifSocProxyIrqExternal8   kDtSocProxyIrqExternal8

Definition at line 255 of file dif_soc_proxy_autogen.h.

kDifSocProxyIrqExternal9

#define kDifSocProxyIrqExternal9   kDtSocProxyIrqExternal9

Definition at line 256 of file dif_soc_proxy_autogen.h.

Typedef Documentation

dif_soc_proxy_irq_enable_snapshot_t

typedef uint32_t dif_soc_proxy_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_soc_proxy_irq_disable_all() and dif_soc_proxy_irq_restore_all() functions.

Definition at line 388 of file dif_soc_proxy_autogen.h.

dif_soc_proxy_irq_state_snapshot_t

typedef uint32_t dif_soc_proxy_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_soc_proxy_irq_get_state() and dif_soc_proxy_irq_acknowledge_state() functions.

Definition at line 286 of file dif_soc_proxy_autogen.h.

dif_soc_proxy_irq_t

typedef dt_soc_proxy_irq_t dif_soc_proxy_irq_t

Definition at line 233 of file dif_soc_proxy_autogen.h.

dif_soc_proxy_t

typedef struct dif_soc_proxy dif_soc_proxy_t

A handle to soc_proxy.

This type should be treated as opaque by users.

Enumeration Type Documentation

dif_soc_proxy_alert

enum dif_soc_proxy_alert

A soc_proxy alert type.

Enumerator
kDifSocProxyAlertFatalAlertIntg	Fatal bus integrity alert.
kDifSocProxyAlertFatalAlertExternal0	Fatal external alert channel 0.
kDifSocProxyAlertFatalAlertExternal1	Fatal external alert channel 1.
kDifSocProxyAlertFatalAlertExternal2	Fatal external alert channel 2.
kDifSocProxyAlertFatalAlertExternal3	Fatal external alert channel 3.
kDifSocProxyAlertFatalAlertExternal4	Fatal external alert channel 4.
kDifSocProxyAlertFatalAlertExternal5	Fatal external alert channel 5.
kDifSocProxyAlertFatalAlertExternal6	Fatal external alert channel 6.
kDifSocProxyAlertFatalAlertExternal7	Fatal external alert channel 7.
kDifSocProxyAlertFatalAlertExternal8	Fatal external alert channel 8.
kDifSocProxyAlertFatalAlertExternal9	Fatal external alert channel 9.
kDifSocProxyAlertFatalAlertExternal10	Fatal external alert channel 10.
kDifSocProxyAlertFatalAlertExternal11	Fatal external alert channel 11.
kDifSocProxyAlertFatalAlertExternal12	Fatal external alert channel 12.
kDifSocProxyAlertFatalAlertExternal13	Fatal external alert channel 13.
kDifSocProxyAlertFatalAlertExternal14	Fatal external alert channel 14.
kDifSocProxyAlertFatalAlertExternal15	Fatal external alert channel 15.
kDifSocProxyAlertFatalAlertExternal16	Fatal external alert channel 16.
kDifSocProxyAlertFatalAlertExternal17	Fatal external alert channel 17.
kDifSocProxyAlertFatalAlertExternal18	Fatal external alert channel 18.
kDifSocProxyAlertFatalAlertExternal19	Fatal external alert channel 19.
kDifSocProxyAlertFatalAlertExternal20	Fatal external alert channel 20.
kDifSocProxyAlertFatalAlertExternal21	Fatal external alert channel 21.
kDifSocProxyAlertFatalAlertExternal22	Fatal external alert channel 22.
kDifSocProxyAlertFatalAlertExternal23	Fatal external alert channel 23.
kDifSocProxyAlertRecovAlertExternal0	Recoverable external alert channel 0.
kDifSocProxyAlertRecovAlertExternal1	Recoverable external alert channel 1.
kDifSocProxyAlertRecovAlertExternal2	Recoverable external alert channel 2.
kDifSocProxyAlertRecovAlertExternal3	Recoverable external alert channel 3.

Definition at line 99 of file dif_soc_proxy_autogen.h.

Function Documentation

dif_soc_proxy_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_alert_force	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_alert_t	alert )

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

Parameters

soc_proxy	A soc_proxy handle.
alert	The alert to force.

Returns

The result of the operation.

Definition at line 63 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_get_dt	(	const dif_soc_proxy_t *	soc_proxy,
		dt_soc_proxy_t *	dt )

Get the DT handle from this DIF.

If this DIF was initialized by dif_soc_proxy_init_from_dt(dt, ..) then this function will return dt. Otherwise it will return an error.

Parameters

	soc_proxy	A soc_proxy handle.
[out]	dt	DT handle.

Returns

kDifBadArg if the DIF has no DT information, kDifOk otherwise.

Definition at line 53 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_init	(	mmio_region_t	base_addr,
		dif_soc_proxy_t *	soc_proxy )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the soc_proxy peripheral.
[out]	soc_proxy	Out param for the initialized handle.

Returns

The result of the operation.

DEPRECATED This function exists solely for the transition to dt-based DIFs and will be removed in the future.

Definition at line 26 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_init_from_dt	(	dt_soc_proxy_t	dt,
		dif_soc_proxy_t *	soc_proxy )

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

This function does not actuate the hardware.

Parameters

	dt	The devicetable description of the device.
[out]	soc_proxy	Out param for the initialized handle.

Returns

The result of the operation.

Definition at line 40 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_acknowledge	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq )

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

Parameters

soc_proxy	A soc_proxy handle.
irq	An interrupt request.

Returns

The result of the operation.

Definition at line 387 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_acknowledge_all

(

const dif_soc_proxy_t *

soc_proxy

)

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

Parameters

soc_proxy

A soc_proxy handle.

Returns

The result of the operation.

Definition at line 368 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_acknowledge_state	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_state_snapshot_t	snapshot )

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

Parameters

soc_proxy	A soc_proxy handle.
snapshot	Interrupt state snapshot.

Returns

The result of the operation.

Definition at line 326 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_disable_all	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_enable_snapshot_t *	snapshot )

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

Parameters

	soc_proxy	A soc_proxy handle.
[out]	snapshot	Out-param for the snapshot; may be NULL.

Returns

The result of the operation.

Definition at line 495 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_force	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq,
		const bool	val )

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

Parameters

soc_proxy	A soc_proxy handle.
irq	An interrupt request.
val	Value to be set.

Returns

The result of the operation.

Definition at line 412 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_get_enabled	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

	soc_proxy	A soc_proxy handle.
	irq	An interrupt request.
[out]	state	Out-param toggle state of the interrupt.

Returns

The result of the operation.

Definition at line 437 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_get_state	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_state_snapshot_t *	snapshot )

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

Parameters

	soc_proxy	A soc_proxy handle.
[out]	snapshot	Out-param for interrupt state snapshot.

Returns

The result of the operation.

Definition at line 309 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_get_type	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

	soc_proxy	A soc_proxy handle.
	irq	An interrupt request.
[out]	type	Out-param for the interrupt type.

Returns

The result of the operation.

Definition at line 290 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_is_pending	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	soc_proxy	A soc_proxy handle.
	irq	An interrupt request.
[out]	is_pending	Out-param for whether the interrupt is pending.

Returns

The result of the operation.

Definition at line 343 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_restore_all	(	const dif_soc_proxy_t *	soc_proxy,
		const dif_soc_proxy_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

soc_proxy	A soc_proxy handle.
snapshot	A snapshot to restore from.

Returns

The result of the operation.

Definition at line 522 of file dif_soc_proxy_autogen.c.

dif_soc_proxy_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_soc_proxy_irq_set_enabled	(	const dif_soc_proxy_t *	soc_proxy,
		dif_soc_proxy_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

soc_proxy	A soc_proxy handle.
irq	An interrupt request.
state	The new toggle state for the interrupt.

Returns

The result of the operation.

Definition at line 464 of file dif_soc_proxy_autogen.c.