1 #ifndef _LINUX_EFI_H 2 #define _LINUX_EFI_H 3 4 /* 5 * Extensible Firmware Interface 6 * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999 7 * 8 * Copyright (C) 1999 VA Linux Systems 9 * Copyright (C) 1999 Walt Drummond <[email protected]> 10 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co. 11 * David Mosberger-Tang <[email protected]> 12 * Stephane Eranian <[email protected]> 13 */ 14 #include <linux/init.h> 15 #include <linux/string.h> 16 #include <linux/time.h> 17 #include <linux/types.h> 18 #include <linux/proc_fs.h> 19 #include <linux/rtc.h> 20 #include <linux/ioport.h> 21 #include <linux/pfn.h> 22 #include <linux/pstore.h> 23 #include <linux/range.h> 24 #include <linux/reboot.h> 25 #include <linux/uuid.h> 26 #include <linux/screen_info.h> 27 28 #include <asm/page.h> 29 30 #define EFI_SUCCESS 0 31 #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1))) 32 #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1))) 33 #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1))) 34 #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1))) 35 #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1))) 36 #define EFI_NOT_READY ( 6 | (1UL << (BITS_PER_LONG-1))) 37 #define EFI_DEVICE_ERROR ( 7 | (1UL << (BITS_PER_LONG-1))) 38 #define EFI_WRITE_PROTECTED ( 8 | (1UL << (BITS_PER_LONG-1))) 39 #define EFI_OUT_OF_RESOURCES ( 9 | (1UL << (BITS_PER_LONG-1))) 40 #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1))) 41 #define EFI_ABORTED (21 | (1UL << (BITS_PER_LONG-1))) 42 #define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1))) 43 44 typedef unsigned long efi_status_t; 45 typedef u8 efi_bool_t; 46 typedef u16 efi_char16_t; /* UNICODE character */ 47 typedef u64 efi_physical_addr_t; 48 typedef void *efi_handle_t; 49 50 typedef guid_t efi_guid_t; 51 52 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \ 53 GUID_INIT(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) 54 55 /* 56 * Generic EFI table header 57 */ 58 typedef struct { 59 u64 signature; 60 u32 revision; 61 u32 headersize; 62 u32 crc32; 63 u32 reserved; 64 } efi_table_hdr_t; 65 66 /* 67 * Memory map descriptor: 68 */ 69 70 /* Memory types: */ 71 #define EFI_RESERVED_TYPE 0 72 #define EFI_LOADER_CODE 1 73 #define EFI_LOADER_DATA 2 74 #define EFI_BOOT_SERVICES_CODE 3 75 #define EFI_BOOT_SERVICES_DATA 4 76 #define EFI_RUNTIME_SERVICES_CODE 5 77 #define EFI_RUNTIME_SERVICES_DATA 6 78 #define EFI_CONVENTIONAL_MEMORY 7 79 #define EFI_UNUSABLE_MEMORY 8 80 #define EFI_ACPI_RECLAIM_MEMORY 9 81 #define EFI_ACPI_MEMORY_NVS 10 82 #define EFI_MEMORY_MAPPED_IO 11 83 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12 84 #define EFI_PAL_CODE 13 85 #define EFI_PERSISTENT_MEMORY 14 86 #define EFI_MAX_MEMORY_TYPE 15 87 88 /* Attribute values: */ 89 #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */ 90 #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */ 91 #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */ 92 #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */ 93 #define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */ 94 #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */ 95 #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */ 96 #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */ 97 #define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */ 98 #define EFI_MEMORY_MORE_RELIABLE \ 99 ((u64)0x0000000000010000ULL) /* higher reliability */ 100 #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */ 101 #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */ 102 #define EFI_MEMORY_DESCRIPTOR_VERSION 1 103 104 #define EFI_PAGE_SHIFT 12 105 #define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT) 106 #define EFI_PAGES_MAX (U64_MAX >> EFI_PAGE_SHIFT) 107 108 typedef struct { 109 u32 type; 110 u32 pad; 111 u64 phys_addr; 112 u64 virt_addr; 113 u64 num_pages; 114 u64 attribute; 115 } efi_memory_desc_t; 116 117 typedef struct { 118 efi_guid_t guid; 119 u32 headersize; 120 u32 flags; 121 u32 imagesize; 122 } efi_capsule_header_t; 123 124 struct efi_boot_memmap { 125 efi_memory_desc_t **map; 126 unsigned long *map_size; 127 unsigned long *desc_size; 128 u32 *desc_ver; 129 unsigned long *key_ptr; 130 unsigned long *buff_size; 131 }; 132 133 /* 134 * EFI capsule flags 135 */ 136 #define EFI_CAPSULE_PERSIST_ACROSS_RESET 0x00010000 137 #define EFI_CAPSULE_POPULATE_SYSTEM_TABLE 0x00020000 138 #define EFI_CAPSULE_INITIATE_RESET 0x00040000 139 140 struct capsule_info { 141 efi_capsule_header_t header; 142 int reset_type; 143 long index; 144 size_t count; 145 size_t total_size; 146 phys_addr_t *pages; 147 size_t page_bytes_remain; 148 }; 149 150 int __efi_capsule_setup_info(struct capsule_info *cap_info); 151 152 /* 153 * Allocation types for calls to boottime->allocate_pages. 154 */ 155 #define EFI_ALLOCATE_ANY_PAGES 0 156 #define EFI_ALLOCATE_MAX_ADDRESS 1 157 #define EFI_ALLOCATE_ADDRESS 2 158 #define EFI_MAX_ALLOCATE_TYPE 3 159 160 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg); 161 162 /* 163 * Types and defines for Time Services 164 */ 165 #define EFI_TIME_ADJUST_DAYLIGHT 0x1 166 #define EFI_TIME_IN_DAYLIGHT 0x2 167 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff 168 169 typedef struct { 170 u16 year; 171 u8 month; 172 u8 day; 173 u8 hour; 174 u8 minute; 175 u8 second; 176 u8 pad1; 177 u32 nanosecond; 178 s16 timezone; 179 u8 daylight; 180 u8 pad2; 181 } efi_time_t; 182 183 typedef struct { 184 u32 resolution; 185 u32 accuracy; 186 u8 sets_to_zero; 187 } efi_time_cap_t; 188 189 typedef struct { 190 efi_table_hdr_t hdr; 191 u32 raise_tpl; 192 u32 restore_tpl; 193 u32 allocate_pages; 194 u32 free_pages; 195 u32 get_memory_map; 196 u32 allocate_pool; 197 u32 free_pool; 198 u32 create_event; 199 u32 set_timer; 200 u32 wait_for_event; 201 u32 signal_event; 202 u32 close_event; 203 u32 check_event; 204 u32 install_protocol_interface; 205 u32 reinstall_protocol_interface; 206 u32 uninstall_protocol_interface; 207 u32 handle_protocol; 208 u32 __reserved; 209 u32 register_protocol_notify; 210 u32 locate_handle; 211 u32 locate_device_path; 212 u32 install_configuration_table; 213 u32 load_image; 214 u32 start_image; 215 u32 exit; 216 u32 unload_image; 217 u32 exit_boot_services; 218 u32 get_next_monotonic_count; 219 u32 stall; 220 u32 set_watchdog_timer; 221 u32 connect_controller; 222 u32 disconnect_controller; 223 u32 open_protocol; 224 u32 close_protocol; 225 u32 open_protocol_information; 226 u32 protocols_per_handle; 227 u32 locate_handle_buffer; 228 u32 locate_protocol; 229 u32 install_multiple_protocol_interfaces; 230 u32 uninstall_multiple_protocol_interfaces; 231 u32 calculate_crc32; 232 u32 copy_mem; 233 u32 set_mem; 234 u32 create_event_ex; 235 } __packed efi_boot_services_32_t; 236 237 typedef struct { 238 efi_table_hdr_t hdr; 239 u64 raise_tpl; 240 u64 restore_tpl; 241 u64 allocate_pages; 242 u64 free_pages; 243 u64 get_memory_map; 244 u64 allocate_pool; 245 u64 free_pool; 246 u64 create_event; 247 u64 set_timer; 248 u64 wait_for_event; 249 u64 signal_event; 250 u64 close_event; 251 u64 check_event; 252 u64 install_protocol_interface; 253 u64 reinstall_protocol_interface; 254 u64 uninstall_protocol_interface; 255 u64 handle_protocol; 256 u64 __reserved; 257 u64 register_protocol_notify; 258 u64 locate_handle; 259 u64 locate_device_path; 260 u64 install_configuration_table; 261 u64 load_image; 262 u64 start_image; 263 u64 exit; 264 u64 unload_image; 265 u64 exit_boot_services; 266 u64 get_next_monotonic_count; 267 u64 stall; 268 u64 set_watchdog_timer; 269 u64 connect_controller; 270 u64 disconnect_controller; 271 u64 open_protocol; 272 u64 close_protocol; 273 u64 open_protocol_information; 274 u64 protocols_per_handle; 275 u64 locate_handle_buffer; 276 u64 locate_protocol; 277 u64 install_multiple_protocol_interfaces; 278 u64 uninstall_multiple_protocol_interfaces; 279 u64 calculate_crc32; 280 u64 copy_mem; 281 u64 set_mem; 282 u64 create_event_ex; 283 } __packed efi_boot_services_64_t; 284 285 /* 286 * EFI Boot Services table 287 */ 288 typedef struct { 289 efi_table_hdr_t hdr; 290 void *raise_tpl; 291 void *restore_tpl; 292 efi_status_t (*allocate_pages)(int, int, unsigned long, 293 efi_physical_addr_t *); 294 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long); 295 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *, 296 unsigned long *, u32 *); 297 efi_status_t (*allocate_pool)(int, unsigned long, void **); 298 efi_status_t (*free_pool)(void *); 299 void *create_event; 300 void *set_timer; 301 void *wait_for_event; 302 void *signal_event; 303 void *close_event; 304 void *check_event; 305 void *install_protocol_interface; 306 void *reinstall_protocol_interface; 307 void *uninstall_protocol_interface; 308 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **); 309 void *__reserved; 310 void *register_protocol_notify; 311 efi_status_t (*locate_handle)(int, efi_guid_t *, void *, 312 unsigned long *, efi_handle_t *); 313 void *locate_device_path; 314 efi_status_t (*install_configuration_table)(efi_guid_t *, void *); 315 void *load_image; 316 void *start_image; 317 void *exit; 318 void *unload_image; 319 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long); 320 void *get_next_monotonic_count; 321 void *stall; 322 void *set_watchdog_timer; 323 void *connect_controller; 324 void *disconnect_controller; 325 void *open_protocol; 326 void *close_protocol; 327 void *open_protocol_information; 328 void *protocols_per_handle; 329 void *locate_handle_buffer; 330 efi_status_t (*locate_protocol)(efi_guid_t *, void *, void **); 331 void *install_multiple_protocol_interfaces; 332 void *uninstall_multiple_protocol_interfaces; 333 void *calculate_crc32; 334 void *copy_mem; 335 void *set_mem; 336 void *create_event_ex; 337 } efi_boot_services_t; 338 339 typedef enum { 340 EfiPciIoWidthUint8, 341 EfiPciIoWidthUint16, 342 EfiPciIoWidthUint32, 343 EfiPciIoWidthUint64, 344 EfiPciIoWidthFifoUint8, 345 EfiPciIoWidthFifoUint16, 346 EfiPciIoWidthFifoUint32, 347 EfiPciIoWidthFifoUint64, 348 EfiPciIoWidthFillUint8, 349 EfiPciIoWidthFillUint16, 350 EfiPciIoWidthFillUint32, 351 EfiPciIoWidthFillUint64, 352 EfiPciIoWidthMaximum 353 } EFI_PCI_IO_PROTOCOL_WIDTH; 354 355 typedef enum { 356 EfiPciIoAttributeOperationGet, 357 EfiPciIoAttributeOperationSet, 358 EfiPciIoAttributeOperationEnable, 359 EfiPciIoAttributeOperationDisable, 360 EfiPciIoAttributeOperationSupported, 361 EfiPciIoAttributeOperationMaximum 362 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION; 363 364 typedef struct { 365 u32 read; 366 u32 write; 367 } efi_pci_io_protocol_access_32_t; 368 369 typedef struct { 370 u64 read; 371 u64 write; 372 } efi_pci_io_protocol_access_64_t; 373 374 typedef struct { 375 void *read; 376 void *write; 377 } efi_pci_io_protocol_access_t; 378 379 typedef struct { 380 u32 poll_mem; 381 u32 poll_io; 382 efi_pci_io_protocol_access_32_t mem; 383 efi_pci_io_protocol_access_32_t io; 384 efi_pci_io_protocol_access_32_t pci; 385 u32 copy_mem; 386 u32 map; 387 u32 unmap; 388 u32 allocate_buffer; 389 u32 free_buffer; 390 u32 flush; 391 u32 get_location; 392 u32 attributes; 393 u32 get_bar_attributes; 394 u32 set_bar_attributes; 395 uint64_t romsize; 396 void *romimage; 397 } efi_pci_io_protocol_32; 398 399 typedef struct { 400 u64 poll_mem; 401 u64 poll_io; 402 efi_pci_io_protocol_access_64_t mem; 403 efi_pci_io_protocol_access_64_t io; 404 efi_pci_io_protocol_access_64_t pci; 405 u64 copy_mem; 406 u64 map; 407 u64 unmap; 408 u64 allocate_buffer; 409 u64 free_buffer; 410 u64 flush; 411 u64 get_location; 412 u64 attributes; 413 u64 get_bar_attributes; 414 u64 set_bar_attributes; 415 uint64_t romsize; 416 void *romimage; 417 } efi_pci_io_protocol_64; 418 419 typedef struct { 420 void *poll_mem; 421 void *poll_io; 422 efi_pci_io_protocol_access_t mem; 423 efi_pci_io_protocol_access_t io; 424 efi_pci_io_protocol_access_t pci; 425 void *copy_mem; 426 void *map; 427 void *unmap; 428 void *allocate_buffer; 429 void *free_buffer; 430 void *flush; 431 void *get_location; 432 void *attributes; 433 void *get_bar_attributes; 434 void *set_bar_attributes; 435 uint64_t romsize; 436 void *romimage; 437 } efi_pci_io_protocol; 438 439 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001 440 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002 441 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004 442 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008 443 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010 444 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020 445 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040 446 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080 447 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100 448 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200 449 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400 450 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800 451 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 452 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000 453 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000 454 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000 455 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000 456 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000 457 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000 458 459 typedef struct { 460 u32 version; 461 u32 get; 462 u32 set; 463 u32 del; 464 u32 get_all; 465 } apple_properties_protocol_32_t; 466 467 typedef struct { 468 u64 version; 469 u64 get; 470 u64 set; 471 u64 del; 472 u64 get_all; 473 } apple_properties_protocol_64_t; 474 475 /* 476 * Types and defines for EFI ResetSystem 477 */ 478 #define EFI_RESET_COLD 0 479 #define EFI_RESET_WARM 1 480 #define EFI_RESET_SHUTDOWN 2 481 482 /* 483 * EFI Runtime Services table 484 */ 485 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL) 486 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000 487 488 typedef struct { 489 efi_table_hdr_t hdr; 490 u32 get_time; 491 u32 set_time; 492 u32 get_wakeup_time; 493 u32 set_wakeup_time; 494 u32 set_virtual_address_map; 495 u32 convert_pointer; 496 u32 get_variable; 497 u32 get_next_variable; 498 u32 set_variable; 499 u32 get_next_high_mono_count; 500 u32 reset_system; 501 u32 update_capsule; 502 u32 query_capsule_caps; 503 u32 query_variable_info; 504 } efi_runtime_services_32_t; 505 506 typedef struct { 507 efi_table_hdr_t hdr; 508 u64 get_time; 509 u64 set_time; 510 u64 get_wakeup_time; 511 u64 set_wakeup_time; 512 u64 set_virtual_address_map; 513 u64 convert_pointer; 514 u64 get_variable; 515 u64 get_next_variable; 516 u64 set_variable; 517 u64 get_next_high_mono_count; 518 u64 reset_system; 519 u64 update_capsule; 520 u64 query_capsule_caps; 521 u64 query_variable_info; 522 } efi_runtime_services_64_t; 523 524 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc); 525 typedef efi_status_t efi_set_time_t (efi_time_t *tm); 526 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending, 527 efi_time_t *tm); 528 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm); 529 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr, 530 unsigned long *data_size, void *data); 531 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name, 532 efi_guid_t *vendor); 533 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor, 534 u32 attr, unsigned long data_size, 535 void *data); 536 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count); 537 typedef void efi_reset_system_t (int reset_type, efi_status_t status, 538 unsigned long data_size, efi_char16_t *data); 539 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size, 540 unsigned long descriptor_size, 541 u32 descriptor_version, 542 efi_memory_desc_t *virtual_map); 543 typedef efi_status_t efi_query_variable_info_t(u32 attr, 544 u64 *storage_space, 545 u64 *remaining_space, 546 u64 *max_variable_size); 547 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules, 548 unsigned long count, 549 unsigned long sg_list); 550 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules, 551 unsigned long count, 552 u64 *max_size, 553 int *reset_type); 554 typedef efi_status_t efi_query_variable_store_t(u32 attributes, 555 unsigned long size, 556 bool nonblocking); 557 558 typedef struct { 559 efi_table_hdr_t hdr; 560 efi_get_time_t *get_time; 561 efi_set_time_t *set_time; 562 efi_get_wakeup_time_t *get_wakeup_time; 563 efi_set_wakeup_time_t *set_wakeup_time; 564 efi_set_virtual_address_map_t *set_virtual_address_map; 565 void *convert_pointer; 566 efi_get_variable_t *get_variable; 567 efi_get_next_variable_t *get_next_variable; 568 efi_set_variable_t *set_variable; 569 efi_get_next_high_mono_count_t *get_next_high_mono_count; 570 efi_reset_system_t *reset_system; 571 efi_update_capsule_t *update_capsule; 572 efi_query_capsule_caps_t *query_capsule_caps; 573 efi_query_variable_info_t *query_variable_info; 574 } efi_runtime_services_t; 575 576 void efi_native_runtime_setup(void); 577 578 /* 579 * EFI Configuration Table and GUID definitions 580 * 581 * These are all defined in a single line to make them easier to 582 * grep for and to see them at a glance - while still having a 583 * similar structure to the definitions in the spec. 584 * 585 * Here's how they are structured: 586 * 587 * GUID: 12345678-1234-1234-1234-123456789012 588 * Spec: 589 * #define EFI_SOME_PROTOCOL_GUID \ 590 * {0x12345678,0x1234,0x1234,\ 591 * {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}} 592 * Here: 593 * #define SOME_PROTOCOL_GUID EFI_GUID(0x12345678, 0x1234, 0x1234, 0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12) 594 * ^ tabs ^extra space 595 * 596 * Note that the 'extra space' separates the values at the same place 597 * where the UEFI SPEC breaks the line. 598 */ 599 #define NULL_GUID EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) 600 #define MPS_TABLE_GUID EFI_GUID(0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 601 #define ACPI_TABLE_GUID EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 602 #define ACPI_20_TABLE_GUID EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81) 603 #define SMBIOS_TABLE_GUID EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 604 #define SMBIOS3_TABLE_GUID EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c, 0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94) 605 #define SAL_SYSTEM_TABLE_GUID EFI_GUID(0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 606 #define HCDP_TABLE_GUID EFI_GUID(0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98) 607 #define UGA_IO_PROTOCOL_GUID EFI_GUID(0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0x0b, 0x07, 0xa2) 608 #define EFI_GLOBAL_VARIABLE_GUID EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c) 609 #define UV_SYSTEM_TABLE_GUID EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93) 610 #define LINUX_EFI_CRASH_GUID EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0) 611 #define LOADED_IMAGE_PROTOCOL_GUID EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 612 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a) 613 #define EFI_UGA_PROTOCOL_GUID EFI_GUID(0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39) 614 #define EFI_PCI_IO_PROTOCOL_GUID EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a) 615 #define EFI_FILE_INFO_ID EFI_GUID(0x09576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 616 #define EFI_SYSTEM_RESOURCE_TABLE_GUID EFI_GUID(0xb122a263, 0x3661, 0x4f68, 0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80) 617 #define EFI_FILE_SYSTEM_GUID EFI_GUID(0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 618 #define DEVICE_TREE_GUID EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0) 619 #define EFI_PROPERTIES_TABLE_GUID EFI_GUID(0x880aaca3, 0x4adc, 0x4a04, 0x90, 0x79, 0xb7, 0x47, 0x34, 0x08, 0x25, 0xe5) 620 #define EFI_RNG_PROTOCOL_GUID EFI_GUID(0x3152bca5, 0xeade, 0x433d, 0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44) 621 #define EFI_RNG_ALGORITHM_RAW EFI_GUID(0xe43176d7, 0xb6e8, 0x4827, 0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61) 622 #define EFI_MEMORY_ATTRIBUTES_TABLE_GUID EFI_GUID(0xdcfa911d, 0x26eb, 0x469f, 0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20) 623 #define EFI_CONSOLE_OUT_DEVICE_GUID EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4, 0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 624 #define APPLE_PROPERTIES_PROTOCOL_GUID EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb, 0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0) 625 626 #define EFI_IMAGE_SECURITY_DATABASE_GUID EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f) 627 #define EFI_SHIM_LOCK_GUID EFI_GUID(0x605dab50, 0xe046, 0x4300, 0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23) 628 629 /* 630 * This GUID is used to pass to the kernel proper the struct screen_info 631 * structure that was populated by the stub based on the GOP protocol instance 632 * associated with ConOut 633 */ 634 #define LINUX_EFI_ARM_SCREEN_INFO_TABLE_GUID EFI_GUID(0xe03fc20a, 0x85dc, 0x406e, 0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95) 635 #define LINUX_EFI_LOADER_ENTRY_GUID EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf, 0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f) 636 #define LINUX_EFI_RANDOM_SEED_TABLE_GUID EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2, 0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b) 637 638 typedef struct { 639 efi_guid_t guid; 640 u64 table; 641 } efi_config_table_64_t; 642 643 typedef struct { 644 efi_guid_t guid; 645 u32 table; 646 } efi_config_table_32_t; 647 648 typedef struct { 649 efi_guid_t guid; 650 unsigned long table; 651 } efi_config_table_t; 652 653 typedef struct { 654 efi_guid_t guid; 655 const char *name; 656 unsigned long *ptr; 657 } efi_config_table_type_t; 658 659 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL) 660 661 #define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30)) 662 #define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20)) 663 #define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10)) 664 #define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00)) 665 #define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10)) 666 #define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02)) 667 668 typedef struct { 669 efi_table_hdr_t hdr; 670 u64 fw_vendor; /* physical addr of CHAR16 vendor string */ 671 u32 fw_revision; 672 u32 __pad1; 673 u64 con_in_handle; 674 u64 con_in; 675 u64 con_out_handle; 676 u64 con_out; 677 u64 stderr_handle; 678 u64 stderr; 679 u64 runtime; 680 u64 boottime; 681 u32 nr_tables; 682 u32 __pad2; 683 u64 tables; 684 } efi_system_table_64_t; 685 686 typedef struct { 687 efi_table_hdr_t hdr; 688 u32 fw_vendor; /* physical addr of CHAR16 vendor string */ 689 u32 fw_revision; 690 u32 con_in_handle; 691 u32 con_in; 692 u32 con_out_handle; 693 u32 con_out; 694 u32 stderr_handle; 695 u32 stderr; 696 u32 runtime; 697 u32 boottime; 698 u32 nr_tables; 699 u32 tables; 700 } efi_system_table_32_t; 701 702 typedef struct { 703 efi_table_hdr_t hdr; 704 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */ 705 u32 fw_revision; 706 unsigned long con_in_handle; 707 unsigned long con_in; 708 unsigned long con_out_handle; 709 unsigned long con_out; 710 unsigned long stderr_handle; 711 unsigned long stderr; 712 efi_runtime_services_t *runtime; 713 efi_boot_services_t *boottime; 714 unsigned long nr_tables; 715 unsigned long tables; 716 } efi_system_table_t; 717 718 /* 719 * Architecture independent structure for describing a memory map for the 720 * benefit of efi_memmap_init_early(), saving us the need to pass four 721 * parameters. 722 */ 723 struct efi_memory_map_data { 724 phys_addr_t phys_map; 725 unsigned long size; 726 unsigned long desc_version; 727 unsigned long desc_size; 728 }; 729 730 struct efi_memory_map { 731 phys_addr_t phys_map; 732 void *map; 733 void *map_end; 734 int nr_map; 735 unsigned long desc_version; 736 unsigned long desc_size; 737 bool late; 738 }; 739 740 struct efi_mem_range { 741 struct range range; 742 u64 attribute; 743 }; 744 745 struct efi_fdt_params { 746 u64 system_table; 747 u64 mmap; 748 u32 mmap_size; 749 u32 desc_size; 750 u32 desc_ver; 751 }; 752 753 typedef struct { 754 u32 revision; 755 u32 parent_handle; 756 u32 system_table; 757 u32 device_handle; 758 u32 file_path; 759 u32 reserved; 760 u32 load_options_size; 761 u32 load_options; 762 u32 image_base; 763 __aligned_u64 image_size; 764 unsigned int image_code_type; 765 unsigned int image_data_type; 766 unsigned long unload; 767 } efi_loaded_image_32_t; 768 769 typedef struct { 770 u32 revision; 771 u64 parent_handle; 772 u64 system_table; 773 u64 device_handle; 774 u64 file_path; 775 u64 reserved; 776 u32 load_options_size; 777 u64 load_options; 778 u64 image_base; 779 __aligned_u64 image_size; 780 unsigned int image_code_type; 781 unsigned int image_data_type; 782 unsigned long unload; 783 } efi_loaded_image_64_t; 784 785 typedef struct { 786 u32 revision; 787 void *parent_handle; 788 efi_system_table_t *system_table; 789 void *device_handle; 790 void *file_path; 791 void *reserved; 792 u32 load_options_size; 793 void *load_options; 794 void *image_base; 795 __aligned_u64 image_size; 796 unsigned int image_code_type; 797 unsigned int image_data_type; 798 unsigned long unload; 799 } efi_loaded_image_t; 800 801 802 typedef struct { 803 u64 size; 804 u64 file_size; 805 u64 phys_size; 806 efi_time_t create_time; 807 efi_time_t last_access_time; 808 efi_time_t modification_time; 809 __aligned_u64 attribute; 810 efi_char16_t filename[1]; 811 } efi_file_info_t; 812 813 typedef struct { 814 u64 revision; 815 u32 open; 816 u32 close; 817 u32 delete; 818 u32 read; 819 u32 write; 820 u32 get_position; 821 u32 set_position; 822 u32 get_info; 823 u32 set_info; 824 u32 flush; 825 } efi_file_handle_32_t; 826 827 typedef struct { 828 u64 revision; 829 u64 open; 830 u64 close; 831 u64 delete; 832 u64 read; 833 u64 write; 834 u64 get_position; 835 u64 set_position; 836 u64 get_info; 837 u64 set_info; 838 u64 flush; 839 } efi_file_handle_64_t; 840 841 typedef struct _efi_file_handle { 842 u64 revision; 843 efi_status_t (*open)(struct _efi_file_handle *, 844 struct _efi_file_handle **, 845 efi_char16_t *, u64, u64); 846 efi_status_t (*close)(struct _efi_file_handle *); 847 void *delete; 848 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *, 849 void *); 850 void *write; 851 void *get_position; 852 void *set_position; 853 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *, 854 unsigned long *, void *); 855 void *set_info; 856 void *flush; 857 } efi_file_handle_t; 858 859 typedef struct _efi_file_io_interface { 860 u64 revision; 861 int (*open_volume)(struct _efi_file_io_interface *, 862 efi_file_handle_t **); 863 } efi_file_io_interface_t; 864 865 #define EFI_FILE_MODE_READ 0x0000000000000001 866 #define EFI_FILE_MODE_WRITE 0x0000000000000002 867 #define EFI_FILE_MODE_CREATE 0x8000000000000000 868 869 typedef struct { 870 u32 version; 871 u32 length; 872 u64 memory_protection_attribute; 873 } efi_properties_table_t; 874 875 #define EFI_PROPERTIES_TABLE_VERSION 0x00010000 876 #define EFI_PROPERTIES_RUNTIME_MEMORY_PROTECTION_NON_EXECUTABLE_PE_DATA 0x1 877 878 #define EFI_INVALID_TABLE_ADDR (~0UL) 879 880 typedef struct { 881 u32 version; 882 u32 num_entries; 883 u32 desc_size; 884 u32 reserved; 885 efi_memory_desc_t entry[0]; 886 } efi_memory_attributes_table_t; 887 888 /* 889 * All runtime access to EFI goes through this structure: 890 */ 891 extern struct efi { 892 efi_system_table_t *systab; /* EFI system table */ 893 unsigned int runtime_version; /* Runtime services version */ 894 unsigned long mps; /* MPS table */ 895 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */ 896 unsigned long acpi20; /* ACPI table (ACPI 2.0) */ 897 unsigned long smbios; /* SMBIOS table (32 bit entry point) */ 898 unsigned long smbios3; /* SMBIOS table (64 bit entry point) */ 899 unsigned long sal_systab; /* SAL system table */ 900 unsigned long boot_info; /* boot info table */ 901 unsigned long hcdp; /* HCDP table */ 902 unsigned long uga; /* UGA table */ 903 unsigned long uv_systab; /* UV system table */ 904 unsigned long fw_vendor; /* fw_vendor */ 905 unsigned long runtime; /* runtime table */ 906 unsigned long config_table; /* config tables */ 907 unsigned long esrt; /* ESRT table */ 908 unsigned long properties_table; /* properties table */ 909 unsigned long mem_attr_table; /* memory attributes table */ 910 unsigned long rng_seed; /* UEFI firmware random seed */ 911 efi_get_time_t *get_time; 912 efi_set_time_t *set_time; 913 efi_get_wakeup_time_t *get_wakeup_time; 914 efi_set_wakeup_time_t *set_wakeup_time; 915 efi_get_variable_t *get_variable; 916 efi_get_next_variable_t *get_next_variable; 917 efi_set_variable_t *set_variable; 918 efi_set_variable_t *set_variable_nonblocking; 919 efi_query_variable_info_t *query_variable_info; 920 efi_query_variable_info_t *query_variable_info_nonblocking; 921 efi_update_capsule_t *update_capsule; 922 efi_query_capsule_caps_t *query_capsule_caps; 923 efi_get_next_high_mono_count_t *get_next_high_mono_count; 924 efi_reset_system_t *reset_system; 925 efi_set_virtual_address_map_t *set_virtual_address_map; 926 struct efi_memory_map memmap; 927 unsigned long flags; 928 } efi; 929 930 static inline int 931 efi_guidcmp (efi_guid_t left, efi_guid_t right) 932 { 933 return memcmp(&left, &right, sizeof (efi_guid_t)); 934 } 935 936 static inline char * 937 efi_guid_to_str(efi_guid_t *guid, char *out) 938 { 939 sprintf(out, "%pUl", guid->b); 940 return out; 941 } 942 943 extern void efi_init (void); 944 extern void *efi_get_pal_addr (void); 945 extern void efi_map_pal_code (void); 946 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg); 947 extern void efi_gettimeofday (struct timespec64 *ts); 948 extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */ 949 #ifdef CONFIG_X86 950 extern void efi_late_init(void); 951 extern void efi_free_boot_services(void); 952 extern efi_status_t efi_query_variable_store(u32 attributes, 953 unsigned long size, 954 bool nonblocking); 955 extern void efi_find_mirror(void); 956 #else 957 static inline void efi_late_init(void) {} 958 static inline void efi_free_boot_services(void) {} 959 960 static inline efi_status_t efi_query_variable_store(u32 attributes, 961 unsigned long size, 962 bool nonblocking) 963 { 964 return EFI_SUCCESS; 965 } 966 #endif 967 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr); 968 969 extern phys_addr_t __init efi_memmap_alloc(unsigned int num_entries); 970 extern int __init efi_memmap_init_early(struct efi_memory_map_data *data); 971 extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size); 972 extern void __init efi_memmap_unmap(void); 973 extern int __init efi_memmap_install(phys_addr_t addr, unsigned int nr_map); 974 extern int __init efi_memmap_split_count(efi_memory_desc_t *md, 975 struct range *range); 976 extern void __init efi_memmap_insert(struct efi_memory_map *old_memmap, 977 void *buf, struct efi_mem_range *mem); 978 979 extern int efi_config_init(efi_config_table_type_t *arch_tables); 980 #ifdef CONFIG_EFI_ESRT 981 extern void __init efi_esrt_init(void); 982 #else 983 static inline void efi_esrt_init(void) { } 984 #endif 985 extern int efi_config_parse_tables(void *config_tables, int count, int sz, 986 efi_config_table_type_t *arch_tables); 987 extern u64 efi_get_iobase (void); 988 extern int efi_mem_type(unsigned long phys_addr); 989 extern u64 efi_mem_attributes (unsigned long phys_addr); 990 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size); 991 extern int __init efi_uart_console_only (void); 992 extern u64 efi_mem_desc_end(efi_memory_desc_t *md); 993 extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md); 994 extern void efi_mem_reserve(phys_addr_t addr, u64 size); 995 extern void efi_initialize_iomem_resources(struct resource *code_resource, 996 struct resource *data_resource, struct resource *bss_resource); 997 extern void efi_reserve_boot_services(void); 998 extern int efi_get_fdt_params(struct efi_fdt_params *params); 999 extern struct kobject *efi_kobj; 1000 1001 extern int efi_reboot_quirk_mode; 1002 extern bool efi_poweroff_required(void); 1003 1004 #ifdef CONFIG_EFI_FAKE_MEMMAP 1005 extern void __init efi_fake_memmap(void); 1006 #else 1007 static inline void efi_fake_memmap(void) { } 1008 #endif 1009 1010 /* 1011 * efi_memattr_perm_setter - arch specific callback function passed into 1012 * efi_memattr_apply_permissions() that updates the 1013 * mapping permissions described by the second 1014 * argument in the page tables referred to by the 1015 * first argument. 1016 */ 1017 typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *); 1018 1019 extern int efi_memattr_init(void); 1020 extern int efi_memattr_apply_permissions(struct mm_struct *mm, 1021 efi_memattr_perm_setter fn); 1022 1023 /* 1024 * efi_early_memdesc_ptr - get the n-th EFI memmap descriptor 1025 * @map: the start of efi memmap 1026 * @desc_size: the size of space for each EFI memmap descriptor 1027 * @n: the index of efi memmap descriptor 1028 * 1029 * EFI boot service provides the GetMemoryMap() function to get a copy of the 1030 * current memory map which is an array of memory descriptors, each of 1031 * which describes a contiguous block of memory. It also gets the size of the 1032 * map, and the size of each descriptor, etc. 1033 * 1034 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of 1035 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t), 1036 * since efi_memory_memdesc_t may be extended in the future. Thus the OS 1037 * MUST use the returned size of the descriptor to find the start of each 1038 * efi_memory_memdesc_t in the memory map array. This should only be used 1039 * during bootup since for_each_efi_memory_desc_xxx() is available after the 1040 * kernel initializes the EFI subsystem to set up struct efi_memory_map. 1041 */ 1042 #define efi_early_memdesc_ptr(map, desc_size, n) \ 1043 (efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size))) 1044 1045 /* Iterate through an efi_memory_map */ 1046 #define for_each_efi_memory_desc_in_map(m, md) \ 1047 for ((md) = (m)->map; \ 1048 (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end; \ 1049 (md) = (void *)(md) + (m)->desc_size) 1050 1051 /** 1052 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap 1053 * @md: the efi_memory_desc_t * iterator 1054 * 1055 * Once the loop finishes @md must not be accessed. 1056 */ 1057 #define for_each_efi_memory_desc(md) \ 1058 for_each_efi_memory_desc_in_map(&efi.memmap, md) 1059 1060 /* 1061 * Format an EFI memory descriptor's type and attributes to a user-provided 1062 * character buffer, as per snprintf(), and return the buffer. 1063 */ 1064 char * __init efi_md_typeattr_format(char *buf, size_t size, 1065 const efi_memory_desc_t *md); 1066 1067 /** 1068 * efi_range_is_wc - check the WC bit on an address range 1069 * @start: starting kvirt address 1070 * @len: length of range 1071 * 1072 * Consult the EFI memory map and make sure it's ok to set this range WC. 1073 * Returns true or false. 1074 */ 1075 static inline int efi_range_is_wc(unsigned long start, unsigned long len) 1076 { 1077 unsigned long i; 1078 1079 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) { 1080 unsigned long paddr = __pa(start + i); 1081 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC)) 1082 return 0; 1083 } 1084 /* The range checked out */ 1085 return 1; 1086 } 1087 1088 #ifdef CONFIG_EFI_PCDP 1089 extern int __init efi_setup_pcdp_console(char *); 1090 #endif 1091 1092 /* 1093 * We play games with efi_enabled so that the compiler will, if 1094 * possible, remove EFI-related code altogether. 1095 */ 1096 #define EFI_BOOT 0 /* Were we booted from EFI? */ 1097 #define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */ 1098 #define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */ 1099 #define EFI_MEMMAP 4 /* Can we use EFI memory map? */ 1100 #define EFI_64BIT 5 /* Is the firmware 64-bit? */ 1101 #define EFI_PARAVIRT 6 /* Access is via a paravirt interface */ 1102 #define EFI_ARCH_1 7 /* First arch-specific bit */ 1103 #define EFI_DBG 8 /* Print additional debug info at runtime */ 1104 #define EFI_NX_PE_DATA 9 /* Can runtime data regions be mapped non-executable? */ 1105 #define EFI_MEM_ATTR 10 /* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */ 1106 1107 #ifdef CONFIG_EFI 1108 /* 1109 * Test whether the above EFI_* bits are enabled. 1110 */ 1111 static inline bool efi_enabled(int feature) 1112 { 1113 return test_bit(feature, &efi.flags) != 0; 1114 } 1115 extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused); 1116 1117 extern bool efi_is_table_address(unsigned long phys_addr); 1118 #else 1119 static inline bool efi_enabled(int feature) 1120 { 1121 return false; 1122 } 1123 static inline void 1124 efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {} 1125 1126 static inline bool 1127 efi_capsule_pending(int *reset_type) 1128 { 1129 return false; 1130 } 1131 1132 static inline bool efi_is_table_address(unsigned long phys_addr) 1133 { 1134 return false; 1135 } 1136 #endif 1137 1138 extern int efi_status_to_err(efi_status_t status); 1139 1140 /* 1141 * Variable Attributes 1142 */ 1143 #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001 1144 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002 1145 #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004 1146 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008 1147 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010 1148 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020 1149 #define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040 1150 1151 #define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \ 1152 EFI_VARIABLE_BOOTSERVICE_ACCESS | \ 1153 EFI_VARIABLE_RUNTIME_ACCESS | \ 1154 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \ 1155 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \ 1156 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \ 1157 EFI_VARIABLE_APPEND_WRITE) 1158 /* 1159 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")) 1160 * not including trailing NUL 1161 */ 1162 #define EFI_VARIABLE_GUID_LEN UUID_STRING_LEN 1163 1164 /* 1165 * The type of search to perform when calling boottime->locate_handle 1166 */ 1167 #define EFI_LOCATE_ALL_HANDLES 0 1168 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1 1169 #define EFI_LOCATE_BY_PROTOCOL 2 1170 1171 /* 1172 * EFI Device Path information 1173 */ 1174 #define EFI_DEV_HW 0x01 1175 #define EFI_DEV_PCI 1 1176 #define EFI_DEV_PCCARD 2 1177 #define EFI_DEV_MEM_MAPPED 3 1178 #define EFI_DEV_VENDOR 4 1179 #define EFI_DEV_CONTROLLER 5 1180 #define EFI_DEV_ACPI 0x02 1181 #define EFI_DEV_BASIC_ACPI 1 1182 #define EFI_DEV_EXPANDED_ACPI 2 1183 #define EFI_DEV_MSG 0x03 1184 #define EFI_DEV_MSG_ATAPI 1 1185 #define EFI_DEV_MSG_SCSI 2 1186 #define EFI_DEV_MSG_FC 3 1187 #define EFI_DEV_MSG_1394 4 1188 #define EFI_DEV_MSG_USB 5 1189 #define EFI_DEV_MSG_USB_CLASS 15 1190 #define EFI_DEV_MSG_I20 6 1191 #define EFI_DEV_MSG_MAC 11 1192 #define EFI_DEV_MSG_IPV4 12 1193 #define EFI_DEV_MSG_IPV6 13 1194 #define EFI_DEV_MSG_INFINIBAND 9 1195 #define EFI_DEV_MSG_UART 14 1196 #define EFI_DEV_MSG_VENDOR 10 1197 #define EFI_DEV_MEDIA 0x04 1198 #define EFI_DEV_MEDIA_HARD_DRIVE 1 1199 #define EFI_DEV_MEDIA_CDROM 2 1200 #define EFI_DEV_MEDIA_VENDOR 3 1201 #define EFI_DEV_MEDIA_FILE 4 1202 #define EFI_DEV_MEDIA_PROTOCOL 5 1203 #define EFI_DEV_BIOS_BOOT 0x05 1204 #define EFI_DEV_END_PATH 0x7F 1205 #define EFI_DEV_END_PATH2 0xFF 1206 #define EFI_DEV_END_INSTANCE 0x01 1207 #define EFI_DEV_END_ENTIRE 0xFF 1208 1209 struct efi_generic_dev_path { 1210 u8 type; 1211 u8 sub_type; 1212 u16 length; 1213 } __attribute ((packed)); 1214 1215 struct efi_dev_path { 1216 u8 type; /* can be replaced with unnamed */ 1217 u8 sub_type; /* struct efi_generic_dev_path; */ 1218 u16 length; /* once we've moved to -std=c11 */ 1219 union { 1220 struct { 1221 u32 hid; 1222 u32 uid; 1223 } acpi; 1224 struct { 1225 u8 fn; 1226 u8 dev; 1227 } pci; 1228 }; 1229 } __attribute ((packed)); 1230 1231 #if IS_ENABLED(CONFIG_EFI_DEV_PATH_PARSER) 1232 struct device *efi_get_device_by_path(struct efi_dev_path **node, size_t *len); 1233 #endif 1234 1235 static inline void memrange_efi_to_native(u64 *addr, u64 *npages) 1236 { 1237 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr); 1238 *addr &= PAGE_MASK; 1239 } 1240 1241 /* 1242 * EFI Variable support. 1243 * 1244 * Different firmware drivers can expose their EFI-like variables using 1245 * the following. 1246 */ 1247 1248 struct efivar_operations { 1249 efi_get_variable_t *get_variable; 1250 efi_get_next_variable_t *get_next_variable; 1251 efi_set_variable_t *set_variable; 1252 efi_set_variable_t *set_variable_nonblocking; 1253 efi_query_variable_store_t *query_variable_store; 1254 }; 1255 1256 struct efivars { 1257 struct kset *kset; 1258 struct kobject *kobject; 1259 const struct efivar_operations *ops; 1260 }; 1261 1262 /* 1263 * The maximum size of VariableName + Data = 1024 1264 * Therefore, it's reasonable to save that much 1265 * space in each part of the structure, 1266 * and we use a page for reading/writing. 1267 */ 1268 1269 #define EFI_VAR_NAME_LEN 1024 1270 1271 struct efi_variable { 1272 efi_char16_t VariableName[EFI_VAR_NAME_LEN/sizeof(efi_char16_t)]; 1273 efi_guid_t VendorGuid; 1274 unsigned long DataSize; 1275 __u8 Data[1024]; 1276 efi_status_t Status; 1277 __u32 Attributes; 1278 } __attribute__((packed)); 1279 1280 struct efivar_entry { 1281 struct efi_variable var; 1282 struct list_head list; 1283 struct kobject kobj; 1284 bool scanning; 1285 bool deleting; 1286 }; 1287 1288 typedef struct { 1289 u32 reset; 1290 u32 output_string; 1291 u32 test_string; 1292 } efi_simple_text_output_protocol_32_t; 1293 1294 typedef struct { 1295 u64 reset; 1296 u64 output_string; 1297 u64 test_string; 1298 } efi_simple_text_output_protocol_64_t; 1299 1300 struct efi_simple_text_output_protocol { 1301 void *reset; 1302 efi_status_t (*output_string)(void *, void *); 1303 void *test_string; 1304 }; 1305 1306 #define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0 1307 #define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1 1308 #define PIXEL_BIT_MASK 2 1309 #define PIXEL_BLT_ONLY 3 1310 #define PIXEL_FORMAT_MAX 4 1311 1312 struct efi_pixel_bitmask { 1313 u32 red_mask; 1314 u32 green_mask; 1315 u32 blue_mask; 1316 u32 reserved_mask; 1317 }; 1318 1319 struct efi_graphics_output_mode_info { 1320 u32 version; 1321 u32 horizontal_resolution; 1322 u32 vertical_resolution; 1323 int pixel_format; 1324 struct efi_pixel_bitmask pixel_information; 1325 u32 pixels_per_scan_line; 1326 } __packed; 1327 1328 struct efi_graphics_output_protocol_mode_32 { 1329 u32 max_mode; 1330 u32 mode; 1331 u32 info; 1332 u32 size_of_info; 1333 u64 frame_buffer_base; 1334 u32 frame_buffer_size; 1335 } __packed; 1336 1337 struct efi_graphics_output_protocol_mode_64 { 1338 u32 max_mode; 1339 u32 mode; 1340 u64 info; 1341 u64 size_of_info; 1342 u64 frame_buffer_base; 1343 u64 frame_buffer_size; 1344 } __packed; 1345 1346 struct efi_graphics_output_protocol_mode { 1347 u32 max_mode; 1348 u32 mode; 1349 unsigned long info; 1350 unsigned long size_of_info; 1351 u64 frame_buffer_base; 1352 unsigned long frame_buffer_size; 1353 } __packed; 1354 1355 struct efi_graphics_output_protocol_32 { 1356 u32 query_mode; 1357 u32 set_mode; 1358 u32 blt; 1359 u32 mode; 1360 }; 1361 1362 struct efi_graphics_output_protocol_64 { 1363 u64 query_mode; 1364 u64 set_mode; 1365 u64 blt; 1366 u64 mode; 1367 }; 1368 1369 struct efi_graphics_output_protocol { 1370 unsigned long query_mode; 1371 unsigned long set_mode; 1372 unsigned long blt; 1373 struct efi_graphics_output_protocol_mode *mode; 1374 }; 1375 1376 typedef efi_status_t (*efi_graphics_output_protocol_query_mode)( 1377 struct efi_graphics_output_protocol *, u32, unsigned long *, 1378 struct efi_graphics_output_mode_info **); 1379 1380 extern struct list_head efivar_sysfs_list; 1381 1382 static inline void 1383 efivar_unregister(struct efivar_entry *var) 1384 { 1385 kobject_put(&var->kobj); 1386 } 1387 1388 int efivars_register(struct efivars *efivars, 1389 const struct efivar_operations *ops, 1390 struct kobject *kobject); 1391 int efivars_unregister(struct efivars *efivars); 1392 struct kobject *efivars_kobject(void); 1393 1394 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *), 1395 void *data, bool duplicates, struct list_head *head); 1396 1397 int efivar_entry_add(struct efivar_entry *entry, struct list_head *head); 1398 int efivar_entry_remove(struct efivar_entry *entry); 1399 1400 int __efivar_entry_delete(struct efivar_entry *entry); 1401 int efivar_entry_delete(struct efivar_entry *entry); 1402 1403 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size); 1404 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes, 1405 unsigned long *size, void *data); 1406 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes, 1407 unsigned long *size, void *data); 1408 int efivar_entry_set(struct efivar_entry *entry, u32 attributes, 1409 unsigned long size, void *data, struct list_head *head); 1410 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes, 1411 unsigned long *size, void *data, bool *set); 1412 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes, 1413 bool block, unsigned long size, void *data); 1414 1415 int efivar_entry_iter_begin(void); 1416 void efivar_entry_iter_end(void); 1417 1418 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *), 1419 struct list_head *head, void *data, 1420 struct efivar_entry **prev); 1421 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *), 1422 struct list_head *head, void *data); 1423 1424 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid, 1425 struct list_head *head, bool remove); 1426 1427 bool efivar_validate(efi_guid_t vendor, efi_char16_t *var_name, u8 *data, 1428 unsigned long data_size); 1429 bool efivar_variable_is_removable(efi_guid_t vendor, const char *name, 1430 size_t len); 1431 1432 extern struct work_struct efivar_work; 1433 void efivar_run_worker(void); 1434 1435 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE) 1436 int efivars_sysfs_init(void); 1437 1438 #define EFIVARS_DATA_SIZE_MAX 1024 1439 1440 #endif /* CONFIG_EFI_VARS */ 1441 extern bool efi_capsule_pending(int *reset_type); 1442 1443 extern int efi_capsule_supported(efi_guid_t guid, u32 flags, 1444 size_t size, int *reset); 1445 1446 extern int efi_capsule_update(efi_capsule_header_t *capsule, 1447 phys_addr_t *pages); 1448 1449 #ifdef CONFIG_EFI_RUNTIME_MAP 1450 int efi_runtime_map_init(struct kobject *); 1451 int efi_get_runtime_map_size(void); 1452 int efi_get_runtime_map_desc_size(void); 1453 int efi_runtime_map_copy(void *buf, size_t bufsz); 1454 #else 1455 static inline int efi_runtime_map_init(struct kobject *kobj) 1456 { 1457 return 0; 1458 } 1459 1460 static inline int efi_get_runtime_map_size(void) 1461 { 1462 return 0; 1463 } 1464 1465 static inline int efi_get_runtime_map_desc_size(void) 1466 { 1467 return 0; 1468 } 1469 1470 static inline int efi_runtime_map_copy(void *buf, size_t bufsz) 1471 { 1472 return 0; 1473 } 1474 1475 #endif 1476 1477 /* prototypes shared between arch specific and generic stub code */ 1478 1479 void efi_printk(efi_system_table_t *sys_table_arg, char *str); 1480 1481 void efi_free(efi_system_table_t *sys_table_arg, unsigned long size, 1482 unsigned long addr); 1483 1484 char *efi_convert_cmdline(efi_system_table_t *sys_table_arg, 1485 efi_loaded_image_t *image, int *cmd_line_len); 1486 1487 efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg, 1488 struct efi_boot_memmap *map); 1489 1490 efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg, 1491 unsigned long size, unsigned long align, 1492 unsigned long *addr); 1493 1494 efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg, 1495 unsigned long size, unsigned long align, 1496 unsigned long *addr, unsigned long max); 1497 1498 efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg, 1499 unsigned long *image_addr, 1500 unsigned long image_size, 1501 unsigned long alloc_size, 1502 unsigned long preferred_addr, 1503 unsigned long alignment); 1504 1505 efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg, 1506 efi_loaded_image_t *image, 1507 char *cmd_line, char *option_string, 1508 unsigned long max_addr, 1509 unsigned long *load_addr, 1510 unsigned long *load_size); 1511 1512 efi_status_t efi_parse_options(char const *cmdline); 1513 1514 efi_status_t efi_setup_gop(efi_system_table_t *sys_table_arg, 1515 struct screen_info *si, efi_guid_t *proto, 1516 unsigned long size); 1517 1518 bool efi_runtime_disabled(void); 1519 extern void efi_call_virt_check_flags(unsigned long flags, const char *call); 1520 1521 enum efi_secureboot_mode { 1522 efi_secureboot_mode_unset, 1523 efi_secureboot_mode_unknown, 1524 efi_secureboot_mode_disabled, 1525 efi_secureboot_mode_enabled, 1526 }; 1527 enum efi_secureboot_mode efi_get_secureboot(efi_system_table_t *sys_table); 1528 1529 #ifdef CONFIG_RESET_ATTACK_MITIGATION 1530 void efi_enable_reset_attack_mitigation(efi_system_table_t *sys_table_arg); 1531 #else 1532 static inline void 1533 efi_enable_reset_attack_mitigation(efi_system_table_t *sys_table_arg) { } 1534 #endif 1535 1536 /* 1537 * Arch code can implement the following three template macros, avoiding 1538 * reptition for the void/non-void return cases of {__,}efi_call_virt(): 1539 * 1540 * * arch_efi_call_virt_setup() 1541 * 1542 * Sets up the environment for the call (e.g. switching page tables, 1543 * allowing kernel-mode use of floating point, if required). 1544 * 1545 * * arch_efi_call_virt() 1546 * 1547 * Performs the call. The last expression in the macro must be the call 1548 * itself, allowing the logic to be shared by the void and non-void 1549 * cases. 1550 * 1551 * * arch_efi_call_virt_teardown() 1552 * 1553 * Restores the usual kernel environment once the call has returned. 1554 */ 1555 1556 #define efi_call_virt_pointer(p, f, args...) \ 1557 ({ \ 1558 efi_status_t __s; \ 1559 unsigned long __flags; \ 1560 \ 1561 arch_efi_call_virt_setup(); \ 1562 \ 1563 local_save_flags(__flags); \ 1564 __s = arch_efi_call_virt(p, f, args); \ 1565 efi_call_virt_check_flags(__flags, __stringify(f)); \ 1566 \ 1567 arch_efi_call_virt_teardown(); \ 1568 \ 1569 __s; \ 1570 }) 1571 1572 #define __efi_call_virt_pointer(p, f, args...) \ 1573 ({ \ 1574 unsigned long __flags; \ 1575 \ 1576 arch_efi_call_virt_setup(); \ 1577 \ 1578 local_save_flags(__flags); \ 1579 arch_efi_call_virt(p, f, args); \ 1580 efi_call_virt_check_flags(__flags, __stringify(f)); \ 1581 \ 1582 arch_efi_call_virt_teardown(); \ 1583 }) 1584 1585 typedef efi_status_t (*efi_exit_boot_map_processing)( 1586 efi_system_table_t *sys_table_arg, 1587 struct efi_boot_memmap *map, 1588 void *priv); 1589 1590 efi_status_t efi_exit_boot_services(efi_system_table_t *sys_table, 1591 void *handle, 1592 struct efi_boot_memmap *map, 1593 void *priv, 1594 efi_exit_boot_map_processing priv_func); 1595 1596 #define EFI_RANDOM_SEED_SIZE 64U 1597 1598 struct linux_efi_random_seed { 1599 u32 size; 1600 u8 bits[]; 1601 }; 1602 1603 #endif /* _LINUX_EFI_H */ 1604