SURF

May 20, 2026 ยท View on GitHub

DOE Code

SLAC Ultimate RTL Framework

Repository Map

  • Agent guidance: project layout, coding conventions, and verification notes for contributors and coding agents.
  • AXI: AXI-Lite, AXI4, AXI Stream, DMA, bridges, and simulation-link RTL.
  • Base: foundational packages, CDC, FIFO, RAM, reset, delay, CRC, and generic RTL helpers.
  • Devices: vendor and component-specific RTL support.
  • DSP: generic and Xilinx-specific DSP support.
  • Ethernet: MAC, raw Ethernet, IPv4, UDP, RoCEv2, and high-speed Ethernet cores.
  • Protocols: PGP, SSI, SRP, RSSI, CoaXPress, JESD204B, peripheral buses, and related protocol cores.
  • Xilinx: Xilinx-family wrappers, primitive integrations, and XVC UDP support.
  • Python: PyRogue package layout under python/surf.
  • Tests: cocotb regression layout, methodology, helpers, and simulator conventions.

Before you clone the GIT repository

Setup for large filesystems on github. git-lfs used for all binary files (example: .dcp)

$ git lfs install

Presentations

An Introduction to SURF Presentation

IEEE RT 2024: SURF Workshop Presentation

Misc

Tutorial

Doxygen Homepage

Support Homepage

Bug Tracking