efi_loader.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. /*
  2. * EFI application loader
  3. *
  4. * Copyright (c) 2016 Alexander Graf
  5. *
  6. * SPDX-License-Identifier: GPL-2.0+
  7. */
  8. #ifndef _EFI_LOADER_H
  9. #define _EFI_LOADER_H 1
  10. #include <common.h>
  11. #include <part_efi.h>
  12. #include <efi_api.h>
  13. /* No need for efi loader support in SPL */
  14. #if defined(CONFIG_EFI_LOADER) && !defined(CONFIG_SPL_BUILD)
  15. #include <linux/list.h>
  16. int __efi_entry_check(void);
  17. int __efi_exit_check(void);
  18. const char *__efi_nesting(void);
  19. const char *__efi_nesting_inc(void);
  20. const char *__efi_nesting_dec(void);
  21. /*
  22. * Enter the u-boot world from UEFI:
  23. */
  24. #define EFI_ENTRY(format, ...) do { \
  25. assert(__efi_entry_check()); \
  26. debug("%sEFI: Entry %s(" format ")\n", __efi_nesting_inc(), \
  27. __func__, ##__VA_ARGS__); \
  28. } while(0)
  29. /*
  30. * Exit the u-boot world back to UEFI:
  31. */
  32. #define EFI_EXIT(ret) ({ \
  33. typeof(ret) _r = ret; \
  34. debug("%sEFI: Exit: %s: %u\n", __efi_nesting_dec(), \
  35. __func__, (u32)((uintptr_t) _r & ~EFI_ERROR_MASK)); \
  36. assert(__efi_exit_check()); \
  37. _r; \
  38. })
  39. /*
  40. * Call non-void UEFI function from u-boot and retrieve return value:
  41. */
  42. #define EFI_CALL(exp) ({ \
  43. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  44. assert(__efi_exit_check()); \
  45. typeof(exp) _r = exp; \
  46. assert(__efi_entry_check()); \
  47. debug("%sEFI: %lu returned by %s\n", __efi_nesting_dec(), \
  48. (unsigned long)((uintptr_t)_r & ~EFI_ERROR_MASK), #exp); \
  49. _r; \
  50. })
  51. /*
  52. * Call void UEFI function from u-boot:
  53. */
  54. #define EFI_CALL_VOID(exp) do { \
  55. debug("%sEFI: Call: %s\n", __efi_nesting_inc(), #exp); \
  56. assert(__efi_exit_check()); \
  57. exp; \
  58. assert(__efi_entry_check()); \
  59. debug("%sEFI: Return From: %s\n", __efi_nesting_dec(), #exp); \
  60. } while(0)
  61. /*
  62. * Write an indented message with EFI prefix
  63. */
  64. #define EFI_PRINT(format, ...) ({ \
  65. debug("%sEFI: " format, __efi_nesting(), \
  66. ##__VA_ARGS__); \
  67. })
  68. extern struct efi_runtime_services efi_runtime_services;
  69. extern struct efi_system_table systab;
  70. extern struct efi_simple_text_output_protocol efi_con_out;
  71. extern struct efi_simple_input_interface efi_con_in;
  72. extern struct efi_console_control_protocol efi_console_control;
  73. extern const struct efi_device_path_to_text_protocol efi_device_path_to_text;
  74. /* implementation of the EFI_DEVICE_PATH_UTILITIES_PROTOCOL */
  75. extern const struct efi_device_path_utilities_protocol
  76. efi_device_path_utilities;
  77. uint16_t *efi_dp_str(struct efi_device_path *dp);
  78. /* GUID of the EFI_BLOCK_IO_PROTOCOL */
  79. extern const efi_guid_t efi_block_io_guid;
  80. extern const efi_guid_t efi_global_variable_guid;
  81. extern const efi_guid_t efi_guid_console_control;
  82. extern const efi_guid_t efi_guid_device_path;
  83. /* GUID of the EFI_DRIVER_BINDING_PROTOCOL */
  84. extern const efi_guid_t efi_guid_driver_binding_protocol;
  85. /* event group ExitBootServices() invoked */
  86. extern const efi_guid_t efi_guid_event_group_exit_boot_services;
  87. /* event group SetVirtualAddressMap() invoked */
  88. extern const efi_guid_t efi_guid_event_group_virtual_address_change;
  89. /* event group memory map changed */
  90. extern const efi_guid_t efi_guid_event_group_memory_map_change;
  91. /* event group boot manager about to boot */
  92. extern const efi_guid_t efi_guid_event_group_ready_to_boot;
  93. /* event group ResetSystem() invoked (before ExitBootServices) */
  94. extern const efi_guid_t efi_guid_event_group_reset_system;
  95. /* GUID of the device tree table */
  96. extern const efi_guid_t efi_guid_fdt;
  97. extern const efi_guid_t efi_guid_loaded_image;
  98. extern const efi_guid_t efi_guid_device_path_to_text_protocol;
  99. extern const efi_guid_t efi_simple_file_system_protocol_guid;
  100. extern const efi_guid_t efi_file_info_guid;
  101. extern const efi_guid_t efi_guid_device_path_utilities_protocol;
  102. extern unsigned int __efi_runtime_start, __efi_runtime_stop;
  103. extern unsigned int __efi_runtime_rel_start, __efi_runtime_rel_stop;
  104. /*
  105. * When a protocol is opened a open protocol info entry is created.
  106. * These are maintained in a list.
  107. */
  108. struct efi_open_protocol_info_item {
  109. /* Link to the list of open protocol info entries of a protocol */
  110. struct list_head link;
  111. struct efi_open_protocol_info_entry info;
  112. };
  113. /*
  114. * When the UEFI payload wants to open a protocol on an object to get its
  115. * interface (usually a struct with callback functions), this struct maps the
  116. * protocol GUID to the respective protocol interface
  117. */
  118. struct efi_handler {
  119. /* Link to the list of protocols of a handle */
  120. struct list_head link;
  121. const efi_guid_t *guid;
  122. void *protocol_interface;
  123. /* Link to the list of open protocol info items */
  124. struct list_head open_infos;
  125. };
  126. /*
  127. * UEFI has a poor man's OO model where one "object" can be polymorphic and have
  128. * multiple different protocols (classes) attached to it.
  129. *
  130. * This struct is the parent struct for all of our actual implementation objects
  131. * that can include it to make themselves an EFI object
  132. */
  133. struct efi_object {
  134. /* Every UEFI object is part of a global object list */
  135. struct list_head link;
  136. /* The list of protocols */
  137. struct list_head protocols;
  138. /* The object spawner can either use this for data or as identifier */
  139. void *handle;
  140. };
  141. /**
  142. * struct efi_event
  143. *
  144. * @link: Link to list of all events
  145. * @type: Type of event, see efi_create_event
  146. * @notify_tpl: Task priority level of notifications
  147. * @nofify_function: Function to call when the event is triggered
  148. * @notify_context: Data to be passed to the notify function
  149. * @trigger_time: Period of the timer
  150. * @trigger_next: Next time to trigger the timer
  151. * @trigger_type: Type of timer, see efi_set_timer
  152. * @is_queued: The notification function is queued
  153. * @is_signaled: The event occurred. The event is in the signaled state.
  154. */
  155. struct efi_event {
  156. struct list_head link;
  157. uint32_t type;
  158. efi_uintn_t notify_tpl;
  159. void (EFIAPI *notify_function)(struct efi_event *event, void *context);
  160. void *notify_context;
  161. u64 trigger_next;
  162. u64 trigger_time;
  163. enum efi_timer_delay trigger_type;
  164. bool is_queued;
  165. bool is_signaled;
  166. };
  167. /* This list contains all UEFI objects we know of */
  168. extern struct list_head efi_obj_list;
  169. /* Called by bootefi to make console interface available */
  170. int efi_console_register(void);
  171. /* Called by bootefi to make all disk storage accessible as EFI objects */
  172. efi_status_t efi_disk_register(void);
  173. /* Create handles and protocols for the partitions of a block device */
  174. int efi_disk_create_partitions(efi_handle_t parent, struct blk_desc *desc,
  175. const char *if_typename, int diskid,
  176. const char *pdevname);
  177. /* Called by bootefi to make GOP (graphical) interface available */
  178. efi_status_t efi_gop_register(void);
  179. /* Called by bootefi to make the network interface available */
  180. efi_status_t efi_net_register(void);
  181. /* Called by bootefi to make the watchdog available */
  182. efi_status_t efi_watchdog_register(void);
  183. /* Called by bootefi to make SMBIOS tables available */
  184. efi_status_t efi_smbios_register(void);
  185. struct efi_simple_file_system_protocol *
  186. efi_fs_from_path(struct efi_device_path *fp);
  187. /* Called by networking code to memorize the dhcp ack package */
  188. void efi_net_set_dhcp_ack(void *pkt, int len);
  189. /* Called by efi_set_watchdog_timer to reset the timer */
  190. efi_status_t efi_set_watchdog(unsigned long timeout);
  191. /* Called from places to check whether a timer expired */
  192. void efi_timer_check(void);
  193. /* PE loader implementation */
  194. void *efi_load_pe(void *efi, struct efi_loaded_image *loaded_image_info);
  195. /* Called once to store the pristine gd pointer */
  196. void efi_save_gd(void);
  197. /* Special case handler for error/abort that just tries to dtrt to get
  198. * back to u-boot world */
  199. void efi_restore_gd(void);
  200. /* Call this to relocate the runtime section to an address space */
  201. void efi_runtime_relocate(ulong offset, struct efi_mem_desc *map);
  202. /* Call this to set the current device name */
  203. void efi_set_bootdev(const char *dev, const char *devnr, const char *path);
  204. /* Add a new object to the object list. */
  205. void efi_add_handle(struct efi_object *obj);
  206. /* Create handle */
  207. efi_status_t efi_create_handle(efi_handle_t *handle);
  208. /* Delete handle */
  209. void efi_delete_handle(struct efi_object *obj);
  210. /* Call this to validate a handle and find the EFI object for it */
  211. struct efi_object *efi_search_obj(const efi_handle_t handle);
  212. /* Find a protocol on a handle */
  213. efi_status_t efi_search_protocol(const efi_handle_t handle,
  214. const efi_guid_t *protocol_guid,
  215. struct efi_handler **handler);
  216. /* Install new protocol on a handle */
  217. efi_status_t efi_add_protocol(const efi_handle_t handle,
  218. const efi_guid_t *protocol,
  219. void *protocol_interface);
  220. /* Delete protocol from a handle */
  221. efi_status_t efi_remove_protocol(const efi_handle_t handle,
  222. const efi_guid_t *protocol,
  223. void *protocol_interface);
  224. /* Delete all protocols from a handle */
  225. efi_status_t efi_remove_all_protocols(const efi_handle_t handle);
  226. /* Call this to create an event */
  227. efi_status_t efi_create_event(uint32_t type, efi_uintn_t notify_tpl,
  228. void (EFIAPI *notify_function) (
  229. struct efi_event *event,
  230. void *context),
  231. void *notify_context, struct efi_event **event);
  232. /* Call this to set a timer */
  233. efi_status_t efi_set_timer(struct efi_event *event, enum efi_timer_delay type,
  234. uint64_t trigger_time);
  235. /* Call this to signal an event */
  236. void efi_signal_event(struct efi_event *event, bool check_tpl);
  237. /* open file system: */
  238. struct efi_simple_file_system_protocol *efi_simple_file_system(
  239. struct blk_desc *desc, int part, struct efi_device_path *dp);
  240. /* open file from device-path: */
  241. struct efi_file_handle *efi_file_from_path(struct efi_device_path *fp);
  242. /* Generic EFI memory allocator, call this to get memory */
  243. void *efi_alloc(uint64_t len, int memory_type);
  244. /* More specific EFI memory allocator, called by EFI payloads */
  245. efi_status_t efi_allocate_pages(int type, int memory_type, efi_uintn_t pages,
  246. uint64_t *memory);
  247. /* EFI memory free function. */
  248. efi_status_t efi_free_pages(uint64_t memory, efi_uintn_t pages);
  249. /* EFI memory allocator for small allocations */
  250. efi_status_t efi_allocate_pool(int pool_type, efi_uintn_t size,
  251. void **buffer);
  252. /* EFI pool memory free function. */
  253. efi_status_t efi_free_pool(void *buffer);
  254. /* Returns the EFI memory map */
  255. efi_status_t efi_get_memory_map(efi_uintn_t *memory_map_size,
  256. struct efi_mem_desc *memory_map,
  257. efi_uintn_t *map_key,
  258. efi_uintn_t *descriptor_size,
  259. uint32_t *descriptor_version);
  260. /* Adds a range into the EFI memory map */
  261. uint64_t efi_add_memory_map(uint64_t start, uint64_t pages, int memory_type,
  262. bool overlap_only_ram);
  263. /* Called by board init to initialize the EFI drivers */
  264. efi_status_t efi_driver_init(void);
  265. /* Called by board init to initialize the EFI memory map */
  266. int efi_memory_init(void);
  267. /* Adds new or overrides configuration table entry to the system table */
  268. efi_status_t efi_install_configuration_table(const efi_guid_t *guid, void *table);
  269. /* Sets up a loaded image */
  270. efi_status_t efi_setup_loaded_image(
  271. struct efi_loaded_image *info, struct efi_object *obj,
  272. struct efi_device_path *device_path,
  273. struct efi_device_path *file_path);
  274. efi_status_t efi_load_image_from_path(struct efi_device_path *file_path,
  275. void **buffer);
  276. #ifdef CONFIG_EFI_LOADER_BOUNCE_BUFFER
  277. extern void *efi_bounce_buffer;
  278. #define EFI_LOADER_BOUNCE_BUFFER_SIZE (64 * 1024 * 1024)
  279. #endif
  280. struct efi_device_path *efi_dp_next(const struct efi_device_path *dp);
  281. int efi_dp_match(const struct efi_device_path *a,
  282. const struct efi_device_path *b);
  283. struct efi_object *efi_dp_find_obj(struct efi_device_path *dp,
  284. struct efi_device_path **rem);
  285. unsigned efi_dp_size(const struct efi_device_path *dp);
  286. struct efi_device_path *efi_dp_dup(const struct efi_device_path *dp);
  287. struct efi_device_path *efi_dp_append(const struct efi_device_path *dp1,
  288. const struct efi_device_path *dp2);
  289. struct efi_device_path *efi_dp_append_node(const struct efi_device_path *dp,
  290. const struct efi_device_path *node);
  291. struct efi_device_path *efi_dp_from_dev(struct udevice *dev);
  292. struct efi_device_path *efi_dp_from_part(struct blk_desc *desc, int part);
  293. /* Create a device node for a block device partition. */
  294. struct efi_device_path *efi_dp_part_node(struct blk_desc *desc, int part);
  295. struct efi_device_path *efi_dp_from_file(struct blk_desc *desc, int part,
  296. const char *path);
  297. struct efi_device_path *efi_dp_from_eth(void);
  298. struct efi_device_path *efi_dp_from_mem(uint32_t mem_type,
  299. uint64_t start_address,
  300. uint64_t end_address);
  301. /* Determine the last device path node that is not the end node. */
  302. const struct efi_device_path *efi_dp_last_node(
  303. const struct efi_device_path *dp);
  304. efi_status_t efi_dp_split_file_path(struct efi_device_path *full_path,
  305. struct efi_device_path **device_path,
  306. struct efi_device_path **file_path);
  307. #define EFI_DP_TYPE(_dp, _type, _subtype) \
  308. (((_dp)->type == DEVICE_PATH_TYPE_##_type) && \
  309. ((_dp)->sub_type == DEVICE_PATH_SUB_TYPE_##_subtype))
  310. /* Convert strings from normal C strings to uEFI strings */
  311. static inline void ascii2unicode(u16 *unicode, const char *ascii)
  312. {
  313. while (*ascii)
  314. *(unicode++) = *(ascii++);
  315. }
  316. static inline int guidcmp(const efi_guid_t *g1, const efi_guid_t *g2)
  317. {
  318. return memcmp(g1, g2, sizeof(efi_guid_t));
  319. }
  320. /*
  321. * Use these to indicate that your code / data should go into the EFI runtime
  322. * section and thus still be available when the OS is running
  323. */
  324. #define __efi_runtime_data __attribute__ ((section ("efi_runtime_data")))
  325. #define __efi_runtime __attribute__ ((section ("efi_runtime_text")))
  326. /* Call this with mmio_ptr as the _pointer_ to a pointer to an MMIO region
  327. * to make it available at runtime */
  328. efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len);
  329. /* Boards may provide the functions below to implement RTS functionality */
  330. void __efi_runtime EFIAPI efi_reset_system(
  331. enum efi_reset_type reset_type,
  332. efi_status_t reset_status,
  333. unsigned long data_size, void *reset_data);
  334. /* Architecture specific initialization of the EFI subsystem */
  335. efi_status_t efi_reset_system_init(void);
  336. efi_status_t __efi_runtime EFIAPI efi_get_time(
  337. struct efi_time *time,
  338. struct efi_time_cap *capabilities);
  339. efi_status_t efi_get_time_init(void);
  340. #ifdef CONFIG_CMD_BOOTEFI_SELFTEST
  341. /*
  342. * Entry point for the tests of the EFI API.
  343. * It is called by 'bootefi selftest'
  344. */
  345. efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
  346. struct efi_system_table *systab);
  347. #endif
  348. efi_status_t EFIAPI efi_get_variable(s16 *variable_name,
  349. efi_guid_t *vendor, u32 *attributes,
  350. unsigned long *data_size, void *data);
  351. efi_status_t EFIAPI efi_get_next_variable(
  352. unsigned long *variable_name_size,
  353. s16 *variable_name, efi_guid_t *vendor);
  354. efi_status_t EFIAPI efi_set_variable(s16 *variable_name,
  355. efi_guid_t *vendor, u32 attributes,
  356. unsigned long data_size, void *data);
  357. void *efi_bootmgr_load(struct efi_device_path **device_path,
  358. struct efi_device_path **file_path);
  359. #else /* defined(EFI_LOADER) && !defined(CONFIG_SPL_BUILD) */
  360. /* Without CONFIG_EFI_LOADER we don't have a runtime section, stub it out */
  361. #define __efi_runtime_data
  362. #define __efi_runtime
  363. static inline efi_status_t efi_add_runtime_mmio(void *mmio_ptr, u64 len)
  364. {
  365. return EFI_SUCCESS;
  366. }
  367. /* No loader configured, stub out EFI_ENTRY */
  368. static inline void efi_restore_gd(void) { }
  369. static inline void efi_set_bootdev(const char *dev, const char *devnr,
  370. const char *path) { }
  371. static inline void efi_net_set_dhcp_ack(void *pkt, int len) { }
  372. #endif /* CONFIG_EFI_LOADER && !CONFIG_SPL_BUILD */
  373. #endif /* _EFI_LOADER_H */