usr/src/man/man7m/usbkbm.7m

   1 '\" te
   2 .\"  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH USBKBM 7M "Jun 27, 2005"
   7 .SH NAME
   8 usbkbm \- keyboard STREAMS module for Sun USB Keyboard
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB\fR
  13 .fi
  14
  15 .LP
  16 .nf
  17 open("/dev/kbd", O_RDWR)
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 The  \fBusbkbm\fR \fBSTREAMS\fR module processes byte streams generated by a
  24 keyboard attached to a  \fBUSB\fR port.   \fBUSB\fR keyboard is a member of
  25 Human Interface Device (HID) Class, and \fBusbkbm\fR only supports the keyboard
  26 protocol defined in the specification.  Definitions for altering keyboard
  27 translation and reading events from the keyboard are in  \fB<sys/kbio.h>\fR and
  28 \fB<sys/kbd.h>\fR\&.
  29 .sp
  30 .LP
  31 The  \fBusbkbm\fR \fBSTREAMS\fR module adheres to the interfaces exported by
  32 \fBkb\fR(7M). Refer to the  \fBDESCRIPTION\fR section of  \fBkb\fR(7M) for a
  33 discussion of the keyboard translation modes and the \fBIOCTL\fR section for
  34 the supported  \fBioctl\fR(2) requests.
  35 .SS "IOCTLS"
  36 .sp
  37 .LP
  38 \fBUSB\fR Keyboard \fBusbkbm\fR returns different values  for the following
  39 ioctls than \fBkb\fR(7M):
  40 .sp
  41 .ne 2
  42 .na
  43 \fB\fBKIOCTYPE\fR \fR
  44 .ad
  45 .RS 13n
  46 This  \fBioctl()\fR returns a new keyboard type defined for the  \fBUSB\fR
  47 keyboard. All types are listed below:
  48 .RE
  49
  50 .sp
  51 .in +2
  52 .nf
  53 KB_SUN3   Sun Type 3 keyboard
  54 KB_SUN4   Sun Type 4 keyboard
  55 KB_ASCII  ASCII terminal masquerading as keyboard
  56 KB_PC     Type 101 PC keyboard
  57 KB_USB    USB keyboard
  58 .fi
  59 .in -2
  60
  61 .sp
  62 .LP
  63 The  \fBUSB\fR keyboard type is \fBKB_USB\fR; \fBusbkbm\fR will return
  64 \fBKB_USB\fR in response to the  \fBKIOCTYPE\fR ioctl.
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBKIOCLAYOUT\fR \fR
  69 .ad
  70 .RS 15n
  71 The argument is a pointer to an  \fBint\fR. The layout code specified by the
  72 \fBbCountryCode\fR value returned in the \fBHID\fR descriptor is returned in
  73 the int pointed to by the argument. The \fBcountrycodes\fR are defined in 6.2.1
  74 of the  \fBHID\fR 1.0 specifications.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBKIOCCMD\fR \fR
  81 .ad
  82 .RS 15n
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBKBD_CMD_CLICK/KBD_CMD_NOCLICK\fR \fR
  87 .ad
  88 .sp .6
  89 .RS 4n
  90 The \fBkb\fR(7M) indicates that inappropriate commands for particular keyboards
  91 are ignored. Because clicking is not supported on the \fBUSB\fR keyboard,
  92 \fBusbkbm\fR ignores this command
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBKBD_CMD_SETLED\fR \fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 Set keyboard LEDs. Same as  \fBkb\fR(7M).
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBKBD_CMD_GETLAYOUT\fR \fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 The country codes defined in 6.2.1 of the \fBHID\fR 1.0 specification are
 113 returned.
 114 .RE
 115
 116 .sp
 117 .ne 2
 118 .na
 119 \fB\fBKBD_CMD_BELL/KBD_CMD_NOBELL\fR \fR
 120 .ad
 121 .sp .6
 122 .RS 4n
 123 This command is supported although the \fBUSB\fR keyboard does not have a
 124 buzzer.  The request for the bell is rerouted.
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBKBD_CMD_RESET\fR \fR
 131 .ad
 132 .sp .6
 133 .RS 4n
 134 There is no notion of resetting the keyboard as there is for the type4
 135 keyboard. \fBusbkbm\fR ignores this command and  does not return an error.
 136 .RE
 137
 138 .RE
 139
 140 .SH FILES
 141 .sp
 142 .ne 2
 143 .na
 144 \fB/kernel/strmod/usbkbm\fR
 145 .ad
 146 .sp .6
 147 .RS 4n
 148 32-bit ELF kernel STREAMS module (x86 platform only)
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB/kernel/strmod/sparcv9/usbkbm\fR
 155 .ad
 156 .sp .6
 157 .RS 4n
 158 SPARC 64-bit ELF kernel STREAMS module
 159 .RE
 160
 161 .SH ATTRIBUTES
 162 .sp
 163 .LP
 164 See \fBattributes\fR(5) for a description of the following attributes:
 165 .sp
 166
 167 .sp
 168 .TS
 169 box;
 170 c | c
 171 l | l .
 172 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 173 _
 174 Architecture    PCI-based  systems
 175 .TE
 176
 177 .SH SEE ALSO
 178 .sp
 179 .LP
 180 \fBdumpkeys\fR(1), \fBkbd\fR(1), \fBloadkeys\fR(1), \fBioctl\fR(2),
 181 \fBkeytables\fR(4), \fBattributes\fR(5), \fBhid\fR(7D), \fBusba\fR(7D),
 182 \fBvirtualkm\fR(7D), \fBkb\fR(7M)
 183 .sp
 184 .LP
 185 \fISTREAMS Programming Guide\fR
 186 .sp
 187 .LP
 188 \fISystem Administration Guide: Basic Administration\fR
 189 .sp
 190 .LP
 191 http://\fIwww.sun.com/io\fR
 192 .SH DIAGN0STICS
 193 .sp
 194 .LP
 195 None