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