419832923044ccfacfea6604ba1e3c7168e1decb
[platform/kernel/u-boot.git] / include / efi_loader.h
1 /*
2  *  EFI application loader
3  *
4  *  Copyright (c) 2016 Alexander Graf
5  *
6  *  SPDX-License-Identifier:     GPL-2.0+
7  */
8
9 #ifndef _EFI_LOADER_H
10 #define _EFI_LOADER_H 1
11
12 #include <common.h>
13 #include <part_efi.h>
14 #include <efi_api.h>
15
16 /* No need for efi loader support in SPL */
17 #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
18
19 #include <linux/list.h>
20
21 int __efi_entry_check(void);
22 int __efi_exit_check(void);
23 const char *__efi_nesting(void);
24 const char *__efi_nesting_inc(void);
25 const char *__efi_nesting_dec(void);
26
27 /*
28  * Enter the u-boot world from UEFI:
29  */
30 #define EFI_ENTRY(format, ...) do { \
31         assert(__efi_entry_check()); \
32         debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
33                 __func__, ##__VA_ARGS__); \
34         } while(0)
35
36 /*
37  * Exit the u-boot world back to UEFI:
38  */
39 #define EFI_EXIT(ret) ({ \
40         typeof(ret) _r = ret; \
41         debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
42                 __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
43         assert(__efi_exit_check()); \
44         _r; \
45         })
46
47 /*
48  * Call non-void UEFI function from u-boot and retrieve return value:
49  */
50 #define EFI_CALL(exp) ({ \
51         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
52         assert(__efi_exit_check()); \
53         typeof(exp) _r = exp; \
54         assert(__efi_entry_check()); \
55         debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
56               (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
57         _r; \
58 })
59
60 /*
61  * Call void UEFI function from u-boot:
62  */
63 #define EFI_CALL_VOID(exp) do { \
64         debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
65         assert(__efi_exit_check()); \
66         exp; \
67         assert(__efi_entry_check()); \
68         debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
69         } while(0)
70
71 /*
72  * Write an indented message with EFI prefix
73  */
74 #define EFI_PRINT(format, ...) ({ \
75         debug("%sEFI: " format, __efi_nesting(), \
76                 ##__VA_ARGS__); \
77         })
78
79 extern struct efi_runtime_services efi_runtime_services;
80 extern struct efi_system_table systab;
81
82 extern struct efi_simple_text_output_protocol efi_con_out;
83 extern struct efi_simple_input_interface efi_con_in;
84 extern struct efi_console_control_protocol efi_console_control;
85 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
86
87 uint16_t *efi_dp_str(struct efi_device_path *dp);
88
89 extern const efi_guid_t efi_global_variable_guid;
90 extern const efi_guid_t efi_guid_console_control;
91 extern const efi_guid_t efi_guid_device_path;
92 extern const efi_guid_t efi_guid_loaded_image;
93 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
94 extern const efi_guid_t efi_simple_file_system_protocol_guid;
95 extern const efi_guid_t efi_file_info_guid;
96
97 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
98 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
99
100 /*
101  * When a protocol is opened a open protocol info entry is created.
102  * These are maintained in a list.
103  */
104 struct efi_open_protocol_info_item {
105         /* Link to the list of open protocol info entries of a protocol */
106         struct list_head link;
107         struct efi_open_protocol_info_entry info;
108 };
109
110 /*
111  * When the UEFI payload wants to open a protocol on an object to get its
112  * interface (usually a struct with callback functions), this struct maps the
113  * protocol GUID to the respective protocol interface
114  */
115 struct efi_handler {
116         /* Link to the list of protocols of a handle */
117         struct list_head link;
118         const efi_guid_t *guid;
119         void *protocol_interface;
120         /* Link to the list of open protocol info items */
121         struct list_head open_infos;
122 };
123
124 /*
125  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
126  * multiple different protocols (classes) attached to it.
127  *
128  * This struct is the parent struct for all of our actual implementation objects
129  * that can include it to make themselves an EFI object
130  */
131 struct efi_object {
132         /* Every UEFI object is part of a global object list */
133         struct list_head link;
134         /* The list of protocols */
135         struct list_head protocols;
136         /* The object spawner can either use this for data or as identifier */
137         void *handle;
138 };
139
140 /**
141  * struct efi_event
142  *
143  * @type:               Type of event, see efi_create_event
144  * @notify_tpl:         Task priority level of notifications
145  * @trigger_time:       Period of the timer
146  * @trigger_next:       Next time to trigger the timer
147  * @nofify_function:    Function to call when the event is triggered
148  * @notify_context:     Data to be passed to the notify function
149  * @trigger_type:       Type of timer, see efi_set_timer
150  * @queued:             The notification function is queued
151  * @signaled:           The event occurred. The event is in the signaled state.
152  */
153 struct efi_event {
154         uint32_t type;
155         efi_uintn_t notify_tpl;
156         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
157         void *notify_context;
158         u64 trigger_next;
159         u64 trigger_time;
160         enum efi_timer_delay trigger_type;
161         bool is_queued;
162         bool is_signaled;
163 };
164
165
166 /* This list contains all UEFI objects we know of */
167 extern struct list_head efi_obj_list;
168
169 /* Called by bootefi to make console interface available */
170 int efi_console_register(void);
171 /* Called by bootefi to make all disk storage accessible as EFI objects */
172 int efi_disk_register(void);
173 /* Called by bootefi to make GOP (graphical) interface available */
174 int efi_gop_register(void);
175 /* Called by bootefi to make the network interface available */
176 int efi_net_register(void);
177 /* Called by bootefi to make the watchdog available */
178 int efi_watchdog_register(void);
179 /* Called by bootefi to make SMBIOS tables available */
180 void efi_smbios_register(void);
181
182 struct efi_simple_file_system_protocol *
183 efi_fs_from_path(struct efi_device_path *fp);
184
185 /* Called by networking code to memorize the dhcp ack package */
186 void efi_net_set_dhcp_ack(void *pkt, int len);
187 /* Called by efi_set_watchdog_timer to reset the timer */
188 efi_status_t efi_set_watchdog(unsigned long timeout);
189
190 /* Called from places to check whether a timer expired */
191 void efi_timer_check(void);
192 /* PE loader implementation */
193 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
194 /* Called once to store the pristine gd pointer */
195 void efi_save_gd(void);
196 /* Special case handler for error/abort that just tries to dtrt to get
197  * back to u-boot world */
198 void efi_restore_gd(void);
199 /* Call this to relocate the runtime section to an address space */
200 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
201 /* Call this to set the current device name */
202 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
203 /* Add a new object to the object list. */
204 void efi_add_handle(struct efi_object *obj);
205 /* Create handle */
206 efi_status_t efi_create_handle(void **handle);
207 /* Delete handle */
208 void efi_delete_handle(struct efi_object *obj);
209 /* Call this to validate a handle and find the EFI object for it */
210 struct efi_object *efi_search_obj(const void *handle);
211 /* Find a protocol on a handle */
212 efi_status_t efi_search_protocol(const void *handle,
213                                  const efi_guid_t *protocol_guid,
214                                  struct efi_handler **handler);
215 /* Install new protocol on a handle */
216 efi_status_t efi_add_protocol(const void *handle, const efi_guid_t *protocol,
217                               void *protocol_interface);
218 /* Delete protocol from a handle */
219 efi_status_t efi_remove_protocol(const void *handle, const efi_guid_t *protocol,
220                                  void *protocol_interface);
221 /* Delete all protocols from a handle */
222 efi_status_t efi_remove_all_protocols(const void *handle);
223 /* Call this to create an event */
224 efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
225                               void (EFIAPI *notify_function) (
226                                         struct efi_event *event,
227                                         void *context),
228                               void *notify_context, struct efi_event **event);
229 /* Call this to set a timer */
230 efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
231                            uint64_t trigger_time);
232 /* Call this to signal an event */
233 void efi_signal_event(struct efi_event *event);
234
235 /* open file system: */
236 struct efi_simple_file_system_protocol *efi_simple_file_system(
237                 struct blk_desc *desc, int part, struct efi_device_path *dp);
238
239 /* open file from device-path: */
240 struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
241
242
243 /* Generic EFI memory allocator, call this to get memory */
244 void *efi_alloc(uint64_t len, int memory_type);
245 /* More specific EFI memory allocator, called by EFI payloads */
246 efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
247                                 uint64_t *memory);
248 /* EFI memory free function. */
249 efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
250 /* EFI memory allocator for small allocations */
251 efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
252                                void **buffer);
253 /* EFI pool memory free function. */
254 efi_status_t efi_free_pool(void *buffer);
255 /* Returns the EFI memory map */
256 efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
257                                 struct efi_mem_desc *memory_map,
258                                 efi_uintn_t *map_key,
259                                 efi_uintn_t *descriptor_size,
260                                 uint32_t *descriptor_version);
261 /* Adds a range into the EFI memory map */
262 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
263                             bool overlap_only_ram);
264 /* Called by board init to initialize the EFI memory map */
265 int efi_memory_init(void);
266 /* Adds new or overrides configuration table entry to the system table */
267 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
268 /* Sets up a loaded image */
269 efi_status_t efi_setup_loaded_image(
270                         struct efi_loaded_image *info, struct efi_object *obj,
271                         struct efi_device_path *device_path,
272                         struct efi_device_path *file_path);
273 efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
274                                       void **buffer);
275
276 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
277 extern void *efi_bounce_buffer;
278 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
279 #endif
280
281
282 struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
283 int efi_dp_match(const struct efi_device_path *a,
284                  const struct efi_device_path *b);
285 struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
286                                    struct efi_device_path **rem);
287 unsigned efi_dp_size(const struct efi_device_path *dp);
288 struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
289 struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
290                                       const struct efi_device_path *dp2);
291 struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
292                                            const struct efi_device_path *node);
293
294
295 struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
296 struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
297 struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
298                                          const char *path);
299 struct efi_device_path *efi_dp_from_eth(void);
300 struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
301                                         uint64_t start_address,
302                                         uint64_t end_address);
303 void efi_dp_split_file_path(struct efi_device_path *full_path,
304                             struct efi_device_path **device_path,
305                             struct efi_device_path **file_path);
306
307 #define EFI_DP_TYPE(_dp, _type, _subtype) \
308         (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
309          ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
310
311 /* Convert strings from normal C strings to uEFI strings */
312 static inline void ascii2unicode(u16 *unicode, const char *ascii)
313 {
314         while (*ascii)
315                 *(unicode++) = *(ascii++);
316 }
317
318 static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
319 {
320         return memcmp(g1, g2, sizeof(efi_guid_t));
321 }
322
323 /*
324  * Use these to indicate that your code / data should go into the EFI runtime
325  * section and thus still be available when the OS is running
326  */
327 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
328 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
329
330 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
331  * to make it available at runtime */
332 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
333
334 /* Boards may provide the functions below to implement RTS functionality */
335
336 void __efi_runtime EFIAPI efi_reset_system(
337                         enum efi_reset_type reset_type,
338                         efi_status_t reset_status,
339                         unsigned long data_size, void *reset_data);
340 void efi_reset_system_init(void);
341
342 efi_status_t __efi_runtime EFIAPI efi_get_time(
343                         struct efi_time *time,
344                         struct efi_time_cap *capabilities);
345 void efi_get_time_init(void);
346
347 #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
348 /*
349  * Entry point for the tests of the EFI API.
350  * It is called by 'bootefi selftest'
351  */
352 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
353                                  struct efi_system_table *systab);
354 #endif
355
356 efi_status_t EFIAPI efi_get_variable(s16 *variable_name,
357                 efi_guid_t *vendor, u32 *attributes,
358                 unsigned long *data_size, void *data);
359 efi_status_t EFIAPI efi_get_next_variable(
360                 unsigned long *variable_name_size,
361                 s16 *variable_name, efi_guid_t *vendor);
362 efi_status_t EFIAPI efi_set_variable(s16 *variable_name,
363                 efi_guid_t *vendor, u32 attributes,
364                 unsigned long data_size, void *data);
365
366 void *efi_bootmgr_load(struct efi_device_path **device_path,
367                        struct efi_device_path **file_path);
368
369 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
370
371 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
372 #define __efi_runtime_data
373 #define __efi_runtime
374 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
375
376 /* No loader configured, stub out EFI_ENTRY */
377 static inline void efi_restore_gd(void) { }
378 static inline void efi_set_bootdev(const char *dev, const char *devnr,
379                                    const char *path) { }
380 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
381
382 #endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
383
384 #endif /* _EFI_LOADER_H */