Nuclei Software Development Kit(Nuclei SDK) is developed for developing and evaluating software using our FPGA evaluation board.
This Nuclei SDK is built based on the NMSIS framework, user can access all the APIs provided by NMSIS and also the APIs that provided by Nuclei SDK which mainly for on-board peripherals access such as GPIO, UART, SPI and I2C etc.
We also intergated three RTOSes into Nuclei SDK, which are FreeRTOS, UCOSII and RTThread, you can easily find it in the OS folder.
Wanner to a try with Nuclei SDK, click Quick Start with Nuclei SDK to start up.
Here is the directory structure for this Nuclei SDK.
$NUCLEI_SDK_ROOT ├── application │ ├── baremetal │ ├── freertos │ ├── ucosii │ └── rtthread ├── Build │ ├── gmsl │ ├── Makefile.base │ ├── Makefile.conf │ ├── Makefile.core │ ├── Makefile.files │ ├── Makefile.files.gd32vf103 │ ├── Makefile.files.hbird │ ├── Makefile.global │ ├── Makefile.misc │ ├── Makefile.rtos │ ├── Makefile.rtos.FreeRTOS │ ├── Makefile.rtos.UCOSII │ ├── Makefile.rtos.RTThread │ ├── Makefile.rules │ ├── Makefile.soc │ ├── Makefile.soc.gd32vf103 │ └── Makefile.soc.hbird ├── doc │ ├── build │ ├── source │ ├── Makefile │ └── requirements.txt ├── NMSIS │ ├── Core │ ├── DSP │ ├── NN │ └── Library ├── OS │ ├── FreeRTOS │ ├── UCOSII │ └── RTThread ├── SoC │ ├── gd32vf103 │ └── hbird ├── test │ ├── core │ ├── ctest.h │ ├── LICENSE │ └── README.md ├── LICENSE ├── Makefile ├── NMSIS_VERSION ├── package.json ├── SConscript ├── README.md ├── setup.bat └── setup.sh
This directory contains all the application softwares for this Nuclei SDK.
The application code can be divided into mainly 4 parts, which are:
This directory contains all the supported SoCs for this Nuclei SDK, the directory name for SoC and its boards should always in lower case.
Here we mainly support Nuclei processor cores running in Hummingbird FPGA evaluation board, the support package placed in SoC/hbird/.
In each SoC's include directory, nuclei_sdk_soc.h must be provided, and include the soc header file, for example, SoC/hbird/Common/Include/nuclei_sdk_soc.h.
In each SoC Board's include directory, nuclei_sdk_hal.h must be provided, and include the board header file, for example, SoC/hbird/Board/hbird_eval/Include/nuclei_sdk_hal.h.
This directory contains the key part of the build system based on Makefile for Nuclei SDK.
This directory contains the NMSIS header files, which is widely used in this Nuclei SDK, you can check the NMSIS_VERSION file to know the current NMSIS version used in Nuclei-SDK.
We will also sync the changes in NMSIS project when it provided a new release.
This directory provided two RTOS package we suppported which are FreeRTOS and UCOSII.
Nuclei SDK license file.
NMSIS Version file. It will show current NMSIS version used in Nuclei SDK.
PlatformIO package json file for Nuclei SDK, used in Nuclei Plaform for PlatformIO
RT-Thread package scons build script, used in RT-Thread package development.
An external Makefile just for build, run, debug application without cd to any coresponding application directory, such as application/baremetal/helloworld/.
Nuclei SDK environment setup script for Linux. You need to create your own
In the $NUCLEI_TOOL_ROOT for Linux, you need to have Nuclei RISC-V GNU GCC toolchain and OpenOCD installed as below.
$NUCLEI_TOOL_ROOT ├── gcc │ ├── bin │ ├── include │ ├── lib │ ├── libexec │ ├── riscv-nuclei-elf │ └── share └── openocd ├── bin ├── contrib ├── distro-info ├── OpenULINK ├── scripts └── share
Nuclei SDK environment setup bat script for Windows. You need to create your own
In the %NUCLEI_TOOL_ROOT% for Windows, you need to have Nuclei RISC-V GNU GCC toolchain, necessary Windows build tools and OpenOCD installed as below.
%NUCLEI_TOOL_ROOT% ├── build-tools │ ├── bin │ ├── gnu-mcu-eclipse │ └── licenses ├── gcc │ ├── bin │ ├── include │ ├── lib │ ├── libexec │ ├── riscv-nuclei-elf │ └── share └── openocd ├── bin ├── contrib ├── distro-info ├── OpenULINK ├── scripts └── share
hbird_eval, if you don't pass any SOC and BOARD variable in Make command, it will use the default SoC and Board.
make CORE=n305 DOWNLOAD=ilm all
make CORE=n305 DOWNLOAD=ilm upload
make CORE=n305 DOWNLOAD=ilm run_openocd
make CORE=n305 DOWNLOAD=ilm run_gdbin the existing terminal, then you can debug it using gdb, if you want to load your program, you need to type
loadto achieve it.
GDB_PORT=<portno>, to change to use new gdb port other than default
3333, for example,
make CORE=n305 DOWNLOAD=ilm GDB_PORT=3344 run_openocdand
make CORE=n305 DOWNLOAD=ilm GDB_PORT=3344 run_gdb
make CORE=n305 DOWNLOAD=ilm debug
teratermin Windows, the default UART baudrate we use is
If you want to learn more about Nuclei SDK documentation, please click Nuclei SDK documentation
If you need to build a new application, or change CORE or DOWNLOAD option, please make sure that you have clean the project by
If you want to specify additional compiler flags, please follow this guidance in your application Makefile.
COMMON_FLAGS := -O3 -funroll-loops -fpeel-loops
CFLAGS := -O3 -funroll-loops -fpeel-loops
If you want to pass additional linker flags, you can use LDFLAGS, and if you have additional library directories, you can use LIBDIRS to specify library directories.
The preprovided applications and its makefile is the best startup examples about how to use Nuclei SDK.
V=1 to your make command, it will show verbose compiling information, otherwise it will only show basic information. Sample output with extra
$ make V=1 all Current Configuration: RISCV_ARCH=rv32imafdc RISCV_ABI=ilp32d SOC=hbird BOARD=hbird_eval CORE=n307fd DOWNLOAD=ilm "Assembling : " ../../../OS/FreeRTOS/Source/portable/GCC/portasm.S riscv-nuclei-elf-gcc -g -march=rv32imafdc -mabi=ilp32d -mcmodel=medany -ffunction-sections -fdata-sections -fno-common -DDOWNLOAD_MODE=DOWNLOAD_MODE_ILM -I. -I../../../NMSIS/Include -I../../../OS/FreeRTOS/Source/include -I../../../OS/FreeRTOS/Source/ portable/GCC -I../../../SoC/hbird/Board/hbird_eval/Include -I../../../SoC/hbird/Common/Include -MMD -MT ../../../OS/FreeRTOS/Source/ portable/GCC/portasm.S.o -MF ../../../OS/FreeRTOS/Source/portable/GCC/portasm.S.o.d -c -o ../../../OS/FreeRTOS/Source/portable/GCC/ portasm.S.o ../../../OS/FreeRTOS/Source/portable/GCC/portasm.S "Assembling : " ../../../SoC/hbird/Common/Source/GCC/intexc_hbird.S riscv-nuclei-elf-gcc -g -march=rv32imafdc -mabi=ilp32d -mcmodel=medany -ffunction-sections -fdata-sections -fno-common -DDOWNLOAD_MODE=DOWNLOAD_MODE_ILM -I. -I../../../NMSIS/Include -I../../../OS/FreeRTOS/Source/include -I../../../OS/FreeRTOS/Source/ portable/GCC -I../../../SoC/hbird/Board/hbird_eval/Include -I../../../SoC/hbird/Common/Include -MMD -MT ../../../SoC/hbird/Common/ Source/GCC/intexc_hbird.S.o -MF ../../../SoC/hbird/Common/Source/GCC/intexc_hbird.S.o.d -c -o ../../../SoC/hbird/Common/Source/GCC/ intexc_hbird.S.o ../../../SoC/hbird/Common/Source/GCC/intexc_hbird.S "Assembling : " ../../../SoC/hbird/Common/Source/GCC/startup_hbird.S