1 /* SPDX-License-Identifier: GPL-2.0 */
3 #ifndef _DRIVERS_FIRMWARE_EFI_EFISTUB_H
4 #define _DRIVERS_FIRMWARE_EFI_EFISTUB_H
6 #include <linux/compiler.h>
8 #include <linux/kernel.h>
9 #include <linux/kern_levels.h>
10 #include <linux/types.h>
14 * __init annotations should not be used in the EFI stub, since the code is
15 * either included in the decompressor (x86, ARM) where they have no effect,
16 * or the whole stub is __init annotated at the section level (arm64), by
17 * renaming the sections, in which case the __init annotation will be
18 * redundant, and will result in section names like .init.init.text, and our
19 * linker script does not expect that.
24 * Allow the platform to override the allocation granularity: this allows
25 * systems that have the capability to run with a larger page size to deal
26 * with the allocations for initrd and fdt more efficiently.
28 #ifndef EFI_ALLOC_ALIGN
29 #define EFI_ALLOC_ALIGN EFI_PAGE_SIZE
32 #ifndef EFI_ALLOC_LIMIT
33 #define EFI_ALLOC_LIMIT ULONG_MAX
36 extern bool efi_no5lvl;
37 extern bool efi_nochunk;
38 extern bool efi_nokaslr;
39 extern int efi_loglevel;
40 extern bool efi_novamap;
42 extern const efi_system_table_t *efi_system_table;
44 typedef union efi_dxe_services_table efi_dxe_services_table_t;
45 extern const efi_dxe_services_table_t *efi_dxe_table;
47 efi_status_t __efiapi efi_pe_entry(efi_handle_t handle,
48 efi_system_table_t *sys_table_arg);
50 #ifndef ARCH_HAS_EFISTUB_WRAPPERS
52 #define efi_is_native() (true)
53 #define efi_table_attr(inst, attr) (inst)->attr
54 #define efi_fn_call(inst, func, ...) (inst)->func(__VA_ARGS__)
58 #define efi_call_proto(inst, func, ...) ({ \
59 __typeof__(inst) __inst = (inst); \
60 efi_fn_call(__inst, func, __inst, ##__VA_ARGS__); \
62 #define efi_bs_call(func, ...) \
63 efi_fn_call(efi_table_attr(efi_system_table, boottime), func, ##__VA_ARGS__)
64 #define efi_rt_call(func, ...) \
65 efi_fn_call(efi_table_attr(efi_system_table, runtime), func, ##__VA_ARGS__)
66 #define efi_dxe_call(func, ...) \
67 efi_fn_call(efi_dxe_table, func, ##__VA_ARGS__)
69 #define efi_info(fmt, ...) \
70 efi_printk(KERN_INFO fmt, ##__VA_ARGS__)
71 #define efi_warn(fmt, ...) \
72 efi_printk(KERN_WARNING "WARNING: " fmt, ##__VA_ARGS__)
73 #define efi_err(fmt, ...) \
74 efi_printk(KERN_ERR "ERROR: " fmt, ##__VA_ARGS__)
75 #define efi_debug(fmt, ...) \
76 efi_printk(KERN_DEBUG "DEBUG: " fmt, ##__VA_ARGS__)
78 #define efi_printk_once(fmt, ...) \
80 static bool __print_once; \
81 bool __ret_print_once = !__print_once; \
83 if (!__print_once) { \
84 __print_once = true; \
85 efi_printk(fmt, ##__VA_ARGS__); \
90 #define efi_info_once(fmt, ...) \
91 efi_printk_once(KERN_INFO fmt, ##__VA_ARGS__)
92 #define efi_warn_once(fmt, ...) \
93 efi_printk_once(KERN_WARNING "WARNING: " fmt, ##__VA_ARGS__)
94 #define efi_err_once(fmt, ...) \
95 efi_printk_once(KERN_ERR "ERROR: " fmt, ##__VA_ARGS__)
96 #define efi_debug_once(fmt, ...) \
97 efi_printk_once(KERN_DEBUG "DEBUG: " fmt, ##__VA_ARGS__)
99 /* Helper macros for the usual case of using simple C variables: */
100 #ifndef fdt_setprop_inplace_var
101 #define fdt_setprop_inplace_var(fdt, node_offset, name, var) \
102 fdt_setprop_inplace((fdt), (node_offset), (name), &(var), sizeof(var))
105 #ifndef fdt_setprop_var
106 #define fdt_setprop_var(fdt, node_offset, name, var) \
107 fdt_setprop((fdt), (node_offset), (name), &(var), sizeof(var))
110 #define get_efi_var(name, vendor, ...) \
111 efi_rt_call(get_variable, (efi_char16_t *)(name), \
112 (efi_guid_t *)(vendor), __VA_ARGS__)
114 #define set_efi_var(name, vendor, ...) \
115 efi_rt_call(set_variable, (efi_char16_t *)(name), \
116 (efi_guid_t *)(vendor), __VA_ARGS__)
118 #define efi_get_handle_at(array, idx) \
119 (efi_is_native() ? (array)[idx] \
120 : (efi_handle_t)(unsigned long)((u32 *)(array))[idx])
122 #define efi_get_handle_num(size) \
123 ((size) / (efi_is_native() ? sizeof(efi_handle_t) : sizeof(u32)))
125 #define for_each_efi_handle(handle, array, size, i) \
127 i < efi_get_handle_num(size) && \
128 ((handle = efi_get_handle_at((array), i)) || true); \
132 void efi_set_u64_split(u64 data, u32 *lo, u32 *hi)
134 *lo = lower_32_bits(data);
135 *hi = upper_32_bits(data);
139 * Allocation types for calls to boottime->allocate_pages.
141 #define EFI_ALLOCATE_ANY_PAGES 0
142 #define EFI_ALLOCATE_MAX_ADDRESS 1
143 #define EFI_ALLOCATE_ADDRESS 2
144 #define EFI_MAX_ALLOCATE_TYPE 3
147 * The type of search to perform when calling boottime->locate_handle
149 #define EFI_LOCATE_ALL_HANDLES 0
150 #define EFI_LOCATE_BY_REGISTER_NOTIFY 1
151 #define EFI_LOCATE_BY_PROTOCOL 2
154 * boottime->stall takes the time period in microseconds
156 #define EFI_USEC_PER_SEC 1000000
159 * boottime->set_timer takes the time in 100ns units
161 #define EFI_100NSEC_PER_USEC ((u64)10)
164 * An efi_boot_memmap is used by efi_get_memory_map() to return the
165 * EFI memory map in a dynamically allocated buffer.
167 * The buffer allocated for the EFI memory map includes extra room for
168 * a minimum of EFI_MMAP_NR_SLACK_SLOTS additional EFI memory descriptors.
169 * This facilitates the reuse of the EFI memory map buffer when a second
170 * call to ExitBootServices() is needed because of intervening changes to
171 * the EFI memory map. Other related structures, e.g. x86 e820ext, need
172 * to factor in this headroom requirement as well.
174 #define EFI_MMAP_NR_SLACK_SLOTS 8
176 typedef struct efi_generic_dev_path efi_device_path_protocol_t;
178 union efi_device_path_to_text_protocol {
180 efi_char16_t *(__efiapi *convert_device_node_to_text)(
181 const efi_device_path_protocol_t *,
183 efi_char16_t *(__efiapi *convert_device_path_to_text)(
184 const efi_device_path_protocol_t *,
188 u32 convert_device_node_to_text;
189 u32 convert_device_path_to_text;
193 typedef union efi_device_path_to_text_protocol efi_device_path_to_text_protocol_t;
195 union efi_device_path_from_text_protocol {
197 efi_device_path_protocol_t *
198 (__efiapi *convert_text_to_device_node)(const efi_char16_t *);
199 efi_device_path_protocol_t *
200 (__efiapi *convert_text_to_device_path)(const efi_char16_t *);
203 u32 convert_text_to_device_node;
204 u32 convert_text_to_device_path;
208 typedef union efi_device_path_from_text_protocol efi_device_path_from_text_protocol_t;
210 typedef void *efi_event_t;
211 /* Note that notifications won't work in mixed mode */
212 typedef void (__efiapi *efi_event_notify_t)(efi_event_t, void *);
214 #define EFI_EVT_TIMER 0x80000000U
215 #define EFI_EVT_RUNTIME 0x40000000U
216 #define EFI_EVT_NOTIFY_WAIT 0x00000100U
217 #define EFI_EVT_NOTIFY_SIGNAL 0x00000200U
220 * efi_set_event_at() - add event to events array
222 * @events: array of UEFI events
223 * @ids: index where to put the event in the array
224 * @event: event to add to the aray
226 * boottime->wait_for_event() takes an array of events as input.
227 * Provide a helper to set it up correctly for mixed mode.
230 void efi_set_event_at(efi_event_t *events, size_t idx, efi_event_t event)
235 ((u32 *)events)[idx] = (u32)(unsigned long)event;
238 #define EFI_TPL_APPLICATION 4
239 #define EFI_TPL_CALLBACK 8
240 #define EFI_TPL_NOTIFY 16
241 #define EFI_TPL_HIGH_LEVEL 31
250 * EFI Boot Services table
252 union efi_boot_services {
257 efi_status_t (__efiapi *allocate_pages)(int, int, unsigned long,
258 efi_physical_addr_t *);
259 efi_status_t (__efiapi *free_pages)(efi_physical_addr_t,
261 efi_status_t (__efiapi *get_memory_map)(unsigned long *, void *,
263 unsigned long *, u32 *);
264 efi_status_t (__efiapi *allocate_pool)(int, unsigned long,
266 efi_status_t (__efiapi *free_pool)(void *);
267 efi_status_t (__efiapi *create_event)(u32, unsigned long,
268 efi_event_notify_t, void *,
270 efi_status_t (__efiapi *set_timer)(efi_event_t,
271 EFI_TIMER_DELAY, u64);
272 efi_status_t (__efiapi *wait_for_event)(unsigned long,
276 efi_status_t (__efiapi *close_event)(efi_event_t);
278 void *install_protocol_interface;
279 void *reinstall_protocol_interface;
280 void *uninstall_protocol_interface;
281 efi_status_t (__efiapi *handle_protocol)(efi_handle_t,
282 efi_guid_t *, void **);
284 void *register_protocol_notify;
285 efi_status_t (__efiapi *locate_handle)(int, efi_guid_t *,
286 void *, unsigned long *,
288 efi_status_t (__efiapi *locate_device_path)(efi_guid_t *,
289 efi_device_path_protocol_t **,
291 efi_status_t (__efiapi *install_configuration_table)(efi_guid_t *,
293 efi_status_t (__efiapi *load_image)(bool, efi_handle_t,
294 efi_device_path_protocol_t *,
295 void *, unsigned long,
297 efi_status_t (__efiapi *start_image)(efi_handle_t, unsigned long *,
299 efi_status_t __noreturn (__efiapi *exit)(efi_handle_t,
303 efi_status_t (__efiapi *unload_image)(efi_handle_t);
304 efi_status_t (__efiapi *exit_boot_services)(efi_handle_t,
306 void *get_next_monotonic_count;
307 efi_status_t (__efiapi *stall)(unsigned long);
308 void *set_watchdog_timer;
309 void *connect_controller;
310 efi_status_t (__efiapi *disconnect_controller)(efi_handle_t,
314 void *close_protocol;
315 void *open_protocol_information;
316 void *protocols_per_handle;
317 void *locate_handle_buffer;
318 efi_status_t (__efiapi *locate_protocol)(efi_guid_t *, void *,
320 efi_status_t (__efiapi *install_multiple_protocol_interfaces)(efi_handle_t *, ...);
321 efi_status_t (__efiapi *uninstall_multiple_protocol_interfaces)(efi_handle_t, ...);
322 void *calculate_crc32;
323 void (__efiapi *copy_mem)(void *, const void *, unsigned long);
324 void (__efiapi *set_mem)(void *, unsigned long, unsigned char);
325 void *create_event_ex;
342 u32 install_protocol_interface;
343 u32 reinstall_protocol_interface;
344 u32 uninstall_protocol_interface;
347 u32 register_protocol_notify;
349 u32 locate_device_path;
350 u32 install_configuration_table;
355 u32 exit_boot_services;
356 u32 get_next_monotonic_count;
358 u32 set_watchdog_timer;
359 u32 connect_controller;
360 u32 disconnect_controller;
363 u32 open_protocol_information;
364 u32 protocols_per_handle;
365 u32 locate_handle_buffer;
367 u32 install_multiple_protocol_interfaces;
368 u32 uninstall_multiple_protocol_interfaces;
377 EfiGcdMemoryTypeNonExistent,
378 EfiGcdMemoryTypeReserved,
379 EfiGcdMemoryTypeSystemMemory,
380 EfiGcdMemoryTypeMemoryMappedIo,
381 EfiGcdMemoryTypePersistent,
382 EfiGcdMemoryTypeMoreReliable,
383 EfiGcdMemoryTypeMaximum
384 } efi_gcd_memory_type_t;
387 efi_physical_addr_t base_address;
391 efi_gcd_memory_type_t gcd_memory_type;
394 } efi_gcd_memory_space_desc_t;
397 * EFI DXE Services table
399 union efi_dxe_services_table {
402 void *add_memory_space;
403 void *allocate_memory_space;
404 void *free_memory_space;
405 void *remove_memory_space;
406 efi_status_t (__efiapi *get_memory_space_descriptor)(efi_physical_addr_t,
407 efi_gcd_memory_space_desc_t *);
408 efi_status_t (__efiapi *set_memory_space_attributes)(efi_physical_addr_t,
410 void *get_memory_space_map;
412 void *allocate_io_space;
414 void *remove_io_space;
415 void *get_io_space_descriptor;
416 void *get_io_space_map;
420 void *process_firmware_volume;
421 void *set_memory_space_capabilities;
425 u32 add_memory_space;
426 u32 allocate_memory_space;
427 u32 free_memory_space;
428 u32 remove_memory_space;
429 u32 get_memory_space_descriptor;
430 u32 set_memory_space_attributes;
431 u32 get_memory_space_map;
433 u32 allocate_io_space;
436 u32 get_io_space_descriptor;
437 u32 get_io_space_map;
441 u32 process_firmware_volume;
442 u32 set_memory_space_capabilities;
446 typedef union efi_memory_attribute_protocol efi_memory_attribute_protocol_t;
448 union efi_memory_attribute_protocol {
450 efi_status_t (__efiapi *get_memory_attributes)(
451 efi_memory_attribute_protocol_t *, efi_physical_addr_t, u64, u64 *);
453 efi_status_t (__efiapi *set_memory_attributes)(
454 efi_memory_attribute_protocol_t *, efi_physical_addr_t, u64, u64);
456 efi_status_t (__efiapi *clear_memory_attributes)(
457 efi_memory_attribute_protocol_t *, efi_physical_addr_t, u64, u64);
460 u32 get_memory_attributes;
461 u32 set_memory_attributes;
462 u32 clear_memory_attributes;
466 typedef union efi_uga_draw_protocol efi_uga_draw_protocol_t;
468 union efi_uga_draw_protocol {
470 efi_status_t (__efiapi *get_mode)(efi_uga_draw_protocol_t *,
471 u32*, u32*, u32*, u32*);
484 efi_char16_t unicode_char;
487 union efi_simple_text_input_protocol {
490 efi_status_t (__efiapi *read_keystroke)(efi_simple_text_input_protocol_t *,
492 efi_event_t wait_for_key;
501 efi_status_t efi_wait_for_key(unsigned long usec, efi_input_key_t *key);
503 union efi_simple_text_output_protocol {
506 efi_status_t (__efiapi *output_string)(efi_simple_text_output_protocol_t *,
517 #define PIXEL_RGB_RESERVED_8BIT_PER_COLOR 0
518 #define PIXEL_BGR_RESERVED_8BIT_PER_COLOR 1
519 #define PIXEL_BIT_MASK 2
520 #define PIXEL_BLT_ONLY 3
521 #define PIXEL_FORMAT_MAX 4
528 } efi_pixel_bitmask_t;
532 u32 horizontal_resolution;
533 u32 vertical_resolution;
535 efi_pixel_bitmask_t pixel_information;
536 u32 pixels_per_scan_line;
537 } efi_graphics_output_mode_info_t;
539 typedef union efi_graphics_output_protocol_mode efi_graphics_output_protocol_mode_t;
541 union efi_graphics_output_protocol_mode {
545 efi_graphics_output_mode_info_t *info;
546 unsigned long size_of_info;
547 efi_physical_addr_t frame_buffer_base;
548 unsigned long frame_buffer_size;
555 u64 frame_buffer_base;
556 u32 frame_buffer_size;
560 typedef union efi_graphics_output_protocol efi_graphics_output_protocol_t;
562 union efi_graphics_output_protocol {
564 efi_status_t (__efiapi *query_mode)(efi_graphics_output_protocol_t *,
565 u32, unsigned long *,
566 efi_graphics_output_mode_info_t **);
567 efi_status_t (__efiapi *set_mode) (efi_graphics_output_protocol_t *, u32);
569 efi_graphics_output_protocol_mode_t *mode;
582 efi_handle_t parent_handle;
583 efi_system_table_t *system_table;
584 efi_handle_t device_handle;
587 u32 load_options_size;
590 __aligned_u64 image_size;
591 unsigned int image_code_type;
592 unsigned int image_data_type;
593 efi_status_t (__efiapi *unload)(efi_handle_t image_handle);
602 u32 load_options_size;
605 __aligned_u64 image_size;
610 } efi_loaded_image_t;
616 efi_time_t create_time;
617 efi_time_t last_access_time;
618 efi_time_t modification_time;
619 __aligned_u64 attribute;
620 efi_char16_t filename[];
623 typedef union efi_file_protocol efi_file_protocol_t;
625 union efi_file_protocol {
628 efi_status_t (__efiapi *open) (efi_file_protocol_t *,
629 efi_file_protocol_t **,
632 efi_status_t (__efiapi *close) (efi_file_protocol_t *);
633 efi_status_t (__efiapi *delete) (efi_file_protocol_t *);
634 efi_status_t (__efiapi *read) (efi_file_protocol_t *,
637 efi_status_t (__efiapi *write) (efi_file_protocol_t *,
638 unsigned long, void *);
639 efi_status_t (__efiapi *get_position)(efi_file_protocol_t *,
641 efi_status_t (__efiapi *set_position)(efi_file_protocol_t *,
643 efi_status_t (__efiapi *get_info) (efi_file_protocol_t *,
647 efi_status_t (__efiapi *set_info) (efi_file_protocol_t *,
651 efi_status_t (__efiapi *flush) (efi_file_protocol_t *);
668 typedef union efi_simple_file_system_protocol efi_simple_file_system_protocol_t;
670 union efi_simple_file_system_protocol {
673 efi_status_t (__efiapi *open_volume)(efi_simple_file_system_protocol_t *,
674 efi_file_protocol_t **);
682 #define EFI_FILE_MODE_READ 0x0000000000000001
683 #define EFI_FILE_MODE_WRITE 0x0000000000000002
684 #define EFI_FILE_MODE_CREATE 0x8000000000000000
691 EfiPciIoWidthFifoUint8,
692 EfiPciIoWidthFifoUint16,
693 EfiPciIoWidthFifoUint32,
694 EfiPciIoWidthFifoUint64,
695 EfiPciIoWidthFillUint8,
696 EfiPciIoWidthFillUint16,
697 EfiPciIoWidthFillUint32,
698 EfiPciIoWidthFillUint64,
700 } EFI_PCI_IO_PROTOCOL_WIDTH;
703 EfiPciIoAttributeOperationGet,
704 EfiPciIoAttributeOperationSet,
705 EfiPciIoAttributeOperationEnable,
706 EfiPciIoAttributeOperationDisable,
707 EfiPciIoAttributeOperationSupported,
708 EfiPciIoAttributeOperationMaximum
709 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
714 } efi_pci_io_protocol_access_32_t;
716 typedef union efi_pci_io_protocol efi_pci_io_protocol_t;
719 efi_status_t (__efiapi *efi_pci_io_protocol_cfg_t)(efi_pci_io_protocol_t *,
720 EFI_PCI_IO_PROTOCOL_WIDTH,
728 } efi_pci_io_protocol_access_t;
731 efi_pci_io_protocol_cfg_t read;
732 efi_pci_io_protocol_cfg_t write;
733 } efi_pci_io_protocol_config_access_t;
735 union efi_pci_io_protocol {
739 efi_pci_io_protocol_access_t mem;
740 efi_pci_io_protocol_access_t io;
741 efi_pci_io_protocol_config_access_t pci;
745 void *allocate_buffer;
748 efi_status_t (__efiapi *get_location)(efi_pci_io_protocol_t *,
749 unsigned long *segment_nr,
750 unsigned long *bus_nr,
751 unsigned long *device_nr,
752 unsigned long *func_nr);
754 void *get_bar_attributes;
755 void *set_bar_attributes;
762 efi_pci_io_protocol_access_32_t mem;
763 efi_pci_io_protocol_access_32_t io;
764 efi_pci_io_protocol_access_32_t pci;
773 u32 get_bar_attributes;
774 u32 set_bar_attributes;
780 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
781 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
782 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
783 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
784 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
785 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
786 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
787 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
788 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
789 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
790 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
791 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
792 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
793 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
794 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
795 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
796 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
797 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
798 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
802 typedef union apple_properties_protocol apple_properties_protocol_t;
804 union apple_properties_protocol {
806 unsigned long version;
807 efi_status_t (__efiapi *get)(apple_properties_protocol_t *,
808 struct efi_dev_path *,
809 efi_char16_t *, void *, u32 *);
810 efi_status_t (__efiapi *set)(apple_properties_protocol_t *,
811 struct efi_dev_path *,
812 efi_char16_t *, void *, u32);
813 efi_status_t (__efiapi *del)(apple_properties_protocol_t *,
814 struct efi_dev_path *,
816 efi_status_t (__efiapi *get_all)(apple_properties_protocol_t *,
817 void *buffer, u32 *);
828 typedef u32 efi_tcg2_event_log_format;
830 #define INITRD_EVENT_TAG_ID 0x8F3B22ECU
831 #define LOAD_OPTIONS_EVENT_TAG_ID 0x8F3B22EDU
832 #define EV_EVENT_TAG 0x00000006U
833 #define EFI_TCG2_EVENT_HEADER_VERSION 0x1
835 struct efi_tcg2_event {
842 } __packed event_header;
843 /* u8[] event follows here */
846 struct efi_tcg2_tagged_event {
848 u32 tagged_event_data_size;
849 /* u8 tagged event data follows here */
852 typedef struct efi_tcg2_event efi_tcg2_event_t;
853 typedef struct efi_tcg2_tagged_event efi_tcg2_tagged_event_t;
854 typedef union efi_tcg2_protocol efi_tcg2_protocol_t;
856 union efi_tcg2_protocol {
858 void *get_capability;
859 efi_status_t (__efiapi *get_event_log)(efi_tcg2_protocol_t *,
860 efi_tcg2_event_log_format,
861 efi_physical_addr_t *,
862 efi_physical_addr_t *,
864 efi_status_t (__efiapi *hash_log_extend_event)(efi_tcg2_protocol_t *,
868 const efi_tcg2_event_t *);
869 void *submit_command;
870 void *get_active_pcr_banks;
871 void *set_active_pcr_banks;
872 void *get_result_of_set_active_pcr_banks;
877 u32 hash_log_extend_event;
879 u32 get_active_pcr_banks;
880 u32 set_active_pcr_banks;
881 u32 get_result_of_set_active_pcr_banks;
885 struct riscv_efi_boot_protocol {
888 efi_status_t (__efiapi *get_boot_hartid)(struct riscv_efi_boot_protocol *,
889 unsigned long *boot_hartid);
892 typedef union efi_load_file_protocol efi_load_file_protocol_t;
893 typedef union efi_load_file_protocol efi_load_file2_protocol_t;
895 union efi_load_file_protocol {
897 efi_status_t (__efiapi *load_file)(efi_load_file_protocol_t *,
898 efi_device_path_protocol_t *,
899 bool, unsigned long *, void *);
908 u16 file_path_list_length;
910 // efi_char16_t description[];
911 // efi_device_path_protocol_t file_path_list[];
912 // u8 optional_data[];
913 } __packed efi_load_option_t;
915 #define EFI_LOAD_OPTION_ACTIVE 0x0001U
916 #define EFI_LOAD_OPTION_FORCE_RECONNECT 0x0002U
917 #define EFI_LOAD_OPTION_HIDDEN 0x0008U
918 #define EFI_LOAD_OPTION_CATEGORY 0x1f00U
919 #define EFI_LOAD_OPTION_CATEGORY_BOOT 0x0000U
920 #define EFI_LOAD_OPTION_CATEGORY_APP 0x0100U
922 #define EFI_LOAD_OPTION_BOOT_MASK \
923 (EFI_LOAD_OPTION_ACTIVE|EFI_LOAD_OPTION_HIDDEN|EFI_LOAD_OPTION_CATEGORY)
924 #define EFI_LOAD_OPTION_MASK (EFI_LOAD_OPTION_FORCE_RECONNECT|EFI_LOAD_OPTION_BOOT_MASK)
928 u16 file_path_list_length;
929 const efi_char16_t *description;
930 const efi_device_path_protocol_t *file_path_list;
931 u32 optional_data_size;
932 const void *optional_data;
933 } efi_load_option_unpacked_t;
935 void efi_pci_disable_bridge_busmaster(void);
937 typedef efi_status_t (*efi_exit_boot_map_processing)(
938 struct efi_boot_memmap *map,
941 efi_status_t efi_exit_boot_services(void *handle, void *priv,
942 efi_exit_boot_map_processing priv_func);
944 efi_status_t efi_boot_kernel(void *handle, efi_loaded_image_t *image,
945 unsigned long kernel_addr, char *cmdline_ptr);
947 void *get_fdt(unsigned long *fdt_size);
949 efi_status_t efi_alloc_virtmap(efi_memory_desc_t **virtmap,
950 unsigned long *desc_size, u32 *desc_ver);
951 void efi_get_virtmap(efi_memory_desc_t *memory_map, unsigned long map_size,
952 unsigned long desc_size, efi_memory_desc_t *runtime_map,
955 efi_status_t efi_get_random_bytes(unsigned long size, u8 *out);
957 efi_status_t efi_random_alloc(unsigned long size, unsigned long align,
958 unsigned long *addr, unsigned long random_seed,
959 int memory_type, unsigned long alloc_min,
960 unsigned long alloc_max);
962 efi_status_t efi_random_get_seed(void);
964 efi_status_t check_platform_features(void);
966 void *get_efi_config_table(efi_guid_t guid);
968 /* NOTE: These functions do not print a trailing newline after the string */
969 void efi_char16_puts(efi_char16_t *);
970 void efi_puts(const char *str);
972 __printf(1, 2) int efi_printk(char const *fmt, ...);
974 void efi_free(unsigned long size, unsigned long addr);
976 void efi_apply_loadoptions_quirk(const void **load_options, u32 *load_options_size);
978 char *efi_convert_cmdline(efi_loaded_image_t *image, int *cmd_line_len);
980 efi_status_t efi_get_memory_map(struct efi_boot_memmap **map,
981 bool install_cfg_tbl);
983 efi_status_t efi_allocate_pages(unsigned long size, unsigned long *addr,
986 efi_status_t efi_allocate_pages_aligned(unsigned long size, unsigned long *addr,
987 unsigned long max, unsigned long align,
990 efi_status_t efi_low_alloc_above(unsigned long size, unsigned long align,
991 unsigned long *addr, unsigned long min);
993 efi_status_t efi_relocate_kernel(unsigned long *image_addr,
994 unsigned long image_size,
995 unsigned long alloc_size,
996 unsigned long preferred_addr,
997 unsigned long alignment,
998 unsigned long min_addr);
1000 efi_status_t efi_parse_options(char const *cmdline);
1002 void efi_parse_option_graphics(char *option);
1004 efi_status_t efi_setup_gop(struct screen_info *si, efi_guid_t *proto,
1005 unsigned long size);
1007 efi_status_t handle_cmdline_files(efi_loaded_image_t *image,
1008 const efi_char16_t *optstr,
1010 unsigned long soft_limit,
1011 unsigned long hard_limit,
1012 unsigned long *load_addr,
1013 unsigned long *load_size);
1016 static inline efi_status_t efi_load_dtb(efi_loaded_image_t *image,
1017 unsigned long *load_addr,
1018 unsigned long *load_size)
1020 return handle_cmdline_files(image, L"dtb=", sizeof(L"dtb=") - 2,
1021 ULONG_MAX, ULONG_MAX, load_addr, load_size);
1024 efi_status_t efi_load_initrd(efi_loaded_image_t *image,
1025 unsigned long soft_limit,
1026 unsigned long hard_limit,
1027 const struct linux_efi_initrd **out);
1029 * This function handles the architcture specific differences between arm and
1030 * arm64 regarding where the kernel image must be loaded and any memory that
1031 * must be reserved. On failure it is required to free all
1032 * all allocations it has made.
1034 efi_status_t handle_kernel_image(unsigned long *image_addr,
1035 unsigned long *image_size,
1036 unsigned long *reserve_addr,
1037 unsigned long *reserve_size,
1038 efi_loaded_image_t *image,
1039 efi_handle_t image_handle);
1041 /* shared entrypoint between the normal stub and the zboot stub */
1042 efi_status_t efi_stub_common(efi_handle_t handle,
1043 efi_loaded_image_t *image,
1044 unsigned long image_addr,
1047 efi_status_t efi_handle_cmdline(efi_loaded_image_t *image, char **cmdline_ptr);
1049 asmlinkage void __noreturn efi_enter_kernel(unsigned long entrypoint,
1050 unsigned long fdt_addr,
1051 unsigned long fdt_size);
1053 void efi_handle_post_ebs_state(void);
1055 enum efi_secureboot_mode efi_get_secureboot(void);
1057 #ifdef CONFIG_RESET_ATTACK_MITIGATION
1058 void efi_enable_reset_attack_mitigation(void);
1061 efi_enable_reset_attack_mitigation(void) { }
1064 void efi_retrieve_tpm2_eventlog(void);
1066 struct screen_info *alloc_screen_info(void);
1067 struct screen_info *__alloc_screen_info(void);
1068 void free_screen_info(struct screen_info *si);
1070 void efi_cache_sync_image(unsigned long image_base,
1071 unsigned long alloc_size);
1073 struct efi_smbios_record {
1079 const struct efi_smbios_record *efi_get_smbios_record(u8 type);
1081 struct efi_smbios_type1_record {
1082 struct efi_smbios_record header;
1094 struct efi_smbios_type4_record {
1095 struct efi_smbios_record header;
1099 u8 processor_family;
1100 u8 processor_manufacturer;
1102 u8 processor_version;
1108 u8 processor_upgrade;
1109 u16 l1_cache_handle;
1110 u16 l2_cache_handle;
1111 u16 l3_cache_handle;
1116 u8 enabled_core_count;
1118 u16 processor_characteristics;
1119 u16 processor_family2;
1121 u16 enabled_core_count2;
1126 #define efi_get_smbios_string(__record, __type, __name) ({ \
1127 int off = offsetof(struct efi_smbios_type ## __type ## _record, \
1129 __efi_get_smbios_string((__record), __type, off); \
1132 const u8 *__efi_get_smbios_string(const struct efi_smbios_record *record,
1133 u8 type, int offset);
1135 void efi_remap_image(unsigned long image_base, unsigned alloc_size,
1136 unsigned long code_size);
1137 efi_status_t efi_kaslr_relocate_kernel(unsigned long *image_addr,
1138 unsigned long *reserve_addr,
1139 unsigned long *reserve_size,
1140 unsigned long kernel_size,
1141 unsigned long kernel_codesize,
1142 unsigned long kernel_memsize,
1144 u32 efi_kaslr_get_phys_seed(efi_handle_t image_handle);
1146 asmlinkage efi_status_t __efiapi
1147 efi_zboot_entry(efi_handle_t handle, efi_system_table_t *systab);
1149 efi_status_t allocate_unaccepted_bitmap(__u32 nr_desc,
1150 struct efi_boot_memmap *map);
1151 void process_unaccepted_memory(u64 start, u64 end);
1152 void accept_memory(phys_addr_t start, phys_addr_t end);
1153 void arch_accept_memory(phys_addr_t start, phys_addr_t end);