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