blob: 4be51335bcb6e8263dc91a4476ed89443cf5ff4c [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 Glass9bc15642020-02-03 07:36:16 -070014#include <malloc.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010015#include <rtc.h>
Simon Glass48b6c6b2019-11-14 12:57:16 -070016#include <u-boot/crc.h>
Alexander Graf0bd425a2016-03-04 01:10:01 +010017
18/* For manual relocation support */
19DECLARE_GLOBAL_DATA_PTR;
20
Heinrich Schuchardt956eff32020-02-19 20:48:49 +010021/* GUID of the runtime properties table */
22static const efi_guid_t efi_rt_properties_table_guid =
23 EFI_RT_PROPERTIES_TABLE_GUID;
24
Alexander Graf77256092016-08-16 21:08:45 +020025struct efi_runtime_mmio_list {
26 struct list_head link;
27 void **ptr;
28 u64 paddr;
29 u64 len;
30};
31
32/* This list contains all runtime available mmio regions */
33LIST_HEAD(efi_runtime_mmio);
34
Alexander Graf393dd912016-10-14 13:45:30 +020035static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
Alexander Graf0bd425a2016-03-04 01:10:01 +010036
Simon Glassfff89d42018-06-11 23:26:40 -060037/*
Heinrich Schuchardt11121542018-09-03 19:29:41 +020038 * TODO(sjg@chromium.org): These defines and structures should come from the ELF
39 * header for each architecture (or a generic header) rather than being repeated
40 * here.
Simon Glassfff89d42018-06-11 23:26:40 -060041 */
Alexander Graf0fe51922018-06-18 17:23:08 +020042#if defined(__aarch64__)
Alexander Graf46c15142018-06-18 17:23:11 +020043#define R_RELATIVE R_AARCH64_RELATIVE
Alexander Graf0bd425a2016-03-04 01:10:01 +010044#define R_MASK 0xffffffffULL
45#define IS_RELA 1
Alexander Graf0fe51922018-06-18 17:23:08 +020046#elif defined(__arm__)
Alexander Graf46c15142018-06-18 17:23:11 +020047#define R_RELATIVE R_ARM_RELATIVE
Alexander Graf0bd425a2016-03-04 01:10:01 +010048#define R_MASK 0xffULL
Heinrich Schuchardt56e82be2018-10-13 20:52:08 -070049#elif defined(__i386__)
Simon Glasscdfe6962016-09-25 15:27:35 -060050#define R_RELATIVE R_386_RELATIVE
51#define R_MASK 0xffULL
Heinrich Schuchardt56e82be2018-10-13 20:52:08 -070052#elif defined(__x86_64__)
53#define R_RELATIVE R_X86_64_RELATIVE
54#define R_MASK 0xffffffffULL
55#define IS_RELA 1
Alexander Graf0fe51922018-06-18 17:23:08 +020056#elif defined(__riscv)
Rick Chen9677a372018-05-28 19:06:37 +080057#define R_RELATIVE R_RISCV_RELATIVE
58#define R_MASK 0xffULL
59#define IS_RELA 1
60
61struct dyn_sym {
62 ulong foo1;
63 ulong addr;
64 u32 foo2;
65 u32 foo3;
66};
Alexander Graf0fe51922018-06-18 17:23:08 +020067#if (__riscv_xlen == 32)
Rick Chen9677a372018-05-28 19:06:37 +080068#define R_ABSOLUTE R_RISCV_32
69#define SYM_INDEX 8
Alexander Graf0fe51922018-06-18 17:23:08 +020070#elif (__riscv_xlen == 64)
Rick Chen9677a372018-05-28 19:06:37 +080071#define R_ABSOLUTE R_RISCV_64
72#define SYM_INDEX 32
Alexander Graf0fe51922018-06-18 17:23:08 +020073#else
74#error unknown riscv target
Rick Chen9677a372018-05-28 19:06:37 +080075#endif
Alexander Graf0bd425a2016-03-04 01:10:01 +010076#else
77#error Need to add relocation awareness
78#endif
79
80struct elf_rel {
81 ulong *offset;
82 ulong info;
83};
84
85struct elf_rela {
86 ulong *offset;
87 ulong info;
88 long addend;
89};
90
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +020091static __efi_runtime_data struct efi_mem_desc *efi_virtmap;
92static __efi_runtime_data efi_uintn_t efi_descriptor_count;
93static __efi_runtime_data efi_uintn_t efi_descriptor_size;
94
Alexander Graf0bd425a2016-03-04 01:10:01 +010095/*
Heinrich Schuchardt11121542018-09-03 19:29:41 +020096 * EFI runtime code lives in two stages. In the first stage, U-Boot and an EFI
Alexander Graf0bd425a2016-03-04 01:10:01 +010097 * payload are running concurrently at the same time. In this mode, we can
98 * handle a good number of runtime callbacks
99 */
100
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100101/**
102 * efi_init_runtime_supported() - create runtime properties table
103 *
104 * Create a configuration table specifying which services are available at
105 * runtime.
106 *
107 * Return: status code
108 */
AKASHI Takahiro32401842019-06-05 13:21:38 +0900109efi_status_t efi_init_runtime_supported(void)
110{
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100111 efi_status_t ret;
112 struct efi_rt_properties_table *rt_table;
113
114 ret = efi_allocate_pool(EFI_RUNTIME_SERVICES_DATA,
115 sizeof(struct efi_rt_properties_table),
116 (void **)&rt_table);
117 if (ret != EFI_SUCCESS)
118 return ret;
119
120 rt_table->version = EFI_RT_PROPERTIES_TABLE_VERSION;
121 rt_table->length = sizeof(struct efi_rt_properties_table);
122 rt_table->runtime_services_supported =
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200123 EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP |
124 EFI_RT_SUPPORTED_CONVERT_POINTER;
AKASHI Takahiro32401842019-06-05 13:21:38 +0900125
126 /*
127 * This value must be synced with efi_runtime_detach_list
128 * as well as efi_runtime_services.
129 */
Heinrich Schuchardt05874fb2019-07-05 18:12:16 +0200130#ifdef CONFIG_EFI_HAVE_RUNTIME_RESET
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100131 rt_table->runtime_services_supported |= EFI_RT_SUPPORTED_RESET_SYSTEM;
AKASHI Takahiro32401842019-06-05 13:21:38 +0900132#endif
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200133
Heinrich Schuchardt956eff32020-02-19 20:48:49 +0100134 ret = efi_install_configuration_table(&efi_rt_properties_table_guid,
135 rt_table);
136 return ret;
AKASHI Takahiro32401842019-06-05 13:21:38 +0900137}
138
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200139/**
140 * efi_update_table_header_crc32() - Update crc32 in table header
141 *
142 * @table: EFI table
143 */
144void __efi_runtime efi_update_table_header_crc32(struct efi_table_hdr *table)
145{
146 table->crc32 = 0;
147 table->crc32 = crc32(0, (const unsigned char *)table,
148 table->headersize);
149}
150
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200151/**
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200152 * efi_reset_system_boottime() - reset system at boot time
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200153 *
154 * This function implements the ResetSystem() runtime service before
155 * SetVirtualAddressMap() is called.
156 *
157 * See the Unified Extensible Firmware Interface (UEFI) specification for
158 * details.
159 *
160 * @reset_type: type of reset to perform
161 * @reset_status: status code for the reset
162 * @data_size: size of reset_data
163 * @reset_data: information about the reset
164 */
Alexander Graf77256092016-08-16 21:08:45 +0200165static void EFIAPI efi_reset_system_boottime(
166 enum efi_reset_type reset_type,
167 efi_status_t reset_status,
168 unsigned long data_size, void *reset_data)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100169{
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100170 struct efi_event *evt;
171
Alexander Graf0bd425a2016-03-04 01:10:01 +0100172 EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
173 reset_data);
174
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100175 /* Notify reset */
176 list_for_each_entry(evt, &efi_events, link) {
177 if (evt->group &&
178 !guidcmp(evt->group,
179 &efi_guid_event_group_reset_system)) {
Heinrich Schuchardt7b4b8d862019-06-07 06:47:01 +0200180 efi_signal_event(evt);
Heinrich Schuchardtbf7f1692018-02-18 15:17:52 +0100181 break;
182 }
183 }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100184 switch (reset_type) {
185 case EFI_RESET_COLD:
186 case EFI_RESET_WARM:
Heinrich Schuchardt450d4c82018-02-06 22:00:22 +0100187 case EFI_RESET_PLATFORM_SPECIFIC:
Alexander Graf0bd425a2016-03-04 01:10:01 +0100188 do_reset(NULL, 0, 0, NULL);
189 break;
190 case EFI_RESET_SHUTDOWN:
Heinrich Schuchardt44489452018-10-16 07:44:53 +0200191#ifdef CONFIG_CMD_POWEROFF
192 do_poweroff(NULL, 0, 0, NULL);
193#endif
Alexander Graf0bd425a2016-03-04 01:10:01 +0100194 break;
195 }
196
Alexander Graf77256092016-08-16 21:08:45 +0200197 while (1) { }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100198}
199
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200200/**
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200201 * efi_get_time_boottime() - get current time at boot time
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200202 *
203 * This function implements the GetTime runtime service before
204 * SetVirtualAddressMap() is called.
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200205 *
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200206 * See the Unified Extensible Firmware Interface (UEFI) specification
207 * for details.
208 *
209 * @time: pointer to structure to receive current time
210 * @capabilities: pointer to structure to receive RTC properties
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200211 * Returns: status code
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200212 */
Alexander Graf77256092016-08-16 21:08:45 +0200213static efi_status_t EFIAPI efi_get_time_boottime(
214 struct efi_time *time,
215 struct efi_time_cap *capabilities)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100216{
Heinrich Schuchardtf2856ad2019-05-31 22:56:02 +0200217#ifdef CONFIG_EFI_GET_TIME
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200218 efi_status_t ret = EFI_SUCCESS;
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200219 struct rtc_time tm;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100220 struct udevice *dev;
221
222 EFI_ENTRY("%p %p", time, capabilities);
223
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200224 if (!time) {
225 ret = EFI_INVALID_PARAMETER;
226 goto out;
227 }
Heinrich Schuchardtb4bd3662019-05-19 21:41:28 +0200228 if (uclass_get_device(UCLASS_RTC, 0, &dev) ||
229 dm_rtc_get(dev, &tm)) {
230 ret = EFI_UNSUPPORTED;
231 goto out;
232 }
233 if (dm_rtc_get(dev, &tm)) {
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200234 ret = EFI_DEVICE_ERROR;
235 goto out;
236 }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100237
238 memset(time, 0, sizeof(*time));
239 time->year = tm.tm_year;
240 time->month = tm.tm_mon;
241 time->day = tm.tm_mday;
242 time->hour = tm.tm_hour;
243 time->minute = tm.tm_min;
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200244 time->second = tm.tm_sec;
Heinrich Schuchardtba3e8282019-05-31 22:08:45 +0200245 if (tm.tm_isdst)
246 time->daylight =
247 EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT;
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200248 time->timezone = EFI_UNSPECIFIED_TIMEZONE;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100249
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200250 if (capabilities) {
251 /* Set reasonable dummy values */
252 capabilities->resolution = 1; /* 1 Hz */
253 capabilities->accuracy = 100000000; /* 100 ppm */
254 capabilities->sets_to_zero = false;
255 }
256out:
257 return EFI_EXIT(ret);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100258#else
Heinrich Schuchardt37035b12018-07-07 23:39:14 +0200259 EFI_ENTRY("%p %p", time, capabilities);
Heinrich Schuchardtb4bd3662019-05-19 21:41:28 +0200260 return EFI_EXIT(EFI_UNSUPPORTED);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100261#endif
262}
263
Heinrich Schuchardtf2856ad2019-05-31 22:56:02 +0200264#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardt33e5a0e2019-05-31 07:35:19 +0200265
266/**
267 * efi_validate_time() - checks if timestamp is valid
268 *
269 * @time: timestamp to validate
270 * Returns: 0 if timestamp is valid, 1 otherwise
271 */
272static int efi_validate_time(struct efi_time *time)
273{
274 return (!time ||
275 time->year < 1900 || time->year > 9999 ||
276 !time->month || time->month > 12 || !time->day ||
277 time->day > rtc_month_days(time->month - 1, time->year) ||
278 time->hour > 23 || time->minute > 59 || time->second > 59 ||
279 time->nanosecond > 999999999 ||
280 time->daylight &
281 ~(EFI_TIME_IN_DAYLIGHT | EFI_TIME_ADJUST_DAYLIGHT) ||
282 ((time->timezone < -1440 || time->timezone > 1440) &&
283 time->timezone != EFI_UNSPECIFIED_TIMEZONE));
284}
285
286#endif
287
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200288/**
289 * efi_set_time_boottime() - set current time
290 *
291 * This function implements the SetTime() runtime service before
292 * SetVirtualAddressMap() is called.
293 *
294 * See the Unified Extensible Firmware Interface (UEFI) specification
295 * for details.
296 *
297 * @time: pointer to structure to with current time
298 * Returns: status code
299 */
300static efi_status_t EFIAPI efi_set_time_boottime(struct efi_time *time)
301{
Heinrich Schuchardtf2856ad2019-05-31 22:56:02 +0200302#ifdef CONFIG_EFI_SET_TIME
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200303 efi_status_t ret = EFI_SUCCESS;
304 struct rtc_time tm;
305 struct udevice *dev;
Alexander Graf77256092016-08-16 21:08:45 +0200306
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200307 EFI_ENTRY("%p", time);
308
Heinrich Schuchardt33e5a0e2019-05-31 07:35:19 +0200309 if (efi_validate_time(time)) {
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200310 ret = EFI_INVALID_PARAMETER;
311 goto out;
312 }
313
314 if (uclass_get_device(UCLASS_RTC, 0, &dev)) {
315 ret = EFI_UNSUPPORTED;
316 goto out;
317 }
318
319 memset(&tm, 0, sizeof(tm));
320 tm.tm_year = time->year;
321 tm.tm_mon = time->month;
322 tm.tm_mday = time->day;
323 tm.tm_hour = time->hour;
324 tm.tm_min = time->minute;
325 tm.tm_sec = time->second;
Heinrich Schuchardtba3e8282019-05-31 22:08:45 +0200326 tm.tm_isdst = time->daylight ==
327 (EFI_TIME_ADJUST_DAYLIGHT | EFI_TIME_IN_DAYLIGHT);
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200328 /* Calculate day of week */
329 rtc_calc_weekday(&tm);
330
331 if (dm_rtc_set(dev, &tm))
332 ret = EFI_DEVICE_ERROR;
333out:
334 return EFI_EXIT(ret);
335#else
336 EFI_ENTRY("%p", time);
337 return EFI_EXIT(EFI_UNSUPPORTED);
338#endif
339}
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200340/**
341 * efi_reset_system() - reset system
342 *
343 * This function implements the ResetSystem() runtime service after
344 * SetVirtualAddressMap() is called. It only executes an endless loop.
345 * Boards may override the helpers below to implement reset functionality.
346 *
347 * See the Unified Extensible Firmware Interface (UEFI) specification for
348 * details.
349 *
350 * @reset_type: type of reset to perform
351 * @reset_status: status code for the reset
352 * @data_size: size of reset_data
353 * @reset_data: information about the reset
354 */
Alexander Graf393dd912016-10-14 13:45:30 +0200355void __weak __efi_runtime EFIAPI efi_reset_system(
Alexander Graf77256092016-08-16 21:08:45 +0200356 enum efi_reset_type reset_type,
357 efi_status_t reset_status,
358 unsigned long data_size, void *reset_data)
359{
360 /* Nothing we can do */
361 while (1) { }
362}
363
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200364/**
365 * efi_reset_system_init() - initialize the reset driver
366 *
367 * Boards may override this function to initialize the reset driver.
368 */
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100369efi_status_t __weak efi_reset_system_init(void)
Alexander Graf77256092016-08-16 21:08:45 +0200370{
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100371 return EFI_SUCCESS;
Alexander Graf77256092016-08-16 21:08:45 +0200372}
373
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200374/**
375 * efi_get_time() - get current time
376 *
377 * This function implements the GetTime runtime service after
378 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
379 * anymore only an error code is returned.
380 *
381 * See the Unified Extensible Firmware Interface (UEFI) specification
382 * for details.
383 *
384 * @time: pointer to structure to receive current time
385 * @capabilities: pointer to structure to receive RTC properties
386 * Returns: status code
387 */
Alexander Graf393dd912016-10-14 13:45:30 +0200388efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
Alexander Graf77256092016-08-16 21:08:45 +0200389 struct efi_time *time,
390 struct efi_time_cap *capabilities)
391{
Heinrich Schuchardtb4ba5be2019-06-13 18:42:40 +0200392 return EFI_UNSUPPORTED;
Alexander Graf77256092016-08-16 21:08:45 +0200393}
394
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200395/**
396 * efi_set_time() - set current time
397 *
398 * This function implements the SetTime runtime service after
399 * SetVirtualAddressMap() is called. As the U-Boot driver are not available
400 * anymore only an error code is returned.
401 *
402 * See the Unified Extensible Firmware Interface (UEFI) specification
403 * for details.
404 *
405 * @time: pointer to structure to with current time
406 * Returns: status code
407 */
408efi_status_t __weak __efi_runtime EFIAPI efi_set_time(struct efi_time *time)
409{
410 return EFI_UNSUPPORTED;
411}
412
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000413/**
414 * efi_is_runtime_service_pointer() - check if pointer points to runtime table
415 *
416 * @p: pointer to check
417 * Return: true if the pointer points to a service function pointer in the
418 * runtime table
419 */
420static bool efi_is_runtime_service_pointer(void *p)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100421{
Heinrich Schuchardt4429d872019-07-11 20:15:09 +0200422 return (p >= (void *)&efi_runtime_services.get_time &&
423 p <= (void *)&efi_runtime_services.query_variable_info) ||
424 p == (void *)&efi_events.prev ||
425 p == (void *)&efi_events.next;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100426}
427
Heinrich Schuchardtc3f2a9f2019-07-05 18:12:21 +0200428/**
429 * efi_runtime_detach() - detach unimplemented runtime functions
430 */
Heinrich Schuchardt1943dbb2019-07-05 17:42:16 +0200431void efi_runtime_detach(void)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100432{
Heinrich Schuchardtc3f2a9f2019-07-05 18:12:21 +0200433 efi_runtime_services.reset_system = efi_reset_system;
434 efi_runtime_services.get_time = efi_get_time;
435 efi_runtime_services.set_time = efi_set_time;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100436
Heinrich Schuchardtc3f2a9f2019-07-05 18:12:21 +0200437 /* Update CRC32 */
438 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000439}
440
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200441/**
442 * efi_set_virtual_address_map_runtime() - change from physical to virtual
443 * mapping
444 *
445 * This function implements the SetVirtualAddressMap() runtime service after
446 * it is first called.
447 *
448 * See the Unified Extensible Firmware Interface (UEFI) specification for
449 * details.
450 *
451 * @memory_map_size: size of the virtual map
452 * @descriptor_size: size of an entry in the map
453 * @descriptor_version: version of the map entries
454 * @virtmap: virtual address mapping information
455 * Return: status code EFI_UNSUPPORTED
456 */
Heinrich Schuchardt2b6bd382019-07-12 22:41:43 +0200457static __efi_runtime efi_status_t EFIAPI efi_set_virtual_address_map_runtime(
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200458 efi_uintn_t memory_map_size,
459 efi_uintn_t descriptor_size,
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200460 uint32_t descriptor_version,
461 struct efi_mem_desc *virtmap)
462{
463 return EFI_UNSUPPORTED;
464}
465
466/**
467 * efi_convert_pointer_runtime() - convert from physical to virtual pointer
468 *
469 * This function implements the ConvertPointer() runtime service after
470 * the first call to SetVirtualAddressMap().
471 *
472 * See the Unified Extensible Firmware Interface (UEFI) specification for
473 * details.
474 *
475 * @debug_disposition: indicates if pointer may be converted to NULL
476 * @address: pointer to be converted
477 * Return: status code EFI_UNSUPPORTED
478 */
479static __efi_runtime efi_status_t EFIAPI efi_convert_pointer_runtime(
480 efi_uintn_t debug_disposition, void **address)
481{
482 return EFI_UNSUPPORTED;
483}
484
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200485/**
486 * efi_convert_pointer_runtime() - convert from physical to virtual pointer
487 *
488 * This function implements the ConvertPointer() runtime service until
489 * the first call to SetVirtualAddressMap().
490 *
491 * See the Unified Extensible Firmware Interface (UEFI) specification for
492 * details.
493 *
494 * @debug_disposition: indicates if pointer may be converted to NULL
495 * @address: pointer to be converted
496 * Return: status code EFI_UNSUPPORTED
497 */
498static __efi_runtime efi_status_t EFIAPI efi_convert_pointer(
499 efi_uintn_t debug_disposition, void **address)
500{
501 efi_physical_addr_t addr = (uintptr_t)*address;
502 efi_uintn_t i;
503 efi_status_t ret = EFI_NOT_FOUND;
504
505 EFI_ENTRY("%zu %p", debug_disposition, address);
506
507 if (!efi_virtmap) {
508 ret = EFI_UNSUPPORTED;
509 goto out;
510 }
511
512 if (!address) {
513 ret = EFI_INVALID_PARAMETER;
514 goto out;
515 }
516
517 for (i = 0; i < efi_descriptor_count; i++) {
518 struct efi_mem_desc *map = (void *)efi_virtmap +
519 (efi_descriptor_size * i);
520
521 if (addr >= map->physical_start &&
522 (addr < map->physical_start
523 + (map->num_pages << EFI_PAGE_SHIFT))) {
524 *address = (void *)(uintptr_t)
525 (addr + map->virtual_start -
526 map->physical_start);
527
528 ret = EFI_SUCCESS;
529 break;
530 }
531 }
532
533out:
534 return EFI_EXIT(ret);
535}
536
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000537static __efi_runtime void efi_relocate_runtime_table(ulong offset)
538{
539 ulong patchoff;
540 void **pos;
541
542 /* Relocate the runtime services pointers */
543 patchoff = offset - gd->relocaddr;
544 for (pos = (void **)&efi_runtime_services.get_time;
545 pos <= (void **)&efi_runtime_services.query_variable_info; ++pos) {
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200546 if (*pos)
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000547 *pos += patchoff;
548 }
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200549
Heinrich Schuchardt25728512019-06-29 03:32:52 +0200550 /*
551 * The entry for SetVirtualAddress() must point to a physical address.
552 * After the first execution the service must return EFI_UNSUPPORTED.
553 */
554 efi_runtime_services.set_virtual_address_map =
555 &efi_set_virtual_address_map_runtime;
556
557 /*
558 * The entry for ConvertPointer() must point to a physical address.
559 * The service is not usable after SetVirtualAddress().
560 */
561 efi_runtime_services.convert_pointer = &efi_convert_pointer_runtime;
562
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200563 /*
564 * TODO: Update UEFI variable RuntimeServicesSupported removing flags
565 * EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP and
566 * EFI_RT_SUPPORTED_CONVERT_POINTER as required by the UEFI spec 2.8.
567 */
568
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200569 /* Update CRC32 */
Heinrich Schuchardt69c15762018-07-29 09:49:04 +0200570 efi_update_table_header_crc32(&efi_runtime_services.hdr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100571}
572
573/* Relocate EFI runtime to uboot_reloc_base = offset */
574void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
575{
576#ifdef IS_RELA
577 struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
578#else
579 struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
580 static ulong lastoff = CONFIG_SYS_TEXT_BASE;
581#endif
582
Alexander Graf62a67482016-06-02 11:38:27 +0200583 debug("%s: Relocating to offset=%lx\n", __func__, offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100584 for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
585 ulong base = CONFIG_SYS_TEXT_BASE;
586 ulong *p;
587 ulong newaddr;
588
589 p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
590
Heinrich Schuchardt33691582019-08-14 06:49:09 +0200591 /*
592 * The runtime services table is updated in
593 * efi_relocate_runtime_table()
594 */
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000595 if (map && efi_is_runtime_service_pointer(p))
596 continue;
597
Heinrich Schuchardt56e82be2018-10-13 20:52:08 -0700598 debug("%s: rel->info=%#lx *p=%#lx rel->offset=%p\n", __func__,
599 rel->info, *p, rel->offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100600
Rick Chen9677a372018-05-28 19:06:37 +0800601 switch (rel->info & R_MASK) {
602 case R_RELATIVE:
Alexander Graf0bd425a2016-03-04 01:10:01 +0100603#ifdef IS_RELA
604 newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
605#else
606 newaddr = *p - lastoff + offset;
607#endif
Rick Chen9677a372018-05-28 19:06:37 +0800608 break;
609#ifdef R_ABSOLUTE
610 case R_ABSOLUTE: {
611 ulong symidx = rel->info >> SYM_INDEX;
612 extern struct dyn_sym __dyn_sym_start[];
613 newaddr = __dyn_sym_start[symidx].addr + offset;
Alexander Grafdf0f6c72018-11-04 22:25:22 +0100614#ifdef IS_RELA
615 newaddr -= CONFIG_SYS_TEXT_BASE;
616#endif
Rick Chen9677a372018-05-28 19:06:37 +0800617 break;
618 }
619#endif
620 default:
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000621 printf("%s: Unknown relocation type %llx\n",
622 __func__, rel->info & R_MASK);
Rick Chen9677a372018-05-28 19:06:37 +0800623 continue;
624 }
Alexander Graf0bd425a2016-03-04 01:10:01 +0100625
626 /* Check if the relocation is inside bounds */
627 if (map && ((newaddr < map->virtual_start) ||
Heinrich Schuchardt9ebc47f2017-09-18 22:11:34 +0200628 newaddr > (map->virtual_start +
629 (map->num_pages << EFI_PAGE_SHIFT)))) {
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000630 printf("%s: Relocation at %p is out of range (%lx)\n",
631 __func__, p, newaddr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100632 continue;
633 }
634
Alexander Graf62a67482016-06-02 11:38:27 +0200635 debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100636 *p = newaddr;
Alexander Grafe5702322016-04-11 23:20:39 +0200637 flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
638 ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
Alexander Graf0bd425a2016-03-04 01:10:01 +0100639 }
640
641#ifndef IS_RELA
642 lastoff = offset;
643#endif
644
645 invalidate_icache_all();
646}
647
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200648/**
649 * efi_set_virtual_address_map() - change from physical to virtual mapping
650 *
651 * This function implements the SetVirtualAddressMap() runtime service.
652 *
653 * See the Unified Extensible Firmware Interface (UEFI) specification for
654 * details.
655 *
656 * @memory_map_size: size of the virtual map
657 * @descriptor_size: size of an entry in the map
658 * @descriptor_version: version of the map entries
659 * @virtmap: virtual address mapping information
660 * Return: status code
661 */
Alexander Graf0bd425a2016-03-04 01:10:01 +0100662static efi_status_t EFIAPI efi_set_virtual_address_map(
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200663 efi_uintn_t memory_map_size,
664 efi_uintn_t descriptor_size,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100665 uint32_t descriptor_version,
666 struct efi_mem_desc *virtmap)
667{
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200668 efi_uintn_t n = memory_map_size / descriptor_size;
669 efi_uintn_t i;
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200670 efi_status_t ret = EFI_INVALID_PARAMETER;
Alexander Graf86e00212018-12-11 10:00:42 +0100671 int rt_code_sections = 0;
Heinrich Schuchardt4429d872019-07-11 20:15:09 +0200672 struct efi_event *event;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100673
Heinrich Schuchardtf8599dc2019-07-27 20:28:47 +0200674 EFI_ENTRY("%zx %zx %x %p", memory_map_size, descriptor_size,
Alexander Graf0bd425a2016-03-04 01:10:01 +0100675 descriptor_version, virtmap);
676
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200677 if (descriptor_version != EFI_MEMORY_DESCRIPTOR_VERSION ||
678 descriptor_size < sizeof(struct efi_mem_desc))
679 goto out;
680
Heinrich Schuchardtc680dc42019-07-27 20:35:24 +0200681 efi_virtmap = virtmap;
682 efi_descriptor_size = descriptor_size;
683 efi_descriptor_count = n;
684
Alexander Graf86e00212018-12-11 10:00:42 +0100685 /*
686 * TODO:
687 * Further down we are cheating. While really we should implement
688 * SetVirtualAddressMap() events and ConvertPointer() to allow
689 * dynamically loaded drivers to expose runtime services, we don't
690 * today.
691 *
692 * So let's ensure we see exactly one single runtime section, as
693 * that is the built-in one. If we see more (or less), someone must
694 * have tried adding or removing to that which we don't support yet.
695 * In that case, let's better fail rather than expose broken runtime
696 * services.
697 */
698 for (i = 0; i < n; i++) {
699 struct efi_mem_desc *map = (void*)virtmap +
700 (descriptor_size * i);
701
702 if (map->type == EFI_RUNTIME_SERVICES_CODE)
703 rt_code_sections++;
704 }
705
706 if (rt_code_sections != 1) {
707 /*
708 * We expose exactly one single runtime code section, so
709 * something is definitely going wrong.
710 */
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200711 goto out;
Alexander Graf86e00212018-12-11 10:00:42 +0100712 }
713
Heinrich Schuchardt4429d872019-07-11 20:15:09 +0200714 /* Notify EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE */
715 list_for_each_entry(event, &efi_events, link) {
716 if (event->notify_function)
717 EFI_CALL_VOID(event->notify_function(
718 event, event->notify_context));
719 }
720
Alexander Graf77256092016-08-16 21:08:45 +0200721 /* Rebind mmio pointers */
722 for (i = 0; i < n; i++) {
723 struct efi_mem_desc *map = (void*)virtmap +
724 (descriptor_size * i);
725 struct list_head *lhandle;
726 efi_physical_addr_t map_start = map->physical_start;
727 efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
728 efi_physical_addr_t map_end = map_start + map_len;
Heinrich Schuchardt39054562018-08-04 23:16:06 +0200729 u64 off = map->virtual_start - map_start;
Alexander Graf77256092016-08-16 21:08:45 +0200730
731 /* Adjust all mmio pointers in this region */
732 list_for_each(lhandle, &efi_runtime_mmio) {
733 struct efi_runtime_mmio_list *lmmio;
734
735 lmmio = list_entry(lhandle,
736 struct efi_runtime_mmio_list,
737 link);
738 if ((map_start <= lmmio->paddr) &&
739 (map_end >= lmmio->paddr)) {
Alexander Graf77256092016-08-16 21:08:45 +0200740 uintptr_t new_addr = lmmio->paddr + off;
741 *lmmio->ptr = (void *)new_addr;
742 }
743 }
Heinrich Schuchardt39054562018-08-04 23:16:06 +0200744 if ((map_start <= (uintptr_t)systab.tables) &&
745 (map_end >= (uintptr_t)systab.tables)) {
746 char *ptr = (char *)systab.tables;
747
748 ptr += off;
749 systab.tables = (struct efi_configuration_table *)ptr;
750 }
Alexander Graf77256092016-08-16 21:08:45 +0200751 }
752
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000753 /* Relocate the runtime. See TODO above */
Alexander Graf0bd425a2016-03-04 01:10:01 +0100754 for (i = 0; i < n; i++) {
755 struct efi_mem_desc *map;
756
757 map = (void*)virtmap + (descriptor_size * i);
758 if (map->type == EFI_RUNTIME_SERVICES_CODE) {
Alexander Graf77256092016-08-16 21:08:45 +0200759 ulong new_offset = map->virtual_start -
Alexander Graf86e00212018-12-11 10:00:42 +0100760 map->physical_start + gd->relocaddr;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100761
Heinrich Schuchardt19cd80b2019-06-20 22:00:02 +0000762 efi_relocate_runtime_table(new_offset);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100763 efi_runtime_relocate(new_offset, map);
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200764 ret = EFI_SUCCESS;
765 goto out;
Alexander Graf0bd425a2016-03-04 01:10:01 +0100766 }
767 }
768
Heinrich Schuchardtc70a1612019-08-14 05:19:37 +0200769out:
770 return EFI_EXIT(ret);
Alexander Graf0bd425a2016-03-04 01:10:01 +0100771}
772
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200773/**
774 * efi_add_runtime_mmio() - add memory-mapped IO region
775 *
776 * This function adds a memory-mapped IO region to the memory map to make it
777 * available at runtime.
778 *
Heinrich Schuchardt7e307642018-12-23 02:35:13 +0100779 * @mmio_ptr: pointer to a pointer to the start of the memory-mapped
780 * IO region
Heinrich Schuchardt11121542018-09-03 19:29:41 +0200781 * @len: size of the memory-mapped IO region
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200782 * Returns: status code
783 */
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100784efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
Alexander Graf77256092016-08-16 21:08:45 +0200785{
786 struct efi_runtime_mmio_list *newmmio;
xypron.glpk@gmx.de93fcc7f2017-08-11 21:19:37 +0200787 u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
Alexander Graf33a83a32018-03-15 15:08:16 +0100788 uint64_t addr = *(uintptr_t *)mmio_ptr;
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100789 efi_status_t ret;
Alexander Graf33a83a32018-03-15 15:08:16 +0100790
Bryan O'Donoghue89a22b42019-07-15 12:00:39 +0100791 ret = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
792 if (ret != EFI_SUCCESS)
Alexander Graf33a83a32018-03-15 15:08:16 +0100793 return EFI_OUT_OF_RESOURCES;
Alexander Graf77256092016-08-16 21:08:45 +0200794
795 newmmio = calloc(1, sizeof(*newmmio));
Heinrich Schuchardt099b3b72018-03-03 15:28:59 +0100796 if (!newmmio)
797 return EFI_OUT_OF_RESOURCES;
Alexander Graf77256092016-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 Schuchardt099b3b72018-03-03 15:28:59 +0100802
Alexander Graf33a83a32018-03-15 15:08:16 +0100803 return EFI_SUCCESS;
Alexander Graf77256092016-08-16 21:08:45 +0200804}
805
Alexander Graf0bd425a2016-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 Graf393dd912016-10-14 13:45:30 +0200817 * __efi_runtime and __efi_runtime_data markers.
Alexander Graf0bd425a2016-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 Schuchardt711853b2018-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 Graf393dd912016-10-14 13:45:30 +0200835static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
Alexander Graf0bd425a2016-03-04 01:10:01 +0100836{
837 return EFI_UNSUPPORTED;
838}
839
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200840/**
Heinrich Schuchardt711853b2018-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 Schuchardt897c0722018-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 Schuchardt711853b2018-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 Schuchardt1d1be362018-09-03 20:59:25 +0200871 * @maximum_capsule_size: maximum capsule size
Heinrich Schuchardt711853b2018-07-29 15:10:11 +0200872 * @reset_type: type of reset needed for capsule update
873 * Returns: status code
874 */
Heinrich Schuchardt897c0722018-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 Takahirod840b672018-11-14 16:18:53 +0900878 u64 *maximum_capsule_size,
879 u32 *reset_type)
Heinrich Schuchardt897c0722018-02-09 20:41:21 +0100880{
881 return EFI_UNSUPPORTED;
882}
883
Alexander Graf393dd912016-10-14 13:45:30 +0200884struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
Alexander Graf0bd425a2016-03-04 01:10:01 +0100885 .hdr = {
886 .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
Heinrich Schuchardte75b3cb2018-06-28 12:45:27 +0200887 .revision = EFI_SPECIFICATION_VERSION,
Heinrich Schuchardt10204252018-06-28 12:45:29 +0200888 .headersize = sizeof(struct efi_runtime_services),
Alexander Graf0bd425a2016-03-04 01:10:01 +0100889 },
Alexander Graf77256092016-08-16 21:08:45 +0200890 .get_time = &efi_get_time_boottime,
Heinrich Schuchardt411b2d52019-05-19 20:07:39 +0200891 .set_time = &efi_set_time_boottime,
Alexander Graf0bd425a2016-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 Schuchardtc680dc42019-07-27 20:35:24 +0200895 .convert_pointer = efi_convert_pointer,
Rob Clark15f3d742017-09-13 18:05:37 -0400896 .get_variable = efi_get_variable,
Heinrich Schuchardtd6a6baa2018-05-17 07:57:05 +0200897 .get_next_variable_name = efi_get_next_variable_name,
Rob Clark15f3d742017-09-13 18:05:37 -0400898 .set_variable = efi_set_variable,
Heinrich Schuchardt5337a6c2019-06-20 15:40:49 +0200899 .get_next_high_mono_count = (void *)&efi_unimplemented,
Alexander Graf77256092016-08-16 21:08:45 +0200900 .reset_system = &efi_reset_system_boottime,
Heinrich Schuchardt897c0722018-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 Graf0bd425a2016-03-04 01:10:01 +0100904};