README.md

   1 <p align="center">
   2 <img src="media/microwatt-title.png" alt="Microwatt">
   3 </p>
   4
   5 # Microwatt
   6
   7 A tiny Open POWER ISA softcore written in VHDL 2008. It aims to be simple and easy
   8 to understand.
   9
  10 ## Simulation using ghdl
  11 <p align="center">
  12 <img src="http://neuling.org/microwatt-micropython.gif" alt="MicroPython running on Microwatt"/>
  13 </p>
  14
  15 You can try out Microwatt/Micropython without hardware by using the ghdl simulator. If you want to build directly for a hardware target board, see below.
  16
  17 - Build micropython. If you aren't building on a ppc64le box you
  18   will need a cross compiler. If it isn't available on your distro
  19   grab the powerpc64le-power8 toolchain from https://toolchains.bootlin.com.
  20   You may need to set the CROSS_COMPILE environment variable
  21   to the prefix used for your cross compilers.  The default is
  22   powerpc64le-linux-gnu-.
  23
  24 ```
  25 git clone https://github.com/micropython/micropython.git
  26 cd micropython
  27 cd ports/powerpc
  28 make -j$(nproc)
  29 cd ../../../
  30 ```
  31
  32   A prebuilt micropython image is also available in the micropython/ directory.
  33
  34 - Microwatt uses ghdl for simulation. Either install this from your
  35   distro or build it. Microwatt requires ghdl to be built with the LLVM
  36   or gcc backend, which not all distros do (Fedora does, Debian/Ubuntu
  37   appears not to). ghdl with the LLVM backend is likely easier to build.
  38
  39   If building ghdl from scratch is too much for you, the microwatt Makefile
  40   supports using Docker or Podman.
  41
  42 - Next build microwatt:
  43
  44 ```
  45 git clone https://github.com/antonblanchard/microwatt
  46 cd microwatt
  47 make
  48 ```
  49
  50    To build using Docker:
  51 ```
  52 make DOCKER=1
  53 ```
  54
  55    and to build using Podman:
  56
  57 ```
  58 make PODMAN=1
  59 ```
  60
  61 - Link in the micropython image:
  62
  63 ```
  64 ln -s ../micropython/ports/powerpc/build/firmware.bin main_ram.bin
  65 ```
  66
  67   Or if you were using the pre-built image:
  68
  69 ```
  70 ln -s micropython/firmware.bin main_ram.bin
  71 ```
  72
  73 - Now run microwatt, sending debug output to /dev/null:
  74
  75 ```
  76 ./core_tb > /dev/null
  77 ```
  78
  79 ## Synthesis on Xilinx FPGAs using Vivado
  80
  81 - Install Vivado (I'm using the free 2019.1 webpack edition).
  82
  83 - Setup Vivado paths:
  84
  85 ```
  86 source /opt/Xilinx/Vivado/2019.1/settings64.sh
  87 ```
  88
  89 - Install FuseSoC:
  90
  91 ```
  92 pip3 install --user -U fusesoc
  93 ```
  94 Fedora users can get FuseSoC package via
  95 ```
  96 sudo dnf copr enable sharkcz/danny
  97 sudo dnf install fusesoc
  98 ```
  99
 100 - If this is your first time using fusesoc, initialize fusesoc.
 101   This is needed to be able to pull down fussoc library components referenced
 102   by microwatt. Run
 103
 104 ```
 105 fusesoc init
 106 ```
 107
 108 - Create a working directory and point FuseSoC at microwatt:
 109
 110 ```
 111 mkdir microwatt-fusesoc
 112 cd microwatt-fusesoc
 113 fusesoc library add microwatt /path/to/microwatt/
 114 ```
 115
 116 - Build using FuseSoC. For hello world (Replace nexys_video with your FPGA board such as --target=arty_a7-100):
 117   You may wish to ensure you have [installed Digilent Board files](https://reference.digilentinc.com/vivado/installing-vivado/start#installing_digilent_board_files)
 118   or appropriate files for your board first.
 119
 120 ```
 121 fusesoc run --target=nexys_video microwatt --memory_size=16384 --ram_init_file=/path/to/microwatt/fpga/hello_world.hex
 122 ```
 123 You should then be able to see output via the serial port of the board (/dev/ttyUSB1, 115200 for example assuming standard clock speeds). There is a know bug where initial output may not be sent - try the reset (not programming button) on your board if you don't see anything.
 124
 125 - To build micropython (currently requires 1MB of BRAM eg an Artix-7 A200):
 126
 127 ```
 128 fusesoc run --target=nexys_video microwatt
 129 ```
 130
 131 ## Testing
 132
 133 - A simple test suite containing random execution test cases and a couple of
 134   micropython test cases can be run with:
 135
 136 ```
 137 make -j$(nproc) check
 138 ```
 139
 140 ## Issues
 141
 142 - There are a few instructions still to be implemented:
 143   - Vector/VMX/VSX