xref: /linux/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp (revision 95298d63c67673c654c08952672d016212b26054)
1What:		/sys/devices/platform/firmware\:zynqmp-firmware/ggs*
2Date:		March 2020
3KernelVersion:	5.6
4Contact:	"Jolly Shah" <jollys@xilinx.com>
5Description:
6		Read/Write PMU global general storage register value,
7		GLOBAL_GEN_STORAGE{0:3}.
8		Global general storage register that can be used
9		by system to pass information between masters.
10
11		The register is reset during system or power-on
12		resets. Three registers are used by the FSBL and
13		other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
14
15		Usage:
16		# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
17		# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
18
19		Example:
20		# cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
21		# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
22
23Users:		Xilinx
24
25What:		/sys/devices/platform/firmware\:zynqmp-firmware/pggs*
26Date:		March 2020
27KernelVersion:	5.6
28Contact:	"Jolly Shah" <jollys@xilinx.com>
29Description:
30		Read/Write PMU persistent global general storage register
31		value, PERS_GLOB_GEN_STORAGE{0:3}.
32		Persistent global general storage register that
33		can be used by system to pass information between
34		masters.
35
36		This register is only reset by the power-on reset
37		and maintains its value through a system reset.
38		Four registers are used by the FSBL and other Xilinx
39		software products: PERS_GLOB_GEN_STORAGE{4:7}.
40		Register is reset only by a POR reset.
41
42		Usage:
43		# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
44		# echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
45
46		Example:
47		# cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
48		# echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
49
50Users:		Xilinx
51
52What:		/sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
53Date:		March 2020
54KernelVersion:	5.6
55Contact:	"Jolly Shah" <jollys@xilinx.com>
56Description:
57		This sysfs interface allows to set the shutdown scope for the
58		next shutdown request. When the next shutdown is performed, the
59		platform specific portion of PSCI-system_off can use the chosen
60		shutdown scope.
61
62		Following are available shutdown scopes(subtypes):
63
64		subsystem:	Only the APU along with all of its peripherals
65				not used by other processing units will be
66				shut down. This may result in the FPD power
67				domain being shut down provided that no other
68				processing unit uses FPD peripherals or DRAM.
69		ps_only:	The complete PS will be shut down, including the
70				RPU, PMU, etc.  Only the PL domain (FPGA)
71				remains untouched.
72		system:		The complete system/device is shut down.
73
74		Usage:
75		# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
76		# echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
77
78		Example:
79		# cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
80		# echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
81
82Users:		Xilinx
83
84What:		/sys/devices/platform/firmware\:zynqmp-firmware/health_status
85Date:		March 2020
86KernelVersion:	5.6
87Contact:	"Jolly Shah" <jollys@xilinx.com>
88Description:
89		This sysfs interface allows to set the health status. If PMUFW
90		is compiled with CHECK_HEALTHY_BOOT, it will check the healthy
91		bit on FPD WDT expiration. If healthy bit is set by a user
92		application running in Linux, PMUFW will do APU only restart. If
93		healthy bit is not set during FPD WDT expiration, PMUFW will do
94		system restart.
95
96		Usage:
97		Set healthy bit
98		# echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
99
100		Unset healthy bit
101		# echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
102
103Users:		Xilinx
104