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 "May 13, 2017"
   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 .LP
  22 The \fBusbkbm\fR \fBSTREAMS\fR module processes byte streams generated by a
  23 keyboard attached to a \fBUSB\fR port.  \fBUSB\fR keyboard is a member of
  24 Human Interface Device (HID) Class, and \fBusbkbm\fR only supports the keyboard
  25 protocol defined in the specification.  Definitions for altering keyboard
  26 translation and reading events from the keyboard are in \fB<sys/kbio.h>\fR and
  27 \fB<sys/kbd.h>\fR\&.
  28 .sp
  29 .LP
  30 The \fBusbkbm\fR \fBSTREAMS\fR module adheres to the interfaces exported by
  31 \fBkb\fR(7M). Refer to the \fBDESCRIPTION\fR section of \fBkb\fR(7M) for a
  32 discussion of the keyboard translation modes and the \fBIOCTL\fR section for
  33 the supported \fBioctl\fR(2) requests.
  34 .SS "IOCTLS"
  35 .LP
  36 \fBUSB\fR Keyboard \fBusbkbm\fR returns different values for the following
  37 ioctls than \fBkb\fR(7M):
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fBKIOCTYPE\fR \fR
  42 .ad
  43 .RS 13n
  44 This \fBioctl()\fR returns a new keyboard type defined for the \fBUSB\fR
  45 keyboard. All types are listed below:
  46 .RE
  47
  48 .sp
  49 .in +2
  50 .nf
  51 KB_SUN3   Sun Type 3 keyboard
  52 KB_SUN4   Sun Type 4 keyboard
  53 KB_ASCII  ASCII terminal masquerading as keyboard
  54 KB_PC     Type 101 PC keyboard
  55 KB_USB    USB keyboard
  56 .fi
  57 .in -2
  58
  59 .sp
  60 .LP
  61 The \fBUSB\fR keyboard type is \fBKB_USB\fR; \fBusbkbm\fR will return
  62 \fBKB_USB\fR in response to the \fBKIOCTYPE\fR ioctl.
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBKIOCLAYOUT\fR \fR
  67 .ad
  68 .RS 15n
  69 The argument is a pointer to an \fBint\fR. The layout code specified by the
  70 \fBbCountryCode\fR value returned in the \fBHID\fR descriptor is returned in
  71 the int pointed to by the argument. The \fBcountrycodes\fR are defined in 6.2.1
  72 of the \fBHID\fR 1.0 specifications.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBKIOCCMD\fR \fR
  79 .ad
  80 .RS 15n
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBKBD_CMD_CLICK/KBD_CMD_NOCLICK\fR \fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The \fBkb\fR(7M) indicates that inappropriate commands for particular keyboards
  89 are ignored. Because clicking is not supported on the \fBUSB\fR keyboard,
  90 \fBusbkbm\fR ignores this command
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBKBD_CMD_SETLED\fR \fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 Set keyboard LEDs. Same as \fBkb\fR(7M).
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBKBD_CMD_GETLAYOUT\fR \fR
 107 .ad
 108 .sp .6
 109 .RS 4n
 110 The country codes defined in 6.2.1 of the \fBHID\fR 1.0 specification are
 111 returned.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBKBD_CMD_BELL/KBD_CMD_NOBELL\fR \fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 This command is supported although the \fBUSB\fR keyboard does not have a
 122 buzzer.  The request for the bell is rerouted.
 123 .RE
 124
 125 .sp
 126 .ne 2
 127 .na
 128 \fB\fBKBD_CMD_RESET\fR \fR
 129 .ad
 130 .sp .6
 131 .RS 4n
 132 There is no notion of resetting the keyboard as there is for the type4
 133 keyboard. \fBusbkbm\fR ignores this command and does not return an error.
 134 .RE
 135
 136 .RE
 137
 138 .SH FILES
 139 .ne 2
 140 .na
 141 \fB/kernel/strmod/usbkbm\fR
 142 .ad
 143 .sp .6
 144 .RS 4n
 145 32-bit ELF kernel STREAMS module (x86 platform only)
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB/kernel/strmod/sparcv9/usbkbm\fR
 152 .ad
 153 .sp .6
 154 .RS 4n
 155 SPARC 64-bit ELF kernel STREAMS module
 156 .RE
 157
 158 .SH ATTRIBUTES
 159 .LP
 160 See \fBattributes\fR(5) for a description of the following attributes:
 161 .sp
 162
 163 .sp
 164 .TS
 165 box;
 166 c | c
 167 l | l .
 168 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 169 _
 170 Architecture    PCI-based  systems
 171 .TE
 172
 173 .SH SEE ALSO
 174 .LP
 175 \fBdumpkeys\fR(1), \fBkbd\fR(1), \fBloadkeys\fR(1), \fBioctl\fR(2),
 176 \fBkeytables\fR(4), \fBattributes\fR(5), \fBhid\fR(7D), \fBusba\fR(7D),
 177 \fBvirtualkm\fR(7D), \fBkb\fR(7M)
 178 .sp
 179 .LP
 180 \fISTREAMS Programming Guide\fR
 181 .sp
 182 .LP
 183 \fISystem Administration Guide: Basic Administration\fR
 184 .SH DIAGN0STICS
 185 .LP
 186 None