Welcome to Nuclei Tool User Guide!

Contents

• 1. Introduction
• 2. Nuclei Studio IDE
  • 2.1. Nuclei Studio IDE 简介
  • 2.2. Nuclei Studio 更新说明
    • 2.2.1. 2025.02版更新说明
    • 2.2.2. 2024.06版更新说明
    • 2.2.3. 2024.02.dev版更新说明
    • 2.2.4. 2023.10版更新说明
    • 2.2.5. 2022.12版更新说明
  • 2.3. Nuclei Studio 下载与安装
    • 2.3.1. Nuclei Studio IDE 下载
    • 2.3.2. Nuclei Studio IDE 安装
    • 2.3.3. Nuclei Studio IDE 启动
  • 2.4. Nuclei Studio NPK 介绍
    • 2.4.1. 组件描述文件(npk.yml)
    • 2.4.2. 模块说明
    • 2.4.3. NPK中的UI组件
    • 2.4.4. NPK的语法
  • 2.5. Nuclei Studio NPK 创建与共享
    • 2.5.1. 开发NPK组件包
    • 2.5.2. NPK组件包的检测和问题处理
    • 2.5.3. 共享NPK组件包
    • 2.5.4. NPK组件包在Nuclei Studio中的使用
  • 2.6. Nuclei Studio NPK 应用
    • 2.6.1. NPK软件包管理
    • 2.6.2. 通过NPK创建工程
    • 2.6.3. 通过NPK导入工具
  • 2.7. Nuclei Studio 创建工程
    • 2.7.1. 通过NPK模板工程自动创建项目
    • 2.7.2. 通过应用关联文件导入工程
    • 2.7.3. 从已有项目直接导入创建新项目
    • 2.7.4. 无模板手动创建项目
    • 2.7.5. 基于已有的Makefile创建项目
  • 2.8. Nuclei Studio 编译工程
    • 2.8.1. 编译工具
    • 2.8.2. Nuclei SDK 工程设置工具
    • 2.8.3. Nuclei Studio中编译Hello World项目
    • 2.8.4. Flash Programming
  • 2.9. Nuclei Studio 调试运行工程
    • 2.9.1. 调试模式管理
    • 2.9.2. 使用蜂鸟调试器结合OpenOCD调试运行项目
    • 2.9.3. 使用J-Link调试运行项目
    • 2.9.4. 使用DLink调试运行项目
  • 2.10. Nuclei Studio 高级功能
    • 2.10.1. 导入旧版本创建的工程
    • 2.10.2. LST View
    • 2.10.3. Code Coverage和Profiling功能
    • 2.10.4. Trace功能的使用
    • 2.10.5. RVProf功能的使用
    • 2.10.6. Nuclei NICE Wizard
    • 2.10.7. Nuclei Model功能的使用
    • 2.10.8. Nuclei Near Cycle Model
    • 2.10.9. Live Watch功能的使用
  • 2.11. Nuclei Studio 升级更新
    • 2.11.1. 工具链的安装
    • 2.11.2. IDE Plugins升级
  • 2.12. Nuclei Studio 常见问题
    • 2.12.1. Nuclei Studio启动慢
    • 2.12.2. Nuclei Studio编译程序很慢
    • 2.12.3. 找不到New Nuclei RISC-V C/C++ Project菜单
    • 2.12.4. 打开/关闭Launch Bar
    • 2.12.5. 使用Launch Bar
    • 2.12.6. 不使用Launch Bar进行运行/调试
    • 2.12.7. Debug页面查看寄存器
    • 2.12.8. Debug页面结束进程
    • 2.12.9. Nuclei Studio工具栏中各按键功能
    • 2.12.10. 显示其他窗口
    • 2.12.11. 恢复默认窗口布局
    • 2.12.12. 对比历史文件
    • 2.12.13. 新建工程时可能出现报错
    • 2.12.14. 新增Include路径出现缓存
    • 2.12.15. 设置页面栏目找不到
    • 2.12.16. 开发板下载速度很慢
    • 2.12.17. Linux环境下多用户使用Nuclei Studio
    • 2.12.18. 设备管理器中识别出两个串口
    • 2.12.19. Linux下使用时报Could not determine GDB version after sending:riscv-nuclei-elf-gdb –version,response:的错误
    • 2.12.20. 在linux下使用QEMU时报错
    • 2.12.21. 工程编译链接C库找不到符号报错
    • 2.12.22. 编译工程报错fatal error: rvintrin.h: No such file or directory
    • 2.12.23. Debug时报错Error: Couldn’t find an available hardware trigger.
  • 2.13. 其他未注明版本问题
• 3. Nuclei Toolchain
  • 3.1. GNU Toolchain
    • 3.1.1. About GNU Toolchain
    • 3.1.2. Extensions Support
    • 3.1.3. General Options
    • 3.1.4. Libraries
    • 3.1.5. Significant Changes Brought by GCC13 Compared to GCC10
    • 3.1.6. Significant Changes Brought by GCC14 Compared to GCC13
    • 3.1.7. Install and Setup
  • 3.2. LLVM Toolchain
    • 3.2.1. About LLVM Toolchain
    • 3.2.2. Extensions Support
    • 3.2.3. General Options
    • 3.2.4. Install and Setup
    • 3.2.5. Changelog
• 4. Nuclei C Runtime Library
  • 4.1. About Nuclei C Runtime Library
  • 4.2. Nuclei C Runtime Library for Nuclei Toolchain
    • 4.2.1. Usage
    • 4.2.2. Varieties
  • 4.3. Quick start
    • 4.3.1. exit()
    • 4.3.2. Basic UART I/O functions (-lfileops_uart)
    • 4.3.3. Using Semihosting (-lfileops_semi)
    • 4.3.4. Using RTT (-lfileops_rtt)
    • 4.3.5. Thread-local storage
    • 4.3.6. Heap
  • 4.4. Runtime support
    • 4.4.1. Getting to main() and then exit()
    • 4.4.2. Multithreaded protection for the heap
  • 4.5. Using customized fileops
  • 4.6. C library API
    • 4.6.1. <assert.h>
    • 4.6.2. <complex.h>
    • 4.6.3. <ctype.h>
    • 4.6.4. <errno.h>
    • 4.6.5. <fenv.h>
    • 4.6.6. <float.h>
    • 4.6.7. <iso646.h>
    • 4.6.8. <limits.h>
    • 4.6.9. <locale.h>
    • 4.6.10. <math.h>
    • 4.6.11. <setjmp.h>
    • 4.6.12. <stdbool.h>
    • 4.6.13. <stddef.h>
    • 4.6.14. <stdint.h>
    • 4.6.15. <stdio.h>
    • 4.6.16. <stdlib.h>
    • 4.6.17. <string.h>
    • 4.6.18. <time.h>
    • 4.6.19. <wchar.h>
    • 4.6.20. <wctype.h>
    • 4.6.21. <xlocale.h>
  • 4.7. Compiler support API
    • 4.7.1. GNU library API
  • 4.8. External function interface
    • 4.8.1. I/O functions
    • 4.8.2. Heap protection functions
    • 4.8.3. Error and assertion functions
    • 4.8.4. RTC functions
    • 4.8.5. Locale functions
• 5. Nuclei OpenOCD
  • 5.1. Introduction to OpenOCD
    • 5.1.1. Repositories and Documentation
  • 5.2. Getting Started
    • 5.2.1. Checking OpenOCD Version
    • 5.2.2. Running OpenOCD
  • 5.3. Nuclei-Specific Features
    • 5.3.1. CPU Information Display
    • 5.3.2. NUSPI (Nuclei SPI) Driver
    • 5.3.3. Custom Driver with OpenFlashLoader
    • 5.3.4. Nuclei-Specific CSRs
    • 5.3.5. Embedded Trace (ETrace) Support
    • 5.3.6. Debug Map Feature
    • 5.3.7. Cross-Trigger Interface
    • 5.3.8. Reset and Halt Command
    • 5.3.9. FTDI nSCAN1 Mode Command
  • 5.4. Configuration File Overview
    • 5.4.1. Debugger Speed Configuration
    • 5.4.2. Debugger Interface Configuration
    • 5.4.3. Debugger Mode Configuration
    • 5.4.4. JTAG Link Configuration
    • 5.4.5. Work Area Configuration
    • 5.4.6. NOR Flash Configuration
    • 5.4.7. Debugger Connection Specification
    • 5.4.8. Debugging Service Ports
    • 5.4.9. Semihosting Support
    • 5.4.10. Target Defer Examine
  • 5.5. Frequently Asked Questions
  • 5.6. Low-Cost Debugger Solution
  • 5.7. Changelog
    • 5.7.1. Version 2025.02
• 6. Nuclei QEMU
  • 6.1. About Nuclei QEMU
  • 6.2. Design and Architecture
    • 6.2.1. Nuclei CPU Types Supported on QEMU
    • 6.2.2. Address Allocation of Evalsoc on QEMU
    • 6.2.3. Nuclei CPU Features Supported on QEMU
  • 6.3. Description of Parameters
  • 6.4. Use Nuclei QEMU in Nuclei SDK
  • 6.5. Use Nuclei QEMU in Nuclei Linux SDK
  • 6.6. Changelog
    • 6.6.1. Version 2025.02
  • 6.7. Known Issues
    • 6.7.1. LiteOS-M is not able to run on Nuclei Qemu
• 7. Nuclei Model
  • 7.1. About Nuclei Near Cycle Model
  • 7.2. Design and Architecture
    • 7.2.1. SystemC components
    • 7.2.2. Address Allocation of Evalsoc in xlmodel
    • 7.2.3. Nuclei CPU Features Supported in xlmodel
    • 7.2.4. Nuclei SDK Cases Supported in xlmodel
  • 7.3. Description of Parameters
    • 7.3.1. model help
    • 7.3.2. parameter usage
  • 7.4. NICE support
    • 7.4.1. NICE build
    • 7.4.2. NICE example
  • 7.5. SystemC integration
  • 7.6. Changelog
    • 7.6.1. Version 2025.02
• 8. ChangeLog
  • 8.1. 2025.02
  • 8.2. 2024.06
  • 8.3. 2024.02
  • 8.4. 2023.10
• 9. Glossary
• 10. Appendix

Indices and tables

• Index

• Search Page