How enjoy-digital/litex works
LiteX is a Python framework for composing FPGA logic and complete SoCs. A designer combines hardware cores, CPUs, interconnects, and board/target configuration; SoC integration brings these into a design that can be emitted as Verilog and used with FPGA toolchains. The repository also provides simulation, embedded BIOS/software, and host-side SoC access. The README documents the overall design flow; some subsystem details below rely on the file tree and SOURCE INDEX, so unsampled links are omitted.
Main entry points: soc.py SoC Integration · verilog.py Verilog Backend · interconnect Bus Fabrics · csr.py CSR Registers
Components 21
Logic Generation
- HDL Expressions
litex/gen/fhdl/expression.py - HDL Hierarchy
litex/gen/fhdl/hierarchy.py - Signal Naming
litex/gen/fhdl/namer.py - Verilog Backend
litex/gen/fhdl/verilog.py
SoC Composition
- SoC Integration
litex/soc/integration/soc.py
Interconnect Fabrics
- Bus Fabrics
litex/soc/interconnect - AXI Full
litex/soc/interconnect/axi/axi_full.py - Streams
litex/soc/interconnect/stream.py - CSR Registers
litex/soc/interconnect/csr.py - CSR Bus
litex/soc/interconnect/csr_bus.py - Event Manager
litex/soc/interconnect/csr_eventmanager.py
Hardware Subsystems
- CPU Cores
litex/soc/cores/cpu - Peripheral Cores
litex/soc/cores - HyperBus Core
litex/soc/cores/hyperbus.py - Video Cores
litex/soc/cores/video.py
Simulation and Access
- Simulation
litex/gen/sim/core.py - BIOS
litex/soc/software/bios/main.c - Host Client
litex/tools/litex_client.py - Etherbone Transport
litex/tools/remote/etherbone.py
Other components
- SoC Designer
- FPGA Toolchains
Connections 23
- SoC Designer → SoC Integration: configures
- CPU Cores → SoC Integration: integrated by
litex/soc/integration/soc.py - Peripheral Cores → SoC Integration: integrated by
litex/soc/integration/soc.py - HyperBus Core → SoC Integration: integrated by
litex/soc/integration/soc.py - SoC Integration → Bus Fabrics: uses
litex/soc/integration/soc.py - SoC Integration → CSR Registers: uses
litex/soc/integration/soc.py - SoC Integration → Event Manager: uses
litex/soc/integration/soc.py - SoC Integration → HyperBus Core: instantiates
litex/soc/integration/soc.py - Video Cores → Streams: uses
litex/soc/cores/video.py - Video Cores → CSR Registers: uses
litex/soc/cores/video.py - AXI Full → Streams: uses
litex/soc/interconnect/axi/axi_full.py - Event Manager → CSR Registers: builds registers
litex/soc/interconnect/csr_eventmanager.py - Bus Fabrics → AXI Full: includes
litex/soc/interconnect/axi/__init__.py - Bus Fabrics → CSR Bus: includes
litex/soc/interconnect/wishbone.py - HDL Expressions → Verilog Backend: translated by
litex/gen/fhdl/verilog.py - HDL Hierarchy → Verilog Backend: lowered by
litex/gen/fhdl/verilog.py - Signal Naming → Verilog Backend: names signals for
litex/gen/fhdl/verilog.py - SoC Integration → Verilog Backend: emits design through
- SoC Integration → Simulation: can simulate through
- SoC Integration → BIOS: provides embedded runtime
- Host Client → Etherbone Transport: uses transport
litex/tools/litex_client.py - Host Client → SoC Integration: accesses SoC
- Verilog Backend → FPGA Toolchains: feeds