]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/efi.h
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
efi: Export more EFI table variables to sysfs
[mirror_ubuntu-bionic-kernel.git] / include / linux / efi.h
CommitLineData
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>
1da177e4
LT		 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)))
5d9db883
MG		 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)))
1da177e4 36#define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
5d9db883 37#define EFI_SECURITY_VIOLATION (26 | (1UL << (BITS_PER_LONG-1)))
1da177e4
LT		 38
39typedef unsigned long efi_status_t;
40typedef u8 efi_bool_t;
41typedef u16 efi_char16_t; /* UNICODE character */
ed37ddff
RF		 42typedef u64 efi_physical_addr_t;
43typedef void *efi_handle_t;
1da177e4
LT		 44
45
46typedef struct {
47 u8 b[16];
48} efi_guid_t;
49
50#define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
51((efi_guid_t) \
52{{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
53 (b) & 0xff, ((b) >> 8) & 0xff, \
54 (c) & 0xff, ((c) >> 8) & 0xff, \
55 (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
56
57/*
58 * Generic EFI table header
59 */
60typedef struct {
61 u64 signature;
62 u32 revision;
63 u32 headersize;
64 u32 crc32;
65 u32 reserved;
66} efi_table_hdr_t;
67
68/*
69 * Memory map descriptor:
70 */
71
72/* Memory types: */
73#define EFI_RESERVED_TYPE 0
74#define EFI_LOADER_CODE 1
75#define EFI_LOADER_DATA 2
76#define EFI_BOOT_SERVICES_CODE 3
77#define EFI_BOOT_SERVICES_DATA 4
78#define EFI_RUNTIME_SERVICES_CODE 5
79#define EFI_RUNTIME_SERVICES_DATA 6
80#define EFI_CONVENTIONAL_MEMORY 7
81#define EFI_UNUSABLE_MEMORY 8
82#define EFI_ACPI_RECLAIM_MEMORY 9
83#define EFI_ACPI_MEMORY_NVS 10
84#define EFI_MEMORY_MAPPED_IO 11
85#define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
86#define EFI_PAL_CODE 13
87#define EFI_MAX_MEMORY_TYPE 14
88
89/* Attribute values: */
90#define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
91#define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
92#define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
93#define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
94#define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
95#define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
96#define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
97#define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
98#define EFI_MEMORY_DESCRIPTOR_VERSION 1
99
100#define EFI_PAGE_SHIFT 12
ed37ddff 101#define EFI_PAGE_SIZE (1UL << EFI_PAGE_SHIFT)
1da177e4 102
1da177e4
LT		 103typedef struct {
104 u32 type;
105 u32 pad;
106 u64 phys_addr;
107 u64 virt_addr;
108 u64 num_pages;
109 u64 attribute;
1da177e4
LT		 110} efi_memory_desc_t;
111
3b370237
MG		 112typedef struct {
113 efi_guid_t guid;
114 u32 headersize;
115 u32 flags;
116 u32 imagesize;
117} efi_capsule_header_t;
118
bb05e4ba
MF		 119/*
120 * Allocation types for calls to boottime->allocate_pages.
121 */
122#define EFI_ALLOCATE_ANY_PAGES 0
123#define EFI_ALLOCATE_MAX_ADDRESS 1
124#define EFI_ALLOCATE_ADDRESS 2
125#define EFI_MAX_ALLOCATE_TYPE 3
126
e088a4ad 127typedef int (*efi_freemem_callback_t) (u64 start, u64 end, void *arg);
1da177e4
LT		 128
129/*
130 * Types and defines for Time Services
131 */
132#define EFI_TIME_ADJUST_DAYLIGHT 0x1
133#define EFI_TIME_IN_DAYLIGHT 0x2
134#define EFI_UNSPECIFIED_TIMEZONE 0x07ff
135
136typedef struct {
137 u16 year;
138 u8 month;
139 u8 day;
140 u8 hour;
141 u8 minute;
142 u8 second;
143 u8 pad1;
144 u32 nanosecond;
145 s16 timezone;
146 u8 daylight;
147 u8 pad2;
148} efi_time_t;
149
150typedef struct {
151 u32 resolution;
152 u32 accuracy;
153 u8 sets_to_zero;
154} efi_time_cap_t;
155
f30ca6ba
MF		 156/*
157 * EFI Boot Services table
158 */
159typedef struct {
160 efi_table_hdr_t hdr;
161 void *raise_tpl;
162 void *restore_tpl;
ed37ddff
RF		 163 efi_status_t (*allocate_pages)(int, int, unsigned long,
164 efi_physical_addr_t *);
165 efi_status_t (*free_pages)(efi_physical_addr_t, unsigned long);
166 efi_status_t (*get_memory_map)(unsigned long *, void *, unsigned long *,
167 unsigned long *, u32 *);
168 efi_status_t (*allocate_pool)(int, unsigned long, void **);
169 efi_status_t (*free_pool)(void *);
f30ca6ba
MF		 170 void *create_event;
171 void *set_timer;
172 void *wait_for_event;
173 void *signal_event;
174 void *close_event;
175 void *check_event;
176 void *install_protocol_interface;
177 void *reinstall_protocol_interface;
178 void *uninstall_protocol_interface;
ed37ddff 179 efi_status_t (*handle_protocol)(efi_handle_t, efi_guid_t *, void **);
f30ca6ba
MF		 180 void *__reserved;
181 void *register_protocol_notify;
182 void *locate_handle;
183 void *locate_device_path;
184 void *install_configuration_table;
185 void *load_image;
186 void *start_image;
187 void *exit;
188 void *unload_image;
ed37ddff 189 efi_status_t (*exit_boot_services)(efi_handle_t, unsigned long);
f30ca6ba
MF		 190 void *get_next_monotonic_count;
191 void *stall;
192 void *set_watchdog_timer;
193 void *connect_controller;
194 void *disconnect_controller;
195 void *open_protocol;
196 void *close_protocol;
197 void *open_protocol_information;
198 void *protocols_per_handle;
199 void *locate_handle_buffer;
200 void *locate_protocol;
201 void *install_multiple_protocol_interfaces;
202 void *uninstall_multiple_protocol_interfaces;
203 void *calculate_crc32;
204 void *copy_mem;
205 void *set_mem;
206 void *create_event_ex;
207} efi_boot_services_t;
208
dd5fc854
MG		 209typedef enum {
210 EfiPciIoWidthUint8,
211 EfiPciIoWidthUint16,
212 EfiPciIoWidthUint32,
213 EfiPciIoWidthUint64,
214 EfiPciIoWidthFifoUint8,
215 EfiPciIoWidthFifoUint16,
216 EfiPciIoWidthFifoUint32,
217 EfiPciIoWidthFifoUint64,
218 EfiPciIoWidthFillUint8,
219 EfiPciIoWidthFillUint16,
220 EfiPciIoWidthFillUint32,
221 EfiPciIoWidthFillUint64,
222 EfiPciIoWidthMaximum
223} EFI_PCI_IO_PROTOCOL_WIDTH;
224
225typedef enum {
226 EfiPciIoAttributeOperationGet,
227 EfiPciIoAttributeOperationSet,
228 EfiPciIoAttributeOperationEnable,
229 EfiPciIoAttributeOperationDisable,
230 EfiPciIoAttributeOperationSupported,
231 EfiPciIoAttributeOperationMaximum
232} EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION;
233
234
235typedef struct {
236 void *read;
237 void *write;
238} efi_pci_io_protocol_access_t;
239
240typedef struct {
241 void *poll_mem;
242 void *poll_io;
243 efi_pci_io_protocol_access_t mem;
244 efi_pci_io_protocol_access_t io;
245 efi_pci_io_protocol_access_t pci;
246 void *copy_mem;
247 void *map;
248 void *unmap;
249 void *allocate_buffer;
250 void *free_buffer;
251 void *flush;
252 void *get_location;
253 void *attributes;
254 void *get_bar_attributes;
255 void *set_bar_attributes;
256 uint64_t romsize;
257 void *romimage;
258} efi_pci_io_protocol;
259
260#define EFI_PCI_IO_ATTRIBUTE_ISA_MOTHERBOARD_IO 0x0001
261#define EFI_PCI_IO_ATTRIBUTE_ISA_IO 0x0002
262#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO 0x0004
263#define EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY 0x0008
264#define EFI_PCI_IO_ATTRIBUTE_VGA_IO 0x0010
265#define EFI_PCI_IO_ATTRIBUTE_IDE_PRIMARY_IO 0x0020
266#define EFI_PCI_IO_ATTRIBUTE_IDE_SECONDARY_IO 0x0040
267#define EFI_PCI_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x0080
268#define EFI_PCI_IO_ATTRIBUTE_IO 0x0100
269#define EFI_PCI_IO_ATTRIBUTE_MEMORY 0x0200
270#define EFI_PCI_IO_ATTRIBUTE_BUS_MASTER 0x0400
271#define EFI_PCI_IO_ATTRIBUTE_MEMORY_CACHED 0x0800
272#define EFI_PCI_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000
273#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_DEVICE 0x2000
274#define EFI_PCI_IO_ATTRIBUTE_EMBEDDED_ROM 0x4000
275#define EFI_PCI_IO_ATTRIBUTE_DUAL_ADDRESS_CYCLE 0x8000
276#define EFI_PCI_IO_ATTRIBUTE_ISA_IO_16 0x10000
277#define EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO_16 0x20000
278#define EFI_PCI_IO_ATTRIBUTE_VGA_IO_16 0x40000
279
1da177e4
LT		 280/*
281 * Types and defines for EFI ResetSystem
282 */
283#define EFI_RESET_COLD 0
284#define EFI_RESET_WARM 1
285#define EFI_RESET_SHUTDOWN 2
286
287/*
288 * EFI Runtime Services table
289 */
290#define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
291#define EFI_RUNTIME_SERVICES_REVISION 0x00010000
292
293typedef struct {
294 efi_table_hdr_t hdr;
43ab0476
BP		 295 void *get_time;
296 void *set_time;
297 void *get_wakeup_time;
298 void *set_wakeup_time;
299 void *set_virtual_address_map;
300 void *convert_pointer;
301 void *get_variable;
302 void *get_next_variable;
303 void *set_variable;
304 void *get_next_high_mono_count;
305 void *reset_system;
306 void *update_capsule;
307 void *query_capsule_caps;
308 void *query_variable_info;
1da177e4
LT		 309} efi_runtime_services_t;
310
311typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
312typedef efi_status_t efi_set_time_t (efi_time_t *tm);
313typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
314 efi_time_t *tm);
315typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
316typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
317 unsigned long *data_size, void *data);
318typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
319 efi_guid_t *vendor);
320typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
f7a2d73f 321 u32 attr, unsigned long data_size,
1da177e4
LT		 322 void *data);
323typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
324typedef void efi_reset_system_t (int reset_type, efi_status_t status,
325 unsigned long data_size, efi_char16_t *data);
326typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
327 unsigned long descriptor_size,
328 u32 descriptor_version,
329 efi_memory_desc_t *virtual_map);
3b370237
MG		 330typedef efi_status_t efi_query_variable_info_t(u32 attr,
331 u64 *storage_space,
332 u64 *remaining_space,
333 u64 *max_variable_size);
334typedef efi_status_t efi_update_capsule_t(efi_capsule_header_t **capsules,
335 unsigned long count,
336 unsigned long sg_list);
337typedef efi_status_t efi_query_capsule_caps_t(efi_capsule_header_t **capsules,
338 unsigned long count,
339 u64 *max_size,
340 int *reset_type);
a6e4d5a0 341typedef efi_status_t efi_query_variable_store_t(u32 attributes, unsigned long size);
1da177e4
LT		 342
343/*
344 * EFI Configuration Table and GUID definitions
345 */
346#define NULL_GUID \
347 EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
348
349#define MPS_TABLE_GUID \
350 EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
351
352#define ACPI_TABLE_GUID \
353 EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
354
355#define ACPI_20_TABLE_GUID \
356 EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
357
358#define SMBIOS_TABLE_GUID \
359 EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
360
361#define SAL_SYSTEM_TABLE_GUID \
362 EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
363
364#define HCDP_TABLE_GUID \
365 EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
366
367#define UGA_IO_PROTOCOL_GUID \
368 EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
369
370#define EFI_GLOBAL_VARIABLE_GUID \
371 EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
372
a50f70b1
RA		 373#define UV_SYSTEM_TABLE_GUID \
374 EFI_GUID( 0x3b13a7d4, 0x633e, 0x11dd, 0x93, 0xec, 0xda, 0x25, 0x56, 0xd8, 0x95, 0x93 )
375
5ee9c198
MG		 376#define LINUX_EFI_CRASH_GUID \
377 EFI_GUID( 0xcfc8fc79, 0xbe2e, 0x4ddc, 0x97, 0xf0, 0x9f, 0x98, 0xbf, 0xe2, 0x98, 0xa0 )
378
8e84f345
MF		 379#define LOADED_IMAGE_PROTOCOL_GUID \
380 EFI_GUID( 0x5b1b31a1, 0x9562, 0x11d2, 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
381
0f7c5d47
MF		 382#define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
383 EFI_GUID( 0x9042a9de, 0x23dc, 0x4a38, 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a )
384
385#define EFI_UGA_PROTOCOL_GUID \
386 EFI_GUID( 0x982c298b, 0xf4fa, 0x41cb, 0xb8, 0x38, 0x77, 0xaa, 0x68, 0x8f, 0xb8, 0x39 )
387
388#define EFI_PCI_IO_PROTOCOL_GUID \
389 EFI_GUID( 0x4cf5b200, 0x68b8, 0x4ca5, 0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a )
390
55839d51
MF		 391#define EFI_FILE_INFO_ID \
392 EFI_GUID( 0x9576e92, 0x6d3f, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
393
394#define EFI_FILE_SYSTEM_GUID \
395 EFI_GUID( 0x964e5b22, 0x6459, 0x11d2, 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b )
396
1adbfa35
OJ		 397typedef struct {
398 efi_guid_t guid;
399 u64 table;
400} efi_config_table_64_t;
401
402typedef struct {
403 efi_guid_t guid;
404 u32 table;
405} efi_config_table_32_t;
406
1da177e4
LT		 407typedef struct {
408 efi_guid_t guid;
409 unsigned long table;
410} efi_config_table_t;
411
272686bf
LL		 412typedef struct {
413 efi_guid_t guid;
414 const char *name;
415 unsigned long *ptr;
416} efi_config_table_type_t;
417
1da177e4 418#define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
1da177e4 419
3b370237
MG		 420#define EFI_2_30_SYSTEM_TABLE_REVISION ((2 << 16) | (30))
421#define EFI_2_20_SYSTEM_TABLE_REVISION ((2 << 16) | (20))
422#define EFI_2_10_SYSTEM_TABLE_REVISION ((2 << 16) | (10))
423#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | (00))
424#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | (10))
425#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | (02))
426
1adbfa35
OJ		 427typedef struct {
428 efi_table_hdr_t hdr;
429 u64 fw_vendor; /* physical addr of CHAR16 vendor string */
430 u32 fw_revision;
431 u32 __pad1;
432 u64 con_in_handle;
433 u64 con_in;
434 u64 con_out_handle;
435 u64 con_out;
436 u64 stderr_handle;
437 u64 stderr;
438 u64 runtime;
439 u64 boottime;
440 u32 nr_tables;
441 u32 __pad2;
442 u64 tables;
443} efi_system_table_64_t;
444
445typedef struct {
446 efi_table_hdr_t hdr;
447 u32 fw_vendor; /* physical addr of CHAR16 vendor string */
448 u32 fw_revision;
449 u32 con_in_handle;
450 u32 con_in;
451 u32 con_out_handle;
452 u32 con_out;
453 u32 stderr_handle;
454 u32 stderr;
455 u32 runtime;
456 u32 boottime;
457 u32 nr_tables;
458 u32 tables;
459} efi_system_table_32_t;
460
1da177e4
LT		 461typedef struct {
462 efi_table_hdr_t hdr;
463 unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
464 u32 fw_revision;
465 unsigned long con_in_handle;
466 unsigned long con_in;
467 unsigned long con_out_handle;
468 unsigned long con_out;
469 unsigned long stderr_handle;
470 unsigned long stderr;
471 efi_runtime_services_t *runtime;
f30ca6ba 472 efi_boot_services_t *boottime;
1da177e4
LT		 473 unsigned long nr_tables;
474 unsigned long tables;
475} efi_system_table_t;
476
477struct efi_memory_map {
7ae65fd3
MT		 478 void *phys_map;
479 void *map;
480 void *map_end;
1da177e4
LT		 481 int nr_map;
482 unsigned long desc_version;
7ae65fd3 483 unsigned long desc_size;
1da177e4
LT		 484};
485
8e84f345
MF		 486typedef struct {
487 u32 revision;
488 void *parent_handle;
489 efi_system_table_t *system_table;
490 void *device_handle;
491 void *file_path;
492 void *reserved;
493 u32 load_options_size;
494 void *load_options;
495 void *image_base;
496 __aligned_u64 image_size;
497 unsigned int image_code_type;
498 unsigned int image_data_type;
499 unsigned long unload;
500} efi_loaded_image_t;
501
55839d51
MF		 502
503typedef struct {
504 u64 size;
505 u64 file_size;
506 u64 phys_size;
507 efi_time_t create_time;
508 efi_time_t last_access_time;
509 efi_time_t modification_time;
510 __aligned_u64 attribute;
511 efi_char16_t filename[1];
512} efi_file_info_t;
513
ed37ddff 514typedef struct _efi_file_handle {
55839d51 515 u64 revision;
ed37ddff
RF		 516 efi_status_t (*open)(struct _efi_file_handle *,
517 struct _efi_file_handle **,
518 efi_char16_t *, u64, u64);
519 efi_status_t (*close)(struct _efi_file_handle *);
55839d51 520 void *delete;
ed37ddff
RF		 521 efi_status_t (*read)(struct _efi_file_handle *, unsigned long *,
522 void *);
55839d51
MF		 523 void *write;
524 void *get_position;
525 void *set_position;
ed37ddff
RF		 526 efi_status_t (*get_info)(struct _efi_file_handle *, efi_guid_t *,
527 unsigned long *, void *);
55839d51
MF		 528 void *set_info;
529 void *flush;
530} efi_file_handle_t;
531
ed37ddff
RF		 532typedef struct _efi_file_io_interface {
533 u64 revision;
534 int (*open_volume)(struct _efi_file_io_interface *,
535 efi_file_handle_t **);
536} efi_file_io_interface_t;
537
55839d51
MF		 538#define EFI_FILE_MODE_READ 0x0000000000000001
539#define EFI_FILE_MODE_WRITE 0x0000000000000002
540#define EFI_FILE_MODE_CREATE 0x8000000000000000
541
b2c99e3c
BH		 542#define EFI_INVALID_TABLE_ADDR (~0UL)
543
1da177e4
LT		 544/*
545 * All runtime access to EFI goes through this structure:
546 */
547extern struct efi {
548 efi_system_table_t *systab; /* EFI system table */
3b370237 549 unsigned int runtime_version; /* Runtime services version */
b2c99e3c
BH		 550 unsigned long mps; /* MPS table */
551 unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
552 unsigned long acpi20; /* ACPI table (ACPI 2.0) */
553 unsigned long smbios; /* SM BIOS table */
554 unsigned long sal_systab; /* SAL system table */
555 unsigned long boot_info; /* boot info table */
556 unsigned long hcdp; /* HCDP table */
557 unsigned long uga; /* UGA table */
a50f70b1 558 unsigned long uv_systab; /* UV system table */
a0998eb1
DY		 559 unsigned long fw_vendor; /* fw_vendor */
560 unsigned long runtime; /* runtime table */
561 unsigned long config_table; /* config tables */
1da177e4
LT		 562 efi_get_time_t *get_time;
563 efi_set_time_t *set_time;
564 efi_get_wakeup_time_t *get_wakeup_time;
565 efi_set_wakeup_time_t *set_wakeup_time;
566 efi_get_variable_t *get_variable;
567 efi_get_next_variable_t *get_next_variable;
568 efi_set_variable_t *set_variable;
3b370237
MG		 569 efi_query_variable_info_t *query_variable_info;
570 efi_update_capsule_t *update_capsule;
571 efi_query_capsule_caps_t *query_capsule_caps;
1da177e4
LT		 572 efi_get_next_high_mono_count_t *get_next_high_mono_count;
573 efi_reset_system_t *reset_system;
574 efi_set_virtual_address_map_t *set_virtual_address_map;
258f6fd7 575 struct efi_memory_map *memmap;
1da177e4
LT		 576} efi;
577
578static inline int
579efi_guidcmp (efi_guid_t left, efi_guid_t right)
580{
581 return memcmp(&left, &right, sizeof (efi_guid_t));
582}
583
584static inline char *
585efi_guid_unparse(efi_guid_t *guid, char *out)
586{
925ede0b 587 sprintf(out, "%pUl", guid->b);
1da177e4
LT		 588 return out;
589}
590
591extern void efi_init (void);
592extern void *efi_get_pal_addr (void);
593extern void efi_map_pal_code (void);
1da177e4
LT		 594extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
595extern void efi_gettimeofday (struct timespec *ts);
596extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
78510792 597#ifdef CONFIG_X86
2223af38 598extern void efi_late_init(void);
78510792 599extern void efi_free_boot_services(void);
a6e4d5a0 600extern efi_status_t efi_query_variable_store(u32 attributes, unsigned long size);
78510792 601#else
2223af38 602static inline void efi_late_init(void) {}
78510792 603static inline void efi_free_boot_services(void) {}
a6e4d5a0
MF		 604
605static inline efi_status_t efi_query_variable_store(u32 attributes, unsigned long size)
606{
607 return EFI_SUCCESS;
608}
78510792 609#endif
7bc90e01 610extern void __iomem *efi_lookup_mapped_addr(u64 phys_addr);
272686bf 611extern int efi_config_init(efi_config_table_type_t *arch_tables);
1da177e4
LT		 612extern u64 efi_get_iobase (void);
613extern u32 efi_mem_type (unsigned long phys_addr);
614extern u64 efi_mem_attributes (unsigned long phys_addr);
32e62c63 615extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
1da177e4
LT		 616extern int __init efi_uart_console_only (void);
617extern void efi_initialize_iomem_resources(struct resource *code_resource,
00bf4098 618 struct resource *data_resource, struct resource *bss_resource);
3565184e
DV		 619extern void efi_get_time(struct timespec *now);
620extern int efi_set_rtc_mmss(const struct timespec *now);
916f676f 621extern void efi_reserve_boot_services(void);
1da177e4
LT		 622extern struct efi_memory_map memmap;
623
624/**
625 * efi_range_is_wc - check the WC bit on an address range
626 * @start: starting kvirt address
627 * @len: length of range
628 *
629 * Consult the EFI memory map and make sure it's ok to set this range WC.
630 * Returns true or false.
631 */
632static inline int efi_range_is_wc(unsigned long start, unsigned long len)
633{
986a80d5 634 unsigned long i;
1da177e4
LT		 635
636 for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
637 unsigned long paddr = __pa(start + i);
638 if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
639 return 0;
640 }
641 /* The range checked out */
642 return 1;
643}
644
645#ifdef CONFIG_EFI_PCDP
646extern int __init efi_setup_pcdp_console(char *);
647#endif
648
649/*
83e68189
MF		 650 * We play games with efi_enabled so that the compiler will, if
651 * possible, remove EFI-related code altogether.
1da177e4 652 */
83e68189
MF		 653#define EFI_BOOT 0 /* Were we booted from EFI? */
654#define EFI_SYSTEM_TABLES 1 /* Can we use EFI system tables? */
655#define EFI_CONFIG_TABLES 2 /* Can we use EFI config tables? */
656#define EFI_RUNTIME_SERVICES 3 /* Can we use runtime services? */
657#define EFI_MEMMAP 4 /* Can we use EFI memory map? */
658#define EFI_64BIT 5 /* Is the firmware 64-bit? */
d2f7cbe7 659#define EFI_ARCH_1 6 /* First arch-specific bit */
83e68189 660
1da177e4
LT		 661#ifdef CONFIG_EFI
662# ifdef CONFIG_X86
83e68189 663extern int efi_enabled(int facility);
1da177e4 664# else
83e68189
MF		 665static inline int efi_enabled(int facility)
666{
667 return 1;
668}
1da177e4
LT		 669# endif
670#else
83e68189
MF		 671static inline int efi_enabled(int facility)
672{
673 return 0;
674}
1da177e4
LT		 675#endif
676
677/*
678 * Variable Attributes
679 */
680#define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
681#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
682#define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
41b3254c
MG		 683#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x0000000000000008
684#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x0000000000000010
685#define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x0000000000000020
686#define EFI_VARIABLE_APPEND_WRITE 0x0000000000000040
687
688#define EFI_VARIABLE_MASK (EFI_VARIABLE_NON_VOLATILE | \
689 EFI_VARIABLE_BOOTSERVICE_ACCESS | \
690 EFI_VARIABLE_RUNTIME_ACCESS | \
691 EFI_VARIABLE_HARDWARE_ERROR_RECORD | \
692 EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS | \
693 EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | \
694 EFI_VARIABLE_APPEND_WRITE)
e14ab23d
MF		 695/*
696 * Length of a GUID string (strlen("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"))
697 * not including trailing NUL
698 */
699#define EFI_VARIABLE_GUID_LEN 36
700
e2527a7c
MF		 701/*
702 * The type of search to perform when calling boottime->locate_handle
703 */
704#define EFI_LOCATE_ALL_HANDLES 0
705#define EFI_LOCATE_BY_REGISTER_NOTIFY 1
706#define EFI_LOCATE_BY_PROTOCOL 2
707
1da177e4
LT		 708/*
709 * EFI Device Path information
710 */
711#define EFI_DEV_HW 0x01
712#define EFI_DEV_PCI 1
713#define EFI_DEV_PCCARD 2
714#define EFI_DEV_MEM_MAPPED 3
715#define EFI_DEV_VENDOR 4
716#define EFI_DEV_CONTROLLER 5
717#define EFI_DEV_ACPI 0x02
718#define EFI_DEV_BASIC_ACPI 1
719#define EFI_DEV_EXPANDED_ACPI 2
720#define EFI_DEV_MSG 0x03
721#define EFI_DEV_MSG_ATAPI 1
722#define EFI_DEV_MSG_SCSI 2
723#define EFI_DEV_MSG_FC 3
724#define EFI_DEV_MSG_1394 4
725#define EFI_DEV_MSG_USB 5
726#define EFI_DEV_MSG_USB_CLASS 15
727#define EFI_DEV_MSG_I20 6
728#define EFI_DEV_MSG_MAC 11
729#define EFI_DEV_MSG_IPV4 12
730#define EFI_DEV_MSG_IPV6 13
731#define EFI_DEV_MSG_INFINIBAND 9
732#define EFI_DEV_MSG_UART 14
733#define EFI_DEV_MSG_VENDOR 10
734#define EFI_DEV_MEDIA 0x04
735#define EFI_DEV_MEDIA_HARD_DRIVE 1
736#define EFI_DEV_MEDIA_CDROM 2
737#define EFI_DEV_MEDIA_VENDOR 3
738#define EFI_DEV_MEDIA_FILE 4
739#define EFI_DEV_MEDIA_PROTOCOL 5
740#define EFI_DEV_BIOS_BOOT 0x05
741#define EFI_DEV_END_PATH 0x7F
742#define EFI_DEV_END_PATH2 0xFF
743#define EFI_DEV_END_INSTANCE 0x01
744#define EFI_DEV_END_ENTIRE 0xFF
745
746struct efi_generic_dev_path {
747 u8 type;
748 u8 sub_type;
749 u16 length;
750} __attribute ((packed));
751
4a3575fd
HY		 752static inline void memrange_efi_to_native(u64 *addr, u64 *npages)
753{
754 *npages = PFN_UP(*addr + (*npages<<EFI_PAGE_SHIFT)) - PFN_DOWN(*addr);
755 *addr &= PAGE_MASK;
756}
757
4fc756bd
MW		 758/*
759 * EFI Variable support.
760 *
761 * Different firmware drivers can expose their EFI-like variables using
762 * the following.
763 */
764
765struct efivar_operations {
766 efi_get_variable_t *get_variable;
767 efi_get_next_variable_t *get_next_variable;
768 efi_set_variable_t *set_variable;
a6e4d5a0 769 efi_query_variable_store_t *query_variable_store;
4fc756bd
MW		 770};
771
772struct efivars {
773 /*
774 * ->lock protects two things:
775 * 1) ->list - adds, removals, reads, writes
776 * 2) ops.[gs]et_variable() calls.
777 * It must not be held when creating sysfs entries or calling kmalloc.
a93bc0c6
SA		 778 * ops.get_next_variable() is only called from register_efivars()
779 * or efivar_update_sysfs_entries(),
4fc756bd
MW		 780 * which is protected by the BKL, so that path is safe.
781 */
782 spinlock_t lock;
4fc756bd 783 struct kset *kset;
605e70c7 784 struct kobject *kobject;
4fc756bd
MW		 785 const struct efivar_operations *ops;
786};
787
e14ab23d
MF		 788/*
789 * The maximum size of VariableName + Data = 1024
790 * Therefore, it's reasonable to save that much
791 * space in each part of the structure,
792 * and we use a page for reading/writing.
793 */
794
795struct efi_variable {
796 efi_char16_t VariableName[1024/sizeof(efi_char16_t)];
797 efi_guid_t VendorGuid;
798 unsigned long DataSize;
799 __u8 Data[1024];
800 efi_status_t Status;
801 __u32 Attributes;
802} __attribute__((packed));
803
804struct efivar_entry {
805 struct efi_variable var;
806 struct list_head list;
807 struct kobject kobj;
808};
809
ed37ddff
RF		 810
811struct efi_simple_text_output_protocol {
812 void *reset;
813 efi_status_t (*output_string)(void *, void *);
814 void *test_string;
815};
816
04851772
MF		 817extern struct list_head efivar_sysfs_list;
818
819static inline void
820efivar_unregister(struct efivar_entry *var)
821{
822 kobject_put(&var->kobj);
823}
824
e14ab23d 825int efivars_register(struct efivars *efivars,
4fc756bd 826 const struct efivar_operations *ops,
e14ab23d
MF		 827 struct kobject *kobject);
828int efivars_unregister(struct efivars *efivars);
829struct kobject *efivars_kobject(void);
830
831int efivar_init(int (*func)(efi_char16_t *, efi_guid_t, unsigned long, void *),
832 void *data, bool atomic, bool duplicates,
833 struct list_head *head);
834
835void efivar_entry_add(struct efivar_entry *entry, struct list_head *head);
836void efivar_entry_remove(struct efivar_entry *entry);
837
838int __efivar_entry_delete(struct efivar_entry *entry);
839int efivar_entry_delete(struct efivar_entry *entry);
840
e14ab23d 841int efivar_entry_size(struct efivar_entry *entry, unsigned long *size);
8a415b8c
MF		 842int __efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
843 unsigned long *size, void *data);
e14ab23d
MF		 844int efivar_entry_get(struct efivar_entry *entry, u32 *attributes,
845 unsigned long *size, void *data);
846int efivar_entry_set(struct efivar_entry *entry, u32 attributes,
847 unsigned long size, void *data, struct list_head *head);
848int efivar_entry_set_get_size(struct efivar_entry *entry, u32 attributes,
849 unsigned long *size, void *data, bool *set);
850int efivar_entry_set_safe(efi_char16_t *name, efi_guid_t vendor, u32 attributes,
851 bool block, unsigned long size, void *data);
852
853void efivar_entry_iter_begin(void);
854void efivar_entry_iter_end(void);
855
856int __efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
857 struct list_head *head, void *data,
858 struct efivar_entry **prev);
859int efivar_entry_iter(int (*func)(struct efivar_entry *, void *),
860 struct list_head *head, void *data);
861
862struct efivar_entry *efivar_entry_find(efi_char16_t *name, efi_guid_t guid,
863 struct list_head *head, bool remove);
864
865bool efivar_validate(struct efi_variable *var, u8 *data, unsigned long len);
866
a9499fa7 867extern struct work_struct efivar_work;
04851772
MF		 868void efivar_run_worker(void);
869
a9499fa7 870#if defined(CONFIG_EFI_VARS) || defined(CONFIG_EFI_VARS_MODULE)
e14ab23d 871int efivars_sysfs_init(void);
4fc756bd
MW		 872
873#endif /* CONFIG_EFI_VARS */
874
1da177e4 875#endif /* _LINUX_EFI_H */
ubuntu-bionic-kernel mirror