• Stars
    star
    2,962
  • Rank 15,296 (Top 0.4 %)
  • Language
    C
  • License
    Other
  • Created about 9 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Build your hardware, easily!

             Copyright 2012-2023 / Enjoy-Digital & LiteX developers

License

Welcome to LiteX!

The LiteX framework provides a convenient and efficient infrastructure to create FPGA Cores/SoCs, to explore various digital design architectures and create full FPGA based systems.

LiteX SoC builder framework quick tour/overview: Slides

Want to get started and/or looking for documentation? Make sure to visit the Wiki!

A question or want to get in touch? Join us on Discord or on our IRC channel: [#litex at irc.libera.chat].

LiteX provides all the common components required to easily create an FPGA Core/SoC:

  • ✔️ Buses and Streams (Wishbone, AXI, Avalon-ST) and their interconnect.
  • ✔️ Simple cores: RAM, ROM, Timer, UART, JTAG, etc….
  • ✔️ Complex cores through the ecosystem of cores: LiteDRAM, LitePCIe, LiteEth, LiteSATA, etc...
  • ✔️ Various CPUs & ISAs: RISC-V, OpenRISC, LM32, Zynq, X86 (through a PCIe), etc...
  • ✔️ Mixed languages support with VHDL/Verilog/(n)Migen/Spinal-HDL/etc... integration capabilities.
  • ✔️ Powerful debug infrastructure through the various bridges and Litescope.
  • ✔️ Direct/Fast simulation through Verilator.
  • ✔️ Build backends for open-source and vendors toolchains.
  • ✔️ And a lot more... :)

By combining LiteX with the ecosystem of cores, creating complex SoCs becomes a lot easier than with traditional approaches while providing better portability and flexibility: Here is for example a Multi-core Linux Capable SoC based on VexRiscv-SMP CPU, LiteDRAM, LiteSATA built and integrated with LiteX, running on a cheap repurposed Acorn CLE215+ Mining Board: For more info, have a look at Linux-on-LiteX-Vexriscv project and try running Linux on your FPGA board!

LiteX's digital logic is currently described with Migen which does not prevent users to create mixed language projects:

  • It's very common and easy to integrate VHDL/Verilog/SystemVerilog/nMigen/Spinal-HDL code in LiteX!
  • It's also very common to do the opposite and generate the LiteX design as a verilog file and integrate it in a traditional flow.

LiteX was initially developed by Enjoy-Digital to create projects for clients (and we are still using it for that :)) and trying to take the different clients' requirements/needs consideration made, we think, the framework very flexible:

  • Some users only want to use it to easily interconnect their existing VHDL/Verilog/SV cores.
  • Some users are only interested to reuse the PCIe/Ethernet/SATA/etc cores as regular core and just integrate them in their traditional flow.
  • Some users with a hardware background start with the above approaches and then switch later to the full Python flow since find it more efficient.
  • Some users with a software background and fluent with Python start playing with FPGAs while they would probably never touch FPGA otherwise :)
  • Etc...

We are well aware that everyone has a different background, so it's up to you to pick the right approach with LiteX that will be convenient for you!

To get started we encourage you to read the wiki.

You already have a FPGA board(s)? Visit LiteX-Boards to see if your board(s) is already supported!

The framework is also far from perfect and we'll be happy to have your feedback or/and contributions.

Have fun! 😉

Moral precisions: The project is shared with a permissive BSD 2-Clause License and we are encouraged to continue sharing it this way thanks to the awesome community and clients willing to support the project! If the projet is useful for your research, hobby or commercial projects, we are just asking you to be coherent and behave with integrity: Don't expect free support or that the community will be welcoming if your spent your time complaining about the project (and then direspect developers) or don't pay the custom developments you asked for... (While it's probably natural for 99% of users/clients, it does seems useful to add this for the 1% remaining that are eating lots of our energy/time).

Typical LiteX design flow:

                                      +---------------+
                                      |FPGA toolchains|
                                      +----^-----+----+
                                           |     |
                                        +--+-----v--+
                       +-------+        |           |
                       | Migen +-------->           |
                       +-------+        |           |        Your design
                                        |   LiteX   +---> ready to be used!
                                        |           |
              +----------------------+  |           |
              |LiteX Cores Ecosystem +-->           |
              +----------------------+  +-^-------^-+
               (Eth, SATA, DRAM, USB,     |       |
                PCIe, Video, etc...)      +       +
                                         board   target
                                         file    file

LiteX already supports various softcores CPUs: VexRiscv, Rocket, LM32, Mor1kx, PicoRV32, BlackParrot and is compatible with the LiteX's Cores Ecosystem:

Name Build Status Description
LiteX-Boards Boards support
LiteDRAM DRAM
LiteEth Ethernet
LitePCIe PCIe
LiteSATA SATA
LiteSDCard SD card
LiteICLink Inter-Chip communication
LiteJESD204B JESD204B
LiteSPI SPI/SPI-Flash
LiteScope Logic analyzer

Examples of designs built with LiteX:

Custom PCIe SDI Capture/Playback board built around LitePCIe and integrated with LiteX, allowing full control of the SDI flow and very low latency. Alternative firmware/gateware for the SDS1104X-E Scope: enter image description here HBM2 test infrastructure on Forest Kitten 33: enter image description here

To discover more products/projects built with LiteX, visit the projects page on the Wiki.

Sponsors/Partners:

A huge shoutout to our awesome industrial clients who have given us the green light to incorporate some of the developments we initially created for them directly into LiteX! These innovative developments often provide the building blocks for the features that the wider community can then use and improve upon. Your support has been instrumental for the project, and we are incredibly grateful for your partnership. Thanks!

Papers, Presentations, Tutorials, Links

FPGA lessons/tutorials:

Migen tutorial:

OSDA 2019 paper/slides:

Linux on LiteX-Vexriscv:

RISC-V Getting Started Guide:

LiteX vs. Vivado First Impressions:

35C3 - Snakes and Rabbits - How CCC shaped an open hardware success:

Tim has to many projects - LatchUp Edition: https://www.youtube.com/watch?v=v7WrTmexod0

Sub-packages

litex.gen Provides specific or experimental modules to generate HDL that are not integrated in Migen.

litex.build: Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to simulate HDL code or full SoCs.

litex.soc: Provides definitions/modules to build cores (bus, bank, flow), cores and tools to build a SoC from such cores.

Quick start guide

  1. Install Python 3.6+ and FPGA vendor's development tools and/or Verilator.
  2. Install Migen/LiteX and the LiteX's cores:
$ wget https://raw.githubusercontent.com/enjoy-digital/litex/master/litex_setup.py
$ chmod +x litex_setup.py
$ ./litex_setup.py --init --install --user (--user to install to user directory) --config=(minimal, standard, full)

Later, if you need to update all repositories:

$ ./litex_setup.py --update

Note: On MacOS, make sure you have HomeBrew installed. Then do, brew install wget.

Note: On Windows, it's possible you'll have to set SHELL environment variable to SHELL=cmd.exe.

  1. Install a RISC-V toolchain (Only if you want to test/create a SoC with a CPU):
$ pip3 install meson ninja
$ ./litex_setup.py --gcc=riscv
  1. Build the target of your board...:

Go to litex-boards/litex_boards/targets and execute the target you want to build.

  1. ... and/or install Verilator and test LiteX directly on your computer without any FPGA board:

On Linux (Ubuntu):

$ sudo apt install libevent-dev libjson-c-dev verilator
$ litex_sim --cpu-type=vexriscv

On MacOS:

$ brew install json-c verilator libevent
$ brew cask install tuntap
$ litex_sim --cpu-type=vexriscv
  1. Run a terminal program on the board's serial port at 115200 8-N-1.

You should get the BIOS prompt like the one below.

Community

Over the years a friendly community has grown around LiteX and the ecosystem of cores. Feedbacks and contributions have already greatly improved the project, EnjoyDigital still leads the development but it is now a community project and collaborative projects created around/with LiteX can be found at https://github.com/litex-hub.

Contact

E-mail: [email protected]

More Repositories

1

litepcie

Small footprint and configurable PCIe core
Python
476
star
2

litedram

Small footprint and configurable DRAM core
Python
378
star
3

liteeth

Small footprint and configurable Ethernet core
Python
212
star
4

usb3_pipe

USB3 PIPE interface for Xilinx 7-Series
Verilog
199
star
5

litescope

Small footprint and configurable embedded FPGA logic analyzer
Python
169
star
6

pcie_screamer

PCIe Screamer - TLPs experiments...
C
164
star
7

litesata

Small footprint and configurable SATA core
Python
126
star
8

litesdcard

Small footprint and configurable SDCard core
Python
110
star
9

colorlite

Take control of your Colorlight FPGA board with LiteX/LiteEth :)
Python
95
star
10

daisho

Test of the USB3 IP Core from Daisho on a Xilinx device
Verilog
85
star
11

litex_m2sdr

LiteX based M2 SDR FPGA board.
C
58
star
12

litex-acorn-baseboard

LiteX development baseboards arround the SQRL Acorn.
Python
57
star
13

liteiclink

Small footprint and configurable Inter-Chip communication cores
Python
54
star
14

pcie_analyzer

PCIe analyzer experiments
Python
45
star
15

litejesd204b

Small footprint and configurable JESD204B core
Python
40
star
16

litex_vexriscv_smp_test

VexRiscv-SMP integration test with LiteX.
Verilog
24
star
17

xtrx_julia

XTRX LiteX/LitePCIe based design for Julia Computing
C
24
star
18

litex_rp2040_pmod_test

Test of a RP2040 PMOD attached to a LiteX SoC.
Python
24
star
19

thunderscope

LiteX based FPGA gateware for Thunderscope.
Python
22
star
20

litex_verilog_axi_test

Integration test of Verilog AXI modules (https://github.com/alexforencich/verilog-axi) with LiteX.
Python
15
star
21

litesata_axiom

Python
12
star
22

fk33_hbm2_test

HBM2 integration test on FK33 with LiteX
Python
9
star
23

litex_hw_ci

LiteX Hardware CI tests.
Python
8
star
24

litex_vexriscv_smp_usb_host_test

Integration test with SpinalHDL's OHCI USB Host core and LiteX/VexRiscv-SMP.
Python
7
star
25

litex_neorv32_test

NEORV32 integration test with LiteX
VHDL
6
star
26

litex_playground

Small LiteX related projects that have been or could be useful...
C
5
star
27

litex_soc_gen_test

Test of LiteX standalone SoC generator.
Python
5
star
28

litepcie_ptm_test

LitePCIe PTM support / test repo.
Python
5
star
29

tapcfg

tapcfg
C
5
star
30

litex_naxriscv_test

NaxRiscv integration test with LiteX
Python
4
star
31

litex_limesdr_mini_v2_test

LiteX alternative SoC/Gateware for the LimeSDR Mini 2.0
Python
3
star
32

litex_openwrt_test

Test of OpenWRT on LiteX SoCs.
C
3
star
33

betrusted_soc_power_tests

Python
3
star
34

vhdl2doc

JavaScript
3
star
35

litex_agilex5_test

Initial Test/Support of LiteX on Intel Agilex5 FPGAs.
Python
3
star
36

litex_mister_test

Simplification test of MiSTer with LiteX to try to help/contribute to MiSTeX project.
Verilog
2
star
37

mbd_poc

Python
1
star
38

litedram_halfrate

Python
1
star
39

acorn_pcie_compute_test

PCIe compute test on Acorn CLE 215+.
Python
1
star
40

litedram_ddr4_mig_phy_test

LiteDRAM Hybrid with DDR4 PHY
Python
1
star
41

litex_thunderscope_test

Test of LiteX component for ThunderScope project.
Python
1
star
42

litex_verilog_axis_test

Integration test of Verilog AXI Stream modules (https://github.com/alexforencich/verilog-axis) with LiteX.
Python
1
star
43

litex_xtrx

XTRX LiteX/LitePCIe based alternative Gateware/Software.
C++
1
star
44

litex_64bit_addressing_test

Test/PoC of 64-bit addressing in LiteX.
Python
1
star