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