[mirror_ubuntu-focal-kernel.git] / include / linux / libps2.h

/* SPDX-License-Identifier: GPL-2.0-only */
#ifndef _LIBPS2_H
#define _LIBPS2_H

/*
 * Copyright (C) 1999-2002 Vojtech Pavlik
 * Copyright (C) 2004 Dmitry Torokhov
 */

#include <linux/bitops.h>
#include <linux/mutex.h>
#include <linux/types.h>
#include <linux/wait.h>

#define PS2_CMD_SETSCALE11	0x00e6
#define PS2_CMD_SETRES		0x10e8
#define PS2_CMD_GETID		0x02f2
#define PS2_CMD_RESET_BAT	0x02ff

#define PS2_RET_BAT		0xaa
#define PS2_RET_ID		0x00
#define PS2_RET_ACK		0xfa
#define PS2_RET_NAK		0xfe
#define PS2_RET_ERR		0xfc

#define PS2_FLAG_ACK		BIT(0)	/* Waiting for ACK/NAK */
#define PS2_FLAG_CMD		BIT(1)	/* Waiting for a command to finish */
#define PS2_FLAG_CMD1		BIT(2)	/* Waiting for the first byte of command response */
#define PS2_FLAG_WAITID		BIT(3)	/* Command executing is GET ID */
#define PS2_FLAG_NAK		BIT(4)	/* Last transmission was NAKed */
#define PS2_FLAG_ACK_CMD	BIT(5)	/* Waiting to ACK the command (first) byte */

struct ps2dev {
	struct serio *serio;

	/* Ensures that only one command is executing at a time */
	struct mutex cmd_mutex;

	/* Used to signal completion from interrupt handler */
	wait_queue_head_t wait;

	unsigned long flags;
	u8 cmdbuf[8];
	u8 cmdcnt;
	u8 nak;
};

void ps2_init(struct ps2dev *ps2dev, struct serio *serio);
int ps2_sendbyte(struct ps2dev *ps2dev, u8 byte, unsigned int timeout);
void ps2_drain(struct ps2dev *ps2dev, size_t maxbytes, unsigned int timeout);
void ps2_begin_command(struct ps2dev *ps2dev);
void ps2_end_command(struct ps2dev *ps2dev);
int __ps2_command(struct ps2dev *ps2dev, u8 *param, unsigned int command);
int ps2_command(struct ps2dev *ps2dev, u8 *param, unsigned int command);
int ps2_sliced_command(struct ps2dev *ps2dev, u8 command);
bool ps2_handle_ack(struct ps2dev *ps2dev, u8 data);
bool ps2_handle_response(struct ps2dev *ps2dev, u8 data);
void ps2_cmd_aborted(struct ps2dev *ps2dev);
bool ps2_is_keyboard_id(u8 id);

#endif /* _LIBPS2_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
1da177e4 LT	2	#ifndef _LIBPS2_H
	3	#define _LIBPS2_H
	4
	5	/*
	6	* Copyright (C) 1999-2002 Vojtech Pavlik
	7	* Copyright (C) 2004 Dmitry Torokhov
1da177e4 LT	8	*/
1da177e4 LT	9
3a92dd33	10	#include <linux/bitops.h>
b28bad65 DT	11	#include <linux/mutex.h>
	12	#include <linux/types.h>
	13	#include <linux/wait.h>
1da177e4	14
08be954b DT	15	#define PS2_CMD_SETSCALE11 0x00e6
08be954b DT	16	#define PS2_CMD_SETRES 0x10e8
1da177e4 LT	17	#define PS2_CMD_GETID 0x02f2
	18	#define PS2_CMD_RESET_BAT 0x02ff
	19
	20	#define PS2_RET_BAT 0xaa
	21	#define PS2_RET_ID 0x00
	22	#define PS2_RET_ACK 0xfa
	23	#define PS2_RET_NAK 0xfe
a2d781fc	24	#define PS2_RET_ERR 0xfc
1da177e4	25
3a92dd33 DT	26	#define PS2_FLAG_ACK BIT(0) /* Waiting for ACK/NAK */
	27	#define PS2_FLAG_CMD BIT(1) /* Waiting for a command to finish */
	28	#define PS2_FLAG_CMD1 BIT(2) /* Waiting for the first byte of command response */
	29	#define PS2_FLAG_WAITID BIT(3) /* Command executing is GET ID */
	30	#define PS2_FLAG_NAK BIT(4) /* Last transmission was NAKed */
29acc42e	31	#define PS2_FLAG_ACK_CMD BIT(5) /* Waiting to ACK the command (first) byte */
1da177e4 LT	32
	33	struct ps2dev {
	34	struct serio *serio;
	35
	36	/* Ensures that only one command is executing at a time */
c4e32e9f	37	struct mutex cmd_mutex;
1da177e4 LT	38
	39	/* Used to signal completion from interrupt handler */
	40	wait_queue_head_t wait;
	41
	42	unsigned long flags;
b28bad65 DT	43	u8 cmdbuf[8];
	44	u8 cmdcnt;
	45	u8 nak;
1da177e4 LT	46	};
	47
	48	void ps2_init(struct ps2dev ps2dev, struct serio serio);
b28bad65 DT	49	int ps2_sendbyte(struct ps2dev *ps2dev, u8 byte, unsigned int timeout);
b28bad65 DT	50	void ps2_drain(struct ps2dev *ps2dev, size_t maxbytes, unsigned int timeout);
181d683d DT	51	void ps2_begin_command(struct ps2dev *ps2dev);
181d683d DT	52	void ps2_end_command(struct ps2dev *ps2dev);
b28bad65 DT	53	int __ps2_command(struct ps2dev ps2dev, u8 param, unsigned int command);
b28bad65 DT	54	int ps2_command(struct ps2dev ps2dev, u8 param, unsigned int command);
08be954b	55	int ps2_sliced_command(struct ps2dev *ps2dev, u8 command);
b28bad65 DT	56	bool ps2_handle_ack(struct ps2dev *ps2dev, u8 data);
b28bad65 DT	57	bool ps2_handle_response(struct ps2dev *ps2dev, u8 data);
1da177e4	58	void ps2_cmd_aborted(struct ps2dev *ps2dev);
b28bad65	59	bool ps2_is_keyboard_id(u8 id);
1da177e4 LT	60
1da177e4 LT	61	#endif /* _LIBPS2_H */