[linux-2.6-block.git] / include / linux / efi.h

#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 <drummond@valinux.com>
 * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
 *	David Mosberger-Tang <davidm@hpl.hp.com>
 *	Stephane Eranian <eranian@hpl.hp.com>
 */
#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>
#include <asm/system.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_FOUND		(14 | (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;

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;

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

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

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;
	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;
	unsigned long 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;
};

#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 */
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.
 */
#ifdef CONFIG_EFI
# ifdef CONFIG_X86
   extern int efi_enabled;
# else
#  define efi_enabled 1
# endif
#else
# define efi_enabled 0
#endif

/*
 * Variable Attributes
 */
#define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
#define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004

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

#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
/*
 * 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;
};

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(),
	 * which is protected by the BKL, so that path is safe.
	 */
	spinlock_t lock;
	struct list_head list;
	struct kset *kset;
	struct bin_attribute *new_var, *del_var;
	const struct efivar_operations *ops;
	struct efivar_entry *walk_entry;
	struct pstore_info efi_pstore_info;
};

int register_efivars(struct efivars *efivars,
		     const struct efivar_operations *ops,
		     struct kobject *parent_kobj);
void unregister_efivars(struct efivars *efivars);

#endif /* CONFIG_EFI_VARS */

#endif /* _LINUX_EFI_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_EFI_H
	2	#define _LINUX_EFI_H
	3
	4	/*
	5	* Extensible Firmware Interface
	6	* Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
	7	*
	8	* Copyright (C) 1999 VA Linux Systems
	9	* Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
	10	* Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
	11	* David Mosberger-Tang <davidm@hpl.hp.com>
	12	* Stephane Eranian <eranian@hpl.hp.com>
	13	*/
	14	#include <linux/init.h>
	15	#include <linux/string.h>
	16	#include <linux/time.h>
	17	#include <linux/types.h>
	18	#include <linux/proc_fs.h>
	19	#include <linux/rtc.h>
	20	#include <linux/ioport.h>
4a3575fd	21	#include <linux/pfn.h>
5ee9c198	22	#include <linux/pstore.h>
1da177e4 LT	23
	24	#include <asm/page.h>
	25	#include <asm/system.h>
	26
	27	#define EFI_SUCCESS 0
	28	#define EFI_LOAD_ERROR ( 1 \| (1UL << (BITS_PER_LONG-1)))
	29	#define EFI_INVALID_PARAMETER ( 2 \| (1UL << (BITS_PER_LONG-1)))
	30	#define EFI_UNSUPPORTED ( 3 \| (1UL << (BITS_PER_LONG-1)))
	31	#define EFI_BAD_BUFFER_SIZE ( 4 \| (1UL << (BITS_PER_LONG-1)))
	32	#define EFI_BUFFER_TOO_SMALL ( 5 \| (1UL << (BITS_PER_LONG-1)))
	33	#define EFI_NOT_FOUND (14 \| (1UL << (BITS_PER_LONG-1)))
	34
	35	typedef unsigned long efi_status_t;
	36	typedef u8 efi_bool_t;
	37	typedef u16 efi_char16_t; /* UNICODE character */
	38
	39
	40	typedef struct {
	41	u8 b[16];
	42	} efi_guid_t;
	43
	44	#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
	45	((efi_guid_t) \
	46	{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
	47	(b) & 0xff, ((b) >> 8) & 0xff, \
	48	(c) & 0xff, ((c) >> 8) & 0xff, \
	49	(d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
	50
	51	/*
	52	* Generic EFI table header
	53	*/
	54	typedef struct {
	55	u64 signature;
	56	u32 revision;
	57	u32 headersize;
	58	u32 crc32;
	59	u32 reserved;
	60	} efi_table_hdr_t;
	61
	62	/*
	63	* Memory map descriptor:
	64	*/
	65
	66	/* Memory types: */
	67	#define EFI_RESERVED_TYPE 0
	68	#define EFI_LOADER_CODE 1
	69	#define EFI_LOADER_DATA 2
	70	#define EFI_BOOT_SERVICES_CODE 3
	71	#define EFI_BOOT_SERVICES_DATA 4
	72	#define EFI_RUNTIME_SERVICES_CODE 5
	73	#define EFI_RUNTIME_SERVICES_DATA 6
	74	#define EFI_CONVENTIONAL_MEMORY 7
	75	#define EFI_UNUSABLE_MEMORY 8
	76	#define EFI_ACPI_RECLAIM_MEMORY 9
	77	#define EFI_ACPI_MEMORY_NVS 10
	78	#define EFI_MEMORY_MAPPED_IO 11
	79	#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
	80	#define EFI_PAL_CODE 13
	81	#define EFI_MAX_MEMORY_TYPE 14
	82
	83	/* Attribute values: */
	84	#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
	85	#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
	86	#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
87	#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
88	#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
89	#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
90	#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
91	#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
92	#define EFI_MEMORY_DESCRIPTOR_VERSION 1
93
94	#define EFI_PAGE_SHIFT 12
95
1da177e4 LT	96	typedef struct {
	97	u32 type;
	98	u32 pad;
	99	u64 phys_addr;
	100	u64 virt_addr;
	101	u64 num_pages;
	102	u64 attribute;
1da177e4 LT	103	} efi_memory_desc_t;
1da177e4 LT	104
3b370237 MG	105	typedef struct {
	106	efi_guid_t guid;
	107	u32 headersize;
	108	u32 flags;
	109	u32 imagesize;
	110	} efi_capsule_header_t;
	111
e088a4ad	112	typedef int (efi_freemem_callback_t) (u64 start, u64 end, void arg);
1da177e4 LT	113
	114	/*
	115	* Types and defines for Time Services
	116	*/
	117	#define EFI_TIME_ADJUST_DAYLIGHT 0x1
	118	#define EFI_TIME_IN_DAYLIGHT 0x2
	119	#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
	120
	121	typedef struct {
	122	u16 year;
	123	u8 month;
	124	u8 day;
	125	u8 hour;
	126	u8 minute;
	127	u8 second;
	128	u8 pad1;
	129	u32 nanosecond;
	130	s16 timezone;
	131	u8 daylight;
	132	u8 pad2;
	133	} efi_time_t;
	134
	135	typedef struct {
	136	u32 resolution;
	137	u32 accuracy;
	138	u8 sets_to_zero;
	139	} efi_time_cap_t;
	140
	141	/*
	142	* Types and defines for EFI ResetSystem
	143	*/
	144	#define EFI_RESET_COLD 0
	145	#define EFI_RESET_WARM 1
	146	#define EFI_RESET_SHUTDOWN 2
	147
	148	/*
	149	* EFI Runtime Services table
	150	*/
	151	#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
	152	#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
	153
	154	typedef struct {
	155	efi_table_hdr_t hdr;
	156	unsigned long get_time;
	157	unsigned long set_time;
	158	unsigned long get_wakeup_time;
	159	unsigned long set_wakeup_time;
	160	unsigned long set_virtual_address_map;
	161	unsigned long convert_pointer;
	162	unsigned long get_variable;
	163	unsigned long get_next_variable;
	164	unsigned long set_variable;
	165	unsigned long get_next_high_mono_count;
	166	unsigned long reset_system;
3b370237 MG	167	unsigned long update_capsule;
	168	unsigned long query_capsule_caps;
	169	unsigned long query_variable_info;
1da177e4 LT	170	} efi_runtime_services_t;
	171
	172	typedef efi_status_t efi_get_time_t (efi_time_t tm, efi_time_cap_t tc);
	173	typedef efi_status_t efi_set_time_t (efi_time_t *tm);
	174	typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t enabled, efi_bool_t pending,
	175	efi_time_t *tm);
	176	typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
	177	typedef efi_status_t efi_get_variable_t (efi_char16_t name, efi_guid_t vendor, u32 *attr,
	178	unsigned long data_size, void data);
	179	typedef efi_status_t efi_get_next_variable_t (unsigned long name_size, efi_char16_t name,
	180	efi_guid_t *vendor);
	181	typedef efi_status_t efi_set_variable_t (efi_char16_t name, efi_guid_t vendor,
f7a2d73f	182	u32 attr, unsigned long data_size,
1da177e4 LT	183	void *data);
	184	typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
	185	typedef void efi_reset_system_t (int reset_type, efi_status_t status,
	186	unsigned long data_size, efi_char16_t *data);
	187	typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
	188	unsigned long descriptor_size,
	189	u32 descriptor_version,
	190	efi_memory_desc_t *virtual_map);
3b370237 MG	191	typedef efi_status_t efi_query_variable_info_t(u32 attr,
	192	u64 *storage_space,
	193	u64 *remaining_space,
	194	u64 *max_variable_size);
	195	typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
	196	unsigned long count,
	197	unsigned long sg_list);
	198	typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
	199	unsigned long count,
	200	u64 *max_size,
	201	int *reset_type);
1da177e4 LT	202
	203	/*
	204	* EFI Configuration Table and GUID definitions
	205	*/
	206	#define NULL_GUID \
	207	EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
	208
	209	#define MPS_TABLE_GUID \
	210	EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
	211
	212	#define ACPI_TABLE_GUID \
	213	EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
	214
	215	#define ACPI_20_TABLE_GUID \
	216	EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
	217
	218	#define SMBIOS_TABLE_GUID \
	219	EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
	220
	221	#define SAL_SYSTEM_TABLE_GUID \
	222	EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
	223
	224	#define HCDP_TABLE_GUID \
	225	EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
	226
	227	#define UGA_IO_PROTOCOL_GUID \
	228	EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
	229
	230	#define EFI_GLOBAL_VARIABLE_GUID \
	231	EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
	232
a50f70b1 RA	233	#define UV_SYSTEM_TABLE_GUID \
	234	EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
	235
5ee9c198 MG	236	#define LINUX_EFI_CRASH_GUID \
	237	EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
	238
1da177e4 LT	239	typedef struct {
	240	efi_guid_t guid;
	241	unsigned long table;
	242	} efi_config_table_t;
	243
	244	#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
1da177e4	245
3b370237 MG	246	#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) \| (30))
	247	#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) \| (20))
	248	#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) \| (10))
	249	#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) \| (00))
	250	#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) \| (10))
	251	#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) \| (02))
	252
1da177e4 LT	253	typedef struct {
	254	efi_table_hdr_t hdr;
	255	unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
	256	u32 fw_revision;
	257	unsigned long con_in_handle;
	258	unsigned long con_in;
	259	unsigned long con_out_handle;
	260	unsigned long con_out;
	261	unsigned long stderr_handle;
	262	unsigned long stderr;
	263	efi_runtime_services_t *runtime;
	264	unsigned long boottime;
	265	unsigned long nr_tables;
	266	unsigned long tables;
	267	} efi_system_table_t;
	268
	269	struct efi_memory_map {
7ae65fd3 MT	270	void *phys_map;
	271	void *map;
	272	void *map_end;
1da177e4 LT	273	int nr_map;
1da177e4 LT	274	unsigned long desc_version;
7ae65fd3	275	unsigned long desc_size;
1da177e4 LT	276	};
1da177e4 LT	277
b2c99e3c BH	278	#define EFI_INVALID_TABLE_ADDR (~0UL)
b2c99e3c BH	279
1da177e4 LT	280	/*
	281	* All runtime access to EFI goes through this structure:
	282	*/
	283	extern struct efi {
	284	efi_system_table_t systab; / EFI system table */
3b370237	285	unsigned int runtime_version; /* Runtime services version */
b2c99e3c BH	286	unsigned long mps; /* MPS table */
	287	unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
	288	unsigned long acpi20; /* ACPI table (ACPI 2.0) */
	289	unsigned long smbios; /* SM BIOS table */
	290	unsigned long sal_systab; /* SAL system table */
	291	unsigned long boot_info; /* boot info table */
	292	unsigned long hcdp; /* HCDP table */
	293	unsigned long uga; /* UGA table */
a50f70b1	294	unsigned long uv_systab; /* UV system table */
1da177e4 LT	295	efi_get_time_t *get_time;
	296	efi_set_time_t *set_time;
	297	efi_get_wakeup_time_t *get_wakeup_time;
	298	efi_set_wakeup_time_t *set_wakeup_time;
	299	efi_get_variable_t *get_variable;
	300	efi_get_next_variable_t *get_next_variable;
	301	efi_set_variable_t *set_variable;
3b370237 MG	302	efi_query_variable_info_t *query_variable_info;
	303	efi_update_capsule_t *update_capsule;
	304	efi_query_capsule_caps_t *query_capsule_caps;
1da177e4 LT	305	efi_get_next_high_mono_count_t *get_next_high_mono_count;
	306	efi_reset_system_t *reset_system;
	307	efi_set_virtual_address_map_t *set_virtual_address_map;
	308	} efi;
	309
	310	static inline int
	311	efi_guidcmp (efi_guid_t left, efi_guid_t right)
	312	{
	313	return memcmp(&left, &right, sizeof (efi_guid_t));
	314	}
	315
	316	static inline char *
	317	efi_guid_unparse(efi_guid_t guid, char out)
	318	{
925ede0b	319	sprintf(out, "%pUl", guid->b);
1da177e4 LT	320	return out;
	321	}
	322
	323	extern void efi_init (void);
	324	extern void *efi_get_pal_addr (void);
	325	extern void efi_map_pal_code (void);
1da177e4 LT	326	extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
	327	extern void efi_gettimeofday (struct timespec *ts);
	328	extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
	329	extern u64 efi_get_iobase (void);
	330	extern u32 efi_mem_type (unsigned long phys_addr);
	331	extern u64 efi_mem_attributes (unsigned long phys_addr);
32e62c63	332	extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1da177e4 LT	333	extern int __init efi_uart_console_only (void);
1da177e4 LT	334	extern void efi_initialize_iomem_resources(struct resource *code_resource,
00bf4098	335	struct resource data_resource, struct resource bss_resource);
e1cccf48	336	extern unsigned long efi_get_time(void);
472ba91d	337	extern int efi_set_rtc_mmss(unsigned long nowtime);
916f676f	338	extern void efi_reserve_boot_services(void);
1da177e4 LT	339	extern struct efi_memory_map memmap;
	340
	341	/**
	342	* efi_range_is_wc - check the WC bit on an address range
	343	* @start: starting kvirt address
	344	* @len: length of range
	345	*
	346	* Consult the EFI memory map and make sure it's ok to set this range WC.
	347	* Returns true or false.
	348	*/
	349	static inline int efi_range_is_wc(unsigned long start, unsigned long len)
	350	{
986a80d5	351	unsigned long i;
1da177e4 LT	352
	353	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
	354	unsigned long paddr = __pa(start + i);
	355	if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
	356	return 0;
	357	}
	358	/* The range checked out */
	359	return 1;
	360	}
	361
	362	#ifdef CONFIG_EFI_PCDP
	363	extern int __init efi_setup_pcdp_console(char *);
	364	#endif
	365
	366	/*
	367	* We play games with efi_enabled so that the compiler will, if possible, remove
	368	* EFI-related code altogether.
	369	*/
	370	#ifdef CONFIG_EFI
	371	# ifdef CONFIG_X86
	372	extern int efi_enabled;
	373	# else
	374	# define efi_enabled 1
	375	# endif
	376	#else
	377	# define efi_enabled 0
	378	#endif
	379
	380	/*
	381	* Variable Attributes
	382	*/
	383	#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
	384	#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
	385	#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
	386
	387	/*
	388	* EFI Device Path information
	389	*/
	390	#define EFI_DEV_HW 0x01
	391	#define EFI_DEV_PCI 1
	392	#define EFI_DEV_PCCARD 2
	393	#define EFI_DEV_MEM_MAPPED 3
	394	#define EFI_DEV_VENDOR 4
	395	#define EFI_DEV_CONTROLLER 5
	396	#define EFI_DEV_ACPI 0x02
	397	#define EFI_DEV_BASIC_ACPI 1
	398	#define EFI_DEV_EXPANDED_ACPI 2
	399	#define EFI_DEV_MSG 0x03
	400	#define EFI_DEV_MSG_ATAPI 1
	401	#define EFI_DEV_MSG_SCSI 2
	402	#define EFI_DEV_MSG_FC 3
	403	#define EFI_DEV_MSG_1394 4
	404	#define EFI_DEV_MSG_USB 5
	405	#define EFI_DEV_MSG_USB_CLASS 15
	406	#define EFI_DEV_MSG_I20 6
	407	#define EFI_DEV_MSG_MAC 11
	408	#define EFI_DEV_MSG_IPV4 12
	409	#define EFI_DEV_MSG_IPV6 13
	410	#define EFI_DEV_MSG_INFINIBAND 9
	411	#define EFI_DEV_MSG_UART 14
	412	#define EFI_DEV_MSG_VENDOR 10
	413	#define EFI_DEV_MEDIA 0x04
	414	#define EFI_DEV_MEDIA_HARD_DRIVE 1
	415	#define EFI_DEV_MEDIA_CDROM 2
416	#define EFI_DEV_MEDIA_VENDOR 3
417	#define EFI_DEV_MEDIA_FILE 4
418	#define EFI_DEV_MEDIA_PROTOCOL 5
419	#define EFI_DEV_BIOS_BOOT 0x05
420	#define EFI_DEV_END_PATH 0x7F
421	#define EFI_DEV_END_PATH2 0xFF
422	#define EFI_DEV_END_INSTANCE 0x01
423	#define EFI_DEV_END_ENTIRE 0xFF
424
425	struct efi_generic_dev_path {
426	u8 type;
427	u8 sub_type;
428	u16 length;
429	} __attribute ((packed));
430
4a3575fd HY	431	static inline void memrange_efi_to_native(u64 addr, u64 npages)
	432	{
	433	npages = PFN_UP(addr + (npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(addr);
	434	*addr &= PAGE_MASK;
	435	}
	436
4fc756bd MW	437	#if defined(CONFIG_EFI_VARS) \|\| defined(CONFIG_EFI_VARS_MODULE)
	438	/*
	439	* EFI Variable support.
	440	*
	441	* Different firmware drivers can expose their EFI-like variables using
	442	* the following.
	443	*/
	444
	445	struct efivar_operations {
	446	efi_get_variable_t *get_variable;
	447	efi_get_next_variable_t *get_next_variable;
	448	efi_set_variable_t *set_variable;
	449	};
	450
	451	struct efivars {
	452	/*
	453	* ->lock protects two things:
	454	* 1) ->list - adds, removals, reads, writes
	455	* 2) ops.[gs]et_variable() calls.
	456	* It must not be held when creating sysfs entries or calling kmalloc.
	457	* ops.get_next_variable() is only called from register_efivars(),
	458	* which is protected by the BKL, so that path is safe.
	459	*/
	460	spinlock_t lock;
	461	struct list_head list;
	462	struct kset *kset;
	463	struct bin_attribute new_var, del_var;
	464	const struct efivar_operations *ops;
5ee9c198 MG	465	struct efivar_entry *walk_entry;
5ee9c198 MG	466	struct pstore_info efi_pstore_info;
4fc756bd MW	467	};
	468
	469	int register_efivars(struct efivars *efivars,
	470	const struct efivar_operations *ops,
	471	struct kobject *parent_kobj);
	472	void unregister_efivars(struct efivars *efivars);
	473
	474	#endif /* CONFIG_EFI_VARS */
	475
1da177e4	476	#endif /* _LINUX_EFI_H */