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

(a649ec5)

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...
 

Detailed Description

USBDEV Device Interface Functions

Definition in file dif_usbdev_autogen.h.


Data Structure Documentation

◆ dif_usbdev

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 Documentation

◆ 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 278 of file dif_usbdev_autogen.h.

◆ 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 186 of file dif_usbdev_autogen.h.

◆ dif_usbdev_t

typedef struct dif_usbdev dif_usbdev_t

A handle to usbdev.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ 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.

◆ dif_usbdev_irq

A usbdev interrupt request type.

Enumerator
kDifUsbdevIrqPktReceived 

Raised if a packet was received using an OUT or SETUP transaction.

This interrupt is directly tied to whether the RX FIFO is empty, so it should be cleared only after handling the FIFO entry.

kDifUsbdevIrqPktSent 

Raised if a packet was sent as part of an IN transaction.

This interrupt is directly tied to whether a sent packet has not been acknowledged in the !!in_sent register. It should be cleared only after clearing all bits in the !!in_sent register.

kDifUsbdevIrqDisconnected 

Raised if VBUS is lost, thus the link is disconnected.

kDifUsbdevIrqHostLost 

Raised if link is active but SOF was not received from host for 4.096 ms.

The SOF should be every 1 ms.

kDifUsbdevIrqLinkReset 

Raised if the link is at SE0 longer than 3 us indicating a link reset (host asserts for min 10 ms, device can react after 2.5 us).

kDifUsbdevIrqLinkSuspend 

Raised if the line has signaled J for longer than 3ms and is therefore in suspend state.

kDifUsbdevIrqLinkResume 

Raised when the link becomes active again after being suspended.

kDifUsbdevIrqAvOutEmpty 

Raised when the Available OUT Buffer FIFO is empty and the device interface is enabled.

This interrupt is directly tied to the FIFO status, so the Available OUT Buffer FIFO must be provided a free buffer before the interrupt is cleared. If the condition is not cleared, the interrupt can re-assert.

kDifUsbdevIrqRxFull 

Raised when the RX FIFO is full and the device interface is enabled.

This interrupt is directly tied to the FIFO status, so the RX FIFO must have an entry removed before the interrupt is cleared. If the condition is not cleared, the interrupt can re-assert.

kDifUsbdevIrqAvOverflow 

Raised if a write was done to either the Available OUT Buffer FIFO or the Available SETUP Buffer FIFO when the FIFO was full.

kDifUsbdevIrqLinkInErr 

Raised if a packet to an IN endpoint started to be received but was then dropped due to an error.

After transmitting the IN payload, the USB device expects a valid ACK handshake packet. This error is raised if either the packet or CRC is invalid, leading to a NAK instead, or if a different token was received.

kDifUsbdevIrqRxCrcErr 

Raised if a CRC error occurred on a received packet.

kDifUsbdevIrqRxPidErr 

Raised if an invalid Packet IDentifier (PID) was received.

kDifUsbdevIrqRxBitstuffErr 

Raised if an invalid bitstuffing was received.

kDifUsbdevIrqFrame 

Raised when the USB frame number is updated with a valid SOF.

kDifUsbdevIrqPowered 

Raised if VBUS is applied.

kDifUsbdevIrqLinkOutErr 

Raised if a packet to an OUT endpoint started to be received but was then dropped due to an error.

This error is raised if the data toggle, token, packet and/or CRC are invalid, or if the appropriate Available OUT Buffer FIFO is empty and/or the Received Buffer FIFO is full when a packet should have been received.

kDifUsbdevIrqAvSetupEmpty 

Raised when the Available SETUP Buffer FIFO is empty and the device interface is enabled.

This interrupt is directly tied to the FIFO status, so the Available SETUP Buffer FIFO must be provided a free buffer before the interrupt is cleared. If the condition is not cleared, the interrupt can re-assert.

Definition at line 77 of file dif_usbdev_autogen.h.

Function Documentation

◆ dif_usbdev_alert_force()

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.

Parameters
usbdevA usbdev handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_usbdev_autogen.c.

◆ dif_usbdev_init()

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.

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

Definition at line 17 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_acknowledge()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 197 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_acknowledge_all()

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.

Parameters
usbdevA usbdev handle.
Returns
The result of the operation.

Definition at line 184 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_acknowledge_state()

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.

Parameters
usbdevA usbdev handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 151 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_disable_all()

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.

Parameters
usbdevA usbdev handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 283 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_force()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 217 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_get_enabled()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 236 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_get_state()

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.

Parameters
usbdevA usbdev handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 138 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_get_type()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 125 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_is_pending()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 164 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_restore_all()

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.

Parameters
usbdevA usbdev handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 303 of file dif_usbdev_autogen.c.

◆ dif_usbdev_irq_set_enabled()

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.

Parameters
usbdevA usbdev handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 258 of file dif_usbdev_autogen.c.