Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

usb: gadget: udc: document our sysfs ABI

I noticed that this has been missing for quite
some time so I decided it was about time to
document it.

Signed-off-by: Felipe Balbi <balbi@ti.com>

+93
+93
Documentation/ABI/stable/sysfs-class-udc
··· 1 + What: /sys/class/udc/<udc>/a_alt_hnp_support 2 + Date: June 2011 3 + KernelVersion: 3.1 4 + Contact: Felipe Balbi <balbi@kernel.org> 5 + Description: 6 + Indicates if an OTG A-Host supports HNP at an alternate port. 7 + Users: 8 + 9 + What: /sys/class/udc/<udc>/a_hnp_support 10 + Date: June 2011 11 + KernelVersion: 3.1 12 + Contact: Felipe Balbi <balbi@kernel.org> 13 + Description: 14 + Indicates if an OTG A-Host supports HNP at this port. 15 + Users: 16 + 17 + What: /sys/class/udc/<udc>/b_hnp_enable 18 + Date: June 2011 19 + KernelVersion: 3.1 20 + Contact: Felipe Balbi <balbi@kernel.org> 21 + Description: 22 + Indicates if an OTG A-Host enabled HNP support. 23 + Users: 24 + 25 + What: /sys/class/udc/<udc>/current_speed 26 + Date: June 2011 27 + KernelVersion: 3.1 28 + Contact: Felipe Balbi <balbi@kernel.org> 29 + Description: 30 + Indicates the current negotiated speed at this port. 31 + Users: 32 + 33 + What: /sys/class/udc/<udc>/is_a_peripheral 34 + Date: June 2011 35 + KernelVersion: 3.1 36 + Contact: Felipe Balbi <balbi@kernel.org> 37 + Description: 38 + Indicates that this port is the default Host on an OTG session 39 + but HNP was used to switch roles. 40 + Users: 41 + 42 + What: /sys/class/udc/<udc>/is_otg 43 + Date: June 2011 44 + KernelVersion: 3.1 45 + Contact: Felipe Balbi <balbi@kernel.org> 46 + Description: 47 + Indicates that this port support OTG. 48 + Users: 49 + 50 + What: /sys/class/udc/<udc>/maximum_speed 51 + Date: June 2011 52 + KernelVersion: 3.1 53 + Contact: Felipe Balbi <balbi@kernel.org> 54 + Description: 55 + Indicates the maximum USB speed supported by this port. 56 + Users: 57 + 58 + What: /sys/class/udc/<udc>/maximum_speed 59 + Date: June 2011 60 + KernelVersion: 3.1 61 + Contact: Felipe Balbi <balbi@kernel.org> 62 + Description: 63 + Indicates the maximum USB speed supported by this port. 64 + Users: 65 + 66 + What: /sys/class/udc/<udc>/soft_connect 67 + Date: June 2011 68 + KernelVersion: 3.1 69 + Contact: Felipe Balbi <balbi@kernel.org> 70 + Description: 71 + Allows users to disconnect data pullup resistors thus causing a 72 + logical disconnection from the USB Host. 73 + Users: 74 + 75 + What: /sys/class/udc/<udc>/srp 76 + Date: June 2011 77 + KernelVersion: 3.1 78 + Contact: Felipe Balbi <balbi@kernel.org> 79 + Description: 80 + Allows users to manually start Session Request Protocol. 81 + Users: 82 + 83 + What: /sys/class/udc/<udc>/state 84 + Date: June 2011 85 + KernelVersion: 3.1 86 + Contact: Felipe Balbi <balbi@kernel.org> 87 + Description: 88 + Indicates current state of the USB Device Controller. Valid 89 + states are: 'not-attached', 'attached', 'powered', 90 + 'reconnecting', 'unauthenticated', 'default', 'addressed', 91 + 'configured', and 'suspended'; however not all USB Device 92 + Controllers support reporting all states. 93 + Users: