firmware: xilinx: Add sysfs to set shutdown scope

[linux-2.6-microblaze.git] / Documentation / ABI / stable / sysfs-driver-firmware-zynqmp

diff --git a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
index 2e3aebd..554f30c 100644 (file)
--- a/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
+++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
@@ -48,3 +48,35 @@ Description:
                # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
 
 Users:         Xilinx
+
+What:          /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+Date:          March 2020
+KernelVersion: 5.6
+Contact:       "Jolly Shah" <jollys@xilinx.com>
+Description:
+               This sysfs interface allows to set the shutdown scope for the
+               next shutdown request. When the next shutdown is performed, the
+               platform specific portion of PSCI-system_off can use the chosen
+               shutdown scope.
+
+               Following are available shutdown scopes(subtypes):
+
+               subsystem:      Only the APU along with all of its peripherals
+                               not used by other processing units will be
+                               shut down. This may result in the FPD power
+                               domain being shut down provided that no other
+                               processing unit uses FPD peripherals or DRAM.
+               ps_only:        The complete PS will be shut down, including the
+                               RPU, PMU, etc.  Only the PL domain (FPGA)
+                               remains untouched.
+               system:         The complete system/device is shut down.
+
+               Usage:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+               # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+
+               Example:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+               # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
+
+Users:         Xilinx