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

/* SPDX-License-Identifier: GPL-2.0 */
/* -*- 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

struct sysrq_key_op {
	void (* const handler)(u8);
	const char * const help_msg;
	const char * const action_msg;
	const 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).
 */

void handle_sysrq(u8 key);
void __handle_sysrq(u8 key, bool check_mask);
int register_sysrq_key(u8 key, const struct sysrq_key_op *op);
int unregister_sysrq_key(u8 key, const struct sysrq_key_op *op);
extern const struct sysrq_key_op *__sysrq_reboot_op;

int sysrq_toggle_support(int enable_mask);
int sysrq_mask(void);

#else

static inline void handle_sysrq(u8 key)
{
}

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

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

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

static inline int sysrq_mask(void)
{
	/* Magic SysRq disabled mask */
	return 0;
}

#endif

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