RM-Linux驱动--Watch Dog Timer(看门狗)驱动分析

from：http://blog.csdn.net/geekcome/article/details/6595265

硬件平台：FL2440

内核版本：2.6.28

主机平台：Ubuntu 11,04

内核版本：2.6.39

原创作品，转载请标明出处http://blog.csdn.net/yming0221/article/details/6595265

1、看门狗驱动的原理

下图是看门狗驱动的原理图

可以看出，PCLK是系统时钟，经过8位的预分频，然后再被分频（16、32、64、128）然后产生计数脉冲，进行计数，当计数器WTCNT加到0或减到0，然后产生中断，或引起系统复位。所以要隔一段时间，重置WTCNT的值，防止WTCNT减到0，称之“喂狗”。

2、驱动分析

下面是自己的驱动分析，如有理解错误，请指正

注，为了尽量是驱动容易理解，这个驱动暂时将有关电源管理的功能删除了，等理解透彻再完善

1. #include <linux/module.h>
2. #include <linux/moduleparam.h>
3. #include <linux/types.h>
4. #include <linux/timer.h>
5. #include <linux/miscdevice.h>
6. #include <linux/watchdog.h>
7. #include <linux/fs.h>
8. #include <linux/init.h>
9. #include <linux/platform_device.h>
10. #include <linux/interrupt.h>
11. #include <linux/clk.h>
12. #include <linux/uaccess.h>
13. #include <linux/io.h>
14. #include <mach/regs-gpio.h>
15. #include <mach/map.h>
16. #undef S3C_VA_WATCHDOG
17. #define S3C_VA_WATCHDOG (0)
18. #include <asm/plat-s3c/regs-watchdog.h>
19. #define PFX "s3c2410-wdt: "
20. #define CONFIG_S3C2410_WATCHDOG_ATBOOT      (0)
21. #define CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME    (15)
22. static int nowayout = WATCHDOG_NOWAYOUT;
23. static int tmr_margin   = CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME;
24. static int tmr_atboot   = CONFIG_S3C2410_WATCHDOG_ATBOOT;
25. static int soft_noboot = 1; //设置默认为执行中断
26. static int debug;
27. static int count;//用于计数，控制LED灯的亮灭
28. module_param(tmr_margin,  int, 0);
29. module_param(tmr_atboot,  int, 0);
30. module_param(nowayout,    int, 0);
31. module_param(soft_noboot, int, 0);
32. module_param(debug,   int, 0);
33. MODULE_PARM_DESC(tmr_margin, "Watchdog tmr_margin in seconds. default="
34. __MODULE_STRING(CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME) ")");
35. MODULE_PARM_DESC(tmr_atboot,
36. "Watchdog is started at boot time if set to 1, default="
37. __MODULE_STRING(CONFIG_S3C2410_WATCHDOG_ATBOOT));
38. MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
39. __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
40. MODULE_PARM_DESC(soft_noboot, "Watchdog action, set to 1 to ignore reboots, 0 to \
41. reboot (default depends on ONLY_TESTING)");
42. MODULE_PARM_DESC(debug, "Watchdog debug, set to >1 for debug, (default 0)");
43. typedef enum close_state
44. {
45. CLOSE_STATE_NOT,
46. CLOSE_STATE_ALLOW = 0x4021
47. } close_state_t;
48. static unsigned long open_lock;
49. static struct device    *wdt_dev;   /* platform device attached to */
50. static struct resource  *wdt_mem;//用来保存IO端口占用的内存资源
51. static struct resource  *wdt_irq;//保存wdt中断号
52. static struct clk   *wdt_clock;//保存从平台获取的watchdog时钟
53. static void __iomem *wdt_base;//经过ioremap后的内存基地址
54. static unsigned int  wdt_count;//保存向WTCNT写的计数值
55. static close_state_t     allow_close;
56. static DEFINE_SPINLOCK(wdt_lock);//定义一个自旋锁，用于资源的互斥访问
57. /* watchdog control routines */
58. #define DBG(msg...) do { \
59. if (debug) \
60. printk(KERN_INFO msg); \
61. } while (0)
62. /* functions */
63. //喂狗函数，实际上是将wdt_count写入WTCNT寄存器
64. static void s3c2410wdt_keepalive(void)
65. {
66. spin_lock(&wdt_lock);//给资源上锁
67. writel(wdt_count, wdt_base + S3C2410_WTCNT);//写WTCNT寄存器
68. spin_unlock(&wdt_lock);//解锁资源,下同
69. }
70. static void __s3c2410wdt_stop(void)
71. {
72. unsigned long wtcon;
73. wtcon = readl(wdt_base + S3C2410_WTCON);
74. wtcon &= ~(S3C2410_WTCON_ENABLE | S3C2410_WTCON_RSTEN);
75. writel(wtcon, wdt_base + S3C2410_WTCON);//设备看门狗使能无效、复位功能无效
76. }
77. //停止watchdog计时
78. static void s3c2410wdt_stop(void)
79. {
80. spin_lock(&wdt_lock);
81. __s3c2410wdt_stop();
82. spin_unlock(&wdt_lock);
83. }
84. //启动watchdog计时
85. static void s3c2410wdt_start(void)
86. {
87. unsigned long wtcon;
88. spin_lock(&wdt_lock);
89. __s3c2410wdt_stop();
90. wtcon = readl(wdt_base + S3C2410_WTCON);
91. wtcon |= S3C2410_WTCON_ENABLE | S3C2410_WTCON_DIV128;//看门狗定时器使能、时钟除数因子128
92. if (soft_noboot) //使用参数soft_noboot来选择看门狗到时是重启还是执行中断函数
93. {
94. wtcon |= S3C2410_WTCON_INTEN;//中断使能
95. wtcon &= ~S3C2410_WTCON_RSTEN;//复位功能无效
96. }
97. else
98. {
99. wtcon &= ~S3C2410_WTCON_INTEN;//中断不使能
100. wtcon |= S3C2410_WTCON_RSTEN;//复位功能有效
101. }
102. writel(wdt_count, wdt_base + S3C2410_WTDAT);//将wdt_count写入WTDAT
103. writel(wdt_count, wdt_base + S3C2410_WTCNT);//将wdt_count写入WTCNT
104. writel(wtcon, wdt_base + S3C2410_WTCON);//设置WTCON
105. spin_unlock(&wdt_lock);
106. }
107. //设置WatchDog周期timeout
108. static int s3c2410wdt_set_heartbeat(int timeout)
109. {
110. unsigned int freq = clk_get_rate(wdt_clock);
111. unsigned int count;
112. unsigned int divisor = 1;
113. unsigned long wtcon;
114. if (timeout < 1)
115. return -EINVAL;
116. freq /= 128;
117. count = timeout * freq;
118. /* if the count is bigger than the watchdog register,
119. then work out what we need to do (and if) we can
120. actually make this value
121. */
122. //如果计时的时间过大，则适当加大预分频值
123. if (count >= 0x10000)
124. {
125. for (divisor = 1; divisor <= 0x100; divisor++)
126. {
127. if ((count / divisor) < 0x10000)
128. break;
129. }
130. //若预分频最大仍不能满足计时周期，则报错
131. if ((count / divisor) >= 0x10000)
132. {
133. dev_err(wdt_dev, "timeout %d too big\n", timeout);
134. return -EINVAL;
135. }
136. }
137. tmr_margin = timeout;
138. count /= divisor;
139. wdt_count = count;
140. /* update the pre-scaler */
141. wtcon = readl(wdt_base + S3C2410_WTCON);
142. wtcon &= ~S3C2410_WTCON_PRESCALE_MASK;
143. wtcon |= S3C2410_WTCON_PRESCALE(divisor-1);
144. writel(count, wdt_base + S3C2410_WTDAT);//是指WTDAT寄存器
145. writel(wtcon, wdt_base + S3C2410_WTCON);//设置预分频值
146. return 0;
147. }
148. /*
149. *  /dev/watchdog handling
150. */
151. static int s3c2410wdt_open(struct inode *inode, struct file *file)
152. {
153. if (test_and_set_bit(0, &open_lock))//测试并设置open_lock第0位为1
154. return -EBUSY;
155. if (nowayout)
156. __module_get(THIS_MODULE);
157. allow_close = CLOSE_STATE_NOT;
158. /* start the timer */
159. s3c2410wdt_start();//启动watchdog
160. return nonseekable_open(inode, file);
161. }
162. static int s3c2410wdt_release(struct inode *inode, struct file *file)
163. {
164. /*
165. *  Shut off the timer.
166. *  Lock it in if it's a module and we set nowayout
167. */
168. if (allow_close == CLOSE_STATE_ALLOW)
169. s3c2410wdt_stop();
170. else
171. {
172. dev_err(wdt_dev, "Unexpected close, not stopping watchdog\n");
173. s3c2410wdt_keepalive();
174. }
175. allow_close = CLOSE_STATE_NOT;
176. clear_bit(0, &open_lock);//清楚open_lock第0位
177. return 0;
178. }
179. static ssize_t s3c2410wdt_write(struct file *file, const char __user *data,
180. size_t len, loff_t *ppos)
181. {
182. /*
183. *  Refresh the timer.
184. */
185. if (len)
186. {
187. if (!nowayout)
188. {
189. size_t i;
190. /* In case it was set long ago */
191. allow_close = CLOSE_STATE_NOT;
192. for (i = 0; i != len; i++)
193. {
194. char c;
195. if (get_user(c, data + i))//从用户空间copy数据
196. return -EFAULT;
197. if (c == 'V')//当输入V时，关闭watchdog
198. allow_close = CLOSE_STATE_ALLOW;
199. }
200. }
201. //注意：这里要手动喂狗一次?!
202. s3c2410wdt_keepalive();//由于将allow_close设置成CLOSE_STATE_ALLOW后，当release时无法再次喂狗
203. }
204. return len;
205. }
206. #define OPTIONS WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE
207. static const struct watchdog_info s3c2410_wdt_ident =
208. {
209. .options          =     OPTIONS,
210. .firmware_version = 0,
211. .identity         = "S3C2410 Watchdog",
212. };
213. //IO控制接口函数
214. static long s3c2410wdt_ioctl(struct file *file, unsigned int cmd,
215. unsigned long arg)
216. {
217. void __user *argp = (void __user *)arg;
218. int __user *p = argp;
219. int new_margin;
220. switch (cmd) {
221. case WDIOC_GETSUPPORT:
222. return copy_to_user(argp, &s3c2410_wdt_ident,
223. sizeof(s3c2410_wdt_ident)) ? -EFAULT : 0;
224. case WDIOC_GETSTATUS:
225. case WDIOC_GETBOOTSTATUS:
226. return put_user(0, p);
227. case WDIOC_KEEPALIVE:
228. s3c2410wdt_keepalive();
229. return 0;
230. case WDIOC_SETTIMEOUT:
231. if (get_user(new_margin, p))
232. return -EFAULT;
233. if (s3c2410wdt_set_heartbeat(new_margin))
234. return -EINVAL;
235. s3c2410wdt_keepalive();
236. return put_user(tmr_margin, p);
237. case WDIOC_GETTIMEOUT:
238. return put_user(tmr_margin, p);
239. default:
240. return -ENOTTY;
241. }
242. }
243. /* kernel interface */
244. //文件操作结构体
245. static const struct file_operations s3c2410wdt_fops =
246. {
247. .owner      = THIS_MODULE,
248. .llseek     = no_llseek,//屏蔽seek操作
249. .write      = s3c2410wdt_write,//写方法
250. .unlocked_ioctl = s3c2410wdt_ioctl,//控制方法
251. .open       = s3c2410wdt_open,//代开设备方法
252. .release    = s3c2410wdt_release,//关闭设备方法
253. };
254. static struct miscdevice s3c2410wdt_miscdev =
255. {
256. .minor      = WATCHDOG_MINOR,
257. .name       = "watchdog",
258. .fops       = &s3c2410wdt_fops,
259. };
260. /* interrupt handler code */
261. static irqreturn_t s3c2410wdt_irq(int irqno, void *param)
262. {
263. //dev_info(wdt_dev, "watchdog timer expired (irq)\n");
264. s3c2410_gpio_setpin(S3C2410_GPB10,(count++)%2);
265. s3c2410wdt_keepalive();
266. return IRQ_HANDLED;
267. }
268. /* device interface */
269. //注册设备时执行
270. static int s3c2410wdt_probe(struct platform_device *pdev)
271. {
272. struct resource *res;
273. struct device *dev;
274. unsigned int wtcon;
275. int started = 0;
276. int ret;
277. int size;
278. dev = &pdev->dev;
279. wdt_dev = &pdev->dev;
280. /* get the memory region for the watchdog timer */
281. //获取IO端口资源，这里 IORESOURCE_MEM和平台设备中资源的定义一致
282. res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
283. if (res == NULL) {
284. dev_err(dev, "no memory resource specified\n");
285. return -ENOENT;
286. }
287. size = (res->end - res->start) + 1;
288. //申请内存空间
289. wdt_mem = request_mem_region(res->start, size, pdev->name);
290. if (wdt_mem == NULL) {
291. dev_err(dev, "failed to get memory region\n");
292. ret = -ENOENT;
293. goto err_req;
294. }
295. //地址映射，wdt_base为基地址
296. wdt_base = ioremap(res->start, size);
297. if (wdt_base == NULL) {
298. dev_err(dev, "failed to ioremap() region\n");
299. ret = -EINVAL;
300. goto err_req;
301. }
302. DBG("probe: mapped wdt_base=%p\n", wdt_base);
303. //从平台设备中获取中断号
304. wdt_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
305. if (wdt_irq == NULL) {
306. dev_err(dev, "no irq resource specified\n");
307. ret = -ENOENT;
308. goto err_map;
309. }
310. //注册中断，中断处理函数s3c2410wdt_irq()
311. ret = request_irq(wdt_irq->start, s3c2410wdt_irq, 0, pdev->name, pdev);
312. if (ret != 0) {
313. dev_err(dev, "failed to install irq (%d)\n", ret);
314. goto err_map;
315. }
316. //获取系统时钟
317. wdt_clock = clk_get(&pdev->dev, "watchdog");
318. if (IS_ERR(wdt_clock)) {
319. dev_err(dev, "failed to find watchdog clock source\n");
320. ret = PTR_ERR(wdt_clock);
321. goto err_irq;
322. }
323. //使能时钟
324. clk_enable(wdt_clock);
325. /* see if we can actually set the requested timer margin, and if
326. * not, try the default value */
327. if (s3c2410wdt_set_heartbeat(tmr_margin))
328. {//这里第一次设置计时周期为tmr_margin，如果设置不成功，则重新设置为默认值
329. started = s3c2410wdt_set_heartbeat(
330. CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
331. if (started == 0)
332. dev_info(dev,
333. "tmr_margin value out of range, default %d used\n",
334. CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
335. else
336. dev_info(dev, "default timer value is out of range, cannot start\n");
337. }
338. //注册设备
339. ret = misc_register(&s3c2410wdt_miscdev);
340. if (ret)
341. {
342. dev_err(dev, "cannot register miscdev on minor=%d (%d)\n",
343. WATCHDOG_MINOR, ret);
344. goto err_clk;
345. }
346. if (tmr_atboot && started == 0)
347. {
348. dev_info(dev, "starting watchdog timer\n");
349. s3c2410wdt_start();//启动看门狗
350. }
351. else if (!tmr_atboot)
352. {
353. /* if we're not enabling the watchdog, then ensure it is
354. * disabled if it has been left running from the bootloader
355. * or other source */
356. s3c2410wdt_stop();
357. }
358. /* print out a statement of readiness */
359. wtcon = readl(wdt_base + S3C2410_WTCON);
360. dev_info(dev, "watchdog %sactive, reset %sabled, irq %sabled\n",
361. (wtcon & S3C2410_WTCON_ENABLE) ?  "" : "in",
362. (wtcon & S3C2410_WTCON_RSTEN) ? "" : "dis",
363. (wtcon & S3C2410_WTCON_INTEN) ? "" : "en");
364. //设置GPB10端口为输出端口，用于点亮LED10
365. s3c2410_gpio_cfgpin(S3C2410_GPB10,S3C2410_GPB10_OUTP);
366. return 0;
367. //出错跳转表，异常处理
368. err_clk:
369. clk_disable(wdt_clock);
370. clk_put(wdt_clock);
371. err_irq:
372. free_irq(wdt_irq->start, pdev);
373. err_map:
374. iounmap(wdt_base);
375. err_req:
376. release_resource(wdt_mem);
377. kfree(wdt_mem);
378. return ret;
379. }
380. //设备移除函数，释放资源和映射
381. static int s3c2410wdt_remove(struct platform_device *dev)
382. {
383. release_resource(wdt_mem);
384. kfree(wdt_mem);
385. wdt_mem = NULL;
386. free_irq(wdt_irq->start, dev);
387. wdt_irq = NULL;
388. clk_disable(wdt_clock);
389. clk_put(wdt_clock);
390. wdt_clock = NULL;
391. iounmap(wdt_base);
392. misc_deregister(&s3c2410wdt_miscdev);
393. return 0;
394. }
395. //关闭看门狗
396. static void s3c2410wdt_shutdown(struct platform_device *dev)
397. {
398. s3c2410wdt_stop();
399. }
400. //定义平台设备驱动
401. static struct platform_driver s3c2410wdt_driver = {
402. .probe      = s3c2410wdt_probe,
403. .remove     = s3c2410wdt_remove,
404. .shutdown   = s3c2410wdt_shutdown,
405. .driver     = {
406. .owner  = THIS_MODULE,
407. .name   = "s3c2410-wdt",//该名称参照内核源码中该资源的名称，两者必须一致
408. },
409. };
410. static char banner[] __initdata =
411. KERN_INFO "S3C2410 Watchdog Timer, (c) 2004 Simtec Electronics\n";
412. //驱动安装时执行
413. static int __init watchdog_init(void)
414. {
415. printk(banner);
416. return platform_driver_register(&s3c2410wdt_driver);//注册设备
417. }
418. //驱动移除是执行
419. static void __exit watchdog_exit(void)
420. {
421. platform_driver_unregister(&s3c2410wdt_driver);//移除设备
422. }
423. module_init(watchdog_init);
424. module_exit(watchdog_exit);
425. MODULE_AUTHOR("Yan Ming");
426. MODULE_DESCRIPTION("S3C2410 Watchdog Device Driver");
427. MODULE_LICENSE("GPL");
428. MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR);

设置默认不是重启机器，而是执行中断函数，当不喂狗，计数器减到0，点亮LED，然后喂狗，重新计数。