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