7 Build your hardware, easily!
8 Copyright 2012-2018 / EnjoyDigital
12 LiteX is a FPGA design/SoC builder that can be used to build cores, create
13 SoCs and full FPGA designs.
15 Typical LiteX design flow:
16 --------------------------
25 +-------+ | | Your design
26 | LiteX +---> ready to be used!
28 +----------------------+ | |
29 |LiteX Cores Ecosystem +--> |
30 +----------------------+ +-^-------^-+
31 (Eth, SATA, DRAM, USB, | |
32 PCIe, Video, etc...) + +
37 LiteX already supports various softcores CPUs: LM32, Mor1kx, PicoRV32, VexRiscv
38 and is compatible with the LiteX's Cores Ecosystem:
40 - LiteDRAM: https://github.com/enjoy-digital/litedram
41 - LiteEth: https://github.com/enjoy-digital/liteeth
42 - LitePCIe: https://github.com/enjoy-digital/litepcie
43 - LiteSATA: https://github.com/enjoy-digital/litesata
44 - LiteUSB: https://github.com/enjoy-digital/liteusb
45 - LiteSDCard: https://github.com/enjoy-digital/litesdcard
46 - LiteICLink: https://github.com/enjoy-digital/liteiclink
47 - LiteJESD204B: https://github.com/enjoy-digital/litejesd204b
48 - LiteVideo: https://github.com/enjoy-digital/litevideo
49 - LiteScope: https://github.com/enjoy-digital/litescope
55 Provides specific or experimental modules to generate HDL that are not integrated
59 Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to
60 simulate HDL code or full SoCs.
63 Provides definitions/modules to build cores (bus, bank, flow), cores and tools
64 to build a SoC from such cores.
67 Provides platforms and targets for the supported boards. All Migen's platforms
68 can also be used in LiteX.
70 [> Very Quick start guide (for newcomers)
71 -----------------------------------------
72 TimVideos.us has done an awesome job for setting up a LiteX environment easily in
73 the litex-buildenv repo: https://github.com/timvideos/litex-buildenv
75 It's recommended for newcomers to go this way. Various FPGA boards are supported
76 and multiple examples provided! You can even run Linux on your FPGA using LiteX
79 Migen documentation can be found here: https://m-labs.hk/migen/manual
81 FPGA lessons/tutorials can be found at: https://github.com/enjoy-digital/fpga_101
83 [> Medium Quick start guide with Conda
84 -----------------------------------------
86 0. Get miniconda by following instructions at https://conda.io/miniconda.html
89 git clone --recurse-submodules https://github.com/enjoy-digital/litex.git
91 2. Create a LiteX environment from environment.yml
92 conda env create -f environment.yml
94 3. Enter conda environment
97 4. Build the target of your board...:
98 Go to boards/targets and execute the target you want to build
101 [> Quick start guide (for advanced users)
102 -----------------------------------------
103 0. Install Python 3.5+ and FPGA vendor's development tools.
105 1. Get litex_setup.py script and execute:
106 ./litex_setup.py init install
107 This will clone and install Migen, LiteX and LiteX's cores.
108 To update all repositories execute:
109 ./litex_setup.py update
111 2. Compile and install binutils. Take the latest version from GNU.
112 mkdir build && cd build
113 ../configure --target=lm32-elf
117 3. (Optional, only if you want to use a lm32 CPU in you SoC)
118 Compile and install GCC. Take gcc-core and gcc-g++ from GNU
119 (version 4.5 or >=4.9).
121 mkdir build && cd build
122 ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc \
127 4. Build the target of your board...:
128 Go to boards/targets and execute the target you want to build
130 5. ... and/or install Verilator and test LiteX on your computer:
131 Download and install Verilator: http://www.veripool.org/
132 Install libevent-devel / json-c-devel packages
136 6. Run a terminal program on the board's serial port at 115200 8-N-1.
137 You should get the BIOS prompt.
141 E-mail: florent [AT] enjoy-digital.fr