本文將介紹看門狗驅動的實現。

目標平臺：TQ2440

CPU：s3c2440

內核版本：2.6.30

1. 看門狗概述

看門狗其實就是一個定時器，當該定時器溢出前必須對看門狗進行"餵狗“，如果不這樣做，定時器溢出後則將復位CPU。

因此，看門狗通常用於對處於異常狀態的CPU進行復位。

具體的概念請自行百度。

2. S3C2440看門狗

s3c2440的看門狗的原理框圖如下：

可以看出，看門狗定時器的頻率由PCLK提供，其預分頻器最大取值為255+1；另外，通過MUX，可以進一步降低頻率。

定時器采用遞減模式，一旦到0，則可以觸發看門狗中斷以及RESET復位信號。

看門狗定時器的頻率的計算公式如下：

3. 看門狗驅動

看門狗驅動代碼位於： linux/drivers/char/watchdog/s3c2410_wdt.c

3.1 模塊註冊以及probe函數

1. static struct platform_driver s3c2410wdt_driver = {
2. .probe = s3c2410wdt_probe,
3. .remove = s3c2410wdt_remove,
4. .shutdown = s3c2410wdt_shutdown,
5. .suspend = s3c2410wdt_suspend,
6. .resume = s3c2410wdt_resume,
7. .driver = {
8. .owner = THIS_MODULE,
9. .name = "s3c2410-wdt",
10. },
11. };
13. static char banner[] __initdata =
14. KERN_INFO "S3C2410 Watchdog Timer, (c) 2004 Simtec Electronics\n";
16. static int __init watchdog_init(void){printk(banner);return platform_driver_register(&s3c2410wdt_driver);}
18. module_init(watchdog_init)

模塊的註冊函數很簡單，直接調用了 platform的驅動註冊函數platform_driver_register。

該函數在註冊時會調用驅動的probe方法，也即s3c2410wdt_probe函數。

我們來看下這個函數：

1. static int s3c2410wdt_probe(struct platform_device *pdev)
2. {
3. struct resource *res;
4. struct device *dev;
5. unsigned int wtcon;
6. int started = 0;
7. int ret;
8. int size;
10. DBG("%s: probe=%p\n", __func__, pdev);
12. dev = &pdev->dev;
13. wdt_dev = &pdev->dev;
15. /* get the memory region for the watchdog timer */
16. /*獲取平臺資源，寄存器地址範圍*/
17. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
18. if (res == NULL) {
19. dev_err(dev, "no memory resource specified\n");
20. return -ENOENT;
21. }
23. /*內存申請*/
24. size = (res->end - res->start) + 1;
25. wdt_mem = request_mem_region(res->start, size, pdev->name);
26. if (wdt_mem == NULL) {
27. dev_err(dev, "failed to get memory region\n");
28. ret = -ENOENT;
29. goto err_req;
30. }
32. /*內存映射*/
33. wdt_base = ioremap(res->start, size);
34. if (wdt_base == NULL) {
35. dev_err(dev, "failed to ioremap() region\n");
36. ret = -EINVAL;
37. goto err_req;
38. }
40. DBG("probe: mapped wdt_base=%p\n", wdt_base);
42. /*獲取平臺資源，看門狗定時器中斷號*/
43. wdt_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
44. if (wdt_irq == NULL) {
45. dev_err(dev, "no irq resource specified\n");
46. ret = -ENOENT;
47. goto err_map;
48. }
50. /*註冊看門狗定時器中斷*/
51. ret = request_irq(wdt_irq->start, s3c2410wdt_irq, 0, pdev->name, pdev);
52. if (ret != 0) {
53. dev_err(dev, "failed to install irq (%d)\n", ret);
54. goto err_map;
55. }
56. /*獲取看門狗模塊的時鐘*/
57. wdt_clock = clk_get(&pdev->dev, "watchdog");
58. if (IS_ERR(wdt_clock)) {
59. dev_err(dev, "failed to find watchdog clock source\n");
60. ret = PTR_ERR(wdt_clock);
61. goto err_irq;
62. }
64. /*使能該時鐘*/
65. clk_enable(wdt_clock);
67. /* see if we can actually set the requested timer margin, and if
68. * not, try the default value */
70. /*設置定時器模塊的時鐘頻率*/
71. if (s3c2410wdt_set_heartbeat(tmr_margin)) {
72. started = s3c2410wdt_set_heartbeat(
73. CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
75. if (started == 0)
76. dev_info(dev,
77. "tmr_margin value out of range, default %d used\n",
78. CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
79. else
80. dev_info(dev, "default timer value is out of range, cannot start\n");
81. }
83. /*註冊混雜設備，設備名watchdog，次設備號130*/
84. ret = misc_register(&s3c2410wdt_miscdev);
85. if (ret) {
86. dev_err(dev, "cannot register miscdev on minor=%d (%d)\n",
87. WATCHDOG_MINOR, ret);
88. goto err_clk;
89. }
91. /*
92. *如果需要在看門狗模塊加載時啟動看門狗則
93. *調用s3c2410wdt_start，否則調用s3c2410wdt_stop
94. */
96. if (tmr_atboot && started == 0) {
97. dev_info(dev, "starting watchdog timer\n");
98. s3c2410wdt_start();
99. } else if (!tmr_atboot) {
100. /* if we‘re not enabling the watchdog, then ensure it is
101. * disabled if it has been left running from the bootloader
102. * or other source */
104. s3c2410wdt_stop();
105. }
107. /* print out a statement of readiness */
108. /*讀取控制寄存器，打印目前看門狗的狀態*/
109. wtcon = readl(wdt_base + S3C2410_WTCON);
111. dev_info(dev, "watchdog %sactive, reset %sabled, irq %sabled\n",
112. (wtcon & S3C2410_WTCON_ENABLE) ? "" : "in",
113. (wtcon & S3C2410_WTCON_RSTEN) ? "" : "dis",
114. (wtcon & S3C2410_WTCON_INTEN) ? "" : "en");
116. return 0;
118. err_clk:
119. clk_disable(wdt_clock);
120. clk_put(wdt_clock);
122. err_irq:
123. free_irq(wdt_irq->start, pdev);
125. err_map:
126. iounmap(wdt_base);
128. err_req:
129. release_resource(wdt_mem);
130. kfree(wdt_mem);
132. return ret;
133. }

該函數的前面幾步和其他驅動的類似：獲取平臺資源後進行相應的註冊，並使能時鐘。接著，將調用s3c2410wdt_set_heartbeat函數來設置看門狗的工作頻率。

然後，註冊一個混雜設備，為看門狗註冊相應的API到內核中。最後，判斷是否需要啟動看門狗並調用相應的函數。

上面是probe函數大致的執行過程。隨後我們看下其中被調用的s3c2410wdt_set_heartbeat函數，該函數將設置看門狗的工作頻率。

PS：probe函數的執行依賴於平臺設備，而看門狗平臺設備的添加和註冊在linux/arch/arm/plat-s3c24xx/devs.c和 linux/arch/arm/mach-s3c2410/mach-smdk2410.c中已經完成，因此對於看門狗驅動無需進行移植。

3.2 s3c2410wdt_set_heartbeat

1. static int s3c2410wdt_set_heartbeat(int timeout) /*timeout 超時時間，單位秒*/
2. {
3. unsigned int freq = clk_get_rate(wdt_clock);
4. unsigned int count;
5. unsigned int divisor = 1;
6. unsigned long wtcon;
8. if (timeout < 1)
9. return -EINVAL;
11. freq /= 128; /*時鐘源為PCLK/128，不使用16 32 和64*/
12. count = timeout * freq; /*得出計數器值*/
14. DBG("%s: count=%d, timeout=%d, freq=%d\n",
15. __func__, count, timeout, freq);
17. /* if the count is bigger than the watchdog register,
18. then work out what we need to do (and if) we can
19. actually make this value
20. */
21. /*計數器最大值為0xFFFF，如果大於則要計算Prescaler value*/
22. if (count >= 0x10000) {
23. for (divisor = 1; divisor <= 0x100; divisor++) { /*Prescaler value最大為0xff*/
24. if ((count / divisor) < 0x10000)
25. break;
26. }
27. /*找不到合適的Prescaler value，報錯返回*/
28. if ((count / divisor) >= 0x10000) {
29. dev_err(wdt_dev, "timeout %d too big\n", timeout);
30. return -EINVAL;
31. }
32. }
34. tmr_margin = timeout; /*保存timeout*/
36. DBG("%s: timeout=%d, divisor=%d, count=%d (%08x)\n",
37. __func__, timeout, divisor, count, count/divisor);
39. count /= divisor; /*根據Prescaler value計算出新的計數器值*/
40. wdt_count = count; /*保存計數器值*/
42. /* update the pre-scaler */
43. /*
44. *設置預分頻計數器和數據寄存器
45. * NOTE:此時並未使能看門狗定時器
46. */
47. wtcon = readl(wdt_base + S3C2410_WTCON);
48. wtcon &= ~S3C2410_WTCON_PRESCALE_MASK;
49. wtcon |= S3C2410_WTCON_PRESCALE(divisor-1);
51. writel(count, wdt_base + S3C2410_WTDAT);
52. writel(wtcon, wdt_base + S3C2410_WTCON);
54. return 0;
55. }

形參timeout為定時時間，單位為秒。

這裏唯一需要註意的是freq/= 128這一步。在第2節我們看到，通過MUX，可選擇的分頻系數為16，32，64和128，但是在這裏驅動直接使用了128來計算系數。

在下一節我們將會看到，驅動為什麽在這裏只使用了128這個分頻系數。

當該函數調用結束時，Prescalervalue 和計數器值都將計算完成，並寫入寄存器。

3.3 定時器的啟動、停止和保活

3.3.1 停止

定時器的停止由 s3c2410wdt_stop函數完成。

1. static void __s3c2410wdt_stop(void)
2. {
3. unsigned long wtcon;
5. wtcon = readl(wdt_base + S3C2410_WTCON);
6. /*禁止看門狗，禁止RESET*/
7. wtcon &= ~(S3C2410_WTCON_ENABLE | S3C2410_WTCON_RSTEN);
8. writel(wtcon, wdt_base + S3C2410_WTCON);
9. }
11. static void s3c2410wdt_stop(void)
12. {
13. spin_lock(&wdt_lock);
14. __s3c2410wdt_stop();
15. spin_unlock(&wdt_lock);
16. }

3.3.2 啟動

定時器的啟動由s3c2410wdt_start函數完成。

1. static void s3c2410wdt_start(void)
2. {
3. unsigned long wtcon;
5. spin_lock(&wdt_lock);
7. __s3c2410wdt_stop(); ./*先禁止看門狗*/
9. wtcon = readl(wdt_base + S3C2410_WTCON); /*讀取控制寄存器*/
10. /*啟動定時器，設置分頻系數為128*/
11. wtcon |= S3C2410_WTCON_ENABLE | S3C2410_WTCON_DIV128;
13. if (soft_noboot) { /*判斷許是否需要RESET*/
14. wtcon |= S3C2410_WTCON_INTEN; /*使能看門狗中斷*/
15. wtcon &= ~S3C2410_WTCON_RSTEN; /*取消RESET*/
16. } else { /*復位*/
17. wtcon &= ~S3C2410_WTCON_INTEN; /*禁止看門狗中斷*/
18. wtcon |= S3C2410_WTCON_RSTEN; /*設置RESET*/
19. }
21. DBG("%s: wdt_count=0x%08x, wtcon=%08lx\n",
22. __func__, wdt_count, wtcon);
24. writel(wdt_count, wdt_base + S3C2410_WTDAT);
25. writel(wdt_count, wdt_base + S3C2410_WTCNT);
26. /*寫入控制器，此時將啟動看門狗定時器*/
27. writel(wtcon, wdt_base + S3C2410_WTCON);
28. spin_unlock(&wdt_lock);
29. }

在這裏我們到了一個宏S3C2410_WTCON_DIV128，這裏設置了分頻系數為128。而s3c2410wdt_start函數的調用肯定在s3c2410wdt_set_heartbeat之後，這也就是為什麽在3.2節中使用了freq/= 128這一步。

3.3.3 保活

定時器的保活由s3c2410wdt_keepalive函數完成。

1. static void s3c2410wdt_keepalive(void)
2. {
3. spin_lock(&wdt_lock);
4. writel(wdt_count, wdt_base + S3C2410_WTCNT); /*重置計數器值*/
5. spin_unlock(&wdt_lock);
6. }

最後需要說明的是，從3.1節probe函數的執行來看，由於tmr_atboot變量的初值為0，因此看門狗定時器是沒有工作的。

3.4 看門狗驅動API

看門狗驅動提供的API如下：

1. static const struct file_operations s3c2410wdt_fops = {
2. .owner = THIS_MODULE,
3. .llseek = no_llseek,
4. .write = s3c2410wdt_write,
5. .unlocked_ioctl = s3c2410wdt_ioctl,
6. .open = s3c2410wdt_open,
7. .release = s3c2410wdt_release,
8. };

我們可以看到驅動提供了4個API，同時，驅動並不支持llseek方法。

3.4.1 open方法

1. static int s3c2410wdt_open(struct inode *inode, struct file *file)
2. {
3. if (test_and_set_bit(0, &open_lock))/*看門狗設備文件只能open一次*/
4. return -EBUSY;
6. if (nowayout)
7. __module_get(THIS_MODULE); /*增加模塊引用計數*/
9. allow_close = CLOSE_STATE_NOT; /*設置標誌位，不允許關閉看門狗*/
11. /* start the timer */
12. s3c2410wdt_start(); /*啟動定時器*/
13. return nonseekable_open(inode, file); /*告知內核不支持llseek操作*/
14. }

這裏需要註意的是，設備文件/dev/watchdog 只能被open一次，大於一次的open都將返回-EBUSY。

3.4.2 release方法

1. static int s3c2410wdt_release(struct inode *inode, struct file *file)
2. {
3. /*
4. * Shut off the timer.
5. * Lock it in if it‘s a module and we set nowayout
6. */
7. /*狀態是允許關閉看門狗，則停止看門狗，否則保活*/
8. if (allow_close == CLOSE_STATE_ALLOW)
9. s3c2410wdt_stop();
10. else {
11. dev_err(wdt_dev, "Unexpected close, not stopping watchdog\n");
12. s3c2410wdt_keepalive();
13. }
14. allow_close = CLOSE_STATE_NOT; /*設置標誌位，不允許關閉看門狗*/
15. clear_bit(0, &open_lock);
16. return 0;
17. }

3.4.3 wirte方法

1. static ssize_t s3c2410wdt_write(struct file *file, const char __user *data,
2. size_t len, loff_t *ppos)
3. {
4. /*
5. * Refresh the timer.
6. */
7. if (len) {
8. /*nowayout 為真，不允許看門狗停止，使其保活*/
9. if (!nowayout) {
10. size_t i;
12. /* In case it was set long ago */
13. allow_close = CLOSE_STATE_NOT;/*設置標誌位，不允許關閉看門狗*/
15. for (i = 0; i != len; i++) {
16. char c;
18. if (get_user(c, data + i)) /*從用戶空間獲取一個字節的數據*/
19. return -EFAULT;
20. /*讀取到字符V，設置標誌位，允許關閉看門狗*/
21. if (c == ‘V‘)
22. allow_close = CLOSE_STATE_ALLOW;
23. }
24. }
25. s3c2410wdt_keepalive(); /*保活*/
26. }
27. return len;
28. }

只要寫入數據的長度不為0，都會調用s3c2410wdt_keepalive函數來重置定時器。

3.4.4 unlocked_ioctl方法

1. static long s3c2410wdt_ioctl(struct file *file, unsigned int cmd,
2. unsigned long arg)
3. {
4. void __user *argp = (void __user *)arg;
5. int __user *p = argp;
6. int new_margin;
8. switch (cmd) {
9. case WDIOC_GETSUPPORT:
10. return copy_to_user(argp, &s3c2410_wdt_ident,
11. sizeof(s3c2410_wdt_ident)) ? -EFAULT : 0;
12. case WDIOC_GETSTATUS:
13. case WDIOC_GETBOOTSTATUS:
14. return put_user(0, p);
15. case WDIOC_KEEPALIVE:
16. s3c2410wdt_keepalive();
17. return 0;
18. case WDIOC_SETTIMEOUT:
19. if (get_user(new_margin, p))
20. return -EFAULT;
21. if (s3c2410wdt_set_heartbeat(new_margin))
22. return -EINVAL;
23. s3c2410wdt_keepalive();
24. return put_user(tmr_margin, p);
25. case WDIOC_GETTIMEOUT:
26. return put_user(tmr_margin, p);
27. default:
28. return -ENOTTY;
29. }
30. }

4. 測試程序

1. #include <stdio.h>
2. #include <unistd.h>
3. #include <linux/watchdog.h>
4. #include <fcntl.h>
6. int main(void)
7. {
8. int fd, val, ret;
10. fd = open("/dev/watchdog", O_RDWR);
11. if(fd < 0){
12. printf("open device fail\n");
13. return -1;
14. }
16. while(1){
17. ret = write(fd, &val, sizeof(val));
18. if(ret < 0){
19. perror("watchdog write wrong\n");
20. return -1;
21. }
22. sleep(5);
23. }
25. return 0;
26. }

該測試程序每隔5秒重置看門狗定時器，而驅動默認的超時時間是15秒。

可以將5秒替換為16秒，你會發現系統自動重啟了。

5. 結束語

本文主要對基於S3C2440的看門狗驅動作出了分析。該驅動只是一個簡單的字符設備，比較簡單。其中，用於計算預分頻系數的s3c2410wdt_set_heartbeat函數比較關鍵，讀者可以好好琢磨下該系數是如何計算出來的。

Thank you for your time。

2013.1.30 添加測試程序

基於S3C2440的嵌入式Linux驅動——看門狗（watchdog）驅動解讀