blob: 9f61fc4b122b830cd161cbc0a097ee7135a5c1c5 [file] [log] [blame]
Alexander Grafcb149c62016-03-04 01:09:58 +01001/*
2 * EFI application loader
3 *
4 * Copyright (c) 2016 Alexander Graf
5 *
6 * SPDX-License-Identifier: GPL-2.0+
7 */
8
Alexander Grafbee91162016-03-04 01:09:59 +01009#include <common.h>
Alexander Grafcb149c62016-03-04 01:09:58 +010010#include <part_efi.h>
11#include <efi_api.h>
Alexander Grafbee91162016-03-04 01:09:59 +010012
13/* No need for efi loader support in SPL */
14#if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
15
Alexander Grafcb149c62016-03-04 01:09:58 +010016#include <linux/list.h>
17
Alexander Grafbee91162016-03-04 01:09:59 +010018/* #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
Alexander Graf50149ea2016-03-04 01:10:01 +010033extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +010034extern struct efi_system_table systab;
35
Alexander Grafc1311ad2016-03-04 01:10:00 +010036extern const struct efi_simple_text_output_protocol efi_con_out;
37extern const struct efi_simple_input_interface efi_con_in;
38extern const struct efi_console_control_protocol efi_console_control;
39
40extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +010041extern const efi_guid_t efi_guid_device_path;
42extern const efi_guid_t efi_guid_loaded_image;
43
Alexander Graf50149ea2016-03-04 01:10:01 +010044extern unsigned int __efi_runtime_start, __efi_runtime_stop;
45extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
46
Alexander Grafbee91162016-03-04 01:09:59 +010047/*
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 */
52struct 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 */
63struct 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 */
78struct 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 */
88extern struct list_head efi_obj_list;
89
Alexander Graf2a22d052016-03-04 01:10:02 +010090/* Called by bootefi to make all disk storage accessible as EFI objects */
91int efi_disk_register(void);
Alexander Grafbe8d3242016-03-15 18:38:21 +010092/* Called by bootefi to make GOP (graphical) interface available */
93int efi_gop_register(void);
Alexander Grafbee91162016-03-04 01:09:59 +010094/*
95 * Stub implementation for a protocol opener that just returns the handle as
96 * interface
97 */
Alexander Grafcb149c62016-03-04 01:09:58 +010098efi_status_t efi_return_handle(void *handle,
99 efi_guid_t *protocol, void **protocol_interface,
100 void *agent_handle, void *controller_handle,
101 uint32_t attributes);
Alexander Grafbee91162016-03-04 01:09:59 +0100102/* Called from places to check whether a timer expired */
103void efi_timer_check(void);
104/* PE loader implementation */
Alexander Grafcb149c62016-03-04 01:09:58 +0100105void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100106/* Called once to store the pristine gd pointer */
107void efi_save_gd(void);
108/* Called from EFI_ENTRY on callback entry to put gd into the gd register */
109void efi_restore_gd(void);
110/* Called from EFI_EXIT on callback exit to restore the gd register */
111efi_status_t efi_exit_func(efi_status_t ret);
Alexander Graf50149ea2016-03-04 01:10:01 +0100112/* Call this to relocate the runtime section to an address space */
113void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100114/* Call this to set the current device name */
115void efi_set_bootdev(const char *dev, const char *devnr);
Alexander Graf50149ea2016-03-04 01:10:01 +0100116
Alexander Graf5d009952016-03-04 01:10:04 +0100117/* Generic EFI memory allocator, call this to get memory */
118void *efi_alloc(uint64_t len, int memory_type);
119/* More specific EFI memory allocator, called by EFI payloads */
120efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
121 uint64_t *memory);
122/* EFI memory free function. Not implemented today */
123efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
124/* Returns the EFI memory map */
125efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
126 struct efi_mem_desc *memory_map,
127 unsigned long *map_key,
128 unsigned long *descriptor_size,
129 uint32_t *descriptor_version);
130/* Adds a range into the EFI memory map */
131uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
132 bool overlap_only_ram);
133/* Called by board init to initialize the EFI memory map */
134int efi_memory_init(void);
135
Alexander Graf0f4060e2016-03-04 01:10:14 +0100136/* Convert strings from normal C strings to uEFI strings */
137static inline void ascii2unicode(u16 *unicode, char *ascii)
138{
139 while (*ascii)
140 *(unicode++) = *(ascii++);
141}
142
Alexander Graf50149ea2016-03-04 01:10:01 +0100143/*
144 * Use these to indicate that your code / data should go into the EFI runtime
145 * section and thus still be available when the OS is running
146 */
147#define EFI_RUNTIME_DATA __attribute__ ((section ("efi_runtime_data")))
148#define EFI_RUNTIME_TEXT __attribute__ ((section ("efi_runtime_text")))
Alexander Grafbee91162016-03-04 01:09:59 +0100149
150#else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
151
Alexander Graf50149ea2016-03-04 01:10:01 +0100152/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
153#define EFI_RUNTIME_DATA
154#define EFI_RUNTIME_TEXT
155
Alexander Grafbee91162016-03-04 01:09:59 +0100156/* No loader configured, stub out EFI_ENTRY */
157static inline void efi_restore_gd(void) { }
Alexander Graf0f4060e2016-03-04 01:10:14 +0100158static inline void efi_set_bootdev(const char *dev, const char *devnr) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100159
160#endif