diff --git a/docs/extension.md b/docs/extension.md index 7d8e57833aeb9830a5ad4df26db2f51640440b23..55cf1005a895d27a7743c2fec9e9c26bcb0d9e3d 100644 --- a/docs/extension.md +++ b/docs/extension.md @@ -6,39 +6,34 @@ ### 扩展发布说明 由于不同的开发板的编译、烧录、调测方式差异较大，`HUAWEI LiteOS Studio`通过不同的扩展来灵活支持各种目标开发板。`HUAWEI LiteOS Studio`扩展主要包含`LiteOS Studio Base基座扩展`和 -为不同的开发板定制的扩展，如`STM32`开发板扩展、`WiFi IoT Hi3861`开发板扩展。为实现`GDB`图形化调测能力，还提供了`LiteOS Studio Debug`调测扩展。在`HUAWEI LiteOS Studio`集成开发环境中已经预置了基座扩展，调测扩展，和部分开发板扩展。如果用户使用VSCode、或其他基于VSCode的定制`IDE`，也可以通过安装`HUAWEI LiteOS Studio`扩展来实现`HUAWEI LiteOS Studio`相同的能力。 +为不同的开发板定制的扩展，如`STM32`开发板扩展、`WiFi IoT Hi3861`开发板扩展。为实现`GDB`图形化调测能力，还提供了`LiteOS Studio Debug`调测扩展。 -各个扩展的安装文件后缀为`.vsix`， 访问[LiteOS Studio Extensions](https://gitee.com/LiteOS/LiteOS_Studio/releases)可以下载扩展安装文件。 +在`HUAWEI LiteOS Studio`集成开发环境中已经预置了基座扩展，调测扩展，和部分开发板扩展。如果用户使用VSCode或其他基于VSCode的定制`IDE`，也可以通过安装`HUAWEI LiteOS Studio`扩展来实现`HUAWEI LiteOS Studio`相同的能力。 -#### 扩展安装 +各个扩展的安装文件后缀为`.vsix`， 可以访问[LiteOS Studio Extensions](https://gitee.com/LiteOS/LiteOS_Studio/extensions)下载。 -在IDE 活动栏中，打开`扩展`视图，点击更多操作`...`，在弹出的菜单中选择`从 VSIX 安装`，然后指定扩展文件的路径，即可完成安装扩展。 +### 扩展安装 + +在IDE 活动栏中，打开`扩展`视图，点击更多操作`...`，在弹出的菜单中选择`从 VSIX 安装`，然后指定扩展文件的路径，即可完成安装。 ![avatar](images/extensionsInstall.png) -**注意：由于扩展中预置了适用于Windows平台的编译器、烧录、调测工具等，HUAWEI LiteOS Studio扩展仅能安装到 Windows 版本的基于VSCode的IDE。** +**注意：由于扩展中预置了适用于Windows平台的编译器、烧录、调测工具等，HUAWEI LiteOS Studio扩展仅支持 Windows 版本的IDE。** -### LiteOS Studio Base扩展介绍 +### LiteOS Studio Base扩展 -`HUAWEI LiteOS Studio Base`基座扩展， 可以安装到各种基于`VSCode`的IDE，如`VSCode-Huawei`、`WeCode`等。 基座扩展实现快捷极简的编译、烧录、调试、目标板选择等工程配置，增加了侧边栏工具按钮 ![avatar](images/sidebar_tools.png)， 集成了`HUAWEI LiteOS Studio`中工具栏支持的功能，点击侧边栏工具按钮， 界面如下： +`HUAWEI LiteOS Studio Base`基座扩展， 可以安装到各种基于`VSCode`的IDE，如`VSCode-Huawei`、`WeCode`等。 基座扩展增加了侧边栏工具按钮 ![avatar](images/sidebar_tools.png)， 集成了`HUAWEI LiteOS Studio`中工具栏支持的功能，包括编译、烧录、调试、目标板选择等工程配置，点击侧边栏工具按钮， 界面如下： ![avatar](images/toolsview.png) -除了基座扩展，`HUAWEI LiteOS Studio`为不同需求的开发板用户提供了定制化的扩展。如下： - ### LiteOS Studio STM32扩展 -对于[开源LiteOS](https://gitee.com/LiteOS/LiteOS)用户，安装`HUAWEI LiteOS Studio Base`基座扩展和`LiteOS Studio STM32`开发板扩展后，可以利用`IDE`新建`LiteOS`工程， 支持对`STM32系列`开发板工程进行编译、烧录、调试等操作。`LiteOS Studio STM32`扩展集成支持`Gitee-LiteOS-Master`等`开源 LiteOS SDK` 版本，用户也可以自行配置支持的`SDK`版本， 支持`STM32F429IG`、`STM32F769NI`、`STM32L431RC`、`STM32F103ZE`等开发板。 +对于[开源LiteOS](https://gitee.com/LiteOS/LiteOS)用户，安装`HUAWEI LiteOS Studio Base`基座扩展和`LiteOS Studio STM32`开发板扩展后，可以利用`IDE`新建`LiteOS STM32`工程， 支持对`STM32系列`开发板工程进行编译、烧录、调试等操作。`LiteOS Studio STM32`扩展支持`Gitee-LiteOS-Master`等`开源 LiteOS SDK` 版本，支持`STM32F429IG`、`STM32F769NI`、`STM32L431RC`等开发板。 ### LiteOS Studio Hi3861扩展 -对于`WIFI IoT Hi3861`开发板用户，安装`HUAWEI LiteOS Studio Base`基座扩展和`LiteOS Studio Hi3861`开发板扩展后，可以利用`IDE`新建`WIFI IoT Hi3861`工程， 支持对`WIFI IoT Hi3861`开发板工程进行编译、烧录、调试、组件配置等操作。 - -**注意：仅`WIFI IoT Hi3861`开发板支持组件化配置** - +对于`WIFI IoT Hi3861`开发板用户，安装`HUAWEI LiteOS Studio Base`基座扩展和`LiteOS Studio Hi3861`开发板扩展后，可以利用`IDE`新建`WIFI IoT Hi3861`工程，支持对`WIFI IoT Hi3861`开发板工程进行编译、烧录、调试、组件配置等操作。 ### LiteOS Studio Debug调测扩展 -`LiteOS Studio Debug`调测扩展支持对`HUAWEI LiteOS Studio`工程进行`GDB`图形化调测，支持`Jlink`、`OpenOCD`等调测器。该扩展还集成多线程感知等能力，调测时在调用栈视图中支持同时展示多个任务的调用栈信息。 - -在`HUAWEI LiteOS Studio`中已经预置，使用VSCode等IDE的用户需要自己安装该扩展。 \ No newline at end of file +`LiteOS Studio Debug`调测扩展支持对`HUAWEI LiteOS Studio`工程进行`GDB`图形化调测，支持`Jlink`、`OpenOCD`等调测器。该扩展还集成多线程感知等能力，调测时在调用栈视图中支持同时展示多个任务的调用栈信息。 \ No newline at end of file diff --git a/docs/install.md b/docs/install.md index 8028ea361cc7e1b0c87ca311912732b9c1a6e69b..df4c1705c574e4d6f09c6db8278b82e0c3694e6b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -3,34 +3,37 @@

HUAWEI LiteOS Studio安装

-`HUAWEI LiteOS Studio`当前只提供Windows 10 64 位操作系统上的安装版本，如果对其他系统上有诉求，请联系我们。 +`HUAWEI LiteOS Studio`当前只提供Windows 10 64 位操作系统上的安装版本，如果对其他系统有诉求，请联系我们。 ### 获取安装文件 获取`HUAWEI LiteOS Studio`安装包`HUAWEI-LiteOS-Studio-Setup-x64-X.XX.X`，xxxx为`LiteOS Studio`版本号，请以实际获取的安装包版本号为准。 -双击`HUAWEI-LiteOS-Studio-Setup-x64-X.XX.X.exe`，依照屏幕提示，安装`HUAWEI LiteOS Studio`集成开发环境。 - -`HUAWEI LiteOS Studio`提供了可供用户自行安装的扩展，可参考[扩展发布说明](/extension?id=扩展发布说明)，并按照扩展安装步骤自行选择安装 +除此之外，`HUAWEI LiteOS Studio`还提供了基于VSCode的扩展，可供用户作为插件安装在VSCode或其他基于VSCode的定制IDE上。具体可参考[扩展发布说明](/extension?id=扩展发布说明)，并按照扩展安装步骤自行选择安装。 ### 安装指导 +双击`HUAWEI-LiteOS-Studio-Setup-x64-X.XX.X.exe`，依照屏幕提示，安装`HUAWEI LiteOS Studio`集成开发环境。 **接受许可协议** + 需要阅读并接受许可协议，才可以继续安装。选中`我接受协议(A)`，点击`下一步`。 ![avatar](images/acceptLicense.png) **选择目标位置** + 使用默认，或者设置程序的安装位置，点击`下一步`。 ![avatar](images/installLocation.png) **选择快捷方式** + 推荐全部勾选，在桌面上使用快捷方式，或在资源管理器文件夹内右键菜单，均可以快速打开程序`HUAWEI LiteOS Studio`。点击`下一步`。 ![avatar](images/installShortcut.png) **安装准备就绪** + 点击`安装`按钮执行安装即可。 ![avatar](images/installStart.png) @@ -41,38 +44,46 @@ ### 常用工具与扩展安装（可选） -`HUAWEI LiteOS Studio`不提供常用工具、常用扩展的预置，需要用户自行下载，如用户本地已安装，可忽略此步骤 +`HUAWEI LiteOS Studio`不提供常用工具、常用扩展的预置，需要用户自行下载，如用户本地已安装，可忽略此步骤。 #### 安装Git工具 -如果用户需要使用新建工程功能下载SDK， 则应根据情况安装`git for windows`工具。 从`https://gitforwindows.org/`下载，并按安装向导完成最新版`git for windows`的安装。也可以使用华为云镜像站点下载`https://mirrors.huaweicloud.com/git-for-windows/`。 +如果用户需要使用新建工程功能下载SDK，则应根据情况安装`git for windows`工具。从[git for windows官网](https://gitforwindows.org/)下载，并按安装向导完成最新版`git for windows`的安装。 #### 安装arm-none-eabi软件 -`开源LiteOS`工程使用`ARM GCC`编译器进行编译， 需要安装编译器软件。 可以通过执行本站提供的GNU Arm Embedded Toolchain自动下载程序来进行下载，默认下载到`C:\Users\\.huawei-liteos-studio\tools\arm-none-eabi`目录。 +`开源LiteOS`工程使用`ARM GCC`编译器进行编译，需要安装编译器软件。 可以通过执行本站提供的GNU Arm Embedded Toolchain自动下载程序来进行下载，默认下载到`C:\Users\\.huawei-liteos-studio\tools\arm-none-eabi`目录。 **注意：通过本站提供的下载程序下载`GNU Arm Embedded Toolchain`，需要先安装`git for windows`工具，并加入环境变量。** #### 安装Make构建软件 -`开源LiteOS`工程使用`Makefile`文件组织编译和链接程序，我们需要安装`GNU Make`工具。可以通过执行本站提供的x_pack_windows_build_tools_download自动下载程序来进行下载，默认下载到`C:\Users\\.huawei-liteos-studio\tools\build`目录 +`开源LiteOS`工程使用`Makefile`文件组织编译和链接程序，需要安装`GNU Make`工具。可以通过执行本站提供的x_pack_windows_build_tools_download自动下载程序来进行下载，默认下载到`C:\Users\\.huawei-liteos-studio\tools\build`目录。 **注意：通过本站提供的下载程序下载`GNU Make`，需要先安装`git for windows`工具，并加入环境变量。** -#### 中文语言包安装与语言切换 +#### 安装JLink仿真器软件 -为了更直观地向中文用户介绍`HUAWEI LiteOS Studio`，本文档所用`HUAWEI LiteOS Studio`安装了中文语言包扩展`vscode-language-pack-zh-hans`。当前用户能够获取的`HUAWEI LiteOS Studio`默认不预置中文语言包，因此界面默认显示为英文，如需要中文语言包，可以通过执行本站提供的语言包自动下载程序来进行下载，默认下载到`C:\Users\\.huawei-liteos-studio\extensions\extension-collections`目录，可参考[扩展安装](/extension?id=扩展安装)完成安装。 +如果开发板使用`JLink`仿真器，则根据情况安装`JLink`软件。从`https://www.segger.com/downloads/jlink/`下载，并按安装向导完成最新版`JLink`的安装。 -**注意：通过本站提供的下载程序下载`中文语言包`，需要先安装`git for windows`工具，并加入环境变量。** +建议将`JLink.exe`所在目录加入`PATH`环境变量。 -安装完成后，通过点击菜单栏中的`查看`->`命令面板`调出命令输入界面 +#### 中文语言包与C/C++扩展安装 -![avatar](images/commandBoard.png) +为了更直观地向中文用户介绍`HUAWEI LiteOS Studio`，本文档所用`HUAWEI LiteOS Studio`安装了中文语言包扩展`vscode-language-pack-zh-hans`。当前用户能够获取的`HUAWEI LiteOS Studio`默认不预置中文语言包，因此界面默认显示为英文。 + +C/C++扩展能够提供`HUAWEI LiteOS Studio`对C/C++语言的支持，包括了C/C++语言代码高亮、转到定义等功能。 -在命令输入框中输入`Configure Display Language`，回车，选择需要切换的语言（`en`、`zh-cn`等），弹出重启IDE完成配置的提示窗口，点击重启，即可完成语言切换 +用户可以通过执行本站提供的扩展自动下载程序下载中文语言包和C/C++扩展，默认下载到`C:\Users\\.huawei-liteos-studio\extensions\extension-collections`目录，可参考[扩展安装](/extension?id=扩展安装)完成安装。 + +**注意：通过本站提供的下载程序下载`中文语言包`，需要先安装`git for windows`工具，并加入环境变量。** -![avatar](images/languageConfig.png) +**中文语言包使能：** + +**步骤 1** 安装完成后，通过点击菜单栏中的`查看`->`命令面板`调出命令输入界面 + +![avatar](images/commandBoard.png) -#### C/C++扩展安装 +**步骤 2** 在命令输入框中输入`Configure Display Language`，回车，选择需要切换的语言（`en`、`zh-cn`等），弹出重启IDE完成配置的提示窗口，点击重启，即可完成语言切换 -C/C++扩展能够提供`HUAWEI LiteOS Studio`对C/C++语言的支持，包括了C/C++语言代码高亮、转到定义等功能，执行中文语言包安装文件后，C/C++扩展也同时被下载到`C:\Users\\.huawei-liteos-studio\extensions\extension-collections`目录，同样可参考[扩展安装](/extension?id=扩展安装)完成安装 \ No newline at end of file +![avatar](images/languageConfig.png) \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md index 7b4e18cd251a98f81b10075d923eea50556d9139..25248c85f87091f78e479793c334da23f1618ee4 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -21,7 +21,7 @@ ### 工具栏介绍 -工具栏界面如下 +工具栏界面如下： ![avatar](images/toolbarview.png) @@ -55,13 +55,13 @@ ### 串口终端界面介绍 -通过点击菜单`查看`中的`串口终端`，或者单击![avatar](images/serialTerminal.png)打开串口终端界面。 +通过单击![avatar](images/serialTerminal.png)打开串口终端界面。 ![avatar](images/serial-termial.png) 串口终端界面从上到下分为4块区域： -**1号区域：** 串口的设置和开关 +**1号区域：** 串口的设置和开关。 ***端口：*** 在下拉框中选择与目标板连接的实际串口号 @@ -77,11 +77,11 @@ ***串口开关：*** 默认为关闭，使用时需要手动打开串口开关 -**2号区域：** 串口数据接收区，左边显示字符串，右边显示16进制，暂未设定接收数据量限制 +**2号区域：** 串口数据接收区，左边显示字符串，右边显示16进制，暂未设定接收数据量限制。 -**3号区域：** 串口数据发送区，通过右上角的下拉菜单来切换数据内容由字符串显示还是16进制显示，通过“发送”按钮将数据发送给连接的目标板 +**3号区域：** 串口数据发送区，通过右上角的下拉菜单来切换数据内容由字符串显示还是16进制显示，通过“发送”按钮将数据发送给连接的目标板。 -**4号区域：** 展示接收和发送数据的计数，并可以将计数清零 +**4号区域：** 展示接收和发送数据的计数，并可以将计数清零。 以`WiFi IoT`开发板为例，下图是接收数据的展示： @@ -89,7 +89,7 @@ ### 新建工程界面介绍 -通过菜单`文件`中的`新建工程`或单击新建工程图标![avatar](images/newFolder.png)打开新建工程界面。 +通过单击新建工程图标![avatar](images/newFolder.png)打开新建工程界面。 新建工程使用`git`进行SDK下载，需要预置`git for windows`工具，可访问[git for windows官网](https://gitforwindows.org/)自行下载`git`工具。 ![avatar](images/newProject.png) @@ -101,17 +101,14 @@ **开发板信息表：** 页面下半区域的表格面板，能够展示所选版本支持的开发板信息，包括开发厂商、开发板名称、对应设备名称与内核名称。 - **注意：** - 新建工程时需要保证网络畅通。如果联网需要代理，请提前配置好代理，否则新建工程会失败。配置代理方法参考[常见问题](/studio_qa?id=新建工程失败问题)。 - - 新建工程使用`git`进行SDK下载，需要预置`git for windows`工具，可访问[git for windows官网](https://gitforwindows.org/)自行下载`git`工具 - + **注意：** + 新建工程时需要保证网络畅通。如果联网需要代理，请提前配置好代理，否则新建工程会失败。配置代理方法参考[常见问题](/studio_qa?id=新建工程失败问题)。 ### 工程配置界面介绍 通过工具栏中的![avatar](images/proSetting.png)按钮打开工程配置界面。 #### 目标板配置界面介绍 -点击工程配置页面左侧的`目标板`选项进入目标板配置界面，选择目标板信息面板上的一行，点击确定保存设置，即指定了当前工程的开发板，后台将根据开发板设置默认的编译、烧录等配置信息。 +点击工程配置页面左侧的`目标板`选项进入目标板配置界面，选择目标板信息面板上的一行，点击确认按钮保存设置，即指定了当前工程的开发板，后台将根据开发板设置默认的编译、烧录等配置信息。 ![avatar](images/targetBoardNew.png) @@ -119,9 +116,9 @@ #### 组件配置界面介绍 -点击工程配置页面左侧的`组件配置`选项进入组件配置界面，首次启动仅展示本地已有的组件，点击左侧组件列表，在右侧组件属性栏通过勾选为组件使能，或输入具体的参数值，点击确定保存后，`HUAWEI LiteOS Studio`将在后台打开组件对应的宏开关，将使能的组件与更新后的属性值加入编译。 +点击工程配置页面左侧的`组件配置`选项进入组件配置界面，首次启动仅展示本地已有的组件。点击左侧组件列表，在右侧组件属性栏通过勾选为组件使能，或输入具体的参数值，点击确认按钮保存后，`HUAWEI LiteOS Studio`将在后台打开组件对应的宏开关，将使能的组件与更新后的属性值加入编译。 -**注意：** 目前仅`WiFi IoT`开发板`Hi3861V100`支持组件化配置。 +**注意：** 目前仅`WiFi IoT`开发板`Hi3861V100`支持组件化配置。 ![avatar](images/componentConfig.png) @@ -129,61 +126,49 @@ #### 编译器界面介绍 点击工程配置页面左侧的`编译器`选项进入编译器界面。 -***编译器类型：*** `编译器类型`下拉菜单目前支持`arm-none-eabi`、`riscv32-unknown-elf`两种编译器，分别适用于ARM架构和RISC-V架构，默认已经配好，如无额外需求不需要用户配置。 - -***编译器路径：*** `编译器路径`是用户所使用的编译器所在目录，`HUAWEI LiteOS Studio`不提供编译器预置，需要用户自行安装。 - -`arm-none-eabi`可参考[Arm工具安装](/install?id=安装arm-none-eabi软件)，通过本站安装程序下载，如通过此方法下载，`编译器路径`可保持默认路径不变。如使用本地的编译器，`编译器路径`填写`arm-none-eabi-gcc.exe`所在路径。 - -**注意：通过本站提供的下载程序下载`GNU Arm Embedded Toolchain`，需要先安装`git for windows`工具，并加入环境变量。** - -`riscv32-unknown-elf`编译器可联系`HUAWEI LiteOS Studio`技术支持人员获取，编译器目录填写`riscv32-unknown-elf-gcc.exe`所在路径。 +**编译器类型：** `编译器类型`下拉菜单目前支持`arm-none-eabi`、`riscv32-unknown-elf`两种编译器，分别适用于ARM架构和RISC-V架构，默认已经配好，如无额外需求不需要用户配置。 -***Make构建器：*** `Make构建器`配置项仅在开发板支持`MakeFile`脚本与`arm-none-eabi`编译方式时出现，`HUAWEI LiteOS Studio`不提供构建器预置，需要用户自行安装。 +**编译器目录：** `编译器目录`是用户所使用的编译器所在目录，`HUAWEI LiteOS Studio`不提供编译器预置，需要用户自行安装。 -`Make构建器`可参考[Make工具安装](/install?id=安装Make构建软件)，通过本站安装程序下载，如通过此方法下载，`Make构建器`目录可保持默认路径不变。如使用本地的`Make构建器`，`Make构建器`路径填写`make.exe`所在路径。 +* `arm-none-eabi`可参考[安装arm-none-eabi软件](/install?id=安装arm-none-eabi软件)，通过本站安装程序下载，如通过此方法下载，`编译器目录`可保持默认路径不变。如使用本地的编译器，`编译器目录`填写`arm-none-eabi-gcc.exe`所在路径。 +* `riscv32-unknown-elf`编译器可联系`HUAWEI LiteOS Studio`技术支持人员获取，`编译器目录`填写`riscv32-unknown-elf-gcc.exe`所在路径。 -**注意：通过本站提供的下载程序下载`GNU Make`，需要先安装`git for windows`工具，并加入环境变量。** +**Make构建器：** `Make构建器`配置项仅在开发板支持`Makefile`脚本与`arm-none-eabi`编译方式时出现，`HUAWEI LiteOS Studio`不提供构建器预置，需要用户自行安装。可参考[安装Make构建软件](/install?id=安装Make构建软件)，通过本站安装程序下载，如通过此方法下载，`Make构建器`目录可保持默认路径不变。如使用本地的`Make构建器`，`Make构建器`路径填写`make.exe`所在路径。 -***MakeFile/SConstruct脚本：*** `MakeFile脚本`和`SConstruct脚本`是按照目标板的编译架构不同，所显示的编译脚本路径配置项，目前`HUAWEI LiteOS Studio`支持`MakeFile`和`Scons`两种编译脚本，支持自动配置与手动配置。编译脚本路径建议不要包含中文、空格、特殊字符，避免编译失败。 +**Makefile/SConstruct脚本：** `Makefile脚本`和`SConstruct脚本`是按照目标板的编译架构不同，所显示的编译脚本路径配置项，目前`HUAWEI LiteOS Studio`支持`Makefile`和`Scons`两种编译脚本，支持自动配置与手动配置。编译脚本路径建议不要包含中文、空格、特殊字符，避免编译失败。 -手动配置脚本： +* 手动配置脚本有两种方式可以配置： + - 方式一：点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 + - 方式二：在`Makefile`或`SConstruct`文件上按照`单击右键->设置为MakeFile/SConstruct文件`步骤完成设置，设置完成后会自动在编译脚本路径配置框中填入脚本路径，如下图所示： -可在`MakeFile`或`SConstruct`文件上按照`单击右键->设置为MakeFile/SConstruct文件`步骤完成设置，设置完成后会自动在编译脚本路径配置框中填入脚本路径，如下图所示： + ![avatar](images/compilerConfig.png) -![avatar](images/compilerConfig.png) +* 自动配置脚本：点击自动搜索脚本按钮![avatar](images/findScript.png)自动匹配当前开发板对应的`Makefile/SConstruct脚本`，如果自动搜索结果为空，或使用该搜索结果导致编译报错，可能由于工程脚本名称、路径等发生改变，可改为手动配置方式设置脚本路径。 -手动配置还有一种方法：点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 +**Make/SCons参数：** `参数`是用户执行编译时可以自行添加的参数，例如 -j 32等，需要用户自行配置。 -自动配置脚本： - -点击自动搜索脚本按钮![avatar](images/findScript.png)自动匹配当前开发板对应的`MakeFile/SConstruct脚本`，如果自动搜索结果为空，或使用该搜索结果导致编译报错，可能由于工程脚本名称、路径等发生改变，可改为手动配置方式设置脚本路径。 - -***参数：*** `参数`是用户执行编译时可以自行添加的参数，例如 -j 32等，需要用户自行配置。 - -填写完成后，点击确认，保存用户配置，此时可以通过单击编译图标![avatar](images/compile.png)，对当前工程进行编译。 +填写完成后，点击确认按钮保存用户配置，此时可以通过单击编译图标![avatar](images/compile.png)，对当前工程进行编译。 #### 烧录器界面介绍 点击工程配置页面左侧的`烧录器`选项进入烧录器界面。 -***烧录器类型：*** `烧录器类型`下拉菜单目前支持`JLink`、`HiBurner`、`OpenOCD`三种烧录器，默认已经配好，如无额外需求不需要用户配置。 +**烧录方式：** `烧录方式`下拉菜单目前支持`JLink`、`HiBurner`、`OpenOCD`三种烧录器，默认已经配好，如无额外需求不需要用户配置。 -***烧录器目录：*** `烧录器目录`是用户所使用的烧录器所在目录，`HUAWEI LiteOS Studio`仅预置`HiBurner`烧录器，默认安装在`C：//users/用户名/.huawei-liteos-studio/tools`下，不需要用户自行配置。`JLink`、`OpenOCD`需要用户自行下载安装。 - -`JLink`烧录器推荐下载地址： +**烧录器目录：** `烧录器目录`是用户所使用的烧录器所在目录。 +- HiBurner烧录器目录：`HUAWEI LiteOS Studio`仅预置`HiBurner`烧录器，默认安装在`C：//users/用户名/.huawei-liteos-studio/tools`下，不需要用户自行配置此目录。 +- JLink烧录器目录：`JLink`需要用户自行下载安装，推荐下载地址： `https://www.segger.com/downloads/jlink/`，下载后需要将`JLink.exe`所在目录加入系统的Path环境变量。烧录器目录填写`JLink.exe`所在路径。 - -`OpenOCD`烧录器推荐下载地址： +- OpenOCD烧录器目录：`OpenOCD`需要用户自行下载安装，推荐下载地址： `https://sourceforge.net/projects/openocd/files/openocd/0.10.0-rc2/`，烧录器目录填写`openocd.exe`所在路径。 -***烧录文件：*** `烧录文件`是用户所编译生成的文件，目前支持`bin`、`fwpkg`、`hex`三种格式，执行编译后，后台将保存生成的烧录文件（`bin`、`fwpkg`、`hex`为后缀的文件），并填入`烧录文件`下拉菜单中供用户点选，用户也可以在`bin`、`fwpkg`或`hex`文件上`单击右键->设置为烧录文件`或点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 +**烧录文件：** `烧录文件`是用户编译生成的文件，目前支持`bin`、`fwpkg`、`hex`三种格式。执行编译后，后台将保存生成的烧录文件（`bin`、`fwpkg`、`hex`后缀的文件），并填入`烧录文件`下拉菜单中供用户点选，用户也可以在`bin`、`fwpkg`或`hex`文件上`单击右键->设置为烧录文件`或点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 ![avatar](images/burnerConfig.png) -其他配置项包括`连接方式`、`连接速率`、`加载地址`、`传输模式`等，可根据开发板及用户需求自行配置。 +其他配置项`连接方式`、`连接速率`、`加载地址`、`传输模式`等，可根据开发板及用户需求自行配置。 -填写完成后，点击确认，保存用户配置，此时可以通过单击烧录图标![avatar](images/burn.png)，对当前工程进行烧录。 +填写完成后，点击确认按钮保存用户配置，此时可以通过单击烧录图标![avatar](images/burn.png)，对当前工程进行烧录。 #### 调试器界面介绍 @@ -191,9 +176,9 @@ 调试器界面包括`调试器`、`端口`、`连接方式`、`连接速率`、`调试器目录`、`GDB目录`、`调试配置`等，默认已为用户配好，用户如有额外需求，可自行配置。 -***可执行文件路径：*** 执行编译后，后台将保存生成的调试可执行文件（`elf`、`out`为后缀的文件）路径，并填入`可执行文件路径`下拉菜单中供用户点选，用户也能通过手动输入或点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 +**可执行文件路径：** 执行编译后，后台将保存生成的调试可执行文件（`elf`、`out`后缀的文件）路径，并填入`可执行文件路径`下拉菜单中供用户点选，用户也能通过手动输入或点击文件夹图标![avatar](images/browserFoler.png)浏览目录自行配置。 -***调试配置：*** `调试配置`中可选择复位调试和附加调试两种调试方式。 +**调试配置：** `调试配置`中可选择复位调试和附加调试两种调试方式。 ![avatar](images/debuggerConfig.png) @@ -203,10 +188,10 @@ 串口配置界面包括`端口`、`端口状态`、`波特率`、`数据位`、`停止位`、`奇偶`、`流控`等，大多选项默认已为用户配好，用户如有额外需求，可自行配置。 -***端口：*** `端口`表示开发板使用的端口号，一般使用Hiburn烧录的开发板在烧录前需要用户手动配置，通过系统的设备管理器界面来判断当前使用的端口号。 +**端口：** `端口`表示开发板使用的端口号，一般使用Hiburn烧录的开发板在烧录前需要用户手动配置，通过系统的设备管理器界面来判断当前使用的端口号。 ![avatar](images/port.png) -***端口状态：*** `端口状态`能够实时显示端口是否被占用。 +**端口状态：** `端口状态`能够实时显示端口是否被占用。 ![avatar](images/serialConfig.png) \ No newline at end of file diff --git a/docs/project_stm32.md b/docs/project_stm32.md index 27c5e33508b8e146027e5385086e74621b37ce4b..d4bf9c3f73d4e22a7da90296a7d9c76d1c782fe2 100644 --- a/docs/project_stm32.md +++ b/docs/project_stm32.md @@ -3,39 +3,30 @@

STM32工程示例

-本节介绍如何使用`HUAWEI LiteOS Studio` 开发`STM32`开发板工程。[开源LiteOS](https://gitee.com/LiteOS/LiteOS)工程中，支持`STM32F429IG`、`STM32F769NI`、`STM32L431RC`、`STM32F103ZE`等`STM32`系列开发板。 +本节介绍如何使用`HUAWEI LiteOS Studio` 开发`STM32`开发板工程。[开源LiteOS](https://gitee.com/LiteOS/LiteOS)工程，支持`STM32F429IG`、`STM32L431RC`、`STM32F769NI`等`STM32`系列开发板。 ### 搭建Windows开发环境 -用户需要根据实际需求情况，安装`GNU Arm Embedded Toolchain Version 9-2019-q4-major`编译交叉工具链、`Make.exe`构建工具、`JLink`仿真器、`git for windows`工具。 +用户需要根据实际情况，安装`git for windows`工具、`GNU Arm Embedded Toolchain`编译交叉工具链、`Make.exe`构建工具、`JLink`仿真器。如果用户使用`OpenOCD`烧录，还需要安装`OpenOCD`烧录工具。 对于一些`STM32`开发板，用户可能还需要安装USB转串口驱动。 #### 安装git for windows工具 -如果用户需要使用新建工程功能下载开源工程SDK， 则应根据情况安装`git for windows`工具。 可参考[git工具安装](/install?id=安装Git工具)。 +如果用户需要使用新建工程功能下载开源工程SDK，则应根据情况安装`git for windows`工具，可参考[安装Git工具](/install?id=安装Git工具)。 #### 安装GNU Arm Embedded Toolchain软件 -`开源LiteOS`工程使用`ARM GCC`编译器进行编译， 需要安装编译器软件。 可参考[Arm工具安装](/install?id=安装arm-none-eabi软件)，通过本站安装程序下载. - -**注意：通过本站提供的下载程序下载`GNU Arm Embedded Toolchain`，需要先安装`git for windows`工具，并加入环境变量。** +`开源LiteOS`工程使用`ARM GCC`编译器进行编译，需要安装编译器软件，可参考[安装arm-none-eabi软件](/install?id=安装arm-none-eabi软件)。 #### 安装GNU Make等构建软件 -`开源LiteOS`工程使用`Makefile`文件组织编译和链接程序，我们需要安装`GNU Make`工具。可参考[Make工具安装](/install?id=安装Make构建软件)，通过本站安装程序下载。 - -**注意：通过本站提供的下载程序下载`GNU Make`，需要先安装`git for windows`工具，并加入环境变量。** +`开源LiteOS`工程使用`Makefile`文件组织编译和链接程序，需要安装`GNU Make`工具，可参考[安装Make构建软件](/install?id=安装Make构建软件)。 #### 安装JLink仿真器软件 -如果开发板使用`JLink`仿真器， 则根据情况安装`JLink`软件。 从`https://www.segger.com/downloads/jlink/`下载，并按安装向导完成最新版`JLink`的安装。 - -建议将`JLink.exe`所在目录加入`PATH`环境变量。 +如果开发板使用`JLink`仿真器，则应根据情况安装`JLink`软件，可参考[安装JLink仿真器软件](/install?id=安装JLink仿真器软件)。 -#### 安装OpenOCD工具（可选） - -如果用户需要使用`OpenOCD`完成烧录， 则应根据情况安装`OpenOCD烧录工具`。 ### 使用入门 @@ -43,29 +34,25 @@ #### 新建工程（可选） -**注意：** 当本地已有工程/源码时，无需再新建工程，直接进入下一步`打开工程`。 +**注意：当本地已有工程/源码时，无需再新建工程，直接进入下一步`打开工程`。** 通过点击`新建工程`图标![avatar](images/newFolder.png)，打开新建工程界面。在使用`HUAWEI LiteOS Studio`新建`STM32`工程时，需要联网，确保可以访问[开源LiteOS](https://gitee.com/LiteOS/LiteOS)。如果联网需要代理，请提前配置好代理，否则新建工程会失败。配置代理方法参考[常见问题](/studio_qa?id=新建工程失败问题)。同时，需要确保本地已安装`git for windows`工具。 **步骤 1** 在`工程名称`中填入自定义的工程名 -**步骤 2** 在`工程目录`中填入或选择工程存储路径 +**步骤 2** 在`工程目录`中填入或选择工程存储路径，路径名中不要包含中文、空格、特殊字符等 **步骤 3** 选择SDK版本号，当前STM32工程被维护在`https://gitee.com/`，支持最新版本`master`分支 -**步骤 4** 在开发板信息表点选开发板所在行，目前默认提供`STM32F429IG`、`STM32L431RC`、`STM32F103ZE`、`STM32F769NI`四种开发板 +**步骤 4** 在开发板信息表点选开发板所在行，目前默认提供`STM32F103ZE`、`STM32F429IG`、`STM32L431RC`、`STM32F769NI`四种开发板 -点击`确认`按钮，后台下载并保存所选目标板的SDK，等待下载完成后会自动重新打开一个新窗口并自动打开用户新建的工程。 +点击`确认`按钮，后台将下载并保存所选目标板的SDK，等待下载完成后会在一个新窗口中自动打开新建的工程。 ![avatar](images/create429.png) #### 打开工程 -新建工程后，会自动打开工程。这里演示如何打开存在的工程： - -**步骤 1** 打开`HUAWEI LiteOS Studio` - -**步骤 2** 点击`打开工程`图标![avatar](images/openFolder.png)，选择工程所在的目录 +新建工程后，会自动打开工程。如果需要打开存在的工程，点击`打开工程`图标![avatar](images/openFolder.png)，选择工程所在目录即可。 #### 目标板配置-选择目标板 @@ -83,17 +70,15 @@ **步骤 2** `编译器类型`选择`arm-none-eabi` -**步骤 3** `编译器目录`用户需要自行下载`GNU Arm Embedded Toolchain Version 9-2019-q4-major编译交叉工具链`，已提供默认路径， 用户可以将`arm-none-eabi`编译器安装到该路径下，也可自行指定安装目录，点击图标![avatar](images/browserFoler.png)设置为`arm-none-eabi-gcc.exe`所在路径 - -**步骤 4** `Make构建器`用户需要自行下载`Make.exe构建工具`，已提供默认路径， 用户可以将`Make.exe构建工具`安装到该路径下，也可自行指定安装目录，点击图标![avatar](images/browserFoler.png)设置为`make.exe`所在路径 +**步骤 3** `编译器目录`用户需要自行下载`GNU Arm Embedded Toolchain编译交叉工具链`，已提供默认路径。通过本站提供的自动下载程序，`arm-none-eabi`编译器就会安装到该路径下。用户也可自行指定安装目录，点击图标![avatar](images/browserFoler.png)设置为`arm-none-eabi-gcc.exe`所在路径 -**步骤 5** `Makefile脚本`路径需要用户自行填入，对于STM32工程，通常在`targets/开发板名/gcc`路径下的`Makefile`文件上点击右键->设置为Makefile文件，或点击图标![avatar](images/browserFoler.png) +**步骤 4** `Make构建器`用户需要自行下载`Make.exe构建工具`，已提供默认路径。通过本站提供的自动下载程序，`Make.exe构建工具`就会安装到该路径下。用户也可自行指定安装目录，点击图标![avatar](images/browserFoler.png)设置为`make.exe`所在路径 -进行自定义设置，也可使用![avatar](images/findScript.png)按钮自动搜索脚本文件 +**步骤 5** `Makefile脚本`路径需要用户自行填入，对于STM32工程，通常在`工程根目录`下的`Makefile`文件上`点击右键->设置为Makefile文件`，或点击图标![avatar](images/browserFoler.png)进行自定义设置，也可使用![avatar](images/findScript.png)按钮自动搜索脚本文件 -**步骤 5** 配置好后点击确认按钮![avatar](images/confirm.png)进行保存 +**步骤 6** 配置好后点击确认按钮![avatar](images/confirm.png)进行保存 -**步骤 6** 点击工具栏上的编译图标 ![avatar](images/compile.png) 进行编译代码，也可以点击重新构建图标 ![avatar](images/recompile.png) 进行清理和重新编译 +**步骤 7** 点击工具栏上的编译图标![avatar](images/compile.png) 开始编译，也可以点击重新构建图标![avatar](images/recompile.png) 进行清理和重新编译 编译成功的截图示例如下： @@ -109,33 +94,32 @@ ![avatar](images/stm/stm_burner.png) -**步骤 2** `烧录方式`选择`JLink`。如果目标板是`STM23L431RC`、`STM32F769NI`，建议刷成`JLInk`进行调测， 详细操作方法参考[ST-Link仿真器单步调测](/project_stm32?id=工程示例-st-link仿真器单步调测) +**步骤 2** `烧录方式`选择`JLink`。如果目标板是`STM23L431RC`、`STM32F769NI`，建议刷成`JLInk`进行调测， 详细操作方法参考[ST-Link仿真器单步调测](/project_stm32?id=st-link仿真器单步调测) **步骤 3** `烧录器目录`已提供默认路径，也可以点击图标![avatar](images/browserFoler.png)进行自定义设置 -**步骤 4** 点击`烧录文件`后的图标![avatar](images/browserFoler.png)或者使用如下图所示方式手动选择烧录文件 +**注意：如果用户安装的`JLink`目录不是Studio默认填入的`C:\Program Files (x86)\SEGGER\JLink`，请根据实际安装目录进行填写。** - ![avatar](images/stm/stm_setBurner.png) +**步骤 4** `烧录文件`设置，可以通过手动和自动两种方式设置文件： +- 手动设置：点击`烧录文件`后的图标![avatar](images/browserFoler.png)或者使用下图所示方式选择烧录文件 -也可点击下拉菜单选择自动匹配的烧录文件 + ![avatar](images/stm/stm_setBurner.png) -**注意：如果用户安装的`JLink`目录不是Studio默认填入的`C:\Program Files (x86)\SEGGER\JLink`，请在`烧录器目录`重新根据实际安装目录进行填写。** +- 自动设置：点击下拉菜单选择自动匹配的烧录文件 -**步骤 5** `连接方式`、`连接速率`、`加载地址`等保持默认，或根据实际开发板进行调整。配置好后点击![avatar](images/confirm.png)进行保存 +**步骤 5** `连接方式`、`连接速率`、`加载地址`等保持默认，或根据开发板进行调整。配置好后点击确认按钮![avatar](images/confirm.png)保存 **步骤 6** 点击工程配置界面上的`串口配置` ![avatar](images/serialConfig.png) -**步骤 7** 根据实际情况进行`端口`设置 - -比如下图中，使用的`USB`转串口的端口为`19`: +**步骤 7** 根据实际情况设置`端口`，比如下图使用的`USB`转串口的端口为`19`: ![avatar](images/stm/stm_serialPorts.png) **步骤 8** 设置`波特率`为`921600`， `数据位`、`停止位`、`奇偶`、`流控`保持默认即可 -**步骤 9** 配置好后点击![avatar](images/confirm.png)进行保存 +**步骤 9** 配置好后点击确认按钮![avatar](images/confirm.png)保存 **步骤 10** 点击工具栏上的图标![avatar](images/burn.png)进行烧录 @@ -155,93 +139,86 @@ ![avatar](images/stm/debugger.png) -**步骤 2** `调试器`根据实际情况选择`JLink`或者`OpenOCD` +**步骤 2** `调试器`根据实际情况选择`JLink`或者`OpenOCD`。对于板载`ST-Link`仿真器的开发板，建议刷成`JLInk`进行调测，操作方法参考[ST-Link仿真器单步调测](/project_stm32?id=st-link仿真器单步调测) **步骤 3** `连接方式`根据需求选择`SWD`或`JTAG`， `连接速率`可以默认或者自行指定 -**步骤 4** `调试器目录`需要指定用户的具体安装目录，如果与实际安装目录不一致，调试可能失败 - -**步骤 5** `GDB目录`需要用户指定编译器目录，可参考编译器界面填写 - -**步骤 6** `可执行文件路径`完成编译后，可填入路径或点击图标![avatar](images/browserFoler.png)进行手动设置，也可以点击下拉菜单选择自动匹配的可执行文件 +**步骤 4** `调试器目录`根据实际情况设置调试器的安装目录，如果与实际安装目录不一致，调试可能失败 -**步骤 6** `调试配置`根据需要，选择`复位调试`或`附加调试` +**步骤 5** `GDB目录`设置编译器目录，可参考编译器界面填写 -***`复位调试`*** 会自动重启开发板，并停止在main函数 +**步骤 6** `可执行文件路径`完成编译后就会生成可执行文件，用户可以点击图标![avatar](images/browserFoler.png)手动设置，也可以点击下拉菜单选择自动匹配的可执行文件 -***`附加调试`*** 不重启开发板，附加到当前运行代码行 +**步骤 7** `调试配置`根据需要，选择`复位调试`或`附加调试` +- 复位调试 会自动重启开发板，并停止在main函数 +- 附加调试 不重启开发板，附加到当前运行代码行 -配置好后点击确认按钮![avatar](images/confirm.png)进行保存， 会根据用户指定的设置自动生成调测配置。 +配置好后点击确认按钮![avatar](images/confirm.png)保存。 -**步骤 7** 点击打开`调试并运行`视图，选择调试配置`JLINK Debug`， 点击绿色三角按钮，开始调试 +**步骤 8** 点击打开`调试并运行`视图，选择调试配置`JLINK Debug`， 点击绿色三角按钮，开始调试 如果`调测器`配置为`OpenOCD`，则显示的是`OpenOCD Debug`。 ![avatar](images/stm/debuggerView.png) -**步骤 8** 调试界面如下： +**步骤 9** 调试界面如下： ![avatar](images/stm/debuggingView.png) -***变量** 展示局部变量、全局变量、静态变量 +- **变量** 展示局部变量、全局变量、静态变量 +- **监视** 监视指定的表达式 +- **调用堆栈** 展示当前运行状态和暂停状态的任务调用堆栈 +- **断点** 展示设置的断点 +- **寄存器** 查看各个寄存器的数值，支持复制数值操作 +- **反汇编 & 内存** 支持对函数进行反汇编，支持查看内存操作 +- **输出** 展示`GDB`客户端的输出日志 +- **调试控制台** 展示`GDB Server`的输出日志 -***监视** 监视指定的表达式 +#### 调试器-断点 +添加断点有两种方式： +- 方式一：将鼠标放在代码行号处，行号前面会出现红色圆点，单击圆点将这一行添加为断点。 +- 方式二：点击右键`添加断点`、`添加条件断点`、`添加记录点`。 -***调用堆栈** 展示当前的调用堆栈 + ![avatar](images/stm/breakpoints.png) -***断点** 展示设置的断点 +右键可以对添加的断点做删除、编辑、禁用操作。 -***寄存器** 查看各个寄存器的数值，支持复制数值操作 - -***反汇编 & 内存** 支持对函数进行反汇编，支持查看内存操作。 - -***输出** 展示`GDB`客户端的输出日志 - -***调试控制台** 展示`GDB Server`的输出日志 - -#### 调试器-断点 监视点 - -在代码行号处单击可以添加断点，或者右键点击，支持`条件断点`、`记录点`等。 - -![avatar](images/stm/breakpoints.png) - -选中代码文件中的变量或表达式，右键上下文菜单，可以添加监视点： +#### 调试器-监视点 +选中代码文件中的变量或表达式，点击右键添加监视点： ![avatar](images/stm/watchpoint.png) #### 调试器-寄存器 -在`调试面板-寄存器`视图，可查看开发板寄存器的数值。右键可复制寄存器值。 +在`调试面板-寄存器`视图，可查看开发板各寄存器的数值。点击右边的“copy value”可以复制这个数值。 ![avatar](images/stm/registers.png) #### 调试器-多线程调测 -LiteOS作为轻量级物联网操作系统，同时只能运行一个Task任务线程。在调试时，只能展示当前运行状态的任务线程的调用堆栈。通过多线程感知调测技术，在调测时，可以展示`Running运行`状态和`Pending暂停`状态的任务线程的调用堆栈，提供更加强大的调试能力。 +LiteOS作为轻量级物联网操作系统，同时只能运行一个Task任务线程，调试时只能展示当前运行状态的任务线程的调用堆栈。通过多线程感知调测技术，调测时可以展示`Running运行`状态和`Pending暂停`状态的任务线程的调用堆栈，提供更加强大的调试能力。 ![avatar](images/stm/threadawareness.png) -点击调用堆栈中的栈帧可以跳转到对应的源文件。当在不同任务的栈帧中切换时，`变量`视图会同步更新展示。 +点击调用堆栈中的栈帧可以跳转到对应的源文件。当在不同任务的栈帧中切换时，`变量`视图也会同步更新展示。 #### 调试器-反汇编 -在单步调测时，调测面板`反汇编&内存`中，支持查看对应源代码的反汇编代码，支持如下两种方式： +单步调测时，在`调试面板-反汇编&内存`视图中，可以查看对应源代码的反汇编代码，反汇编文件展示效果如下： -**反汇编指定函数** 通过输入函数名称，展示指定函数的反汇编代码。 +![avatar](images/stm/dissasm_2.png) -![avatar](images/stm/dissasm_1.png) +`反汇编&内存`支持如下两种反汇编方式： -**反汇编当前函数** 自动展示当前任务栈函数的反汇编代码。 +- **反汇编指定函数** 点击反汇编指定函数，在弹出的窗口中输入想要反汇编的函数名，回车后就可以在代码区中看到这个函数的反汇编代码。 -反汇编文件展示效果如下： + ![avatar](images/stm/dissasm_1.png) -![avatar](images/stm/dissasm_2.png) +- **反汇编当前函数** 点击反汇编当前函数，就可以在代码区中展示当前函数的反汇编代码。 #### 调试器-查看内存 -调测面板`反汇编&内存`中，点击`查看内存`，通过指定内存起始地址及长度，可以展示开发板的内存信息。 - -在弹窗中输入内存起始地址， 要展示内存的长度： +在`调试面板-反汇编&内存`视图中，点击`查看内存`，在弹窗中输入内存起始地址及长度，可以展示开发板的内存信息。 ![avatar](images/hi3861/memoryAddress.png) @@ -251,17 +228,17 @@ LiteOS作为轻量级物联网操作系统，同时只能运行一个Task任务 ![avatar](images/hi3861/viewmemory.png) -### 工程示例-ST-Link仿真器单步调测 +### ST-Link仿真器单步调测 -对于板载`ST-Link`仿真器的`STM32`开发板，如`STM23L431RC`、`STM32F769NI`，为了更加稳定的调测体验，建议刷成`JLInk`进行调测。步骤如下： +对于板载`ST-Link`仿真器的`STM32`开发板，如`STM23L431RC`、`STM32F769NI`，为了更加稳定的调测体验，建议刷成`JLInk`进行调测。在开始之前，需要先确保已安装`ST-LINK USB Drivers`和`J-Link`软件。 `ST-Link`刷`J-Link`的步骤如下： #### STLinkReflash 刷JLINK固件 -确保已安装`ST-LINK USB Drivers`和`J-Link软件`。 下载`ST-Link Reflash Utility`,解压后，双击`STLinkReflash.exe`运行。 +官方站点下载`ST-Link Reflash Utility`，或本站下载。解压`STLinkReflash.zip`，双击`STLinkReflash.exe`运行。 **步骤 1** 接受许可Accept -解压`STLinkReflash.zip`， 双击`STLinkReflash.exe`运行，输入`A`接受许可协议。 +输入`A`接受许可协议。 ![avatar](images/stm/stlinkreflashAccept.png) @@ -271,15 +248,15 @@ LiteOS作为轻量级物联网操作系统，同时只能运行一个Task任务 **步骤 3** Restore ST-Link -如果想恢复ST-Link仿真器，可以选择`[3]`执行即可恢复。 +如果想恢复ST-Link仿真器，选择`[3]`即可恢复。 #### 工程设置中切换为JLINK -**步骤 1** 烧录器切换为JLINK +**步骤 1** 烧录器的烧录方式切换为JLink ![avatar](images/stm/st-jlink-burn.png) -**步骤 2** 调试器切换为JLINK +**步骤 2** 调试器切换为JLink ![avatar](images/stm/st-jlink-debug.png) @@ -287,4 +264,4 @@ LiteOS作为轻量级物联网操作系统，同时只能运行一个Task任务 正常执行调测，如图： -![avatar](images/stm/st-jlink-debugging.png) +![avatar](images/stm/st-jlink-debugging.png) \ No newline at end of file diff --git a/docs/scripts/GNU_Arm_Embedded_Toolchain_download.bat b/docs/scripts/GNU_Arm_Embedded_Toolchain_download.bat index 9cab4aeb9e3a524f3c44d239a4bad35224d90d20..f6413abee5e19ca82f7463e6552c272c9e1c1b3b 100644 --- a/docs/scripts/GNU_Arm_Embedded_Toolchain_download.bat +++ b/docs/scripts/GNU_Arm_Embedded_Toolchain_download.bat @@ -1,5 +1,5 @@ cd /d %USERPROFILE%\.huawei-liteos-studio\tools -REM "if proxy is needed,please delete 'REM' on line 4-8,and input username, password, server on line 4-6" +REM "if proxy is needed,please delete 'REM' on lines below(NOTICE: EXCEPT THIS LINE) and input username, password(if spical character included, use escape character), server on line 3-5" REM set username= REM set password= REM set server= diff --git a/docs/scripts/extension_download.bat b/docs/scripts/extension_download.bat index f32814a71f11478f7fbca1cb6823b3ca6d3d3699..56723cbd6b81a2b76e086d647ca2e3856f75b8a3 100644 --- a/docs/scripts/extension_download.bat +++ b/docs/scripts/extension_download.bat @@ -1,5 +1,5 @@ cd /d %USERPROFILE%\.huawei-liteos-studio\extensions -REM "if proxy is needed,please delete 'REM' on line 4-8,and input username, password, server on line 4-6" +REM "if proxy is needed,please delete 'REM' on lines below(NOTICE: EXCEPT THIS LINE) and input username, password(if spical character included, use escape character), server on line 3-5" REM set username= REM set password= REM set server= diff --git a/docs/scripts/x_pack_windows_build_tools_download.bat b/docs/scripts/x_pack_windows_build_tools_download.bat index d0072bb8a690d0e659cb1f56555cbe6cf1e35ab8..1cfef331d744dbf9694dcb733bcd76df601f9d52 100644 --- a/docs/scripts/x_pack_windows_build_tools_download.bat +++ b/docs/scripts/x_pack_windows_build_tools_download.bat @@ -1,5 +1,5 @@ cd /d %USERPROFILE%\.huawei-liteos-studio\tools -REM "if proxy is needed,please delete 'REM' on line 4-8,and input username, password, server on line 4-6" +REM "if proxy is needed,please delete 'REM' on lines below(NOTICE: EXCEPT THIS LINE) and input username, password(if spical character included, use escape character), server on line 3-5" REM set username= REM set password= REM set server= diff --git a/docs/updates/1410.md b/docs/updates/1410.md index 7a684a8001a3366e806d8046ef8f8cbd497cd47a..52b6a23f3ce705d2444ae5268caf24c9b7354563 100644 --- a/docs/updates/1410.md +++ b/docs/updates/1410.md @@ -6,9 +6,7 @@ version 1.41.0 - WiFi IoT（Scons）、AI Camera编译（makefile+cygwin）、烧录 -- STM32开发板支持jlink、openocd、st-link等方式进行调试 - -- 预置编译器(arm gcc、risc-v gcc)、构建工具(make.exe，scons+cygwin)、调试工具（openocd、jlink、stutil等） +- STM32开发板支持jlink、openocd等方式进行调试 - 支持编译、烧录、调试、目标板等工程配置 diff --git a/docs/updates/1411.md b/docs/updates/1411.md index d05d1e52f4e4c0a0ca3744a0d58a81154c48e767..726f2a0779bf282c6363dff7687c50e92d97a4db 100644 --- a/docs/updates/1411.md +++ b/docs/updates/1411.md @@ -10,8 +10,6 @@ version 1.41.1 - 支持`WiFi IoT Hi3861`开发板的一键编译、烧录、调试。调试依赖支持JTAG的开发板。当前集成支持的WiFi IoT SDK版本为`Hi3861V100R001C00SPC012` -- 预置编译器(arm gcc、risc-v gcc)、构建工具(make.exe)、调试工具（openocd、jlink、stutil等） - - 支持快捷极简的编译、烧录、调试、目标板等工程配置 - 工具栏功能实现，新建工程，快进、后退，编译、烧录、调试，重启开发板，串口工程设置等 @@ -27,8 +25,6 @@ version 1.41.1 - `LiteOS Studio` GDB单步调测能力继续定位修复，易用性功能开发，反馈与改进 -- `LiteOS Studio` DFX能力持续集成，集成LMS、trace、栈估算等特性 - diff --git a/docs/updates/14110.md b/docs/updates/14110.md index d9ed7017b200d7bc1098d20bea2d77e994466131..ddb9456a8a99baee648be9ed9b2685c7d221707a 100644 --- a/docs/updates/14110.md +++ b/docs/updates/14110.md @@ -11,19 +11,15 @@ version 1.41.10 - 基于开发者使用习惯，实现工具栏功能， 支持新建工程， 快进、后退， 编译、烧录、调试， 重启开发板， 串口工程设置等 -- 集成栈估算DFX特性，评估任务栈大小设置，提升内存利用效率 - - 支持`STM32系列`开发板的一键编译、烧录、调试， 对齐开源`LiteOS`已支持的开发板型号 - 支持基于码云开源`LiteOS`， 支持选择适配的开发板，新建工程 - - 预置ARM GCC编译器、构建工具(make.exe)、调试工具（openocd、jlink、stutil等） - 支持GDB单步调测， 支持多线程感知，支持基础的查看反汇编、查看内存功能 -- 支持`WiFi IoT Hi3861`开发板的一键编译、烧录、调试， 预置`Histreaming、HiLink`组件 +- 支持`WiFi IoT Hi3861`开发板的一键编译、烧录、调试， 支持`Histreaming、HiLink`组件功能 - 集成最新的`WiFi IoT Hi3861`SDK TR5 版本`Hi3861V100R001C00SPC021` - 支持新建`WiFi IoT Hi3861`工程， 零配置， 实现一键编译、烧录、调测 - 支持`JLink`、`HiBurn串口`两种一键式烧录 - 支持GDB单步调测， 支持多线程感知，支持基础的查看反汇编、查看内存功能 - - 组件化预置`HiStreaming`、`HiLink`组件， 待组件化预置示例Demo 下版本计划： @@ -32,6 +28,4 @@ version 1.41.10 - `WiFi IoT Hi3861` 继续组件化集成支持示例Demo：Hello Word， 串口命令行控制红绿灯开关， HiStreaming使用手机APP控制灯开关 -- `LiteOS Studio`引擎版本升级，扩展升级发布 - -- `LiteOS Studio` DFX能力持续集成， 集成LMS、trace等特性 \ No newline at end of file +- `LiteOS Studio`引擎版本升级，扩展升级发布 \ No newline at end of file diff --git a/docs/updates/README.md b/docs/updates/README.md index 0be128491dba5b8e623b6d994b28902307a34d66..00e8d79ba882e6799b89cb08efc3852a11c10a60 100644 --- a/docs/updates/README.md +++ b/docs/updates/README.md @@ -1,4 +1,4 @@ -version 1.45.10 +version 1.45.1 有任何问题， 请随时联系我们的技术支持人员。 @@ -13,25 +13,16 @@ version 1.45.10 #### STM32系列开发板 - 支持`STM32系列`开发板的一键编译、烧录、调试， 对齐开源`LiteOS`已支持的开发板型号 - - 支持基于码云开源`LiteOS`， 支持选择适配的开发板，新建工程 - - 预置ARM GCC编译器、构建工具(make.exe)、调试工具（openocd、jlink、stutil等） + - 支持基于码云开源`LiteOS`， 支持选择适配的开发板`STM32F429IG`、`STM32F769NI`、`STM32L431RC`，支持新建工程远程下载 - 支持GDB单步调测， 支持多线程感知， 支持基础的查看反汇编、查看内存功能 #### WiFi IoT Hi3861开发板 - 支持`WiFi IoT Hi3861`开发板的一键编译、烧录、调试， 预置`Histreaming、HiLink`组件 - 集成最新的`WiFi IoT Hi3861`SDK TR5 版本`Hi3861V100R001C00SPC021` - - 支持新建`WiFi IoT Hi3861`工程， 零配置， 实现一键编译、烧录、调测 + - 支持新建`WiFi IoT Hi3861`工程，实现编译、烧录、调测 - 支持`JLink`、`HiBurn串口`两种一键式烧录 - 支持GDB单步调测， 支持多线程感知， 支持基础的查看反汇编、查看内存功能 - - 组件化预置`HiStreaming`、`HiLink`组件， 待组件化预置示例Demo - - -#### DFX调测能力工具 - -- 提供`LiteOS`定制的调测能力 ，辅助用户定位、分析问题。当前提供的能力工具有：栈估算， LMS内存检测， 可视化Trace。 - - - 栈估算， 使用模拟执行和动态标记技术来精确估算任务栈的内存使用空间， 提升内存利用效率 #### 后续计划 diff --git a/docs/updates/_sidebar.md b/docs/updates/_sidebar.md index 7229a19e702a5b9415a5476e786f80762e2e271e..e4e181aedc9640541897fe194ff33d79aeb165a9 100644 --- a/docs/updates/_sidebar.md +++ b/docs/updates/_sidebar.md @@ -1,5 +1,5 @@ - 发行说明 - - [Version 1.45.10](updates/README.md) + - [Version 1.45.1](updates/README.md) - [Version 1.41.10](updates/14110.md) - [Version 1.41.1](updates/1411.md) - [Version 1.41.0](updates/1410.md) \ No newline at end of file