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