1# Watchdog 2 3## 概述 4 5### 功能简介 6 7看门狗（Watchdog），又称看门狗计时器（Watchdog timer），是一种硬件计时设备。一般有一个输入，叫做喂狗，一个输出到系统的复位端。当系统主程序发生错误导致未及时清除看门狗计时器的计时值时，看门狗计时器就会对系统发出复位信号，使系统从悬停状态恢复到正常运作状态。 8 9### 基本概念 10 11系统正常工作的时候，每隔一段时间输出一个信号到喂狗端，给看门狗清零，这个操作就叫做喂狗。如果超过规定的时间不喂狗，看门狗定时超时，就会给出一个复位信号到系统，使系统复位。 12 13### 运作机制 14 15在HDF框架中，Watchdog接口适配模式采用独立服务模式（如图1所示）。在这种模式下，每一个设备对象会独立发布一个设备服务来处理外部访问，设备管理器收到API的访问请求之后，通过提取该请求的参数，达到调用实际设备对象的相应内部方法的目的。独立服务模式可以直接借助HDF设备管理器的服务管理能力，但需要为每个设备单独配置设备节点，增加内存占用。 16 17独立服务模式下，核心层不会统一发布一个服务供上层使用，因此这种模式下驱动要为每个控制器发布一个服务，具体表现为： 18 19- 驱动适配者需要实现HdfDriverEntry的Bind钩子函数以绑定服务。 20- device_info.hcs文件中deviceNode的policy字段为1或2，不能为0。 21 22Watchdog模块各分层作用： 23 24- 接口层提供打开看门狗设备、获取看门狗设备状态、启动看门狗设备、设置看门狗设备超时时间、获取看门狗设备超时时间、喂狗、停止看门狗设备超时时间、关闭看门狗设备的接口。 25- 核心层主要提供看门狗控制器的添加、移除以及管理的能力，通过钩子函数与适配层交互。 26- 适配层主要是将钩子函数的功能实例化，实现具体的功能。 27 28**图 1** Watchdog独立服务模式结构图 29 30 31 32## 开发指导 33 34### 场景介绍 35 36对于无法直接观测到的软件异常，我们可以使用看门狗进行自动检测，并在异常产生时及时重置。当驱动开发者需要将Watchdog设备适配到OpenHarmony时，需要进行Watchdog驱动适配。下文将介绍如何进行Watchdog驱动适配。 37 38### 接口说明 39 40为了保证上层在调用Watchdog接口时能够正确的操作Watchdog控制器，核心层在//drivers/hdf_core/framework/support/platform/include/watchdog/watchdog_core.h中定义了以下钩子函数，驱动适配者需要在适配层实现这些函数的具体功能，并与钩子函数挂接，从而完成适配层与核心层的交互。 41 42WatchdogMethod定义： 43 44```c 45struct WatchdogMethod { 46 int32_t (*getStatus)(struct WatchdogCntlr *wdt, int32_t *status); 47 int32_t (*setTimeout)(struct WatchdogCntlr *wdt, uint32_t seconds); 48 int32_t (*getTimeout)(struct WatchdogCntlr *wdt, uint32_t *seconds); 49 int32_t (*start)(struct WatchdogCntlr *wdt); 50 int32_t (*stop)(struct WatchdogCntlr *wdt); 51 int32_t (*feed)(struct WatchdogCntlr *wdt); 52 int32_t (*getPriv)(struct WatchdogCntlr *wdt); // 【可选】如果WatchdogCntlr中的priv成员存在，则按需实例化 53 void (*releasePriv)(struct WatchdogCntlr *wdt); // 【可选】 54}; 55``` 56 57**表1** WatchdogMethod成员的钩子函数功能说明 58 59| 成员函数 | 入参 | 出参 | 返回值 | 功能 | 60| -------- | -------- | -------- | -------- | -------- | 61| getStatus | wdt：结构体指针，核心层Watchdog控制器 | status：int32_t类型指针，表示获取的看门狗的状态（打开或关闭） | HDF_STATUS相关状态 | 获取看门狗状态 | 62| setTimeout | wdt：结构体指针，核心层Watchdog控制器；seconds：设置的看门狗超时时间 | 无 | HDF_STATUS相关状态 | 设置看门狗超时时间，单位秒，需要保证看门狗实际运行的时间符合该值 | 63| getTimeout | wdt：结构体指针，核心层Watchdog控制器 | seconds：uint32_t类型指针，表示获取的超时时间 | HDF_STATUS相关状态 | 获取看门狗超时时间 | 64| start | wdt：结构体指针，核心层Watchdog控制器 | 无 | HDF_STATUS相关状态 | 启动看门狗 | 65| stop | wdt：结构体指针，核心层Watchdog控制器 | 无 | HDF_STATUS相关状态 | 停止看门狗 | 66| feed | wdt：结构体指针，核心层Watchdog控制器 | 无 | HDF_STATUS相关状态 | 喂狗 | 67| getPriv | wdt：结构体指针，核心层Watchdog控制器 | 无 | HDF_STATUS相关状态 | 获取看门狗驱动的私有数据 | 68| releasePriv | wdt：结构体指针，核心层Watchdog控制器 | 无 | HDF_STATUS相关状态 | 释放看门狗驱动的私有数据 | 69 70### 开发步骤 71 72Watchdog模块适配包含以下四个步骤： 73 74- 实例化驱动入口。 75- 配置属性文件。 76- 实例化Watchdog控制器对象。 77- 驱动调试。 78 79### 开发实例 80 81下方将基于Hi3516DV300开发板以//device_soc_hisilicon/common/platform/watchdog/watchdog_hi35xx.c驱动为示例，展示需要驱动适配者提供哪些内容来完整实现设备功能。 82 831. 实例化驱动入口。 84 85 驱动入口必须为HdfDriverEntry（在 hdf_device_desc.h 中定义）类型的全局变量，且moduleName要和device_info.hcs中保持一致。HDF框架会将所有加载的驱动的HdfDriverEntry对象首地址汇总，形成一个类似数组的段地址空间，方便上层调用。 86 一般在加载驱动时HDF会先调用Bind函数，再调用Init函数加载该驱动。当Init调用异常时，HDF框架会调用Release释放驱动资源并退出。 87 88 Watchdog驱动入口开发参考： 89 90 ```c 91 struct HdfDriverEntry g_watchdogDriverEntry = { 92 .moduleVersion = 1, 93 .Bind = Hi35xxWatchdogBind, // 见Bind参考 94 .Init = Hi35xxWatchdogInit, // 见Init参考 95 .Release = Hi35xxWatchdogRelease, // 见Release参考 96 .moduleName = "HDF_PLATFORM_WATCHDOG", // 【必要且与HCS文件中里面的moduleName匹配】 97 }; 98 HDF_INIT(g_watchdogDriverEntry); // 调用HDF_INIT将驱动入口注册到HDF框架中 99 ``` 100 1012. 配置属性文件。 102 103 完成驱动入口注册之后，需要在device_info.hcs文件中添加deviceNode描述。deviceNode信息与驱动入口注册相关。本例以一个Watchdog控制器为例，如有多个器件信息，则需要在device_info文件增加对应的deviceNode描述。器件属性值与核心层WatchdogCntlr成员的默认值或限制范围有密切关系，比如Watchdog设备号，需要在watchdog_config.hcs文件中增加对应的器件属性。 104 105 - device_info.hcs 配置参考： 106 107 在//vendor/hisilicon/hispark_taurus/hdf_config/device_info/device_info.hcs文件中添加deviceNode描述。 108 109 ```c 110 root { 111 device_info { 112 match_attr = "hdf_manager"; 113 device_watchdog :: device { // 设备节点 114 device0 :: deviceNode { // 驱动的DeviceNode节点 115 policy = 2; // policy字段是驱动服务发布的策略,如果需要面向用户态，则为2 116 priority = 20; // 驱动启动优先级 117 permission = 0644; // 驱动创建设备节点权限 118 moduleName = "HDF_PLATFORM_WATCHDOG"; // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致 119 serviceName = "HDF_PLATFORM_WATCHDOG_0"; // 【必要】驱动对外发布服务的名称，必须唯一。 120 deviceMatchAttr = "hisilicon_hi35xx_watchdog_0"; // 【必要】用于配置控制器私有数据，必须和驱动私有数据配置表watchdog_config.hcs中的match_attr值保持一致。 121 } 122 } 123 } 124 } 125 ``` 126 127 - watchdog_config.hcs 配置参考： 128 129 在//device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/watchdog/watchdog_config.hcs文件配置器件属性，其中配置参数如下： 130 131 ```c 132 root { 133 platform { 134 template watchdog_controller { // 【必要】配置模板，如果下面节点使用时继承该模板，则节点中未声明的字段会使用该模板中的默认值 135 id = 0; // watchdog ID号 136 match_attr = ""; 137 regBase = 0x12050000; // 【必要】地址映射需要，物理基地址 138 regStep = 0x1000; // 【必要】地址映射需要，寄存器偏移步进 139 } 140 controller_0x12050000 :: watchdog_controller { // 【必要】是作为设备驱动私有数据匹配的关键字 141 match_attr = "hisilicon_hi35xx_watchdog_0"; // 【必要】必须和device_info.hcs中的deviceMatchAttr值一致 142 } 143 // 如果存在多个watchdog设备时【必须】添加节点，否则不用 144 ... 145 } 146 } 147 ``` 148 149 需要注意的是，新增watchdog_config.hcs配置文件后，必须在产品对应的hdf.hcs文件中将其包含如下语句所示，否则配置文件无法生效。 150 151 ```c 152 #include "../../../../device/soc/hisilicon/hi3516dv300/sdk_liteos/hdf_config/watchdog/watchdog_config.hcs" // 配置文件相对路径 153 ``` 154 1553. 实例化Watchdog控制器对象。 156 157 完成驱动入口注册之后，下一步就是以核心层WatchdogCntlr对象的初始化为核心，包括驱动适配者自定义结构体（传递参数和数据），实例化WatchdogCntlr成员WatchdogMethod（让用户可以通过接口来调用驱动底层函数），实现HdfDriverEntry成员函数（Bind，Init，Release）。 158 159 - 驱动适配者自定义结构体参考。 160 161 从驱动的角度看，驱动适配者自定义结构体是参数和数据的载体，而且watchdog_config.hcs文件中的数值会被HDF读入通过DeviceResourceIface来初始化结构体成员，其中一些重要数值也会传递给核心层WatchdogCntlr对象，例如watchdog设备ID号。 162 163 ```c 164 struct Hi35xxWatchdog { 165 struct WatchdogCntlr wdt; // 【必要】是核心层控制对象，具体描述见下面 166 OsalSpinlock lock; // 【必要】驱动适配者需要基于此锁变量对watchdog设备实现对应的加锁解锁 167 volatile unsigned char *regBase; // 【必要】地址映射需要，寄存器基地址 168 uint32_t phyBase; // 【必要】地址映射需要，物理基址 169 uint32_t regStep; // 【必要】地址映射需要，寄存器偏移步进 170 }; 171 172 struct WatchdogCntlr { // WatchdogCntlr是核心层控制器结构体，其中的成员在Init函数中会被赋值。 173 struct IDeviceIoService service; // 驱动服务 174 struct HdfDeviceObject *device; // 驱动设备对象 175 OsalSpinlock lock; // 自旋锁 176 struct WatchdogMethod *ops; // 钩子函数 177 int16_t wdtId; // watchdog设备ID号 178 void *priv; // 私有数据 179 }; 180 ``` 181 182 - WatchdogCntlr成员钩子函数结构体WatchdogMethod的实例化，其他成员在Init和Bind函数中初始化。 183 184 ```c 185 static struct WatchdogMethod g_method = { // 钩子函数实例化 186 .getStatus = Hi35xxWatchdogGetStatus, // 获取看门狗状态 187 .start = Hi35xxWatchdogStart, // 启动看门狗 188 .stop = Hi35xxWatchdogStop, // 停止看门狗 189 .setTimeout = Hi35xxWatchdogSetTimeout, // 设置看门狗超时时间 190 .getTimeout = Hi35xxWatchdogGetTimeout, // 获取看门狗超时时间 191 .feed = Hi35xxWatchdogFeed, // 喂狗 192 }; 193 ``` 194 195 - Init函数和Bind函数开发参考： 196 197 入参： 198 199 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 200 201 返回值： 202 203 HDF_STATUS相关状态 （下表为部分展示，如需使用其他状态，可见//drivers/hdf_core/framework/include/utils/hdf_base.h中HDF_STATUS的定义）。 204 205 **表2** Init函数和Bind函数返回值和描述 206 207 | 状态(值) | 问题描述 | 208 | -------- | -------- | 209 | HDF_ERR_INVALID_OBJECT | 控制器对象非法 | 210 | HDF_ERR_MALLOC_FAIL | 内存分配失败 | 211 | HDF_ERR_IO | I/O 错误 | 212 | HDF_SUCCESS | 初始化成功 | 213 | HDF_FAILURE | 初始化失败 | 214 215 函数说明： 216 217 初始化自定义结构体对象，初始化WatchdogCntlr成员，调用核心层WatchdogCntlrAdd函数，完成看门狗控制器的添加。 218 219 ```c 220 // 一般而言，Init函数需要根据入参(HdfDeviceObject对象)的属性值初始化Hi35xxWatchdog结构体的成员， 221 // 但watchdog_hi35xx.c示例中是在bind函数中实现的 222 static int32_t Hi35xxWatchdogInit(struct HdfDeviceObject *device) 223 { 224 (void)device; 225 return HDF_SUCCESS; 226 } 227 228 static int32_t Hi35xxWatchdogBind(struct HdfDeviceObject *device) 229 { 230 int32_t ret; 231 struct Hi35xxWatchdog *hwdt = NULL; 232 ... 233 hwdt = (struct Hi35xxWatchdog *)OsalMemCalloc(sizeof(*hwdt)); //Hi35xxWatchdog 结构体指针的内存申请 234 ... 235 hwdt->regBase = OsalIoRemap(hwdt->phyBase, hwdt->regStep); //地址映射 236 ... 237 hwdt->wdt.priv = (void *)device->property; // 【必要】此处是将设备属性的内容赋值给priv成员，但后续没有调用 priv 成员， 238 // 如果需要用到priv成员，需要额外实例化WatchdogMethod的getPriv和releasePriv成员函数 239 hwdt->wdt.ops = &g_method; // 【必要】WatchdogMethod实例化对象的挂载 240 hwdt->wdt.device = device; // 【必要】这是为了方便HdfDeviceObject与WatchdogcCntlr相互转化 241 ret = WatchdogCntlrAdd(&hwdt->wdt); // 【必要】调用此函数初始化核心层结构体，返回成功信号后驱动才完全接入平台核心层 242 if (ret != HDF_SUCCESS) { // 不成功的话，需要去除映射并释放Init函数申请的资源 243 OsalIoUnmap((void *)hwdt->regBase); 244 OsalMemFree(hwdt); 245 return ret; 246 } 247 return HDF_SUCCESS; 248 } 249 ``` 250 251 - Release函数开发参考： 252 253 入参： 254 255 HdfDeviceObject：HDF框架给每一个驱动创建的设备对象，用来保存设备相关的私有数据和服务接口。 256 257 返回值： 258 259 无。 260 261 函数说明： 262 263 该函数需要在驱动入口结构体中赋值给Release，当HDF框架调用Init函数初始化驱动失败时，可以调用Release释放驱动资源。该函数中需包含释放内存和删除控制器等操作。 264 265 ```c 266 static void Hi35xxWatchdogRelease(struct HdfDeviceObject *device) 267 { 268 struct WatchdogCntlr *wdt = NULL; 269 struct Hi35xxWatchdog *hwdt = NULL; 270 ... 271 wdt = WatchdogCntlrFromDevice(device); // 【必要】通过device获取WatchdogCntlr 272 ... 273 if (wdt == NULL) { 274 return; 275 } 276 WatchdogCntlrRemove(wdt); // 【必要】调用WatchdogCntlrRemove函数来释放WatchdogCntlr对象的内容 277 hwdt = (struct Hi35xxWatchdog *)wdt; // 这里将WatchdogCntlr转化为Hi35xxWatchdog 278 if (hwdt->regBase != NULL) { // 【必要】解除地址映射 279 OsalIoUnmap((void *)hwdt->regBase); 280 hwdt->regBase = NULL; 281 } 282 OsalMemFree(hwdt); // 【必要】释放驱动适配者自定义对象占用的内存 283 } 284 ``` 285 2864. 驱动调试。 287 288 【可选】针对新增驱动程序，建议验证驱动基本功能，例如挂载后的信息反馈，数据传输的成功与否等。