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                 0 - Unknown
  39                 1 - System Firmware
  40                 2 - Device Firmware
  41                 3 - UEFI Driver
  42
  43 What:           /sys/firmware/efi/esrt/entries/entry$N/fw_class
  44 Date:           February 2015
  45 Contact:        Peter Jones <pjones@redhat.com>
  46 Description:    This is the entry's guid, and will match the directory name.
  47
  48 What:           /sys/firmware/efi/esrt/entries/entry$N/fw_version
  49 Date:           February 2015
  50 Contact:        Peter Jones <pjones@redhat.com>
  51 Description:    The version of the firmware currently installed.  This is a
  52                 32-bit unsigned integer.
  53
  54 What:           /sys/firmware/efi/esrt/entries/entry$N/lowest_supported_fw_version
  55 Date:           February 2015
  56 Contact:        Peter Jones <pjones@redhat.com>
  57 Description:    The lowest version of the firmware that can be installed.
  58
  59 What:           /sys/firmware/efi/esrt/entries/entry$N/capsule_flags
  60 Date:           February 2015
  61 Contact:        Peter Jones <pjones@redhat.com>
  62 Description:    Flags that must be passed to UpdateCapsule()
  63
  64 What:           /sys/firmware/efi/esrt/entries/entry$N/last_attempt_version
  65 Date:           February 2015
  66 Contact:        Peter Jones <pjones@redhat.com>
  67 Description:    The last firmware version for which an update was attempted.
  68
  69 What:           /sys/firmware/efi/esrt/entries/entry$N/last_attempt_status
  70 Date:           February 2015
  71 Contact:        Peter Jones <pjones@redhat.com>
  72 Description:    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