Prepare for new DDR PHY
[litex.git] / README
1 [> Milkymist-NG system-on-chip
2 ------------------------------
3
4 This is the next-generation Milkymist(tm) system-on-chip design,
5 introducing two key innovations:
6 * Built on the powerful Migen VLSI logic design system.
7 * Increased system memory performance thanks to a new architecture
8 (ASMI) containing a transaction-reordering and superscalar controller.
9
10 The Milkymist-NG SoC supports the Milkymist One board. Obtain yours from:
11 http://milkymist.org
12
13 Note that the -NG version is still experimental work in progress. For the
14 production version of Milkymist SoC, visit:
15 https://github.com/milkymist/milkymist
16
17 [> Instructions
18 ---------------
19 First, download and install Migen from:
20 https://github.com/milkymist/migen
21
22 Once this is done, build the bitstream with:
23 python3 build.py
24 This will generate the build/soc.bit programming file.
25
26 The SoC expects a bootloader to be located in flash at 0x860000, just
27 like the legacy SoC did. However, there is no binary compatibility and a
28 new BIOS needs to be built and flashed for the -NG SoC.
29
30 You can find the source code of a compatible BIOS in the software/bios
31 directory. It compiles with Clang and LLVM by default, and you can find
32 the modified version with support for LM32 at:
33 https://github.com/milkymist/llvm-lm32
34 https://github.com/milkymist/clang-lm32
35
36 Enjoy!
37
38 [> Misc
39 -------
40 Code repository:
41 https://github.com/milkymist/milkymist-ng
42
43 Send questions, comments and patches to devel [AT] lists.milkymist.org
44 We are also on IRC: #milkymist on the Freenode network.
45
46 Milkymist-NG is free software: you can redistribute it and/or modify it
47 under the terms of the GNU General Public License as published by the
48 Free Software Foundation, version 3 of the License. This program is
49 distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
50 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
51 PARTICULAR PURPOSE. See the GNU General Public License for more details.
52
53 The authors grant the additional permissions that the code can be used in
54 conjunction with the LatticeMico32 CPU core from Lattice.
55
56 Unless otherwise noted, Milkymist-NG's source code is copyright (C)
57 2011-2012 Sebastien Bourdeauducq. Other authors retain ownership of their
58 contributions. If a submission can reasonably be considered independently
59 copyrightable, it's yours and I encourage you to claim it with
60 appropriate copyright notices. This submission then falls under the
61 "otherwise noted" category. All submissions must use a license compatible
62 with the GPL and the additional permissions above.