xref: /illumos-gate/usr/src/uts/common/sys/i8042.h (revision 257873cfc1dd3337766407f80397db60a56f2f5a)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _SYS_I8042_H
27 #define	_SYS_I8042_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 /*
34  * Here's the interface to the virtual registers on the device.
35  *
36  * Normal interrupt-driven I/O:
37  *
38  * I8042_INT_INPUT_AVAIL
39  *	Interrupt mode input bytes available?  Zero = No.
40  * I8042_INT_INPUT_DATA
41  *	Fetch interrupt mode input byte.
42  * I8042_INT_OUTPUT_DATA
43  *	Interrupt mode output byte.
44  *
45  * Polled I/O, used by (e.g.) kmdb, when normal system services are
46  * unavailable:
47  *
48  * I8042_POLL_INPUT_AVAIL
49  *	Polled mode input bytes available?  Zero = No.
50  * I8042_POLL_INPUT_DATA
51  *	Polled mode input byte.
52  * I8042_POLL_OUTPUT_DATA
53  *	Polled mode output byte.
54  */
55 
56 #define	I8042_INT_INPUT_AVAIL		0x00
57 #define	I8042_INT_INPUT_DATA		0x01
58 #define	I8042_INT_OUTPUT_DATA		0x03
59 #define	I8042_INT_CMD_PLUS_PARAM	0x05	/* See comment below */
60 #define	I8042_POLL_INPUT_AVAIL		0x10
61 #define	I8042_POLL_INPUT_DATA		0x11
62 #define	I8042_POLL_OUTPUT_DATA		0x13
63 #define	I8042_POLL_CMD_PLUS_PARAM	0x15	/* See comment below */
64 
65 /*
66  * The I8042_INT_CMD_PLUS_PARAM and I8042_POLL_CMD_PLUS_PARAM virtual
67  * registers are meant to be used with i8042_rep_put8() [via
68  * ddi_rep_put8 in child drivers], which is designed to allow commands
69  * that have responses (or that have responses plus an option byte) to
70  * execute atomically with respect to commands from other children
71  * (some 8042 implementations get confused when other child devices
72  * intersperse their own commands while a command to a different
73  * 8042-connected device is in flight).
74  */
75 
76 /* Softint priority used */
77 #define	I8042_SOFTINT_PRI	4
78 
79 #ifdef	__cplusplus
80 }
81 #endif
82 
83 #endif	/* _SYS_I8042_H */
84