Efinity RISC-V Embedded Software IDE Readme

Last updated: Dec 1, 2022


*** Errata ***


*** Description ***

This is a release package of the Efinity RISC-V Embedded Software IDE for 
project creation, editing, building and debugging on Efinix RISC-V SOC. This IDE 
is powered by Ashling RiscFree that provides a complete, seamless environment for
RISC-V "C" and "C++" software development. 


*** New features in Efinity RISC-V Embedded Software IDE 2022.2.3 ***

   -- Integrated JTAG debug support for Efinix RISC-V based FPGA boards (via OpenOCD).
   -- Supports importing, building, and debugging Efinity BSP Bare-Metal and FreeRTOS 
      sample projects. 
   -- Supports creating new Bare-Metal and FreeRTOS applications based on Efinity BSP.
   -- Includes xPack GNU RISC-V Embedded GCC, 64-bit 8.3.0 toolchain.
   -- Utilized same GNU Build Tools, v4.2.1 as RISC-V SDK for binary compatibility. 
   -- Supports Serial Terminal view. 
   -- Auto-created launch configurations includes default SVD and CSR register file path.
   -- Projects listing is categorized in the Efinity IDE project import 
      wizard based on the Efinity BSP software folder structure (E.g., FreeRTOS, Standalone).
      * Efinity IDE project import wizard shows only standalone projects if FreeRTOS 
        kernel source location is not specified.
   -- Includes QEMU ISA simulator for 32-bit RISC-V Cores. 
   -- Supports High-level Sapphire SoC Register Viewer (CSR and Peripheral registers) 
   -- Supports FreeRTOS Task and Queue Lists Viewer 


*** Fixed issues in Efinity RISC-V Embedded Software IDE 2022.2.3 ***
   -- N/A


*** Contents ***

build_tools		: Build tools (i.e. GNU make)
Efinity-RISCV-IDE	: IDE related files (i.e. Java Executable, Eclipse plugins...)  
examples		: Example project, QEMU baremetal project 
licenses		: Efinix Software License file
openocd 		: OpenOCD Binary 
qemu			: QEMU Emulator executable and libraries
scripts			: IDE Scripts
templates 		: IDE templates for generating launch configurations, 
			  new projects and include settings 
toolchain		: xPack GNU RISC-V Embedded GCC 8.3.0
APB225-Efinix-IDE.pdf	: Getting started guide on Efinity RISC-V Embedded Software IDE
Efinity RISC-V IDE	: Shortcut to launch the IDE in Windows 
efinity-riscv-ide	: Shortcut to launch the IDE in Linux
README.rtf 		: IDE Readme file
uninst.exe		: Efinity RISC-V Embedded Software IDE Uninstaller for Windows 
uninstall.sh		: Efinity RISC-V Embedded Software IDE Uninstaller for Linux 


*** Setup Requirements ***

This release has been verified to run on several mainstream 64-bit desktop
Linux distributions.  Efinix recommends Ubuntu 18.04 x86-64 (or later 
versions) or Red Hat Enterprise / CentOS 8 x86-64 (or later versions).

The Efinity IDE is also supported for Microsoft Windows 8.1 64-bit 
(or more recent versions).


*** Installation ***

Linux installation:

	Simply run efinity-riscv-ide-<version>-linux-x64.run in terminal and follow
	the on-screen instructions.
	
		> ./efinity-riscv-ide-<version>-linux-x64.run
		
	The IDE would be located by default at:
		/home/<user>/efinity/efinity-riscv-ide-<version>/

Windows installation:

	Double-click on the efinity-riscv-ide-<version>-windows-x64.exe installer 
	package and follow the on-screen instructions.
	
	The IDE would be located by default at:
		C:\Efinity\efinity-riscv-ide-<version>
	

*** More Information ***

For more information on the IDE, please refer to Sapphire SoC User Guide at 
our support page.