README

   1               YARI -- Yet Another RISC Implementation
   2
   3 Last update: 2007-12-12
   4
   5 INTRODUCTION
   6
   7 YARI is an high performance soft core RISC implementation, binary
   8 compatible with a subset of MIPS R3000.
   9
  10 This README will be out of date at the time you read this, but the
  11 implementation currently comprises:
  12
  13 - A reference simulator which closely matches the RTL implementation
  14   (in fact they co-simulate).
  15
  16 - A few regression and tests programs
  17 - An RTL (Verilog) implementation
  18
  19   Core features:
  20   + an eight stage pipeline.
  21   + a 4-way associative write-through instruction cache (default 8 KiB)
  22   + a 4-way associative write-through data cache (default 16 KiB)
  23   + a store buffer
  24   + all of the integer user-level instructions supported (current
  25     missing DIV*).
  26
  27   Peripherals (depending on the target)
  28   + SRAM interface
  29   + 640x480x1 video interface
  30   + Serial in/out
  31   + 8 LED out put for debugging.
  32
  33   Simulation
  34   + Enough support to fully simulate the RTL with Icarus Verilog.
  35   + Co-simulation against the reference simulator supported
  36
  37   Synthesis
  38   + Targeted at the Altera Nios Dev Kit, Cyclone edition, and
  39     others.
  40
  41   + Runs (last it ran) happily at 50+ MHz.
  42
  43 - A boot loader pre-loaded into the I$ - will load programs over the
  44   serial port.
  45
  46 - Assorted tools to turn the elf binaries into ROM and RAM images.
  47
  48
  49
  50 GETTING STARTED
  51
  52 There are a few prerequisites for full YARI enjoyment:
  53
  54 - For building any test programs: Cross compilation tool much be built
  55   (mips-elf-gcc, etc).  The script xtools/BUILD is what I used to
  56   build them
  57
  58 - For simulation: Icarus Verilog.  Great stuff.  Get the most recent
  59   version from http://www.icarus.com/eda/verilog
  60
  61 - For synthesis: currently I've only tested with Quartus 7.2sp1.  Get it
  62   for free from http://www.altera.com (alas, only works with Windows,
  63   whereas everything else here expects Linux).
  64
  65 With the Icarus Verilog installed you should be able to simply run
  66
  67   make rtlsim
  68
  69 and see the trace of instructions as the Verilog implementation makes
  70 it through a small self-checking regression test.
  71
  72 For more interesting workloads, try
  73
  74   make -C testcases VERB= PROG=buzzard isasim
  75
  76 or try co-simulation
  77
  78   make -C testcases VERB= PROG=fib cosim
  79
  80
  81 Tommy