Commit 5b92f46c967706d43717aa666c50c6ea0b12da43

Authored by Andrzej Pietrasiewicz
Committed by Greg Kroah-Hartman
1 parent 5e654a4655

Documentation/ABI/testing: configfs-based usb gadgets

Signed-off-by: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com>
Acked-by: Felipe Balbi <balbi@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

Showing 10 changed files with 142 additions and 4 deletions Side-by-side Diff

Documentation/ABI/testing/configfs-usb-gadget
  1 +What: /config/usb-gadget
  2 +Date: Jun 2013
  3 +KenelVersion: 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 +KenelVersion: 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 +KenelVersion: 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 +KenelVersion: 3.11
  62 +Description:
  63 + This group contains functions available to this USB gadget.
  64 +
  65 +What: /config/usb-gadget/gadget/strings
  66 +Date: Jun 2013
  67 +KenelVersion: 3.11
  68 +Description:
  69 + This group contains subdirectories for language-specific
  70 + strings for this gadget.
  71 +
  72 +What: /config/usb-gadget/gadget/strings/language
  73 +Date: Jun 2013
  74 +KenelVersion: 3.11
  75 +Description:
  76 + The attributes:
  77 +
  78 + serialnumber - gadget's serial number (string)
  79 + product - gadget's product description
  80 + manufacturer - gadget's manufacturer description
Documentation/ABI/testing/configfs-usb-gadget-acm
  1 +What: /config/usb-gadget/gadget/functions/acm.name
  2 +Date: Jun 2013
  3 +KenelVersion: 3.11
  4 +Description:
  5 +
  6 + This item contains just one readonly attribute: port_num.
  7 + It contains the port number of the /dev/ttyGS<n> device
  8 + associated with acm function's instance "name".
Documentation/ABI/testing/configfs-usb-gadget-ecm
  1 +What: /config/usb-gadget/gadget/functions/ecm.name
  2 +Date: Jun 2013
  3 +KenelVersion: 3.11
  4 +Description:
  5 + The attributes:
  6 +
  7 + ifname - network device interface name associated with
  8 + this function instance
  9 + qmult - queue length multiplier for high and
  10 + super speed
  11 + host_addr - MAC address of host's end of this
  12 + Ethernet over USB link
  13 + dev_addr - MAC address of device's end of this
  14 + Ethernet over USB link
Documentation/ABI/testing/configfs-usb-gadget-eem
1 1 What: /config/usb-gadget/gadget/functions/eem.name
2   -Date: May 2013
  2 +Date: Jun 2013
3 3 KenelVersion: 3.11
4 4 Description:
5 5 The attributes:
Documentation/ABI/testing/configfs-usb-gadget-ncm
  1 +What: /config/usb-gadget/gadget/functions/ncm.name
  2 +Date: Jun 2013
  3 +KenelVersion: 3.11
  4 +Description:
  5 + The attributes:
  6 +
  7 + ifname - network device interface name associated with
  8 + this function instance
  9 + qmult - queue length multiplier for high and
  10 + super speed
  11 + host_addr - MAC address of host's end of this
  12 + Ethernet over USB link
  13 + dev_addr - MAC address of device's end of this
  14 + Ethernet over USB link
Documentation/ABI/testing/configfs-usb-gadget-obex
  1 +What: /config/usb-gadget/gadget/functions/obex.name
  2 +Date: Jun 2013
  3 +KenelVersion: 3.11
  4 +Description:
  5 +
  6 + This item contains just one readonly attribute: port_num.
  7 + It contains the port number of the /dev/ttyGS<n> device
  8 + associated with obex function's instance "name".
Documentation/ABI/testing/configfs-usb-gadget-phonet
1 1 What: /config/usb-gadget/gadget/functions/phonet.name
2   -Date: May 2013
  2 +Date: Jun 2013
3 3 KenelVersion: 3.11
4 4 Description:
5 5  
Documentation/ABI/testing/configfs-usb-gadget-rndis
1 1 What: /config/usb-gadget/gadget/functions/rndis.name
2   -Date: May 2013
  2 +Date: Jun 2013
3 3 KenelVersion: 3.11
4 4 Description:
5 5 The attributes:
Documentation/ABI/testing/configfs-usb-gadget-serial
  1 +What: /config/usb-gadget/gadget/functions/gser.name
  2 +Date: Jun 2013
  3 +KenelVersion: 3.11
  4 +Description:
  5 +
  6 + This item contains just one readonly attribute: port_num.
  7 + It contains the port number of the /dev/ttyGS<n> device
  8 + associated with gser function's instance "name".
Documentation/ABI/testing/configfs-usb-gadget-subset
1 1 What: /config/usb-gadget/gadget/functions/geth.name
2   -Date: May 2013
  2 +Date: Jun 2013
3 3 KenelVersion: 3.11
4 4 Description:
5 5 The attributes: