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