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