[mirror_ubuntu-bionic-kernel.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 (*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).
 */

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

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
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 {
1495cc9d	33	void (*handler)(int);
1da177e4 LT	34	char *help_msg;
	35	char *action_msg;
	36	int enable_mask;
	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
f335397d	46	void handle_sysrq(int key);
c456d0e9	47	void __handle_sysrq(int key, bool check_mask);
5d6f647f IM	48	int register_sysrq_key(int key, struct sysrq_key_op *op);
5d6f647f IM	49	int unregister_sysrq_key(int key, struct sysrq_key_op *op);
1da177e4 LT	50	struct sysrq_key_op *__sysrq_get_key_op(int key);
1da177e4 LT	51
97f5f0cd DT	52	int sysrq_toggle_support(int enable_mask);
97f5f0cd DT	53
1da177e4 LT	54	#else
1da177e4 LT	55
f335397d	56	static inline void handle_sysrq(int key)
5d6f647f	57	{
5d6f647f	58	}
97f5f0cd	59
f335397d	60	static inline void __handle_sysrq(int key, bool check_mask)
1495cc9d DT	61	{
	62	}
	63
97f5f0cd	64	static inline int register_sysrq_key(int key, struct sysrq_key_op *op)
1da177e4 LT	65	{
	66	return -EINVAL;
	67	}
97f5f0cd DT	68
97f5f0cd DT	69	static inline int unregister_sysrq_key(int key, struct sysrq_key_op *op)
5d6f647f	70	{
97f5f0cd	71	return -EINVAL;
5d6f647f	72	}
1da177e4	73
1da177e4	74	#endif
89bbc03c TP	75
89bbc03c TP	76	#endif /* _LINUX_SYSRQ_H */