412cd7fda0a77688c5cc43d87ed7cec93140557f
[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 features:
6 * Built on the powerful Migen VLSI logic design system.
7 * Increased system memory performance thanks to LASMI.
8
9 This translates to more development productivity, better video resolution
10 and quality, ease of designing complex hardware accelerators, and much
11 more flexibility in hardware designs.
12
13 The milkymist-ng SoC supports the Mixxeo and the Milkymist One.
14 Obtain yours at http://milkymist.org
15
16 [> Instructions (software)
17 --------------------------
18 1. Compile and install binutils. Take the latest version from GNU.
19 mkdir build && cd build
20 ../configure --target=lm32-elf
21 make
22 make install
23
24 2. Compile and install GCC 4.5. Take gcc-core and gcc-g++ from GNU.
25 rm -rf libstdc++-v3
26 mkdir build && cd build
27 ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
28 make
29 make install
30
31 3. Obtain compiler-rt and set the CRTDIR environment variable to the root of
32 its source tree.
33 svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt
34 export CRTDIR=/path_to/compiler-rt
35
36 4. Build and flash the BIOS (part of this source distribution).
37 cd software/bios
38 make
39 make flash
40
41 The second command requires m1nor, FJMEM and UrJTAG.
42 These tools can be found at:
43 https://github.com/milkymist/fjmem-m1
44 http://urjtag.org
45
46 [> Instructions (gateware)
47 --------------------------
48 First, download and install Migen from:
49 https://github.com/milkymist/migen
50
51 Once this is done, build the bitstream with:
52 ./make.py [-p <platform>] -l
53 This will generate the build/soc-<platform>.bit programming file
54 and load it with UrJTAG.
55
56 A new BIOS needs to be built and flashed for the -ng SoC.
57
58 Enjoy!
59
60 [> Misc
61 -------
62 Code repository:
63 https://github.com/milkymist/milkymist-ng
64
65 Send questions, comments and patches to devel [AT] lists.milkymist.org
66 We are also on IRC: #milkymist on the Freenode network.
67
68 Milkymist-ng is released under the very permissive two-clause BSD license. Under
69 the terms of this license, you are authorized to use milkymist-ng for
70 closed-source proprietary designs.
71 Even though we do not require you to do so, those things are awesome, so please
72 do them if possible:
73 * tell us that you are using milkymist-ng
74 * cite milkymist-ng in publications related to research it has helped
75 * send us feedback and suggestions for improvements
76 * send us bug reports when something goes wrong
77 * send us the modifications and improvements you have done to milkymist-ng.
78 The use of "git format-patch" is recommended. If your submission is large and
79 complex and/or you are not sure how to proceed, feel free to discuss it on
80 the mailing list or IRC (#milkymist on Freenode) beforehand.
81
82 See LICENSE file for full copyright and license info. You can contact us on the
83 public mailing list devel [AT] lists.milkymist.org.