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