share/man/man7d/usbsksp.7d

   1 '\" te
   2 .\" Copyright (c) 2006, 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 USBSKSP 7D "May 13, 2017"
   7 .SH NAME
   8 usbsksp \- Keyspan USB to serial converter driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <fcntl.h>
  13 .fi
  14
  15 .LP
  16 .nf
  17 #include <sys/termio.h>
  18 .fi
  19
  20 .LP
  21 .nf
  22 usbskpsp@unit
  23 .fi
  24
  25 .SH DESCRIPTION
  26 .LP
  27 The \fBusbsksp\fR driver is a loadable \fBSTREAMS\fR and \fBUSBA\fR (Solaris
  28 USB architecture) compliant client driver that provides basic asynchronous
  29 communication support for Keyspan USB-to-serial converters. The \fBusbsksp\fR
  30 driver supports the Keyspan USA19HS, USA49WG and USA49WLC models. By default,
  31 the USA19HS and USA49WG models are compatible with the \fBusbsksp\fR driver and
  32 no configuration or installation steps are required.  (The USA49WG model is a
  33 USB 2.0 device conforming to \fIUniversal Serial Bus Specification 2.0\fR and
  34 the USB 2.0 host controller is required to support the USA49WG model. Note that
  35 the USA49WG is not compatible with USB 1.1 host controllers). The Keyspan
  36 USA49WLC model requires a firmware package that is no longer publicly available.
  37 Serial device streams are built with appropriate modules that are pushed atop
  38 the \fBusbsksp\fR driver by the \fBautopush\fR(8) facility.
  39 .sp
  40 .LP
  41 The \fBusbsksp\fR module supports the \fBtermio\fR(7I) device control functions
  42 specified by flags in the \fBc_cflag\fR word of the termios structure, and by
  43 the IGNBRK, IGNPAR, PARMRK and INPCK flags in the \fBc_iflag\fR word of the
  44 termios structure. All other \fBtermio\fR(7I) functions must be performed by
  45 \fBSTREAMS\fR modules pushed atop the driver. When a device is opened, the
  46 \fBldterm\fR(7M) and \fBttcompat\fR(7M) \fBSTREAMS\fR modules are
  47 automatically pushed on top of the stream, providing the standard
  48 \fBtermio\fR(7I) interface.
  49 .sp
  50 .LP
  51 Use device logical names \fB/dev/term/[0-9]\fR* to access the serial ports.
  52 These names are typically used to provide a logical access point for a dial-in
  53 line that is used with a modem.
  54 .sp
  55 .LP
  56 A special feature (controlled by the minor device number) is available that
  57 enables a single tty line to be connected to a modem and used for incoming and
  58 outgoing calls. By accessing through device logical name \fB/dev/cua/[0-9]\fR*,
  59 you can open a port without the carrier detect signal being asserted, either
  60 through hardware or an equivalent software mechanism. These devices are
  61 commonly known as 'dial-out' lines.
  62 .sp
  63 .LP
  64 Unlike onboard serial ports, the \fBusbsksp\fR ports cannot serve as a local
  65 serial console.
  66 .SH APPLICATION PROGRAMMING INTERFACE
  67 .LP
  68 A dial-in line can be opened only if the corresponding dial-out line is closed.
  69 A blocking \fB/dev/term\fR open waits until the \fB/dev/cua\fR line is closed
  70 (which drops Data Terminal Ready, after which Carrier Detect usually drops as
  71 well) and carrier is detected again.  A non-blocking \fB/dev/term\fR open
  72 returns an error if the \fB/dev/cua\fR is open.
  73 .sp
  74 .LP
  75 If the \fB/dev/term\fR line is opened successfully (usually only when
  76 carrier is recognized on the modem), the corresponding \fB/dev/cua\fR line
  77 cannot be opened. This allows a modem and port to be used for dial-in (by
  78 enabling the line for login in \fB/etc/inittab\fR) or dial-out (by
  79 \fBtip\fR(1)) when no one is logged in on the line.
  80 .sp
  81 .LP
  82 Device hot-removal is functionally equivalent to a modem disconnect event, as
  83 defined in \fBtermio\fR(7I).
  84 .SH IOCTLS
  85 .LP
  86 The \fBusbsksp\fR driver supports the standard set of \fBtermio\fR(7I) ioctl
  87 calls.
  88 .sp
  89 .LP
  90 Input and output line speeds can be set to the following baud rates: 0, 50,
  91 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, 19200, 38400,
  92 57600, 115200, or 230400.  Input and output line speeds cannot be set
  93 independently. For example, when the output speed is set, the input speed is
  94 automatically set to the same speed.
  95 .SH ERRORS
  96 .LP
  97 An \fBopen()\fR fails under the following conditions:
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBENXIO\fR\fR
 102 .ad
 103 .RS 9n
 104 The unit being opened does not exist.
 105 .RE
 106
 107 .sp
 108 .ne 2
 109 .na
 110 \fB\fBEBUSY\fR\fR
 111 .ad
 112 .RS 9n
 113 The \fB/dev/cua\fR (dial-out) device is being opened while the \fB/dev/term\fR
 114 (dial-in device) is open, or the dial-in device is being opened with a no-delay
 115 open while the dial-out device is open.
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBEBUSY\fR\fR
 122 .ad
 123 .RS 9n
 124 The unit has been marked as exclusive-use by another process with a TIOCEXCL
 125 ioctl() call.
 126 .RE
 127
 128 .sp
 129 .ne 2
 130 .na
 131 \fB\fBEIO\fR\fR
 132 .ad
 133 .RS 9n
 134 USB device I/O error.
 135 .RE
 136
 137 .SH FILES
 138 .ne 2
 139 .na
 140 \fB\fB/kernel/drv/usbsksp\fR\fR
 141 .ad
 142 .sp .6
 143 .RS 4n
 144 32-bit x86 ELF kernel module.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB/kernel/drv/amd64/usbsksp\fR\fR
 151 .ad
 152 .sp .6
 153 .RS 4n
 154 64-bit x86 ELF kernel module.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB/kernel/drv/sparcv9/usbsksp\fR\fR
 161 .ad
 162 .sp .6
 163 .RS 4n
 164 64-bit SPARC ELF kernel module.
 165 .RE
 166
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fB/dev/cua/[0-9]*\fR\fR
 171 .ad
 172 .sp .6
 173 .RS 4n
 174 dial-out tty lines.
 175 .RE
 176
 177 .sp
 178 .ne 2
 179 .na
 180 \fB\fB/dev/term/[0-9]*\fR\fR
 181 .ad
 182 .sp .6
 183 .RS 4n
 184 dial-in tty lines.
 185 .RE
 186
 187 .SH ATTRIBUTES
 188 .LP
 189 See \fBattributes\fR(5) for descriptions of the following attributes:
 190 .sp
 191
 192 .sp
 193 .TS
 194 box;
 195 c | c
 196 l | l .
 197 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 198 _
 199 Architecture    SPARC, x86, PCI-based systems
 200 .TE
 201
 202 .SH SEE ALSO
 203 .LP
 204 \fBstrconf\fR(1), \fBtip\fR(1), \fBautopush\fR(8),
 205 \fBioctl\fR(2), \fBopen\fR(2), \fBtermios\fR(3C), \fBattributes\fR(5),
 206 \fBusba\fR(7D), \fBtermio\fR(7I), \fBldterm\fR(7M), \fBttcompat\fR(7M)
 207 .SH DIAGNOSTICS
 208 .LP
 209 In addition to being logged, the following messages may appear on the system
 210 console. All messages are formatted in the following manner:
 211 .sp
 212 .in +2
 213 .nf
 214 Warning: <device path> (usbsksp<instance num>): Error Message...
 215 .fi
 216 .in -2
 217 .sp
 218
 219 .sp
 220 .ne 2
 221 .na
 222 \fBDevice was disconnected while open. Data may have been lost.\fR
 223 .ad
 224 .sp .6
 225 .RS 4n
 226 The device has been hot-removed or powered off while it was open and a possible
 227 data transfer was in progress. The job may be aborted.
 228 .RE
 229
 230 .sp
 231 .ne 2
 232 .na
 233 \fBDevice is not identical to the previous one on this port. Please disconnect
 234 and reconnect.\fR
 235 .ad
 236 .sp .6
 237 .RS 4n
 238 The device was hot-removed while open. A new device was hot-inserted which is
 239 not identical to the original device. Please disconnect the device and
 240 reconnect the original device to the same port.
 241 .RE
 242
 243 .sp
 244 .ne 2
 245 .na
 246 \fBDevice has been reconnected, but data may have been lost.\fR
 247 .ad
 248 .sp .6
 249 .RS 4n
 250 The device that was hot-removed from its USB port has been re-inserted again to
 251 the same port. It is available for access but data from a previous transfer
 252 may be lost.
 253 .RE
 254
 255 .sp
 256 .ne 2
 257 .na
 258 \fBCannot access <\fIdevice\fR>. Please reconnect.\fR
 259 .ad
 260 .sp .6
 261 .RS 4n
 262 This device has been disconnected because a device other than the original one
 263 has been inserted. The driver informs you of this fact by displaying the name
 264 of the original device.
 265 .RE
 266
 267 .sp
 268 .ne 2
 269 .na
 270 \fBNo valid firmware available for Keyspan usa49wlc usb-to-serial adapter.
 271 Please download it from Keyspan website and install it.\fR
 272 .ad
 273 .sp .6
 274 .RS 4n
 275 By default, only an empty firmware package is installed for the usa49wlc model.
 276 You will need to obtain a copy of the SUNWukspfw package and install it.
 277 .RE
 278
 279 .sp
 280 .LP
 281 The following messages may be logged into the system log. They are formatted in
 282 the following manner:
 283 .sp
 284 .in +2
 285 .nf
 286 <device path><usbsksp<instance number>): message...
 287 .fi
 288 .in -2
 289 .sp
 290
 291 .sp
 292 .ne 2
 293 .na
 294 \fBInput overrun\fR
 295 .ad
 296 .RS 17n
 297 Data was lost.
 298 .RE
 299