Commit b50220c1 authored by Christian Gromm's avatar Christian Gromm Committed by Greg Kroah-Hartman
Browse files

Documentation: ABI: correct sysfs attribute description of MOST driver


This patch fixes the ABI description file sysfs-bus-most.
Signed-off-by: default avatarChristian Gromm <christian.gromm@microchip.com>
Link: https://lore.kernel.org/r/1589534465-7423-8-git-send-email-christian.gromm@microchip.com

Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent dfeb9380
What: /sys/bus/most/devices/.../description What: /sys/bus/most/devices/<dev>/description
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Provides information about the interface type and the physical Provides information about the physical location of the
location of the device. Hardware attached via USB, for instance, device. Hardware attached via USB, for instance,
might return <1-1.1:1.0> might return <1-1.1:1.0>
Users: Users:
What: /sys/bus/most/devices/.../interface What: /sys/bus/most/devices/<dev>/interface
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -16,7 +16,7 @@ Description: ...@@ -16,7 +16,7 @@ Description:
Indicates the type of peripheral interface the device uses. Indicates the type of peripheral interface the device uses.
Users: Users:
What: /sys/bus/most/devices/.../dci What: /sys/bus/most/devices/<dev>/dci
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -26,7 +26,7 @@ Description: ...@@ -26,7 +26,7 @@ Description:
write the controller's DCI registers. write the controller's DCI registers.
Users: Users:
What: /sys/bus/most/devices/.../dci/arb_address What: /sys/bus/most/devices/<dev>/dci/arb_address
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -35,7 +35,7 @@ Description: ...@@ -35,7 +35,7 @@ Description:
application wants to read from or write to. application wants to read from or write to.
Users: Users:
What: /sys/bus/most/devices/.../dci/arb_value What: /sys/bus/most/devices/<dev>/dci/arb_value
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -44,7 +44,7 @@ Description: ...@@ -44,7 +44,7 @@ Description:
is stored in arb_address. is stored in arb_address.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_eui48_hi What: /sys/bus/most/devices/<dev>/dci/mep_eui48_hi
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -52,7 +52,7 @@ Description: ...@@ -52,7 +52,7 @@ Description:
This is used to check and configure the MAC address. This is used to check and configure the MAC address.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_eui48_lo What: /sys/bus/most/devices/<dev>/dci/mep_eui48_lo
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -60,7 +60,7 @@ Description: ...@@ -60,7 +60,7 @@ Description:
This is used to check and configure the MAC address. This is used to check and configure the MAC address.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_eui48_mi What: /sys/bus/most/devices/<dev>/dci/mep_eui48_mi
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -68,7 +68,7 @@ Description: ...@@ -68,7 +68,7 @@ Description:
This is used to check and configure the MAC address. This is used to check and configure the MAC address.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_filter What: /sys/bus/most/devices/<dev>/dci/mep_filter
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -76,7 +76,7 @@ Description: ...@@ -76,7 +76,7 @@ Description:
This is used to check and configure the MEP filter address. This is used to check and configure the MEP filter address.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_hash0 What: /sys/bus/most/devices/<dev>/dci/mep_hash0
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -84,7 +84,7 @@ Description: ...@@ -84,7 +84,7 @@ Description:
This is used to check and configure the MEP hash table. This is used to check and configure the MEP hash table.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_hash1 What: /sys/bus/most/devices/<dev>/dci/mep_hash1
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -92,7 +92,7 @@ Description: ...@@ -92,7 +92,7 @@ Description:
This is used to check and configure the MEP hash table. This is used to check and configure the MEP hash table.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_hash2 What: /sys/bus/most/devices/<dev>/dci/mep_hash2
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -100,7 +100,7 @@ Description: ...@@ -100,7 +100,7 @@ Description:
This is used to check and configure the MEP hash table. This is used to check and configure the MEP hash table.
Users: Users:
What: /sys/bus/most/devices/.../dci/mep_hash3 What: /sys/bus/most/devices/<dev>/dci/mep_hash3
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -108,7 +108,7 @@ Description: ...@@ -108,7 +108,7 @@ Description:
This is used to check and configure the MEP hash table. This is used to check and configure the MEP hash table.
Users: Users:
What: /sys/bus/most/devices/.../dci/ni_state What: /sys/bus/most/devices/<dev>/dci/ni_state
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -116,7 +116,7 @@ Description: ...@@ -116,7 +116,7 @@ Description:
Indicates the current network interface state. Indicates the current network interface state.
Users: Users:
What: /sys/bus/most/devices/.../dci/node_address What: /sys/bus/most/devices/<dev>/dci/node_address
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -124,7 +124,7 @@ Description: ...@@ -124,7 +124,7 @@ Description:
Indicates the current node address. Indicates the current node address.
Users: Users:
What: /sys/bus/most/devices/.../dci/node_position What: /sys/bus/most/devices/<dev>/dci/node_position
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -132,7 +132,7 @@ Description: ...@@ -132,7 +132,7 @@ Description:
Indicates the current node position. Indicates the current node position.
Users: Users:
What: /sys/bus/most/devices/.../dci/packet_bandwidth What: /sys/bus/most/devices/<dev>/dci/packet_bandwidth
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -140,7 +140,7 @@ Description: ...@@ -140,7 +140,7 @@ Description:
Indicates the configured packet bandwidth. Indicates the configured packet bandwidth.
Users: Users:
What: /sys/bus/most/devices/.../dci/sync_ep What: /sys/bus/most/devices/<dev>/dci/sync_ep
Date: June 2016 Date: June 2016
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -149,7 +149,7 @@ Description: ...@@ -149,7 +149,7 @@ Description:
endpoint. endpoint.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/ What: /sys/bus/most/devices/<dev>/<channel>/
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
...@@ -160,91 +160,92 @@ Description: ...@@ -160,91 +160,92 @@ Description:
configure it. configure it.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/available_datatypes What: /sys/bus/most/devices/<dev>/<channel>/available_datatypes
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the data types the current channel can transport. Indicates the data types the channel can transport.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/available_directions What: /sys/bus/most/devices/<dev>/<channel>/available_directions
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the directions the current channel is capable of. Indicates the directions the channel is capable of.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/number_of_packet_buffers What: /sys/bus/most/devices/<dev>/<channel>/number_of_packet_buffers
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the number of packet buffers the current channel can Indicates the number of packet buffers the channel can
handle. handle.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/number_of_stream_buffers What: /sys/bus/most/devices/<dev>/<channel>/number_of_stream_buffers
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the number of streaming buffers the current channel can Indicates the number of streaming buffers the channel can
handle. handle.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/size_of_packet_buffer What: /sys/bus/most/devices/<dev>/<channel>/size_of_packet_buffer
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the size of a packet buffer the current channel can Indicates the size of a packet buffer the channel can
handle. handle.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/size_of_stream_buffer What: /sys/bus/most/devices/<dev>/<channel>/size_of_stream_buffer
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates the size of a streaming buffer the current channel can Indicates the size of a streaming buffer the channel can
handle. handle.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_number_of_buffers What: /sys/bus/most/devices/<dev>/<channel>/set_number_of_buffers
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the number of buffers of the current channel. This is to read back the configured number of buffers of
the channel.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_buffer_size What: /sys/bus/most/devices/<dev>/<channel>/set_buffer_size
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the size of a buffer of the current channel. This is to read back the configured buffer size of the channel.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_direction What: /sys/bus/most/devices/<dev>/<channel>/set_direction
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the direction of the current channel. This is to read back the configured direction of the channel.
The following strings will be accepted: The following strings will be accepted:
'dir_tx', 'tx',
'dir_rx' 'rx'
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_datatype What: /sys/bus/most/devices/<dev>/<channel>/set_datatype
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the data type of the current channel. This is to read back the configured data type of the channel.
The following strings will be accepted: The following strings will be accepted:
'control', 'control',
'async', 'async',
...@@ -252,30 +253,31 @@ Description: ...@@ -252,30 +253,31 @@ Description:
'isoc_avp' 'isoc_avp'
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_subbuffer_size What: /sys/bus/most/devices/<dev>/<channel>/set_subbuffer_size
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the subbuffer size of the current channel. This is to read back the configured subbuffer size of
the channel.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/set_packets_per_xact What: /sys/bus/most/devices/<dev>/<channel>/set_packets_per_xact
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
This is to configure the number of packets per transaction of This is to read back the configured number of packets per
the current channel. This is only needed network interface transaction of the channel. This is only applicable when
controller is attached via USB. connected via USB.
Users: Users:
What: /sys/bus/most/devices/.../<channel>/channel_starving What: /sys/bus/most/devices/<dev>/<channel>/channel_starving
Date: March 2017 Date: March 2017
KernelVersion: 4.15 KernelVersion: 4.15
Contact: Christian Gromm <christian.gromm@microchip.com> Contact: Christian Gromm <christian.gromm@microchip.com>
Description: Description:
Indicates whether current channel ran out of buffers. Indicates whether channel ran out of buffers.
Users: Users:
What: /sys/bus/most/drivers/most_core/components What: /sys/bus/most/drivers/most_core/components
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment