xref: /OK3568_Linux_fs/u-boot/include/efi_api.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
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 LOADED_IMAGE_PROTOCOL_GUID \
215 	EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
216 		 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
217 
218 #define EFI_FDT_GUID \
219 	EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
220 		 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
221 
222 #define SMBIOS_TABLE_GUID \
223 	EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  \
224 		 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
225 
226 struct efi_configuration_table
227 {
228 	efi_guid_t guid;
229 	void *table;
230 };
231 
232 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
233 
234 struct efi_system_table {
235 	struct efi_table_hdr hdr;
236 	unsigned long fw_vendor;   /* physical addr of wchar_t vendor string */
237 	u32 fw_revision;
238 	unsigned long con_in_handle;
239 	struct efi_simple_input_interface *con_in;
240 	unsigned long con_out_handle;
241 	struct efi_simple_text_output_protocol *con_out;
242 	unsigned long stderr_handle;
243 	struct efi_simple_text_output_protocol *std_err;
244 	struct efi_runtime_services *runtime;
245 	struct efi_boot_services *boottime;
246 	unsigned long nr_tables;
247 	struct efi_configuration_table *tables;
248 };
249 
250 #define LOADED_IMAGE_GUID \
251 	EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
252 		 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
253 
254 struct efi_loaded_image {
255 	u32 revision;
256 	void *parent_handle;
257 	struct efi_system_table *system_table;
258 	void *device_handle;
259 	void *file_path;
260 	void *reserved;
261 	u32 load_options_size;
262 	void *load_options;
263 	void *image_base;
264 	aligned_u64 image_size;
265 	unsigned int image_code_type;
266 	unsigned int image_data_type;
267 	unsigned long unload;
268 
269 	/* Below are efi loader private fields */
270 #ifdef CONFIG_EFI_LOADER
271 	efi_status_t exit_status;
272 	struct jmp_buf_data exit_jmp;
273 #endif
274 };
275 
276 #define DEVICE_PATH_GUID \
277 	EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
278 		 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
279 
280 #define DEVICE_PATH_TYPE_END			0x7f
281 #  define DEVICE_PATH_SUB_TYPE_END		0xff
282 
283 struct efi_device_path {
284 	u8 type;
285 	u8 sub_type;
286 	u16 length;
287 };
288 
289 struct efi_mac_addr {
290 	u8 addr[32];
291 };
292 
293 #define DEVICE_PATH_TYPE_HARDWARE_DEVICE	0x01
294 #  define DEVICE_PATH_SUB_TYPE_VENDOR		0x04
295 
296 struct efi_device_path_vendor {
297 	struct efi_device_path dp;
298 	efi_guid_t guid;
299 	u8 vendor_data[];
300 } __packed;
301 
302 #define DEVICE_PATH_TYPE_ACPI_DEVICE		0x02
303 #  define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE	0x01
304 
305 #define EFI_PNP_ID(ID)				(u32)(((ID) << 16) | 0x41D0)
306 #define EISA_PNP_ID(ID)				EFI_PNP_ID(ID)
307 
308 struct efi_device_path_acpi_path {
309 	struct efi_device_path dp;
310 	u32 hid;
311 	u32 uid;
312 } __packed;
313 
314 #define DEVICE_PATH_TYPE_MESSAGING_DEVICE	0x03
315 #  define DEVICE_PATH_SUB_TYPE_MSG_USB		0x05
316 #  define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR	0x0b
317 #  define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS	0x0f
318 #  define DEVICE_PATH_SUB_TYPE_MSG_SD		0x1a
319 #  define DEVICE_PATH_SUB_TYPE_MSG_MMC		0x1d
320 
321 struct efi_device_path_usb {
322 	struct efi_device_path dp;
323 	u8 parent_port_number;
324 	u8 usb_interface;
325 } __packed;
326 
327 struct efi_device_path_mac_addr {
328 	struct efi_device_path dp;
329 	struct efi_mac_addr mac;
330 	u8 if_type;
331 };
332 
333 struct efi_device_path_usb_class {
334 	struct efi_device_path dp;
335 	u16 vendor_id;
336 	u16 product_id;
337 	u8 device_class;
338 	u8 device_subclass;
339 	u8 device_protocol;
340 } __packed;
341 
342 struct efi_device_path_sd_mmc_path {
343 	struct efi_device_path dp;
344 	u8 slot_number;
345 } __packed;
346 
347 #define DEVICE_PATH_TYPE_MEDIA_DEVICE		0x04
348 #  define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH	0x01
349 #  define DEVICE_PATH_SUB_TYPE_CDROM_PATH	0x02
350 #  define DEVICE_PATH_SUB_TYPE_FILE_PATH	0x04
351 
352 struct efi_device_path_hard_drive_path {
353 	struct efi_device_path dp;
354 	u32 partition_number;
355 	u64 partition_start;
356 	u64 partition_end;
357 	u8 partition_signature[16];
358 	u8 partmap_type;
359 	u8 signature_type;
360 } __packed;
361 
362 struct efi_device_path_cdrom_path {
363 	struct efi_device_path dp;
364 	u32 boot_entry;
365 	u64 partition_start;
366 	u64 partition_end;
367 } __packed;
368 
369 struct efi_device_path_file_path {
370 	struct efi_device_path dp;
371 	u16 str[32];
372 };
373 
374 #define BLOCK_IO_GUID \
375 	EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
376 		 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
377 
378 struct efi_block_io_media
379 {
380 	u32 media_id;
381 	char removable_media;
382 	char media_present;
383 	char logical_partition;
384 	char read_only;
385 	char write_caching;
386 	u8 pad[3];
387 	u32 block_size;
388 	u32 io_align;
389 	u8 pad2[4];
390 	u64 last_block;
391 };
392 
393 struct efi_block_io {
394 	u64 revision;
395 	struct efi_block_io_media *media;
396 	efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
397 			char extended_verification);
398 	efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
399 			u32 media_id, u64 lba, unsigned long buffer_size,
400 			void *buffer);
401 	efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
402 			u32 media_id, u64 lba, unsigned long buffer_size,
403 			void *buffer);
404 	efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
405 };
406 
407 struct simple_text_output_mode {
408 	s32 max_mode;
409 	s32 mode;
410 	s32 attribute;
411 	s32 cursor_column;
412 	s32 cursor_row;
413 	bool cursor_visible;
414 };
415 
416 
417 #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
418 	EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
419 		 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
420 
421 struct efi_simple_text_output_protocol {
422 	void *reset;
423 	efi_status_t (EFIAPI *output_string)(
424 			struct efi_simple_text_output_protocol *this,
425 			const unsigned short *str);
426 	efi_status_t (EFIAPI *test_string)(
427 			struct efi_simple_text_output_protocol *this,
428 			const unsigned short *str);
429 	efi_status_t(EFIAPI *query_mode)(
430 			struct efi_simple_text_output_protocol *this,
431 			unsigned long mode_number, unsigned long *columns,
432 			unsigned long *rows);
433 	efi_status_t(EFIAPI *set_mode)(
434 			struct efi_simple_text_output_protocol *this,
435 			unsigned long mode_number);
436 	efi_status_t(EFIAPI *set_attribute)(
437 			struct efi_simple_text_output_protocol *this,
438 			unsigned long attribute);
439 	efi_status_t(EFIAPI *clear_screen) (
440 			struct efi_simple_text_output_protocol *this);
441 	efi_status_t(EFIAPI *set_cursor_position) (
442 			struct efi_simple_text_output_protocol *this,
443 			unsigned long column, unsigned long row);
444 	efi_status_t(EFIAPI *enable_cursor)(
445 			struct efi_simple_text_output_protocol *this,
446 			bool enable);
447 	struct simple_text_output_mode *mode;
448 };
449 
450 struct efi_input_key {
451 	u16 scan_code;
452 	s16 unicode_char;
453 };
454 
455 #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
456 	EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
457 		 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
458 
459 struct efi_simple_input_interface {
460 	efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
461 			bool ExtendedVerification);
462 	efi_status_t(EFIAPI *read_key_stroke)(
463 			struct efi_simple_input_interface *this,
464 			struct efi_input_key *key);
465 	struct efi_event *wait_for_key;
466 };
467 
468 #define CONSOLE_CONTROL_GUID \
469 	EFI_GUID(0xf42f7782, 0x12e, 0x4c12, \
470 		 0x99, 0x56, 0x49, 0xf9, 0x43, 0x4, 0xf7, 0x21)
471 #define EFI_CONSOLE_MODE_TEXT	0
472 #define EFI_CONSOLE_MODE_GFX	1
473 
474 struct efi_console_control_protocol
475 {
476 	efi_status_t (EFIAPI *get_mode)(
477 			struct efi_console_control_protocol *this, int *mode,
478 			char *uga_exists, char *std_in_locked);
479 	efi_status_t (EFIAPI *set_mode)(
480 			struct efi_console_control_protocol *this, int mode);
481 	efi_status_t (EFIAPI *lock_std_in)(
482 			struct efi_console_control_protocol *this,
483 			uint16_t *password);
484 };
485 
486 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
487 	EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
488 		 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
489 
490 struct efi_device_path_protocol
491 {
492 	uint8_t type;
493 	uint8_t sub_type;
494 	uint16_t length;
495 	uint8_t data[];
496 };
497 
498 struct efi_device_path_to_text_protocol
499 {
500 	uint16_t *(EFIAPI *convert_device_node_to_text)(
501 			struct efi_device_path_protocol *device_node,
502 			bool display_only,
503 			bool allow_shortcuts);
504 	uint16_t *(EFIAPI *convert_device_path_to_text)(
505 			struct efi_device_path_protocol *device_path,
506 			bool display_only,
507 			bool allow_shortcuts);
508 };
509 
510 #define EFI_GOP_GUID \
511 	EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
512 		 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
513 
514 #define EFI_GOT_RGBA8		0
515 #define EFI_GOT_BGRA8		1
516 #define EFI_GOT_BITMASK		2
517 
518 struct efi_gop_mode_info
519 {
520 	u32 version;
521 	u32 width;
522 	u32 height;
523 	u32 pixel_format;
524 	u32 pixel_bitmask[4];
525 	u32 pixels_per_scanline;
526 };
527 
528 struct efi_gop_mode
529 {
530 	u32 max_mode;
531 	u32 mode;
532 	struct efi_gop_mode_info *info;
533 	unsigned long info_size;
534 	efi_physical_addr_t fb_base;
535 	unsigned long fb_size;
536 };
537 
538 #define EFI_BLT_VIDEO_FILL		0
539 #define EFI_BLT_VIDEO_TO_BLT_BUFFER	1
540 #define EFI_BLT_BUFFER_TO_VIDEO		2
541 #define EFI_BLT_VIDEO_TO_VIDEO		3
542 
543 struct efi_gop
544 {
545 	efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
546 					  unsigned long *size_of_info,
547 					  struct efi_gop_mode_info **info);
548 	efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
549 	efi_status_t (EFIAPI *blt)(struct efi_gop *this, void *buffer,
550 				   unsigned long operation, unsigned long sx,
551 				   unsigned long sy, unsigned long dx,
552 				   unsigned long dy, unsigned long width,
553 				   unsigned long height, unsigned long delta);
554 	struct efi_gop_mode *mode;
555 };
556 
557 #define EFI_SIMPLE_NETWORK_GUID \
558 	EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
559 		 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
560 
561 struct efi_mac_address {
562 	char mac_addr[32];
563 };
564 
565 struct efi_ip_address {
566 	u8 ip_addr[16];
567 };
568 
569 enum efi_simple_network_state {
570 	EFI_NETWORK_STOPPED,
571 	EFI_NETWORK_STARTED,
572 	EFI_NETWORK_INITIALIZED,
573 };
574 
575 struct efi_simple_network_mode {
576 	enum efi_simple_network_state state;
577 	u32 hwaddr_size;
578 	u32 media_header_size;
579 	u32 max_packet_size;
580 	u32 nvram_size;
581 	u32 nvram_access_size;
582 	u32 receive_filter_mask;
583 	u32 receive_filter_setting;
584 	u32 max_mcast_filter_count;
585 	u32 mcast_filter_count;
586 	struct efi_mac_address mcast_filter[16];
587 	struct efi_mac_address current_address;
588 	struct efi_mac_address broadcast_address;
589 	struct efi_mac_address permanent_address;
590 	u8 if_type;
591 	u8 mac_changeable;
592 	u8 multitx_supported;
593 	u8 media_present_supported;
594 	u8 media_present;
595 };
596 
597 #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST               0x01,
598 #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST             0x02,
599 #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST             0x04,
600 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS           0x08,
601 #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10,
602 
603 struct efi_simple_network
604 {
605 	u64 revision;
606 	efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
607 	efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
608 	efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
609 			ulong extra_rx, ulong extra_tx);
610 	efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
611 			int extended_verification);
612 	efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
613 	efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
614 			u32 enable, u32 disable, int reset_mcast_filter,
615 			ulong mcast_filter_count,
616 			struct efi_mac_address *mcast_filter);
617 	efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
618 			int reset, struct efi_mac_address *new_mac);
619 	efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
620 			int reset, ulong *stat_size, void *stat_table);
621 	efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
622 			int ipv6, struct efi_ip_address *ip,
623 			struct efi_mac_address *mac);
624 	efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
625 			int read_write, ulong offset, ulong buffer_size,
626 			char *buffer);
627 	efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
628 			u32 *int_status, void **txbuf);
629 	efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
630 			ulong header_size, ulong buffer_size, void *buffer,
631 			struct efi_mac_address *src_addr,
632 			struct efi_mac_address *dest_addr, u16 *protocol);
633 	efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
634 			ulong *header_size, ulong *buffer_size, void *buffer,
635 			struct efi_mac_address *src_addr,
636 			struct efi_mac_address *dest_addr, u16 *protocol);
637 	void (EFIAPI *waitforpacket)(void);
638 	struct efi_simple_network_mode *mode;
639 };
640 
641 #define EFI_PXE_GUID \
642 	EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
643 		 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
644 
645 struct efi_pxe_packet {
646 	u8 packet[1472];
647 };
648 
649 struct efi_pxe_mode
650 {
651 	u8 unused[52];
652 	struct efi_pxe_packet dhcp_discover;
653 	struct efi_pxe_packet dhcp_ack;
654 	struct efi_pxe_packet proxy_offer;
655 	struct efi_pxe_packet pxe_discover;
656 	struct efi_pxe_packet pxe_reply;
657 };
658 
659 struct efi_pxe {
660 	u64 rev;
661 	void (EFIAPI *start)(void);
662 	void (EFIAPI *stop)(void);
663 	void (EFIAPI *dhcp)(void);
664 	void (EFIAPI *discover)(void);
665 	void (EFIAPI *mftp)(void);
666 	void (EFIAPI *udpwrite)(void);
667 	void (EFIAPI *udpread)(void);
668 	void (EFIAPI *setipfilter)(void);
669 	void (EFIAPI *arp)(void);
670 	void (EFIAPI *setparams)(void);
671 	void (EFIAPI *setstationip)(void);
672 	void (EFIAPI *setpackets)(void);
673 	struct efi_pxe_mode *mode;
674 };
675 
676 #endif
677