1 /* $NetBSD: kbd_zs.c,v 1.7 2001/06/12 15:17:26 wiz Exp $ */ 2 3 /* 4 * Copyright (c) 1992, 1993 5 * The Regents of the University of California. All rights reserved. 6 * 7 * This software was developed by the Computer Systems Engineering group 8 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and 9 * contributed to Berkeley. 10 * 11 * All advertising materials mentioning features or use of this software 12 * must display the following acknowledgement: 13 * This product includes software developed by the University of 14 * California, Lawrence Berkeley Laboratory. 15 * 16 * Redistribution and use in source and binary forms, with or without 17 * modification, are permitted provided that the following conditions 18 * are met: 19 * 1. Redistributions of source code must retain the above copyright 20 * notice, this list of conditions and the following disclaimer. 21 * 2. Redistributions in binary form must reproduce the above copyright 22 * notice, this list of conditions and the following disclaimer in the 23 * documentation and/or other materials provided with the distribution. 24 * 3. All advertising materials mentioning features or use of this software 25 * must display the following acknowledgement: 26 * This product includes software developed by the University of 27 * California, Berkeley and its contributors. 28 * 4. Neither the name of the University nor the names of its contributors 29 * may be used to endorse or promote products derived from this software 30 * without specific prior written permission. 31 * 32 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 33 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 34 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 35 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 36 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 40 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 41 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 42 * SUCH DAMAGE. 43 * 44 * @(#)kbd.c 8.2 (Berkeley) 10/30/93 45 */ 46 47 /* 48 * Keyboard driver (/dev/kbd -- note that we do not have minor numbers 49 * [yet?]). Translates incoming bytes to ASCII or to `firm_events' and 50 * passes them up to the appropriate reader. 51 */ 52 53 /* 54 * Zilog Z8530 Dual UART driver (keyboard interface) 55 * 56 * This is the 8530 portion of the driver that will be attached to 57 * the "zsc" driver for a Sun keyboard. 58 */ 59 60 #include <sys/param.h> 61 #include <sys/systm.h> 62 #include <sys/conf.h> 63 #include <sys/device.h> 64 #include <sys/kernel.h> 65 #include <sys/malloc.h> 66 #include <sys/proc.h> 67 #include <sys/signal.h> 68 #include <sys/signalvar.h> 69 #include <sys/time.h> 70 #include <sys/select.h> 71 #include <sys/syslog.h> 72 73 #include <dev/ic/z8530reg.h> 74 #include <machine/z8530var.h> 75 #include <machine/vuid_event.h> 76 #include <machine/kbd.h> 77 #include <dev/sun/event_var.h> 78 #include <dev/sun/kbd_xlate.h> 79 #include <dev/sun/kbdvar.h> 80 81 /**************************************************************** 82 * Interface to the lower layer (zscc) 83 ****************************************************************/ 84 85 static void kbd_zs_rxint __P((struct zs_chanstate *)); 86 static void kbd_zs_stint __P((struct zs_chanstate *, int)); 87 static void kbd_zs_txint __P((struct zs_chanstate *)); 88 static void kbd_zs_softint __P((struct zs_chanstate *)); 89 90 struct zsops zsops_kbd = { 91 kbd_zs_rxint, /* receive char available */ 92 kbd_zs_stint, /* external/status */ 93 kbd_zs_txint, /* xmit buffer empty */ 94 kbd_zs_softint, /* process software interrupt */ 95 }; 96 97 static int kbd_zs_match(struct device *, struct cfdata *, void *); 98 static void kbd_zs_attach(struct device *, struct device *, void *); 99 static void kbd_zs_write_data __P((struct kbd_softc *, int)); 100 101 struct cfattach kbd_zs_ca = { 102 sizeof(struct kbd_softc), kbd_zs_match, kbd_zs_attach 103 }; 104 105 /* 106 * kbd_zs_match: how is this zs channel configured? 107 */ 108 int 109 kbd_zs_match(parent, cf, aux) 110 struct device *parent; 111 struct cfdata *cf; 112 void *aux; 113 { 114 struct zsc_attach_args *args = aux; 115 116 /* Exact match required for keyboard. */ 117 if (cf->cf_loc[ZSCCF_CHANNEL] == args->channel) 118 return 2; 119 120 return 0; 121 } 122 123 void 124 kbd_zs_attach(parent, self, aux) 125 struct device *parent, *self; 126 void *aux; 127 128 { 129 struct zsc_softc *zsc = (void *) parent; 130 struct kbd_softc *k = (void *) self; 131 struct zsc_attach_args *args = aux; 132 struct zs_chanstate *cs; 133 struct cfdata *cf; 134 int channel, kbd_unit; 135 int reset, s; 136 137 cf = k->k_dev.dv_cfdata; 138 kbd_unit = k->k_dev.dv_unit; 139 channel = args->channel; 140 cs = zsc->zsc_cs[channel]; 141 cs->cs_private = k; 142 cs->cs_ops = &zsops_kbd; 143 k->k_cs = cs; 144 k->k_write_data = kbd_zs_write_data; 145 146 if ((args->hwflags & ZS_HWFLAG_CONSOLE_INPUT) != 0) { 147 /* 148 * Hookup ourselves as the console input channel 149 */ 150 struct cons_channel *cc; 151 152 if ((cc = malloc(sizeof *cc, M_DEVBUF, M_NOWAIT)) == NULL) 153 return; 154 155 cc->cc_dev = self; 156 cc->cc_iopen = kbd_cc_open; 157 cc->cc_iclose = kbd_cc_close; 158 cc->cc_upstream = NULL; 159 cons_attach_input(cc, args->consdev); 160 k->k_cc = cc; 161 k->k_isconsole = 1; 162 printf(" (console input)"); 163 } 164 printf("\n"); 165 166 callout_init(&k->k_repeat_ch); 167 168 /* Initialize the speed, etc. */ 169 s = splzs(); 170 if (k->k_isconsole == 0) { 171 /* Not the console; may need reset. */ 172 reset = (channel == 0) ? 173 ZSWR9_A_RESET : ZSWR9_B_RESET; 174 zs_write_reg(cs, 9, reset); 175 } 176 /* These are OK as set by zscc: WR3, WR4, WR5 */ 177 /* We don't care about status interrupts. */ 178 cs->cs_preg[1] = ZSWR1_RIE | ZSWR1_TIE; 179 (void) zs_set_speed(cs, KBD_BPS); 180 zs_loadchannelregs(cs); 181 splx(s); 182 183 /* Do this before any calls to kbd_rint(). */ 184 kbd_xlate_init(&k->k_state); 185 186 /* XXX - Do this in open? */ 187 k->k_repeat_start = hz/2; 188 k->k_repeat_step = hz/20; 189 190 /* Magic sequence. */ 191 k->k_magic1 = KBD_L1; 192 k->k_magic2 = KBD_A; 193 } 194 195 /* 196 * used by kbd_start_tx(); 197 */ 198 void 199 kbd_zs_write_data(k, c) 200 struct kbd_softc *k; 201 int c; 202 { 203 int s; 204 205 /* Need splzs to avoid interruption of the delay. */ 206 s = splzs(); 207 zs_write_data(k->k_cs, c); 208 splx(s); 209 } 210 211 static void 212 kbd_zs_rxint(cs) 213 struct zs_chanstate *cs; 214 { 215 struct kbd_softc *k; 216 int put, put_next; 217 u_char c, rr1; 218 219 k = cs->cs_private; 220 put = k->k_rbput; 221 222 /* 223 * First read the status, because reading the received char 224 * destroys the status of this char. 225 */ 226 rr1 = zs_read_reg(cs, 1); 227 c = zs_read_data(cs); 228 229 if (rr1 & (ZSRR1_FE | ZSRR1_DO | ZSRR1_PE)) { 230 /* Clear the receive error. */ 231 zs_write_csr(cs, ZSWR0_RESET_ERRORS); 232 } 233 234 /* 235 * Check NOW for a console abort sequence, so that we can 236 * abort even when interrupts are locking up the machine. 237 */ 238 if (k->k_magic1_down) { 239 /* The last keycode was "MAGIC1" down. */ 240 k->k_magic1_down = 0; 241 if (c == k->k_magic2) { 242 /* Magic "L1-A" sequence; enter debugger. */ 243 if (k->k_isconsole) { 244 zs_abort(cs); 245 /* Debugger done. Fake L1-up to finish it. */ 246 c = k->k_magic1 | KBD_UP; 247 } else { 248 printf("kbd: magic sequence, but not console\n"); 249 } 250 } 251 } 252 if (c == k->k_magic1) { 253 k->k_magic1_down = 1; 254 } 255 256 k->k_rbuf[put] = (c << 8) | rr1; 257 put_next = (put + 1) & KBD_RX_RING_MASK; 258 259 /* Would overrun if increment makes (put==get). */ 260 if (put_next == k->k_rbget) { 261 k->k_intr_flags |= INTR_RX_OVERRUN; 262 } else { 263 /* OK, really increment. */ 264 put = put_next; 265 } 266 267 /* Done reading. */ 268 k->k_rbput = put; 269 270 /* Ask for softint() call. */ 271 cs->cs_softreq = 1; 272 } 273 274 275 static void 276 kbd_zs_txint(cs) 277 struct zs_chanstate *cs; 278 { 279 struct kbd_softc *k; 280 281 k = cs->cs_private; 282 zs_write_csr(cs, ZSWR0_RESET_TXINT); 283 k->k_intr_flags |= INTR_TX_EMPTY; 284 /* Ask for softint() call. */ 285 cs->cs_softreq = 1; 286 } 287 288 289 static void 290 kbd_zs_stint(cs, force) 291 struct zs_chanstate *cs; 292 int force; 293 { 294 struct kbd_softc *k; 295 int rr0; 296 297 k = cs->cs_private; 298 299 rr0 = zs_read_csr(cs); 300 zs_write_csr(cs, ZSWR0_RESET_STATUS); 301 302 #if 0 303 if (rr0 & ZSRR0_BREAK) { 304 /* Keyboard unplugged? */ 305 zs_abort(cs); 306 return (0); 307 } 308 #endif 309 310 /* 311 * We have to accumulate status line changes here. 312 * Otherwise, if we get multiple status interrupts 313 * before the softint runs, we could fail to notice 314 * some status line changes in the softint routine. 315 * Fix from Bill Studenmund, October 1996. 316 */ 317 cs->cs_rr0_delta |= (cs->cs_rr0 ^ rr0); 318 cs->cs_rr0 = rr0; 319 k->k_intr_flags |= INTR_ST_CHECK; 320 321 /* Ask for softint() call. */ 322 cs->cs_softreq = 1; 323 } 324 325 /* 326 * Get input from the receive ring and pass it on. 327 * Note: this is called at splsoftclock() 328 */ 329 static void 330 kbd_zs_softint(cs) 331 struct zs_chanstate *cs; 332 { 333 struct kbd_softc *k; 334 int get, c, s; 335 int intr_flags; 336 u_short ring_data; 337 338 k = cs->cs_private; 339 340 /* Atomically get and clear flags. */ 341 s = splzs(); 342 intr_flags = k->k_intr_flags; 343 k->k_intr_flags = 0; 344 345 /* Now lower to spltty for the rest. */ 346 (void) spltty(); 347 348 /* 349 * Copy data from the receive ring to the event layer. 350 */ 351 get = k->k_rbget; 352 while (get != k->k_rbput) { 353 ring_data = k->k_rbuf[get]; 354 get = (get + 1) & KBD_RX_RING_MASK; 355 356 /* low byte of ring_data is rr1 */ 357 c = (ring_data >> 8) & 0xff; 358 359 if (ring_data & ZSRR1_DO) 360 intr_flags |= INTR_RX_OVERRUN; 361 if (ring_data & (ZSRR1_FE | ZSRR1_PE)) { 362 /* 363 * After garbage, flush pending input, and 364 * send a reset to resync key translation. 365 */ 366 log(LOG_ERR, "%s: input error (0x%x)\n", 367 k->k_dev.dv_xname, ring_data); 368 get = k->k_rbput; /* flush */ 369 goto send_reset; 370 } 371 372 /* Pass this up to the "middle" layer. */ 373 kbd_input_raw(k, c); 374 } 375 if (intr_flags & INTR_RX_OVERRUN) { 376 log(LOG_ERR, "%s: input overrun\n", 377 k->k_dev.dv_xname); 378 send_reset: 379 /* Send a reset to resync translation. */ 380 kbd_output(k, KBD_CMD_RESET); 381 kbd_start_tx(k); 382 } 383 k->k_rbget = get; 384 385 if (intr_flags & INTR_TX_EMPTY) { 386 /* 387 * Transmit done. Try to send more, or 388 * clear busy and wakeup drain waiters. 389 */ 390 k->k_txflags &= ~K_TXBUSY; 391 kbd_start_tx(k); 392 } 393 394 if (intr_flags & INTR_ST_CHECK) { 395 /* 396 * Status line change. (Not expected.) 397 */ 398 log(LOG_ERR, "%s: status interrupt?\n", 399 k->k_dev.dv_xname); 400 cs->cs_rr0_delta = 0; 401 } 402 403 splx(s); 404 } 405