m1crg: reset VGA clock generator
[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 at:
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 (software)
18 --------------------------
19 1. Compile and install binutils. Take the latest version from GNU.
20 mkdir build && cd build
21 ../configure --target=lm32-elf
22 make
23 make install
24
25 2. Compile and install GCC 4.5. Take gcc-core and gcc-g++ from GNU.
26 rm -rf libstdc++-v3
27 mkdir build && cd build
28 ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
29 make
30 make install
31
32 3. Obtain compiler-rt and set the CRTDIR environment variable to the root of
33 its source tree.
34 svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt
35 export CRTDIR=/path_to/compiler-rt
36
37 4. Build and flash the BIOS (part of this source distribution).
38 cd software/bios
39 make
40 make flash
41
42 The second command requires m1nor, FJMEM and UrJTAG.
43 These tools can be found at:
44 https://github.com/milkymist/fjmem-m1
45 http://urjtag.org
46
47 [> Instructions (gateware)
48 --------------------------
49 First, download and install Migen from:
50 https://github.com/milkymist/migen
51
52 Once this is done, build the bitstream with:
53 make
54 This will generate the build/soc.bit programming file.
55 Use:
56 make load
57 to load it with UrJTAG.
58
59 The SoC expects a bootloader to be located in flash at 0x860000, just
60 like the legacy SoC did. However, there is no binary compatibility and a
61 new BIOS needs to be built and flashed for the -NG SoC.
62
63 Enjoy!
64
65 [> Misc
66 -------
67 Code repository:
68 https://github.com/milkymist/milkymist-ng
69
70 Send questions, comments and patches to devel [AT] lists.milkymist.org
71 We are also on IRC: #milkymist on the Freenode network.
72
73 Milkymist-NG is free software: you can redistribute it and/or modify it
74 under the terms of the GNU General Public License as published by the
75 Free Software Foundation, version 3 of the License. This program is
76 distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
77 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
78 PARTICULAR PURPOSE. See the GNU General Public License for more details.
79
80 The authors grant the additional permissions that the code can be used in
81 conjunction with the LatticeMico32 CPU core from Lattice.
82
83 Unless otherwise noted, Milkymist-NG's source code is copyright (C)
84 2011-2013 Sebastien Bourdeauducq. Other authors retain ownership of their
85 contributions. If a submission can reasonably be considered independently
86 copyrightable, it's yours and I encourage you to claim it with
87 appropriate copyright notices. This submission then falls under the
88 "otherwise noted" category. All submissions must use a license compatible
89 with the GPL and the additional permissions above.