1 What: /sys/devices/platform/firmware 1 What: /sys/devices/platform/firmware\:zynqmp-firmware/ggs*
2 Date: March 2020 2 Date: March 2020
3 KernelVersion: 5.6 3 KernelVersion: 5.6
4 Contact: "Jolly Shah" <jollys@xilinx.com 4 Contact: "Jolly Shah" <jollys@xilinx.com>
5 Description: 5 Description:
6 Read/Write PMU global general 6 Read/Write PMU global general storage register value,
7 GLOBAL_GEN_STORAGE{0:3}. 7 GLOBAL_GEN_STORAGE{0:3}.
8 Global general storage registe 8 Global general storage register that can be used
9 by system to pass information 9 by system to pass information between masters.
10 10
11 The register is reset during s 11 The register is reset during system or power-on
12 resets. Three registers are us 12 resets. Three registers are used by the FSBL and
13 other Xilinx software products 13 other Xilinx software products: GLOBAL_GEN_STORAGE{4:6}.
14 14
15 Usage:: 15 Usage::
16 16
17 # cat /sys/devices/platfor 17 # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
18 # echo <value> > /sys/devi 18 # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
19 19
20 Example:: 20 Example::
21 21
22 # cat /sys/devices/platfor 22 # cat /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
23 # echo 0x1234ABCD > /sys/d 23 # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/ggs0
24 24
25 Users: Xilinx 25 Users: Xilinx
26 26
27 What: /sys/devices/platform/firmware 27 What: /sys/devices/platform/firmware\:zynqmp-firmware/pggs*
28 Date: March 2020 28 Date: March 2020
29 KernelVersion: 5.6 29 KernelVersion: 5.6
30 Contact: "Jolly Shah" <jollys@xilinx.com 30 Contact: "Jolly Shah" <jollys@xilinx.com>
31 Description: 31 Description:
32 Read/Write PMU persistent glob 32 Read/Write PMU persistent global general storage register
33 value, PERS_GLOB_GEN_STORAGE{0 33 value, PERS_GLOB_GEN_STORAGE{0:3}.
34 Persistent global general stor 34 Persistent global general storage register that
35 can be used by system to pass 35 can be used by system to pass information between
36 masters. 36 masters.
37 37
38 This register is only reset by 38 This register is only reset by the power-on reset
39 and maintains its value throug 39 and maintains its value through a system reset.
40 Four registers are used by the 40 Four registers are used by the FSBL and other Xilinx
41 software products: PERS_GLOB_G 41 software products: PERS_GLOB_GEN_STORAGE{4:7}.
42 Register is reset only by a PO 42 Register is reset only by a POR reset.
43 43
44 Usage:: 44 Usage::
45 45
46 # cat /sys/devices/platfor 46 # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
47 # echo <value> > /sys/devi 47 # echo <value> > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
48 48
49 Example:: 49 Example::
50 50
51 # cat /sys/devices/platfor 51 # cat /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
52 # echo 0x1234ABCD > /sys/d 52 # echo 0x1234ABCD > /sys/devices/platform/firmware\:zynqmp-firmware/pggs0
53 53
54 Users: Xilinx 54 Users: Xilinx
55 55
56 What: /sys/devices/platform/firmware 56 What: /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
57 Date: March 2020 57 Date: March 2020
58 KernelVersion: 5.6 58 KernelVersion: 5.6
59 Contact: "Jolly Shah" <jollys@xilinx.com 59 Contact: "Jolly Shah" <jollys@xilinx.com>
60 Description: 60 Description:
61 This sysfs interface allows to 61 This sysfs interface allows to set the shutdown scope for the
62 next shutdown request. When th 62 next shutdown request. When the next shutdown is performed, the
63 platform specific portion of P 63 platform specific portion of PSCI-system_off can use the chosen
64 shutdown scope. 64 shutdown scope.
65 65
66 Following are available shutdo 66 Following are available shutdown scopes(subtypes):
67 67
68 subsystem: 68 subsystem:
69 Only the APU a 69 Only the APU along with all of its peripherals
70 not used by ot 70 not used by other processing units will be
71 shut down. Thi 71 shut down. This may result in the FPD power
72 domain being s 72 domain being shut down provided that no other
73 processing uni 73 processing unit uses FPD peripherals or DRAM.
74 ps_only: 74 ps_only:
75 The complete P 75 The complete PS will be shut down, including the
76 RPU, PMU, etc. 76 RPU, PMU, etc. Only the PL domain (FPGA)
77 remains untouc 77 remains untouched.
78 system: 78 system:
79 The complete s 79 The complete system/device is shut down.
80 80
81 Usage:: 81 Usage::
82 82
83 # cat /sys/devices/platfor 83 # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
84 # echo <scope> > /sys/devi 84 # echo <scope> > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
85 85
86 Example:: 86 Example::
87 87
88 # cat /sys/devices/platfor 88 # cat /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
89 # echo "subsystem" > /sys/ 89 # echo "subsystem" > /sys/devices/platform/firmware\:zynqmp-firmware/shutdown_scope
90 90
91 Users: Xilinx 91 Users: Xilinx
92 92
93 What: /sys/devices/platform/firmware 93 What: /sys/devices/platform/firmware\:zynqmp-firmware/health_status
94 Date: March 2020 94 Date: March 2020
95 KernelVersion: 5.6 95 KernelVersion: 5.6
96 Contact: "Jolly Shah" <jollys@xilinx.com 96 Contact: "Jolly Shah" <jollys@xilinx.com>
97 Description: 97 Description:
98 This sysfs interface allows to 98 This sysfs interface allows to set the health status. If PMUFW
99 is compiled with CHECK_HEALTHY 99 is compiled with CHECK_HEALTHY_BOOT, it will check the healthy
100 bit on FPD WDT expiration. If 100 bit on FPD WDT expiration. If healthy bit is set by a user
101 application running in Linux, 101 application running in Linux, PMUFW will do APU only restart. If
102 healthy bit is not set during 102 healthy bit is not set during FPD WDT expiration, PMUFW will do
103 system restart. 103 system restart.
104 104
105 Usage: 105 Usage:
106 106
107 Set healthy bit:: 107 Set healthy bit::
108 108
109 # echo 1 > /sys/devices/pl 109 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
110 110
111 Unset healthy bit:: 111 Unset healthy bit::
112 112
113 # echo 0 > /sys/devices/pl 113 # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/health_status
114 114
115 Users: Xilinx 115 Users: Xilinx
116 116
117 What: /sys/devices/platform/firmware 117 What: /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
118 Date: Feb 2022 118 Date: Feb 2022
119 KernelVersion: 5.18 119 KernelVersion: 5.18
120 Contact: "Ronak Jain" <ronak.jain@xilinx 120 Contact: "Ronak Jain" <ronak.jain@xilinx.com>
121 Description: 121 Description:
122 This sysfs interface allows us 122 This sysfs interface allows user to configure features at
123 runtime. The user can enable o 123 runtime. The user can enable or disable features running at
124 firmware as well as the user c 124 firmware as well as the user can configure the parameters of
125 the features at runtime. The s 125 the features at runtime. The supported features are over
126 temperature and external watch 126 temperature and external watchdog. Here, the external watchdog
127 is completely different than t 127 is completely different than the /dev/watchdog as the external
128 watchdog is running on the fir 128 watchdog is running on the firmware and it is used to monitor
129 the health of firmware not APU 129 the health of firmware not APU(Linux). Also, the external
130 watchdog is interfaced outside 130 watchdog is interfaced outside of the zynqmp soc.
131 131
132 The supported config ids are f 132 The supported config ids are for the feature configuration is,
133 1. PM_FEATURE_OVERTEMP_STATUS 133 1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
134 disable the over temperature f 134 disable the over temperature feature.
135 2. PM_FEATURE_OVERTEMP_VALUE = 135 2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
136 over temperature limit in Degr 136 over temperature limit in Degree Celsius.
137 3. PM_FEATURE_EXTWDT_STATUS = 137 3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
138 the external watchdog feature. 138 the external watchdog feature.
139 4. PM_FEATURE_EXTWDT_VALUE = 4 139 4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
140 external watchdog feature. 140 external watchdog feature.
141 141
142 Usage: 142 Usage:
143 143
144 Select over temperature config 144 Select over temperature config ID to enable/disable feature
145 # echo 1 > /sys/devices/platfo 145 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
146 146
147 Check over temperature config 147 Check over temperature config ID is selected or not
148 # cat /sys/devices/platform/fi 148 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
149 The expected result is 1. 149 The expected result is 1.
150 150
151 Select over temperature config 151 Select over temperature config ID to configure OT limit
152 # echo 2 > /sys/devices/platfo 152 # echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
153 153
154 Check over temperature config 154 Check over temperature config ID is selected or not
155 # cat /sys/devices/platform/fi 155 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
156 The expected result is 2. 156 The expected result is 2.
157 157
158 Select external watchdog confi 158 Select external watchdog config ID to enable/disable feature
159 # echo 3 > /sys/devices/platfo 159 # echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
160 160
161 Check external watchdog config 161 Check external watchdog config ID is selected or not
162 # cat /sys/devices/platform/fi 162 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
163 The expected result is 3. 163 The expected result is 3.
164 164
165 Select external watchdog confi 165 Select external watchdog config ID to configure time interval
166 # echo 4 > /sys/devices/platfo 166 # echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
167 167
168 Check external watchdog config 168 Check external watchdog config ID is selected or not
169 # cat /sys/devices/platform/fi 169 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
170 The expected result is 4. 170 The expected result is 4.
171 171
172 Users: Xilinx 172 Users: Xilinx
173 173
174 What: /sys/devices/platform/firmware 174 What: /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
175 Date: Feb 2022 175 Date: Feb 2022
176 KernelVersion: 5.18 176 KernelVersion: 5.18
177 Contact: "Ronak Jain" <ronak.jain@xilinx 177 Contact: "Ronak Jain" <ronak.jain@xilinx.com>
178 Description: 178 Description:
179 This sysfs interface allows to 179 This sysfs interface allows to configure features at runtime.
180 The user can enable or disable 180 The user can enable or disable features running at firmware.
181 Also, the user can configure t 181 Also, the user can configure the parameters of the features
182 at runtime. The supported feat 182 at runtime. The supported features are over temperature and
183 external watchdog. Here, the e 183 external watchdog. Here, the external watchdog is completely
184 different than the /dev/watchd 184 different than the /dev/watchdog as the external watchdog is
185 running on the firmware and it 185 running on the firmware and it is used to monitor the health
186 of firmware not APU(Linux). Al 186 of firmware not APU(Linux). Also, the external watchdog is
187 interfaced outside of the zynq 187 interfaced outside of the zynqmp soc.
188 188
189 By default the features are di 189 By default the features are disabled in the firmware. The user
190 can enable features by queryin 190 can enable features by querying appropriate config id of the
191 features. 191 features.
192 192
193 The default limit for the over 193 The default limit for the over temperature is 90 Degree Celsius.
194 The default timer interval for 194 The default timer interval for the external watchdog is 570ms.
195 195
196 The supported config ids are f 196 The supported config ids are for the feature configuration is,
197 1. PM_FEATURE_OVERTEMP_STATUS 197 1. PM_FEATURE_OVERTEMP_STATUS = 1, the user can enable or
198 disable the over temperature f 198 disable the over temperature feature.
199 2. PM_FEATURE_OVERTEMP_VALUE = 199 2. PM_FEATURE_OVERTEMP_VALUE = 2, the user can configure the
200 over temperature limit in Degr 200 over temperature limit in Degree Celsius.
201 3. PM_FEATURE_EXTWDT_STATUS = 201 3. PM_FEATURE_EXTWDT_STATUS = 3, the user can enable or disable
202 the external watchdog feature. 202 the external watchdog feature.
203 4. PM_FEATURE_EXTWDT_VALUE = 4 203 4. PM_FEATURE_EXTWDT_VALUE = 4, the user can configure the
204 external watchdog feature. 204 external watchdog feature.
205 205
206 Usage: 206 Usage:
207 207
208 Enable over temperature featur 208 Enable over temperature feature
209 # echo 1 > /sys/devices/platfo 209 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
210 # echo 1 > /sys/devices/platfo 210 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
211 211
212 Check whether the over tempera 212 Check whether the over temperature feature is enabled or not
213 # cat /sys/devices/platform/fi 213 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
214 The expected result is 1. 214 The expected result is 1.
215 215
216 Disable over temperature featu 216 Disable over temperature feature
217 # echo 1 > /sys/devices/platfo 217 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
218 # echo 0 > /sys/devices/platfo 218 # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
219 219
220 Check whether the over tempera 220 Check whether the over temperature feature is disabled or not
221 # cat /sys/devices/platform/fi 221 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
222 The expected result is 0. 222 The expected result is 0.
223 223
224 Configure over temperature lim 224 Configure over temperature limit to 50 Degree Celsius
225 # echo 2 > /sys/devices/platfo 225 # echo 2 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
226 # echo 50 > /sys/devices/platf 226 # echo 50 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
227 227
228 Check whether the over tempera 228 Check whether the over temperature limit is configured or not
229 # cat /sys/devices/platform/fi 229 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
230 The expected result is 50. 230 The expected result is 50.
231 231
232 Enable external watchdog featu 232 Enable external watchdog feature
233 # echo 3 > /sys/devices/platfo 233 # echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
234 # echo 1 > /sys/devices/platfo 234 # echo 1 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
235 235
236 Check whether the external wat 236 Check whether the external watchdog feature is enabled or not
237 # cat /sys/devices/platform/fi 237 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
238 The expected result is 1. 238 The expected result is 1.
239 239
240 Disable external watchdog feat 240 Disable external watchdog feature
241 # echo 3 > /sys/devices/platfo 241 # echo 3 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
242 # echo 0 > /sys/devices/platfo 242 # echo 0 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
243 243
244 Check whether the external wat 244 Check whether the external watchdog feature is disabled or not
245 # cat /sys/devices/platform/fi 245 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
246 The expected result is 0. 246 The expected result is 0.
247 247
248 Configure external watchdog ti 248 Configure external watchdog timer interval to 500ms
249 # echo 4 > /sys/devices/platfo 249 # echo 4 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_id
250 # echo 500 > /sys/devices/plat 250 # echo 500 > /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
251 251
252 Check whether the external wat 252 Check whether the external watchdog timer interval is configured or not
253 # cat /sys/devices/platform/fi 253 # cat /sys/devices/platform/firmware\:zynqmp-firmware/feature_config_value
254 The expected result is 500. 254 The expected result is 500.
255 255
256 Users: Xilinx 256 Users: Xilinx
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.