未验证 提交 93bbc293 编写于 作者: K king_he 提交者: Gitee

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

Signed-off-by: Nking_he <6384784@qq.com>
上级 e9bfd639
...@@ -5,12 +5,12 @@ ...@@ -5,12 +5,12 @@
### 功能简介 ### 功能简介
- Regulator模块用于控制系统中某些设备的电压/电流供应。在嵌入式系统(尤其是手机)中,控制耗电量很重要,直接影响到电池的续航时间。所以,如果系统中某一个模块暂时不需要使用,就可以通过Regulator关闭其电源供应;或者降低提供给该模块的电压、电流大小。 Regulator模块用于控制系统中某些设备的电压/电流供应。在嵌入式系统(尤其是手机)中,控制耗电量很重要,直接影响到电池的续航时间。所以,如果系统中某一个模块暂时不需要使用,就可以通过Regulator关闭其电源供应;或者降低提供给该模块的电压、电流大小。
- Regulator接口定义了操作Regulator设备的通用方法集合,包括: Regulator接口定义了操作Regulator设备的通用方法集合,包括:
- Regulator设备句柄获取和销毁。 - Regulator设备句柄获取和销毁。
- Regulator设备电压、电流的设置。 - Regulator设备电压、电流的设置。
- Regulator设备使能和关闭。 - Regulator设备使能和关闭。
- Regulator设备电压、电流和状态的获取。 - Regulator设备电压、电流和状态的获取。
### 基本概念 ### 基本概念
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
Regulator模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。 Regulator模块各分层的作用为:接口层提供打开设备,写入数据,关闭设备接口的能力。核心层主要提供绑定设备、初始化设备以及释放设备的能力。适配层实现其他具体的功能。
![](../public_sys-resources/icon-note.gif) 说明:核心层可以调用接口层的函数,也可以通过钩子函数调用适配层函数,从而使得适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。 ![](../public_sys-resources/icon-note.gif) 说明:<br>核心层可以调用接口层的函数,也可以通过钩子函数调用适配层函数,从而使得适配层间接的可以调用接口层函数,但是不可逆转接口层调用适配层函数。
**图 1** 统一服务模式结构图 **图 1** 统一服务模式结构图
...@@ -45,7 +45,7 @@ Regulator模块各分层的作用为:接口层提供打开设备,写入数 ...@@ -45,7 +45,7 @@ Regulator模块各分层的作用为:接口层提供打开设备,写入数
### 约束与限制 ### 约束与限制
Regulator模块当前仅支持轻量和小型系统内核(LiteOS) Regulator模块当前仅支持轻量和小型系统内核(LiteOS)。
## 使用指导 ## 使用指导
...@@ -58,20 +58,20 @@ Regulator主要用于: ...@@ -58,20 +58,20 @@ Regulator主要用于:
### 接口说明 ### 接口说明
**表1** Regulator设备API功能介绍 **表1** Regulator设备API接口说明
| 接口名 | 描述 | | 接口名 | 描述 |
| --------------------- | ------------------------- | | --------------------- | ------------------------- |
| RegulatorOpen | 获取Regulator设备驱动句柄 | | RegulatorOpen | 获取Regulator设备驱动句柄 |
| RegulatorClose | 销毁Regulator设备驱动句柄 | | RegulatorClose | 销毁Regulator设备驱动句柄 |
| RegulatorEnable | 使能Regulator | | RegulatorEnable | 使能Regulator |
| RegulatorDisable | 禁用Regulator | | RegulatorDisable | 禁用Regulator |
| RegulatorForceDisable | 强制禁用Regulator | | RegulatorForceDisable | 强制禁用Regulator |
| RegulatorSetVoltage | 设置Regulator输出电压 | | RegulatorSetVoltage | 设置Regulator输出电压 |
| RegulatorGetVoltage | 获取Regulator输出电压 | | RegulatorGetVoltage | 获取Regulator输出电压 |
| RegulatorSetCurrent | 设置Regulator输出电流 | | RegulatorSetCurrent | 设置Regulator输出电流 |
| RegulatorGetCurrent | 获取Regulator输出电流 | | RegulatorGetCurrent | 获取Regulator输出电流 |
| RegulatorGetStatus | 获取Regulator状态 | | RegulatorGetStatus | 获取Regulator状态 |
...@@ -95,12 +95,12 @@ DevHandle RegulatorOpen(const char *name); ...@@ -95,12 +95,12 @@ DevHandle RegulatorOpen(const char *name);
**表2** RegulatorOpen参数和返回值描述 **表2** RegulatorOpen参数和返回值描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------------------- | | ---------- | ----------------------------- |
| name | Regulator设备名称 | | name | Regulator设备名称 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| handle | 获取成功返回Regulator设备句柄 | | handle | 获取成功返回Regulator设备句柄 |
| NULL | 获取失败 | | NULL | 获取失败 |
...@@ -126,7 +126,7 @@ void RegulatorClose(DevHandle handle); ...@@ -126,7 +126,7 @@ void RegulatorClose(DevHandle handle);
**表3** RegulatorClose参数描述 **表3** RegulatorClose参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ------ | ----------------- | | ------ | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
...@@ -145,22 +145,22 @@ int32_t RegulatorEnable(DevHandle handle); ...@@ -145,22 +145,22 @@ int32_t RegulatorEnable(DevHandle handle);
**表4** RegulatorEnable参数描述 **表4** RegulatorEnable参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 使能成功 | | 0 | 使能成功 |
| 负数 | 使能失败 | | 负数 | 使能失败 |
``` ```
int32_t ret; int32_t ret;
/*启用Regulator设备*/ /* 启用Regulator设备 */
ret = RegulatorEnable(handle); ret = RegulatorEnable(handle);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -174,20 +174,20 @@ int32_t RegulatorDisable(DevHandle handle); ...@@ -174,20 +174,20 @@ int32_t RegulatorDisable(DevHandle handle);
**表5** RegulatorDisable参数描述 **表5** RegulatorDisable参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 禁用成功 | | 0 | 禁用成功 |
| 负数 | 禁用失败 | | 负数 | 禁用失败 |
``` ```
int32_t ret; int32_t ret;
/*禁用Regulator设备*/ /* 禁用Regulator设备 */
ret = RegulatorDisable(handle); ret = RegulatorDisable(handle);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -202,20 +202,20 @@ int32_t RegulatorForceDisable(DevHandle handle); ...@@ -202,20 +202,20 @@ int32_t RegulatorForceDisable(DevHandle handle);
**表6** RegulatorForceDisable参数描述 **表6** RegulatorForceDisable参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 禁用成功 | | 0 | 禁用成功 |
| 负数 | 禁用失败 | | 负数 | 禁用失败 |
``` ```
int32_t ret; int32_t ret;
/*强制禁用Regulator设备*/ /* 强制禁用Regulator设备 */
ret = RegulatorForceDisable(handle); ret = RegulatorForceDisable(handle);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -229,24 +229,24 @@ int32_t RegulatorSetVoltage(DevHandle handle, uint32_t minUv, uint32_t maxUv); ...@@ -229,24 +229,24 @@ int32_t RegulatorSetVoltage(DevHandle handle, uint32_t minUv, uint32_t maxUv);
**表7** RegulatorSetVoltage参数描述 **表7** RegulatorSetVoltage参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| minUv | 最小电压 | | minUv | 最小电压 |
| maxUv | 最大电压 | | maxUv | 最大电压 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 设置成功 | | 0 | 设置成功 |
| 负数 | 设置失败 | | 负数 | 设置失败 |
``` ```
int32_t ret; int32_t ret;
int32_t minUv = 0; //最小电压为0µV int32_t minUv = 0; // 最小电压为0µV
int32_t maxUv = 20000; //最大电压为20000µV int32_t maxUv = 20000; // 最大电压为20000µV
/*设置Regulator电压输出电压范围*/ /*设置Regulator电压输出电压范围*/
ret = RegulatorSetVoltage(handle, minUv, maxUv); ret = RegulatorSetVoltage(handle, minUv, maxUv);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -261,13 +261,13 @@ int32_t RegulatorGetVoltage(DevHandle handle, uint32_t *voltage); ...@@ -261,13 +261,13 @@ int32_t RegulatorGetVoltage(DevHandle handle, uint32_t *voltage);
**表8** RegulatorGetVoltage参数描述 **表8** RegulatorGetVoltage参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| *voltage | 参数指针 | | *voltage | 参数指针 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 获取成功 | | 0 | 获取成功 |
| 负数 | 获取失败 | | 负数 | 获取失败 |
``` ```
int32_t ret; int32_t ret;
...@@ -290,24 +290,24 @@ int32_t RegulatorSetCurrent(DevHandle handle, uint32_t minUa, uint32_t maxUa); ...@@ -290,24 +290,24 @@ int32_t RegulatorSetCurrent(DevHandle handle, uint32_t minUa, uint32_t maxUa);
**表9** RegulatorSetCurrent参数描述 **表9** RegulatorSetCurrent参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| minUa | 最小电流 | | minUa | 最小电流 |
| maxUa | 最大电流 | | maxUa | 最大电流 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 设置成功 | | 0<br>| 设置成功 |
| 负数 | 设置失败 | | 负数 | 设置失败 |
``` ```
int32_t ret; int32_t ret;
int32_t minUa = 0; //最小电流为0μA int32_t minUa = 0; // 最小电流为0μA
int32_t maxUa = 200; //最大电流为200μA int32_t maxUa = 200; // 最大电流为200μA
/*设置Regulator输出电流范围*/ /* 设置Regulator输出电流范围 */
ret = RegulatorSetCurrent(handle, minUa, maxUa); ret = RegulatorSetCurrent(handle, minUa, maxUa);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -321,22 +321,22 @@ int32_t RegulatorGetCurrent(DevHandle handle, uint32_t *regCurrent); ...@@ -321,22 +321,22 @@ int32_t RegulatorGetCurrent(DevHandle handle, uint32_t *regCurrent);
**表10** RegulatorGetCurrent参数描述 **表10** RegulatorGetCurrent参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ----------- | ----------------- | | ----------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| *regCurrent | 参数指针 | | *regCurrent | 参数指针 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 获取成功 | | 0 | 获取成功 |
| 负数 | 获取失败 | | 负数 | 获取失败 |
``` ```
int32_t ret; int32_t ret;
uint32_t regCurrent; uint32_t regCurrent;
/*获取Regulator电流*/ /* 获取Regulator电流 */
ret = RegulatorGetCurrent(handle, &regCurrent); ret = RegulatorGetCurrent(handle, &regCurrent);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -350,22 +350,22 @@ int32_t RegulatorGetStatus(DevHandle handle, uint32_t *status); ...@@ -350,22 +350,22 @@ int32_t RegulatorGetStatus(DevHandle handle, uint32_t *status);
**表11** RegulatorGetStatus参数描述 **表11** RegulatorGetStatus参数描述
| 参数 | 参数描述 | | 参数 | 参数描述 |
| ---------- | ----------------- | | ---------- | ----------------- |
| handle | Regulator设备句柄 | | handle | Regulator设备句柄 |
| *status | 参数指针 | | *status | 参数指针 |
| **返回值** | **返回值描述** | | **返回值** | **返回值描述** |
| 0 | 获取成功 | | 0 | 获取成功 |
| 负数 | 获取失败 | | 负数 | 获取失败 |
``` ```
int32_t ret; int32_t ret;
uint32_t status; uint32_t status;
/*获取Regulator状态*/ /* 获取Regulator状态 */
ret = RegulatorGetStatus(handle, &status); ret = RegulatorGetStatus(handle, &status);
if (ret != 0) { if (ret != 0) {
/*错误处理*/ /* 错误处理 */
} }
``` ```
...@@ -391,17 +391,17 @@ void RegulatorTestSample(void) ...@@ -391,17 +391,17 @@ void RegulatorTestSample(void)
return; return;
} }
/*启用Regulator设备*/ /* 启用Regulator设备 */
ret = RegulatorEnable(handle); ret = RegulatorEnable(handle);
if (ret != 0) { if (ret != 0) {
HDF_LOGE("RegulatorEnable: failed, ret %d\n", ret); HDF_LOGE("RegulatorEnable: failed, ret %d\n", ret);
goto _ERR; goto _ERR;
} }
int32_t minUv = 0; //最小电压为0µV int32_t minUv = 0; // 最小电压为0µV
int32_t maxUv = 20000; //最大电压为20000µV int32_t maxUv = 20000; // 最大电压为20000µV
/*设置Regulator输出电压范围*/ /* 设置Regulator输出电压范围 */
ret = RegulatorSetVoltage(handle, minUv, maxUv); ret = RegulatorSetVoltage(handle, minUv, maxUv);
if (ret != 0) { if (ret != 0) {
HDF_LOGE("RegulatorSetVoltage: failed, ret %d\n", ret); HDF_LOGE("RegulatorSetVoltage: failed, ret %d\n", ret);
...@@ -410,7 +410,7 @@ void RegulatorTestSample(void) ...@@ -410,7 +410,7 @@ void RegulatorTestSample(void)
uint32_t voltage; uint32_t voltage;
/*获取Regulator电压*/ /* 获取Regulator电压 */
ret = RegulatorGetVoltage(handle, &voltage); ret = RegulatorGetVoltage(handle, &voltage);
if (ret != 0) { if (ret != 0) {
HDF_LOGE("RegulatorGetVoltage: failed, ret %d\n", ret); HDF_LOGE("RegulatorGetVoltage: failed, ret %d\n", ret);
...@@ -419,14 +419,14 @@ void RegulatorTestSample(void) ...@@ -419,14 +419,14 @@ void RegulatorTestSample(void)
uint32_t status; uint32_t status;
/*获取Regulator状态*/ /* 获取Regulator状态 */
ret = RegulatorGetStatus(handle, &status); ret = RegulatorGetStatus(handle, &status);
if (ret != 0) { if (ret != 0) {
HDF_LOGE("RegulatorGetStatus: failed, ret %d\n", ret); HDF_LOGE("RegulatorGetStatus: failed, ret %d\n", ret);
goto _ERR; goto _ERR;
} }
/*禁用Regulator设备*/ /* 禁用Regulator设备 */
ret = RegulatorDisable(handle); ret = RegulatorDisable(handle);
if (ret != 0) { if (ret != 0) {
HDF_LOGE("RegulatorDisable: failed, ret %d\n", ret); HDF_LOGE("RegulatorDisable: failed, ret %d\n", ret);
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册