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