Update kd233, stm32f407-st-discovery, hifive1, qemu board README.md

board/hifive1-emulator/README.md

@@ -1,7 +1,14 @@
-# hifive1 emulator README
+# 从零开始构建矽璓工业物联操作系统：使用risc-v架构的hifive1 emulator
+
+# hifive1 emulator
+
+[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓XiUOS是一款面向智慧车间的工业物联网操作系统，主要由一个极简的微型实时操作系统内核和其上的工业物联框架构成，通过高效管理工业物联网设备、支撑工业物联应用，在生产车间内实现智能化的“感知环境、联网传输、知悉识别、控制调整”，促进以工业设备和工业控制系统为核心的人、机、物深度互联，帮助提升生产线的数字化和智能化水平。
+
+>注：最新版README请访问[从零开始构建矽璓工业物联操作系统：使用risc-v架构的hifive1 emulator](https://blog.csdn.net/AIIT_Ubiquitous/article/details/116295249)，如博客内容与本地文档有差异，以网站内容为准。
 
 ## 1. 简介
-Q‎EMU 是一个通用的开源模拟器和虚拟化工具。‎从5.0版本开始，Q‎EMU已经可以较完整的支持RISC-V架构，同时支持SiFive的E系列核心。目前XiUOS同样支持运行在Q‎EMU上。
+
+Q‎EMU 是一个通用的开源模拟器和虚拟化工具。‎从5.0版本开始，Q‎EMU已经可以较完整的支持RISC-V架构，同时支持SiFive的E系列核心。目前XiUOS同样支持运行在Q‎EMU上
 
 | 硬件 | 描述 |
 | -- | -- |
@@ -15,41 +22,118 @@ XiUOS板级当前支持使用UART。
 
 ## 2. 编译说明
 
-编译环境：Ubuntu18.04
+**操作系统：** ubuntu18.04 [https://ubuntu.com/download/desktop](https://ubuntu.com/download/desktop)
 
-编译工具链：[riscv-none-embed-gcc](https://github.com/ilg-archived/riscv-none-gcc/releases)
+**开发工具推荐使用 VSCode   ，VScode下载地址为：** VSCode  [https://code.visualstudio.com/](https://code.visualstudio.com/)，推荐下载地址为 [http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb](http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb)
 
-编译步骤：
+### 依赖包安装：
 
->1.将编译工具链的路径添加到board/hifive1-emulator/config.mk文件当中，例如将gnu-mcu-eclipse-riscv-none-gcc-8.2.0-2.1-20190425-1021-centos64.tgz解压到/opt/下时添加：
 ```
+$ sudo apt install build-essential pkg-config
+$ sudo apt install gcc make libncurses5-dev openssl libssl-dev bison flex libelf-dev autoconf libtool gperf libc6-dev  git
+```
+
+**XiUOS操作系统源码下载：** XiUOS [https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos)
+
+新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下：
+
+```c
+mkdir test  &&  cd test
+git clone https://git.trustie.net/xuos/xiuos.git
+```
+
+打开源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| application | 应用代码 |
+| board | 板级支持包 |
+| framework | 应用框架 |
+| fs | 文件系统 |
+| kernel | 内核源码 |
+| resources | 驱动文件 |
+| tool | 系统工具 |
+
+使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示：
+
+<div align= "center"> 
+<img src = img/vscode.jpg  width =1000>
+  </div>
+
+### 裁减配置工具的下载
+
+**裁减配置工具：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends)
+执行以下命令下载配置工具：
+
+```c
+mkdir kfrontends  && cd kfrontends
+git  clone https://git.trustie.net/xuos/kconfig-frontends.git
+```
+
+下载源码后按以下步骤执行软件安装：
+
+```c
+cd kconfig-frontends
+ ./xs_build.sh
+```
+
+### 编译工具链：
+
+RISC-V: riscv-none-embed-，默认安装到Ubuntu的/opt/，下载源码并解压。[下载网址 http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2](http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2)，下载完成后，执行以下命令：
+
+```c
+ sudo tar -xvjf gnu-mcu-eclipse.tar.bz2 -C /opt/
+```
+
+在VScode中将上述解压的编译工具链的路径添加到board/hifive1-emulator/config.mk文件当中，操作如下：
+
+```c
 export CROSS_COMPILE ?=/opt/gnu-mcu-eclipse/riscv-none-gcc/8.2.0-2.1-20190425-1021/bin/riscv-none-embed-
 ```
->2.在代码根目录下执行以下命令，生成配置文件
+
+若`CROSS_COMPILE `  变量定义语句已经存在，将它替换成上面的语句
+
+# 编译步骤：
+
+1.在`VScode`的“命令终端”中执行以下命令，生成配置文件
+
 ```
 make BOARD=hifive1-emulator menuconfig
 ```
->3.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出
 
-![hifive1-Rev-B](img/menuconfig.png)
+2.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出（本例旨在演示简单的输出例程，所以没有需要配置的选项，双击快捷键ESC退出配置）
 
->4.继续执行以下命令，进行编译
-```
+![menuconfig1](img/menuconfig1.png)
+
+退出时选择`yes`保存上面所配置的内容，如下图所示：
+
+![menuconfig2](img/menuconfig2.jpg)
+
+若执行 `make BOARD=hifive1-emulator menuconfig`后出现以下界面：
+
+![menuconfig3](img/menuconfig3.png)
+
+解决的方法是将终端向上拉伸超过当前界面的三分之二以上，效果如下：
+
+![menuconfig4](img/menuconfig4.png)
+
+3.继续在VScode命令终端中执行以下命令，进行编译
+
+```c
 make BOARD=hifive1-emulator
 ```
->5.如果编译正确无误，会在build目录下产生XiUOS_hifive1-emulator.elf、XiUOS_hifive1-emulator.bin文件。
->注：最后可以执行以下命令，清除配置文件和编译生成的文件
-```
-make BOARD=hifive1-emulator distclean
-```
+
+4.如果编译正确无误，会在build目录下产生XiUOS_hifive1-emulator.elf、XiUOS_hifive1-emulator.bin文件。
 
 ## 3. 运行
 
 ### 3.1 编译并安装Q‎EMU
-官网下载Q‎EMU源码编译安装，推荐使用[Q‎EMU v5.2.0](https://download.qemu.org/qemu-5.2.0.tar.xz)版本，如果官网下载速度慢，也可从下面链接下载Q‎EMU v5.2.0源码压缩包[下载地址](https://download.qemu.org/qemu-5.2.0.tar.xz)
+
+官网下载Q‎EMU源码编译安装，推荐使用[Q‎EMU v5.2.0](https://download.qemu.org/qemu-5.2.0.tar.xz)版本，如果官网下载速度慢，也可从下面链接下载Q‎EMU v5.2.0源码压缩包[下载地址](https://download.qemu.org/qemu-5.2.0.tar.xz)，用户可执行下面的命令进行下载并安装`QUME`。
+
 ```
 wget https://download.qemu.org/qemu-5.2.0.tar.xz
 tar -xvf qemu-5.2.0.tar.xz
+sudo apt  install   ninja-build libpixman-1-dev
 cd qemu-5.2.0
 ./configure --target-list=riscv32-softmmu
 make
@@ -59,18 +143,25 @@ sudo make install
 ### 3.2 运行结果
 
 通过以下命令启动Q‎EMU并加载XiUOS ELF文件
+
 ```
 qemu-system-riscv32 -nographic -machine sifive_e -kernel build/XiUOS_hifive1-emulator.elf
 ```
+
 QEMU运行起来后将会在终端上看到信息打印输出
+
 ![terminal](img/terminal.png)
 
 ### 3.3 调试
+
 利用Q‎EMU可以方便的对XiUOS进行调试，首先通过以下命令启动Q‎EMU
+
 ```
 qemu-system-riscv32 -nographic -machine sifive_e -kernel build/XiUOS_hifive1-emulator.elf -s -S
 ```
-然后在另一个终端，执行riscv-none-embed-gdb命令
+
+然后要重新开启另一个linux系统终端一个终端，执行`riscv-none-embed-gdb`命令
+
 ```
 riscv-none-embed-gdb build/XiUOS_hifive1-emulator.elf -ex "target remote localhost:1234"
-```
+```

board/hifive1-rev-B/README.md

@@ -1,6 +1,87 @@
-# hifive1 Rev B board README
+# 从零开始构建矽璓工业物联操作系统：使用risc-v架构的HiFive1 Rev B 开发板
 
-## 1. 简介
+[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓工业物联操作系统是一款面向工业物联场景的泛在操作系统，来自泛在操作系统研究计划。所谓泛在操作系统(UOS: Ubiquitous Operating Systems)，是支持互联网时代人机物融合泛在计算应用模式的新型操作系统，是传统操作系统概念的泛化与延伸。在泛在操作系统技术体系中，不同的泛在计算设备和泛在应用场景需要符合各自特性的不同UOS，XiUOS即是面向工业物联场景的一种UOS，主要由一个极简的微型实时操作系统(RTOS)内核和其上的智能工业物联框架构成，支持工业物联网(IIoT: Industrial Internet of Things)应用。
+
+>注：最新版README请访问[从零开始构建矽璓工业物联操作系统：使用risc-v架构的HiFive1 Rev B 开发板](https://blog.csdn.net/AIIT_Ubiquitous/article/details/116259873)，如博客内容与本地文档有差异，以网站内容为准。
+
+## 开发环境搭建
+
+### 推荐使用：
+
+**操作系统：** ubuntu18.04 [https://ubuntu.com/download/desktop](https://ubuntu.com/download/desktop)
+
+**开发工具推荐使用 VSCode   ，VScode下载地址为：** VSCode  [https://code.visualstudio.com/](https://code.visualstudio.com/)，推荐下载地址为 [http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb](http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb)
+
+### 依赖包安装：
+
+```
+$ sudo apt install build-essential pkg-config
+$ sudo apt install gcc make libncurses5-dev openssl libssl-dev bison flex libelf-dev autoconf libtool gperf libc6-dev  git
+```
+
+**源码下载：** XiUOS [https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos)
+
+新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下：
+
+```c
+mkdir test  &&  cd test
+git clone https://git.trustie.net/xuos/xiuos.git
+```
+
+打开源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| application | 应用代码 |
+| board | 板级支持包 |
+| framework | 应用框架 |
+| fs | 文件系统 |
+| kernel | 内核源码 |
+| resources | 驱动文件 |
+| tool | 系统工具 |
+
+使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示：
+
+<div align= "center"> 
+<img src = img/vscode.jpg  width =1000>
+  </div>
+  
+### 裁减配置工具的下载
+
+裁减配置工具：
+
+**工具地址：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends)
+
+```c
+mkdir kfrontends  && cd kfrontends
+git  clone https://git.trustie.net/xuos/kconfig-frontends.git
+```
+
+下载源码后按以下步骤执行软件安装：
+
+```c
+cd kconfig-frontends
+ ./xs_build.sh
+```
+
+### 编译工具链：
+
+RISC-V: riscv-none-embed-，默认安装到Ubuntu的/opt/，下载源码并解压。[下载网址 http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2](http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2)
+
+```shell
+$ tar -xjf gnu-mcu-eclipse.tar.bz2 -C /opt/
+```
+
+将上述解压的编译工具链的路径添加到board/hifive1-rev-B/config.mk文件当中，例如：
+
+```
+export CROSS_COMPILE ?=/opt/gnu-mcu-eclipse/riscv-none-gcc/8.2.0-2.1-20190425-1021/bin/riscv-none-embed-
+```
+
+若已存在`export CROSS_COMPILE ?=xxxx`   应该将原有的语句注释，再写入上面的语句。
+
+# 在HiFive1 Rev B board 上创建第一个应用
+
+## 1.HiFive1 Rev B board 简介
 
 | 硬件 | 描述 |
 | -- | -- |
@@ -12,32 +93,42 @@
 
 XiUOS板级当前支持使用UART。
 
-## 2. 编译说明
+## 2. 代码编写与编译说明
 
-编译环境：Ubuntu18.04
+编辑环境：`VScode`
 
-编译工具链：[riscv-none-embed-gcc](https://github.com/ilg-archived/riscv-none-gcc/releases)
+编译工具链：`riscv-none-embed-gcc`
+
+使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入终端即可打开目标项目
+
+修改`applications`文件夹下`main.c`
+
+在输出函数中写入  Hello, world!  \n running on Hifive1 Rev B  board完成代码编辑。
+
+![main](img/main.jpg)
 
 编译步骤：
 
->1.将编译工具链的路径添加到board/hifive1-rev-B/config.mk文件当中，例如将gnu-mcu-eclipse-riscv-none-gcc-8.2.0-2.1-20190425-1021-centos64.tgz解压到/opt/下时添加：
-```
-export CROSS_COMPILE ?=/opt/gnu-mcu-eclipse/riscv-none-gcc/8.2.0-2.1-20190425-1021/bin/riscv-none-embed-
-```
->2.在代码根目录下执行以下命令，生成配置文件
+1.在VScode终端下执行以下命令，生成配置文件
+
 ```
 make BOARD=hifive1-rev-B menuconfig
 ```
->3.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出
 
-![hifive1-Rev-B](img/menuconfig.png)
+2.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出
+
+![menuconfig](img/menuconfig.png)
+
+3.继续执行以下命令，进行编译
 
->4.继续执行以下命令，进行编译
 ```
 make BOARD=hifive1-rev-B
 ```
->5.如果编译正确无误，会在build目录下产生XiUOS_hifive1-rev-B.elf、XiUOS_hifive1-rev-B.bin文件。其中XiUOS_hifive1-rev-B.bin需要烧写到设备中进行运行。
+
+4.如果编译正确无误，build文件夹下会产生XiUOS_hifive1-rev-B.elf、XiUOS_hifive1-rev-B.bin文件。其中XiUOS_hifive1-rev-B.bin需要烧写到设备中进行运行。
+
 >注：最后可以执行以下命令，清除配置文件和编译生成的文件
+
 ```
 make BOARD=hifive1-rev-B distclean
 ```
@@ -46,34 +137,45 @@ make BOARD=hifive1-rev-B distclean
 
 hifive1-rev-B支持J-Link，可以通过J-Link进行烧录和调试。
 
-![hifive1-Rev-B](img/hifive1-Rev-B.png)
+![hifive1](img/hifive1-Rev-B.png)
 
-首先电脑需要安装J-Link Software and Documentation Pack，这里以Ubuntu18.04为例，下载[JLink_Linux_V700_x86_64.deb](https://www.segger.com/downloads/jlink/JLink_Linux_V700_x86_64.deb)，执行以下命令安装到电脑上
-```
+首先电脑需要安装J-Link Software and Documentation Pack，这里以Ubuntu18.04为例，下载[JLink_Linux_V700_x86_64.deb](https://www.segger.com/downloads/jlink/JLink_Linux_V700_x86_64.deb)，推荐使用[http://101.36.126.201:8011/JLink_Linux_V700_x86_64.deb](http://101.36.126.201:8011/JLink_Linux_V700_x86_64.deb)下载，然后执行以下命令安装到电脑上
+
+```c
 sudo apt install  ./JLink_Linux_V700_x86_64.deb
 ```
+
 使用 Micro USB 线将开发板与电脑连接，终端执行以下命令进入J-Link控制台，并通过J-Link连接设备
-```
+
+```c
 JLinkExe -device FE310 -if jtag -jtagconf -1,-1 -speed 4000
 ```
+
 命令执行成功后终端如下图：
-![hifive1-Rev-B](img/jlink_cmd1.png)
+
+![cmd1](img/jlink_cmd1.png)
 
 在J-Link控制台输入connect连接设备，如下图：
-![hifive1-Rev-B](img/jlink_cmd2.png)
+
+![cmd2](img/jlink_cmd2.png)
 
 接着输入erase命令擦除FLASH，如图：
-![hifive1-Rev-B](img/jlink_cmd3.png)
+
+![cmd3](img/jlink_cmd3.png)
 
 输入loadbin命令，并指定烧录的bin文件和烧录地址，将bin文件烧录到开发板中，如图：
-![hifive1-Rev-B](img/jlink_cmd4.png)
+
+![cmd4](img/jlink_cmd4.png)
 
 ### 3.1 运行结果
 
 如果编译 & 烧写无误，可以通过screen工具打开串口终端，hifive1-rev-B连接电脑后，在/dev 目录下会多出/dev/ttyACM0、/dev/ttyACM1两个串口设备，一般串口输出为/dev/ttyACM0，通过screen命令打开串口：
+
 ```
 sudo apt install screen
 screen /dev/ttyACM0 115200
 ```
+
 按下开发板Reset按钮，将会在串口终端上看到信息打印输出
-![terminal](img/terminal.png)
+
+![terminal](img/terminal.png)

board/kd233/README.md

@@ -1,6 +1,85 @@
-# KD233 README
+# 从零开始构建矽璓工业物联操作系统：使用risc-v架构的kd233开发板
 
-## 1. 简介
+[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓XiUOS是一款面向智慧车间的工业物联网操作系统，主要由一个极简的微型实时操作系统内核和其上的工业物联框架构成，通过高效管理工业物联网设备、支撑工业物联应用，在生产车间内实现智能化的“感知环境、联网传输、知悉识别、控制调整”，促进以工业设备和工业控制系统为核心的人、机、物深度互联，帮助提升生产线的数字化和智能化水平。
+
+>注：最新版README请访问[从零开始构建矽璓工业物联操作系统：使用risc-v架构的kd233开发板](https://blog.csdn.net/AIIT_Ubiquitous/article/details/116175737)，如博客内容与本地文档有差异，以网站内容为准。
+
+## 开发环境搭建
+
+### 推荐使用：
+
+**操作系统：** ubuntu18.04 [https://ubuntu.com/download/desktop](https://ubuntu.com/download/desktop)
+**开发工具推荐使用 VSCode   ，VScode下载地址为：** VSCode  [https://code.visualstudio.com/](https://code.visualstudio.com/)，推荐下载地址为 [http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb](http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb)
+
+### 依赖包安装：
+
+```
+$ sudo apt install build-essential pkg-config
+$ sudo apt install gcc make libncurses5-dev openssl libssl-dev bison flex libelf-dev autoconf libtool gperf libc6-dev  git
+```
+
+**源码下载：** XiUOS [https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos)
+新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下：
+
+```c
+mkdir test  &&  cd test
+git clone https://git.trustie.net/xuos/xiuos.git
+```
+
+打开源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| application | 应用代码 |
+| board | 板级支持包 |
+| framework | 应用框架 |
+| fs | 文件系统 |
+| kernel | 内核源码 |
+| resources | 驱动文件 |
+| tool | 系统工具 |
+
+使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示：
+
+<div align= "center"> 
+<img src = img/vscode.jpg  width =1000>
+  </div>
+
+### 裁减配置工具的下载
+**裁减配置工具：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends)
+执行以下命令下载配置工具：
+
+```c
+mkdir kfrontends  && cd kfrontends
+git  clone https://git.trustie.net/xuos/kconfig-frontends.git
+```
+
+下载源码后按以下步骤执行软件安装：
+
+```c
+cd kconfig-frontends
+ ./xs_build.sh
+```
+
+### 编译工具链：
+
+RISC-V: riscv-none-embed-，默认安装到Ubuntu的/opt/，下载源码并解压。[下载网址 http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2](http://101.36.126.201:8011/gnu-mcu-eclipse.tar.bz2)
+
+```shell
+$ tar -xjf gnu-mcu-eclipse.tar.bz2 -C /opt/
+```
+
+将上述解压的编译工具链的路径添加到board/kd233/config.mk文件当中，例如：
+
+```
+export CROSS_COMPILE ?=/opt/gnu-mcu-eclipse/riscv-none-gcc/8.2.0-2.1-20190425-1021/bin/riscv-none-embed-
+```
+
+若`CROSS_COMPILE `  变量定义语句已经存在，将它替换成上面的语句
+
+# 在KD233上创建第一个应用 --helloworld
+
+# KD233开发板简介
+
+## 1. 微处理器简介
 
 | 硬件 | 描述 |
 | -- | -- |
@@ -8,64 +87,94 @@
 |CPU| 双核RV64GC |
 |主频| 400MHz |
 |片内SRAM| 8MB |
-| 外设 | 内嵌AES与SHA256算法加速器 |
-| | DVP、JTAG、OTP、FPIOA、GPIO、UART、SPI、RTC、I²S、I²C、WDT、Timer与PWM |
+| 外设 | DVP、JTAG、OTP、FPIOA、GPIO、UART、SPI、RTC、I²S、I²C、WDT、Timer与PWM |
 
-XiUOS板级当前支持使用GPIO、I2C、RTC、SPI、Timer、UART和watchdog等。
+XiUOS板级当前支持使用GPIO、I2C、LCD、RTC、SPI、Timer、UART、watchdog。
 
-## 2. 编译说明
+## 2. 代码编写与编译说明
 
-编译环境：Ubuntu18.04
+编辑环境：`VScode`
 
-编译工具链：[riscv-none-embed-gcc](https://github.com/ilg-archived/riscv-none-gcc/releases)
+编译工具链：`riscv-none-embed-gcc`
+使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入终端即可打开目标项目
+
+修改`applications`文件夹下`main.c`
+在输出函数中写入  Hello, world!!!  \n Running on KD233完成代码编辑。
+
+![main](img/main.png)
 
 编译步骤：
 
->1.将编译工具链的路径添加到board/kd233/config.mk文件当中，例如将gnu-mcu-eclipse-riscv-none-gcc-8.2.0-2.1-20190425-1021-centos64.tgz解压到/opt/下时添加：
+1.在`VScode`的“命令终端”下执行以下命令，生成配置文件
+
+```c
+    make BOARD=kd233 menuconfig
 ```
-export CROSS_COMPILE ?=/opt/gnu-mcu-eclipse/riscv-none-gcc/8.2.0-2.1-20190425-1021/bin/riscv-none-embed-
+
+2.在`menuconfig`界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出（本实验无需选择任何选项，所以双击ESC结束选择，继续操作即可）。
+
+![menuconfig1](img/menuconfig1.png)
+
+双击`ESC`键会出现如下图所示结果：
+
+![menuconfig2](img/menuconfig2.png)
+
+选择`yes`键退出。
+
+若执行 `make BOARD=kd233 menuconfig`后出现以下界面：
+
+![menuconfig3](img/menuconfig3.png)
+
+解决的方法是将终端向上拉伸超过当前界面的三分之二以上，效果如下：
+
+![menuconfig4](img/menuconfig4.png)
+
+3.继续在`VScode`的“命令终端”中执行以下命令，进行编译
+
+```c
+   make BOARD=kd233
 ```
->2.在代码根目录下执行以下命令，生成配置文件
-```
-make BOARD=kd233 menuconfig
-```
->3.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出
->4.继续执行以下命令，进行编译
-```
-make BOARD=kd233
-```
->5.如果编译正确无误，会产生XiUOS_kd233.elf、XiUOS_kd233.bin文件。其中XiUOS_kd233.bin需要烧写到设备中进行运行。
+
+4.如果编译正确无误，会在build文件夹下生成XiUOS_kd233.elf、XiUOS_kd233.bin文件。其中XiUOS_kd233.bin需要烧写到设备中进行运行。
+
 >注：最后可以执行以下命令，清除配置文件和编译生成的文件
-```
-make BOARD=kd233 distclean
+
+```c
+   make BOARD=kd233 distclean
 ```
 
 ## 3. 烧写及执行
 
 连接开发板串口（即Type-C口）到USB接口，拨动电源开关打开开发板，然后使用K-Flash工具进行烧写bin文件。
 
-![KD233](img/kd233.jpg)
+![kd233](img/kd233.jpg)
 
 执行以下命令安装K-Flash工具
+
 ```
 sudo apt install python3 python3-pip
 sudo pip3 install pyserial
 sudo pip3 install pyelftools
 sudo pip3 install kflash
 ```
+
 如果最后一步安装kflash出现错误，可以尝试以下命令
+
 ```
 sudo python -m pip install kflash
 sudo python3 -m pip install kflash
 sudo pip install kflash
 sudo pip2 install kflash
 ```
+
 代码根目录下执行K-Flash工具烧录，-p为USB端口号，视实际情况而定
+
 ```
-kflash -t build/XiUOS_kd233.bin -p /dev/ttyUSB0
+sudo kflash -t build/XiUOS_kd233.bin -p /dev/ttyUSB0
 ```
+
 ### 3.1 运行结果
 
 如果编译 & 烧写无误，将会在串口终端上看到信息打印输出。
 
-![terminal](img/terminal.png)
+![terminal](img/terminal.png)

board/stm32f407-st-discovery/README.md

@@ -1,4 +1,107 @@
-# STM32F407-DISCOVERY README
+# 从零开始构建矽璓工业物联操作系统：使用ARM架构的STM32F407-discovery开发板
+
+[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓工业物联操作系统是一款面向工业物联场景的泛在操作系统，来自泛在操作系统研究计划。所谓泛在操作系统(UOS: Ubiquitous Operating Systems)，是支持互联网时代人机物融合泛在计算应用模式的新型操作系统，是传统操作系统概念的泛化与延伸。在泛在操作系统技术体系中，不同的泛在计算设备和泛在应用场景需要符合各自特性的不同UOS，XiUOS即是面向工业物联场景的一种UOS，主要由一个极简的微型实时操作系统(RTOS)内核和其上的智能工业物联框架构成，支持工业物联网(IIoT: Industrial Internet of Things)应用。
+
+>注：最新版README请访问[从零开始构建矽璓工业物联操作系统：使用ARM架构的STM32F407-discovery开发板](https://blog.csdn.net/AIIT_Ubiquitous/article/details/116209686)，如博客内容与本地文档有差异，以网站内容为准。
+
+## 开发环境搭建
+
+### 推荐使用：
+
+**操作系统：** ubuntu18.04 [https://ubuntu.com/download/desktop](https://ubuntu.com/download/desktop)
+
+更新`ubuntu 18.04`源的方法:（根据自身情况而定，可以不更改）
+
+第一步:打开sources.list文件
+
+```c
+sudo vim /etc/apt/sources.list
+```
+
+第二步:将以下内容复制到sources.list文件
+
+```c
+deb http://mirrors.aliyun.com/ubuntu/ bionic main restricted universe multiverse
+deb http://mirrors.aliyun.com/ubuntu/ bionic-security main restricted universe multiverse
+deb http://mirrors.aliyun.com/ubuntu/ bionic-updates main restricted universe multiverse
+deb http://mirrors.aliyun.com/ubuntu/ bionic-proposed main restricted universe multiverse
+deb http://mirrors.aliyun.com/ubuntu/ bionic-backports main restricted universe multiverse
+deb-src http://mirrors.aliyun.com/ubuntu/ bionic main restricted universe multiverse
+deb-src http://mirrors.aliyun.com/ubuntu/ bionic-security main restricted universe multiverse
+deb-src http://mirrors.aliyun.com/ubuntu/ bionic-updates main restricted universe multiverse
+deb-src http://mirrors.aliyun.com/ubuntu/ bionic-proposed main restricted universe multiverse
+deb-src http://mirrors.aliyun.com/ubuntu/ bionic-backports main restricted universe multiverse
+```
+
+第三步:更新源和系统软件
+
+```c
+sudo apt-get update
+sudo apt-get upgrade
+```
+
+**开发工具推荐使用 VSCode   ，VScode下载地址为：** VSCode  [https://code.visualstudio.com/](https://code.visualstudio.com/)，推荐下载地址为 [http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb](http://vscode.cdn.azure.cn/stable/3c4e3df9e89829dce27b7b5c24508306b151f30d/code_1.55.2-1618307277_amd64.deb)
+
+### 依赖包安装：
+
+```
+$ sudo apt install build-essential pkg-config  git
+$ sudo apt install gcc make libncurses5-dev openssl libssl-dev bison flex libelf-dev autoconf libtool gperf libc6-dev
+```
+
+**XiUOS操作系统源码下载：** XiUOS [https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos)
+
+新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下：
+
+```c
+mkdir test  &&  cd test
+git clone https://git.trustie.net/xuos/xiuos.git
+```
+
+打开源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| application | 应用代码 |
+| board | 板级支持包 |
+| framework | 应用框架 |
+| fs | 文件系统 |
+| kernel | 内核源码 |
+| resources | 驱动文件 |
+| tool | 系统工具 |
+
+使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示：
+
+<div align= "center"> 
+<img src = img/vscode.jpg  width =1000>
+  </div>
+
+### 裁减配置工具的下载
+
+裁减配置工具：
+
+**工具地址：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends)，下载与安装的具体命令如下：
+
+```c
+mkdir kfrontends  && cd kfrontends
+git  clone https://git.trustie.net/xuos/kconfig-frontends.git
+```
+
+下载源码后按以下步骤执行软件安装：
+
+```c
+cd kconfig-frontends
+ ./xs_build.sh
+```
+
+### 编译工具链：
+
+ARM： arm-none-eabi(`gcc version 6.3.1`)，默认安装到Ubuntu的/usr/bin/arm-none-eabi-，使用如下命令行下载和安装。
+
+```shell
+$ sudo apt install gcc-arm-none-eabi
+```
+
+# 在STM32F407-DISCOVERY上创建第一个应用 --helloworld
 
 ## 1. 简介
 
@@ -9,70 +112,102 @@
 |主频| 168MHz |
 |片内SRAM| 192KB |
 |片上FLASH| 1MB |
-| 外设 | 内嵌FPU处理器 |
-| | DCMI、JTAG、OTG、ADC、DAC、USB、GPIO、UART、SPI、SDIO、RTC、I²S、CAN、DMA、MAC、I²C、WDT、Timer与PWM |
+| 外设 | -- |
+| | ADC、DAC、USB、GPIO、UART、SPI、SDIO、RTC、CAN、DMA、MAC、I²C、WDT、Timer等 |
 
 XiUOS板级驱动当前支持使用GPIO、I2C、LCD、USB、RTC、SPI、Timer、UART和WDT等。
 
 ## 2. 编译说明
 
-### 编译环境：Ubuntu18.04
+### 编辑环境：`Ubuntu18.04`
 
-### 编译工具链：arm-none-eabi-gcc
+### 编译工具链：`arm-none-eabi-gcc`
+使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入linux系统命令终端即可打开目标项目
+
+修改`applications`文件夹下`main.c`
+在输出函数中写入 `Hello, world!!! \n   Running on stm32f407-st-discovery`完成代码编辑。
+
+![main](img/main.png)
 
 编译步骤：
->	1.ARM下编译需要安装arm-none-eabi编译工具, 安装到Ubuntu的默认路径/usr/bin/arm-none-eabi-，使用如下命令行下载
-```
-sudo apt-get install gcc-arm-none-eabi
-```
->2.在代码根目录下执行以下命令，生成配置文件
 
-```
-make BOARD=stm32f407-st-discovery menuconfig
-```
->3.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后保存并退出
+1.在VScode命令终端中执行以下命令，生成配置文件
 
-![img](menu.png )
-
->4.继续执行以下命令，进行编译
+```c
+   make BOARD=stm32f407-st-discovery menuconfig
 ```
+
+2.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后保存并退出（本例旨在演示简单的输出例程，所以没有需要配置的选项，双击快捷键ESC退出配置）
+
+![menuconfig1](img/menuconfig1.png)
+
+退出时选择`yes`保存上面所配置的内容，如下图所示：
+
+![menuconfig2](img/menuconfig2.jpg)
+
+3.继续执行以下命令，进行编译
+
+```c
 make BOARD=stm32f407-st-discovery
 ```
->5.如果编译正确无误，会产生XiUOS_stm32f407-st-discovery.elf、XiUOS_stm32f407-st-discovery.bin文件。其中XiUOS_stm32f407-st-discovery.bin需要烧写到设备中进行运行。
-```
-sudo write build/XiUOS_stm32f407-st-discovery.bin 0x8000000
-```
->6.最后可以执行以下命令，清除配置文件和编译生成的文件
-```
-make  BOARD=stm32f407-st-discovery distclean
-```
+
+4.如果编译正确无误，会产生XiUOS_stm32f407-st-discovery.elf、XiUOS_stm32f407-st-discovery.bin文件。其中XiUOS_stm32f407-st-discovery.bin需要烧写到设备中进行运行。
 
 ## 3. 烧写及执行
 
 将 BOARD=stm32f407-st-discovery开发板SWD经 st-link 转接到USB接口，然后使用st-flash工具进行烧写bin文件。
 
-执行以下命令下载st-link工具
+![stm32f407-st-discovery](img/stm32f407-st-discovery.png)
+
+### 烧写工具
+
+ARM：ST-LINK（ST-LINK V2实物如图，可在购物网站搜索关键字购买）
+
+![st-link](img/st-link.png)
+
+下载并以下执行命令以下命令安装st-link工具(本文使用v1.5.1版本)，下载地址为：[http://101.36.126.201:8011/stlink.zip](http://101.36.126.201:8011/stlink.zip)
+
 ```
-git clone https://github.com/texane/stlink.git
+sudo apt install libusb-dev
+sudo apt install libusb-1.0-0-dev
+sudo apt  install cmake
+cd stlink
+make
+cd build/Release && make install DESTDIR=_install
 ```
 
+将生成的st-flash（在stlink/build/Release/bin文件夹下）复制到/usr/bin下就可使用了
+
 代码根目录下执行st-flash工具烧录
+
 ```
 sudo st-flash  write  build/XiUOS_stm32f407-st-discovery.bin 0x8000000
 ```
-然后，安装串口调试工具，推荐使用putty
-```
-sudo apt-get  putty
-```
-将USB转串口模块两端分别连接开发板与开发电脑,连接引脚如下图所示：
 
-<div align= "center"> 
-<img src = load.jpg   width =40%>
-  </div>
+此外，推荐用户使用putty作为终端工具，安装命令如下：
+
+```c
+sudo apt install  putty
+```
+
+打开putty配置串口信息
+
+```c
+sudo puty
+```
+
+选择ttyUSB0（这个端口号根据具体情况而定），配置波特率为115200。
+
+![putty](img/putty.png)
+
+注意：选择正确的终端端口号，最后可以执行以下命令，清除配置文件和编译生成的文件
+
+```c
+make  BOARD=stm32f407-st-discovery distclean
+```
 
 ### 3.1 运行结果
 
 如果编译 & 烧写无误，将会在串口终端上看到信息打印输出，(终端串口引脚为PB6、PB7)。
 
-![img](shell.png )
-
+![terminal](img/terminal.png)