Skip to content

Latest commit

 

History

History
76 lines (63 loc) · 11.7 KB

interfaces.md

File metadata and controls

76 lines (63 loc) · 11.7 KB
Raw

Hardware Interfaces

Referring to the Comportable guideline for peripheral device functionality, the module usbdev has the following hardware interfaces defined

  • Primary Clock: clk_i
  • Other Clocks: clk_aon_i
  • Bus Device Interfaces (TL-UL): tl
  • Bus Host Interfaces (TL-UL): none

Peripheral Pins for Chip IO

Pin name Direction Description
sense input USB host VBUS sense
usb_dp inout USB data D+
usb_dn inout USB data D-

Inter-Module Signals

Port Name Package::Struct Type Act Width Description
usb_rx_d logic uni rcv 1 USB RX data from an external differential receiver, if available
usb_tx_d logic uni req 1 USB transmit data value (not used if usb_tx_se0 is set)
usb_tx_se0 logic uni req 1 Force transmission of a USB single-ended zero (i.e. both D+ and D- are low) regardless of usb_tx_d
usb_tx_use_d_se0 logic uni req 1 Use the usb_tx_d and usb_tx_se0 TX interface, instead of usb_dp_o and usb_dn_o
usb_dp_pullup logic uni req 1 USB D+ pullup control
usb_dn_pullup logic uni req 1 USB D- pullup control
usb_rx_enable logic uni req 1 USB differential receiver enable
usb_ref_val logic uni req 1 This indicates that USB timing reference signal 'usb_ref_pulse' is valid
usb_ref_pulse logic uni req 1 USB timing reference signal. This signal pulses for a single 48MHz clock every 1ms USB frame
usb_aon_suspend_req logic uni req 1 Request to activate the AON/Wake module and take control of the USB pullups
usb_aon_wake_ack logic uni req 1 Acknowledge a wake signal from the AON/Wake and relinquish control of the USB pullups
usb_aon_bus_reset logic uni rcv 1 Indicates that the reason for waking was that a USB Bus Reset occurred
usb_aon_sense_lost logic uni rcv 1 Indicates that the reason for waking was that the VBUS/SENSE signal became deasserted
usb_aon_bus_not_idle logic uni rcv 1 Indicates that the reason for waking was that the USB is in a non-idle state
usb_aon_wake_detect_active logic uni rcv 1 Indicates that the external AON/Wake module is active and controlling the USB pullups
ram_cfg prim_ram_1p_pkg::ram_1p_cfg uni rcv 1
tl tlul_pkg::tl req_rsp rsp 1

Interrupts

Interrupt Name Type Description
pkt_received Status 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.
pkt_sent Status 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.
disconnected Event Raised if VBUS is lost, thus the link is disconnected.
host_lost Event Raised if link is active but SOF was not received from host for 4.096 ms. The SOF should be every 1 ms.
link_reset Event 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).
link_suspend Event Raised if the line has signaled J for longer than 3ms and is therefore in suspend state.
link_resume Event Raised when the link becomes active again after being suspended.
av_out_empty Status 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 with a free buffer before the interrupt can be cleared.
rx_full Status 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.
av_overflow Event Raised if a write was done to either the Available OUT Buffer FIFO or the Available SETUP Buffer FIFO when the FIFO was full.
link_in_err Event 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.
rx_crc_err Event Raised if a CRC error occurred on a received packet.
rx_pid_err Event Raised if an invalid Packet IDentifier (PID) was received.
rx_bitstuff_err Event Raised if an invalid bitstuffing was received.
frame Event Raised when the USB frame number is updated with a valid SOF.
powered Event Raised if VBUS is applied.
link_out_err Event 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.
av_setup_empty Status 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 with a free buffer before the interrupt can be cleared.

Security Alerts

Alert Name Description
fatal_fault This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Security Countermeasures

Countermeasure ID Description
USBDEV.BUS.INTEGRITY End-to-end bus integrity scheme.