taxi/README.md

Taxi Transport Library

AXI, AXI stream, Ethernet, and PCIe components in System Verilog.

GitHub repository: https://github.com/fpganinja/taxi

Introduction

The goal of the Taxi transport library is to provide a set of performant, easy-to-use building blocks in modern System Verilog facilitating data transport and interfacing, both internally via AXI and AXI stream, and externally via Ethernet, PCI express, UART, and I2C. The building blocks are accompanied by testbenches and simulation models utilizing Cocotb and Verilator.

This library is currently under development; more components will be added over time as they are developed.

License

Taxi is provided by FPGA Ninja, LLC under either the CERN Open Hardware Licence Version 2 - Strongly Reciprocal (CERN-OHL-S 2.0), or a paid commercial license. Contact info@fpga.ninja for commercial use. Note that some components may be provided under less restrictive licenses (e.g. example designs).

Under the strongly-reciprocal CERN OHL, you must provide the source code of the entire digital design upon request, including all modifications, extensions, and customizations, such that the design can be rebuilt. If this is not an acceptable restriction for your product, please contact info@fpga.ninja to inquire about a commercial license without this requirement. License fees support the continued development and maintenance of this project and related projects.

To facilitate the dual-license model, contributions to the project can only be accepted under a contributor license agreement.

Components

• AXI stream
  • SV interface for AXI stream
  • Register slice
  • Width converter
  • Synchronous FIFO
  • Asynchronous FIFO
  • Combined FIFO + width converter
  • Combined async FIFO + width converter
• Ethernet
  • 1G MAC
  • 1G MAC + FIFO
  • 10G MAC
  • 10G MAC + FIFO
  • 10G MAC/PHY
  • 10G MAC/PHY + FIFO
  • 10G PHY
• Linear-feedback shift register
  • Parametrizable combinatorial LFSR/CRC module
  • CRC computation module
  • PRBS generator
  • PRBS checker
  • LFSR self-synchronizing scrambler
  • LFSR self-synchronizing descrambler
• Low-speed serial
  • UART
• Primitives
  • Arbiter
  • Priority encoder
• Precision Time Protocol (PTP)
  • PTP clock
  • PTP CDC
• Synchronization primitives
  • Reset synchronizer
  • Signal synchronizer

Testing

Running the included testbenches requires cocotb, cocotbext-axi, cocotbext-eth, cocotbext-uart, cocotbext-pcie, and Verilator. The testbenches can be run with pytest directly (requires cocotb-test), pytest via tox, or via cocotb makefiles.