blob: a4aa1d8b6c003184f24b174c6efa64e6564f9b7f [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001// SPDX-License-Identifier: GPL-2.0+
Alexander Graf0bd425a2016-03-04 01:10:01 +01002/*
3 * EFI application runtime services
4 *
5 * Copyright (c) 2016 Alexander Graf
Alexander Graf0bd425a2016-03-04 01:10:01 +01006 */
7
8#include <common.h>
9#include <command.h>
Simon Glass63334482019-11-14 12:57:39 -070010#include <cpu_func.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010011#include <dm.h>
Alexander Graf46c15142018-06-18 17:23:11 +020012#include <elf.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010013#include <efi_loader.h>
Simon Glass0f2af882020-05-10 11:40:05 -060014#include <log.h>
Simon Glass9bc15642020-02-03 07:36:16 -070015#include <malloc.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010016#include <rtc.h>
Simon Glass48b6c6b2019-11-14 12:57:16 -070017#include <u-boot/crc.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010018
19/* For manual relocation support */
20DECLARE_GLOBAL_DATA_PTR;
21
Heinrich Schuchardt956eff32020-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 Graf77256092016-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 Graf393dd912016-10-14 13:45:30 +020036static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +010037
Simon Glassfff89d42018-06-11 23:26:40 -060038/*
Heinrich Schuchardt11121542018-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 Glassfff89d42018-06-11 23:26:40 -060042 */
Alexander Graf0fe51922018-06-18 17:23:08 +020043#if defined(__aarch64__)
Alexander Graf46c15142018-06-18 17:23:11 +020044#define R_RELATIVE R_AARCH64_RELATIVE
Alexander Graf0bd425a2016-03-04 01:10:01 +010045#define R_MASK 0xffffffffULL
46#define IS_RELA 1
Alexander Graf0fe51922018-06-18 17:23:08 +020047#elif defined(__arm__)
Alexander Graf46c15142018-06-18 17:23:11 +020048#define R_RELATIVE R_ARM_RELATIVE
Alexander Graf0bd425a2016-03-04 01:10:01 +010049#define R_MASK 0xffULL
Heinrich Schuchardt56e82be2018-10-13 20:52:08 -070050#elif defined(__i386__)
Simon Glasscdfe6962016-09-25 15:27:35 -060051#define R_RELATIVE R_386_RELATIVE
52#define R_MASK 0xffULL
Heinrich Schuchardt56e82be2018-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 Graf0fe51922018-06-18 17:23:08 +020057#elif defined(__riscv)
Rick Chen9677a372018-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 Graf0fe51922018-06-18 17:23:08 +020068#if (__riscv_xlen == 32)
Rick Chen9677a372018-05-28 19:06:37 +080069#define R_ABSOLUTE R_RISCV_32
70#define SYM_INDEX 8
Alexander Graf0fe51922018-06-18 17:23:08 +020071#elif (__riscv_xlen == 64)
Rick Chen9677a372018-05-28 19:06:37 +080072#define R_ABSOLUTE R_RISCV_64
73#define SYM_INDEX 32
Alexander Graf0fe51922018-06-18 17:23:08 +020074#else
75#error unknown riscv target
Rick Chen9677a372018-05-28 19:06:37 +080076#endif
Alexander Graf0bd425a2016-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 Schuchardtc680dc42019-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 Graf0bd425a2016-03-04 01:10:01 +010096/*
Heinrich Schuchardt11121542018-09-03 19:29:41 +020097 * EFI runtime code lives in two stages. In the first stage, U-Boot and an EFI
Alexander Graf0bd425a2016-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 Schuchardt956eff32020-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 Takahiro32401842019-06-05 13:21:38 +0900110efi_status_t efi_init_runtime_supported(void)
111{
Heinrich Schuchardt956eff32020-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 Schuchardtc680dc42019-07-27 20:35:24 +0200124 EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP |
125 EFI_RT_SUPPORTED_CONVERT_POINTER;
AKASHI Takahiro32401842019-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 Schuchardt05874fb2019-07-05 18:12:16 +0200131#ifdef CONFIG_EFI_HAVE_RUNTIME_RESET
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100132 rt_table->runtime_services_supported |= EFI_RT_SUPPORTED_RESET_SYSTEM;
AKASHI Takahiro32401842019-06-05 13:21:38 +0900133#endif
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200134
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100135 ret = efi_install_configuration_table(&efi_rt_properties_table_guid,
136 rt_table);
137 return ret;
AKASHI Takahiro32401842019-06-05 13:21:38 +0900138}
139
Heinrich Schuchardt69c15762018-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 Schuchardt711853b2018-07-29 15:10:11 +0200152/**
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200153 * efi_reset_system_boottime() - reset system at boot time
Heinrich Schuchardt711853b2018-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 Graf77256092016-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 Graf0bd425a2016-03-04 01:10:01 +0100170{
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100171 struct efi_event *evt;
172
Alexander Graf0bd425a2016-03-04 01:10:01 +0100173 EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
174 reset_data);
175
Heinrich Schuchardtbf7f1692018-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 Schuchardt7b4b8d862019-06-07 06:47:01 +0200181 efi_signal_event(evt);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100182 break;
183 }
184 }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100185 switch (reset_type) {
186 case EFI_RESET_COLD:
187 case EFI_RESET_WARM:
Heinrich Schuchardt450d4c82018-02-06 22:00:22 +0100188 case EFI_RESET_PLATFORM_SPECIFIC:
Alexander Graf0bd425a2016-03-04 01:10:01 +0100189 do_reset(NULL, 0, 0, NULL);
190 break;
191 case EFI_RESET_SHUTDOWN:
Heinrich Schuchardt44489452018-10-16 07:44:53 +0200192#ifdef CONFIG_CMD_POWEROFF
193 do_poweroff(NULL, 0, 0, NULL);
194#endif
Alexander Graf0bd425a2016-03-04 01:10:01 +0100195 break;
196 }
197
Alexander Graf77256092016-08-16 21:08:45 +0200198 while (1) { }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100199}
200
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200201/**
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200202 * efi_get_time_boottime() - get current time at boot time
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200203 *
204 * This function implements the GetTime runtime service before
205 * SetVirtualAddressMap() is called.
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200206 *
Heinrich Schuchardt37035b12018-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 Schuchardt711853b2018-07-29 15:10:11 +0200212 * Returns: status code
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200213 */
Alexander Graf77256092016-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 Graf0bd425a2016-03-04 01:10:01 +0100217{
Heinrich Schuchardtf2856ad2019-05-31 22:56:02 +0200218#ifdef CONFIG_EFI_GET_TIME
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200219 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200220 struct rtc_time tm;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100221 struct udevice *dev;
222
223 EFI_ENTRY("%p %p", time, capabilities);
224
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200225 if (!time) {
226 ret = EFI_INVALID_PARAMETER;
227 goto out;
228 }
Heinrich Schuchardtb4bd3662019-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 Schuchardt37035b12018-07-07 23:39:14 +0200235 ret = EFI_DEVICE_ERROR;
236 goto out;
237 }
Alexander Graf0bd425a2016-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 Schuchardt37035b12018-07-07 23:39:14 +0200245 time->second = tm.tm_sec;
Heinrich Schuchardtba3e8282019-05-31 22:08:45 +0200246 if (tm.tm_isdst)
247 time->daylight =
248 EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT;
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200249 time->timezone = EFI_UNSPECIFIED_TIMEZONE;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100250
Heinrich Schuchardt37035b12018-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 Graf0bd425a2016-03-04 01:10:01 +0100259#else
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200260 EFI_ENTRY("%p %p", time, capabilities);
Heinrich Schuchardtb4bd3662019-05-19 21:41:28 +0200261 return EFI_EXIT(EFI_UNSUPPORTED);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100262#endif
263}
264
Heinrich Schuchardtf2856ad2019-05-31 22:56:02 +0200265#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardt33e5a0e2019-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 Schuchardt411b2d52019-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 Schuchardtf2856ad2019-05-31 22:56:02 +0200303#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200304 efi_status_t ret = EFI_SUCCESS;
305 struct rtc_time tm;
306 struct udevice *dev;
Alexander Graf77256092016-08-16 21:08:45 +0200307
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200308 EFI_ENTRY("%p", time);
309
Heinrich Schuchardt33e5a0e2019-05-31 07:35:19 +0200310 if (efi_validate_time(time)) {
Heinrich Schuchardt411b2d52019-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 Schuchardtba3e8282019-05-31 22:08:45 +0200327 tm.tm_isdst = time->daylight ==
328 (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT);
Heinrich Schuchardt411b2d52019-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 Schuchardt711853b2018-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 Graf393dd912016-10-14 13:45:30 +0200356void __weak __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-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 Schuchardt711853b2018-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 Schuchardt099b3b72018-03-03 15:28:59 +0100370efi_status_t __weak efi_reset_system_init(void)
Alexander Graf77256092016-08-16 21:08:45 +0200371{
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100372 return EFI_SUCCESS;
Alexander Graf77256092016-08-16 21:08:45 +0200373}
374
Heinrich Schuchardt711853b2018-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 Graf393dd912016-10-14 13:45:30 +0200389efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200390 struct efi_time *time,
391 struct efi_time_cap *capabilities)
392{
Heinrich Schuchardtb4ba5be2019-06-13 18:42:40 +0200393 return EFI_UNSUPPORTED;
Alexander Graf77256092016-08-16 21:08:45 +0200394}
395
Heinrich Schuchardt411b2d52019-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 Schuchardt19cd80b2019-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 Graf0bd425a2016-03-04 01:10:01 +0100422{
Heinrich Schuchardt4429d872019-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 Graf0bd425a2016-03-04 01:10:01 +0100427}
428
Heinrich Schuchardtc3f2a9f2019-07-05 18:12:21 +0200429/**
430 * efi_runtime_detach() - detach unimplemented runtime functions
431 */
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200432void efi_runtime_detach(void)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100433{
Heinrich Schuchardtc3f2a9f2019-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 Graf0bd425a2016-03-04 01:10:01 +0100437
Heinrich Schuchardtc3f2a9f2019-07-05 18:12:21 +0200438 /* Update CRC32 */
439 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000440}
441
Heinrich Schuchardt25728512019-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 Schuchardt2b6bd382019-07-12 22:41:43 +0200458static __efi_runtime efi_status_t EFIAPI efi_set_virtual_address_map_runtime(
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200459 efi_uintn_t memory_map_size,
460 efi_uintn_t descriptor_size,
Heinrich Schuchardt25728512019-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 Schuchardtc680dc42019-07-27 20:35:24 +0200486/**
Heinrich Schuchardt582f8572020-03-22 08:28:15 +0100487 * efi_convert_pointer() - convert from physical to virtual pointer
Heinrich Schuchardtc680dc42019-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 Schuchardt582f8572020-03-22 08:28:15 +0100497 * Return: status code
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200498 */
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100499__efi_runtime efi_status_t EFIAPI
500efi_convert_pointer(efi_uintn_t debug_disposition, void **address)
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200501{
Heinrich Schuchardtb0818b72020-07-07 03:10:12 +0200502 efi_physical_addr_t addr;
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200503 efi_uintn_t i;
504 efi_status_t ret = EFI_NOT_FOUND;
505
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200506 if (!efi_virtmap) {
507 ret = EFI_UNSUPPORTED;
508 goto out;
509 }
510
511 if (!address) {
512 ret = EFI_INVALID_PARAMETER;
513 goto out;
514 }
Heinrich Schuchardtdabe54a2020-03-24 17:52:40 +0100515 if (!*address) {
516 if (debug_disposition & EFI_OPTIONAL_PTR)
517 return EFI_SUCCESS;
518 else
519 return EFI_INVALID_PARAMETER;
520 }
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200521
Heinrich Schuchardtb0818b72020-07-07 03:10:12 +0200522 addr = (uintptr_t)*address;
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200523 for (i = 0; i < efi_descriptor_count; i++) {
524 struct efi_mem_desc *map = (void *)efi_virtmap +
525 (efi_descriptor_size * i);
526
527 if (addr >= map->physical_start &&
528 (addr < map->physical_start
529 + (map->num_pages << EFI_PAGE_SHIFT))) {
530 *address = (void *)(uintptr_t)
531 (addr + map->virtual_start -
532 map->physical_start);
533
534 ret = EFI_SUCCESS;
535 break;
536 }
537 }
538
539out:
Heinrich Schuchardt699b7c62020-03-24 18:05:22 +0100540 return ret;
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200541}
542
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000543static __efi_runtime void efi_relocate_runtime_table(ulong offset)
544{
545 ulong patchoff;
546 void **pos;
547
548 /* Relocate the runtime services pointers */
549 patchoff = offset - gd->relocaddr;
550 for (pos = (void **)&efi_runtime_services.get_time;
551 pos <= (void **)&efi_runtime_services.query_variable_info; ++pos) {
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200552 if (*pos)
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000553 *pos += patchoff;
554 }
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200555
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200556 /*
557 * The entry for SetVirtualAddress() must point to a physical address.
558 * After the first execution the service must return EFI_UNSUPPORTED.
559 */
560 efi_runtime_services.set_virtual_address_map =
561 &efi_set_virtual_address_map_runtime;
562
563 /*
564 * The entry for ConvertPointer() must point to a physical address.
565 * The service is not usable after SetVirtualAddress().
566 */
567 efi_runtime_services.convert_pointer = &efi_convert_pointer_runtime;
568
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200569 /*
570 * TODO: Update UEFI variable RuntimeServicesSupported removing flags
571 * EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP and
572 * EFI_RT_SUPPORTED_CONVERT_POINTER as required by the UEFI spec 2.8.
573 */
574
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200575 /* Update CRC32 */
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200576 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100577}
578
579/* Relocate EFI runtime to uboot_reloc_base = offset */
580void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
581{
582#ifdef IS_RELA
583 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
584#else
585 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
586 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
587#endif
588
Alexander Graf62a67482016-06-02 11:38:27 +0200589 debug("%s: Relocating to offset=%lx\n", __func__, offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100590 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
591 ulong base = CONFIG_SYS_TEXT_BASE;
592 ulong *p;
593 ulong newaddr;
594
595 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
596
Heinrich Schuchardt33691582019-08-14 06:49:09 +0200597 /*
598 * The runtime services table is updated in
599 * efi_relocate_runtime_table()
600 */
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000601 if (map && efi_is_runtime_service_pointer(p))
602 continue;
603
Heinrich Schuchardt56e82be2018-10-13 20:52:08 -0700604 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
605 rel->info, *p, rel->offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100606
Rick Chen9677a372018-05-28 19:06:37 +0800607 switch (rel->info & R_MASK) {
608 case R_RELATIVE:
Alexander Graf0bd425a2016-03-04 01:10:01 +0100609#ifdef IS_RELA
610 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
611#else
612 newaddr = *p - lastoff + offset;
613#endif
Rick Chen9677a372018-05-28 19:06:37 +0800614 break;
615#ifdef R_ABSOLUTE
616 case R_ABSOLUTE: {
617 ulong symidx = rel->info >> SYM_INDEX;
618 extern struct dyn_sym __dyn_sym_start[];
619 newaddr = __dyn_sym_start[symidx].addr + offset;
Alexander Grafdf0f6c72018-11-04 22:25:22 +0100620#ifdef IS_RELA
621 newaddr -= CONFIG_SYS_TEXT_BASE;
622#endif
Rick Chen9677a372018-05-28 19:06:37 +0800623 break;
624 }
625#endif
626 default:
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000627 printf("%s: Unknown relocation type %llx\n",
628 __func__, rel->info & R_MASK);
Rick Chen9677a372018-05-28 19:06:37 +0800629 continue;
630 }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100631
632 /* Check if the relocation is inside bounds */
633 if (map && ((newaddr < map->virtual_start) ||
Heinrich Schuchardt9ebc47f2017-09-18 22:11:34 +0200634 newaddr > (map->virtual_start +
635 (map->num_pages << EFI_PAGE_SHIFT)))) {
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000636 printf("%s: Relocation at %p is out of range (%lx)\n",
637 __func__, p, newaddr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100638 continue;
639 }
640
Alexander Graf62a67482016-06-02 11:38:27 +0200641 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100642 *p = newaddr;
Alexander Grafe5702322016-04-11 23:20:39 +0200643 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
644 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
Alexander Graf0bd425a2016-03-04 01:10:01 +0100645 }
646
647#ifndef IS_RELA
648 lastoff = offset;
649#endif
650
651 invalidate_icache_all();
652}
653
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200654/**
655 * efi_set_virtual_address_map() - change from physical to virtual mapping
656 *
657 * This function implements the SetVirtualAddressMap() runtime service.
658 *
659 * See the Unified Extensible Firmware Interface (UEFI) specification for
660 * details.
661 *
662 * @memory_map_size: size of the virtual map
663 * @descriptor_size: size of an entry in the map
664 * @descriptor_version: version of the map entries
665 * @virtmap: virtual address mapping information
666 * Return: status code
667 */
Alexander Graf0bd425a2016-03-04 01:10:01 +0100668static efi_status_t EFIAPI efi_set_virtual_address_map(
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200669 efi_uintn_t memory_map_size,
670 efi_uintn_t descriptor_size,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100671 uint32_t descriptor_version,
672 struct efi_mem_desc *virtmap)
673{
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200674 efi_uintn_t n = memory_map_size / descriptor_size;
675 efi_uintn_t i;
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200676 efi_status_t ret = EFI_INVALID_PARAMETER;
Alexander Graf86e00212018-12-11 10:00:42 +0100677 int rt_code_sections = 0;
Heinrich Schuchardt4429d872019-07-11 20:15:09 +0200678 struct efi_event *event;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100679
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200680 EFI_ENTRY("%zx %zx %x %p", memory_map_size, descriptor_size,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100681 descriptor_version, virtmap);
682
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200683 if (descriptor_version != EFI_MEMORY_DESCRIPTOR_VERSION ||
684 descriptor_size < sizeof(struct efi_mem_desc))
685 goto out;
686
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200687 efi_virtmap = virtmap;
688 efi_descriptor_size = descriptor_size;
689 efi_descriptor_count = n;
690
Alexander Graf86e00212018-12-11 10:00:42 +0100691 /*
692 * TODO:
693 * Further down we are cheating. While really we should implement
694 * SetVirtualAddressMap() events and ConvertPointer() to allow
695 * dynamically loaded drivers to expose runtime services, we don't
696 * today.
697 *
698 * So let's ensure we see exactly one single runtime section, as
699 * that is the built-in one. If we see more (or less), someone must
700 * have tried adding or removing to that which we don't support yet.
701 * In that case, let's better fail rather than expose broken runtime
702 * services.
703 */
704 for (i = 0; i < n; i++) {
705 struct efi_mem_desc *map = (void*)virtmap +
706 (descriptor_size * i);
707
708 if (map->type == EFI_RUNTIME_SERVICES_CODE)
709 rt_code_sections++;
710 }
711
712 if (rt_code_sections != 1) {
713 /*
714 * We expose exactly one single runtime code section, so
715 * something is definitely going wrong.
716 */
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200717 goto out;
Alexander Graf86e00212018-12-11 10:00:42 +0100718 }
719
Heinrich Schuchardt4429d872019-07-11 20:15:09 +0200720 /* Notify EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
721 list_for_each_entry(event, &efi_events, link) {
722 if (event->notify_function)
723 EFI_CALL_VOID(event->notify_function(
724 event, event->notify_context));
725 }
726
Alexander Graf77256092016-08-16 21:08:45 +0200727 /* Rebind mmio pointers */
728 for (i = 0; i < n; i++) {
729 struct efi_mem_desc *map = (void*)virtmap +
730 (descriptor_size * i);
731 struct list_head *lhandle;
732 efi_physical_addr_t map_start = map->physical_start;
733 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
734 efi_physical_addr_t map_end = map_start + map_len;
Heinrich Schuchardt39054562018-08-04 23:16:06 +0200735 u64 off = map->virtual_start - map_start;
Alexander Graf77256092016-08-16 21:08:45 +0200736
737 /* Adjust all mmio pointers in this region */
738 list_for_each(lhandle, &efi_runtime_mmio) {
739 struct efi_runtime_mmio_list *lmmio;
740
741 lmmio = list_entry(lhandle,
742 struct efi_runtime_mmio_list,
743 link);
744 if ((map_start <= lmmio->paddr) &&
745 (map_end >= lmmio->paddr)) {
Alexander Graf77256092016-08-16 21:08:45 +0200746 uintptr_t new_addr = lmmio->paddr + off;
747 *lmmio->ptr = (void *)new_addr;
748 }
749 }
Heinrich Schuchardt39054562018-08-04 23:16:06 +0200750 if ((map_start <= (uintptr_t)systab.tables) &&
751 (map_end >= (uintptr_t)systab.tables)) {
752 char *ptr = (char *)systab.tables;
753
754 ptr += off;
755 systab.tables = (struct efi_configuration_table *)ptr;
756 }
Alexander Graf77256092016-08-16 21:08:45 +0200757 }
758
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000759 /* Relocate the runtime. See TODO above */
Alexander Graf0bd425a2016-03-04 01:10:01 +0100760 for (i = 0; i < n; i++) {
761 struct efi_mem_desc *map;
762
763 map = (void*)virtmap + (descriptor_size * i);
764 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
Alexander Graf77256092016-08-16 21:08:45 +0200765 ulong new_offset = map->virtual_start -
Alexander Graf86e00212018-12-11 10:00:42 +0100766 map->physical_start + gd->relocaddr;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100767
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000768 efi_relocate_runtime_table(new_offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100769 efi_runtime_relocate(new_offset, map);
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200770 ret = EFI_SUCCESS;
771 goto out;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100772 }
773 }
774
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200775out:
776 return EFI_EXIT(ret);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100777}
778
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200779/**
780 * efi_add_runtime_mmio() - add memory-mapped IO region
781 *
782 * This function adds a memory-mapped IO region to the memory map to make it
783 * available at runtime.
784 *
Heinrich Schuchardt7e307642018-12-23 02:35:13 +0100785 * @mmio_ptr: pointer to a pointer to the start of the memory-mapped
786 * IO region
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200787 * @len: size of the memory-mapped IO region
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200788 * Returns: status code
789 */
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100790efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
Alexander Graf77256092016-08-16 21:08:45 +0200791{
792 struct efi_runtime_mmio_list *newmmio;
Alexander Graf33a83a32018-03-15 15:08:16 +0100793 uint64_t addr = *(uintptr_t *)mmio_ptr;
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100794 efi_status_t ret;
Alexander Graf33a83a32018-03-15 15:08:16 +0100795
Michael Walle282d3862020-05-17 12:29:19 +0200796 ret = efi_add_memory_map(addr, len, EFI_MMAP_IO);
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100797 if (ret != EFI_SUCCESS)
Alexander Graf33a83a32018-03-15 15:08:16 +0100798 return EFI_OUT_OF_RESOURCES;
Alexander Graf77256092016-08-16 21:08:45 +0200799
800 newmmio = calloc(1, sizeof(*newmmio));
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100801 if (!newmmio)
802 return EFI_OUT_OF_RESOURCES;
Alexander Graf77256092016-08-16 21:08:45 +0200803 newmmio->ptr = mmio_ptr;
804 newmmio->paddr = *(uintptr_t *)mmio_ptr;
805 newmmio->len = len;
806 list_add_tail(&newmmio->link, &efi_runtime_mmio);
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100807
Alexander Graf33a83a32018-03-15 15:08:16 +0100808 return EFI_SUCCESS;
Alexander Graf77256092016-08-16 21:08:45 +0200809}
810
Alexander Graf0bd425a2016-03-04 01:10:01 +0100811/*
812 * In the second stage, U-Boot has disappeared. To isolate our runtime code
813 * that at this point still exists from the rest, we put it into a special
814 * section.
815 *
816 * !!WARNING!!
817 *
818 * This means that we can not rely on any code outside of this file in any
819 * function or variable below this line.
820 *
821 * Please keep everything fully self-contained and annotated with
Alexander Graf393dd912016-10-14 13:45:30 +0200822 * __efi_runtime and __efi_runtime_data markers.
Alexander Graf0bd425a2016-03-04 01:10:01 +0100823 */
824
825/*
826 * Relocate the EFI runtime stub to a different place. We need to call this
827 * the first time we expose the runtime interface to a user and on set virtual
828 * address map calls.
829 */
830
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200831/**
832 * efi_unimplemented() - replacement function, returns EFI_UNSUPPORTED
833 *
834 * This function is used after SetVirtualAddressMap() is called as replacement
835 * for services that are not available anymore due to constraints of the U-Boot
836 * implementation.
837 *
838 * Return: EFI_UNSUPPORTED
839 */
Alexander Graf393dd912016-10-14 13:45:30 +0200840static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100841{
842 return EFI_UNSUPPORTED;
843}
844
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200845/**
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200846 * efi_update_capsule() - process information from operating system
847 *
848 * This function implements the UpdateCapsule() runtime service.
849 *
850 * See the Unified Extensible Firmware Interface (UEFI) specification for
851 * details.
852 *
853 * @capsule_header_array: pointer to array of virtual pointers
854 * @capsule_count: number of pointers in capsule_header_array
855 * @scatter_gather_list: pointer to arry of physical pointers
856 * Returns: status code
857 */
Heinrich Schuchardt897c0722018-02-09 20:41:21 +0100858efi_status_t __efi_runtime EFIAPI efi_update_capsule(
859 struct efi_capsule_header **capsule_header_array,
860 efi_uintn_t capsule_count,
861 u64 scatter_gather_list)
862{
863 return EFI_UNSUPPORTED;
864}
865
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200866/**
867 * efi_query_capsule_caps() - check if capsule is supported
868 *
869 * This function implements the QueryCapsuleCapabilities() runtime service.
870 *
871 * See the Unified Extensible Firmware Interface (UEFI) specification for
872 * details.
873 *
874 * @capsule_header_array: pointer to array of virtual pointers
875 * @capsule_count: number of pointers in capsule_header_array
Heinrich Schuchardt1d1be362018-09-03 20:59:25 +0200876 * @maximum_capsule_size: maximum capsule size
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200877 * @reset_type: type of reset needed for capsule update
878 * Returns: status code
879 */
Heinrich Schuchardt897c0722018-02-09 20:41:21 +0100880efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
881 struct efi_capsule_header **capsule_header_array,
882 efi_uintn_t capsule_count,
AKASHI Takahirod840b672018-11-14 16:18:53 +0900883 u64 *maximum_capsule_size,
884 u32 *reset_type)
Heinrich Schuchardt897c0722018-02-09 20:41:21 +0100885{
886 return EFI_UNSUPPORTED;
887}
888
Alexander Graf393dd912016-10-14 13:45:30 +0200889struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
Alexander Graf0bd425a2016-03-04 01:10:01 +0100890 .hdr = {
891 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +0200892 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +0200893 .headersize = sizeof(struct efi_runtime_services),
Alexander Graf0bd425a2016-03-04 01:10:01 +0100894 },
Alexander Graf77256092016-08-16 21:08:45 +0200895 .get_time = &efi_get_time_boottime,
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200896 .set_time = &efi_set_time_boottime,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100897 .get_wakeup_time = (void *)&efi_unimplemented,
898 .set_wakeup_time = (void *)&efi_unimplemented,
899 .set_virtual_address_map = &efi_set_virtual_address_map,
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200900 .convert_pointer = efi_convert_pointer,
Rob Clark15f3d742017-09-13 18:05:37 -0400901 .get_variable = efi_get_variable,
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200902 .get_next_variable_name = efi_get_next_variable_name,
Rob Clark15f3d742017-09-13 18:05:37 -0400903 .set_variable = efi_set_variable,
Heinrich Schuchardt5337a6c2019-06-20 15:40:49 +0200904 .get_next_high_mono_count = (void *)&efi_unimplemented,
Alexander Graf77256092016-08-16 21:08:45 +0200905 .reset_system = &efi_reset_system_boottime,
Heinrich Schuchardt897c0722018-02-09 20:41:21 +0100906 .update_capsule = efi_update_capsule,
907 .query_capsule_caps = efi_query_capsule_caps,
908 .query_variable_info = efi_query_variable_info,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100909};