![Kees Cook](/assets/img/avatar_default.png)
This converts all remaining cases of the old setup_timer() API into using timer_setup(), where the callback argument is the structure already holding the struct timer_list. These should have no behavioral changes, since they just change which pointer is passed into the callback with the same available pointers after conversion. It handles the following examples, in addition to some other variations. Casting from unsigned long: void my_callback(unsigned long data) { struct something *ptr = (struct something *)data; ... } ... setup_timer(&ptr->my_timer, my_callback, ptr); and forced object casts: void my_callback(struct something *ptr) { ... } ... setup_timer(&ptr->my_timer, my_callback, (unsigned long)ptr); become: void my_callback(struct timer_list *t) { struct something *ptr = from_timer(ptr, t, my_timer); ... } ... timer_setup(&ptr->my_timer, my_callback, 0); Direct function assignments: void my_callback(unsigned long data) { struct something *ptr = (struct something *)data; ... } ... ptr->my_timer.function = my_callback; have a temporary cast added, along with converting the args: void my_callback(struct timer_list *t) { struct something *ptr = from_timer(ptr, t, my_timer); ... } ... ptr->my_timer.function = (TIMER_FUNC_TYPE)my_callback; And finally, callbacks without a data assignment: void my_callback(unsigned long data) { ... } ... setup_timer(&ptr->my_timer, my_callback, 0); have their argument renamed to verify they're unused during conversion: void my_callback(struct timer_list *unused) { ... } ... timer_setup(&ptr->my_timer, my_callback, 0); The conversion is done with the following Coccinelle script: spatch --very-quiet --all-includes --include-headers \ -I ./arch/x86/include -I ./arch/x86/include/generated \ -I ./include -I ./arch/x86/include/uapi \ -I ./arch/x86/include/generated/uapi -I ./include/uapi \ -I ./include/generated/uapi --include ./include/linux/kconfig.h \ --dir . \ --cocci-file ~/src/data/timer_setup.cocci @fix_address_of@ expression e; @@ setup_timer( -&(e) +&e , ...) // Update any raw setup_timer() usages that have a NULL callback, but // would otherwise match change_timer_function_usage, since the latter // will update all function assignments done in the face of a NULL // function initialization in setup_timer(). @change_timer_function_usage_NULL@ expression _E; identifier _timer; type _cast_data; @@ ( -setup_timer(&_E->_timer, NULL, _E); +timer_setup(&_E->_timer, NULL, 0); | -setup_timer(&_E->_timer, NULL, (_cast_data)_E); +timer_setup(&_E->_timer, NULL, 0); | -setup_timer(&_E._timer, NULL, &_E); +timer_setup(&_E._timer, NULL, 0); | -setup_timer(&_E._timer, NULL, (_cast_data)&_E); +timer_setup(&_E._timer, NULL, 0); ) @change_timer_function_usage@ expression _E; identifier _timer; struct timer_list _stl; identifier _callback; type _cast_func, _cast_data; @@ ( -setup_timer(&_E->_timer, _callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, &_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, &_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)&_callback, _E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, (_cast_func)&_callback, (_cast_data)_E); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E._timer, _callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, &_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, &_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)&_callback, (_cast_data)_E); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, (_cast_func)&_callback, (_cast_data)&_E); +timer_setup(&_E._timer, _callback, 0); | _E->_timer@_stl.function = _callback; | _E->_timer@_stl.function = &_callback; | _E->_timer@_stl.function = (_cast_func)_callback; | _E->_timer@_stl.function = (_cast_func)&_callback; | _E._timer@_stl.function = _callback; | _E._timer@_stl.function = &_callback; | _E._timer@_stl.function = (_cast_func)_callback; | _E._timer@_stl.function = (_cast_func)&_callback; ) // callback(unsigned long arg) @change_callback_handle_cast depends on change_timer_function_usage@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _origtype; identifier _origarg; type _handletype; identifier _handle; @@ void _callback( -_origtype _origarg +struct timer_list *t ) { ( ... when != _origarg _handletype *_handle = -(_handletype *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle = -(void *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle; ... when != _handle _handle = -(_handletype *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg | ... when != _origarg _handletype *_handle; ... when != _handle _handle = -(void *)_origarg; +from_timer(_handle, t, _timer); ... when != _origarg ) } // callback(unsigned long arg) without existing variable @change_callback_handle_cast_no_arg depends on change_timer_function_usage && !change_callback_handle_cast@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _origtype; identifier _origarg; type _handletype; @@ void _callback( -_origtype _origarg +struct timer_list *t ) { + _handletype *_origarg = from_timer(_origarg, t, _timer); + ... when != _origarg - (_handletype *)_origarg + _origarg ... when != _origarg } // Avoid already converted callbacks. @match_callback_converted depends on change_timer_function_usage && !change_callback_handle_cast && !change_callback_handle_cast_no_arg@ identifier change_timer_function_usage._callback; identifier t; @@ void _callback(struct timer_list *t) { ... } // callback(struct something *handle) @change_callback_handle_arg depends on change_timer_function_usage && !match_callback_converted && !change_callback_handle_cast && !change_callback_handle_cast_no_arg@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _handletype; identifier _handle; @@ void _callback( -_handletype *_handle +struct timer_list *t ) { + _handletype *_handle = from_timer(_handle, t, _timer); ... } // If change_callback_handle_arg ran on an empty function, remove // the added handler. @unchange_callback_handle_arg depends on change_timer_function_usage && change_callback_handle_arg@ identifier change_timer_function_usage._callback; identifier change_timer_function_usage._timer; type _handletype; identifier _handle; identifier t; @@ void _callback(struct timer_list *t) { - _handletype *_handle = from_timer(_handle, t, _timer); } // We only want to refactor the setup_timer() data argument if we've found // the matching callback. This undoes changes in change_timer_function_usage. @unchange_timer_function_usage depends on change_timer_function_usage && !change_callback_handle_cast && !change_callback_handle_cast_no_arg && !change_callback_handle_arg@ expression change_timer_function_usage._E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type change_timer_function_usage._cast_data; @@ ( -timer_setup(&_E->_timer, _callback, 0); +setup_timer(&_E->_timer, _callback, (_cast_data)_E); | -timer_setup(&_E._timer, _callback, 0); +setup_timer(&_E._timer, _callback, (_cast_data)&_E); ) // If we fixed a callback from a .function assignment, fix the // assignment cast now. @change_timer_function_assignment depends on change_timer_function_usage && (change_callback_handle_cast || change_callback_handle_cast_no_arg || change_callback_handle_arg)@ expression change_timer_function_usage._E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type _cast_func; typedef TIMER_FUNC_TYPE; @@ ( _E->_timer.function = -_callback +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -&_callback +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -(_cast_func)_callback; +(TIMER_FUNC_TYPE)_callback ; | _E->_timer.function = -(_cast_func)&_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -&_callback; +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -(_cast_func)_callback +(TIMER_FUNC_TYPE)_callback ; | _E._timer.function = -(_cast_func)&_callback +(TIMER_FUNC_TYPE)_callback ; ) // Sometimes timer functions are called directly. Replace matched args. @change_timer_function_calls depends on change_timer_function_usage && (change_callback_handle_cast || change_callback_handle_cast_no_arg || change_callback_handle_arg)@ expression _E; identifier change_timer_function_usage._timer; identifier change_timer_function_usage._callback; type _cast_data; @@ _callback( ( -(_cast_data)_E +&_E->_timer | -(_cast_data)&_E +&_E._timer | -_E +&_E->_timer ) ) // If a timer has been configured without a data argument, it can be // converted without regard to the callback argument, since it is unused. @match_timer_function_unused_data@ expression _E; identifier _timer; identifier _callback; @@ ( -setup_timer(&_E->_timer, _callback, 0); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, 0L); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E->_timer, _callback, 0UL); +timer_setup(&_E->_timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0L); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_E._timer, _callback, 0UL); +timer_setup(&_E._timer, _callback, 0); | -setup_timer(&_timer, _callback, 0); +timer_setup(&_timer, _callback, 0); | -setup_timer(&_timer, _callback, 0L); +timer_setup(&_timer, _callback, 0); | -setup_timer(&_timer, _callback, 0UL); +timer_setup(&_timer, _callback, 0); | -setup_timer(_timer, _callback, 0); +timer_setup(_timer, _callback, 0); | -setup_timer(_timer, _callback, 0L); +timer_setup(_timer, _callback, 0); | -setup_timer(_timer, _callback, 0UL); +timer_setup(_timer, _callback, 0); ) @change_callback_unused_data depends on match_timer_function_unused_data@ identifier match_timer_function_unused_data._callback; type _origtype; identifier _origarg; @@ void _callback( -_origtype _origarg +struct timer_list *unused ) { ... when != _origarg } Signed-off-by: Kees Cook <keescook@chromium.org>
318 lines
7 KiB
C
318 lines
7 KiB
C
/*
|
|
* Broadcom BCM63xx SoC watchdog driver
|
|
*
|
|
* Copyright (C) 2007, Miguel Gaio <miguel.gaio@efixo.com>
|
|
* Copyright (C) 2008, Florian Fainelli <florian@openwrt.org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version
|
|
* 2 of the License, or (at your option) any later version.
|
|
*/
|
|
|
|
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
|
|
|
|
#include <linux/bitops.h>
|
|
#include <linux/errno.h>
|
|
#include <linux/fs.h>
|
|
#include <linux/io.h>
|
|
#include <linux/kernel.h>
|
|
#include <linux/miscdevice.h>
|
|
#include <linux/module.h>
|
|
#include <linux/moduleparam.h>
|
|
#include <linux/types.h>
|
|
#include <linux/uaccess.h>
|
|
#include <linux/watchdog.h>
|
|
#include <linux/timer.h>
|
|
#include <linux/jiffies.h>
|
|
#include <linux/interrupt.h>
|
|
#include <linux/ptrace.h>
|
|
#include <linux/resource.h>
|
|
#include <linux/platform_device.h>
|
|
|
|
#include <bcm63xx_cpu.h>
|
|
#include <bcm63xx_io.h>
|
|
#include <bcm63xx_regs.h>
|
|
#include <bcm63xx_timer.h>
|
|
|
|
#define PFX KBUILD_MODNAME
|
|
|
|
#define WDT_HZ 50000000 /* Fclk */
|
|
#define WDT_DEFAULT_TIME 30 /* seconds */
|
|
#define WDT_MAX_TIME 256 /* seconds */
|
|
|
|
static struct {
|
|
void __iomem *regs;
|
|
struct timer_list timer;
|
|
unsigned long inuse;
|
|
atomic_t ticks;
|
|
} bcm63xx_wdt_device;
|
|
|
|
static int expect_close;
|
|
|
|
static int wdt_time = WDT_DEFAULT_TIME;
|
|
static bool nowayout = WATCHDOG_NOWAYOUT;
|
|
module_param(nowayout, bool, 0);
|
|
MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
|
|
__MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
|
|
|
|
/* HW functions */
|
|
static void bcm63xx_wdt_hw_start(void)
|
|
{
|
|
bcm_writel(0xfffffffe, bcm63xx_wdt_device.regs + WDT_DEFVAL_REG);
|
|
bcm_writel(WDT_START_1, bcm63xx_wdt_device.regs + WDT_CTL_REG);
|
|
bcm_writel(WDT_START_2, bcm63xx_wdt_device.regs + WDT_CTL_REG);
|
|
}
|
|
|
|
static void bcm63xx_wdt_hw_stop(void)
|
|
{
|
|
bcm_writel(WDT_STOP_1, bcm63xx_wdt_device.regs + WDT_CTL_REG);
|
|
bcm_writel(WDT_STOP_2, bcm63xx_wdt_device.regs + WDT_CTL_REG);
|
|
}
|
|
|
|
static void bcm63xx_wdt_isr(void *data)
|
|
{
|
|
struct pt_regs *regs = get_irq_regs();
|
|
|
|
die(PFX " fire", regs);
|
|
}
|
|
|
|
static void bcm63xx_timer_tick(struct timer_list *unused)
|
|
{
|
|
if (!atomic_dec_and_test(&bcm63xx_wdt_device.ticks)) {
|
|
bcm63xx_wdt_hw_start();
|
|
mod_timer(&bcm63xx_wdt_device.timer, jiffies + HZ);
|
|
} else
|
|
pr_crit("watchdog will restart system\n");
|
|
}
|
|
|
|
static void bcm63xx_wdt_pet(void)
|
|
{
|
|
atomic_set(&bcm63xx_wdt_device.ticks, wdt_time);
|
|
}
|
|
|
|
static void bcm63xx_wdt_start(void)
|
|
{
|
|
bcm63xx_wdt_pet();
|
|
bcm63xx_timer_tick(0);
|
|
}
|
|
|
|
static void bcm63xx_wdt_pause(void)
|
|
{
|
|
del_timer_sync(&bcm63xx_wdt_device.timer);
|
|
bcm63xx_wdt_hw_stop();
|
|
}
|
|
|
|
static int bcm63xx_wdt_settimeout(int new_time)
|
|
{
|
|
if ((new_time <= 0) || (new_time > WDT_MAX_TIME))
|
|
return -EINVAL;
|
|
|
|
wdt_time = new_time;
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int bcm63xx_wdt_open(struct inode *inode, struct file *file)
|
|
{
|
|
if (test_and_set_bit(0, &bcm63xx_wdt_device.inuse))
|
|
return -EBUSY;
|
|
|
|
bcm63xx_wdt_start();
|
|
return nonseekable_open(inode, file);
|
|
}
|
|
|
|
static int bcm63xx_wdt_release(struct inode *inode, struct file *file)
|
|
{
|
|
if (expect_close == 42)
|
|
bcm63xx_wdt_pause();
|
|
else {
|
|
pr_crit("Unexpected close, not stopping watchdog!\n");
|
|
bcm63xx_wdt_start();
|
|
}
|
|
clear_bit(0, &bcm63xx_wdt_device.inuse);
|
|
expect_close = 0;
|
|
return 0;
|
|
}
|
|
|
|
static ssize_t bcm63xx_wdt_write(struct file *file, const char *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')
|
|
expect_close = 42;
|
|
}
|
|
}
|
|
bcm63xx_wdt_pet();
|
|
}
|
|
return len;
|
|
}
|
|
|
|
static struct watchdog_info bcm63xx_wdt_info = {
|
|
.identity = PFX,
|
|
.options = WDIOF_SETTIMEOUT |
|
|
WDIOF_KEEPALIVEPING |
|
|
WDIOF_MAGICCLOSE,
|
|
};
|
|
|
|
|
|
static long bcm63xx_wdt_ioctl(struct file *file, unsigned int cmd,
|
|
unsigned long arg)
|
|
{
|
|
void __user *argp = (void __user *)arg;
|
|
int __user *p = argp;
|
|
int new_value, retval = -EINVAL;
|
|
|
|
switch (cmd) {
|
|
case WDIOC_GETSUPPORT:
|
|
return copy_to_user(argp, &bcm63xx_wdt_info,
|
|
sizeof(bcm63xx_wdt_info)) ? -EFAULT : 0;
|
|
|
|
case WDIOC_GETSTATUS:
|
|
case WDIOC_GETBOOTSTATUS:
|
|
return put_user(0, p);
|
|
|
|
case WDIOC_SETOPTIONS:
|
|
if (get_user(new_value, p))
|
|
return -EFAULT;
|
|
|
|
if (new_value & WDIOS_DISABLECARD) {
|
|
bcm63xx_wdt_pause();
|
|
retval = 0;
|
|
}
|
|
if (new_value & WDIOS_ENABLECARD) {
|
|
bcm63xx_wdt_start();
|
|
retval = 0;
|
|
}
|
|
|
|
return retval;
|
|
|
|
case WDIOC_KEEPALIVE:
|
|
bcm63xx_wdt_pet();
|
|
return 0;
|
|
|
|
case WDIOC_SETTIMEOUT:
|
|
if (get_user(new_value, p))
|
|
return -EFAULT;
|
|
|
|
if (bcm63xx_wdt_settimeout(new_value))
|
|
return -EINVAL;
|
|
|
|
bcm63xx_wdt_pet();
|
|
|
|
case WDIOC_GETTIMEOUT:
|
|
return put_user(wdt_time, p);
|
|
|
|
default:
|
|
return -ENOTTY;
|
|
|
|
}
|
|
}
|
|
|
|
static const struct file_operations bcm63xx_wdt_fops = {
|
|
.owner = THIS_MODULE,
|
|
.llseek = no_llseek,
|
|
.write = bcm63xx_wdt_write,
|
|
.unlocked_ioctl = bcm63xx_wdt_ioctl,
|
|
.open = bcm63xx_wdt_open,
|
|
.release = bcm63xx_wdt_release,
|
|
};
|
|
|
|
static struct miscdevice bcm63xx_wdt_miscdev = {
|
|
.minor = WATCHDOG_MINOR,
|
|
.name = "watchdog",
|
|
.fops = &bcm63xx_wdt_fops,
|
|
};
|
|
|
|
|
|
static int bcm63xx_wdt_probe(struct platform_device *pdev)
|
|
{
|
|
int ret;
|
|
struct resource *r;
|
|
|
|
timer_setup(&bcm63xx_wdt_device.timer, bcm63xx_timer_tick, 0);
|
|
|
|
r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
|
|
if (!r) {
|
|
dev_err(&pdev->dev, "failed to get resources\n");
|
|
return -ENODEV;
|
|
}
|
|
|
|
bcm63xx_wdt_device.regs = devm_ioremap_nocache(&pdev->dev, r->start,
|
|
resource_size(r));
|
|
if (!bcm63xx_wdt_device.regs) {
|
|
dev_err(&pdev->dev, "failed to remap I/O resources\n");
|
|
return -ENXIO;
|
|
}
|
|
|
|
ret = bcm63xx_timer_register(TIMER_WDT_ID, bcm63xx_wdt_isr, NULL);
|
|
if (ret < 0) {
|
|
dev_err(&pdev->dev, "failed to register wdt timer isr\n");
|
|
return ret;
|
|
}
|
|
|
|
if (bcm63xx_wdt_settimeout(wdt_time)) {
|
|
bcm63xx_wdt_settimeout(WDT_DEFAULT_TIME);
|
|
dev_info(&pdev->dev,
|
|
": wdt_time value must be 1 <= wdt_time <= 256, using %d\n",
|
|
wdt_time);
|
|
}
|
|
|
|
ret = misc_register(&bcm63xx_wdt_miscdev);
|
|
if (ret < 0) {
|
|
dev_err(&pdev->dev, "failed to register watchdog device\n");
|
|
goto unregister_timer;
|
|
}
|
|
|
|
dev_info(&pdev->dev, " started, timer margin: %d sec\n",
|
|
WDT_DEFAULT_TIME);
|
|
|
|
return 0;
|
|
|
|
unregister_timer:
|
|
bcm63xx_timer_unregister(TIMER_WDT_ID);
|
|
return ret;
|
|
}
|
|
|
|
static int bcm63xx_wdt_remove(struct platform_device *pdev)
|
|
{
|
|
if (!nowayout)
|
|
bcm63xx_wdt_pause();
|
|
|
|
misc_deregister(&bcm63xx_wdt_miscdev);
|
|
bcm63xx_timer_unregister(TIMER_WDT_ID);
|
|
return 0;
|
|
}
|
|
|
|
static void bcm63xx_wdt_shutdown(struct platform_device *pdev)
|
|
{
|
|
bcm63xx_wdt_pause();
|
|
}
|
|
|
|
static struct platform_driver bcm63xx_wdt_driver = {
|
|
.probe = bcm63xx_wdt_probe,
|
|
.remove = bcm63xx_wdt_remove,
|
|
.shutdown = bcm63xx_wdt_shutdown,
|
|
.driver = {
|
|
.name = "bcm63xx-wdt",
|
|
}
|
|
};
|
|
|
|
module_platform_driver(bcm63xx_wdt_driver);
|
|
|
|
MODULE_AUTHOR("Miguel Gaio <miguel.gaio@efixo.com>");
|
|
MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
|
|
MODULE_DESCRIPTION("Driver for the Broadcom BCM63xx SoC watchdog");
|
|
MODULE_LICENSE("GPL");
|
|
MODULE_ALIAS("platform:bcm63xx-wdt");
|