1# PWM 2 3## 概述 4 5### 功能简介 6 7PWM（Pulse Width Modulation）即脉冲宽度调制，是一种对模拟信号电平进行数字编码并将其转换为脉冲的技术，广泛应用在从测量、通信到功率控制与变换的许多领域中。通常情况下，在使用马达控制、背光亮度调节时会用到PWM模块。 8 9### 基本概念 10 11脉冲是“电脉冲”的简称，指电路中电流或电压短暂起伏的现象，其特点是突变和不连续性。脉冲的种类很多，常见的脉冲波形有：三角脉冲、尖脉冲、矩形脉冲、方形脉冲、梯形脉冲及阶梯脉冲等。脉冲的主要参数包括重复周期T（T=1/F，F为煎复频率）、脉冲幅度U、脉冲前沿上升时间ts、后沿下降时间t、脉冲宽度tk等。 12 13### 运作机制 14 15在HDF框架中，PWM接口适配模式采用独立服务模式（如图1所示）。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDF设备管理器的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 16 17独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 18 19- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 20- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 21 22PWM模块各分层作用： 23 24- 接口层提供打开PWM设备、设置PWM设备周期、设置PWM设备占空时间、设置PWM设备极性、设置PWM设备参数、获取PWM设备参数、使能PWM设备、禁止PWM设备、关闭PWM设备的接口。 25- 核心层主要提供PWM控制器的添加、移除以及管理的能力，通过钩子函数与适配层交互。 26- 适配层主要是将钩子函数的功能实例化，实现具体的功能。 27 28**图1** PWM独立服务模式结构图 29 30 31 32## 开发指导 33 34### 场景介绍 35 36PWM用于脉冲宽度调制，当驱动开发者需要将PWM设备适配到OpenHarmony时，需要进行PWM驱动适配。下文将介绍如何进行PWM驱动适配。 37 38### 接口说明 39 40为了保证上层在调用PWM接口时能够正确的操作PWM控制器，核心层在//drivers/hdf_core/framework/support/platform/include/pwm/pwm_core.h中定义了以下钩子函数，驱动适配者需要在适配层实现这些函数的具体功能，并与钩子函数挂接，从而完成适配层与核心层的交互。 41 42PwmMethod定义： 43 44```c 45struct PwmMethod { 46 int32_t (*setConfig)(struct PwmDev *pwm, struct PwmConfig *config); 47 int32_t (*open)(struct PwmDev *pwm); 48 int32_t (*close)(struct PwmDev *pwm); 49}; 50``` 51 52**表1** PwmMethod结构体成员的钩子函数功能说明 53 54| 成员函数 | 入参 | 返回值 | 功能 | 55| -------- | -------- | -------- | -------- | 56| setConfig | pwm：结构体指针，核心层PWM控制器<br/>config：结构体指针，传入设置得设备属性 | HDF_STATUS相关状态 | 配置属性 | 57| open | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 打开PWM设备 | 58| close | pwm：结构体指针，核心层PWM控制器 | HDF_STATUS相关状态 | 关闭PWM设备 | 59 60### 开发步骤 61 62PWM模块适配包含以下四个步骤： 63 64- 驱实例化驱动入口。 65- 配置属性文件。 66- 实例化PWM控制器对象。 67- 驱动调试。 68 69### 开发实例 70 71下方将基于Hi3516DV300开发板以//device_soc_hisilicon/common/platform/pwm/pwm_hi35xx.c驱动为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 72 731. 驱实例化驱动入口。 74 75 驱动入口必须为HdfDriverEntry（在hdf_device_desc.h中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 76 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 77 78 PWM驱动入口开发参考： 79 80 ```c 81 struct HdfDriverEntry g_hdfPwm = { 82 .moduleVersion = 1, 83 .moduleName = "HDF_PLATFORM_PWM", // 【必要且与HCS文件中里面的moduleName匹配】 84 .Bind = HdfPwmBind, // 见Bind参考 85 .Init = HdfPwmInit, // 见Init参考 86 .Release = HdfPwmRelease, // 见Release参考 87 }; 88 HDF_INIT(g_hdfPwm); // 调用HDF_INIT将驱动入口注册到HDF框架中 89 ``` 90 912. 配置属性文件。 92 93 完成驱动入口注册之后，需要在device_info.hcs文件中添加deviceNode信息，deviceNode信息与驱动入口注册相关。本例以两个PWM控制器为例，如有多个器件信息，则需要在device_info.hcs文件增加对应的deviceNode信息。器件属性值与核心层PwmDev成员的默认值或限制范围有密切关系，比如PWM设备号，需要在pwm_config.hcs文件中增加对应的器件属性。 94 95 - device_info.hcs 配置参考： 96 97 在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。 98 99 ```c 100 root { 101 device_info { 102 platform :: host { 103 hostName = "platform_host"; 104 priority = 50; 105 device_pwm :: device { // 为每一个PWM控制器配置一个HDF设备节点 106 device0 :: deviceNode { 107 policy = 1; // 等于1，向内核态发布服务 108 priority = 80; // 驱动启动优先级 109 permission = 0644; // 驱动创建设备节点权限 110 moduleName = "HDF_PLATFORM_PWM"; // 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 111 serviceName = "HDF_PLATFORM_PWM_0"; // 【必要且唯一】驱动对外发布服务的名称 112 deviceMatchAttr = "hisilicon_hi35xx_pwm_0"; // 【必要】用于配置控制器私有数据，要与pwm_config.hcs中对应控制器保持一致，具体的控制器信息在pwm_config.hcs中 113 } 114 device1 :: deviceNode { 115 policy = 1; 116 priority = 80; 117 permission = 0644; 118 moduleName = "HDF_PLATFORM_PWM"; 119 serviceName = "HDF_PLATFORM_PWM_1"; 120 deviceMatchAttr = "hisilicon_hi35xx_pwm_1"; 121 } 122 ... 123 } 124 } 125 } 126 } 127 ``` 128 129 - pwm_config.hcs 配置参考 130 131 在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/pwm/pwm_config.hcs文件配置器件属性，其中配置参数如下： 132 133 ```c 134 root { 135 platform { 136 pwm_config { 137 template pwm_device { // 【必要】配置模板，如果下面节点使用时继承该模板，则节点中未声明的字段会使用该模板中的默认值 138 serviceName = ""; 139 match_attr = ""; 140 num = 0; // 【必要】设备号 141 base = 0x12070000; // 【必要】地址映射需要 142 } 143 device_0x12070000 :: pwm_device { // 存在多个设备时，请逐一添加相关HDF节点和设备节点信息。 144 match_attr = "hisilicon_hi35xx_pwm_0"; // 【必要】需要和device_info.hcs中的deviceMatchAttr值一致 145 } 146 device_0x12070020 :: pwm_device { 147 match_attr = "hisilicon_hi35xx_pwm_1"; 148 num = 1; 149 base = 0x12070020; // 【必要】地址映射需要 150 } 151 } 152 } 153 } 154 ``` 155 156 需要注意的是，新增pwm_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。 157 158 ```c 159 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/pwm/pwm_config.hcs" // 配置文件相对路径 160 ``` 161 1623. 实例化PWM控制器对象。 163 164 完成驱动入口注册之后，下一步就是以核心层PwmDev对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化PwmDev成员PwmMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind、Init、Release）。 165 166 - 驱动适配者自定义结构体参考。 167 168 从驱动的角度看，驱动适配者自定义结构体是参数和数据的载体，而且pwm_config.hcs文件中的数值会被HDF读入并通过DeviceResourceIface来初始化结构体成员，一些重要数值也会传递给核心层对象，例如PWM设备号。 169 170 ```c 171 struct HiPwm { 172 struct PwmDev dev; // 【必要】 核是核心层控制对象 173 volatile unsigned char *base; // 【必要】地址映射需要，寄存器基地址 174 struct HiPwmRegs *reg; // 设备属性结构体，可自定义。 175 bool supportPolarity; // 是否支持极性 176 }; 177 178 struct PwmDev { // PwmDev是核心层控制器结构体，其中的成员在Init函数中会被赋值。 179 struct IDeviceIoService service; // 驱动服务 180 struct HdfDeviceObject *device; // 驱动设备对象 181 struct PwmConfig cfg; // 设备属性结构体，相关定义见下。 182 struct PwmMethod *method; // 钩子函数 183 bool busy; // 是否繁忙 184 uint32_t num; // 设备号 185 OsalSpinlock lock; // 自旋锁 186 void *priv; // 私有数据 187 }; 188 189 struct PwmConfig { // PWM设备属性 190 uint32_t duty; // 占空时间 nanoseconds 191 uint32_t period; // pwm 周期 nanoseconds 192 uint32_t number; // pwm 连续个数 193 uint8_t polarity; // Polarity 194 // ------------------- | -------------- 195 // PWM_NORMAL_POLARITY | Normal polarity 196 // PWM_INVERTED_POLARITY | Inverted polarity 197 // 198 uint8_t status; // 运行状态 199 // ------------------ | ----------------- 200 // PWM_DISABLE_STATUS | Disabled 201 // PWM_ENABLE_STATUS | Enabled 202 }; 203 ``` 204 205 - PwmDev成员钩子函数结构体PwmMethod的实例化，其他成员在Init函数中初始化。 206 207 ```c 208 struct PwmMethod g_pwmOps = { // pwm_hi35xx.c中的示例：钩子函数实例化 209 .setConfig = HiPwmSetConfig, // 配置属性 210 }; 211 ``` 212 213 - Init函数开发参考 214 215 入参： 216 217 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 218 219 返回值： 220 221 HDF_STATUS相关状态（下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS定义）。 222 223 | 状态(值) | 问题描述 | 224 | -------- | -------- | 225 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 226 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 227 | HDF_ERR_INVALID_PARAM | 参数非法 | 228 | HDF_ERR_IO | I/O 错误 | 229 | HDF_SUCCESS | 初始化成功 | 230 | HDF_FAILURE | 初始化失败 | 231 232 函数说明： 233 234 初始化自定义结构体对象，初始化PwmDev成员，调用核心层PwmDeviceAdd函数，完成PWM控制器的添加。 235 236 ```c 237 // 此处Bind函数为空函数，可与Init函数结合，也可根据驱动适配者需要实现相关操作。 238 static int32_t HdfPwmBind(struct HdfDeviceObject *obj) 239 { 240 (void)obj; 241 return HDF_SUCCESS; 242 } 243 244 static int32_t HdfPwmInit(struct HdfDeviceObject *obj) 245 { 246 int ret; 247 struct HiPwm *hp = NULL; 248 ... 249 hp = (struct HiPwm *)OsalMemCalloc(sizeof(*hp)); 250 ... 251 ret = HiPwmProbe(hp, obj); // 【必要】实现见下 252 ... 253 return ret; 254 } 255 256 static int32_t HiPwmProbe(struct HiPwm *hp, struct HdfDeviceObject *obj) 257 { 258 uint32_t tmp; 259 struct DeviceResourceIface *iface = NULL; 260 261 iface = DeviceResourceGetIfaceInstance(HDF_CONFIG_SOURCE); //初始化自定义结构体HiPwm 262 ... 263 264 hp->reg = (struct HiPwmRegs *)hp->base; // 初始化自定义结构体HiPwm 265 hp->supportPolarity = false; // 初始化自定义结构体HiPwm 266 hp->dev.method = &g_pwmOps; // PwmMethod的实例化对象的挂载 267 hp->dev.cfg.duty = PWM_DEFAULT_DUTY_CYCLE; // 初始化PwmDev 268 hp->dev.cfg.period = PWM_DEFAULT_PERIOD; // 初始化PwmDev 269 hp->dev.cfg.polarity = PWM_DEFAULT_POLARITY; // 初始化PwmDev 270 hp->dev.cfg.status = PWM_DISABLE_STATUS; // 初始化PwmDev 271 hp->dev.cfg.number = 0; // 初始化PwmDev 272 hp->dev.busy = false; // 初始化PwmDev 273 if (PwmDeviceAdd(obj, &(hp->dev)) != HDF_SUCCESS) { // 【重要】调用核心层函数，初始化hp->dev的设备和服务。 274 OsalIoUnmap((void *)hp->base); 275 return HDF_FAILURE; 276 } 277 return HDF_SUCCESS; 278 } 279 ``` 280 281 - Release函数开发参考 282 283 入参： 284 285 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 286 287 返回值： 288 289 无。 290 291 函数说明： 292 293 释放内存和删除控制器，该函数需要在驱动入口结构体中赋值给Release接口，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。 294 295 ```c 296 static void HdfPwmRelease(struct HdfDeviceObject *obj) 297 { 298 struct HiPwm *hp = NULL; 299 ... 300 hp = (struct HiPwm *)obj->service; // 这里有HdfDeviceObject到HiPwm的强制转化 301 ... 302 PwmDeviceRemove(obj, &(hp->dev)); // 【必要】调用核心层函数，释放PwmDev的设备和服务，这里有HiPwm到PwmDev的强制转化。 303 HiPwmRemove(hp); // 释放HiPwm 304 } 305 ``` 306 3074. 驱动调试。 308 309 【可选】针对新增驱动程序，建议验证驱动基本功能，例如PWM控制状态，中断响应情况等。