Linux嵌入式系统开发 - 开门狗 - 驱动篇

今天就正式开始有关linux嵌入式系统开发之看门狗---驱动篇的讲解:

首先，咱们先看看有关S3C2440上看门狗的硬件电路：

 

     从结构图和数据手册得知，看门狗Watchdog主要是实现系统自动复位的功能，它是利用芯片内部的定时器，定时输出连接到电路的复位端，程序在一定时间范围内对定时器清零(俗称“喂狗”)，当程序在正常工作时，定时器总是不能溢出，也就不能产生复位信号；一旦程序出现错误，可能就无法在定时周期内复位看门狗，那么定时器就会溢出而产生复位信号使系统复位。

     S3C2440的Watchdog模块提供了三个寄存器来对Watchdog进行操作，他们分别是：定时器控制寄存器WTCON、定时器数据寄存器WTDAT和定时器计数寄存器WTCNT。注意：在对定时器数据寄存器WTDAT进行操作时必须在定时器控制寄存器WTCON使能之前写入一个计数目标值，当Watchdog使能开启后，WTDAT中的值会自动被加载到计数寄存器WTCNT中，然后Watchdog从CPU内部的时钟分频和时钟除数因子得到一个工作周期，当每个周期结束时计数寄存器WTCNT中的值会1，直到递减为0时，如果还不重新往WTCNT中写入新的计数目标值(即“喂狗”)，则 Watchdog就产生复位信号使系统复位。

   了解了大致的硬件原理后，咱们就开始结合驱动程序源代码，来讲解有关看门狗驱动程序的写法。

//必要的头文件
#define S3C_VA_WATCHDOG (0)
#define PFX "s3c2410-wdt:"
#define CONFIG_S3C2410_WATCHDOG_ATBOOT  (0)
#define CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME  (15)
static int nowayout = WATCHDOG_NOWAYOUT;
//nowayout与CONFIG_WATCHDOG_NOWAYOUT配置相关，其一旦配置应用层调用close函数将不能关闭看门狗
static int tmr_margin = CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME;//默认的喂狗时间
static int tmr_atboot = CONFIG_S3C2410_WATCHDOG_ATBOOT;
//关于tmr_atboot，要想系统一上电自动使能看门狗，就为1。最好使用0，由于我们想通过open函数来打开看门狗
static int soft_noboot;
//soft_noboot为1时看门狗将作为一般的中断定时器使用，为0时作为可复位电路的看门狗，默认为0
static int debug;  调式模式
/*驱动程序模块参数，如果在加载驱动模块时没有设定这些参数，则这些参数将采用默认值，
这些参数在接下来的步骤中将被一一用到，参数具体作用也将在各步骤中来说明*/
module_param(tmr_margin, int, 0);
module_param(tmr_atboot, int, 0);
module_param(nowayout, int, 0);
module_param(soft_noboot, int, 0);
module_param(debug, int, 0);
//下面的这些没什么大的作用，就是为了做参数描述
MODULE_PARM_DESC(tmr_margin, "Watchdog tmr_margin in seconds. default="
__MODULE_STRING(CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME) ")");
MODULE_PARM_DESC(tmr_atboot, "Watchdog is started at boot time if set to 1, default="
__MODULE_STRING(CONFIG_S3C2410_WATCHDOG_ATBOOT));
MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
MODULE_PARM_DESC(soft_noboot, "Watchdog action, set to 1 to ignore reboots, "
"0 to reboot (default depends on ONLY_TESTING)");
MODULE_PARM_DESC(debug, "Watchdog debug, set to >1 for debug, (default 0)");
static unsigned long open_lock;
static struct device *wdt_dev;    /* platform device attached to */
//用来保存watchdog的IO端口占用的IO空间和经过虚拟映射后的内存地址
static struct resource *wdt_mem;
static void __iomem *wdt_base;
static struct resource *wdt_irq;
//保存从平台时钟队列中获取watchdog的时钟
static struct clk *wdt_clock;
//用于保存经计算后得到的计数寄存器WTCNT的计数值
static unsigned int wdt_count;
static char expect_close;
static DEFINE_SPINLOCK(wdt_lock);
/* watchdog control routines */
#define DBG(msg...) do { \ //打印调试信息
if (debug) printk(KERN_INFO msg); } while (0)
/* functions */
static void s3c2410wdt_keepalive(void) //喂狗
{
spin_lock(&wdt_lock);//获取自旋锁保护临界区资源 
writel(wdt_count, wdt_base + S3C2410_WTCNT);//往计数寄存器WTCNT重新写入计数值
spin_unlock(&wdt_lock);//释放自旋锁
}
static void __s3c2410wdt_stop(void)
{
unsigned long wtcon;
//停止看门狗定时器
wtcon = readl(wdt_base + S3C2410_WTCON);
wtcon &= ~(S3C2410_WTCON_ENABLE | S3C2410_WTCON_RSTEN);
writel(wtcon, wdt_base + S3C2410_WTCON);
}
static void s3c2410wdt_stop(void)
{
spin_lock(&wdt_lock);//获取自旋锁保护临界区资源
__s3c2410wdt_stop();
spin_unlock(&wdt_lock);//释放自旋锁，即解锁
}
static void s3c2410wdt_start(void)
{
unsigned long wtcon;
spin_lock(&wdt_lock);
__s3c2410wdt_stop();
wtcon = readl(wdt_base + S3C2410_WTCON);
wtcon |= S3C2410_WTCON_ENABLE | S3C2410_WTCON_DIV128;
if (soft_noboot) {
wtcon |= S3C2410_WTCON_INTEN;//该为1时，看门狗为一般定时器产生中断
wtcon &= ~S3C2410_WTCON_RSTEN;//重启无效
} else {
wtcon &= ~S3C2410_WTCON_INTEN;//默认为可复位
wtcon |= S3C2410_WTCON_RSTEN;
}
DBG("%s: wdt_count=0x%08x, wtcon=%08lx\n",__func__, wdt_count, wtcon);
writel(wdt_count, wdt_base + S3C2410_WTDAT);
writel(wdt_count, wdt_base + S3C2410_WTCNT);
writel(wtcon, wdt_base + S3C2410_WTCON);
spin_unlock(&wdt_lock);
}
//计算并设置看门狗定时器时钟周期值并初始化看门狗定时器 
static int s3c2410wdt_set_heartbeat(int timeout)
{
unsigned int freq = clk_get_rate(wdt_clock);
unsigned int count;
unsigned int divisor = 1;
unsigned long wtcon;
if (timeout < 1)
return -EINVAL;
freq /= 128;
count = timeout * freq;
DBG("%s: count=%d, timeout=%d, freq=%d\n",__func__, count, timeout, freq);
if (count >= 0x10000) {
for (divisor = 1; divisor <= 0x100; divisor++) {
if ((count / divisor) < 0x10000)
break;
}
        if ((count / divisor) >= 0x10000) {
dev_err(wdt_dev, "timeout %d too big\n", timeout);
return -EINVAL;
}
}
tmr_margin = timeout;
DBG("%s: timeout=%d, divisor=%d, count=%d (%08x)\n",__func__, timeout, divisor, count, count/divisor);
count /= divisor;
wdt_count = count;
//看数据手册得到,wtcon=1000000000100001 这是控制寄存器的默认值
wtcon = readl(wdt_base + S3C2410_WTCON);
wtcon &= ~S3C2410_WTCON_PRESCALE_MASK;
/*wtcon=1000000000100001 & ~1111111100000000 = 0000000000100001
S3C2410_WTCON_PRESCALE宏是将divisor-1的值向左位移8位，也就是说该值的右8位都为0，则计算如下：
wtcon=0000000000100001 | (xxxxxxxx)00000000 = (xxxxxxxx)00100001
*/
wtcon |= S3C2410_WTCON_PRESCALE(divisor-1);
//设置看门狗定时器数据寄存器WTDAT的值，然后WTDAT的值会自动加载到WTCNT中 
writel(count, wdt_base + S3C2410_WTDAT);
writel(wtcon, wdt_base + S3C2410_WTCON);
return 0;
}
//看门狗设备驱动的打开接口函数
static int s3c2410wdt_open(struct inode *inode, struct file *file)
{
if (test_and_set_bit(0, &open_lock))//试着获取信号量(即：加锁)，如果获取不成功，说明其他进程此时占用了，就返回忙
return -EBUSY;
    if (nowayout) //如果内核配置了CONFIG_WATCHDOG_NOWAYOUT项，则使模块使用计数加1
__module_get(THIS_MODULE);
expect_close = 0;
//开启看门狗定时器
s3c2410wdt_start();
//表示返回的这个设备文件是不可以被seek操作的，nonseekable_open定义在fs.h中
return nonseekable_open(inode, file);
}
//看门狗设备驱动的关闭接口函数
static int s3c2410wdt_release(struct inode *inode, struct file *file)
{
// 如果判断到当前操作状态是可以关闭看门狗定时器时就关闭，否则就是“喂狗”状态
if (expect_close == 42)
s3c2410wdt_stop();
else {
dev_err(wdt_dev, "Unexpected close, not stopping watchdog\n");
s3c2410wdt_keepalive();//喂狗
}
expect_close = 0;
clear_bit(0, &open_lock);
return 0;
}
static ssize_t s3c2410wdt_write(struct file *file, const char __user *data,
size_t len, loff_t *ppos)
{
//刷新定时器
if (len) {
if (!nowayout) {
size_t i;
/* In case it was set long ago */
expect_close = 0;
for (i = 0; i != len; i++) {
char c;
if (get_user(c, data + i))
return -EFAULT;
if (c == 'V')//写入字符 V容许关闭看门狗，但前提还是不配置CONFIG_WATCHDOG_NOWAYOUT
expect_close = 42;
}
}
s3c2410wdt_keepalive();//喂狗
}
return len;
}
//用于支持看门狗IO控制中获取看门狗信息的命令WDIOC_GETSUPPORT，下面的宏和看门狗信息结构体定义在watchdog.h中
#define OPTIONS (WDIOF_SETTIMEOUT | WDIOF_KEEPALIVEPING | WDIOF_MAGICCLOSE)
static const struct watchdog_info s3c2410_wdt_ident = {
.options = OPTIONS,
.firmware_version = 0,
.identity = "S3C2410 Watchdog",
};
//看门狗设备驱动的IO控制接口函数
static long s3c2410wdt_ioctl(struct file *file,    unsigned int cmd, unsigned long arg)
{
void __user *argp = (void __user *)arg;
int __user *p = argp;
int new_margin;
//以下对看门狗定时器IO控制的命令定义在watchdog.h中
switch (cmd) {
case WDIOC_GETSUPPORT://获取看门狗的支持信息，wdt_ident定义在上面
return copy_to_user(argp, &s3c2410_wdt_ident,sizeof(s3c2410_wdt_ident)) ? -EFAULT : 0;
case WDIOC_GETSTATUS://获取看门狗状态
case WDIOC_GETBOOTSTATUS:
return put_user(0, p);
case WDIOC_KEEPALIVE://喂狗命令
s3c2410wdt_keepalive();
return 0;
case WDIOC_SETTIMEOUT://设置定时器溢出时间值命令(以秒为单位)
if (get_user(new_margin, p))//获取时间值
return -EFAULT;
if (s3c2410wdt_set_heartbeat(new_margin))//设置到计数寄存器WTCNT中
return -EINVAL;
s3c2410wdt_keepalive();//喂狗
return put_user(tmr_margin, p);
case WDIOC_GETTIMEOUT://读取定时器默认溢出时间值命令
return put_user(tmr_margin, p);
default:
return -ENOTTY;
}
}
//字符设备的相关操作实现
static const struct file_operations s3c2410wdt_fops = {
.owner = THIS_MODULE,
.llseek = no_llseek,//定义为不可定位，即屏蔽seek操作，no_llseek定义在fs.h中
.write = s3c2410wdt_write,
.unlocked_ioctl = s3c2410wdt_ioctl,
.open = s3c2410wdt_open,
.release = s3c2410wdt_release,
};
//混杂设备结构体
static struct miscdevice s3c2410wdt_miscdev = {
.minor  = WATCHDOG_MINOR,//WATCHDOG_MINOR为次设备号定义在miscdevice.h中为130
.name = "watchdog", //设备名称
.fops = &s3c2410wdt_fops,//实现字符设备的相关操作
};
//看门狗定时器中断服务程序
static irqreturn_t s3c2410wdt_irq(int irqno, void *param)
{
dev_info(wdt_dev, "watchdog timer expired (irq)\n");
//主要要做的事情是在看门狗定时器计数寄存器值递减到0之前重新写入新值(即：“喂狗”)
s3c2410wdt_keepalive();
return IRQ_HANDLED;
}
/* device interface */
static int __devinit s3c2410wdt_probe(struct platform_device *pdev)
{
struct resource *res; //定义一个资源，用来保存获取的watchdog的IO资源
struct device *dev;
unsigned int wtcon;
int started = 0;
int ret;
int size;
//DBG一般在其出现的文件的开始部分，作为打印debug信息用.这句话实现打印它所在函数的函数名称
DBG("%s: probe=%p\n", __func__, pdev);
dev = &pdev->dev;
wdt_dev = &pdev->dev;
//获取watchdog平台设备所使用的IO端口资源，注意这个IORESOURCE_MEM标志和watchdog平台设备定义中的一致
res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
if (res == NULL) {
dev_err(dev, "no memory resource specified\n");
return -ENOENT;
}
size = (res->end - res->start) + 1;
//request_mem_region 标记这段物理地址自己使用了，其他人不要使用而已，也不是必须的。
wdt_mem = request_mem_region(res->start, size, pdev->name);
if (wdt_mem == NULL) {
dev_err(dev, "failed to get memory region\n");
ret = -ENOENT;
goto err_req;
}
//将watchdog的IO端口占用的这段IO空间映射到内存的虚拟地址，被映射数据的长度由size参数设定。
//该函数的实质是把一块物理区域二次映射到一个可以从驱动程序里访问的虚拟地址上去。
wdt_base = ioremap(res->start, size);
if (wdt_base == NULL) {
dev_err(dev, "failed to ioremap() region\n");
ret = -EINVAL;
goto err_req;
}
DBG("probe: mapped wdt_base=%p\n", wdt_base);
//在系统定义的watchdog平台设备中获取watchdog中断号platform_get_irq定义在platform_device.h中
wdt_irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
if (wdt_irq == NULL) {///*获取watchdog中断号不成功错误处理
dev_err(dev, "no irq resource specified\n");
ret = -ENOENT;
goto err_map;
}
//申请Watchdog中断服务.中断服务程序为:s3c2410wdt_irq，将Watchdog平台设备pdev做参数传递过去了 
ret = request_irq(wdt_irq->start, s3c2410wdt_irq, 0, pdev->name, pdev);
if (ret != 0) {
dev_err(dev, "failed to install irq (%d)\n", ret);
goto err_map;
}
/*从平台时钟队列中获取watchdog的时钟，看门狗定时器的工作周期是由这个时钟和时钟除数因子得到的。
注意这里的watchdog参数要与系统中定义的时钟名称一致才能获取得到，也就是说，系统必须先定义得
有watchdog。系统的一些时钟定义在arch/arm/plat-s3c24xx/s3c2410-clock.c中
*/
wdt_clock = clk_get(&pdev->dev, "watchdog");
if (IS_ERR(wdt_clock)) {
dev_err(dev, "failed to find watchdog clock source\n");
ret = PTR_ERR(wdt_clock);
goto err_irq;
}
//时钟获取后要使能后才可以使用，clk_enable定义在arch/arm/plat-s3c/clock.c中
clk_enable(wdt_clock);
//通过上面的步骤已经将watchdog的资源都准备好了，下面就开始使用啦 
//这里是计算并设置看门狗定时器时钟周期值,其实这里就是初始化看门狗定时器,wdt_set_heartbeat定义在下面。
if(s3c2410wdt_set_heartbeat(tmr_margin)) {
//调用两次的意思是看能不能设置成期望的值，如果不能就设置默认的值
started = s3c2410wdt_set_heartbeat(CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
if (started == 0)
dev_info(dev, "tmr_margin value out of range, default %d used\n",CONFIG_S3C2410_WATCHDOG_DEFAULT_TIME);
else
dev_info(dev, "default timer value is out of range, cannot start\n");
}
//把wdt又注册为一个杂项设备
ret = misc_register(&s3c2410wdt_miscdev);
if (ret) {
dev_err(dev, "cannot register miscdev on minor=%d (%d)\n",
WATCHDOG_MINOR, ret);
goto err_clk;
}
if (tmr_atboot && started == 0) {
dev_info(dev, "starting watchdog timer\n");
s3c2410wdt_start();//如果此时看门狗还没有开启，现在就调用函数开启
} else if (!tmr_atboot) {
s3c2410wdt_stop();
}
wtcon = readl(wdt_base + S3C2410_WTCON);
dev_info(dev, "watchdog %sactive, reset %sabled, irq %sabled\n",
(wtcon & S3C2410_WTCON_ENABLE) ?  " " : "in",
(wtcon & S3C2410_WTCON_RSTEN) ? "" : "dis",
(wtcon & S3C2410_WTCON_INTEN) ? "" : "en");
return 0;
err_clk:
clk_disable(wdt_clock);
clk_put(wdt_clock);
err_irq:
free_irq(wdt_irq->start, pdev);
err_map:
iounmap(wdt_base);
err_req:
release_resource(wdt_mem);
kfree(wdt_mem);
return ret;
}
static int __devexit s3c2410wdt_remove(struct platform_device *dev)
{
release_resource(wdt_mem);//释放获取的watchdog平台设备的IO资源
kfree(wdt_mem);
wdt_mem = NULL;
//同watchdog_probe中中断的申请相对应，在那里申请中断，这里就释放中断
free_irq(wdt_irq->start, dev);
wdt_irq = NULL;
//释放获取的Watchdog平台设备的时钟
clk_disable(wdt_clock);
clk_put(wdt_clock);
wdt_clock = NULL;
//释放Watchdog设备虚拟地址映射空间
iounmap(wdt_base);
//注销misc设备
misc_deregister(&s3c2410wdt_miscdev);
return 0;
}
//Watchdog平台驱动的设备关闭接口函数的实现
static void s3c2410wdt_shutdown(struct platform_device *dev)
{
s3c2410wdt_stop();
}
/*对Watchdog平台设备驱动电源管理的支持。CONFIG_PM这个宏定义在内核中，
当配置内核时选上电源管理，则Watchdog平台驱动的设备挂起和恢复功能均有效，
这时候你应该明白了在第②步中为什么要有device_init_wakeup(&pdev->dev, 1)这句吧*/
#ifdef CONFIG_PM
//定义两个变量来分别保存挂起时的WTCON和WTDAT值，到恢复的时候使用
static unsigned long wtcon_save;
static unsigned long wtdat_save;
//Watchdog平台驱动的设备挂起接口函数的实现
static int s3c2410wdt_suspend(struct platform_device *dev, pm_message_t state)
{
//保存看门狗的状态值，并且关闭它
wtcon_save = readl(wdt_base + S3C2410_WTCON);
wtdat_save = readl(wdt_base + S3C2410_WTDAT);
//停止看门狗定时器 
s3c2410wdt_stop();
return 0;
}
//Watchdog平台驱动的设备恢复接口函数的实现
static int s3c2410wdt_resume(struct platform_device *dev)
{
//恢复看门狗的状态
writel(wtdat_save, wdt_base + S3C2410_WTDAT);
writel(wtdat_save, wdt_base + S3C2410_WTCNT);  //重置寄存器
writel(wtcon_save, wdt_base + S3C2410_WTCON);
printk(KERN_INFO PFX "watchdog %sabled\n",(wtcon_save & S3C2410_WTCON_ENABLE) ? "en" : "dis");
return 0;
}
#else //如果配置内核时没选上电源管理,Watchdog平台驱动的设备挂起和恢复功能均无效,这两个函数也就无需实现了
#define s3c2410wdt_suspend NULL
#define s3c2410wdt_resume  NULL
#endif /* CONFIG_PM */
//Watchdog平台驱动结构体，平台驱动结构体定义在platform_device.h中
static struct platform_driver s3c2410wdt_driver = {
.probe = s3c2410wdt_probe,
.remove = __devexit_p(s3c2410wdt_remove),
.shutdown = s3c2410wdt_shutdown,
.suspend = s3c2410wdt_suspend,
.resume = s3c2410wdt_resume,
//注意这里的名称一定要和系统中定义平台设备的地方一致，这样才能把平台设备与该平台设备的驱动关联起来
.driver = {
.owner = THIS_MODULE,
.name = "s3c2410-wdt",
},
};
static char banner[] __initdata = KERN_INFO "S3C2410 Watchdog Timer, (c) 2004 Simtec Electronics\n";
static int __init watchdog_init(void)
{
printk(banner);
//将Watchdog注册成平台设备驱动
return platform_driver_register(&s3c2410wdt_driver);
}
static void __exit watchdog_exit(void)
{
//注销Watchdog平台设备驱动
platform_driver_unregister(&s3c2410wdt_driver);
}
module_init(watchdog_init);
module_exit(watchdog_exit);
MODULE_AUTHOR("hanyan225");
MODULE_LICENSE("GPL");
MODULE_ALIAS_MISCDEV(WATCHDOG_MINOR); 

好了，以上就是完整的代码结构，小王，看的云里雾里吧（嘿嘿，看你还敢欺负人， 不知道天高地厚，不知我的技术能力不），没关系，下面我给你解释一些东西，然后给出一个完整的代码结构图，你呢，有个词叫按图索骥啥的，你就顺着来，问题应该就不会大的了：

 

      左边是我特意给你画的结构，相信有了这个结构图，你就会对整体的架构有一个了解，好了，你可能会问，你说看门狗是字符设备(char device),是平台设备(platform device) ,最后还是混杂设备(miscdevice).那它到底是啥设备，不用你问，下面我就来告诉你，这也是今天的最后一个内容了（看着小王对这几个概念

一头雾水，我也别卖关子了，告诉她得了)：曾看到这样一段话，说一粒花生，如果我们把它看作字符设备，当我们煮着炖着吃了，它就成了菜中的一个混杂设备，但是了它总是从挂在花生秧的根部上的一员长来了，因此它是可以作为一个花生秧苗中一个独立的设备而存在，所以就也可以定义为一个平台设备。这说明什么呢？字符设备是对其本质的描述，说明是串行，顺序访问的(而不是缓冲随机的)，混杂设备是存放这个字符设备的容器，即这个设备是被丢在使用了同一设备号的混杂设备里面，平台设备则是描述了设备的一种特性或者说属性。换句话说就是这个设备属于平台的独立模块，完全是一种附加的属性。

     唉吆我呀，这篇看门狗驱动篇，终于讲完了，从年前讲到年后，讲的那是混天暗地，日月无光，值得庆幸的是终于讲完了，成就？现在倒是没有，不过小王看的捶胸顿足，我的那个开心啊,哈哈