efi_runtime.c 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * EFI application runtime services
  4. *
  5. * Copyright (c) 2016 Alexander Graf
  6. */
  7. #include <common.h>
  8. #include <command.h>
  9. #include <dm.h>
  10. #include <efi_loader.h>
  11. #include <rtc.h>
  12. #include <asm/global_data.h>
  13. /* For manual relocation support */
  14. DECLARE_GLOBAL_DATA_PTR;
  15. struct efi_runtime_mmio_list {
  16. struct list_head link;
  17. void **ptr;
  18. u64 paddr;
  19. u64 len;
  20. };
  21. /* This list contains all runtime available mmio regions */
  22. LIST_HEAD(efi_runtime_mmio);
  23. static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void);
  24. static efi_status_t __efi_runtime EFIAPI efi_device_error(void);
  25. static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void);
  26. #ifdef CONFIG_SYS_CACHELINE_SIZE
  27. #define EFI_CACHELINE_SIZE CONFIG_SYS_CACHELINE_SIZE
  28. #else
  29. /* Just use the greatest cache flush alignment requirement I'm aware of */
  30. #define EFI_CACHELINE_SIZE 128
  31. #endif
  32. #if defined(CONFIG_ARM64)
  33. #define R_RELATIVE 1027
  34. #define R_MASK 0xffffffffULL
  35. #define IS_RELA 1
  36. #elif defined(CONFIG_ARM)
  37. #define R_RELATIVE 23
  38. #define R_MASK 0xffULL
  39. #elif defined(CONFIG_X86)
  40. #include <asm/elf.h>
  41. #define R_RELATIVE R_386_RELATIVE
  42. #define R_MASK 0xffULL
  43. #else
  44. #error Need to add relocation awareness
  45. #endif
  46. struct elf_rel {
  47. ulong *offset;
  48. ulong info;
  49. };
  50. struct elf_rela {
  51. ulong *offset;
  52. ulong info;
  53. long addend;
  54. };
  55. /*
  56. * EFI Runtime code lives in 2 stages. In the first stage, U-Boot and an EFI
  57. * payload are running concurrently at the same time. In this mode, we can
  58. * handle a good number of runtime callbacks
  59. */
  60. static void EFIAPI efi_reset_system_boottime(
  61. enum efi_reset_type reset_type,
  62. efi_status_t reset_status,
  63. unsigned long data_size, void *reset_data)
  64. {
  65. struct efi_event *evt;
  66. EFI_ENTRY("%d %lx %lx %p", reset_type, reset_status, data_size,
  67. reset_data);
  68. /* Notify reset */
  69. list_for_each_entry(evt, &efi_events, link) {
  70. if (evt->group &&
  71. !guidcmp(evt->group,
  72. &efi_guid_event_group_reset_system)) {
  73. efi_signal_event(evt, false);
  74. break;
  75. }
  76. }
  77. switch (reset_type) {
  78. case EFI_RESET_COLD:
  79. case EFI_RESET_WARM:
  80. case EFI_RESET_PLATFORM_SPECIFIC:
  81. do_reset(NULL, 0, 0, NULL);
  82. break;
  83. case EFI_RESET_SHUTDOWN:
  84. /* We don't have anything to map this to */
  85. break;
  86. }
  87. while (1) { }
  88. }
  89. static efi_status_t EFIAPI efi_get_time_boottime(
  90. struct efi_time *time,
  91. struct efi_time_cap *capabilities)
  92. {
  93. #if defined(CONFIG_CMD_DATE) && defined(CONFIG_DM_RTC)
  94. struct rtc_time tm;
  95. int r;
  96. struct udevice *dev;
  97. EFI_ENTRY("%p %p", time, capabilities);
  98. r = uclass_get_device(UCLASS_RTC, 0, &dev);
  99. if (r)
  100. return EFI_EXIT(EFI_DEVICE_ERROR);
  101. r = dm_rtc_get(dev, &tm);
  102. if (r)
  103. return EFI_EXIT(EFI_DEVICE_ERROR);
  104. memset(time, 0, sizeof(*time));
  105. time->year = tm.tm_year;
  106. time->month = tm.tm_mon;
  107. time->day = tm.tm_mday;
  108. time->hour = tm.tm_hour;
  109. time->minute = tm.tm_min;
  110. time->daylight = tm.tm_isdst;
  111. return EFI_EXIT(EFI_SUCCESS);
  112. #else
  113. return EFI_DEVICE_ERROR;
  114. #endif
  115. }
  116. /* Boards may override the helpers below to implement RTS functionality */
  117. void __weak __efi_runtime EFIAPI efi_reset_system(
  118. enum efi_reset_type reset_type,
  119. efi_status_t reset_status,
  120. unsigned long data_size, void *reset_data)
  121. {
  122. /* Nothing we can do */
  123. while (1) { }
  124. }
  125. efi_status_t __weak efi_reset_system_init(void)
  126. {
  127. return EFI_SUCCESS;
  128. }
  129. efi_status_t __weak __efi_runtime EFIAPI efi_get_time(
  130. struct efi_time *time,
  131. struct efi_time_cap *capabilities)
  132. {
  133. /* Nothing we can do */
  134. return EFI_DEVICE_ERROR;
  135. }
  136. efi_status_t __weak efi_get_time_init(void)
  137. {
  138. return EFI_SUCCESS;
  139. }
  140. struct efi_runtime_detach_list_struct {
  141. void *ptr;
  142. void *patchto;
  143. };
  144. static const struct efi_runtime_detach_list_struct efi_runtime_detach_list[] = {
  145. {
  146. /* do_reset is gone */
  147. .ptr = &efi_runtime_services.reset_system,
  148. .patchto = efi_reset_system,
  149. }, {
  150. /* invalidate_*cache_all are gone */
  151. .ptr = &efi_runtime_services.set_virtual_address_map,
  152. .patchto = &efi_invalid_parameter,
  153. }, {
  154. /* RTC accessors are gone */
  155. .ptr = &efi_runtime_services.get_time,
  156. .patchto = &efi_get_time,
  157. }, {
  158. /* Clean up system table */
  159. .ptr = &systab.con_in,
  160. .patchto = NULL,
  161. }, {
  162. /* Clean up system table */
  163. .ptr = &systab.con_out,
  164. .patchto = NULL,
  165. }, {
  166. /* Clean up system table */
  167. .ptr = &systab.std_err,
  168. .patchto = NULL,
  169. }, {
  170. /* Clean up system table */
  171. .ptr = &systab.boottime,
  172. .patchto = NULL,
  173. }, {
  174. .ptr = &efi_runtime_services.get_variable,
  175. .patchto = &efi_device_error,
  176. }, {
  177. .ptr = &efi_runtime_services.get_next_variable,
  178. .patchto = &efi_device_error,
  179. }, {
  180. .ptr = &efi_runtime_services.set_variable,
  181. .patchto = &efi_device_error,
  182. }
  183. };
  184. static bool efi_runtime_tobedetached(void *p)
  185. {
  186. int i;
  187. for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++)
  188. if (efi_runtime_detach_list[i].ptr == p)
  189. return true;
  190. return false;
  191. }
  192. static void efi_runtime_detach(ulong offset)
  193. {
  194. int i;
  195. ulong patchoff = offset - (ulong)gd->relocaddr;
  196. for (i = 0; i < ARRAY_SIZE(efi_runtime_detach_list); i++) {
  197. ulong patchto = (ulong)efi_runtime_detach_list[i].patchto;
  198. ulong *p = efi_runtime_detach_list[i].ptr;
  199. ulong newaddr = patchto ? (patchto + patchoff) : 0;
  200. debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
  201. *p = newaddr;
  202. }
  203. }
  204. /* Relocate EFI runtime to uboot_reloc_base = offset */
  205. void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map)
  206. {
  207. #ifdef IS_RELA
  208. struct elf_rela *rel = (void*)&__efi_runtime_rel_start;
  209. #else
  210. struct elf_rel *rel = (void*)&__efi_runtime_rel_start;
  211. static ulong lastoff = CONFIG_SYS_TEXT_BASE;
  212. #endif
  213. debug("%s: Relocating to offset=%lx\n", __func__, offset);
  214. for (; (ulong)rel < (ulong)&__efi_runtime_rel_stop; rel++) {
  215. ulong base = CONFIG_SYS_TEXT_BASE;
  216. ulong *p;
  217. ulong newaddr;
  218. p = (void*)((ulong)rel->offset - base) + gd->relocaddr;
  219. if ((rel->info & R_MASK) != R_RELATIVE) {
  220. continue;
  221. }
  222. #ifdef IS_RELA
  223. newaddr = rel->addend + offset - CONFIG_SYS_TEXT_BASE;
  224. #else
  225. newaddr = *p - lastoff + offset;
  226. #endif
  227. /* Check if the relocation is inside bounds */
  228. if (map && ((newaddr < map->virtual_start) ||
  229. newaddr > (map->virtual_start +
  230. (map->num_pages << EFI_PAGE_SHIFT)))) {
  231. if (!efi_runtime_tobedetached(p))
  232. printf("U-Boot EFI: Relocation at %p is out of "
  233. "range (%lx)\n", p, newaddr);
  234. continue;
  235. }
  236. debug("%s: Setting %p to %lx\n", __func__, p, newaddr);
  237. *p = newaddr;
  238. flush_dcache_range((ulong)p & ~(EFI_CACHELINE_SIZE - 1),
  239. ALIGN((ulong)&p[1], EFI_CACHELINE_SIZE));
  240. }
  241. #ifndef IS_RELA
  242. lastoff = offset;
  243. #endif
  244. invalidate_icache_all();
  245. }
  246. static efi_status_t EFIAPI efi_set_virtual_address_map(
  247. unsigned long memory_map_size,
  248. unsigned long descriptor_size,
  249. uint32_t descriptor_version,
  250. struct efi_mem_desc *virtmap)
  251. {
  252. ulong runtime_start = (ulong)&__efi_runtime_start &
  253. ~(ulong)EFI_PAGE_MASK;
  254. int n = memory_map_size / descriptor_size;
  255. int i;
  256. EFI_ENTRY("%lx %lx %x %p", memory_map_size, descriptor_size,
  257. descriptor_version, virtmap);
  258. /* Rebind mmio pointers */
  259. for (i = 0; i < n; i++) {
  260. struct efi_mem_desc *map = (void*)virtmap +
  261. (descriptor_size * i);
  262. struct list_head *lhandle;
  263. efi_physical_addr_t map_start = map->physical_start;
  264. efi_physical_addr_t map_len = map->num_pages << EFI_PAGE_SHIFT;
  265. efi_physical_addr_t map_end = map_start + map_len;
  266. /* Adjust all mmio pointers in this region */
  267. list_for_each(lhandle, &efi_runtime_mmio) {
  268. struct efi_runtime_mmio_list *lmmio;
  269. lmmio = list_entry(lhandle,
  270. struct efi_runtime_mmio_list,
  271. link);
  272. if ((map_start <= lmmio->paddr) &&
  273. (map_end >= lmmio->paddr)) {
  274. u64 off = map->virtual_start - map_start;
  275. uintptr_t new_addr = lmmio->paddr + off;
  276. *lmmio->ptr = (void *)new_addr;
  277. }
  278. }
  279. }
  280. /* Move the actual runtime code over */
  281. for (i = 0; i < n; i++) {
  282. struct efi_mem_desc *map;
  283. map = (void*)virtmap + (descriptor_size * i);
  284. if (map->type == EFI_RUNTIME_SERVICES_CODE) {
  285. ulong new_offset = map->virtual_start -
  286. (runtime_start - gd->relocaddr);
  287. efi_runtime_relocate(new_offset, map);
  288. /* Once we're virtual, we can no longer handle
  289. complex callbacks */
  290. efi_runtime_detach(new_offset);
  291. return EFI_EXIT(EFI_SUCCESS);
  292. }
  293. }
  294. return EFI_EXIT(EFI_INVALID_PARAMETER);
  295. }
  296. efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
  297. {
  298. struct efi_runtime_mmio_list *newmmio;
  299. u64 pages = (len + EFI_PAGE_MASK) >> EFI_PAGE_SHIFT;
  300. uint64_t addr = *(uintptr_t *)mmio_ptr;
  301. uint64_t retaddr;
  302. retaddr = efi_add_memory_map(addr, pages, EFI_MMAP_IO, false);
  303. if (retaddr != addr)
  304. return EFI_OUT_OF_RESOURCES;
  305. newmmio = calloc(1, sizeof(*newmmio));
  306. if (!newmmio)
  307. return EFI_OUT_OF_RESOURCES;
  308. newmmio->ptr = mmio_ptr;
  309. newmmio->paddr = *(uintptr_t *)mmio_ptr;
  310. newmmio->len = len;
  311. list_add_tail(&newmmio->link, &efi_runtime_mmio);
  312. return EFI_SUCCESS;
  313. }
  314. /*
  315. * In the second stage, U-Boot has disappeared. To isolate our runtime code
  316. * that at this point still exists from the rest, we put it into a special
  317. * section.
  318. *
  319. * !!WARNING!!
  320. *
  321. * This means that we can not rely on any code outside of this file in any
  322. * function or variable below this line.
  323. *
  324. * Please keep everything fully self-contained and annotated with
  325. * __efi_runtime and __efi_runtime_data markers.
  326. */
  327. /*
  328. * Relocate the EFI runtime stub to a different place. We need to call this
  329. * the first time we expose the runtime interface to a user and on set virtual
  330. * address map calls.
  331. */
  332. static efi_status_t __efi_runtime EFIAPI efi_unimplemented(void)
  333. {
  334. return EFI_UNSUPPORTED;
  335. }
  336. static efi_status_t __efi_runtime EFIAPI efi_device_error(void)
  337. {
  338. return EFI_DEVICE_ERROR;
  339. }
  340. static efi_status_t __efi_runtime EFIAPI efi_invalid_parameter(void)
  341. {
  342. return EFI_INVALID_PARAMETER;
  343. }
  344. efi_status_t __efi_runtime EFIAPI efi_update_capsule(
  345. struct efi_capsule_header **capsule_header_array,
  346. efi_uintn_t capsule_count,
  347. u64 scatter_gather_list)
  348. {
  349. return EFI_UNSUPPORTED;
  350. }
  351. efi_status_t __efi_runtime EFIAPI efi_query_capsule_caps(
  352. struct efi_capsule_header **capsule_header_array,
  353. efi_uintn_t capsule_count,
  354. u64 maximum_capsule_size,
  355. u32 reset_type)
  356. {
  357. return EFI_UNSUPPORTED;
  358. }
  359. efi_status_t __efi_runtime EFIAPI efi_query_variable_info(
  360. u32 attributes,
  361. u64 maximum_variable_storage_size,
  362. u64 remaining_variable_storage_size,
  363. u64 maximum_variable_size)
  364. {
  365. return EFI_UNSUPPORTED;
  366. }
  367. struct efi_runtime_services __efi_runtime_data efi_runtime_services = {
  368. .hdr = {
  369. .signature = EFI_RUNTIME_SERVICES_SIGNATURE,
  370. .revision = EFI_RUNTIME_SERVICES_REVISION,
  371. .headersize = sizeof(struct efi_table_hdr),
  372. },
  373. .get_time = &efi_get_time_boottime,
  374. .set_time = (void *)&efi_device_error,
  375. .get_wakeup_time = (void *)&efi_unimplemented,
  376. .set_wakeup_time = (void *)&efi_unimplemented,
  377. .set_virtual_address_map = &efi_set_virtual_address_map,
  378. .convert_pointer = (void *)&efi_invalid_parameter,
  379. .get_variable = efi_get_variable,
  380. .get_next_variable = efi_get_next_variable,
  381. .set_variable = efi_set_variable,
  382. .get_next_high_mono_count = (void *)&efi_device_error,
  383. .reset_system = &efi_reset_system_boottime,
  384. .update_capsule = efi_update_capsule,
  385. .query_capsule_caps = efi_query_capsule_caps,
  386. .query_variable_info = efi_query_variable_info,
  387. };