Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 24f6182f 编写于 作者: K king_he 提交者： Gitee
浏览文件
操作

update zh-cn/device-dev/driver/driver-platform-regulator-develop.md. 

Signed-off-by: Nking_he <6384784@qq.com>
上级 09e2840a
隐藏空白更改
内联 并排
Showing with 35 addition and 39 deletion
zh-cn/device-dev/driver/driver-platform-regulator-develop.md
浏览文件 @ 24f6182f
......@@ -5,10 +5,6 @@
### 功能简介
Regulator模块用于控制系统中某些设备的电压/电流供应。
### 基本概念
Regulator模块用于控制系统中某些设备的电压/电流供应。在嵌入式系统（尤其是手机）中，控制耗电量很重要，直接影响到电池的续航时间。所以，如果系统中某一个模块暂时不需要使用，就可以通过Regulator关闭其电源供应；或者降低提供给该模块的电压、电流大小。
### 运作机制
......@@ -17,7 +13,7 @@ Regulator模块用于控制系统中某些设备的电压/电流供应。在嵌
Regulator模块各分层的作用为：接口层提供打开设备，写入数据，关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
![](../public_sys-resources/icon-note.gif) 说明：核心层可以调用接口层的函数，也可以通过钩子函数调用适配层函数，从而使得适配层间接的可以调用接口层函数，但是不可逆转接口层调用适配层函数。
![](../public_sys-resources/icon-note.gif) 说明：<br>核心层可以调用接口层的函数，也可以通过钩子函数调用适配层函数，从而使得适配层间接的可以调用接口层函数，但是不可逆转接口层调用适配层函数。
**图 1** 统一服务模式结构图
......@@ -61,18 +57,18 @@ struct RegulatorMethod {
| 成员函数 | 入参 | 返回值 | 功能 |
| ------------ | ------------------------------------------------------------ | ------------------ | ---------------- |
| open | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 打开设备 |
| close | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 关闭设备 |
| release | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 释放设备句柄 |
| enable | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 使能 |
| disable | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 禁用 |
| forceDisable | **node**：结构体指针，核心层Regulator节点； | HDF_STATUS相关状态 | 强制禁用 |
| setVoltage | **node**：结构体指针，核心层Regulator节点；<br>**minUv**：uint32_t变量，最小电压；<br>**maxUv**：uint32_t变量，最大电压； | HDF_STATUS相关状态 | 设置输出电压范围 |
| getVoltage | **node**：结构体指针，核心层Regulator节点；<br>**voltage**：uint32_t指针，传出电压值； | HDF_STATUS相关状态 | 获取电压 |
| setCurrent | **node**：结构体指针，核心层Regulator节点；<br>**minUa**：uint32_t变量，最小电流；<br>**maxUa**：uint32_t变量，最大电流； | HDF_STATUS相关状态 | 设置输出电流范围 |
| getCurrent | **node**：结构体指针，核心层Regulator节点；<br>**regCurrent**：uint32_t指针，传出电流值； | HDF_STATUS相关状态 | 获取电流 |
| getStatus | **node**：结构体指针，核心层Regulator节点；<br>**status**：uint32_t指针，传出状态值； | HDF_STATUS相关状态 | 获取设备状态 |
| ------------ | ----------------------------------------------------------- | ----------------- | ---------------- |
| open | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 打开设备 |
| close | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 关闭设备 |
| release | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 释放设备句柄 |
| enable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 使能 |
| disable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 禁用 |
| forceDisable | **node**：结构体指针，核心层Regulator节点 | HDF_STATUS相关状态 | 强制禁用 |
| setVoltage | **node**：结构体指针，核心层Regulator节点<br>**minUv**：uint32_t变量，最小电压<br>**maxUv**：uint32_t变量，最大电压 | HDF_STATUS相关状态 | 设置输出电压范围 |
| getVoltage | **node**：结构体指针，核心层Regulator节点<br>**voltage**：uint32_t指针，传出电压值 | HDF_STATUS相关状态 | 获取电压 |
| setCurrent | **node**：结构体指针，核心层Regulator节点<br>**minUa**：uint32_t变量，最小电流<br>**maxUa**：uint32_t变量，最大电流 | HDF_STATUS相关状态 | 设置输出电流范围 |
| getCurrent | **node**：结构体指针，核心层Regulator节点<br>**regCurrent**：uint32_t指针，传出电流值 | HDF_STATUS相关状态 | 获取电流 |
| getStatus | **node**：结构体指针，核心层Regulator节点<br>**status**：uint32_t指针，传出状态值 | HDF_STATUS相关状态 | 获取设备状态 |
### 开发步骤
......@@ -92,11 +88,11 @@ Regulator模块适配包含以下四个步骤：
```
struct HdfDriverEntry g_regulatorDriverEntry = {
.moduleVersion = 1,
.moduleName = "virtual_regulator_driver",//【必要且与HCS文件中里面的moduleName匹配】
.moduleName = "virtual_regulator_driver",// 【必要且与HCS文件中里面的moduleName匹配】
.Init = VirtualRegulatorInit,
.Release = VirtualRegulatorRelease,
};
//调用HDF_INIT将驱动入口注册到HDF框架中
// 调用HDF_INIT将驱动入口注册到HDF框架中
HDF_INIT(g_regulatorDriverEntry);
```
......@@ -111,7 +107,7 @@ Regulator模块适配包含以下四个步骤：
| 成员名 | 值 |
| --------------- | ------------------------------------------------------------ |
| policy | 具体配置为0，不发布服务 |
| priority | 驱动启动优先级（0-200），值越大优先级越低,，优先级相同则不保证device的加载顺序。 |
| priority | 驱动启动优先级（0-200）。值越大优先级越低，优先级相同则不保证device的加载顺序 |
| permission | 驱动权限 |
| moduleName | 固定为HDF_PLATFORM_REGULATOR_MANAGER |
| serviceName | 固定为HDF_PLATFORM_REGULATOR_MANAGER |
......@@ -119,7 +115,7 @@ Regulator模块适配包含以下四个步骤：
从第二个节点开始配置具体Regulator控制器信息，此节点并不表示某一路Regulator控制器，而是代表一个资源性质设备，用于描述一类Regulator控制器的信息。本例只有一个Regulator设备，如有多个设备，则需要在device_info文件增加deviceNode信息，以及在regulator\_config文件中增加对应的器件属性。
- device_info.hcs 配置参考。
- device_info.hcs 配置参考
```
root {
......@@ -128,14 +124,14 @@ Regulator模块适配包含以下四个步骤：
hostName = "platform_host";
priority = 50;
device_regulator :: device {
device0 :: deviceNode { //为每一个Regulator控制器配置一个HDF设备节点，存在多个时添加，否则不用
device0 :: deviceNode { // 为每一个Regulator控制器配置一个HDF设备节点，存在多个时添加，否则不用
policy = 1; // 2:用户态可见,1:内核态可见,0:不需要发布服务
priority = 50; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
/*【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致；*/
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 */
moduleName = "HDF_PLATFORM_REGULATOR_MANAGER";
serviceName = "HDF_PLATFORM_REGULATOR_MANAGER"; //【必要且唯一】驱动对外发布服务的名称
/*【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs 中*/
/* 【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs中 */
deviceMatchAttr = "hdf_platform_regulator_manager";
}
device1 :: deviceNode {
......@@ -151,14 +147,14 @@ Regulator模块适配包含以下四个步骤：
}
```
- regulator\_config.hcs 配置参考。
- regulator\_config.hcs配置参考
```
root {
platform {
regulator_config {
match_attr = "linux_regulator_adapter";
template regulator_controller { //【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
template regulator_controller { // 【必要】模板配置，继承该模板的节点如果使用模板中的默认值，则节点字段可以缺省
device_num = 1;
name = "";
devName = "regulator_adapter_consumer01";
......@@ -180,7 +176,7 @@ Regulator模块适配包含以下四个步骤：
minUa = 0;
maxUa = 0;
}
/*每个Regulator控制器对应一个controller节点，如存在多个Regulator控制器，请依次添加对应的controller节点。*/
/* 每个Regulator控制器对应一个controller节点，如存在多个Regulator控制器，请依次添加对应的controller节点 */
controller_0x130d0001 :: regulator_controller {
device_num = 1;
name = "regulator_adapter_2";
......@@ -216,9 +212,9 @@ Regulator模块适配包含以下四个步骤：
};
struct RegulatorDesc {
const char *name; /* regulator 名称 */
const char *parentName; /* regulator 父节点名称 */
struct RegulatorConstraints constraints; /* regulator 约束信息 */
const char *name; /* regulator名称 */
const char *parentName; /* regulator父节点名称 */
struct RegulatorConstraints constraints; /* regulator约束信息 */
uint32_t minUv; /* 最小输出电压值 */
uint32_t maxUv; /* 最大输出电压值 */
uint32_t minUa; /* 最小输出电流值 */
......@@ -244,7 +240,7 @@ Regulator模块适配包含以下四个步骤：
- 实例化RegulatorNode成员RegulatorMethod，其他成员在Init函数中初始化。
```c
// regulator_virtual.c 中的示例：钩子函数的填充
// regulator_virtual.c中的示例：钩子函数的填充
static struct RegulatorMethod g_method = {
.enable = VirtualRegulatorEnable,
.disable = VirtualRegulatorDisable,
......@@ -270,7 +266,7 @@ Regulator模块适配包含以下四个步骤：
**表 2** HDF\_STATUS相关状态
| 状态(值) | 问题描述 |
| 状态(值) | 描述 |
| ---------------------- | -------------- |
| HDF_ERR_INVALID_OBJECT | 控制器对象非法 |
| HDF_ERR_MALLOC_FAIL | 内存分配失败 |
......@@ -291,7 +287,7 @@ Regulator模块适配包含以下四个步骤：
const struct DeviceResourceNode *childNode = NULL;
...
DEV_RES_NODE_FOR_EACH_CHILD_NODE(device->property, childNode) {
ret = VirtualRegulatorParseAndInit(device, childNode);//【必要】实现见下
ret = VirtualRegulatorParseAndInit(device, childNode);// 【必要】实现见下
...
}
...
......@@ -305,12 +301,12 @@ Regulator模块适配包含以下四个步骤：
regNode = (struct RegulatorNode *)OsalMemCalloc(sizeof(*regNode));//加载HCS文件
...
ret = VirtualRegulatorReadHcs(regNode, node);//读取HCS文件信息
ret = VirtualRegulatorReadHcs(regNode, node);// 读取HCS文件信息
...
regNode->priv = (void *)node; //实例化节点
regNode->ops = &g_method; //实例化ops
regNode->priv = (void *)node; // 实例化节点
regNode->ops = &g_method; // 实例化ops
ret = RegulatorNodeAdd(regNode); //挂载节点
ret = RegulatorNodeAdd(regNode); // 挂载节点
...
}
```
......@@ -327,13 +323,13 @@ Regulator模块适配包含以下四个步骤：
函数说明:
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数 初始化驱动失败时，可以调用Release释放驱动资源。
释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。
```c
static void VirtualRegulatorRelease(struct HdfDeviceObject *device)
{
...
RegulatorNodeRemoveAll();//【必要】调用核心层函数，释放RegulatorNode的设备和服务
RegulatorNodeRemoveAll();// 【必要】调用核心层函数，释放RegulatorNode的设备和服务
}
```
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或