Nuclei Studio IDE使用说明

1.3. Nuclei Studio IDE安装

当完成NucleiStudio IDE压缩软件包下载，解压后包含若干文件如图 1‑2（解压路径中不可包含中文），分别介绍如下。

• NucleiStudio软件包

  • 该软件包中包含了Nuclei Studio IDE的软件。注意：具体版本以及文件名可能会不断更新。

    • HBird_Driver.exe（2021.02版本起不再提供）

  • 仅Windows版提供，此文件为芯来蜂鸟调试器的USB驱动安装文件。

  • 当在Windows环境下，使用该调试器时，需要安装此驱动使该USB设备能够被系统识别。

  • 由于2021.02版本中更新的openocd引入了免驱功能。

    • SerialDebugging_Tool（2021.02版本起不再提供）

  • 仅Windows版提供，此文件为”串口调试助手”软件。此软件可以用于后续软件示例调试时通过串口打印信息。

图 1‑2NucleiStudio IDE压缩包文件内容

2. 启动Nuclei Studio

启动Nuclei Studio的要点如下（windows和linux均按照如下操作）：

• 直接双击NucleiStudio
  IDE文件包中NucleiStudio文件夹下面的可执行文件，即可启动Nuclei
  Studio，如图 2‑1所示。

• 第一次启动Nuclei
  Studio后，将会弹出对话框要求设置Workspace目录路径，该目录将用于存放后续创建的项目工程文件，如图
  2‑2所示。

• 设置好Workspace目录之后，单击”Launch”按钮，将会启动Nuclei
  Studio。第一次启动后的Nuclei Studio界面如图 2‑3所示。

• 2021.02版本Nuclei Studio默认关闭了Launch Bar，请参照9.1开启Nuclei
  Studio中的Launch Bar功能，方便快速编译调试和下载。

图 2‑1双击”NucleiStudio.exe”启动Nuclei Studio

图 2‑2设置Nuclei Studio的Workspace目录

图 2‑3第一次启动Nuclei Studio界面

3. Nuclei Studio更新说明

Nuclei Studio自2021.09版后，将IDE与SDK完全分离，将采用全新的Nuclei
Package(NPK)的包管理的方式进行模板工程的管理和使用，方便用户进行不同SDK的导入并且在IDE上创建示例工程并使用，针对Nuclei
SDK和HBird SDK以及我们公司的SoC
IP产品提供的SDK，均可以打包成Zip包的方式以通过Nuclei Package
Management方式进行导入使用。

4. Nuclei Studio NPK功能

Nuclei Studio 中内建了对Nuclei
Package（NPK）功能的完整支持，方便开发者或者创建不同的软件开发包，并且通过Nuclei
Package Management方式导入到Nuclei Studio中使用，如果是CPU
IP客户，可以将自己的芯片SDK略作改造以支持NPK，并导入到Nuclei
Studio中使用，如果是SoC
IP客户，可以将提供的SDK打包成Zip包，导入使用，如果是开发者，也可以依赖某个特定的NPK，创建对应的BSP包或者APP包并提供给第三方使用，关于NPK功能的详细介绍，以及后续更新说明参见
https://github.com/Nuclei-Software/nuclei-sdk/wiki/Nuclei-Studio-NPK-Introduction。通过在原有的SDK中引入npk功能，编写npk.yml可以达到Project
Wizard功能的部分定制化。

开发者要使用Nuclei Studio进行工程的创建，需先将对应的SDK NPK
Zip包安装到IDE中，方可根据不同的开发板快速新建不同的模板工程，并根据不同的模板添加需要的SDK源码，根据选项生成不同的编译链接选项设置。

本章将在RVSTAR开发板上，以新建和修改GD32VF103的工程为例快速介绍Nuclei
Studio功能，RVSTAR开发板开发需要使用nuclei_sdk的npk包，详细的流程请参考之后的章节。

• 从官网提供的地址下载Nuclei NPK
  Zip包到本地，目前芯来提供的开放下载的SDK包有nuclei_sdk.zip和hbird_sdk.zip，到指定页面下载相对应的zip包。

  • Nuclei SDK（针对Nuclei
    RISC-V处理器）下载地址：https://github.com/Nuclei-Software/nuclei-sdk

  • Hbird
    SDK（针对开源蜂鸟v1和v2处理器）下载地址：https://github.com/riscv-mcu/hbird-sdk

图 4‑1下载SDK的zip包

• 将下载到的sdk的zip包安装到Nuclei
  Studio中，在菜单栏选择”RV-Tools-->Nuclei Package
  Management”在弹出的Nuclei Package
  Management管理页执行导入操作，选择下载到的nuclei_sdk.zip导入结果如图3-2。您也可以在Nuclei
  Package Management管理页执行相关SDK包的删除。

图 4‑2进入SDK Manage

图 4‑3导入资源包

图 4‑4资源包管理

• 新建一个工程，可以在菜单栏中，选择”File --> New --> New Nuclei
  RISC-V C/C++ Project”，如 图4‑1。也可以在Project
  Explorer视图中选中”New Nuclei RISC-V C/C++ Project”

图 4‑5使用菜单栏创建项目

图 4‑6从Project Explorer中创建项目

• 如图3-8所示，在弹出的窗口中可以不同的厂商提供的不同版本的SDK,选种某一Board下的SDK,看到相关SoC及Board的介绍。这里以RVSTAR开发板为例，所以这一项选择”GigaDevice->GD32VF103->Nuclei
  GD32VF103 RVSTAR Board->sdk-nuclei_sdk@0.3.4-dev”
  。点击”Next”进入下一步。（注意：这里的sdk版本号会随着版本迭代做相应的更新，并且也可能依赖特定版本的Nuclei
  Studio使用）

图 4‑7选择建立项目类型

• 进入具体的项目配置页如图3-9所示，因为RVSTAR的内核是固定的N205，其对应的arch和abi分别是rv32imac和ilp32，所以Core选项不能修改。同样，RVSTAR开发板仅支持一种FLASHXIP下载模式，所以DOWNLOAD这一选项也不能修改。点击”Finish”完成工程创建。

图 4‑8选择程序模板及相关设置项

• Nuclei Studio可以根据不同的工程模板添加不同的SDK源码，例如FreeRTOS模板工程会添加对应的OS内容，Demo_dsp模板工程可以添加NMSIS库文件。关于NMSIS详细信息请参考（https://doc.nucleisys.com/nmsis/index.html）。这里以Demo_dsp为例，”Project Example”选择”baremetal_demo_dsp”。因为使用dsp工程，需要添加NMSIS库，所以”Libraries”选择”NMSIS DSP”。

• Nuclei Studio可以根据新建工程时的选项自动设置工程的选项。这里选择不使用浮点打印，所以”NEWLIB”选择”newlib-nano without float”。编译优化等级”Optimization Level”选择”Optimize more（-O2）”。之后一直选择”Next”直到”Finish”。

• Nuclei Studio可以快速修改工程的设置选项。新建好的工程如图3-10所示，单击要修改的工程名，右击打开右键菜单，选择”SDK Configuration Tools”打开设置选项工具。如图3-11，如果要修改编译优化等级，修改”Optimization Level”为”None（-O0）”，点击”Save”修改选项。如图3-12修改成功后在修改后的工程处右击打开右键菜单，选择”clean”清除一下工程，再点击锤子图标编译工程。

• 注意：SDK Configuration Tools修改编译配置后对调试配置（Debug Configurations）不生效，请手动修改对应的调试配置。

图 4‑9打开SDK设置工具

图 4‑10修改工程设置

图 4‑11清理工程并重新编译

5. 创建项目

这里以开发板为Nuclei FPGA Evaluation
Board，评估处理器内核为N307(rv32imafc)为例，详细介绍Nuclei
Studio中创建项目的常见方式。

在Nuclei Studio IDE创建项目可以有以下几种常见方式：

• 使用模板自动创建项目：

  • 这是最简单快捷的方式，目前模板项目功能依赖于Nuclei Studio
    NPK功能，在导入对应的SDK NPK Zip包，即可在Nuclei
    Studio上进行模板工程的创建。芯来科技提供了Nuclei SDK、HBird
    SDK、SoC IP SDK的NPK
    Zip包，均可导入到IDE中进行工程的创建和使用。

• 从已有项目直接导入创建新项目：

  • 这是最常见的方式，譬如，用户A可以将已有项目的文件夹直接进行打包保存，然后进行分享传播，用户B可以在另外的电脑上直接导入该项目，从而以此为基础创建新的项目，在此基础上直接使用或者开发修改。

• 无模板手动创建项目：

  • 这是最繁琐的方式，该方法除了创建项目之外，还需要手动设置各种选项和路径。由于该方式比较繁琐，所以在实际工作中较少使用，但是通过该方式的详细讲解，用户可以详细了解如何配置各中选项和路径。

• 基于已有的Makefile创建项目：

  • 这种方式比较适合于已经采用Makefile或者其他编译工具的项目，提供一种在IDE中编译工程，清理工程，调试工程的方式。在不修改编译系统的基础上，提供良好的IDE调试环境。

下文将对这几种方式分别进行介绍。

5.1. 通过模板自动创建项目

本节将介绍如何使用模板自动创建项目的方式，在Nuclei Studio
IDE创建一个简单的Hello World项目，详细步骤如下。

• 新建一个工程，可以在菜单栏中，选择”File --> New --> New Nuclei
  RISC-V C/C++ Project”，如图4-1。也可以在Project
  Explorer视图中选中”New Nuclei RISC-V C/C++ Project” ，如图4-2。

图 5‑1 从菜单创建项目

图 5‑2 Project Explorer视图创建项目

• 如图4-3所示，在弹出的窗口中选择项目类型，这里我们在Nuclei
  FPGA板，内核是N307，SDK为nuclei_sdk@0.3.2-dev
  版本来做一个测试开发，选对对应的Board下的SDK, 点击”Next”进入下一步。

图 5‑3 选择建立项目模型

• 如图 5‑2所示，在弹出的窗口中设定如下参数（注意：此页面是通过NPK
  Configuration字段自动解析并生成的页面，不同的SDK或者不同的开发板或者不同的例子都可能会有不同的选项页面，请注意）。

  • Project name：项目命名。这里设置为”1_helloworld”

  • Project Example：选Helloworld。

  • Toolchains：我们使用Nuclei GUN Toolchain。

• 我们的内核是N307，所以”Core”选择”N307”。

• 蜂鸟开发板支持三种下载模式，以下为每种下载模式的简介，这里我们选择ILM模式。

• ILM下载模式程序将被直接
  下载在MCU的ILM中，并从ILM开始执行。ILM由SRAM组成，会掉电丢失。

• FLASH下载模式程序代码段的物理地址约束Flash区间，将代码段的逻辑地址约束在ILM的地址区间，意味着程序将被直接下载在MCU的Flash中，但是上电后要通过引导程序将代码段搬运到ILM中，然后从ILM中开始执行。程序被烧写在Flash中，不会掉电丢失。

• FLASHXIP下载模式程序代码段约束Flash区间，意味着程序将被直接下载在MCU的Flash中，并直接从Flash开始执行。程序被烧写在Flash中，不会掉电丢失。

  • 其他各项可以按需进行配置

  • 点击”Finish”完成工程创建。

图 5‑2新建项目及模板选择