yinjiaming
bcd177bbd3
【背景】 3.1 代码检视中有一些问题需要修改 【修改方案】 在README 中添加了文档链接,更改了非可执行文件的权限 【影响】 对现有的产品编译不会有影响。 Signed-off-by: yinjiaming <yinjiaming@huawei.com> Change-Id: I25eb1a2bfcbfdf7bc40b0516bcf9262c2d67f8b4
136 lines
6.9 KiB
Markdown
136 lines
6.9 KiB
Markdown
# LiteOS-M内核<a name="ZH-CN_TOPIC_0000001096757661"></a>
|
||
|
||
- [简介](#section11660541593)
|
||
- [目录](#section161941989596)
|
||
- [约束](#section119744591305)
|
||
- [使用说明](#section3732185231214)
|
||
- [贡献](#section1371123476307)
|
||
- [相关仓](#section1371113476307)
|
||
|
||
## 简介<a name="section11660541593"></a>
|
||
|
||
OpenHarmony LiteOS-M内核是面向IoT领域构建的轻量级物联网操作系统内核，具有小体积、低功耗、高性能的特点，其代码结构简单，主要包括内核最小功能集、内核抽象层、可选组件以及工程目录等，分为硬件相关层以及硬件无关层，硬件相关层提供统一的HAL（Hardware Abstraction Layer）接口，提升硬件易适配性，不同编译工具链和芯片架构的组合分类，满足AIoT类型丰富的硬件和编译工具链的拓展。其架构图如图1所示：
|
||
|
||
**图 1** OpenHarmony LiteOS-M核内核架构图<a name="fig0865152210223"></a>
|
||
|
||
|
||
## 目录<a name="section161941989596"></a>
|
||
|
||
目录结构如下，详细目录请参考[arch_spec_zh.md](arch_spec_zh.md)。
|
||
|
||
```
|
||
/kernel/liteos_m
|
||
├── arch # 内核指令架构层目录
|
||
│ ├── arm # arm 架构代码
|
||
│ │ ├── arm9 # arm9 架构代码
|
||
│ │ ├── cortex-m3 # cortex-m3架构代码
|
||
│ │ ├── cortex-m33 # cortex-m33架构代码
|
||
│ │ ├── cortex-m4 # cortex-m4架构代码
|
||
│ │ ├── cortex-m7 # cortex-m7架构代码
|
||
│ │ └── include # arm架构公共头文件目录
|
||
│ ├── csky # csky架构代码
|
||
│ │ └── v2 # csky v2架构代码
|
||
│ ├── include # 架构层对外接口存放目录
|
||
│ ├── risc-v # risc-v 架构
|
||
│ │ ├── nuclei # 芯来科技risc-v架构代码
|
||
│ │ └── riscv32 # risc-v官方通用架构代码
|
||
│ └── xtensa # xtensa 架构代码
|
||
│ └── lx6 # xtensa lx6架构代码
|
||
├── components # 可选组件
|
||
│ ├── backtrace # 栈回溯功能
|
||
│ ├── cppsupport # C++支持
|
||
│ ├── cpup # CPUP功能
|
||
│ ├── dynlink # 动态加载与链接
|
||
│ ├── exchook # 异常钩子
|
||
│ ├── fs # 文件系统
|
||
│ ├── lmk # Low memory killer 机制
|
||
│ ├── lms # Lite memory sanitizer 机制
|
||
│ ├── net # Network功能
|
||
│ ├── power # 低功耗管理
|
||
│ ├── shell # shell功能
|
||
│ └── trace # trace 工具
|
||
├── drivers # 驱动框架Kconfig
|
||
├── kal # 内核抽象层
|
||
│ ├── cmsis # cmsis标准接口支持
|
||
│ └── posix # posix标准接口支持
|
||
├── kernel # 内核最小功能集支持
|
||
│ ├── include # 对外接口存放目录
|
||
│ └── src # 内核最小功能集源码
|
||
├── targets # 板级工程目录
|
||
├── testsuites # 内核测试用例
|
||
├── tools # 内核工具
|
||
├── utils # 通用公共目录
|
||
```
|
||
|
||
## 约束<a name="section119744591305"></a>
|
||
|
||
开发语言：C/C++；
|
||
|
||
适用架构：详见目录结构arch层。
|
||
|
||
动态加载模块：待加载的共享库需要验签或者限制来源，确保安全性。
|
||
|
||
## 使用说明<a name="section3732185231214"></a>
|
||
|
||
OpenHarmony
|
||
LiteOS-M内核的编译构建系统是一个基于gn和ninja的组件化构建系统，支持按组件配置、裁剪和拼装，按需构建出定制化的产品。本文主要介绍如何基于gn和ninja编译LiteOS-M工程，GCC+gn、IAR、Keil MDK等编译方式可以参考社区爱好者贡献的站点。
|
||
|
||
### 搭建系统基础环境
|
||
|
||
在搭建各个开发板环境前，需要完成OpenHarmony系统基础环境搭建。系统基础环境主要是指OpenHarmony的编译环境和开发环境，详细介绍请参考官方站点[开发环境准备](https://gitee.com/openharmony/docs/blob/HEAD/zh-cn/device-dev/quick-start/quickstart-lite-env-setup.md)。开发者需要根据环境搭建文档完成环境搭建。
|
||
|
||
### 获取OpenHarmony源码
|
||
|
||
详细的源码获取方式，请见[源码获取](https://gitee.com/openharmony/docs/blob/HEAD/zh-cn/device-dev/get-code/sourcecode-acquire.md)。获取OpenHarmony完整仓代码后，假设克隆目录为`~/openHarmony`。
|
||
|
||
### 已支持的示例工程
|
||
|
||
Qemu模拟器: `arm_mps2_an386、esp32、riscv32_virt、SmartL_E802`, 编译运行详见: [Qemu指导](https://gitee.com/openharmony/device_qemu)
|
||
|
||
恒玄科技: `bes2600`, 编译运行详见: [恒玄开发指导](https://gitee.com/openharmony/device_soc_bestechnic)
|
||
|
||
### 社区移植工程链接
|
||
|
||
LiteOS-M内核移植的具体开发板的工程由社区开发者提供，可以访问社区开发者代码仓获取。如果您移植支持了更多开发板，可以提供链接给我们进行社区分享。
|
||
|
||
- cortex-m3：
|
||
|
||
- STM32F103 https://gitee.com/rtos_lover/stm32f103_simulator_keil
|
||
|
||
该仓包含OpenHarmony LiteOS-M内核基于STM32F103芯片架构构建的Keil工程，支持Keil MDK方式进行编译。
|
||
|
||
- cortex-m4：
|
||
|
||
- 野火挑战者STM32F429IGTb https://gitee.com/harylee/stm32f429ig_firechallenger
|
||
|
||
该仓包含OpenHarmony LiteOS-M内核移植支持`野火挑战者STM32F429IGTb`开发板的工程代码，支持Ninja、GCC、IAR等方式进行编译。
|
||
|
||
- cortex-m7：
|
||
|
||
- Nucleo-F767ZI https://gitee.com/harylee/nucleo_f767zi
|
||
|
||
该仓包含OpenHarmony LiteOS-M内核移植支持`Nucleo-F767ZI`开发板的工程代码，支持Ninja、GCC、IAR等方式进行编译。
|
||
|
||
## 贡献<a name="section1371123476307"></a>
|
||
|
||
[如何贡献](https://gitee.com/openharmony/docs/blob/HEAD/zh-cn/contribute/%E5%8F%82%E4%B8%8E%E8%B4%A1%E7%8C%AE.md)
|
||
|
||
[Commit message规范](https://gitee.com/openharmony/kernel_liteos_m/wikis/Commit%20message%E8%A7%84%E8%8C%83)
|
||
|
||
[Liteos-M 内核编码规范](https://gitee.com/openharmony/kernel_liteos_m/wikis/OpenHarmony%E8%BD%BB%E5%86%85%E6%A0%B8%E7%BC%96%E7%A0%81%E8%A7%84%E8%8C%83)
|
||
|
||
如何基于Liteos-M内核贡献一款芯片:
|
||
|
||
[板级目录规范](https://gitee.com/openharmony/docs/blob/HEAD/zh-cn/device-dev/porting/porting-chip-board-overview.md)
|
||
|
||
[轻量系统芯片移植指导](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/porting/porting-minichip.md)
|
||
|
||
[轻量系统芯片移植案例](https://gitee.com/openharmony/docs/blob/master/zh-cn/device-dev/porting/porting-minichip-cases.md)
|
||
|
||
## 相关仓<a name="section1371113476307"></a>
|
||
|
||
[内核子系统](https://gitee.com/openharmony/docs/blob/HEAD/zh-cn/readme/%E5%86%85%E6%A0%B8%E5%AD%90%E7%B3%BB%E7%BB%9F.md)
|
||
|
||
[kernel\_liteos\_m](https://gitee.com/openharmony/kernel_liteos_m/blob/master/README_zh.md)
|
||
|