xref: /linux/Documentation/ABI/testing/sysfs-bus-siox (revision 56fb34d86e875dbb0d3e6a81c5d3d035db373031)
1What:		/sys/bus/siox/devices/siox-X/active
2KernelVersion:	4.16
3Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
4Description:
5		On reading represents the current state of the bus. If it
6		contains a "0" the bus is stopped and connected devices are
7		expected to not do anything because their watchdog triggered.
8		When the file contains a "1" the bus is operated and periodically
9		does a push-pull cycle to write and read data from the
10		connected devices.
11		When writing a "0" or "1" the bus moves to the described state.
12
13What:		/sys/bus/siox/devices/siox-X/device_add
14KernelVersion:	4.16
15Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
16Description:
17		Write-only file. Write
18
19			<type> <inbytes> <outbytes> <statustype>
20
21		to add a new device dynamically. <type> is the name that is used to match
22		to a driver (similar to the platform bus). <inbytes> and <outbytes> define
23		the length of the input and output shift register in bytes respectively.
24		<statustype> defines the 4 bit device type that is check to identify connection
25		problems.
26		The new device is added to the end of the existing chain.
27
28What:		/sys/bus/siox/devices/siox-X/device_remove
29KernelVersion:	4.16
30Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
31Description:
32		Write-only file. A single write removes the last device in the siox chain.
33
34What:		/sys/bus/siox/devices/siox-X/poll_interval_ns
35KernelVersion:	4.16
36Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
37Description:
38		Defines the interval between two poll cycles in nano seconds.
39		Note this is rounded to jiffies on writing. On reading the current value
40		is returned.
41
42What:		/sys/bus/siox/devices/siox-X-Y/connected
43KernelVersion:	4.16
44Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
45Description:
46		Read-only value. "0" means the Yth device on siox bus X isn't "connected" i.e.
47		communication with it is not ensured. "1" signals a working connection.
48
49What:		/sys/bus/siox/devices/siox-X-Y/inbytes
50KernelVersion:	4.16
51Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
52Description:
53		Read-only value reporting the inbytes value provided to siox-X/device_add
54
55What:		/sys/bus/siox/devices/siox-X-Y/status_errors
56KernelVersion:	4.16
57Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
58Description:
59		Counts the number of time intervals when the read status byte doesn't yield the
60		expected value.
61
62What:		/sys/bus/siox/devices/siox-X-Y/type
63KernelVersion:	4.16
64Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
65Description:
66		Read-only value reporting the type value provided to siox-X/device_add.
67
68What:		/sys/bus/siox/devices/siox-X-Y/watchdog
69KernelVersion:	4.16
70Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
71Description:
72		Read-only value reporting if the watchdog of the siox device is
73		active. "0" means the watchdog is not active and the device is expected to
74		be operational. "1" means the watchdog keeps the device in reset.
75
76What:		/sys/bus/siox/devices/siox-X-Y/watchdog_errors
77KernelVersion:	4.16
78Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
79Description:
80		Read-only value reporting the number to time intervals when the
81		watchdog was active.
82
83What:		/sys/bus/siox/devices/siox-X-Y/outbytes
84KernelVersion:	4.16
85Contact:	Thorsten Scherer <t.scherer@eckelmann.de>, Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
86Description:
87		Read-only value reporting the outbytes value provided to siox-X/device_add.
88