usr/src/man/man9s/usb_ep_descr.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_EP_DESCR 9S "Jan 5, 2004"
   7 .SH NAME
   8 usb_ep_descr \- USB endpoint descriptor
   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 The \fBusb_ep_descr_t\fR endpoint descriptor defines endpoint attributes.  An
  23 endpoint is a uniquely addressable portion of a USB device that is a source or
  24 sink of data.
  25 .sp
  26 .LP
  27 Please refer to Section \fI9.6.6\fR of the \fIUSB 2.0\fR specification. The
  28 \fIUSB 2.0\fR specification is available at \fIwww.usb.org\fR.
  29 .sp
  30 .LP
  31 One or more endpoint descriptors are retrieved from a USB device during device
  32 enumeration.  They can be accessed via \fBusb_get_dev_data\fR(9F).
  33 .sp
  34 .LP
  35 A endpoint descriptor has the following fields:
  36 .sp
  37 .in +2
  38 .nf
  39 uint8_t    bLength                 Size of this descriptor
  40                                    in bytes.
  41
  42 uint8_t    bDescriptorType         Set to USB_DESCR_TYPE_EP.
  43
  44 uint8_t    bEndpointAddress        Endpoint address.
  45
  46 uint8_t    bmAttributes            Endpoint attrib. (see below.)
  47
  48 uint16_t   wMaxPacketSize          Maximum pkt size.
  49
  50 uint8_t    bInterval               Polling interval for interrupt
  51                                    and isochro. endpoints.
  52                                    NAK rate for high-speed control
  53                                    and bulk endpoints.
  54
  55 Endpoint descriptor bEndpointAddress bitmasks contain address number
  56 and direction fields as follows:
  57     USB_EP_NUM_MASK        Address bits
  58     USB_EP_DIR_MASK        Direction bit
  59     USB_EP_DIR_OUT         OUT towards device
  60     USB_EP_DIR_IN          IN towards host
  61
  62 Endpoint descriptor transfer type bmAttributes values and mask:
  63     USB_EP_ATTR_CONTROL    Endpoint supports control transfers
  64     USB_EP_ATTR_ISOCH      Endpoint supports isochronous xfers
  65     USB_EP_ATTR_BULK       Endpoint supports bulk transfers
  66     USB_EP_ATTR_INTR       Endpoint supports interrupt transfers
  67     USB_EP_ATTR_MASK       bmAttributes transfer-type bit field
  68
  69 Endpoint descriptor synchronization type bmAttributes values and mask
  70 for isochronous endpoints:
  71     USB_EP_SYNC_NONE       Endpoint supports no synchronization
  72     USB_EP_SYNC_ASYNC      Endpoint supports asynchronous sync
  73     USB_EP_SYNC_ADPT       Endpoint supports adaptive sync
  74     USB_EP_SYNC_SYNC       Endpoint supports synchronous sync
  75     USB_EP_SYNC_MASK       bmAttributes sync type bit field
  76
  77 Endpoint descriptor feedback type bmAttributes values and mask for
  78 isochronous endpoints:
  79     USB_EP_USAGE_DATA                 Data endpoint
  80     USB_EP_USAGE_FEED                 Feedback endpoint
  81     USB_EP_USAGE_IMPL                 Implicit feedback data endpoint
  82     USB_EP_USAGE_MASK                 bmAttributes feedback type bit fld
  83
  84 Endpoint descriptor additional-transaction-opportunities-
  85 per-microframe wMaxPacketSize values and mask for high speed
  86 isochronous and interrupt endpoints:
  87     USB_EP_MAX_PKTSZ_MASK             Mask for packetsize bits
  88     USB_EP_MAX_XACTS_MASK             Bits for additional transfers per
  89                                       microframe
  90     USB_EP_MAX_XACTS_SHIFT            Left-shift this number of bits to
  91                                       get to additional-transfers-per-
  92                                       microframe bitfield
  93
  94 Endpoint descriptor polling bInterval range values:
  95     USB_EP_MIN_HIGH_CONTROL_INTRVL    Min NAK rate for highspd ctrl e/p
  96     USB_EP_MAX_HIGH_CONTROL_INTRVL    Max NAK rate for highspd ctrl e/p
  97
  98     USB_EP_MIN_HIGH_BULK_INTRVL       Min NAK rate for highspd bulk e/p
  99     USB_EP_MAX_HIGH_BULK_INTRVL       Max NAK rate for highspd bulk e/p
 100
 101     USB_EP_MIN_LOW_INTR_INTRVL        Min poll interval, lowspd intr e/p
 102     USB_EP_MAX_LOW_INTR_INTRVL        Max poll interval, lowspd intr e/p
 103
 104     USB_EP_MIN_FULL_INTR_INTRVL       Min poll interval, fullspd intr e/p
 105     USB_EP_MAX_FULL_INTR_INTRVL       Max poll interval, fullspd intr e/p
 106
 107 Note that for the following polling bInterval range values, the interval
 108 is 2**(value-1). See Section 9.6.6 of the USB 2.0 specification.
 109
 110     USB_EP_MIN_HIGH_INTR_INTRVL       Min poll interval, highspd intr e/p
 111     USB_EP_MAX_HIGH_INTR_INTRVL       Max poll interval, highspd intr e/p
 112
 113     USB_EP_MIN_FULL_ISOCH_INTRVL      Min poll interval, fullspd isoc e/p
 114     USB_EP_MAX_FULL_ISOCH_INTRVL      Max poll interval, fullspd isoc e/p
 115
 116     USB_EP_MIN_HIGH_ISOCH_INTRVL      Min poll interval, highspd isoc e/p
 117     USB_EP_MAX_HIGH_ISOCH_INTRVL      Max poll interval, highspd isoc e/p
 118
 119 .fi
 120 .in -2
 121
 122 .SH ATTRIBUTES
 123 .sp
 124 .LP
 125 See \fBattributes\fR(5) for descriptions of the following attributes:
 126 .sp
 127
 128 .sp
 129 .TS
 130 box;
 131 c | c
 132 l | l .
 133 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 134 _
 135 Architecture    PCI-based systems
 136 _
 137 Interface stability     Committed
 138 .TE
 139
 140 .SH SEE ALSO
 141 .sp
 142 .LP
 143 \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F),
 144 \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F),
 145 \fBusb_parse_data\fR(9F), \fBusb_cfg_descr\fR(9S), \fBusb_ctrl_request\fR(9S),
 146 \fBusb_dev_descr\fR(9S), \fBusb_dev_qlf_descr\fR(9S), \fBusb_if_descr\fR(9S),
 147 \fBusb_other_speed_cfg_descr\fR(9S), \fBusb_string_descr\fR(9S)