blob: 97388350eb90e87ad32bbb56ed667ce0b14f12c6 [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 EFI_ENTRY(format, ...) do { \
19 efi_restore_gd(); \
Alexander Grafedcef3b2016-06-02 11:38:27 +020020 debug("EFI: Entry %s(" format ")\n", __func__, ##__VA_ARGS__); \
Alexander Grafbee91162016-03-04 01:09:59 +010021 } while(0)
Alexander Grafbee91162016-03-04 01:09:59 +010022
23#define EFI_EXIT(ret) efi_exit_func(ret);
24
Alexander Graf50149ea2016-03-04 01:10:01 +010025extern struct efi_runtime_services efi_runtime_services;
Alexander Grafbee91162016-03-04 01:09:59 +010026extern struct efi_system_table systab;
27
Alexander Grafc1311ad2016-03-04 01:10:00 +010028extern const struct efi_simple_text_output_protocol efi_con_out;
29extern const struct efi_simple_input_interface efi_con_in;
30extern const struct efi_console_control_protocol efi_console_control;
31
32extern const efi_guid_t efi_guid_console_control;
Alexander Grafcb149c62016-03-04 01:09:58 +010033extern const efi_guid_t efi_guid_device_path;
34extern const efi_guid_t efi_guid_loaded_image;
35
Alexander Graf50149ea2016-03-04 01:10:01 +010036extern unsigned int __efi_runtime_start, __efi_runtime_stop;
37extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
38
Alexander Grafbee91162016-03-04 01:09:59 +010039/*
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 */
44struct 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 */
55struct 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 */
70struct 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 */
80extern struct list_head efi_obj_list;
81
Alexander Graf2a22d052016-03-04 01:10:02 +010082/* Called by bootefi to make all disk storage accessible as EFI objects */
83int efi_disk_register(void);
Alexander Grafbe8d3242016-03-15 18:38:21 +010084/* Called by bootefi to make GOP (graphical) interface available */
85int efi_gop_register(void);
Alexander Graf0efe1bc2016-05-06 21:01:01 +020086/* Called by bootefi to make the network interface available */
87int efi_net_register(void **handle);
88
89/* Called by networking code to memorize the dhcp ack package */
90void efi_net_set_dhcp_ack(void *pkt, int len);
91
Alexander Grafbee91162016-03-04 01:09:59 +010092/*
93 * Stub implementation for a protocol opener that just returns the handle as
94 * interface
95 */
Alexander Grafcb149c62016-03-04 01:09:58 +010096efi_status_t efi_return_handle(void *handle,
97 efi_guid_t *protocol, void **protocol_interface,
98 void *agent_handle, void *controller_handle,
99 uint32_t attributes);
Alexander Grafbee91162016-03-04 01:09:59 +0100100/* Called from places to check whether a timer expired */
101void efi_timer_check(void);
102/* PE loader implementation */
Alexander Grafcb149c62016-03-04 01:09:58 +0100103void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
Alexander Grafbee91162016-03-04 01:09:59 +0100104/* Called once to store the pristine gd pointer */
105void efi_save_gd(void);
106/* Called from EFI_ENTRY on callback entry to put gd into the gd register */
107void efi_restore_gd(void);
108/* Called from EFI_EXIT on callback exit to restore the gd register */
109efi_status_t efi_exit_func(efi_status_t ret);
Alexander Graf50149ea2016-03-04 01:10:01 +0100110/* Call this to relocate the runtime section to an address space */
111void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
Alexander Graf0f4060e2016-03-04 01:10:14 +0100112/* Call this to set the current device name */
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200113void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
Alexander Graf50149ea2016-03-04 01:10:01 +0100114
Alexander Graf5d009952016-03-04 01:10:04 +0100115/* Generic EFI memory allocator, call this to get memory */
116void *efi_alloc(uint64_t len, int memory_type);
117/* More specific EFI memory allocator, called by EFI payloads */
118efi_status_t efi_allocate_pages(int type, int memory_type, unsigned long pages,
119 uint64_t *memory);
120/* EFI memory free function. Not implemented today */
121efi_status_t efi_free_pages(uint64_t memory, unsigned long pages);
122/* Returns the EFI memory map */
123efi_status_t efi_get_memory_map(unsigned long *memory_map_size,
124 struct efi_mem_desc *memory_map,
125 unsigned long *map_key,
126 unsigned long *descriptor_size,
127 uint32_t *descriptor_version);
128/* Adds a range into the EFI memory map */
129uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
130 bool overlap_only_ram);
131/* Called by board init to initialize the EFI memory map */
132int efi_memory_init(void);
133
Alexander Graf51735ae2016-05-11 18:25:48 +0200134#ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
135extern void *efi_bounce_buffer;
136#define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
137#endif
138
Alexander Graf0f4060e2016-03-04 01:10:14 +0100139/* Convert strings from normal C strings to uEFI strings */
Simon Glass487d7562016-05-14 14:03:05 -0600140static inline void ascii2unicode(u16 *unicode, const char *ascii)
Alexander Graf0f4060e2016-03-04 01:10:14 +0100141{
142 while (*ascii)
143 *(unicode++) = *(ascii++);
144}
145
Alexander Graf50149ea2016-03-04 01:10:01 +0100146/*
147 * Use these to indicate that your code / data should go into the EFI runtime
148 * section and thus still be available when the OS is running
149 */
150#define EFI_RUNTIME_DATA __attribute__ ((section ("efi_runtime_data")))
151#define EFI_RUNTIME_TEXT __attribute__ ((section ("efi_runtime_text")))
Alexander Grafbee91162016-03-04 01:09:59 +0100152
153#else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
154
Alexander Graf50149ea2016-03-04 01:10:01 +0100155/* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
156#define EFI_RUNTIME_DATA
157#define EFI_RUNTIME_TEXT
158
Alexander Grafbee91162016-03-04 01:09:59 +0100159/* No loader configured, stub out EFI_ENTRY */
160static inline void efi_restore_gd(void) { }
Alexander Grafc07ad7c2016-04-11 16:16:19 +0200161static inline void efi_set_bootdev(const char *dev, const char *devnr,
162 const char *path) { }
Alexander Graf0efe1bc2016-05-06 21:01:01 +0200163static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
Alexander Grafbee91162016-03-04 01:09:59 +0100164
165#endif