!104 add: add environment setup and compilation into document
Merge pull request !104 from kenneth/master
This commit is contained in:
openharmony_ci
Gitee
commit
748a827560
68
README_zh.md
68
README_zh.md
|
|
@ -41,26 +41,74 @@ OpenHarmony LiteOS-M内核是面向IoT领域构建的轻量级物联网操作系
|
||||||
|
|
||||||
## 使用说明<a name="section3732185231214"></a>
|
## 使用说明<a name="section3732185231214"></a>
|
||||||
|
|
||||||
LiteOS-M内核提供了三种芯片架构的工程位于targets目录。三种架构的工程编译及使用方式如下：
|
OpenHarmony LiteOS-M内核的编译构建系统是一个基于gn和ninja的组件化构建系统，支持按组件配置、裁剪和拼装，按需构建出定制化的产品。编译构建系统的详细信息可以参考[官方开源站点编译系统介绍](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/porting/%E7%BC%96%E8%AF%91%E7%B3%BB%E7%BB%9F%E4%BB%8B%E7%BB%8D.md)。本文主要介绍如何基于gn和ninja编译LiteOS-M工程，GCC+Makefile、IAR、Keil MDK等编译方式可以参考社区爱好者贡献的站点。
|
||||||
|
|
||||||
|
### 搭建系统基础环境
|
||||||
|
|
||||||
|
在搭建各个开发板环境前，需要完成OpenHarmony系统基础环境搭建。系统基础环境主要是指OpenHarmony的编译环境和开发环境，详细介绍请参考官方站点[搭建系统基础环境](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/quick-start/%E6%90%AD%E5%BB%BA%E7%B3%BB%E7%BB%9F%E5%9F%BA%E7%A1%80%E7%8E%AF%E5%A2%83.md)。开发者需要根据环境搭建文档，完成下述软件的安装：Python3.7+、gn、ninja、hb。对于LiteOS-M内核，还需要安装Make构建工具和[ARM GCC编译工具链](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)。
|
||||||
|
|
||||||
|
### 获取OpenHarmony源码
|
||||||
|
|
||||||
|
开发者需要在Linux服务器上通过Git克隆获取OpenHarmony最新源码，详细的源码获取方式，请见[源码获取](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/get-code/%E6%BA%90%E7%A0%81%E8%8E%B7%E5%8F%96.md)。获取OpenHarmony完整仓代码后，假设克隆目录为`~/openHarmony`。
|
||||||
|
|
||||||
|
### 获取示例工程源码
|
||||||
|
|
||||||
|
以开发板Nucleo-F767Zi为例，演示如何编译运行`OpenHarmony LiteOS-M`内核工程。在本地目录，执行下述命令克隆示例代码。
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://gitee.com/harylee/nucleo_f767zi.git
|
||||||
|
```
|
||||||
|
|
||||||
|
假设克隆到的代码目录为`~/nucleo_f767zi`。 执行如下命令把代码目录的`device`、`vendor`目录复制到`openHarmony`工程的相应目录。
|
||||||
|
|
||||||
|
```
|
||||||
|
cp -r ~/nucleo_f767zi/device/st/nucleo_f767zi ~/openHarmony/device/st/nucleo_f767zi
|
||||||
|
|
||||||
|
chmod +x ~/openHarmony/device/st/nucleo_f767zi/build.sh
|
||||||
|
|
||||||
|
cp -r ~/nucleo_f767zi/vendor/st ~/openHarmony/vendor/st
|
||||||
|
```
|
||||||
|
|
||||||
|
关于示例代码目录的说明，可以参考资料站点[板级目录规范](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/porting/%E7%A7%BB%E6%A4%8D%E6%A6%82%E8%BF%B0-0.md#section6204129143013)。如果需要自行移植开发板，请参考[板级系统移植](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/porting/%E6%9D%BF%E7%BA%A7%E7%B3%BB%E7%BB%9F%E7%A7%BB%E6%A4%8D.md)。
|
||||||
|
|
||||||
|
### 编译运行
|
||||||
|
|
||||||
|
编译运行前，交叉编译工具链`bin`目录配置到`PATH`环境变量中或者配置`device/st/nucleo_f767zi/liteos_m/config.gni`文件中`board_toolchain_path`配置项为交叉编译工具链`bin`目录。
|
||||||
|
在`OpenHarmony`根目录，执行`hb set`设置产品路径，选择`nucleo_f767zi`产品，然后执行`hb build`开启编译。如下：
|
||||||
|
|
||||||
|
```
|
||||||
|
user@dev:~/OpenHarmony$ hb set
|
||||||
|
|
||||||
|
[OHOS INFO] Input code path: # 直接按回车，然后选择nucleo_f767zi产品即可
|
||||||
|
|
||||||
|
OHOS Which product do you need? nucleo_f767zi@st
|
||||||
|
|
||||||
|
user@dev:~/OpenHarmony$ hb build
|
||||||
|
```
|
||||||
|
|
||||||
|
最终的镜像生成在`~/openHarmony/out/nucleo_f767zi/`目录中，通过`STM32 ST-LINK Utility`软件将镜像文件下载至单板查看运行效果。
|
||||||
|
|
||||||
|
### 社区移植工程链接
|
||||||
|
|
||||||
|
LiteOS-M内核移植的具体开发板的工程由社区开发者提供，可以访问社区开发者代码仓获取。如果您移植支持了更多开发板，可以提供链接给我们进行社区分享。
|
||||||
|
|
||||||
- cortex-m3：
|
- cortex-m3：
|
||||||
|
|
||||||
kernel/liteos\_m/targets/cortex-m3\_stm32f103\_simulator\_keil目录是基于STM32F103芯片架构构建的keil工程目录，keil开发工具可通过网络下载并安装。进入cortex-m3\_stm32f103\_simulator\_keil/project目录，双击los\_demo.uvproj文件即可打开相应工程，编译成功后即可通过JLINK或者STM32 ST-LINK Utility烧录至对应单板。
|
- STM32F103 https://gitee.com/rtos_lover/stm32f103_simulator_keil
|
||||||
|
|
||||||
|
该仓包含OpenHarmony LiteOS-M内核基于STM32F103芯片架构构建的Keil工程，支持Keil MDK方式进行编译。
|
||||||
|
|
||||||
- cortex-m4：
|
- cortex-m4：
|
||||||
|
|
||||||
kernel/liteos\_m/targets/cortex-m4\_stm32f429ig\_fire-challenger\_iar目录是基于STM32F429IG芯片架构构建的IAR工程目录，IAR开发工具可通过网络下载并安装。进入cortex-m4\_stm32f429ig\_fire-challenger\_iar/project目录，双击los\_demo.eww文件即可打开相应工程，编译成功后即可通过JLINK或者STM32 ST-LINK Utility烧录至对应单板。
|
- 野火挑战者STM32F429IGTb https://gitee.com/harylee/stm32f429ig_firechallenger
|
||||||
|
|
||||||
|
该仓包含OpenHarmony LiteOS-M内核移植支持`野火挑战者STM32F429IGTb`开发板的工程代码，支持Ninja、GCC、IAR等方式进行编译。
|
||||||
|
|
||||||
- cortex-m7：
|
- cortex-m7：
|
||||||
|
|
||||||
kernel/liteos\_m/targets/cortex-m7\_nucleo\_f767zi\_gcc目录是基于STM32F767ZI芯片架构构建的Makefile工程目录。编译方式如下：
|
- Nucleo-F767ZI https://gitee.com/harylee/nucleo_f767zi
|
||||||
|
|
||||||
```
|
该仓包含OpenHarmony LiteOS-M内核移植支持`Nucleo-F767ZI`开发板的工程代码，支持Ninja、GCC、IAR等方式进行编译。
|
||||||
cd kernel/liteos_m/targets/cortex-m7_nucleo_f767zi_gcc
|
|
||||||
make clean; make
|
|
||||||
```
|
|
||||||
|
|
||||||
编译成功后在cortex-m7\_nucleo\_f767zi\_gcc/build目录下生成NUCLEO-F767.hex可执行文件，通过烧录工具STM32 ST-LINK Utility烧录到对应的单板。
|
|
||||||
|
|
||||||
## 修改日志
|
## 修改日志
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue