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