Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

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

资料规范性检查 

Signed-off-by: Nli-yan339 <liyan339@h-partners.com>
上级 840eaabd
显示空白变更内容
内联 并排
Showing with 51 addition and 42 deletion
zh-cn/device-dev/driver/driver-platform-pwm-develop.md
浏览文件 @ cbec4dda
......@@ -27,30 +27,31 @@ struct PwmMethod {
| 成员函数 | 入参 | 返回值 | 功能 |
| -------- | -------- | -------- | -------- |
| setConfig | -**pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器<br/>-**config**:&nbsp;&nbsp;结构体指针，属性传入值 | HDF_STATUS相关状态 | 配置属性 |
| open | **pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 打开设备 |
| close | **pwm**:&nbsp;&nbsp;结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 关闭设备 |
| setConfig | pwm：结构体指针，核心层PWM控制器<br/>config：结构体指针，属性传入值 | HDF_STATUS相关状态 | 配置属性 |
| open | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 打开设备 |
| close | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 关闭设备 |
## 开发步骤
PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动入口，以及填充核心层接口函数。
PWM模块适配HDF框架的三个必选环节是实例化驱动入口，配置属性文件，以及填充核心层接口函数。
1. **实例化驱动入口：**
1. 实例化驱动入口
- 实例化HdfDriverEntry结构体成员。
- 调用HDF_INIT将HdfDriverEntry实例化对象注册到HDF框架中。
2. **配置属性文件：**
2. 配置属性文件
- 在device_info.hcs文件中添加deviceNode描述。
- 【可选】添加pwm_config.hcs器件属性文件。
3. **实例化PWM控制器对象：**
3. 实例化PWM控制器对象
- 初始化PwmDev成员。
- 实例化PwmDev成员PwmMethod。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**<br>
> 实例化PwmDev成员PwmMethod，其定义和成员说明见[接口说明](#接口说明)。
4. **驱动调试：**
4. 驱动调试
【可选】针对新增驱动程序，建议验证驱动基本功能，例如PWM控制状态，中断响应情况等。
......@@ -58,7 +59,11 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
下方将以pwm_hi35xx.c为示例，展示需要厂商提供哪些内容来完整实现设备功能。
1. 驱动开发首先需要实例化驱动入口，驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
1. 驱动开发首先需要实例化驱动入口。
驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。
HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。
一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。
......@@ -67,7 +72,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
```
struct HdfDriverEntry g_hdfPwm = {
.moduleVersion = 1,
.moduleName = "HDF_PLATFORM_PWM",// 【必要，且与HCS文件中里面的moduleName匹配】
.moduleName = "HDF_PLATFORM_PWM",// 【必要且与HCS文件中里面的moduleName匹配】
.Bind = HdfPwmBind,
.Init = HdfPwmInit,
.Release = HdfPwmRelease,
......@@ -76,7 +81,10 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
HDF_INIT(g_hdfPwm);
```
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在 pwm_config.hcs 中配置器件属性。deviceNode信息与驱动入口注册相关，器件属性值与核心层PwmDev成员的默认值或限制范围有密切关系。如有更多个器件信息，则需要在device_info文件增加deviceNode信息，以及在pwm_config文件中增加对应的器件属性。
2. 完成驱动入口注册之后，下一步请在device_info.hcs文件中添加deviceNode信息，并在pwm_config.hcs中配置器件属性。
deviceNode信息与驱动入口注册相关，器件属性值与核心层PwmDev成员的默认值或限制范围有密切关系。如有更多个器件信息，则需要在device_info文件增加deviceNode信息，以及在pwm_config文件中增加对应的器件属性。
- device_info.hcs配置参考
......@@ -86,15 +94,15 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
platform :: host {
hostName = "platform_host";
priority = 50;
device_pwm :: device {// 为每一个pwm控制器配置一个HDF设备节点
device_pwm :: device { // 为每一个pwm控制器配置一个HDF设备节点
device0 :: deviceNode {
policy = 1; // 等于1，向内核态发布服务
policy = 1; // 等于1，向内核态发布服务。
priority = 80; // 驱动启动优先级
permission = 0644;// 驱动创建设备节点权限
moduleName = "HDF_PLATFORM_PWM"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；
serviceName = "HDF_PLATFORM_PWM_0";// 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_pwm_0";// 【必要】用于配置控制器私有数据，要与 pwm_config.hcs 中对应
// 控制器保持一致，具体的控制器信息在 pwm_config.hcs 中
permission = 0644; // 驱动创建设备节点权限
moduleName = "HDF_PLATFORM_PWM"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致。
serviceName = "HDF_PLATFORM_PWM_0"; // 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_pwm_0";// 【必要】用于配置控制器私有数据，要与pwm_config.hcs中对应
// 控制器保持一致，具体的控制器信息在pwm_config.hcs中。
}
device1 :: deviceNode {
policy = 1;
......@@ -135,30 +143,31 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
}
```
3. 完成驱动入口注册之后，最后一步就是以核心层PwmDev对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化PwmDev成员PwmMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。
3. 完成驱动入口注册之后，下一步就是以核心层PwmDev对象的初始化为核心，包括厂商自定义结构体（传递参数和数据），实例化PwmDev成员PwmMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。
- 自定义结构体参考。
从驱动的角度看，自定义结构体是参数和数据的载体，而且pwm_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。
从驱动的角度看，自定义结构体是参数和数据的载体，而且pwm_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如设备号等。
```
struct HiPwm {
struct PwmDev dev; // 【必要】 核心层结构体
volatile unsigned char *base;
struct HiPwmRegs *reg; // 设备属性结构体，可自定义
struct HiPwmRegs *reg; // 设备属性结构体，可自定义。
bool supportPolarity;
};
// PwmDev是核心层控制器结构体，其中的成员在Init函数中会被赋值
// PwmDev是核心层控制器结构体，其中的成员在Init函数中会被赋值。
struct PwmDev {
struct IDeviceIoService service;
struct HdfDeviceObject *device;
struct PwmConfig cfg; // 属性结构体，相关定义见下
struct PwmConfig cfg; // 属性结构体，相关定义见下。
struct PwmMethod *method; // 钩子函数模板
bool busy;
uint32_t num; // 设备号
OsalSpinlock lock;
void *priv; // 私有数据，一般存储自定义结构体首地址，方便调用
void *priv; // 私有数据，一般存储自定义结构体首地址，方便调用。
};
struct PwmConfig {
uint32_t duty; // 占空时间 nanoseconds
......@@ -189,11 +198,11 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
入参：
HdfDeviceObject 是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
HdfDeviceObject是整个驱动对外暴露的接口参数，具备HCS配置文件的信息。
返回值：
HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS 定义）。
HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/framework/include/utils/hdf_base.h中HDF_STATUS定义）。
| 状态(值) | 问题描述 |
| -------- | -------- |
......@@ -210,7 +219,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
```
// 此处bind函数为空函数，可与init函数结合，也可根据厂商需要实现相关操作
// 此处Bind函数为空函数，可与Init函数结合，也可根据厂商需要实现相关操作。
static int32_t HdfPwmBind(struct HdfDeviceObject *obj)
{
(void)obj;
......@@ -246,7 +255,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
hp->dev.cfg.status = PWM_DISABLE_STATUS; // 初始化PwmDev
hp->dev.cfg.number = 0; // 初始化PwmDev
hp->dev.busy = false; // 初始化PwmDev
if (PwmDeviceAdd(obj, &(hp->dev)) != HDF_SUCCESS) {// 【重要】调用核心层函数，初始化hp->dev 的设备和服务
if (PwmDeviceAdd(obj, &(hp->dev)) != HDF_SUCCESS) { // 【重要】调用核心层函数，初始化hp->dev的设备和服务。
OsalIoUnmap((void *)hp->base);
return HDF_FAILURE;
}
......@@ -265,7 +274,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
函数说明：
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口， 当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
```
......@@ -275,7 +284,7 @@ PWM模块适配HDF框架的三个环节是配置属性文件，实例化驱动
...
hp = (struct HiPwm *)obj->service;// 这里有HdfDeviceObject到HiPwm的强制转化
...
PwmDeviceRemove(obj, &(hp->dev));// 【必要】调用核心层函数，释放PwmDev的设备和服务,这里有HiPwm到PwmDev的强制转化
PwmDeviceRemove(obj, &(hp->dev)); // 【必要】调用核心层函数，释放PwmDev的设备和服务，这里有HiPwm到PwmDev的强制转化。
HiPwmRemove(hp); // 释放HiPwm
}
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或