firmware: xilinx: Add sysfs interface

[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
new file mode 100644 (file)
index 0000000..2e3aebd
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-driver-firmware-zynqmp
@@ -0,0 +1,50 @@
+What:          /sys/devices/platform/firmware\:zynqmp-firmware/ggs*
+Date:          March 2020
+KernelVersion: 5.6
+Contact:       "Jolly Shah" <jollys@xilinx.com>
+Description:
+               Read/Write PMU global general storage register value,
+               GLOBAL_GEN_STORAGE{0:3}.
+               Global general storage register that can be used
+               by system to pass information between masters.
+
+               The register is reset during system or power-on
+               resets. Three registers are used by the FSBL and
+               other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
+
+               Usage:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+               # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+
+               Example:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+               # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
+
+Users:         Xilinx
+
+What:          /sys/devices/platform/firmware\:zynqmp-firmware/pggs*
+Date:          March 2020
+KernelVersion: 5.6
+Contact:       "Jolly Shah" <jollys@xilinx.com>
+Description:
+               Read/Write PMU persistent global general storage register
+               value, PERS_GLOB_GEN_STORAGE{0:3}.
+               Persistent global general storage register that
+               can be used by system to pass information between
+               masters.
+
+               This register is only reset by the power-on reset
+               and maintains its value through a system reset.
+               Four registers are used by the FSBL and other Xilinx
+               software products: PERS_GLOB_GEN_STORAGE{4:7}.
+               Register is reset only by a POR reset.
+
+               Usage:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+               # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+
+               Example:
+               # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+               # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
+
+Users:         Xilinx