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