xref: /linux/Documentation/ABI/testing/sysfs-firmware-efi-esrt (revision 7aacf86b75bc5523d20fd9127104384fce51ce9c)
1What:		/sys/firmware/efi/esrt/
2Date:		February 2015
3Contact:	Peter Jones <pjones@redhat.com>
4Description:	Provides userland access to read the EFI System Resource Table
5		(ESRT), a catalog of firmware for which can be updated with
6		the UEFI UpdateCapsule mechanism described in section 7.5 of
7		the UEFI Standard.
8Users:		fwupdate - https://github.com/rhinstaller/fwupdate
9
10What:		/sys/firmware/efi/esrt/fw_resource_count
11Date:		February 2015
12Contact:	Peter Jones <pjones@redhat.com>
13Description:	The number of entries in the ESRT
14
15What:		/sys/firmware/efi/esrt/fw_resource_count_max
16Date:		February 2015
17Contact:	Peter Jones <pjones@redhat.com>
18Description:	The maximum number of entries that /could/ be registered
19		in the allocation the table is currently in.  This is
20		really only useful to the system firmware itself.
21
22What:		/sys/firmware/efi/esrt/fw_resource_version
23Date:		February 2015
24Contact:	Peter Jones <pjones@redhat.com>
25Description:	The version of the ESRT structure provided by the firmware.
26
27What:		/sys/firmware/efi/esrt/entries/entry$N/
28Date:		February 2015
29Contact:	Peter Jones <pjones@redhat.com>
30Description:	Each ESRT entry is identified by a GUID, and each gets a
31		subdirectory under entries/ .
32		example: /sys/firmware/efi/esrt/entries/entry0/
33
34What:		/sys/firmware/efi/esrt/entries/entry$N/fw_type
35Date:		February 2015
36Contact:	Peter Jones <pjones@redhat.com>
37Description:	What kind of firmware entry this is:
38		0 - Unknown
39		1 - System Firmware
40		2 - Device Firmware
41		3 - UEFI Driver
42
43What:		/sys/firmware/efi/esrt/entries/entry$N/fw_class
44Date:		February 2015
45Contact:	Peter Jones <pjones@redhat.com>
46Description:	This is the entry's guid, and will match the directory name.
47
48What:		/sys/firmware/efi/esrt/entries/entry$N/fw_version
49Date:		February 2015
50Contact:	Peter Jones <pjones@redhat.com>
51Description:	The version of the firmware currently installed.  This is a
52		32-bit unsigned integer.
53
54What:		/sys/firmware/efi/esrt/entries/entry$N/lowest_supported_fw_version
55Date:		February 2015
56Contact:	Peter Jones <pjones@redhat.com>
57Description:	The lowest version of the firmware that can be installed.
58
59What:		/sys/firmware/efi/esrt/entries/entry$N/capsule_flags
60Date:		February 2015
61Contact:	Peter Jones <pjones@redhat.com>
62Description:	Flags that must be passed to UpdateCapsule()
63
64What:		/sys/firmware/efi/esrt/entries/entry$N/last_attempt_version
65Date:		February 2015
66Contact:	Peter Jones <pjones@redhat.com>
67Description:	The last firmware version for which an update was attempted.
68
69What:		/sys/firmware/efi/esrt/entries/entry$N/last_attempt_status
70Date:		February 2015
71Contact:	Peter Jones <pjones@redhat.com>
72Description:	The result of the last firmware update attempt for the
73		firmware resource entry.
74		0 - Success
75		1 - Insufficient resources
76		2 - Incorrect version
77		3 - Invalid format
78		4 - Authentication error
79		5 - AC power event
80		6 - Battery power event
81
82