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