Difference between revisions of "RISC-V & FreeRTOS"

From spiderboard.org
Jump to: navigation, search
(9 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
* Linux Operating System (this guide uses Ubuntu 16.04)
 
* Linux Operating System (this guide uses Ubuntu 16.04)
* Utility Software (git, make)
+
* Utility Software (git, make, python)
 
* [http://fpgasoftware.intel.com/?edition=lite Quartus Prime]
 
* [http://fpgasoftware.intel.com/?edition=lite Quartus Prime]
* A [[Spiderboard_SoM|SpiderSoM]] (alternatively MX10) with [[Spiderboard_Baseboard|SpiderBase]]
+
* A [[Spiderboard_SoM|SpiderSoM]] or MX10<sup>[[Installing OpenOCD#MX10 Hardware Issue|[note]]]</sup> with atleast 8K LE, [[Spiderboard_Baseboard|SpiderBase]]
 
* One of the following:
 
* One of the following:
 
** [[Installing OpenOCD|OpenOCD]]
 
** [[Installing OpenOCD|OpenOCD]]
Line 28: Line 28:
  
  
* Download the [ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190506_SpiderSoM_quartus_riscv_freertos.zip RISC-V & FreeRTOS Example] and unpack.
+
* Download the [ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190604_mx10_spider_riscv_freertos.zip RISC-V & FreeRTOS Example] and unpack.
 
* Then choose either RISC-V or RISC-V & FreeRTOS and run make.
 
* Then choose either RISC-V or RISC-V & FreeRTOS and run make.
* For this, open a terminal window and run the commands:
+
* Open a terminal window and run the commands:
*: '''$''' wget <nowiki>ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190506_SpiderSoM_quartus_riscv_freertos.zip</nowiki>
+
*: '''$''' wget <nowiki>ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190604_mx10_spider_riscv_freertos.zip</nowiki>
*: '''$''' unzip 20190506_SpiderSoM_quartus_riscv_freertos.zip
+
*: '''$''' unzip 20190604_mx10_spider_riscv_freertos.zip
 
** For the RISC-V standalone demo:
 
** For the RISC-V standalone demo:
**: '''$''' cd riscv_freertos_example/riscv
+
**: '''$''' cd mx10_spider_riscv_freertos/riscv
 
** Or for RISC-V with FreeRTOS:
 
** Or for RISC-V with FreeRTOS:
**: '''$''' cd riscv_freertos_example/riscv_freertos
+
**: '''$''' cd mx10_spider_riscv_freertos/riscv_freertos
 
*: '''$''' make
 
*: '''$''' make
 
* This will create the ''bootrom.mif'' (Memory Initialization File) in the subfolder ''out''.
 
* This will create the ''bootrom.mif'' (Memory Initialization File) in the subfolder ''out''.
* Copy the ''bootrom.mif'' to ''riscv_freertos_example/quartus''
+
* Copy the ''bootrom.mif'' to ''mx10_spider_riscv_freertos/quartus_mx10'' or ''mx10_spider_riscv_freertos/quartus_spider'', depending on which module you use.
*: '''$''' cp out/bootrom.mif ../quartus
+
*: '''$''' cp out/bootrom.mif ../quartus_spider
  
 
[[File:terminal_make_riscv.png|1200px|Terminal after calling make.]]
 
[[File:terminal_make_riscv.png|1200px|Terminal after calling make.]]
Line 46: Line 46:
 
== Quartus Prime Project ==
 
== Quartus Prime Project ==
  
 
+
* Open Quartus Prime and load the project under ''mx10_spider_riscv_freertos/quartus_mx10'' or ''mx10_spider_riscv_freertos/quartus_spider''
 
+
* Open Device Settings (Assigments -> Device) and select your FPGA, the default FPGA the MX10 project is the 10M08DAF256C8G FPGA and for the SpiderSoM project the 10M08SAU169C8G FPGA.
* Open Quartus Prime and load the project under ''riscv_freertos_example/quartus''.
 
*: INFO: This Quartus project is specific to the SpiderSoM - for the MX10 the pin assignment has to be changed.
 
 
* Open '''Assignments -> Settings -> IP Settings -> IP Catalog Search Locations''' and add the search path to ORCA.
 
* Open '''Assignments -> Settings -> IP Settings -> IP Catalog Search Locations''' and add the search path to ORCA.
 
*: If ORCA was installed under ''/opt/orca/'' then type in as search path ''/opt/orca/**/*'' and click on the ''Add'' button.
 
*: If ORCA was installed under ''/opt/orca/'' then type in as search path ''/opt/orca/**/*'' and click on the ''Add'' button.
Line 62: Line 60:
 
After programming:
 
After programming:
  
* If the red LED on the module starts blinking once per second, the FPGA was programmed successfully.
+
* If the red or orange LED on the module starts blinking once per second, the FPGA was programmed successfully.
 
* If the green LED on the module starts blinking once every two seconds, the RISC-V Core and its firmware is working.
 
* If the green LED on the module starts blinking once every two seconds, the RISC-V Core and its firmware is working.
 
* PMod J2 will output a binary counter.
 
* PMod J2 will output a binary counter.
Line 79: Line 77:
  
 
* [https://github.com/VectorBlox/orca VectorBlox ORCA]
 
* [https://github.com/VectorBlox/orca VectorBlox ORCA]
* [ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190506_SpiderSoM_quartus_riscv_freertos.zip RISC-V & FreeRTOS Example]
+
* [ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190604_mx10_spider_riscv_freertos.zip RISC-V & FreeRTOS Example]

Revision as of 12:27, 4 June 2019

Prerequisites

  • Linux Operating System (this guide uses Ubuntu 16.04)
  • Utility Software (git, make, python)
  • Quartus Prime
  • A SpiderSoM or MX10[note] with atleast 8K LE, SpiderBase
  • One of the following:
    • OpenOCD
    • USB Blaster and Quartus Programmer

Installing VectorBlox ORCA Core and RISC-V Tools

  • Download the source from https://github.com/VectorBlox/orca using git.
    This guide uses the install locations /opt/orca/ and /opt/riscv/, you can substitute them if you wish.
  • Open a terminal window and run:
    $ git clone https://github.com/VectorBlox/orca.git /opt/orca
    $ cd /opt/orca/tools/riscv-toolchain/
    $ export RISCV_INSTALL="/opt/riscv"
    $ ./build-toolchain.sh
    Info: This may take a while.
  • Finally, add the RISC-V tools to your path. Open .profile in your home directory with a text exitor and add the line:
    PATH="/opt/riscv/bin:$PATH"
  • After updating the path variable you may need to logout and login again or run the following command in the terminal:
    $ source ~/.profile

Compiling Firmware

  • Download the RISC-V & FreeRTOS Example and unpack.
  • Then choose either RISC-V or RISC-V & FreeRTOS and run make.
  • Open a terminal window and run the commands:
    $ wget ftp://ftp.aries-embedded.de/products/MX10/software/demo/20190604_mx10_spider_riscv_freertos.zip
    $ unzip 20190604_mx10_spider_riscv_freertos.zip
    • For the RISC-V standalone demo:
      $ cd mx10_spider_riscv_freertos/riscv
    • Or for RISC-V with FreeRTOS:
      $ cd mx10_spider_riscv_freertos/riscv_freertos
    $ make
  • This will create the bootrom.mif (Memory Initialization File) in the subfolder out.
  • Copy the bootrom.mif to mx10_spider_riscv_freertos/quartus_mx10 or mx10_spider_riscv_freertos/quartus_spider, depending on which module you use.
    $ cp out/bootrom.mif ../quartus_spider

Terminal after calling make.

Quartus Prime Project

  • Open Quartus Prime and load the project under mx10_spider_riscv_freertos/quartus_mx10 or mx10_spider_riscv_freertos/quartus_spider
  • Open Device Settings (Assigments -> Device) and select your FPGA, the default FPGA the MX10 project is the 10M08DAF256C8G FPGA and for the SpiderSoM project the 10M08SAU169C8G FPGA.
  • Open Assignments -> Settings -> IP Settings -> IP Catalog Search Locations and add the search path to ORCA.
    If ORCA was installed under /opt/orca/ then type in as search path /opt/orca/**/* and click on the Add button.

Type in the search path and then click on Add.

  • (Optional) Launch Qsys Platform Designer and open qsys.qsys
    • (Optional) Under System Contents, double-click onchip_memory2_0 and under memory initialization provide your bootrom.mif file. Per default the bootrom.mif in the quartus folder will be used.
    • (Optional) Save and Generate the Qsys system.

Setting the memory initialization in Qsys Platform Designer


After programming:

  • If the red or orange LED on the module starts blinking once per second, the FPGA was programmed successfully.
  • If the green LED on the module starts blinking once every two seconds, the RISC-V Core and its firmware is working.
  • PMod J2 will output a binary counter.
  • You can use the UART of the FPGA by using standard tools such as picocom:
    $ sudo picocom -b 115200 /dev/ttyACM0
    • Every character written is looped back and should be displayed on the terminal.


  • Spider with LED PMod connected on J2 showing the binary counter.
  • Characters written are looped back and displayed.


Downloads