add readme

Ubiquitous/XiZi_IIoT/board/imx8mp/README.md

@@ -0,0 +1,210 @@
+# 从零开始构建矽璓工业物联操作系统：使用ARM架构的NXP imx8mp
+
+[XiUOS](http://xuos.io/) (X Industrial Ubiquitous Operating System) 矽璓XiUOS是一款面向智慧车间的工业物联网操作系统，主要由一个极简的微型实时操作系统内核和其上的工业物联框架构成，通过高效管理工业物联网设备、支撑工业物联应用，在生产车间内实现智能化的“感知环境、联网传输、知悉识别、控制调整”，促进以工业设备和工业控制系统为核心的人、机、物深度互联，帮助提升生产线的数字化和智能化水平。
+
+
+
+## 1. 简介
+
+| 硬件     | 描述          |
+| -------- | ------------- |
+| 芯片型号 | i.MX8MP |
+| 架构     | ARM Cortex-M7 |
+| 主频     | 最高主频为 800 MHz |
+| 片内SRAM | 256 KB  |
+| 外设支持 | UART    |
+
+
+
+## 2. 开发环境搭建
+
+### 推荐使用：
+
+**操作系统：** 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://www.gitlink.org.cn/xuos/xiuos](https://www.gitlink.org.cn/xuos/xiuos)
+
+新建一个空文件夹并进入文件夹中，并下载源码，具体命令如下：
+
+```c
+mkdir test  &&  cd test
+git clone https://gitlink.org.cn/xuos/xiuos.git
+```
+
+1、打开XiUOS源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| APP_Framework | 应用代码 |
+| Ubiquitous | 板级支持包,支持NuttX、RT-Thread和XiZi内核 |
+
+2、打开XiZi内核源码文件包可以看到以下目录：
+| 名称 | 说明 |
+| -- | -- |
+| arch | 架构代码 |
+| board | 板级支持包 |
+| fs | 文件系统 |
+| kernel | 内核源码 |
+| lib | 第三方库源码 |
+| resources | 驱动文件 |
+| tool | 系统工具 |
+
+使用VScode打开代码，具体操作步骤为：在源码文件夹下打开系统终端，输入`code .`即可打开VScode开发环境，如下图所示：
+
+<div align= "center">
+<img src="img/vscode.jpg"  width =1000>
+  </div>
+
+
+### 裁减配置工具的下载
+
+裁减配置工具：
+
+**工具地址：** kconfig-frontends [https://www.gitlink.org.cn/xuos/kconfig-frontends](https://www.gitlink.org.cn/xuos/kconfig-frontends)，下载与安装的具体命令如下：
+
+```c
+mkdir kfrontends  && cd kfrontends
+git clone https://gitlink.org.cn/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
+```
+
+
+
+## 3. 编译说明
+
+### 编辑环境：`Ubuntu18.04`
+
+### 编译工具链：`arm-none-eabi-gcc`
+
+使用`VScode`打开工程的方法有多种，本文介绍一种快捷键，在项目目录下将`code .`输入linux系统命令终端即可打开目标项目
+
+
+编译步骤：
+
+1.在VScode命令终端中执行以下命令，生成配置文件
+
+```c
+cd ./Ubiquitous/XiZi
+make BOARD=imx8mp distclean
+make BOARD=imx8mp 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=imx8mp
+```
+
+4.如果编译正确无误，会产生XiZi-imx8mp.elf、XiZi-imx8mp.bin文件。
+
+
+
+## 4. 运行
+
+### 4.1 运行方式
+
+imx8mp开发板通过sd卡启动，sd卡中需要事先烧好uboot镜像和一个文件系统，并将XiZi-imx8mp.bin文件保存到文件系统中。之后启动开发板，用uboot在cortex-M7核执行例程，程序运行在DRAM，命令如下：
+
+```
+fatload mmc 1:1 0x80000000 XiZi-imx8mp.bin
+dcache flush
+bootaux 0x80000000
+```
+
+
+
+### 4.2 运行结果
+
+运行起来后将会在UART4串口上看到如下信息：
+
+<div align= "center">
+<img src="img/terminal.png"  width =1000>
+  </div>
+### 4.3 运行rpmsg例程
+
+目前支持在M核上运行rpmsg例程，与A核上的Linux应用程序通过RPMsg通信。具体方式如下：
+
+1. 首先通过上述步骤，通过uboot在M核上运行XiUOS，然后在letter shell中输入CreateRPMsgTask，按下回车，启动rpmsg例程。例程将等待A核上的Linux初始化RPMsg通信通道。
+
+2. 通过uboot在A核上启动Linux，Linux启动后，执行示例程序。
+
+3. 在Linux端可观察到：
+
+   <div align= "center">
+   <img src="img/linux.png"  width =1000>
+     </div>
+
+4. 在XiUOS上可观察到：
+
+   <div align= "center">
+   <img src="img/xiuos.png"  width =1000>
+     </div>
+
+* 通信流程图
+
+<div align= "center">
+<img src="img/rpmsg.png"  width =1000>
+  </div>