bust¶
bust generates the register file of an FPGA or ASIC module from a JSON register map. From one file it writes the VHDL register file with its bus endpoint, a self-checking UVVM testbench, C, C++ and Python headers, an IPBus address table and documentation as HTML, Markdown, LaTeX and PDF.
bust supports six buses: AXI4-Lite, IPBus, SBI, Avalon-MM, Wishbone and APB.
pip install bust
bust my_module.json -o out
Why bust¶
Your design sees registers by name. The generated module hands every field
to your logic through two VHDL records, to_hw and from_hw. You write
to_hw.ctrl.enable, not a bit slice of a data bus, and enumerated fields
arrive as VHDL enumeration types.
One register map, every bus. Each bus is a thin endpoint in front of the same register file. Moving a module from AXI4-Lite to Avalon-MM changes one word in the JSON and leaves your logic untouched.
Access modes beyond read and write. Fields can clear on read, set or clear on write, pulse for one cycle, or be set and cleared by hardware, with the same keywords as SystemRDL. bust generates the logic and the checks for each.
Software and documentation stay in step. The headers, the IPBus address table and the documentation come from the same file as the VHDL, so they cannot drift apart.
Tested output. Every generated module comes with a testbench that checks its registers through the bus, and the bust repository simulates the generated testbench of every bus in CI.
Documentation¶
Getting started: install bust, describe a module, generate it and connect it to your design.
Register map format: every key of the JSON file.
Access modes: what software and hardware can do with each field.
Buses: the ports and protocol details of each bus.
Base address and address range: how a module decodes an address, and the generics that set its base address and address range.
Generated HDL: the generated files, the records and how to instantiate the module.
Documentation: the HTML, Markdown, LaTeX and PDF documentation, with examples.
Software headers: the C, C++ and Python headers and the IPBus address table.
Testbenches: what the testbench checks and how to run it.
Command line: every option of the
bustcommand.