/*      $NetBSD: kbd_reg.h,v 1.5 2005/12/11 12:23:56 christos Exp $ */

/*
* Copyright (c) 1992, 1993
*      The Regents of the University of California.  All rights reserved.
*
* This software was developed by the Computer Systems Engineering group
* at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
* contributed to Berkeley.
*
* All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
*      This product includes software developed by the University of
*      California, Lawrence Berkeley Laboratory.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
*      @(#)kbd.h       8.1 (Berkeley) 6/11/93
*/

/*
* Keyboard `registers'.  (This is actually #included as machine/kbd.h to
* be compatible.)
*/

/*
* Control codes sent from type 2, 3, and 4 keyboards.
*
* Note that KBD_RESET is followed by a keyboard ID, while KBD_IDLE is not.
* KBD_IDLE does not take the place of any `up' transitions (it merely occurs
* after them).
*/
#define KBD_RESET       0xff            /* `reset' response (ID follows) */
#define KBD_LAYOUT      0xfe            /* Indicates that `layout' follows */
#define KBD_IDLE        0x7f            /* keyboard `all keys are up' code */
#define KBD_ERROR       0x7e            /* keyboard detected an error */
#define KBD_SPECIAL(c) (((c) & 0x7e) == 0x7e)

/*
* Keyboard IDs
* The serial versions of the type 5 and 6 keyboards both return ID 4.
*/
#define KB_KLUNK        0               /* Micro Switch 103SD32-2 */
#define KB_VT100        1               /* Keytronics VT100 compatible */
#define KB_SUN2         2               /* type 2 keyboard */
#define KB_SUN3         3               /* type 3 keyboard */
#define KB_SUN4         4               /* type 4 keyboard */

/* Key codes are in 0x00..0x7e; KBD_UP is set if the key goes up */
#define KBD_KEYMASK     0x7f            /* keyboard key mask */
#define KBD_UP          0x80            /* keyboard `up' transition */

/* Keyboard codes needed to recognize the L1-A sequence */
#define KBD_L1          1               /* keyboard code for `L1' key */
#define KBD_A           77              /* keyboard code for `A' key */

/* Control codes sent to the various keyboards */
#define KBD_CMD_RESET   1               /* reset keyboard */
#define KBD_CMD_BELL    2               /* turn bell on */
#define KBD_CMD_NOBELL  3               /* turn bell off */
#define KBD_CMD_CLICK   10              /* turn keyclick on */
#define KBD_CMD_NOCLICK 11              /* turn keyclick off */
#define KBD_CMD_SETLED  14              /* set LED state (type 4 kbd) */
#define KBD_CMD_GETLAYOUT       15              /* get DIP switch (type 4 kbd) */

#define LED_NUM_LOCK    0x1
#define LED_COMPOSE     0x2
#define LED_SCROLL_LOCK 0x4
#define LED_CAPS_LOCK   0x8

#ifdef _KERNEL
/* XXX: backdoor for /dev/fb driver */
extern void kbd_bell(int);
#endif