[thirdparty/u-boot.git] / include / efi.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Extensible Firmware Interface
 * Based on 'Extensible Firmware Interface Specification' version 0.9,
 * April 30, 1999
 *
 * Copyright (C) 1999 VA Linux Systems
 * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
 *	David Mosberger-Tang <davidm@hpl.hp.com>
 *	Stephane Eranian <eranian@hpl.hp.com>
 *
 * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
 */

#ifndef _EFI_H
#define _EFI_H

#include <linux/linkage.h>
#include <linux/string.h>
#include <linux/types.h>

/*
 * EFI on x86_64 uses the Microsoft ABI which is not the default for GCC.
 *
 * There are two scenarios for EFI on x86_64: building a 64-bit EFI stub
 * codes (CONFIG_EFI_STUB_64BIT) and building a 64-bit U-Boot (CONFIG_X86_64).
 * Either needs to be properly built with the '-m64' compiler flag, and hence
 * it is enough to only check the compiler provided define __x86_64__ here.
 */
#ifdef __x86_64__
#define EFIAPI __attribute__((ms_abi))
#define efi_va_list __builtin_ms_va_list
#define efi_va_start __builtin_ms_va_start
#define efi_va_arg __builtin_va_arg
#define efi_va_end __builtin_ms_va_end
#else
#define EFIAPI asmlinkage
#define efi_va_list va_list
#define efi_va_start va_start
#define efi_va_arg va_arg
#define efi_va_end va_end
#endif /* __x86_64__ */

#define EFI32_LOADER_SIGNATURE	"EL32"
#define EFI64_LOADER_SIGNATURE	"EL64"

struct efi_device_path;

typedef struct {
	u8 b[16];
} efi_guid_t __attribute__((aligned(8)));

#define EFI_BITS_PER_LONG	(sizeof(long) * 8)

/* Bit mask for EFI status code with error */
#define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
/* Status codes returned by EFI protocols */
#define EFI_SUCCESS			0
#define EFI_LOAD_ERROR			(EFI_ERROR_MASK | 1)
#define EFI_INVALID_PARAMETER		(EFI_ERROR_MASK | 2)
#define EFI_UNSUPPORTED			(EFI_ERROR_MASK | 3)
#define EFI_BAD_BUFFER_SIZE		(EFI_ERROR_MASK | 4)
#define EFI_BUFFER_TOO_SMALL		(EFI_ERROR_MASK | 5)
#define EFI_NOT_READY			(EFI_ERROR_MASK | 6)
#define EFI_DEVICE_ERROR		(EFI_ERROR_MASK | 7)
#define EFI_WRITE_PROTECTED		(EFI_ERROR_MASK | 8)
#define EFI_OUT_OF_RESOURCES		(EFI_ERROR_MASK | 9)
#define EFI_VOLUME_CORRUPTED		(EFI_ERROR_MASK | 10)
#define EFI_VOLUME_FULL			(EFI_ERROR_MASK | 11)
#define EFI_NO_MEDIA			(EFI_ERROR_MASK | 12)
#define EFI_MEDIA_CHANGED		(EFI_ERROR_MASK | 13)
#define EFI_NOT_FOUND			(EFI_ERROR_MASK | 14)
#define EFI_ACCESS_DENIED		(EFI_ERROR_MASK | 15)
#define EFI_NO_RESPONSE			(EFI_ERROR_MASK | 16)
#define EFI_NO_MAPPING			(EFI_ERROR_MASK | 17)
#define EFI_TIMEOUT			(EFI_ERROR_MASK | 18)
#define EFI_NOT_STARTED			(EFI_ERROR_MASK | 19)
#define EFI_ALREADY_STARTED		(EFI_ERROR_MASK | 20)
#define EFI_ABORTED			(EFI_ERROR_MASK | 21)
#define EFI_ICMP_ERROR			(EFI_ERROR_MASK | 22)
#define EFI_TFTP_ERROR			(EFI_ERROR_MASK | 23)
#define EFI_PROTOCOL_ERROR		(EFI_ERROR_MASK | 24)
#define EFI_INCOMPATIBLE_VERSION	(EFI_ERROR_MASK | 25)
#define EFI_SECURITY_VIOLATION		(EFI_ERROR_MASK | 26)
#define EFI_CRC_ERROR			(EFI_ERROR_MASK | 27)
#define EFI_END_OF_MEDIA		(EFI_ERROR_MASK | 28)
#define EFI_END_OF_FILE			(EFI_ERROR_MASK | 31)
#define EFI_INVALID_LANGUAGE		(EFI_ERROR_MASK | 32)
#define EFI_COMPROMISED_DATA		(EFI_ERROR_MASK | 33)
#define EFI_IP_ADDRESS_CONFLICT		(EFI_ERROR_MASK | 34)
#define EFI_HTTP_ERROR			(EFI_ERROR_MASK | 35)

#define EFI_WARN_UNKNOWN_GLYPH		1
#define EFI_WARN_DELETE_FAILURE		2
#define EFI_WARN_WRITE_FAILURE		3
#define EFI_WARN_BUFFER_TOO_SMALL	4
#define EFI_WARN_STALE_DATA		5
#define EFI_WARN_FILE_SYSTEM		6
#define EFI_WARN_RESET_REQUIRED		7

typedef unsigned long efi_status_t;
typedef u64 efi_physical_addr_t;
typedef u64 efi_virtual_addr_t;
typedef struct efi_object *efi_handle_t;

#define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
	{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
		((a) >> 24) & 0xff, \
		(b) & 0xff, ((b) >> 8) & 0xff, \
		(c) & 0xff, ((c) >> 8) & 0xff, \
		(d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }

/* Generic EFI table header */
struct efi_table_hdr {
	u64 signature;
	u32 revision;
	u32 headersize;
	u32 crc32;
	u32 reserved;
};

/* Enumeration of memory types introduced in UEFI */
enum efi_mem_type {
	EFI_RESERVED_MEMORY_TYPE,
	/*
	 * The code portions of a loaded application.
	 * (Note that UEFI OS loaders are UEFI applications.)
	 */
	EFI_LOADER_CODE,
	/*
	 * The data portions of a loaded application and
	 * the default data allocation type used by an application
	 * to allocate pool memory.
	 */
	EFI_LOADER_DATA,
	/* The code portions of a loaded Boot Services Driver */
	EFI_BOOT_SERVICES_CODE,
	/*
	 * The data portions of a loaded Boot Services Driver and
	 * the default data allocation type used by a Boot Services
	 * Driver to allocate pool memory.
	 */
	EFI_BOOT_SERVICES_DATA,
	/* The code portions of a loaded Runtime Services Driver */
	EFI_RUNTIME_SERVICES_CODE,
	/*
	 * The data portions of a loaded Runtime Services Driver and
	 * the default data allocation type used by a Runtime Services
	 * Driver to allocate pool memory.
	 */
	EFI_RUNTIME_SERVICES_DATA,
	/* Free (unallocated) memory */
	EFI_CONVENTIONAL_MEMORY,
	/* Memory in which errors have been detected */
	EFI_UNUSABLE_MEMORY,
	/* Memory that holds the ACPI tables */
	EFI_ACPI_RECLAIM_MEMORY,
	/* Address space reserved for use by the firmware */
	EFI_ACPI_MEMORY_NVS,
	/*
	 * Used by system firmware to request that a memory-mapped IO region
	 * be mapped by the OS to a virtual address so it can be accessed by
	 * EFI runtime services.
	 */
	EFI_MMAP_IO,
	/*
	 * System memory-mapped IO region that is used to translate
	 * memory cycles to IO cycles by the processor.
	 */
	EFI_MMAP_IO_PORT,
	/*
	 * Address space reserved by the firmware for code that is
	 * part of the processor.
	 */
	EFI_PAL_CODE,
	/*
	 * Non-volatile memory.
	 */
	EFI_PERSISTENT_MEMORY_TYPE,

	EFI_MAX_MEMORY_TYPE,
	EFI_TABLE_END,	/* For efi_build_mem_table() */
};

/* Attribute values */
#define EFI_MEMORY_UC		((u64)0x0000000000000001ULL)	/* uncached */
#define EFI_MEMORY_WC		((u64)0x0000000000000002ULL)	/* write-coalescing */
#define EFI_MEMORY_WT		((u64)0x0000000000000004ULL)	/* write-through */
#define EFI_MEMORY_WB		((u64)0x0000000000000008ULL)	/* write-back */
#define EFI_MEMORY_UCE		((u64)0x0000000000000010ULL)	/* uncached, exported */
#define EFI_MEMORY_WP		((u64)0x0000000000001000ULL)	/* write-protect */
#define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
#define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
#define EFI_MEMORY_NV		((u64)0x0000000000008000ULL)	/* non-volatile */
#define EFI_MEMORY_MORE_RELIABLE \
				((u64)0x0000000000010000ULL)	/* higher reliability */
#define EFI_MEMORY_RO		((u64)0x0000000000020000ULL)	/* read-only */
#define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
#define EFI_MEM_DESC_VERSION	1

#define EFI_PAGE_SHIFT		12
#define EFI_PAGE_SIZE		(1ULL << EFI_PAGE_SHIFT)
#define EFI_PAGE_MASK		(EFI_PAGE_SIZE - 1)

struct efi_mem_desc {
	u32 type;
	u32 reserved;
	efi_physical_addr_t physical_start;
	efi_virtual_addr_t virtual_start;
	u64 num_pages;
	u64 attribute;
};

#define EFI_MEMORY_DESCRIPTOR_VERSION 1

/* Allocation types for calls to boottime->allocate_pages*/
#define EFI_ALLOCATE_ANY_PAGES		0
#define EFI_ALLOCATE_MAX_ADDRESS	1
#define EFI_ALLOCATE_ADDRESS		2
#define EFI_MAX_ALLOCATE_TYPE		3

/* Types and defines for Time Services */
#define EFI_TIME_ADJUST_DAYLIGHT 0x1
#define EFI_TIME_IN_DAYLIGHT     0x2
#define EFI_UNSPECIFIED_TIMEZONE 0x07ff

struct efi_time {
	u16 year;
	u8 month;
	u8 day;
	u8 hour;
	u8 minute;
	u8 second;
	u8 pad1;
	u32 nanosecond;
	s16 timezone;
	u8 daylight;
	u8 pad2;
};

struct efi_time_cap {
	u32 resolution;
	u32 accuracy;
	u8 sets_to_zero;
};

enum efi_locate_search_type {
	ALL_HANDLES,
	BY_REGISTER_NOTIFY,
	BY_PROTOCOL
};

struct efi_open_protocol_info_entry {
	efi_handle_t agent_handle;
	efi_handle_t controller_handle;
	u32 attributes;
	u32 open_count;
};

enum efi_entry_t {
	EFIET_END,	/* Signals this is the last (empty) entry */
	EFIET_MEMORY_MAP,
	EFIET_GOP_MODE,
	EFIET_SYS_TABLE,

	/* Number of entries */
	EFIET_MEMORY_COUNT,
};

#define EFI_TABLE_VERSION	1

/**
 * struct efi_info_hdr - Header for the EFI info table
 *
 * @version:	EFI_TABLE_VERSION
 * @hdr_size:	Size of this struct in bytes
 * @total_size:	Total size of this header plus following data
 * @spare:	Spare space for expansion
 */
struct efi_info_hdr {
	u32 version;
	u32 hdr_size;
	u32 total_size;
	u32 spare[5];
};

/**
 * struct efi_entry_hdr - Header for a table entry
 *
 * @type:	enum eft_entry_t
 * @size	size of entry bytes excluding header and padding
 * @addr:	address of this entry (0 if it follows the header )
 * @link:	size of entry including header and padding
 * @spare1:	Spare space for expansion
 * @spare2:	Spare space for expansion
 */
struct efi_entry_hdr {
	u32 type;
	u32 size;
	u64 addr;
	u32 link;
	u32 spare1;
	u64 spare2;
};

/**
 * struct efi_entry_memmap - a memory map table passed to U-Boot
 *
 * @version:	EFI's memory map table version
 * @desc_size:	EFI's size of each memory descriptor
 * @spare:	Spare space for expansion
 * @desc:	An array of descriptors, each @desc_size bytes apart
 */
struct efi_entry_memmap {
	u32 version;
	u32 desc_size;
	u64 spare;
	struct efi_mem_desc desc[];
};

/**
 * struct efi_entry_gopmode - a GOP mode table passed to U-Boot
 *
 * @fb_base:	EFI's framebuffer base address
 * @fb_size:	EFI's framebuffer size
 * @info_size:	GOP mode info structure size
 * @info:	Start address of the GOP mode info structure
 */
struct efi_entry_gopmode {
	efi_physical_addr_t fb_base;
	/*
	 * Not like the ones in 'struct efi_gop_mode' which are 'unsigned
	 * long', @fb_size and @info_size have to be 'u64' here. As the EFI
	 * stub codes may have different bit size from the U-Boot payload,
	 * using 'long' will cause mismatch between the producer (stub) and
	 * the consumer (payload).
	 */
	u64 fb_size;
	u64 info_size;
	/*
	 * We cannot directly use 'struct efi_gop_mode_info info[]' here as
	 * it causes compiler to complain: array type has incomplete element
	 * type 'struct efi_gop_mode_info'.
	 */
	struct /* efi_gop_mode_info */ {
		u32 version;
		u32 width;
		u32 height;
		u32 pixel_format;
		u32 pixel_bitmask[4];
		u32 pixels_per_scanline;
	} info[];
};

/**
 * struct efi_entry_systable - system table passed to U-Boot
 *
 * @sys_table:	EFI system table address
 */
struct efi_entry_systable {
	efi_physical_addr_t sys_table;
};

static inline struct efi_mem_desc *efi_get_next_mem_desc(
		struct efi_entry_memmap *map, struct efi_mem_desc *desc)
{
	return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
}

struct efi_priv {
	efi_handle_t parent_image;
	struct efi_device_path *device_path;
	struct efi_system_table *sys_table;
	struct efi_boot_services *boot;
	struct efi_runtime_services *run;
	bool use_pool_for_malloc;
	unsigned long ram_base;
	unsigned int image_data_type;
	struct efi_info_hdr *info;
	unsigned int info_size;
	void *next_hdr;
};

/* Base address of the EFI image */
extern char image_base[];

/* Start and end of U-Boot image (for payload) */
extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];

/*
 * Variable Attributes
 */
#define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
#define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
#define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040

#define EFI_VARIABLE_MASK	(EFI_VARIABLE_NON_VOLATILE | \
				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
				EFI_VARIABLE_RUNTIME_ACCESS | \
				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
				EFI_VARIABLE_APPEND_WRITE)

/**
 * efi_get_sys_table() - Get access to the main EFI system table
 *
 * @return pointer to EFI system table
 */

struct efi_system_table *efi_get_sys_table(void);

/**
 * efi_get_ram_base() - Find the base of RAM
 *
 * This is used when U-Boot is built as an EFI application.
 *
 * @return the base of RAM as known to U-Boot
 */
unsigned long efi_get_ram_base(void);

/**
 * efi_init() - Set up ready for use of EFI boot services
 *
 * @priv:	Pointer to our private EFI structure to fill in
 * @banner:	Banner to display when starting
 * @image:	The image handle passed to efi_main()
 * @sys_table:	The EFI system table pointer passed to efi_main()
 */
int efi_init(struct efi_priv *priv, const char *banner, efi_handle_t image,
	     struct efi_system_table *sys_table);

/**
 * efi_malloc() - Allocate some memory from EFI
 *
 * @priv:	Pointer to private EFI structure
 * @size:	Number of bytes to allocate
 * @retp:	Return EFI status result
 * @return pointer to memory allocated, or NULL on error
 */
void *efi_malloc(struct efi_priv *priv, int size, efi_status_t *retp);

/**
 * efi_free() - Free memory allocated from EFI
 *
 * @priv:	Pointer to private EFI structure
 * @ptr:	Pointer to memory to free
 */
void efi_free(struct efi_priv *priv, void *ptr);

/**
 * efi_puts() - Write out a string to the EFI console
 *
 * @priv:	Pointer to private EFI structure
 * @str:	String to write (note this is a ASCII, not unicode)
 */
void efi_puts(struct efi_priv *priv, const char *str);

/**
 * efi_putc() - Write out a character to the EFI console
 *
 * @priv:	Pointer to private EFI structure
 * @ch:		Character to write (note this is not unicode)
 */
void efi_putc(struct efi_priv *priv, const char ch);

/**
 * efi_info_get() - get an entry from an EFI table
 *
 * @type:	Entry type to search for
 * @datap:	Returns pointer to entry data
 * @sizep:	Returns pointer to entry size
 * @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
 * of the requested type, -EPROTONOSUPPORT if the table has the wrong version
 */
int efi_info_get(enum efi_entry_t type, void **datap, int *sizep);

/**
 * efi_build_mem_table() - make a sorted copy of the memory table
 *
 * @map:	Pointer to EFI memory map table
 * @size:	Size of table in bytes
 * @skip_bs:	True to skip boot-time memory and merge it with conventional
 *		memory. This will significantly reduce the number of table
 *		entries.
 * @return pointer to the new table. It should be freed with free() by the
 *	   caller
 */
void *efi_build_mem_table(struct efi_entry_memmap *map, int size, bool skip_bs);

#endif /* _LINUX_EFI_H */
Commit	Line	Data
04a0f563	1	/* SPDX-License-Identifier: GPL-2.0 */
867a6ac8 SG	2	/*
	3	* Extensible Firmware Interface
	4	* Based on 'Extensible Firmware Interface Specification' version 0.9,
	5	* April 30, 1999
	6	*
	7	* Copyright (C) 1999 VA Linux Systems
	8	* Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
	9	* Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
	10	* David Mosberger-Tang <davidm@hpl.hp.com>
	11	* Stephane Eranian <eranian@hpl.hp.com>
	12	*
	13	* From include/linux/efi.h in kernel 4.1 with some additions/subtractions
	14	*/
	15
	16	#ifndef _EFI_H
	17	#define _EFI_H
	18
a0b49bc3	19	#include <linux/linkage.h>
867a6ac8 SG	20	#include <linux/string.h>
	21	#include <linux/types.h>
	22
01866446 AG	23	/*
	24	* EFI on x86_64 uses the Microsoft ABI which is not the default for GCC.
	25	*
	26	* There are two scenarios for EFI on x86_64: building a 64-bit EFI stub
	27	* codes (CONFIG_EFI_STUB_64BIT) and building a 64-bit U-Boot (CONFIG_X86_64).
	28	* Either needs to be properly built with the '-m64' compiler flag, and hence
	29	* it is enough to only check the compiler provided define __x86_64__ here.
	30	*/
	31	#ifdef __x86_64__
96a8d409	32	#define EFIAPI __attribute__((ms_abi))
beb077a2 AG	33	#define efi_va_list __builtin_ms_va_list
	34	#define efi_va_start __builtin_ms_va_start
	35	#define efi_va_arg __builtin_va_arg
	36	#define efi_va_end __builtin_ms_va_end
96a8d409	37	#else
a0b49bc3	38	#define EFIAPI asmlinkage
beb077a2 AG	39	#define efi_va_list va_list
	40	#define efi_va_start va_start
	41	#define efi_va_arg va_arg
	42	#define efi_va_end va_end
01866446	43	#endif /* __x86_64__ */
96a8d409	44
1fdeacd3 BM	45	#define EFI32_LOADER_SIGNATURE "EL32"
	46	#define EFI64_LOADER_SIGNATURE "EL64"
	47
867a6ac8 SG	48	struct efi_device_path;
867a6ac8 SG	49
0d6ab32e RC	50	typedef struct {
0d6ab32e RC	51	u8 b[16];
4b05fe9c	52	} efi_guid_t __attribute__((aligned(8)));
0d6ab32e	53
01866446	54	#define EFI_BITS_PER_LONG (sizeof(long) * 8)
3e6cc35f	55
3c8ffb68 HS	56	/* Bit mask for EFI status code with error */
	57	#define EFI_ERROR_MASK (1UL << (EFI_BITS_PER_LONG - 1))
	58	/* Status codes returned by EFI protocols */
	59	#define EFI_SUCCESS 0
	60	#define EFI_LOAD_ERROR (EFI_ERROR_MASK \| 1)
	61	#define EFI_INVALID_PARAMETER (EFI_ERROR_MASK \| 2)
	62	#define EFI_UNSUPPORTED (EFI_ERROR_MASK \| 3)
	63	#define EFI_BAD_BUFFER_SIZE (EFI_ERROR_MASK \| 4)
	64	#define EFI_BUFFER_TOO_SMALL (EFI_ERROR_MASK \| 5)
	65	#define EFI_NOT_READY (EFI_ERROR_MASK \| 6)
	66	#define EFI_DEVICE_ERROR (EFI_ERROR_MASK \| 7)
	67	#define EFI_WRITE_PROTECTED (EFI_ERROR_MASK \| 8)
	68	#define EFI_OUT_OF_RESOURCES (EFI_ERROR_MASK \| 9)
	69	#define EFI_VOLUME_CORRUPTED (EFI_ERROR_MASK \| 10)
	70	#define EFI_VOLUME_FULL (EFI_ERROR_MASK \| 11)
	71	#define EFI_NO_MEDIA (EFI_ERROR_MASK \| 12)
	72	#define EFI_MEDIA_CHANGED (EFI_ERROR_MASK \| 13)
	73	#define EFI_NOT_FOUND (EFI_ERROR_MASK \| 14)
	74	#define EFI_ACCESS_DENIED (EFI_ERROR_MASK \| 15)
	75	#define EFI_NO_RESPONSE (EFI_ERROR_MASK \| 16)
	76	#define EFI_NO_MAPPING (EFI_ERROR_MASK \| 17)
	77	#define EFI_TIMEOUT (EFI_ERROR_MASK \| 18)
	78	#define EFI_NOT_STARTED (EFI_ERROR_MASK \| 19)
	79	#define EFI_ALREADY_STARTED (EFI_ERROR_MASK \| 20)
	80	#define EFI_ABORTED (EFI_ERROR_MASK \| 21)
	81	#define EFI_ICMP_ERROR (EFI_ERROR_MASK \| 22)
	82	#define EFI_TFTP_ERROR (EFI_ERROR_MASK \| 23)
	83	#define EFI_PROTOCOL_ERROR (EFI_ERROR_MASK \| 24)
	84	#define EFI_INCOMPATIBLE_VERSION (EFI_ERROR_MASK \| 25)
	85	#define EFI_SECURITY_VIOLATION (EFI_ERROR_MASK \| 26)
	86	#define EFI_CRC_ERROR (EFI_ERROR_MASK \| 27)
	87	#define EFI_END_OF_MEDIA (EFI_ERROR_MASK \| 28)
	88	#define EFI_END_OF_FILE (EFI_ERROR_MASK \| 31)
	89	#define EFI_INVALID_LANGUAGE (EFI_ERROR_MASK \| 32)
	90	#define EFI_COMPROMISED_DATA (EFI_ERROR_MASK \| 33)
	91	#define EFI_IP_ADDRESS_CONFLICT (EFI_ERROR_MASK \| 34)
	92	#define EFI_HTTP_ERROR (EFI_ERROR_MASK \| 35)
867a6ac8	93
7b31efc5 HS	94	#define EFI_WARN_UNKNOWN_GLYPH 1
	95	#define EFI_WARN_DELETE_FAILURE 2
	96	#define EFI_WARN_WRITE_FAILURE 3
	97	#define EFI_WARN_BUFFER_TOO_SMALL 4
	98	#define EFI_WARN_STALE_DATA 5
	99	#define EFI_WARN_FILE_SYSTEM 6
	100	#define EFI_WARN_RESET_REQUIRED 7
2a92080d	101
867a6ac8 SG	102	typedef unsigned long efi_status_t;
	103	typedef u64 efi_physical_addr_t;
	104	typedef u64 efi_virtual_addr_t;
faea1041	105	typedef struct efi_object *efi_handle_t;
867a6ac8 SG	106
867a6ac8 SG	107	#define EFI_GUID(a, b, c, d0, d1, d2, d3, d4, d5, d6, d7) \
867a6ac8 SG	108	{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, \
	109	((a) >> 24) & 0xff, \
	110	(b) & 0xff, ((b) >> 8) & 0xff, \
	111	(c) & 0xff, ((c) >> 8) & 0xff, \
44ab2d32	112	(d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) } }
867a6ac8 SG	113
	114	/* Generic EFI table header */
	115	struct efi_table_hdr {
	116	u64 signature;
	117	u32 revision;
	118	u32 headersize;
	119	u32 crc32;
	120	u32 reserved;
	121	};
	122
	123	/* Enumeration of memory types introduced in UEFI */
	124	enum efi_mem_type {
	125	EFI_RESERVED_MEMORY_TYPE,
	126	/*
	127	* The code portions of a loaded application.
	128	* (Note that UEFI OS loaders are UEFI applications.)
	129	*/
	130	EFI_LOADER_CODE,
	131	/*
	132	* The data portions of a loaded application and
	133	* the default data allocation type used by an application
	134	* to allocate pool memory.
	135	*/
	136	EFI_LOADER_DATA,
	137	/* The code portions of a loaded Boot Services Driver */
	138	EFI_BOOT_SERVICES_CODE,
	139	/*
29f1a367	140	* The data portions of a loaded Boot Services Driver and
867a6ac8 SG	141	* the default data allocation type used by a Boot Services
	142	* Driver to allocate pool memory.
	143	*/
	144	EFI_BOOT_SERVICES_DATA,
	145	/* The code portions of a loaded Runtime Services Driver */
	146	EFI_RUNTIME_SERVICES_CODE,
	147	/*
	148	* The data portions of a loaded Runtime Services Driver and
	149	* the default data allocation type used by a Runtime Services
	150	* Driver to allocate pool memory.
	151	*/
	152	EFI_RUNTIME_SERVICES_DATA,
	153	/* Free (unallocated) memory */
	154	EFI_CONVENTIONAL_MEMORY,
	155	/* Memory in which errors have been detected */
	156	EFI_UNUSABLE_MEMORY,
	157	/* Memory that holds the ACPI tables */
	158	EFI_ACPI_RECLAIM_MEMORY,
	159	/* Address space reserved for use by the firmware */
	160	EFI_ACPI_MEMORY_NVS,
	161	/*
	162	* Used by system firmware to request that a memory-mapped IO region
	163	* be mapped by the OS to a virtual address so it can be accessed by
	164	* EFI runtime services.
	165	*/
	166	EFI_MMAP_IO,
	167	/*
	168	* System memory-mapped IO region that is used to translate
	169	* memory cycles to IO cycles by the processor.
	170	*/
	171	EFI_MMAP_IO_PORT,
	172	/*
	173	* Address space reserved by the firmware for code that is
	174	* part of the processor.
	175	*/
	176	EFI_PAL_CODE,
f12bcc91 HS	177	/*
	178	* Non-volatile memory.
	179	*/
	180	EFI_PERSISTENT_MEMORY_TYPE,
867a6ac8 SG	181
	182	EFI_MAX_MEMORY_TYPE,
	183	EFI_TABLE_END, /* For efi_build_mem_table() */
	184	};
	185
	186	/* Attribute values */
9b89183b ER	187	#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
	188	#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
	189	#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
	190	#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
	191	#define EFI_MEMORY_UCE ((u64)0x0000000000000010ULL) /* uncached, exported */
	192	#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
	193	#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
	194	#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
c3a40cce ER	195	#define EFI_MEMORY_NV ((u64)0x0000000000008000ULL) /* non-volatile */
	196	#define EFI_MEMORY_MORE_RELIABLE \
	197	((u64)0x0000000000010000ULL) /* higher reliability */
	198	#define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */
9b89183b ER	199	#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
9b89183b ER	200	#define EFI_MEM_DESC_VERSION 1
867a6ac8 SG	201
867a6ac8 SG	202	#define EFI_PAGE_SHIFT 12
60fd8844	203	#define EFI_PAGE_SIZE (1ULL << EFI_PAGE_SHIFT)
2bb9b79d	204	#define EFI_PAGE_MASK (EFI_PAGE_SIZE - 1)
867a6ac8 SG	205
	206	struct efi_mem_desc {
	207	u32 type;
	208	u32 reserved;
	209	efi_physical_addr_t physical_start;
	210	efi_virtual_addr_t virtual_start;
	211	u64 num_pages;
	212	u64 attribute;
	213	};
	214
4c02c11d MYK	215	#define EFI_MEMORY_DESCRIPTOR_VERSION 1
4c02c11d MYK	216
867a6ac8 SG	217	/* Allocation types for calls to boottime->allocate_pages*/
	218	#define EFI_ALLOCATE_ANY_PAGES 0
	219	#define EFI_ALLOCATE_MAX_ADDRESS 1
	220	#define EFI_ALLOCATE_ADDRESS 2
	221	#define EFI_MAX_ALLOCATE_TYPE 3
	222
	223	/* Types and defines for Time Services */
	224	#define EFI_TIME_ADJUST_DAYLIGHT 0x1
	225	#define EFI_TIME_IN_DAYLIGHT 0x2
	226	#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
	227
	228	struct efi_time {
	229	u16 year;
	230	u8 month;
	231	u8 day;
	232	u8 hour;
	233	u8 minute;
	234	u8 second;
	235	u8 pad1;
	236	u32 nanosecond;
	237	s16 timezone;
	238	u8 daylight;
	239	u8 pad2;
	240	};
	241
	242	struct efi_time_cap {
	243	u32 resolution;
	244	u32 accuracy;
	245	u8 sets_to_zero;
	246	};
	247
	248	enum efi_locate_search_type {
9f0770ff HS	249	ALL_HANDLES,
	250	BY_REGISTER_NOTIFY,
	251	BY_PROTOCOL
867a6ac8 SG	252	};
	253
	254	struct efi_open_protocol_info_entry {
	255	efi_handle_t agent_handle;
	256	efi_handle_t controller_handle;
	257	u32 attributes;
	258	u32 open_count;
	259	};
	260
	261	enum efi_entry_t {
	262	EFIET_END, /* Signals this is the last (empty) entry */
	263	EFIET_MEMORY_MAP,
d1fe9927	264	EFIET_GOP_MODE,
cbe503fb	265	EFIET_SYS_TABLE,
867a6ac8 SG	266
	267	/* Number of entries */
	268	EFIET_MEMORY_COUNT,
	269	};
	270
	271	#define EFI_TABLE_VERSION 1
	272
	273	/**
	274	* struct efi_info_hdr - Header for the EFI info table
	275	*
	276	* @version: EFI_TABLE_VERSION
	277	* @hdr_size: Size of this struct in bytes
	278	* @total_size: Total size of this header plus following data
	279	* @spare: Spare space for expansion
	280	*/
	281	struct efi_info_hdr {
	282	u32 version;
	283	u32 hdr_size;
	284	u32 total_size;
	285	u32 spare[5];
	286	};
	287
	288	/**
	289	* struct efi_entry_hdr - Header for a table entry
	290	*
	291	* @type: enum eft_entry_t
	292	* @size size of entry bytes excluding header and padding
	293	* @addr: address of this entry (0 if it follows the header )
	294	* @link: size of entry including header and padding
	295	* @spare1: Spare space for expansion
	296	* @spare2: Spare space for expansion
	297	*/
	298	struct efi_entry_hdr {
	299	u32 type;
	300	u32 size;
	301	u64 addr;
	302	u32 link;
	303	u32 spare1;
	304	u64 spare2;
	305	};
	306
	307	/**
	308	* struct efi_entry_memmap - a memory map table passed to U-Boot
	309	*
	310	* @version: EFI's memory map table version
	311	* @desc_size: EFI's size of each memory descriptor
	312	* @spare: Spare space for expansion
	313	* @desc: An array of descriptors, each @desc_size bytes apart
	314	*/
	315	struct efi_entry_memmap {
	316	u32 version;
	317	u32 desc_size;
	318	u64 spare;
	319	struct efi_mem_desc desc[];
	320	};
	321
d1fe9927 BM	322	/**
	323	* struct efi_entry_gopmode - a GOP mode table passed to U-Boot
	324	*
	325	* @fb_base: EFI's framebuffer base address
	326	* @fb_size: EFI's framebuffer size
	327	* @info_size: GOP mode info structure size
	328	* @info: Start address of the GOP mode info structure
	329	*/
	330	struct efi_entry_gopmode {
	331	efi_physical_addr_t fb_base;
	332	/*
	333	* Not like the ones in 'struct efi_gop_mode' which are 'unsigned
	334	* long', @fb_size and @info_size have to be 'u64' here. As the EFI
	335	* stub codes may have different bit size from the U-Boot payload,
	336	* using 'long' will cause mismatch between the producer (stub) and
	337	* the consumer (payload).
	338	*/
	339	u64 fb_size;
	340	u64 info_size;
	341	/*
	342	* We cannot directly use 'struct efi_gop_mode_info info[]' here as
	343	* it causes compiler to complain: array type has incomplete element
	344	* type 'struct efi_gop_mode_info'.
	345	*/
	346	struct /* efi_gop_mode_info */ {
	347	u32 version;
	348	u32 width;
	349	u32 height;
	350	u32 pixel_format;
	351	u32 pixel_bitmask[4];
	352	u32 pixels_per_scanline;
	353	} info[];
	354	};
	355
cbe503fb BM	356	/**
	357	* struct efi_entry_systable - system table passed to U-Boot
	358	*
	359	* @sys_table: EFI system table address
	360	*/
	361	struct efi_entry_systable {
	362	efi_physical_addr_t sys_table;
	363	};
	364
867a6ac8 SG	365	static inline struct efi_mem_desc *efi_get_next_mem_desc(
	366	struct efi_entry_memmap map, struct efi_mem_desc desc)
	367	{
	368	return (struct efi_mem_desc *)((ulong)desc + map->desc_size);
	369	}
	370
	371	struct efi_priv {
	372	efi_handle_t parent_image;
	373	struct efi_device_path *device_path;
	374	struct efi_system_table *sys_table;
	375	struct efi_boot_services *boot;
	376	struct efi_runtime_services *run;
	377	bool use_pool_for_malloc;
	378	unsigned long ram_base;
	379	unsigned int image_data_type;
	380	struct efi_info_hdr *info;
	381	unsigned int info_size;
	382	void *next_hdr;
	383	};
	384
	385	/* Base address of the EFI image */
	386	extern char image_base[];
	387
476476e7	388	/* Start and end of U-Boot image (for payload) */
3dc51ab0	389	extern char _binary_u_boot_bin_start[], _binary_u_boot_bin_end[];
476476e7	390
ad644e7c RC	391	/*
	392	* Variable Attributes
	393	*/
	394	#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
	395	#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
	396	#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
	397	#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
	398	#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
	399	#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
	400	#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
	401
	402	#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE \| \
	403	EFI_VARIABLE_BOOTSERVICE_ACCESS \| \
	404	EFI_VARIABLE_RUNTIME_ACCESS \| \
	405	EFI_VARIABLE_HARDWARE_ERROR_RECORD \| \
	406	EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS \| \
	407	EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS \| \
	408	EFI_VARIABLE_APPEND_WRITE)
	409
867a6ac8 SG	410	/**
	411	* efi_get_sys_table() - Get access to the main EFI system table
	412	*
	413	* @return pointer to EFI system table
	414	*/
476476e7	415
867a6ac8 SG	416	struct efi_system_table *efi_get_sys_table(void);
	417
	418	/**
	419	* efi_get_ram_base() - Find the base of RAM
	420	*
	421	* This is used when U-Boot is built as an EFI application.
	422	*
	423	* @return the base of RAM as known to U-Boot
	424	*/
	425	unsigned long efi_get_ram_base(void);
	426
	427	/**
	428	* efi_init() - Set up ready for use of EFI boot services
	429	*
	430	* @priv: Pointer to our private EFI structure to fill in
	431	* @banner: Banner to display when starting
	432	* @image: The image handle passed to efi_main()
	433	* @sys_table: The EFI system table pointer passed to efi_main()
	434	*/
	435	int efi_init(struct efi_priv priv, const char banner, efi_handle_t image,
	436	struct efi_system_table *sys_table);
	437
	438	/**
	439	* efi_malloc() - Allocate some memory from EFI
	440	*
	441	* @priv: Pointer to private EFI structure
	442	* @size: Number of bytes to allocate
	443	* @retp: Return EFI status result
	444	* @return pointer to memory allocated, or NULL on error
	445	*/
	446	void efi_malloc(struct efi_priv priv, int size, efi_status_t *retp);
	447
	448	/**
	449	* efi_free() - Free memory allocated from EFI
	450	*
	451	* @priv: Pointer to private EFI structure
	452	* @ptr: Pointer to memory to free
	453	*/
	454	void efi_free(struct efi_priv priv, void ptr);
	455
	456	/**
	457	* efi_puts() - Write out a string to the EFI console
	458	*
	459	* @priv: Pointer to private EFI structure
	460	* @str: String to write (note this is a ASCII, not unicode)
	461	*/
	462	void efi_puts(struct efi_priv priv, const char str);
	463
	464	/**
	465	* efi_putc() - Write out a character to the EFI console
	466	*
	467	* @priv: Pointer to private EFI structure
	468	* @ch: Character to write (note this is not unicode)
	469	*/
	470	void efi_putc(struct efi_priv *priv, const char ch);
	471
	472	/**
	473	* efi_info_get() - get an entry from an EFI table
	474	*
	475	* @type: Entry type to search for
	476	* @datap: Returns pointer to entry data
	477	* @sizep: Returns pointer to entry size
	478	* @return 0 if OK, -ENODATA if there is no table, -ENOENT if there is no entry
	479	* of the requested type, -EPROTONOSUPPORT if the table has the wrong version
480	*/
481	int efi_info_get(enum efi_entry_t type, void *datap, int sizep);
482
483	/**
484	* efi_build_mem_table() - make a sorted copy of the memory table
485	*
486	* @map: Pointer to EFI memory map table
487	* @size: Size of table in bytes
488	* @skip_bs: True to skip boot-time memory and merge it with conventional
489	* memory. This will significantly reduce the number of table
490	* entries.
491	* @return pointer to the new table. It should be freed with free() by the
492	* caller
493	*/
494	void efi_build_mem_table(struct efi_entry_memmap map, int size, bool skip_bs);
495
496	#endif /* _LINUX_EFI_H */