Skip to content

Commit 3443333

Browse files
mchehabgregkh
authored andcommitted
docs: ABI: testing: make the files compatible with ReST output
Some files over there won't parse well by Sphinx. Fix them. Acked-by: Jonathan Cameron <Jonathan.Cameron@huawei.com> # for IIO Acked-by: Fabrice Gasnier <fabrice.gasnier@st.com> Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
1 parent 9891340 commit 3443333

74 files changed

Lines changed: 1336 additions & 879 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Documentation/ABI/testing/configfs-spear-pcie-gadget

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,24 @@ Description:
1010
This interfaces can be used to show spear's PCIe device capability.
1111

1212
Nodes are only visible when configfs is mounted. To mount configfs
13-
in /config directory use:
14-
# mount -t configfs none /config/
13+
in /config directory use::
1514

16-
For nth PCIe Device Controller
17-
/config/pcie-gadget.n/
18-
link ... used to enable ltssm and read its status.
19-
int_type ...used to configure and read type of supported
20-
interrupt
21-
no_of_msi ... used to configure number of MSI vector needed and
15+
# mount -t configfs none /config/
16+
17+
For nth PCIe Device Controller /config/pcie-gadget.n/:
18+
19+
=============== ======================================================
20+
link used to enable ltssm and read its status.
21+
int_type used to configure and read type of supported interrupt
22+
no_of_msi used to configure number of MSI vector needed and
2223
to read no of MSI granted.
23-
inta ... write 1 to assert INTA and 0 to de-assert.
24-
send_msi ... write MSI vector to be sent.
25-
vendor_id ... used to write and read vendor id (hex)
26-
device_id ... used to write and read device id (hex)
27-
bar0_size ... used to write and read bar0_size
28-
bar0_address ... used to write and read bar0 mapped area in hex.
29-
bar0_rw_offset ... used to write and read offset of bar0 where
30-
bar0_data will be written or read.
31-
bar0_data ... used to write and read data at bar0_rw_offset.
24+
inta write 1 to assert INTA and 0 to de-assert.
25+
send_msi write MSI vector to be sent.
26+
vendor_id used to write and read vendor id (hex)
27+
device_id used to write and read device id (hex)
28+
bar0_size used to write and read bar0_size
29+
bar0_address used to write and read bar0 mapped area in hex.
30+
bar0_rw_offset used to write and read offset of bar0 where bar0_data
31+
will be written or read.
32+
bar0_data used to write and read data at bar0_rw_offset.
33+
=============== ======================================================

Documentation/ABI/testing/configfs-usb-gadget

Lines changed: 51 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,22 +12,24 @@ Description:
1212

1313
The attributes of a gadget:
1414

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
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+
================ ============================================
3133

3234
What: /config/usb-gadget/gadget/configs
3335
Date: Jun 2013
@@ -41,8 +43,10 @@ KernelVersion: 3.11
4143
Description:
4244
The attributes of a configuration:
4345

44-
bmAttributes - configuration characteristics
45-
MaxPower - maximum power consumption from the bus
46+
================ ======================================
47+
bmAttributes configuration characteristics
48+
MaxPower maximum power consumption from the bus
49+
================ ======================================
4650

4751
What: /config/usb-gadget/gadget/configs/config/strings
4852
Date: Jun 2013
@@ -57,7 +61,9 @@ KernelVersion: 3.11
5761
Description:
5862
The attributes:
5963

60-
configuration - configuration description
64+
================ =========================
65+
configuration configuration description
66+
================ =========================
6167

6268

6369
What: /config/usb-gadget/gadget/functions
@@ -76,8 +82,10 @@ Description:
7682

7783
The attributes:
7884

79-
compatible_id - 8-byte string for "Compatible ID"
80-
sub_compatible_id - 8-byte string for "Sub Compatible ID"
85+
================= =====================================
86+
compatible_id 8-byte string for "Compatible ID"
87+
sub_compatible_id 8-byte string for "Sub Compatible ID"
88+
================= =====================================
8189

8290
What: /config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>
8391
Date: May 2014
@@ -89,16 +97,19 @@ Description:
8997

9098
The attributes:
9199

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
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
101111
type
112+
===== ===============================================
102113

103114
What: /config/usb-gadget/gadget/strings
104115
Date: Jun 2013
@@ -113,18 +124,22 @@ KernelVersion: 3.11
113124
Description:
114125
The attributes:
115126

116-
serialnumber - gadget's serial number (string)
117-
product - gadget's product description
118-
manufacturer - gadget's manufacturer description
127+
============ =================================
128+
serialnumber gadget's serial number (string)
129+
product gadget's product description
130+
manufacturer gadget's manufacturer description
131+
============ =================================
119132

120133
What: /config/usb-gadget/gadget/os_desc
121134
Date: May 2014
122135
KernelVersion: 3.16
123136
Description:
124137
This group contains "OS String" extension handling attributes.
125138

126-
use - flag turning "OS Desctiptors" support on/off
127-
b_vendor_code - one-byte value used for custom per-device and
139+
============= ===============================================
140+
use flag turning "OS Desctiptors" support on/off
141+
b_vendor_code one-byte value used for custom per-device and
128142
per-interface requests
129-
qw_sign - an identifier to be reported as "OS String"
143+
qw_sign an identifier to be reported as "OS String"
130144
proper
145+
============= ===============================================

Documentation/ABI/testing/configfs-usb-gadget-hid

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ KernelVersion: 3.19
44
Description:
55
The attributes:
66

7-
protocol - HID protocol to use
8-
report_desc - blob corresponding to HID report descriptors
7+
============= ============================================
8+
protocol HID protocol to use
9+
report_desc blob corresponding to HID report descriptors
910
except the data passed through /dev/hidg<N>
10-
report_length - HID report length
11-
subclass - HID device subclass to use
11+
report_length HID report length
12+
subclass HID device subclass to use
13+
============= ============================================

Documentation/ABI/testing/configfs-usb-gadget-rndis

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,16 @@ KernelVersion: 3.11
44
Description:
55
The attributes:
66

7-
ifname - network device interface name associated with
7+
========= =============================================
8+
ifname network device interface name associated with
89
this function instance
9-
qmult - queue length multiplier for high and
10+
qmult queue length multiplier for high and
1011
super speed
11-
host_addr - MAC address of host's end of this
12+
host_addr MAC address of host's end of this
1213
Ethernet over USB link
13-
dev_addr - MAC address of device's end of this
14+
dev_addr MAC address of device's end of this
1415
Ethernet over USB link
15-
class - USB interface class, default is 02 (hex)
16-
subclass - USB interface subclass, default is 06 (hex)
17-
protocol - USB interface protocol, default is 00 (hex)
16+
class USB interface class, default is 02 (hex)
17+
subclass USB interface subclass, default is 06 (hex)
18+
protocol USB interface protocol, default is 00 (hex)
19+
========= =============================================

Documentation/ABI/testing/configfs-usb-gadget-uac1

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ KernelVersion: 4.14
44
Description:
55
The attributes:
66

7-
c_chmask - capture channel mask
8-
c_srate - capture sampling rate
9-
c_ssize - capture sample size (bytes)
10-
p_chmask - playback channel mask
11-
p_srate - playback sampling rate
12-
p_ssize - playback sample size (bytes)
13-
req_number - the number of pre-allocated request
14-
for both capture and playback
7+
========== ===================================
8+
c_chmask capture channel mask
9+
c_srate capture sampling rate
10+
c_ssize capture sample size (bytes)
11+
p_chmask playback channel mask
12+
p_srate playback sampling rate
13+
p_ssize playback sample size (bytes)
14+
req_number the number of pre-allocated request
15+
for both capture and playback
16+
========== ===================================

0 commit comments

Comments
 (0)