Revision History

Table 1. Revision History
Date Version Description
February 2026 8.1 Updated Sapphire RISC-V SoC Hardware and Software User Guide as a standalone user guide. The Embedded IDE Software User Guide is separated from the current user guide. (DOC-2929)
November 2025 8.0 Added i2cMasterInterruptDemo Design in Example Software. (DOC-2683)
Added i2c_writeData_b_ack(), i2c_writeData_w_ack(), i2c_readData_b_ack(), i2c_readData_w_ack() in I2C API Calls. Updated i2c_writeData_w().
Added chapter Concurrent Debug chapter.
Change AXI master/slave interface 0/1.
Updated typo at Modify the Bootloader Software to extend the External Memory Size, Create a Custom APB3 Peripheral, Application Software in Migrating to Sapphire SoC, Memory Test of Troubleshooting. Corrected name in step 5 of Target another Efinix Voard. (DOC-2769)
Added new troubleshooting topics in Troubleshooting chapter.
June 2025 7.3 Added sub-topic Move Project to Other Location or Machine in IDE Launcher from Efinity. (DOC-2542)
Updated table List of Files Structure Changes and added table List of Reallocation File in List of Restructured BSP Files.
May 2025 7.2 Added Topaz device. (DOC-2461)
Added note in Table 13.
Updated Modify the Bootloader Software to Enable Multi-Data Lines.
Included Topaz Tz170 J484 into About the Example Design.
Added sub-topic IDE Launcher from Efinity.
Added note in Create a New Project and Import Sample Projects.
Added directory in table BSP Files.
Added subtopic List of Restructured BSP Files.
In Example Software, removed compatibilityDemo, freertosUartInterruptDemo, openocdServer, spiReadFlash, and spiWriteFlash, and freertosDemo2 in FreeRTOS. Replaced coreTimerInterrupt Demo with clintTimerInterruptDemo. Updated content for dCacheFlushDemo, spiDemo, Download the FreeRTOS.
March 2025 7.1 Added Installation Error (2350): Path too long (Windows) in the Troubleshooting section. (DOC-1979)
December 2024 7.0 Updated table Sapphire SoC Tab Parameter, Sapphire Cache/Memory Tab Parameter, Sapphire UART Tab Parameters, and Sapphire SPI Tab Parameters. Added Sapphire Watchdog Timer Parameters. (DOC-2098)
Removed note in chapter Create, Import, and Build a Software Project.
Added Watchdog Timer chapter.
June 2024 6.1 Added in D-Cache in table Sapphire SoC Tab Parameters. (DOC-1790)
Added in option 32 for GPIO n Bit Width in table Sapphire GPIO Tab Parameters.
Updated Simulate chapter.
Updated Create a New Project and Import Sample Projects topic.
December 2023 6.0 Added in Lite option in Customizing the Sapphire SoC. (DOC-1533)
Added semihostngDemo in Example Software.
Added in Semihosting Printing section in Unified Printf.
Added ENABLE_SEMIHOSTING_PRINT in Preprocessor Directives.
October 2023 5.4 Added steps and notes in Modify the Bootloader Software to Extend the External Memory Size, Modify the Bootloader Software without External Memory Enabled. Created new section Modify the Bootloader Software to Enable Multi-Data Lines. (DOC-1471)
Added new example software inlineASMDemo.
Added new topic Inline Assembly.
Corrected wording of images with prints/messages in software examples. (DOC-1419)
August 2023 5.3 Updated and added new API Reference: (DOC-1379)
–Control and Status Registers
–GPIO API Calls
–I2C API Calls
–Core Local Interrupt Timer API Calls
–User Timer API Calls
–PLIC API Calls
–SPI API Calls
–SPI Flash Memory API Calls
–UART API Calls
–RISC-V API Calls (new)
Added footnote in Sapphire Debug Tab Parameters table.
Added new section: Launching OpenOCD for Your Own Board and Updating OpenOCD Configuration for External FTDI Cable in Target Your Own Board topic.
Added new topic: Updating Bootloader with Efinity BRAM Initial Content Updater under Modify the Bootloader topic.
Added new section: i2cMasterDemo Design.
Replaced new content in i2cSlaveDemo Design section.
Replaced the section Warning when Debug with softTap with Unexpected CPUTAPID/JTAG Device ID.
June 2023 5.2 Updated address from 0xF900_0000 to 0xF900_0C00 in line 4 and add a new line in Notes of Boot Sequence Case B. (DOC-1181)
Added new paragraph after Default Address Map, Interrupt ID, and Cached Channels table in Address Map topic. (DOC-1199)
Updated the following sections: (DOC-1253)
–Customizing the Sapphire SoC
–Example Design Implementation table
–Launch the Debug Script
–Debug Daisy Chain
–Example Software
–API Reference
Added new topic: Other Customize Debugger
Added in new sub-topics:
–Debug - Single Core and Debug - SMP
–dCacheFlushDemo, iCacheFlushDemo, and 12CEepromDemo
–i2C_getSlaveStatus(), i2C_getSlaveOverride(), and i2C_masterRecoverBlocking()
Change Ti180M484 to Ti180J484.
January 2023 5.1 Updated On-Chip RAM of 512KB in the figure titled Sapphire Memory Space. (DOC-
December 2022 5.0 Moved topics Required Software for Eclipse, Launch Eclipse, Create and Build a Software Project, and Debug with the OpenOCD Debugger to Appendix. (DOC-981)
Changed topic title, Connect the FTDI CableConnect the FTDI Mini-Module and FTDI cable → FTDI mini-module
Added new main topics:
–Launch Efinity RISC-V Embedded Software IDE
–Create and Build a Software Project
–Debug with the OpenOCD Debugger
–Unified Printf
Added new sub-topics:
–Efinity RISC-V Embedded Software IDE
–Install the Efinity RISC-V Embedded Software IDE
–SoC Configuration Guideline
Sapphire SoC IDE Backward Compatibility
–Launching the Efinity RISC-V Embedded Software IDE.
–Optimization Settings
–Import Sample Projects
–Debug - Daisy Chain
–Peripheral Register View
–CSR Register View
–FreeRTOS View
–QEMU Emulator
–Bsp_print
–Bsp_printf
–Bsp_printf_full
–Preprocessor Directives
–Warning when Debug with softTap
Updated on sub-topics Open a Terminal, Connect the FTDI Cable, OpenOCD Error: timed out while waiting for target halted, Memory Test, Eclipse Fails to Launch with Exit Code 13, and API Reference.
Updated Appendix: Copy a User Binary to the Flash Device (2 Terminals) and Import the Debug Configuration.
November 2022 4.2 Corrected boot sequence cases A and B. (DOC-932)
September 2022 4.1 Updates for the Ti180 M484 development board.
September 2022 4.0
Updated the instructions for debugging with OpenOCD. You now use launch scripts.
Added information on the possible boot sequence scenarios.
Enhanced the information on the address map.
Added description for debugging with multiple cores.
Added new SPI API functions.
Added instructions on migrating from Ruby, Jade, and Opal to Sapphire.
Updated IP Manager configuration options.
Updated instructions on launching Eclipse.
Updated Installing USB drivers topics.
June 2022 3.2 When finding the COM port in Windows, look for the first COM port listed under Ports (COM & LPT). (DOC-811)
The VexRiscv core used in the Sapphire SoC has six pipeline stages.
March 2022 3.1 Fixed typo in Connect the FTDI Cable topic. (DOC-731)
December 2021 3.0 Updated the SDK version numbers.
Updated the IP Manager Configuration Wizard description for new configuration options.
Added instructions for using the Ti60 F225 Development Board and example design.
Updated instructions for Eclipse global environment variables.
Explained new Efinity Programmer feature for programming a flash device with a combined user bitstream and application binary.
Updated register map.
Updated the API Reference for new driver support.
October 2021 2.1 Corrected incomplete instructions for copying a user binary to flash. (DOC-576)
October 2021 2.0
IP Manager options changed for the updated Sapphire wizard. (DOC-544)
Updated the address map. (DOC-544)
Updated the example design description for the new features in the design. (DOC-544)
New simulation instructions. (DOC-544)
New instructions for changing the bootloader RAM size. (DOC-544)
Changed the EfxApb3Example, EfxAxi4Example, and userInterruptDemo example descriptions. (DOC-544)
Changed the TX pin number for the instructions on setting up a USB-to-UART module. (DOC-544)
When using the Soft Debug Tap option, the IP Manager connects the pins for you. (DOC-544)
Described the pins needed to connect an FTDI cable to the Trion® T120 BGA324 Development Board when using the Soft Debug Tap option. (DOC-544)
August 2021 1.1 Corrected typo in example design name in topics describing Eclipse and OpenOCD (EfxAxi4Example instead of EfxAxiExample). (DOC-517)
July 2021 1.0 Initial release.