[mirror_ubuntu-artful-kernel.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>
#include <linux/types.h>

/* 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

#define SYSRQ_DISABLE_USERSPACE	0x00010000

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

#ifdef CONFIG_MAGIC_SYSRQ

/* 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).
 */

#define SYSRQ_FROM_KERNEL	0x0001
#define SYSRQ_FROM_PROC		0x0002
#define SYSRQ_FROM_SYNTHETIC	0x0004

void handle_sysrq(int key);
void __handle_sysrq(int key, unsigned int from);
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);

int sysrq_toggle_support(int enable_mask);

#else

static inline void handle_sysrq(int key)
{
}

static inline void __handle_sysrq(int key, bool check_mask)
{
}

static inline int register_sysrq_key(int key, struct sysrq_key_op *op)
{
	return -EINVAL;
}

static inline int unregister_sysrq_key(int key, struct sysrq_key_op *op)
{
	return -EINVAL;
}

#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	17	#include <linux/errno.h>
f335397d	18	#include <linux/types.h>
1da177e4 LT	19
	20	/* Possible values of bitmask for enabling sysrq functions */
	21	/* 0x0001 is reserved for enable everything */
	22	#define SYSRQ_ENABLE_LOG 0x0002
	23	#define SYSRQ_ENABLE_KEYBOARD 0x0004
	24	#define SYSRQ_ENABLE_DUMP 0x0008
	25	#define SYSRQ_ENABLE_SYNC 0x0010
	26	#define SYSRQ_ENABLE_REMOUNT 0x0020
	27	#define SYSRQ_ENABLE_SIGNAL 0x0040
	28	#define SYSRQ_ENABLE_BOOT 0x0080
	29	#define SYSRQ_ENABLE_RTNICE 0x0100
	30
bfd27940 KM	31	#define SYSRQ_DISABLE_USERSPACE 0x00010000
bfd27940 KM	32
1da177e4	33	struct sysrq_key_op {
1495cc9d	34	void (*handler)(int);
1da177e4 LT	35	char *help_msg;
	36	char *action_msg;
	37	int enable_mask;
	38	};
	39
	40	#ifdef CONFIG_MAGIC_SYSRQ
	41
	42	/* Generic SysRq interface -- you may call it from any device driver, supplying
	43	* ASCII code of the key, pointer to registers and kbd/tty structs (if they
	44	* are available -- else NULL's).
	45	*/
	46
bfd27940 KM	47	#define SYSRQ_FROM_KERNEL 0x0001
	48	#define SYSRQ_FROM_PROC 0x0002
	49	#define SYSRQ_FROM_SYNTHETIC 0x0004
	50
f335397d	51	void handle_sysrq(int key);
bfd27940	52	void __handle_sysrq(int key, unsigned int from);
5d6f647f IM	53	int register_sysrq_key(int key, struct sysrq_key_op *op);
5d6f647f IM	54	int unregister_sysrq_key(int key, struct sysrq_key_op *op);
1da177e4 LT	55	struct sysrq_key_op *__sysrq_get_key_op(int key);
1da177e4 LT	56
97f5f0cd DT	57	int sysrq_toggle_support(int enable_mask);
97f5f0cd DT	58
1da177e4 LT	59	#else
1da177e4 LT	60
f335397d	61	static inline void handle_sysrq(int key)
5d6f647f	62	{
5d6f647f	63	}
97f5f0cd	64
f335397d	65	static inline void __handle_sysrq(int key, bool check_mask)
1495cc9d DT	66	{
	67	}
	68
97f5f0cd	69	static inline int register_sysrq_key(int key, struct sysrq_key_op *op)
1da177e4 LT	70	{
	71	return -EINVAL;
	72	}
97f5f0cd DT	73
97f5f0cd DT	74	static inline int unregister_sysrq_key(int key, struct sysrq_key_op *op)
5d6f647f	75	{
97f5f0cd	76	return -EINVAL;
5d6f647f	77	}
1da177e4	78
1da177e4	79	#endif
89bbc03c TP	80
89bbc03c TP	81	#endif /* _LINUX_SYSRQ_H */