1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Extensible Firmware Interface 4 * Based on 'Extensible Firmware Interface Specification' version 0.9, 5 * April 30, 1999 6 * 7 * Copyright (C) 1999 VA Linux Systems 8 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com> 9 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co. 10 * David Mosberger-Tang <davidm@hpl.hp.com> 11 * Stephane Eranian <eranian@hpl.hp.com> 12 * 13 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions 14 */ 15 16 #ifndef _EFI_API_H 17 #define _EFI_API_H 18 19 #include <efi.h> 20 #include <charset.h> 21 22 #ifdef CONFIG_EFI_LOADER 23 #include <asm/setjmp.h> 24 #endif 25 26 /* UEFI spec version 2.7 */ 27 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70) 28 29 /* Types and defines for EFI CreateEvent */ 30 enum efi_timer_delay { 31 EFI_TIMER_STOP = 0, 32 EFI_TIMER_PERIODIC = 1, 33 EFI_TIMER_RELATIVE = 2 34 }; 35 36 #define efi_intn_t ssize_t 37 #define efi_uintn_t size_t 38 typedef void *efi_hii_handle_t; 39 typedef u16 *efi_string_t; 40 typedef u16 efi_string_id_t; 41 typedef u32 efi_hii_font_style_t; 42 typedef u16 efi_question_id_t; 43 typedef u16 efi_image_id_t; 44 typedef u16 efi_form_id_t; 45 46 #define EVT_TIMER 0x80000000 47 #define EVT_RUNTIME 0x40000000 48 #define EVT_NOTIFY_WAIT 0x00000100 49 #define EVT_NOTIFY_SIGNAL 0x00000200 50 #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201 51 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202 52 53 #define TPL_APPLICATION 0x04 54 #define TPL_CALLBACK 0x08 55 #define TPL_NOTIFY 0x10 56 #define TPL_HIGH_LEVEL 0x1F 57 58 struct efi_event; 59 60 /* EFI Boot Services table */ 61 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42 62 struct efi_boot_services { 63 struct efi_table_hdr hdr; 64 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl); 65 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl); 66 67 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t, 68 efi_physical_addr_t *); 69 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t); 70 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size, 71 struct efi_mem_desc *desc, 72 efi_uintn_t *key, 73 efi_uintn_t *desc_size, 74 u32 *desc_version); 75 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **); 76 efi_status_t (EFIAPI *free_pool)(void *); 77 78 efi_status_t (EFIAPI *create_event)(uint32_t type, 79 efi_uintn_t notify_tpl, 80 void (EFIAPI *notify_function) ( 81 struct efi_event *event, 82 void *context), 83 void *notify_context, struct efi_event **event); 84 efi_status_t (EFIAPI *set_timer)(struct efi_event *event, 85 enum efi_timer_delay type, 86 uint64_t trigger_time); 87 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events, 88 struct efi_event **event, 89 efi_uintn_t *index); 90 efi_status_t (EFIAPI *signal_event)(struct efi_event *event); 91 efi_status_t (EFIAPI *close_event)(struct efi_event *event); 92 efi_status_t (EFIAPI *check_event)(struct efi_event *event); 93 #define EFI_NATIVE_INTERFACE 0x00000000 94 efi_status_t (EFIAPI *install_protocol_interface)( 95 efi_handle_t *handle, const efi_guid_t *protocol, 96 int protocol_interface_type, void *protocol_interface); 97 efi_status_t (EFIAPI *reinstall_protocol_interface)( 98 efi_handle_t handle, const efi_guid_t *protocol, 99 void *old_interface, void *new_interface); 100 efi_status_t (EFIAPI *uninstall_protocol_interface)( 101 efi_handle_t handle, const efi_guid_t *protocol, 102 void *protocol_interface); 103 efi_status_t (EFIAPI *handle_protocol)( 104 efi_handle_t handle, const efi_guid_t *protocol, 105 void **protocol_interface); 106 void *reserved; 107 efi_status_t (EFIAPI *register_protocol_notify)( 108 const efi_guid_t *protocol, struct efi_event *event, 109 void **registration); 110 efi_status_t (EFIAPI *locate_handle)( 111 enum efi_locate_search_type search_type, 112 const efi_guid_t *protocol, void *search_key, 113 efi_uintn_t *buffer_size, efi_handle_t *buffer); 114 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol, 115 struct efi_device_path **device_path, 116 efi_handle_t *device); 117 efi_status_t (EFIAPI *install_configuration_table)( 118 efi_guid_t *guid, void *table); 119 120 efi_status_t (EFIAPI *load_image)(bool boot_policiy, 121 efi_handle_t parent_image, 122 struct efi_device_path *file_path, void *source_buffer, 123 efi_uintn_t source_size, efi_handle_t *image); 124 efi_status_t (EFIAPI *start_image)(efi_handle_t handle, 125 efi_uintn_t *exitdata_size, 126 u16 **exitdata); 127 efi_status_t (EFIAPI *exit)(efi_handle_t handle, 128 efi_status_t exit_status, 129 efi_uintn_t exitdata_size, u16 *exitdata); 130 efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle); 131 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long); 132 133 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count); 134 efi_status_t (EFIAPI *stall)(unsigned long usecs); 135 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout, 136 uint64_t watchdog_code, unsigned long data_size, 137 uint16_t *watchdog_data); 138 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle, 139 efi_handle_t *driver_image_handle, 140 struct efi_device_path *remaining_device_path, 141 bool recursive); 142 efi_status_t (EFIAPI *disconnect_controller)( 143 efi_handle_t controller_handle, 144 efi_handle_t driver_image_handle, 145 efi_handle_t child_handle); 146 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001 147 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002 148 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004 149 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008 150 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010 151 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020 152 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle, 153 const efi_guid_t *protocol, void **interface, 154 efi_handle_t agent_handle, 155 efi_handle_t controller_handle, u32 attributes); 156 efi_status_t (EFIAPI *close_protocol)( 157 efi_handle_t handle, const efi_guid_t *protocol, 158 efi_handle_t agent_handle, 159 efi_handle_t controller_handle); 160 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle, 161 const efi_guid_t *protocol, 162 struct efi_open_protocol_info_entry **entry_buffer, 163 efi_uintn_t *entry_count); 164 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle, 165 efi_guid_t ***protocol_buffer, 166 efi_uintn_t *protocols_buffer_count); 167 efi_status_t (EFIAPI *locate_handle_buffer) ( 168 enum efi_locate_search_type search_type, 169 const efi_guid_t *protocol, void *search_key, 170 efi_uintn_t *no_handles, efi_handle_t **buffer); 171 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol, 172 void *registration, void **protocol_interface); 173 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)( 174 efi_handle_t *handle, ...); 175 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)( 176 efi_handle_t handle, ...); 177 efi_status_t (EFIAPI *calculate_crc32)(const void *data, 178 efi_uintn_t data_size, 179 u32 *crc32); 180 void (EFIAPI *copy_mem)(void *destination, const void *source, 181 size_t length); 182 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value); 183 efi_status_t (EFIAPI *create_event_ex)( 184 uint32_t type, efi_uintn_t notify_tpl, 185 void (EFIAPI *notify_function) ( 186 struct efi_event *event, 187 void *context), 188 void *notify_context, 189 efi_guid_t *event_group, 190 struct efi_event **event); 191 }; 192 193 /* Types and defines for EFI ResetSystem */ 194 enum efi_reset_type { 195 EFI_RESET_COLD = 0, 196 EFI_RESET_WARM = 1, 197 EFI_RESET_SHUTDOWN = 2, 198 EFI_RESET_PLATFORM_SPECIFIC = 3, 199 }; 200 201 /* EFI Runtime Services table */ 202 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL 203 204 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000 205 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000 206 #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000 207 208 struct efi_capsule_header { 209 efi_guid_t *capsule_guid; 210 u32 header_size; 211 u32 flags; 212 u32 capsule_image_size; 213 }; 214 215 struct efi_runtime_services { 216 struct efi_table_hdr hdr; 217 efi_status_t (EFIAPI *get_time)(struct efi_time *time, 218 struct efi_time_cap *capabilities); 219 efi_status_t (EFIAPI *set_time)(struct efi_time *time); 220 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending, 221 struct efi_time *time); 222 efi_status_t (EFIAPI *set_wakeup_time)(char enabled, 223 struct efi_time *time); 224 efi_status_t (EFIAPI *set_virtual_address_map)( 225 unsigned long memory_map_size, 226 unsigned long descriptor_size, 227 uint32_t descriptor_version, 228 struct efi_mem_desc *virtmap); 229 efi_status_t (*convert_pointer)(unsigned long dbg, void **address); 230 efi_status_t (EFIAPI *get_variable)(u16 *variable_name, 231 const efi_guid_t *vendor, 232 u32 *attributes, 233 efi_uintn_t *data_size, void *data); 234 efi_status_t (EFIAPI *get_next_variable_name)( 235 efi_uintn_t *variable_name_size, 236 u16 *variable_name, const efi_guid_t *vendor); 237 efi_status_t (EFIAPI *set_variable)(u16 *variable_name, 238 const efi_guid_t *vendor, 239 u32 attributes, 240 efi_uintn_t data_size, 241 const void *data); 242 efi_status_t (EFIAPI *get_next_high_mono_count)( 243 uint32_t *high_count); 244 void (EFIAPI *reset_system)(enum efi_reset_type reset_type, 245 efi_status_t reset_status, 246 unsigned long data_size, void *reset_data); 247 efi_status_t (EFIAPI *update_capsule)( 248 struct efi_capsule_header **capsule_header_array, 249 efi_uintn_t capsule_count, 250 u64 scatter_gather_list); 251 efi_status_t (EFIAPI *query_capsule_caps)( 252 struct efi_capsule_header **capsule_header_array, 253 efi_uintn_t capsule_count, 254 u64 *maximum_capsule_size, 255 u32 *reset_type); 256 efi_status_t (EFIAPI *query_variable_info)( 257 u32 attributes, 258 u64 *maximum_variable_storage_size, 259 u64 *remaining_variable_storage_size, 260 u64 *maximum_variable_size); 261 }; 262 263 /* EFI event group GUID definitions */ 264 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \ 265 EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \ 266 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf) 267 268 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \ 269 EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \ 270 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96) 271 272 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \ 273 EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \ 274 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab) 275 276 #define EFI_EVENT_GROUP_READY_TO_BOOT \ 277 EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \ 278 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b) 279 280 #define EFI_EVENT_GROUP_RESET_SYSTEM \ 281 EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \ 282 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b) 283 284 /* EFI Configuration Table and GUID definitions */ 285 #define NULL_GUID \ 286 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \ 287 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) 288 289 #define EFI_GLOBAL_VARIABLE_GUID \ 290 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \ 291 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c) 292 293 #define LOADED_IMAGE_PROTOCOL_GUID \ 294 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \ 295 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 296 297 #define EFI_FDT_GUID \ 298 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \ 299 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0) 300 301 #define EFI_ACPI_TABLE_GUID \ 302 EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \ 303 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81) 304 305 #define SMBIOS_TABLE_GUID \ 306 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \ 307 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 308 309 struct efi_configuration_table { 310 efi_guid_t guid; 311 void *table; 312 } __packed; 313 314 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL) 315 316 struct efi_system_table { 317 struct efi_table_hdr hdr; 318 u16 *fw_vendor; /* physical addr of wchar_t vendor string */ 319 u32 fw_revision; 320 efi_handle_t con_in_handle; 321 struct efi_simple_text_input_protocol *con_in; 322 efi_handle_t con_out_handle; 323 struct efi_simple_text_output_protocol *con_out; 324 efi_handle_t stderr_handle; 325 struct efi_simple_text_output_protocol *std_err; 326 struct efi_runtime_services *runtime; 327 struct efi_boot_services *boottime; 328 efi_uintn_t nr_tables; 329 struct efi_configuration_table *tables; 330 }; 331 332 #define LOADED_IMAGE_GUID \ 333 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \ 334 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 335 336 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000 337 338 struct efi_loaded_image { 339 u32 revision; 340 void *parent_handle; 341 struct efi_system_table *system_table; 342 efi_handle_t device_handle; 343 struct efi_device_path *file_path; 344 void *reserved; 345 u32 load_options_size; 346 void *load_options; 347 void *image_base; 348 aligned_u64 image_size; 349 unsigned int image_code_type; 350 unsigned int image_data_type; 351 unsigned long unload; 352 }; 353 354 #define DEVICE_PATH_GUID \ 355 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \ 356 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 357 358 #define DEVICE_PATH_TYPE_END 0x7f 359 # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01 360 # define DEVICE_PATH_SUB_TYPE_END 0xff 361 362 struct efi_device_path { 363 u8 type; 364 u8 sub_type; 365 u16 length; 366 } __packed; 367 368 struct efi_mac_addr { 369 u8 addr[32]; 370 } __packed; 371 372 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01 373 # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03 374 # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04 375 376 struct efi_device_path_memory { 377 struct efi_device_path dp; 378 u32 memory_type; 379 u64 start_address; 380 u64 end_address; 381 } __packed; 382 383 struct efi_device_path_vendor { 384 struct efi_device_path dp; 385 efi_guid_t guid; 386 u8 vendor_data[]; 387 } __packed; 388 389 #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02 390 # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01 391 392 #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0) 393 #define EISA_PNP_ID(ID) EFI_PNP_ID(ID) 394 #define EISA_PNP_NUM(ID) ((ID) >> 16) 395 396 struct efi_device_path_acpi_path { 397 struct efi_device_path dp; 398 u32 hid; 399 u32 uid; 400 } __packed; 401 402 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03 403 # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01 404 # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02 405 # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05 406 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b 407 # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f 408 # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a 409 # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d 410 411 struct efi_device_path_atapi { 412 struct efi_device_path dp; 413 u8 primary_secondary; 414 u8 slave_master; 415 u16 logical_unit_number; 416 } __packed; 417 418 struct efi_device_path_scsi { 419 struct efi_device_path dp; 420 u16 target_id; 421 u16 logical_unit_number; 422 } __packed; 423 424 struct efi_device_path_usb { 425 struct efi_device_path dp; 426 u8 parent_port_number; 427 u8 usb_interface; 428 } __packed; 429 430 struct efi_device_path_mac_addr { 431 struct efi_device_path dp; 432 struct efi_mac_addr mac; 433 u8 if_type; 434 } __packed; 435 436 struct efi_device_path_usb_class { 437 struct efi_device_path dp; 438 u16 vendor_id; 439 u16 product_id; 440 u8 device_class; 441 u8 device_subclass; 442 u8 device_protocol; 443 } __packed; 444 445 struct efi_device_path_sd_mmc_path { 446 struct efi_device_path dp; 447 u8 slot_number; 448 } __packed; 449 450 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04 451 # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01 452 # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02 453 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04 454 455 struct efi_device_path_hard_drive_path { 456 struct efi_device_path dp; 457 u32 partition_number; 458 u64 partition_start; 459 u64 partition_end; 460 u8 partition_signature[16]; 461 u8 partmap_type; 462 u8 signature_type; 463 } __packed; 464 465 struct efi_device_path_cdrom_path { 466 struct efi_device_path dp; 467 u32 boot_entry; 468 u64 partition_start; 469 u64 partition_end; 470 } __packed; 471 472 struct efi_device_path_file_path { 473 struct efi_device_path dp; 474 u16 str[]; 475 } __packed; 476 477 #define BLOCK_IO_GUID \ 478 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \ 479 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 480 481 struct efi_block_io_media { 482 u32 media_id; 483 char removable_media; 484 char media_present; 485 char logical_partition; 486 char read_only; 487 char write_caching; 488 u8 pad[3]; 489 u32 block_size; 490 u32 io_align; 491 u8 pad2[4]; 492 u64 last_block; 493 /* Added in revision 2 of the protocol */ 494 u64 lowest_aligned_lba; 495 u32 logical_blocks_per_physical_block; 496 /* Added in revision 3 of the protocol */ 497 u32 optimal_transfer_length_granualarity; 498 }; 499 500 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001 501 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f 502 503 struct efi_block_io { 504 u64 revision; 505 struct efi_block_io_media *media; 506 efi_status_t (EFIAPI *reset)(struct efi_block_io *this, 507 char extended_verification); 508 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this, 509 u32 media_id, u64 lba, efi_uintn_t buffer_size, 510 void *buffer); 511 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this, 512 u32 media_id, u64 lba, efi_uintn_t buffer_size, 513 void *buffer); 514 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this); 515 }; 516 517 struct simple_text_output_mode { 518 s32 max_mode; 519 s32 mode; 520 s32 attribute; 521 s32 cursor_column; 522 s32 cursor_row; 523 bool cursor_visible; 524 }; 525 526 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \ 527 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \ 528 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 529 530 #define EFI_BLACK 0x00 531 #define EFI_BLUE 0x01 532 #define EFI_GREEN 0x02 533 #define EFI_CYAN 0x03 534 #define EFI_RED 0x04 535 #define EFI_MAGENTA 0x05 536 #define EFI_BROWN 0x06 537 #define EFI_LIGHTGRAY 0x07 538 #define EFI_BRIGHT 0x08 539 #define EFI_DARKGRAY 0x08 540 #define EFI_LIGHTBLUE 0x09 541 #define EFI_LIGHTGREEN 0x0a 542 #define EFI_LIGHTCYAN 0x0b 543 #define EFI_LIGHTRED 0x0c 544 #define EFI_LIGHTMAGENTA 0x0d 545 #define EFI_YELLOW 0x0e 546 #define EFI_WHITE 0x0f 547 #define EFI_BACKGROUND_BLACK 0x00 548 #define EFI_BACKGROUND_BLUE 0x10 549 #define EFI_BACKGROUND_GREEN 0x20 550 #define EFI_BACKGROUND_CYAN 0x30 551 #define EFI_BACKGROUND_RED 0x40 552 #define EFI_BACKGROUND_MAGENTA 0x50 553 #define EFI_BACKGROUND_BROWN 0x60 554 #define EFI_BACKGROUND_LIGHTGRAY 0x70 555 556 /* extract foreground color from EFI attribute */ 557 #define EFI_ATTR_FG(attr) ((attr) & 0x07) 558 /* treat high bit of FG as bright/bold (similar to edk2) */ 559 #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01) 560 /* extract background color from EFI attribute */ 561 #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7) 562 563 struct efi_simple_text_output_protocol { 564 void *reset; 565 efi_status_t (EFIAPI *output_string)( 566 struct efi_simple_text_output_protocol *this, 567 const efi_string_t str); 568 efi_status_t (EFIAPI *test_string)( 569 struct efi_simple_text_output_protocol *this, 570 const efi_string_t str); 571 efi_status_t(EFIAPI *query_mode)( 572 struct efi_simple_text_output_protocol *this, 573 unsigned long mode_number, unsigned long *columns, 574 unsigned long *rows); 575 efi_status_t(EFIAPI *set_mode)( 576 struct efi_simple_text_output_protocol *this, 577 unsigned long mode_number); 578 efi_status_t(EFIAPI *set_attribute)( 579 struct efi_simple_text_output_protocol *this, 580 unsigned long attribute); 581 efi_status_t(EFIAPI *clear_screen) ( 582 struct efi_simple_text_output_protocol *this); 583 efi_status_t(EFIAPI *set_cursor_position) ( 584 struct efi_simple_text_output_protocol *this, 585 unsigned long column, unsigned long row); 586 efi_status_t(EFIAPI *enable_cursor)( 587 struct efi_simple_text_output_protocol *this, 588 bool enable); 589 struct simple_text_output_mode *mode; 590 }; 591 592 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \ 593 EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \ 594 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa) 595 596 struct efi_input_key { 597 u16 scan_code; 598 s16 unicode_char; 599 }; 600 601 #define EFI_SHIFT_STATE_INVALID 0x00000000 602 #define EFI_RIGHT_SHIFT_PRESSED 0x00000001 603 #define EFI_LEFT_SHIFT_PRESSED 0x00000002 604 #define EFI_RIGHT_CONTROL_PRESSED 0x00000004 605 #define EFI_LEFT_CONTROL_PRESSED 0x00000008 606 #define EFI_RIGHT_ALT_PRESSED 0x00000010 607 #define EFI_LEFT_ALT_PRESSED 0x00000020 608 #define EFI_RIGHT_LOGO_PRESSED 0x00000040 609 #define EFI_LEFT_LOGO_PRESSED 0x00000080 610 #define EFI_MENU_KEY_PRESSED 0x00000100 611 #define EFI_SYS_REQ_PRESSED 0x00000200 612 #define EFI_SHIFT_STATE_VALID 0x80000000 613 614 #define EFI_TOGGLE_STATE_INVALID 0x00 615 #define EFI_SCROLL_LOCK_ACTIVE 0x01 616 #define EFI_NUM_LOCK_ACTIVE 0x02 617 #define EFI_CAPS_LOCK_ACTIVE 0x04 618 #define EFI_KEY_STATE_EXPOSED 0x40 619 #define EFI_TOGGLE_STATE_VALID 0x80 620 621 struct efi_key_state { 622 u32 key_shift_state; 623 u8 key_toggle_state; 624 }; 625 626 struct efi_key_data { 627 struct efi_input_key key; 628 struct efi_key_state key_state; 629 }; 630 631 struct efi_simple_text_input_ex_protocol { 632 efi_status_t (EFIAPI *reset) ( 633 struct efi_simple_text_input_ex_protocol *this, 634 bool extended_verification); 635 efi_status_t (EFIAPI *read_key_stroke_ex) ( 636 struct efi_simple_text_input_ex_protocol *this, 637 struct efi_key_data *key_data); 638 struct efi_event *wait_for_key_ex; 639 efi_status_t (EFIAPI *set_state) ( 640 struct efi_simple_text_input_ex_protocol *this, 641 u8 key_toggle_state); 642 efi_status_t (EFIAPI *register_key_notify) ( 643 struct efi_simple_text_input_ex_protocol *this, 644 struct efi_key_data *key_data, 645 efi_status_t (EFIAPI *key_notify_function)( 646 struct efi_key_data *key_data), 647 void **notify_handle); 648 efi_status_t (EFIAPI *unregister_key_notify) ( 649 struct efi_simple_text_input_ex_protocol *this, 650 void *notification_handle); 651 }; 652 653 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \ 654 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \ 655 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 656 657 struct efi_simple_text_input_protocol { 658 efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this, 659 bool extended_verification); 660 efi_status_t(EFIAPI *read_key_stroke)( 661 struct efi_simple_text_input_protocol *this, 662 struct efi_input_key *key); 663 struct efi_event *wait_for_key; 664 }; 665 666 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \ 667 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \ 668 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c) 669 670 struct efi_device_path_to_text_protocol { 671 uint16_t *(EFIAPI *convert_device_node_to_text)( 672 struct efi_device_path *device_node, 673 bool display_only, 674 bool allow_shortcuts); 675 uint16_t *(EFIAPI *convert_device_path_to_text)( 676 struct efi_device_path *device_path, 677 bool display_only, 678 bool allow_shortcuts); 679 }; 680 681 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \ 682 EFI_GUID(0x0379be4e, 0xd706, 0x437d, \ 683 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4) 684 685 struct efi_device_path_utilities_protocol { 686 efi_uintn_t (EFIAPI *get_device_path_size)( 687 const struct efi_device_path *device_path); 688 struct efi_device_path *(EFIAPI *duplicate_device_path)( 689 const struct efi_device_path *device_path); 690 struct efi_device_path *(EFIAPI *append_device_path)( 691 const struct efi_device_path *src1, 692 const struct efi_device_path *src2); 693 struct efi_device_path *(EFIAPI *append_device_node)( 694 const struct efi_device_path *device_path, 695 const struct efi_device_path *device_node); 696 struct efi_device_path *(EFIAPI *append_device_path_instance)( 697 const struct efi_device_path *device_path, 698 const struct efi_device_path *device_path_instance); 699 struct efi_device_path *(EFIAPI *get_next_device_path_instance)( 700 struct efi_device_path **device_path_instance, 701 efi_uintn_t *device_path_instance_size); 702 bool (EFIAPI *is_device_path_multi_instance)( 703 const struct efi_device_path *device_path); 704 struct efi_device_path *(EFIAPI *create_device_node)( 705 uint8_t node_type, 706 uint8_t node_sub_type, 707 uint16_t node_length); 708 }; 709 710 /* 711 * Human Interface Infrastructure (HII) 712 */ 713 struct efi_hii_package_list_header { 714 efi_guid_t package_list_guid; 715 u32 package_length; 716 } __packed; 717 718 /** 719 * struct efi_hii_package_header - EFI HII package header 720 * 721 * @fields: 'fields' replaces the bit-fields defined in the EFI 722 * specification to to avoid possible compiler incompatibilities:: 723 * 724 * u32 length:24; 725 * u32 type:8; 726 */ 727 struct efi_hii_package_header { 728 u32 fields; 729 } __packed; 730 731 #define __EFI_HII_PACKAGE_LEN_SHIFT 0 732 #define __EFI_HII_PACKAGE_TYPE_SHIFT 24 733 #define __EFI_HII_PACKAGE_LEN_MASK 0xffffff 734 #define __EFI_HII_PACKAGE_TYPE_MASK 0xff 735 736 #define EFI_HII_PACKAGE_TYPE_ALL 0x00 737 #define EFI_HII_PACKAGE_TYPE_GUID 0x01 738 #define EFI_HII_PACKAGE_FORMS 0x02 739 #define EFI_HII_PACKAGE_STRINGS 0x04 740 #define EFI_HII_PACKAGE_FONTS 0x05 741 #define EFI_HII_PACKAGE_IMAGES 0x06 742 #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07 743 #define EFI_HII_PACKAGE_DEVICE_PATH 0x08 744 #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09 745 #define EFI_HII_PACKAGE_ANIMATIONS 0x0A 746 #define EFI_HII_PACKAGE_END 0xDF 747 #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0 748 #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF 749 750 /* 751 * HII GUID package 752 */ 753 struct efi_hii_guid_package { 754 struct efi_hii_package_header header; 755 efi_guid_t guid; 756 char data[]; 757 } __packed; 758 759 /* 760 * HII string package 761 */ 762 struct efi_hii_strings_package { 763 struct efi_hii_package_header header; 764 u32 header_size; 765 u32 string_info_offset; 766 u16 language_window[16]; 767 efi_string_id_t language_name; 768 u8 language[]; 769 } __packed; 770 771 struct efi_hii_string_block { 772 u8 block_type; 773 /* u8 block_body[]; */ 774 } __packed; 775 776 #define EFI_HII_SIBT_END 0x00 777 #define EFI_HII_SIBT_STRING_SCSU 0x10 778 #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11 779 #define EFI_HII_SIBT_STRINGS_SCSU 0x12 780 #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13 781 #define EFI_HII_SIBT_STRING_UCS2 0x14 782 #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15 783 #define EFI_HII_SIBT_STRINGS_UCS2 0x16 784 #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17 785 #define EFI_HII_SIBT_DUPLICATE 0x20 786 #define EFI_HII_SIBT_SKIP2 0x21 787 #define EFI_HII_SIBT_SKIP1 0x22 788 #define EFI_HII_SIBT_EXT1 0x30 789 #define EFI_HII_SIBT_EXT2 0x31 790 #define EFI_HII_SIBT_EXT4 0x32 791 #define EFI_HII_SIBT_FONT 0x40 792 793 struct efi_hii_sibt_string_ucs2_block { 794 struct efi_hii_string_block header; 795 u16 string_text[]; 796 } __packed; 797 798 static inline struct efi_hii_string_block * efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block * blk)799 efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk) 800 { 801 return ((void *)blk) + sizeof(*blk) + 802 (u16_strlen(blk->string_text) + 1) * 2; 803 } 804 805 /* 806 * HII forms package 807 * TODO: full scope of definitions 808 */ 809 struct efi_hii_time { 810 u8 hour; 811 u8 minute; 812 u8 second; 813 }; 814 815 struct efi_hii_date { 816 u16 year; 817 u8 month; 818 u8 day; 819 }; 820 821 struct efi_hii_ref { 822 efi_question_id_t question_id; 823 efi_form_id_t form_id; 824 efi_guid_t form_set_guid; 825 efi_string_id_t device_path; 826 }; 827 828 union efi_ifr_type_value { 829 u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8 830 u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16 831 u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32 832 u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64 833 bool b; // EFI_IFR_TYPE_BOOLEAN 834 struct efi_hii_time time; // EFI_IFR_TYPE_TIME 835 struct efi_hii_date date; // EFI_IFR_TYPE_DATE 836 efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION 837 struct efi_hii_ref ref; // EFI_IFR_TYPE_REF 838 // u8 buffer[]; // EFI_IFR_TYPE_BUFFER 839 }; 840 841 #define EFI_IFR_TYPE_NUM_SIZE_8 0x00 842 #define EFI_IFR_TYPE_NUM_SIZE_16 0x01 843 #define EFI_IFR_TYPE_NUM_SIZE_32 0x02 844 #define EFI_IFR_TYPE_NUM_SIZE_64 0x03 845 #define EFI_IFR_TYPE_BOOLEAN 0x04 846 #define EFI_IFR_TYPE_TIME 0x05 847 #define EFI_IFR_TYPE_DATE 0x06 848 #define EFI_IFR_TYPE_STRING 0x07 849 #define EFI_IFR_TYPE_OTHER 0x08 850 #define EFI_IFR_TYPE_UNDEFINED 0x09 851 #define EFI_IFR_TYPE_ACTION 0x0A 852 #define EFI_IFR_TYPE_BUFFER 0x0B 853 #define EFI_IFR_TYPE_REF 0x0C 854 #define EFI_IFR_OPTION_DEFAULT 0x10 855 #define EFI_IFR_OPTION_DEFAULT_MFG 0x20 856 857 #define EFI_IFR_ONE_OF_OPTION_OP 0x09 858 859 struct efi_ifr_op_header { 860 u8 opCode; 861 u8 length:7; 862 u8 scope:1; 863 }; 864 865 struct efi_ifr_one_of_option { 866 struct efi_ifr_op_header header; 867 efi_string_id_t option; 868 u8 flags; 869 u8 type; 870 union efi_ifr_type_value value; 871 }; 872 873 typedef efi_uintn_t efi_browser_action_t; 874 875 #define EFI_BROWSER_ACTION_REQUEST_NONE 0 876 #define EFI_BROWSER_ACTION_REQUEST_RESET 1 877 #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2 878 #define EFI_BROWSER_ACTION_REQUEST_EXIT 3 879 #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4 880 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5 881 #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6 882 #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7 883 #define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8 884 885 typedef efi_uintn_t efi_browser_action_request_t; 886 887 #define EFI_BROWSER_ACTION_CHANGING 0 888 #define EFI_BROWSER_ACTION_CHANGED 1 889 #define EFI_BROWSER_ACTION_RETRIEVE 2 890 #define EFI_BROWSER_ACTION_FORM_OPEN 3 891 #define EFI_BROWSER_ACTION_FORM_CLOSE 4 892 #define EFI_BROWSER_ACTION_SUBMITTED 5 893 #define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000 894 #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001 895 #define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002 896 #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000 897 #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000 898 #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000 899 900 /* 901 * HII keyboard package 902 */ 903 typedef enum { 904 EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR, 905 EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW, 906 EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO, 907 EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0, 908 EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6, 909 EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT, 910 EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE, 911 EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4, 912 EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9, 913 EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE, 914 EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2, 915 EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8, 916 EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13, 917 EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT, 918 EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3, 919 EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9, 920 EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE, 921 EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH, 922 EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2, 923 EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8, 924 EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT, 925 EFI_KEY_SLCK, EFI_KEY_PAUSE, 926 } efi_key; 927 928 struct efi_key_descriptor { 929 u32 key; 930 u16 unicode; 931 u16 shifted_unicode; 932 u16 alt_gr_unicode; 933 u16 shifted_alt_gr_unicode; 934 u16 modifier; 935 u16 affected_attribute; 936 } __packed; 937 938 struct efi_hii_keyboard_layout { 939 u16 layout_length; 940 efi_guid_t guid; 941 u32 layout_descriptor_string_offset; 942 u8 descriptor_count; 943 struct efi_key_descriptor descriptors[]; 944 } __packed; 945 946 struct efi_hii_keyboard_package { 947 struct efi_hii_package_header header; 948 u16 layout_count; 949 struct efi_hii_keyboard_layout layout[]; 950 } __packed; 951 952 /* 953 * HII protocols 954 */ 955 #define EFI_HII_STRING_PROTOCOL_GUID \ 956 EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \ 957 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a) 958 959 struct efi_font_info { 960 efi_hii_font_style_t font_style; 961 u16 font_size; 962 u16 font_name[1]; 963 }; 964 965 struct efi_hii_string_protocol { 966 efi_status_t(EFIAPI *new_string)( 967 const struct efi_hii_string_protocol *this, 968 efi_hii_handle_t package_list, 969 efi_string_id_t *string_id, 970 const u8 *language, 971 const u16 *language_name, 972 const efi_string_t string, 973 const struct efi_font_info *string_font_info); 974 efi_status_t(EFIAPI *get_string)( 975 const struct efi_hii_string_protocol *this, 976 const u8 *language, 977 efi_hii_handle_t package_list, 978 efi_string_id_t string_id, 979 efi_string_t string, 980 efi_uintn_t *string_size, 981 struct efi_font_info **string_font_info); 982 efi_status_t(EFIAPI *set_string)( 983 const struct efi_hii_string_protocol *this, 984 efi_hii_handle_t package_list, 985 efi_string_id_t string_id, 986 const u8 *language, 987 const efi_string_t string, 988 const struct efi_font_info *string_font_info); 989 efi_status_t(EFIAPI *get_languages)( 990 const struct efi_hii_string_protocol *this, 991 efi_hii_handle_t package_list, 992 u8 *languages, 993 efi_uintn_t *languages_size); 994 efi_status_t(EFIAPI *get_secondary_languages)( 995 const struct efi_hii_string_protocol *this, 996 efi_hii_handle_t package_list, 997 const u8 *primary_language, 998 u8 *secondary_languages, 999 efi_uintn_t *secondary_languages_size); 1000 }; 1001 1002 #define EFI_HII_DATABASE_PROTOCOL_GUID \ 1003 EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \ 1004 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42) 1005 1006 struct efi_hii_database_protocol { 1007 efi_status_t(EFIAPI *new_package_list)( 1008 const struct efi_hii_database_protocol *this, 1009 const struct efi_hii_package_list_header *package_list, 1010 const efi_handle_t driver_handle, 1011 efi_hii_handle_t *handle); 1012 efi_status_t(EFIAPI *remove_package_list)( 1013 const struct efi_hii_database_protocol *this, 1014 efi_hii_handle_t handle); 1015 efi_status_t(EFIAPI *update_package_list)( 1016 const struct efi_hii_database_protocol *this, 1017 efi_hii_handle_t handle, 1018 const struct efi_hii_package_list_header *package_list); 1019 efi_status_t(EFIAPI *list_package_lists)( 1020 const struct efi_hii_database_protocol *this, 1021 u8 package_type, 1022 const efi_guid_t *package_guid, 1023 efi_uintn_t *handle_buffer_length, 1024 efi_hii_handle_t *handle); 1025 efi_status_t(EFIAPI *export_package_lists)( 1026 const struct efi_hii_database_protocol *this, 1027 efi_hii_handle_t handle, 1028 efi_uintn_t *buffer_size, 1029 struct efi_hii_package_list_header *buffer); 1030 efi_status_t(EFIAPI *register_package_notify)( 1031 const struct efi_hii_database_protocol *this, 1032 u8 package_type, 1033 const efi_guid_t *package_guid, 1034 const void *package_notify_fn, 1035 efi_uintn_t notify_type, 1036 efi_handle_t *notify_handle); 1037 efi_status_t(EFIAPI *unregister_package_notify)( 1038 const struct efi_hii_database_protocol *this, 1039 efi_handle_t notification_handle 1040 ); 1041 efi_status_t(EFIAPI *find_keyboard_layouts)( 1042 const struct efi_hii_database_protocol *this, 1043 u16 *key_guid_buffer_length, 1044 efi_guid_t *key_guid_buffer); 1045 efi_status_t(EFIAPI *get_keyboard_layout)( 1046 const struct efi_hii_database_protocol *this, 1047 efi_guid_t *key_guid, 1048 u16 *keyboard_layout_length, 1049 struct efi_hii_keyboard_layout *keyboard_layout); 1050 efi_status_t(EFIAPI *set_keyboard_layout)( 1051 const struct efi_hii_database_protocol *this, 1052 efi_guid_t *key_guid); 1053 efi_status_t(EFIAPI *get_package_list_handle)( 1054 const struct efi_hii_database_protocol *this, 1055 efi_hii_handle_t package_list_handle, 1056 efi_handle_t *driver_handle); 1057 }; 1058 1059 #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \ 1060 EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \ 1061 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f) 1062 1063 struct efi_hii_config_routing_protocol { 1064 efi_status_t(EFIAPI *extract_config)( 1065 const struct efi_hii_config_routing_protocol *this, 1066 const efi_string_t request, 1067 efi_string_t *progress, 1068 efi_string_t *results); 1069 efi_status_t(EFIAPI *export_config)( 1070 const struct efi_hii_config_routing_protocol *this, 1071 efi_string_t *results); 1072 efi_status_t(EFIAPI *route_config)( 1073 const struct efi_hii_config_routing_protocol *this, 1074 const efi_string_t configuration, 1075 efi_string_t *progress); 1076 efi_status_t(EFIAPI *block_to_config)( 1077 const struct efi_hii_config_routing_protocol *this, 1078 const efi_string_t config_request, 1079 const uint8_t *block, 1080 const efi_uintn_t block_size, 1081 efi_string_t *config, 1082 efi_string_t *progress); 1083 efi_status_t(EFIAPI *config_to_block)( 1084 const struct efi_hii_config_routing_protocol *this, 1085 const efi_string_t config_resp, 1086 const uint8_t *block, 1087 const efi_uintn_t *block_size, 1088 efi_string_t *progress); 1089 efi_status_t(EFIAPI *get_alt_config)( 1090 const struct efi_hii_config_routing_protocol *this, 1091 const efi_string_t config_resp, 1092 const efi_guid_t *guid, 1093 const efi_string_t name, 1094 const struct efi_device_path *device_path, 1095 const efi_string_t alt_cfg_id, 1096 efi_string_t *alt_cfg_resp); 1097 }; 1098 1099 #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \ 1100 EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \ 1101 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85) 1102 1103 struct efi_hii_config_access_protocol { 1104 efi_status_t(EFIAPI *extract_config_access)( 1105 const struct efi_hii_config_access_protocol *this, 1106 const efi_string_t request, 1107 efi_string_t *progress, 1108 efi_string_t *results); 1109 efi_status_t(EFIAPI *route_config_access)( 1110 const struct efi_hii_config_access_protocol *this, 1111 const efi_string_t configuration, 1112 efi_string_t *progress); 1113 efi_status_t(EFIAPI *form_callback)( 1114 const struct efi_hii_config_access_protocol *this, 1115 efi_browser_action_t action, 1116 efi_question_id_t question_id, 1117 u8 type, 1118 union efi_ifr_type_value *value, 1119 efi_browser_action_request_t *action_request); 1120 }; 1121 1122 #define EFI_GOP_GUID \ 1123 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \ 1124 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a) 1125 1126 #define EFI_GOT_RGBA8 0 1127 #define EFI_GOT_BGRA8 1 1128 #define EFI_GOT_BITMASK 2 1129 1130 struct efi_gop_mode_info { 1131 u32 version; 1132 u32 width; 1133 u32 height; 1134 u32 pixel_format; 1135 u32 pixel_bitmask[4]; 1136 u32 pixels_per_scanline; 1137 }; 1138 1139 struct efi_gop_mode { 1140 u32 max_mode; 1141 u32 mode; 1142 struct efi_gop_mode_info *info; 1143 unsigned long info_size; 1144 efi_physical_addr_t fb_base; 1145 unsigned long fb_size; 1146 }; 1147 1148 struct efi_gop_pixel { 1149 u8 blue; 1150 u8 green; 1151 u8 red; 1152 u8 reserved; 1153 }; 1154 1155 #define EFI_BLT_VIDEO_FILL 0 1156 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1 1157 #define EFI_BLT_BUFFER_TO_VIDEO 2 1158 #define EFI_BLT_VIDEO_TO_VIDEO 3 1159 1160 struct efi_gop { 1161 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number, 1162 efi_uintn_t *size_of_info, 1163 struct efi_gop_mode_info **info); 1164 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number); 1165 efi_status_t (EFIAPI *blt)(struct efi_gop *this, 1166 struct efi_gop_pixel *buffer, 1167 u32 operation, efi_uintn_t sx, 1168 efi_uintn_t sy, efi_uintn_t dx, 1169 efi_uintn_t dy, efi_uintn_t width, 1170 efi_uintn_t height, efi_uintn_t delta); 1171 struct efi_gop_mode *mode; 1172 }; 1173 1174 #define EFI_SIMPLE_NETWORK_GUID \ 1175 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \ 1176 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 1177 1178 struct efi_mac_address { 1179 char mac_addr[32]; 1180 }; 1181 1182 struct efi_ip_address { 1183 u8 ip_addr[16]; 1184 } __attribute__((aligned(4))); 1185 1186 enum efi_simple_network_state { 1187 EFI_NETWORK_STOPPED, 1188 EFI_NETWORK_STARTED, 1189 EFI_NETWORK_INITIALIZED, 1190 }; 1191 1192 struct efi_simple_network_mode { 1193 enum efi_simple_network_state state; 1194 u32 hwaddr_size; 1195 u32 media_header_size; 1196 u32 max_packet_size; 1197 u32 nvram_size; 1198 u32 nvram_access_size; 1199 u32 receive_filter_mask; 1200 u32 receive_filter_setting; 1201 u32 max_mcast_filter_count; 1202 u32 mcast_filter_count; 1203 struct efi_mac_address mcast_filter[16]; 1204 struct efi_mac_address current_address; 1205 struct efi_mac_address broadcast_address; 1206 struct efi_mac_address permanent_address; 1207 u8 if_type; 1208 u8 mac_changeable; 1209 u8 multitx_supported; 1210 u8 media_present_supported; 1211 u8 media_present; 1212 }; 1213 1214 /* receive_filters bit mask */ 1215 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01 1216 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02 1217 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04 1218 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08 1219 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10 1220 1221 /* interrupt status bit mask */ 1222 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01 1223 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02 1224 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04 1225 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08 1226 1227 /* revision of the simple network protocol */ 1228 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000 1229 1230 struct efi_simple_network { 1231 u64 revision; 1232 efi_status_t (EFIAPI *start)(struct efi_simple_network *this); 1233 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this); 1234 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this, 1235 ulong extra_rx, ulong extra_tx); 1236 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this, 1237 int extended_verification); 1238 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this); 1239 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this, 1240 u32 enable, u32 disable, int reset_mcast_filter, 1241 ulong mcast_filter_count, 1242 struct efi_mac_address *mcast_filter); 1243 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this, 1244 int reset, struct efi_mac_address *new_mac); 1245 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this, 1246 int reset, ulong *stat_size, void *stat_table); 1247 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this, 1248 int ipv6, struct efi_ip_address *ip, 1249 struct efi_mac_address *mac); 1250 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this, 1251 int read_write, ulong offset, ulong buffer_size, 1252 char *buffer); 1253 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this, 1254 u32 *int_status, void **txbuf); 1255 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this, 1256 size_t header_size, size_t buffer_size, void *buffer, 1257 struct efi_mac_address *src_addr, 1258 struct efi_mac_address *dest_addr, u16 *protocol); 1259 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this, 1260 size_t *header_size, size_t *buffer_size, void *buffer, 1261 struct efi_mac_address *src_addr, 1262 struct efi_mac_address *dest_addr, u16 *protocol); 1263 struct efi_event *wait_for_packet; 1264 struct efi_simple_network_mode *mode; 1265 }; 1266 1267 #define EFI_PXE_GUID \ 1268 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \ 1269 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d) 1270 1271 struct efi_pxe_packet { 1272 u8 packet[1472]; 1273 }; 1274 1275 struct efi_pxe_mode { 1276 u8 started; 1277 u8 ipv6_available; 1278 u8 ipv6_supported; 1279 u8 using_ipv6; 1280 u8 bis_supported; 1281 u8 bis_detected; 1282 u8 auto_arp; 1283 u8 send_guid; 1284 u8 dhcp_discover_valid; 1285 u8 dhcp_ack_received; 1286 u8 proxy_offer_received; 1287 u8 pxe_discover_valid; 1288 u8 pxe_reply_received; 1289 u8 pxe_bis_reply_received; 1290 u8 icmp_error_received; 1291 u8 tftp_error_received; 1292 u8 make_callbacks; 1293 u8 ttl; 1294 u8 tos; 1295 u8 pad; 1296 struct efi_ip_address station_ip; 1297 struct efi_ip_address subnet_mask; 1298 struct efi_pxe_packet dhcp_discover; 1299 struct efi_pxe_packet dhcp_ack; 1300 struct efi_pxe_packet proxy_offer; 1301 struct efi_pxe_packet pxe_discover; 1302 struct efi_pxe_packet pxe_reply; 1303 }; 1304 1305 struct efi_pxe { 1306 u64 rev; 1307 void (EFIAPI *start)(void); 1308 void (EFIAPI *stop)(void); 1309 void (EFIAPI *dhcp)(void); 1310 void (EFIAPI *discover)(void); 1311 void (EFIAPI *mftp)(void); 1312 void (EFIAPI *udpwrite)(void); 1313 void (EFIAPI *udpread)(void); 1314 void (EFIAPI *setipfilter)(void); 1315 void (EFIAPI *arp)(void); 1316 void (EFIAPI *setparams)(void); 1317 void (EFIAPI *setstationip)(void); 1318 void (EFIAPI *setpackets)(void); 1319 struct efi_pxe_mode *mode; 1320 }; 1321 1322 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \ 1323 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \ 1324 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 1325 #define EFI_FILE_PROTOCOL_REVISION 0x00010000 1326 #define EFI_FILE_PROTOCOL_REVISION2 0x00020000 1327 #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2 1328 1329 struct efi_file_handle { 1330 u64 rev; 1331 efi_status_t (EFIAPI *open)(struct efi_file_handle *file, 1332 struct efi_file_handle **new_handle, 1333 u16 *file_name, u64 open_mode, u64 attributes); 1334 efi_status_t (EFIAPI *close)(struct efi_file_handle *file); 1335 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file); 1336 efi_status_t (EFIAPI *read)(struct efi_file_handle *file, 1337 efi_uintn_t *buffer_size, void *buffer); 1338 efi_status_t (EFIAPI *write)(struct efi_file_handle *file, 1339 efi_uintn_t *buffer_size, void *buffer); 1340 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file, 1341 u64 *pos); 1342 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file, 1343 u64 pos); 1344 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file, 1345 const efi_guid_t *info_type, efi_uintn_t *buffer_size, 1346 void *buffer); 1347 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file, 1348 const efi_guid_t *info_type, efi_uintn_t buffer_size, 1349 void *buffer); 1350 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file); 1351 /* 1352 * TODO: We currently only support EFI file protocol revision 0x00010000 1353 * while UEFI specs 2.4 - 2.7 prescribe revision 0x00020000. 1354 */ 1355 }; 1356 1357 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000 1358 1359 struct efi_simple_file_system_protocol { 1360 u64 rev; 1361 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this, 1362 struct efi_file_handle **root); 1363 }; 1364 1365 #define EFI_FILE_INFO_GUID \ 1366 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \ 1367 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 1368 1369 #define EFI_FILE_SYSTEM_INFO_GUID \ 1370 EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \ 1371 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b) 1372 1373 #define EFI_FILE_MODE_READ 0x0000000000000001 1374 #define EFI_FILE_MODE_WRITE 0x0000000000000002 1375 #define EFI_FILE_MODE_CREATE 0x8000000000000000 1376 1377 #define EFI_FILE_READ_ONLY 0x0000000000000001 1378 #define EFI_FILE_HIDDEN 0x0000000000000002 1379 #define EFI_FILE_SYSTEM 0x0000000000000004 1380 #define EFI_FILE_RESERVED 0x0000000000000008 1381 #define EFI_FILE_DIRECTORY 0x0000000000000010 1382 #define EFI_FILE_ARCHIVE 0x0000000000000020 1383 #define EFI_FILE_VALID_ATTR 0x0000000000000037 1384 1385 struct efi_file_info { 1386 u64 size; 1387 u64 file_size; 1388 u64 physical_size; 1389 struct efi_time create_time; 1390 struct efi_time last_access_time; 1391 struct efi_time modification_time; 1392 u64 attribute; 1393 u16 file_name[0]; 1394 }; 1395 1396 struct efi_file_system_info { 1397 u64 size; 1398 u8 read_only; 1399 u64 volume_size; 1400 u64 free_space; 1401 u32 block_size; 1402 u16 volume_label[0]; 1403 }; 1404 1405 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \ 1406 EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\ 1407 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71) 1408 struct efi_driver_binding_protocol { 1409 efi_status_t (EFIAPI * supported)( 1410 struct efi_driver_binding_protocol *this, 1411 efi_handle_t controller_handle, 1412 struct efi_device_path *remaining_device_path); 1413 efi_status_t (EFIAPI * start)( 1414 struct efi_driver_binding_protocol *this, 1415 efi_handle_t controller_handle, 1416 struct efi_device_path *remaining_device_path); 1417 efi_status_t (EFIAPI * stop)( 1418 struct efi_driver_binding_protocol *this, 1419 efi_handle_t controller_handle, 1420 efi_uintn_t number_of_children, 1421 efi_handle_t *child_handle_buffer); 1422 u32 version; 1423 efi_handle_t image_handle; 1424 efi_handle_t driver_binding_handle; 1425 }; 1426 1427 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \ 1428 EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \ 1429 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49) 1430 struct efi_unicode_collation_protocol { 1431 efi_intn_t (EFIAPI *stri_coll)( 1432 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2); 1433 bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this, 1434 const u16 *string, const u16 *patter); 1435 void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol 1436 *this, u16 *string); 1437 void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this, 1438 u16 *string); 1439 void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this, 1440 efi_uintn_t fat_size, char *fat, u16 *string); 1441 bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this, 1442 const u16 *string, efi_uintn_t fat_size, 1443 char *fat); 1444 char *supported_languages; 1445 }; 1446 1447 /* Boot manager load options */ 1448 #define LOAD_OPTION_ACTIVE 0x00000001 1449 #define LOAD_OPTION_FORCE_RECONNECT 0x00000002 1450 #define LOAD_OPTION_HIDDEN 0x00000008 1451 /* All values 0x00000200-0x00001F00 are reserved */ 1452 #define LOAD_OPTION_CATEGORY 0x00001F00 1453 #define LOAD_OPTION_CATEGORY_BOOT 0x00000000 1454 #define LOAD_OPTION_CATEGORY_APP 0x00000100 1455 1456 #endif 1457