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