2014-04-08 11:11:27 -04:00
|
|
|
__ ___ _ ____ _____
|
|
|
|
/ |/ / (_) / __/__ / ___/
|
|
|
|
/ /|_/ / / / _\ \/ _ \/ /__
|
|
|
|
/_/ /_/ /_/ /___/\___/\___/
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2015-03-02 12:39:03 -05:00
|
|
|
Copyright 2007-2015 / M-Labs Ltd
|
|
|
|
Copyright 2012-2015 / Enjoy-Digital
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2015-03-02 12:39:03 -05:00
|
|
|
a high performance and small footprint SoC based on Migen
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2014-04-08 11:11:27 -04:00
|
|
|
[> Features
|
|
|
|
-----------
|
|
|
|
* LatticeMico32 CPU, modified to include an optional MMU (experimental).
|
2014-08-03 03:48:55 -04:00
|
|
|
* mor1kx (a better OpenRISC implementation) as alternative CPU option.
|
2014-04-08 11:22:44 -04:00
|
|
|
* High performance memory controller capable of issuing several SDRAM commands
|
|
|
|
per FPGA cycle.
|
2014-09-20 15:51:37 -04:00
|
|
|
* Supports SDR, DDR, LPDDR, DDR2 and DDR3.
|
2014-04-08 11:22:44 -04:00
|
|
|
* Provided peripherals: UART, GPIO, timer, GPIO, NOR flash controller, SPI
|
|
|
|
flash controller, Ethernet MAC, and more.
|
2014-09-20 15:51:37 -04:00
|
|
|
* High performance:
|
|
|
|
- on Spartan-6, 83MHz system clock frequencies, 10+Gbps DDR
|
2014-04-08 11:22:44 -04:00
|
|
|
SDRAM bandwidth, 1080p 32bpp framebuffer, etc.
|
2014-09-20 15:51:37 -04:00
|
|
|
- on Kintex-7, 125MHz system clock frequencies (up to 200MHz without DDR3),
|
|
|
|
64Gbps DDR3 SDRAM bandwidth.
|
2014-04-08 11:11:27 -04:00
|
|
|
* Low resource usage: basic implementation fits easily in Spartan-6 LX9.
|
2014-04-08 11:22:44 -04:00
|
|
|
* Portable and easy to customize thanks to Python- and Migen-based
|
|
|
|
architecture.
|
|
|
|
* Design new peripherals using Migen and benefit from automatic CSR maps
|
|
|
|
and logic, etc.
|
2014-04-08 11:11:27 -04:00
|
|
|
* Possibility to encapsulate legacy Verilog/VHDL code.
|
2015-03-02 12:39:03 -05:00
|
|
|
* Complex FPGA cores that can be used integrated in MiSoC or in standalone:
|
|
|
|
- LiteEth: a small footprint and configurable Ethernet core
|
|
|
|
- LiteSATA: a small footprint and configurable SATA core
|
|
|
|
- LiteScope: a small footprint and configurable logic analyzer core
|
2014-04-08 11:11:27 -04:00
|
|
|
|
|
|
|
MiSoC comes with built-in support for the following boards:
|
|
|
|
* Mixxeo, the digital video mixer from M-Labs [XC6SLX45]
|
|
|
|
* Milkymist One, the original M-Labs video synthesizer [XC6SLX45]
|
|
|
|
* Papilio Pro, a simple and low-cost development board [XC6SLX9]
|
2015-03-02 12:39:03 -05:00
|
|
|
* De0 Nano, a simple and low-cost development board [CYCLONEIV]
|
2014-08-03 03:48:55 -04:00
|
|
|
* KC705, a Kintex-7 devboard from Xilinx [XC7K325T]
|
2014-04-08 11:22:44 -04:00
|
|
|
MiSoC is portable and support for other boards can easily be added as external
|
|
|
|
modules.
|
2014-04-08 11:11:27 -04:00
|
|
|
|
|
|
|
[> Quick start guide
|
|
|
|
--------------------
|
|
|
|
1. Install Python 3.3+, Migen and FPGA vendor's development tools.
|
|
|
|
Get Migen from: https://github.com/m-labs/migen
|
|
|
|
|
|
|
|
2. Install JTAG tools.
|
2014-08-03 03:48:55 -04:00
|
|
|
For Mixxeo and M1: http://urjtag.org
|
|
|
|
For Papilio Pro and KC705: http://xc3sprog.sourceforge.net
|
2015-03-02 12:39:03 -05:00
|
|
|
For De0 Nano: USBBlaster from Altera
|
|
|
|
We recommend using xc3sprog for Xilinx devices, but Vivado programmer
|
|
|
|
is also supported for Xilinx 7-series.
|
2014-04-08 11:11:27 -04:00
|
|
|
|
2015-03-02 12:39:03 -05:00
|
|
|
3. (Optional, only needed if you want to flash the bistream/software)
|
|
|
|
Obtain and build any required flash proxy bitstreams. Flash proxy bitstreams
|
2014-04-08 11:22:44 -04:00
|
|
|
give JTAG access to a flash chip through the FPGA.
|
2014-04-08 11:11:27 -04:00
|
|
|
For Mixxeo and M1: https://github.com/m-labs/fjmem-m1
|
|
|
|
For Papilio Pro: https://github.com/GadgetFactory/Papilio-Loader
|
|
|
|
(xc3sprog/trunk/bscan_spi/bscan_spi_lx9_papilio.bit)
|
2014-09-20 15:51:37 -04:00
|
|
|
For KC705: https://github.com/m-labs/bscan_spi_kc705
|
2014-04-08 11:11:27 -04:00
|
|
|
|
|
|
|
4. Compile and install binutils. Take the latest version from GNU.
|
2013-02-16 17:41:42 -05:00
|
|
|
mkdir build && cd build
|
|
|
|
../configure --target=lm32-elf
|
2012-06-03 16:17:34 -04:00
|
|
|
make
|
|
|
|
make install
|
2014-09-20 15:51:37 -04:00
|
|
|
|
2014-08-03 03:48:55 -04:00
|
|
|
5. Compile and install GCC. Take gcc-core and gcc-g++ from GNU (version 4.5 or >=4.9).
|
2013-02-16 17:41:42 -05:00
|
|
|
rm -rf libstdc++-v3
|
|
|
|
mkdir build && cd build
|
|
|
|
../configure --target=lm32-elf --enable-languages="c,c++" --disable-libgcc --disable-libssp
|
2012-06-03 16:17:34 -04:00
|
|
|
make
|
|
|
|
make install
|
|
|
|
|
2014-11-06 21:02:02 -05:00
|
|
|
6. Build and flash the BIOS and bitstream. Run from MiSoC:
|
2014-04-08 11:11:27 -04:00
|
|
|
For Mixxeo: ./make.py all
|
2014-08-03 03:48:55 -04:00
|
|
|
For M1: ./make.py -p m1 all
|
|
|
|
For Papilio Pro: ./make.py -t ppro all
|
2015-03-02 12:39:03 -05:00
|
|
|
For De0 Nano: ./make.py -t de0nano all load-bitstream
|
2014-08-03 03:48:55 -04:00
|
|
|
For KC705: ./make.py -t kc705 all
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2015-03-02 12:39:03 -05:00
|
|
|
If just want to load the bitstream in volatile SRAM use:
|
|
|
|
all load-bitstream
|
|
|
|
|
2014-11-06 21:02:02 -05:00
|
|
|
7. Run a terminal program on the board's serial port at 115200 8-N-1.
|
2014-04-08 11:11:27 -04:00
|
|
|
You should get the BIOS prompt.
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2014-11-06 21:02:02 -05:00
|
|
|
8. Read and experiment with the source!
|
2014-04-08 11:22:44 -04:00
|
|
|
Come to our IRC channel and mailing list!
|
2015-03-02 12:39:03 -05:00
|
|
|
A simple target is provided to test MiSoC easily with your board:
|
|
|
|
Create your target with a clock and serial pins.
|
|
|
|
Build and test it: ./make.py -t simple -p your_platform all load-bitstream
|
|
|
|
If you don't have access to a FPGA board, you can also try MiSoC with Verilator:
|
|
|
|
Download and install Verilator: http://www.veripool.org/
|
|
|
|
Test it: ./make.py -t simple -p sim build-bitstream
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2014-04-08 11:11:27 -04:00
|
|
|
[> License
|
|
|
|
----------
|
2013-11-09 09:27:32 -05:00
|
|
|
MiSoC is released under the very permissive two-clause BSD license. Under
|
|
|
|
the terms of this license, you are authorized to use MiSoC for
|
2013-07-31 17:20:32 -04:00
|
|
|
closed-source proprietary designs.
|
|
|
|
Even though we do not require you to do so, those things are awesome, so please
|
|
|
|
do them if possible:
|
2013-11-09 09:27:32 -05:00
|
|
|
* tell us that you are using MiSoC
|
|
|
|
* cite MiSoC in publications related to research it has helped
|
2013-07-31 17:20:32 -04:00
|
|
|
* send us feedback and suggestions for improvements
|
|
|
|
* send us bug reports when something goes wrong
|
2013-11-09 09:27:32 -05:00
|
|
|
* send us the modifications and improvements you have done to MiSoC.
|
2013-07-31 17:20:32 -04:00
|
|
|
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
|
2013-11-23 05:29:20 -05:00
|
|
|
the mailing list or IRC (#m-labs on Freenode) beforehand.
|
2012-02-14 09:43:09 -05:00
|
|
|
|
2014-04-08 11:11:27 -04:00
|
|
|
See LICENSE file for full copyright and license info.
|
|
|
|
|
|
|
|
[> Links
|
|
|
|
--------
|
|
|
|
Web:
|
|
|
|
http://m-labs.hk
|
2015-03-02 12:39:03 -05:00
|
|
|
http://enjoy-digital.fr
|
2014-04-08 11:11:27 -04:00
|
|
|
|
|
|
|
Code repository:
|
|
|
|
https://github.com/m-labs/misoc
|
|
|
|
|
|
|
|
You can contact us on the public mailing list devel [AT] lists.m-labs.hk.
|