include/linux/efi.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_EFI_H
   3 #define _LINUX_EFI_H
   4
   5 /*
   6  * Extensible Firmware Interface
   7  * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
   8  *
   9  * Copyright (C) 1999 VA Linux Systems
  10  * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
  11  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  12  *      David Mosberger-Tang <davidm@hpl.hp.com>
  13  *      Stephane Eranian <eranian@hpl.hp.com>
  14  */
  15 #include <linux/init.h>
  16 #include <linux/string.h>
  17 #include <linux/time.h>
  18 #include <linux/types.h>
  19 #include <linux/proc_fs.h>
  20 #include <linux/rtc.h>
  21 #include <linux/ioport.h>
  22 #include <linux/pfn.h>
  23 #include <linux/pstore.h>
  24 #include <linux/range.h>
  25 #include <linux/reboot.h>
  26 #include <linux/uuid.h>
  27 #include <linux/screen_info.h>
  28
  29 #include <asm/page.h>
  30
  31 #define EFI_SUCCESS             0
  32 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
  33 #define EFI_INVALID_PARAMETER   ( 2 | (1UL << (BITS_PER_LONG-1)))
  34 #define EFI_UNSUPPORTED         ( 3 | (1UL << (BITS_PER_LONG-1)))
  35 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
  36 #define EFI_BUFFER_TOO_SMALL    ( 5 | (1UL << (BITS_PER_LONG-1)))
  37 #define EFI_NOT_READY           ( 6 | (1UL << (BITS_PER_LONG-1)))
  38 #define EFI_DEVICE_ERROR        ( 7 | (1UL << (BITS_PER_LONG-1)))
  39 #define EFI_WRITE_PROTECTED     ( 8 | (1UL << (BITS_PER_LONG-1)))
  40 #define EFI_OUT_OF_RESOURCES    ( 9 | (1UL << (BITS_PER_LONG-1)))
  41 #define EFI_NOT_FOUND           (14 | (1UL << (BITS_PER_LONG-1)))
  42 #define EFI_TIMEOUT             (18 | (1UL << (BITS_PER_LONG-1)))
  43 #define EFI_ABORTED             (21 | (1UL << (BITS_PER_LONG-1)))
  44 #define EFI_SECURITY_VIOLATION  (26 | (1UL << (BITS_PER_LONG-1)))
  45
  46 typedef unsigned long efi_status_t;
  47 typedef u8 efi_bool_t;
  48 typedef u16 efi_char16_t;               /* UNICODE character */
  49 typedef u64 efi_physical_addr_t;
  50 typedef void *efi_handle_t;
  51
  52 #if defined(CONFIG_X86_64)
  53 #define __efiapi __attribute__((ms_abi))
  54 #elif defined(CONFIG_X86_32)
  55 #define __efiapi __attribute__((regparm(0)))
  56 #else
  57 #define __efiapi
  58 #endif
  59
  60 /*
  61  * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
  62  * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
  63  * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
  64  * this means that firmware services invoked by the kernel may assume that
  65  * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
  66  * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
  67  *
  68  * Note that the UEFI spec as well as some comments in the EDK2 code base
  69  * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
  70  * a mistake, given that no code seems to exist that actually enforces that
  71  * or relies on it.
  72  */
  73 typedef guid_t efi_guid_t __aligned(__alignof__(u32));
  74
  75 #define EFI_GUID(a, b, c, d...) (efi_guid_t){ {                                 \
  76         (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff,  \
  77         (b) & 0xff, ((b) >> 8) & 0xff,                                          \
  78         (c) & 0xff, ((c) >> 8) & 0xff, d } }
  79
  80 /*
  81  * Generic EFI table header
  82  */
  83 typedef struct {
  84         u64 signature;
  85         u32 revision;
  86         u32 headersize;
  87         u32 crc32;
  88         u32 reserved;
  89 } efi_table_hdr_t;
  90
  91 /*
  92  * Memory map descriptor:
  93  */
  94
  95 /* Memory types: */
  96 #define EFI_RESERVED_TYPE                0
  97 #define EFI_LOADER_CODE                  1
  98 #define EFI_LOADER_DATA                  2
  99 #define EFI_BOOT_SERVICES_CODE           3
 100 #define EFI_BOOT_SERVICES_DATA           4
 101 #define EFI_RUNTIME_SERVICES_CODE        5
 102 #define EFI_RUNTIME_SERVICES_DATA        6
 103 #define EFI_CONVENTIONAL_MEMORY          7
 104 #define EFI_UNUSABLE_MEMORY              8
 105 #define EFI_ACPI_RECLAIM_MEMORY          9
 106 #define EFI_ACPI_MEMORY_NVS             10
 107 #define EFI_MEMORY_MAPPED_IO            11
 108 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
 109 #define EFI_PAL_CODE                    13
 110 #define EFI_PERSISTENT_MEMORY           14
 111 #define EFI_MAX_MEMORY_TYPE             15
 112
 113 /* Attribute values: */
 114 #define EFI_MEMORY_UC           ((u64)0x0000000000000001ULL)    /* uncached */
 115 #define EFI_MEMORY_WC           ((u64)0x0000000000000002ULL)    /* write-coalescing */
 116 #define EFI_MEMORY_WT           ((u64)0x0000000000000004ULL)    /* write-through */
 117 #define EFI_MEMORY_WB           ((u64)0x0000000000000008ULL)    /* write-back */
 118 #define EFI_MEMORY_UCE          ((u64)0x0000000000000010ULL)    /* uncached, exported */
 119 #define EFI_MEMORY_WP           ((u64)0x0000000000001000ULL)    /* write-protect */
 120 #define EFI_MEMORY_RP           ((u64)0x0000000000002000ULL)    /* read-protect */
 121 #define EFI_MEMORY_XP           ((u64)0x0000000000004000ULL)    /* execute-protect */
 122 #define EFI_MEMORY_NV           ((u64)0x0000000000008000ULL)    /* non-volatile */
 123 #define EFI_MEMORY_MORE_RELIABLE \
 124                                 ((u64)0x0000000000010000ULL)    /* higher reliability */
 125 #define EFI_MEMORY_RO           ((u64)0x0000000000020000ULL)    /* read-only */
 126 #define EFI_MEMORY_SP           ((u64)0x0000000000040000ULL)    /* soft reserved */
 127 #define EFI_MEMORY_CPU_CRYPTO   ((u64)0x0000000000080000ULL)    /* supports encryption */
 128 #define EFI_MEMORY_RUNTIME      ((u64)0x8000000000000000ULL)    /* range requires runtime mapping */
 129 #define EFI_MEMORY_DESCRIPTOR_VERSION   1
 130
 131 #define EFI_PAGE_SHIFT          12
 132 #define EFI_PAGE_SIZE           (1UL << EFI_PAGE_SHIFT)
 133 #define EFI_PAGES_MAX           (U64_MAX >> EFI_PAGE_SHIFT)
 134
 135 typedef struct {
 136         u32 type;
 137         u32 pad;
 138         u64 phys_addr;
 139         u64 virt_addr;
 140         u64 num_pages;
 141         u64 attribute;
 142 } efi_memory_desc_t;
 143
 144 typedef struct {
 145         efi_guid_t guid;
 146         u32 headersize;
 147         u32 flags;
 148         u32 imagesize;
 149 } efi_capsule_header_t;
 150
 151 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER */
 152 struct efi_manage_capsule_header {
 153         u32 ver;
 154         u16 emb_drv_cnt;
 155         u16 payload_cnt;
 156         /*
 157          * Variable-size array of the size given by the sum of
 158          * emb_drv_cnt and payload_cnt.
 159          */
 160         u64 offset_list[];
 161 } __packed;
 162
 163 /* EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER */
 164 struct efi_manage_capsule_image_header {
 165         u32 ver;
 166         efi_guid_t image_type_id;
 167         u8 image_index;
 168         u8 reserved_bytes[3];
 169         u32 image_size;
 170         u32 vendor_code_size;
 171         /* hw_ins was introduced in version 2 */
 172         u64 hw_ins;
 173         /* capsule_support was introduced in version 3 */
 174         u64 capsule_support;
 175 } __packed;
 176
 177 /* WIN_CERTIFICATE */
 178 struct win_cert {
 179         u32 len;
 180         u16 rev;
 181         u16 cert_type;
 182 };
 183
 184 /* WIN_CERTIFICATE_UEFI_GUID */
 185 struct win_cert_uefi_guid {
 186         struct win_cert hdr;
 187         efi_guid_t cert_type;
 188         u8 cert_data[];
 189 };
 190
 191 /* EFI_FIRMWARE_IMAGE_AUTHENTICATION */
 192 struct efi_image_auth {
 193         u64 mon_count;
 194         struct win_cert_uefi_guid auth_info;
 195 };
 196
 197 /*
 198  * EFI capsule flags
 199  */
 200 #define EFI_CAPSULE_PERSIST_ACROSS_RESET        0x00010000
 201 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE       0x00020000
 202 #define EFI_CAPSULE_INITIATE_RESET              0x00040000
 203
 204 struct capsule_info {
 205         efi_capsule_header_t    header;
 206         efi_capsule_header_t    *capsule;
 207         int                     reset_type;
 208         long                    index;
 209         size_t                  count;
 210         size_t                  total_size;
 211         struct page             **pages;
 212         phys_addr_t             *phys;
 213         size_t                  page_bytes_remain;
 214 };
 215
 216 int __efi_capsule_setup_info(struct capsule_info *cap_info);
 217
 218 /*
 219  * Types and defines for Time Services
 220  */
 221 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
 222 #define EFI_TIME_IN_DAYLIGHT     0x2
 223 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 224
 225 typedef struct {
 226         u16 year;
 227         u8 month;
 228         u8 day;
 229         u8 hour;
 230         u8 minute;
 231         u8 second;
 232         u8 pad1;
 233         u32 nanosecond;
 234         s16 timezone;
 235         u8 daylight;
 236         u8 pad2;
 237 } efi_time_t;
 238
 239 typedef struct {
 240         u32 resolution;
 241         u32 accuracy;
 242         u8 sets_to_zero;
 243 } efi_time_cap_t;
 244
 245 typedef union efi_boot_services efi_boot_services_t;
 246
 247 /*
 248  * Types and defines for EFI ResetSystem
 249  */
 250 #define EFI_RESET_COLD 0
 251 #define EFI_RESET_WARM 1
 252 #define EFI_RESET_SHUTDOWN 2
 253
 254 /*
 255  * EFI Runtime Services table
 256  */
 257 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 258 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 259
 260 typedef struct {
 261         efi_table_hdr_t hdr;
 262         u32 get_time;
 263         u32 set_time;
 264         u32 get_wakeup_time;
 265         u32 set_wakeup_time;
 266         u32 set_virtual_address_map;
 267         u32 convert_pointer;
 268         u32 get_variable;
 269         u32 get_next_variable;
 270         u32 set_variable;
 271         u32 get_next_high_mono_count;
 272         u32 reset_system;
 273         u32 update_capsule;
 274         u32 query_capsule_caps;
 275         u32 query_variable_info;
 276 } efi_runtime_services_32_t;
 277
 278 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 279 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 280 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 281                                             efi_time_t *tm);
 282 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 283 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 284                                          unsigned long *data_size, void *data);
 285 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 286                                               efi_guid_t *vendor);
 287 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 288                                          u32 attr, unsigned long data_size,
 289                                          void *data);
 290 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 291 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 292                                  unsigned long data_size, efi_char16_t *data);
 293 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 294                                                 unsigned long descriptor_size,
 295                                                 u32 descriptor_version,
 296                                                 efi_memory_desc_t *virtual_map);
 297 typedef efi_status_t efi_query_variable_info_t(u32 attr,
 298                                                u64 *storage_space,
 299                                                u64 *remaining_space,
 300                                                u64 *max_variable_size);
 301 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 302                                           unsigned long count,
 303                                           unsigned long sg_list);
 304 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 305                                               unsigned long count,
 306                                               u64 *max_size,
 307                                               int *reset_type);
 308 typedef efi_status_t efi_query_variable_store_t(u32 attributes,
 309                                                 unsigned long size,
 310                                                 bool nonblocking);
 311
 312 typedef union {
 313         struct {
 314                 efi_table_hdr_t                         hdr;
 315                 efi_get_time_t __efiapi                 *get_time;
 316                 efi_set_time_t __efiapi                 *set_time;
 317                 efi_get_wakeup_time_t __efiapi          *get_wakeup_time;
 318                 efi_set_wakeup_time_t __efiapi          *set_wakeup_time;
 319                 efi_set_virtual_address_map_t __efiapi  *set_virtual_address_map;
 320                 void                                    *convert_pointer;
 321                 efi_get_variable_t __efiapi             *get_variable;
 322                 efi_get_next_variable_t __efiapi        *get_next_variable;
 323                 efi_set_variable_t __efiapi             *set_variable;
 324                 efi_get_next_high_mono_count_t __efiapi *get_next_high_mono_count;
 325                 efi_reset_system_t __efiapi             *reset_system;
 326                 efi_update_capsule_t __efiapi           *update_capsule;
 327                 efi_query_capsule_caps_t __efiapi       *query_capsule_caps;
 328                 efi_query_variable_info_t __efiapi      *query_variable_info;
 329         };
 330         efi_runtime_services_32_t mixed_mode;
 331 } efi_runtime_services_t;
 332
 333 void efi_native_runtime_setup(void);
 334
 335 /*
 336  * EFI Configuration Table and GUID definitions
 337  *
 338  * These are all defined in a single line to make them easier to
 339  * grep for and to see them at a glance - while still having a
 340  * similar structure to the definitions in the spec.
 341  *
 342  * Here's how they are structured:
 343  *
 344  * GUID: 12345678-1234-1234-1234-123456789012
 345  * Spec:
 346  *      #define EFI_SOME_PROTOCOL_GUID \
 347  *        {0x12345678,0x1234,0x1234,\
 348  *          {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
 349  * Here:
 350  *      #define SOME_PROTOCOL_GUID              EFI_GUID(0x12345678, 0x1234, 0x1234,  0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
 351  *                                      ^ tabs                                      ^extra space
 352  *
 353  * Note that the 'extra space' separates the values at the same place
 354  * where the UEFI SPEC breaks the line.
 355  */
 356 #define NULL_GUID                               EFI_GUID(0x00000000, 0x0000, 0x0000,  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 357 #define MPS_TABLE_GUID                          EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 358 #define ACPI_TABLE_GUID                         EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 359 #define ACPI_20_TABLE_GUID                      EFI_GUID(0x8868e871, 0xe4f1, 0x11d3,  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
 360 #define SMBIOS_TABLE_GUID                       EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 361 #define SMBIOS3_TABLE_GUID                      EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c,  0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
 362 #define SAL_SYSTEM_TABLE_GUID                   EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 363 #define HCDP_TABLE_GUID                         EFI_GUID(0xf951938d, 0x620b, 0x42ef,  0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98)
 364 #define UGA_IO_PROTOCOL_GUID                    EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b,  0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2)
 365 #define EFI_GLOBAL_VARIABLE_GUID                EFI_GUID(0x8be4df61, 0x93ca, 0x11d2,  0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 366 #define UV_SYSTEM_TABLE_GUID                    EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd,  0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
 367 #define LINUX_EFI_CRASH_GUID                    EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc,  0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
 368 #define LOADED_IMAGE_PROTOCOL_GUID              EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 369 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID       EFI_GUID(0x9042a9de, 0x23dc, 0x4a38,  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
 370 #define EFI_UGA_PROTOCOL_GUID                   EFI_GUID(0x982c298b, 0xf4fa, 0x41cb,  0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39)
 371 #define EFI_PCI_IO_PROTOCOL_GUID                EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5,  0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
 372 #define EFI_FILE_INFO_ID                        EFI_GUID(0x09576e92, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 373 #define EFI_SYSTEM_RESOURCE_TABLE_GUID          EFI_GUID(0xb122a263, 0x3661, 0x4f68,  0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
 374 #define EFI_FILE_SYSTEM_GUID                    EFI_GUID(0x964e5b22, 0x6459, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 375 #define DEVICE_TREE_GUID                        EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5,  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 376 #define EFI_PROPERTIES_TABLE_GUID               EFI_GUID(0x880aaca3, 0x4adc, 0x4a04,  0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5)
 377 #define EFI_RNG_PROTOCOL_GUID                   EFI_GUID(0x3152bca5, 0xeade, 0x433d,  0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
 378 #define EFI_RNG_ALGORITHM_RAW                   EFI_GUID(0xe43176d7, 0xb6e8, 0x4827,  0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
 379 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID        EFI_GUID(0xdcfa911d, 0x26eb, 0x469f,  0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
 380 #define EFI_CONSOLE_OUT_DEVICE_GUID             EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4,  0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 381 #define APPLE_PROPERTIES_PROTOCOL_GUID          EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb,  0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
 382 #define EFI_TCG2_PROTOCOL_GUID                  EFI_GUID(0x607f766c, 0x7455, 0x42be,  0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
 383 #define EFI_LOAD_FILE_PROTOCOL_GUID             EFI_GUID(0x56ec3091, 0x954c, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 384 #define EFI_LOAD_FILE2_PROTOCOL_GUID            EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e,  0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
 385 #define EFI_RT_PROPERTIES_TABLE_GUID            EFI_GUID(0xeb66918a, 0x7eef, 0x402a,  0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
 386
 387 #define EFI_IMAGE_SECURITY_DATABASE_GUID        EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596,  0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
 388 #define EFI_SHIM_LOCK_GUID                      EFI_GUID(0x605dab50, 0xe046, 0x4300,  0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
 389
 390 #define EFI_CERT_SHA256_GUID                    EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
 391 #define EFI_CERT_X509_GUID                      EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
 392 #define EFI_CERT_X509_SHA256_GUID               EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
 393
 394 /*
 395  * This GUID is used to pass to the kernel proper the struct screen_info
 396  * structure that was populated by the stub based on the GOP protocol instance
 397  * associated with ConOut
 398  */
 399 #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID    EFI_GUID(0xe03fc20a, 0x85dc, 0x406e,  0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
 400 #define LINUX_EFI_ARM_CPU_STATE_TABLE_GUID      EFI_GUID(0xef79e4aa, 0x3c3d, 0x4989,  0xb9, 0x02, 0x07, 0xa9, 0x43, 0xe5, 0x50, 0xd2)
 401 #define LINUX_EFI_LOADER_ENTRY_GUID             EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf,  0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
 402 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID        EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2,  0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
 403 #define LINUX_EFI_TPM_EVENT_LOG_GUID            EFI_GUID(0xb7799cb0, 0xeca2, 0x4943,  0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
 404 #define LINUX_EFI_TPM_FINAL_LOG_GUID            EFI_GUID(0x1e2ed096, 0x30e2, 0x4254,  0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
 405 #define LINUX_EFI_MEMRESERVE_TABLE_GUID         EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5,  0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
 406 #define LINUX_EFI_INITRD_MEDIA_GUID             EFI_GUID(0x5568e427, 0x68fc, 0x4f3d,  0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68)
 407 #define LINUX_EFI_MOK_VARIABLE_TABLE_GUID       EFI_GUID(0xc451ed2b, 0x9694, 0x45d3,  0xba, 0xba, 0xed, 0x9f, 0x89, 0x88, 0xa3, 0x89)
 408
 409 /* OEM GUIDs */
 410 #define DELLEMC_EFI_RCI2_TABLE_GUID             EFI_GUID(0x2d9f28a2, 0xa886, 0x456a,  0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
 411 #define AMD_SEV_MEM_ENCRYPT_GUID                EFI_GUID(0x0cf29b71, 0x9e51, 0x433a,  0xa3, 0xb7, 0x81, 0xf3, 0xab, 0x16, 0xb8, 0x75)
 412
 413 typedef struct {
 414         efi_guid_t guid;
 415         u64 table;
 416 } efi_config_table_64_t;
 417
 418 typedef struct {
 419         efi_guid_t guid;
 420         u32 table;
 421 } efi_config_table_32_t;
 422
 423 typedef union {
 424         struct {
 425                 efi_guid_t guid;
 426                 void *table;
 427         };
 428         efi_config_table_32_t mixed_mode;
 429 } efi_config_table_t;
 430
 431 typedef struct {
 432         efi_guid_t guid;
 433         unsigned long *ptr;
 434         const char name[16];
 435 } efi_config_table_type_t;
 436
 437 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 438
 439 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 440 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 441 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 442 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 443 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 444 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 445
 446 typedef struct {
 447         efi_table_hdr_t hdr;
 448         u64 fw_vendor;  /* physical addr of CHAR16 vendor string */
 449         u32 fw_revision;
 450         u32 __pad1;
 451         u64 con_in_handle;
 452         u64 con_in;
 453         u64 con_out_handle;
 454         u64 con_out;
 455         u64 stderr_handle;
 456         u64 stderr;
 457         u64 runtime;
 458         u64 boottime;
 459         u32 nr_tables;
 460         u32 __pad2;
 461         u64 tables;
 462 } efi_system_table_64_t;
 463
 464 typedef struct {
 465         efi_table_hdr_t hdr;
 466         u32 fw_vendor;  /* physical addr of CHAR16 vendor string */
 467         u32 fw_revision;
 468         u32 con_in_handle;
 469         u32 con_in;
 470         u32 con_out_handle;
 471         u32 con_out;
 472         u32 stderr_handle;
 473         u32 stderr;
 474         u32 runtime;
 475         u32 boottime;
 476         u32 nr_tables;
 477         u32 tables;
 478 } efi_system_table_32_t;
 479
 480 typedef union efi_simple_text_input_protocol efi_simple_text_input_protocol_t;
 481 typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
 482
 483 typedef union {
 484         struct {
 485                 efi_table_hdr_t hdr;
 486                 unsigned long fw_vendor;        /* physical addr of CHAR16 vendor string */
 487                 u32 fw_revision;
 488                 unsigned long con_in_handle;
 489                 efi_simple_text_input_protocol_t *con_in;
 490                 unsigned long con_out_handle;
 491                 efi_simple_text_output_protocol_t *con_out;
 492                 unsigned long stderr_handle;
 493                 unsigned long stderr;
 494                 efi_runtime_services_t *runtime;
 495                 efi_boot_services_t *boottime;
 496                 unsigned long nr_tables;
 497                 unsigned long tables;
 498         };
 499         efi_system_table_32_t mixed_mode;
 500 } efi_system_table_t;
 501
 502 /*
 503  * Architecture independent structure for describing a memory map for the
 504  * benefit of efi_memmap_init_early(), and for passing context between
 505  * efi_memmap_alloc() and efi_memmap_install().
 506  */
 507 struct efi_memory_map_data {
 508         phys_addr_t phys_map;
 509         unsigned long size;
 510         unsigned long desc_version;
 511         unsigned long desc_size;
 512         unsigned long flags;
 513 };
 514
 515 struct efi_memory_map {
 516         phys_addr_t phys_map;
 517         void *map;
 518         void *map_end;
 519         int nr_map;
 520         unsigned long desc_version;
 521         unsigned long desc_size;
 522 #define EFI_MEMMAP_LATE (1UL << 0)
 523 #define EFI_MEMMAP_MEMBLOCK (1UL << 1)
 524 #define EFI_MEMMAP_SLAB (1UL << 2)
 525         unsigned long flags;
 526 };
 527
 528 struct efi_mem_range {
 529         struct range range;
 530         u64 attribute;
 531 };
 532
 533 typedef struct {
 534         u32 version;
 535         u32 length;
 536         u64 memory_protection_attribute;
 537 } efi_properties_table_t;
 538
 539 #define EFI_PROPERTIES_TABLE_VERSION    0x00010000
 540 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1
 541
 542 typedef struct {
 543         u16 version;
 544         u16 length;
 545         u32 runtime_services_supported;
 546 } efi_rt_properties_table_t;
 547
 548 #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
 549
 550 #define EFI_INVALID_TABLE_ADDR          (~0UL)
 551
 552 typedef struct {
 553         u32 version;
 554         u32 num_entries;
 555         u32 desc_size;
 556         u32 reserved;
 557         efi_memory_desc_t entry[0];
 558 } efi_memory_attributes_table_t;
 559
 560 typedef struct {
 561         efi_guid_t signature_owner;
 562         u8 signature_data[];
 563 } efi_signature_data_t;
 564
 565 typedef struct {
 566         efi_guid_t signature_type;
 567         u32 signature_list_size;
 568         u32 signature_header_size;
 569         u32 signature_size;
 570         u8 signature_header[];
 571         /* efi_signature_data_t signatures[][] */
 572 } efi_signature_list_t;
 573
 574 typedef u8 efi_sha256_hash_t[32];
 575
 576 typedef struct {
 577         efi_sha256_hash_t to_be_signed_hash;
 578         efi_time_t time_of_revocation;
 579 } efi_cert_x509_sha256_t;
 580
 581 extern unsigned long __ro_after_init efi_rng_seed;              /* RNG Seed table */
 582
 583 /*
 584  * All runtime access to EFI goes through this structure:
 585  */
 586 extern struct efi {
 587         const efi_runtime_services_t    *runtime;               /* EFI runtime services table */
 588         unsigned int                    runtime_version;        /* Runtime services version */
 589         unsigned int                    runtime_supported_mask;
 590
 591         unsigned long                   acpi;                   /* ACPI table  (IA64 ext 0.71) */
 592         unsigned long                   acpi20;                 /* ACPI table  (ACPI 2.0) */
 593         unsigned long                   smbios;                 /* SMBIOS table (32 bit entry point) */
 594         unsigned long                   smbios3;                /* SMBIOS table (64 bit entry point) */
 595         unsigned long                   esrt;                   /* ESRT table */
 596         unsigned long                   tpm_log;                /* TPM2 Event Log table */
 597         unsigned long                   tpm_final_log;          /* TPM2 Final Events Log table */
 598         unsigned long                   mokvar_table;           /* MOK variable config table */
 599
 600         efi_get_time_t                  *get_time;
 601         efi_set_time_t                  *set_time;
 602         efi_get_wakeup_time_t           *get_wakeup_time;
 603         efi_set_wakeup_time_t           *set_wakeup_time;
 604         efi_get_variable_t              *get_variable;
 605         efi_get_next_variable_t         *get_next_variable;
 606         efi_set_variable_t              *set_variable;
 607         efi_set_variable_t              *set_variable_nonblocking;
 608         efi_query_variable_info_t       *query_variable_info;
 609         efi_query_variable_info_t       *query_variable_info_nonblocking;
 610         efi_update_capsule_t            *update_capsule;
 611         efi_query_capsule_caps_t        *query_capsule_caps;
 612         efi_get_next_high_mono_count_t  *get_next_high_mono_count;
 613         efi_reset_system_t              *reset_system;
 614
 615         struct efi_memory_map           memmap;
 616         unsigned long                   flags;
 617 } efi;
 618
 619 #define EFI_RT_SUPPORTED_GET_TIME                               0x0001
 620 #define EFI_RT_SUPPORTED_SET_TIME                               0x0002
 621 #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME                        0x0004
 622 #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME                        0x0008
 623 #define EFI_RT_SUPPORTED_GET_VARIABLE                           0x0010
 624 #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME                 0x0020
 625 #define EFI_RT_SUPPORTED_SET_VARIABLE                           0x0040
 626 #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP                0x0080
 627 #define EFI_RT_SUPPORTED_CONVERT_POINTER                        0x0100
 628 #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT          0x0200
 629 #define EFI_RT_SUPPORTED_RESET_SYSTEM                           0x0400
 630 #define EFI_RT_SUPPORTED_UPDATE_CAPSULE                         0x0800
 631 #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES             0x1000
 632 #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO                    0x2000
 633
 634 #define EFI_RT_SUPPORTED_ALL                                    0x3fff
 635
 636 #define EFI_RT_SUPPORTED_TIME_SERVICES                          0x000f
 637 #define EFI_RT_SUPPORTED_VARIABLE_SERVICES                      0x0070
 638
 639 extern struct mm_struct efi_mm;
 640
 641 static inline int
 642 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 643 {
 644         return memcmp(&left, &right, sizeof (efi_guid_t));
 645 }
 646
 647 static inline char *
 648 efi_guid_to_str(efi_guid_t *guid, char *out)
 649 {
 650         sprintf(out, "%pUl", guid->b);
 651         return out;
 652 }
 653
 654 extern void efi_init (void);
 655 #ifdef CONFIG_EFI
 656 extern void efi_enter_virtual_mode (void);      /* switch EFI to virtual mode, if possible */
 657 #else
 658 static inline void efi_enter_virtual_mode (void) {}
 659 #endif
 660 #ifdef CONFIG_X86
 661 extern efi_status_t efi_query_variable_store(u32 attributes,
 662                                              unsigned long size,
 663                                              bool nonblocking);
 664 #else
 665
 666 static inline efi_status_t efi_query_variable_store(u32 attributes,
 667                                                     unsigned long size,
 668                                                     bool nonblocking)
 669 {
 670         return EFI_SUCCESS;
 671 }
 672 #endif
 673 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
 674
 675 extern int __init efi_memmap_alloc(unsigned int num_entries,
 676                                    struct efi_memory_map_data *data);
 677 extern void __efi_memmap_free(u64 phys, unsigned long size,
 678                               unsigned long flags);
 679 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
 680 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
 681 extern void __init efi_memmap_unmap(void);
 682 extern int __init efi_memmap_install(struct efi_memory_map_data *data);
 683 extern int __init efi_memmap_split_count(efi_memory_desc_t *md,
 684                                          struct range *range);
 685 extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap,
 686                                      void *buf, struct efi_mem_range *mem);
 687
 688 #ifdef CONFIG_EFI_ESRT
 689 extern void __init efi_esrt_init(void);
 690 #else
 691 static inline void efi_esrt_init(void) { }
 692 #endif
 693 extern int efi_config_parse_tables(const efi_config_table_t *config_tables,
 694                                    int count,
 695                                    const efi_config_table_type_t *arch_tables);
 696 extern int efi_systab_check_header(const efi_table_hdr_t *systab_hdr,
 697                                    int min_major_version);
 698 extern void efi_systab_report_header(const efi_table_hdr_t *systab_hdr,
 699                                      unsigned long fw_vendor);
 700 extern u64 efi_get_iobase (void);
 701 extern int efi_mem_type(unsigned long phys_addr);
 702 extern u64 efi_mem_attributes (unsigned long phys_addr);
 703 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 704 extern int __init efi_uart_console_only (void);
 705 extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
 706 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
 707 extern void efi_mem_reserve(phys_addr_t addr, u64 size);
 708 extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
 709 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 710                 struct resource *data_resource, struct resource *bss_resource);
 711 extern u64 efi_get_fdt_params(struct efi_memory_map_data *data);
 712 extern struct kobject *efi_kobj;
 713
 714 extern int efi_reboot_quirk_mode;
 715 extern bool efi_poweroff_required(void);
 716
 717 #ifdef CONFIG_EFI_FAKE_MEMMAP
 718 extern void __init efi_fake_memmap(void);
 719 #else
 720 static inline void efi_fake_memmap(void) { }
 721 #endif
 722
 723 extern unsigned long efi_mem_attr_table;
 724
 725 /*
 726  * efi_memattr_perm_setter - arch specific callback function passed into
 727  *                           efi_memattr_apply_permissions() that updates the
 728  *                           mapping permissions described by the second
 729  *                           argument in the page tables referred to by the
 730  *                           first argument.
 731  */
 732 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *);
 733
 734 extern int efi_memattr_init(void);
 735 extern int efi_memattr_apply_permissions(struct mm_struct *mm,
 736                                          efi_memattr_perm_setter fn);
 737
 738 /*
 739  * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor
 740  * @map: the start of efi memmap
 741  * @desc_size: the size of space for each EFI memmap descriptor
 742  * @n: the index of efi memmap descriptor
 743  *
 744  * EFI boot service provides the GetMemoryMap() function to get a copy of the
 745  * current memory map which is an array of memory descriptors, each of
 746  * which describes a contiguous block of memory. It also gets the size of the
 747  * map, and the size of each descriptor, etc.
 748  *
 749  * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
 750  * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
 751  * since efi_memory_memdesc_t may be extended in the future. Thus the OS
 752  * MUST use the returned size of the descriptor to find the start of each
 753  * efi_memory_memdesc_t in the memory map array. This should only be used
 754  * during bootup since for_each_efi_memory_desc_xxx() is available after the
 755  * kernel initializes the EFI subsystem to set up struct efi_memory_map.
 756  */
 757 #define efi_early_memdesc_ptr(map, desc_size, n)                        \
 758         (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
 759
 760 /* Iterate through an efi_memory_map */
 761 #define for_each_efi_memory_desc_in_map(m, md)                             \
 762         for ((md) = (m)->map;                                              \
 763              (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end;      \
 764              (md) = (void *)(md) + (m)->desc_size)
 765
 766 /**
 767  * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
 768  * @md: the efi_memory_desc_t * iterator
 769  *
 770  * Once the loop finishes @md must not be accessed.
 771  */
 772 #define for_each_efi_memory_desc(md) \
 773         for_each_efi_memory_desc_in_map(&efi.memmap, md)
 774
 775 /*
 776  * Format an EFI memory descriptor's type and attributes to a user-provided
 777  * character buffer, as per snprintf(), and return the buffer.
 778  */
 779 char * __init efi_md_typeattr_format(char *buf, size_t size,
 780                                      const efi_memory_desc_t *md);
 781
 782
 783 typedef void (*efi_element_handler_t)(const char *source,
 784                                       const void *element_data,
 785                                       size_t element_size);
 786 extern int __init parse_efi_signature_list(
 787         const char *source,
 788         const void *data, size_t size,
 789         efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
 790
 791 /**
 792  * efi_range_is_wc - check the WC bit on an address range
 793  * @start: starting kvirt address
 794  * @len: length of range
 795  *
 796  * Consult the EFI memory map and make sure it's ok to set this range WC.
 797  * Returns true or false.
 798  */
 799 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 800 {
 801         unsigned long i;
 802
 803         for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 804                 unsigned long paddr = __pa(start + i);
 805                 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 806                         return 0;
 807         }
 808         /* The range checked out */
 809         return 1;
 810 }
 811
 812 #ifdef CONFIG_EFI_PCDP
 813 extern int __init efi_setup_pcdp_console(char *);
 814 #endif
 815
 816 /*
 817  * We play games with efi_enabled so that the compiler will, if
 818  * possible, remove EFI-related code altogether.
 819  */
 820 #define EFI_BOOT                0       /* Were we booted from EFI? */
 821 #define EFI_CONFIG_TABLES       2       /* Can we use EFI config tables? */
 822 #define EFI_RUNTIME_SERVICES    3       /* Can we use runtime services? */
 823 #define EFI_MEMMAP              4       /* Can we use EFI memory map? */
 824 #define EFI_64BIT               5       /* Is the firmware 64-bit? */
 825 #define EFI_PARAVIRT            6       /* Access is via a paravirt interface */
 826 #define EFI_ARCH_1              7       /* First arch-specific bit */
 827 #define EFI_DBG                 8       /* Print additional debug info at runtime */
 828 #define EFI_NX_PE_DATA          9       /* Can runtime data regions be mapped non-executable? */
 829 #define EFI_MEM_ATTR            10      /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
 830 #define EFI_MEM_NO_SOFT_RESERVE 11      /* Is the kernel configured to ignore soft reservations? */
 831 #define EFI_PRESERVE_BS_REGIONS 12      /* Are EFI boot-services memory segments available? */
 832
 833 #ifdef CONFIG_EFI
 834 /*
 835  * Test whether the above EFI_* bits are enabled.
 836  */
 837 static inline bool efi_enabled(int feature)
 838 {
 839         return test_bit(feature, &efi.flags) != 0;
 840 }
 841 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
 842
 843 bool __pure __efi_soft_reserve_enabled(void);
 844
 845 static inline bool __pure efi_soft_reserve_enabled(void)
 846 {
 847         return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
 848                 && __efi_soft_reserve_enabled();
 849 }
 850
 851 static inline bool efi_rt_services_supported(unsigned int mask)
 852 {
 853         return (efi.runtime_supported_mask & mask) == mask;
 854 }
 855 #else
 856 static inline bool efi_enabled(int feature)
 857 {
 858         return false;
 859 }
 860 static inline void
 861 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
 862
 863 static inline bool efi_soft_reserve_enabled(void)
 864 {
 865         return false;
 866 }
 867
 868 static inline bool efi_rt_services_supported(unsigned int mask)
 869 {
 870         return false;
 871 }
 872 #endif
 873
 874 extern int efi_status_to_err(efi_status_t status);
 875
 876 /*
 877  * Variable Attributes
 878  */
 879 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 880 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 881 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 882 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
 883 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
 884 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
 885 #define EFI_VARIABLE_APPEND_WRITE       0x0000000000000040
 886
 887 #define EFI_VARIABLE_MASK       (EFI_VARIABLE_NON_VOLATILE | \
 888                                 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 889                                 EFI_VARIABLE_RUNTIME_ACCESS | \
 890                                 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
 891                                 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
 892                                 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
 893                                 EFI_VARIABLE_APPEND_WRITE)
 894 /*
 895  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
 896  * not including trailing NUL
 897  */
 898 #define EFI_VARIABLE_GUID_LEN   UUID_STRING_LEN
 899
 900 /*
 901  * EFI Device Path information
 902  */
 903 #define EFI_DEV_HW                      0x01
 904 #define  EFI_DEV_PCI                             1
 905 #define  EFI_DEV_PCCARD                          2
 906 #define  EFI_DEV_MEM_MAPPED                      3
 907 #define  EFI_DEV_VENDOR                          4
 908 #define  EFI_DEV_CONTROLLER                      5
 909 #define EFI_DEV_ACPI                    0x02
 910 #define   EFI_DEV_BASIC_ACPI                     1
 911 #define   EFI_DEV_EXPANDED_ACPI                  2
 912 #define EFI_DEV_MSG                     0x03
 913 #define   EFI_DEV_MSG_ATAPI                      1
 914 #define   EFI_DEV_MSG_SCSI                       2
 915 #define   EFI_DEV_MSG_FC                         3
 916 #define   EFI_DEV_MSG_1394                       4
 917 #define   EFI_DEV_MSG_USB                        5
 918 #define   EFI_DEV_MSG_USB_CLASS                 15
 919 #define   EFI_DEV_MSG_I20                        6
 920 #define   EFI_DEV_MSG_MAC                       11
 921 #define   EFI_DEV_MSG_IPV4                      12
 922 #define   EFI_DEV_MSG_IPV6                      13
 923 #define   EFI_DEV_MSG_INFINIBAND                 9
 924 #define   EFI_DEV_MSG_UART                      14
 925 #define   EFI_DEV_MSG_VENDOR                    10
 926 #define EFI_DEV_MEDIA                   0x04
 927 #define   EFI_DEV_MEDIA_HARD_DRIVE               1
 928 #define   EFI_DEV_MEDIA_CDROM                    2
 929 #define   EFI_DEV_MEDIA_VENDOR                   3
 930 #define   EFI_DEV_MEDIA_FILE                     4
 931 #define   EFI_DEV_MEDIA_PROTOCOL                 5
 932 #define EFI_DEV_BIOS_BOOT               0x05
 933 #define EFI_DEV_END_PATH                0x7F
 934 #define EFI_DEV_END_PATH2               0xFF
 935 #define   EFI_DEV_END_INSTANCE                  0x01
 936 #define   EFI_DEV_END_ENTIRE                    0xFF
 937
 938 struct efi_generic_dev_path {
 939         u8                              type;
 940         u8                              sub_type;
 941         u16                             length;
 942 } __packed;
 943
 944 struct efi_acpi_dev_path {
 945         struct efi_generic_dev_path     header;
 946         u32                             hid;
 947         u32                             uid;
 948 } __packed;
 949
 950 struct efi_pci_dev_path {
 951         struct efi_generic_dev_path     header;
 952         u8                              fn;
 953         u8                              dev;
 954 } __packed;
 955
 956 struct efi_vendor_dev_path {
 957         struct efi_generic_dev_path     header;
 958         efi_guid_t                      vendorguid;
 959         u8                              vendordata[];
 960 } __packed;
 961
 962 struct efi_dev_path {
 963         union {
 964                 struct efi_generic_dev_path     header;
 965                 struct efi_acpi_dev_path        acpi;
 966                 struct efi_pci_dev_path         pci;
 967                 struct efi_vendor_dev_path      vendor;
 968         };
 969 } __packed;
 970
 971 struct device *efi_get_device_by_path(const struct efi_dev_path **node,
 972                                       size_t *len);
 973
 974 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
 975 {
 976         *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
 977         *addr &= PAGE_MASK;
 978 }
 979
 980 /*
 981  * EFI Variable support.
 982  *
 983  * Different firmware drivers can expose their EFI-like variables using
 984  * the following.
 985  */
 986
 987 struct efivar_operations {
 988         efi_get_variable_t *get_variable;
 989         efi_get_next_variable_t *get_next_variable;
 990         efi_set_variable_t *set_variable;
 991         efi_set_variable_t *set_variable_nonblocking;
 992         efi_query_variable_store_t *query_variable_store;
 993 };
 994
 995 struct efivars {
 996         struct kset *kset;
 997         struct kobject *kobject;
 998         const struct efivar_operations *ops;
 999 };
1000
1001 /*
1002  * The maximum size of VariableName + Data = 1024
1003  * Therefore, it's reasonable to save that much
1004  * space in each part of the structure,
1005  * and we use a page for reading/writing.
1006  */
1007
1008 #define EFI_VAR_NAME_LEN        1024
1009
1010 struct efi_variable {
1011         efi_char16_t  VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)];
1012         efi_guid_t    VendorGuid;
1013         unsigned long DataSize;
1014         __u8          Data[1024];
1015         efi_status_t  Status;
1016         __u32         Attributes;
1017 } __attribute__((packed));
1018
1019 struct efivar_entry {
1020         struct efi_variable var;
1021         struct list_head list;
1022         struct kobject kobj;
1023         bool scanning;
1024         bool deleting;
1025 };
1026
1027 static inline void
1028 efivar_unregister(struct efivar_entry *var)
1029 {
1030         kobject_put(&var->kobj);
1031 }
1032
1033 int efivars_register(struct efivars *efivars,
1034                      const struct efivar_operations *ops,
1035                      struct kobject *kobject);
1036 int efivars_unregister(struct efivars *efivars);
1037 struct kobject *efivars_kobject(void);
1038
1039 int efivar_supports_writes(void);
1040 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
1041                 void *data, bool duplicates, struct list_head *head);
1042
1043 int efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
1044 int efivar_entry_remove(struct efivar_entry *entry);
1045
1046 int __efivar_entry_delete(struct efivar_entry *entry);
1047 int efivar_entry_delete(struct efivar_entry *entry);
1048
1049 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
1050 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1051                        unsigned long *size, void *data);
1052 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
1053                      unsigned long *size, void *data);
1054 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
1055                      unsigned long size, void *data, struct list_head *head);
1056 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
1057                               unsigned long *size, void *data, bool *set);
1058 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
1059                           bool block, unsigned long size, void *data);
1060
1061 int efivar_entry_iter_begin(void);
1062 void efivar_entry_iter_end(void);
1063
1064 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1065                         struct list_head *head, void *data,
1066                         struct efivar_entry **prev);
1067 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
1068                       struct list_head *head, void *data);
1069
1070 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
1071                                        struct list_head *head, bool remove);
1072
1073 bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data,
1074                      unsigned long data_size);
1075 bool efivar_variable_is_removable(efi_guid_t vendor, const char *name,
1076                                   size_t len);
1077
1078 #if IS_ENABLED(CONFIG_EFI_CAPSULE_LOADER)
1079 extern bool efi_capsule_pending(int *reset_type);
1080
1081 extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1082                                  size_t size, int *reset);
1083
1084 extern int efi_capsule_update(efi_capsule_header_t *capsule,
1085                               phys_addr_t *pages);
1086 #else
1087 static inline bool efi_capsule_pending(int *reset_type) { return false; }
1088 #endif
1089
1090 #ifdef CONFIG_EFI_RUNTIME_MAP
1091 int efi_runtime_map_init(struct kobject *);
1092 int efi_get_runtime_map_size(void);
1093 int efi_get_runtime_map_desc_size(void);
1094 int efi_runtime_map_copy(void *buf, size_t bufsz);
1095 #else
1096 static inline int efi_runtime_map_init(struct kobject *kobj)
1097 {
1098         return 0;
1099 }
1100
1101 static inline int efi_get_runtime_map_size(void)
1102 {
1103         return 0;
1104 }
1105
1106 static inline int efi_get_runtime_map_desc_size(void)
1107 {
1108         return 0;
1109 }
1110
1111 static inline int efi_runtime_map_copy(void *buf, size_t bufsz)
1112 {
1113         return 0;
1114 }
1115
1116 #endif
1117
1118 #ifdef CONFIG_EFI
1119 extern bool efi_runtime_disabled(void);
1120 #else
1121 static inline bool efi_runtime_disabled(void) { return true; }
1122 #endif
1123
1124 extern void efi_call_virt_check_flags(unsigned long flags, const char *call);
1125 extern unsigned long efi_call_virt_save_flags(void);
1126
1127 enum efi_secureboot_mode {
1128         efi_secureboot_mode_unset,
1129         efi_secureboot_mode_unknown,
1130         efi_secureboot_mode_disabled,
1131         efi_secureboot_mode_enabled,
1132 };
1133
1134 static inline
1135 enum efi_secureboot_mode efi_get_secureboot_mode(efi_get_variable_t *get_var)
1136 {
1137         u8 secboot, setupmode = 0;
1138         efi_status_t status;
1139         unsigned long size;
1140
1141         size = sizeof(secboot);
1142         status = get_var(L"SecureBoot", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size,
1143                          &secboot);
1144         if (status == EFI_NOT_FOUND)
1145                 return efi_secureboot_mode_disabled;
1146         if (status != EFI_SUCCESS)
1147                 return efi_secureboot_mode_unknown;
1148
1149         size = sizeof(setupmode);
1150         get_var(L"SetupMode", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size, &setupmode);
1151         if (secboot == 0 || setupmode == 1)
1152                 return efi_secureboot_mode_disabled;
1153         return efi_secureboot_mode_enabled;
1154 }
1155
1156 #ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1157 void efi_check_for_embedded_firmwares(void);
1158 #else
1159 static inline void efi_check_for_embedded_firmwares(void) { }
1160 #endif
1161
1162 efi_status_t efi_random_get_seed(void);
1163
1164 /*
1165  * Arch code can implement the following three template macros, avoiding
1166  * reptition for the void/non-void return cases of {__,}efi_call_virt():
1167  *
1168  *  * arch_efi_call_virt_setup()
1169  *
1170  *    Sets up the environment for the call (e.g. switching page tables,
1171  *    allowing kernel-mode use of floating point, if required).
1172  *
1173  *  * arch_efi_call_virt()
1174  *
1175  *    Performs the call. The last expression in the macro must be the call
1176  *    itself, allowing the logic to be shared by the void and non-void
1177  *    cases.
1178  *
1179  *  * arch_efi_call_virt_teardown()
1180  *
1181  *    Restores the usual kernel environment once the call has returned.
1182  */
1183
1184 #define efi_call_virt_pointer(p, f, args...)                            \
1185 ({                                                                      \
1186         efi_status_t __s;                                               \
1187         unsigned long __flags;                                          \
1188                                                                         \
1189         arch_efi_call_virt_setup();                                     \
1190                                                                         \
1191         __flags = efi_call_virt_save_flags();                           \
1192         __s = arch_efi_call_virt(p, f, args);                           \
1193         efi_call_virt_check_flags(__flags, __stringify(f));             \
1194                                                                         \
1195         arch_efi_call_virt_teardown();                                  \
1196                                                                         \
1197         __s;                                                            \
1198 })
1199
1200 #define __efi_call_virt_pointer(p, f, args...)                          \
1201 ({                                                                      \
1202         unsigned long __flags;                                          \
1203                                                                         \
1204         arch_efi_call_virt_setup();                                     \
1205                                                                         \
1206         __flags = efi_call_virt_save_flags();                           \
1207         arch_efi_call_virt(p, f, args);                                 \
1208         efi_call_virt_check_flags(__flags, __stringify(f));             \
1209                                                                         \
1210         arch_efi_call_virt_teardown();                                  \
1211 })
1212
1213 #define EFI_RANDOM_SEED_SIZE            64U
1214
1215 struct linux_efi_random_seed {
1216         u32     size;
1217         u8      bits[];
1218 };
1219
1220 struct linux_efi_tpm_eventlog {
1221         u32     size;
1222         u32     final_events_preboot_size;
1223         u8      version;
1224         u8      log[];
1225 };
1226
1227 extern int efi_tpm_eventlog_init(void);
1228
1229 struct efi_tcg2_final_events_table {
1230         u64 version;
1231         u64 nr_events;
1232         u8 events[];
1233 };
1234 extern int efi_tpm_final_log_size;
1235
1236 extern unsigned long rci2_table_phys;
1237
1238 /*
1239  * efi_runtime_service() function identifiers.
1240  * "NONE" is used by efi_recover_from_page_fault() to check if the page
1241  * fault happened while executing an efi runtime service.
1242  */
1243 enum efi_rts_ids {
1244         EFI_NONE,
1245         EFI_GET_TIME,
1246         EFI_SET_TIME,
1247         EFI_GET_WAKEUP_TIME,
1248         EFI_SET_WAKEUP_TIME,
1249         EFI_GET_VARIABLE,
1250         EFI_GET_NEXT_VARIABLE,
1251         EFI_SET_VARIABLE,
1252         EFI_QUERY_VARIABLE_INFO,
1253         EFI_GET_NEXT_HIGH_MONO_COUNT,
1254         EFI_RESET_SYSTEM,
1255         EFI_UPDATE_CAPSULE,
1256         EFI_QUERY_CAPSULE_CAPS,
1257 };
1258
1259 /*
1260  * efi_runtime_work:    Details of EFI Runtime Service work
1261  * @arg<1-5>:           EFI Runtime Service function arguments
1262  * @status:             Status of executing EFI Runtime Service
1263  * @efi_rts_id:         EFI Runtime Service function identifier
1264  * @efi_rts_comp:       Struct used for handling completions
1265  */
1266 struct efi_runtime_work {
1267         void *arg1;
1268         void *arg2;
1269         void *arg3;
1270         void *arg4;
1271         void *arg5;
1272         efi_status_t status;
1273         struct work_struct work;
1274         enum efi_rts_ids efi_rts_id;
1275         struct completion efi_rts_comp;
1276 };
1277
1278 extern struct efi_runtime_work efi_rts_work;
1279
1280 /* Workqueue to queue EFI Runtime Services */
1281 extern struct workqueue_struct *efi_rts_wq;
1282
1283 struct linux_efi_memreserve {
1284         int             size;                   // allocated size of the array
1285         atomic_t        count;                  // number of entries used
1286         phys_addr_t     next;                   // pa of next struct instance
1287         struct {
1288                 phys_addr_t     base;
1289                 phys_addr_t     size;
1290         } entry[];
1291 };
1292
1293 #define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1294         / sizeof_field(struct linux_efi_memreserve, entry[0]))
1295
1296 void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size);
1297
1298 char *efi_systab_show_arch(char *str);
1299
1300 /*
1301  * The LINUX_EFI_MOK_VARIABLE_TABLE_GUID config table can be provided
1302  * to the kernel by an EFI boot loader. The table contains a packed
1303  * sequence of these entries, one for each named MOK variable.
1304  * The sequence is terminated by an entry with a completely NULL
1305  * name and 0 data size.
1306  */
1307 struct efi_mokvar_table_entry {
1308         char name[256];
1309         u64 data_size;
1310         u8 data[];
1311 } __attribute((packed));
1312
1313 #ifdef CONFIG_LOAD_UEFI_KEYS
1314 extern void __init efi_mokvar_table_init(void);
1315 extern struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1316                         struct efi_mokvar_table_entry **mokvar_entry);
1317 extern struct efi_mokvar_table_entry *efi_mokvar_entry_find(const char *name);
1318 #else
1319 static inline void efi_mokvar_table_init(void) { }
1320 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1321                         struct efi_mokvar_table_entry **mokvar_entry)
1322 {
1323         return NULL;
1324 }
1325 static inline struct efi_mokvar_table_entry *efi_mokvar_entry_find(
1326                         const char *name)
1327 {
1328         return NULL;
1329 }
1330 #endif
1331
1332 #ifdef CONFIG_SYSFB
1333 extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);
1334 #else
1335 static inline void efifb_setup_from_dmi(struct screen_info *si, const char *opt) { }
1336 #endif
1337
1338 #endif /* _LINUX_EFI_H */