psm - Sync psm(4) with FreeBSD
[dragonfly.git] / sys / dev / misc / kbd / atkbdcreg.h
1 /*-
2  * Copyright (c) 1996-1999
3  * Kazutaka YOKOTA (yokota@zodiac.mech.utsunomiya-u.ac.jp)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. The name of the author may not be used to endorse or promote 
15  *    products derived from this software without specific prior written 
16  *    permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * $FreeBSD: src/sys/dev/kbd/atkbdcreg.h,v 1.4.2.2 2000/03/31 12:51:57 yokota Exp $
31  * $DragonFly: src/sys/dev/misc/kbd/atkbdcreg.h,v 1.3 2007/01/15 00:11:36 dillon Exp $
32  * from kbdio.h,v 1.8 1998/09/25 11:55:46 yokota Exp
33  */
34
35 #ifndef _DEV_KBD_ATKBDCREG_H_
36 #define _DEV_KBD_ATKBDCREG_H_
37
38 /* constants */
39
40 /* I/O ports */
41 #define KBD_STATUS_PORT         4       /* status port, read */
42 #define KBD_COMMAND_PORT        4       /* controller command port, write */
43 #define KBD_DATA_PORT           0       /* data port, read/write 
44                                          * also used as keyboard command
45                                          * and mouse command port 
46                                          */
47
48 /* controller commands (sent to KBD_COMMAND_PORT) */
49 #define KBDC_SET_COMMAND_BYTE   0x0060
50 #define KBDC_GET_COMMAND_BYTE   0x0020
51 #define KBDC_WRITE_TO_AUX       0x00d4
52 #define KBDC_DISABLE_AUX_PORT   0x00a7
53 #define KBDC_ENABLE_AUX_PORT    0x00a8
54 #define KBDC_TEST_AUX_PORT      0x00a9
55 #define KBDC_DIAGNOSE           0x00aa
56 #define KBDC_TEST_KBD_PORT      0x00ab
57 #define KBDC_DISABLE_KBD_PORT   0x00ad
58 #define KBDC_ENABLE_KBD_PORT    0x00ae
59
60 /* controller command byte (set by KBDC_SET_COMMAND_BYTE) */
61 #define KBD_TRANSLATION         0x0040
62 #define KBD_RESERVED_BITS       0x0004
63 #define KBD_OVERRIDE_KBD_LOCK   0x0008
64 #define KBD_ENABLE_KBD_PORT     0x0000
65 #define KBD_DISABLE_KBD_PORT    0x0010
66 #define KBD_ENABLE_AUX_PORT     0x0000
67 #define KBD_DISABLE_AUX_PORT    0x0020
68 #define KBD_ENABLE_AUX_INT      0x0002
69 #define KBD_DISABLE_AUX_INT     0x0000
70 #define KBD_ENABLE_KBD_INT      0x0001
71 #define KBD_DISABLE_KBD_INT     0x0000
72 #define KBD_KBD_CONTROL_BITS    (KBD_DISABLE_KBD_PORT | KBD_ENABLE_KBD_INT)
73 #define KBD_AUX_CONTROL_BITS    (KBD_DISABLE_AUX_PORT | KBD_ENABLE_AUX_INT)
74
75 /* keyboard device commands (sent to KBD_DATA_PORT) */
76 #define KBDC_RESET_KBD          0x00ff
77 #define KBDC_ENABLE_KBD         0x00f4
78 #define KBDC_DISABLE_KBD        0x00f5
79 #define KBDC_SET_DEFAULTS       0x00f6
80 #define KBDC_SEND_DEV_ID        0x00f2
81 #define KBDC_SET_LEDS           0x00ed
82 #define KBDC_ECHO               0x00ee
83 #define KBDC_SET_SCANCODE_SET   0x00f0
84 #define KBDC_SET_TYPEMATIC      0x00f3
85
86 /* aux device commands (sent to KBD_DATA_PORT) */
87 #define PSMC_RESET_DEV          0x00ff
88 #define PSMC_ENABLE_DEV         0x00f4
89 #define PSMC_DISABLE_DEV        0x00f5
90 #define PSMC_SET_DEFAULTS       0x00f6
91 #define PSMC_SEND_DEV_ID        0x00f2
92 #define PSMC_SEND_DEV_STATUS    0x00e9
93 #define PSMC_SEND_DEV_DATA      0x00eb
94 #define PSMC_SET_SCALING11      0x00e6
95 #define PSMC_SET_SCALING21      0x00e7
96 #define PSMC_SET_RESOLUTION     0x00e8
97 #define PSMC_SET_STREAM_MODE    0x00ea
98 #define PSMC_SET_REMOTE_MODE    0x00f0
99 #define PSMC_SET_SAMPLING_RATE  0x00f3
100
101 /* PSMC_SET_RESOLUTION argument */
102 #define PSMD_RES_LOW            0       /* typically 25ppi */
103 #define PSMD_RES_MEDIUM_LOW     1       /* typically 50ppi */
104 #define PSMD_RES_MEDIUM_HIGH    2       /* typically 100ppi (default) */
105 #define PSMD_RES_HIGH           3       /* typically 200ppi */
106 #define PSMD_MAX_RESOLUTION     PSMD_RES_HIGH
107
108 /* PSMC_SET_SAMPLING_RATE */
109 #define PSMD_MAX_RATE           255     /* FIXME: not sure if it's possible */
110
111 /* status bits (KBD_STATUS_PORT) */
112 #define KBDS_BUFFER_FULL        0x0021
113 #define KBDS_ANY_BUFFER_FULL    0x0001
114 #define KBDS_KBD_BUFFER_FULL    0x0001
115 #define KBDS_AUX_BUFFER_FULL    0x0021
116 #define KBDS_INPUT_BUFFER_FULL  0x0002
117
118 /* return code */
119 #define KBD_ACK                 0x00fa
120 #define KBD_RESEND              0x00fe
121 #define KBD_RESET_DONE          0x00aa
122 #define KBD_RESET_FAIL          0x00fc
123 #define KBD_DIAG_DONE           0x0055
124 #define KBD_DIAG_FAIL           0x00fd
125 #define KBD_ECHO                0x00ee
126
127 #define PSM_ACK                 0x00fa
128 #define PSM_RESEND              0x00fe
129 #define PSM_RESET_DONE          0x00aa
130 #define PSM_RESET_FAIL          0x00fc
131
132 /* aux device ID */
133 #define PSM_MOUSE_ID            0
134 #define PSM_BALLPOINT_ID        2
135 #define PSM_INTELLI_ID          3
136 #define PSM_EXPLORER_ID         4
137 #define PSM_4DMOUSE_ID          6
138 #define PSM_4DPLUS_ID           8
139 #define PSM_4DPLUS_RFSW35_ID  24
140
141 #ifdef _KERNEL
142
143 #define ATKBDC_DRIVER_NAME      "atkbdc"
144
145 /* 
146  * driver specific options: the following options may be set by
147  * `options' statements in the kernel configuration file. 
148  */
149
150 /* retry count */
151 #ifndef KBD_MAXRETRY
152 #define KBD_MAXRETRY    3
153 #endif
154
155 /* timing parameters */
156 #ifndef KBD_RESETDELAY
157 #define KBD_RESETDELAY  200     /* wait 200msec after kbd/mouse reset */
158 #endif
159 #ifndef KBD_MAXWAIT
160 #define KBD_MAXWAIT     5       /* wait 5 times at most after reset */
161 #endif
162
163 /* I/O recovery time */
164 #define KBDC_DELAYTIME  20
165 #define KBDD_DELAYTIME  7
166
167 /* debug option */
168 #ifndef KBDIO_DEBUG
169 #define KBDIO_DEBUG     0
170 #endif
171
172 /* end of driver specific options */
173
174 /* types/structures */
175
176 #define KBDQ_BUFSIZE    32
177
178 typedef struct _kbdkqueue {
179     int head;
180     int tail;
181     unsigned char q[KBDQ_BUFSIZE];
182 #if KBDIO_DEBUG >= 2
183     int call_count;
184     int qcount;
185     int max_qcount;
186 #endif
187 } kbdkqueue;
188
189 struct resource;
190
191 typedef struct atkbdc_softc {
192     struct resource *port0;     /* data port */
193     struct resource *port1;     /* status port */
194     bus_space_tag_t iot;
195     bus_space_handle_t ioh0;
196     bus_space_handle_t ioh1;
197     int command_byte;           /* current command byte value */
198     int command_mask;           /* command byte mask bits for kbd/aux devices */
199     int lock;                   /* FIXME: XXX not quite a semaphore... */
200     kbdkqueue kbd;              /* keyboard data queue */
201     kbdkqueue aux;              /* auxiliary data queue */
202 } atkbdc_softc_t; 
203
204 enum kbdc_device_ivar {
205         KBDC_IVAR_IRQ,
206         KBDC_IVAR_FLAGS,
207         KBDC_IVAR_VENDORID,
208         KBDC_IVAR_SERIAL,
209         KBDC_IVAR_LOGICALID,
210         KBDC_IVAR_COMPATID, 
211 };
212
213 typedef caddr_t KBDC;
214
215 #define KBDC_RID_KBD     0
216 #define KBDC_RID_AUX     1
217
218 /* function prototypes */
219
220 atkbdc_softc_t *atkbdc_get_softc(int unit);
221 int atkbdc_probe_unit(int unit, struct resource *port0, struct resource *port1);
222 int atkbdc_attach_unit(int unit, atkbdc_softc_t *sc, struct resource *port0,
223                        struct resource *port1);
224 int atkbdc_configure(void);
225
226 KBDC atkbdc_open(int unit);
227 int kbdc_lock(KBDC kbdc, int lock);
228 int kbdc_data_ready(KBDC kbdc);
229
230 int write_controller_command(KBDC kbdc,int c);
231 int write_controller_data(KBDC kbdc,int c);
232
233 int write_kbd_command(KBDC kbdc,int c);
234 int write_aux_command(KBDC kbdc,int c);
235 int send_kbd_command(KBDC kbdc,int c);
236 int send_aux_command(KBDC kbdc,int c);
237 int send_kbd_command_and_data(KBDC kbdc,int c,int d);
238 int send_aux_command_and_data(KBDC kbdc,int c,int d);
239
240 int read_controller_data(KBDC kbdc);
241 int read_kbd_data(KBDC kbdc);
242 int read_kbd_data_no_wait(KBDC kbdc);
243 int read_aux_data(KBDC kbdc);
244 int read_aux_data_no_wait(KBDC kbdc);
245
246 void empty_kbd_buffer(KBDC kbdc, int t);
247 void empty_aux_buffer(KBDC kbdc, int t);
248 void empty_both_buffers(KBDC kbdc, int t);
249
250 int reset_kbd(KBDC kbdc);
251 int reset_aux_dev(KBDC kbdc);
252
253 int test_controller(KBDC kbdc);
254 int test_kbd_port(KBDC kbdc);
255 int test_aux_port(KBDC kbdc);
256
257 int kbdc_get_device_mask(KBDC kbdc);
258 void kbdc_set_device_mask(KBDC kbdc, int mask);
259
260 int get_controller_command_byte(KBDC kbdc);
261 int set_controller_command_byte(KBDC kbdc, int command, int flag);
262
263 #endif /* _KERNEL */
264
265 #endif /* !_DEV_KBD_ATKBDCREG_H_ */