USB test suite - guide

• Introduction
  • Structure of this document
• Quickstart
  • Prerequisites
  • Steps
  • Additional setup
• Project architecture
  • Repository structure
    • usb-test-suite-cocotb-usb
    • usb-test-suite-testbenches
    • Other submodules
• Running the tests
• Supported targets
  • ValentyUSB IP core
  • usb1_device
  • Foboot
  • TinyFPGA-Bootloader
  • tnt`s USB IP core
• Example tests
  • test-basic
  • test-sequence
  • test-sof
  • test-enum
  • test-w10enum
  • test-macOSenum
  • test-clocks
  • test-cdc
  • test-valenty-cdc
• Development
  • Adding new tests
    • Obtaining test harness
    • Resetting the device
    • Providing clock signals
    • Waiting and recovery periods
    • Sending requests
    • Verifying responses
    • Using low-level functions
  • Adding new test target
    • Necessary files
    • Naming scheme
    • LiteX wrapper
    • Target-specific makefile
    • Testbench file
    • Descriptor config file
  • Adding new USB class
    • Class descriptors
    • Class requests
    • Parser and config file support
    • Documentation
• cocotb_usb module
  • Setup
  • Usage
    • Quickstart
• cocotb_usb module reference
  • Descriptors
  • Supported USB device classes
    • DFU
    • CDC
  • Clocks and triggers
  • Device
  • Host
  • Monitor
  • Harness