Documentation/ABI/testing/configfs-usb-gadget

   1 What:           /config/usb-gadget
   2 Date:           Jun 2013
   3 KernelVersion:  3.11
   4 Description:
   5                 This group contains sub-groups corresponding to created
   6                 USB gadgets.
   7
   8 What:           /config/usb-gadget/gadget
   9 Date:           Jun 2013
  10 KernelVersion:  3.11
  11 Description:
  12
  13                 The attributes of a gadget:
  14
  15                 ================  ============================================
  16                 UDC               bind a gadget to UDC/unbind a gadget;
  17                                   write UDC's name found in /sys/class/udc/*
  18                                   to bind a gadget, empty string "" to unbind.
  19
  20                 max_speed         maximum speed the driver supports. Valid
  21                                   names are super-speed-plus, super-speed,
  22                                   high-speed, full-speed, and low-speed.
  23
  24                 bDeviceClass      USB device class code
  25                 bDeviceSubClass   USB device subclass code
  26                 bDeviceProtocol   USB device protocol code
  27                 bMaxPacketSize0   maximum endpoint 0 packet size
  28                 bcdDevice         bcd device release number
  29                 bcdUSB            bcd USB specification version number
  30                 idProduct         product ID
  31                 idVendor          vendor ID
  32                 ================  ============================================
  33
  34 What:           /config/usb-gadget/gadget/configs
  35 Date:           Jun 2013
  36 KernelVersion:  3.11
  37 Description:
  38                 This group contains a USB gadget's configurations
  39
  40 What:           /config/usb-gadget/gadget/configs/config
  41 Date:           Jun 2013
  42 KernelVersion:  3.11
  43 Description:
  44                 The attributes of a configuration:
  45
  46                 ================  ======================================
  47                 bmAttributes      configuration characteristics
  48                 MaxPower          maximum power consumption from the bus
  49                 ================  ======================================
  50
  51 What:           /config/usb-gadget/gadget/configs/config/strings
  52 Date:           Jun 2013
  53 KernelVersion:  3.11
  54 Description:
  55                 This group contains subdirectories for language-specific
  56                 strings for this configuration.
  57
  58 What:           /config/usb-gadget/gadget/configs/config/strings/language
  59 Date:           Jun 2013
  60 KernelVersion:  3.11
  61 Description:
  62                 The attributes:
  63
  64                 ================  =========================
  65                 configuration     configuration description
  66                 ================  =========================
  67
  68
  69 What:           /config/usb-gadget/gadget/functions
  70 Date:           Jun 2013
  71 KernelVersion:  3.11
  72 Description:
  73                 This group contains functions available to this USB gadget.
  74
  75 What:           /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>
  76 Date:           May 2014
  77 KernelVersion:  3.16
  78 Description:
  79                 This group contains "Feature Descriptors" specific for one
  80                 gadget's USB interface or one interface group described
  81                 by an IAD.
  82
  83                 The attributes:
  84
  85                 =================       =====================================
  86                 compatible_id           8-byte string for "Compatible ID"
  87                 sub_compatible_id       8-byte string for "Sub Compatible ID"
  88                 =================       =====================================
  89
  90 What:           /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
  91 Date:           May 2014
  92 KernelVersion:  3.16
  93 Description:
  94                 This group contains "Extended Property Descriptors" specific for one
  95                 gadget's USB interface or one interface group described
  96                 by an IAD.
  97
  98                 The attributes:
  99
 100                 =====           ===============================================
 101                 type            value 1..7 for interpreting the data
 102
 103                                 - 1: unicode string
 104                                 - 2: unicode string with environment variable
 105                                 - 3: binary
 106                                 - 4: little-endian 32-bit
 107                                 - 5: big-endian 32-bit
 108                                 - 6: unicode string with a symbolic link
 109                                 - 7: multiple unicode strings
 110                 data            blob of data to be interpreted depending on
 111                                 type
 112                 =====           ===============================================
 113
 114 What:           /config/usb-gadget/gadget/strings
 115 Date:           Jun 2013
 116 KernelVersion:  3.11
 117 Description:
 118                 This group contains subdirectories for language-specific
 119                 strings for this gadget.
 120
 121 What:           /config/usb-gadget/gadget/strings/language
 122 Date:           Jun 2013
 123 KernelVersion:  3.11
 124 Description:
 125                 The attributes:
 126
 127                 ============    =================================
 128                 serialnumber    gadget's serial number (string)
 129                 product         gadget's product description
 130                 manufacturer    gadget's manufacturer description
 131                 ============    =================================
 132
 133 What:           /config/usb-gadget/gadget/os_desc
 134 Date:           May 2014
 135 KernelVersion:  3.16
 136 Description:
 137                 This group contains "OS String" extension handling attributes.
 138
 139                 =============   ===============================================
 140                 use             flag turning "OS Desctiptors" support on/off
 141                 b_vendor_code   one-byte value used for custom per-device and
 142                                 per-interface requests
 143                 qw_sign         an identifier to be reported as "OS String"
 144                                 proper
 145                 =============   ===============================================