]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/efi_api.h
projects / people / ms / u-boot.git / blob
? search:


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