mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-03 17:40:04 +00:00
![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>
259 lines
6.2 KiB
C
259 lines
6.2 KiB
C
/*
|
|
* Driver for the MTX-1 Watchdog.
|
|
*
|
|
* (C) Copyright 2005 4G Systems <info@4g-systems.biz>,
|
|
* All Rights Reserved.
|
|
* http://www.4g-systems.biz
|
|
*
|
|
* (C) Copyright 2007 OpenWrt.org, 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.
|
|
*
|
|
* Neither Michael Stickel nor 4G Systems admit liability nor provide
|
|
* warranty for any of this software. This material is provided
|
|
* "AS-IS" and at no charge.
|
|
*
|
|
* (c) Copyright 2005 4G Systems <info@4g-systems.biz>
|
|
*
|
|
* Release 0.01.
|
|
* Author: Michael Stickel michael.stickel@4g-systems.biz
|
|
*
|
|
* Release 0.02.
|
|
* Author: Florian Fainelli florian@openwrt.org
|
|
* use the Linux watchdog/timer APIs
|
|
*
|
|
* The Watchdog is configured to reset the MTX-1
|
|
* if it is not triggered for 100 seconds.
|
|
* It should not be triggered more often than 1.6 seconds.
|
|
*
|
|
* A timer triggers the watchdog every 5 seconds, until
|
|
* it is opened for the first time. After the first open
|
|
* it MUST be triggered every 2..95 seconds.
|
|
*/
|
|
|
|
#include <linux/module.h>
|
|
#include <linux/moduleparam.h>
|
|
#include <linux/types.h>
|
|
#include <linux/errno.h>
|
|
#include <linux/miscdevice.h>
|
|
#include <linux/fs.h>
|
|
#include <linux/ioport.h>
|
|
#include <linux/timer.h>
|
|
#include <linux/completion.h>
|
|
#include <linux/jiffies.h>
|
|
#include <linux/watchdog.h>
|
|
#include <linux/platform_device.h>
|
|
#include <linux/io.h>
|
|
#include <linux/uaccess.h>
|
|
#include <linux/gpio.h>
|
|
|
|
#include <asm/mach-au1x00/au1000.h>
|
|
|
|
#define MTX1_WDT_INTERVAL (5 * HZ)
|
|
|
|
static int ticks = 100 * HZ;
|
|
|
|
static struct {
|
|
struct completion stop;
|
|
spinlock_t lock;
|
|
int running;
|
|
struct timer_list timer;
|
|
int queue;
|
|
int default_ticks;
|
|
unsigned long inuse;
|
|
unsigned gpio;
|
|
unsigned int gstate;
|
|
} mtx1_wdt_device;
|
|
|
|
static void mtx1_wdt_trigger(struct timer_list *unused)
|
|
{
|
|
spin_lock(&mtx1_wdt_device.lock);
|
|
if (mtx1_wdt_device.running)
|
|
ticks--;
|
|
|
|
/* toggle wdt gpio */
|
|
mtx1_wdt_device.gstate = !mtx1_wdt_device.gstate;
|
|
gpio_set_value(mtx1_wdt_device.gpio, mtx1_wdt_device.gstate);
|
|
|
|
if (mtx1_wdt_device.queue && ticks)
|
|
mod_timer(&mtx1_wdt_device.timer, jiffies + MTX1_WDT_INTERVAL);
|
|
else
|
|
complete(&mtx1_wdt_device.stop);
|
|
spin_unlock(&mtx1_wdt_device.lock);
|
|
}
|
|
|
|
static void mtx1_wdt_reset(void)
|
|
{
|
|
ticks = mtx1_wdt_device.default_ticks;
|
|
}
|
|
|
|
|
|
static void mtx1_wdt_start(void)
|
|
{
|
|
unsigned long flags;
|
|
|
|
spin_lock_irqsave(&mtx1_wdt_device.lock, flags);
|
|
if (!mtx1_wdt_device.queue) {
|
|
mtx1_wdt_device.queue = 1;
|
|
mtx1_wdt_device.gstate = 1;
|
|
gpio_set_value(mtx1_wdt_device.gpio, 1);
|
|
mod_timer(&mtx1_wdt_device.timer, jiffies + MTX1_WDT_INTERVAL);
|
|
}
|
|
mtx1_wdt_device.running++;
|
|
spin_unlock_irqrestore(&mtx1_wdt_device.lock, flags);
|
|
}
|
|
|
|
static int mtx1_wdt_stop(void)
|
|
{
|
|
unsigned long flags;
|
|
|
|
spin_lock_irqsave(&mtx1_wdt_device.lock, flags);
|
|
if (mtx1_wdt_device.queue) {
|
|
mtx1_wdt_device.queue = 0;
|
|
mtx1_wdt_device.gstate = 0;
|
|
gpio_set_value(mtx1_wdt_device.gpio, 0);
|
|
}
|
|
ticks = mtx1_wdt_device.default_ticks;
|
|
spin_unlock_irqrestore(&mtx1_wdt_device.lock, flags);
|
|
return 0;
|
|
}
|
|
|
|
/* Filesystem functions */
|
|
|
|
static int mtx1_wdt_open(struct inode *inode, struct file *file)
|
|
{
|
|
if (test_and_set_bit(0, &mtx1_wdt_device.inuse))
|
|
return -EBUSY;
|
|
return nonseekable_open(inode, file);
|
|
}
|
|
|
|
|
|
static int mtx1_wdt_release(struct inode *inode, struct file *file)
|
|
{
|
|
clear_bit(0, &mtx1_wdt_device.inuse);
|
|
return 0;
|
|
}
|
|
|
|
static long mtx1_wdt_ioctl(struct file *file, unsigned int cmd,
|
|
unsigned long arg)
|
|
{
|
|
void __user *argp = (void __user *)arg;
|
|
int __user *p = (int __user *)argp;
|
|
unsigned int value;
|
|
static const struct watchdog_info ident = {
|
|
.options = WDIOF_CARDRESET,
|
|
.identity = "MTX-1 WDT",
|
|
};
|
|
|
|
switch (cmd) {
|
|
case WDIOC_GETSUPPORT:
|
|
if (copy_to_user(argp, &ident, sizeof(ident)))
|
|
return -EFAULT;
|
|
break;
|
|
case WDIOC_GETSTATUS:
|
|
case WDIOC_GETBOOTSTATUS:
|
|
put_user(0, p);
|
|
break;
|
|
case WDIOC_SETOPTIONS:
|
|
if (get_user(value, p))
|
|
return -EFAULT;
|
|
if (value & WDIOS_ENABLECARD)
|
|
mtx1_wdt_start();
|
|
else if (value & WDIOS_DISABLECARD)
|
|
mtx1_wdt_stop();
|
|
else
|
|
return -EINVAL;
|
|
return 0;
|
|
case WDIOC_KEEPALIVE:
|
|
mtx1_wdt_reset();
|
|
break;
|
|
default:
|
|
return -ENOTTY;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
|
|
static ssize_t mtx1_wdt_write(struct file *file, const char *buf,
|
|
size_t count, loff_t *ppos)
|
|
{
|
|
if (!count)
|
|
return -EIO;
|
|
mtx1_wdt_reset();
|
|
return count;
|
|
}
|
|
|
|
static const struct file_operations mtx1_wdt_fops = {
|
|
.owner = THIS_MODULE,
|
|
.llseek = no_llseek,
|
|
.unlocked_ioctl = mtx1_wdt_ioctl,
|
|
.open = mtx1_wdt_open,
|
|
.write = mtx1_wdt_write,
|
|
.release = mtx1_wdt_release,
|
|
};
|
|
|
|
|
|
static struct miscdevice mtx1_wdt_misc = {
|
|
.minor = WATCHDOG_MINOR,
|
|
.name = "watchdog",
|
|
.fops = &mtx1_wdt_fops,
|
|
};
|
|
|
|
|
|
static int mtx1_wdt_probe(struct platform_device *pdev)
|
|
{
|
|
int ret;
|
|
|
|
mtx1_wdt_device.gpio = pdev->resource[0].start;
|
|
ret = devm_gpio_request_one(&pdev->dev, mtx1_wdt_device.gpio,
|
|
GPIOF_OUT_INIT_HIGH, "mtx1-wdt");
|
|
if (ret < 0) {
|
|
dev_err(&pdev->dev, "failed to request gpio");
|
|
return ret;
|
|
}
|
|
|
|
spin_lock_init(&mtx1_wdt_device.lock);
|
|
init_completion(&mtx1_wdt_device.stop);
|
|
mtx1_wdt_device.queue = 0;
|
|
clear_bit(0, &mtx1_wdt_device.inuse);
|
|
timer_setup(&mtx1_wdt_device.timer, mtx1_wdt_trigger, 0);
|
|
mtx1_wdt_device.default_ticks = ticks;
|
|
|
|
ret = misc_register(&mtx1_wdt_misc);
|
|
if (ret < 0) {
|
|
dev_err(&pdev->dev, "failed to register\n");
|
|
return ret;
|
|
}
|
|
mtx1_wdt_start();
|
|
dev_info(&pdev->dev, "MTX-1 Watchdog driver\n");
|
|
return 0;
|
|
}
|
|
|
|
static int mtx1_wdt_remove(struct platform_device *pdev)
|
|
{
|
|
/* FIXME: do we need to lock this test ? */
|
|
if (mtx1_wdt_device.queue) {
|
|
mtx1_wdt_device.queue = 0;
|
|
wait_for_completion(&mtx1_wdt_device.stop);
|
|
}
|
|
|
|
misc_deregister(&mtx1_wdt_misc);
|
|
return 0;
|
|
}
|
|
|
|
static struct platform_driver mtx1_wdt_driver = {
|
|
.probe = mtx1_wdt_probe,
|
|
.remove = mtx1_wdt_remove,
|
|
.driver.name = "mtx1-wdt",
|
|
.driver.owner = THIS_MODULE,
|
|
};
|
|
|
|
module_platform_driver(mtx1_wdt_driver);
|
|
|
|
MODULE_AUTHOR("Michael Stickel, Florian Fainelli");
|
|
MODULE_DESCRIPTION("Driver for the MTX-1 watchdog");
|
|
MODULE_LICENSE("GPL");
|
|
MODULE_ALIAS("platform:mtx1-wdt");
|