]> git.sur5r.net Git - u-boot/blob - include/efi_loader.h
efi_console: set up events
[u-boot] / 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 #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 EFI_ENTRY(format, ...) do { \
19         efi_restore_gd(); \
20         debug("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
21         } while(0)
22
23 #define EFI_EXIT(ret) efi_exit_func(ret);
24
25 extern struct efi_runtime_services efi_runtime_services;
26 extern struct efi_system_table systab;
27
28 extern const struct efi_simple_text_output_protocol efi_con_out;
29 extern struct efi_simple_input_interface efi_con_in;
30 extern const struct efi_console_control_protocol efi_console_control;
31 extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
32
33 extern const efi_guid_t efi_guid_console_control;
34 extern const efi_guid_t efi_guid_device_path;
35 extern const efi_guid_t efi_guid_loaded_image;
36 extern const efi_guid_t efi_guid_device_path_to_text_protocol;
37
38 extern unsigned int __efi_runtime_start, __efi_runtime_stop;
39 extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
40
41 /*
42  * When the UEFI payload wants to open a protocol on an object to get its
43  * interface (usually a struct with callback functions), this struct maps the
44  * protocol GUID to the respective protocol interface */
45 struct efi_handler {
46         const efi_guid_t *guid;
47         void *protocol_interface;
48 };
49
50 /*
51  * UEFI has a poor man's OO model where one "object" can be polymorphic and have
52  * multiple different protocols (classes) attached to it.
53  *
54  * This struct is the parent struct for all of our actual implementation objects
55  * that can include it to make themselves an EFI object
56  */
57 struct efi_object {
58         /* Every UEFI object is part of a global object list */
59         struct list_head link;
60         /* We support up to 8 "protocols" an object can be accessed through */
61         struct efi_handler protocols[8];
62         /* The object spawner can either use this for data or as identifier */
63         void *handle;
64 };
65
66 /**
67  * struct efi_event
68  *
69  * @type:               Type of event, see efi_create_event
70  * @notify_tpl:         Task priority level of notifications
71  * @trigger_time:       Period of the timer
72  * @trigger_next:       Next time to trigger the timer
73  * @nofify_function:    Function to call when the event is triggered
74  * @notify_context:     Data to be passed to the notify function
75  * @trigger_type:       Type of timer, see efi_set_timer
76  * @signaled:           The notify function was already called
77  */
78 struct efi_event {
79         u32 type;
80         UINTN notify_tpl;
81         void (EFIAPI *notify_function)(struct efi_event *event, void *context);
82         void *notify_context;
83         u64 trigger_next;
84         u64 trigger_time;
85         enum efi_event_type trigger_type;
86         int signaled;
87 };
88
89
90 /* This list contains all UEFI objects we know of */
91 extern struct list_head efi_obj_list;
92
93 /* Called by bootefi to make console interface available */
94 int efi_console_register(void);
95 /* Called by bootefi to make all disk storage accessible as EFI objects */
96 int efi_disk_register(void);
97 /* Called by bootefi to make GOP (graphical) interface available */
98 int efi_gop_register(void);
99 /* Called by bootefi to make the network interface available */
100 int efi_net_register(void **handle);
101 /* Called by bootefi to make SMBIOS tables available */
102 void efi_smbios_register(void);
103
104 /* Called by networking code to memorize the dhcp ack package */
105 void efi_net_set_dhcp_ack(void *pkt, int len);
106
107 /* Called from places to check whether a timer expired */
108 void efi_timer_check(void);
109 /* PE loader implementation */
110 void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
111 /* Called once to store the pristine gd pointer */
112 void efi_save_gd(void);
113 /* Called from EFI_ENTRY on callback entry to put gd into the gd register */
114 void efi_restore_gd(void);
115 /* Called from EFI_EXIT on callback exit to restore the gd register */
116 efi_status_t efi_exit_func(efi_status_t ret);
117 /* Call this to relocate the runtime section to an address space */
118 void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
119 /* Call this to set the current device name */
120 void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
121 /* Call this to create an event */
122 efi_status_t efi_create_event(enum efi_event_type type, UINTN notify_tpl,
123                               void (EFIAPI *notify_function) (
124                                         struct efi_event *event,
125                                         void *context),
126                               void *notify_context, struct efi_event **event);
127 /* Call this to set a timer */
128 efi_status_t efi_set_timer(struct efi_event *event, int type,
129                            uint64_t trigger_time);
130 /* Call this to signal an event */
131 void efi_signal_event(struct efi_event *event);
132
133 /* Generic EFI memory allocator, call this to get memory */
134 void *efi_alloc(uint64_t len, int memory_type);
135 /* More specific EFI memory allocator, called by EFI payloads */
136 efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
137                                 uint64_t *memory);
138 /* EFI memory free function. */
139 efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
140 /* EFI memory allocator for small allocations */
141 efi_status_t efi_allocate_pool(int pool_type, unsigned long size,
142                                void **buffer);
143 /* EFI pool memory free function. */
144 efi_status_t efi_free_pool(void *buffer);
145 /* Returns the EFI memory map */
146 efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
147                                 struct efi_mem_desc *memory_map,
148                                 unsigned long *map_key,
149                                 unsigned long *descriptor_size,
150                                 uint32_t *descriptor_version);
151 /* Adds a range into the EFI memory map */
152 uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
153                             bool overlap_only_ram);
154 /* Called by board init to initialize the EFI memory map */
155 int efi_memory_init(void);
156 /* Adds new or overrides configuration table entry to the system table */
157 efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
158
159 #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
160 extern void *efi_bounce_buffer;
161 #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
162 #endif
163
164 /* Convert strings from normal C strings to uEFI strings */
165 static inline void ascii2unicode(u16 *unicode, const char *ascii)
166 {
167         while (*ascii)
168                 *(unicode++) = *(ascii++);
169 }
170
171 /*
172  * Use these to indicate that your code / data should go into the EFI runtime
173  * section and thus still be available when the OS is running
174  */
175 #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
176 #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
177
178 /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
179  * to make it available at runtime */
180 void efi_add_runtime_mmio(void *mmio_ptr, u64 len);
181
182 /* Boards may provide the functions below to implement RTS functionality */
183
184 void __efi_runtime EFIAPI efi_reset_system(
185                         enum efi_reset_type reset_type,
186                         efi_status_t reset_status,
187                         unsigned long data_size, void *reset_data);
188 void efi_reset_system_init(void);
189
190 efi_status_t __efi_runtime EFIAPI efi_get_time(
191                         struct efi_time *time,
192                         struct efi_time_cap *capabilities);
193 void efi_get_time_init(void);
194
195 #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
196
197 /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
198 #define __efi_runtime_data
199 #define __efi_runtime
200 static inline void efi_add_runtime_mmio(void *mmio_ptr, u64 len) { }
201
202 /* No loader configured, stub out EFI_ENTRY */
203 static inline void efi_restore_gd(void) { }
204 static inline void efi_set_bootdev(const char *dev, const char *devnr,
205                                    const char *path) { }
206 static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
207
208 #endif