-[> Milkymist-NG system-on-chip
-------------------------------
+ __ _ __ _ __
+ / / (_) /____ | |/_/
+ / /__/ / __/ -_)> <
+ /____/_/\__/\__/_/|_|
+ Migen inside
-This is the next-generation Milkymist(tm) system-on-chip design,
-introducing two key features:
- * Built on the powerful Migen VLSI logic design system.
- * Increased system memory performance thanks to LASMI.
+ Build your hardware, easily!
+ Copyright 2012-2016 Enjoy-Digital
-This translates to more development productivity, better video resolution
-and quality, ease of designing complex hardware accelerators, and much
-more flexibility in hardware designs.
+[> Intro
+--------
+LiteX is an alternative to Migen/MiSoC maintained and used by Enjoy-Digital
+to build our cores, integrate them in complete SoC and load/flash them to
+the hardware and experiment new features.
-The Milkymist-NG SoC supports the Mixxeo and the Milkymist One.
-Obtain yours at http://milkymist.org
+The structure of LiteX is kept close to Migen/MiSoC to ease collaboration
+between projects and efforts are made to keep cores developed with LiteX
+compatible with Migen/MiSoC.
-[> Instructions (software)
---------------------------
-1. Compile and install binutils. Take the latest version from GNU.
+[> License
+----------
+LiteX is Copyright (c) 2012-2015 Enjoy-Digital under BSD Lisense.
+Since it is based on Migen/MiSoC, please also refer to LICENSE file in gen/soc
+directory or git history to get correct copyrights.
+
+[> Sub-packages
+---------------
+gen:
+ Provides specific or experimentatl modules to generate HDL that are not integrated
+ in Migen.
+
+build:
+ Provides tools to build FPGA bitstreams (interface to vendor toolchains) and to
+ simulate HDL code or full SoCs.
+
+soc:
+ Provides definitions/modules to build cores (bus, bank, flow), cores and tools
+ to build a SoC from such cores.
+
+boards:
+ Provides platforms and targets for the supported boards.
+
+[> Quick start guide
+--------------------
+0. If cloned from Git without the --recursive option, get the submodules:
+ git submodule update --init
+
+1. Install Python 3.3+, Migen and FPGA vendor's development tools and JTAG tools.
+ Get Migen from: https://github.com/m-labs/migen
+
+2. Compile and install binutils. Take the latest version from GNU.
mkdir build && cd build
../configure --target=lm32-elf
make
make install
-
-2. Compile and install GCC 4.5. Take gcc-core and gcc-g++ from GNU.
+
+3. (Optional, only if you want to use a lm32 CPU in you SoC)
+ Compile and install GCC. Take gcc-core and gcc-g++ from GNU
+ (version 4.5 or >=4.9).
rm -rf libstdc++-v3
mkdir build && cd build
- ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
+ ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc \
+ --disable-libssp
make
make install
-3. Obtain compiler-rt and set the CRTDIR environment variable to the root of
- its source tree.
- svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt
- export CRTDIR=/path_to/compiler-rt
+4. Build the target of your board...:
+ Go to boards/targets and execute the target you want to build
-4. Build and flash the BIOS (part of this source distribution).
- cd software/bios
- make
- make flash
-
-The second command requires m1nor, FJMEM and UrJTAG.
-These tools can be found at:
- https://github.com/milkymist/fjmem-m1
- http://urjtag.org
-
-[> Instructions (gateware)
---------------------------
-First, download and install Migen from:
- https://github.com/milkymist/migen
-
-Once this is done, build the bitstream with:
- ./make.py [-p <platform>] -l
-This will generate the build/soc-<platform>.bit programming file
-and load it with UrJTAG.
-
-A new BIOS needs to be built and flashed for the -NG SoC.
-
-Enjoy!
-
-[> Misc
--------
-Code repository:
- https://github.com/milkymist/milkymist-ng
-
-Send questions, comments and patches to devel [AT] lists.milkymist.org
-We are also on IRC: #milkymist on the Freenode network.
-
-Milkymist-NG is free software: you can redistribute it and/or modify it
-under the terms of the GNU General Public License as published by the
-Free Software Foundation, version 3 of the License. This program is
-distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
-PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-The authors grant the additional permissions that the code can be used in
-conjunction with the LatticeMico32 CPU core from Lattice.
-
-Unless otherwise noted, Milkymist-NG's source code is copyright (C)
-2011-2013 Sebastien Bourdeauducq. Other authors retain ownership of their
-contributions. If a submission can reasonably be considered independently
-copyrightable, it's yours and I encourage you to claim it with
-appropriate copyright notices. This submission then falls under the
-"otherwise noted" category. All submissions must use a license compatible
-with the GPL and the additional permissions above.
+5. ... and/or install Verilator and test LiteX on your computer:
+ Download and install Verilator: http://www.veripool.org/
+ Install libevent-devel / json-c-devel packages
+ Go to boards/targets
+ ./sim.py
+
+6. Run a terminal program on the board's serial port at 115200 8-N-1.
+ You should get the BIOS prompt.
+
+[> Contact
+----------
+E-mail: florent [AT] enjoy-digital.fr
\ No newline at end of file
projects / litex.git / blobdiff