include/linux/efi.h - kernel/common - Git at Google

 #ifndef _LINUX_EFI_H
 #define _LINUX_EFI_H

 /*
  * 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 <[email protected]>
  * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  *	David Mosberger-Tang <[email protected]>
  *	Stephane Eranian <[email protected]>
  */
 #include <linux/init.h>
 #include <linux/string.h>
 #include <linux/time.h>
 #include <linux/types.h>
 #include <linux/proc_fs.h>
 #include <linux/rtc.h>
 #include <linux/ioport.h>
 #include <linux/pfn.h>
 #include <linux/pstore.h>

 #include <asm/page.h>

 #define EFI_SUCCESS		0
 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_INVALID_PARAMETER	( 2 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_UNSUPPORTED		( 3 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_BUFFER_TOO_SMALL	( 5 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_NOT_READY		( 6 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_DEVICE_ERROR	( 7 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_WRITE_PROTECTED	( 8 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_OUT_OF_RESOURCES	( 9 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_NOT_FOUND		(14 | (1UL << (BITS_PER_LONG-1)))
 #define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))

 typedef unsigned long efi_status_t;
 typedef u8 efi_bool_t;
 typedef u16 efi_char16_t;		/* UNICODE character */


 typedef struct {
 	u8 b[16];
 } efi_guid_t;

 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
 ((efi_guid_t) \
 {{ (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
  */
 typedef	struct {
 	u64 signature;
 	u32 revision;
 	u32 headersize;
 	u32 crc32;
 	u32 reserved;
 } efi_table_hdr_t;

 /*
  * Memory map descriptor:
  */

 /* Memory types: */
 #define EFI_RESERVED_TYPE		 0
 #define EFI_LOADER_CODE			 1
 #define EFI_LOADER_DATA			 2
 #define EFI_BOOT_SERVICES_CODE		 3
 #define EFI_BOOT_SERVICES_DATA		 4
 #define EFI_RUNTIME_SERVICES_CODE	 5
 #define EFI_RUNTIME_SERVICES_DATA	 6
 #define EFI_CONVENTIONAL_MEMORY		 7
 #define EFI_UNUSABLE_MEMORY		 8
 #define EFI_ACPI_RECLAIM_MEMORY		 9
 #define EFI_ACPI_MEMORY_NVS		10
 #define EFI_MEMORY_MAPPED_IO		11
 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
 #define EFI_PAL_CODE			13
 #define EFI_MAX_MEMORY_TYPE		14

 /* 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_WP		((u64)0x0000000000001000ULL)	/* write-protect */
 #define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
 #define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
 #define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
 #define EFI_MEMORY_DESCRIPTOR_VERSION	1

 #define EFI_PAGE_SHIFT		12

 typedef struct {
 	u32 type;
 	u32 pad;
 	u64 phys_addr;
 	u64 virt_addr;
 	u64 num_pages;
 	u64 attribute;
 } efi_memory_desc_t;

 typedef struct {
 	efi_guid_t guid;
 	u32 headersize;
 	u32 flags;
 	u32 imagesize;
 } efi_capsule_header_t;

 /*
  * 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

 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);

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

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

 typedef struct {
 	u32 resolution;
 	u32 accuracy;
 	u8 sets_to_zero;
 } efi_time_cap_t;

 /*
  * EFI Boot Services table
  */
 typedef struct {
 	efi_table_hdr_t hdr;
 	void *raise_tpl;
 	void *restore_tpl;
 	void *allocate_pages;
 	void *free_pages;
 	void *get_memory_map;
 	void *allocate_pool;
 	void *free_pool;
 	void *create_event;
 	void *set_timer;
 	void *wait_for_event;
 	void *signal_event;
 	void *close_event;
 	void *check_event;
 	void *install_protocol_interface;
 	void *reinstall_protocol_interface;
 	void *uninstall_protocol_interface;
 	void *handle_protocol;
 	void *__reserved;
 	void *register_protocol_notify;
 	void *locate_handle;
 	void *locate_device_path;
 	void *install_configuration_table;
 	void *load_image;
 	void *start_image;
 	void *exit;
 	void *unload_image;
 	void *exit_boot_services;
 	void *get_next_monotonic_count;
 	void *stall;
 	void *set_watchdog_timer;
 	void *connect_controller;
 	void *disconnect_controller;
 	void *open_protocol;
 	void *close_protocol;
 	void *open_protocol_information;
 	void *protocols_per_handle;
 	void *locate_handle_buffer;
 	void *locate_protocol;
 	void *install_multiple_protocol_interfaces;
 	void *uninstall_multiple_protocol_interfaces;
 	void *calculate_crc32;
 	void *copy_mem;
 	void *set_mem;
 	void *create_event_ex;
 } efi_boot_services_t;

 typedef enum {
 	EfiPciIoWidthUint8,
 	EfiPciIoWidthUint16,
 	EfiPciIoWidthUint32,
 	EfiPciIoWidthUint64,
 	EfiPciIoWidthFifoUint8,
 	EfiPciIoWidthFifoUint16,
 	EfiPciIoWidthFifoUint32,
 	EfiPciIoWidthFifoUint64,
 	EfiPciIoWidthFillUint8,
 	EfiPciIoWidthFillUint16,
 	EfiPciIoWidthFillUint32,
 	EfiPciIoWidthFillUint64,
 	EfiPciIoWidthMaximum
 } EFI_PCI_IO_PROTOCOL_WIDTH;

 typedef enum {
 	EfiPciIoAttributeOperationGet,
 	EfiPciIoAttributeOperationSet,
 	EfiPciIoAttributeOperationEnable,
 	EfiPciIoAttributeOperationDisable,
 	EfiPciIoAttributeOperationSupported,
     EfiPciIoAttributeOperationMaximum
 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;


 typedef struct {
 	void *read;
 	void *write;
 } efi_pci_io_protocol_access_t;

 typedef struct {
 	void *poll_mem;
 	void *poll_io;
 	efi_pci_io_protocol_access_t mem;
 	efi_pci_io_protocol_access_t io;
 	efi_pci_io_protocol_access_t pci;
 	void *copy_mem;
 	void *map;
 	void *unmap;
 	void *allocate_buffer;
 	void *free_buffer;
 	void *flush;
 	void *get_location;
 	void *attributes;
 	void *get_bar_attributes;
 	void *set_bar_attributes;
 	uint64_t romsize;
 	void *romimage;
 } efi_pci_io_protocol;

 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000

 /*
  * Types and defines for EFI ResetSystem
  */
 #define EFI_RESET_COLD 0
 #define EFI_RESET_WARM 1
 #define EFI_RESET_SHUTDOWN 2

 /*
  * EFI Runtime Services table
  */
 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000

 typedef struct {
 	efi_table_hdr_t hdr;
 	unsigned long get_time;
 	unsigned long set_time;
 	unsigned long get_wakeup_time;
 	unsigned long set_wakeup_time;
 	unsigned long set_virtual_address_map;
 	unsigned long convert_pointer;
 	unsigned long get_variable;
 	unsigned long get_next_variable;
 	unsigned long set_variable;
 	unsigned long get_next_high_mono_count;
 	unsigned long reset_system;
 	unsigned long update_capsule;
 	unsigned long query_capsule_caps;
 	unsigned long query_variable_info;
 } efi_runtime_services_t;

 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
 					    efi_time_t *tm);
 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
 					 unsigned long *data_size, void *data);
 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
 					      efi_guid_t *vendor);
 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
 					 u32 attr, unsigned long data_size,
 					 void *data);
 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
 				 unsigned long data_size, efi_char16_t *data);
 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
 						unsigned long descriptor_size,
 						u32 descriptor_version,
 						efi_memory_desc_t *virtual_map);
 typedef efi_status_t efi_query_variable_info_t(u32 attr,
 					       u64 *storage_space,
 					       u64 *remaining_space,
 					       u64 *max_variable_size);
 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
 					  unsigned long count,
 					  unsigned long sg_list);
 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
 					      unsigned long count,
 					      u64 *max_size,
 					      int *reset_type);
 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);

 /*
  *  EFI Configuration Table and GUID definitions
  */
 #define NULL_GUID \
     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )

 #define MPS_TABLE_GUID    \
     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )

 #define ACPI_TABLE_GUID    \
     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )

 #define ACPI_20_TABLE_GUID    \
     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )

 #define SMBIOS_TABLE_GUID    \
     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )

 #define SAL_SYSTEM_TABLE_GUID    \
     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )

 #define HCDP_TABLE_GUID	\
     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )

 #define UGA_IO_PROTOCOL_GUID \
     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )

 #define EFI_GLOBAL_VARIABLE_GUID \
     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )

 #define UV_SYSTEM_TABLE_GUID \
     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )

 #define LINUX_EFI_CRASH_GUID \
     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )

 #define LOADED_IMAGE_PROTOCOL_GUID \
     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )

 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )

 #define EFI_UGA_PROTOCOL_GUID \
     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )

 #define EFI_PCI_IO_PROTOCOL_GUID \
     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )

 #define EFI_FILE_INFO_ID \
     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )

 #define EFI_FILE_SYSTEM_GUID \
     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )

 typedef struct {
 	efi_guid_t guid;
 	u64 table;
 } efi_config_table_64_t;

 typedef struct {
 	efi_guid_t guid;
 	u32 table;
 } efi_config_table_32_t;

 typedef struct {
 	efi_guid_t guid;
 	unsigned long table;
 } efi_config_table_t;

 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)

 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))

 typedef struct {
 	efi_table_hdr_t hdr;
 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
 	u32 fw_revision;
 	u32 __pad1;
 	u64 con_in_handle;
 	u64 con_in;
 	u64 con_out_handle;
 	u64 con_out;
 	u64 stderr_handle;
 	u64 stderr;
 	u64 runtime;
 	u64 boottime;
 	u32 nr_tables;
 	u32 __pad2;
 	u64 tables;
 } efi_system_table_64_t;

 typedef struct {
 	efi_table_hdr_t hdr;
 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
 	u32 fw_revision;
 	u32 con_in_handle;
 	u32 con_in;
 	u32 con_out_handle;
 	u32 con_out;
 	u32 stderr_handle;
 	u32 stderr;
 	u32 runtime;
 	u32 boottime;
 	u32 nr_tables;
 	u32 tables;
 } efi_system_table_32_t;

 typedef struct {
 	efi_table_hdr_t hdr;
 	unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
 	u32 fw_revision;
 	unsigned long con_in_handle;
 	unsigned long con_in;
 	unsigned long con_out_handle;
 	unsigned long con_out;
 	unsigned long stderr_handle;
 	unsigned long stderr;
 	efi_runtime_services_t *runtime;
 	efi_boot_services_t *boottime;
 	unsigned long nr_tables;
 	unsigned long tables;
 } efi_system_table_t;

 struct efi_memory_map {
 	void *phys_map;
 	void *map;
 	void *map_end;
 	int nr_map;
 	unsigned long desc_version;
 	unsigned long desc_size;
 };

 typedef struct {
 	u32 revision;
 	void *parent_handle;
 	efi_system_table_t *system_table;
 	void *device_handle;
 	void *file_path;
 	void *reserved;
 	u32 load_options_size;
 	void *load_options;
 	void *image_base;
 	__aligned_u64 image_size;
 	unsigned int image_code_type;
 	unsigned int image_data_type;
 	unsigned long unload;
 } efi_loaded_image_t;

 typedef struct {
 	u64 revision;
 	void *open_volume;
 } efi_file_io_interface_t;

 typedef struct {
 	u64 size;
 	u64 file_size;
 	u64 phys_size;
 	efi_time_t create_time;
 	efi_time_t last_access_time;
 	efi_time_t modification_time;
 	__aligned_u64 attribute;
 	efi_char16_t filename[1];
 } efi_file_info_t;

 typedef struct {
 	u64 revision;
 	void *open;
 	void *close;
 	void *delete;
 	void *read;
 	void *write;
 	void *get_position;
 	void *set_position;
 	void *get_info;
 	void *set_info;
 	void *flush;
 } efi_file_handle_t;

 #define EFI_FILE_MODE_READ	0x0000000000000001
 #define EFI_FILE_MODE_WRITE	0x0000000000000002
 #define EFI_FILE_MODE_CREATE	0x8000000000000000

 #define EFI_INVALID_TABLE_ADDR		(~0UL)

 /*
  * All runtime access to EFI goes through this structure:
  */
 extern struct efi {
 	efi_system_table_t *systab;	/* EFI system table */
 	unsigned int runtime_version;	/* Runtime services version */
 	unsigned long mps;		/* MPS table */
 	unsigned long acpi;		/* ACPI table  (IA64 ext 0.71) */
 	unsigned long acpi20;		/* ACPI table  (ACPI 2.0) */
 	unsigned long smbios;		/* SM BIOS table */
 	unsigned long sal_systab;	/* SAL system table */
 	unsigned long boot_info;	/* boot info table */
 	unsigned long hcdp;		/* HCDP table */
 	unsigned long uga;		/* UGA table */
 	unsigned long uv_systab;	/* UV system table */
 	efi_get_time_t *get_time;
 	efi_set_time_t *set_time;
 	efi_get_wakeup_time_t *get_wakeup_time;
 	efi_set_wakeup_time_t *set_wakeup_time;
 	efi_get_variable_t *get_variable;
 	efi_get_next_variable_t *get_next_variable;
 	efi_set_variable_t *set_variable;
 	efi_query_variable_info_t *query_variable_info;
 	efi_update_capsule_t *update_capsule;
 	efi_query_capsule_caps_t *query_capsule_caps;
 	efi_get_next_high_mono_count_t *get_next_high_mono_count;
 	efi_reset_system_t *reset_system;
 	efi_set_virtual_address_map_t *set_virtual_address_map;
 } efi;

 static inline int
 efi_guidcmp (efi_guid_t left, efi_guid_t right)
 {
 	return memcmp(&left, &right, sizeof (efi_guid_t));
 }

 static inline char *
 efi_guid_unparse(efi_guid_t *guid, char *out)
 {
 	sprintf(out, "%pUl", guid->b);
         return out;
 }

 extern void efi_init (void);
 extern void *efi_get_pal_addr (void);
 extern void efi_map_pal_code (void);
 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
 extern void efi_gettimeofday (struct timespec *ts);
 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
 #ifdef CONFIG_X86
 extern void efi_late_init(void);
 extern void efi_free_boot_services(void);
 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
 #else
 static inline void efi_late_init(void) {}
 static inline void efi_free_boot_services(void) {}

 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
 {
 	return EFI_SUCCESS;
 }
 #endif
 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
 extern u64 efi_get_iobase (void);
 extern u32 efi_mem_type (unsigned long phys_addr);
 extern u64 efi_mem_attributes (unsigned long phys_addr);
 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
 extern int __init efi_uart_console_only (void);
 extern void efi_initialize_iomem_resources(struct resource *code_resource,
 		struct resource *data_resource, struct resource *bss_resource);
 extern unsigned long efi_get_time(void);
 extern int efi_set_rtc_mmss(unsigned long nowtime);
 extern void efi_reserve_boot_services(void);
 extern struct efi_memory_map memmap;

 /**
  * efi_range_is_wc - check the WC bit on an address range
  * @start: starting kvirt address
  * @len: length of range
  *
  * Consult the EFI memory map and make sure it's ok to set this range WC.
  * Returns true or false.
  */
 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
 {
 	unsigned long i;

 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
 		unsigned long paddr = __pa(start + i);
 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
 			return 0;
 	}
 	/* The range checked out */
 	return 1;
 }

 #ifdef CONFIG_EFI_PCDP
 extern int __init efi_setup_pcdp_console(char *);
 #endif

 /*
  * We play games with efi_enabled so that the compiler will, if
  * possible, remove EFI-related code altogether.
  */
 #define EFI_BOOT		0	/* Were we booted from EFI? */
 #define EFI_SYSTEM_TABLES	1	/* Can we use EFI system tables? */
 #define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
 #define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
 #define EFI_MEMMAP		4	/* Can we use EFI memory map? */
 #define EFI_64BIT		5	/* Is the firmware 64-bit? */

 #ifdef CONFIG_EFI
 # ifdef CONFIG_X86
 extern int efi_enabled(int facility);
 # else
 static inline int efi_enabled(int facility)
 {
 	return 1;
 }
 # endif
 #else
 static inline int efi_enabled(int facility)
 {
 	return 0;
 }
 #endif

 /*
  * 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)
 /*
  * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
  * not including trailing NUL
  */
 #define EFI_VARIABLE_GUID_LEN 36

 /*
  * The type of search to perform when calling boottime->locate_handle
  */
 #define EFI_LOCATE_ALL_HANDLES			0
 #define EFI_LOCATE_BY_REGISTER_NOTIFY		1
 #define EFI_LOCATE_BY_PROTOCOL			2

 /*
  * EFI Device Path information
  */
 #define EFI_DEV_HW			0x01
 #define  EFI_DEV_PCI				 1
 #define  EFI_DEV_PCCARD				 2
 #define  EFI_DEV_MEM_MAPPED			 3
 #define  EFI_DEV_VENDOR				 4
 #define  EFI_DEV_CONTROLLER			 5
 #define EFI_DEV_ACPI			0x02
 #define   EFI_DEV_BASIC_ACPI			 1
 #define   EFI_DEV_EXPANDED_ACPI			 2
 #define EFI_DEV_MSG			0x03
 #define   EFI_DEV_MSG_ATAPI			 1
 #define   EFI_DEV_MSG_SCSI			 2
 #define   EFI_DEV_MSG_FC			 3
 #define   EFI_DEV_MSG_1394			 4
 #define   EFI_DEV_MSG_USB			 5
 #define   EFI_DEV_MSG_USB_CLASS			15
 #define   EFI_DEV_MSG_I20			 6
 #define   EFI_DEV_MSG_MAC			11
 #define   EFI_DEV_MSG_IPV4			12
 #define   EFI_DEV_MSG_IPV6			13
 #define   EFI_DEV_MSG_INFINIBAND		 9
 #define   EFI_DEV_MSG_UART			14
 #define   EFI_DEV_MSG_VENDOR			10
 #define EFI_DEV_MEDIA			0x04
 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
 #define   EFI_DEV_MEDIA_CDROM			 2
 #define   EFI_DEV_MEDIA_VENDOR			 3
 #define   EFI_DEV_MEDIA_FILE			 4
 #define   EFI_DEV_MEDIA_PROTOCOL		 5
 #define EFI_DEV_BIOS_BOOT		0x05
 #define EFI_DEV_END_PATH		0x7F
 #define EFI_DEV_END_PATH2		0xFF
 #define   EFI_DEV_END_INSTANCE			0x01
 #define   EFI_DEV_END_ENTIRE			0xFF

 struct efi_generic_dev_path {
 	u8 type;
 	u8 sub_type;
 	u16 length;
 } __attribute ((packed));

 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
 {
 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
 	*addr &= PAGE_MASK;
 }

 /*
  * EFI Variable support.
  *
  * Different firmware drivers can expose their EFI-like variables using
  * the following.
  */

 struct efivar_operations {
 	efi_get_variable_t *get_variable;
 	efi_get_next_variable_t *get_next_variable;
 	efi_set_variable_t *set_variable;
 	efi_query_variable_store_t *query_variable_store;
 };

 struct efivars {
 	/*
 	 * ->lock protects two things:
 	 * 1) ->list - adds, removals, reads, writes
 	 * 2) ops.[gs]et_variable() calls.
 	 * It must not be held when creating sysfs entries or calling kmalloc.
 	 * ops.get_next_variable() is only called from register_efivars()
 	 * or efivar_update_sysfs_entries(),
 	 * which is protected by the BKL, so that path is safe.
 	 */
 	spinlock_t lock;
 	struct kset *kset;
 	struct kobject *kobject;
 	const struct efivar_operations *ops;
 };

 /*
  * The maximum size of VariableName + Data = 1024
  * Therefore, it's reasonable to save that much
  * space in each part of the structure,
  * and we use a page for reading/writing.
  */

 struct efi_variable {
 	efi_char16_t  VariableName[1024/sizeof(efi_char16_t)];
 	efi_guid_t    VendorGuid;
 	unsigned long DataSize;
 	__u8          Data[1024];
 	efi_status_t  Status;
 	__u32         Attributes;
 } __attribute__((packed));

 struct efivar_entry {
 	struct efi_variable var;
 	struct list_head list;
 	struct kobject kobj;
 };

 extern struct list_head efivar_sysfs_list;

 static inline void
 efivar_unregister(struct efivar_entry *var)
 {
 	kobject_put(&var->kobj);
 }

 int efivars_register(struct efivars *efivars,
 		     const struct efivar_operations *ops,
 		     struct kobject *kobject);
 int efivars_unregister(struct efivars *efivars);
 struct kobject *efivars_kobject(void);

 int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
 		void *data, bool atomic, bool duplicates,
 		struct list_head *head);

 void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
 void efivar_entry_remove(struct efivar_entry *entry);

 int __efivar_entry_delete(struct efivar_entry *entry);
 int efivar_entry_delete(struct efivar_entry *entry);

 int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
 int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
 		       unsigned long *size, void *data);
 int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
 		     unsigned long *size, void *data);
 int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
 		     unsigned long size, void *data, struct list_head *head);
 int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
 			      unsigned long *size, void *data, bool *set);
 int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
 			  bool block, unsigned long size, void *data);

 void efivar_entry_iter_begin(void);
 void efivar_entry_iter_end(void);

 int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
 			struct list_head *head, void *data,
 			struct efivar_entry **prev);
 int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
 		      struct list_head *head, void *data);

 struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
 				       struct list_head *head, bool remove);

 bool efivar_validate(struct efi_variable *var, u8 *data, unsigned long len);

 extern struct work_struct efivar_work;
 void efivar_run_worker(void);

 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
 int efivars_sysfs_init(void);

 #endif /* CONFIG_EFI_VARS */

 #endif /* _LINUX_EFI_H */