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>
21 #include <linux/pfn.h>
22 #include <linux/pstore.h>
23 
24 #include <asm/page.h>
25 
26 #define EFI_SUCCESS		0
27 #define EFI_LOAD_ERROR          ( 1 | (1UL << (BITS_PER_LONG-1)))
28 #define EFI_INVALID_PARAMETER	( 2 | (1UL << (BITS_PER_LONG-1)))
29 #define EFI_UNSUPPORTED		( 3 | (1UL << (BITS_PER_LONG-1)))
30 #define EFI_BAD_BUFFER_SIZE     ( 4 | (1UL << (BITS_PER_LONG-1)))
31 #define EFI_BUFFER_TOO_SMALL	( 5 | (1UL << (BITS_PER_LONG-1)))
32 #define EFI_NOT_READY		( 6 | (1UL << (BITS_PER_LONG-1)))
33 #define EFI_DEVICE_ERROR	( 7 | (1UL << (BITS_PER_LONG-1)))
34 #define EFI_WRITE_PROTECTED	( 8 | (1UL << (BITS_PER_LONG-1)))
35 #define EFI_OUT_OF_RESOURCES	( 9 | (1UL << (BITS_PER_LONG-1)))
36 #define EFI_NOT_FOUND		(14 | (1UL << (BITS_PER_LONG-1)))
37 #define EFI_SECURITY_VIOLATION	(26 | (1UL << (BITS_PER_LONG-1)))
38 
39 typedef unsigned long efi_status_t;
40 typedef u8 efi_bool_t;
41 typedef u16 efi_char16_t;		/* UNICODE character */
42 
43 
44 typedef struct {
45 	u8 b[16];
46 } efi_guid_t;
47 
48 #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
49 ((efi_guid_t) \
50 {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
51   (b) & 0xff, ((b) >> 8) & 0xff, \
52   (c) & 0xff, ((c) >> 8) & 0xff, \
53   (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
54 
55 /*
56  * Generic EFI table header
57  */
58 typedef	struct {
59 	u64 signature;
60 	u32 revision;
61 	u32 headersize;
62 	u32 crc32;
63 	u32 reserved;
64 } efi_table_hdr_t;
65 
66 /*
67  * Memory map descriptor:
68  */
69 
70 /* Memory types: */
71 #define EFI_RESERVED_TYPE		 0
72 #define EFI_LOADER_CODE			 1
73 #define EFI_LOADER_DATA			 2
74 #define EFI_BOOT_SERVICES_CODE		 3
75 #define EFI_BOOT_SERVICES_DATA		 4
76 #define EFI_RUNTIME_SERVICES_CODE	 5
77 #define EFI_RUNTIME_SERVICES_DATA	 6
78 #define EFI_CONVENTIONAL_MEMORY		 7
79 #define EFI_UNUSABLE_MEMORY		 8
80 #define EFI_ACPI_RECLAIM_MEMORY		 9
81 #define EFI_ACPI_MEMORY_NVS		10
82 #define EFI_MEMORY_MAPPED_IO		11
83 #define EFI_MEMORY_MAPPED_IO_PORT_SPACE	12
84 #define EFI_PAL_CODE			13
85 #define EFI_MAX_MEMORY_TYPE		14
86 
87 /* Attribute values: */
88 #define EFI_MEMORY_UC		((u64)0x0000000000000001ULL)	/* uncached */
89 #define EFI_MEMORY_WC		((u64)0x0000000000000002ULL)	/* write-coalescing */
90 #define EFI_MEMORY_WT		((u64)0x0000000000000004ULL)	/* write-through */
91 #define EFI_MEMORY_WB		((u64)0x0000000000000008ULL)	/* write-back */
92 #define EFI_MEMORY_WP		((u64)0x0000000000001000ULL)	/* write-protect */
93 #define EFI_MEMORY_RP		((u64)0x0000000000002000ULL)	/* read-protect */
94 #define EFI_MEMORY_XP		((u64)0x0000000000004000ULL)	/* execute-protect */
95 #define EFI_MEMORY_RUNTIME	((u64)0x8000000000000000ULL)	/* range requires runtime mapping */
96 #define EFI_MEMORY_DESCRIPTOR_VERSION	1
97 
98 #define EFI_PAGE_SHIFT		12
99 
100 typedef struct {
101 	u32 type;
102 	u32 pad;
103 	u64 phys_addr;
104 	u64 virt_addr;
105 	u64 num_pages;
106 	u64 attribute;
107 } efi_memory_desc_t;
108 
109 typedef struct {
110 	efi_guid_t guid;
111 	u32 headersize;
112 	u32 flags;
113 	u32 imagesize;
114 } efi_capsule_header_t;
115 
116 /*
117  * Allocation types for calls to boottime->allocate_pages.
118  */
119 #define EFI_ALLOCATE_ANY_PAGES		0
120 #define EFI_ALLOCATE_MAX_ADDRESS	1
121 #define EFI_ALLOCATE_ADDRESS		2
122 #define EFI_MAX_ALLOCATE_TYPE		3
123 
124 typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
125 
126 /*
127  * Types and defines for Time Services
128  */
129 #define EFI_TIME_ADJUST_DAYLIGHT 0x1
130 #define EFI_TIME_IN_DAYLIGHT     0x2
131 #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
132 
133 typedef struct {
134 	u16 year;
135 	u8 month;
136 	u8 day;
137 	u8 hour;
138 	u8 minute;
139 	u8 second;
140 	u8 pad1;
141 	u32 nanosecond;
142 	s16 timezone;
143 	u8 daylight;
144 	u8 pad2;
145 } efi_time_t;
146 
147 typedef struct {
148 	u32 resolution;
149 	u32 accuracy;
150 	u8 sets_to_zero;
151 } efi_time_cap_t;
152 
153 /*
154  * EFI Boot Services table
155  */
156 typedef struct {
157 	efi_table_hdr_t hdr;
158 	void *raise_tpl;
159 	void *restore_tpl;
160 	void *allocate_pages;
161 	void *free_pages;
162 	void *get_memory_map;
163 	void *allocate_pool;
164 	void *free_pool;
165 	void *create_event;
166 	void *set_timer;
167 	void *wait_for_event;
168 	void *signal_event;
169 	void *close_event;
170 	void *check_event;
171 	void *install_protocol_interface;
172 	void *reinstall_protocol_interface;
173 	void *uninstall_protocol_interface;
174 	void *handle_protocol;
175 	void *__reserved;
176 	void *register_protocol_notify;
177 	void *locate_handle;
178 	void *locate_device_path;
179 	void *install_configuration_table;
180 	void *load_image;
181 	void *start_image;
182 	void *exit;
183 	void *unload_image;
184 	void *exit_boot_services;
185 	void *get_next_monotonic_count;
186 	void *stall;
187 	void *set_watchdog_timer;
188 	void *connect_controller;
189 	void *disconnect_controller;
190 	void *open_protocol;
191 	void *close_protocol;
192 	void *open_protocol_information;
193 	void *protocols_per_handle;
194 	void *locate_handle_buffer;
195 	void *locate_protocol;
196 	void *install_multiple_protocol_interfaces;
197 	void *uninstall_multiple_protocol_interfaces;
198 	void *calculate_crc32;
199 	void *copy_mem;
200 	void *set_mem;
201 	void *create_event_ex;
202 } efi_boot_services_t;
203 
204 /*
205  * Types and defines for EFI ResetSystem
206  */
207 #define EFI_RESET_COLD 0
208 #define EFI_RESET_WARM 1
209 #define EFI_RESET_SHUTDOWN 2
210 
211 /*
212  * EFI Runtime Services table
213  */
214 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
215 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
216 
217 typedef struct {
218 	efi_table_hdr_t hdr;
219 	unsigned long get_time;
220 	unsigned long set_time;
221 	unsigned long get_wakeup_time;
222 	unsigned long set_wakeup_time;
223 	unsigned long set_virtual_address_map;
224 	unsigned long convert_pointer;
225 	unsigned long get_variable;
226 	unsigned long get_next_variable;
227 	unsigned long set_variable;
228 	unsigned long get_next_high_mono_count;
229 	unsigned long reset_system;
230 	unsigned long update_capsule;
231 	unsigned long query_capsule_caps;
232 	unsigned long query_variable_info;
233 } efi_runtime_services_t;
234 
235 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
236 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
237 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
238 					    efi_time_t *tm);
239 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
240 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
241 					 unsigned long *data_size, void *data);
242 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
243 					      efi_guid_t *vendor);
244 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
245 					 u32 attr, unsigned long data_size,
246 					 void *data);
247 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
248 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
249 				 unsigned long data_size, efi_char16_t *data);
250 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
251 						unsigned long descriptor_size,
252 						u32 descriptor_version,
253 						efi_memory_desc_t *virtual_map);
254 typedef efi_status_t efi_query_variable_info_t(u32 attr,
255 					       u64 *storage_space,
256 					       u64 *remaining_space,
257 					       u64 *max_variable_size);
258 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
259 					  unsigned long count,
260 					  unsigned long sg_list);
261 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
262 					      unsigned long count,
263 					      u64 *max_size,
264 					      int *reset_type);
265 typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
266 
267 /*
268  *  EFI Configuration Table and GUID definitions
269  */
270 #define NULL_GUID \
271     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
272 
273 #define MPS_TABLE_GUID    \
274     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
275 
276 #define ACPI_TABLE_GUID    \
277     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
278 
279 #define ACPI_20_TABLE_GUID    \
280     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
281 
282 #define SMBIOS_TABLE_GUID    \
283     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
284 
285 #define SAL_SYSTEM_TABLE_GUID    \
286     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
287 
288 #define HCDP_TABLE_GUID	\
289     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
290 
291 #define UGA_IO_PROTOCOL_GUID \
292     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
293 
294 #define EFI_GLOBAL_VARIABLE_GUID \
295     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
296 
297 #define UV_SYSTEM_TABLE_GUID \
298     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
299 
300 #define LINUX_EFI_CRASH_GUID \
301     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
302 
303 #define LOADED_IMAGE_PROTOCOL_GUID \
304     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
305 
306 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
307     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
308 
309 #define EFI_UGA_PROTOCOL_GUID \
310     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
311 
312 #define EFI_PCI_IO_PROTOCOL_GUID \
313     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
314 
315 #define EFI_FILE_INFO_ID \
316     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
317 
318 #define EFI_FILE_SYSTEM_GUID \
319     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
320 
321 typedef struct {
322 	efi_guid_t guid;
323 	u64 table;
324 } efi_config_table_64_t;
325 
326 typedef struct {
327 	efi_guid_t guid;
328 	u32 table;
329 } efi_config_table_32_t;
330 
331 typedef struct {
332 	efi_guid_t guid;
333 	unsigned long table;
334 } efi_config_table_t;
335 
336 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
337 
338 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
339 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
340 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
341 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
342 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
343 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
344 
345 typedef struct {
346 	efi_table_hdr_t hdr;
347 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
348 	u32 fw_revision;
349 	u32 __pad1;
350 	u64 con_in_handle;
351 	u64 con_in;
352 	u64 con_out_handle;
353 	u64 con_out;
354 	u64 stderr_handle;
355 	u64 stderr;
356 	u64 runtime;
357 	u64 boottime;
358 	u32 nr_tables;
359 	u32 __pad2;
360 	u64 tables;
361 } efi_system_table_64_t;
362 
363 typedef struct {
364 	efi_table_hdr_t hdr;
365 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
366 	u32 fw_revision;
367 	u32 con_in_handle;
368 	u32 con_in;
369 	u32 con_out_handle;
370 	u32 con_out;
371 	u32 stderr_handle;
372 	u32 stderr;
373 	u32 runtime;
374 	u32 boottime;
375 	u32 nr_tables;
376 	u32 tables;
377 } efi_system_table_32_t;
378 
379 typedef struct {
380 	efi_table_hdr_t hdr;
381 	unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
382 	u32 fw_revision;
383 	unsigned long con_in_handle;
384 	unsigned long con_in;
385 	unsigned long con_out_handle;
386 	unsigned long con_out;
387 	unsigned long stderr_handle;
388 	unsigned long stderr;
389 	efi_runtime_services_t *runtime;
390 	efi_boot_services_t *boottime;
391 	unsigned long nr_tables;
392 	unsigned long tables;
393 } efi_system_table_t;
394 
395 struct efi_memory_map {
396 	void *phys_map;
397 	void *map;
398 	void *map_end;
399 	int nr_map;
400 	unsigned long desc_version;
401 	unsigned long desc_size;
402 };
403 
404 typedef struct {
405 	u32 revision;
406 	void *parent_handle;
407 	efi_system_table_t *system_table;
408 	void *device_handle;
409 	void *file_path;
410 	void *reserved;
411 	u32 load_options_size;
412 	void *load_options;
413 	void *image_base;
414 	__aligned_u64 image_size;
415 	unsigned int image_code_type;
416 	unsigned int image_data_type;
417 	unsigned long unload;
418 } efi_loaded_image_t;
419 
420 typedef struct {
421 	u64 revision;
422 	void *open_volume;
423 } efi_file_io_interface_t;
424 
425 typedef struct {
426 	u64 size;
427 	u64 file_size;
428 	u64 phys_size;
429 	efi_time_t create_time;
430 	efi_time_t last_access_time;
431 	efi_time_t modification_time;
432 	__aligned_u64 attribute;
433 	efi_char16_t filename[1];
434 } efi_file_info_t;
435 
436 typedef struct {
437 	u64 revision;
438 	void *open;
439 	void *close;
440 	void *delete;
441 	void *read;
442 	void *write;
443 	void *get_position;
444 	void *set_position;
445 	void *get_info;
446 	void *set_info;
447 	void *flush;
448 } efi_file_handle_t;
449 
450 #define EFI_FILE_MODE_READ	0x0000000000000001
451 #define EFI_FILE_MODE_WRITE	0x0000000000000002
452 #define EFI_FILE_MODE_CREATE	0x8000000000000000
453 
454 #define EFI_INVALID_TABLE_ADDR		(~0UL)
455 
456 /*
457  * All runtime access to EFI goes through this structure:
458  */
459 extern struct efi {
460 	efi_system_table_t *systab;	/* EFI system table */
461 	unsigned int runtime_version;	/* Runtime services version */
462 	unsigned long mps;		/* MPS table */
463 	unsigned long acpi;		/* ACPI table  (IA64 ext 0.71) */
464 	unsigned long acpi20;		/* ACPI table  (ACPI 2.0) */
465 	unsigned long smbios;		/* SM BIOS table */
466 	unsigned long sal_systab;	/* SAL system table */
467 	unsigned long boot_info;	/* boot info table */
468 	unsigned long hcdp;		/* HCDP table */
469 	unsigned long uga;		/* UGA table */
470 	unsigned long uv_systab;	/* UV system table */
471 	efi_get_time_t *get_time;
472 	efi_set_time_t *set_time;
473 	efi_get_wakeup_time_t *get_wakeup_time;
474 	efi_set_wakeup_time_t *set_wakeup_time;
475 	efi_get_variable_t *get_variable;
476 	efi_get_next_variable_t *get_next_variable;
477 	efi_set_variable_t *set_variable;
478 	efi_query_variable_info_t *query_variable_info;
479 	efi_update_capsule_t *update_capsule;
480 	efi_query_capsule_caps_t *query_capsule_caps;
481 	efi_get_next_high_mono_count_t *get_next_high_mono_count;
482 	efi_reset_system_t *reset_system;
483 	efi_set_virtual_address_map_t *set_virtual_address_map;
484 } efi;
485 
486 static inline int
efi_guidcmp(efi_guid_t left,efi_guid_t right)487 efi_guidcmp (efi_guid_t left, efi_guid_t right)
488 {
489 	return memcmp(&left, &right, sizeof (efi_guid_t));
490 }
491 
492 static inline char *
efi_guid_unparse(efi_guid_t * guid,char * out)493 efi_guid_unparse(efi_guid_t *guid, char *out)
494 {
495 	sprintf(out, "%pUl", guid->b);
496         return out;
497 }
498 
499 extern void efi_init (void);
500 extern void *efi_get_pal_addr (void);
501 extern void efi_map_pal_code (void);
502 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
503 extern void efi_gettimeofday (struct timespec *ts);
504 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
505 #ifdef CONFIG_X86
506 extern void efi_free_boot_services(void);
507 extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
508 #else
efi_free_boot_services(void)509 static inline void efi_free_boot_services(void) {}
510 
efi_query_variable_store(u32 attributes,unsigned long size)511 static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
512 {
513 	return EFI_SUCCESS;
514 }
515 #endif
516 extern u64 efi_get_iobase (void);
517 extern u32 efi_mem_type (unsigned long phys_addr);
518 extern u64 efi_mem_attributes (unsigned long phys_addr);
519 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
520 extern int __init efi_uart_console_only (void);
521 extern void efi_initialize_iomem_resources(struct resource *code_resource,
522 		struct resource *data_resource, struct resource *bss_resource);
523 extern unsigned long efi_get_time(void);
524 extern int efi_set_rtc_mmss(unsigned long nowtime);
525 extern void efi_reserve_boot_services(void);
526 extern struct efi_memory_map memmap;
527 
528 /**
529  * efi_range_is_wc - check the WC bit on an address range
530  * @start: starting kvirt address
531  * @len: length of range
532  *
533  * Consult the EFI memory map and make sure it's ok to set this range WC.
534  * Returns true or false.
535  */
efi_range_is_wc(unsigned long start,unsigned long len)536 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
537 {
538 	unsigned long i;
539 
540 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
541 		unsigned long paddr = __pa(start + i);
542 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
543 			return 0;
544 	}
545 	/* The range checked out */
546 	return 1;
547 }
548 
549 #ifdef CONFIG_EFI_PCDP
550 extern int __init efi_setup_pcdp_console(char *);
551 #endif
552 
553 /*
554  * We play games with efi_enabled so that the compiler will, if
555  * possible, remove EFI-related code altogether.
556  */
557 #define EFI_BOOT		0	/* Were we booted from EFI? */
558 #define EFI_SYSTEM_TABLES	1	/* Can we use EFI system tables? */
559 #define EFI_CONFIG_TABLES	2	/* Can we use EFI config tables? */
560 #define EFI_RUNTIME_SERVICES	3	/* Can we use runtime services? */
561 #define EFI_MEMMAP		4	/* Can we use EFI memory map? */
562 #define EFI_64BIT		5	/* Is the firmware 64-bit? */
563 
564 #ifdef CONFIG_EFI
565 # ifdef CONFIG_X86
566 extern int efi_enabled(int facility);
567 # else
efi_enabled(int facility)568 static inline int efi_enabled(int facility)
569 {
570 	return 1;
571 }
572 # endif
573 #else
efi_enabled(int facility)574 static inline int efi_enabled(int facility)
575 {
576 	return 0;
577 }
578 #endif
579 
580 /*
581  * Variable Attributes
582  */
583 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
584 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
585 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
586 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
587 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
588 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
589 #define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
590 
591 #define EFI_VARIABLE_MASK 	(EFI_VARIABLE_NON_VOLATILE | \
592 				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
593 				EFI_VARIABLE_RUNTIME_ACCESS | \
594 				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
595 				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
596 				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
597 				EFI_VARIABLE_APPEND_WRITE)
598 /*
599  * The type of search to perform when calling boottime->locate_handle
600  */
601 #define EFI_LOCATE_ALL_HANDLES			0
602 #define EFI_LOCATE_BY_REGISTER_NOTIFY		1
603 #define EFI_LOCATE_BY_PROTOCOL			2
604 
605 /*
606  * EFI Device Path information
607  */
608 #define EFI_DEV_HW			0x01
609 #define  EFI_DEV_PCI				 1
610 #define  EFI_DEV_PCCARD				 2
611 #define  EFI_DEV_MEM_MAPPED			 3
612 #define  EFI_DEV_VENDOR				 4
613 #define  EFI_DEV_CONTROLLER			 5
614 #define EFI_DEV_ACPI			0x02
615 #define   EFI_DEV_BASIC_ACPI			 1
616 #define   EFI_DEV_EXPANDED_ACPI			 2
617 #define EFI_DEV_MSG			0x03
618 #define   EFI_DEV_MSG_ATAPI			 1
619 #define   EFI_DEV_MSG_SCSI			 2
620 #define   EFI_DEV_MSG_FC			 3
621 #define   EFI_DEV_MSG_1394			 4
622 #define   EFI_DEV_MSG_USB			 5
623 #define   EFI_DEV_MSG_USB_CLASS			15
624 #define   EFI_DEV_MSG_I20			 6
625 #define   EFI_DEV_MSG_MAC			11
626 #define   EFI_DEV_MSG_IPV4			12
627 #define   EFI_DEV_MSG_IPV6			13
628 #define   EFI_DEV_MSG_INFINIBAND		 9
629 #define   EFI_DEV_MSG_UART			14
630 #define   EFI_DEV_MSG_VENDOR			10
631 #define EFI_DEV_MEDIA			0x04
632 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
633 #define   EFI_DEV_MEDIA_CDROM			 2
634 #define   EFI_DEV_MEDIA_VENDOR			 3
635 #define   EFI_DEV_MEDIA_FILE			 4
636 #define   EFI_DEV_MEDIA_PROTOCOL		 5
637 #define EFI_DEV_BIOS_BOOT		0x05
638 #define EFI_DEV_END_PATH		0x7F
639 #define EFI_DEV_END_PATH2		0xFF
640 #define   EFI_DEV_END_INSTANCE			0x01
641 #define   EFI_DEV_END_ENTIRE			0xFF
642 
643 struct efi_generic_dev_path {
644 	u8 type;
645 	u8 sub_type;
646 	u16 length;
647 } __attribute ((packed));
648 
memrange_efi_to_native(u64 * addr,u64 * npages)649 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
650 {
651 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
652 	*addr &= PAGE_MASK;
653 }
654 
655 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
656 /*
657  * EFI Variable support.
658  *
659  * Different firmware drivers can expose their EFI-like variables using
660  * the following.
661  */
662 
663 struct efivar_operations {
664 	efi_get_variable_t *get_variable;
665 	efi_get_next_variable_t *get_next_variable;
666 	efi_set_variable_t *set_variable;
667 	efi_query_variable_store_t *query_variable_store;
668 };
669 
670 struct efivars {
671 	/*
672 	 * ->lock protects two things:
673 	 * 1) ->list - adds, removals, reads, writes
674 	 * 2) ops.[gs]et_variable() calls.
675 	 * It must not be held when creating sysfs entries or calling kmalloc.
676 	 * ops.get_next_variable() is only called from register_efivars()
677 	 * or efivar_update_sysfs_entries(),
678 	 * which is protected by the BKL, so that path is safe.
679 	 */
680 	spinlock_t lock;
681 	struct list_head list;
682 	struct kset *kset;
683 	struct bin_attribute *new_var, *del_var;
684 	const struct efivar_operations *ops;
685 	struct efivar_entry *walk_entry;
686 	struct pstore_info efi_pstore_info;
687 };
688 
689 int register_efivars(struct efivars *efivars,
690 		     const struct efivar_operations *ops,
691 		     struct kobject *parent_kobj);
692 void unregister_efivars(struct efivars *efivars);
693 
694 #endif /* CONFIG_EFI_VARS */
695 
696 #endif /* _LINUX_EFI_H */
697