[PATCH RFC 6/6] staging: most: Documentation: move ABI description files out of staging area

Christian Gromm christian.gromm at microchip.com
Mon Nov 25 15:51:36 UTC 2019


This patch moves the ABI description fils sysfs-bus-most and
configfs-most to the kernel's documentation folder.

Signed-off-by: Christian Gromm <christian.gromm at microchip.com>
---
 Documentation/ABI/testing/configfs-most            | 196 ++++++++++++++
 Documentation/ABI/testing/sysfs-bus-most           | 295 +++++++++++++++++++++
 .../most/Documentation/ABI/configfs-most.txt       | 196 --------------
 .../most/Documentation/ABI/sysfs-bus-most.txt      | 295 ---------------------
 4 files changed, 491 insertions(+), 491 deletions(-)
 create mode 100644 Documentation/ABI/testing/configfs-most
 create mode 100644 Documentation/ABI/testing/sysfs-bus-most
 delete mode 100644 drivers/staging/most/Documentation/ABI/configfs-most.txt
 delete mode 100644 drivers/staging/most/Documentation/ABI/sysfs-bus-most.txt

diff --git a/Documentation/ABI/testing/configfs-most b/Documentation/ABI/testing/configfs-most
new file mode 100644
index 0000000..ed67a4d
--- /dev/null
+++ b/Documentation/ABI/testing/configfs-most
@@ -0,0 +1,196 @@
+What: 		/sys/kernel/config/most_<component>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description: 	Interface is used to configure and connect device channels
+		to component drivers.
+
+		Attributes are visible only when configfs is mounted. To mount
+		configfs in /sys/kernel/config directory use:
+		# mount -t configfs none /sys/kernel/config/
+
+
+What: 		/sys/kernel/config/most_cdev/<link>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description:
+		The attributes:
+
+		buffer_size	configure the buffer size for this channel
+
+		subbuffer_size	configure the sub-buffer size for this channel
+				(needed for synchronous and isochrnous data)
+
+
+		num_buffers	configure number of buffers used for this
+				channel
+
+		datatype	configure type of data that will travel over
+				this channel
+
+		direction	configure whether this link will be an input
+				or output
+
+		dbr_size	configure DBR data buffer size (this is used
+				for MediaLB communication only)
+
+		packets_per_xact
+				configure the number of packets that will be
+				collected from the network before being
+				transmitted via USB (this is used for USB
+				communication only)
+
+		device		name of the device the link is to be attached to
+
+		channel		name of the channel the link is to be attached to
+
+		comp_params	pass parameters needed by some components
+
+		create_link	write '1' to this attribute to trigger the
+				creation of the link. In case of speculative
+				configuration, the creation is post-poned until
+				a physical device is being attached to the bus.
+
+		destroy_link	write '1' to this attribute to destroy an
+				active link
+
+What: 		/sys/kernel/config/most_video/<link>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description:
+		The attributes:
+
+		buffer_size	configure the buffer size for this channel
+
+		subbuffer_size	configure the sub-buffer size for this channel
+				(needed for synchronous and isochrnous data)
+
+
+		num_buffers	configure number of buffers used for this
+				channel
+
+		datatype	configure type of data that will travel over
+				this channel
+
+		direction	configure whether this link will be an input
+				or output
+
+		dbr_size	configure DBR data buffer size (this is used
+				for MediaLB communication only)
+
+		packets_per_xact
+				configure the number of packets that will be
+				collected from the network before being
+				transmitted via USB (this is used for USB
+				communication only)
+
+		device		name of the device the link is to be attached to
+
+		channel		name of the channel the link is to be attached to
+
+		comp_params	pass parameters needed by some components
+
+		create_link	write '1' to this attribute to trigger the
+				creation of the link. In case of speculative
+				configuration, the creation is post-poned until
+				a physical device is being attached to the bus.
+
+		destroy_link	write '1' to this attribute to destroy an
+				active link
+
+What: 		/sys/kernel/config/most_net/<link>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description:
+		The attributes:
+
+		buffer_size	configure the buffer size for this channel
+
+		subbuffer_size	configure the sub-buffer size for this channel
+				(needed for synchronous and isochrnous data)
+
+
+		num_buffers	configure number of buffers used for this
+				channel
+
+		datatype	configure type of data that will travel over
+				this channel
+
+		direction	configure whether this link will be an input
+				or output
+
+		dbr_size	configure DBR data buffer size (this is used
+				for MediaLB communication only)
+
+		packets_per_xact
+				configure the number of packets that will be
+				collected from the network before being
+				transmitted via USB (this is used for USB
+				communication only)
+
+		device		name of the device the link is to be attached to
+
+		channel		name of the channel the link is to be attached to
+
+		comp_params	pass parameters needed by some components
+
+		create_link	write '1' to this attribute to trigger the
+				creation of the link. In case of speculative
+				configuration, the creation is post-poned until
+				a physical device is being attached to the bus.
+
+		destroy_link	write '1' to this attribute to destroy an
+				active link
+
+What: 		/sys/kernel/config/most_sound/<card>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description:
+		The attributes:
+
+		create_card	write '1' to this attribute to trigger the
+                                registration of the sound card with the ALSA
+				subsystem.
+
+What: 		/sys/kernel/config/most_sound/<card>/<link>
+Date: 		March 8, 2019
+KernelVersion:  5.2
+Description:
+		The attributes:
+
+		buffer_size	configure the buffer size for this channel
+
+		subbuffer_size	configure the sub-buffer size for this channel
+				(needed for synchronous and isochrnous data)
+
+
+		num_buffers	configure number of buffers used for this
+				channel
+
+		datatype	configure type of data that will travel over
+				this channel
+
+		direction	configure whether this link will be an input
+				or output
+
+		dbr_size	configure DBR data buffer size (this is used
+				for MediaLB communication only)
+
+		packets_per_xact
+				configure the number of packets that will be
+				collected from the network before being
+				transmitted via USB (this is used for USB
+				communication only)
+
+		device		name of the device the link is to be attached to
+
+		channel		name of the channel the link is to be attached to
+
+		comp_params	pass parameters needed by some components
+
+		create_link	write '1' to this attribute to trigger the
+				creation of the link. In case of speculative
+				configuration, the creation is post-poned until
+				a physical device is being attached to the bus.
+
+		destroy_link	write '1' to this attribute to destroy an
+				active link
diff --git a/Documentation/ABI/testing/sysfs-bus-most b/Documentation/ABI/testing/sysfs-bus-most
new file mode 100644
index 0000000..6b1d06e
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-most
@@ -0,0 +1,295 @@
+What:		/sys/bus/most/devices/.../description
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Provides information about the interface type and the physical
+		location of the device. Hardware attached via USB, for instance,
+		might return <1-1.1:1.0>
+Users:
+
+What:		/sys/bus/most/devices/.../interface
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the type of peripheral interface the device uses.
+Users:
+
+What:		/sys/bus/most/devices/.../dci
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		If the network interface controller is attached via USB, a dci
+		directory is created that allows applications to read and
+		write the controller's DCI registers.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/arb_address
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to set an arbitrary DCI register address an
+		application wants to read from or write to.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/arb_value
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to read and write the DCI register whose address
+		is stored in arb_address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_eui48_hi
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MAC address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_eui48_lo
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MAC address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_eui48_mi
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MAC address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_filter
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MEP filter address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_hash0
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MEP hash table.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_hash1
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MEP hash table.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_hash2
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MEP hash table.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/mep_hash3
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to check and configure the MEP hash table.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/ni_state
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the current network interface state.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/node_address
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the current node address.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/node_position
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the current node position.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/packet_bandwidth
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the configured packet bandwidth.
+Users:
+
+What:		/sys/bus/most/devices/.../dci/sync_ep
+Date:		June 2016
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Triggers the controller's synchronization process for a certain
+		endpoint.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		For every channel of the device a directory is created, whose
+		name is dictated by the HDM. This enables an application to
+		collect information about the channel's capabilities and
+		configure it.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/available_datatypes
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the data types the current channel can transport.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/available_directions
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the directions the current channel is capable of.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/number_of_packet_buffers
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the number of packet buffers the current channel can
+		handle.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/number_of_stream_buffers
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the number of streaming buffers the current channel can
+		handle.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/size_of_packet_buffer
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the size of a packet buffer the current channel can
+		handle.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/size_of_stream_buffer
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates the size of a streaming buffer the current channel can
+		handle.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_number_of_buffers
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the number of buffers of the current channel.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_buffer_size
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the size of a buffer of the current channel.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_direction
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the direction of the current channel.
+		The following strings will be accepted:
+			'dir_tx',
+			'dir_rx'
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_datatype
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the data type of the current channel.
+		The following strings will be accepted:
+			'control',
+			'async',
+			'sync',
+			'isoc_avp'
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_subbuffer_size
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the subbuffer size of the current channel.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/set_packets_per_xact
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is to configure the number of packets per transaction of
+		the current channel. This is only needed network interface
+		controller is attached via USB.
+Users:
+
+What:		/sys/bus/most/devices/.../<channel>/channel_starving
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		Indicates whether current channel ran out of buffers.
+Users:
+
+What:		/sys/bus/most/drivers/most_core/components
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to retrieve a list of registered components.
+Users:
+
+What:		/sys/bus/most/drivers/most_core/links
+Date:		March 2017
+KernelVersion:	4.15
+Contact:	Christian Gromm <christian.gromm at microchip.com>
+Description:
+		This is used to retrieve a list of established links.
+Users:
diff --git a/drivers/staging/most/Documentation/ABI/configfs-most.txt b/drivers/staging/most/Documentation/ABI/configfs-most.txt
deleted file mode 100644
index ed67a4d..0000000
--- a/drivers/staging/most/Documentation/ABI/configfs-most.txt
+++ /dev/null
@@ -1,196 +0,0 @@
-What: 		/sys/kernel/config/most_<component>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description: 	Interface is used to configure and connect device channels
-		to component drivers.
-
-		Attributes are visible only when configfs is mounted. To mount
-		configfs in /sys/kernel/config directory use:
-		# mount -t configfs none /sys/kernel/config/
-
-
-What: 		/sys/kernel/config/most_cdev/<link>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description:
-		The attributes:
-
-		buffer_size	configure the buffer size for this channel
-
-		subbuffer_size	configure the sub-buffer size for this channel
-				(needed for synchronous and isochrnous data)
-
-
-		num_buffers	configure number of buffers used for this
-				channel
-
-		datatype	configure type of data that will travel over
-				this channel
-
-		direction	configure whether this link will be an input
-				or output
-
-		dbr_size	configure DBR data buffer size (this is used
-				for MediaLB communication only)
-
-		packets_per_xact
-				configure the number of packets that will be
-				collected from the network before being
-				transmitted via USB (this is used for USB
-				communication only)
-
-		device		name of the device the link is to be attached to
-
-		channel		name of the channel the link is to be attached to
-
-		comp_params	pass parameters needed by some components
-
-		create_link	write '1' to this attribute to trigger the
-				creation of the link. In case of speculative
-				configuration, the creation is post-poned until
-				a physical device is being attached to the bus.
-
-		destroy_link	write '1' to this attribute to destroy an
-				active link
-
-What: 		/sys/kernel/config/most_video/<link>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description:
-		The attributes:
-
-		buffer_size	configure the buffer size for this channel
-
-		subbuffer_size	configure the sub-buffer size for this channel
-				(needed for synchronous and isochrnous data)
-
-
-		num_buffers	configure number of buffers used for this
-				channel
-
-		datatype	configure type of data that will travel over
-				this channel
-
-		direction	configure whether this link will be an input
-				or output
-
-		dbr_size	configure DBR data buffer size (this is used
-				for MediaLB communication only)
-
-		packets_per_xact
-				configure the number of packets that will be
-				collected from the network before being
-				transmitted via USB (this is used for USB
-				communication only)
-
-		device		name of the device the link is to be attached to
-
-		channel		name of the channel the link is to be attached to
-
-		comp_params	pass parameters needed by some components
-
-		create_link	write '1' to this attribute to trigger the
-				creation of the link. In case of speculative
-				configuration, the creation is post-poned until
-				a physical device is being attached to the bus.
-
-		destroy_link	write '1' to this attribute to destroy an
-				active link
-
-What: 		/sys/kernel/config/most_net/<link>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description:
-		The attributes:
-
-		buffer_size	configure the buffer size for this channel
-
-		subbuffer_size	configure the sub-buffer size for this channel
-				(needed for synchronous and isochrnous data)
-
-
-		num_buffers	configure number of buffers used for this
-				channel
-
-		datatype	configure type of data that will travel over
-				this channel
-
-		direction	configure whether this link will be an input
-				or output
-
-		dbr_size	configure DBR data buffer size (this is used
-				for MediaLB communication only)
-
-		packets_per_xact
-				configure the number of packets that will be
-				collected from the network before being
-				transmitted via USB (this is used for USB
-				communication only)
-
-		device		name of the device the link is to be attached to
-
-		channel		name of the channel the link is to be attached to
-
-		comp_params	pass parameters needed by some components
-
-		create_link	write '1' to this attribute to trigger the
-				creation of the link. In case of speculative
-				configuration, the creation is post-poned until
-				a physical device is being attached to the bus.
-
-		destroy_link	write '1' to this attribute to destroy an
-				active link
-
-What: 		/sys/kernel/config/most_sound/<card>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description:
-		The attributes:
-
-		create_card	write '1' to this attribute to trigger the
-                                registration of the sound card with the ALSA
-				subsystem.
-
-What: 		/sys/kernel/config/most_sound/<card>/<link>
-Date: 		March 8, 2019
-KernelVersion:  5.2
-Description:
-		The attributes:
-
-		buffer_size	configure the buffer size for this channel
-
-		subbuffer_size	configure the sub-buffer size for this channel
-				(needed for synchronous and isochrnous data)
-
-
-		num_buffers	configure number of buffers used for this
-				channel
-
-		datatype	configure type of data that will travel over
-				this channel
-
-		direction	configure whether this link will be an input
-				or output
-
-		dbr_size	configure DBR data buffer size (this is used
-				for MediaLB communication only)
-
-		packets_per_xact
-				configure the number of packets that will be
-				collected from the network before being
-				transmitted via USB (this is used for USB
-				communication only)
-
-		device		name of the device the link is to be attached to
-
-		channel		name of the channel the link is to be attached to
-
-		comp_params	pass parameters needed by some components
-
-		create_link	write '1' to this attribute to trigger the
-				creation of the link. In case of speculative
-				configuration, the creation is post-poned until
-				a physical device is being attached to the bus.
-
-		destroy_link	write '1' to this attribute to destroy an
-				active link
diff --git a/drivers/staging/most/Documentation/ABI/sysfs-bus-most.txt b/drivers/staging/most/Documentation/ABI/sysfs-bus-most.txt
deleted file mode 100644
index 6b1d06e..0000000
--- a/drivers/staging/most/Documentation/ABI/sysfs-bus-most.txt
+++ /dev/null
@@ -1,295 +0,0 @@
-What:		/sys/bus/most/devices/.../description
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Provides information about the interface type and the physical
-		location of the device. Hardware attached via USB, for instance,
-		might return <1-1.1:1.0>
-Users:
-
-What:		/sys/bus/most/devices/.../interface
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the type of peripheral interface the device uses.
-Users:
-
-What:		/sys/bus/most/devices/.../dci
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		If the network interface controller is attached via USB, a dci
-		directory is created that allows applications to read and
-		write the controller's DCI registers.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/arb_address
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to set an arbitrary DCI register address an
-		application wants to read from or write to.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/arb_value
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to read and write the DCI register whose address
-		is stored in arb_address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_eui48_hi
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MAC address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_eui48_lo
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MAC address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_eui48_mi
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MAC address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_filter
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MEP filter address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_hash0
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MEP hash table.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_hash1
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MEP hash table.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_hash2
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MEP hash table.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/mep_hash3
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to check and configure the MEP hash table.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/ni_state
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the current network interface state.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/node_address
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the current node address.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/node_position
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the current node position.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/packet_bandwidth
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the configured packet bandwidth.
-Users:
-
-What:		/sys/bus/most/devices/.../dci/sync_ep
-Date:		June 2016
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Triggers the controller's synchronization process for a certain
-		endpoint.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		For every channel of the device a directory is created, whose
-		name is dictated by the HDM. This enables an application to
-		collect information about the channel's capabilities and
-		configure it.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/available_datatypes
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the data types the current channel can transport.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/available_directions
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the directions the current channel is capable of.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/number_of_packet_buffers
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the number of packet buffers the current channel can
-		handle.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/number_of_stream_buffers
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the number of streaming buffers the current channel can
-		handle.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/size_of_packet_buffer
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the size of a packet buffer the current channel can
-		handle.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/size_of_stream_buffer
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates the size of a streaming buffer the current channel can
-		handle.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_number_of_buffers
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the number of buffers of the current channel.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_buffer_size
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the size of a buffer of the current channel.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_direction
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the direction of the current channel.
-		The following strings will be accepted:
-			'dir_tx',
-			'dir_rx'
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_datatype
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the data type of the current channel.
-		The following strings will be accepted:
-			'control',
-			'async',
-			'sync',
-			'isoc_avp'
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_subbuffer_size
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the subbuffer size of the current channel.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/set_packets_per_xact
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is to configure the number of packets per transaction of
-		the current channel. This is only needed network interface
-		controller is attached via USB.
-Users:
-
-What:		/sys/bus/most/devices/.../<channel>/channel_starving
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		Indicates whether current channel ran out of buffers.
-Users:
-
-What:		/sys/bus/most/drivers/most_core/components
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to retrieve a list of registered components.
-Users:
-
-What:		/sys/bus/most/drivers/most_core/links
-Date:		March 2017
-KernelVersion:	4.15
-Contact:	Christian Gromm <christian.gromm at microchip.com>
-Description:
-		This is used to retrieve a list of established links.
-Users:
-- 
2.7.4



More information about the devel mailing list