README

   1                 __  ___  _   ____     _____
   2                /  |/  / (_) / __/__  / ___/
   3               / /|_/ / / / _\ \/ _ \/ /__
   4              /_/  /_/ /_/ /___/\___/\___/
   5
   6 a high performance and small footprint SoC based on Migen
   7
   8
   9 [> Features
  10 -----------
  11  * LatticeMico32 CPU, modified to include an optional MMU (experimental).
  12  * mor1kx (a better OpenRISC implementation) as alternative CPU option.
  13  * High performance memory controller capable of issuing several SDRAM commands
  14    per FPGA cycle.
  15  * Supports SDR, DDR, LPDDR and DDR2.
  16  * Provided peripherals: UART, GPIO, timer, GPIO, NOR flash controller, SPI
  17    flash controller, Ethernet MAC, and more.
  18  * High performance: on Spartan-6, 83MHz system clock frequencies, 10+Gbps DDR
  19    SDRAM bandwidth, 1080p 32bpp framebuffer, etc.
  20  * Low resource usage: basic implementation fits easily in Spartan-6 LX9.
  21  * Portable and easy to customize thanks to Python- and Migen-based
  22    architecture.
  23  * Design new peripherals using Migen and benefit from automatic CSR maps
  24    and logic, etc.
  25  * Possibility to encapsulate legacy Verilog/VHDL code.
  26
  27 MiSoC comes with built-in support for the following boards:
  28  * Mixxeo, the digital video mixer from M-Labs [XC6SLX45]
  29  * Milkymist One, the original M-Labs video synthesizer [XC6SLX45]
  30  * Papilio Pro, a simple and low-cost development board [XC6SLX9]
  31  * KC705, a Kintex-7 devboard from Xilinx [XC7K325T]
  32 MiSoC is portable and support for other boards can easily be added as external
  33 modules.
  34
  35 [> Quick start guide
  36 --------------------
  37 1. Install Python 3.3+, Migen and FPGA vendor's development tools.
  38   Get Migen from: https://github.com/m-labs/migen
  39
  40 2. Install JTAG tools.
  41   For Mixxeo and M1:          http://urjtag.org
  42   For Papilio Pro and KC705:  http://xc3sprog.sourceforge.net
  43
  44 3. Obtain and build any required flash proxy bitstreams. Flash proxy bitstreams
  45   give JTAG access to a flash chip through the FPGA.
  46   For Mixxeo and M1: https://github.com/m-labs/fjmem-m1
  47   For Papilio Pro:   https://github.com/GadgetFactory/Papilio-Loader
  48     (xc3sprog/trunk/bscan_spi/bscan_spi_lx9_papilio.bit)
  49
  50 4. Compile and install binutils. Take the latest version from GNU.
  51   mkdir build && cd build
  52   ../configure --target=lm32-elf
  53   make
  54   make install
  55
  56 5. Compile and install GCC. Take gcc-core and gcc-g++ from GNU (version 4.5 or >=4.9).
  57   rm -rf libstdc++-v3
  58   mkdir build && cd build
  59   ../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
  60   make
  61   make install
  62
  63 6. Obtain compiler-rt and set the CRTDIR environment variable to the root of
  64   its source tree.
  65   svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt
  66   export CRTDIR=/path_to/compiler-rt
  67
  68 7. Build and flash the BIOS and bitstream. Run from MiSoC:
  69   For Mixxeo:      ./make.py all
  70   For M1:          ./make.py -p m1 all
  71   For Papilio Pro: ./make.py -t ppro all
  72   For KC705:       ./make.py -t kc705 all
  73
  74 8. Run a terminal program on the board's serial port at 115200 8-N-1.
  75   You should get the BIOS prompt.
  76
  77 9. Read and experiment with the source!
  78   Come to our IRC channel and mailing list!
  79
  80 [> License
  81 ----------
  82 MiSoC is released under the very permissive two-clause BSD license. Under
  83 the terms of this license, you are authorized to use MiSoC for
  84 closed-source proprietary designs.
  85 Even though we do not require you to do so, those things are awesome, so please
  86 do them if possible:
  87  * tell us that you are using MiSoC
  88  * cite MiSoC in publications related to research it has helped
  89  * send us feedback and suggestions for improvements
  90  * send us bug reports when something goes wrong
  91  * send us the modifications and improvements you have done to MiSoC.
  92    The use of "git format-patch" is recommended. If your submission is large and
  93    complex and/or you are not sure how to proceed, feel free to discuss it on
  94    the mailing list or IRC (#m-labs on Freenode) beforehand.
  95
  96 See LICENSE file for full copyright and license info.
  97
  98 [> Links
  99 --------
 100 Web:
 101   http://m-labs.hk
 102
 103 Code repository:
 104   https://github.com/m-labs/misoc
 105
 106 You can contact us on the public mailing list devel [AT] lists.m-labs.hk.