Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 deb6d2ea 编写于 作者: L liyan 提交者： Gitee
浏览文件
操作

update zh-cn/device-dev/porting/standard-system-porting-guide.md. 

Signed-off-by: Nli-yan339 <liyan339@h-partners.com>
Signed-off-by: Nliyan <liyan339@h-partners.com>
上级 5aed7da9
显示空白变更内容
内联 并排
Showing with 209 addition and 214 deletion
zh-cn/device-dev/porting/standard-system-porting-guide.md
浏览文件 @ deb6d2ea
......@@ -11,7 +11,7 @@
### 定义产品
在“//vendor/MyProductVendor/{product_name}名称的目录下创建一个config.json文件，该文件用于描述产品所使用的SOC 以及所需的子系统。配置如下：
在`//vendor/MyProductVendor/{product_name}`名称的目录下创建一个`config.json`文件，该文件用于描述产品所使用的SOC以及所需的子系统。配置如下：
//vendor/MyProductVendor/MyProduct/config.json
......@@ -41,34 +41,25 @@
```
主要的配置内容
product_name：产品名称 必填
| 配置项 | 说明 |
|-------|----------|
|product_name |（必填）产品名称|
|version|（必填）版本 |
|type|（必填）配置的系统级别，包含（small、standard等) |
|target_cpu |（必填）设备的CPU类型（根据实际情况，这里的target_cpu也可能是arm64 、riscv、 x86等）|
|ohos_version|（选填）操作系统版本|
|device_company|（必填）device厂商名|
|board|（必填）开发板名称|
|enable_ramdisk|（必填）是否启动ramdisk|
|kernel_type|（选填）内核类型|
|kernel_version|（选填）kernel_type与kernel_version在standard是固定的不需要写|
|subsystems|（必填）系统需要启用的子系统。子系统可以简单理解为一块独立构建的功能块。|
|product_company|不体现在配置中，而是目录名，vendor下一级目录就是product_company，BUILD.gn脚本依然可以访问。|
version：版本 必填
type：配置的系统级别，包含（small，standard …) 必填
已定义的子系统可以在`//build/subsystem_config.json`中找到。当然你也可以定制子系统。
target_cpu ：设备的CPU类型（根据实际情况，这里的target_cpu也可能是arm64 、riscv、 x86等。） 必填
ohos_version：操作系统版本 选填
device_company：device厂商名 必填
board：开发板名称 必填
enable_ramdisk：是否启动ramdisk 必填
kernel_type 选填
kernel_version 选填 kernel_type与 kernel_version在 standard 是固定的不需要写。
subsystems:系统需要启用的子系统。子系统可以简单理解为一块独立构建的功能块。必填
product_company：不体现在配置中，而是目录名，vendor下一级目录就是product_company，BUILD.gn脚本依然可以访问。
已定义的子系统可以在“//build/subsystem_config.json”中找到。当然你也可以定制子系统。
这里建议先拷贝Hi3516DV300 开发板的配置文件，删除掉 hisilicon_products 这个子系统。这个子系统为Hi3516DV300 SOC编译内核，显然不适合MySOC。
这里建议先拷贝Hi3516DV300开发板的配置文件，删除掉hisilicon_products这个子系统。这个子系统为Hi3516DV300 SOC编译内核，显然不适合MySOC。
### 移植验证
......@@ -79,7 +70,7 @@ product_company：不体现在配置中，而是目录名，vendor下一级目
./build.sh --product-name MyProduct
```
构建完成后，可以在“//out/{device_name}/packages/phone/images”目录下看到构建出来的OpenHarmony镜像文件。
构建完成后，可以在`//out/{device_name}/packages/phone/images`目录下看到构建出来的OpenHarmony镜像文件。
## 内核移植
......@@ -89,7 +80,7 @@ product_company：不体现在配置中，而是目录名，vendor下一级目
### 为SOC添加内核构建的子系统
修改文件 //build/subsystem_config.json增加一个子系统. 配置如下：
修改文件`//build/subsystem_config.json`增加一个子系统. 配置如下：
```
......@@ -101,12 +92,12 @@ product_company：不体现在配置中，而是目录名，vendor下一级目
},
```
接着需要修改定义产品的配置文件//vendor/MyProductVendor/MyProduct/config.json，将刚刚定义的子系统加入到产品中。
接着需要修改定义产品的配置文件`//vendor/MyProductVendor/MyProduct/config.json`，将刚刚定义的子系统加入到产品中。
### 编译内核
源码中提供了Linux 4.19的内核，归档在//kernel/linux-4.19。本节以该内核版本为例，讲解如何编译内核。
源码中提供了Linux 4.19的内核，归档在`//kernel/linux-4.19`。本节以该内核版本为例，讲解如何编译内核。
在子系统的定义中，描述了子系统构建的路径path，即`//device/MySOCVendor/MySOC/build`。这一节会在这个目录创建构建脚本，告诉构建系统如何构建内核。
......@@ -126,9 +117,8 @@ BUILD.gn是subsystem构建的唯一入口。
期望的构建结果
| | |
| -------- | -------- |
| 文件 | 文件说明 |
| -------- | -------- |
| $root_build_dir/packages/phone/images/uImage | 内核镜像 |
| $root_build_dir/packages/phone/images/uboot | bootloader镜像 |
......@@ -156,13 +146,13 @@ BUILD.gn是subsystem构建的唯一入口。
2. init。
init启动引导组件配置文件包含了所有需要由init进程启动的系统关键服务的服务名、可执行文件路径、权限和其他信息。每个系统服务各自安装其启动脚本到/system/etc/init目录下。
init启动引导组件配置文件包含了所有需要由init进程启动的系统关键服务的服务名、可执行文件路径、权限和其他信息。每个系统服务各自安装其启动脚本到`/system/etc/init`目录下。
新芯片平台移植时，平台相关的初始化配置需要增加平台相关的初始化配置文件/vendor/etc/init/init.{hardware}.cfg；该文件完成平台相关的初始化设置，如安装ko驱动，设置平台相关的/proc节点信息。
新芯片平台移植时，平台相关的初始化配置需要增加平台相关的初始化配置文件`/vendor/etc/init/init.{hardware}.cfg`；该文件完成平台相关的初始化设置，如安装ko驱动，设置平台相关的`/proc`节点信息。
init相关进程代码在//base/startup/init_lite目录下，该进程是系统第一个进程，无其它依赖。
init相关进程代码在`//base/startup/init_lite`目录下，该进程是系统第一个进程，无其它依赖。
初始化配置文件具体的开发指导请参考 [init启动子系统概述](../subsystems/subsys-boot-overview.md)。
初始化配置文件具体的开发指导请参考[init启动子系统概述](../subsystems/subsys-boot-overview.md)。
## HDF驱动移植
......@@ -172,16 +162,16 @@ BUILD.gn是subsystem构建的唯一入口。
HDF为LCD设计了驱动模型。支持一块新的LCD，需要编写一个驱动，在驱动中生成模型的实例，并完成注册。
这些LCD的驱动被放置在//drivers/hdf_core/framework/model/display/driver/panel目录中。
这些LCD的驱动被放置在`//drivers/hdf_core/framework/model/display/driver/panel`目录中。
- 创建Panel驱动
1. 创建Panel驱动
在驱动的Init方法中，需要调用RegisterPanel接口注册模型实例。如:
在驱动的Init方法中，需要调用RegisterPanel接口注册模型实例。如:
```
int32_t XXXInit(struct HdfDeviceObject *object)
{
```
int32_t XXXInit(struct HdfDeviceObject *object)
{
struct PanelData *panel = CreateYourPanel();
// 注册
......@@ -190,21 +180,23 @@ int32_t XXXInit(struct HdfDeviceObject *object)
return HDF_FAILURE;
}
return HDF_SUCCESS;
}
}
struct HdfDriverEntry g_xxxxDevEntry = {
struct HdfDriverEntry g_xxxxDevEntry = {
.moduleVersion = 1,
.moduleName = "LCD_XXXX",
.Init = XXXInit,
};
};
HDF_INIT(g_xxxxDevEntry);
```
HDF_INIT(g_xxxxDevEntry);
```
- 配置加载panel驱动产品的所有设备信息被定义在文件//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs中。修改该文件，在display的host中，名为device_lcd的device中增加配置。注意：moduleName 要与panel驱动中的moduleName相同。
2. 配置加载panel驱动产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在display的host中，名为device_lcd的device中增加配置。
```
root {
注意：moduleName 要与panel驱动中的moduleName相同。
```
root {
...
display :: host {
device_lcd :: device {
......@@ -216,60 +208,62 @@ root {
}
}
}
}
```
}
```
更详细的驱动开发指导，请参考 [LCD](../driver/driver-peripherals-lcd-des.md)。
更详细的驱动开发指导，请参考[LCD](../driver/driver-peripherals-lcd-des.md)。
### 触摸屏
本节描述如何移植触摸屏驱动。触摸屏的驱动被放置在//drivers/hdf_core/framework/model/input/driver/touchscreen目录中。移植触摸屏驱动主要工作是向系统注册ChipDevice模型实例。
本节描述如何移植触摸屏驱动。触摸屏的驱动被放置在`//drivers/hdf_core/framework/model/input/driver/touchscreen`目录中。移植触摸屏驱动主要工作是向系统注册ChipDevice模型实例。
- 创建触摸屏器件驱动
1. 创建触摸屏器件驱动
在目录中创建名为touch_ic_name.c的文件。代码模板如下：注意：请替换ic_name为你所适配芯片的名称。
在目录中创建名为`touch_ic_name.c`的文件。代码模板如下：
注意：请替换ic_name为你所适配芯片的名称。
```
#include "hdf_touch.h"
static int32_t HdfXXXXChipInit(struct HdfDeviceObject *device)
{
```
#include "hdf_touch.h"
static int32_t HdfXXXXChipInit(struct HdfDeviceObject *device)
{
ChipDevice *tpImpl = CreateXXXXTpImpl();
if(RegisterChipDevice(tpImpl) != HDF_SUCCESS) {
ReleaseXXXXTpImpl(tpImpl);
return HDF_FAILURE;
}
return HDF_SUCCESS;
}
}
struct HdfDriverEntry g_touchXXXXChipEntry = {
struct HdfDriverEntry g_touchXXXXChipEntry = {
.moduleVersion = 1,
.moduleName = "HDF_TOUCH_XXXX",
.Init = HdfXXXXChipInit,
};
};
HDF_INIT(g_touchXXXXChipEntry);
```
HDF_INIT(g_touchXXXXChipEntry);
```
其中ChipDevice中要提供若干方法。
其中ChipDevice中要提供若干方法。
| | |
| -------- | -------- |
| 方法 | 实现说明 |
| int32_t&nbsp;(\*Init)(ChipDevice&nbsp;\*device) | 器件初始化 |
| int32_t&nbsp;(\*Detect)(ChipDevice&nbsp;\*device) | 器件探测 |
| int32_t&nbsp;(\*Suspend)(ChipDevice&nbsp;\*device) | 器件休眠 |
| int32_t&nbsp;(\*Resume)(ChipDevice&nbsp;\*device) | 器件唤醒 |
| int32_t&nbsp;(\*DataHandle)(ChipDevice&nbsp;\*device) | 从器件读取数据，将触摸点数据填写入device-&gt;driver-&gt;frameData中 |
| int32_t&nbsp;(\*UpdateFirmware)(ChipDevice&nbsp;\*device) | 固件升级 |
| 方法 | 实现说明 |
| -------- | -------- |
| int32_t&nbsp;(\*Init)(ChipDevice&nbsp;\*device) | 器件初始化 |
| int32_t&nbsp;(\*Detect)(ChipDevice&nbsp;\*device) | 器件探测 |
| int32_t&nbsp;(\*Suspend)(ChipDevice&nbsp;\*device) | 器件休眠 |
| int32_t&nbsp;(\*Resume)(ChipDevice&nbsp;\*device) | 器件唤醒 |
| int32_t&nbsp;(\*DataHandle)(ChipDevice&nbsp;\*device) | 从器件读取数据，将触摸点数据填写入device-&gt;driver-&gt;frameData中 |
| int32_t&nbsp;(\*UpdateFirmware)(ChipDevice&nbsp;\*device) | 固件升级 |
- 配置产品，加载器件驱动
产品的所有设备信息被定义在文件//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs中。修改该文件，在名为input的host中，名为device_touch_chip的device中增加配置。注意：moduleName 要与触摸屏驱动中的moduleName相同。
2. 配置产品，加载器件驱动
产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在名为input的host中，名为device_touch_chip的device中增加配置。注意：moduleName 要与触摸屏驱动中的moduleName相同。
```
```
deviceN :: deviceNode {
policy = 0;
priority = 130;
......@@ -278,9 +272,9 @@ HDF_INIT(g_touchXXXXChipEntry);
moduleName = "HDF_TOUCH_XXXX";
deviceMatchAttr = "touch_XXXX_configs";
}
```
```
更详细的驱动开发指导，请参考 [TOUCHSCREEN](../driver/driver-peripherals-touch-des.md)。
更详细的驱动开发指导，请参考[TOUCHSCREEN](../driver/driver-peripherals-touch-des.md)。
### WLAN
......@@ -293,20 +287,20 @@ Wi-Fi驱动分为两部分，一部分负责管理WLAN设备，另一个部分
支持一款芯片的主要工作是实现一个ChipDriver驱动。实现HDF_WLAN_CORE和NetDevice提供的接口。主要需要实现的接口有:
| | | |
| -------- | -------- | -------- |
| 接口 | 定义头文件 | 说明 |
| -------- | -------- | -------- |
| HdfChipDriverFactory | //drivers/hdf_core/framework/include/wifi/hdf_wlan_chipdriver_manager.h | ChipDriver的Factory，用于支持一个芯片多个Wi-Fi端口 |
| HdfChipDriver | //drivers/hdf_core/framework/include/wifi/wifi_module.h | 每个WLAN端口对应一个HdfChipDriver，用来管理一个特定的WLAN端口 |
| NetDeviceInterFace | //drivers/hdf_core/framework/include/net/net_device.h | 与协议栈之间的接口，如发送数据、设置网络接口状态等 |
建议适配按如下步骤操作：
1.创建HDF驱动建议将代码放置在//device/MySoCVendor/peripheral/wifi/chip_name/，文件模板如下：
1. 创建HDF驱动建议将代码放置在`//device/MySoCVendor/peripheral/wifi/chip_name/`，文件模板如下：
```
static int32_t HdfWlanXXXChipDriverInit(struct HdfDeviceObject *device) {
```
static int32_t HdfWlanXXXChipDriverInit(struct HdfDeviceObject *device) {
static struct HdfChipDriverFactory factory = CreateChipDriverFactory();
struct HdfChipDriverManager *driverMgr = HdfWlanGetChipDriverMgr();
if (driverMgr->RegChipDriver(&factory) != HDF_SUCCESS) {
......@@ -314,53 +308,51 @@ static int32_t HdfWlanXXXChipDriverInit(struct HdfDeviceObject *device) {
return HDF_FAILURE;
}
return HDF_SUCCESS;
}
}
struct HdfDriverEntry g_hdfXXXChipEntry = {
struct HdfDriverEntry g_hdfXXXChipEntry = {
.moduleVersion = 1,
.Init = HdfWlanXXXChipDriverInit,
.Release = HdfWlanXXXChipRelease,
.moduleName = "HDF_WIFI_CHIP_XXX"
};
};
HDF_INIT(g_hdfXXXChipEntry);
```
HDF_INIT(g_hdfXXXChipEntry);
```
在CreateChipDriverFactory中，需要创建一个HdfChipDriverFactory，接口如下：
在CreateChipDriverFactory中，需要创建一个HdfChipDriverFactory，接口如下：
| | |
| -------- | -------- |
| 接口 | 说明 |
| const&nbsp;char&nbsp;\*driverName | 当前driverName |
| int32_t&nbsp;(\*InitChip)(struct&nbsp;HdfWlanDevice&nbsp;\*device) | 初始化芯片 |
| int32_t&nbsp;(\*DeinitChip)(struct&nbsp;HdfWlanDevice&nbsp;\*device) | 去初始化芯片 |
| void&nbsp;(_ReleaseFactory)(struct&nbsp;HdfChipDriverFactory&nbsp;_factory) | 释放HdfChipDriverFactory对象 |
| struct&nbsp;HdfChipDriver&nbsp;_(_Build)(struct&nbsp;HdfWlanDevice&nbsp;\*device,&nbsp;uint8_t&nbsp;ifIndex) | 创建一个HdfChipDriver；输入参数中，device是设备信息，ifIndex是当前创建的接口在这个芯片中的序号 |
| void&nbsp;(_Release)(struct&nbsp;HdfChipDriver&nbsp;_chipDriver) | 释放chipDriver |
| uint8_t&nbsp;(\*GetMaxIFCount)(struct&nbsp;HdfChipDriverFactory&nbsp;\*factory) | 获取当前芯片支持的最大接口数 |
HdfChipDriver需要实现的接口有
| | |
| -------- | -------- |
| 接口 | 说明 |
| int32_t&nbsp;(\*init)(struct&nbsp;HdfChipDriver&nbsp;\*chipDriver,&nbsp;NetDevice&nbsp;\*netDev) | 初始化当前网络接口，这里需要向netDev提供接口NetDeviceInterFace |
| int32_t&nbsp;(\*deinit)(struct&nbsp;HdfChipDriver&nbsp;\*chipDriver,&nbsp;NetDevice&nbsp;\*netDev) | 去初始化当前网络接口 |
| struct&nbsp;HdfMac80211BaseOps&nbsp;\*ops | WLAN基础能力接口集 |
| struct&nbsp;HdfMac80211STAOps&nbsp;\*staOps | 支持STA模式所需的接口集 |
| struct&nbsp;HdfMac80211APOps&nbsp;\*apOps | 支持AP模式所需要的接口集 |
| 接口 | 说明 |
| -------- | -------- |
| const&nbsp;char&nbsp;\*driverName | 当前driverName |
| int32_t&nbsp;(\*InitChip)(struct&nbsp;HdfWlanDevice&nbsp;\*device) | 初始化芯片 |
| int32_t&nbsp;(\*DeinitChip)(struct&nbsp;HdfWlanDevice&nbsp;\*device) | 去初始化芯片 |
| void&nbsp;(_ReleaseFactory)(struct&nbsp;HdfChipDriverFactory&nbsp;_factory) | 释放HdfChipDriverFactory对象 |
| struct&nbsp;HdfChipDriver&nbsp;_(_Build)(struct&nbsp;HdfWlanDevice&nbsp;\*device,&nbsp;uint8_t&nbsp;ifIndex) | 创建一个HdfChipDriver；输入参数中，device是设备信息，ifIndex是当前创建的接口在这个芯片中的序号 |
| void&nbsp;(_Release)(struct&nbsp;HdfChipDriver&nbsp;_chipDriver) | 释放chipDriver |
| uint8_t&nbsp;(\*GetMaxIFCount)(struct&nbsp;HdfChipDriverFactory&nbsp;\*factory) | 获取当前芯片支持的最大接口数 |
2.编写配置文件，描述驱动支持的设备
HdfChipDriver需要实现的接口有：
在产品配置目录下创建芯片的配置文件//vendor/MyProductVendor/MyProduct/config/wifi/wlan_chip_chip_name.hcs。
| 接口 | 说明 |
| -------- | -------- |
| int32_t&nbsp;(\*init)(struct&nbsp;HdfChipDriver&nbsp;\*chipDriver,&nbsp;NetDevice&nbsp;\*netDev) | 初始化当前网络接口，这里需要向netDev提供接口NetDeviceInterFace |
| int32_t&nbsp;(\*deinit)(struct&nbsp;HdfChipDriver&nbsp;\*chipDriver,&nbsp;NetDevice&nbsp;\*netDev) | 去初始化当前网络接口 |
| struct&nbsp;HdfMac80211BaseOps&nbsp;\*ops | WLAN基础能力接口集 |
| struct&nbsp;HdfMac80211STAOps&nbsp;\*staOps | 支持STA模式所需的接口集 |
| struct&nbsp;HdfMac80211APOps&nbsp;\*apOps | 支持AP模式所需要的接口集 |
注意： 路径中的vendor_name、product_name、chip_name请替换成实际名称。
2. 编写配置文件，描述驱动支持的设备。
模板如下：
在产品配置目录下创建芯片的配置文件`//vendor/MyProductVendor/MyProduct/config/wifi/wlan_chip_chip_name.hcs`。
注意： 路径中的vendor_name、product_name、chip_name请替换成实际名称。
```
root {
模板如下：
```
root {
wlan_config {
chip_name :& chipList {
chip_name :: chipInst {
......@@ -373,15 +365,17 @@ root {
}
}
}
}
```
}
```
3.编写配置文件，加载驱动
3. 编写配置文件，加载驱动。
产品的所有设备信息被定义在文件//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs中。修改该文件，在名为network的host中，名为device_wlan_chips的device中增加配置。注意：moduleName 要与触摸屏驱动中的moduleName相同。
产品的所有设备信息被定义在文件`//vendor/MyProductVendor/MyProduct/config/device_info/device_info.hcs`中。修改该文件，在名为network的host中，名为device_wlan_chips的device中增加配置。
注意：moduleName 要与触摸屏驱动中的moduleName相同。
```
```
deviceN :: deviceNode {
policy = 0;
preload = 2;
......@@ -389,39 +383,40 @@ root {
deviceMatchAttr = "hdf_wlan_chips_chip_name";
serviceName = "driverName";
}
```
```
4.构建驱动
4. 构建驱动
- 创建内核菜单在//device/MySoCVendor/peripheral目录中创建Kconfig文件，内容模板如下：
- 创建内核菜单在`//device/MySoCVendor/peripheral`目录中创建Kconfig文件，内容模板如下：
```
config DRIVERS_WLAN_XXX
```
config DRIVERS_WLAN_XXX
bool "Enable XXX WLAN Host driver"
default n
depends on DRIVERS_HDF_WIFI
help
Answer Y to enable XXX Host driver. Support chip xxx
```
```
接着修改文件//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Kconfig,在文件末尾加入如下代码将配置菜单加入内核中，如：
接着修改文件`//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Kconfig`，在文件末尾加入如下代码将配置菜单加入内核中，如：
```
source "../../../../../device/MySoCVendor/peripheral/Kconfig"
```
```
source "../../../../../device/MySoCVendor/peripheral/Kconfig"
```
- 创建构建脚本
在//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Makefile文件末尾增加配置，模板如下：
- 创建构建脚本
在`//drivers/hdf_core/adapter/khdf/linux/model/network/wifi/Makefile`文件末尾增加配置，模板如下：
```
HDF_DEVICE_ROOT := $(HDF_DIR_PREFIX)/../device
obj-$(CONFIG_DRIVERS_WLAN_XXX) += $(HDF_DEVICE_ROOT)/MySoCVendor/peripheral/build/standard/
```
当在内核中开启DRIVERS_WLAN_XXX开关时，会调用//device/MySoCVendor/peripheral/build/standard/中的makefile。更多详细的开发手册，请参考[WLAN开发](../guide/device-wlan-led-control.md)。
```
HDF_DEVICE_ROOT := $(HDF_DIR_PREFIX)/../device
obj-$(CONFIG_DRIVERS_WLAN_XXX) += $(HDF_DEVICE_ROOT)/MySoCVendor/peripheral/build/standard/
```
当在内核中开启DRIVERS_WLAN_XXX开关时，会调用`//device/MySoCVendor/peripheral/build/standard/`中的makefile。更多详细的开发手册，请参考[WLAN开发](../guide/device-wlan-led-control.md)。
### 开发移植示例
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或