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