dif_gpio_autogen.h File Reference

GPIO 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_gpio.h"

Go to the source code of this file.

Data Structures
struct	dif_gpio
	A handle to gpio. More...

Macros
#define	kDifGpioIrqGpio0   kDtGpioIrqGpio0
	A gpio interrupt request type.
#define	kDifGpioIrqGpio1   kDtGpioIrqGpio1
#define	kDifGpioIrqGpio2   kDtGpioIrqGpio2
#define	kDifGpioIrqGpio3   kDtGpioIrqGpio3
#define	kDifGpioIrqGpio4   kDtGpioIrqGpio4
#define	kDifGpioIrqGpio5   kDtGpioIrqGpio5
#define	kDifGpioIrqGpio6   kDtGpioIrqGpio6
#define	kDifGpioIrqGpio7   kDtGpioIrqGpio7
#define	kDifGpioIrqGpio8   kDtGpioIrqGpio8
#define	kDifGpioIrqGpio9   kDtGpioIrqGpio9
#define	kDifGpioIrqGpio10   kDtGpioIrqGpio10
#define	kDifGpioIrqGpio11   kDtGpioIrqGpio11
#define	kDifGpioIrqGpio12   kDtGpioIrqGpio12
#define	kDifGpioIrqGpio13   kDtGpioIrqGpio13
#define	kDifGpioIrqGpio14   kDtGpioIrqGpio14
#define	kDifGpioIrqGpio15   kDtGpioIrqGpio15
#define	kDifGpioIrqGpio16   kDtGpioIrqGpio16
#define	kDifGpioIrqGpio17   kDtGpioIrqGpio17
#define	kDifGpioIrqGpio18   kDtGpioIrqGpio18
#define	kDifGpioIrqGpio19   kDtGpioIrqGpio19
#define	kDifGpioIrqGpio20   kDtGpioIrqGpio20
#define	kDifGpioIrqGpio21   kDtGpioIrqGpio21
#define	kDifGpioIrqGpio22   kDtGpioIrqGpio22
#define	kDifGpioIrqGpio23   kDtGpioIrqGpio23
#define	kDifGpioIrqGpio24   kDtGpioIrqGpio24
#define	kDifGpioIrqGpio25   kDtGpioIrqGpio25
#define	kDifGpioIrqGpio26   kDtGpioIrqGpio26
#define	kDifGpioIrqGpio27   kDtGpioIrqGpio27
#define	kDifGpioIrqGpio28   kDtGpioIrqGpio28
#define	kDifGpioIrqGpio29   kDtGpioIrqGpio29
#define	kDifGpioIrqGpio30   kDtGpioIrqGpio30
#define	kDifGpioIrqGpio31   kDtGpioIrqGpio31

Typedefs
typedef struct dif_gpio	dif_gpio_t
	A handle to gpio.
typedef enum dif_gpio_alert	dif_gpio_alert_t
	A gpio alert type.
typedef dt_gpio_irq_t	dif_gpio_irq_t
typedef uint32_t	dif_gpio_irq_state_snapshot_t
	A snapshot of the state of the interrupts for this IP.
typedef uint32_t	dif_gpio_irq_enable_snapshot_t
	A snapshot of the enablement state of the interrupts for this IP.

Enumerations
enum	dif_gpio_alert { kDifGpioAlertFatalFault = 0 }
	A gpio alert type. More...

Functions
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_init (mmio_region_t base_addr, dif_gpio_t *gpio)
	Creates a new handle for a(n) gpio peripheral.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_init_from_dt (dt_gpio_t dt, dif_gpio_t *gpio)
	Creates a new handle for a(n) gpio peripheral.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_get_dt (const dif_gpio_t *gpio, dt_gpio_t *dt)
	Get the DT handle from this DIF.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_alert_force (const dif_gpio_t *gpio, dif_gpio_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_gpio_irq_get_type (const dif_gpio_t *gpio, dif_gpio_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_gpio_irq_get_state (const dif_gpio_t *gpio, dif_gpio_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_gpio_irq_is_pending (const dif_gpio_t *gpio, dif_gpio_irq_t, bool *is_pending)
	Returns whether a particular interrupt is currently pending.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_acknowledge_state (const dif_gpio_t *gpio, dif_gpio_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_gpio_irq_acknowledge_all (const dif_gpio_t *gpio)
	Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_acknowledge (const dif_gpio_t *gpio, dif_gpio_irq_t)
	Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_force (const dif_gpio_t *gpio, dif_gpio_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_gpio_irq_get_enabled (const dif_gpio_t *gpio, dif_gpio_irq_t, dif_toggle_t *state)
	Checks whether a particular interrupt is currently enabled or disabled.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_set_enabled (const dif_gpio_t *gpio, dif_gpio_irq_t, dif_toggle_t state)
	Sets whether a particular interrupt is currently enabled or disabled.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_disable_all (const dif_gpio_t *gpio, dif_gpio_irq_enable_snapshot_t *snapshot)
	Disables all interrupts, optionally snapshotting all enable states for later restoration.
OT_WARN_UNUSED_RESULT dif_result_t	dif_gpio_irq_restore_all (const dif_gpio_t *gpio, const dif_gpio_irq_enable_snapshot_t *snapshot)
	Restores interrupts from the given (enable) snapshot.

Detailed Description

GPIO Device Interface Functions

Definition in file dif_gpio_autogen.h.

---

Data Structure Documentation

dif_gpio

struct dif_gpio

A handle to gpio.

This type should be treated as opaque by users.

Definition at line 37 of file dif_gpio_autogen.h.

Data Fields
mmio_region_t	base_addr	The base address for the gpio hardware registers.
dt_gpio_t	dt	The instance, set to kDtGpioCount if not initialized through dif_gpio_init_from_dt.

Macro Definition Documentation

kDifGpioIrqGpio0

#define kDifGpioIrqGpio0   kDtGpioIrqGpio0

A gpio interrupt request type.

DEPRECATED Use dt_gpio_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. Raised if any of GPIO pin detects configured interrupt mode

Definition at line 134 of file dif_gpio_autogen.h.

kDifGpioIrqGpio1

#define kDifGpioIrqGpio1   kDtGpioIrqGpio1

Definition at line 135 of file dif_gpio_autogen.h.

kDifGpioIrqGpio10

#define kDifGpioIrqGpio10   kDtGpioIrqGpio10

Definition at line 144 of file dif_gpio_autogen.h.

kDifGpioIrqGpio11

#define kDifGpioIrqGpio11   kDtGpioIrqGpio11

Definition at line 145 of file dif_gpio_autogen.h.

kDifGpioIrqGpio12

#define kDifGpioIrqGpio12   kDtGpioIrqGpio12

Definition at line 146 of file dif_gpio_autogen.h.

kDifGpioIrqGpio13

#define kDifGpioIrqGpio13   kDtGpioIrqGpio13

Definition at line 147 of file dif_gpio_autogen.h.

kDifGpioIrqGpio14

#define kDifGpioIrqGpio14   kDtGpioIrqGpio14

Definition at line 148 of file dif_gpio_autogen.h.

kDifGpioIrqGpio15

#define kDifGpioIrqGpio15   kDtGpioIrqGpio15

Definition at line 149 of file dif_gpio_autogen.h.

kDifGpioIrqGpio16

#define kDifGpioIrqGpio16   kDtGpioIrqGpio16

Definition at line 150 of file dif_gpio_autogen.h.

kDifGpioIrqGpio17

#define kDifGpioIrqGpio17   kDtGpioIrqGpio17

Definition at line 151 of file dif_gpio_autogen.h.

kDifGpioIrqGpio18

#define kDifGpioIrqGpio18   kDtGpioIrqGpio18

Definition at line 152 of file dif_gpio_autogen.h.

kDifGpioIrqGpio19

#define kDifGpioIrqGpio19   kDtGpioIrqGpio19

Definition at line 153 of file dif_gpio_autogen.h.

kDifGpioIrqGpio2

#define kDifGpioIrqGpio2   kDtGpioIrqGpio2

Definition at line 136 of file dif_gpio_autogen.h.

kDifGpioIrqGpio20

#define kDifGpioIrqGpio20   kDtGpioIrqGpio20

Definition at line 154 of file dif_gpio_autogen.h.

kDifGpioIrqGpio21

#define kDifGpioIrqGpio21   kDtGpioIrqGpio21

Definition at line 155 of file dif_gpio_autogen.h.

kDifGpioIrqGpio22

#define kDifGpioIrqGpio22   kDtGpioIrqGpio22

Definition at line 156 of file dif_gpio_autogen.h.

kDifGpioIrqGpio23

#define kDifGpioIrqGpio23   kDtGpioIrqGpio23

Definition at line 157 of file dif_gpio_autogen.h.

kDifGpioIrqGpio24

#define kDifGpioIrqGpio24   kDtGpioIrqGpio24

Definition at line 158 of file dif_gpio_autogen.h.

kDifGpioIrqGpio25

#define kDifGpioIrqGpio25   kDtGpioIrqGpio25

Definition at line 159 of file dif_gpio_autogen.h.

kDifGpioIrqGpio26

#define kDifGpioIrqGpio26   kDtGpioIrqGpio26

Definition at line 160 of file dif_gpio_autogen.h.

kDifGpioIrqGpio27

#define kDifGpioIrqGpio27   kDtGpioIrqGpio27

Definition at line 161 of file dif_gpio_autogen.h.

kDifGpioIrqGpio28

#define kDifGpioIrqGpio28   kDtGpioIrqGpio28

Definition at line 162 of file dif_gpio_autogen.h.

kDifGpioIrqGpio29

#define kDifGpioIrqGpio29   kDtGpioIrqGpio29

Definition at line 163 of file dif_gpio_autogen.h.

kDifGpioIrqGpio3

#define kDifGpioIrqGpio3   kDtGpioIrqGpio3

Definition at line 137 of file dif_gpio_autogen.h.

kDifGpioIrqGpio30

#define kDifGpioIrqGpio30   kDtGpioIrqGpio30

Definition at line 164 of file dif_gpio_autogen.h.

kDifGpioIrqGpio31

#define kDifGpioIrqGpio31   kDtGpioIrqGpio31

Definition at line 165 of file dif_gpio_autogen.h.

kDifGpioIrqGpio4

#define kDifGpioIrqGpio4   kDtGpioIrqGpio4

Definition at line 138 of file dif_gpio_autogen.h.

kDifGpioIrqGpio5

#define kDifGpioIrqGpio5   kDtGpioIrqGpio5

Definition at line 139 of file dif_gpio_autogen.h.

kDifGpioIrqGpio6

#define kDifGpioIrqGpio6   kDtGpioIrqGpio6

Definition at line 140 of file dif_gpio_autogen.h.

kDifGpioIrqGpio7

#define kDifGpioIrqGpio7   kDtGpioIrqGpio7

Definition at line 141 of file dif_gpio_autogen.h.

kDifGpioIrqGpio8

#define kDifGpioIrqGpio8   kDtGpioIrqGpio8

Definition at line 142 of file dif_gpio_autogen.h.

kDifGpioIrqGpio9

#define kDifGpioIrqGpio9   kDtGpioIrqGpio9

Definition at line 143 of file dif_gpio_autogen.h.

Typedef Documentation

dif_gpio_irq_enable_snapshot_t

typedef uint32_t dif_gpio_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_gpio_irq_disable_all() and dif_gpio_irq_restore_all() functions.

Definition at line 275 of file dif_gpio_autogen.h.

dif_gpio_irq_state_snapshot_t

typedef uint32_t dif_gpio_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_gpio_irq_get_state() and dif_gpio_irq_acknowledge_state() functions.

Definition at line 173 of file dif_gpio_autogen.h.

dif_gpio_irq_t

typedef dt_gpio_irq_t dif_gpio_irq_t

Definition at line 120 of file dif_gpio_autogen.h.

dif_gpio_t

typedef struct dif_gpio dif_gpio_t

A handle to gpio.

This type should be treated as opaque by users.

Enumeration Type Documentation

dif_gpio_alert

enum dif_gpio_alert

A gpio alert type.

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

Definition at line 98 of file dif_gpio_autogen.h.

Function Documentation

dif_gpio_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_alert_force	(	const dif_gpio_t *	gpio,
		dif_gpio_alert_t	alert )

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

Parameters

gpio	A gpio handle.
alert	The alert to force.

Returns

The result of the operation.

Definition at line 62 of file dif_gpio_autogen.c.

dif_gpio_get_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_get_dt	(	const dif_gpio_t *	gpio,
		dt_gpio_t *	dt )

Get the DT handle from this DIF.

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

Parameters

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

Returns

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

Definition at line 52 of file dif_gpio_autogen.c.

dif_gpio_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_init	(	mmio_region_t	base_addr,
		dif_gpio_t *	gpio )

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

This function does not actuate the hardware.

Parameters

	base_addr	The MMIO base address of the gpio peripheral.
[out]	gpio	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 25 of file dif_gpio_autogen.c.

dif_gpio_init_from_dt()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_init_from_dt	(	dt_gpio_t	dt,
		dif_gpio_t *	gpio )

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

This function does not actuate the hardware.

Parameters

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

Returns

The result of the operation.

Definition at line 39 of file dif_gpio_autogen.c.

dif_gpio_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_acknowledge	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq )

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

Parameters

gpio	A gpio handle.
irq	An interrupt request.

Returns

The result of the operation.

Definition at line 302 of file dif_gpio_autogen.c.

dif_gpio_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_acknowledge_all

(

const dif_gpio_t *

gpio

)

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

Parameters

gpio	A gpio handle.

Returns

The result of the operation.

Definition at line 283 of file dif_gpio_autogen.c.

dif_gpio_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_acknowledge_state	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_state_snapshot_t	snapshot )

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

Parameters

gpio	A gpio handle.
snapshot	Interrupt state snapshot.

Returns

The result of the operation.

Definition at line 241 of file dif_gpio_autogen.c.

dif_gpio_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_disable_all	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_enable_snapshot_t *	snapshot )

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

Parameters

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

Returns

The result of the operation.

Definition at line 410 of file dif_gpio_autogen.c.

dif_gpio_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_force	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq,
		const bool	val )

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

Parameters

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

Returns

The result of the operation.

Definition at line 327 of file dif_gpio_autogen.c.

dif_gpio_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_get_enabled	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq,
		dif_toggle_t *	state )

Checks whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns

The result of the operation.

Definition at line 352 of file dif_gpio_autogen.c.

dif_gpio_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_get_state	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_state_snapshot_t *	snapshot )

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

Parameters

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

Returns

The result of the operation.

Definition at line 224 of file dif_gpio_autogen.c.

dif_gpio_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_get_type	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq,
		dif_irq_type_t *	type )

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

Parameters

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

Returns

The result of the operation.

Definition at line 205 of file dif_gpio_autogen.c.

dif_gpio_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_is_pending	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq,
		bool *	is_pending )

Returns whether a particular interrupt is currently pending.

Parameters

	gpio	A gpio 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 258 of file dif_gpio_autogen.c.

dif_gpio_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_restore_all	(	const dif_gpio_t *	gpio,
		const dif_gpio_irq_enable_snapshot_t *	snapshot )

Restores interrupts from the given (enable) snapshot.

Parameters

gpio	A gpio handle.
snapshot	A snapshot to restore from.

Returns

The result of the operation.

Definition at line 437 of file dif_gpio_autogen.c.

dif_gpio_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_gpio_irq_set_enabled	(	const dif_gpio_t *	gpio,
		dif_gpio_irq_t	irq,
		dif_toggle_t	state )

Sets whether a particular interrupt is currently enabled or disabled.

Parameters

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

Returns

The result of the operation.

Definition at line 379 of file dif_gpio_autogen.c.