share/man/man4/atkbdc.4

   1 .\"
   2 .\" Copyright (c) 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 as
  11 .\"    the first lines of this file unmodified.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man4/atkbdc.4,v 1.9.2.4 2001/08/17 13:08:37 ru Exp $
  28 .\"
  29 .Dd February 9, 1999
  30 .Dt ATKBDC 4
  31 .Os
  32 .Sh NAME
  33 .Nm atkbdc
  34 .Nd the AT keyboard controller interface
  35 .Sh SYNOPSIS
  36 .Cd "options KBD_RESETDELAY=N"
  37 .Cd "options KBD_MAXWAIT=N"
  38 .Cd "options KBDIO_DEBUG=N"
  39 .Cd "device atkbdc0 at isa? port IO_KBD"
  40 .Sh DESCRIPTION
  41 The keyboard controller
  42 .Nm
  43 provides I/O services for the AT keyboard and PS/2 mouse style
  44 pointing devices.
  45 This controller is required for the keyboard driver
  46 .Nm atkbd
  47 and the PS/2 pointing device driver
  48 .Nm psm .
  49 .Pp
  50 There can be only one
  51 .Nm
  52 device configured in the system.
  53 .Sh DRIVER CONFIGURATION
  54 .Ss Kernel Configuration Options
  55 The following kernel configuration options can be used to control the
  56 .Nm
  57 driver.
  58 They may be set in the kernel configuration file
  59 (see
  60 .Xr config 8 ) .
  61 .Bl -tag -width MOUSE
  62 .It Em KBD_RESETDELAY=X , KBD_MAXWAIT=Y
  63 The keyboard driver
  64 .Nm atkbd
  65 and the pointing device driver
  66 .Nm psm
  67 may ask the
  68 .Nm
  69 driver to reset these devices during the boot process.
  70 It sometimes takes a long time before these devices respond to
  71 the reset command.
  72 These options control how long the
  73 .Nm
  74 driver should
  75 wait before eventually giving up -- the driver will wait
  76 .Fa X
  77 *
  78 .Fa Y
  79 msecs at most.
  80 If the drivers seem unable to detect
  81 devices, you may want to increase these values.
  82 The default values are
  83 200 msec for
  84 .Fa X
  85 and 5
  86 for
  87 .Fa Y .
  88 .It Em KBDIO_DEBUG=N
  89 Sets the debug level to
  90 .Fa N .
  91 The default value is zero, which suppresses all debugging output.
  92 .El
  93 .\".Ss Driver Flags
  94 .\".Sh FILES
  95 .\".Sh EXAMPLE
  96 .\".Sh DIAGNOSTICS
  97 .\".Sh CAVEATS
  98 .\".Sh BUGS
  99 .Sh SEE ALSO
 100 .Xr atkbd 4 ,
 101 .Xr psm 4 ,
 102 .Xr config 8
 103 .Sh HISTORY
 104 The
 105 .Nm
 106 driver first appeared in
 107 .Fx 3.1 .
 108 It is based on the kbdio module in
 109 .Fx 2.2 .
 110 .Sh AUTHORS
 111 The kbdio module, the
 112 .Nm
 113 driver and this manual page were written by
 114 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .