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