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