efi.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. #ifndef _LINUX_EFI_H
  2. #define _LINUX_EFI_H
  3. /*
  4. * Extensible Firmware Interface
  5. * Based on 'Extensible Firmware Interface Specification' version 0.9, April 30, 1999
  6. *
  7. * Copyright (C) 1999 VA Linux Systems
  8. * Copyright (C) 1999 Walt Drummond <drummond@valinux.com>
  9. * Copyright (C) 1999, 2002-2003 Hewlett-Packard Co.
  10. * David Mosberger-Tang <davidm@hpl.hp.com>
  11. * Stephane Eranian <eranian@hpl.hp.com>
  12. */
  13. #include <linux/init.h>
  14. #include <linux/string.h>
  15. #include <linux/time.h>
  16. #include <linux/types.h>
  17. #include <linux/proc_fs.h>
  18. #include <linux/rtc.h>
  19. #include <linux/ioport.h>
  20. #include <asm/page.h>
  21. #include <asm/system.h>
  22. #define EFI_SUCCESS 0
  23. #define EFI_LOAD_ERROR ( 1 | (1UL << (BITS_PER_LONG-1)))
  24. #define EFI_INVALID_PARAMETER ( 2 | (1UL << (BITS_PER_LONG-1)))
  25. #define EFI_UNSUPPORTED ( 3 | (1UL << (BITS_PER_LONG-1)))
  26. #define EFI_BAD_BUFFER_SIZE ( 4 | (1UL << (BITS_PER_LONG-1)))
  27. #define EFI_BUFFER_TOO_SMALL ( 5 | (1UL << (BITS_PER_LONG-1)))
  28. #define EFI_NOT_FOUND (14 | (1UL << (BITS_PER_LONG-1)))
  29. typedef unsigned long efi_status_t;
  30. typedef u8 efi_bool_t;
  31. typedef u16 efi_char16_t; /* UNICODE character */
  32. typedef struct {
  33. u8 b[16];
  34. } efi_guid_t;
  35. #define EFI_GUID(a,b,c,d0,d1,d2,d3,d4,d5,d6,d7) \
  36. ((efi_guid_t) \
  37. {{ (a) & 0xff, ((a) >> 8) & 0xff, ((a) >> 16) & 0xff, ((a) >> 24) & 0xff, \
  38. (b) & 0xff, ((b) >> 8) & 0xff, \
  39. (c) & 0xff, ((c) >> 8) & 0xff, \
  40. (d0), (d1), (d2), (d3), (d4), (d5), (d6), (d7) }})
  41. /*
  42. * Generic EFI table header
  43. */
  44. typedef struct {
  45. u64 signature;
  46. u32 revision;
  47. u32 headersize;
  48. u32 crc32;
  49. u32 reserved;
  50. } efi_table_hdr_t;
  51. /*
  52. * Memory map descriptor:
  53. */
  54. /* Memory types: */
  55. #define EFI_RESERVED_TYPE 0
  56. #define EFI_LOADER_CODE 1
  57. #define EFI_LOADER_DATA 2
  58. #define EFI_BOOT_SERVICES_CODE 3
  59. #define EFI_BOOT_SERVICES_DATA 4
  60. #define EFI_RUNTIME_SERVICES_CODE 5
  61. #define EFI_RUNTIME_SERVICES_DATA 6
  62. #define EFI_CONVENTIONAL_MEMORY 7
  63. #define EFI_UNUSABLE_MEMORY 8
  64. #define EFI_ACPI_RECLAIM_MEMORY 9
  65. #define EFI_ACPI_MEMORY_NVS 10
  66. #define EFI_MEMORY_MAPPED_IO 11
  67. #define EFI_MEMORY_MAPPED_IO_PORT_SPACE 12
  68. #define EFI_PAL_CODE 13
  69. #define EFI_MAX_MEMORY_TYPE 14
  70. /* Attribute values: */
  71. #define EFI_MEMORY_UC ((u64)0x0000000000000001ULL) /* uncached */
  72. #define EFI_MEMORY_WC ((u64)0x0000000000000002ULL) /* write-coalescing */
  73. #define EFI_MEMORY_WT ((u64)0x0000000000000004ULL) /* write-through */
  74. #define EFI_MEMORY_WB ((u64)0x0000000000000008ULL) /* write-back */
  75. #define EFI_MEMORY_WP ((u64)0x0000000000001000ULL) /* write-protect */
  76. #define EFI_MEMORY_RP ((u64)0x0000000000002000ULL) /* read-protect */
  77. #define EFI_MEMORY_XP ((u64)0x0000000000004000ULL) /* execute-protect */
  78. #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */
  79. #define EFI_MEMORY_DESCRIPTOR_VERSION 1
  80. #define EFI_PAGE_SHIFT 12
  81. typedef struct {
  82. u32 type;
  83. u32 pad;
  84. u64 phys_addr;
  85. u64 virt_addr;
  86. u64 num_pages;
  87. u64 attribute;
  88. } efi_memory_desc_t;
  89. typedef int (*efi_freemem_callback_t) (unsigned long start, unsigned long end, void *arg);
  90. /*
  91. * Types and defines for Time Services
  92. */
  93. #define EFI_TIME_ADJUST_DAYLIGHT 0x1
  94. #define EFI_TIME_IN_DAYLIGHT 0x2
  95. #define EFI_UNSPECIFIED_TIMEZONE 0x07ff
  96. typedef struct {
  97. u16 year;
  98. u8 month;
  99. u8 day;
  100. u8 hour;
  101. u8 minute;
  102. u8 second;
  103. u8 pad1;
  104. u32 nanosecond;
  105. s16 timezone;
  106. u8 daylight;
  107. u8 pad2;
  108. } efi_time_t;
  109. typedef struct {
  110. u32 resolution;
  111. u32 accuracy;
  112. u8 sets_to_zero;
  113. } efi_time_cap_t;
  114. /*
  115. * Types and defines for EFI ResetSystem
  116. */
  117. #define EFI_RESET_COLD 0
  118. #define EFI_RESET_WARM 1
  119. #define EFI_RESET_SHUTDOWN 2
  120. /*
  121. * EFI Runtime Services table
  122. */
  123. #define EFI_RUNTIME_SERVICES_SIGNATURE ((u64)0x5652453544e5552ULL)
  124. #define EFI_RUNTIME_SERVICES_REVISION 0x00010000
  125. typedef struct {
  126. efi_table_hdr_t hdr;
  127. unsigned long get_time;
  128. unsigned long set_time;
  129. unsigned long get_wakeup_time;
  130. unsigned long set_wakeup_time;
  131. unsigned long set_virtual_address_map;
  132. unsigned long convert_pointer;
  133. unsigned long get_variable;
  134. unsigned long get_next_variable;
  135. unsigned long set_variable;
  136. unsigned long get_next_high_mono_count;
  137. unsigned long reset_system;
  138. } efi_runtime_services_t;
  139. typedef efi_status_t efi_get_time_t (efi_time_t *tm, efi_time_cap_t *tc);
  140. typedef efi_status_t efi_set_time_t (efi_time_t *tm);
  141. typedef efi_status_t efi_get_wakeup_time_t (efi_bool_t *enabled, efi_bool_t *pending,
  142. efi_time_t *tm);
  143. typedef efi_status_t efi_set_wakeup_time_t (efi_bool_t enabled, efi_time_t *tm);
  144. typedef efi_status_t efi_get_variable_t (efi_char16_t *name, efi_guid_t *vendor, u32 *attr,
  145. unsigned long *data_size, void *data);
  146. typedef efi_status_t efi_get_next_variable_t (unsigned long *name_size, efi_char16_t *name,
  147. efi_guid_t *vendor);
  148. typedef efi_status_t efi_set_variable_t (efi_char16_t *name, efi_guid_t *vendor,
  149. unsigned long attr, unsigned long data_size,
  150. void *data);
  151. typedef efi_status_t efi_get_next_high_mono_count_t (u32 *count);
  152. typedef void efi_reset_system_t (int reset_type, efi_status_t status,
  153. unsigned long data_size, efi_char16_t *data);
  154. typedef efi_status_t efi_set_virtual_address_map_t (unsigned long memory_map_size,
  155. unsigned long descriptor_size,
  156. u32 descriptor_version,
  157. efi_memory_desc_t *virtual_map);
  158. /*
  159. * EFI Configuration Table and GUID definitions
  160. */
  161. #define NULL_GUID \
  162. EFI_GUID( 0x00000000, 0x0000, 0x0000, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 )
  163. #define MPS_TABLE_GUID \
  164. EFI_GUID( 0xeb9d2d2f, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
  165. #define ACPI_TABLE_GUID \
  166. EFI_GUID( 0xeb9d2d30, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
  167. #define ACPI_20_TABLE_GUID \
  168. EFI_GUID( 0x8868e871, 0xe4f1, 0x11d3, 0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 )
  169. #define SMBIOS_TABLE_GUID \
  170. EFI_GUID( 0xeb9d2d31, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
  171. #define SAL_SYSTEM_TABLE_GUID \
  172. EFI_GUID( 0xeb9d2d32, 0x2d88, 0x11d3, 0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d )
  173. #define HCDP_TABLE_GUID \
  174. EFI_GUID( 0xf951938d, 0x620b, 0x42ef, 0x82, 0x79, 0xa8, 0x4b, 0x79, 0x61, 0x78, 0x98 )
  175. #define UGA_IO_PROTOCOL_GUID \
  176. EFI_GUID( 0x61a4d49e, 0x6f68, 0x4f1b, 0xb9, 0x22, 0xa8, 0x6e, 0xed, 0xb, 0x7, 0xa2 )
  177. #define EFI_GLOBAL_VARIABLE_GUID \
  178. EFI_GUID( 0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c )
  179. typedef struct {
  180. efi_guid_t guid;
  181. unsigned long table;
  182. } efi_config_table_t;
  183. #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
  184. #define EFI_SYSTEM_TABLE_REVISION ((1 << 16) | 00)
  185. typedef struct {
  186. efi_table_hdr_t hdr;
  187. unsigned long fw_vendor; /* physical addr of CHAR16 vendor string */
  188. u32 fw_revision;
  189. unsigned long con_in_handle;
  190. unsigned long con_in;
  191. unsigned long con_out_handle;
  192. unsigned long con_out;
  193. unsigned long stderr_handle;
  194. unsigned long stderr;
  195. efi_runtime_services_t *runtime;
  196. unsigned long boottime;
  197. unsigned long nr_tables;
  198. unsigned long tables;
  199. } efi_system_table_t;
  200. struct efi_memory_map {
  201. void *phys_map;
  202. void *map;
  203. void *map_end;
  204. int nr_map;
  205. unsigned long desc_version;
  206. unsigned long desc_size;
  207. };
  208. #define EFI_INVALID_TABLE_ADDR (~0UL)
  209. /*
  210. * All runtime access to EFI goes through this structure:
  211. */
  212. extern struct efi {
  213. efi_system_table_t *systab; /* EFI system table */
  214. unsigned long mps; /* MPS table */
  215. unsigned long acpi; /* ACPI table (IA64 ext 0.71) */
  216. unsigned long acpi20; /* ACPI table (ACPI 2.0) */
  217. unsigned long smbios; /* SM BIOS table */
  218. unsigned long sal_systab; /* SAL system table */
  219. unsigned long boot_info; /* boot info table */
  220. unsigned long hcdp; /* HCDP table */
  221. unsigned long uga; /* UGA table */
  222. efi_get_time_t *get_time;
  223. efi_set_time_t *set_time;
  224. efi_get_wakeup_time_t *get_wakeup_time;
  225. efi_set_wakeup_time_t *set_wakeup_time;
  226. efi_get_variable_t *get_variable;
  227. efi_get_next_variable_t *get_next_variable;
  228. efi_set_variable_t *set_variable;
  229. efi_get_next_high_mono_count_t *get_next_high_mono_count;
  230. efi_reset_system_t *reset_system;
  231. efi_set_virtual_address_map_t *set_virtual_address_map;
  232. } efi;
  233. static inline int
  234. efi_guidcmp (efi_guid_t left, efi_guid_t right)
  235. {
  236. return memcmp(&left, &right, sizeof (efi_guid_t));
  237. }
  238. static inline char *
  239. efi_guid_unparse(efi_guid_t *guid, char *out)
  240. {
  241. sprintf(out, "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-%02x%02x%02x%02x%02x%02x",
  242. guid->b[3], guid->b[2], guid->b[1], guid->b[0],
  243. guid->b[5], guid->b[4], guid->b[7], guid->b[6],
  244. guid->b[8], guid->b[9], guid->b[10], guid->b[11],
  245. guid->b[12], guid->b[13], guid->b[14], guid->b[15]);
  246. return out;
  247. }
  248. extern void efi_init (void);
  249. extern void *efi_get_pal_addr (void);
  250. extern void efi_map_pal_code (void);
  251. extern void efi_map_memmap(void);
  252. extern void efi_memmap_walk (efi_freemem_callback_t callback, void *arg);
  253. extern void efi_gettimeofday (struct timespec *ts);
  254. extern void efi_enter_virtual_mode (void); /* switch EFI to virtual mode, if possible */
  255. extern u64 efi_get_iobase (void);
  256. extern u32 efi_mem_type (unsigned long phys_addr);
  257. extern u64 efi_mem_attributes (unsigned long phys_addr);
  258. extern u64 efi_mem_attribute (unsigned long phys_addr, unsigned long size);
  259. extern int efi_mem_attribute_range (unsigned long phys_addr, unsigned long size,
  260. u64 attr);
  261. extern int __init efi_uart_console_only (void);
  262. extern void efi_initialize_iomem_resources(struct resource *code_resource,
  263. struct resource *data_resource);
  264. extern unsigned long efi_get_time(void);
  265. extern int efi_set_rtc_mmss(unsigned long nowtime);
  266. extern int is_available_memory(efi_memory_desc_t * md);
  267. extern struct efi_memory_map memmap;
  268. /**
  269. * efi_range_is_wc - check the WC bit on an address range
  270. * @start: starting kvirt address
  271. * @len: length of range
  272. *
  273. * Consult the EFI memory map and make sure it's ok to set this range WC.
  274. * Returns true or false.
  275. */
  276. static inline int efi_range_is_wc(unsigned long start, unsigned long len)
  277. {
  278. unsigned long i;
  279. for (i = 0; i < len; i += (1UL << EFI_PAGE_SHIFT)) {
  280. unsigned long paddr = __pa(start + i);
  281. if (!(efi_mem_attributes(paddr) & EFI_MEMORY_WC))
  282. return 0;
  283. }
  284. /* The range checked out */
  285. return 1;
  286. }
  287. #ifdef CONFIG_EFI_PCDP
  288. extern int __init efi_setup_pcdp_console(char *);
  289. #endif
  290. /*
  291. * We play games with efi_enabled so that the compiler will, if possible, remove
  292. * EFI-related code altogether.
  293. */
  294. #ifdef CONFIG_EFI
  295. # ifdef CONFIG_X86
  296. extern int efi_enabled;
  297. # else
  298. # define efi_enabled 1
  299. # endif
  300. #else
  301. # define efi_enabled 0
  302. #endif
  303. /*
  304. * Variable Attributes
  305. */
  306. #define EFI_VARIABLE_NON_VOLATILE 0x0000000000000001
  307. #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x0000000000000002
  308. #define EFI_VARIABLE_RUNTIME_ACCESS 0x0000000000000004
  309. /*
  310. * EFI Device Path information
  311. */
  312. #define EFI_DEV_HW 0x01
  313. #define EFI_DEV_PCI 1
  314. #define EFI_DEV_PCCARD 2
  315. #define EFI_DEV_MEM_MAPPED 3
  316. #define EFI_DEV_VENDOR 4
  317. #define EFI_DEV_CONTROLLER 5
  318. #define EFI_DEV_ACPI 0x02
  319. #define EFI_DEV_BASIC_ACPI 1
  320. #define EFI_DEV_EXPANDED_ACPI 2
  321. #define EFI_DEV_MSG 0x03
  322. #define EFI_DEV_MSG_ATAPI 1
  323. #define EFI_DEV_MSG_SCSI 2
  324. #define EFI_DEV_MSG_FC 3
  325. #define EFI_DEV_MSG_1394 4
  326. #define EFI_DEV_MSG_USB 5
  327. #define EFI_DEV_MSG_USB_CLASS 15
  328. #define EFI_DEV_MSG_I20 6
  329. #define EFI_DEV_MSG_MAC 11
  330. #define EFI_DEV_MSG_IPV4 12
  331. #define EFI_DEV_MSG_IPV6 13
  332. #define EFI_DEV_MSG_INFINIBAND 9
  333. #define EFI_DEV_MSG_UART 14
  334. #define EFI_DEV_MSG_VENDOR 10
  335. #define EFI_DEV_MEDIA 0x04
  336. #define EFI_DEV_MEDIA_HARD_DRIVE 1
  337. #define EFI_DEV_MEDIA_CDROM 2
  338. #define EFI_DEV_MEDIA_VENDOR 3
  339. #define EFI_DEV_MEDIA_FILE 4
  340. #define EFI_DEV_MEDIA_PROTOCOL 5
  341. #define EFI_DEV_BIOS_BOOT 0x05
  342. #define EFI_DEV_END_PATH 0x7F
  343. #define EFI_DEV_END_PATH2 0xFF
  344. #define EFI_DEV_END_INSTANCE 0x01
  345. #define EFI_DEV_END_ENTIRE 0xFF
  346. struct efi_generic_dev_path {
  347. u8 type;
  348. u8 sub_type;
  349. u16 length;
  350. } __attribute ((packed));
  351. #endif /* _LINUX_EFI_H */