【移植】OpenHarmony 轻量级系统移植准备工作概述本文档从芯片适配的端到端视角，为芯片/模组制造商提供基于 O

概述

本文档从芯片适配的端到端视角，为芯片/模组制造商提供基于 OpenHarmony 的芯片适配指导。典型的芯片架构，例如 cortex-m、risc-v 系列都可以按照本文档进行适配移植。

约束与限制

本文档适用于 OpenHarmony LTS 3.0.1 及之前版本的轻量系统的适配。

说明： 本文仅对 OpenHarmony 移植适配过程中需要关注的文件和配置项进行介绍，其他文件以及配置项开发者无需关注，故不作详细介绍。

适配流程

主要开展基于伙伴硬件平台面向 OpenHarmony 系统的移植适配工作，具体细分为：移植准备、移植内核、移植子系统和移植验证四个环节，见表 1 芯片适配步骤。 表 1 芯片适配步骤

步骤	介绍
移植准备	从 OpenHarmony 开源社区下载代码，并完成编译环境搭建，基于此初步熟悉和了解 OpenHarmony 的编译构建框架。
移植内核	将伙伴的 SDK 移植到 OpenHarmony 平台，同时根据芯片 arch 支持情况确认是否需要开展 arch 的适配工作。
移植子系统	开展包括启动子系统、文件子系统、安全子系统、通信子系统和外设驱动的移植。
移植验证	在适配完成之后使用 OpenHarmony 社区提供的兼容性测试套件对适配的工程进行基本接口的测试验证，同时伙伴需要使用自有测试能力对适配工程开展质量验证活动。

图 1 业务总体流程

基本概念

表 2 基本概念

名词	介绍
子系统	是一个逻辑概念，它由一个或多个具体的部件组成。OpenHarmony 整体遵从分层设计，从下向上依次为：内核层、系统服务层、框架层和应用层。系统功能按照“系统 > 子系统 > 部件”逐级展开，在多设备部署场景下，支持根据实际需求裁剪某些非必要的子系统或部件。
部件	系统最小的可复用、可配置、可裁剪的功能单元。部件具备目录独立可并行开发、可独立编译、可独立测试的特征。
hb	OpenHarmony 的命令行工具，用来执行编译命令。
kv	键值对(key-value)，描述数据存储的格式。

由于 OpenHarmony 工程需要在 Linux 环境下进行编译，此章节将指导厂商搭建 OpenHarmony 的编译环境、获取 OpenHarmony 源码，并且创建厂商工作目录完成厂商芯片的编译框架适配。

搭建编译环境

开展移植前请参考开发环境准备完成环境搭建工作。

获取源码

获取操作

请参考获取源码完成源码下载并进行编译。

说明： 本文档仅适用于 OpenHarmony LTS 3.0.1 及之前版本，所以请获取对应版本的源码。

目录介绍

OpenHarmony 源码重要目录介绍见表 1 OpenHarmony 重要目录，其中 device 和 vendor 目录为芯片厂商和终端模组厂商工作区域（在搭建编译框架部分详细介绍）。

表 1 OpenHarmony 重要目录

目录	用途
build	编译框架所在目录。
kernel/liteos_m	内核所在的目录，其中 arch 目录描述支撑的内核架构。
device	芯片厂商适配目录，其中“config.gni”描述当前芯片使用的 arch，工具链，编译链接选项等。
vendor	终端模组厂商适配目录，其中“config.json”描述需要集成的 OpenHarmony 子系统列表。
utils	file，kv 等相关的适配。

搭建编译框架

厂商开展移植工作时，需要在工程中按照公司名、芯片型号、开发板型号等创建工作目录，并且将所创目录加入到 OpenHarmony 的编译框架中，使厂商的工作目录能够参与编译，开发者可参照以下步骤进行操作。

新增芯片厂商。

基于某款芯片进行 OpenHarmony 的适配，需要在 device 目录下创建芯片厂商目录，目录内文件描述内核类型，编译工具链，编译链接选项，内核配置选项等。创建目录规则：“device/{芯片厂商}/{芯片开发板}”。例：“device/MyDeviceCompany/MyBoard”

    device
    ├── hisilicon                                   # hisilicon芯片相关目录，创建目录时可供参考
    ├── MyDeviceCompany                             # MyDeviceCompany 芯片厂商
    │   └── MyBoard                                 # MyBoard 芯片型号
    │          ├── BUILD.gn
    │          ├── liteos_m
    │          │   └── config.gni                   # 芯片工具链，编译链接选项
    │          └── target_config.h                  # 内核配置选项
    └── qemu                                        # qemu相关

编译脚本：将“device/MyDeviceCompany/MyBoard”下的文件添加到 OpenHarmony 编译框架中。

路径：“device/MyDeviceCompany/MyBoard/BUILD.gn”

    group("MyBoard") {    #将此BUILD.gn文件加入解析
        print("MyDeviceCompany MyBoard is under developing.")
    }

开发板编译配置：包括内核类型、工具链类型以及编译参数等内容（详见表 2“config.gni”主要配置项）。路径：“device/MyDeviceCompany/MyBoard/liteos_m/config.gni”

    # Kernel type, e.g. "linux", "liteos_a", "liteos_m".
    kernel_type = "liteos_m"
    # Kernel version.
    kernel_version = ""
    # Board CPU type, e.g. "cortex-a7", "riscv32".
    board_cpu = "cortex-m4"
    # Board arch, e.g.  "armv7-a", "rv32imac".
    board_arch = ""
    # Toolchain name used for system compiling.
    # E.g. gcc-arm-none-eabi, arm-linux-harmonyeabi-gcc, ohos-clang,  riscv32-unknown-elf.
    # Note: The default toolchain is "ohos-clang". It's not mandatory if you use the default toochain.
    board_toolchain = "arm-none-eabi-gcc"
    # The toolchain path instatlled, it's not mandatory if you have added toolchian path to your ~/.bashrc.
    board_toolchain_path = ""
    # Compiler prefix.
    board_toolchain_prefix = "arm-none-eabi-"
    # Compiler type, "gcc" or "clang".
    board_toolchain_type = "gcc"
    # Board related common compile flags.
    board_cflags = []
    board_cxx_flags = board_cflags
    board_ld_flags = []
    # Board related headfiles search path.
    board_include_dirs = []
    # Board adapter dir for OHOS components.
    board_adapter_dir =""

表 2 “config.gni”主要配置项

配置项	介绍
kernel_type	开发板使用的内核类型，例如：“liteos_a”,“liteos_m”,“linux”。
kernel_version	开发板使用的内核版本。
board_cpu	开发板 CPU 类型，例如：“cortex-m4”，“cortex-a7”，“riscv32”。
board_arch	开发芯片 arch 指令集, 例如：“armv7-a”。
board_toolchain	开发板自定义的编译工具链名称，例如：“gcc-arm-none-eabi”。若为空，则使用默认为 ohos-clang。
board_toolchain_path	编译工具链路径，为空则默认使用环境变量中的工具链。
board_toolchain_prefix	编译工具链前缀，例如：“arm-none-eabi-”。
board_toolchain_type	编译工具链类型，目前支持 gcc 和 clang。
board_cflags	开发板配置的 c 文件编译选项。
board_cxx_flags	开发板配置的 cpp 文件编译选项。
board_ld_flags	开发板配置的链接选项。
board_include_dirs	开发板配置的系统头文件路径列表。
board_adapter_dir	开发板适配文件路径。

新增模组终端厂商。基于某款具备 OpenHarmony 能力的芯片进行模组终端开发，需要在 vendor 下创建模组厂商目录，目录内容主要是使用的 OpenHarmony 子系统能力。创建目录规则：“vendor/{产品模组厂商}/{产品模组名称}”。例：“vendor/MyVendorCompany/MyProduct”

    vendor
    ├── hisilicon                                            # hisilicon 产品相关目录，可供参考
    └── MyVendorCompany                                      # MyVendorCompany 产品模组厂商
           └── MyProduct                                     # 具体产品
                  ├── BUILD.gn
                  └── config.json                            # 产品子系统列表

编译脚本：将“vendor/MyVendorCompany/MyProduct/BUILD.gn”下的文件添加到 OpenHarmony 编译框架中。路径：“vendor/MyVendorCompany/MyProduct/BUILD.gn”

    group("MyProduct") {
        print("MyVendorCompany MyProduct is under developing.")
    }

DD一下：`欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。`

`欢迎大家关注工粽号<程序猿百晓生>，可以了解到以下知识点。`
1.OpenHarmony开发基础
2.OpenHarmony北向开发环境搭建
3.鸿蒙南向开发环境的搭建
4.鸿蒙生态应用开发白皮书V2.0 & V3.0
5.鸿蒙开发面试真题（含参考答案） 
6.TypeScript入门学习手册
7.OpenHarmony 经典面试题(含参考答案)
8.OpenHarmony设备开发入门【最新版】
9.沉浸式剖析OpenHarmony源代码
10.系统定制指南
11.【OpenHarmony】Uboot 驱动加载流程
12.OpenHarmony构建系统--GN与子系统、部件、模块详解
13.ohos开机init启动流程
14.鸿蒙版性能优化指南
.......

产品配置信息：包括产品名、设备厂商、内核类型以及所添加的子系统列表等信息（详见表 3）。路径：“vendor/MyVendorCompany/MyProduct/config.json”

    {
        "product_name": "MyProduct",
        "ohos_version": "OpenHarmony 1.0",
        "device_company": "MyDeviceCompany",
        "board": "MyBoard",
        "kernel_type": "liteos_m",
        "kernel_version": "",
        "subsystems": [
          {
            "subsystem": "startup",
            "components": [
              { "component": "bootstrap", "features":[] },
              { "component": "syspara_lite", "features":
                [
                  "enable_ohos_startup_syspara_lite_use_thirdparty_mbedtls = false"
                ]
              }
            ]
          }
        ],
        "vendor_adapter_dir": "",
        "third_party_dir": "",
        "product_adapter_dir": "//vendor/MyVendorCompany/MyProduct/hals",
    }

表 3 “config.json”文件配置项

配置项	介绍
product_name	产品名称，hb set 时显示产品名称。
ohos_version	OpenHarmony 版本号，与实际版本保持一致即可。
device_company	芯片厂商名称，与 device 的二级目录名称一致。
board	开发板名称，与 device 的三级目录名称一致。
kernel_type	内核类型，应与开发板移植的 OpenHarmony 系统内核类型匹配。
kernel_version	内核版本号，与 config.gni 中 kernel_version 值匹配。
subsystem	产品选择的子系统，应为 OS 支持的子系统。子系统定义请见 build/lite/components 目录下的各子系统描述文件。
components	产品选择的某个子系统下的组件，子系统支持的组件详见 build/lite/components/{子系统}.json 文件。
features	产品配置的某个组件的特性，详见子系统源码目录对应的 BUILD.gn 文件。
vendor_adapter_dir	适配 IOT 外设，UtilsFile 文件读写能力，一般指向 device 下目录。使用详见文件子系统移植实例步骤 2。
third_party_dir	芯片厂自身三方软件目录，例如 mbedtls，lwip 等。如果使用 OpenHarmony 提供的三方软件，可暂时设空，也可参考 hispark_pegasus 的配置。
product_adapter_dir	适配 hal_token 以及系统参数，一般指向 vendor 下目录。使用详见[启动恢复子系统移植实例步骤 1。

说明：

编译构建系统会对字段进行有效性检查，其中：

device_company，board，kernel_type，kernel_version 应与芯片厂商配置匹配。

subsystem，component 应与“build/lite/components”下的部件描述匹配。

【移植】OpenHarmony 轻量级系统移植准备工作

概述