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