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