MIDI
[mw/milkymist.git] / README
1 [> Milkymist(tm) System-on-Chip
2 -------------------------------
3
4 This is the complete core source code and documentation for the opensource
5 system-on-chip used in the Milkymist(tm) interactive VJ station.
6
7 For the latest releases, binary distributions and more:
8   http://www.milkymist.org
9
10
11 [> Directory Structure
12  /cores/      Cores library, with Verilog sources, test benches and documentation.
13  /boards/     Top-level design files, constraint files and Makefiles
14               for supported FPGA boards.
15  /software/   Software for the SoC.
16  /doc/        System documentation.
17  /tools/      Small tools for developers.
18  /patches/    Example patches.
19
20
21 [> Building tools
22 You will need:
23  - GNU Make,
24  - Bourne Again Shell (bash),
25  - Xilinx ISE for synthesizing the FPGA bitstream (WebPack is enough),
26  - LatticeMico32 toolchain for building the SoC software,
27  - SRecord,
28  - xxd,
29  - mtools,
30  - native Clang/LLVM toolchain,
31  - libGD,
32  - RE2C,
33  - Lemon parser generator,
34  - Scilab.
35
36 In case of Xst bugs or to improve timing/area (optional):
37  - Synplify Pro (Synopsys),
38  - or Precision RTL (Mentor Graphics).
39
40 NB. Before switching synthesis tools, don't forget to run "make clean" in the
41 synthesis directory.
42
43
44 [> Output files
45  /boards/xxx/synthesis/build/system.bit build_bitstream.sh FPGA bitstream.
46  /software/bios/bios.bin                build_bios.sh      BIOS image.
47  /software/demo/boot.bin                build_demo.sh      Demonstration firmware image.
48  /boards/xxx/flash/yyy.mcs                                 Flash images.
49  /doc/xxx.pdf                           build_doc.sh       System-wide documentation.
50  /cores/xxx/doc/xxx.pdf                 build_doc.sh       Core-specific documentation.
51
52
53 [> Development
54 For Verilog simulations, the scripts (usually Makefiles) shipped with the test benches
55 take care of running the simulator.
56
57 Depending on the IP core, one or more of these free simulators are supported:
58  - Icarus Verilog (http://www.icarus.com/eda/verilog/)
59  - GPL Cver (http://www.pragmatic-c.com/gpl-cver/)
60  - Verilator (http://www.veripool.org/wiki/verilator)
61
62 For firmware development, a serial console program compatible with automatic firmware
63 loading over the serial line (SFL boot) is provided in the /tools/ directory.
64
65
66 [> Credits
67 Most of the work is (C) Copyright 2007, 2008, 2009, 2010 Sebastien Bourdeauducq.
68 For this work:
69  - The hardware design is licensed under GNU GPLv3.
70    See the LICENSE.GPL file for more information.
71  - The software (software/*) is licensed under GNU GPLv3, except the SDRAM
72    initialization runtime (libHPDMC) which is under GNU LGPLv3.
73    See LICENSE.GPL and LICENSE.LGPL.
74  - The documentation is licensed under FDL.
75    See LICENSE.FDL.
76
77 Milkymist is a trademark of Sebastien Bourdeauducq.
78
79 The SoC design uses:
80  - the Mico32 soft-processor by Lattice Semiconductor. See the LICENSE.LATTICE file.
81  - a modified version of wb_conbus by Johny Chi and Rudolf Usselmann. See LICENSE.LGPL.
82
83 The directory organization and build scripts were inspired by soc-lm32 by the German
84 hackerspace Das Labor. Some of the UART and timer code also comes from there.
85
86 The software and software library include:
87  - the SoftFloat IEC/IEEE Floating-point Arithmetic Package, Release 2,
88    written by John R. Hauser. See source files headers for license.
89  - fundamental functions library by Jesus Calvino-Fraga. See the LICENSE.LGPL file.
90  - line drawing code from the GD library. See the LICENSE.GD file.
91
92 Special thanks to the people who did significant things which made this project possible:
93  - Lattice Semiconductor for the Mico32 processor,
94  - Shawn Tan for the AEMB processor (used earlier),
95  - Stephen Williams for Icarus Verilog,
96  - Pragmatic C Software for GPL Cver,
97  - Wilson Snyder for Verilator,
98  - Henry from Xilinx,
99  - Das Labor for providing neat build scripts for SoCs (soc-lm32).
100
101
102 [> Contact
103 E-mail: sebastien.bourdeauducq at lekernel daaht net
104 Phone:  +33(0)606644335
105 PGP:    0x9277FCF2
106
107 -----BEGIN PGP PUBLIC KEY BLOCK-----
108 Version: GnuPG v1.4.9 (GNU/Linux)
109
110 mQGiBEnPSIoRBADK2T3lN98btWazmH8Wz8YX6ZY38l9ouq5CgucTYWgljUTB6WMI
111 P3LPAKjp+LpaeeHC3C9cJcWqI1AmrcoemqUjeeez1Y9TIPSL4Qy5mp3pEQ/evxYy
112 xQShzSOQQFZ3St4yC7eSKW629qO1F7P2939l4Icfwjubu77L7kYqI39MGwCgknSz
113 PKDGRFo2mHsL5Kd4YDXMzeMD/jyO9cOQgpUNQWtIiMz9ju26nfKfI1XECB8rtvP+
114 m2rHmqUnMcOd060lGyBvssZUPvllSxZ6931kXTHukWjuqYlVPy7JLpaFXMajJ/Eg
115 JI8btTiXueHYxW0SwtoJcuLQes7bGNw78PhvhWpurPl95BEVgzBwDEmcjm/2wkyf
116 B0AqBACmX2idI6CYDkHSMxb0UTyiR+65DgaDBN0UbKWoeAFOG19LRj5ugshSIPHy
117 4lMhGbvIwSHqYxj+3LplFdz0jSWsbN7f8ZfykLveI2rTpStGTyitFkOsLpcqZg/h
118 tsWyVi4XGqpsE7+DvS6Cn1oKiBDqhw3/mk0K33MzchSiCTMRQLQ8U2ViYXN0aWVu
119 IEJvdXJkZWF1ZHVjcSA8c2ViYXN0aWVuLmJvdXJkZWF1ZHVjcUBsZWtlcm5lbC5u
120 ZXQ+iGYEExECACYFAknPSIoCGyMFCQlmAYAGCwkIBwMCBBUCCAMEFgIDAQIeAQIX
121 gAAKCRAWFy/1knf88qk5AJwPD2aqIRx3iVGoQLm8Kp6ewjno/ACfXVjCuRDVbh8V
122 UC1OZoSM5JQ/mxi5BA0ESc9IihAQAPQMDGoiQh9q0JACjGK+igpBi9dwU4BGNvNz
123 E6JYFtZTTQ/2XIPQ8lFm1OiIcCX9M6CGg2mn7K4lsnWtVwpKe2NoQNsRRUSBLpoY
124 Y54E8ydYd2ivLYajxv9H1amqpdLaq5TP/qPS9PyQ9u2sUYZ9vbtFfsTVauDjq4ld
125 waFI6YWM9s0zPcDQ1HVX94uVoKbovzU0dJDD+hz/HQiZPMahGFbxOAY6GgyoLI1c
126 NSXPz7XABW3aNilumWUW3rJ0vhW7qozIfhyUaOmlRDvS6L8Hpc5rUQEe0zBVFl3+
127 8y2O/OLAOUn1GwydXnj7PkPlvyzBHD7Pvp2tds0lpggndJaHOB7gAER5Sk/JZ+63
128 KbsWTb3sVAqW31Ko3FNKVejjg/WuwkdV/5OaS/yuCt4e5okX7watzzksfItlpO0z
129 HvuQ8oEYo3BEdHMLJphRpD4O3izvZee1Mh/NAGEBgaZ8w7MfIVyiUoPfnPdveM79
130 fhseELiKK0ImJ1+ADLxoOq0Jh+Wv81Zkhm1GpX1L8gT1hHUqWTcF6yfR3Vp0Qy/m
131 Fug5ARAGXkqZb5OQd0ENB5Jj6U82p7PQ6xzicB2fgpIgebjCL5Ycibd6000yRMfo
132 oIk4tOpOFt39FeYQDFf9dKx0NV4u0lDUodkMr3itrtk7Se4VDH1SPFojdFwXiHmY
133 oHhmm9YjAAMFD/9X69dPL+B2Q8N2ibFiTmL88+QM7upPUT+TGT2Z5CNrPTqUsiNG
134 Ow70e1lQugPa55nI8QPFyzBGomJRZy7y2OutSv0Yog1BbZqdNamuN6v2tceuSgpk
135 Hm80dpj1CkQa3WhLITMfvjL6/dznDbFpqx5i3yr0LaJAbQLl8LGrkwiEM8N4xIPA
136 B1sbG17aOUgJth2CUQAy/i2DgtLp6WcpBn2Lgo6S3EU5itvq3TRUWeulLvaaDJSv
137 f1J/zDOnl3kyjbCdaaIebTLBG8QSex9ogbnpXf7pQBqK78fuIeyjYUk0/7NBMiHt
138 qW0KrC8BnsS8JtbwX/xBMDoU2vuxOnBs+Vu5b4GV+r5LHmTsbtlKuxvP9GS1/a9M
139 3euzcyIUzzsdShIT6ekGpijLBUV40QhlnTQqaMjiYUimQ9AeaipP2D0ipZzqDi8F
140 95WIYotRe49g1dRBjJiQiAmHJEOxUk7J1mYCThS4infc8pKwZulvz2uSel0pdjmN
141 xu7LouhnMQNSAOgxgvdB5hc15xfcZAajhHGt2npKiD/uSWzwLKA86O/0EOAD/M8v
142 HJFUY0gF7/IfBscSArSmRef4+wY6qdCYnxWKYU+vz0hKk4dnplEWWk+MbmLE5Tig
143 9W6nuXzNjFhsKjVWqKjjYeggLITvKslLkv2eC9qE2uKDRNirXMZwCFMSDIhPBBgR
144 AgAPBQJJz0iKAhsMBQkJZgGAAAoJEBYXL/WSd/zybSEAniuiaCR/7aYk94u06jiQ
145 lRHoJGwiAJ9JnmgPtl71/XVNcFxNQqUxVTOvjg==
146 =NnZi
147 -----END PGP PUBLIC KEY BLOCK-----