share/man/man9s/usb_completion_reason.9s

   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 USB_COMPLETION_REASON 9S "Jan 5, 2004"
   7 .SH NAME
   8 usb_completion_reason \- USB completion reason definitions
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/usb/usba.h>
  13 .fi
  14
  15 .SH INTERFACE LEVEL
  16 .sp
  17 .LP
  18 Solaris DDI specific (Solaris DDI)
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 If an error occurs during execution of a USB request, the USBA framework calls
  23 a client driver's exception callback handler to relay what happened. The host
  24 controller reports transport errors to the exception callback handler through
  25 the handler's request argument's completion reason (usb_cr_t) field. A
  26 completion reason of USB_CR_OK means the transfer completed with no errors
  27 detected.
  28 .sp
  29 .LP
  30 The usb_cr_t enumerated type contains the following definitions:
  31 .sp
  32 .ne 2
  33 .na
  34 \fBUSB_CR_OK\fR
  35 .ad
  36 .RS 27n
  37 The transfer completed without any errors being detected.
  38 .RE
  39
  40 .sp
  41 .ne 2
  42 .na
  43 \fBUSB_CR_CRC\fR
  44 .ad
  45 .RS 27n
  46 CRC error was detected.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fBUSB_CR_BITSTUFFING\fR
  53 .ad
  54 .RS 27n
  55 Bit stuffing violation was detected.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fBUSB_CR_DATA_TOGGLE_MM\fR
  62 .ad
  63 .RS 27n
  64 Data toggle packet identifier did not match expected value.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fBUSB_CR_STALL\fR
  71 .ad
  72 .RS 27n
  73 The device endpoint indicated that it is stalled. If autoclearing is enabled
  74 for the request (request attributes has USB_ATTRS_AUTOCLEARING set), check the
  75 callback flags (usb_cb_flags_t) in the callback handler to determine whether
  76 the stall is a functional stall (USB_CB_FUNCTIONAL_STALL) or a protocol stall
  77 (USB_CB_PROTOCOL_STALL).  Please see \fBusb_request_attributes\fR(9S) for more
  78 information on autoclearing.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fBUSB_CR_DEV_NOT_RESP\fR
  85 .ad
  86 .RS 27n
  87 Host controller timed out while waiting for device to respond.
  88 .RE
  89
  90 .sp
  91 .ne 2
  92 .na
  93 \fBUSB_CR_PID_CHECKFAILURE\fR
  94 .ad
  95 .RS 27n
  96 Check bits on the packet identifier returned from the device             were
  97 not as expected.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fBUSB_CR_UNEXP_PID\fR
 104 .ad
 105 .RS 27n
 106 Packet identifier received was not valid.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fBUSB_CR_DATA_OVERRUN\fR
 113 .ad
 114 .RS 27n
 115 Amount of data returned exceeded either the maximum packet size of the endpoint
 116 or the remaining buffer size.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fBUSB_CR_DATA_UNDERRUN\fR
 123 .ad
 124 .RS 27n
 125 Amount of data returned was not sufficient to fill the specified buffer and the
 126 USB_ATTRS_SHORT_XFER_OK attribute was not set. Please see
 127 \fBusb_request_attributes\fR(9S) for more information on allowance of short
 128 transfers.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fBUSB_CR_BUFFER_OVERRUN\fR
 135 .ad
 136 .RS 27n
 137 A device sent data faster than the system could digest it.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fBUSB_CR_BUFFER_UNDERRUN\fR
 144 .ad
 145 .RS 27n
 146 The host controller could not get data from the system fast enough to keep up
 147 with the required USB data rate.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fBUSB_CR_TIMEOUT\fR
 154 .ad
 155 .RS 27n
 156 A timeout specified in a control, bulk, or one-time interrupt request has
 157 expired.
 158 .RE
 159
 160 .sp
 161 .ne 2
 162 .na
 163 \fBUSB_CR_NOT_ACCESSED\fR
 164 .ad
 165 .RS 27n
 166 Request was not accessed nor processed by the host controller.
 167 .RE
 168
 169 .sp
 170 .ne 2
 171 .na
 172 \fBUSB_CR_NO_RESOURCES\fR
 173 .ad
 174 .RS 27n
 175 No resources were available to continue servicing a periodic interrupt or
 176 isochronous request.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fBUSB_CR_STOPPED_POLLING\fR
 183 .ad
 184 .RS 27n
 185 Servicing of the current periodic request cannot continue because polling on an
 186 interrupt-IN or isochronous-IN endpoint has stopped.
 187 .RE
 188
 189 .sp
 190 .ne 2
 191 .na
 192 \fBUSB_CR_PIPE_CLOSING\fR
 193 .ad
 194 .RS 27n
 195 Request was not started because the pipe to which it was queued was closing or
 196 closed.
 197 .RE
 198
 199 .sp
 200 .ne 2
 201 .na
 202 \fBUSB_CR_PIPE_RESET\fR
 203 .ad
 204 .RS 27n
 205 Request was not started because the pipe to which it was queued was reset.
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fBUSB_CR_NOT_SUPPORTED\fR
 212 .ad
 213 .RS 27n
 214 Request or command is not supported.
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fBUSB_CR_FLUSHED\fR
 221 .ad
 222 .RS 27n
 223 Request was not completed because the pipe to which it was queued went to an
 224 error state, became stalled, was reset or was closed.
 225 .RE
 226
 227 .sp
 228 .ne 2
 229 .na
 230 \fBUSB_CR_HC_HARDWARE_ERR\fR
 231 .ad
 232 .RS 27n
 233 Request could not be completed due to a general host             controller
 234 hardware error.
 235 .RE
 236
 237 .SH ATTRIBUTES
 238 .sp
 239 .LP
 240 See attributes(5) for descriptions of the following attributes:
 241 .sp
 242
 243 .sp
 244 .TS
 245 box;
 246 c | c
 247 l | l .
 248 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 249 _
 250 Architecture    PCI-based systems
 251 _
 252 Interface stability     Committed
 253 .TE
 254
 255 .SH SEE ALSO
 256 .sp
 257 .LP
 258 \fBusb_alloc_request\fR(9F), \fBusb_pipe_bulk_xfer\fR(9F),
 259 \fBusb_pipe_ctrl_xfer\fR(9F), \fBusb_pipe_intr_xfer\fR(9F),
 260 \fBusb_pipe_isoc_xfer\fR(9F), \fBusb_bulk_request\fR(9S),
 261 \fBusb_ctrl_request\fR(9S), \fBusb_intr_request\fR(9S),
 262 \fBusb_isoc_request\fR(9S)