Documentation/ABI/testing/sysfs-firmware-efi-esrt

   1 What:           /sys/firmware/efi/esrt/
   2 Date:           February 2015
   3 Contact:        Peter Jones <pjones@redhat.com>
   4 Description:    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.
   8 Users:          fwupdate - https://github.com/rhinstaller/fwupdate
   9
  10 What:           /sys/firmware/efi/esrt/fw_resource_count
  11 Date:           February 2015
  12 Contact:        Peter Jones <pjones@redhat.com>
  13 Description:    The number of entries in the ESRT
  14
  15 What:           /sys/firmware/efi/esrt/fw_resource_count_max
  16 Date:           February 2015
  17 Contact:        Peter Jones <pjones@redhat.com>
  18 Description:    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
  22 What:           /sys/firmware/efi/esrt/fw_resource_version
  23 Date:           February 2015
  24 Contact:        Peter Jones <pjones@redhat.com>
  25 Description:    The version of the ESRT structure provided by the firmware.
  26
  27 What:           /sys/firmware/efi/esrt/entries/entry$N/
  28 Date:           February 2015
  29 Contact:        Peter Jones <pjones@redhat.com>
  30 Description:    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
  34 What:           /sys/firmware/efi/esrt/entries/entry$N/fw_type
  35 Date:           February 2015
  36 Contact:        Peter Jones <pjones@redhat.com>
  37 Description:    What kind of firmware entry this is:
  38
  39                 ==  ===============
  40                 0   Unknown
  41                 1   System Firmware
  42                 2   Device Firmware
  43                 3   UEFI Driver
  44                 ==  ===============
  45
  46 What:           /sys/firmware/efi/esrt/entries/entry$N/fw_class
  47 Date:           February 2015
  48 Contact:        Peter Jones <pjones@redhat.com>
  49 Description:    This is the entry's guid, and will match the directory name.
  50
  51 What:           /sys/firmware/efi/esrt/entries/entry$N/fw_version
  52 Date:           February 2015
  53 Contact:        Peter Jones <pjones@redhat.com>
  54 Description:    The version of the firmware currently installed.  This is a
  55                 32-bit unsigned integer.
  56
  57 What:           /sys/firmware/efi/esrt/entries/entry$N/lowest_supported_fw_version
  58 Date:           February 2015
  59 Contact:        Peter Jones <pjones@redhat.com>
  60 Description:    The lowest version of the firmware that can be installed.
  61
  62 What:           /sys/firmware/efi/esrt/entries/entry$N/capsule_flags
  63 Date:           February 2015
  64 Contact:        Peter Jones <pjones@redhat.com>
  65 Description:    Flags that must be passed to UpdateCapsule()
  66
  67 What:           /sys/firmware/efi/esrt/entries/entry$N/last_attempt_version
  68 Date:           February 2015
  69 Contact:        Peter Jones <pjones@redhat.com>
  70 Description:    The last firmware version for which an update was attempted.
  71
  72 What:           /sys/firmware/efi/esrt/entries/entry$N/last_attempt_status
  73 Date:           February 2015
  74 Contact:        Peter Jones <pjones@redhat.com>
  75 Description:    The result of the last firmware update attempt for the
  76                 firmware resource entry.
  77
  78                 ==  ======================
  79                 0   Success
  80                 1   Insufficient resources
  81                 2   Incorrect version
  82                 3   Invalid format
  83                 4   Authentication error
  84                 5   AC power event
  85                 6   Battery power event
  86                 ==  ======================
  87