xref: /rk3399_rockchip-uboot/include/efi_api.h (revision 867a6ac86dd823de409752e9ca5dc8f4d4880f26)
1*867a6ac8SSimon Glass /*
2*867a6ac8SSimon Glass  * Extensible Firmware Interface
3*867a6ac8SSimon Glass  * Based on 'Extensible Firmware Interface Specification' version 0.9,
4*867a6ac8SSimon Glass  * April 30, 1999
5*867a6ac8SSimon Glass  *
6*867a6ac8SSimon Glass  * Copyright (C) 1999 VA Linux Systems
7*867a6ac8SSimon Glass  * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
8*867a6ac8SSimon Glass  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
9*867a6ac8SSimon Glass  *	David Mosberger-Tang <davidm@hpl.hp.com>
10*867a6ac8SSimon Glass  *	Stephane Eranian <eranian@hpl.hp.com>
11*867a6ac8SSimon Glass  *
12*867a6ac8SSimon Glass  * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
13*867a6ac8SSimon Glass  */
14*867a6ac8SSimon Glass 
15*867a6ac8SSimon Glass #ifndef _EFI_API_H
16*867a6ac8SSimon Glass #define _EFI_API_H
17*867a6ac8SSimon Glass 
18*867a6ac8SSimon Glass #include <efi.h>
19*867a6ac8SSimon Glass 
20*867a6ac8SSimon Glass /* EFI Boot Services table */
21*867a6ac8SSimon Glass struct efi_boot_services {
22*867a6ac8SSimon Glass 	struct efi_table_hdr hdr;
23*867a6ac8SSimon Glass 	void *raise_tpl;
24*867a6ac8SSimon Glass 	void *restore_tpl;
25*867a6ac8SSimon Glass 
26*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *allocate_pages)(int, int, unsigned long,
27*867a6ac8SSimon Glass 					      efi_physical_addr_t *);
28*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, unsigned long);
29*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *get_memory_map)(unsigned long *memory_map_size,
30*867a6ac8SSimon Glass 			struct efi_mem_desc *desc, unsigned long *key,
31*867a6ac8SSimon Glass 			unsigned long *desc_size, u32 *desc_version);
32*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *allocate_pool)(int, unsigned long, void **);
33*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *free_pool)(void *);
34*867a6ac8SSimon Glass 
35*867a6ac8SSimon Glass 	void *create_event;
36*867a6ac8SSimon Glass 	void *set_timer;
37*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *wait_for_event)(unsigned long number_of_events,
38*867a6ac8SSimon Glass 					     void *event, unsigned long *index);
39*867a6ac8SSimon Glass 	void *signal_event;
40*867a6ac8SSimon Glass 	void *close_event;
41*867a6ac8SSimon Glass 	void *check_event;
42*867a6ac8SSimon Glass 
43*867a6ac8SSimon Glass 	void *install_protocol_interface;
44*867a6ac8SSimon Glass 	void *reinstall_protocol_interface;
45*867a6ac8SSimon Glass 	void *uninstall_protocol_interface;
46*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *handle_protocol)(efi_handle_t, efi_guid_t *,
47*867a6ac8SSimon Glass 					       void **);
48*867a6ac8SSimon Glass 	void *reserved;
49*867a6ac8SSimon Glass 	void *register_protocol_notify;
50*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *locate_handle)(
51*867a6ac8SSimon Glass 			enum efi_locate_search_type search_type,
52*867a6ac8SSimon Glass 			efi_guid_t *protocol, void *search_key,
53*867a6ac8SSimon Glass 			unsigned long *buffer_size, efi_handle_t *buffer);
54*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *locate_device_path)(efi_guid_t *protocol,
55*867a6ac8SSimon Glass 			struct efi_device_path **device_path,
56*867a6ac8SSimon Glass 			efi_handle_t *device);
57*867a6ac8SSimon Glass 	void *install_configuration_table;
58*867a6ac8SSimon Glass 
59*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *load_image)(bool boot_policiy,
60*867a6ac8SSimon Glass 			efi_handle_t parent_image,
61*867a6ac8SSimon Glass 			struct efi_device_path *file_path, void *source_buffer,
62*867a6ac8SSimon Glass 			unsigned long source_size, efi_handle_t *image);
63*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
64*867a6ac8SSimon Glass 					   unsigned long *exitdata_size,
65*867a6ac8SSimon Glass 					   s16 **exitdata);
66*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *exit)(efi_handle_t handle,
67*867a6ac8SSimon Glass 				    efi_status_t exit_status,
68*867a6ac8SSimon Glass 				    unsigned long exitdata_size, s16 *exitdata);
69*867a6ac8SSimon Glass 	void *unload_image;
70*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t, unsigned long);
71*867a6ac8SSimon Glass 
72*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
73*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *stall)(unsigned long usecs);
74*867a6ac8SSimon Glass 	void *set_watchdog_timer;
75*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
76*867a6ac8SSimon Glass 			efi_handle_t *driver_image_handle,
77*867a6ac8SSimon Glass 			struct efi_device_path *remaining_device_path,
78*867a6ac8SSimon Glass 			bool recursive);
79*867a6ac8SSimon Glass 	void *disconnect_controller;
80*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL  0x00000001
81*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_GET_PROTOCOL        0x00000002
82*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL       0x00000004
83*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
84*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_BY_DRIVER           0x00000010
85*867a6ac8SSimon Glass #define EFI_OPEN_PROTOCOL_EXCLUSIVE           0x00000020
86*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
87*867a6ac8SSimon Glass 			efi_guid_t *protocol, void **interface,
88*867a6ac8SSimon Glass 			efi_handle_t agent_handle,
89*867a6ac8SSimon Glass 			efi_handle_t controller_handle, u32 attributes);
90*867a6ac8SSimon Glass 	void *close_protocol;
91*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
92*867a6ac8SSimon Glass 			efi_guid_t *protocol,
93*867a6ac8SSimon Glass 			struct efi_open_protocol_info_entry **entry_buffer,
94*867a6ac8SSimon Glass 			unsigned long *entry_count);
95*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
96*867a6ac8SSimon Glass 			efi_guid_t ***protocol_buffer,
97*867a6ac8SSimon Glass 			unsigned long *protocols_buffer_count);
98*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *locate_handle_buffer) (
99*867a6ac8SSimon Glass 			enum efi_locate_search_type search_type,
100*867a6ac8SSimon Glass 			efi_guid_t *protocol, void *search_key,
101*867a6ac8SSimon Glass 			unsigned long *no_handles, efi_handle_t **buffer);
102*867a6ac8SSimon Glass 	void *locate_protocol;
103*867a6ac8SSimon Glass 	void *install_multiple_protocol_interfaces;
104*867a6ac8SSimon Glass 	void *uninstall_multiple_protocol_interfaces;
105*867a6ac8SSimon Glass 	void *calculate_crc32;
106*867a6ac8SSimon Glass 	void *copy_mem;
107*867a6ac8SSimon Glass 	void *set_mem;
108*867a6ac8SSimon Glass 	void *create_event_ex;
109*867a6ac8SSimon Glass };
110*867a6ac8SSimon Glass 
111*867a6ac8SSimon Glass /* Types and defines for EFI ResetSystem */
112*867a6ac8SSimon Glass enum efi_reset_type {
113*867a6ac8SSimon Glass 	EFI_RESET_COLD = 0,
114*867a6ac8SSimon Glass 	EFI_RESET_WARM = 1,
115*867a6ac8SSimon Glass 	EFI_RESET_SHUTDOWN = 2
116*867a6ac8SSimon Glass };
117*867a6ac8SSimon Glass 
118*867a6ac8SSimon Glass /* EFI Runtime Services table */
119*867a6ac8SSimon Glass #define EFI_RUNTIME_SERVICES_SIGNATURE	0x5652453544e5552ULL
120*867a6ac8SSimon Glass #define EFI_RUNTIME_SERVICES_REVISION	0x00010000
121*867a6ac8SSimon Glass 
122*867a6ac8SSimon Glass struct efi_runtime_services {
123*867a6ac8SSimon Glass 	struct efi_table_hdr hdr;
124*867a6ac8SSimon Glass 	void *get_time;
125*867a6ac8SSimon Glass 	void *set_time;
126*867a6ac8SSimon Glass 	void *get_wakeup_time;
127*867a6ac8SSimon Glass 	void *set_wakeup_time;
128*867a6ac8SSimon Glass 	void *set_virtual_address_map;
129*867a6ac8SSimon Glass 	void *convert_pointer;
130*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *get_variable)(s16 *variable_name,
131*867a6ac8SSimon Glass 			efi_guid_t *vendor, u32 *attributes,
132*867a6ac8SSimon Glass 			unsigned long *data_size, void *data);
133*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *get_next_variable)(
134*867a6ac8SSimon Glass 			unsigned long *variable_name_size,
135*867a6ac8SSimon Glass 			s16 *variable_name, efi_guid_t *vendor);
136*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *set_variable)(s16 *variable_name,
137*867a6ac8SSimon Glass 			efi_guid_t *vendor, u32 attributes,
138*867a6ac8SSimon Glass 			unsigned long data_size, void *data);
139*867a6ac8SSimon Glass 	void *get_next_high_mono_count;
140*867a6ac8SSimon Glass 	void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
141*867a6ac8SSimon Glass 				    efi_status_t reset_status,
142*867a6ac8SSimon Glass 				    unsigned long data_size, void *reset_data);
143*867a6ac8SSimon Glass 	void *update_capsule;
144*867a6ac8SSimon Glass 	void *query_capsule_caps;
145*867a6ac8SSimon Glass 	void *query_variable_info;
146*867a6ac8SSimon Glass };
147*867a6ac8SSimon Glass 
148*867a6ac8SSimon Glass /* EFI Configuration Table and GUID definitions */
149*867a6ac8SSimon Glass #define NULL_GUID \
150*867a6ac8SSimon Glass 	EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
151*867a6ac8SSimon Glass 		 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
152*867a6ac8SSimon Glass 
153*867a6ac8SSimon Glass #define LOADED_IMAGE_PROTOCOL_GUID \
154*867a6ac8SSimon Glass 	EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, \
155*867a6ac8SSimon Glass 		 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
156*867a6ac8SSimon Glass 
157*867a6ac8SSimon Glass struct efi_system_table {
158*867a6ac8SSimon Glass 	struct efi_table_hdr hdr;
159*867a6ac8SSimon Glass 	unsigned long fw_vendor;   /* physical addr of wchar_t vendor string */
160*867a6ac8SSimon Glass 	u32 fw_revision;
161*867a6ac8SSimon Glass 	unsigned long con_in_handle;
162*867a6ac8SSimon Glass 	struct efi_simple_input_interface *con_in;
163*867a6ac8SSimon Glass 	unsigned long con_out_handle;
164*867a6ac8SSimon Glass 	struct efi_simple_text_output_protocol *con_out;
165*867a6ac8SSimon Glass 	unsigned long stderr_handle;
166*867a6ac8SSimon Glass 	unsigned long std_err;
167*867a6ac8SSimon Glass 	struct efi_runtime_services *runtime;
168*867a6ac8SSimon Glass 	struct efi_boot_services *boottime;
169*867a6ac8SSimon Glass 	unsigned long nr_tables;
170*867a6ac8SSimon Glass 	unsigned long tables;
171*867a6ac8SSimon Glass };
172*867a6ac8SSimon Glass 
173*867a6ac8SSimon Glass struct efi_loaded_image {
174*867a6ac8SSimon Glass 	u32 revision;
175*867a6ac8SSimon Glass 	void *parent_handle;
176*867a6ac8SSimon Glass 	struct efi_system_table *system_table;
177*867a6ac8SSimon Glass 	void *device_handle;
178*867a6ac8SSimon Glass 	void *file_path;
179*867a6ac8SSimon Glass 	void *reserved;
180*867a6ac8SSimon Glass 	u32 load_options_size;
181*867a6ac8SSimon Glass 	void *load_options;
182*867a6ac8SSimon Glass 	void *image_base;
183*867a6ac8SSimon Glass 	aligned_u64 image_size;
184*867a6ac8SSimon Glass 	unsigned int image_code_type;
185*867a6ac8SSimon Glass 	unsigned int image_data_type;
186*867a6ac8SSimon Glass 	unsigned long unload;
187*867a6ac8SSimon Glass };
188*867a6ac8SSimon Glass 
189*867a6ac8SSimon Glass struct efi_device_path {
190*867a6ac8SSimon Glass 	u8 type;
191*867a6ac8SSimon Glass 	u8 sub_type;
192*867a6ac8SSimon Glass 	u16 length;
193*867a6ac8SSimon Glass };
194*867a6ac8SSimon Glass 
195*867a6ac8SSimon Glass struct simple_text_output_mode {
196*867a6ac8SSimon Glass 	s32 max_mode;
197*867a6ac8SSimon Glass 	s32 mode;
198*867a6ac8SSimon Glass 	s32 attribute;
199*867a6ac8SSimon Glass 	s32 cursor_column;
200*867a6ac8SSimon Glass 	s32 cursor_row;
201*867a6ac8SSimon Glass 	bool cursor_visible;
202*867a6ac8SSimon Glass };
203*867a6ac8SSimon Glass 
204*867a6ac8SSimon Glass struct efi_simple_text_output_protocol {
205*867a6ac8SSimon Glass 	void *reset;
206*867a6ac8SSimon Glass 	efi_status_t (EFIAPI *output_string)(
207*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this,
208*867a6ac8SSimon Glass 			const unsigned short *str);
209*867a6ac8SSimon Glass 	void *test_string;
210*867a6ac8SSimon Glass 
211*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *query_mode)(
212*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this,
213*867a6ac8SSimon Glass 			unsigned long mode_number, unsigned long *columns,
214*867a6ac8SSimon Glass 			unsigned long *rows);
215*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *set_mode)(
216*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this,
217*867a6ac8SSimon Glass 			unsigned long mode_number);
218*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *set_attribute)(
219*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this,
220*867a6ac8SSimon Glass 			unsigned long attribute);
221*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *clear_screen) (
222*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this);
223*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *set_cursor_position) (
224*867a6ac8SSimon Glass 			struct efi_simple_text_output_protocol *this,
225*867a6ac8SSimon Glass 			unsigned long column, unsigned long row);
226*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *enable_cursor)(void *, bool enable);
227*867a6ac8SSimon Glass 	struct simple_text_output_mode *mode;
228*867a6ac8SSimon Glass };
229*867a6ac8SSimon Glass 
230*867a6ac8SSimon Glass struct efi_input_key {
231*867a6ac8SSimon Glass 	u16 scan_code;
232*867a6ac8SSimon Glass 	s16 unicode_char;
233*867a6ac8SSimon Glass };
234*867a6ac8SSimon Glass 
235*867a6ac8SSimon Glass struct efi_simple_input_interface {
236*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *reset)(struct efi_simple_input_interface *this,
237*867a6ac8SSimon Glass 			bool ExtendedVerification);
238*867a6ac8SSimon Glass 	efi_status_t(EFIAPI *read_key_stroke)(
239*867a6ac8SSimon Glass 			struct efi_simple_input_interface *this,
240*867a6ac8SSimon Glass 			struct efi_input_key *key);
241*867a6ac8SSimon Glass 	void *wait_for_key;
242*867a6ac8SSimon Glass };
243*867a6ac8SSimon Glass 
244*867a6ac8SSimon Glass #endif
245