xref: /linux-6.15/include/linux/efi.h (revision 8fdff1dc)
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_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 typedef enum {
205 	EfiPciIoWidthUint8,
206 	EfiPciIoWidthUint16,
207 	EfiPciIoWidthUint32,
208 	EfiPciIoWidthUint64,
209 	EfiPciIoWidthFifoUint8,
210 	EfiPciIoWidthFifoUint16,
211 	EfiPciIoWidthFifoUint32,
212 	EfiPciIoWidthFifoUint64,
213 	EfiPciIoWidthFillUint8,
214 	EfiPciIoWidthFillUint16,
215 	EfiPciIoWidthFillUint32,
216 	EfiPciIoWidthFillUint64,
217 	EfiPciIoWidthMaximum
218 } EFI_PCI_IO_PROTOCOL_WIDTH;
219 
220 typedef enum {
221 	EfiPciIoAttributeOperationGet,
222 	EfiPciIoAttributeOperationSet,
223 	EfiPciIoAttributeOperationEnable,
224 	EfiPciIoAttributeOperationDisable,
225 	EfiPciIoAttributeOperationSupported,
226     EfiPciIoAttributeOperationMaximum
227 } EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
228 
229 
230 typedef struct {
231 	void *read;
232 	void *write;
233 } efi_pci_io_protocol_access_t;
234 
235 typedef struct {
236 	void *poll_mem;
237 	void *poll_io;
238 	efi_pci_io_protocol_access_t mem;
239 	efi_pci_io_protocol_access_t io;
240 	efi_pci_io_protocol_access_t pci;
241 	void *copy_mem;
242 	void *map;
243 	void *unmap;
244 	void *allocate_buffer;
245 	void *free_buffer;
246 	void *flush;
247 	void *get_location;
248 	void *attributes;
249 	void *get_bar_attributes;
250 	void *set_bar_attributes;
251 	uint64_t romsize;
252 	void *romimage;
253 } efi_pci_io_protocol;
254 
255 #define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
256 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
257 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
258 #define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
259 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
260 #define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
261 #define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
262 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
263 #define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
264 #define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
265 #define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
266 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
267 #define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
268 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
269 #define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
270 #define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
271 #define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
272 #define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
273 #define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
274 
275 /*
276  * Types and defines for EFI ResetSystem
277  */
278 #define EFI_RESET_COLD 0
279 #define EFI_RESET_WARM 1
280 #define EFI_RESET_SHUTDOWN 2
281 
282 /*
283  * EFI Runtime Services table
284  */
285 #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
286 #define EFI_RUNTIME_SERVICES_REVISION  0x00010000
287 
288 typedef struct {
289 	efi_table_hdr_t hdr;
290 	unsigned long get_time;
291 	unsigned long set_time;
292 	unsigned long get_wakeup_time;
293 	unsigned long set_wakeup_time;
294 	unsigned long set_virtual_address_map;
295 	unsigned long convert_pointer;
296 	unsigned long get_variable;
297 	unsigned long get_next_variable;
298 	unsigned long set_variable;
299 	unsigned long get_next_high_mono_count;
300 	unsigned long reset_system;
301 	unsigned long update_capsule;
302 	unsigned long query_capsule_caps;
303 	unsigned long query_variable_info;
304 } efi_runtime_services_t;
305 
306 typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
307 typedef efi_status_t efi_set_time_t (efi_time_t *tm);
308 typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
309 					    efi_time_t *tm);
310 typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
311 typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
312 					 unsigned long *data_size, void *data);
313 typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
314 					      efi_guid_t *vendor);
315 typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
316 					 u32 attr, unsigned long data_size,
317 					 void *data);
318 typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
319 typedef void efi_reset_system_t (int reset_type, efi_status_t status,
320 				 unsigned long data_size, efi_char16_t *data);
321 typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
322 						unsigned long descriptor_size,
323 						u32 descriptor_version,
324 						efi_memory_desc_t *virtual_map);
325 typedef efi_status_t efi_query_variable_info_t(u32 attr,
326 					       u64 *storage_space,
327 					       u64 *remaining_space,
328 					       u64 *max_variable_size);
329 typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
330 					  unsigned long count,
331 					  unsigned long sg_list);
332 typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
333 					      unsigned long count,
334 					      u64 *max_size,
335 					      int *reset_type);
336 
337 /*
338  *  EFI Configuration Table and GUID definitions
339  */
340 #define NULL_GUID \
341     EFI_GUID(  0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
342 
343 #define MPS_TABLE_GUID    \
344     EFI_GUID(  0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
345 
346 #define ACPI_TABLE_GUID    \
347     EFI_GUID(  0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
348 
349 #define ACPI_20_TABLE_GUID    \
350     EFI_GUID(  0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
351 
352 #define SMBIOS_TABLE_GUID    \
353     EFI_GUID(  0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
354 
355 #define SAL_SYSTEM_TABLE_GUID    \
356     EFI_GUID(  0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
357 
358 #define HCDP_TABLE_GUID	\
359     EFI_GUID(  0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
360 
361 #define UGA_IO_PROTOCOL_GUID \
362     EFI_GUID(  0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
363 
364 #define EFI_GLOBAL_VARIABLE_GUID \
365     EFI_GUID(  0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
366 
367 #define UV_SYSTEM_TABLE_GUID \
368     EFI_GUID(  0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
369 
370 #define LINUX_EFI_CRASH_GUID \
371     EFI_GUID(  0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
372 
373 #define LOADED_IMAGE_PROTOCOL_GUID \
374     EFI_GUID(  0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
375 
376 #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
377     EFI_GUID(  0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
378 
379 #define EFI_UGA_PROTOCOL_GUID \
380     EFI_GUID(  0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
381 
382 #define EFI_PCI_IO_PROTOCOL_GUID \
383     EFI_GUID(  0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
384 
385 #define EFI_FILE_INFO_ID \
386     EFI_GUID(  0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
387 
388 #define EFI_FILE_SYSTEM_GUID \
389     EFI_GUID(  0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
390 
391 typedef struct {
392 	efi_guid_t guid;
393 	u64 table;
394 } efi_config_table_64_t;
395 
396 typedef struct {
397 	efi_guid_t guid;
398 	u32 table;
399 } efi_config_table_32_t;
400 
401 typedef struct {
402 	efi_guid_t guid;
403 	unsigned long table;
404 } efi_config_table_t;
405 
406 #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
407 
408 #define EFI_2_30_SYSTEM_TABLE_REVISION  ((2 << 16) | (30))
409 #define EFI_2_20_SYSTEM_TABLE_REVISION  ((2 << 16) | (20))
410 #define EFI_2_10_SYSTEM_TABLE_REVISION  ((2 << 16) | (10))
411 #define EFI_2_00_SYSTEM_TABLE_REVISION  ((2 << 16) | (00))
412 #define EFI_1_10_SYSTEM_TABLE_REVISION  ((1 << 16) | (10))
413 #define EFI_1_02_SYSTEM_TABLE_REVISION  ((1 << 16) | (02))
414 
415 typedef struct {
416 	efi_table_hdr_t hdr;
417 	u64 fw_vendor;	/* physical addr of CHAR16 vendor string */
418 	u32 fw_revision;
419 	u32 __pad1;
420 	u64 con_in_handle;
421 	u64 con_in;
422 	u64 con_out_handle;
423 	u64 con_out;
424 	u64 stderr_handle;
425 	u64 stderr;
426 	u64 runtime;
427 	u64 boottime;
428 	u32 nr_tables;
429 	u32 __pad2;
430 	u64 tables;
431 } efi_system_table_64_t;
432 
433 typedef struct {
434 	efi_table_hdr_t hdr;
435 	u32 fw_vendor;	/* physical addr of CHAR16 vendor string */
436 	u32 fw_revision;
437 	u32 con_in_handle;
438 	u32 con_in;
439 	u32 con_out_handle;
440 	u32 con_out;
441 	u32 stderr_handle;
442 	u32 stderr;
443 	u32 runtime;
444 	u32 boottime;
445 	u32 nr_tables;
446 	u32 tables;
447 } efi_system_table_32_t;
448 
449 typedef struct {
450 	efi_table_hdr_t hdr;
451 	unsigned long fw_vendor;	/* physical addr of CHAR16 vendor string */
452 	u32 fw_revision;
453 	unsigned long con_in_handle;
454 	unsigned long con_in;
455 	unsigned long con_out_handle;
456 	unsigned long con_out;
457 	unsigned long stderr_handle;
458 	unsigned long stderr;
459 	efi_runtime_services_t *runtime;
460 	efi_boot_services_t *boottime;
461 	unsigned long nr_tables;
462 	unsigned long tables;
463 } efi_system_table_t;
464 
465 struct efi_memory_map {
466 	void *phys_map;
467 	void *map;
468 	void *map_end;
469 	int nr_map;
470 	unsigned long desc_version;
471 	unsigned long desc_size;
472 };
473 
474 typedef struct {
475 	u32 revision;
476 	void *parent_handle;
477 	efi_system_table_t *system_table;
478 	void *device_handle;
479 	void *file_path;
480 	void *reserved;
481 	u32 load_options_size;
482 	void *load_options;
483 	void *image_base;
484 	__aligned_u64 image_size;
485 	unsigned int image_code_type;
486 	unsigned int image_data_type;
487 	unsigned long unload;
488 } efi_loaded_image_t;
489 
490 typedef struct {
491 	u64 revision;
492 	void *open_volume;
493 } efi_file_io_interface_t;
494 
495 typedef struct {
496 	u64 size;
497 	u64 file_size;
498 	u64 phys_size;
499 	efi_time_t create_time;
500 	efi_time_t last_access_time;
501 	efi_time_t modification_time;
502 	__aligned_u64 attribute;
503 	efi_char16_t filename[1];
504 } efi_file_info_t;
505 
506 typedef struct {
507 	u64 revision;
508 	void *open;
509 	void *close;
510 	void *delete;
511 	void *read;
512 	void *write;
513 	void *get_position;
514 	void *set_position;
515 	void *get_info;
516 	void *set_info;
517 	void *flush;
518 } efi_file_handle_t;
519 
520 #define EFI_FILE_MODE_READ	0x0000000000000001
521 #define EFI_FILE_MODE_WRITE	0x0000000000000002
522 #define EFI_FILE_MODE_CREATE	0x8000000000000000
523 
524 #define EFI_INVALID_TABLE_ADDR		(~0UL)
525 
526 /*
527  * All runtime access to EFI goes through this structure:
528  */
529 extern struct efi {
530 	efi_system_table_t *systab;	/* EFI system table */
531 	unsigned int runtime_version;	/* Runtime services version */
532 	unsigned long mps;		/* MPS table */
533 	unsigned long acpi;		/* ACPI table  (IA64 ext 0.71) */
534 	unsigned long acpi20;		/* ACPI table  (ACPI 2.0) */
535 	unsigned long smbios;		/* SM BIOS table */
536 	unsigned long sal_systab;	/* SAL system table */
537 	unsigned long boot_info;	/* boot info table */
538 	unsigned long hcdp;		/* HCDP table */
539 	unsigned long uga;		/* UGA table */
540 	unsigned long uv_systab;	/* UV system table */
541 	efi_get_time_t *get_time;
542 	efi_set_time_t *set_time;
543 	efi_get_wakeup_time_t *get_wakeup_time;
544 	efi_set_wakeup_time_t *set_wakeup_time;
545 	efi_get_variable_t *get_variable;
546 	efi_get_next_variable_t *get_next_variable;
547 	efi_set_variable_t *set_variable;
548 	efi_query_variable_info_t *query_variable_info;
549 	efi_update_capsule_t *update_capsule;
550 	efi_query_capsule_caps_t *query_capsule_caps;
551 	efi_get_next_high_mono_count_t *get_next_high_mono_count;
552 	efi_reset_system_t *reset_system;
553 	efi_set_virtual_address_map_t *set_virtual_address_map;
554 } efi;
555 
556 static inline int
557 efi_guidcmp (efi_guid_t left, efi_guid_t right)
558 {
559 	return memcmp(&left, &right, sizeof (efi_guid_t));
560 }
561 
562 static inline char *
563 efi_guid_unparse(efi_guid_t *guid, char *out)
564 {
565 	sprintf(out, "%pUl", guid->b);
566         return out;
567 }
568 
569 extern void efi_init (void);
570 extern void *efi_get_pal_addr (void);
571 extern void efi_map_pal_code (void);
572 extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
573 extern void efi_gettimeofday (struct timespec *ts);
574 extern void efi_enter_virtual_mode (void);	/* switch EFI to virtual mode, if possible */
575 #ifdef CONFIG_X86
576 extern void efi_late_init(void);
577 extern void efi_free_boot_services(void);
578 #else
579 static inline void efi_late_init(void) {}
580 static inline void efi_free_boot_services(void) {}
581 #endif
582 extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
583 extern u64 efi_get_iobase (void);
584 extern u32 efi_mem_type (unsigned long phys_addr);
585 extern u64 efi_mem_attributes (unsigned long phys_addr);
586 extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
587 extern int __init efi_uart_console_only (void);
588 extern void efi_initialize_iomem_resources(struct resource *code_resource,
589 		struct resource *data_resource, struct resource *bss_resource);
590 extern unsigned long efi_get_time(void);
591 extern int efi_set_rtc_mmss(unsigned long nowtime);
592 extern void efi_reserve_boot_services(void);
593 extern struct efi_memory_map memmap;
594 
595 /**
596  * efi_range_is_wc - check the WC bit on an address range
597  * @start: starting kvirt address
598  * @len: length of range
599  *
600  * Consult the EFI memory map and make sure it's ok to set this range WC.
601  * Returns true or false.
602  */
603 static inline int efi_range_is_wc(unsigned long start, unsigned long len)
604 {
605 	unsigned long i;
606 
607 	for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
608 		unsigned long paddr = __pa(start + i);
609 		if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
610 			return 0;
611 	}
612 	/* The range checked out */
613 	return 1;
614 }
615 
616 #ifdef CONFIG_EFI_PCDP
617 extern int __init efi_setup_pcdp_console(char *);
618 #endif
619 
620 /*
621  * We play games with efi_enabled so that the compiler will, if possible, remove
622  * EFI-related code altogether.
623  */
624 #ifdef CONFIG_EFI
625 # ifdef CONFIG_X86
626    extern int efi_enabled;
627    extern bool efi_64bit;
628 # else
629 #  define efi_enabled 1
630 # endif
631 #else
632 # define efi_enabled 0
633 #endif
634 
635 /*
636  * Variable Attributes
637  */
638 #define EFI_VARIABLE_NON_VOLATILE       0x0000000000000001
639 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
640 #define EFI_VARIABLE_RUNTIME_ACCESS     0x0000000000000004
641 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
642 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
643 #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
644 #define EFI_VARIABLE_APPEND_WRITE	0x0000000000000040
645 
646 #define EFI_VARIABLE_MASK 	(EFI_VARIABLE_NON_VOLATILE | \
647 				EFI_VARIABLE_BOOTSERVICE_ACCESS | \
648 				EFI_VARIABLE_RUNTIME_ACCESS | \
649 				EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
650 				EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
651 				EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
652 				EFI_VARIABLE_APPEND_WRITE)
653 /*
654  * The type of search to perform when calling boottime->locate_handle
655  */
656 #define EFI_LOCATE_ALL_HANDLES			0
657 #define EFI_LOCATE_BY_REGISTER_NOTIFY		1
658 #define EFI_LOCATE_BY_PROTOCOL			2
659 
660 /*
661  * EFI Device Path information
662  */
663 #define EFI_DEV_HW			0x01
664 #define  EFI_DEV_PCI				 1
665 #define  EFI_DEV_PCCARD				 2
666 #define  EFI_DEV_MEM_MAPPED			 3
667 #define  EFI_DEV_VENDOR				 4
668 #define  EFI_DEV_CONTROLLER			 5
669 #define EFI_DEV_ACPI			0x02
670 #define   EFI_DEV_BASIC_ACPI			 1
671 #define   EFI_DEV_EXPANDED_ACPI			 2
672 #define EFI_DEV_MSG			0x03
673 #define   EFI_DEV_MSG_ATAPI			 1
674 #define   EFI_DEV_MSG_SCSI			 2
675 #define   EFI_DEV_MSG_FC			 3
676 #define   EFI_DEV_MSG_1394			 4
677 #define   EFI_DEV_MSG_USB			 5
678 #define   EFI_DEV_MSG_USB_CLASS			15
679 #define   EFI_DEV_MSG_I20			 6
680 #define   EFI_DEV_MSG_MAC			11
681 #define   EFI_DEV_MSG_IPV4			12
682 #define   EFI_DEV_MSG_IPV6			13
683 #define   EFI_DEV_MSG_INFINIBAND		 9
684 #define   EFI_DEV_MSG_UART			14
685 #define   EFI_DEV_MSG_VENDOR			10
686 #define EFI_DEV_MEDIA			0x04
687 #define   EFI_DEV_MEDIA_HARD_DRIVE		 1
688 #define   EFI_DEV_MEDIA_CDROM			 2
689 #define   EFI_DEV_MEDIA_VENDOR			 3
690 #define   EFI_DEV_MEDIA_FILE			 4
691 #define   EFI_DEV_MEDIA_PROTOCOL		 5
692 #define EFI_DEV_BIOS_BOOT		0x05
693 #define EFI_DEV_END_PATH		0x7F
694 #define EFI_DEV_END_PATH2		0xFF
695 #define   EFI_DEV_END_INSTANCE			0x01
696 #define   EFI_DEV_END_ENTIRE			0xFF
697 
698 struct efi_generic_dev_path {
699 	u8 type;
700 	u8 sub_type;
701 	u16 length;
702 } __attribute ((packed));
703 
704 static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
705 {
706 	*npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
707 	*addr &= PAGE_MASK;
708 }
709 
710 #if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
711 /*
712  * EFI Variable support.
713  *
714  * Different firmware drivers can expose their EFI-like variables using
715  * the following.
716  */
717 
718 struct efivar_operations {
719 	efi_get_variable_t *get_variable;
720 	efi_get_next_variable_t *get_next_variable;
721 	efi_set_variable_t *set_variable;
722 	efi_query_variable_info_t *query_variable_info;
723 };
724 
725 struct efivars {
726 	/*
727 	 * ->lock protects two things:
728 	 * 1) ->list - adds, removals, reads, writes
729 	 * 2) ops.[gs]et_variable() calls.
730 	 * It must not be held when creating sysfs entries or calling kmalloc.
731 	 * ops.get_next_variable() is only called from register_efivars(),
732 	 * which is protected by the BKL, so that path is safe.
733 	 */
734 	spinlock_t lock;
735 	struct list_head list;
736 	struct kset *kset;
737 	struct kobject *kobject;
738 	struct bin_attribute *new_var, *del_var;
739 	const struct efivar_operations *ops;
740 	struct efivar_entry *walk_entry;
741 	struct pstore_info efi_pstore_info;
742 };
743 
744 int register_efivars(struct efivars *efivars,
745 		     const struct efivar_operations *ops,
746 		     struct kobject *parent_kobj);
747 void unregister_efivars(struct efivars *efivars);
748 
749 #endif /* CONFIG_EFI_VARS */
750 
751 #endif /* _LINUX_EFI_H */
752