usb_ep_descr(9s)

1usb_ep_descr(9S)          Data Structures for Drivers         usb_ep_descr(9S)
2
3
4

NAME

6       usb_ep_descr - USB endpoint descriptor
7

SYNOPSIS

9       #include <sys/usb/usba.h>
10
11

INTERFACE LEVEL

13       Solaris DDI specific (Solaris DDI)
14

DESCRIPTION

16       The usb_ep_descr_t endpoint descriptor defines endpoint attributes.  An
17       endpoint is a uniquely addressable portion of a USB device  that  is  a
18       source or sink of data.
19
20
21       Please refer to Section 9.6.6 of the USB 2.0 specification. The USB 2.0
22       specification is available at www.usb.org.
23
24
25       One or more endpoint descriptors are retrieved from a USB device during
26       device enumeration.  They can be accessed via usb_get_dev_data(9F).
27
28
29       A endpoint descriptor has the following fields:
30
31         uint8_t    bLength                 Size of this descriptor
32                                            in bytes.
33
34         uint8_t    bDescriptorType         Set to USB_DESCR_TYPE_EP.
35
36         uint8_t    bEndpointAddress        Endpoint address.
37
38         uint8_t    bmAttributes            Endpoint attrib. (see below.)
39
40         uint16_t   wMaxPacketSize          Maximum pkt size.
41
42         uint8_t    bInterval               Polling interval for interrupt
43                                            and isochro. endpoints.
44                                            NAK rate for high-speed control
45                                            and bulk endpoints.
46
47         Endpoint descriptor bEndpointAddress bitmasks contain address number
48         and direction fields as follows:
49             USB_EP_NUM_MASK        Address bits
50             USB_EP_DIR_MASK        Direction bit
51             USB_EP_DIR_OUT         OUT towards device
52             USB_EP_DIR_IN          IN towards host
53
54         Endpoint descriptor transfer type bmAttributes values and mask:
55             USB_EP_ATTR_CONTROL    Endpoint supports control transfers
56             USB_EP_ATTR_ISOCH      Endpoint supports isochronous xfers
57             USB_EP_ATTR_BULK       Endpoint supports bulk transfers
58             USB_EP_ATTR_INTR       Endpoint supports interrupt transfers
59             USB_EP_ATTR_MASK       bmAttributes transfer-type bit field
60
61         Endpoint descriptor synchronization type bmAttributes values and mask
62         for isochronous endpoints:
63             USB_EP_SYNC_NONE       Endpoint supports no synchronization
64             USB_EP_SYNC_ASYNC      Endpoint supports asynchronous sync
65             USB_EP_SYNC_ADPT       Endpoint supports adaptive sync
66             USB_EP_SYNC_SYNC       Endpoint supports synchronous sync
67             USB_EP_SYNC_MASK       bmAttributes sync type bit field
68
69         Endpoint descriptor feedback type bmAttributes values and mask for
70         isochronous endpoints:
71             USB_EP_USAGE_DATA                 Data endpoint
72             USB_EP_USAGE_FEED                 Feedback endpoint
73             USB_EP_USAGE_IMPL                 Implicit feedback data endpoint
74             USB_EP_USAGE_MASK                 bmAttributes feedback type bit fld
75
76         Endpoint descriptor additional-transaction-opportunities-
77         per-microframe wMaxPacketSize values and mask for high speed
78         isochronous and interrupt endpoints:
79             USB_EP_MAX_PKTSZ_MASK             Mask for packetsize bits
80             USB_EP_MAX_XACTS_MASK             Bits for additional transfers per
81                                               microframe
82             USB_EP_MAX_XACTS_SHIFT            Left-shift this number of bits to
83                                               get to additional-transfers-per-
84                                               microframe bitfield
85
86         Endpoint descriptor polling bInterval range values:
87             USB_EP_MIN_HIGH_CONTROL_INTRVL    Min NAK rate for highspd ctrl e/p
88             USB_EP_MAX_HIGH_CONTROL_INTRVL    Max NAK rate for highspd ctrl e/p
89
90             USB_EP_MIN_HIGH_BULK_INTRVL       Min NAK rate for highspd bulk e/p
91             USB_EP_MAX_HIGH_BULK_INTRVL       Max NAK rate for highspd bulk e/p
92
93             USB_EP_MIN_LOW_INTR_INTRVL        Min poll interval, lowspd intr e/p
94             USB_EP_MAX_LOW_INTR_INTRVL        Max poll interval, lowspd intr e/p
95
96             USB_EP_MIN_FULL_INTR_INTRVL       Min poll interval, fullspd intr e/p
97             USB_EP_MAX_FULL_INTR_INTRVL       Max poll interval, fullspd intr e/p
98
99         Note that for the following polling bInterval range values, the interval
100         is 2**(value-1). See Section 9.6.6 of the USB 2.0 specification.
101
102             USB_EP_MIN_HIGH_INTR_INTRVL       Min poll interval, highspd intr e/p
103             USB_EP_MAX_HIGH_INTR_INTRVL       Max poll interval, highspd intr e/p
104
105             USB_EP_MIN_FULL_ISOCH_INTRVL      Min poll interval, fullspd isoc e/p
106             USB_EP_MAX_FULL_ISOCH_INTRVL      Max poll interval, fullspd isoc e/p
107
108             USB_EP_MIN_HIGH_ISOCH_INTRVL      Min poll interval, highspd isoc e/p
109             USB_EP_MAX_HIGH_ISOCH_INTRVL      Max poll interval, highspd isoc e/p
110
111
112

ATTRIBUTES

114       See attributes(5) for descriptions of the following attributes:
115
116
117
118
119       ┌─────────────────────────────┬─────────────────────────────┐
120       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
121       ├─────────────────────────────┼─────────────────────────────┤
122       │Architecture                 │PCI-based systems            │
123       ├─────────────────────────────┼─────────────────────────────┤
124       │Interface stability          │Committed                    │
125       ├─────────────────────────────┼─────────────────────────────┤
126       │Availability                 │SUNWusbu                     │
127       └─────────────────────────────┴─────────────────────────────┘
128

NAME

SYNOPSIS

INTERFACE LEVEL

DESCRIPTION

ATTRIBUTES

SEE ALSO