]> git.ipfire.org Git - people/ms/u-boot.git/blob - include/efi_api.h
common: arm: davinci: Move header file out of common
[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_event_type {
26 EFI_TIMER_STOP = 0,
27 EFI_TIMER_PERIODIC = 1,
28 EFI_TIMER_RELATIVE = 2
29 };
30
31 /* EFI Boot Services table */
32 struct efi_boot_services {
33 struct efi_table_hdr hdr;
34 efi_status_t (EFIAPI *raise_tpl)(unsigned long new_tpl);
35 void (EFIAPI *restore_tpl)(unsigned long old_tpl);
36
37 efi_status_t (EFIAPI *allocate_pages)(int, int, unsigned long,
38 efi_physical_addr_t *);
39 efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, unsigned long);
40 efi_status_t (EFIAPI *get_memory_map)(unsigned long *memory_map_size,
41 struct efi_mem_desc *desc, unsigned long *key,
42 unsigned long *desc_size, u32 *desc_version);
43 efi_status_t (EFIAPI *allocate_pool)(int, unsigned long, void **);
44 efi_status_t (EFIAPI *free_pool)(void *);
45
46 efi_status_t (EFIAPI *create_event)(enum efi_event_type type,
47 unsigned long notify_tpl,
48 void (EFIAPI *notify_function) (void *event,
49 void *context),
50 void *notify_context, void **event);
51 efi_status_t (EFIAPI *set_timer)(void *event, int type,
52 uint64_t trigger_time);
53 efi_status_t (EFIAPI *wait_for_event)(unsigned long number_of_events,
54 void *event, unsigned long *index);
55 efi_status_t (EFIAPI *signal_event)(void *event);
56 efi_status_t (EFIAPI *close_event)(void *event);
57 efi_status_t (EFIAPI *check_event)(void *event);
58
59 efi_status_t (EFIAPI *install_protocol_interface)(
60 void **handle, efi_guid_t *protocol,
61 int protocol_interface_type, void *protocol_interface);
62 efi_status_t (EFIAPI *reinstall_protocol_interface)(
63 void *handle, efi_guid_t *protocol,
64 void *old_interface, void *new_interface);
65 efi_status_t (EFIAPI *uninstall_protocol_interface)(void *handle,
66 efi_guid_t *protocol, void *protocol_interface);
67 efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *,
68 void **);
69 void *reserved;
70 efi_status_t (EFIAPI *register_protocol_notify)(
71 efi_guid_t *protocol, void *event,
72 void **registration);
73 efi_status_t (EFIAPI *locate_handle)(
74 enum efi_locate_search_type search_type,
75 efi_guid_t *protocol, void *search_key,
76 unsigned long *buffer_size, efi_handle_t *buffer);
77 efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol,
78 struct efi_device_path **device_path,
79 efi_handle_t *device);
80 efi_status_t (EFIAPI *install_configuration_table)(
81 efi_guid_t *guid, void *table);
82
83 efi_status_t (EFIAPI *load_image)(bool boot_policiy,
84 efi_handle_t parent_image,
85 struct efi_device_path *file_path, void *source_buffer,
86 unsigned long source_size, efi_handle_t *image);
87 efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
88 unsigned long *exitdata_size,
89 s16 **exitdata);
90 efi_status_t (EFIAPI *exit)(efi_handle_t handle,
91 efi_status_t exit_status,
92 unsigned long exitdata_size, s16 *exitdata);
93 efi_status_t (EFIAPI *unload_image)(void *image_handle);
94 efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
95
96 efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
97 efi_status_t (EFIAPI *stall)(unsigned long usecs);
98 efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
99 uint64_t watchdog_code, unsigned long data_size,
100 uint16_t *watchdog_data);
101 efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
102 efi_handle_t *driver_image_handle,
103 struct efi_device_path *remaining_device_path,
104 bool recursive);
105 efi_status_t (EFIAPI *disconnect_controller)(void *controller_handle,
106 void *driver_image_handle, void *child_handle);
107 #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
108 #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
109 #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
110 #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
111 #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
112 #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
113 efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
114 efi_guid_t *protocol, void **interface,
115 efi_handle_t agent_handle,
116 efi_handle_t controller_handle, u32 attributes);
117 efi_status_t (EFIAPI *close_protocol)(void *handle,
118 efi_guid_t *protocol, void *agent_handle,
119 void *controller_handle);
120 efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
121 efi_guid_t *protocol,
122 struct efi_open_protocol_info_entry **entry_buffer,
123 unsigned long *entry_count);
124 efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
125 efi_guid_t ***protocol_buffer,
126 unsigned long *protocols_buffer_count);
127 efi_status_t (EFIAPI *locate_handle_buffer) (
128 enum efi_locate_search_type search_type,
129 efi_guid_t *protocol, void *search_key,
130 unsigned long *no_handles, efi_handle_t **buffer);
131 efi_status_t (EFIAPI *locate_protocol)(efi_guid_t *protocol,
132 void *registration, void **protocol_interface);
133 efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
134 void **handle, ...);
135 efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
136 void *handle, ...);
137 efi_status_t (EFIAPI *calculate_crc32)(void *data,
138 unsigned long data_size, uint32_t *crc32);
139 void (EFIAPI *copy_mem)(void *destination, void *source,
140 unsigned long length);
141 void (EFIAPI *set_mem)(void *buffer, unsigned long size,
142 uint8_t value);
143 void *create_event_ex;
144 };
145
146 /* Types and defines for EFI ResetSystem */
147 enum efi_reset_type {
148 EFI_RESET_COLD = 0,
149 EFI_RESET_WARM = 1,
150 EFI_RESET_SHUTDOWN = 2
151 };
152
153 /* EFI Runtime Services table */
154 #define EFI_RUNTIME_SERVICES_SIGNATURE 0x5652453544e5552ULL
155 #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
156
157 struct efi_runtime_services {
158 struct efi_table_hdr hdr;
159 efi_status_t (EFIAPI *get_time)(struct efi_time *time,
160 struct efi_time_cap *capabilities);
161 efi_status_t (EFIAPI *set_time)(struct efi_time *time);
162 efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
163 struct efi_time *time);
164 efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
165 struct efi_time *time);
166 efi_status_t (EFIAPI *set_virtual_address_map)(
167 unsigned long memory_map_size,
168 unsigned long descriptor_size,
169 uint32_t descriptor_version,
170 struct efi_mem_desc *virtmap);
171 efi_status_t (*convert_pointer)(unsigned long dbg, void **address);
172 efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
173 efi_guid_t *vendor, u32 *attributes,
174 unsigned long *data_size, void *data);
175 efi_status_t (EFIAPI *get_next_variable)(
176 unsigned long *variable_name_size,
177 s16 *variable_name, efi_guid_t *vendor);
178 efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
179 efi_guid_t *vendor, u32 attributes,
180 unsigned long data_size, void *data);
181 efi_status_t (EFIAPI *get_next_high_mono_count)(
182 uint32_t *high_count);
183 void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
184 efi_status_t reset_status,
185 unsigned long data_size, void *reset_data);
186 void *update_capsule;
187 void *query_capsule_caps;
188 void *query_variable_info;
189 };
190
191 /* EFI Configuration Table and GUID definitions */
192 #define NULL_GUID \
193 EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
194 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
195
196 #define LOADED_IMAGE_PROTOCOL_GUID \
197 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
198 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
199
200 #define EFI_FDT_GUID \
201 EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
202 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
203
204 #define SMBIOS_TABLE_GUID \
205 EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
206 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
207
208 struct efi_configuration_table
209 {
210 efi_guid_t guid;
211 void *table;
212 };
213
214 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
215
216 struct efi_system_table {
217 struct efi_table_hdr hdr;
218 unsigned long fw_vendor; /* physical addr of wchar_t vendor string */
219 u32 fw_revision;
220 unsigned long con_in_handle;
221 struct efi_simple_input_interface *con_in;
222 unsigned long con_out_handle;
223 struct efi_simple_text_output_protocol *con_out;
224 unsigned long stderr_handle;
225 struct efi_simple_text_output_protocol *std_err;
226 struct efi_runtime_services *runtime;
227 struct efi_boot_services *boottime;
228 unsigned long nr_tables;
229 struct efi_configuration_table *tables;
230 };
231
232 #define LOADED_IMAGE_GUID \
233 EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
234 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
235
236 struct efi_loaded_image {
237 u32 revision;
238 void *parent_handle;
239 struct efi_system_table *system_table;
240 void *device_handle;
241 void *file_path;
242 void *reserved;
243 u32 load_options_size;
244 void *load_options;
245 void *image_base;
246 aligned_u64 image_size;
247 unsigned int image_code_type;
248 unsigned int image_data_type;
249 unsigned long unload;
250
251 /* Below are efi loader private fields */
252 #ifdef CONFIG_EFI_LOADER
253 efi_status_t exit_status;
254 struct jmp_buf_data exit_jmp;
255 #endif
256 };
257
258 #define DEVICE_PATH_GUID \
259 EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
260 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
261
262 #define DEVICE_PATH_TYPE_END 0x7f
263 # define DEVICE_PATH_SUB_TYPE_END 0xff
264
265 struct efi_device_path {
266 u8 type;
267 u8 sub_type;
268 u16 length;
269 };
270
271 struct efi_mac_addr {
272 u8 addr[32];
273 };
274
275 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
276 # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
277
278 struct efi_device_path_mac_addr {
279 struct efi_device_path dp;
280 struct efi_mac_addr mac;
281 u8 if_type;
282 };
283
284 #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
285 # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
286
287 struct efi_device_path_file_path {
288 struct efi_device_path dp;
289 u16 str[32];
290 };
291
292 #define BLOCK_IO_GUID \
293 EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
294 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
295
296 struct efi_block_io_media
297 {
298 u32 media_id;
299 char removable_media;
300 char media_present;
301 char logical_partition;
302 char read_only;
303 char write_caching;
304 u8 pad[3];
305 u32 block_size;
306 u32 io_align;
307 u8 pad2[4];
308 u64 last_block;
309 };
310
311 struct efi_block_io {
312 u64 revision;
313 struct efi_block_io_media *media;
314 efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
315 char extended_verification);
316 efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
317 u32 media_id, u64 lba, unsigned long buffer_size,
318 void *buffer);
319 efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
320 u32 media_id, u64 lba, unsigned long buffer_size,
321 void *buffer);
322 efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
323 };
324
325 struct simple_text_output_mode {
326 s32 max_mode;
327 s32 mode;
328 s32 attribute;
329 s32 cursor_column;
330 s32 cursor_row;
331 bool cursor_visible;
332 };
333
334 struct efi_simple_text_output_protocol {
335 void *reset;
336 efi_status_t (EFIAPI *output_string)(
337 struct efi_simple_text_output_protocol *this,
338 const unsigned short *str);
339 efi_status_t (EFIAPI *test_string)(
340 struct efi_simple_text_output_protocol *this,
341 const unsigned short *str);
342 efi_status_t(EFIAPI *query_mode)(
343 struct efi_simple_text_output_protocol *this,
344 unsigned long mode_number, unsigned long *columns,
345 unsigned long *rows);
346 efi_status_t(EFIAPI *set_mode)(
347 struct efi_simple_text_output_protocol *this,
348 unsigned long mode_number);
349 efi_status_t(EFIAPI *set_attribute)(
350 struct efi_simple_text_output_protocol *this,
351 unsigned long attribute);
352 efi_status_t(EFIAPI *clear_screen) (
353 struct efi_simple_text_output_protocol *this);
354 efi_status_t(EFIAPI *set_cursor_position) (
355 struct efi_simple_text_output_protocol *this,
356 unsigned long column, unsigned long row);
357 efi_status_t(EFIAPI *enable_cursor)(
358 struct efi_simple_text_output_protocol *this,
359 bool enable);
360 struct simple_text_output_mode *mode;
361 };
362
363 struct efi_input_key {
364 u16 scan_code;
365 s16 unicode_char;
366 };
367
368 struct efi_simple_input_interface {
369 efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
370 bool ExtendedVerification);
371 efi_status_t(EFIAPI *read_key_stroke)(
372 struct efi_simple_input_interface *this,
373 struct efi_input_key *key);
374 void *wait_for_key;
375 };
376
377 #define CONSOLE_CONTROL_GUID \
378 EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
379 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
380 #define EFI_CONSOLE_MODE_TEXT 0
381 #define EFI_CONSOLE_MODE_GFX 1
382
383 struct efi_console_control_protocol
384 {
385 efi_status_t (EFIAPI *get_mode)(
386 struct efi_console_control_protocol *this, int *mode,
387 char *uga_exists, char *std_in_locked);
388 efi_status_t (EFIAPI *set_mode)(
389 struct efi_console_control_protocol *this, int mode);
390 efi_status_t (EFIAPI *lock_std_in)(
391 struct efi_console_control_protocol *this,
392 uint16_t *password);
393 };
394
395 #define EFI_GOP_GUID \
396 EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
397 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
398
399 #define EFI_GOT_RGBA8 0
400 #define EFI_GOT_BGRA8 1
401 #define EFI_GOT_BITMASK 2
402
403 struct efi_gop_mode_info
404 {
405 u32 version;
406 u32 width;
407 u32 height;
408 u32 pixel_format;
409 u32 pixel_bitmask[4];
410 u32 pixels_per_scanline;
411 };
412
413 struct efi_gop_mode
414 {
415 u32 max_mode;
416 u32 mode;
417 struct efi_gop_mode_info *info;
418 unsigned long info_size;
419 efi_physical_addr_t fb_base;
420 unsigned long fb_size;
421 };
422
423 #define EFI_BLT_VIDEO_FILL 0
424 #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
425 #define EFI_BLT_BUFFER_TO_VIDEO 2
426 #define EFI_BLT_VIDEO_TO_VIDEO 3
427
428 struct efi_gop
429 {
430 efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
431 unsigned long *size_of_info,
432 struct efi_gop_mode_info **info);
433 efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
434 efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
435 unsigned long operation, unsigned long sx,
436 unsigned long sy, unsigned long dx,
437 unsigned long dy, unsigned long width,
438 unsigned long height, unsigned long delta);
439 struct efi_gop_mode *mode;
440 };
441
442 #define EFI_SIMPLE_NETWORK_GUID \
443 EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
444 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
445
446 struct efi_mac_address {
447 char mac_addr[32];
448 };
449
450 struct efi_ip_address {
451 u8 ip_addr[16];
452 };
453
454 enum efi_simple_network_state {
455 EFI_NETWORK_STOPPED,
456 EFI_NETWORK_STARTED,
457 EFI_NETWORK_INITIALIZED,
458 };
459
460 struct efi_simple_network_mode {
461 enum efi_simple_network_state state;
462 u32 hwaddr_size;
463 u32 media_header_size;
464 u32 max_packet_size;
465 u32 nvram_size;
466 u32 nvram_access_size;
467 u32 receive_filter_mask;
468 u32 receive_filter_setting;
469 u32 max_mcast_filter_count;
470 u32 mcast_filter_count;
471 struct efi_mac_address mcast_filter[16];
472 struct efi_mac_address current_address;
473 struct efi_mac_address broadcast_address;
474 struct efi_mac_address permanent_address;
475 u8 if_type;
476 u8 mac_changeable;
477 u8 multitx_supported;
478 u8 media_present_supported;
479 u8 media_present;
480 };
481
482 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01,
483 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02,
484 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04,
485 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08,
486 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10,
487
488 struct efi_simple_network
489 {
490 u64 revision;
491 efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
492 efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
493 efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
494 ulong extra_rx, ulong extra_tx);
495 efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
496 int extended_verification);
497 efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
498 efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
499 u32 enable, u32 disable, int reset_mcast_filter,
500 ulong mcast_filter_count,
501 struct efi_mac_address *mcast_filter);
502 efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
503 int reset, struct efi_mac_address *new_mac);
504 efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
505 int reset, ulong *stat_size, void *stat_table);
506 efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
507 int ipv6, struct efi_ip_address *ip,
508 struct efi_mac_address *mac);
509 efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
510 int read_write, ulong offset, ulong buffer_size,
511 char *buffer);
512 efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
513 u32 *int_status, void **txbuf);
514 efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
515 ulong header_size, ulong buffer_size, void *buffer,
516 struct efi_mac_address *src_addr,
517 struct efi_mac_address *dest_addr, u16 *protocol);
518 efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
519 ulong *header_size, ulong *buffer_size, void *buffer,
520 struct efi_mac_address *src_addr,
521 struct efi_mac_address *dest_addr, u16 *protocol);
522 void (EFIAPI *waitforpacket)(void);
523 struct efi_simple_network_mode *mode;
524 };
525
526 #define EFI_PXE_GUID \
527 EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
528 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
529
530 struct efi_pxe_packet {
531 u8 packet[1472];
532 };
533
534 struct efi_pxe_mode
535 {
536 u8 unused[52];
537 struct efi_pxe_packet dhcp_discover;
538 struct efi_pxe_packet dhcp_ack;
539 struct efi_pxe_packet proxy_offer;
540 struct efi_pxe_packet pxe_discover;
541 struct efi_pxe_packet pxe_reply;
542 };
543
544 struct efi_pxe {
545 u64 rev;
546 void (EFIAPI *start)(void);
547 void (EFIAPI *stop)(void);
548 void (EFIAPI *dhcp)(void);
549 void (EFIAPI *discover)(void);
550 void (EFIAPI *mftp)(void);
551 void (EFIAPI *udpwrite)(void);
552 void (EFIAPI *udpread)(void);
553 void (EFIAPI *setipfilter)(void);
554 void (EFIAPI *arp)(void);
555 void (EFIAPI *setparams)(void);
556 void (EFIAPI *setstationip)(void);
557 void (EFIAPI *setpackets)(void);
558 struct efi_pxe_mode *mode;
559 };
560
561 #endif