efi.h

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _LINUX_EFI_H
   3#define _LINUX_EFI_H
   4
   5/*
   6 * Extensible Firmware Interface
   7 * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
   8 *
   9 * Copyright (C) 1999 VA Linux Systems
  10 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
  11 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  12 *	David Mosberger-Tang <davidm@hpl.hp.com>
  13 *	Stephane Eranian <eranian@hpl.hp.com>
  14 */
  15#include <linux/init.h>
  16#include <linux/string.h>
  17#include <linux/time.h>
  18#include <linux/types.h>
  19#include <linux/proc_fs.h>
  20#include <linux/rtc.h>
  21#include <linux/ioport.h>
  22#include <linux/pfn.h>
  23#include <linux/pstore.h>
  24#include <linux/range.h>
  25#include <linux/reboot.h>
  26#include <linux/uuid.h>
  27
  28#include <asm/page.h>
  29
  30struct screen_info;
  31
  32#define EFI_SUCCESS		0
  33#define EFI_LOAD_ERROR		( 1 | (1UL << (BITS_PER_LONG-1)))
  34#define EFI_INVALID_PARAMETER	( 2 | (1UL << (BITS_PER_LONG-1)))
  35#define EFI_UNSUPPORTED		( 3 | (1UL << (BITS_PER_LONG-1)))
  36#define EFI_BAD_BUFFER_SIZE	( 4 | (1UL << (BITS_PER_LONG-1)))
  37#define EFI_BUFFER_TOO_SMALL	( 5 | (1UL << (BITS_PER_LONG-1)))
  38#define EFI_NOT_READY		( 6 | (1UL << (BITS_PER_LONG-1)))
  39#define EFI_DEVICE_ERROR	( 7 | (1UL << (BITS_PER_LONG-1)))
  40#define EFI_WRITE_PROTECTED	( 8 | (1UL << (BITS_PER_LONG-1)))
  41#define EFI_OUT_OF_RESOURCES	( 9 | (1UL << (BITS_PER_LONG-1)))
  42#define EFI_NOT_FOUND		(14 | (1UL << (BITS_PER_LONG-1)))
  43#define EFI_ACCESS_DENIED	(15 | (1UL << (BITS_PER_LONG-1)))
  44#define EFI_TIMEOUT		(18 | (1UL << (BITS_PER_LONG-1)))
  45#define EFI_ABORTED		(21 | (1UL << (BITS_PER_LONG-1)))
  46#define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))
  47
  48typedef unsigned long efi_status_t;
  49typedef u8 efi_bool_t;
  50typedef u16 efi_char16_t;		/* UNICODE character */
  51typedef u64 efi_physical_addr_t;
  52typedef void *efi_handle_t;
  53
  54#if defined(CONFIG_X86_64)
  55#define __efiapi __attribute__((ms_abi))
  56#elif defined(CONFIG_X86_32)
  57#define __efiapi __attribute__((regparm(0)))
  58#else
  59#define __efiapi
  60#endif
  61
  62/*
  63 * The UEFI spec and EDK2 reference implementation both define EFI_GUID as
  64 * struct { u32 a; u16; b; u16 c; u8 d[8]; }; and so the implied alignment
  65 * is 32 bits not 8 bits like our guid_t. In some cases (i.e., on 32-bit ARM),
  66 * this means that firmware services invoked by the kernel may assume that
  67 * efi_guid_t* arguments are 32-bit aligned, and use memory accessors that
  68 * do not tolerate misalignment. So let's set the minimum alignment to 32 bits.
  69 *
  70 * Note that the UEFI spec as well as some comments in the EDK2 code base
  71 * suggest that EFI_GUID should be 64-bit aligned, but this appears to be
  72 * a mistake, given that no code seems to exist that actually enforces that
  73 * or relies on it.
  74 */
  75typedef guid_t efi_guid_t __aligned(__alignof__(u32));
  76
  77#define EFI_GUID(a, b, c, d...) ((efi_guid_t){ {				\
  78	(a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff,	\
  79	(b) & 0xff, ((b) >> 8) & 0xff,						\
  80	(c) & 0xff, ((c) >> 8) & 0xff, d } })
  81
  82/*
  83 * Generic EFI table header
  84 */
  85typedef	struct {
  86	u64 signature;
  87	u32 revision;
  88	u32 headersize;
  89	u32 crc32;
  90	u32 reserved;
  91} efi_table_hdr_t;
  92
  93/*
  94 * Memory map descriptor:
  95 */
  96
  97/* Memory types: */
  98#define EFI_RESERVED_TYPE		 0
  99#define EFI_LOADER_CODE			 1
 100#define EFI_LOADER_DATA			 2
 101#define EFI_BOOT_SERVICES_CODE		 3
 102#define EFI_BOOT_SERVICES_DATA		 4
 103#define EFI_RUNTIME_SERVICES_CODE	 5
 104#define EFI_RUNTIME_SERVICES_DATA	 6
 105#define EFI_CONVENTIONAL_MEMORY		 7
 106#define EFI_UNUSABLE_MEMORY		 8
 107#define EFI_ACPI_RECLAIM_MEMORY		 9
 108#define EFI_ACPI_MEMORY_NVS		10
 109#define EFI_MEMORY_MAPPED_IO		11
 110#define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
 111#define EFI_PAL_CODE			13
 112#define EFI_PERSISTENT_MEMORY		14
 113#define EFI_UNACCEPTED_MEMORY		15
 114#define EFI_MAX_MEMORY_TYPE		16
 115
 116/* Attribute values: */
 117#define EFI_MEMORY_UC			BIT_ULL(0)	/* uncached */
 118#define EFI_MEMORY_WC			BIT_ULL(1)	/* write-coalescing */
 119#define EFI_MEMORY_WT			BIT_ULL(2)	/* write-through */
 120#define EFI_MEMORY_WB			BIT_ULL(3)	/* write-back */
 121#define EFI_MEMORY_UCE			BIT_ULL(4)	/* uncached, exported */
 122#define EFI_MEMORY_WP			BIT_ULL(12)	/* write-protect */
 123#define EFI_MEMORY_RP			BIT_ULL(13)	/* read-protect */
 124#define EFI_MEMORY_XP			BIT_ULL(14)	/* execute-protect */
 125#define EFI_MEMORY_NV			BIT_ULL(15)	/* non-volatile */
 126#define EFI_MEMORY_MORE_RELIABLE	BIT_ULL(16)	/* higher reliability */
 127#define EFI_MEMORY_RO			BIT_ULL(17)	/* read-only */
 128#define EFI_MEMORY_SP			BIT_ULL(18)	/* soft reserved */
 129#define EFI_MEMORY_CPU_CRYPTO		BIT_ULL(19)	/* supports encryption */
 130#define EFI_MEMORY_HOT_PLUGGABLE	BIT_ULL(20)	/* supports unplugging at runtime */
 131#define EFI_MEMORY_RUNTIME		BIT_ULL(63)	/* range requires runtime mapping */
 132
 133#define EFI_MEMORY_DESCRIPTOR_VERSION	1
 134
 135#define EFI_PAGE_SHIFT		12
 136#define EFI_PAGE_SIZE		(1UL << EFI_PAGE_SHIFT)
 137#define EFI_PAGES_MAX		(U64_MAX >> EFI_PAGE_SHIFT)
 138
 139typedef struct {
 140	u32 type;
 141	u32 pad;
 142	u64 phys_addr;
 143	u64 virt_addr;
 144	u64 num_pages;
 145	u64 attribute;
 146} efi_memory_desc_t;
 147
 148typedef struct {
 149	efi_guid_t guid;
 150	u32 headersize;
 151	u32 flags;
 152	u32 imagesize;
 153} efi_capsule_header_t;
 154
 155/* EFI_FIRMWARE_MANAGEMENT_CAPSULE_HEADER */
 156struct efi_manage_capsule_header {
 157	u32 ver;
 158	u16 emb_drv_cnt;
 159	u16 payload_cnt;
 160	/*
 161	 * Variable-size array of the size given by the sum of
 162	 * emb_drv_cnt and payload_cnt.
 163	 */
 164	u64 offset_list[];
 165} __packed;
 166
 167/* EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER */
 168struct efi_manage_capsule_image_header {
 169	u32 ver;
 170	efi_guid_t image_type_id;
 171	u8 image_index;
 172	u8 reserved_bytes[3];
 173	u32 image_size;
 174	u32 vendor_code_size;
 175	/* hw_ins was introduced in version 2 */
 176	u64 hw_ins;
 177	/* capsule_support was introduced in version 3 */
 178	u64 capsule_support;
 179} __packed;
 180
 181/* WIN_CERTIFICATE */
 182struct win_cert {
 183	u32 len;
 184	u16 rev;
 185	u16 cert_type;
 186};
 187
 188/* WIN_CERTIFICATE_UEFI_GUID */
 189struct win_cert_uefi_guid {
 190	struct win_cert	hdr;
 191	efi_guid_t cert_type;
 192	u8 cert_data[];
 193};
 194
 195/* EFI_FIRMWARE_IMAGE_AUTHENTICATION */
 196struct efi_image_auth {
 197	u64 mon_count;
 198	struct win_cert_uefi_guid auth_info;
 199};
 200
 201/*
 202 * EFI capsule flags
 203 */
 204#define EFI_CAPSULE_PERSIST_ACROSS_RESET	0x00010000
 205#define EFI_CAPSULE_POPULATE_SYSTEM_TABLE	0x00020000
 206#define EFI_CAPSULE_INITIATE_RESET		0x00040000
 207
 208struct capsule_info {
 209	efi_capsule_header_t	header;
 210	efi_capsule_header_t	*capsule;
 211	int			reset_type;
 212	long			index;
 213	size_t			count;
 214	size_t			total_size;
 215	struct page		**pages;
 216	phys_addr_t		*phys;
 217	size_t			page_bytes_remain;
 218};
 219
 220int efi_capsule_setup_info(struct capsule_info *cap_info, void *kbuff,
 221                           size_t hdr_bytes);
 222int __efi_capsule_setup_info(struct capsule_info *cap_info);
 223
 224/*
 225 * Types and defines for Time Services
 226 */
 227#define EFI_TIME_ADJUST_DAYLIGHT 0x1
 228#define EFI_TIME_IN_DAYLIGHT     0x2
 229#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
 230
 231typedef struct {
 232	u16 year;
 233	u8 month;
 234	u8 day;
 235	u8 hour;
 236	u8 minute;
 237	u8 second;
 238	u8 pad1;
 239	u32 nanosecond;
 240	s16 timezone;
 241	u8 daylight;
 242	u8 pad2;
 243} efi_time_t;
 244
 245typedef struct {
 246	u32 resolution;
 247	u32 accuracy;
 248	u8 sets_to_zero;
 249} efi_time_cap_t;
 250
 251typedef union efi_boot_services efi_boot_services_t;
 252
 253/*
 254 * Types and defines for EFI ResetSystem
 255 */
 256#define EFI_RESET_COLD 0
 257#define EFI_RESET_WARM 1
 258#define EFI_RESET_SHUTDOWN 2
 259
 260/*
 261 * EFI Runtime Services table
 262 */
 263#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 264#define EFI_RUNTIME_SERVICES_REVISION  0x00010000
 265
 266typedef struct {
 267	efi_table_hdr_t hdr;
 268	u32 get_time;
 269	u32 set_time;
 270	u32 get_wakeup_time;
 271	u32 set_wakeup_time;
 272	u32 set_virtual_address_map;
 273	u32 convert_pointer;
 274	u32 get_variable;
 275	u32 get_next_variable;
 276	u32 set_variable;
 277	u32 get_next_high_mono_count;
 278	u32 reset_system;
 279	u32 update_capsule;
 280	u32 query_capsule_caps;
 281	u32 query_variable_info;
 282} efi_runtime_services_32_t;
 283
 284typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 285typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 286typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 287					    efi_time_t *tm);
 288typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 289typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 290					 unsigned long *data_size, void *data);
 291typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 292					      efi_guid_t *vendor);
 293typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 294					 u32 attr, unsigned long data_size,
 295					 void *data);
 296typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 297typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 298				 unsigned long data_size, efi_char16_t *data);
 299typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 300						unsigned long descriptor_size,
 301						u32 descriptor_version,
 302						efi_memory_desc_t *virtual_map);
 303typedef efi_status_t efi_query_variable_info_t(u32 attr,
 304					       u64 *storage_space,
 305					       u64 *remaining_space,
 306					       u64 *max_variable_size);
 307typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 308					  unsigned long count,
 309					  unsigned long sg_list);
 310typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 311					      unsigned long count,
 312					      u64 *max_size,
 313					      int *reset_type);
 314typedef efi_status_t efi_query_variable_store_t(u32 attributes,
 315						unsigned long size,
 316						bool nonblocking);
 317
 318typedef union {
 319	struct {
 320		efi_table_hdr_t				hdr;
 321		efi_get_time_t __efiapi			*get_time;
 322		efi_set_time_t __efiapi			*set_time;
 323		efi_get_wakeup_time_t __efiapi		*get_wakeup_time;
 324		efi_set_wakeup_time_t __efiapi		*set_wakeup_time;
 325		efi_set_virtual_address_map_t __efiapi	*set_virtual_address_map;
 326		void					*convert_pointer;
 327		efi_get_variable_t __efiapi		*get_variable;
 328		efi_get_next_variable_t __efiapi	*get_next_variable;
 329		efi_set_variable_t __efiapi		*set_variable;
 330		efi_get_next_high_mono_count_t __efiapi	*get_next_high_mono_count;
 331		efi_reset_system_t __efiapi		*reset_system;
 332		efi_update_capsule_t __efiapi		*update_capsule;
 333		efi_query_capsule_caps_t __efiapi	*query_capsule_caps;
 334		efi_query_variable_info_t __efiapi	*query_variable_info;
 335	};
 336	efi_runtime_services_32_t mixed_mode;
 337} efi_runtime_services_t;
 338
 339void efi_native_runtime_setup(void);
 340
 341/*
 342 * EFI Configuration Table and GUID definitions
 343 *
 344 * These are all defined in a single line to make them easier to
 345 * grep for and to see them at a glance - while still having a
 346 * similar structure to the definitions in the spec.
 347 *
 348 * Here's how they are structured:
 349 *
 350 * GUID: 12345678-1234-1234-1234-123456789012
 351 * Spec:
 352 *      #define EFI_SOME_PROTOCOL_GUID \
 353 *        {0x12345678,0x1234,0x1234,\
 354 *          {0x12,0x34,0x12,0x34,0x56,0x78,0x90,0x12}}
 355 * Here:
 356 *	#define SOME_PROTOCOL_GUID		EFI_GUID(0x12345678, 0x1234, 0x1234,  0x12, 0x34, 0x12, 0x34, 0x56, 0x78, 0x90, 0x12)
 357 *					^ tabs					    ^extra space
 358 *
 359 * Note that the 'extra space' separates the values at the same place
 360 * where the UEFI SPEC breaks the line.
 361 */
 362#define NULL_GUID				EFI_GUID(0x00000000, 0x0000, 0x0000,  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
 363#define ACPI_TABLE_GUID				EFI_GUID(0xeb9d2d30, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 364#define ACPI_20_TABLE_GUID			EFI_GUID(0x8868e871, 0xe4f1, 0x11d3,  0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
 365#define SMBIOS_TABLE_GUID			EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3,  0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 366#define SMBIOS3_TABLE_GUID			EFI_GUID(0xf2fd1544, 0x9794, 0x4a2c,  0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94)
 367#define EFI_GLOBAL_VARIABLE_GUID		EFI_GUID(0x8be4df61, 0x93ca, 0x11d2,  0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
 368#define UV_SYSTEM_TABLE_GUID			EFI_GUID(0x3b13a7d4, 0x633e, 0x11dd,  0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93)
 369#define LINUX_EFI_CRASH_GUID			EFI_GUID(0xcfc8fc79, 0xbe2e, 0x4ddc,  0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0)
 370#define LOADED_IMAGE_PROTOCOL_GUID		EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 371#define LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID	EFI_GUID(0xbc62157e, 0x3e33, 0x4fec,  0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
 372#define EFI_DEVICE_PATH_PROTOCOL_GUID		EFI_GUID(0x09576e91, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 373#define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID	EFI_GUID(0x8b843e20, 0x8132, 0x4852,  0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
 374#define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID	EFI_GUID(0x05c99a21, 0xc70f, 0x4ad2,  0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e)
 375#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID	EFI_GUID(0x9042a9de, 0x23dc, 0x4a38,  0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
 376#define EFI_EDID_DISCOVERED_PROTOCOL_GUID	EFI_GUID(0x1c0c34f6, 0xd380, 0x41fa,  0xa0, 0x49, 0x8a, 0xd0, 0x6c, 0x1a, 0x66, 0xaa)
 377#define EFI_EDID_ACTIVE_PROTOCOL_GUID		EFI_GUID(0xbd8c1056, 0x9f36, 0x44ec,  0x92, 0xa8, 0xa6, 0x33, 0x7f, 0x81, 0x79, 0x86)
 378#define EFI_PCI_IO_PROTOCOL_GUID		EFI_GUID(0x4cf5b200, 0x68b8, 0x4ca5,  0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x02, 0x9a)
 379#define EFI_FILE_INFO_ID			EFI_GUID(0x09576e92, 0x6d3f, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 380#define EFI_SYSTEM_RESOURCE_TABLE_GUID		EFI_GUID(0xb122a263, 0x3661, 0x4f68,  0x99, 0x29, 0x78, 0xf8, 0xb0, 0xd6, 0x21, 0x80)
 381#define EFI_FILE_SYSTEM_GUID			EFI_GUID(0x964e5b22, 0x6459, 0x11d2,  0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 382#define DEVICE_TREE_GUID			EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5,  0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
 383#define EFI_RNG_PROTOCOL_GUID			EFI_GUID(0x3152bca5, 0xeade, 0x433d,  0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44)
 384#define EFI_RNG_ALGORITHM_RAW			EFI_GUID(0xe43176d7, 0xb6e8, 0x4827,  0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61)
 385#define EFI_MEMORY_ATTRIBUTES_TABLE_GUID	EFI_GUID(0xdcfa911d, 0x26eb, 0x469f,  0xa2, 0x20, 0x38, 0xb7, 0xdc, 0x46, 0x12, 0x20)
 386#define EFI_CONSOLE_OUT_DEVICE_GUID		EFI_GUID(0xd3b36f2c, 0xd551, 0x11d4,  0x9a, 0x46, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
 387#define APPLE_PROPERTIES_PROTOCOL_GUID		EFI_GUID(0x91bd12fe, 0xf6c3, 0x44fb,  0xa5, 0xb7, 0x51, 0x22, 0xab, 0x30, 0x3a, 0xe0)
 388#define APPLE_SET_OS_PROTOCOL_GUID		EFI_GUID(0xc5c5da95, 0x7d5c, 0x45e6,  0xb2, 0xf1, 0x3f, 0xd5, 0x2b, 0xb1, 0x00, 0x77)
 389#define EFI_TCG2_PROTOCOL_GUID			EFI_GUID(0x607f766c, 0x7455, 0x42be,  0x93, 0x0b, 0xe4, 0xd7, 0x6d, 0xb2, 0x72, 0x0f)
 390#define EFI_TCG2_FINAL_EVENTS_TABLE_GUID	EFI_GUID(0x1e2ed096, 0x30e2, 0x4254,  0xbd, 0x89, 0x86, 0x3b, 0xbe, 0xf8, 0x23, 0x25)
 391#define EFI_LOAD_FILE_PROTOCOL_GUID		EFI_GUID(0x56ec3091, 0x954c, 0x11d2,  0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
 392#define EFI_LOAD_FILE2_PROTOCOL_GUID		EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e,  0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
 393#define EFI_RT_PROPERTIES_TABLE_GUID		EFI_GUID(0xeb66918a, 0x7eef, 0x402a,  0x84, 0x2e, 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
 394#define EFI_DXE_SERVICES_TABLE_GUID		EFI_GUID(0x05ad34ba, 0x6f02, 0x4214,  0x95, 0x2e, 0x4d, 0xa0, 0x39, 0x8e, 0x2b, 0xb9)
 395#define EFI_SMBIOS_PROTOCOL_GUID		EFI_GUID(0x03583ff6, 0xcb36, 0x4940,  0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7)
 396#define EFI_MEMORY_ATTRIBUTE_PROTOCOL_GUID	EFI_GUID(0xf4560cf6, 0x40ec, 0x4b4a,  0xa1, 0x92, 0xbf, 0x1d, 0x57, 0xd0, 0xb1, 0x89)
 397
 398#define EFI_IMAGE_SECURITY_DATABASE_GUID	EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596,  0xa3, 0xbc, 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
 399#define EFI_SHIM_LOCK_GUID			EFI_GUID(0x605dab50, 0xe046, 0x4300,  0xab, 0xb6, 0x3d, 0xd8, 0x10, 0xdd, 0x8b, 0x23)
 400
 401#define EFI_CERT_SHA256_GUID			EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
 402#define EFI_CERT_X509_GUID			EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
 403#define EFI_CERT_X509_SHA256_GUID		EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
 404#define EFI_CC_BLOB_GUID			EFI_GUID(0x067b1f5f, 0xcf26, 0x44c5, 0x85, 0x54, 0x93, 0xd7, 0x77, 0x91, 0x2d, 0x42)
 405#define EFI_CC_MEASUREMENT_PROTOCOL_GUID	EFI_GUID(0x96751a3d, 0x72f4, 0x41a6, 0xa7, 0x94, 0xed, 0x5d, 0x0e, 0x67, 0xae, 0x6b)
 406#define EFI_CC_FINAL_EVENTS_TABLE_GUID		EFI_GUID(0xdd4a4648, 0x2de7, 0x4665, 0x96, 0x4d, 0x21, 0xd9, 0xef, 0x5f, 0xb4, 0x46)
 407
 408/*
 409 * This GUID is used to pass to the kernel proper the struct screen_info
 410 * structure that was populated by the stub based on the GOP protocol instance
 411 * associated with ConOut
 412 */
 413#define LINUX_EFI_SCREEN_INFO_TABLE_GUID	EFI_GUID(0xe03fc20a, 0x85dc, 0x406e,  0xb9, 0x0e, 0x4a, 0xb5, 0x02, 0x37, 0x1d, 0x95)
 414#define LINUX_EFI_ARM_CPU_STATE_TABLE_GUID	EFI_GUID(0xef79e4aa, 0x3c3d, 0x4989,  0xb9, 0x02, 0x07, 0xa9, 0x43, 0xe5, 0x50, 0xd2)
 415#define LINUX_EFI_LOADER_ENTRY_GUID		EFI_GUID(0x4a67b082, 0x0a4c, 0x41cf,  0xb6, 0xc7, 0x44, 0x0b, 0x29, 0xbb, 0x8c, 0x4f)
 416#define LINUX_EFI_RANDOM_SEED_TABLE_GUID	EFI_GUID(0x1ce1e5bc, 0x7ceb, 0x42f2,  0x81, 0xe5, 0x8a, 0xad, 0xf1, 0x80, 0xf5, 0x7b)
 417#define LINUX_EFI_TPM_EVENT_LOG_GUID		EFI_GUID(0xb7799cb0, 0xeca2, 0x4943,  0x96, 0x67, 0x1f, 0xae, 0x07, 0xb7, 0x47, 0xfa)
 418#define LINUX_EFI_MEMRESERVE_TABLE_GUID		EFI_GUID(0x888eb0c6, 0x8ede, 0x4ff5,  0xa8, 0xf0, 0x9a, 0xee, 0x5c, 0xb9, 0x77, 0xc2)
 419#define LINUX_EFI_INITRD_MEDIA_GUID		EFI_GUID(0x5568e427, 0x68fc, 0x4f3d,  0xac, 0x74, 0xca, 0x55, 0x52, 0x31, 0xcc, 0x68)
 420#define LINUX_EFI_MOK_VARIABLE_TABLE_GUID	EFI_GUID(0xc451ed2b, 0x9694, 0x45d3,  0xba, 0xba, 0xed, 0x9f, 0x89, 0x88, 0xa3, 0x89)
 421#define LINUX_EFI_COCO_SECRET_AREA_GUID		EFI_GUID(0xadf956ad, 0xe98c, 0x484c,  0xae, 0x11, 0xb5, 0x1c, 0x7d, 0x33, 0x64, 0x47)
 422#define LINUX_EFI_BOOT_MEMMAP_GUID		EFI_GUID(0x800f683f, 0xd08b, 0x423a,  0xa2, 0x93, 0x96, 0x5c, 0x3c, 0x6f, 0xe2, 0xb4)
 423#define LINUX_EFI_UNACCEPTED_MEM_TABLE_GUID	EFI_GUID(0xd5d1de3c, 0x105c, 0x44f9,  0x9e, 0xa9, 0xbc, 0xef, 0x98, 0x12, 0x00, 0x31)
 424
 425#define RISCV_EFI_BOOT_PROTOCOL_GUID		EFI_GUID(0xccd15fec, 0x6f73, 0x4eec,  0x83, 0x95, 0x3e, 0x69, 0xe4, 0xb9, 0x40, 0xbf)
 426
 427/*
 428 * This GUID may be installed onto the kernel image's handle as a NULL protocol
 429 * to signal to the stub that the placement of the image should be respected,
 430 * and moving the image in physical memory is undesirable. To ensure
 431 * compatibility with 64k pages kernels with virtually mapped stacks, and to
 432 * avoid defeating physical randomization, this protocol should only be
 433 * installed if the image was placed at a randomized 128k aligned address in
 434 * memory.
 435 */
 436#define LINUX_EFI_LOADED_IMAGE_FIXED_GUID	EFI_GUID(0xf5a37b6d, 0x3344, 0x42a5,  0xb6, 0xbb, 0x97, 0x86, 0x48, 0xc1, 0x89, 0x0a)
 437
 438/* OEM GUIDs */
 439#define DELLEMC_EFI_RCI2_TABLE_GUID		EFI_GUID(0x2d9f28a2, 0xa886, 0x456a,  0x97, 0xa8, 0xf1, 0x1e, 0xf2, 0x4f, 0xf4, 0x55)
 440#define AMD_SEV_MEM_ENCRYPT_GUID		EFI_GUID(0x0cf29b71, 0x9e51, 0x433a,  0xa3, 0xb7, 0x81, 0xf3, 0xab, 0x16, 0xb8, 0x75)
 441
 442/* OVMF protocol GUIDs */
 443#define OVMF_SEV_MEMORY_ACCEPTANCE_PROTOCOL_GUID	EFI_GUID(0xc5a010fe, 0x38a7, 0x4531,  0x8a, 0x4a, 0x05, 0x00, 0xd2, 0xfd, 0x16, 0x49)
 444#define OVMF_MEMORY_LOG_TABLE_GUID		EFI_GUID(0x95305139, 0xb20f, 0x4723,  0x84, 0x25, 0x62, 0x7c, 0x88, 0x8f, 0xf1, 0x21)
 445
 446typedef struct {
 447	efi_guid_t guid;
 448	u64 table;
 449} efi_config_table_64_t;
 450
 451typedef struct {
 452	efi_guid_t guid;
 453	u32 table;
 454} efi_config_table_32_t;
 455
 456typedef union {
 457	struct {
 458		efi_guid_t guid;
 459		void *table;
 460	};
 461	efi_config_table_32_t mixed_mode;
 462} efi_config_table_t;
 463
 464typedef struct {
 465	efi_guid_t guid;
 466	unsigned long *ptr;
 467	const char name[16];
 468} efi_config_table_type_t;
 469
 470#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
 471#define EFI_DXE_SERVICES_TABLE_SIGNATURE ((u64)0x565245535f455844ULL)
 472
 473#define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 474#define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 475#define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 476#define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 477#define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 478#define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
 479
 480typedef struct {
 481	efi_table_hdr_t hdr;
 482	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
 483	u32 fw_revision;
 484	u32 __pad1;
 485	u64 con_in_handle;
 486	u64 con_in;
 487	u64 con_out_handle;
 488	u64 con_out;
 489	u64 stderr_handle;
 490	u64 stderr;
 491	u64 runtime;
 492	u64 boottime;
 493	u32 nr_tables;
 494	u32 __pad2;
 495	u64 tables;
 496} efi_system_table_64_t;
 497
 498typedef struct {
 499	efi_table_hdr_t hdr;
 500	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
 501	u32 fw_revision;
 502	u32 con_in_handle;
 503	u32 con_in;
 504	u32 con_out_handle;
 505	u32 con_out;
 506	u32 stderr_handle;
 507	u32 stderr;
 508	u32 runtime;
 509	u32 boottime;
 510	u32 nr_tables;
 511	u32 tables;
 512} efi_system_table_32_t;
 513
 514typedef union efi_simple_text_input_protocol efi_simple_text_input_protocol_t;
 515typedef union efi_simple_text_output_protocol efi_simple_text_output_protocol_t;
 516
 517typedef union {
 518	struct {
 519		efi_table_hdr_t hdr;
 520		unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
 521		u32 fw_revision;
 522		unsigned long con_in_handle;
 523		efi_simple_text_input_protocol_t *con_in;
 524		unsigned long con_out_handle;
 525		efi_simple_text_output_protocol_t *con_out;
 526		unsigned long stderr_handle;
 527		unsigned long stderr;
 528		efi_runtime_services_t *runtime;
 529		efi_boot_services_t *boottime;
 530		unsigned long nr_tables;
 531		unsigned long tables;
 532	};
 533	efi_system_table_32_t mixed_mode;
 534} efi_system_table_t;
 535
 536struct efi_boot_memmap {
 537	unsigned long		map_size;
 538	unsigned long		desc_size;
 539	u32			desc_ver;
 540	unsigned long		map_key;
 541	unsigned long		buff_size;
 542	efi_memory_desc_t	map[];
 543};
 544
 545struct efi_unaccepted_memory {
 546	u32 version;
 547	u32 unit_size;
 548	u64 phys_base;
 549	u64 size;
 550	unsigned long bitmap[];
 551};
 552
 553/*
 554 * Architecture independent structure for describing a memory map for the
 555 * benefit of efi_memmap_init_early(), and for passing context between
 556 * efi_memmap_alloc() and efi_memmap_install().
 557 */
 558struct efi_memory_map_data {
 559	phys_addr_t phys_map;
 560	unsigned long size;
 561	unsigned long desc_version;
 562	unsigned long desc_size;
 563	unsigned long flags;
 564};
 565
 566struct efi_memory_map {
 567	phys_addr_t phys_map;
 568	void *map;
 569	void *map_end;
 570	int nr_map;
 571	unsigned long desc_version;
 572	unsigned long desc_size;
 573#define EFI_MEMMAP_LATE (1UL << 0)
 574#define EFI_MEMMAP_MEMBLOCK (1UL << 1)
 575#define EFI_MEMMAP_SLAB (1UL << 2)
 576	unsigned long flags;
 577};
 578
 579struct efi_mem_range {
 580	struct range range;
 581	u64 attribute;
 582};
 583
 584typedef struct {
 585	u16 version;
 586	u16 length;
 587	u32 runtime_services_supported;
 588} efi_rt_properties_table_t;
 589
 590#define EFI_RT_PROPERTIES_TABLE_VERSION	0x1
 591
 592#define EFI_INVALID_TABLE_ADDR		(~0UL)
 593
 594// BIT0 implies that Runtime code includes the forward control flow guard
 595// instruction, such as X86 CET-IBT or ARM BTI.
 596#define EFI_MEMORY_ATTRIBUTES_FLAGS_RT_FORWARD_CONTROL_FLOW_GUARD	0x1
 597
 598typedef struct {
 599	u32 version;
 600	u32 num_entries;
 601	u32 desc_size;
 602	u32 flags;
 603	/*
 604	 * There are @num_entries following, each of size @desc_size bytes,
 605	 * including an efi_memory_desc_t header. See efi_memdesc_ptr().
 606	 */
 607	efi_memory_desc_t entry[];
 608} efi_memory_attributes_table_t;
 609
 610typedef struct {
 611	efi_guid_t signature_owner;
 612	u8 signature_data[];
 613} efi_signature_data_t;
 614
 615typedef struct {
 616	efi_guid_t signature_type;
 617	u32 signature_list_size;
 618	u32 signature_header_size;
 619	u32 signature_size;
 620	u8 signature_header[];
 621	/* efi_signature_data_t signatures[][] */
 622} efi_signature_list_t;
 623
 624typedef u8 efi_sha256_hash_t[32];
 625
 626typedef struct {
 627	efi_sha256_hash_t to_be_signed_hash;
 628	efi_time_t time_of_revocation;
 629} efi_cert_x509_sha256_t;
 630
 631extern unsigned long __ro_after_init efi_rng_seed;		/* RNG Seed table */
 632
 633/*
 634 * All runtime access to EFI goes through this structure:
 635 */
 636extern struct efi {
 637	const efi_runtime_services_t	*runtime;		/* EFI runtime services table */
 638	unsigned int			runtime_version;	/* Runtime services version */
 639	unsigned int			runtime_supported_mask;
 640
 641	unsigned long			acpi;			/* ACPI table  (IA64 ext 0.71) */
 642	unsigned long			acpi20;			/* ACPI table  (ACPI 2.0) */
 643	unsigned long			smbios;			/* SMBIOS table (32 bit entry point) */
 644	unsigned long			smbios3;		/* SMBIOS table (64 bit entry point) */
 645	unsigned long			esrt;			/* ESRT table */
 646	unsigned long			tpm_log;		/* TPM2 Event Log table */
 647	unsigned long			tpm_final_log;		/* TPM2 Final Events Log table */
 648	unsigned long                   ovmf_debug_log;
 649	unsigned long			mokvar_table;		/* MOK variable config table */
 650	unsigned long			coco_secret;		/* Confidential computing secret table */
 651	unsigned long			unaccepted;		/* Unaccepted memory table */
 652
 653	efi_get_time_t			*get_time;
 654	efi_set_time_t			*set_time;
 655	efi_get_wakeup_time_t		*get_wakeup_time;
 656	efi_set_wakeup_time_t		*set_wakeup_time;
 657	efi_get_variable_t		*get_variable;
 658	efi_get_next_variable_t		*get_next_variable;
 659	efi_set_variable_t		*set_variable;
 660	efi_set_variable_t		*set_variable_nonblocking;
 661	efi_query_variable_info_t	*query_variable_info;
 662	efi_query_variable_info_t	*query_variable_info_nonblocking;
 663	efi_update_capsule_t		*update_capsule;
 664	efi_query_capsule_caps_t	*query_capsule_caps;
 665	efi_get_next_high_mono_count_t	*get_next_high_mono_count;
 666	efi_reset_system_t		*reset_system;
 667
 668	struct efi_memory_map		memmap;
 669	unsigned long			flags;
 670} efi;
 671
 672#define EFI_RT_SUPPORTED_GET_TIME				0x0001
 673#define EFI_RT_SUPPORTED_SET_TIME				0x0002
 674#define EFI_RT_SUPPORTED_GET_WAKEUP_TIME			0x0004
 675#define EFI_RT_SUPPORTED_SET_WAKEUP_TIME			0x0008
 676#define EFI_RT_SUPPORTED_GET_VARIABLE				0x0010
 677#define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME			0x0020
 678#define EFI_RT_SUPPORTED_SET_VARIABLE				0x0040
 679#define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP		0x0080
 680#define EFI_RT_SUPPORTED_CONVERT_POINTER			0x0100
 681#define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT		0x0200
 682#define EFI_RT_SUPPORTED_RESET_SYSTEM				0x0400
 683#define EFI_RT_SUPPORTED_UPDATE_CAPSULE				0x0800
 684#define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES		0x1000
 685#define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO			0x2000
 686
 687#define EFI_RT_SUPPORTED_ALL					0x3fff
 688
 689#define EFI_RT_SUPPORTED_TIME_SERVICES				0x0003
 690#define EFI_RT_SUPPORTED_WAKEUP_SERVICES			0x000c
 691#define EFI_RT_SUPPORTED_VARIABLE_SERVICES			0x0070
 692
 693extern struct mm_struct efi_mm;
 694
 695static inline bool mm_is_efi(struct mm_struct *mm)
 696{
 697	return IS_ENABLED(CONFIG_EFI) && mm == &efi_mm;
 698}
 699
 700static inline int
 701efi_guidcmp (efi_guid_t left, efi_guid_t right)
 702{
 703	return memcmp(&left, &right, sizeof (efi_guid_t));
 704}
 705
 706static inline char *
 707efi_guid_to_str(efi_guid_t *guid, char *out)
 708{
 709	sprintf(out, "%pUl", guid->b);
 710        return out;
 711}
 712
 713extern void efi_init (void);
 714extern void efi_earlycon_reprobe(void);
 715#ifdef CONFIG_EFI
 716extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
 717#else
 718static inline void efi_enter_virtual_mode (void) {}
 719#endif
 720#ifdef CONFIG_X86
 721extern efi_status_t efi_query_variable_store(u32 attributes,
 722					     unsigned long size,
 723					     bool nonblocking);
 724#else
 725
 726static inline efi_status_t efi_query_variable_store(u32 attributes,
 727						    unsigned long size,
 728						    bool nonblocking)
 729{
 730	return EFI_SUCCESS;
 731}
 732#endif
 733
 734extern int __init __efi_memmap_init(struct efi_memory_map_data *data);
 735extern int __init efi_memmap_init_early(struct efi_memory_map_data *data);
 736extern int __init efi_memmap_init_late(phys_addr_t addr, unsigned long size);
 737extern void __init efi_memmap_unmap(void);
 738
 739#ifdef CONFIG_EFI_ESRT
 740extern void __init efi_esrt_init(void);
 741#else
 742static inline void efi_esrt_init(void) { }
 743#endif
 744extern int efi_config_parse_tables(const efi_config_table_t *config_tables,
 745				   int count,
 746				   const efi_config_table_type_t *arch_tables);
 747extern int efi_systab_check_header(const efi_table_hdr_t *systab_hdr);
 748extern void efi_systab_report_header(const efi_table_hdr_t *systab_hdr,
 749				     unsigned long fw_vendor);
 750extern u64 efi_get_iobase (void);
 751extern int efi_mem_type(unsigned long phys_addr);
 752extern u64 efi_mem_attributes (unsigned long phys_addr);
 753extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 754extern int __init efi_uart_console_only (void);
 755extern u64 efi_mem_desc_end(efi_memory_desc_t *md);
 756extern int efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
 757extern int __efi_mem_desc_lookup(u64 phys_addr, efi_memory_desc_t *out_md);
 758extern void efi_mem_reserve(phys_addr_t addr, u64 size);
 759extern int efi_mem_reserve_persistent(phys_addr_t addr, u64 size);
 760extern u64 efi_get_fdt_params(struct efi_memory_map_data *data);
 761extern struct kobject *efi_kobj;
 762
 763extern int efi_reboot_quirk_mode;
 764extern bool efi_poweroff_required(void);
 765
 766extern unsigned long efi_mem_attr_table;
 767
 768/*
 769 * efi_memattr_perm_setter - arch specific callback function passed into
 770 *                           efi_memattr_apply_permissions() that updates the
 771 *                           mapping permissions described by the second
 772 *                           argument in the page tables referred to by the
 773 *                           first argument.
 774 */
 775typedef int (*efi_memattr_perm_setter)(struct mm_struct *, efi_memory_desc_t *, bool);
 776
 777extern void efi_memattr_init(void);
 778extern int efi_memattr_apply_permissions(struct mm_struct *mm,
 779					 efi_memattr_perm_setter fn);
 780
 781/*
 782 * efi_memdesc_ptr - get the n-th EFI memmap descriptor
 783 * @map: the start of efi memmap
 784 * @desc_size: the size of space for each EFI memmap descriptor
 785 * @n: the index of efi memmap descriptor
 786 *
 787 * EFI boot service provides the GetMemoryMap() function to get a copy of the
 788 * current memory map which is an array of memory descriptors, each of
 789 * which describes a contiguous block of memory. It also gets the size of the
 790 * map, and the size of each descriptor, etc.
 791 *
 792 * Note that per section 6.2 of UEFI Spec 2.6 Errata A, the returned size of
 793 * each descriptor might not be equal to sizeof(efi_memory_memdesc_t),
 794 * since efi_memory_memdesc_t may be extended in the future. Thus the OS
 795 * MUST use the returned size of the descriptor to find the start of each
 796 * efi_memory_memdesc_t in the memory map array. This should only be used
 797 * during bootup since for_each_efi_memory_desc_xxx() is available after the
 798 * kernel initializes the EFI subsystem to set up struct efi_memory_map.
 799 */
 800#define efi_memdesc_ptr(map, desc_size, n)			\
 801	(efi_memory_desc_t *)((void *)(map) + ((n) * (desc_size)))
 802
 803/* Iterate through an efi_memory_map */
 804#define for_each_efi_memory_desc_in_map(m, md)				   \
 805	for ((md) = (m)->map;						   \
 806	     (md) && ((void *)(md) + (m)->desc_size) <= (m)->map_end;	   \
 807	     (md) = (void *)(md) + (m)->desc_size)
 808
 809/**
 810 * for_each_efi_memory_desc - iterate over descriptors in efi.memmap
 811 * @md: the efi_memory_desc_t * iterator
 812 *
 813 * Once the loop finishes @md must not be accessed.
 814 */
 815#define for_each_efi_memory_desc(md) \
 816	for_each_efi_memory_desc_in_map(&efi.memmap, md)
 817
 818/*
 819 * Format an EFI memory descriptor's type and attributes to a user-provided
 820 * character buffer, as per snprintf(), and return the buffer.
 821 */
 822char * __init efi_md_typeattr_format(char *buf, size_t size,
 823				     const efi_memory_desc_t *md);
 824
 825
 826typedef void (*efi_element_handler_t)(const char *source,
 827				      const void *element_data,
 828				      size_t element_size);
 829extern int __init parse_efi_signature_list(
 830	const char *source,
 831	const void *data, size_t size,
 832	efi_element_handler_t (*get_handler_for_guid)(const efi_guid_t *));
 833
 834/**
 835 * efi_range_is_wc - check the WC bit on an address range
 836 * @start: starting kvirt address
 837 * @len: length of range
 838 *
 839 * Consult the EFI memory map and make sure it's ok to set this range WC.
 840 * Returns true or false.
 841 */
 842static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 843{
 844	unsigned long i;
 845
 846	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 847		unsigned long paddr = __pa(start + i);
 848		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 849			return 0;
 850	}
 851	/* The range checked out */
 852	return 1;
 853}
 854
 855/*
 856 * We play games with efi_enabled so that the compiler will, if
 857 * possible, remove EFI-related code altogether.
 858 */
 859#define EFI_BOOT		0	/* Were we booted from EFI? */
 860#define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
 861#define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
 862#define EFI_MEMMAP		4	/* Can we use EFI memory map? */
 863#define EFI_64BIT		5	/* Is the firmware 64-bit? */
 864#define EFI_PARAVIRT		6	/* Access is via a paravirt interface */
 865#define EFI_ARCH_1		7	/* First arch-specific bit */
 866#define EFI_DBG			8	/* Print additional debug info at runtime */
 867#define EFI_MEM_ATTR		9	/* Did firmware publish an EFI_MEMORY_ATTRIBUTES table? */
 868#define EFI_MEM_NO_SOFT_RESERVE	10	/* Is the kernel configured to ignore soft reservations? */
 869#define EFI_PRESERVE_BS_REGIONS	11	/* Are EFI boot-services memory segments available? */
 870
 871#ifdef CONFIG_EFI
 872/*
 873 * Test whether the above EFI_* bits are enabled.
 874 */
 875static inline bool efi_enabled(int feature)
 876{
 877	return test_bit(feature, &efi.flags) != 0;
 878}
 879extern void efi_reboot(enum reboot_mode reboot_mode, const char *__unused);
 880
 881bool __pure __efi_soft_reserve_enabled(void);
 882
 883static inline bool __pure efi_soft_reserve_enabled(void)
 884{
 885	return IS_ENABLED(CONFIG_EFI_SOFT_RESERVE)
 886		&& __efi_soft_reserve_enabled();
 887}
 888
 889static inline bool efi_rt_services_supported(unsigned int mask)
 890{
 891	return (efi.runtime_supported_mask & mask) == mask;
 892}
 893extern void efi_find_mirror(void);
 894#else
 895static inline bool efi_enabled(int feature)
 896{
 897	return false;
 898}
 899static inline void
 900efi_reboot(enum reboot_mode reboot_mode, const char *__unused) {}
 901
 902static inline bool efi_soft_reserve_enabled(void)
 903{
 904	return false;
 905}
 906
 907static inline bool efi_rt_services_supported(unsigned int mask)
 908{
 909	return false;
 910}
 911
 912static inline void efi_find_mirror(void) {}
 913#endif
 914
 915extern int efi_status_to_err(efi_status_t status);
 916
 917/*
 918 * Variable Attributes
 919 */
 920#define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
 921#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
 922#define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
 923#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
 924#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
 925#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
 926#define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
 927
 928#define EFI_VARIABLE_MASK	(EFI_VARIABLE_NON_VOLATILE | \
 929				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
 930				EFI_VARIABLE_RUNTIME_ACCESS | \
 931				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
 932				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
 933				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
 934				EFI_VARIABLE_APPEND_WRITE)
 935/*
 936 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
 937 * not including trailing NUL
 938 */
 939#define EFI_VARIABLE_GUID_LEN	UUID_STRING_LEN
 940
 941/*
 942 * EFI Device Path information
 943 */
 944#define EFI_DEV_HW			0x01
 945#define  EFI_DEV_PCI				 1
 946#define  EFI_DEV_PCCARD				 2
 947#define  EFI_DEV_MEM_MAPPED			 3
 948#define  EFI_DEV_VENDOR				 4
 949#define  EFI_DEV_CONTROLLER			 5
 950#define EFI_DEV_ACPI			0x02
 951#define   EFI_DEV_BASIC_ACPI			 1
 952#define   EFI_DEV_EXPANDED_ACPI			 2
 953#define EFI_DEV_MSG			0x03
 954#define   EFI_DEV_MSG_ATAPI			 1
 955#define   EFI_DEV_MSG_SCSI			 2
 956#define   EFI_DEV_MSG_FC			 3
 957#define   EFI_DEV_MSG_1394			 4
 958#define   EFI_DEV_MSG_USB			 5
 959#define   EFI_DEV_MSG_USB_CLASS			15
 960#define   EFI_DEV_MSG_I20			 6
 961#define   EFI_DEV_MSG_MAC			11
 962#define   EFI_DEV_MSG_IPV4			12
 963#define   EFI_DEV_MSG_IPV6			13
 964#define   EFI_DEV_MSG_INFINIBAND		 9
 965#define   EFI_DEV_MSG_UART			14
 966#define   EFI_DEV_MSG_VENDOR			10
 967#define EFI_DEV_MEDIA			0x04
 968#define   EFI_DEV_MEDIA_HARD_DRIVE		 1
 969#define   EFI_DEV_MEDIA_CDROM			 2
 970#define   EFI_DEV_MEDIA_VENDOR			 3
 971#define   EFI_DEV_MEDIA_FILE			 4
 972#define   EFI_DEV_MEDIA_PROTOCOL		 5
 973#define   EFI_DEV_MEDIA_REL_OFFSET		 8
 974#define EFI_DEV_BIOS_BOOT		0x05
 975#define EFI_DEV_END_PATH		0x7F
 976#define EFI_DEV_END_PATH2		0xFF
 977#define   EFI_DEV_END_INSTANCE			0x01
 978#define   EFI_DEV_END_ENTIRE			0xFF
 979
 980struct efi_generic_dev_path {
 981	u8				type;
 982	u8				sub_type;
 983	u16				length;
 984} __packed;
 985
 986struct efi_acpi_dev_path {
 987	struct efi_generic_dev_path	header;
 988	u32				hid;
 989	u32				uid;
 990} __packed;
 991
 992struct efi_pci_dev_path {
 993	struct efi_generic_dev_path	header;
 994	u8				fn;
 995	u8				dev;
 996} __packed;
 997
 998struct efi_vendor_dev_path {
 999	struct efi_generic_dev_path	header;
1000	efi_guid_t			vendorguid;
1001	u8				vendordata[];
1002} __packed;
1003
1004struct efi_rel_offset_dev_path {
1005	struct efi_generic_dev_path	header;
1006	u32				reserved;
1007	u64				starting_offset;
1008	u64				ending_offset;
1009} __packed;
1010
1011struct efi_mem_mapped_dev_path {
1012	struct efi_generic_dev_path	header;
1013	u32				memory_type;
1014	u64				starting_addr;
1015	u64				ending_addr;
1016} __packed;
1017
1018struct efi_file_path_dev_path {
1019	struct efi_generic_dev_path	header;
1020	efi_char16_t			filename[];
1021} __packed;
1022
1023struct efi_dev_path {
1024	union {
1025		struct efi_generic_dev_path	header;
1026		struct efi_acpi_dev_path	acpi;
1027		struct efi_pci_dev_path		pci;
1028		struct efi_vendor_dev_path	vendor;
1029		struct efi_rel_offset_dev_path	rel_offset;
1030	};
1031} __packed;
1032
1033struct device *efi_get_device_by_path(const struct efi_dev_path **node,
1034				      size_t *len);
1035
1036static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
1037{
1038	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
1039	*addr &= PAGE_MASK;
1040}
1041
1042/*
1043 * EFI Variable support.
1044 *
1045 * Different firmware drivers can expose their EFI-like variables using
1046 * the following.
1047 */
1048
1049struct efivar_operations {
1050	efi_get_variable_t *get_variable;
1051	efi_get_next_variable_t *get_next_variable;
1052	efi_set_variable_t *set_variable;
1053	efi_set_variable_t *set_variable_nonblocking;
1054	efi_query_variable_store_t *query_variable_store;
1055	efi_query_variable_info_t *query_variable_info;
1056};
1057
1058struct efivars {
1059	struct kset *kset;
1060	const struct efivar_operations *ops;
1061};
1062
1063#ifdef CONFIG_X86
1064u64 __attribute_const__ efivar_reserved_space(void);
1065#else
1066static inline u64 efivar_reserved_space(void) { return 0; }
1067#endif
1068
1069/*
1070 * There is no actual upper limit specified for the variable name size.
1071 *
1072 * This limit exists only for practical purposes, since name conversions
1073 * are bounds-checked and name data is occasionally stored in-line.
1074 */
1075#define EFI_VAR_NAME_LEN	1024
1076
1077int efivars_register(struct efivars *efivars,
1078		     const struct efivar_operations *ops);
1079int efivars_unregister(struct efivars *efivars);
1080
1081#ifdef CONFIG_EFI
1082bool efivar_is_available(void);
1083#else
1084static inline bool efivar_is_available(void) { return false; }
1085#endif
1086
1087bool efivar_supports_writes(void);
1088
1089int efivar_lock(void);
1090int efivar_trylock(void);
1091void efivar_unlock(void);
1092
1093efi_status_t efivar_get_variable(efi_char16_t *name, efi_guid_t *vendor,
1094				 u32 *attr, unsigned long *size, void *data);
1095
1096efi_status_t efivar_get_next_variable(unsigned long *name_size,
1097				      efi_char16_t *name, efi_guid_t *vendor);
1098
1099efi_status_t efivar_set_variable_locked(efi_char16_t *name, efi_guid_t *vendor,
1100					u32 attr, unsigned long data_size,
1101					void *data, bool nonblocking);
1102
1103efi_status_t efivar_set_variable(efi_char16_t *name, efi_guid_t *vendor,
1104				 u32 attr, unsigned long data_size, void *data);
1105
1106efi_status_t efivar_query_variable_info(u32 attr, u64 *storage_space,
1107					u64 *remaining_space,
1108					u64 *max_variable_size);
1109
1110#if IS_ENABLED(CONFIG_EFI_CAPSULE_LOADER)
1111extern bool efi_capsule_pending(int *reset_type);
1112
1113extern int efi_capsule_supported(efi_guid_t guid, u32 flags,
1114				 size_t size, int *reset);
1115
1116extern int efi_capsule_update(efi_capsule_header_t *capsule,
1117			      phys_addr_t *pages);
1118#else
1119static inline bool efi_capsule_pending(int *reset_type) { return false; }
1120#endif
1121
1122#ifdef CONFIG_EFI
1123extern bool efi_runtime_disabled(void);
1124#else
1125static inline bool efi_runtime_disabled(void) { return true; }
1126#endif
1127
1128extern void efi_call_virt_check_flags(unsigned long flags, const void *caller);
1129extern unsigned long efi_call_virt_save_flags(void);
1130
1131void efi_runtime_assert_lock_held(void);
1132
1133enum efi_secureboot_mode {
1134	efi_secureboot_mode_unset,
1135	efi_secureboot_mode_unknown,
1136	efi_secureboot_mode_disabled,
1137	efi_secureboot_mode_enabled,
1138};
1139
1140static inline
1141enum efi_secureboot_mode efi_get_secureboot_mode(efi_get_variable_t *get_var)
1142{
1143	u8 secboot, setupmode = 0;
1144	efi_status_t status;
1145	unsigned long size;
1146
1147	size = sizeof(secboot);
1148	status = get_var(L"SecureBoot", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size,
1149			 &secboot);
1150	if (status == EFI_NOT_FOUND)
1151		return efi_secureboot_mode_disabled;
1152	if (status != EFI_SUCCESS)
1153		return efi_secureboot_mode_unknown;
1154
1155	size = sizeof(setupmode);
1156	get_var(L"SetupMode", &EFI_GLOBAL_VARIABLE_GUID, NULL, &size, &setupmode);
1157	if (secboot == 0 || setupmode == 1)
1158		return efi_secureboot_mode_disabled;
1159	return efi_secureboot_mode_enabled;
1160}
1161
1162#ifdef CONFIG_EFI_EMBEDDED_FIRMWARE
1163void efi_check_for_embedded_firmwares(void);
1164#else
1165static inline void efi_check_for_embedded_firmwares(void) { }
1166#endif
1167
1168#define arch_efi_call_virt(p, f, args...)	((p)->f(args))
1169
1170/*
1171 * Arch code must implement the following three routines:
1172 *
1173 *  * arch_efi_call_virt_setup()
1174 *
1175 *    Sets up the environment for the call (e.g. switching page tables,
1176 *    allowing kernel-mode use of floating point, if required).
1177 *
1178 *  * arch_efi_call_virt()
1179 *
1180 *    Performs the call. This routine takes a variable number of arguments so
1181 *    it must be implemented as a variadic preprocessor macro.
1182 *
1183 *  * arch_efi_call_virt_teardown()
1184 *
1185 *    Restores the usual kernel environment once the call has returned.
1186 */
1187
1188#define efi_call_virt_pointer(p, f, args...)				\
1189({									\
1190	typeof((p)->f(args)) __s;					\
1191	unsigned long __flags;						\
1192									\
1193	arch_efi_call_virt_setup();					\
1194									\
1195	__flags = efi_call_virt_save_flags();				\
1196	__s = arch_efi_call_virt(p, f, args);				\
1197	efi_call_virt_check_flags(__flags, NULL);			\
1198									\
1199	arch_efi_call_virt_teardown();					\
1200									\
1201	__s;								\
1202})
1203
1204#define EFI_RANDOM_SEED_SIZE		32U // BLAKE2S_HASH_SIZE
1205
1206struct linux_efi_random_seed {
1207	u32	size;
1208	u8	bits[];
1209};
1210
1211struct linux_efi_tpm_eventlog {
1212	u32	size;
1213	u32	final_events_preboot_size;
1214	u8	version;
1215	u8	log[];
1216};
1217
1218extern int efi_tpm_eventlog_init(void);
1219
1220struct efi_tcg2_final_events_table {
1221	u64 version;
1222	u64 nr_events;
1223	u8 events[];
1224};
1225extern int efi_tpm_final_log_size;
1226
1227extern unsigned long rci2_table_phys;
1228
1229efi_status_t
1230efi_call_acpi_prm_handler(efi_status_t (__efiapi *handler_addr)(u64, void *),
1231			  u64 param_buffer_addr, void *context);
1232
1233/*
1234 * efi_runtime_service() function identifiers.
1235 * "NONE" is used by efi_recover_from_page_fault() to check if the page
1236 * fault happened while executing an efi runtime service.
1237 */
1238enum efi_rts_ids {
1239	EFI_NONE,
1240	EFI_GET_TIME,
1241	EFI_SET_TIME,
1242	EFI_GET_WAKEUP_TIME,
1243	EFI_SET_WAKEUP_TIME,
1244	EFI_GET_VARIABLE,
1245	EFI_GET_NEXT_VARIABLE,
1246	EFI_SET_VARIABLE,
1247	EFI_QUERY_VARIABLE_INFO,
1248	EFI_GET_NEXT_HIGH_MONO_COUNT,
1249	EFI_RESET_SYSTEM,
1250	EFI_UPDATE_CAPSULE,
1251	EFI_QUERY_CAPSULE_CAPS,
1252	EFI_ACPI_PRM_HANDLER,
1253};
1254
1255union efi_rts_args;
1256
1257/*
1258 * efi_runtime_work:	Details of EFI Runtime Service work
1259 * @args:		Pointer to union describing the arguments
1260 * @status:		Status of executing EFI Runtime Service
1261 * @efi_rts_id:		EFI Runtime Service function identifier
1262 * @efi_rts_comp:	Struct used for handling completions
1263 * @caller:		The caller of the runtime service
1264 */
1265struct efi_runtime_work {
1266	union efi_rts_args	*args;
1267	efi_status_t		status;
1268	struct work_struct	work;
1269	enum efi_rts_ids	efi_rts_id;
1270	struct completion	efi_rts_comp;
1271	const void		*caller;
1272};
1273
1274extern struct efi_runtime_work efi_rts_work;
1275
1276/* Workqueue to queue EFI Runtime Services */
1277extern struct workqueue_struct *efi_rts_wq;
1278
1279struct linux_efi_memreserve {
1280	int		size;			// allocated size of the array
1281	atomic_t	count;			// number of entries used
1282	phys_addr_t	next;			// pa of next struct instance
1283	struct {
1284		phys_addr_t	base;
1285		phys_addr_t	size;
1286	} entry[];
1287};
1288
1289#define EFI_MEMRESERVE_COUNT(size) (((size) - sizeof(struct linux_efi_memreserve)) \
1290	/ sizeof_field(struct linux_efi_memreserve, entry[0]))
1291
1292void __init efi_arch_mem_reserve(phys_addr_t addr, u64 size);
1293
1294/*
1295 * The LINUX_EFI_MOK_VARIABLE_TABLE_GUID config table can be provided
1296 * to the kernel by an EFI boot loader. The table contains a packed
1297 * sequence of these entries, one for each named MOK variable.
1298 * The sequence is terminated by an entry with a completely NULL
1299 * name and 0 data size.
1300 */
1301struct efi_mokvar_table_entry {
1302	char name[256];
1303	u64 data_size;
1304	u8 data[];
1305} __attribute((packed));
1306
1307#ifdef CONFIG_LOAD_UEFI_KEYS
1308extern void __init efi_mokvar_table_init(void);
1309extern struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1310			struct efi_mokvar_table_entry **mokvar_entry);
1311extern struct efi_mokvar_table_entry *efi_mokvar_entry_find(const char *name);
1312#else
1313static inline void efi_mokvar_table_init(void) { }
1314static inline struct efi_mokvar_table_entry *efi_mokvar_entry_next(
1315			struct efi_mokvar_table_entry **mokvar_entry)
1316{
1317	return NULL;
1318}
1319static inline struct efi_mokvar_table_entry *efi_mokvar_entry_find(
1320			const char *name)
1321{
1322	return NULL;
1323}
1324#endif
1325
1326extern void efifb_setup_from_dmi(struct screen_info *si, const char *opt);
1327
1328struct linux_efi_coco_secret_area {
1329	u64	base_pa;
1330	u64	size;
1331};
1332
1333struct linux_efi_initrd {
1334	unsigned long	base;
1335	unsigned long	size;
1336};
1337
1338/* Header of a populated EFI secret area */
1339#define EFI_SECRET_TABLE_HEADER_GUID	EFI_GUID(0x1e74f542, 0x71dd, 0x4d66,  0x96, 0x3e, 0xef, 0x42, 0x87, 0xff, 0x17, 0x3b)
1340
1341bool xen_efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table);
1342
1343static __always_inline
1344bool efi_config_table_is_usable(const efi_guid_t *guid, unsigned long table)
1345{
1346	if (!IS_ENABLED(CONFIG_XEN_EFI))
1347		return true;
1348	return xen_efi_config_table_is_usable(guid, table);
1349}
1350
1351umode_t efi_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n);
1352
1353int ovmf_log_probe(unsigned long ovmf_debug_log_table);
1354
1355/*
1356 * efivar ops event type
1357 */
1358#define EFIVAR_OPS_RDONLY 0
1359#define EFIVAR_OPS_RDWR 1
1360
1361extern struct blocking_notifier_head efivar_ops_nh;
1362
1363void efivars_generic_ops_register(void);
1364void efivars_generic_ops_unregister(void);
1365
1366#endif /* _LINUX_EFI_H */