litex/README

[> MiSoC system-on-chip
------------------------------

A high performance system-on-chip design based on Migen.

MiSoC supports the Mixxeo and the Milkymist One.
Obtain your development system at http://milkymist.org

[> Instructions (software)
--------------------------
1. Compile and install binutils. Take the latest version from GNU.
  mkdir build && cd build
  ../configure --target=lm32-elf
  make
  make install
  
2. Compile and install GCC 4.5. Take gcc-core and gcc-g++ from GNU.
  rm -rf libstdc++-v3
  mkdir build && cd build
  ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
  make
  make install

3. Obtain compiler-rt and set the CRTDIR environment variable to the root of 
   its source tree.
  svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt
  export CRTDIR=/path_to/compiler-rt

4. Build and flash the BIOS (part of this source distribution).
  cd software/bios
  make
  make flash

The second command requires m1nor-ng, FJMEM and UrJTAG.
These tools can be found at:
  https://github.com/milkymist/fjmem-m1
  http://urjtag.org
  
[> Instructions (gateware)
--------------------------
First, download and install Migen from:
  https://github.com/milkymist/migen

Once this is done, build the bitstream with:
  ./make.py [-p <platform>] -l
This will generate the build/soc-<platform>.bit programming file
and load it with UrJTAG.

A new BIOS needs to be built and flashed for MiSoC.
There is no compatibility with Milkymist SoC.

Enjoy!

[> Misc
-------
Code repository:
  https://github.com/milkymist/misoc

Send questions, comments and patches to devel [AT] lists.milkymist.org
We are also on IRC: #milkymist on the Freenode network.

MiSoC is released under the very permissive two-clause BSD license. Under
the terms of this license, you are authorized to use MiSoC for
closed-source proprietary designs.
Even though we do not require you to do so, those things are awesome, so please
do them if possible:
 * tell us that you are using MiSoC
 * cite MiSoC in publications related to research it has helped
 * send us feedback and suggestions for improvements
 * send us bug reports when something goes wrong
 * send us the modifications and improvements you have done to MiSoC.
   The use of "git format-patch" is recommended. If your submission is large and
   complex and/or you are not sure how to proceed, feel free to discuss it on
   the mailing list or IRC (#milkymist on Freenode) beforehand.

See LICENSE file for full copyright and license info. You can contact us on the
public mailing list devel [AT] lists.milkymist.org.