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