mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-06 02:24:14 +08:00
e99e88a9d2
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>
300 lines
6.6 KiB
C
300 lines
6.6 KiB
C
/*
|
|
* sma cpu5 watchdog driver
|
|
*
|
|
* Copyright (C) 2003 Heiko Ronsdorf <hero@ihg.uni-duisburg.de>
|
|
*
|
|
* 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.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
*
|
|
*/
|
|
|
|
#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
|
|
|
|
#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/io.h>
|
|
#include <linux/uaccess.h>
|
|
#include <linux/watchdog.h>
|
|
|
|
/* adjustable parameters */
|
|
|
|
static int verbose;
|
|
static int port = 0x91;
|
|
static int ticks = 10000;
|
|
static DEFINE_SPINLOCK(cpu5wdt_lock);
|
|
|
|
#define PFX "cpu5wdt: "
|
|
|
|
#define CPU5WDT_EXTENT 0x0A
|
|
|
|
#define CPU5WDT_STATUS_REG 0x00
|
|
#define CPU5WDT_TIME_A_REG 0x02
|
|
#define CPU5WDT_TIME_B_REG 0x03
|
|
#define CPU5WDT_MODE_REG 0x04
|
|
#define CPU5WDT_TRIGGER_REG 0x07
|
|
#define CPU5WDT_ENABLE_REG 0x08
|
|
#define CPU5WDT_RESET_REG 0x09
|
|
|
|
#define CPU5WDT_INTERVAL (HZ/10+1)
|
|
|
|
/* some device data */
|
|
|
|
static struct {
|
|
struct completion stop;
|
|
int running;
|
|
struct timer_list timer;
|
|
int queue;
|
|
int default_ticks;
|
|
unsigned long inuse;
|
|
} cpu5wdt_device;
|
|
|
|
/* generic helper functions */
|
|
|
|
static void cpu5wdt_trigger(struct timer_list *unused)
|
|
{
|
|
if (verbose > 2)
|
|
pr_debug("trigger at %i ticks\n", ticks);
|
|
|
|
if (cpu5wdt_device.running)
|
|
ticks--;
|
|
|
|
spin_lock(&cpu5wdt_lock);
|
|
/* keep watchdog alive */
|
|
outb(1, port + CPU5WDT_TRIGGER_REG);
|
|
|
|
/* requeue?? */
|
|
if (cpu5wdt_device.queue && ticks)
|
|
mod_timer(&cpu5wdt_device.timer, jiffies + CPU5WDT_INTERVAL);
|
|
else {
|
|
/* ticks doesn't matter anyway */
|
|
complete(&cpu5wdt_device.stop);
|
|
}
|
|
spin_unlock(&cpu5wdt_lock);
|
|
|
|
}
|
|
|
|
static void cpu5wdt_reset(void)
|
|
{
|
|
ticks = cpu5wdt_device.default_ticks;
|
|
|
|
if (verbose)
|
|
pr_debug("reset (%i ticks)\n", (int) ticks);
|
|
|
|
}
|
|
|
|
static void cpu5wdt_start(void)
|
|
{
|
|
unsigned long flags;
|
|
|
|
spin_lock_irqsave(&cpu5wdt_lock, flags);
|
|
if (!cpu5wdt_device.queue) {
|
|
cpu5wdt_device.queue = 1;
|
|
outb(0, port + CPU5WDT_TIME_A_REG);
|
|
outb(0, port + CPU5WDT_TIME_B_REG);
|
|
outb(1, port + CPU5WDT_MODE_REG);
|
|
outb(0, port + CPU5WDT_RESET_REG);
|
|
outb(0, port + CPU5WDT_ENABLE_REG);
|
|
mod_timer(&cpu5wdt_device.timer, jiffies + CPU5WDT_INTERVAL);
|
|
}
|
|
/* if process dies, counter is not decremented */
|
|
cpu5wdt_device.running++;
|
|
spin_unlock_irqrestore(&cpu5wdt_lock, flags);
|
|
}
|
|
|
|
static int cpu5wdt_stop(void)
|
|
{
|
|
unsigned long flags;
|
|
|
|
spin_lock_irqsave(&cpu5wdt_lock, flags);
|
|
if (cpu5wdt_device.running)
|
|
cpu5wdt_device.running = 0;
|
|
ticks = cpu5wdt_device.default_ticks;
|
|
spin_unlock_irqrestore(&cpu5wdt_lock, flags);
|
|
if (verbose)
|
|
pr_crit("stop not possible\n");
|
|
return -EIO;
|
|
}
|
|
|
|
/* filesystem operations */
|
|
|
|
static int cpu5wdt_open(struct inode *inode, struct file *file)
|
|
{
|
|
if (test_and_set_bit(0, &cpu5wdt_device.inuse))
|
|
return -EBUSY;
|
|
return nonseekable_open(inode, file);
|
|
}
|
|
|
|
static int cpu5wdt_release(struct inode *inode, struct file *file)
|
|
{
|
|
clear_bit(0, &cpu5wdt_device.inuse);
|
|
return 0;
|
|
}
|
|
|
|
static long cpu5wdt_ioctl(struct file *file, unsigned int cmd,
|
|
unsigned long arg)
|
|
{
|
|
void __user *argp = (void __user *)arg;
|
|
int __user *p = argp;
|
|
unsigned int value;
|
|
static const struct watchdog_info ident = {
|
|
.options = WDIOF_CARDRESET,
|
|
.identity = "CPU5 WDT",
|
|
};
|
|
|
|
switch (cmd) {
|
|
case WDIOC_GETSUPPORT:
|
|
if (copy_to_user(argp, &ident, sizeof(ident)))
|
|
return -EFAULT;
|
|
break;
|
|
case WDIOC_GETSTATUS:
|
|
value = inb(port + CPU5WDT_STATUS_REG);
|
|
value = (value >> 2) & 1;
|
|
return put_user(value, p);
|
|
case WDIOC_GETBOOTSTATUS:
|
|
return put_user(0, p);
|
|
case WDIOC_SETOPTIONS:
|
|
if (get_user(value, p))
|
|
return -EFAULT;
|
|
if (value & WDIOS_ENABLECARD)
|
|
cpu5wdt_start();
|
|
if (value & WDIOS_DISABLECARD)
|
|
cpu5wdt_stop();
|
|
break;
|
|
case WDIOC_KEEPALIVE:
|
|
cpu5wdt_reset();
|
|
break;
|
|
default:
|
|
return -ENOTTY;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static ssize_t cpu5wdt_write(struct file *file, const char __user *buf,
|
|
size_t count, loff_t *ppos)
|
|
{
|
|
if (!count)
|
|
return -EIO;
|
|
cpu5wdt_reset();
|
|
return count;
|
|
}
|
|
|
|
static const struct file_operations cpu5wdt_fops = {
|
|
.owner = THIS_MODULE,
|
|
.llseek = no_llseek,
|
|
.unlocked_ioctl = cpu5wdt_ioctl,
|
|
.open = cpu5wdt_open,
|
|
.write = cpu5wdt_write,
|
|
.release = cpu5wdt_release,
|
|
};
|
|
|
|
static struct miscdevice cpu5wdt_misc = {
|
|
.minor = WATCHDOG_MINOR,
|
|
.name = "watchdog",
|
|
.fops = &cpu5wdt_fops,
|
|
};
|
|
|
|
/* init/exit function */
|
|
|
|
static int cpu5wdt_init(void)
|
|
{
|
|
unsigned int val;
|
|
int err;
|
|
|
|
if (verbose)
|
|
pr_debug("port=0x%x, verbose=%i\n", port, verbose);
|
|
|
|
init_completion(&cpu5wdt_device.stop);
|
|
cpu5wdt_device.queue = 0;
|
|
timer_setup(&cpu5wdt_device.timer, cpu5wdt_trigger, 0);
|
|
cpu5wdt_device.default_ticks = ticks;
|
|
|
|
if (!request_region(port, CPU5WDT_EXTENT, PFX)) {
|
|
pr_err("request_region failed\n");
|
|
err = -EBUSY;
|
|
goto no_port;
|
|
}
|
|
|
|
/* watchdog reboot? */
|
|
val = inb(port + CPU5WDT_STATUS_REG);
|
|
val = (val >> 2) & 1;
|
|
if (!val)
|
|
pr_info("sorry, was my fault\n");
|
|
|
|
err = misc_register(&cpu5wdt_misc);
|
|
if (err < 0) {
|
|
pr_err("misc_register failed\n");
|
|
goto no_misc;
|
|
}
|
|
|
|
|
|
pr_info("init success\n");
|
|
return 0;
|
|
|
|
no_misc:
|
|
release_region(port, CPU5WDT_EXTENT);
|
|
no_port:
|
|
return err;
|
|
}
|
|
|
|
static int cpu5wdt_init_module(void)
|
|
{
|
|
return cpu5wdt_init();
|
|
}
|
|
|
|
static void cpu5wdt_exit(void)
|
|
{
|
|
if (cpu5wdt_device.queue) {
|
|
cpu5wdt_device.queue = 0;
|
|
wait_for_completion(&cpu5wdt_device.stop);
|
|
del_timer(&cpu5wdt_device.timer);
|
|
}
|
|
|
|
misc_deregister(&cpu5wdt_misc);
|
|
|
|
release_region(port, CPU5WDT_EXTENT);
|
|
|
|
}
|
|
|
|
static void cpu5wdt_exit_module(void)
|
|
{
|
|
cpu5wdt_exit();
|
|
}
|
|
|
|
/* module entry points */
|
|
|
|
module_init(cpu5wdt_init_module);
|
|
module_exit(cpu5wdt_exit_module);
|
|
|
|
MODULE_AUTHOR("Heiko Ronsdorf <hero@ihg.uni-duisburg.de>");
|
|
MODULE_DESCRIPTION("sma cpu5 watchdog driver");
|
|
MODULE_SUPPORTED_DEVICE("sma cpu5 watchdog");
|
|
MODULE_LICENSE("GPL");
|
|
|
|
module_param_hw(port, int, ioport, 0);
|
|
MODULE_PARM_DESC(port, "base address of watchdog card, default is 0x91");
|
|
|
|
module_param(verbose, int, 0);
|
|
MODULE_PARM_DESC(verbose, "be verbose, default is 0 (no)");
|
|
|
|
module_param(ticks, int, 0);
|
|
MODULE_PARM_DESC(ticks, "count down ticks, default is 10000");
|