]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/efi_api.h
efi_loader: support device path for IDE and SCSI disks
[people/ms/u-boot.git] / include / efi_api.h
CommitLineData
867a6ac8
SG
1/*
2 * Extensible Firmware Interface
3 * Based on 'Extensible Firmware Interface Specification' version 0.9,
4 * April 30, 1999
5 *
6 * Copyright (C) 1999 VA Linux Systems
7 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
8 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
9 * David Mosberger-Tang <davidm@hpl.hp.com>
10 * Stephane Eranian <eranian@hpl.hp.com>
11 *
12 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
13 */
14
15#ifndef _EFI_API_H
16#define _EFI_API_H
17
18#include <efi.h>
19
a86aeaf2
AG
20#ifdef CONFIG_EFI_LOADER
21#include <asm/setjmp.h>
22#endif
23
2bb9b79d 24/* Types and defines for EFI CreateEvent */
b521d29e 25enum efi_timer_delay {
2bb9b79d
AG
26 EFI_TIMER_STOP = 0,
27 EFI_TIMER_PERIODIC = 1,
28 EFI_TIMER_RELATIVE = 2
29};
30
152cade3 31#define efi_uintn_t size_t
3a45bc7f 32typedef uint16_t *efi_string_t;
503f2695 33
c6841592 34#define EVT_TIMER 0x80000000
35#define EVT_RUNTIME 0x40000000
36#define EVT_NOTIFY_WAIT 0x00000100
37#define EVT_NOTIFY_SIGNAL 0x00000200
38#define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
39#define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
40
41#define TPL_APPLICATION 0x04
42#define TPL_CALLBACK 0x08
43#define TPL_NOTIFY 0x10
44#define TPL_HIGH_LEVEL 0x1F
37a980b3 45
2fd945fe 46struct efi_event;
47
867a6ac8
SG
48/* EFI Boot Services table */
49struct efi_boot_services {
50 struct efi_table_hdr hdr;
152cade3
HS
51 efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
52 void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
867a6ac8 53
f5a2a938 54 efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
867a6ac8 55 efi_physical_addr_t *);
f5a2a938
HS
56 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
57 efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
58 struct efi_mem_desc *desc,
59 efi_uintn_t *key,
60 efi_uintn_t *desc_size,
61 u32 *desc_version);
62 efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
867a6ac8
SG
63 efi_status_t (EFIAPI *free_pool)(void *);
64
b521d29e 65 efi_status_t (EFIAPI *create_event)(uint32_t type,
152cade3 66 efi_uintn_t notify_tpl,
2fd945fe 67 void (EFIAPI *notify_function) (
68 struct efi_event *event,
69 void *context),
70 void *notify_context, struct efi_event **event);
b521d29e 71 efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
72 enum efi_timer_delay type,
73 uint64_t trigger_time);
f5a2a938
HS
74 efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
75 struct efi_event **event,
76 efi_uintn_t *index);
2fd945fe 77 efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
78 efi_status_t (EFIAPI *close_event)(struct efi_event *event);
79 efi_status_t (EFIAPI *check_event)(struct efi_event *event);
e0549f8a 80#define EFI_NATIVE_INTERFACE 0x00000000
2bb9b79d 81 efi_status_t (EFIAPI *install_protocol_interface)(
5a9682d0 82 void **handle, const efi_guid_t *protocol,
2bb9b79d
AG
83 int protocol_interface_type, void *protocol_interface);
84 efi_status_t (EFIAPI *reinstall_protocol_interface)(
5a9682d0 85 void *handle, const efi_guid_t *protocol,
2bb9b79d
AG
86 void *old_interface, void *new_interface);
87 efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
5a9682d0
HS
88 const efi_guid_t *protocol, void *protocol_interface);
89 efi_status_t (EFIAPI *handle_protocol)(efi_handle_t,
90 const efi_guid_t *protocol,
91 void **protocol_interface);
867a6ac8 92 void *reserved;
2bb9b79d 93 efi_status_t (EFIAPI *register_protocol_notify)(
5a9682d0 94 const efi_guid_t *protocol, struct efi_event *event,
2bb9b79d 95 void **registration);
867a6ac8
SG
96 efi_status_t (EFIAPI *locate_handle)(
97 enum efi_locate_search_type search_type,
5a9682d0 98 const efi_guid_t *protocol, void *search_key,
f5a2a938 99 efi_uintn_t *buffer_size, efi_handle_t *buffer);
5a9682d0 100 efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
867a6ac8
SG
101 struct efi_device_path **device_path,
102 efi_handle_t *device);
2bb9b79d
AG
103 efi_status_t (EFIAPI *install_configuration_table)(
104 efi_guid_t *guid, void *table);
867a6ac8
SG
105
106 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
107 efi_handle_t parent_image,
108 struct efi_device_path *file_path, void *source_buffer,
109 unsigned long source_size, efi_handle_t *image);
110 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
111 unsigned long *exitdata_size,
112 s16 **exitdata);
113 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
114 efi_status_t exit_status,
115 unsigned long exitdata_size, s16 *exitdata);
2bb9b79d 116 efi_status_t (EFIAPI *unload_image)(void *image_handle);
867a6ac8
SG
117 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
118
119 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
120 efi_status_t (EFIAPI *stall)(unsigned long usecs);
2bb9b79d
AG
121 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
122 uint64_t watchdog_code, unsigned long data_size,
123 uint16_t *watchdog_data);
867a6ac8
SG
124 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
125 efi_handle_t *driver_image_handle,
126 struct efi_device_path *remaining_device_path,
127 bool recursive);
2bb9b79d
AG
128 efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle,
129 void *driver_image_handle, void *child_handle);
867a6ac8
SG
130#define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
131#define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
132#define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
133#define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
134#define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
135#define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
136 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
5a9682d0 137 const efi_guid_t *protocol, void **interface,
867a6ac8
SG
138 efi_handle_t agent_handle,
139 efi_handle_t controller_handle, u32 attributes);
2bb9b79d 140 efi_status_t (EFIAPI *close_protocol)(void *handle,
5a9682d0 141 const efi_guid_t *protocol, void *agent_handle,
2bb9b79d 142 void *controller_handle);
867a6ac8 143 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
5a9682d0 144 const efi_guid_t *protocol,
867a6ac8 145 struct efi_open_protocol_info_entry **entry_buffer,
f5a2a938 146 efi_uintn_t *entry_count);
867a6ac8
SG
147 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
148 efi_guid_t ***protocol_buffer,
f5a2a938 149 efi_uintn_t *protocols_buffer_count);
867a6ac8
SG
150 efi_status_t (EFIAPI *locate_handle_buffer) (
151 enum efi_locate_search_type search_type,
5a9682d0 152 const efi_guid_t *protocol, void *search_key,
f5a2a938 153 efi_uintn_t *no_handles, efi_handle_t **buffer);
5a9682d0 154 efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
2bb9b79d
AG
155 void *registration, void **protocol_interface);
156 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
157 void **handle, ...);
158 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
159 void *handle, ...);
160 efi_status_t (EFIAPI *calculate_crc32)(void *data,
161 unsigned long data_size, uint32_t *crc32);
fc05a959
HS
162 void (EFIAPI *copy_mem)(void *destination, const void *source,
163 size_t length);
164 void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
867a6ac8
SG
165 void *create_event_ex;
166};
167
168/* Types and defines for EFI ResetSystem */
169enum efi_reset_type {
170 EFI_RESET_COLD = 0,
171 EFI_RESET_WARM = 1,
172 EFI_RESET_SHUTDOWN = 2
173};
174
175/* EFI Runtime Services table */
176#define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL
177#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
178
179struct efi_runtime_services {
180 struct efi_table_hdr hdr;
2bb9b79d
AG
181 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
182 struct efi_time_cap *capabilities);
183 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
184 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
185 struct efi_time *time);
186 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
187 struct efi_time *time);
188 efi_status_t (EFIAPI *set_virtual_address_map)(
189 unsigned long memory_map_size,
190 unsigned long descriptor_size,
191 uint32_t descriptor_version,
192 struct efi_mem_desc *virtmap);
193 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
867a6ac8
SG
194 efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
195 efi_guid_t *vendor, u32 *attributes,
196 unsigned long *data_size, void *data);
197 efi_status_t (EFIAPI *get_next_variable)(
198 unsigned long *variable_name_size,
199 s16 *variable_name, efi_guid_t *vendor);
200 efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
201 efi_guid_t *vendor, u32 attributes,
202 unsigned long data_size, void *data);
2bb9b79d
AG
203 efi_status_t (EFIAPI *get_next_high_mono_count)(
204 uint32_t *high_count);
867a6ac8
SG
205 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
206 efi_status_t reset_status,
207 unsigned long data_size, void *reset_data);
208 void *update_capsule;
209 void *query_capsule_caps;
210 void *query_variable_info;
211};
212
213/* EFI Configuration Table and GUID definitions */
214#define NULL_GUID \
215 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
216 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
217
9975fe96
RC
218#define EFI_GLOBAL_VARIABLE_GUID \
219 EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
220 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
221
867a6ac8
SG
222#define LOADED_IMAGE_PROTOCOL_GUID \
223 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
224 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
225
2bb9b79d
AG
226#define EFI_FDT_GUID \
227 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
228 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
229
e663b350
AG
230#define SMBIOS_TABLE_GUID \
231 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
232 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
233
2bb9b79d
AG
234struct efi_configuration_table
235{
236 efi_guid_t guid;
237 void *table;
238};
239
240#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
241
867a6ac8
SG
242struct efi_system_table {
243 struct efi_table_hdr hdr;
244 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
245 u32 fw_revision;
246 unsigned long con_in_handle;
247 struct efi_simple_input_interface *con_in;
248 unsigned long con_out_handle;
249 struct efi_simple_text_output_protocol *con_out;
250 unsigned long stderr_handle;
2bb9b79d 251 struct efi_simple_text_output_protocol *std_err;
867a6ac8
SG
252 struct efi_runtime_services *runtime;
253 struct efi_boot_services *boottime;
f5a2a938 254 efi_uintn_t nr_tables;
2bb9b79d 255 struct efi_configuration_table *tables;
867a6ac8
SG
256};
257
2bb9b79d
AG
258#define LOADED_IMAGE_GUID \
259 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
260 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
261
867a6ac8
SG
262struct efi_loaded_image {
263 u32 revision;
264 void *parent_handle;
265 struct efi_system_table *system_table;
266 void *device_handle;
267 void *file_path;
268 void *reserved;
269 u32 load_options_size;
270 void *load_options;
271 void *image_base;
272 aligned_u64 image_size;
273 unsigned int image_code_type;
274 unsigned int image_data_type;
275 unsigned long unload;
a86aeaf2
AG
276
277 /* Below are efi loader private fields */
278#ifdef CONFIG_EFI_LOADER
279 efi_status_t exit_status;
280 struct jmp_buf_data exit_jmp;
281#endif
867a6ac8
SG
282};
283
2bb9b79d
AG
284#define DEVICE_PATH_GUID \
285 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
286 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
287
288#define DEVICE_PATH_TYPE_END 0x7f
289# define DEVICE_PATH_SUB_TYPE_END 0xff
290
867a6ac8
SG
291struct efi_device_path {
292 u8 type;
293 u8 sub_type;
294 u16 length;
a8606ef0 295} __packed;
867a6ac8 296
d7608aba
OT
297struct efi_mac_addr {
298 u8 addr[32];
a8606ef0 299} __packed;
d7608aba 300
c80214ce 301#define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
bf19273e 302# define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
c80214ce
PJ
303# define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
304
bf19273e
RC
305struct efi_device_path_memory {
306 struct efi_device_path dp;
307 u32 memory_type;
308 u64 start_address;
309 u64 end_address;
310} __packed;
311
c80214ce
PJ
312struct efi_device_path_vendor {
313 struct efi_device_path dp;
314 efi_guid_t guid;
315 u8 vendor_data[];
316} __packed;
317
318#define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
319# define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
320
321#define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
322#define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
adae4313 323#define EISA_PNP_NUM(ID) ((ID) >> 16)
c80214ce
PJ
324
325struct efi_device_path_acpi_path {
326 struct efi_device_path dp;
327 u32 hid;
328 u32 uid;
329} __packed;
330
d7608aba 331#define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
af3106a1
HS
332# define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
333# define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
c80214ce 334# define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
d7608aba 335# define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
b66c60dd 336# define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
c80214ce
PJ
337# define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
338# define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
339
af3106a1
HS
340struct efi_device_path_atapi {
341 struct efi_device_path dp;
342 u8 primary_secondary;
343 u8 slave_master;
344 u16 logical_unit_number;
345} __packed;
346
347struct efi_device_path_scsi {
348 struct efi_device_path dp;
349 u16 target_id;
350 u16 logical_unit_number;
351} __packed;
352
c80214ce
PJ
353struct efi_device_path_usb {
354 struct efi_device_path dp;
355 u8 parent_port_number;
356 u8 usb_interface;
357} __packed;
d7608aba
OT
358
359struct efi_device_path_mac_addr {
360 struct efi_device_path dp;
361 struct efi_mac_addr mac;
362 u8 if_type;
a8606ef0 363} __packed;
d7608aba 364
b66c60dd
RC
365struct efi_device_path_usb_class {
366 struct efi_device_path dp;
367 u16 vendor_id;
368 u16 product_id;
369 u8 device_class;
370 u8 device_subclass;
371 u8 device_protocol;
372} __packed;
373
c80214ce
PJ
374struct efi_device_path_sd_mmc_path {
375 struct efi_device_path dp;
376 u8 slot_number;
377} __packed;
378
2bb9b79d 379#define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
c80214ce
PJ
380# define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
381# define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
2bb9b79d
AG
382# define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
383
c80214ce
PJ
384struct efi_device_path_hard_drive_path {
385 struct efi_device_path dp;
386 u32 partition_number;
387 u64 partition_start;
388 u64 partition_end;
389 u8 partition_signature[16];
390 u8 partmap_type;
391 u8 signature_type;
392} __packed;
393
394struct efi_device_path_cdrom_path {
395 struct efi_device_path dp;
396 u32 boot_entry;
397 u64 partition_start;
398 u64 partition_end;
399} __packed;
400
2bb9b79d
AG
401struct efi_device_path_file_path {
402 struct efi_device_path dp;
61b7e224 403 u16 str[];
a8606ef0 404} __packed;
2bb9b79d
AG
405
406#define BLOCK_IO_GUID \
407 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
408 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
409
410struct efi_block_io_media
411{
412 u32 media_id;
413 char removable_media;
414 char media_present;
415 char logical_partition;
416 char read_only;
417 char write_caching;
418 u8 pad[3];
419 u32 block_size;
420 u32 io_align;
421 u8 pad2[4];
422 u64 last_block;
423};
424
425struct efi_block_io {
426 u64 revision;
427 struct efi_block_io_media *media;
428 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
429 char extended_verification);
430 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
431 u32 media_id, u64 lba, unsigned long buffer_size,
432 void *buffer);
433 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
434 u32 media_id, u64 lba, unsigned long buffer_size,
435 void *buffer);
436 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
437};
438
867a6ac8
SG
439struct simple_text_output_mode {
440 s32 max_mode;
441 s32 mode;
442 s32 attribute;
443 s32 cursor_column;
444 s32 cursor_row;
445 bool cursor_visible;
446};
447
a17e62cc
RC
448
449#define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
450 EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
451 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
452
2d5dc2a5
RC
453#define EFI_BLACK 0x00
454#define EFI_BLUE 0x01
455#define EFI_GREEN 0x02
456#define EFI_CYAN 0x03
457#define EFI_RED 0x04
458#define EFI_MAGENTA 0x05
459#define EFI_BROWN 0x06
460#define EFI_LIGHTGRAY 0x07
461#define EFI_BRIGHT 0x08
462#define EFI_DARKGRAY 0x08
463#define EFI_LIGHTBLUE 0x09
464#define EFI_LIGHTGREEN 0x0a
465#define EFI_LIGHTCYAN 0x0b
466#define EFI_LIGHTRED 0x0c
467#define EFI_LIGHTMAGENTA 0x0d
468#define EFI_YELLOW 0x0e
469#define EFI_WHITE 0x0f
470#define EFI_BACKGROUND_BLACK 0x00
471#define EFI_BACKGROUND_BLUE 0x10
472#define EFI_BACKGROUND_GREEN 0x20
473#define EFI_BACKGROUND_CYAN 0x30
474#define EFI_BACKGROUND_RED 0x40
475#define EFI_BACKGROUND_MAGENTA 0x50
476#define EFI_BACKGROUND_BROWN 0x60
477#define EFI_BACKGROUND_LIGHTGRAY 0x70
478
479/* extract foreground color from EFI attribute */
480#define EFI_ATTR_FG(attr) ((attr) & 0x07)
481/* treat high bit of FG as bright/bold (similar to edk2) */
482#define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
483/* extract background color from EFI attribute */
484#define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
485
867a6ac8
SG
486struct efi_simple_text_output_protocol {
487 void *reset;
488 efi_status_t (EFIAPI *output_string)(
489 struct efi_simple_text_output_protocol *this,
3a45bc7f 490 const efi_string_t str);
2bb9b79d
AG
491 efi_status_t (EFIAPI *test_string)(
492 struct efi_simple_text_output_protocol *this,
3a45bc7f 493 const efi_string_t str);
867a6ac8
SG
494 efi_status_t(EFIAPI *query_mode)(
495 struct efi_simple_text_output_protocol *this,
496 unsigned long mode_number, unsigned long *columns,
497 unsigned long *rows);
498 efi_status_t(EFIAPI *set_mode)(
499 struct efi_simple_text_output_protocol *this,
500 unsigned long mode_number);
501 efi_status_t(EFIAPI *set_attribute)(
502 struct efi_simple_text_output_protocol *this,
503 unsigned long attribute);
504 efi_status_t(EFIAPI *clear_screen) (
505 struct efi_simple_text_output_protocol *this);
506 efi_status_t(EFIAPI *set_cursor_position) (
507 struct efi_simple_text_output_protocol *this,
508 unsigned long column, unsigned long row);
2bb9b79d
AG
509 efi_status_t(EFIAPI *enable_cursor)(
510 struct efi_simple_text_output_protocol *this,
511 bool enable);
867a6ac8
SG
512 struct simple_text_output_mode *mode;
513};
514
515struct efi_input_key {
516 u16 scan_code;
517 s16 unicode_char;
518};
519
a17e62cc
RC
520#define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
521 EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
522 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
523
867a6ac8
SG
524struct efi_simple_input_interface {
525 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
526 bool ExtendedVerification);
527 efi_status_t(EFIAPI *read_key_stroke)(
528 struct efi_simple_input_interface *this,
529 struct efi_input_key *key);
2fd945fe 530 struct efi_event *wait_for_key;
867a6ac8
SG
531};
532
2bb9b79d
AG
533#define CONSOLE_CONTROL_GUID \
534 EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
535 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
536#define EFI_CONSOLE_MODE_TEXT 0
537#define EFI_CONSOLE_MODE_GFX 1
538
539struct efi_console_control_protocol
540{
541 efi_status_t (EFIAPI *get_mode)(
542 struct efi_console_control_protocol *this, int *mode,
543 char *uga_exists, char *std_in_locked);
544 efi_status_t (EFIAPI *set_mode)(
545 struct efi_console_control_protocol *this, int mode);
546 efi_status_t (EFIAPI *lock_std_in)(
547 struct efi_console_control_protocol *this,
548 uint16_t *password);
549};
550
cc5b7081 551#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
552 EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
553 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
554
cc5b7081 555struct efi_device_path_to_text_protocol
556{
557 uint16_t *(EFIAPI *convert_device_node_to_text)(
9309a1b7 558 struct efi_device_path *device_node,
cc5b7081 559 bool display_only,
560 bool allow_shortcuts);
561 uint16_t *(EFIAPI *convert_device_path_to_text)(
9309a1b7 562 struct efi_device_path *device_path,
cc5b7081 563 bool display_only,
564 bool allow_shortcuts);
565};
566
be8d3241
AG
567#define EFI_GOP_GUID \
568 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
569 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
570
571#define EFI_GOT_RGBA8 0
572#define EFI_GOT_BGRA8 1
573#define EFI_GOT_BITMASK 2
574
575struct efi_gop_mode_info
576{
577 u32 version;
578 u32 width;
579 u32 height;
580 u32 pixel_format;
581 u32 pixel_bitmask[4];
582 u32 pixels_per_scanline;
583};
584
585struct efi_gop_mode
586{
587 u32 max_mode;
588 u32 mode;
589 struct efi_gop_mode_info *info;
590 unsigned long info_size;
591 efi_physical_addr_t fb_base;
592 unsigned long fb_size;
593};
594
595#define EFI_BLT_VIDEO_FILL 0
596#define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
597#define EFI_BLT_BUFFER_TO_VIDEO 2
598#define EFI_BLT_VIDEO_TO_VIDEO 3
599
600struct efi_gop
601{
602 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
1c38a774 603 efi_uintn_t *size_of_info,
be8d3241
AG
604 struct efi_gop_mode_info **info);
605 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
606 efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
1c38a774
HS
607 u32 operation, efi_uintn_t sx,
608 efi_uintn_t sy, efi_uintn_t dx,
609 efi_uintn_t dy, efi_uintn_t width,
610 efi_uintn_t height, efi_uintn_t delta);
be8d3241
AG
611 struct efi_gop_mode *mode;
612};
613
0efe1bcf
AG
614#define EFI_SIMPLE_NETWORK_GUID \
615 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
616 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
617
618struct efi_mac_address {
619 char mac_addr[32];
620};
621
622struct efi_ip_address {
623 u8 ip_addr[16];
624};
625
626enum efi_simple_network_state {
627 EFI_NETWORK_STOPPED,
628 EFI_NETWORK_STARTED,
629 EFI_NETWORK_INITIALIZED,
630};
631
632struct efi_simple_network_mode {
633 enum efi_simple_network_state state;
634 u32 hwaddr_size;
635 u32 media_header_size;
636 u32 max_packet_size;
637 u32 nvram_size;
638 u32 nvram_access_size;
639 u32 receive_filter_mask;
640 u32 receive_filter_setting;
641 u32 max_mcast_filter_count;
642 u32 mcast_filter_count;
643 struct efi_mac_address mcast_filter[16];
644 struct efi_mac_address current_address;
645 struct efi_mac_address broadcast_address;
646 struct efi_mac_address permanent_address;
647 u8 if_type;
648 u8 mac_changeable;
649 u8 multitx_supported;
650 u8 media_present_supported;
651 u8 media_present;
652};
653
2e0864a4
HS
654/* receive_filters bit mask */
655#define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
656#define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
657#define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
658#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
659#define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
0efe1bcf 660
891b3d90
HS
661/* interrupt status bit mask */
662#define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
663#define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
664#define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
665#define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
666
bdecf974
HS
667/* revision of the simple network protocol */
668#define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
669
0efe1bcf
AG
670struct efi_simple_network
671{
672 u64 revision;
673 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
674 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
675 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
676 ulong extra_rx, ulong extra_tx);
677 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
678 int extended_verification);
679 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
680 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
681 u32 enable, u32 disable, int reset_mcast_filter,
682 ulong mcast_filter_count,
683 struct efi_mac_address *mcast_filter);
684 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
685 int reset, struct efi_mac_address *new_mac);
686 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
687 int reset, ulong *stat_size, void *stat_table);
688 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
689 int ipv6, struct efi_ip_address *ip,
690 struct efi_mac_address *mac);
691 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
692 int read_write, ulong offset, ulong buffer_size,
693 char *buffer);
694 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
695 u32 *int_status, void **txbuf);
696 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
8db174d6 697 size_t header_size, size_t buffer_size, void *buffer,
0efe1bcf
AG
698 struct efi_mac_address *src_addr,
699 struct efi_mac_address *dest_addr, u16 *protocol);
700 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
8db174d6 701 size_t *header_size, size_t *buffer_size, void *buffer,
0efe1bcf
AG
702 struct efi_mac_address *src_addr,
703 struct efi_mac_address *dest_addr, u16 *protocol);
84a12ce6 704 struct efi_event *wait_for_packet;
0efe1bcf
AG
705 struct efi_simple_network_mode *mode;
706};
707
708#define EFI_PXE_GUID \
709 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
710 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
711
712struct efi_pxe_packet {
713 u8 packet[1472];
714};
715
716struct efi_pxe_mode
717{
718 u8 unused[52];
719 struct efi_pxe_packet dhcp_discover;
720 struct efi_pxe_packet dhcp_ack;
721 struct efi_pxe_packet proxy_offer;
722 struct efi_pxe_packet pxe_discover;
723 struct efi_pxe_packet pxe_reply;
724};
725
726struct efi_pxe {
727 u64 rev;
728 void (EFIAPI *start)(void);
729 void (EFIAPI *stop)(void);
730 void (EFIAPI *dhcp)(void);
731 void (EFIAPI *discover)(void);
732 void (EFIAPI *mftp)(void);
733 void (EFIAPI *udpwrite)(void);
734 void (EFIAPI *udpread)(void);
735 void (EFIAPI *setipfilter)(void);
736 void (EFIAPI *arp)(void);
737 void (EFIAPI *setparams)(void);
738 void (EFIAPI *setstationip)(void);
739 void (EFIAPI *setpackets)(void);
740 struct efi_pxe_mode *mode;
741};
742
2a92080d
RC
743#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
744 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
745 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
746#define EFI_FILE_PROTOCOL_REVISION 0x00010000
747
748struct efi_file_handle {
749 u64 rev;
750 efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
751 struct efi_file_handle **new_handle,
752 s16 *file_name, u64 open_mode, u64 attributes);
753 efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
754 efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
755 efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
756 u64 *buffer_size, void *buffer);
757 efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
758 u64 *buffer_size, void *buffer);
759 efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
760 u64 *pos);
761 efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
762 u64 pos);
763 efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
764 efi_guid_t *info_type, u64 *buffer_size, void *buffer);
765 efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
766 efi_guid_t *info_type, u64 buffer_size, void *buffer);
767 efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
768};
769
770#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
771 EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
772 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
773#define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
774
775struct efi_simple_file_system_protocol {
776 u64 rev;
777 efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
778 struct efi_file_handle **root);
779};
780
781#define EFI_FILE_INFO_GUID \
782 EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
783 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
784
785#define EFI_FILE_MODE_READ 0x0000000000000001
786#define EFI_FILE_MODE_WRITE 0x0000000000000002
787#define EFI_FILE_MODE_CREATE 0x8000000000000000
788
789#define EFI_FILE_READ_ONLY 0x0000000000000001
790#define EFI_FILE_HIDDEN 0x0000000000000002
791#define EFI_FILE_SYSTEM 0x0000000000000004
792#define EFI_FILE_RESERVED 0x0000000000000008
793#define EFI_FILE_DIRECTORY 0x0000000000000010
794#define EFI_FILE_ARCHIVE 0x0000000000000020
795#define EFI_FILE_VALID_ATTR 0x0000000000000037
796
797struct efi_file_info {
798 u64 size;
799 u64 file_size;
800 u64 physical_size;
801 struct efi_time create_time;
802 struct efi_time last_access_time;
803 struct efi_time modification_time;
804 u64 attribute;
805 s16 file_name[0];
806};
807
867a6ac8 808#endif