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