xref: /rk3399_rockchip-uboot/include/efi_loader.h (revision 2a22d05d335975279a7616809c47a3bf03e42994)
1 /*
2  *  EFI application loader
3  *
4  *  Copyright (c) 2016 Alexander Graf
5  *
6  *  SPDX-License-Identifier:     GPL-2.0+
7  */
8 
9 #include <common.h>
10 #include <part_efi.h>
11 #include <efi_api.h>
12 
13 /* No need for efi loader support in SPL */
14 #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
15 
16 #include <linux/list.h>
17 
18 /* #define DEBUG_EFI */
19 
20 #ifdef DEBUG_EFI
21 #define EFI_ENTRY(format, ...) do { \
22 	efi_restore_gd(); \
23 	printf("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
24 	} while(0)
25 #else
26 #define EFI_ENTRY(format, ...) do { \
27 	efi_restore_gd(); \
28 	} while(0)
29 #endif
30 
31 #define EFI_EXIT(ret) efi_exit_func(ret);
32 
33 extern struct efi_runtime_services efi_runtime_services;
34 extern struct efi_system_table systab;
35 
36 extern const struct efi_simple_text_output_protocol efi_con_out;
37 extern const struct efi_simple_input_interface efi_con_in;
38 extern const struct efi_console_control_protocol efi_console_control;
39 
40 extern const efi_guid_t efi_guid_console_control;
41 extern const efi_guid_t efi_guid_device_path;
42 extern const efi_guid_t efi_guid_loaded_image;
43 
44 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
45 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
46 
47 /*
48  * While UEFI objects can have callbacks, you can also call functions on
49  * protocols (classes) themselves. This struct maps a protocol GUID to its
50  * interface (usually a struct with callback functions).
51  */
52 struct efi_class_map {
53 	const efi_guid_t *guid;
54 	const void *interface;
55 };
56 
57 /*
58  * When the UEFI payload wants to open a protocol on an object to get its
59  * interface (usually a struct with callback functions), this struct maps the
60  * protocol GUID to the respective protocol handler open function for that
61  * object protocol combination.
62  */
63 struct efi_handler {
64 	const efi_guid_t *guid;
65 	efi_status_t (EFIAPI *open)(void *handle,
66 			efi_guid_t *protocol, void **protocol_interface,
67 			void *agent_handle, void *controller_handle,
68 			uint32_t attributes);
69 };
70 
71 /*
72  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
73  * multiple different protocols (classes) attached to it.
74  *
75  * This struct is the parent struct for all of our actual implementation objects
76  * that can include it to make themselves an EFI object
77  */
78 struct efi_object {
79 	/* Every UEFI object is part of a global object list */
80 	struct list_head link;
81 	/* We support up to 4 "protocols" an object can be accessed through */
82 	struct efi_handler protocols[4];
83 	/* The object spawner can either use this for data or as identifier */
84 	void *handle;
85 };
86 
87 /* This list contains all UEFI objects we know of */
88 extern struct list_head efi_obj_list;
89 
90 /* Called by bootefi to make all disk storage accessible as EFI objects */
91 int efi_disk_register(void);
92 /*
93  * Stub implementation for a protocol opener that just returns the handle as
94  * interface
95  */
96 efi_status_t efi_return_handle(void *handle,
97 		efi_guid_t *protocol, void **protocol_interface,
98 		void *agent_handle, void *controller_handle,
99 		uint32_t attributes);
100 /* Called from places to check whether a timer expired */
101 void efi_timer_check(void);
102 /* PE loader implementation */
103 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
104 /* Called once to store the pristine gd pointer */
105 void efi_save_gd(void);
106 /* Called from EFI_ENTRY on callback entry to put gd into the gd register */
107 void efi_restore_gd(void);
108 /* Called from EFI_EXIT on callback exit to restore the gd register */
109 efi_status_t efi_exit_func(efi_status_t ret);
110 /* Call this to relocate the runtime section to an address space */
111 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
112 
113 /*
114  * Use these to indicate that your code / data should go into the EFI runtime
115  * section and thus still be available when the OS is running
116  */
117 #define EFI_RUNTIME_DATA __attribute__ ((section ("efi_runtime_data")))
118 #define EFI_RUNTIME_TEXT __attribute__ ((section ("efi_runtime_text")))
119 
120 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
121 
122 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
123 #define EFI_RUNTIME_DATA
124 #define EFI_RUNTIME_TEXT
125 
126 /* No loader configured, stub out EFI_ENTRY */
127 static inline void efi_restore_gd(void) { }
128 
129 #endif
130