arch/all-pc/boot/grub2-aros/include/grub/efi/api.h

   1 /* efi.h - declare EFI types and functions */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2006,2007,2008,2009  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GRUB_EFI_API_HEADER
  21 #define GRUB_EFI_API_HEADER     1
  22
  23 #include <grub/types.h>
  24 #include <grub/symbol.h>
  25
  26 /* For consistency and safety, we name the EFI-defined types differently.
  27    All names are transformed into lower case, _t appended, and
  28    grub_efi_ prepended.  */
  29
  30 /* Constants.  */
  31 #define GRUB_EFI_EVT_TIMER                              0x80000000
  32 #define GRUB_EFI_EVT_RUNTIME                            0x40000000
  33 #define GRUB_EFI_EVT_RUNTIME_CONTEXT                    0x20000000
  34 #define GRUB_EFI_EVT_NOTIFY_WAIT                        0x00000100
  35 #define GRUB_EFI_EVT_NOTIFY_SIGNAL                      0x00000200
  36 #define GRUB_EFI_EVT_SIGNAL_EXIT_BOOT_SERVICES          0x00000201
  37 #define GRUB_EFI_EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE      0x60000202
  38
  39 #define GRUB_EFI_TPL_APPLICATION        4
  40 #define GRUB_EFI_TPL_CALLBACK           8
  41 #define GRUB_EFI_TPL_NOTIFY             16
  42 #define GRUB_EFI_TPL_HIGH_LEVEL         31
  43
  44 #define GRUB_EFI_MEMORY_UC      0x0000000000000001LL
  45 #define GRUB_EFI_MEMORY_WC      0x0000000000000002LL
  46 #define GRUB_EFI_MEMORY_WT      0x0000000000000004LL
  47 #define GRUB_EFI_MEMORY_WB      0x0000000000000008LL
  48 #define GRUB_EFI_MEMORY_UCE     0x0000000000000010LL
  49 #define GRUB_EFI_MEMORY_WP      0x0000000000001000LL
  50 #define GRUB_EFI_MEMORY_RP      0x0000000000002000LL
  51 #define GRUB_EFI_MEMORY_XP      0x0000000000004000LL
  52 #define GRUB_EFI_MEMORY_RUNTIME 0x8000000000000000LL
  53
  54 #define GRUB_EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL       0x00000001
  55 #define GRUB_EFI_OPEN_PROTOCOL_GET_PROTOCOL             0x00000002
  56 #define GRUB_EFI_OPEN_PROTOCOL_TEST_PROTOCOL            0x00000004
  57 #define GRUB_EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER      0x00000008
  58 #define GRUB_EFI_OPEN_PROTOCOL_BY_DRIVER                0x00000010
  59 #define GRUB_EFI_OPEN_PROTOCOL_BY_EXCLUSIVE             0x00000020
  60
  61 #define GRUB_EFI_VARIABLE_NON_VOLATILE          0x0000000000000001
  62 #define GRUB_EFI_VARIABLE_BOOTSERVICE_ACCESS    0x0000000000000002
  63 #define GRUB_EFI_VARIABLE_RUNTIME_ACCESS        0x0000000000000004
  64
  65 #define GRUB_EFI_TIME_ADJUST_DAYLIGHT   0x01
  66 #define GRUB_EFI_TIME_IN_DAYLIGHT       0x02
  67
  68 #define GRUB_EFI_UNSPECIFIED_TIMEZONE   0x07FF
  69
  70 #define GRUB_EFI_OPTIONAL_PTR   0x00000001
  71
  72 #define GRUB_EFI_LOADED_IMAGE_GUID      \
  73   { 0x5b1b31a1, 0x9562, 0x11d2, \
  74     { 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  75   }
  76
  77 #define GRUB_EFI_DISK_IO_GUID   \
  78   { 0xce345171, 0xba0b, 0x11d2, \
  79     { 0x8e, 0x4f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  80   }
  81
  82 #define GRUB_EFI_BLOCK_IO_GUID  \
  83   { 0x964e5b21, 0x6459, 0x11d2, \
  84     { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
  85   }
  86
  87 #define GRUB_EFI_SERIAL_IO_GUID \
  88   { 0xbb25cf6f, 0xf1d4, 0x11d2, \
  89     { 0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0xfd } \
  90   }
  91
  92 #define GRUB_EFI_SIMPLE_NETWORK_GUID    \
  93   { 0xa19832b9, 0xac25, 0x11d3, \
  94     { 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
  95   }
  96
  97 #define GRUB_EFI_PXE_GUID       \
  98   { 0x03c4e603, 0xac28, 0x11d3, \
  99     { 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
 100   }
 101
 102 #define GRUB_EFI_DEVICE_PATH_GUID       \
 103   { 0x09576e91, 0x6d3f, 0x11d2, \
 104     { 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \
 105   }
 106
 107 #define GRUB_EFI_MPS_TABLE_GUID \
 108   { 0xeb9d2d2f, 0x2d88, 0x11d3, \
 109     { 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
 110   }
 111
 112 #define GRUB_EFI_ACPI_TABLE_GUID        \
 113   { 0xeb9d2d30, 0x2d88, 0x11d3, \
 114     { 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
 115   }
 116
 117 #define GRUB_EFI_ACPI_20_TABLE_GUID     \
 118   { 0x8868e871, 0xe4f1, 0x11d3, \
 119     { 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } \
 120   }
 121
 122 #define GRUB_EFI_SMBIOS_TABLE_GUID      \
 123   { 0xeb9d2d31, 0x2d88, 0x11d3, \
 124     { 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
 125   }
 126
 127 #define GRUB_EFI_SAL_TABLE_GUID \
 128   { 0xeb9d2d32, 0x2d88, 0x11d3, \
 129       { 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
 130   }
 131
 132 #define GRUB_EFI_HCDP_TABLE_GUID \
 133   { 0xf951938d, 0x620b, 0x42ef, \
 134       { 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 } \
 135   }
 136
 137 struct grub_efi_sal_system_table
 138 {
 139   grub_uint32_t signature;
 140   grub_uint32_t total_table_len;
 141   grub_uint16_t sal_rev;
 142   grub_uint16_t entry_count;
 143   grub_uint8_t checksum;
 144   grub_uint8_t reserved1[7];
 145   grub_uint16_t sal_a_version;
 146   grub_uint16_t sal_b_version;
 147   grub_uint8_t oem_id[32];
 148   grub_uint8_t product_id[32];
 149   grub_uint8_t reserved2[8];
 150   grub_uint8_t entries[0];
 151 };
 152
 153 enum
 154   {
 155     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_ENTRYPOINT_DESCRIPTOR = 0,
 156     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_MEMORY_DESCRIPTOR = 1,
 157     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_PLATFORM_FEATURES = 2,
 158     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_TRANSLATION_REGISTER_DESCRIPTOR = 3,
 159     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_PURGE_TRANSLATION_COHERENCE = 4,
 160     GRUB_EFI_SAL_SYSTEM_TABLE_TYPE_AP_WAKEUP = 5
 161   };
 162
 163 struct grub_efi_sal_system_table_entrypoint_descriptor
 164 {
 165   grub_uint8_t type;
 166   grub_uint8_t pad[7];
 167   grub_uint64_t pal_proc_addr;
 168   grub_uint64_t sal_proc_addr;
 169   grub_uint64_t global_data_ptr;
 170   grub_uint64_t reserved[2];
 171 };
 172
 173 struct grub_efi_sal_system_table_memory_descriptor
 174 {
 175   grub_uint8_t type;
 176   grub_uint8_t sal_used;
 177   grub_uint8_t attr;
 178   grub_uint8_t ar;
 179   grub_uint8_t attr_mask;
 180   grub_uint8_t mem_type;
 181   grub_uint8_t usage;
 182   grub_uint8_t unknown;
 183   grub_uint64_t addr;
 184   grub_uint64_t len;
 185   grub_uint64_t unknown2;
 186 };
 187
 188 struct grub_efi_sal_system_table_platform_features
 189 {
 190   grub_uint8_t type;
 191   grub_uint8_t flags;
 192   grub_uint8_t reserved[14];
 193 };
 194
 195 struct grub_efi_sal_system_table_translation_register_descriptor
 196 {
 197   grub_uint8_t type;
 198   grub_uint8_t register_type;
 199   grub_uint8_t register_number;
 200   grub_uint8_t reserved[5];
 201   grub_uint64_t addr;
 202   grub_uint64_t page_size;
 203   grub_uint64_t reserver;
 204 };
 205
 206 struct grub_efi_sal_system_table_purge_translation_coherence
 207 {
 208   grub_uint8_t type;
 209   grub_uint8_t reserved[3];
 210   grub_uint32_t ndomains;
 211   grub_uint64_t coherence;
 212 };
 213
 214 struct grub_efi_sal_system_table_ap_wakeup
 215 {
 216   grub_uint8_t type;
 217   grub_uint8_t mechanism;
 218   grub_uint8_t reserved[6];
 219   grub_uint64_t vector;
 220 };
 221
 222 enum
 223   {
 224     GRUB_EFI_SAL_SYSTEM_TABLE_PLATFORM_FEATURE_BUSLOCK = 1,
 225     GRUB_EFI_SAL_SYSTEM_TABLE_PLATFORM_FEATURE_IRQREDIRECT = 2,
 226     GRUB_EFI_SAL_SYSTEM_TABLE_PLATFORM_FEATURE_IPIREDIRECT = 4,
 227     GRUB_EFI_SAL_SYSTEM_TABLE_PLATFORM_FEATURE_ITCDRIFT = 8,
 228   };
 229
 230 typedef enum grub_efi_parity_type
 231   {
 232     GRUB_EFI_SERIAL_DEFAULT_PARITY,
 233     GRUB_EFI_SERIAL_NO_PARITY,
 234     GRUB_EFI_SERIAL_EVEN_PARITY,
 235     GRUB_EFI_SERIAL_ODD_PARITY
 236   }
 237 grub_efi_parity_type_t;
 238
 239 typedef enum grub_efi_stop_bits
 240   {
 241     GRUB_EFI_SERIAL_DEFAULT_STOP_BITS,
 242     GRUB_EFI_SERIAL_1_STOP_BIT,
 243     GRUB_EFI_SERIAL_1_5_STOP_BITS,
 244     GRUB_EFI_SERIAL_2_STOP_BITS
 245   }
 246   grub_efi_stop_bits_t;
 247
 248 /* Enumerations.  */
 249 enum grub_efi_timer_delay
 250   {
 251     GRUB_EFI_TIMER_CANCEL,
 252     GRUB_EFI_TIMER_PERIODIC,
 253     GRUB_EFI_TIMER_RELATIVE
 254   };
 255 typedef enum grub_efi_timer_delay grub_efi_timer_delay_t;
 256
 257 enum grub_efi_allocate_type
 258   {
 259     GRUB_EFI_ALLOCATE_ANY_PAGES,
 260     GRUB_EFI_ALLOCATE_MAX_ADDRESS,
 261     GRUB_EFI_ALLOCATE_ADDRESS,
 262     GRUB_EFI_MAX_ALLOCATION_TYPE
 263   };
 264 typedef enum grub_efi_allocate_type grub_efi_allocate_type_t;
 265
 266 enum grub_efi_memory_type
 267   {
 268     GRUB_EFI_RESERVED_MEMORY_TYPE,
 269     GRUB_EFI_LOADER_CODE,
 270     GRUB_EFI_LOADER_DATA,
 271     GRUB_EFI_BOOT_SERVICES_CODE,
 272     GRUB_EFI_BOOT_SERVICES_DATA,
 273     GRUB_EFI_RUNTIME_SERVICES_CODE,
 274     GRUB_EFI_RUNTIME_SERVICES_DATA,
 275     GRUB_EFI_CONVENTIONAL_MEMORY,
 276     GRUB_EFI_UNUSABLE_MEMORY,
 277     GRUB_EFI_ACPI_RECLAIM_MEMORY,
 278     GRUB_EFI_ACPI_MEMORY_NVS,
 279     GRUB_EFI_MEMORY_MAPPED_IO,
 280     GRUB_EFI_MEMORY_MAPPED_IO_PORT_SPACE,
 281     GRUB_EFI_PAL_CODE,
 282     GRUB_EFI_MAX_MEMORY_TYPE
 283   };
 284 typedef enum grub_efi_memory_type grub_efi_memory_type_t;
 285
 286 enum grub_efi_interface_type
 287   {
 288     GRUB_EFI_NATIVE_INTERFACE
 289   };
 290 typedef enum grub_efi_interface_type grub_efi_interface_type_t;
 291
 292 enum grub_efi_locate_search_type
 293   {
 294     GRUB_EFI_ALL_HANDLES,
 295     GRUB_EFI_BY_REGISTER_NOTIFY,
 296     GRUB_EFI_BY_PROTOCOL
 297   };
 298 typedef enum grub_efi_locate_search_type grub_efi_locate_search_type_t;
 299
 300 enum grub_efi_reset_type
 301   {
 302     GRUB_EFI_RESET_COLD,
 303     GRUB_EFI_RESET_WARM,
 304     GRUB_EFI_RESET_SHUTDOWN
 305   };
 306 typedef enum grub_efi_reset_type grub_efi_reset_type_t;
 307
 308 /* Types.  */
 309 typedef char grub_efi_boolean_t;
 310 typedef long grub_efi_intn_t;
 311 typedef unsigned long grub_efi_uintn_t;
 312 typedef grub_int8_t grub_efi_int8_t;
 313 typedef grub_uint8_t grub_efi_uint8_t;
 314 typedef grub_int16_t grub_efi_int16_t;
 315 typedef grub_uint16_t grub_efi_uint16_t;
 316 typedef grub_int32_t grub_efi_int32_t;
 317 typedef grub_uint32_t grub_efi_uint32_t;
 318 typedef grub_int64_t grub_efi_int64_t;
 319 typedef grub_uint64_t grub_efi_uint64_t;
 320 typedef grub_uint8_t grub_efi_char8_t;
 321 typedef grub_uint16_t grub_efi_char16_t;
 322
 323 #define PRIxGRUB_EFI_UINTN_T "lx"
 324
 325 typedef grub_efi_intn_t grub_efi_status_t;
 326
 327 #define GRUB_EFI_ERROR_CODE(value)      \
 328   ((1L << (sizeof (grub_efi_status_t) * 8 - 1)) | (value))
 329
 330 #define GRUB_EFI_WARNING_CODE(value)    (value)
 331
 332 #define GRUB_EFI_SUCCESS                0
 333
 334 #define GRUB_EFI_LOAD_ERROR             GRUB_EFI_ERROR_CODE (1)
 335 #define GRUB_EFI_INVALID_PARAMETER      GRUB_EFI_ERROR_CODE (2)
 336 #define GRUB_EFI_UNSUPPORTED            GRUB_EFI_ERROR_CODE (3)
 337 #define GRUB_EFI_BAD_BUFFER_SIZE        GRUB_EFI_ERROR_CODE (4)
 338 #define GRUB_EFI_BUFFER_TOO_SMALL       GRUB_EFI_ERROR_CODE (5)
 339 #define GRUB_EFI_NOT_READY              GRUB_EFI_ERROR_CODE (6)
 340 #define GRUB_EFI_DEVICE_ERROR           GRUB_EFI_ERROR_CODE (7)
 341 #define GRUB_EFI_WRITE_PROTECTED        GRUB_EFI_ERROR_CODE (8)
 342 #define GRUB_EFI_OUT_OF_RESOURCES       GRUB_EFI_ERROR_CODE (9)
 343 #define GRUB_EFI_VOLUME_CORRUPTED       GRUB_EFI_ERROR_CODE (10)
 344 #define GRUB_EFI_VOLUME_FULL            GRUB_EFI_ERROR_CODE (11)
 345 #define GRUB_EFI_NO_MEDIA               GRUB_EFI_ERROR_CODE (12)
 346 #define GRUB_EFI_MEDIA_CHANGED          GRUB_EFI_ERROR_CODE (13)
 347 #define GRUB_EFI_NOT_FOUND              GRUB_EFI_ERROR_CODE (14)
 348 #define GRUB_EFI_ACCESS_DENIED          GRUB_EFI_ERROR_CODE (15)
 349 #define GRUB_EFI_NO_RESPONSE            GRUB_EFI_ERROR_CODE (16)
 350 #define GRUB_EFI_NO_MAPPING             GRUB_EFI_ERROR_CODE (17)
 351 #define GRUB_EFI_TIMEOUT                GRUB_EFI_ERROR_CODE (18)
 352 #define GRUB_EFI_NOT_STARTED            GRUB_EFI_ERROR_CODE (19)
 353 #define GRUB_EFI_ALREADY_STARTED        GRUB_EFI_ERROR_CODE (20)
 354 #define GRUB_EFI_ABORTED                GRUB_EFI_ERROR_CODE (21)
 355 #define GRUB_EFI_ICMP_ERROR             GRUB_EFI_ERROR_CODE (22)
 356 #define GRUB_EFI_TFTP_ERROR             GRUB_EFI_ERROR_CODE (23)
 357 #define GRUB_EFI_PROTOCOL_ERROR         GRUB_EFI_ERROR_CODE (24)
 358 #define GRUB_EFI_INCOMPATIBLE_VERSION   GRUB_EFI_ERROR_CODE (25)
 359 #define GRUB_EFI_SECURITY_VIOLATION     GRUB_EFI_ERROR_CODE (26)
 360 #define GRUB_EFI_CRC_ERROR              GRUB_EFI_ERROR_CODE (27)
 361
 362 #define GRUB_EFI_WARN_UNKNOWN_GLYPH     GRUB_EFI_WARNING_CODE (1)
 363 #define GRUB_EFI_WARN_DELETE_FAILURE    GRUB_EFI_WARNING_CODE (2)
 364 #define GRUB_EFI_WARN_WRITE_FAILURE     GRUB_EFI_WARNING_CODE (3)
 365 #define GRUB_EFI_WARN_BUFFER_TOO_SMALL  GRUB_EFI_WARNING_CODE (4)
 366
 367 typedef void *grub_efi_handle_t;
 368 typedef void *grub_efi_event_t;
 369 typedef grub_efi_uint64_t grub_efi_lba_t;
 370 typedef grub_efi_uintn_t grub_efi_tpl_t;
 371 typedef grub_uint8_t grub_efi_mac_address_t[32];
 372 typedef grub_uint8_t grub_efi_ipv4_address_t[4];
 373 typedef grub_uint16_t grub_efi_ipv6_address_t[8];
 374 typedef grub_uint8_t grub_efi_ip_address_t[8] __attribute__ ((aligned(4)));
 375 typedef grub_efi_uint64_t grub_efi_physical_address_t;
 376 typedef grub_efi_uint64_t grub_efi_virtual_address_t;
 377
 378 struct grub_efi_guid
 379 {
 380   grub_uint32_t data1;
 381   grub_uint16_t data2;
 382   grub_uint16_t data3;
 383   grub_uint8_t data4[8];
 384 } __attribute__ ((aligned(8)));
 385 typedef struct grub_efi_guid grub_efi_guid_t;
 386
 387 /* XXX although the spec does not specify the padding, this actually
 388    must have the padding!  */
 389 struct grub_efi_memory_descriptor
 390 {
 391   grub_efi_uint32_t type;
 392   grub_efi_uint32_t padding;
 393   grub_efi_physical_address_t physical_start;
 394   grub_efi_virtual_address_t virtual_start;
 395   grub_efi_uint64_t num_pages;
 396   grub_efi_uint64_t attribute;
 397 } __attribute__ ((packed));
 398 typedef struct grub_efi_memory_descriptor grub_efi_memory_descriptor_t;
 399
 400 /* Device Path definitions.  */
 401 struct grub_efi_device_path
 402 {
 403   grub_efi_uint8_t type;
 404   grub_efi_uint8_t subtype;
 405   grub_efi_uint8_t length[2];
 406 };
 407 typedef struct grub_efi_device_path grub_efi_device_path_t;
 408 /* XXX EFI does not define EFI_DEVICE_PATH_PROTOCOL but uses it.
 409    It seems to be identical to EFI_DEVICE_PATH.  */
 410 typedef struct grub_efi_device_path grub_efi_device_path_protocol_t;
 411
 412 #define GRUB_EFI_DEVICE_PATH_TYPE(dp)           ((dp)->type & 0x7f)
 413 #define GRUB_EFI_DEVICE_PATH_SUBTYPE(dp)        ((dp)->subtype)
 414 #define GRUB_EFI_DEVICE_PATH_LENGTH(dp)         \
 415   ((dp)->length[0] | ((grub_efi_uint16_t) ((dp)->length[1]) << 8))
 416
 417 /* The End of Device Path nodes.  */
 418 #define GRUB_EFI_END_DEVICE_PATH_TYPE                   (0xff & 0x7f)
 419
 420 #define GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE         0xff
 421 #define GRUB_EFI_END_THIS_DEVICE_PATH_SUBTYPE           0x01
 422
 423 #define GRUB_EFI_END_ENTIRE_DEVICE_PATH(dp)     \
 424   (GRUB_EFI_DEVICE_PATH_TYPE (dp) == GRUB_EFI_END_DEVICE_PATH_TYPE \
 425    && (GRUB_EFI_DEVICE_PATH_SUBTYPE (dp) \
 426        == GRUB_EFI_END_ENTIRE_DEVICE_PATH_SUBTYPE))
 427
 428 #define GRUB_EFI_NEXT_DEVICE_PATH(dp)   \
 429   ((grub_efi_device_path_t *) ((char *) (dp) \
 430                                + GRUB_EFI_DEVICE_PATH_LENGTH (dp)))
 431
 432 /* Hardware Device Path.  */
 433 #define GRUB_EFI_HARDWARE_DEVICE_PATH_TYPE              1
 434
 435 #define GRUB_EFI_PCI_DEVICE_PATH_SUBTYPE                1
 436
 437 struct grub_efi_pci_device_path
 438 {
 439   grub_efi_device_path_t header;
 440   grub_efi_uint8_t function;
 441   grub_efi_uint8_t device;
 442 } __attribute__ ((packed));
 443 typedef struct grub_efi_pci_device_path grub_efi_pci_device_path_t;
 444
 445 #define GRUB_EFI_PCCARD_DEVICE_PATH_SUBTYPE             2
 446
 447 struct grub_efi_pccard_device_path
 448 {
 449   grub_efi_device_path_t header;
 450   grub_efi_uint8_t function;
 451 } __attribute__ ((packed));
 452 typedef struct grub_efi_pccard_device_path grub_efi_pccard_device_path_t;
 453
 454 #define GRUB_EFI_MEMORY_MAPPED_DEVICE_PATH_SUBTYPE      3
 455
 456 struct grub_efi_memory_mapped_device_path
 457 {
 458   grub_efi_device_path_t header;
 459   grub_efi_uint32_t memory_type;
 460   grub_efi_physical_address_t start_address;
 461   grub_efi_physical_address_t end_address;
 462 } __attribute__ ((packed));
 463 typedef struct grub_efi_memory_mapped_device_path grub_efi_memory_mapped_device_path_t;
 464
 465 #define GRUB_EFI_VENDOR_DEVICE_PATH_SUBTYPE             4
 466
 467 struct grub_efi_vendor_device_path
 468 {
 469   grub_efi_device_path_t header;
 470   grub_efi_guid_t vendor_guid;
 471   grub_efi_uint8_t vendor_defined_data[0];
 472 } __attribute__ ((packed));
 473 typedef struct grub_efi_vendor_device_path grub_efi_vendor_device_path_t;
 474
 475 #define GRUB_EFI_CONTROLLER_DEVICE_PATH_SUBTYPE         5
 476
 477 struct grub_efi_controller_device_path
 478 {
 479   grub_efi_device_path_t header;
 480   grub_efi_uint32_t controller_number;
 481 } __attribute__ ((packed));
 482 typedef struct grub_efi_controller_device_path grub_efi_controller_device_path_t;
 483
 484 /* ACPI Device Path.  */
 485 #define GRUB_EFI_ACPI_DEVICE_PATH_TYPE                  2
 486
 487 #define GRUB_EFI_ACPI_DEVICE_PATH_SUBTYPE               1
 488
 489 struct grub_efi_acpi_device_path
 490 {
 491   grub_efi_device_path_t header;
 492   grub_efi_uint32_t hid;
 493   grub_efi_uint32_t uid;
 494 } __attribute__ ((packed));
 495 typedef struct grub_efi_acpi_device_path grub_efi_acpi_device_path_t;
 496
 497 #define GRUB_EFI_EXPANDED_ACPI_DEVICE_PATH_SUBTYPE      2
 498
 499 struct grub_efi_expanded_acpi_device_path
 500 {
 501   grub_efi_device_path_t header;
 502   grub_efi_uint32_t hid;
 503   grub_efi_uint32_t uid;
 504   grub_efi_uint32_t cid;
 505   char hidstr[0];
 506 } __attribute__ ((packed));
 507 typedef struct grub_efi_expanded_acpi_device_path grub_efi_expanded_acpi_device_path_t;
 508
 509 #define GRUB_EFI_EXPANDED_ACPI_HIDSTR(dp)       \
 510   (((grub_efi_expanded_acpi_device_path_t *) dp)->hidstr)
 511 #define GRUB_EFI_EXPANDED_ACPI_UIDSTR(dp)       \
 512   (GRUB_EFI_EXPANDED_ACPI_HIDSTR(dp) \
 513    + grub_strlen (GRUB_EFI_EXPANDED_ACPI_HIDSTR(dp)) + 1)
 514 #define GRUB_EFI_EXPANDED_ACPI_CIDSTR(dp)       \
 515   (GRUB_EFI_EXPANDED_ACPI_UIDSTR(dp) \
 516    + grub_strlen (GRUB_EFI_EXPANDED_ACPI_UIDSTR(dp)) + 1)
 517
 518 /* Messaging Device Path.  */
 519 #define GRUB_EFI_MESSAGING_DEVICE_PATH_TYPE             3
 520
 521 #define GRUB_EFI_ATAPI_DEVICE_PATH_SUBTYPE              1
 522
 523 struct grub_efi_atapi_device_path
 524 {
 525   grub_efi_device_path_t header;
 526   grub_efi_uint8_t primary_secondary;
 527   grub_efi_uint8_t slave_master;
 528   grub_efi_uint16_t lun;
 529 } __attribute__ ((packed));
 530 typedef struct grub_efi_atapi_device_path grub_efi_atapi_device_path_t;
 531
 532 #define GRUB_EFI_SCSI_DEVICE_PATH_SUBTYPE               2
 533
 534 struct grub_efi_scsi_device_path
 535 {
 536   grub_efi_device_path_t header;
 537   grub_efi_uint16_t pun;
 538   grub_efi_uint16_t lun;
 539 } __attribute__ ((packed));
 540 typedef struct grub_efi_scsi_device_path grub_efi_scsi_device_path_t;
 541
 542 #define GRUB_EFI_FIBRE_CHANNEL_DEVICE_PATH_SUBTYPE      3
 543
 544 struct grub_efi_fibre_channel_device_path
 545 {
 546   grub_efi_device_path_t header;
 547   grub_efi_uint32_t reserved;
 548   grub_efi_uint64_t wwn;
 549   grub_efi_uint64_t lun;
 550 } __attribute__ ((packed));
 551 typedef struct grub_efi_fibre_channel_device_path grub_efi_fibre_channel_device_path_t;
 552
 553 #define GRUB_EFI_1394_DEVICE_PATH_SUBTYPE               4
 554
 555 struct grub_efi_1394_device_path
 556 {
 557   grub_efi_device_path_t header;
 558   grub_efi_uint32_t reserved;
 559   grub_efi_uint64_t guid;
 560 } __attribute__ ((packed));
 561 typedef struct grub_efi_1394_device_path grub_efi_1394_device_path_t;
 562
 563 #define GRUB_EFI_USB_DEVICE_PATH_SUBTYPE                5
 564
 565 struct grub_efi_usb_device_path
 566 {
 567   grub_efi_device_path_t header;
 568   grub_efi_uint8_t parent_port_number;
 569   grub_efi_uint8_t interface;
 570 } __attribute__ ((packed));
 571 typedef struct grub_efi_usb_device_path grub_efi_usb_device_path_t;
 572
 573 #define GRUB_EFI_USB_CLASS_DEVICE_PATH_SUBTYPE          15
 574
 575 struct grub_efi_usb_class_device_path
 576 {
 577   grub_efi_device_path_t header;
 578   grub_efi_uint16_t vendor_id;
 579   grub_efi_uint16_t product_id;
 580   grub_efi_uint8_t device_class;
 581   grub_efi_uint8_t device_subclass;
 582   grub_efi_uint8_t device_protocol;
 583 } __attribute__ ((packed));
 584 typedef struct grub_efi_usb_class_device_path grub_efi_usb_class_device_path_t;
 585
 586 #define GRUB_EFI_I2O_DEVICE_PATH_SUBTYPE                6
 587
 588 struct grub_efi_i2o_device_path
 589 {
 590   grub_efi_device_path_t header;
 591   grub_efi_uint32_t tid;
 592 } __attribute__ ((packed));
 593 typedef struct grub_efi_i2o_device_path grub_efi_i2o_device_path_t;
 594
 595 #define GRUB_EFI_MAC_ADDRESS_DEVICE_PATH_SUBTYPE        11
 596
 597 struct grub_efi_mac_address_device_path
 598 {
 599   grub_efi_device_path_t header;
 600   grub_efi_mac_address_t mac_address;
 601   grub_efi_uint8_t if_type;
 602 } __attribute__ ((packed));
 603 typedef struct grub_efi_mac_address_device_path grub_efi_mac_address_device_path_t;
 604
 605 #define GRUB_EFI_IPV4_DEVICE_PATH_SUBTYPE               12
 606
 607 struct grub_efi_ipv4_device_path
 608 {
 609   grub_efi_device_path_t header;
 610   grub_efi_ipv4_address_t local_ip_address;
 611   grub_efi_ipv4_address_t remote_ip_address;
 612   grub_efi_uint16_t local_port;
 613   grub_efi_uint16_t remote_port;
 614   grub_efi_uint16_t protocol;
 615   grub_efi_uint8_t static_ip_address;
 616 } __attribute__ ((packed));
 617 typedef struct grub_efi_ipv4_device_path grub_efi_ipv4_device_path_t;
 618
 619 #define GRUB_EFI_IPV6_DEVICE_PATH_SUBTYPE               13
 620
 621 struct grub_efi_ipv6_device_path
 622 {
 623   grub_efi_device_path_t header;
 624   grub_efi_ipv6_address_t local_ip_address;
 625   grub_efi_ipv6_address_t remote_ip_address;
 626   grub_efi_uint16_t local_port;
 627   grub_efi_uint16_t remote_port;
 628   grub_efi_uint16_t protocol;
 629   grub_efi_uint8_t static_ip_address;
 630 } __attribute__ ((packed));
 631 typedef struct grub_efi_ipv6_device_path grub_efi_ipv6_device_path_t;
 632
 633 #define GRUB_EFI_INFINIBAND_DEVICE_PATH_SUBTYPE         9
 634
 635 struct grub_efi_infiniband_device_path
 636 {
 637   grub_efi_device_path_t header;
 638   grub_efi_uint32_t resource_flags;
 639   grub_efi_uint8_t port_gid[16];
 640   grub_efi_uint64_t remote_id;
 641   grub_efi_uint64_t target_port_id;
 642   grub_efi_uint64_t device_id;
 643 } __attribute__ ((packed));
 644 typedef struct grub_efi_infiniband_device_path grub_efi_infiniband_device_path_t;
 645
 646 #define GRUB_EFI_UART_DEVICE_PATH_SUBTYPE               14
 647
 648 struct grub_efi_uart_device_path
 649 {
 650   grub_efi_device_path_t header;
 651   grub_efi_uint32_t reserved;
 652   grub_efi_uint64_t baud_rate;
 653   grub_efi_uint8_t data_bits;
 654   grub_efi_uint8_t parity;
 655   grub_efi_uint8_t stop_bits;
 656 } __attribute__ ((packed));
 657 typedef struct grub_efi_uart_device_path grub_efi_uart_device_path_t;
 658
 659 #define GRUB_EFI_VENDOR_MESSAGING_DEVICE_PATH_SUBTYPE   10
 660
 661 struct grub_efi_vendor_messaging_device_path
 662 {
 663   grub_efi_device_path_t header;
 664   grub_efi_guid_t vendor_guid;
 665   grub_efi_uint8_t vendor_defined_data[0];
 666 } __attribute__ ((packed));
 667 typedef struct grub_efi_vendor_messaging_device_path grub_efi_vendor_messaging_device_path_t;
 668
 669 /* Media Device Path.  */
 670 #define GRUB_EFI_MEDIA_DEVICE_PATH_TYPE                 4
 671
 672 #define GRUB_EFI_HARD_DRIVE_DEVICE_PATH_SUBTYPE         1
 673
 674 struct grub_efi_hard_drive_device_path
 675 {
 676   grub_efi_device_path_t header;
 677   grub_efi_uint32_t partition_number;
 678   grub_efi_lba_t partition_start;
 679   grub_efi_lba_t partition_size;
 680   grub_efi_uint8_t partition_signature[8];
 681   grub_efi_uint8_t mbr_type;
 682   grub_efi_uint8_t signature_type;
 683 } __attribute__ ((packed));
 684 typedef struct grub_efi_hard_drive_device_path grub_efi_hard_drive_device_path_t;
 685
 686 #define GRUB_EFI_CDROM_DEVICE_PATH_SUBTYPE              2
 687
 688 struct grub_efi_cdrom_device_path
 689 {
 690   grub_efi_device_path_t header;
 691   grub_efi_uint32_t boot_entry;
 692   grub_efi_lba_t partition_start;
 693   grub_efi_lba_t partition_size;
 694 } __attribute__ ((packed));
 695 typedef struct grub_efi_cdrom_device_path grub_efi_cdrom_device_path_t;
 696
 697 #define GRUB_EFI_VENDOR_MEDIA_DEVICE_PATH_SUBTYPE       3
 698
 699 struct grub_efi_vendor_media_device_path
 700 {
 701   grub_efi_device_path_t header;
 702   grub_efi_guid_t vendor_guid;
 703   grub_efi_uint8_t vendor_defined_data[0];
 704 } __attribute__ ((packed));
 705 typedef struct grub_efi_vendor_media_device_path grub_efi_vendor_media_device_path_t;
 706
 707 #define GRUB_EFI_FILE_PATH_DEVICE_PATH_SUBTYPE          4
 708
 709 struct grub_efi_file_path_device_path
 710 {
 711   grub_efi_device_path_t header;
 712   grub_efi_char16_t path_name[0];
 713 } __attribute__ ((packed));
 714 typedef struct grub_efi_file_path_device_path grub_efi_file_path_device_path_t;
 715
 716 #define GRUB_EFI_PROTOCOL_DEVICE_PATH_SUBTYPE           5
 717
 718 struct grub_efi_protocol_device_path
 719 {
 720   grub_efi_device_path_t header;
 721   grub_efi_guid_t guid;
 722 } __attribute__ ((packed));
 723 typedef struct grub_efi_protocol_device_path grub_efi_protocol_device_path_t;
 724
 725 #define GRUB_EFI_PIWG_DEVICE_PATH_SUBTYPE               6
 726
 727 struct grub_efi_piwg_device_path
 728 {
 729   grub_efi_device_path_t header;
 730   grub_efi_guid_t guid __attribute__ ((packed));
 731 } __attribute__ ((packed));
 732 typedef struct grub_efi_piwg_device_path grub_efi_piwg_device_path_t;
 733
 734
 735 /* BIOS Boot Specification Device Path.  */
 736 #define GRUB_EFI_BIOS_DEVICE_PATH_TYPE                  5
 737
 738 #define GRUB_EFI_BIOS_DEVICE_PATH_SUBTYPE               1
 739
 740 struct grub_efi_bios_device_path
 741 {
 742   grub_efi_device_path_t header;
 743   grub_efi_uint16_t device_type;
 744   grub_efi_uint16_t status_flags;
 745   char description[0];
 746 } __attribute__ ((packed));
 747 typedef struct grub_efi_bios_device_path grub_efi_bios_device_path_t;
 748
 749 struct grub_efi_open_protocol_information_entry
 750 {
 751   grub_efi_handle_t agent_handle;
 752   grub_efi_handle_t controller_handle;
 753   grub_efi_uint32_t attributes;
 754   grub_efi_uint32_t open_count;
 755 };
 756 typedef struct grub_efi_open_protocol_information_entry grub_efi_open_protocol_information_entry_t;
 757
 758 struct grub_efi_time
 759 {
 760   grub_efi_uint16_t year;
 761   grub_efi_uint8_t month;
 762   grub_efi_uint8_t day;
 763   grub_efi_uint8_t hour;
 764   grub_efi_uint8_t minute;
 765   grub_efi_uint8_t second;
 766   grub_efi_uint8_t pad1;
 767   grub_efi_uint32_t nanosecond;
 768   grub_efi_int16_t time_zone;
 769   grub_efi_uint8_t daylight;
 770   grub_efi_uint8_t pad2;
 771 } __attribute__ ((packed));
 772 typedef struct grub_efi_time grub_efi_time_t;
 773
 774 struct grub_efi_time_capabilities
 775 {
 776   grub_efi_uint32_t resolution;
 777   grub_efi_uint32_t accuracy;
 778   grub_efi_boolean_t sets_to_zero;
 779 };
 780 typedef struct grub_efi_time_capabilities grub_efi_time_capabilities_t;
 781
 782 struct grub_efi_input_key
 783 {
 784   grub_efi_uint16_t scan_code;
 785   grub_efi_char16_t unicode_char;
 786 };
 787 typedef struct grub_efi_input_key grub_efi_input_key_t;
 788
 789 struct grub_efi_simple_text_output_mode
 790 {
 791   grub_efi_int32_t max_mode;
 792   grub_efi_int32_t mode;
 793   grub_efi_int32_t attribute;
 794   grub_efi_int32_t cursor_column;
 795   grub_efi_int32_t cursor_row;
 796   grub_efi_boolean_t cursor_visible;
 797 };
 798 typedef struct grub_efi_simple_text_output_mode grub_efi_simple_text_output_mode_t;
 799
 800 /* Tables.  */
 801 struct grub_efi_table_header
 802 {
 803   grub_efi_uint64_t signature;
 804   grub_efi_uint32_t revision;
 805   grub_efi_uint32_t header_size;
 806   grub_efi_uint32_t crc32;
 807   grub_efi_uint32_t reserved;
 808 };
 809 typedef struct grub_efi_table_header grub_efi_table_header_t;
 810
 811 struct grub_efi_boot_services
 812 {
 813   grub_efi_table_header_t hdr;
 814
 815   grub_efi_tpl_t
 816   (*raise_tpl) (grub_efi_tpl_t new_tpl);
 817
 818   void
 819   (*restore_tpl) (grub_efi_tpl_t old_tpl);
 820
 821   grub_efi_status_t
 822   (*allocate_pages) (grub_efi_allocate_type_t type,
 823                      grub_efi_memory_type_t memory_type,
 824                      grub_efi_uintn_t pages,
 825                      grub_efi_physical_address_t *memory);
 826
 827   grub_efi_status_t
 828   (*free_pages) (grub_efi_physical_address_t memory,
 829                  grub_efi_uintn_t pages);
 830
 831   grub_efi_status_t
 832   (*get_memory_map) (grub_efi_uintn_t *memory_map_size,
 833                      grub_efi_memory_descriptor_t *memory_map,
 834                      grub_efi_uintn_t *map_key,
 835                      grub_efi_uintn_t *descriptor_size,
 836                      grub_efi_uint32_t *descriptor_version);
 837
 838   grub_efi_status_t
 839   (*allocate_pool) (grub_efi_memory_type_t pool_type,
 840                     grub_efi_uintn_t size,
 841                     void **buffer);
 842
 843   grub_efi_status_t
 844   (*free_pool) (void *buffer);
 845
 846   grub_efi_status_t
 847   (*create_event) (grub_efi_uint32_t type,
 848                    grub_efi_tpl_t notify_tpl,
 849                    void (*notify_function) (grub_efi_event_t event,
 850                                             void *context),
 851                    void *notify_context,
 852                    grub_efi_event_t *event);
 853
 854   grub_efi_status_t
 855   (*set_timer) (grub_efi_event_t event,
 856                 grub_efi_timer_delay_t type,
 857                 grub_efi_uint64_t trigger_time);
 858
 859    grub_efi_status_t
 860    (*wait_for_event) (grub_efi_uintn_t num_events,
 861                       grub_efi_event_t *event,
 862                       grub_efi_uintn_t *index);
 863
 864   grub_efi_status_t
 865   (*signal_event) (grub_efi_event_t event);
 866
 867   grub_efi_status_t
 868   (*close_event) (grub_efi_event_t event);
 869
 870   grub_efi_status_t
 871   (*check_event) (grub_efi_event_t event);
 872
 873    grub_efi_status_t
 874    (*install_protocol_interface) (grub_efi_handle_t *handle,
 875                                   grub_efi_guid_t *protocol,
 876                                   grub_efi_interface_type_t interface_type,
 877                                   void *interface);
 878
 879   grub_efi_status_t
 880   (*reinstall_protocol_interface) (grub_efi_handle_t handle,
 881                                    grub_efi_guid_t *protocol,
 882                                    void *old_interface,
 883                                    void *new_interface);
 884
 885   grub_efi_status_t
 886   (*uninstall_protocol_interface) (grub_efi_handle_t handle,
 887                                    grub_efi_guid_t *protocol,
 888                                    void *interface);
 889
 890   grub_efi_status_t
 891   (*handle_protocol) (grub_efi_handle_t handle,
 892                       grub_efi_guid_t *protocol,
 893                       void **interface);
 894
 895   void *reserved;
 896
 897   grub_efi_status_t
 898   (*register_protocol_notify) (grub_efi_guid_t *protocol,
 899                                grub_efi_event_t event,
 900                                void **registration);
 901
 902   grub_efi_status_t
 903   (*locate_handle) (grub_efi_locate_search_type_t search_type,
 904                     grub_efi_guid_t *protocol,
 905                     void *search_key,
 906                     grub_efi_uintn_t *buffer_size,
 907                     grub_efi_handle_t *buffer);
 908
 909   grub_efi_status_t
 910   (*locate_device_path) (grub_efi_guid_t *protocol,
 911                          grub_efi_device_path_t **device_path,
 912                          grub_efi_handle_t *device);
 913
 914   grub_efi_status_t
 915   (*install_configuration_table) (grub_efi_guid_t *guid, void *table);
 916
 917   grub_efi_status_t
 918   (*load_image) (grub_efi_boolean_t boot_policy,
 919                  grub_efi_handle_t parent_image_handle,
 920                  grub_efi_device_path_t *file_path,
 921                  void *source_buffer,
 922                  grub_efi_uintn_t source_size,
 923                  grub_efi_handle_t *image_handle);
 924
 925   grub_efi_status_t
 926   (*start_image) (grub_efi_handle_t image_handle,
 927                   grub_efi_uintn_t *exit_data_size,
 928                   grub_efi_char16_t **exit_data);
 929
 930   grub_efi_status_t
 931   (*exit) (grub_efi_handle_t image_handle,
 932            grub_efi_status_t exit_status,
 933            grub_efi_uintn_t exit_data_size,
 934            grub_efi_char16_t *exit_data) __attribute__((noreturn));
 935
 936   grub_efi_status_t
 937   (*unload_image) (grub_efi_handle_t image_handle);
 938
 939   grub_efi_status_t
 940   (*exit_boot_services) (grub_efi_handle_t image_handle,
 941                          grub_efi_uintn_t map_key);
 942
 943   grub_efi_status_t
 944   (*get_next_monotonic_count) (grub_efi_uint64_t *count);
 945
 946   grub_efi_status_t
 947   (*stall) (grub_efi_uintn_t microseconds);
 948
 949   grub_efi_status_t
 950   (*set_watchdog_timer) (grub_efi_uintn_t timeout,
 951                          grub_efi_uint64_t watchdog_code,
 952                          grub_efi_uintn_t data_size,
 953                          grub_efi_char16_t *watchdog_data);
 954
 955   grub_efi_status_t
 956   (*connect_controller) (grub_efi_handle_t controller_handle,
 957                          grub_efi_handle_t *driver_image_handle,
 958                          grub_efi_device_path_protocol_t *remaining_device_path,
 959                          grub_efi_boolean_t recursive);
 960
 961   grub_efi_status_t
 962   (*disconnect_controller) (grub_efi_handle_t controller_handle,
 963                             grub_efi_handle_t driver_image_handle,
 964                             grub_efi_handle_t child_handle);
 965
 966   grub_efi_status_t
 967   (*open_protocol) (grub_efi_handle_t handle,
 968                     grub_efi_guid_t *protocol,
 969                     void **interface,
 970                     grub_efi_handle_t agent_handle,
 971                     grub_efi_handle_t controller_handle,
 972                     grub_efi_uint32_t attributes);
 973
 974   grub_efi_status_t
 975   (*close_protocol) (grub_efi_handle_t handle,
 976                      grub_efi_guid_t *protocol,
 977                      grub_efi_handle_t agent_handle,
 978                      grub_efi_handle_t controller_handle);
 979
 980   grub_efi_status_t
 981   (*open_protocol_information) (grub_efi_handle_t handle,
 982                                 grub_efi_guid_t *protocol,
 983                                 grub_efi_open_protocol_information_entry_t **entry_buffer,
 984                                 grub_efi_uintn_t *entry_count);
 985
 986   grub_efi_status_t
 987   (*protocols_per_handle) (grub_efi_handle_t handle,
 988                            grub_efi_guid_t ***protocol_buffer,
 989                            grub_efi_uintn_t *protocol_buffer_count);
 990
 991   grub_efi_status_t
 992   (*locate_handle_buffer) (grub_efi_locate_search_type_t search_type,
 993                            grub_efi_guid_t *protocol,
 994                            void *search_key,
 995                            grub_efi_uintn_t *no_handles,
 996                            grub_efi_handle_t **buffer);
 997
 998   grub_efi_status_t
 999   (*locate_protocol) (grub_efi_guid_t *protocol,
1000                       void *registration,
1001                       void **interface);
1002
1003   grub_efi_status_t
1004   (*install_multiple_protocol_interfaces) (grub_efi_handle_t *handle, ...);
1005
1006   grub_efi_status_t
1007   (*uninstall_multiple_protocol_interfaces) (grub_efi_handle_t handle, ...);
1008
1009   grub_efi_status_t
1010   (*calculate_crc32) (void *data,
1011                       grub_efi_uintn_t data_size,
1012                       grub_efi_uint32_t *crc32);
1013
1014   void
1015   (*copy_mem) (void *destination, void *source, grub_efi_uintn_t length);
1016
1017   void
1018   (*set_mem) (void *buffer, grub_efi_uintn_t size, grub_efi_uint8_t value);
1019 };
1020 typedef struct grub_efi_boot_services grub_efi_boot_services_t;
1021
1022 struct grub_efi_runtime_services
1023 {
1024   grub_efi_table_header_t hdr;
1025
1026   grub_efi_status_t
1027   (*get_time) (grub_efi_time_t *time,
1028                grub_efi_time_capabilities_t *capabilities);
1029
1030   grub_efi_status_t
1031   (*set_time) (grub_efi_time_t *time);
1032
1033   grub_efi_status_t
1034   (*get_wakeup_time) (grub_efi_boolean_t *enabled,
1035                       grub_efi_boolean_t *pending,
1036                       grub_efi_time_t *time);
1037
1038   grub_efi_status_t
1039   (*set_wakeup_time) (grub_efi_boolean_t enabled,
1040                       grub_efi_time_t *time);
1041
1042   grub_efi_status_t
1043   (*set_virtual_address_map) (grub_efi_uintn_t memory_map_size,
1044                               grub_efi_uintn_t descriptor_size,
1045                               grub_efi_uint32_t descriptor_version,
1046                               grub_efi_memory_descriptor_t *virtual_map);
1047
1048   grub_efi_status_t
1049   (*convert_pointer) (grub_efi_uintn_t debug_disposition, void **address);
1050
1051 #define GRUB_EFI_GLOBAL_VARIABLE_GUID \
1052   { 0x8BE4DF61, 0x93CA, 0x11d2, { 0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B,0x8C }}
1053
1054
1055   grub_efi_status_t
1056   (*get_variable) (grub_efi_char16_t *variable_name,
1057                    const grub_efi_guid_t *vendor_guid,
1058                    grub_efi_uint32_t *attributes,
1059                    grub_efi_uintn_t *data_size,
1060                    void *data);
1061
1062   grub_efi_status_t
1063   (*get_next_variable_name) (grub_efi_uintn_t *variable_name_size,
1064                              grub_efi_char16_t *variable_name,
1065                              grub_efi_guid_t *vendor_guid);
1066
1067   grub_efi_status_t
1068   (*set_variable) (grub_efi_char16_t *variable_name,
1069                    grub_efi_guid_t *vendor_guid,
1070                    grub_efi_uint32_t attributes,
1071                    grub_efi_uintn_t data_size,
1072                    void *data);
1073
1074   grub_efi_status_t
1075   (*get_next_high_monotonic_count) (grub_efi_uint32_t *high_count);
1076
1077   void
1078   (*reset_system) (grub_efi_reset_type_t reset_type,
1079                    grub_efi_status_t reset_status,
1080                    grub_efi_uintn_t data_size,
1081                    grub_efi_char16_t *reset_data);
1082 };
1083 typedef struct grub_efi_runtime_services grub_efi_runtime_services_t;
1084
1085 struct grub_efi_configuration_table
1086 {
1087   grub_efi_guid_t vendor_guid;
1088   void *vendor_table;
1089 } __attribute__ ((packed));
1090 typedef struct grub_efi_configuration_table grub_efi_configuration_table_t;
1091
1092 #define GRUB_EFIEMU_SYSTEM_TABLE_SIGNATURE 0x5453595320494249LL
1093 #define GRUB_EFIEMU_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552LL
1094
1095 struct grub_efi_serial_io_interface
1096 {
1097   grub_efi_uint32_t revision;
1098   void (*reset) (void);
1099   grub_efi_status_t (*set_attributes) (struct grub_efi_serial_io_interface *this,
1100                                        grub_efi_uint64_t speed,
1101                                        grub_efi_uint32_t fifo_depth,
1102                                        grub_efi_uint32_t timeout,
1103                                        grub_efi_parity_type_t parity,
1104                                        grub_uint8_t word_len,
1105                                        grub_efi_stop_bits_t stop_bits);
1106   void (*set_control_bits) (void);
1107   void (*get_control_bits) (void);
1108   grub_efi_status_t (*write) (struct grub_efi_serial_io_interface *this,
1109                               grub_efi_uintn_t *buf_size,
1110                               void *buffer);
1111   grub_efi_status_t (*read) (struct grub_efi_serial_io_interface *this,
1112                              grub_efi_uintn_t *buf_size,
1113                              void *buffer);
1114 };
1115
1116 struct grub_efi_simple_input_interface
1117 {
1118   grub_efi_status_t
1119   (*reset) (struct grub_efi_simple_input_interface *this,
1120             grub_efi_boolean_t extended_verification);
1121
1122   grub_efi_status_t
1123   (*read_key_stroke) (struct grub_efi_simple_input_interface *this,
1124                       grub_efi_input_key_t *key);
1125
1126   grub_efi_event_t wait_for_key;
1127 };
1128 typedef struct grub_efi_simple_input_interface grub_efi_simple_input_interface_t;
1129
1130 struct grub_efi_simple_text_output_interface
1131 {
1132   grub_efi_status_t
1133   (*reset) (struct grub_efi_simple_text_output_interface *this,
1134             grub_efi_boolean_t extended_verification);
1135
1136   grub_efi_status_t
1137   (*output_string) (struct grub_efi_simple_text_output_interface *this,
1138                     grub_efi_char16_t *string);
1139
1140   grub_efi_status_t
1141   (*test_string) (struct grub_efi_simple_text_output_interface *this,
1142                   grub_efi_char16_t *string);
1143
1144   grub_efi_status_t
1145   (*query_mode) (struct grub_efi_simple_text_output_interface *this,
1146                  grub_efi_uintn_t mode_number,
1147                  grub_efi_uintn_t *columns,
1148                  grub_efi_uintn_t *rows);
1149
1150   grub_efi_status_t
1151   (*set_mode) (struct grub_efi_simple_text_output_interface *this,
1152                grub_efi_uintn_t mode_number);
1153
1154   grub_efi_status_t
1155   (*set_attributes) (struct grub_efi_simple_text_output_interface *this,
1156                      grub_efi_uintn_t attribute);
1157
1158   grub_efi_status_t
1159   (*clear_screen) (struct grub_efi_simple_text_output_interface *this);
1160
1161   grub_efi_status_t
1162   (*set_cursor_position) (struct grub_efi_simple_text_output_interface *this,
1163                           grub_efi_uintn_t column,
1164                           grub_efi_uintn_t row);
1165
1166   grub_efi_status_t
1167   (*enable_cursor) (struct grub_efi_simple_text_output_interface *this,
1168                     grub_efi_boolean_t visible);
1169
1170   grub_efi_simple_text_output_mode_t *mode;
1171 };
1172 typedef struct grub_efi_simple_text_output_interface grub_efi_simple_text_output_interface_t;
1173
1174 typedef grub_uint8_t grub_efi_pxe_packet_t[1472];
1175
1176 typedef struct grub_efi_pxe_mode
1177 {
1178   grub_uint8_t unused[52];
1179   grub_efi_pxe_packet_t dhcp_discover;
1180   grub_efi_pxe_packet_t dhcp_ack;
1181   grub_efi_pxe_packet_t proxy_offer;
1182   grub_efi_pxe_packet_t pxe_discover;
1183   grub_efi_pxe_packet_t pxe_reply;
1184 } grub_efi_pxe_mode_t;
1185
1186 typedef struct grub_efi_pxe
1187 {
1188   grub_uint64_t rev;
1189   void (*start) (void);
1190   void (*stop) (void);
1191   void (*dhcp) (void);
1192   void (*discover) (void);
1193   void (*mftp) (void);
1194   void (*udpwrite) (void);
1195   void (*udpread) (void);
1196   void (*setipfilter) (void);
1197   void (*arp) (void);
1198   void (*setparams) (void);
1199   void (*setstationip) (void);
1200   void (*setpackets) (void);
1201   struct grub_efi_pxe_mode *mode;
1202 } grub_efi_pxe_t;
1203
1204 #define GRUB_EFI_BLACK          0x00
1205 #define GRUB_EFI_BLUE           0x01
1206 #define GRUB_EFI_GREEN          0x02
1207 #define GRUB_EFI_CYAN           0x03
1208 #define GRUB_EFI_RED            0x04
1209 #define GRUB_EFI_MAGENTA        0x05
1210 #define GRUB_EFI_BROWN          0x06
1211 #define GRUB_EFI_LIGHTGRAY      0x07
1212 #define GRUB_EFI_BRIGHT         0x08
1213 #define GRUB_EFI_DARKGRAY       0x08
1214 #define GRUB_EFI_LIGHTBLUE      0x09
1215 #define GRUB_EFI_LIGHTGREEN     0x0A
1216 #define GRUB_EFI_LIGHTCYAN      0x0B
1217 #define GRUB_EFI_LIGHTRED       0x0C
1218 #define GRUB_EFI_LIGHTMAGENTA   0x0D
1219 #define GRUB_EFI_YELLOW         0x0E
1220 #define GRUB_EFI_WHITE          0x0F
1221
1222 #define GRUB_EFI_BACKGROUND_BLACK       0x00
1223 #define GRUB_EFI_BACKGROUND_BLUE        0x10
1224 #define GRUB_EFI_BACKGROUND_GREEN       0x20
1225 #define GRUB_EFI_BACKGROUND_CYAN        0x30
1226 #define GRUB_EFI_BACKGROUND_RED         0x40
1227 #define GRUB_EFI_BACKGROUND_MAGENTA     0x50
1228 #define GRUB_EFI_BACKGROUND_BROWN       0x60
1229 #define GRUB_EFI_BACKGROUND_LIGHTGRAY   0x70
1230
1231 #define GRUB_EFI_TEXT_ATTR(fg, bg)      ((fg) | ((bg)))
1232
1233 struct grub_efi_system_table
1234 {
1235   grub_efi_table_header_t hdr;
1236   grub_efi_char16_t *firmware_vendor;
1237   grub_efi_uint32_t firmware_revision;
1238   grub_efi_handle_t console_in_handler;
1239   grub_efi_simple_input_interface_t *con_in;
1240   grub_efi_handle_t console_out_handler;
1241   grub_efi_simple_text_output_interface_t *con_out;
1242   grub_efi_handle_t standard_error_handle;
1243   grub_efi_simple_text_output_interface_t *std_err;
1244   grub_efi_runtime_services_t *runtime_services;
1245   grub_efi_boot_services_t *boot_services;
1246   grub_efi_uintn_t num_table_entries;
1247   grub_efi_configuration_table_t *configuration_table;
1248 };
1249 typedef struct grub_efi_system_table  grub_efi_system_table_t;
1250
1251 struct grub_efi_loaded_image
1252 {
1253   grub_efi_uint32_t revision;
1254   grub_efi_handle_t parent_handle;
1255   grub_efi_system_table_t *system_table;
1256
1257   grub_efi_handle_t device_handle;
1258   grub_efi_device_path_t *file_path;
1259   void *reserved;
1260
1261   grub_efi_uint32_t load_options_size;
1262   void *load_options;
1263
1264   void *image_base;
1265   grub_efi_uint64_t image_size;
1266   grub_efi_memory_type_t image_code_type;
1267   grub_efi_memory_type_t image_data_type;
1268
1269   grub_efi_status_t (*unload) (grub_efi_handle_t image_handle);
1270 };
1271 typedef struct grub_efi_loaded_image grub_efi_loaded_image_t;
1272
1273 struct grub_efi_disk_io
1274 {
1275   grub_efi_uint64_t revision;
1276   grub_efi_status_t (*read) (struct grub_efi_disk_io *this,
1277                              grub_efi_uint32_t media_id,
1278                              grub_efi_uint64_t offset,
1279                              grub_efi_uintn_t buffer_size,
1280                              void *buffer);
1281   grub_efi_status_t (*write) (struct grub_efi_disk_io *this,
1282                              grub_efi_uint32_t media_id,
1283                              grub_efi_uint64_t offset,
1284                              grub_efi_uintn_t buffer_size,
1285                              void *buffer);
1286 };
1287 typedef struct grub_efi_disk_io grub_efi_disk_io_t;
1288
1289 struct grub_efi_block_io_media
1290 {
1291   grub_efi_uint32_t media_id;
1292   grub_efi_boolean_t removable_media;
1293   grub_efi_boolean_t media_present;
1294   grub_efi_boolean_t logical_partition;
1295   grub_efi_boolean_t read_only;
1296   grub_efi_boolean_t write_caching;
1297   grub_efi_uint8_t pad[3];
1298   grub_efi_uint32_t block_size;
1299   grub_efi_uint32_t io_align;
1300   grub_efi_uint8_t pad2[4];
1301   grub_efi_lba_t last_block;
1302 };
1303 typedef struct grub_efi_block_io_media grub_efi_block_io_media_t;
1304
1305 typedef grub_uint8_t grub_efi_mac_t[32];
1306
1307 struct grub_efi_simple_network_mode
1308 {
1309   grub_uint32_t state;
1310   grub_uint32_t hwaddr_size;
1311   grub_uint32_t media_header_size;
1312   grub_uint32_t max_packet_size;
1313   grub_uint32_t nvram_size;
1314   grub_uint32_t nvram_access_size;
1315   grub_uint32_t receive_filter_mask;
1316   grub_uint32_t receive_filter_setting;
1317   grub_uint32_t max_mcast_filter_count;
1318   grub_uint32_t mcast_filter_count;
1319   grub_efi_mac_t mcast_filter[16];
1320   grub_efi_mac_t current_address;
1321   grub_efi_mac_t broadcast_address;
1322   grub_efi_mac_t permanent_address;
1323   grub_uint8_t if_type;
1324   grub_uint8_t mac_changeable;
1325   grub_uint8_t multitx_supported;
1326   grub_uint8_t media_present_supported;
1327   grub_uint8_t media_present;
1328 };
1329
1330 enum
1331   {
1332     GRUB_EFI_NETWORK_STOPPED,
1333     GRUB_EFI_NETWORK_STARTED,
1334     GRUB_EFI_NETWORK_INITIALIZED,
1335   };
1336
1337 struct grub_efi_simple_network
1338 {
1339   grub_uint64_t revision;
1340   grub_efi_status_t (*start) (struct grub_efi_simple_network *this);
1341   void (*stop) (void);
1342   grub_efi_status_t (*initialize) (struct grub_efi_simple_network *this,
1343                                    grub_efi_uintn_t extra_rx,
1344                                    grub_efi_uintn_t extra_tx);
1345   void (*reset) (void);
1346   void (*shutdown) (void);
1347   void (*receive_filters) (void);
1348   void (*station_address) (void);
1349   void (*statistics) (void);
1350   void (*mcastiptomac) (void);
1351   void (*nvdata) (void);
1352   grub_efi_status_t (*get_status) (struct grub_efi_simple_network *this,
1353                                    grub_uint32_t *int_status,
1354                                    void **txbuf);
1355   grub_efi_status_t (*transmit) (struct grub_efi_simple_network *this,
1356                                  grub_efi_uintn_t header_size,
1357                                  grub_efi_uintn_t buffer_size,
1358                                  void *buffer,
1359                                  grub_efi_mac_t *src_addr,
1360                                  grub_efi_mac_t *dest_addr,
1361                                  grub_efi_uint16_t *protocol);
1362   grub_efi_status_t (*receive) (struct grub_efi_simple_network *this,
1363                                 grub_efi_uintn_t *header_size,
1364                                 grub_efi_uintn_t *buffer_size,
1365                                 void *buffer,
1366                                 grub_efi_mac_t *src_addr,
1367                                 grub_efi_mac_t *dest_addr,
1368                                 grub_uint16_t *protocol);
1369   void (*waitforpacket) (void);
1370   struct grub_efi_simple_network_mode *mode;
1371 };
1372 typedef struct grub_efi_simple_network grub_efi_simple_network_t;
1373
1374
1375 struct grub_efi_block_io
1376 {
1377   grub_efi_uint64_t revision;
1378   grub_efi_block_io_media_t *media;
1379   grub_efi_status_t (*reset) (struct grub_efi_block_io *this,
1380                               grub_efi_boolean_t extended_verification);
1381   grub_efi_status_t (*read_blocks) (struct grub_efi_block_io *this,
1382                                     grub_efi_uint32_t media_id,
1383                                     grub_efi_lba_t lba,
1384                                     grub_efi_uintn_t buffer_size,
1385                                     void *buffer);
1386   grub_efi_status_t (*write_blocks) (struct grub_efi_block_io *this,
1387                                      grub_efi_uint32_t media_id,
1388                                      grub_efi_lba_t lba,
1389                                      grub_efi_uintn_t buffer_size,
1390                                      void *buffer);
1391   grub_efi_status_t (*flush_blocks) (struct grub_efi_block_io *this);
1392 };
1393 typedef struct grub_efi_block_io grub_efi_block_io_t;
1394
1395 #if (GRUB_TARGET_SIZEOF_VOID_P == 4) || defined (__ia64__)
1396
1397 #define efi_call_0(func)                func()
1398 #define efi_call_1(func, a)             func(a)
1399 #define efi_call_2(func, a, b)          func(a, b)
1400 #define efi_call_3(func, a, b, c)       func(a, b, c)
1401 #define efi_call_4(func, a, b, c, d)    func(a, b, c, d)
1402 #define efi_call_5(func, a, b, c, d, e) func(a, b, c, d, e)
1403 #define efi_call_6(func, a, b, c, d, e, f) func(a, b, c, d, e, f)
1404 #define efi_call_7(func, a, b, c, d, e, f, g) func(a, b, c, d, e, f, g)
1405 #define efi_call_10(func, a, b, c, d, e, f, g, h, i, j) func(a, b, c, d, e, f, g, h, i, j)
1406
1407 #else
1408
1409 #define efi_call_0(func) \
1410   efi_wrap_0(func)
1411 #define efi_call_1(func, a) \
1412   efi_wrap_1(func, (grub_uint64_t) (a))
1413 #define efi_call_2(func, a, b) \
1414   efi_wrap_2(func, (grub_uint64_t) (a), (grub_uint64_t) (b))
1415 #define efi_call_3(func, a, b, c) \
1416   efi_wrap_3(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1417              (grub_uint64_t) (c))
1418 #define efi_call_4(func, a, b, c, d) \
1419   efi_wrap_4(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1420              (grub_uint64_t) (c), (grub_uint64_t) (d))
1421 #define efi_call_5(func, a, b, c, d, e) \
1422   efi_wrap_5(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1423              (grub_uint64_t) (c), (grub_uint64_t) (d), (grub_uint64_t) (e))
1424 #define efi_call_6(func, a, b, c, d, e, f) \
1425   efi_wrap_6(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1426              (grub_uint64_t) (c), (grub_uint64_t) (d), (grub_uint64_t) (e), \
1427              (grub_uint64_t) (f))
1428 #define efi_call_7(func, a, b, c, d, e, f, g) \
1429   efi_wrap_7(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1430              (grub_uint64_t) (c), (grub_uint64_t) (d), (grub_uint64_t) (e), \
1431              (grub_uint64_t) (f), (grub_uint64_t) (g))
1432 #define efi_call_10(func, a, b, c, d, e, f, g, h, i, j) \
1433   efi_wrap_10(func, (grub_uint64_t) (a), (grub_uint64_t) (b), \
1434               (grub_uint64_t) (c), (grub_uint64_t) (d), (grub_uint64_t) (e), \
1435               (grub_uint64_t) (f), (grub_uint64_t) (g), (grub_uint64_t) (h), \
1436               (grub_uint64_t) (i), (grub_uint64_t) (j))
1437
1438 grub_uint64_t EXPORT_FUNC(efi_wrap_0) (void *func);
1439 grub_uint64_t EXPORT_FUNC(efi_wrap_1) (void *func, grub_uint64_t arg1);
1440 grub_uint64_t EXPORT_FUNC(efi_wrap_2) (void *func, grub_uint64_t arg1,
1441                                        grub_uint64_t arg2);
1442 grub_uint64_t EXPORT_FUNC(efi_wrap_3) (void *func, grub_uint64_t arg1,
1443                                        grub_uint64_t arg2, grub_uint64_t arg3);
1444 grub_uint64_t EXPORT_FUNC(efi_wrap_4) (void *func, grub_uint64_t arg1,
1445                                        grub_uint64_t arg2, grub_uint64_t arg3,
1446                                        grub_uint64_t arg4);
1447 grub_uint64_t EXPORT_FUNC(efi_wrap_5) (void *func, grub_uint64_t arg1,
1448                                        grub_uint64_t arg2, grub_uint64_t arg3,
1449                                        grub_uint64_t arg4, grub_uint64_t arg5);
1450 grub_uint64_t EXPORT_FUNC(efi_wrap_6) (void *func, grub_uint64_t arg1,
1451                                        grub_uint64_t arg2, grub_uint64_t arg3,
1452                                        grub_uint64_t arg4, grub_uint64_t arg5,
1453                                        grub_uint64_t arg6);
1454 grub_uint64_t EXPORT_FUNC(efi_wrap_7) (void *func, grub_uint64_t arg1,
1455                                        grub_uint64_t arg2, grub_uint64_t arg3,
1456                                        grub_uint64_t arg4, grub_uint64_t arg5,
1457                                        grub_uint64_t arg6, grub_uint64_t arg7);
1458 grub_uint64_t EXPORT_FUNC(efi_wrap_10) (void *func, grub_uint64_t arg1,
1459                                         grub_uint64_t arg2, grub_uint64_t arg3,
1460                                         grub_uint64_t arg4, grub_uint64_t arg5,
1461                                         grub_uint64_t arg6, grub_uint64_t arg7,
1462                                         grub_uint64_t arg8, grub_uint64_t arg9,
1463                                         grub_uint64_t arg10);
1464 #endif
1465
1466 #endif /* ! GRUB_EFI_API_HEADER */