《I.MX6U嵌入式Linux C应用编程指南》第二十八章 看门狗应用编程

正点原子

1）实验平台：正点原子i.MX6ULL Linux阿尔法开发板
2)  章节摘自【正点原子】I.MX6U嵌入式Linux C应用编程指南
3）购买链接:https://item.taobao.com/item.htm?&id=603672744434
4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/arm-linux/zdyz-i.mx6ull.html
5）正点原子官方B站：https://space.bilibili.com/394620890
6）正点原子Linux技术交流群：1027879335

第二十八章 看门狗应用编程

       在产品化的嵌入式系统中，为了使系统在异常情况下能自动复位，一般都需要引入看门狗。看门狗其实就是一个可以在一定时间内被复位的计数器。当看门狗启动后，计数器开始自动计数，经过一定时间，如果没有被复位，计数器溢出就会对CPU产生一个复位信号使系统重启（俗称“被狗咬”）。系统正常运行时，需要在看门狗允许的时间间隔内对看门狗计数器清零（俗称“喂狗”），不让复位信号产生。如果系统不出问题，程序保证按时“喂狗”，一旦程序跑飞，没有“喂狗”，系统“被咬”复位。
       本章我们来学习应用层如何控制看门狗外设，譬如打开看门狗、关闭看门狗以及喂狗等操作。
       本章将会讨论如下主题内容。
       看门狗应用编程介绍；
       编写程序控制看门狗外设。
1.1看门狗应用编程介绍
       前面已经说到，看门狗其实就是一个可以在一定时间内被复位/重置的计数器，一般叫做看门狗计时器（或看门狗定时器）；如果在规定时间内没有复位看门狗计时器，计数器溢出则会对CPU产生一个复位信号使系统重启，当然有些看门狗也可以只产生中断信号而不会使系统复位。
       I.MX6UL/I.MX6ULL SoC集成了两个看门狗定时器（WDOG）：WDOG1和WDOG2；WDOG2用于安全目的，而WDOG1则是一个普通的看门狗，支持产生中断信号以及复位CPU。
       Linux系统中所注册的看门狗外设，都会在/dev/目录下生成对应的设备节点（设备文件），设备节点名称通常为watchdogX（X表示一个数字编号0、1、2、3等），譬如/dev/watchdog0、/dev/watchdog1等，通过这些设备节点可以控制看门狗外设。

图 28.1.1 watchdog0和watchdog设备节点

       这个watchdog0其实就是I.MX6U的WDOG1所对应的设备节点，从图中可知，除了/dev/watchdog0之外，还有一个watchdog设备节点，这个设备节点的名称没有后面的数字编号，这个又是什么意思呢？因为系统中可能注册了多个看门狗设备，/dev/watchdog设备节点则代表系统默认的看门狗设备；通常这指的就是watchdog0，所以，上图中，/dev/watchdog其实就等于/dev/watchdog0，也就意味着它俩代表的是同一个硬件外设。
       应用层控制看门狗其实非常简单，通过ioctl()函数即可做到！接下来笔者向大家进行介绍。
       首先在我们的应用程序中，需要包含头文件<linux/watchdog.h>头文件，该头文件中定义了一些ioctl指令宏，每一个不同的指令宏表示向设备请求不同的操作，如下所示：

1. #define        WDIOC_GETSUPPORT                _IOR(WATCHDOG_IOCTL_BASE, 0, struct watchdog_info)
   
2. #define        WDIOC_GETSTATUS                        _IOR(WATCHDOG_IOCTL_BASE, 1, int)
   
3. #define        WDIOC_GETBOOTSTATUS        _IOR(WATCHDOG_IOCTL_BASE, 2, int)
   
4. #define        WDIOC_GETTEMP                        _IOR(WATCHDOG_IOCTL_BASE, 3, int)
   
5. #define        WDIOC_SETOPTIONS                        _IOR(WATCHDOG_IOCTL_BASE, 4, int)
   
6. #define        WDIOC_KEEPALIVE                        _IOR(WATCHDOG_IOCTL_BASE, 5, int)
   
7. #define        WDIOC_SETTIMEOUT              _IOWR(WATCHDOG_IOCTL_BASE, 6, int)
   
8. #define        WDIOC_GETTIMEOUT              _IOR(WATCHDOG_IOCTL_BASE, 7, int)
   
9. #define        WDIOC_SETPRETIMEOUT                _IOWR(WATCHDOG_IOCTL_BASE, 8, int)
   
10. #define        WDIOC_GETPRETIMEOUT        _IOR(WATCHDOG_IOCTL_BASE, 9, int)
    
11. #define        WDIOC_GETTIMELEFT                _IOR(WATCHDOG_IOCTL_BASE, 10, int)

复制代码

       比较常用指令包括：WDIOC_GETSUPPORT、WDIOC_SETOPTIONS、WDIOC_KEEPALIVE、WDIOC_SETTIMEOUT、WDIOC_GETTIMEOUT，说明如下：

表 28.1.1 看门狗常用指令

1.1.1打开设备
        首先在调用ioctl()函数之前，需要先打开看门狗设备得到文件描述符，如下所示：

1. int fd;
   
2. 
   
3. fd = open("/dev/watchdog", "O_RDWR");
   
4. if (0 > fd)
   
5.         fprintf(stderr, "open error: %s: %s\n", "/dev/watchdog", strerror(errno));

复制代码

1.1.2获取设备支持哪些功能：WDIOC_GETSUPPORT
       使用WDIOC_GETSUPPORT指令获取看门狗设备支持哪些功能，使用方式如下：

1. ioctl(int fd, WDIOC_GETSUPPORT, struct watchdog_info *info);

复制代码

       使用WDIOC_GETSUPPORT指令可以获取设备的信息，调用ioctl()需要传入一个struct watchdog_info *指针，ioctl()会将获取到的数据写入到info指针所指向的对象中。struct watchdog_info结构体描述了看门狗设备的信息，我们来看看struct watchdog_info结构体的定义：
       示例代码 28.1.1 struct watchdog_info结构体

1. struct watchdog_info {
   
2.     __u32 options;                      /* Options the card/driver supports */
   
3.     __u32 firmware_version;         /* Firmware version of the card */
   
4.     __u8  identity[32];                 /* Identity of the board */
   
5. };

复制代码

       options字段记录了设备支持哪些功能或选项；
       firmware_version字段记录了设备的固件版本号；
       identity字段则是一个描述性的字符串。
       我们重点关注的是options字段，该字段描述了设备支持哪些功能、选项，该字段的值如下（可以是以下任意一个值或多个值的位或关系）：

1. #define        WDIOF_OVERHEAT                0x0001        /* Reset due to CPU overheat */
   
2. #define        WDIOF_FANFAULT                0x0002        /* Fan failed */
   
3. #define        WDIOF_EXTERN1                0x0004        /* External relay 1 */
   
4. #define        WDIOF_EXTERN2                0x0008        /* External relay 2 */
   
5. #define        WDIOF_POWERUNDER        0x0010        /* Power bad/power fault */
   
6. #define        WDIOF_CARDRESET                0x0020        /* Card previously reset the CPU */
   
7. #define        WDIOF_POWEROVER                0x0040        /* Power over voltage */
   
8. #define        WDIOF_SETTIMEOUT        0x0080  /* Set timeout (in seconds) */
   
9. #define        WDIOF_MAGICCLOSE        0x0100        /* Supports magic close char */
   
10. #define        WDIOF_PRETIMEOUT        0x0200  /* Pretimeout (in seconds), get/set */
    
11. #define        WDIOF_ALARMONLY                0x0400        /* Watchdog triggers a management or other external alarm not a reboot */
    
12. #define        WDIOF_KEEPALIVEPING        0x8000        /* Keep alive ping reply */

复制代码

       一般常见的值包括：WDIOF_SETTIMEOUT、WDIOF_KEEPALIVEPING；WDIOF_SETTIMEOUT表示设备支持设置超时时间；WDIOF_KEEPALIVEPING表示设备支持“喂狗”操作，也就是重置看门狗计时器。
       使用示例如下：

1. struct watchdog_info info;
   
2. 
   
3. if (0 > ioctl(fd, WDIOC_GETSUPPORT, &info)) {
   
4.         fprintf(stderr, "ioctl error: WDIOC_GETSUPPORT: %s\n", strerror(errno));
   
5.         return -1;
   
6. }
   
7. 
   
8. printf("identity: %s\n", info.identity);
   
9. printf("version: %u\n", firmware_version);
   
10. 
    
11. if (0 == (WDIOF_KEEPALIVEPING & info.options))
    
12.         printf("设备不支持喂狗操作\n");
    
13. if (0 == (WDIOF_SETTIMEOUT & info.options))
    
14.         printf("设备不支持设置超时时间\n");

复制代码

1.1.3获取/设置超时时间：WDIOC_GETTIMEOUT、WDIOC_SETTIMEOUT
       使用WDIOC_GETTIMEOUT指令可获取设备当前设置的超时时间，使用方式如下：

1. ioctl(int fd, WDIOC_GETTIMEOUT, int *timeout);

复制代码

        使用WDIOC_SETTIMEOUT指令可设置看门狗的超时时间，使用方式如下：

1. ioctl(int fd, WDIOC_SETTIMEOUT, int *timeout);

复制代码

         超时时间是以秒为单位，设置超时时间时，不可超过其最大值、否则ioctl()调用将会失败，使用示例如下所示：

1. int timeout;
   
2. 
   
3. /* 获取超时时间 */
   
4. if (0 > ioctl(fd, WDIOC_GETTIMEOUT, &timeout)) {
   
5.         fprintf(stderr, "ioctl error: WDIOC_GETTIMEOUT: %s\n", strerror(errno));
   
6.         return -1;
   
7. }
   
8. 
   
9. printf("current timeout: %ds\n", timeout);
   
10. 
    
11. /* 设置超时时间 */
    
12. timeout = 10;        //10秒钟
    
13. if (0 > ioctl(fd, WDIOC_SETTIMEOUT, &timeout)) {
    
14.         fprintf(stderr, "ioctl error: WDIOC_SETTIMEOUT: %s\n", strerror(errno));
    
15.         return -1;
    
16. }

复制代码

1.1.4开启/关闭看门狗：WDIOC_SETOPTIONS
         设置好超时时间之后，接着便可以开启看门狗计时了，使用WDIOC_SETOPTIONS指令可以开启看门狗计时或停止看门狗计时，使用方式如下：

1. ioctl(int fd, WDIOC_SETOPTIONS, int *option);

复制代码

         option指针指向一个int类型变量，该变量可取值如下：

1. #define        WDIOS_DISABLECARD        0x0001        /* Turn off the watchdog timer */
   
2. #define        WDIOS_ENABLECARD        0x0002        /* Turn on the watchdog timer */

复制代码

         WDIOS_DISABLECARD表示停止看门狗计时，WDIOS_ENABLECARD则表示开启看门狗计时。
         使用示例如下所示：

1. int option = WDIOS_ENABLECARD;        //开启
   
2. //int option = WDIOS_DISABLECARD; //停止
   
3. 
   
4. if (0 > ioctl(fd, WDIOC_SETOPTIONS, &option)) {
   
5.         fprintf(stderr, "ioctl error: WDIOC_SETOPTIONS: %s\n", strerror(errno));
   
6.         return -1;
   
7. }

复制代码

       需要注意的是，当调用open()打开看门狗设备的时候，即使程序中没有开启看门狗计时器，当close()关闭设备时，看门狗会自动启动；所以，当打开设备之后，需要使用WDIOC_SETOPTIONS指令停止看门狗计时，等所有设置完成之后再开启看门狗计时器。
1.1.5喂狗：WDIOC_KEEPALIVE
       看门狗计时器启动之后，我们需要在超时之前，去“喂狗”，否则计时器溢出超时将会导致系统复位或产生一个中断信号，通过WDIOC_KEEPALIVE指令喂狗，使用方式如下：

1. ioctl(int fd, WDIOC_KEEPALIVE, NULL);

复制代码

       使用示例如下：

1. if (0 > ioctl(fd, WDIOC_KEEPALIVE, NULL)) {
   
2.         fprintf(stderr, "ioctl error: WDIOC_KEEPALIVE: %s\n", strerror(errno));
   
3. }

复制代码

1.2看门狗应用编程实战
       通过上小节介绍之后，我们已经知道了如何编写应用程序去控制看门狗外设了，本小节我们来编写一个简单地看门狗应用程序，示例代码如下所示：
       本例程源码对应的路径为：开发板光盘->11、Linux C应用编程例程源码->28_watchdog->watchdog_test.c。
       示例代码 28.2.1 看门狗测试程序

1. /***************************************************************
   
2. Copyright © ALIENTEK Co., Ltd. 1998-2021. All rights reserved.
   
3. 文件名 : watchdog_test.c
   
4. 作者 : 邓涛
   
5. 版本 : V1.0
   
6. 描述 : 看门狗应用程序示例代码
   
7. 其他 : 无
   
8. 论坛 : <a href="www.openedv.com" target="_blank">www.openedv.com</a>
   
9. 日志 : 初版 V1.0 2021/7/14 邓涛创建
   
10. ***************************************************************/
    
11. 
    
12. #include <stdio.h>
    
13. #include <stdlib.h>
    
14. #include <sys/types.h>
    
15. #include <sys/stat.h>
    
16. #include <fcntl.h>
    
17. #include <unistd.h>
    
18. #include <sys/ioctl.h>
    
19. #include <errno.h>
    
20. #include <string.h>
    
21. #include <linux/watchdog.h>
    
22. 
    
23. #define  WDOG_DEV   "/dev/watchdog"
    
24. 
    
25. int main(int argc, char *argv[])
    
26. {
    
27.     struct watchdog_info info;
    
28.     int timeout;
    
29.     int time;
    
30.     int fd;
    
31.     int op;
    
32. 
    
33.     if (2 != argc) {
    
34.         fprintf(stderr, "usage: %s <timeout>\n", argv[0]);
    
35.         exit(EXIT_FAILURE);
    
36.     }
    
37. 
    
38.     /* 打开看门狗 */
    
39.     fd = open(WDOG_DEV, O_RDWR);
    
40.     if (0 > fd) {
    
41.         fprintf(stderr, "open error: %s: %s\n", WDOG_DEV, strerror(errno));
    
42.         exit(EXIT_FAILURE);
    
43.     }
    
44. 
    
45.     /* 打开之后看门狗计时器会开启、先停止它 */
    
46.     op = WDIOS_DISABLECARD;
    
47.     if (0 > ioctl(fd, WDIOC_SETOPTIONS, &op)) {
    
48.         fprintf(stderr, "ioctl error: WDIOC_SETOPTIONS: %s\n", strerror(errno));
    
49.         close(fd);
    
50.         exit(EXIT_FAILURE);
    
51.     }
    
52. 
    
53.     timeout = atoi(argv[1]);
    
54.     if (1 > timeout)
    
55.         timeout = 1;
    
56. 
    
57.     /* 设置超时时间 */
    
58.     printf("timeout: %ds\n", timeout);
    
59.     if (0 > ioctl(fd, WDIOC_SETTIMEOUT, &timeout)) {
    
60.         fprintf(stderr, "ioctl error: WDIOC_SETTIMEOUT: %s\n", strerror(errno));
    
61.         close(fd);
    
62.         exit(EXIT_FAILURE);
    
63.     }
    
64. 
    
65.     /* 开启看门狗计时器 */
    
66.     op = WDIOS_ENABLECARD;
    
67.     if (0 > ioctl(fd, WDIOC_SETOPTIONS, &op)) {
    
68.         fprintf(stderr, "ioctl error: WDIOC_SETOPTIONS: %s\n", strerror(errno));
    
69.         close(fd);
    
70.         exit(EXIT_FAILURE);
    
71.     }
    
72. 
    
73.     /* 喂狗 */
    
74.     time = (timeout * 1000 - 100) * 1000;//喂狗时间设置us微秒、在超时时间到来前100ms喂狗
    
75.     for ( ; ; ) {
    
76. 
    
77.         usleep(time);
    
78.         ioctl(fd, WDIOC_KEEPALIVE, NULL);
    
79.     }
    
80. }

复制代码

       示例代码很简单，首先打开看门狗设备，接着使用WDIOC_SETOPTIONS指令（op = WDIOS_DISABLECARD）先停止看门狗计时器；接着通过atoi获取到用户传入的超时时间，所以执行该测试程序的时候，需要传入一个参数作为看门狗超时时间。
       接着使用WDIOC_SETTIMEOUT指令设置超时时间，再使用WDIOC_SETOPTIONS指令（op = WDIOS_ENABLECARD）开启看门狗计时器，看门狗开始工作。接着我们需要在超时时间到来之前，去喂狗，喂狗之后，计时器重置，重新计时；不断地喂狗重置计时器、不让其超时、如果一旦超时系统将会复位重启。
编译示例代码：

图 28.2.1 编译示例代码

       将编译得到的可执行文件拷贝到开发板Linux系统/home/root目录下，执行测试程序，譬如启动看门狗，设置超时时间为2秒钟，如下：

图 28.2.2 开启看门狗2秒超时时间

       执行程序之后，开门狗计时器就已经启动了，程序中会不断的喂狗重置计时器，以保证程序不会重启。
       现在我们按Ctrl + C结束程序，结束程序意味着已经停止喂狗了、然后看门狗计时器并没有停止，这样将会导致计时器溢出、发生复位重启：

图 28.2.3 计时器溢出系统重启

       当按Ctrl+C终止进程后，内核打印出“watchdog watchdog0: watchdog did not stop!”信息，表示看门狗计时器还正在计时、未停止。