1# 标准系统移植指南
2
3
4本文描述了移植一块开发板的通用步骤，和具体芯片相关的详细移植过程无法在此一一列举。后续社区还会陆续发布开发板移植的实例供开发者参考。
5
6
7## 定义开发板
8
9本文以移植名为MyProduct的开发板为例讲解移植过程，假定MyProduct是MyProductVendor公司的开发板，使用MySoCVendor公司生产的MySOC芯片作为处理器。
10
11
12### 定义产品
13
14在`//vendor/MyProductVendor/{product_name}`名称的目录下创建一个config.json文件，该文件用于描述产品所使用的SOC 以及所需的子系统。配置如下：
15
16//vendor/MyProductVendor/MyProduct/config.json
17
18
19```
20{
21    "product_name": "MyProduct",
22    "version": "3.0",
23    "type": "standard",
24    "target_cpu": "arm",
25    "ohos_version": "OpenHarmony 1.0",
26    "device_company": "MyProductVendor",
27    "board": "MySOC",
28    "enable_ramdisk": true,
29    "subsystems": [
30      {
31        "subsystem": "ace",
32        "components": [
33          { "component": "ace_engine_lite", "features":[] }
34        ]
35      },
36	...
37    ]
38}
39
40
41```
42主要的配置内容
43
44| 配置项 | 说明 |
45|-------|----------|
46|product_name |（必填）产品名称|
47|version|（必填）版本 |
48|type|（必填）配置的系统级别，包含（small、standard等) |
49|target_cpu |（必填）设备的CPU类型（根据实际情况，这里的target_cpu也可能是arm64 、riscv、 x86等）|
50|ohos_version|（选填）操作系统版本|
51|device_company|（必填）device厂商名|
52|board|（必填）开发板名称|
53|enable_ramdisk|（必填）是否启动ramdisk|
54|kernel_type|（选填）内核类型|
55|kernel_version|（选填）kernel_type与kernel_version在standard是固定的不需要写|
56|subsystems|（必填）系统需要启用的子系统。子系统可以简单理解为一块独立构建的功能块。|
57|product_company|不体现在配置中，而是目录名，vendor下一级目录就是product_company，BUILD.gn脚本依然可以访问。|
58
59
60已定义的子系统可以在“//build/subsystem_config.json”中找到。当然你也可以定制子系统。
61
62这里建议先拷贝Hi3516DV300 开发板的配置文件，删除掉 hisilicon_products 这个子系统。这个子系统为Hi3516DV300 SOC编译内核，显然不适合MySOC。
63
64
65### 移植验证
66
67  至此，你可以使用如下命令，启动你产品的构建了：
68
69```
70./build.sh --product-name MyProduct
71```
72
73构建完成后，可以在`//out/{device_name}/packages/phone/images`目录下看到构建出来的OpenHarmony镜像文件。
74
75
76## 内核移植
77
78这一步需要移植Linux内核，让Linux内核可以成功运行起来。
79
80
81### 为SOC添加内核构建的子系统
82
83修改文件`//build/subsystem_config.json`增加一个子系统。配置如下：
84
85
86```
87  "MySOCVendor_products": {
88    "project": "hmf/MySOCVendor_products",
89    "path": "device/MySOCVendor/MySOC/build",
90    "name": "MySOCVendor_products",
91    "dir": "device/MySOCVendor"
92  },
93```
94
95接着需要修改定义产品的配置文件`//vendor/MyProductVendor/MyProduct/config.json`，将刚刚定义的子系统加入到产品中。
96
97
98### 编译内核
99
100源码中提供了Linux 4.19的内核，归档在`//kernel/linux-4.19`。本节以该内核版本为例，讲解如何编译内核。
101
102在子系统的定义中，描述了子系统构建的路径path，即`//device/MySOCVendor/MySOC/build`。这一节会在这个目录创建构建脚本，告诉构建系统如何构建内核。
103
104建议的目录结构：
105
106
107```
108├── build
109│ ├── kernel
110│ │     ├── linux
111│ │           ├──standard_patch_for_4_19.patch // 基于4.19版本内核的补丁
112│ ├── BUILD.gn
113│ ├── ohos.build
114```
115
116BUILD.gn是subsystem构建的唯一入口。
117
118期望的构建结果
119
120| 文件 | 文件说明 |
121| -------- | -------- |
122| $root_build_dir/packages/phone/images/uImage | 内核镜像 |
123| $root_build_dir/packages/phone/images/uboot | bootloader镜像 |
124
125
126### 移植验证
127
128启动编译，验证预期的kernel镜像是否成功生成。
129
130## 用户态启动引导
131
1321. 用户态进程启动引导总览。
133
134   ![zh-cn_image_0000001199805369](figures/zh-cn_image_0000001199805369.png)
135
136
137   系统上电加载内核后，按照以下流程完成系统各个服务和应用的启动：
138
139   1. 内核启动init进程，一般在bootloader启动内核时通过设置内核的cmdline来指定init的位置；如上图所示的"init=/init root/dev/xxx"。
140   2. init进程启动后，会挂载tmpfs，procfs，创建基本的dev设备节点，提供最基本的根文件系统。
141   3. init继续启动ueventd监听内核热插拔事件，为这些设备创建dev设备节点；包括block设备各个分区设备都是通过此事件创建。
142   4. init进程挂载block设备各个分区（system，vendor），开始扫描各个系统服务的init启动脚本，并拉起各个SA服务。
143   5. samgr是各个SA的服务注册中心，每个SA启动时，都需要向samgr注册，每个SA会分配一个ID，应用可以通过该ID访问SA。
144   6. foundation是一个特殊的SA服务进程，提供了用户程序管理框架及基础服务；由该进程负责应用的生命周期管理。
145   7. 由于应用都需要加载JS的运行环境，涉及大量准备工作，因此appspawn作为应用的孵化器，在接收到foundation里的应用启动请求时，可以直接孵化出应用进程，减少应用启动时间。
146
1472. init。
148
149   init启动引导组件配置文件包含了所有需要由init进程启动的系统关键服务的服务名、可执行文件路径、权限和其他信息。每个系统服务各自安装其启动脚本到`/system/etc/init`目录下。
150
151   新芯片平台移植时，平台相关的初始化配置需要增加平台相关的初始化配置文件`/vendor/etc/init/init.{hardware}.cfg`；该文件完成平台相关的初始化设置，如安装ko驱动，设置平台相关的`/proc`节点信息。
152
153   init相关进程代码在`//base/startup/init_lite`目录下，该进程是系统第一个进程，无其它依赖。
154
155   初始化配置文件具体的开发指导请参考 [init启动子系统概述](../subsystems/subsys-boot-overview.md)。
156
157
158## HDF驱动移植
159
160
161### LCD
162
163HDF为LCD设计了驱动模型。支持一块新的LCD，需要编写一个驱动，在驱动中生成模型的实例，并完成注册。
164
165这些LCD的驱动被放置在`//drivers/hdf_core/framework/model/display/driver/panel`目录中。
166
1671. 创建Panel驱动
168
169   在驱动的Init方法中，需要调用RegisterPanel接口注册模型实例。如:
170
171
172   ```
173   int32_t XXXInit(struct HdfDeviceObject *object)
174   {
175       struct PanelData *panel = CreateYourPanel();
176
177       // 注册
178       if (RegisterPanel(panel) != HDF_SUCCESS) {
179           HDF_LOGE("%s: RegisterPanel failed", __func__);
180           return HDF_FAILURE;
181       }
182       return HDF_SUCCESS;
183   }
184
185   struct HdfDriverEntry g_xxxxDevEntry = {
186       .moduleVersion = 1,
187       .moduleName = "LCD_XXXX",
188       .Init = XXXInit,
189   };
190
191   HDF_INIT(g_xxxxDevEntry);
192   ```
193
1942. 配置加载panel驱动产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在display的host中，名为device_lcd的device中增加配置。
195
196   注意：moduleName要与panel驱动中的moduleName相同。
197
198   ```
199   root {
200       ...
201       display :: host {
202           device_lcd :: device {
203               deviceN :: deviceNode {
204                   policy = 0;
205                   priority = 100;
206                   preload = 2;
207                   moduleName = "LCD_XXXX";
208               }
209           }
210       }
211   }
212   ```
213
214   更详细的驱动开发指导，请参考[LCD](../driver/driver-peripherals-lcd-des.md)。
215
216
217### 触摸屏
218
219本节描述如何移植触摸屏驱动。触摸屏的驱动被放置在`//drivers/hdf_core/framework/model/input/driver/touchscreen`目录中。移植触摸屏驱动主要工作是向系统注册ChipDevice模型实例。
220
2211. 创建触摸屏器件驱动
222
223   在目录中创建名为touch_ic_name.c的文件。代码模板如下：注意：请替换ic_name为你所适配芯片的名称。
224
225
226   ```
227   #include "hdf_touch.h"
228
229   static int32_t HdfXXXXChipInit(struct HdfDeviceObject *device)
230   {
231       ChipDevice *tpImpl = CreateXXXXTpImpl();
232       if(RegisterChipDevice(tpImpl) != HDF_SUCCESS) {
233           ReleaseXXXXTpImpl(tpImpl);
234           return HDF_FAILURE;
235       }
236       return HDF_SUCCESS;
237   }
238
239   struct HdfDriverEntry g_touchXXXXChipEntry = {
240       .moduleVersion = 1,
241       .moduleName = "HDF_TOUCH_XXXX",
242       .Init = HdfXXXXChipInit,
243   };
244
245   HDF_INIT(g_touchXXXXChipEntry);
246   ```
247
248   其中ChipDevice中要提供若干方法。
249
250   | 方法 | 实现说明 |
251   | -------- | -------- |
252   | int32_t (\*Init)(ChipDevice \*device) | 器件初始化 |
253   | int32_t (\*Detect)(ChipDevice \*device) | 器件探测 |
254   | int32_t (\*Suspend)(ChipDevice \*device) | 器件休眠 |
255   | int32_t (\*Resume)(ChipDevice \*device) | 器件唤醒 |
256   | int32_t (\*DataHandle)(ChipDevice \*device) | 从器件读取数据，将触摸点数据填写入device->driver->frameData中 |
257   | int32_t (\*UpdateFirmware)(ChipDevice \*device) | 固件升级 |
258
2592. 配置产品，加载器件驱动
260
261   产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在名为input的host中，名为device_touch_chip的device中增加配置。注意：moduleName 要与触摸屏驱动中的moduleName相同。
262
263
264   ```
265   deviceN :: deviceNode {
266       policy = 0;
267       priority = 130;
268       preload = 0;
269       permission = 0660;
270       moduleName = "HDF_TOUCH_XXXX";
271       deviceMatchAttr = "touch_XXXX_configs";
272   }
273   ```
274
275   更详细的驱动开发指导，请参考[TOUCHSCREEN](../driver/driver-peripherals-touch-des.md)。
276
277
278### WLAN
279
280Wi-Fi驱动分为两部分，一部分负责管理WLAN设备，另一个部分负责处理WLAN流量。HDF WLAN分别为这两部分做了抽象。目前支持SDIO接口的WLAN芯片。
281
282  **图1** WLAN芯片
283
284  ![zh-cn_image_0000001188241031](figures/zh-cn_image_0000001188241031.png)
285
286支持一款芯片的主要工作是实现一个ChipDriver驱动。实现HDF_WLAN_CORE和NetDevice提供的接口。主要需要实现的接口有:
287
288| 接口 | 定义头文件 | 说明 |
289| -------- | -------- | -------- |
290| HdfChipDriverFactory | //drivers/hdf_core/framework/include/wifi/hdf_wlan_chipdriver_manager.h | ChipDriver的Factory，用于支持一个芯片多个Wi-Fi端口 |
291| HdfChipDriver | //drivers/hdf_core/framework/include/wifi/wifi_module.h | 每个WLAN端口对应一个HdfChipDriver，用来管理一个特定的WLAN端口 |
292| NetDeviceInterFace | //drivers/hdf_core/framework/include/net/net_device.h | 与协议栈之间的接口，如发送数据、设置网络接口状态等 |
293
294建议适配按如下步骤操作：
295
2961. 创建HDF驱动建议将代码放置在`//device/MySoCVendor/peripheral/wifi/chip_name/`，文件模板如下：
297
298
299   ```
300   static int32_t HdfWlanXXXChipDriverInit(struct HdfDeviceObject *device) {
301       static struct HdfChipDriverFactory factory = CreateChipDriverFactory();
302       struct HdfChipDriverManager *driverMgr = HdfWlanGetChipDriverMgr();
303       if (driverMgr->RegChipDriver(&factory) != HDF_SUCCESS) {
304           HDF_LOGE("%s fail: driverMgr is NULL!", __func__);
305           return HDF_FAILURE;
306       }
307       return HDF_SUCCESS;
308   }
309
310   struct HdfDriverEntry g_hdfXXXChipEntry = {
311       .moduleVersion = 1,
312       .Init = HdfWlanXXXChipDriverInit,
313       .Release = HdfWlanXXXChipRelease,
314       .moduleName = "HDF_WIFI_CHIP_XXX"
315   };
316
317   HDF_INIT(g_hdfXXXChipEntry);
318   ```
319
320   在CreateChipDriverFactory中，需要创建一个HdfChipDriverFactory，接口如下：
321
322
323
324   | 接口 | 说明 |
325   | -------- | -------- |
326   | const char \*driverName | 当前driverName |
327   | int32_t (\*InitChip)(struct HdfWlanDevice \*device) | 初始化芯片 |
328   | int32_t (\*DeinitChip)(struct HdfWlanDevice \*device) | 去初始化芯片 |
329   | void (_ReleaseFactory)(struct HdfChipDriverFactory _factory) | 释放HdfChipDriverFactory对象 |
330   | struct HdfChipDriver _(_Build)(struct HdfWlanDevice \*device, uint8_t ifIndex) | 创建一个HdfChipDriver；输入参数中，device是设备信息，ifIndex是当前创建的接口在这个芯片中的序号 |
331   | void (_Release)(struct HdfChipDriver _chipDriver) | 释放chipDriver |
332   | uint8_t (\*GetMaxIFCount)(struct HdfChipDriverFactory \*factory) | 获取当前芯片支持的最大接口数 |
333
334   HdfChipDriver需要实现的接口有：
335
336   | 接口 | 说明 |
337   | -------- | -------- |
338   | int32_t (\*init)(struct HdfChipDriver \*chipDriver, NetDevice \*netDev) | 初始化当前网络接口，这里需要向netDev提供接口NetDeviceInterFace |
339   | int32_t (\*deinit)(struct HdfChipDriver \*chipDriver, NetDevice \*netDev) | 去初始化当前网络接口 |
340   | struct HdfMac80211BaseOps \*ops | WLAN基础能力接口集 |
341   | struct HdfMac80211STAOps \*staOps | 支持STA模式所需的接口集 |
342   | struct HdfMac80211APOps \*apOps | 支持AP模式所需要的接口集 |
343
3442. 编写配置文件，描述驱动支持的设备。
345
346   在产品配置目录下创建芯片的配置文件`//vendor/MyProductVendor/MyProduct/config/wifi/wlan_chip_chip_name.hcs`。
347
348   注意： 路径中的vendor_name、product_name、chip_name请替换成实际名称。
349
350   模板如下：
351
352   ```
353   root {
354       wlan_config {
355           chip_name :& chipList {
356               chip_name :: chipInst {
357                   match_attr = "hdf_wlan_chips_chip_name"; /* 这是配置匹配属性，用于提供驱动的配置根 */
358                   driverName = "driverName"; /* 需要与HdfChipDriverFactory中的driverName相同*/
359                   sdio {
360                       vendorId = 0x0296;
361                       deviceId = [0x5347];
362                   }
363               }
364           }
365       }
366   }
367   ```
368
3693. 编写配置文件，加载驱动。
370
371   产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在名为network的host中，名为device_wlan_chips的device中增加配置。
372
373   注意：moduleName 要与触摸屏驱动中的moduleName相同。
374
375   ```
376   deviceN :: deviceNode {
377       policy = 0;
378       preload = 2;
379       moduleName = "HDF_WLAN_CHIPS";
380       deviceMatchAttr = "hdf_wlan_chips_chip_name";
381       serviceName = "driverName";
382   }
383   ```
384
3854. 构建驱动
386
387   - 创建内核菜单在`//device/MySoCVendor/peripheral`目录中创建Kconfig文件，内容模板如下：
388
389     ```
390     config DRIVERS_WLAN_XXX
391         bool "Enable XXX WLAN Host driver"
392         default n
393         depends on DRIVERS_HDF_WIFI
394         help
395           Answer Y to enable XXX Host driver. Support chip xxx
396     ```
397
398     接着修改文件`//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Kconfig`，在文件末尾加入如下代码将配置菜单加入内核中，如：
399
400
401     ```
402     source "../../../../../device/MySoCVendor/peripheral/Kconfig"
403     ```
404
405   - 创建构建脚本
406
407     在`//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Makefile`文件末尾增加配置，模板如下：
408
409
410     ```
411     HDF_DEVICE_ROOT := $(HDF_DIR_PREFIX)/../device
412     obj-$(CONFIG_DRIVERS_WLAN_XXX) += $(HDF_DEVICE_ROOT)/MySoCVendor/peripheral/build/standard/
413     ```
414
415     当在内核中开启DRIVERS_WLAN_XXX开关时，会调用`//device/MySoCVendor/peripheral/build/standard/`中的makefile。更多详细的开发手册，请参考[WLAN开发](../guide/device-wlan-led-control.md)。
416
417
418### 开发移植示例
419
420开发移植示例请参考[DAYU开发板](https://gitee.com/openharmony-sig/devboard_device_hihope_build/blob/master/DAYU%20%E5%B9%B3%E5%8F%B0OpenHarmony%20%E9%80%82%E9%85%8D%E6%8C%87%E5%AF%BC%20-202108.pdf)。
421