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