1 What: /sys/class/firmware-attributes
2 Date: February 2021
3 KernelVersion: 5.11
4 Contact: Divya Bharathi <Divya.Bharathi@
5 Prasanth KSR <prasanth.ksr@dell
6 Dell.Client.Kernel@dell.com
7 Description:
8 A sysfs interface for systems
9 configuration capability on su
10 exposes interfaces for interac
11
12 Unless otherwise specified in
13 and will accept UTF-8 input.
14
15 type:
16 A file that can be read to
17 This attribute is mandator
18
19 The following are known types:
20
21 - enumeration: a set o
22 - integer: a range of
23 - string
24
25 HP specific types
26 -----------------
27 - ordered-list - a set
28
29
30 All attribute types support th
31
32 current_value:
33 A file that ca
34 value of the <
35
36 This file can
37 <attr>
38
39 This attribute
40
41 default_value:
42 A file that ca
43 value of the <
44
45 display_name:
46 A file that ca
47 description of
48
49 display_name_language_code:
50
51
52
53
54 "enumeration"-type specific pr
55
56 possible_values:
57 A file
58 values
59 semi-c
60
61 "integer"-type specific proper
62
63 min_value:
64 A file that ca
65 bound value of
66
67 max_value:
68 A file that ca
69 bound value of
70
71 scalar_increment:
72 A file
73 increm
74
75 "string"-type specific propert
76
77 max_length:
78 A file that ca
79 length value o
80
81 min_length:
82 A file that ca
83 length value o
84
85 Dell specific class extensions
86 ------------------------------
87
88 On Dell systems the following
89
90 dell_modifier:
91 A file that ca
92 dependency rul
93 suppressed, if
94
95 modifier rules
96
97 [ReadOnlyI
98 [ReadOnlyI
99 [SuppressI
100 [SuppressI
101
102 For example::
103
104 AutoOnFri/
105 [S
106
107 This means Aut
108 attribute is n
109 through sysfs
110
111 Enumeration attributes also su
112
113 dell_value_modifier:
114 A file
115 This f
116 attrib
117 depend
118
119 dell_v
120
121 <v
122 <v
123
124 For ex
125
126 Le
127
128
129 This m
130 "Disab
131 value
132 met.
133
134 HP specific class extensions
135 ------------------------------
136
137 On HP systems the following ad
138
139 "ordered-list"-type specific p
140
141 elements:
142 A file
143 list o
144 semi-c
145 An ele
146 the li
147 the pr
148
149 What: /sys/class/firmware-attributes
150 Date: February 2021
151 KernelVersion: 5.11
152 Contact: Divya Bharathi <Divya.Bharathi@
153 Prasanth KSR <prasanth.ksr@dell
154 Dell.Client.Kernel@dell.com
155 Description:
156 Devices support various authen
157 as a separate configuration ob
158
159 For example a "BIOS Admin" pas
160 reset or cleared using these a
161
162 - An "Admin" password is used
163 settings.
164 - A "System" password is requi
165
166 Change in any of these two aut
167 uevent KOBJ_CHANGE.
168
169 is_enabled:
170 A file
171 <attr>
172 This a
173
174 role:
175 The ty
176 This a
177
178 Known
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194 mechanism:
195 The me
196 Only s
197
198 max_password_length:
199 A file
200 maximu
201
202 min_password_length:
203 A file
204 minimu
205
206 current_password:
207 A writ
208 settin
209 or res
210
211 This a
212
213 new_password:
214 A writ
215 curren
216
217 Note, password management is s
218 same password must be written
219 password-validation) and must
220 For example::
221
222 echo "password" > curr
223 echo "disabled" > Touc
224 echo "" > current_pass
225
226 Drivers may emit a CHANGE ueve
227 userspace may check it again.
228
229 On Dell, Lenovo and HP systems
230 require password validation.
231 On Lenovo systems if you chang
232 the next boot.
233
234 Lenovo specific class extensio
235 ------------------------------
236
237 On Lenovo systems the followin
238
239 role: system-mgmt This g
240 securi
241 the BI
242
243 role: HDD & NVMe This p
244 'level
245
246 lenovo_encoding:
247 The en
248 or "sc
249
250 lenovo_kbdlang:
251 The ke
252 two ch
253 Defaul
254
255 level:
256 Availa
257 privil
258 If onl
259 unlock
260 then e
261 is req
262 This a
263
264 index:
265 Used w
266 that i
267 This a
268
269 certificate, signature, save_s
270 These
271 used i
272 based
273 The us
274 from t
275 The at
276
277 Some u
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300 You ca
301 has no
302 Cleari
303 being
304 After
305 take e
306
307 certificate_thumbprint:
308 Read o
309 for th
310
311 certificate_to_password:
312 Write
313 back t
314 Usage:
315
316
317
318
319 HP specific class extensions
320 ------------------------------
321
322 On HP systems the following ad
323
324 role: enhanced-bios-auth:
325 This r
326 It req
327
328
329 What: /sys/class/firmware-attributes
330 Date: February 2021
331 KernelVersion: 5.11
332 Contact: Divya Bharathi <Divya.Bharathi@
333 Prasanth KSR <prasanth.ksr@dell
334 Dell.Client.Kernel@dell.com
335 Description:
336 A read-only attribute reads 1
337 pending BIOS attribute changes
338 generated when it changes to 1
339
340 == ==============
341 0 All BIOS attri
342 1 A reboot is ne
343 attribute chan
344 == ==============
345
346 Note, userspace applications n
347 BIOS management,
348
349 1. Check if admin passwor
350 password management as
351 2. Before setting any att
352 or value_modifiers. If
353 attribute.
354
355 Drivers may emit a CHANGE ueve
356 may check it again.
357
358 What: /sys/class/firmware-attributes
359 Date: February 2021
360 KernelVersion: 5.11
361 Contact: Divya Bharathi <Divya.Bharathi@
362 Prasanth KSR <prasanth.ksr@dell
363 Dell.Client.Kernel@dell.com
364 Description:
365 This attribute can be used to
366 Specifically, it tells which t
367 requested on the host.
368
369 Reading from it returns a list
370
371 - 'builtinsafe' (Built
372 - 'lastknowngood' (Las
373 - 'factory' (Default f
374 - 'custom' (Custom sav
375
376 The currently selected option
377 shown below::
378
379 # echo "factory" > /sys/cl
380 # cat /sys/class/firmware-
381 builtinsafe lastknowngood
382
383 Note that any changes to this
384 for changes to take effect.
385
386 What: /sys/class/firmware-attributes
387 Date: August 2023
388 KernelVersion: 6.6
389 Contact: Mark Pearson <mpearson-lenovo@s
390 Description:
391 On Lenovo platforms there is a
392 saved. This is an architectura
393 that can be modified to 48.
394 A solution for this is instead
395 to allow a user to bulk set th
396 unlimited attributes.
397
398 Read the attribute to check wh
399 E.g:
400 # cat /sys/class/firmware-attr
401 single
402
403 Write the attribute with 'bulk
404 Write the attribute with 'sing
405 The default setting is single
406 E.g:
407 # echo bulk > /sys/class/firmw
408
409 When in bulk mode write 'save'
410 Note, once a save has been tri
411 will return a permissions erro
412 (which requires entering the B
413 E.g:
414 # echo save > /sys/class/firmw
415
416 What: /sys/class/firmware-attributes
417 Date: July 2021
418 KernelVersion: 5.14
419 Contact: Mark Pearson <markpearson@lenov
420 Description:
421 This write only attribute can
422 This should only be used when
423 use it to enable extra debug a
424
425 Note that any changes to this
426
427
428 HP specific class extensions -
429 ------------------------------
430
431 What: /sys/class/firmware-attributes
432 Date: March 2023
433 KernelVersion: 5.18
434 Contact: "Jorge Lopez" <jorge.lopez2@hp.
435 Description:
436 'kek' Key-Encryption-Key is a
437 RSA public key that will be us
438 signatures when setting the si
439 the bytes should correspond to
440 (x509 .DER format containing a
441 certificate must be less than
442
443 What: /sys/class/firmware-attributes
444 Date: March 2023
445 KernelVersion: 5.18
446 Contact: "Jorge Lopez" <jorge.lopez2@hp.
447 Description:
448 'sk' Signature Key is a write-
449 public key that will be used b
450 when configuring BIOS settings
451 written, the bytes should corr
452 public key. The exponent is a
453
454 What: /sys/class/firmware-attributes
455 Date: March 2023
456 KernelVersion: 5.18
457 Contact: "Jorge Lopez" <jorge.lopez2@hp.
458 Description:
459 'status' is a read-only file t
460 the status information.
461
462 "State": "not provisioned |
463 "Version": "Major.Minor",
464 "Nonce": <16-bit unsigned nu
465 "FeaturesInUse": <16-bit uns
466 "EndorsementKeyMod": "<256 b
467 "SigningKeyMod": "<256 bytes
468
469 What: /sys/class/firmware-attributes
470 Date: March 2023
471 KernelVersion: 5.18
472 Contact: "Jorge Lopez" <jorge.lopez2@hp.
473 Description:
474 'audit_log_entries' is a read-
475
476 Audit log entry format
477
478 Byte 0-15: Requested
479 Byte 16-127: Unused
480
481 What: /sys/class/firmware-attributes
482 Date: March 2023
483 KernelVersion: 5.18
484 Contact: "Jorge Lopez" <jorge.lopez2@hp.
485 Description:
486 'audit_log_entry_count' is a r
487 audit log events available to
488
489 [No of entries],[log e
490
491 log entry size identifies audi
492 The current size is 16 bytes b
493 versions.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.