efi_loader: use const efi_guid_t * for variable services
[oweals/u-boot.git] / include / efi_api.h
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
21 #ifdef CONFIG_EFI_LOADER
22 #include <asm/setjmp.h>
23 #endif
24
25 /* UEFI spec version 2.7 */
26 #define EFI_SPECIFICATION_VERSION (2 << 16 | 70)
27
28 /* Types and defines for EFI CreateEvent */
29 enum efi_timer_delay {
30         EFI_TIMER_STOP = 0,
31         EFI_TIMER_PERIODIC = 1,
32         EFI_TIMER_RELATIVE = 2
33 };
34
35 #define efi_intn_t ssize_t
36 #define efi_uintn_t size_t
37 typedef uint16_t *efi_string_t;
38
39 #define EVT_TIMER                               0x80000000
40 #define EVT_RUNTIME                             0x40000000
41 #define EVT_NOTIFY_WAIT                         0x00000100
42 #define EVT_NOTIFY_SIGNAL                       0x00000200
43 #define EVT_SIGNAL_EXIT_BOOT_SERVICES           0x00000201
44 #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE       0x60000202
45
46 #define TPL_APPLICATION         0x04
47 #define TPL_CALLBACK            0x08
48 #define TPL_NOTIFY              0x10
49 #define TPL_HIGH_LEVEL          0x1F
50
51 struct efi_event;
52
53 /* EFI Boot Services table */
54 #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
55 struct efi_boot_services {
56         struct efi_table_hdr hdr;
57         efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
58         void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
59
60         efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
61                                               efi_physical_addr_t *);
62         efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
63         efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
64                                               struct efi_mem_desc *desc,
65                                               efi_uintn_t *key,
66                                               efi_uintn_t *desc_size,
67                                               u32 *desc_version);
68         efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
69         efi_status_t (EFIAPI *free_pool)(void *);
70
71         efi_status_t (EFIAPI *create_event)(uint32_t type,
72                         efi_uintn_t notify_tpl,
73                         void (EFIAPI *notify_function) (
74                                         struct efi_event *event,
75                                         void *context),
76                         void *notify_context, struct efi_event **event);
77         efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
78                                          enum efi_timer_delay type,
79                                          uint64_t trigger_time);
80         efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
81                                               struct efi_event **event,
82                                               efi_uintn_t *index);
83         efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
84         efi_status_t (EFIAPI *close_event)(struct efi_event *event);
85         efi_status_t (EFIAPI *check_event)(struct efi_event *event);
86 #define EFI_NATIVE_INTERFACE    0x00000000
87         efi_status_t (EFIAPI *install_protocol_interface)(
88                         efi_handle_t *handle, const efi_guid_t *protocol,
89                         int protocol_interface_type, void *protocol_interface);
90         efi_status_t (EFIAPI *reinstall_protocol_interface)(
91                         efi_handle_t handle, const efi_guid_t *protocol,
92                         void *old_interface, void *new_interface);
93         efi_status_t (EFIAPI *uninstall_protocol_interface)(
94                         efi_handle_t handle, const efi_guid_t *protocol,
95                         void *protocol_interface);
96         efi_status_t (EFIAPI *handle_protocol)(
97                         efi_handle_t handle, const efi_guid_t *protocol,
98                         void **protocol_interface);
99         void *reserved;
100         efi_status_t (EFIAPI *register_protocol_notify)(
101                         const efi_guid_t *protocol, struct efi_event *event,
102                         void **registration);
103         efi_status_t (EFIAPI *locate_handle)(
104                         enum efi_locate_search_type search_type,
105                         const efi_guid_t *protocol, void *search_key,
106                         efi_uintn_t *buffer_size, efi_handle_t *buffer);
107         efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
108                         struct efi_device_path **device_path,
109                         efi_handle_t *device);
110         efi_status_t (EFIAPI *install_configuration_table)(
111                         efi_guid_t *guid, void *table);
112
113         efi_status_t (EFIAPI *load_image)(bool boot_policiy,
114                         efi_handle_t parent_image,
115                         struct efi_device_path *file_path, void *source_buffer,
116                         efi_uintn_t source_size, efi_handle_t *image);
117         efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
118                                            efi_uintn_t *exitdata_size,
119                                            u16 **exitdata);
120         efi_status_t (EFIAPI *exit)(efi_handle_t handle,
121                                     efi_status_t exit_status,
122                                     efi_uintn_t exitdata_size, u16 *exitdata);
123         efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
124         efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
125
126         efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
127         efi_status_t (EFIAPI *stall)(unsigned long usecs);
128         efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
129                         uint64_t watchdog_code, unsigned long data_size,
130                         uint16_t *watchdog_data);
131         efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
132                         efi_handle_t *driver_image_handle,
133                         struct efi_device_path *remaining_device_path,
134                         bool recursive);
135         efi_status_t (EFIAPI *disconnect_controller)(
136                         efi_handle_t controller_handle,
137                         efi_handle_t driver_image_handle,
138                         efi_handle_t child_handle);
139 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL  0x00000001
140 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL        0x00000002
141 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL       0x00000004
142 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
143 #define EFI_OPEN_PROTOCOL_BY_DRIVER           0x00000010
144 #define EFI_OPEN_PROTOCOL_EXCLUSIVE           0x00000020
145         efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
146                         const efi_guid_t *protocol, void **interface,
147                         efi_handle_t agent_handle,
148                         efi_handle_t controller_handle, u32 attributes);
149         efi_status_t (EFIAPI *close_protocol)(
150                         efi_handle_t handle, const efi_guid_t *protocol,
151                         efi_handle_t agent_handle,
152                         efi_handle_t controller_handle);
153         efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
154                         const efi_guid_t *protocol,
155                         struct efi_open_protocol_info_entry **entry_buffer,
156                         efi_uintn_t *entry_count);
157         efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
158                         efi_guid_t ***protocol_buffer,
159                         efi_uintn_t *protocols_buffer_count);
160         efi_status_t (EFIAPI *locate_handle_buffer) (
161                         enum efi_locate_search_type search_type,
162                         const efi_guid_t *protocol, void *search_key,
163                         efi_uintn_t *no_handles, efi_handle_t **buffer);
164         efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
165                         void *registration, void **protocol_interface);
166         efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
167                         efi_handle_t *handle, ...);
168         efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
169                         efi_handle_t handle, ...);
170         efi_status_t (EFIAPI *calculate_crc32)(const void *data,
171                                                efi_uintn_t data_size,
172                                                u32 *crc32);
173         void (EFIAPI *copy_mem)(void *destination, const void *source,
174                         size_t length);
175         void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
176         efi_status_t (EFIAPI *create_event_ex)(
177                                 uint32_t type, efi_uintn_t notify_tpl,
178                                 void (EFIAPI *notify_function) (
179                                         struct efi_event *event,
180                                         void *context),
181                                 void *notify_context,
182                                 efi_guid_t *event_group,
183                                 struct efi_event **event);
184 };
185
186 /* Types and defines for EFI ResetSystem */
187 enum efi_reset_type {
188         EFI_RESET_COLD = 0,
189         EFI_RESET_WARM = 1,
190         EFI_RESET_SHUTDOWN = 2,
191         EFI_RESET_PLATFORM_SPECIFIC = 3,
192 };
193
194 /* EFI Runtime Services table */
195 #define EFI_RUNTIME_SERVICES_SIGNATURE  0x56524553544e5552ULL
196
197 #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET      0x00010000
198 #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE     0x00020000
199 #define CAPSULE_FLAGS_INITIATE_RESET            0x00040000
200
201 struct efi_capsule_header {
202         efi_guid_t *capsule_guid;
203         u32 header_size;
204         u32 flags;
205         u32 capsule_image_size;
206 };
207
208 struct efi_runtime_services {
209         struct efi_table_hdr hdr;
210         efi_status_t (EFIAPI *get_time)(struct efi_time *time,
211                         struct efi_time_cap *capabilities);
212         efi_status_t (EFIAPI *set_time)(struct efi_time *time);
213         efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
214                         struct efi_time *time);
215         efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
216                         struct efi_time *time);
217         efi_status_t (EFIAPI *set_virtual_address_map)(
218                         unsigned long memory_map_size,
219                         unsigned long descriptor_size,
220                         uint32_t descriptor_version,
221                         struct efi_mem_desc *virtmap);
222         efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
223         efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
224                                             const efi_guid_t *vendor,
225                                             u32 *attributes,
226                                             efi_uintn_t *data_size, void *data);
227         efi_status_t (EFIAPI *get_next_variable_name)(
228                         efi_uintn_t *variable_name_size,
229                         u16 *variable_name, const efi_guid_t *vendor);
230         efi_status_t (EFIAPI *set_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_high_mono_count)(
235                         uint32_t *high_count);
236         void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
237                                     efi_status_t reset_status,
238                                     unsigned long data_size, void *reset_data);
239         efi_status_t (EFIAPI *update_capsule)(
240                         struct efi_capsule_header **capsule_header_array,
241                         efi_uintn_t capsule_count,
242                         u64 scatter_gather_list);
243         efi_status_t (EFIAPI *query_capsule_caps)(
244                         struct efi_capsule_header **capsule_header_array,
245                         efi_uintn_t capsule_count,
246                         u64 *maximum_capsule_size,
247                         u32 *reset_type);
248         efi_status_t (EFIAPI *query_variable_info)(
249                         u32 attributes,
250                         u64 *maximum_variable_storage_size,
251                         u64 *remaining_variable_storage_size,
252                         u64 *maximum_variable_size);
253 };
254
255 /* EFI event group GUID definitions */
256 #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
257         EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
258                  0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
259
260 #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
261         EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
262                  0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
263
264 #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
265         EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
266                  0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
267
268 #define EFI_EVENT_GROUP_READY_TO_BOOT \
269         EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
270                  0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
271
272 #define EFI_EVENT_GROUP_RESET_SYSTEM \
273         EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
274                  0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
275
276 /* EFI Configuration Table and GUID definitions */
277 #define NULL_GUID \
278         EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
279                  0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
280
281 #define EFI_GLOBAL_VARIABLE_GUID \
282         EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
283                  0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
284
285 #define LOADED_IMAGE_PROTOCOL_GUID \
286         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
287                  0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
288
289 #define EFI_FDT_GUID \
290         EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
291                  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
292
293 #define EFI_ACPI_TABLE_GUID \
294         EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
295                  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
296
297 #define SMBIOS_TABLE_GUID \
298         EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  \
299                  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
300
301 struct efi_configuration_table {
302         efi_guid_t guid;
303         void *table;
304 } __packed;
305
306 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
307
308 struct efi_system_table {
309         struct efi_table_hdr hdr;
310         u16 *fw_vendor;   /* physical addr of wchar_t vendor string */
311         u32 fw_revision;
312         efi_handle_t con_in_handle;
313         struct efi_simple_text_input_protocol *con_in;
314         efi_handle_t con_out_handle;
315         struct efi_simple_text_output_protocol *con_out;
316         efi_handle_t stderr_handle;
317         struct efi_simple_text_output_protocol *std_err;
318         struct efi_runtime_services *runtime;
319         struct efi_boot_services *boottime;
320         efi_uintn_t nr_tables;
321         struct efi_configuration_table *tables;
322 };
323
324 #define LOADED_IMAGE_GUID \
325         EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
326                  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
327
328 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
329
330 struct efi_loaded_image {
331         u32 revision;
332         void *parent_handle;
333         struct efi_system_table *system_table;
334         efi_handle_t device_handle;
335         struct efi_device_path *file_path;
336         void *reserved;
337         u32 load_options_size;
338         void *load_options;
339         void *image_base;
340         aligned_u64 image_size;
341         unsigned int image_code_type;
342         unsigned int image_data_type;
343         unsigned long unload;
344 };
345
346 #define DEVICE_PATH_GUID \
347         EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
348                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
349
350 #define DEVICE_PATH_TYPE_END                    0x7f
351 #  define DEVICE_PATH_SUB_TYPE_INSTANCE_END     0x01
352 #  define DEVICE_PATH_SUB_TYPE_END              0xff
353
354 struct efi_device_path {
355         u8 type;
356         u8 sub_type;
357         u16 length;
358 } __packed;
359
360 struct efi_mac_addr {
361         u8 addr[32];
362 } __packed;
363
364 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE        0x01
365 #  define DEVICE_PATH_SUB_TYPE_MEMORY           0x03
366 #  define DEVICE_PATH_SUB_TYPE_VENDOR           0x04
367
368 struct efi_device_path_memory {
369         struct efi_device_path dp;
370         u32 memory_type;
371         u64 start_address;
372         u64 end_address;
373 } __packed;
374
375 struct efi_device_path_vendor {
376         struct efi_device_path dp;
377         efi_guid_t guid;
378         u8 vendor_data[];
379 } __packed;
380
381 #define DEVICE_PATH_TYPE_ACPI_DEVICE            0x02
382 #  define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE      0x01
383
384 #define EFI_PNP_ID(ID)                          (u32)(((ID) << 16) | 0x41D0)
385 #define EISA_PNP_ID(ID)                         EFI_PNP_ID(ID)
386 #define EISA_PNP_NUM(ID)                        ((ID) >> 16)
387
388 struct efi_device_path_acpi_path {
389         struct efi_device_path dp;
390         u32 hid;
391         u32 uid;
392 } __packed;
393
394 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE       0x03
395 #  define DEVICE_PATH_SUB_TYPE_MSG_ATAPI        0x01
396 #  define DEVICE_PATH_SUB_TYPE_MSG_SCSI         0x02
397 #  define DEVICE_PATH_SUB_TYPE_MSG_USB          0x05
398 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR     0x0b
399 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS    0x0f
400 #  define DEVICE_PATH_SUB_TYPE_MSG_SD           0x1a
401 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC          0x1d
402
403 struct efi_device_path_atapi {
404         struct efi_device_path dp;
405         u8 primary_secondary;
406         u8 slave_master;
407         u16 logical_unit_number;
408 } __packed;
409
410 struct efi_device_path_scsi {
411         struct efi_device_path dp;
412         u16 target_id;
413         u16 logical_unit_number;
414 } __packed;
415
416 struct efi_device_path_usb {
417         struct efi_device_path dp;
418         u8 parent_port_number;
419         u8 usb_interface;
420 } __packed;
421
422 struct efi_device_path_mac_addr {
423         struct efi_device_path dp;
424         struct efi_mac_addr mac;
425         u8 if_type;
426 } __packed;
427
428 struct efi_device_path_usb_class {
429         struct efi_device_path dp;
430         u16 vendor_id;
431         u16 product_id;
432         u8 device_class;
433         u8 device_subclass;
434         u8 device_protocol;
435 } __packed;
436
437 struct efi_device_path_sd_mmc_path {
438         struct efi_device_path dp;
439         u8 slot_number;
440 } __packed;
441
442 #define DEVICE_PATH_TYPE_MEDIA_DEVICE           0x04
443 #  define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH  0x01
444 #  define DEVICE_PATH_SUB_TYPE_CDROM_PATH       0x02
445 #  define DEVICE_PATH_SUB_TYPE_FILE_PATH        0x04
446
447 struct efi_device_path_hard_drive_path {
448         struct efi_device_path dp;
449         u32 partition_number;
450         u64 partition_start;
451         u64 partition_end;
452         u8 partition_signature[16];
453         u8 partmap_type;
454         u8 signature_type;
455 } __packed;
456
457 struct efi_device_path_cdrom_path {
458         struct efi_device_path dp;
459         u32 boot_entry;
460         u64 partition_start;
461         u64 partition_end;
462 } __packed;
463
464 struct efi_device_path_file_path {
465         struct efi_device_path dp;
466         u16 str[];
467 } __packed;
468
469 #define BLOCK_IO_GUID \
470         EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
471                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
472
473 struct efi_block_io_media {
474         u32 media_id;
475         char removable_media;
476         char media_present;
477         char logical_partition;
478         char read_only;
479         char write_caching;
480         u8 pad[3];
481         u32 block_size;
482         u32 io_align;
483         u8 pad2[4];
484         u64 last_block;
485         /* Added in revision 2 of the protocol */
486         u64 lowest_aligned_lba;
487         u32 logical_blocks_per_physical_block;
488         /* Added in revision 3 of the protocol */
489         u32 optimal_transfer_length_granualarity;
490 };
491
492 #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
493 #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
494
495 struct efi_block_io {
496         u64 revision;
497         struct efi_block_io_media *media;
498         efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
499                         char extended_verification);
500         efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
501                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
502                         void *buffer);
503         efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
504                         u32 media_id, u64 lba, efi_uintn_t buffer_size,
505                         void *buffer);
506         efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
507 };
508
509 struct simple_text_output_mode {
510         s32 max_mode;
511         s32 mode;
512         s32 attribute;
513         s32 cursor_column;
514         s32 cursor_row;
515         bool cursor_visible;
516 };
517
518 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
519         EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
520                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
521
522 #define EFI_BLACK                0x00
523 #define EFI_BLUE                 0x01
524 #define EFI_GREEN                0x02
525 #define EFI_CYAN                 0x03
526 #define EFI_RED                  0x04
527 #define EFI_MAGENTA              0x05
528 #define EFI_BROWN                0x06
529 #define EFI_LIGHTGRAY            0x07
530 #define EFI_BRIGHT               0x08
531 #define EFI_DARKGRAY             0x08
532 #define EFI_LIGHTBLUE            0x09
533 #define EFI_LIGHTGREEN           0x0a
534 #define EFI_LIGHTCYAN            0x0b
535 #define EFI_LIGHTRED             0x0c
536 #define EFI_LIGHTMAGENTA         0x0d
537 #define EFI_YELLOW               0x0e
538 #define EFI_WHITE                0x0f
539 #define EFI_BACKGROUND_BLACK     0x00
540 #define EFI_BACKGROUND_BLUE      0x10
541 #define EFI_BACKGROUND_GREEN     0x20
542 #define EFI_BACKGROUND_CYAN      0x30
543 #define EFI_BACKGROUND_RED       0x40
544 #define EFI_BACKGROUND_MAGENTA   0x50
545 #define EFI_BACKGROUND_BROWN     0x60
546 #define EFI_BACKGROUND_LIGHTGRAY 0x70
547
548 /* extract foreground color from EFI attribute */
549 #define EFI_ATTR_FG(attr)        ((attr) & 0x07)
550 /* treat high bit of FG as bright/bold (similar to edk2) */
551 #define EFI_ATTR_BOLD(attr)      (((attr) >> 3) & 0x01)
552 /* extract background color from EFI attribute */
553 #define EFI_ATTR_BG(attr)        (((attr) >> 4) & 0x7)
554
555 struct efi_simple_text_output_protocol {
556         void *reset;
557         efi_status_t (EFIAPI *output_string)(
558                         struct efi_simple_text_output_protocol *this,
559                         const efi_string_t str);
560         efi_status_t (EFIAPI *test_string)(
561                         struct efi_simple_text_output_protocol *this,
562                         const efi_string_t str);
563         efi_status_t(EFIAPI *query_mode)(
564                         struct efi_simple_text_output_protocol *this,
565                         unsigned long mode_number, unsigned long *columns,
566                         unsigned long *rows);
567         efi_status_t(EFIAPI *set_mode)(
568                         struct efi_simple_text_output_protocol *this,
569                         unsigned long mode_number);
570         efi_status_t(EFIAPI *set_attribute)(
571                         struct efi_simple_text_output_protocol *this,
572                         unsigned long attribute);
573         efi_status_t(EFIAPI *clear_screen) (
574                         struct efi_simple_text_output_protocol *this);
575         efi_status_t(EFIAPI *set_cursor_position) (
576                         struct efi_simple_text_output_protocol *this,
577                         unsigned long column, unsigned long row);
578         efi_status_t(EFIAPI *enable_cursor)(
579                         struct efi_simple_text_output_protocol *this,
580                         bool enable);
581         struct simple_text_output_mode *mode;
582 };
583
584 #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
585         EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
586                  0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
587
588 struct efi_input_key {
589         u16 scan_code;
590         s16 unicode_char;
591 };
592
593 #define EFI_SHIFT_STATE_INVALID         0x00000000
594 #define EFI_RIGHT_SHIFT_PRESSED         0x00000001
595 #define EFI_LEFT_SHIFT_PRESSED          0x00000002
596 #define EFI_RIGHT_CONTROL_PRESSED       0x00000004
597 #define EFI_LEFT_CONTROL_PRESSED        0x00000008
598 #define EFI_RIGHT_ALT_PRESSED           0x00000010
599 #define EFI_LEFT_ALT_PRESSED            0x00000020
600 #define EFI_RIGHT_LOGO_PRESSED          0x00000040
601 #define EFI_LEFT_LOGO_PRESSED           0x00000080
602 #define EFI_MENU_KEY_PRESSED            0x00000100
603 #define EFI_SYS_REQ_PRESSED             0x00000200
604 #define EFI_SHIFT_STATE_VALID           0x80000000
605
606 #define EFI_TOGGLE_STATE_INVALID        0x00
607 #define EFI_SCROLL_LOCK_ACTIVE          0x01
608 #define EFI_NUM_LOCK_ACTIVE             0x02
609 #define EFI_CAPS_LOCK_ACTIVE            0x04
610 #define EFI_KEY_STATE_EXPOSED           0x40
611 #define EFI_TOGGLE_STATE_VALID          0x80
612
613 struct efi_key_state {
614         u32 key_shift_state;
615         u8 key_toggle_state;
616 };
617
618 struct efi_key_data {
619         struct efi_input_key key;
620         struct efi_key_state key_state;
621 };
622
623 struct efi_simple_text_input_ex_protocol {
624         efi_status_t (EFIAPI *reset) (
625                 struct efi_simple_text_input_ex_protocol *this,
626                 bool extended_verification);
627         efi_status_t (EFIAPI *read_key_stroke_ex) (
628                 struct efi_simple_text_input_ex_protocol *this,
629                 struct efi_key_data *key_data);
630         struct efi_event *wait_for_key_ex;
631         efi_status_t (EFIAPI *set_state) (
632                 struct efi_simple_text_input_ex_protocol *this,
633                 u8 key_toggle_state);
634         efi_status_t (EFIAPI *register_key_notify) (
635                 struct efi_simple_text_input_ex_protocol *this,
636                 struct efi_key_data *key_data,
637                 efi_status_t (EFIAPI *key_notify_function)(
638                         struct efi_key_data *key_data),
639                 void **notify_handle);
640         efi_status_t (EFIAPI *unregister_key_notify) (
641                 struct efi_simple_text_input_ex_protocol *this,
642                 void *notification_handle);
643 };
644
645 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
646         EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
647                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
648
649 struct efi_simple_text_input_protocol {
650         efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
651                                     bool extended_verification);
652         efi_status_t(EFIAPI *read_key_stroke)(
653                         struct efi_simple_text_input_protocol *this,
654                         struct efi_input_key *key);
655         struct efi_event *wait_for_key;
656 };
657
658 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
659         EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
660                  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
661
662 struct efi_device_path_to_text_protocol {
663         uint16_t *(EFIAPI *convert_device_node_to_text)(
664                         struct efi_device_path *device_node,
665                         bool display_only,
666                         bool allow_shortcuts);
667         uint16_t *(EFIAPI *convert_device_path_to_text)(
668                         struct efi_device_path *device_path,
669                         bool display_only,
670                         bool allow_shortcuts);
671 };
672
673 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
674         EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
675                  0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
676
677 struct efi_device_path_utilities_protocol {
678         efi_uintn_t (EFIAPI *get_device_path_size)(
679                 const struct efi_device_path *device_path);
680         struct efi_device_path *(EFIAPI *duplicate_device_path)(
681                 const struct efi_device_path *device_path);
682         struct efi_device_path *(EFIAPI *append_device_path)(
683                 const struct efi_device_path *src1,
684                 const struct efi_device_path *src2);
685         struct efi_device_path *(EFIAPI *append_device_node)(
686                 const struct efi_device_path *device_path,
687                 const struct efi_device_path *device_node);
688         struct efi_device_path *(EFIAPI *append_device_path_instance)(
689                 const struct efi_device_path *device_path,
690                 const struct efi_device_path *device_path_instance);
691         struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
692                 struct efi_device_path **device_path_instance,
693                 efi_uintn_t *device_path_instance_size);
694         bool (EFIAPI *is_device_path_multi_instance)(
695                 const struct efi_device_path *device_path);
696         struct efi_device_path *(EFIAPI *create_device_node)(
697                 uint8_t node_type,
698                 uint8_t node_sub_type,
699                 uint16_t node_length);
700 };
701
702 #define EFI_GOP_GUID \
703         EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
704                  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
705
706 #define EFI_GOT_RGBA8           0
707 #define EFI_GOT_BGRA8           1
708 #define EFI_GOT_BITMASK         2
709
710 struct efi_gop_mode_info {
711         u32 version;
712         u32 width;
713         u32 height;
714         u32 pixel_format;
715         u32 pixel_bitmask[4];
716         u32 pixels_per_scanline;
717 };
718
719 struct efi_gop_mode {
720         u32 max_mode;
721         u32 mode;
722         struct efi_gop_mode_info *info;
723         unsigned long info_size;
724         efi_physical_addr_t fb_base;
725         unsigned long fb_size;
726 };
727
728 struct efi_gop_pixel {
729         u8 blue;
730         u8 green;
731         u8 red;
732         u8 reserved;
733 };
734
735 #define EFI_BLT_VIDEO_FILL              0
736 #define EFI_BLT_VIDEO_TO_BLT_BUFFER     1
737 #define EFI_BLT_BUFFER_TO_VIDEO         2
738 #define EFI_BLT_VIDEO_TO_VIDEO          3
739
740 struct efi_gop {
741         efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
742                                           efi_uintn_t *size_of_info,
743                                           struct efi_gop_mode_info **info);
744         efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
745         efi_status_t (EFIAPI *blt)(struct efi_gop *this,
746                                    struct efi_gop_pixel *buffer,
747                                    u32 operation, efi_uintn_t sx,
748                                    efi_uintn_t sy, efi_uintn_t dx,
749                                    efi_uintn_t dy, efi_uintn_t width,
750                                    efi_uintn_t height, efi_uintn_t delta);
751         struct efi_gop_mode *mode;
752 };
753
754 #define EFI_SIMPLE_NETWORK_GUID \
755         EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
756                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
757
758 struct efi_mac_address {
759         char mac_addr[32];
760 };
761
762 struct efi_ip_address {
763         u8 ip_addr[16];
764 } __attribute__((aligned(4)));
765
766 enum efi_simple_network_state {
767         EFI_NETWORK_STOPPED,
768         EFI_NETWORK_STARTED,
769         EFI_NETWORK_INITIALIZED,
770 };
771
772 struct efi_simple_network_mode {
773         enum efi_simple_network_state state;
774         u32 hwaddr_size;
775         u32 media_header_size;
776         u32 max_packet_size;
777         u32 nvram_size;
778         u32 nvram_access_size;
779         u32 receive_filter_mask;
780         u32 receive_filter_setting;
781         u32 max_mcast_filter_count;
782         u32 mcast_filter_count;
783         struct efi_mac_address mcast_filter[16];
784         struct efi_mac_address current_address;
785         struct efi_mac_address broadcast_address;
786         struct efi_mac_address permanent_address;
787         u8 if_type;
788         u8 mac_changeable;
789         u8 multitx_supported;
790         u8 media_present_supported;
791         u8 media_present;
792 };
793
794 /* receive_filters bit mask */
795 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01
796 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02
797 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04
798 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08
799 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
800
801 /* interrupt status bit mask */
802 #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT    0x01
803 #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT   0x02
804 #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT    0x04
805 #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT   0x08
806
807 /* revision of the simple network protocol */
808 #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION    0x00010000
809
810 struct efi_simple_network {
811         u64 revision;
812         efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
813         efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
814         efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
815                         ulong extra_rx, ulong extra_tx);
816         efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
817                         int extended_verification);
818         efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
819         efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
820                         u32 enable, u32 disable, int reset_mcast_filter,
821                         ulong mcast_filter_count,
822                         struct efi_mac_address *mcast_filter);
823         efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
824                         int reset, struct efi_mac_address *new_mac);
825         efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
826                         int reset, ulong *stat_size, void *stat_table);
827         efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
828                         int ipv6, struct efi_ip_address *ip,
829                         struct efi_mac_address *mac);
830         efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
831                         int read_write, ulong offset, ulong buffer_size,
832                         char *buffer);
833         efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
834                         u32 *int_status, void **txbuf);
835         efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
836                         size_t header_size, size_t buffer_size, void *buffer,
837                         struct efi_mac_address *src_addr,
838                         struct efi_mac_address *dest_addr, u16 *protocol);
839         efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
840                         size_t *header_size, size_t *buffer_size, void *buffer,
841                         struct efi_mac_address *src_addr,
842                         struct efi_mac_address *dest_addr, u16 *protocol);
843         struct efi_event *wait_for_packet;
844         struct efi_simple_network_mode *mode;
845 };
846
847 #define EFI_PXE_GUID \
848         EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
849                  0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
850
851 struct efi_pxe_packet {
852         u8 packet[1472];
853 };
854
855 struct efi_pxe_mode {
856         u8 started;
857         u8 ipv6_available;
858         u8 ipv6_supported;
859         u8 using_ipv6;
860         u8 bis_supported;
861         u8 bis_detected;
862         u8 auto_arp;
863         u8 send_guid;
864         u8 dhcp_discover_valid;
865         u8 dhcp_ack_received;
866         u8 proxy_offer_received;
867         u8 pxe_discover_valid;
868         u8 pxe_reply_received;
869         u8 pxe_bis_reply_received;
870         u8 icmp_error_received;
871         u8 tftp_error_received;
872         u8 make_callbacks;
873         u8 ttl;
874         u8 tos;
875         u8 pad;
876         struct efi_ip_address station_ip;
877         struct efi_ip_address subnet_mask;
878         struct efi_pxe_packet dhcp_discover;
879         struct efi_pxe_packet dhcp_ack;
880         struct efi_pxe_packet proxy_offer;
881         struct efi_pxe_packet pxe_discover;
882         struct efi_pxe_packet pxe_reply;
883 };
884
885 struct efi_pxe {
886         u64 rev;
887         void (EFIAPI *start)(void);
888         void (EFIAPI *stop)(void);
889         void (EFIAPI *dhcp)(void);
890         void (EFIAPI *discover)(void);
891         void (EFIAPI *mftp)(void);
892         void (EFIAPI *udpwrite)(void);
893         void (EFIAPI *udpread)(void);
894         void (EFIAPI *setipfilter)(void);
895         void (EFIAPI *arp)(void);
896         void (EFIAPI *setparams)(void);
897         void (EFIAPI *setstationip)(void);
898         void (EFIAPI *setpackets)(void);
899         struct efi_pxe_mode *mode;
900 };
901
902 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
903         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
904                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
905 #define EFI_FILE_PROTOCOL_REVISION 0x00010000
906
907 struct efi_file_handle {
908         u64 rev;
909         efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
910                         struct efi_file_handle **new_handle,
911                         s16 *file_name, u64 open_mode, u64 attributes);
912         efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
913         efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
914         efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
915                         efi_uintn_t *buffer_size, void *buffer);
916         efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
917                         efi_uintn_t *buffer_size, void *buffer);
918         efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
919                                       u64 *pos);
920         efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
921                                       u64 pos);
922         efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
923                         const efi_guid_t *info_type, efi_uintn_t *buffer_size,
924                         void *buffer);
925         efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
926                         const efi_guid_t *info_type, efi_uintn_t buffer_size,
927                         void *buffer);
928         efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
929 };
930
931 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
932         EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
933                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
934 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
935
936 struct efi_simple_file_system_protocol {
937         u64 rev;
938         efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
939                         struct efi_file_handle **root);
940 };
941
942 #define EFI_FILE_INFO_GUID \
943         EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
944                  0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
945
946 #define EFI_FILE_SYSTEM_INFO_GUID \
947         EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
948                  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
949
950 #define EFI_FILE_MODE_READ      0x0000000000000001
951 #define EFI_FILE_MODE_WRITE     0x0000000000000002
952 #define EFI_FILE_MODE_CREATE    0x8000000000000000
953
954 #define EFI_FILE_READ_ONLY      0x0000000000000001
955 #define EFI_FILE_HIDDEN         0x0000000000000002
956 #define EFI_FILE_SYSTEM         0x0000000000000004
957 #define EFI_FILE_RESERVED       0x0000000000000008
958 #define EFI_FILE_DIRECTORY      0x0000000000000010
959 #define EFI_FILE_ARCHIVE        0x0000000000000020
960 #define EFI_FILE_VALID_ATTR     0x0000000000000037
961
962 struct efi_file_info {
963         u64 size;
964         u64 file_size;
965         u64 physical_size;
966         struct efi_time create_time;
967         struct efi_time last_access_time;
968         struct efi_time modification_time;
969         u64 attribute;
970         u16 file_name[0];
971 };
972
973 struct efi_file_system_info {
974         u64 size;
975         u8 read_only;
976         u64 volume_size;
977         u64 free_space;
978         u32 block_size;
979         u16 volume_label[0];
980 };
981
982 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
983         EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
984                  0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
985 struct efi_driver_binding_protocol {
986         efi_status_t (EFIAPI * supported)(
987                         struct efi_driver_binding_protocol *this,
988                         efi_handle_t controller_handle,
989                         struct efi_device_path *remaining_device_path);
990         efi_status_t (EFIAPI * start)(
991                         struct efi_driver_binding_protocol *this,
992                         efi_handle_t controller_handle,
993                         struct efi_device_path *remaining_device_path);
994         efi_status_t (EFIAPI * stop)(
995                         struct efi_driver_binding_protocol *this,
996                         efi_handle_t controller_handle,
997                         efi_uintn_t number_of_children,
998                         efi_handle_t *child_handle_buffer);
999         u32 version;
1000         efi_handle_t image_handle;
1001         efi_handle_t driver_binding_handle;
1002 };
1003
1004 #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
1005         EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
1006                  0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
1007 struct efi_unicode_collation_protocol {
1008         efi_intn_t (EFIAPI *stri_coll)(
1009                 struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
1010         bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
1011                                    const u16 *string, const u16 *patter);
1012         void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
1013                                *this, u16 *string);
1014         void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
1015                                u16 *string);
1016         void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
1017                                   efi_uintn_t fat_size, char *fat, u16 *string);
1018         bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
1019                                   const u16 *string, efi_uintn_t fat_size,
1020                                   char *fat);
1021         char *supported_languages;
1022 };
1023
1024 #endif