Commit 34433332 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Greg Kroah-Hartman
Browse files

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: default avatarFabrice Gasnier <fabrice.gasnier@st.com>
Acked-by: default avatarJonathan Corbet <corbet@lwn.net>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/58cf3c2d611e0197fb215652719ebd82ca2658db.1604042072.git.mchehab+huawei@kernel.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 98913408

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

+19 −17
Original line number Diff line number Diff line
@@ -10,22 +10,24 @@ Description: 
	This interfaces can be used to show spear's PCIe device capability.



	Nodes are only visible when configfs is mounted. To mount configfs

	in /config directory use:

	in /config directory use::



	  # mount -t configfs none /config/



	For nth PCIe Device Controller

	/config/pcie-gadget.n/

		link ... used to enable ltssm and read its status.

		int_type ...used to configure and read type of supported

			interrupt

		no_of_msi ... used to configure number of MSI vector needed and

	For nth PCIe Device Controller /config/pcie-gadget.n/:



	=============== ======================================================

	link		used to enable ltssm and read its status.

	int_type	used to configure and read type of supported interrupt

	no_of_msi	used to configure number of MSI vector needed and

			to read no of MSI granted.

		inta ... write 1 to assert INTA and 0 to de-assert.

		send_msi ... write MSI vector to be sent.

		vendor_id ... used to write and read vendor id (hex)

		device_id ... used to write and read device id (hex)

		bar0_size ... used to write and read bar0_size

		bar0_address ... used to write and read bar0 mapped area in hex.

		bar0_rw_offset ... used to write and read offset of bar0 where

			bar0_data will be written or read.

		bar0_data ... used to write and read data at bar0_rw_offset.
 
	inta		write 1 to assert INTA and 0 to de-assert.

	send_msi	write MSI vector to be sent.

	vendor_id	used to write and read vendor id (hex)

	device_id	used to write and read device id (hex)

	bar0_size	used to write and read bar0_size

	bar0_address	used to write and read bar0 mapped area in hex.

	bar0_rw_offset	used to write and read offset of bar0 where bar0_data

			will be written or read.

	bar0_data	used to write and read data at bar0_rw_offset.

	=============== ======================================================

Documentation/ABI/testing/configfs-usb-gadget

+51 −36
Original line number Diff line number Diff line
@@ -12,22 +12,24 @@ Description: 


		The attributes of a gadget:



		UDC		- bind a gadget to UDC/unbind a gadget;

		================  ============================================

		UDC		  bind a gadget to UDC/unbind a gadget;

				  write UDC's name found in /sys/class/udc/*

				  to bind a gadget, empty string "" to unbind.



		max_speed	- maximum speed the driver supports. Valid

		max_speed	  maximum speed the driver supports. Valid

				  names are super-speed-plus, super-speed,

				  high-speed, full-speed, and low-speed.



		bDeviceClass	- USB device class code

		bDeviceSubClass	- USB device subclass code

		bDeviceProtocol	- USB device protocol code

		bMaxPacketSize0	- maximum endpoint 0 packet size

		bcdDevice	- bcd device release number

		bcdUSB		- bcd USB specification version number

		idProduct	- product ID

		idVendor	- vendor ID

		bDeviceClass	  USB device class code

		bDeviceSubClass	  USB device subclass code

		bDeviceProtocol	  USB device protocol code

		bMaxPacketSize0	  maximum endpoint 0 packet size

		bcdDevice	  bcd device release number

		bcdUSB		  bcd USB specification version number

		idProduct	  product ID

		idVendor	  vendor ID

		================  ============================================



What:		/config/usb-gadget/gadget/configs

Date:		Jun 2013
@@ -41,8 +43,10 @@ KernelVersion: 3.11 
Description:

		The attributes of a configuration:



		bmAttributes	- configuration characteristics

		MaxPower	- maximum power consumption from the bus

		================  ======================================

		bmAttributes	  configuration characteristics

		MaxPower	  maximum power consumption from the bus

		================  ======================================



What:		/config/usb-gadget/gadget/configs/config/strings

Date:		Jun 2013
@@ -57,7 +61,9 @@ KernelVersion: 3.11 
Description:

		The attributes:



		configuration	- configuration description

		================  =========================

		configuration	  configuration description

		================  =========================





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


		The attributes:



		compatible_id		- 8-byte string for "Compatible ID"

		sub_compatible_id	- 8-byte string for "Sub Compatible ID"

		=================	=====================================

		compatible_id		8-byte string for "Compatible ID"

		sub_compatible_id	8-byte string for "Sub Compatible ID"

		=================	=====================================



What:		/config/usb-gadget/gadget/functions/<func>.<inst>/interface.<n>/<property>

Date:		May 2014
@@ -89,16 +97,19 @@ Description: 


		The attributes:



		type		- value 1..7 for interpreting the data

				1: unicode string

				2: unicode string with environment variable

				3: binary

				4: little-endian 32-bit

				5: big-endian 32-bit

				6: unicode string with a symbolic link

				7: multiple unicode strings

		data		- blob of data to be interpreted depending on

		=====		===============================================

		type		value 1..7 for interpreting the data



				- 1: unicode string

				- 2: unicode string with environment variable

				- 3: binary

				- 4: little-endian 32-bit

				- 5: big-endian 32-bit

				- 6: unicode string with a symbolic link

				- 7: multiple unicode strings

		data		blob of data to be interpreted depending on

				type

		=====		===============================================



What:		/config/usb-gadget/gadget/strings

Date:		Jun 2013
@@ -113,9 +124,11 @@ KernelVersion: 3.11 
Description:

		The attributes:



		serialnumber	- gadget's serial number (string)

		product		- gadget's product description

		manufacturer	- gadget's manufacturer description

		============	=================================

		serialnumber	gadget's serial number (string)

		product		gadget's product description

		manufacturer	gadget's manufacturer description

		============	=================================



What:		/config/usb-gadget/gadget/os_desc

Date:		May 2014
@@ -123,8 +136,10 @@ KernelVersion: 3.16 
Description:

		This group contains "OS String" extension handling attributes.



		use		- flag turning "OS Desctiptors" support on/off

		b_vendor_code	- one-byte value used for custom per-device and

		=============	===============================================

		use		flag turning "OS Desctiptors" support on/off

		b_vendor_code	one-byte value used for custom per-device and

				per-interface requests

		qw_sign		- an identifier to be reported as "OS String"

		qw_sign		an identifier to be reported as "OS String"

				proper

		=============	===============================================

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

+6 −4
Original line number Diff line number Diff line
@@ -4,8 +4,10 @@ KernelVersion: 3.19 
Description:

		The attributes:



		protocol	- HID protocol to use

		report_desc	- blob corresponding to HID report descriptors

		=============	============================================

		protocol	HID protocol to use

		report_desc	blob corresponding to HID report descriptors

				except the data passed through /dev/hidg<N>

		report_length	- HID report length

		subclass	- HID device subclass to use
 
		report_length	HID report length

		subclass	HID device subclass to use

		=============	============================================

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

+9 −7
Original line number Diff line number Diff line
@@ -4,14 +4,16 @@ KernelVersion: 3.11 
Description:

		The attributes:



		ifname		- network device interface name associated with

		=========	=============================================

		ifname		network device interface name associated with

				this function instance

		qmult		- queue length multiplier for high and

		qmult		queue length multiplier for high and

				super speed

		host_addr	- MAC address of host's end of this

		host_addr	MAC address of host's end of this

				Ethernet over USB link

		dev_addr	- MAC address of device's end of this

		dev_addr	MAC address of device's end of this

				Ethernet over USB link

		class		- USB interface class, default is 02 (hex)

		subclass	- USB interface subclass, default is 06 (hex)

		protocol	- USB interface protocol, default is 00 (hex)
 
		class		USB interface class, default is 02 (hex)

		subclass	USB interface subclass, default is 06 (hex)

		protocol	USB interface protocol, default is 00 (hex)

		=========	=============================================

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

+10 −8
Original line number Diff line number Diff line
@@ -4,11 +4,13 @@ KernelVersion: 4.14 
Description:

		The attributes:



		c_chmask - capture channel mask

		c_srate - capture sampling rate

		c_ssize - capture sample size (bytes)

		p_chmask - playback channel mask

		p_srate - playback sampling rate

		p_ssize - playback sample size (bytes)

		req_number - the number of pre-allocated request

		==========	===================================

		c_chmask	capture channel mask

		c_srate		capture sampling rate

		c_ssize		capture sample size (bytes)

		p_chmask	playback channel mask

		p_srate		playback sampling rate

		p_ssize		playback sample size (bytes)

		req_number	the number of pre-allocated request

				for both capture and playback

		==========	===================================

CRA Git | Maintained and supported by SUSTech CRA and CCSE