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