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