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