├── conf ├── requirements.txt └── environment.yml ├── .dependabot └── config.yml ├── setup.sh ├── .gitmodules ├── README.md ├── .github └── workflows │ └── test.yml └── LICENSE /conf/requirements.txt: -------------------------------------------------------------------------------- 1 | flake8 2 | cocotb 3 | wheel 4 | -------------------------------------------------------------------------------- /conf/environment.yml: -------------------------------------------------------------------------------- 1 | name: usb-test-suite-env 2 | channels: 3 | - conda-forge 4 | - symbiflow 5 | dependencies: 6 | - python=3.7 7 | - libzip 8 | - sigrok-cli 9 | - iverilog 10 | -------------------------------------------------------------------------------- /.dependabot/config.yml: -------------------------------------------------------------------------------- 1 | version: 1 2 | update_configs: 3 | - package_manager: "submodules" 4 | directory: "/" 5 | update_schedule: "weekly" 6 | automerged_updates: 7 | - match: 8 | dependency_name: "*" 9 | -------------------------------------------------------------------------------- /setup.sh: -------------------------------------------------------------------------------- 1 | #/bin/sh 2 | 3 | set -e 4 | 5 | # Initalize submodules 6 | # Update foboot separately, as it contains a lot of heavy dependencies 7 | git -c submodule."foboot".update=none submodule update --init --recursive 8 | git submodule update --init foboot 9 | 10 | # Setup virtualenv 11 | pip install virtualenv 12 | virtualenv --python=python3 env 13 | 14 | # Setup dependencies in virtualenv 15 | . env/bin/activate 16 | pip install -r conf/requirements.txt 17 | pip install -e usb-test-suite-cocotb-usb/ 18 | cp litex/litex_setup.py . 19 | ./litex_setup.py init install 20 | 21 | # For building foboot firmware we need a rescv toolchain 22 | wget https://static.dev.sifive.com/dev-tools/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz 23 | tar -xvf riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz 24 | rm riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz 25 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "litex"] 2 | path = litex 3 | url = https://github.com/enjoy-digital/litex.git 4 | [submodule "usb-test-suite-testbenches"] 5 | path = usb-test-suite-testbenches 6 | url = https://github.com/antmicro/usb-test-suite-testbenches.git 7 | [submodule "usb-test-suite-cocotb-usb"] 8 | path = usb-test-suite-cocotb-usb 9 | url = https://github.com/antmicro/usb-test-suite-cocotb-usb.git 10 | [submodule "valentyusb"] 11 | path = valentyusb 12 | url = https://github.com/im-tomu/valentyusb.git 13 | [submodule "usb1_device"] 14 | path = usb1_device 15 | url = https://github.com/antmicro/usb1_device.git 16 | branch = cocotb-usb 17 | [submodule "foboot"] 18 | path = foboot 19 | url = https://github.com/im-tomu/foboot.git 20 | [submodule "tinyfpga"] 21 | path = tinyfpga 22 | url = https://github.com/tinyfpga/TinyFPGA-Bootloader.git 23 | [submodule "ice40-playground"] 24 | path = ice40-playground 25 | url = https://github.com/smunaut/ice40-playground.git 26 | branch = usb 27 | [submodule "yosys"] 28 | path = yosys 29 | url = https://github.com/YosysHQ/yosys.git 30 | [submodule "docs"] 31 | path = docs 32 | url = https://github.com/antmicro/usb-test-suite-docs 33 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # USB test suite 2 | 3 | Copyright (c) 2019-2021 [Antmicro](https://www.antmicro.com) 4 | 5 | This is a [Cocotb](https://github.com/cocotb/cocotb) based USB 1.1 test suite (to be extended to cover higher versions of the standard) for FPGA IP, with testbenches for a variety of open source USB cores. Cocotb enables testing IPs with Python, which makes for a very robust and developer-friendly workflow. 6 | 7 | This repository is a top level repo, with libraries used by the project and specific testbenches and cores as submodules. 8 | 9 | Documentation for this project is hosted at [Read the Docs](https://usb-test-suite.readthedocs.io/en/latest/index.html). 10 | 11 | ## Setup 12 | 13 | It is recommended that you use a virtualenv or similar tool. 14 | This will be taken care of by the `setup.sh` script. 15 | 16 | ### Prerequisites 17 | 18 | * python3 19 | * pip 20 | * iverilog 21 | 22 | ### Steps 23 | 24 | ``` 25 | # Install dependencies 26 | sudo apt install python3 python3-pip iverilog 27 | # Clone the repository. 28 | git clone https://github.com/antmicro/usb-test-suite-build.git 29 | cd usb-test-suite-build 30 | # Run script to setup environment 31 | ./setup.sh 32 | ``` 33 | 34 | ## Usage 35 | 36 | Use the Makefile in **usb-test-suite-testbenches** folder to choose the IP core and test module. 37 | Currently we support testing: 38 | 39 | * [ValentyUSB](https://github.com/im-tomu/valentyusb) 40 | * [Foboot](https://github.com/im-tomu/foboot) 41 | * [asics-ws usb1_device](https://github.com/www-asics-ws/usb1_device) 42 | * [tnt's USB IP core](https://github.com/smunaut/ice40-playground/tree/master/cores/usb) 43 | * [TinyFPGA-Bootloader](https://github.com/tinyfpga/TinyFPGA-Bootloader) 44 | 45 | Execute tests by calling: 46 | 47 | ``` 48 | # Make sure you are in the virtualenv 49 | . env/bin/activate 50 | cd usb-test-suite-testbenches 51 | # Execute tests with default values 52 | make sim 53 | ``` 54 | 55 | Make sure to run `make clean` when switching targets. See the README in **usb-test-suite-testbenches** for details. 56 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: usb-tests 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | jobs: 8 | tests: 9 | runs-on: ubuntu-latest 10 | strategy: 11 | fail-fast: false 12 | matrix: 13 | include: 14 | 15 | - {T: "valentyusb", S: "test-eptri", OP: "sim"} 16 | - {T: "valentyusb", S: "test-eptri", OP: "decode"} 17 | - {T: "valentyusb", S: "test-enum", OP: "sim"} 18 | - {T: "valentyusb", S: "test-enum", OP: "decode"} 19 | - {T: "valentyusb", S: "test-w10enum", OP: "sim"} 20 | - {T: "valentyusb", S: "test-w10enum", OP: "decode"} 21 | - {T: "valentyusb", S: "test-clocks", OP: "sim"} 22 | - {T: "valentyusb", S: "test-clocks", OP: "decode"} 23 | - {T: "valentyusb", S: "test-macOSenum", OP: "sim"} 24 | - {T: "valentyusb", S: "test-macOSenum", OP: "decode"} 25 | - {T: "valentyusb", S: "test-valenty-cdc", OP: "sim"} 26 | - {T: "valentyusb", S: "test-valenty-cdc", OP: "decode"} 27 | - {T: "usb1device", S: "test-basic", OP: "sim"} 28 | - {T: "usb1device", S: "test-basic", OP: "decode"} 29 | - {T: "usb1device", S: "test-sof", OP: "sim"} 30 | - {T: "usb1device", S: "test-sof", OP: "decode"} 31 | - {T: "usb1device", S: "test-sequence", OP: "sim"} 32 | - {T: "usb1device", S: "test-sequence", OP: "decode"} 33 | - {T: "usb1device", S: "test-enum", OP: "sim"} 34 | - {T: "usb1device", S: "test-enum", OP: "decode"} 35 | - {T: "usb1device", S: "test-w10enum", OP: "sim"} 36 | - {T: "usb1device", S: "test-w10enum", OP: "decode"} 37 | - {T: "usb1device", S: "test-clocks", OP: "sim"} 38 | - {T: "usb1device", S: "test-clocks", OP: "decode"} 39 | - {T: "usb1device", S: "test-macOSenum", OP: "sim"} 40 | - {T: "usb1device", S: "test-macOSenum", OP: "decode"} 41 | - {T: "foboot", S: "test-basic", OP: "sim"} 42 | - {T: "foboot", S: "test-basic", OP: "decode"} 43 | - {T: "foboot", S: "test-sof", OP: "sim"} 44 | - {T: "foboot", S: "test-sof", OP: "decode"} 45 | - {T: "foboot", S: "test-sequence", OP: "sim"} 46 | - {T: "foboot", S: "test-sequence", OP: "decode"} 47 | - {T: "foboot", S: "test-enum", OP: "sim"} 48 | - {T: "foboot", S: "test-enum", OP: "decode"} 49 | - {T: "foboot", S: "test-w10enum", OP: "sim"} 50 | - {T: "foboot", S: "test-w10enum", OP: "decode"} 51 | - {T: "foboot", S: "test-clocks", OP: "sim"} 52 | - {T: "foboot", S: "test-clocks", OP: "decode"} 53 | - {T: "foboot", S: "test-macOSenum", OP: "sim"} 54 | - {T: "foboot", S: "test-macOSenum", OP: "decode"} 55 | - {T: "tinyfpgabl", S: "test-basic", OP: "sim"} 56 | - {T: "tinyfpgabl", S: "test-basic", OP: "decode"} 57 | - {T: "tinyfpgabl", S: "test-sof", OP: "sim"} 58 | - {T: "tinyfpgabl", S: "test-sof", OP: "decode"} 59 | - {T: "tinyfpgabl", S: "test-sequence", OP: "sim"} 60 | - {T: "tinyfpgabl", S: "test-sequence", OP: "decode"} 61 | - {T: "tinyfpgabl", S: "test-enum", OP: "sim"} 62 | - {T: "tinyfpgabl", S: "test-enum", OP: "decode"} 63 | - {T: "tinyfpgabl", S: "test-w10enum", OP: "sim"} 64 | - {T: "tinyfpgabl", S: "test-w10enum", OP: "decode"} 65 | - {T: "tinyfpgabl", S: "test-clocks", OP: "sim"} 66 | - {T: "tinyfpgabl", S: "test-clocks", OP: "decode"} 67 | - {T: "tinyfpgabl", S: "test-macOSenum", OP: "sim"} 68 | - {T: "tinyfpgabl", S: "test-macOSenum", OP: "decode"} 69 | - {T: "tinyfpgabl", S: "test-cdc", OP: "sim"} 70 | - {T: "tinyfpgabl", S: "test-cdc", OP: "decode"} 71 | - {T: "tntusb", S: "test-basic", OP: "sim"} 72 | - {T: "tntusb", S: "test-basic", OP: "decode"} 73 | - {T: "tntusb", S: "test-sof", OP: "sim"} 74 | - {T: "tntusb", S: "test-sof", OP: "decode"} 75 | - {T: "tntusb", S: "test-sequence", OP: "sim"} 76 | - {T: "tntusb", S: "test-sequence", OP: "decode"} 77 | - {T: "tntusb", S: "test-enum", OP: "sim"} 78 | - {T: "tntusb", S: "test-enum", OP: "decode"} 79 | - {T: "tntusb", S: "test-w10enum", OP: "sim"} 80 | - {T: "tntusb", S: "test-w10enum", OP: "decode"} 81 | - {T: "tntusb", S: "test-clocks", OP: "sim"} 82 | - {T: "tntusb", S: "test-clocks", OP: "decode"} 83 | - {T: "tntusb", S: "test-macOSenum", OP: "sim"} 84 | - {T: "tntusb", S: "test-macOSenum", OP: "decode"} 85 | 86 | env: 87 | LANG: "en_US.UTF-8" 88 | DEBIAN_FRONTEND: "noninteractive" 89 | 90 | steps: 91 | - name: Setup repository 92 | uses: actions/checkout@v2 93 | 94 | - name: Get submodules 95 | run: | 96 | 97 | git -c submodule."foboot".update=none submodule update --init --recursive 98 | pip install -r conf/requirements.txt 99 | git submodule update --init foboot 100 | 101 | - name: Check format 102 | run: | 103 | 104 | flake8 --max-line-length 80 usb-test-suite-testbenches/tests/*.py usb-test-suite-testbenches/wrappers/*.py usb-test-suite-cocotb-usb/cocotb_usb/*.py usb-test-suite-cocotb-usb/cocotb_usb/usb/*.py 105 | 106 | - name: Run tests 107 | run: | 108 | 109 | wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh 110 | bash miniconda.sh -b -p $HOME/miniconda 111 | source "$HOME/miniconda/etc/profile.d/conda.sh" 112 | hash -r 113 | conda config --set always_yes yes --set changeps1 no 114 | conda update -q conda 115 | conda info -a 116 | conda env create --file conf/environment.yml 117 | conda activate usb-test-suite-env 118 | #conda complains if it does not have the libs as well 119 | pip install -r conf/requirements.txt 120 | pip install -e usb-test-suite-cocotb-usb/ 121 | cp litex/litex_setup.py . 122 | ./litex_setup.py init install --user 123 | pip install -e valentyusb/ # should be done after installing LiteX 124 | wget https://static.dev.sifive.com/dev-tools/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz 125 | tar -xvf riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14.tar.gz 126 | export PATH=$PATH:$PWD/riscv64-unknown-elf-gcc-8.1.0-2019.01.0-x86_64-linux-ubuntu14/bin/ 127 | cd usb-test-suite-testbenches 128 | make TARGET=${{matrix.T}} TEST_SCRIPT=${{matrix.S}} ${{matrix.OP}} 129 | 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2019-2021 Antmicro 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------