USBDEV 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_usbdev |
A handle to usbdev. More... | |
Typedefs | |
typedef struct dif_usbdev | dif_usbdev_t |
A handle to usbdev. More... | |
typedef enum dif_usbdev_alert | dif_usbdev_alert_t |
A usbdev alert type. | |
typedef enum dif_usbdev_irq | dif_usbdev_irq_t |
A usbdev interrupt request type. | |
typedef uint32_t | dif_usbdev_irq_state_snapshot_t |
A snapshot of the state of the interrupts for this IP. More... | |
typedef uint32_t | dif_usbdev_irq_enable_snapshot_t |
A snapshot of the enablement state of the interrupts for this IP. More... | |
Enumerations | |
enum | dif_usbdev_alert { kDifUsbdevAlertFatalFault = 0 } |
A usbdev alert type. More... | |
enum | dif_usbdev_irq { kDifUsbdevIrqPktReceived = 0, kDifUsbdevIrqPktSent = 1, kDifUsbdevIrqDisconnected = 2, kDifUsbdevIrqHostLost = 3, kDifUsbdevIrqLinkReset = 4, kDifUsbdevIrqLinkSuspend = 5, kDifUsbdevIrqLinkResume = 6, kDifUsbdevIrqAvOutEmpty = 7, kDifUsbdevIrqRxFull = 8, kDifUsbdevIrqAvOverflow = 9, kDifUsbdevIrqLinkInErr = 10, kDifUsbdevIrqRxCrcErr = 11, kDifUsbdevIrqRxPidErr = 12, kDifUsbdevIrqRxBitstuffErr = 13, kDifUsbdevIrqFrame = 14, kDifUsbdevIrqPowered = 15, kDifUsbdevIrqLinkOutErr = 16, kDifUsbdevIrqAvSetupEmpty = 17 } |
A usbdev interrupt request type. More... | |
Functions | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_usbdev_init (mmio_region_t base_addr, dif_usbdev_t *usbdev) |
Creates a new handle for a(n) usbdev peripheral. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_usbdev_alert_force (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_get_type (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_get_state (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_is_pending (const dif_usbdev_t *usbdev, dif_usbdev_irq_t irq, bool *is_pending) |
Returns whether a particular interrupt is currently pending. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_usbdev_irq_acknowledge_state (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_acknowledge_all (const dif_usbdev_t *usbdev) |
Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_usbdev_irq_acknowledge (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_force (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_get_enabled (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_set_enabled (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_disable_all (const dif_usbdev_t *usbdev, dif_usbdev_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_usbdev_irq_restore_all (const dif_usbdev_t *usbdev, const dif_usbdev_irq_enable_snapshot_t *snapshot) |
Restores interrupts from the given (enable) snapshot. More... | |
USBDEV Device Interface Functions
Definition in file dif_usbdev_autogen.h.
struct dif_usbdev |
A handle to usbdev.
This type should be treated as opaque by users.
Definition at line 32 of file dif_usbdev_autogen.h.
Data Fields | ||
---|---|---|
mmio_region_t | base_addr | The base address for the usbdev hardware registers. |
typedef uint32_t dif_usbdev_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_usbdev_irq_disable_all()
and dif_usbdev_irq_restore_all()
functions.
Definition at line 276 of file dif_usbdev_autogen.h.
typedef uint32_t dif_usbdev_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_usbdev_irq_get_state()
and dif_usbdev_irq_acknowledge_state()
functions.
Definition at line 184 of file dif_usbdev_autogen.h.
typedef struct dif_usbdev dif_usbdev_t |
A handle to usbdev.
This type should be treated as opaque by users.
enum dif_usbdev_alert |
A usbdev alert type.
Enumerator | |
---|---|
kDifUsbdevAlertFatalFault | This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. |
Definition at line 54 of file dif_usbdev_autogen.h.
enum dif_usbdev_irq |
A usbdev interrupt request type.
Definition at line 77 of file dif_usbdev_autogen.h.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_alert_force | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_alert_t | alert | ||
) |
Forces a particular alert, causing it to be escalated as if the hardware had raised it.
usbdev | A usbdev handle. |
alert | The alert to force. |
Definition at line 27 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_init | ( | mmio_region_t | base_addr, |
dif_usbdev_t * | usbdev | ||
) |
Creates a new handle for a(n) usbdev peripheral.
This function does not actuate the hardware.
base_addr | The MMIO base address of the usbdev peripheral. | |
[out] | usbdev | Out param for the initialized handle. |
Definition at line 17 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_acknowledge | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq | ||
) |
Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.
usbdev | A usbdev handle. |
irq | An interrupt request. |
Definition at line 197 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_acknowledge_all | ( | const dif_usbdev_t * | usbdev | ) |
Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.
usbdev | A usbdev handle. |
Definition at line 184 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_acknowledge_state | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_state_snapshot_t | snapshot | ||
) |
Acknowledges all interrupts that were pending at the time of the state snapshot.
usbdev | A usbdev handle. |
snapshot | Interrupt state snapshot. |
Definition at line 151 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_disable_all | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_enable_snapshot_t * | snapshot | ||
) |
Disables all interrupts, optionally snapshotting all enable states for later restoration.
usbdev | A usbdev handle. | |
[out] | snapshot | Out-param for the snapshot; may be NULL . |
Definition at line 283 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_force | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq, | ||
const bool | val | ||
) |
Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.
usbdev | A usbdev handle. |
irq | An interrupt request. |
val | Value to be set. |
Definition at line 217 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_get_enabled | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq, | ||
dif_toggle_t * | state | ||
) |
Checks whether a particular interrupt is currently enabled or disabled.
usbdev | A usbdev handle. | |
irq | An interrupt request. | |
[out] | state | Out-param toggle state of the interrupt. |
Definition at line 236 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_get_state | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_state_snapshot_t * | snapshot | ||
) |
Returns the state of all interrupts (i.e., pending or not) for this IP.
usbdev | A usbdev handle. | |
[out] | snapshot | Out-param for interrupt state snapshot. |
Definition at line 138 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_get_type | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq, | ||
dif_irq_type_t * | type | ||
) |
Returns the type of a given interrupt (i.e., event or status) for this IP.
usbdev | A usbdev handle. | |
irq | An interrupt request. | |
[out] | type | Out-param for the interrupt type. |
Definition at line 125 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_is_pending | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq, | ||
bool * | is_pending | ||
) |
Returns whether a particular interrupt is currently pending.
usbdev | A usbdev handle. | |
irq | An interrupt request. | |
[out] | is_pending | Out-param for whether the interrupt is pending. |
Definition at line 164 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_restore_all | ( | const dif_usbdev_t * | usbdev, |
const dif_usbdev_irq_enable_snapshot_t * | snapshot | ||
) |
Restores interrupts from the given (enable) snapshot.
usbdev | A usbdev handle. |
snapshot | A snapshot to restore from. |
Definition at line 303 of file dif_usbdev_autogen.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_usbdev_irq_set_enabled | ( | const dif_usbdev_t * | usbdev, |
dif_usbdev_irq_t | irq, | ||
dif_toggle_t | state | ||
) |
Sets whether a particular interrupt is currently enabled or disabled.
usbdev | A usbdev handle. |
irq | An interrupt request. |
state | The new toggle state for the interrupt. |
Definition at line 258 of file dif_usbdev_autogen.c.