PicoNut Manual

Licence

This manual is licensed under the Creative Commons Attribution 4.0 International License.

Please cite as:
    PicoNut Documentation, <Author(s)>, https://ees.tha.de/,
    CC-BY 4.0, https://creativecommons.org/licenses/by/4.0/

Replace <Author(s)> with the author(s) of the respective artwork or chapter, or with “Editors Gundolf Kiefer, Michael Schäferling, Johannes Hofmann”, if no author is given.

Document History

Version	Date	Description
0.0.1	2024-04-03	Initial version (how to document, welcome page)
1.0.0	2025-04-23	Initial GitHub Release (Minimal Nucleus, Soft-MemU, Wishbone-MemU, Soft-Debugger, Soft-Uart, Wishbone-Uart)

PicoNut Manual

• The PicoNut Project
  • Introduction
  • System architecture
  • Software and Simulation
• Getting Started
  • Prerequisites
  • Running the “Hello World” Example in Simulation
  • Running the “Hello World” Example on ULX3S FPGA Board
• Interface Definitions
  • IPort/DPort Interface
  • CSR Bus
  • Wishbone Systembus
  • Software-Simulated Hardware
• Nucleus Variants
  • The Minimal Nucleus
• Memory Unit Variants
  • Soft-MemU
  • Hardware-MemU
• Debugging
  • Soft Debugger
  • Debug Handler
  • Hardware Debugger
• Software Support Library
• Peripherals
  • UART
  • Video Interface
  • Audio Interface

For Contributors

• Formatting
• How to Document
  • Introduction
  • Additional Syntax Provided by MyST
  • Tables
  • Images and Figures
  • Using draw.io diagrams
  • Create wave diagrams
  • Doxygen
  • Tips and Workarounds
• The Build System
  • Integrate a Core/Memu into the piconut toplevel
  • Adding a configuration option to the piconut
• Embedded RAM Templates
  • Single Port Block RAM
  • Dual Port Block RAM
  • Dual Port Byte Enable Block RAM
  • Using a template in a design

Appendix

• Appendix
  • Building the GNU Toolchain
  • Udev Rules