diff --git a/docs/doc/appdev/start_from_scratch/kd233.md b/docs/doc/appdev/start_from_scratch/kd233.md index 3ddb1a4..30393bd 100644 --- a/docs/doc/appdev/start_from_scratch/kd233.md +++ b/docs/doc/appdev/start_from_scratch/kd233.md @@ -1,58 +1,32 @@ + # 从零开始构建矽璓工业物联操作系统：使用risc-v架构的kd233开发板 -[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓工业物联操作系统是一款面向工业物联场景的泛在操作系统，来自泛在操作系统研究计划。所谓泛在操作系统(UOS: Ubiquitous Operating Systems)，是支持互联网时代人机物融合泛在计算应用模式的新型操作系统，是传统操作系统概念的泛化与延伸。在泛在操作系统技术体系中，不同的泛在计算设备和泛在应用场景需要符合各自特性的不同UOS，XiUOS即是面向工业物联场景的一种UOS，主要由一个极简的微型实时操作系统(RTOS)内核和其上的智能工业物联框架构成，支持工业物联网(IIoT: Industrial Internet of Things)应用。 +[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓XiUOS是一款面向智慧车间的工业物联网操作系统，主要由一个极简的微型实时操作系统内核和其上的工业物联框架构成，通过高效管理工业物联网设备、支撑工业物联应用，在生产车间内实现智能化的“感知环境、联网传输、知悉识别、控制调整”，促进以工业设备和工业控制系统为核心的人、机、物深度互联，帮助提升生产线的数字化和智能化水平。 + + + + + ## 开发环境搭建 -### 推荐使用 +### 推荐使用： -**操作系统：** ubuntu18.04[https://ubuntu.com/download/desktop](https://ubuntu.com/download/desktop) -更新`ubuntu 18.04`源的方法:（根据自身情况而定，可以不更改） -第一步:打开sources.list文件 - -```bash -sudo vim /etc/apt/sources.list +**操作系统：** 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) +### 依赖包安装： ``` - -第二步:将以下内容复制到sources.list文件 +$ 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 ``` -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 -``` - -第三步:更新源和系统软件 - -```bash -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) - -### 依赖包安装 - -```bash -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 [https://forgeplus.trustie.net/projects/xuos/xiuos](https://forgeplus.trustie.net/projects/xuos/xiuos) 新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下： -```bash +```c mkdir test && cd test git clone https://git.trustie.net/xuos/xiuos.git ``` - 打开源码文件包可以看到以下目录： | 名称 | 说明 | | -- | -- | @@ -64,135 +38,137 @@ git clone https://git.trustie.net/xuos/xiuos.git | resources | 驱动文件 | | tool | 系统工具 | 使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示： -
+
### 裁减配置工具的下载 +**裁减配置工具：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends) +执行以下命令下载配置工具： +```c -裁减配置工具： -**工具地址：** kconfig-frontends [https://forgeplus.trustie.net/projects/xuos/kconfig-frontends](https://forgeplus.trustie.net/projects/xuos/kconfig-frontends) - -```bash mkdir kfrontends && cd kfrontends git clone https://git.trustie.net/xuos/kconfig-frontends.git ``` 下载源码后按以下步骤执行软件安装： -```bash +```c cd kconfig-frontends ./xs_build.sh ``` -### 编译工具链 -ARM： arm-none-eabi(`gcc version 6.3.1`)，默认安装到Ubuntu的/usr/bin/arm-none-eabi-，使用如下命令行下载 -```bash -sudo apt install gcc-arm-none-eabi +### 编译工具链： + + +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 ` 变量定义语句已经存在，将它替换成上面的语句 -# 在STM32F407-DISCOVERY上创建第一个应用 --helloworld +# 在KD233上创建第一个应用 --helloworld +# KD233开发板简介 -## 1. 简介 +## 1. 微处理器简介 | 硬件 | 描述 | | -- | -- | -|芯片型号| Stm32F407VGT6| -|CPU|arm cortex-m| -|主频| 168MHz | -|片内SRAM| 192KB | -|片上FLASH| 1MB | -| 外设 | -- | -| | ADC、DAC、USB、GPIO、UART、SPI、SDIO、RTC、CAN、DMA、MAC、I²C、WDT、Timer等 | +|芯片型号| K210 | +|CPU| 双核RV64GC | +|主频| 400MHz | +|片内SRAM| 8MB | +| 外设 | DVP、JTAG、OTP、FPIOA、GPIO、UART、SPI、RTC、I²S、I²C、WDT、Timer与PWM | -XiUOS板级驱动当前支持使用GPIO、I2C、LCD、USB、RTC、SPI、Timer、UART和WDT等。 -## 2. 编译说明 +XiUOS板级当前支持使用GPIO、I2C、LCD、RTC、SPI、Timer、UART、watchdog。 -### 编辑环境：`Ubuntu18.04` +## 2. 代码编写与编译说明 -### 编译工具链：`arm-none-eabi-gcc` +编辑环境：`VScode` +编译工具链：`riscv-none-embed-gcc` 使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入终端即可打开目标项目 修改`applications`文件夹下`main.c` -在输出函数中写入 `Hello, world!!! \n Running on stm32f407-st-discovery`完成代码编辑。 +在输出函数中写入 Hello, world!!! \n Running on KD233完成代码编辑。 + +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210429211012268.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70#pic_center) + -
![在这里插入图片描述](https://img-blog.csdnimg.cn/20210428145204668.png)
编译步骤： -1.在代码根目录下执行以下命令，生成配置文件 +1.在`VScode`的“命令终端”下执行以下命令，生成配置文件 -```bash - make BOARD=stm32f407-st-discovery menuconfig +```c + make BOARD=kd233 menuconfig ``` -2.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后保存并退出 +2.在`menuconfig`界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后选择Exit保存并退出（本实验无需选择任何选项，所以双击ESC结束选择，继续操作即可）。 +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210428115820495.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70#pic_center)双击`ESC`键会出现如下图所示结果： +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210429205352780.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70#pic_center) +选择`yes`键退出。 +若执行 `make BOARD=kd233 menuconfig`后出现以下界面： +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210429204440614.png#pic_center)解决的方法是将终端向上拉伸超过当前界面的三分之二以上，效果如下： +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210429204819645.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70#pic_center) -
![在这里插入图片描述](https://img-blog.csdnimg.cn/20210426212955727.png?x-oss-process=none,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1ViaXF1aXRvdXNUZWFt,size_16,color_FFFFFF,t_70)
-3.继续执行以下命令，进行编译 +3.继续在`VScode`的“命令终端”中执行以下命令，进行编译 -```bash -make BOARD=stm32f407-st-discovery +```c + make BOARD=kd233 +``` + +4.如果编译正确无误，会在build文件夹下生成XiUOS_kd233.elf、XiUOS_kd233.bin文件。其中XiUOS_kd233.bin需要烧写到设备中进行运行。 + + + +>注：最后可以执行以下命令，清除配置文件和编译生成的文件 + +```c + make BOARD=kd233 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文件。 -
![在这里插入图片描述](https://img-blog.csdnimg.cn/2021042716353240.png?x-oss-process=none,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70)
+连接开发板串口（即Type-C口）到USB接口，拨动电源开关打开开发板，然后使用K-Flash工具进行烧写bin文件。 +![在这里插入图片描述](https://img-blog.csdnimg.cn/20210426211024969.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1ViaXF1aXRvdXNUZWFt,size_16,color_FFFFFF,t_70#pic_center) +执行以下命令安装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端口号，视实际情况而定 +``` +sudo kflash -t build/XiUOS_kd233.bin -p /dev/ttyUSB0 -### 烧写工具 - -ARM：ST-LINK（ST-LINK V2实物如图，可在购物网站搜索关键字购买） -
![在这里插入图片描述](https://img-blog.csdnimg.cn/20210427144736126.png)
- -下载并以下执行命令以下命令安装st-link工具(本文使用v1.5.1版本)，下载地址为：[http://101.36.126.201:8011/stlink.zip](http://101.36.126.201:8011/stlink.zip) - -```bash -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工具烧录 - -```bash -sudo st-flash write build/XiUOS_stm32f407-st-discovery.bin 0x8000000 -``` - -此外，推荐用户使用putty作为终端工具，安装命令如下： - -```bash -sudo apt install putty -``` - -打开putty配置串口信息 - -```bash -sudo puty -``` - -选择ttyUSB0（这个端口号根据具体情况而定），配置波特率为115200。 -
![在这里插入图片描述](https://img-blog.csdnimg.cn/2021042815015872.png?x-oss-process=none,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0FJSVRfVWJpcXVpdG91cw==,size_16,color_FFFFFF,t_70)
- -注意：选择正确的终端端口号，最后可以执行以下命令，清除配置文件和编译生成的文件 - -```bash -make BOARD=stm32f407-st-discovery distclean -``` ### 3.1 运行结果 -如果编译 & 烧写无误，将会在串口终端上看到信息打印输出，(终端串口引脚为PB6、PB7)。 -
![在这里插入图片描述](https://img-blog.csdnimg.cn/20210426213212239.PNG?x-oss-process=none,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1ViaXF1aXRvdXNUZWFt,size_16,color_FFFFFF,t_70#pic_center)
+如果编译 & 烧写无误，将会在串口终端上看到信息打印输出。 +![在这里插入图片描述](https://img-blog.csdnimg.cn/202104262129080.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1ViaXF1aXRvdXNUZWFt,size_16,color_FFFFFF,t_70#pic_center) + + + + +