blob: c0bd99b86746536508d18f51bf27b9282c069b05 [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Graf50149ea2016-03-04 01:10:01 +01002/*
3 * EFI application runtime services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf50149ea2016-03-04 01:10:01 +01006 */
7
8#include <common.h>
9#include <command.h>
Simon Glass1eb69ae2019-11-14 12:57:39 -070010#include <cpu_func.h>
Alexander Graf50149ea2016-03-04 01:10:01 +010011#include <dm.h>
Alexander Grafb34662d2018-06-18 17:23:11 +020012#include <elf.h>
Alexander Graf50149ea2016-03-04 01:10:01 +010013#include <efi_loader.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060014#include <log.h>
Simon Glass336d4612020-02-03 07:36:16 -070015#include <malloc.h>
Alexander Graf50149ea2016-03-04 01:10:01 +010016#include <rtc.h>
Simon Glass3db71102019-11-14 12:57:16 -070017#include <u-boot/crc.h>
Alexander Graf50149ea2016-03-04 01:10:01 +010018
19/* For manual relocation support */
20DECLARE_GLOBAL_DATA_PTR;
21
Heinrich Schuchardt76be6872020-02-19 20:48:49 +010022/* GUID of the runtime properties table */
23static const efi_guid_t efi_rt_properties_table_guid =
24 EFI_RT_PROPERTIES_TABLE_GUID;
25
Alexander Graf80a48002016-08-16 21:08:45 +020026struct efi_runtime_mmio_list {
27 struct list_head link;
28 void **ptr;
29 u64 paddr;
30 u64 len;
31};
32
33/* This list contains all runtime available mmio regions */
34LIST_HEAD(efi_runtime_mmio);
35
Alexander Graf3c63db92016-10-14 13:45:30 +020036static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
Alexander Graf50149ea2016-03-04 01:10:01 +010037
Simon Glass2d2b5b22018-06-11 23:26:40 -060038/*
Heinrich Schuchardt250b3252018-09-03 19:29:41 +020039 * TODO(sjg@chromium.org): These defines and structures should come from the ELF
40 * header for each architecture (or a generic header) rather than being repeated
41 * here.
Simon Glass2d2b5b22018-06-11 23:26:40 -060042 */
Alexander Grafbc028912018-06-18 17:23:08 +020043#if defined(__aarch64__)
Alexander Grafb34662d2018-06-18 17:23:11 +020044#define R_RELATIVE R_AARCH64_RELATIVE
Alexander Graf50149ea2016-03-04 01:10:01 +010045#define R_MASK 0xffffffffULL
46#define IS_RELA 1
Alexander Grafbc028912018-06-18 17:23:08 +020047#elif defined(__arm__)
Alexander Grafb34662d2018-06-18 17:23:11 +020048#define R_RELATIVE R_ARM_RELATIVE
Alexander Graf50149ea2016-03-04 01:10:01 +010049#define R_MASK 0xffULL
Heinrich Schuchardt3ce78292018-10-13 20:52:08 -070050#elif defined(__i386__)
Simon Glass65e4c0b2016-09-25 15:27:35 -060051#define R_RELATIVE R_386_RELATIVE
52#define R_MASK 0xffULL
Heinrich Schuchardt3ce78292018-10-13 20:52:08 -070053#elif defined(__x86_64__)
54#define R_RELATIVE R_X86_64_RELATIVE
55#define R_MASK 0xffffffffULL
56#define IS_RELA 1
Alexander Grafbc028912018-06-18 17:23:08 +020057#elif defined(__riscv)
Rick Chen6836adb2018-05-28 19:06:37 +080058#define R_RELATIVE R_RISCV_RELATIVE
59#define R_MASK 0xffULL
60#define IS_RELA 1
61
62struct dyn_sym {
63 ulong foo1;
64 ulong addr;
65 u32 foo2;
66 u32 foo3;
67};
Alexander Grafbc028912018-06-18 17:23:08 +020068#if (__riscv_xlen == 32)
Rick Chen6836adb2018-05-28 19:06:37 +080069#define R_ABSOLUTE R_RISCV_32
70#define SYM_INDEX 8
Alexander Grafbc028912018-06-18 17:23:08 +020071#elif (__riscv_xlen == 64)
Rick Chen6836adb2018-05-28 19:06:37 +080072#define R_ABSOLUTE R_RISCV_64
73#define SYM_INDEX 32
Alexander Grafbc028912018-06-18 17:23:08 +020074#else
75#error unknown riscv target
Rick Chen6836adb2018-05-28 19:06:37 +080076#endif
Alexander Graf50149ea2016-03-04 01:10:01 +010077#else
78#error Need to add relocation awareness
79#endif
80
81struct elf_rel {
82 ulong *offset;
83 ulong info;
84};
85
86struct elf_rela {
87 ulong *offset;
88 ulong info;
89 long addend;
90};
91
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +020092static __efi_runtime_data struct efi_mem_desc *efi_virtmap;
93static __efi_runtime_data efi_uintn_t efi_descriptor_count;
94static __efi_runtime_data efi_uintn_t efi_descriptor_size;
95
Alexander Graf50149ea2016-03-04 01:10:01 +010096/*
Heinrich Schuchardt250b3252018-09-03 19:29:41 +020097 * EFI runtime code lives in two stages. In the first stage, U-Boot and an EFI
Alexander Graf50149ea2016-03-04 01:10:01 +010098 * payload are running concurrently at the same time. In this mode, we can
99 * handle a good number of runtime callbacks
100 */
101
Heinrich Schuchardt76be6872020-02-19 20:48:49 +0100102/**
103 * efi_init_runtime_supported() - create runtime properties table
104 *
105 * Create a configuration table specifying which services are available at
106 * runtime.
107 *
108 * Return: status code
109 */
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900110efi_status_t efi_init_runtime_supported(void)
111{
Heinrich Schuchardt76be6872020-02-19 20:48:49 +0100112 efi_status_t ret;
113 struct efi_rt_properties_table *rt_table;
114
115 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
116 sizeof(struct efi_rt_properties_table),
117 (void **)&rt_table);
118 if (ret != EFI_SUCCESS)
119 return ret;
120
121 rt_table->version = EFI_RT_PROPERTIES_TABLE_VERSION;
122 rt_table->length = sizeof(struct efi_rt_properties_table);
123 rt_table->runtime_services_supported =
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200124 EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP |
125 EFI_RT_SUPPORTED_CONVERT_POINTER;
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900126
127 /*
128 * This value must be synced with efi_runtime_detach_list
129 * as well as efi_runtime_services.
130 */
Heinrich Schuchardt953661a2019-07-05 18:12:16 +0200131#ifdef CONFIG_EFI_HAVE_RUNTIME_RESET
Heinrich Schuchardt76be6872020-02-19 20:48:49 +0100132 rt_table->runtime_services_supported |= EFI_RT_SUPPORTED_RESET_SYSTEM;
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900133#endif
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200134
Heinrich Schuchardt76be6872020-02-19 20:48:49 +0100135 ret = efi_install_configuration_table(&efi_rt_properties_table_guid,
136 rt_table);
137 return ret;
AKASHI Takahiroe771b4b2019-06-05 13:21:38 +0900138}
139
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200140/**
141 * efi_update_table_header_crc32() - Update crc32 in table header
142 *
143 * @table: EFI table
144 */
145void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table)
146{
147 table->crc32 = 0;
148 table->crc32 = crc32(0, (const unsigned char *)table,
149 table->headersize);
150}
151
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200152/**
Heinrich Schuchardt250b3252018-09-03 19:29:41 +0200153 * efi_reset_system_boottime() - reset system at boot time
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200154 *
155 * This function implements the ResetSystem() runtime service before
156 * SetVirtualAddressMap() is called.
157 *
158 * See the Unified Extensible Firmware Interface (UEFI) specification for
159 * details.
160 *
161 * @reset_type: type of reset to perform
162 * @reset_status: status code for the reset
163 * @data_size: size of reset_data
164 * @reset_data: information about the reset
165 */
Alexander Graf80a48002016-08-16 21:08:45 +0200166static void EFIAPI efi_reset_system_boottime(
167 enum efi_reset_type reset_type,
168 efi_status_t reset_status,
169 unsigned long data_size, void *reset_data)
Alexander Graf50149ea2016-03-04 01:10:01 +0100170{
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100171 struct efi_event *evt;
172
Alexander Graf50149ea2016-03-04 01:10:01 +0100173 EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
174 reset_data);
175
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100176 /* Notify reset */
177 list_for_each_entry(evt, &efi_events, link) {
178 if (evt->group &&
179 !guidcmp(evt->group,
180 &efi_guid_event_group_reset_system)) {
Heinrich Schuchardt7eaa9002019-06-07 06:47:01 +0200181 efi_signal_event(evt);
Heinrich Schuchardtb095f3c2018-02-18 15:17:52 +0100182 break;
183 }
184 }
Alexander Graf50149ea2016-03-04 01:10:01 +0100185 switch (reset_type) {
186 case EFI_RESET_COLD:
187 case EFI_RESET_WARM:
Heinrich Schuchardt482fc902018-02-06 22:00:22 +0100188 case EFI_RESET_PLATFORM_SPECIFIC:
Alexander Graf50149ea2016-03-04 01:10:01 +0100189 do_reset(NULL, 0, 0, NULL);
190 break;
191 case EFI_RESET_SHUTDOWN:
Heinrich Schuchardte706ed72018-10-16 07:44:53 +0200192#ifdef CONFIG_CMD_POWEROFF
193 do_poweroff(NULL, 0, 0, NULL);
194#endif
Alexander Graf50149ea2016-03-04 01:10:01 +0100195 break;
196 }
197
Alexander Graf80a48002016-08-16 21:08:45 +0200198 while (1) { }
Alexander Graf50149ea2016-03-04 01:10:01 +0100199}
200
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200201/**
Heinrich Schuchardt250b3252018-09-03 19:29:41 +0200202 * efi_get_time_boottime() - get current time at boot time
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200203 *
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200204 * This function implements the GetTime runtime service before
205 * SetVirtualAddressMap() is called.
206 *
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200207 * See the Unified Extensible Firmware Interface (UEFI) specification
208 * for details.
209 *
210 * @time: pointer to structure to receive current time
211 * @capabilities: pointer to structure to receive RTC properties
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200212 * Returns: status code
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200213 */
Alexander Graf80a48002016-08-16 21:08:45 +0200214static efi_status_t EFIAPI efi_get_time_boottime(
215 struct efi_time *time,
216 struct efi_time_cap *capabilities)
Alexander Graf50149ea2016-03-04 01:10:01 +0100217{
Heinrich Schuchardt5ec48e32019-05-31 22:56:02 +0200218#ifdef CONFIG_EFI_GET_TIME
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200219 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200220 struct rtc_time tm;
Alexander Graf50149ea2016-03-04 01:10:01 +0100221 struct udevice *dev;
222
223 EFI_ENTRY("%p %p", time, capabilities);
224
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200225 if (!time) {
226 ret = EFI_INVALID_PARAMETER;
227 goto out;
228 }
Heinrich Schuchardtbb2b13d2019-05-19 21:41:28 +0200229 if (uclass_get_device(UCLASS_RTC, 0, &dev) ||
230 dm_rtc_get(dev, &tm)) {
231 ret = EFI_UNSUPPORTED;
232 goto out;
233 }
234 if (dm_rtc_get(dev, &tm)) {
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200235 ret = EFI_DEVICE_ERROR;
236 goto out;
237 }
Alexander Graf50149ea2016-03-04 01:10:01 +0100238
239 memset(time, 0, sizeof(*time));
240 time->year = tm.tm_year;
241 time->month = tm.tm_mon;
242 time->day = tm.tm_mday;
243 time->hour = tm.tm_hour;
244 time->minute = tm.tm_min;
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200245 time->second = tm.tm_sec;
Heinrich Schuchardt38b9a792019-05-31 22:08:45 +0200246 if (tm.tm_isdst)
247 time->daylight =
248 EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT;
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200249 time->timezone = EFI_UNSPECIFIED_TIMEZONE;
Alexander Graf50149ea2016-03-04 01:10:01 +0100250
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200251 if (capabilities) {
252 /* Set reasonable dummy values */
253 capabilities->resolution = 1; /* 1 Hz */
254 capabilities->accuracy = 100000000; /* 100 ppm */
255 capabilities->sets_to_zero = false;
256 }
257out:
258 return EFI_EXIT(ret);
Alexander Graf50149ea2016-03-04 01:10:01 +0100259#else
Heinrich Schuchardt49de2452018-07-07 23:39:14 +0200260 EFI_ENTRY("%p %p", time, capabilities);
Heinrich Schuchardtbb2b13d2019-05-19 21:41:28 +0200261 return EFI_EXIT(EFI_UNSUPPORTED);
Alexander Graf50149ea2016-03-04 01:10:01 +0100262#endif
263}
264
Heinrich Schuchardt5ec48e32019-05-31 22:56:02 +0200265#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardte6bcc352019-05-31 07:35:19 +0200266
267/**
268 * efi_validate_time() - checks if timestamp is valid
269 *
270 * @time: timestamp to validate
271 * Returns: 0 if timestamp is valid, 1 otherwise
272 */
273static int efi_validate_time(struct efi_time *time)
274{
275 return (!time ||
276 time->year < 1900 || time->year > 9999 ||
277 !time->month || time->month > 12 || !time->day ||
278 time->day > rtc_month_days(time->month - 1, time->year) ||
279 time->hour > 23 || time->minute > 59 || time->second > 59 ||
280 time->nanosecond > 999999999 ||
281 time->daylight &
282 ~(EFI_TIME_IN_DAYLIGHT | EFI_TIME_ADJUST_DAYLIGHT) ||
283 ((time->timezone < -1440 || time->timezone > 1440) &&
284 time->timezone != EFI_UNSPECIFIED_TIMEZONE));
285}
286
287#endif
288
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200289/**
290 * efi_set_time_boottime() - set current time
291 *
292 * This function implements the SetTime() runtime service before
293 * SetVirtualAddressMap() is called.
294 *
295 * See the Unified Extensible Firmware Interface (UEFI) specification
296 * for details.
297 *
298 * @time: pointer to structure to with current time
299 * Returns: status code
300 */
301static efi_status_t EFIAPI efi_set_time_boottime(struct efi_time *time)
302{
Heinrich Schuchardt5ec48e32019-05-31 22:56:02 +0200303#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200304 efi_status_t ret = EFI_SUCCESS;
305 struct rtc_time tm;
306 struct udevice *dev;
Alexander Graf80a48002016-08-16 21:08:45 +0200307
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200308 EFI_ENTRY("%p", time);
309
Heinrich Schuchardte6bcc352019-05-31 07:35:19 +0200310 if (efi_validate_time(time)) {
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200311 ret = EFI_INVALID_PARAMETER;
312 goto out;
313 }
314
315 if (uclass_get_device(UCLASS_RTC, 0, &dev)) {
316 ret = EFI_UNSUPPORTED;
317 goto out;
318 }
319
320 memset(&tm, 0, sizeof(tm));
321 tm.tm_year = time->year;
322 tm.tm_mon = time->month;
323 tm.tm_mday = time->day;
324 tm.tm_hour = time->hour;
325 tm.tm_min = time->minute;
326 tm.tm_sec = time->second;
Heinrich Schuchardt38b9a792019-05-31 22:08:45 +0200327 tm.tm_isdst = time->daylight ==
328 (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT);
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200329 /* Calculate day of week */
330 rtc_calc_weekday(&tm);
331
332 if (dm_rtc_set(dev, &tm))
333 ret = EFI_DEVICE_ERROR;
334out:
335 return EFI_EXIT(ret);
336#else
337 EFI_ENTRY("%p", time);
338 return EFI_EXIT(EFI_UNSUPPORTED);
339#endif
340}
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200341/**
342 * efi_reset_system() - reset system
343 *
344 * This function implements the ResetSystem() runtime service after
345 * SetVirtualAddressMap() is called. It only executes an endless loop.
346 * Boards may override the helpers below to implement reset functionality.
347 *
348 * See the Unified Extensible Firmware Interface (UEFI) specification for
349 * details.
350 *
351 * @reset_type: type of reset to perform
352 * @reset_status: status code for the reset
353 * @data_size: size of reset_data
354 * @reset_data: information about the reset
355 */
Alexander Graf3c63db92016-10-14 13:45:30 +0200356void __weak __efi_runtime EFIAPI efi_reset_system(
Alexander Graf80a48002016-08-16 21:08:45 +0200357 enum efi_reset_type reset_type,
358 efi_status_t reset_status,
359 unsigned long data_size, void *reset_data)
360{
361 /* Nothing we can do */
362 while (1) { }
363}
364
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200365/**
366 * efi_reset_system_init() - initialize the reset driver
367 *
368 * Boards may override this function to initialize the reset driver.
369 */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100370efi_status_t __weak efi_reset_system_init(void)
Alexander Graf80a48002016-08-16 21:08:45 +0200371{
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100372 return EFI_SUCCESS;
Alexander Graf80a48002016-08-16 21:08:45 +0200373}
374
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200375/**
376 * efi_get_time() - get current time
377 *
378 * This function implements the GetTime runtime service after
379 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
380 * anymore only an error code is returned.
381 *
382 * See the Unified Extensible Firmware Interface (UEFI) specification
383 * for details.
384 *
385 * @time: pointer to structure to receive current time
386 * @capabilities: pointer to structure to receive RTC properties
387 * Returns: status code
388 */
Alexander Graf3c63db92016-10-14 13:45:30 +0200389efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
Alexander Graf80a48002016-08-16 21:08:45 +0200390 struct efi_time *time,
391 struct efi_time_cap *capabilities)
392{
Heinrich Schuchardtc5b63be2019-06-13 18:42:40 +0200393 return EFI_UNSUPPORTED;
Alexander Graf80a48002016-08-16 21:08:45 +0200394}
395
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200396/**
397 * efi_set_time() - set current time
398 *
399 * This function implements the SetTime runtime service after
400 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
401 * anymore only an error code is returned.
402 *
403 * See the Unified Extensible Firmware Interface (UEFI) specification
404 * for details.
405 *
406 * @time: pointer to structure to with current time
407 * Returns: status code
408 */
409efi_status_t __weak __efi_runtime EFIAPI efi_set_time(struct efi_time *time)
410{
411 return EFI_UNSUPPORTED;
412}
413
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000414/**
415 * efi_is_runtime_service_pointer() - check if pointer points to runtime table
416 *
417 * @p: pointer to check
418 * Return: true if the pointer points to a service function pointer in the
419 * runtime table
420 */
421static bool efi_is_runtime_service_pointer(void *p)
Alexander Graf50149ea2016-03-04 01:10:01 +0100422{
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200423 return (p >= (void *)&efi_runtime_services.get_time &&
424 p <= (void *)&efi_runtime_services.query_variable_info) ||
425 p == (void *)&efi_events.prev ||
426 p == (void *)&efi_events.next;
Alexander Graf50149ea2016-03-04 01:10:01 +0100427}
428
Heinrich Schuchardtb23ffcb2019-07-05 18:12:21 +0200429/**
430 * efi_runtime_detach() - detach unimplemented runtime functions
431 */
Heinrich Schuchardt7f951042019-07-05 17:42:16 +0200432void efi_runtime_detach(void)
Alexander Graf50149ea2016-03-04 01:10:01 +0100433{
Heinrich Schuchardtb23ffcb2019-07-05 18:12:21 +0200434 efi_runtime_services.reset_system = efi_reset_system;
435 efi_runtime_services.get_time = efi_get_time;
436 efi_runtime_services.set_time = efi_set_time;
Alexander Graf50149ea2016-03-04 01:10:01 +0100437
Heinrich Schuchardtb23ffcb2019-07-05 18:12:21 +0200438 /* Update CRC32 */
439 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000440}
441
Heinrich Schuchardtee8ebaa2019-06-29 03:32:52 +0200442/**
443 * efi_set_virtual_address_map_runtime() - change from physical to virtual
444 * mapping
445 *
446 * This function implements the SetVirtualAddressMap() runtime service after
447 * it is first called.
448 *
449 * See the Unified Extensible Firmware Interface (UEFI) specification for
450 * details.
451 *
452 * @memory_map_size: size of the virtual map
453 * @descriptor_size: size of an entry in the map
454 * @descriptor_version: version of the map entries
455 * @virtmap: virtual address mapping information
456 * Return: status code EFI_UNSUPPORTED
457 */
Heinrich Schuchardt96185602019-07-12 22:41:43 +0200458static __efi_runtime efi_status_t EFIAPI efi_set_virtual_address_map_runtime(
Heinrich Schuchardt24e67222019-07-27 20:28:47 +0200459 efi_uintn_t memory_map_size,
460 efi_uintn_t descriptor_size,
Heinrich Schuchardtee8ebaa2019-06-29 03:32:52 +0200461 uint32_t descriptor_version,
462 struct efi_mem_desc *virtmap)
463{
464 return EFI_UNSUPPORTED;
465}
466
467/**
468 * efi_convert_pointer_runtime() - convert from physical to virtual pointer
469 *
470 * This function implements the ConvertPointer() runtime service after
471 * the first call to SetVirtualAddressMap().
472 *
473 * See the Unified Extensible Firmware Interface (UEFI) specification for
474 * details.
475 *
476 * @debug_disposition: indicates if pointer may be converted to NULL
477 * @address: pointer to be converted
478 * Return: status code EFI_UNSUPPORTED
479 */
480static __efi_runtime efi_status_t EFIAPI efi_convert_pointer_runtime(
481 efi_uintn_t debug_disposition, void **address)
482{
483 return EFI_UNSUPPORTED;
484}
485
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200486/**
Heinrich Schuchardt7aeceff2020-03-22 08:28:15 +0100487 * efi_convert_pointer() - convert from physical to virtual pointer
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200488 *
489 * This function implements the ConvertPointer() runtime service until
490 * the first call to SetVirtualAddressMap().
491 *
492 * See the Unified Extensible Firmware Interface (UEFI) specification for
493 * details.
494 *
495 * @debug_disposition: indicates if pointer may be converted to NULL
496 * @address: pointer to be converted
Heinrich Schuchardt7aeceff2020-03-22 08:28:15 +0100497 * Return: status code
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200498 */
499static __efi_runtime efi_status_t EFIAPI efi_convert_pointer(
500 efi_uintn_t debug_disposition, void **address)
501{
502 efi_physical_addr_t addr = (uintptr_t)*address;
503 efi_uintn_t i;
504 efi_status_t ret = EFI_NOT_FOUND;
505
506 EFI_ENTRY("%zu %p", debug_disposition, address);
507
508 if (!efi_virtmap) {
509 ret = EFI_UNSUPPORTED;
510 goto out;
511 }
512
513 if (!address) {
514 ret = EFI_INVALID_PARAMETER;
515 goto out;
516 }
517
518 for (i = 0; i < efi_descriptor_count; i++) {
519 struct efi_mem_desc *map = (void *)efi_virtmap +
520 (efi_descriptor_size * i);
521
522 if (addr >= map->physical_start &&
523 (addr < map->physical_start
524 + (map->num_pages << EFI_PAGE_SHIFT))) {
525 *address = (void *)(uintptr_t)
526 (addr + map->virtual_start -
527 map->physical_start);
528
529 ret = EFI_SUCCESS;
530 break;
531 }
532 }
533
534out:
535 return EFI_EXIT(ret);
536}
537
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000538static __efi_runtime void efi_relocate_runtime_table(ulong offset)
539{
540 ulong patchoff;
541 void **pos;
542
543 /* Relocate the runtime services pointers */
544 patchoff = offset - gd->relocaddr;
545 for (pos = (void **)&efi_runtime_services.get_time;
546 pos <= (void **)&efi_runtime_services.query_variable_info; ++pos) {
Heinrich Schuchardtee8ebaa2019-06-29 03:32:52 +0200547 if (*pos)
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000548 *pos += patchoff;
Alexander Graf50149ea2016-03-04 01:10:01 +0100549 }
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200550
Heinrich Schuchardtee8ebaa2019-06-29 03:32:52 +0200551 /*
552 * The entry for SetVirtualAddress() must point to a physical address.
553 * After the first execution the service must return EFI_UNSUPPORTED.
554 */
555 efi_runtime_services.set_virtual_address_map =
556 &efi_set_virtual_address_map_runtime;
557
558 /*
559 * The entry for ConvertPointer() must point to a physical address.
560 * The service is not usable after SetVirtualAddress().
561 */
562 efi_runtime_services.convert_pointer = &efi_convert_pointer_runtime;
563
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200564 /*
565 * TODO: Update UEFI variable RuntimeServicesSupported removing flags
566 * EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP and
567 * EFI_RT_SUPPORTED_CONVERT_POINTER as required by the UEFI spec 2.8.
568 */
569
Heinrich Schuchardt250b3252018-09-03 19:29:41 +0200570 /* Update CRC32 */
Heinrich Schuchardta39f39c2018-07-29 09:49:04 +0200571 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Alexander Graf50149ea2016-03-04 01:10:01 +0100572}
573
574/* Relocate EFI runtime to uboot_reloc_base = offset */
575void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
576{
577#ifdef IS_RELA
578 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
579#else
580 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
581 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
582#endif
583
Alexander Grafedcef3b2016-06-02 11:38:27 +0200584 debug("%s: Relocating to offset=%lx\n", __func__, offset);
Alexander Graf50149ea2016-03-04 01:10:01 +0100585 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
586 ulong base = CONFIG_SYS_TEXT_BASE;
587 ulong *p;
588 ulong newaddr;
589
590 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
591
Heinrich Schuchardt9f8932d2019-08-14 06:49:09 +0200592 /*
593 * The runtime services table is updated in
594 * efi_relocate_runtime_table()
595 */
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000596 if (map && efi_is_runtime_service_pointer(p))
597 continue;
598
Heinrich Schuchardt3ce78292018-10-13 20:52:08 -0700599 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
600 rel->info, *p, rel->offset);
Alexander Graf50149ea2016-03-04 01:10:01 +0100601
Rick Chen6836adb2018-05-28 19:06:37 +0800602 switch (rel->info & R_MASK) {
603 case R_RELATIVE:
Alexander Graf50149ea2016-03-04 01:10:01 +0100604#ifdef IS_RELA
605 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
606#else
607 newaddr = *p - lastoff + offset;
608#endif
Rick Chen6836adb2018-05-28 19:06:37 +0800609 break;
610#ifdef R_ABSOLUTE
611 case R_ABSOLUTE: {
612 ulong symidx = rel->info >> SYM_INDEX;
613 extern struct dyn_sym __dyn_sym_start[];
614 newaddr = __dyn_sym_start[symidx].addr + offset;
Alexander Grafafdc4fc2018-11-04 22:25:22 +0100615#ifdef IS_RELA
616 newaddr -= CONFIG_SYS_TEXT_BASE;
617#endif
Rick Chen6836adb2018-05-28 19:06:37 +0800618 break;
619 }
620#endif
621 default:
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000622 printf("%s: Unknown relocation type %llx\n",
623 __func__, rel->info & R_MASK);
Rick Chen6836adb2018-05-28 19:06:37 +0800624 continue;
625 }
Alexander Graf50149ea2016-03-04 01:10:01 +0100626
627 /* Check if the relocation is inside bounds */
628 if (map && ((newaddr < map->virtual_start) ||
Heinrich Schuchardt591cf2e2017-09-18 22:11:34 +0200629 newaddr > (map->virtual_start +
630 (map->num_pages << EFI_PAGE_SHIFT)))) {
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000631 printf("%s: Relocation at %p is out of range (%lx)\n",
632 __func__, p, newaddr);
Alexander Graf50149ea2016-03-04 01:10:01 +0100633 continue;
634 }
635
Alexander Grafedcef3b2016-06-02 11:38:27 +0200636 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
Alexander Graf50149ea2016-03-04 01:10:01 +0100637 *p = newaddr;
Alexander Graf36c37a82016-04-11 23:20:39 +0200638 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
639 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
Alexander Graf50149ea2016-03-04 01:10:01 +0100640 }
641
642#ifndef IS_RELA
643 lastoff = offset;
644#endif
645
646 invalidate_icache_all();
647}
648
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200649/**
650 * efi_set_virtual_address_map() - change from physical to virtual mapping
651 *
652 * This function implements the SetVirtualAddressMap() runtime service.
653 *
654 * See the Unified Extensible Firmware Interface (UEFI) specification for
655 * details.
656 *
657 * @memory_map_size: size of the virtual map
658 * @descriptor_size: size of an entry in the map
659 * @descriptor_version: version of the map entries
660 * @virtmap: virtual address mapping information
661 * Return: status code
662 */
Alexander Graf50149ea2016-03-04 01:10:01 +0100663static efi_status_t EFIAPI efi_set_virtual_address_map(
Heinrich Schuchardt24e67222019-07-27 20:28:47 +0200664 efi_uintn_t memory_map_size,
665 efi_uintn_t descriptor_size,
Alexander Graf50149ea2016-03-04 01:10:01 +0100666 uint32_t descriptor_version,
667 struct efi_mem_desc *virtmap)
668{
Heinrich Schuchardt24e67222019-07-27 20:28:47 +0200669 efi_uintn_t n = memory_map_size / descriptor_size;
670 efi_uintn_t i;
Heinrich Schuchardt53e1d8f2019-08-14 05:19:37 +0200671 efi_status_t ret = EFI_INVALID_PARAMETER;
Alexander Graf5c38e052018-12-11 10:00:42 +0100672 int rt_code_sections = 0;
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200673 struct efi_event *event;
Alexander Graf50149ea2016-03-04 01:10:01 +0100674
Heinrich Schuchardt24e67222019-07-27 20:28:47 +0200675 EFI_ENTRY("%zx %zx %x %p", memory_map_size, descriptor_size,
Alexander Graf50149ea2016-03-04 01:10:01 +0100676 descriptor_version, virtmap);
677
Heinrich Schuchardt53e1d8f2019-08-14 05:19:37 +0200678 if (descriptor_version != EFI_MEMORY_DESCRIPTOR_VERSION ||
679 descriptor_size < sizeof(struct efi_mem_desc))
680 goto out;
681
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200682 efi_virtmap = virtmap;
683 efi_descriptor_size = descriptor_size;
684 efi_descriptor_count = n;
685
Alexander Graf5c38e052018-12-11 10:00:42 +0100686 /*
687 * TODO:
688 * Further down we are cheating. While really we should implement
689 * SetVirtualAddressMap() events and ConvertPointer() to allow
690 * dynamically loaded drivers to expose runtime services, we don't
691 * today.
692 *
693 * So let's ensure we see exactly one single runtime section, as
694 * that is the built-in one. If we see more (or less), someone must
695 * have tried adding or removing to that which we don't support yet.
696 * In that case, let's better fail rather than expose broken runtime
697 * services.
698 */
699 for (i = 0; i < n; i++) {
700 struct efi_mem_desc *map = (void*)virtmap +
701 (descriptor_size * i);
702
703 if (map->type == EFI_RUNTIME_SERVICES_CODE)
704 rt_code_sections++;
705 }
706
707 if (rt_code_sections != 1) {
708 /*
709 * We expose exactly one single runtime code section, so
710 * something is definitely going wrong.
711 */
Heinrich Schuchardt53e1d8f2019-08-14 05:19:37 +0200712 goto out;
Alexander Graf5c38e052018-12-11 10:00:42 +0100713 }
714
Heinrich Schuchardt14b40482019-07-11 20:15:09 +0200715 /* Notify EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
716 list_for_each_entry(event, &efi_events, link) {
717 if (event->notify_function)
718 EFI_CALL_VOID(event->notify_function(
719 event, event->notify_context));
720 }
721
Alexander Graf80a48002016-08-16 21:08:45 +0200722 /* Rebind mmio pointers */
723 for (i = 0; i < n; i++) {
724 struct efi_mem_desc *map = (void*)virtmap +
725 (descriptor_size * i);
726 struct list_head *lhandle;
727 efi_physical_addr_t map_start = map->physical_start;
728 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
729 efi_physical_addr_t map_end = map_start + map_len;
Heinrich Schuchardt07240da2018-08-04 23:16:06 +0200730 u64 off = map->virtual_start - map_start;
Alexander Graf80a48002016-08-16 21:08:45 +0200731
732 /* Adjust all mmio pointers in this region */
733 list_for_each(lhandle, &efi_runtime_mmio) {
734 struct efi_runtime_mmio_list *lmmio;
735
736 lmmio = list_entry(lhandle,
737 struct efi_runtime_mmio_list,
738 link);
739 if ((map_start <= lmmio->paddr) &&
740 (map_end >= lmmio->paddr)) {
Alexander Graf80a48002016-08-16 21:08:45 +0200741 uintptr_t new_addr = lmmio->paddr + off;
742 *lmmio->ptr = (void *)new_addr;
743 }
744 }
Heinrich Schuchardt07240da2018-08-04 23:16:06 +0200745 if ((map_start <= (uintptr_t)systab.tables) &&
746 (map_end >= (uintptr_t)systab.tables)) {
747 char *ptr = (char *)systab.tables;
748
749 ptr += off;
750 systab.tables = (struct efi_configuration_table *)ptr;
751 }
Alexander Graf80a48002016-08-16 21:08:45 +0200752 }
753
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000754 /* Relocate the runtime. See TODO above */
Alexander Graf50149ea2016-03-04 01:10:01 +0100755 for (i = 0; i < n; i++) {
756 struct efi_mem_desc *map;
757
758 map = (void*)virtmap + (descriptor_size * i);
759 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
Alexander Graf80a48002016-08-16 21:08:45 +0200760 ulong new_offset = map->virtual_start -
Alexander Graf5c38e052018-12-11 10:00:42 +0100761 map->physical_start + gd->relocaddr;
Alexander Graf50149ea2016-03-04 01:10:01 +0100762
Heinrich Schuchardt24a238f2019-06-20 22:00:02 +0000763 efi_relocate_runtime_table(new_offset);
Alexander Graf50149ea2016-03-04 01:10:01 +0100764 efi_runtime_relocate(new_offset, map);
Heinrich Schuchardt53e1d8f2019-08-14 05:19:37 +0200765 ret = EFI_SUCCESS;
766 goto out;
Alexander Graf50149ea2016-03-04 01:10:01 +0100767 }
768 }
769
Heinrich Schuchardt53e1d8f2019-08-14 05:19:37 +0200770out:
771 return EFI_EXIT(ret);
Alexander Graf50149ea2016-03-04 01:10:01 +0100772}
773
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200774/**
775 * efi_add_runtime_mmio() - add memory-mapped IO region
776 *
777 * This function adds a memory-mapped IO region to the memory map to make it
778 * available at runtime.
779 *
Heinrich Schuchardtfb34f292018-12-23 02:35:13 +0100780 * @mmio_ptr: pointer to a pointer to the start of the memory-mapped
781 * IO region
Heinrich Schuchardt250b3252018-09-03 19:29:41 +0200782 * @len: size of the memory-mapped IO region
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200783 * Returns: status code
784 */
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100785efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
Alexander Graf80a48002016-08-16 21:08:45 +0200786{
787 struct efi_runtime_mmio_list *newmmio;
Alexander Graf813468c2018-03-15 15:08:16 +0100788 uint64_t addr = *(uintptr_t *)mmio_ptr;
Bryan O'Donoghueb225c922019-07-15 12:00:39 +0100789 efi_status_t ret;
Alexander Graf813468c2018-03-15 15:08:16 +0100790
Michael Walle714497e2020-05-17 12:29:19 +0200791 ret = efi_add_memory_map(addr, len, EFI_MMAP_IO);
Bryan O'Donoghueb225c922019-07-15 12:00:39 +0100792 if (ret != EFI_SUCCESS)
Alexander Graf813468c2018-03-15 15:08:16 +0100793 return EFI_OUT_OF_RESOURCES;
Alexander Graf80a48002016-08-16 21:08:45 +0200794
795 newmmio = calloc(1, sizeof(*newmmio));
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100796 if (!newmmio)
797 return EFI_OUT_OF_RESOURCES;
Alexander Graf80a48002016-08-16 21:08:45 +0200798 newmmio->ptr = mmio_ptr;
799 newmmio->paddr = *(uintptr_t *)mmio_ptr;
800 newmmio->len = len;
801 list_add_tail(&newmmio->link, &efi_runtime_mmio);
Heinrich Schuchardt22c793e2018-03-03 15:28:59 +0100802
Alexander Graf813468c2018-03-15 15:08:16 +0100803 return EFI_SUCCESS;
Alexander Graf80a48002016-08-16 21:08:45 +0200804}
805
Alexander Graf50149ea2016-03-04 01:10:01 +0100806/*
807 * In the second stage, U-Boot has disappeared. To isolate our runtime code
808 * that at this point still exists from the rest, we put it into a special
809 * section.
810 *
811 * !!WARNING!!
812 *
813 * This means that we can not rely on any code outside of this file in any
814 * function or variable below this line.
815 *
816 * Please keep everything fully self-contained and annotated with
Alexander Graf3c63db92016-10-14 13:45:30 +0200817 * __efi_runtime and __efi_runtime_data markers.
Alexander Graf50149ea2016-03-04 01:10:01 +0100818 */
819
820/*
821 * Relocate the EFI runtime stub to a different place. We need to call this
822 * the first time we expose the runtime interface to a user and on set virtual
823 * address map calls.
824 */
825
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200826/**
827 * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
828 *
829 * This function is used after SetVirtualAddressMap() is called as replacement
830 * for services that are not available anymore due to constraints of the U-Boot
831 * implementation.
832 *
833 * Return: EFI_UNSUPPORTED
834 */
Alexander Graf3c63db92016-10-14 13:45:30 +0200835static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
Alexander Graf50149ea2016-03-04 01:10:01 +0100836{
837 return EFI_UNSUPPORTED;
838}
839
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200840/**
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200841 * efi_update_capsule() - process information from operating system
842 *
843 * This function implements the UpdateCapsule() runtime service.
844 *
845 * See the Unified Extensible Firmware Interface (UEFI) specification for
846 * details.
847 *
848 * @capsule_header_array: pointer to array of virtual pointers
849 * @capsule_count: number of pointers in capsule_header_array
850 * @scatter_gather_list: pointer to arry of physical pointers
851 * Returns: status code
852 */
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100853efi_status_t __efi_runtime EFIAPI efi_update_capsule(
854 struct efi_capsule_header **capsule_header_array,
855 efi_uintn_t capsule_count,
856 u64 scatter_gather_list)
857{
858 return EFI_UNSUPPORTED;
859}
860
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200861/**
862 * efi_query_capsule_caps() - check if capsule is supported
863 *
864 * This function implements the QueryCapsuleCapabilities() runtime service.
865 *
866 * See the Unified Extensible Firmware Interface (UEFI) specification for
867 * details.
868 *
869 * @capsule_header_array: pointer to array of virtual pointers
870 * @capsule_count: number of pointers in capsule_header_array
Heinrich Schuchardtcc0bfc02018-09-03 20:59:25 +0200871 * @maximum_capsule_size: maximum capsule size
Heinrich Schuchardtbcfb0e22018-07-29 15:10:11 +0200872 * @reset_type: type of reset needed for capsule update
873 * Returns: status code
874 */
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100875efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
876 struct efi_capsule_header **capsule_header_array,
877 efi_uintn_t capsule_count,
AKASHI Takahiro19dd9072018-11-14 16:18:53 +0900878 u64 *maximum_capsule_size,
879 u32 *reset_type)
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100880{
881 return EFI_UNSUPPORTED;
882}
883
Alexander Graf3c63db92016-10-14 13:45:30 +0200884struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
Alexander Graf50149ea2016-03-04 01:10:01 +0100885 .hdr = {
886 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
Heinrich Schuchardt112f2432018-06-28 12:45:27 +0200887 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt71c846a2018-06-28 12:45:29 +0200888 .headersize = sizeof(struct efi_runtime_services),
Alexander Graf50149ea2016-03-04 01:10:01 +0100889 },
Alexander Graf80a48002016-08-16 21:08:45 +0200890 .get_time = &efi_get_time_boottime,
Heinrich Schuchardt433bfe72019-05-19 20:07:39 +0200891 .set_time = &efi_set_time_boottime,
Alexander Graf50149ea2016-03-04 01:10:01 +0100892 .get_wakeup_time = (void *)&efi_unimplemented,
893 .set_wakeup_time = (void *)&efi_unimplemented,
894 .set_virtual_address_map = &efi_set_virtual_address_map,
Heinrich Schuchardt7be56e82019-07-27 20:35:24 +0200895 .convert_pointer = efi_convert_pointer,
Rob Clarkad644e72017-09-13 18:05:37 -0400896 .get_variable = efi_get_variable,
Heinrich Schuchardt45c66f92018-05-17 07:57:05 +0200897 .get_next_variable_name = efi_get_next_variable_name,
Rob Clarkad644e72017-09-13 18:05:37 -0400898 .set_variable = efi_set_variable,
Heinrich Schuchardtb94461c2019-06-20 15:40:49 +0200899 .get_next_high_mono_count = (void *)&efi_unimplemented,
Alexander Graf80a48002016-08-16 21:08:45 +0200900 .reset_system = &efi_reset_system_boottime,
Heinrich Schuchardt0c230742018-02-09 20:41:21 +0100901 .update_capsule = efi_update_capsule,
902 .query_capsule_caps = efi_query_capsule_caps,
903 .query_variable_info = efi_query_variable_info,
Alexander Graf50149ea2016-03-04 01:10:01 +0100904};