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