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