[PATCHv3] watchdog: add support for the Synopsys DesignWare WDT

[jamie@jamieiles.com (Jamie Iles)]

Hi Viresh,

Thanks for the feedback, comments inline.

Jamie

On Fri, Jan 07, 2011 at 10:13:50PM +0530, viresh kumar wrote:
> On Fri, Jan 7, 2011 at 5:33 PM, Jamie Iles <jamie@jamieiles.com> wrote:
> 
> (...)
> 
> > diff --git a/drivers/watchdog/dw_wdt.c b/drivers/watchdog/dw_wdt.c
> > new file mode 100644
> > index 0000000..e0d0e377
> > --- /dev/null
> > +++ b/drivers/watchdog/dw_wdt.c
> > @@ -0,0 +1,300 @@
> 
> (...)
> 
> > +static inline int dw_wdt_is_enabled(void)
> > +{
> > +#define WDOG_CONTROL_REG_WDT_EN_MASK ? ? ? ? ? 0x01
> 
> can be moved to top, with other macros.
> 
> > + ? ? ? return readl(dw_wdt.regs + WDOG_CONTROL_REG_OFFSET) &
> > + ? ? ? ? ? ? ? WDOG_CONTROL_REG_WDT_EN_MASK;
> > +}
> > +
> 
> (...)
> 
> > +static void dw_wdt_keepalive(void)
> > +{
> > +#define WDOG_COUNTER_RESTART_KICK_VALUE ? ? ? ? ? ?0x76
> 
> ditto...

Ok, agreed.

> > + ? ? ? writel(WDOG_COUNTER_RESTART_KICK_VALUE, dw_wdt.regs +
> > + ? ? ? ? ? ? ?WDOG_COUNTER_RESTART_REG_OFFSET);
> > +}
> > +
> > +static int dw_wdt_open(struct inode *inode, struct file *filp)
> > +{
> > + ? ? ? /* Make sure we don't get unloaded. */
> > + ? ? ? __module_get(THIS_MODULE);
> > +
> > + ? ? ? spin_lock(&dw_wdt.lock);
> > + ? ? ? if (!dw_wdt_is_enabled()) {
> > + ? ? ? ? ? ? ? /*
> > + ? ? ? ? ? ? ? ?* The watchdog is not currently enabled. Set the timeout to
> > + ? ? ? ? ? ? ? ?* the maximum and then start it.
> > + ? ? ? ? ? ? ? ?*/
> > + ? ? ? ? ? ? ? dw_wdt_set_top(DW_WDT_MAX_TOP);
> 
> shouldn't we check return value here??

No, dw_wdt_set_top() can't fail, it just returns the timeout period that 
it set in seconds.  We use this when the user changes the timeout period 
as we may not be able to select the exact timeout period they chose, but 
here we just select the maximum timeout.

> > + ? ? ? ? ? ? ? writel(WDOG_CONTROL_REG_WDT_EN_MASK,
> > + ? ? ? ? ? ? ? ? ? ? ?dw_wdt.regs + WDOG_CONTROL_REG_OFFSET);
> > + ? ? ? }
> > + ? ? ? spin_unlock(&dw_wdt.lock);
> > +
> > + ? ? ? return nonseekable_open(inode, filp);
> > +}
> > +
> 
> (...)
> 
> > +static const struct dev_pm_ops dw_wdt_pm_ops = {
> > + ? ? ? .suspend ? ? ? ?= dw_wdt_suspend,
> > + ? ? ? .resume ? ? ? ? = dw_wdt_resume,
> > +};
> > +
> > +#define DW_WDT_PM_OPS ?(&dw_wdt_pm_ops)
> > +#else /* CONFIG_PM */
> > +#define DW_WDT_PM_OPS ?NULL
> > +#endif /* CONFIG_PM */
> 
> This can be rewritten as:
> static struct platform_driver dw_wdt_driver = {
> ...
> +#ifdef CONFIG_PM
>  ? ? ? ? ? ? ? .pm ? ? = dw_wdt_pm_ops,
> #endif
> }

Ok, that's clearer.

> > +static int __devinit dw_wdt_drv_probe(struct platform_device *pdev)
> > +{
> > + ? ? ? int ret;
> > + ? ? ? struct resource *mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> > +
> > + ? ? ? if (!mem)
> > + ? ? ? ? ? ? ? return -EINVAL;
> > +
> > + ? ? ? if (!devm_request_mem_region(&pdev->dev, mem->start, resource_size(mem),
> > + ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?"iomem"))
> > + ? ? ? ? ? ? ? return -ENOMEM;
> > +
> > + ? ? ? dw_wdt.regs = devm_ioremap(&pdev->dev, mem->start,
> > + ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?resource_size(mem));
> > + ? ? ? if (!dw_wdt.regs)
> > + ? ? ? ? ? ? ? return -ENOMEM;
> 
> should release mem_region in case of error.
> 
> > +
> > + ? ? ? dw_wdt.clk = clk_get(&pdev->dev, NULL);
> > + ? ? ? if (IS_ERR_OR_NULL(dw_wdt.clk))
> > + ? ? ? ? ? ? ? return -ENODEV;
> 
> should release mem_region and free ioremaped space.

We're using devres for the ioremap and region request so that takes care 
of the cleanup for us.  This also means we don't need to iounmap and 
release in the release method.

> Also, may be we can continue here in case of error too.
> Some platforms might nor support clock framework. You can enable and
> disable clk's if dw_wdt.clk is !NULL

The DesignWare watchdog has 16 timeout periods and these are derived 
from the clock frequency input to the WDT.  If we don't have a clk then 
we don't know how long the timeout periods.  The only alternative would 
be to have a 'struct dw_wdt_platform_data' that includes the input clock 
frequency which we use if we can't get a clk and get the rate.

> > + ? ? ? clk_enable(dw_wdt.clk);
> > +
> > + ? ? ? ret = misc_register(&dw_wdt_miscdev);
> > + ? ? ? if (ret)
> > + ? ? ? ? ? ? ? goto register_failed;
> > +
> > + ? ? ? return 0;
> > +
> > +register_failed:
> > + ? ? ? clk_disable(dw_wdt.clk);
> > + ? ? ? clk_put(dw_wdt.clk);
> 
> also iounmap and release_mem_region...
> 
> > +
> > + ? ? ? return ret;
> > +}
> > +
> > +static int __devexit dw_wdt_drv_remove(struct platform_device *pdev)
> > +{
> > + ? ? ? clk_disable(dw_wdt.clk);
> > + ? ? ? clk_put(dw_wdt.clk);
> > +
> > + ? ? ? misc_deregister(&dw_wdt_miscdev);
> 
> also iounmap and release_mem_region...
> 
> > +
> > + ? ? ? return 0;
> > +}
> > +
> > +static struct platform_driver dw_wdt_driver = {
> > + ? ? ? .probe ? ? ? ? ?= dw_wdt_drv_probe,
> > + ? ? ? .remove ? ? ? ? = __devexit_p(dw_wdt_drv_remove),
> > + ? ? ? .driver ? ? ? ? = {
> > + ? ? ? ? ? ? ? .name ? = "dw_wdt",
> > + ? ? ? ? ? ? ? .owner ?= THIS_MODULE,
> > + ? ? ? ? ? ? ? .pm ? ? = DW_WDT_PM_OPS,
> > + ? ? ? },
> > +};
> > +
> > +static int __init dw_wdt_watchdog_init(void)
> > +{
> > + ? ? ? spin_lock_init(&dw_wdt.lock);
> 
> This can be moved to probe. spin_lock_init should be only called when we have
> some device for this driver.

Agreed.

> > +
> > + ? ? ? return platform_driver_register(&dw_wdt_driver);
> > +}
> > +
> > +static void __exit dw_wdt_watchdog_exit(void)
> > +{
> > + ? ? ? platform_driver_unregister(&dw_wdt_driver);
> > +}
> > +
> > +module_init(dw_wdt_watchdog_init);
> > +module_exit(dw_wdt_watchdog_exit);
> 
> should be moved after init & exit routines without any blank lines.

Ok, thanks.