title: “User Guides”

User Guides

  • Getting Started
    • [Getting started]({{< relref “getting_started.md” >}})
    • [Quickstart]({{< relref “quickstart.md” >}})
    • [Notes on using GitHub and local git]({{< relref “github_notes.md” >}})
    • [Build software]({{< relref “getting_started_sw.md” >}})
    • [Getting started with Verilator]({{< relref “getting_started_verilator.md” >}})
    • [Getting started on FPGAs]({{< relref “getting_started_fpga.md” >}})
      • [Obtaining an FPGA board]({{< relref “fpga_boards.md” >}})
      • [Installing Xilinx Vivado]({{< relref “install_instructions#xilinx-vivado” >}})
    • [Getting started with a design]({{< relref “getting_started_design.md” >}})
    • Getting started with verification (TODO)
  • [Work with hardware code in external repositories]({{< relref “vendor_hw.md” >}})
  • [Hardware Development Stages]({{< relref “hw_stages.md” >}})
  • [Design Methodology]({{< relref “design.md” >}})
    • Language and Tool Selection
    • Comportability and the Importance of Architectural Conformity
    • Defining Design Complete: stages and tracking
    • Documentation
    • Usage of Register Tool
    • Linting Methodology
    • Assertions Methodology
    • CDC Methodology
    • DFT
    • Generated Code
  • Verification Methodology (TODO)
    • Verification strategy overview
    • How do we define Verification completion
      • Current verification status of IP and definition of milestones
    • Tools
    • Test planning
    • Progress and tracking
    • Code coverage output
      • How do we report status
    • Overview of in-tree helper classes, test benches, etc.
  • Validation Methodology (TODO)
    • How to download bit stream
    • What tests exist today
    • How to run tests
    • How does this differ from verification
    • How to add tests
  • [List of Top-Level Designs]({{< relref “system_list.md” >}})