[linux-2.6-block.git] / include / linux / sysrq.h

/* -*- linux-c -*-
 *
 *	$Id: sysrq.h,v 1.3 1997/07/17 11:54:33 mj Exp $
 *
 *	Linux Magic System Request Key Hacks
 *
 *	(c) 1997 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
 *
 *	(c) 2000 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
 *	overhauled to use key registration
 *	based upon discusions in irc://irc.openprojects.net/#kernelnewbies
 */

#ifndef _LINUX_SYSRQ_H
#define _LINUX_SYSRQ_H

#include <linux/errno.h>

struct pt_regs;
struct tty_struct;

/* Possible values of bitmask for enabling sysrq functions */
/* 0x0001 is reserved for enable everything */
#define SYSRQ_ENABLE_LOG	0x0002
#define SYSRQ_ENABLE_KEYBOARD	0x0004
#define SYSRQ_ENABLE_DUMP	0x0008
#define SYSRQ_ENABLE_SYNC	0x0010
#define SYSRQ_ENABLE_REMOUNT	0x0020
#define SYSRQ_ENABLE_SIGNAL	0x0040
#define SYSRQ_ENABLE_BOOT	0x0080
#define SYSRQ_ENABLE_RTNICE	0x0100

struct sysrq_key_op {
	void (*handler)(int, struct tty_struct *);
	char *help_msg;
	char *action_msg;
	int enable_mask;
};

#ifdef CONFIG_MAGIC_SYSRQ

extern int sysrq_on(void);

/*
 * Do not use this one directly:
 */
extern int __sysrq_enabled;

/* Generic SysRq interface -- you may call it from any device driver, supplying
 * ASCII code of the key, pointer to registers and kbd/tty structs (if they
 * are available -- else NULL's).
 */

void handle_sysrq(int key, struct tty_struct *tty);
void __handle_sysrq(int key, struct tty_struct *tty, int check_mask);
int register_sysrq_key(int key, struct sysrq_key_op *op);
int unregister_sysrq_key(int key, struct sysrq_key_op *op);
struct sysrq_key_op *__sysrq_get_key_op(int key);

#else

static inline int sysrq_on(void)
{
	return 0;
}
static inline int __reterr(void)
{
	return -EINVAL;
}
static inline void handle_sysrq(int key, struct tty_struct *tty)
{
}

#define register_sysrq_key(ig,nore) __reterr()
#define unregister_sysrq_key(ig,nore) __reterr()

#endif

#endif /* _LINUX_SYSRQ_H */
Commit	Line	Data
1da177e4 LT	1	/* -- linux-c --
	2	*
	3	* $Id: sysrq.h,v 1.3 1997/07/17 11:54:33 mj Exp $
	4	*
	5	* Linux Magic System Request Key Hacks
	6	*
	7	* (c) 1997 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
	8	*
	9	* (c) 2000 Crutcher Dunnavant <crutcher+kernel@datastacks.com>
	10	* overhauled to use key registration
	11	* based upon discusions in irc://irc.openprojects.net/#kernelnewbies
	12	*/
	13
89bbc03c TP	14	#ifndef _LINUX_SYSRQ_H
89bbc03c TP	15	#define _LINUX_SYSRQ_H
1da177e4	16
82e3310a TD	17	#include <linux/errno.h>
82e3310a TD	18
1da177e4 LT	19	struct pt_regs;
	20	struct tty_struct;
	21
	22	/* Possible values of bitmask for enabling sysrq functions */
	23	/* 0x0001 is reserved for enable everything */
	24	#define SYSRQ_ENABLE_LOG 0x0002
	25	#define SYSRQ_ENABLE_KEYBOARD 0x0004
	26	#define SYSRQ_ENABLE_DUMP 0x0008
	27	#define SYSRQ_ENABLE_SYNC 0x0010
	28	#define SYSRQ_ENABLE_REMOUNT 0x0020
	29	#define SYSRQ_ENABLE_SIGNAL 0x0040
	30	#define SYSRQ_ENABLE_BOOT 0x0080
	31	#define SYSRQ_ENABLE_RTNICE 0x0100
	32
	33	struct sysrq_key_op {
7d12e780	34	void (handler)(int, struct tty_struct );
1da177e4 LT	35	char *help_msg;
	36	char *action_msg;
	37	int enable_mask;
	38	};
	39
	40	#ifdef CONFIG_MAGIC_SYSRQ
	41
5d6f647f IM	42	extern int sysrq_on(void);
	43
	44	/*
	45	* Do not use this one directly:
	46	*/
	47	extern int __sysrq_enabled;
	48
1da177e4 LT	49	/* Generic SysRq interface -- you may call it from any device driver, supplying
	50	* ASCII code of the key, pointer to registers and kbd/tty structs (if they
	51	* are available -- else NULL's).
	52	*/
	53
5d6f647f IM	54	void handle_sysrq(int key, struct tty_struct *tty);
	55	void __handle_sysrq(int key, struct tty_struct *tty, int check_mask);
	56	int register_sysrq_key(int key, struct sysrq_key_op *op);
	57	int unregister_sysrq_key(int key, struct sysrq_key_op *op);
1da177e4 LT	58	struct sysrq_key_op *__sysrq_get_key_op(int key);
	59
	60	#else
	61
5d6f647f IM	62	static inline int sysrq_on(void)
	63	{
	64	return 0;
	65	}
1da177e4 LT	66	static inline int __reterr(void)
	67	{
	68	return -EINVAL;
	69	}
5d6f647f IM	70	static inline void handle_sysrq(int key, struct tty_struct *tty)
	71	{
	72	}
1da177e4 LT	73
	74	#define register_sysrq_key(ig,nore) __reterr()
	75	#define unregister_sysrq_key(ig,nore) __reterr()
	76
	77	#endif
89bbc03c TP	78
89bbc03c TP	79	#endif /* _LINUX_SYSRQ_H */