技术文档与视频

Ubiquitous/XiUOS/board/cortex-m4-emulator/documents/技术文档.md

@@ -0,0 +1,234 @@
+# 技术报告（作品类别：系统软件）
+
+
+
+## 1.设计方案
+
+Add QEMU support for XiUOS based on Cortex-M4
+
+- 分析操作系统启动流程并且确定移植方案
+
+  <div align= "center"> 
+  <img src = img/road.png  width =1000>
+    </div>
+
+  如图，操作系统在启动时需进行一系列初始化操作，包括设置内存起止地址和大小，设置堆栈、指针等。这些操作随着主板的变化而变化。因此，为了将XiUOS移植到cortex-m4-emulator平台，需要针对该平台编写相应的初始化代码。增加 xiuos\Ubiquitous\XiUOS\board\cortex-m4-emulator 目录，目录包括cortex-m4初始化代码。
+
+- XiUOS 用cortex-m4-emulator编译
+
+  修改 xiuos\Ubiquitous\XiUOS 文件夹下的 path_kernel.mk 、 Makefile 、 kconfig 和 xconfig.h 
+
+  修改 xiuos\Ubiquitous\XiUOS\arch\arm 文件下的 Makefile
+
+- 编译后的XiUOS在QEMU运行
+
+
+
+## 2.实现方案
+
+### 2.1 编译环境搭建
+
+#### 推荐使用：
+
+**操作系统：** 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
+```
+
+
+
+### 2.2 XiUOS 用cortex-m4编译
+
+#### 编辑环境：`Ubuntu18.04`
+
+#### 编译工具链：`arm-none-eabi-gcc`
+
+使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入linux系统命令终端即可打开目标项目
+
+
+编译步骤：
+
+1.在VScode命令终端中执行以下命令，生成配置文件
+
+```c
+   make BOARD=cortex-m4-emulator menuconfig
+```
+
+2.在menuconfig界面配置需要关闭和开启的功能，按回车键进入下级菜单，按Y键选中需要开启的功能，按N键选中需要关闭的功能，配置结束后保存并退出（本例旨在演示简单的输出例程，所以没有需要配置的选项，双击快捷键ESC退出配置）
+
+<div align= "center"> 
+<img src = img/menuconfig.png  width =1000>
+  </div>
+
+
+退出时选择`yes`保存上面所配置的内容，如下图所示：
+
+<div align= "center"> 
+<img src = img/menuconfig1.png  width =1000>
+  </div>
+
+
+3.继续执行以下命令，进行编译
+
+```
+make BOARD=cortex-m4-emulator
+```
+
+4.如果编译正确无误，会产生XiUOS_cortex-m4-emulator.elf、XiUOS_cortex-m4-emulator.bin文件。
+
+
+
+### 2.3 QEMU环境
+
+Q‎EMU 是一个通用的开源模拟器和虚拟化工具。目前Q‎EMU已经可以较完整的支持ARM cortex-m4架构。XiUOS同样支持运行在Q‎EMU上
+
+| 硬件     | 描述          |
+| -------- | ------------- |
+| 芯片型号 | netduinoplus2 |
+| 架构     | cortex-m4     |
+| 主频     | 168MHz        |
+| 片内SRAM | 100+KB        |
+| 外设支持 | UART、GPIO    |
+
+
+
+
+
+## 3.运行效果
+
+### 3.1 安装Q‎EMU
+
+```
+sudo apt install qemu-system-arm
+```
+
+### 3.2 运行结果
+
+通过以下命令启动Q‎EMU并加载XiUOS ELF文件
+
+```
+qemu-system-arm -machine netduinoplus2  -nographic -kernel build/XiUOS_cortex-m4-emulator.elf
+```
+
+QEMU运行起来后将会在终端上看到信息打印输出
+
+<div align= "center"> 
+<img src = img/terminal.png  width =1000>
+  </div>
+
+
+### 3.3 调试
+
+通过Q‎EMU可以方便的对XiUOS进行调试，首先安装gdb调试工具
+
+```
+sudo apt install gdb-multiarch
+```
+
+并通过以下命令启动Q‎EMU
+
+```
+qemu-system-arm -machine netduinoplus2  -nographic -kernel build/XiUOS_cortex-m4-emulator.elf -s -S
+```
+
+然后要重新开启另一个linux系统终端一个终端，执行`riscv-none-embed-gdb`命令
+
+```
+gdb-multiarch build/XiUOS_cortex-m4-emulator.elf -ex "target remote localhost:1234" 
+```
+
+
+
+
+
+
+