share/man/man9s/usb_cfg_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_CFG_DESCR 9S "Jan 5, 2004"
   7 .SH NAME
   8 usb_cfg_descr \- USB configuration 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_cfg_descr_t\fR configuration descriptor defines attributes of a
  23 configuration. A configuration contains one or more interfaces. A configuration
  24 descriptor acts as a header for the group of other descriptors describing the
  25 subcomponents (for example, interfaces and endpoints) of a configuration.
  26 Please refer to Section \fI9.6.3\fR of the \fIUSB 2.0\fR specification. The
  27 \fIUSB 2.0\fR specification is available at \fIwww.usb.org\fR.
  28 .sp
  29 .LP
  30 One or more configuration descriptors are retrieved from a USB device during
  31 device enumeration. They can be accessed via \fBusb_get_dev_data\fR(9F).
  32 .sp
  33 .LP
  34 A configuration descriptor has the following fields:
  35 .sp
  36 .in +2
  37 .nf
  38 uint8_t         bLength                 Size of this descriptor
  39                                         in bytes.
  40
  41 uint8_t         bDescriptorType         Set to USB_DESCR_TYPE_CFG.
  42
  43 uint16_t        wTotalLength            Total length of data returned
  44                                         including this and all other
  45                                         descriptors in this configuration.
  46
  47 uint8_t         bNumInterfaces          Number of interfaces in this
  48                                         configuration.
  49
  50 uint8_t         bConfigurationValue     ID of this configuration
  51                                         (1-based).
  52
  53 uint8_t         iConfiguration          Index of optional configuration
  54                                         string. Valid if > 0.
  55
  56 uint8_t         bmAttributes            Configuration characteristics
  57                                         (See below).
  58
  59 uint8_t         bMaxPower               Maximum power consumption, in
  60                                         2mA units.
  61
  62 Configuration descriptors define the following bmAttributes:
  63      USB_CFG_ATTR_SELFPWR       -      Set if config not using bus power.
  64      USB_CFG_ATTR_REMOTE_WAKEUP -      Set if config supports rem wakeup.
  65 .fi
  66 .in -2
  67
  68 .SH ATTRIBUTES
  69 .sp
  70 .LP
  71 See \fBattributes\fR(5) for descriptions of the following attributes:
  72 .sp
  73
  74 .sp
  75 .TS
  76 box;
  77 c | c
  78 l | l .
  79 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  80 _
  81 Architecture    PCI-based systems
  82 _
  83 Interface stability     Committed
  84 .TE
  85
  86 .SH SEE ALSO
  87 .sp
  88 .LP
  89 \fBattributes\fR(5), \fBusb_get_alt_if\fR(9F), \fBusb_get_cfg\fR(9F),
  90 \fBusb_get_dev_data\fR(9F), \fBusb_get_string_descr\fR(9F),
  91 \fBusb_parse_data\fR(9F), \fBusb_ctrl_request\fR(9S), \fBusb_dev_descr\fR(9S),
  92 \fBusb_dev_qlf_descr\fR(9S), \fBusb_ep_descr\fR(9S), \fBusb_if_descr\fR(9S),
  93 \fBusb_other_speed_cfg_descr\fR(9S), \fBusb_string_descr\fR(9S)