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