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