efi_api.h 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * Extensible Firmware Interface
  4. * Based on 'Extensible Firmware Interface Specification' version 0.9,
  5. * 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. * From include/linux/efi.h in kernel 4.1 with some additions/subtractions
  14. */
  15. #ifndef _EFI_API_H
  16. #define _EFI_API_H
  17. #include <efi.h>
  18. #include <charset.h>
  19. #include <pe.h>
  20. #ifdef CONFIG_EFI_LOADER
  21. #include <asm/setjmp.h>
  22. #endif
  23. /* UEFI spec version 2.8 */
  24. #define EFI_SPECIFICATION_VERSION (2 << 16 | 80)
  25. /* Types and defines for EFI CreateEvent */
  26. enum efi_timer_delay {
  27. EFI_TIMER_STOP = 0,
  28. EFI_TIMER_PERIODIC = 1,
  29. EFI_TIMER_RELATIVE = 2
  30. };
  31. #define efi_intn_t ssize_t
  32. #define efi_uintn_t size_t
  33. typedef void *efi_hii_handle_t;
  34. typedef u16 *efi_string_t;
  35. typedef u16 efi_string_id_t;
  36. typedef u32 efi_hii_font_style_t;
  37. typedef u16 efi_question_id_t;
  38. typedef u16 efi_image_id_t;
  39. typedef u16 efi_form_id_t;
  40. #define EVT_TIMER 0x80000000
  41. #define EVT_RUNTIME 0x40000000
  42. #define EVT_NOTIFY_WAIT 0x00000100
  43. #define EVT_NOTIFY_SIGNAL 0x00000200
  44. #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
  45. #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
  46. #define TPL_APPLICATION 0x04
  47. #define TPL_CALLBACK 0x08
  48. #define TPL_NOTIFY 0x10
  49. #define TPL_HIGH_LEVEL 0x1F
  50. struct efi_event;
  51. /* OsIndicationsSupported flags */
  52. #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001
  53. #define EFI_OS_INDICATIONS_TIMESTAMP_REVOCATION 0x0000000000000002
  54. #define EFI_OS_INDICATIONS_FILE_CAPSULE_DELIVERY_SUPPORTED 0x0000000000000004
  55. #define EFI_OS_INDICATIONS_FMP_CAPSULE_SUPPORTED 0x0000000000000008
  56. #define EFI_OS_INDICATIONS_CAPSULE_RESULT_VAR_SUPPORTED 0x0000000000000010
  57. #define EFI_OS_INDICATIONS_START_OS_RECOVERY 0x0000000000000020
  58. #define EFI_OS_INDICATIONS_START_PLATFORM_RECOVERY 0x0000000000000040
  59. #define EFI_OS_INDICATIONS_JSON_CONFIG_DATA_REFRESH 0x0000000000000080
  60. /* EFI Boot Services table */
  61. #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
  62. struct efi_boot_services {
  63. struct efi_table_hdr hdr;
  64. efi_status_t (EFIAPI *raise_tpl)(efi_uintn_t new_tpl);
  65. void (EFIAPI *restore_tpl)(efi_uintn_t old_tpl);
  66. efi_status_t (EFIAPI *allocate_pages)(int, int, efi_uintn_t,
  67. efi_physical_addr_t *);
  68. efi_status_t (EFIAPI *free_pages)(efi_physical_addr_t, efi_uintn_t);
  69. efi_status_t (EFIAPI *get_memory_map)(efi_uintn_t *memory_map_size,
  70. struct efi_mem_desc *desc,
  71. efi_uintn_t *key,
  72. efi_uintn_t *desc_size,
  73. u32 *desc_version);
  74. efi_status_t (EFIAPI *allocate_pool)(int, efi_uintn_t, void **);
  75. efi_status_t (EFIAPI *free_pool)(void *);
  76. efi_status_t (EFIAPI *create_event)(uint32_t type,
  77. efi_uintn_t notify_tpl,
  78. void (EFIAPI *notify_function) (
  79. struct efi_event *event,
  80. void *context),
  81. void *notify_context, struct efi_event **event);
  82. efi_status_t (EFIAPI *set_timer)(struct efi_event *event,
  83. enum efi_timer_delay type,
  84. uint64_t trigger_time);
  85. efi_status_t (EFIAPI *wait_for_event)(efi_uintn_t number_of_events,
  86. struct efi_event **event,
  87. efi_uintn_t *index);
  88. efi_status_t (EFIAPI *signal_event)(struct efi_event *event);
  89. efi_status_t (EFIAPI *close_event)(struct efi_event *event);
  90. efi_status_t (EFIAPI *check_event)(struct efi_event *event);
  91. #define EFI_NATIVE_INTERFACE 0x00000000
  92. efi_status_t (EFIAPI *install_protocol_interface)(
  93. efi_handle_t *handle, const efi_guid_t *protocol,
  94. int protocol_interface_type, void *protocol_interface);
  95. efi_status_t (EFIAPI *reinstall_protocol_interface)(
  96. efi_handle_t handle, const efi_guid_t *protocol,
  97. void *old_interface, void *new_interface);
  98. efi_status_t (EFIAPI *uninstall_protocol_interface)(
  99. efi_handle_t handle, const efi_guid_t *protocol,
  100. void *protocol_interface);
  101. efi_status_t (EFIAPI *handle_protocol)(
  102. efi_handle_t handle, const efi_guid_t *protocol,
  103. void **protocol_interface);
  104. void *reserved;
  105. efi_status_t (EFIAPI *register_protocol_notify)(
  106. const efi_guid_t *protocol, struct efi_event *event,
  107. void **registration);
  108. efi_status_t (EFIAPI *locate_handle)(
  109. enum efi_locate_search_type search_type,
  110. const efi_guid_t *protocol, void *search_key,
  111. efi_uintn_t *buffer_size, efi_handle_t *buffer);
  112. efi_status_t (EFIAPI *locate_device_path)(const efi_guid_t *protocol,
  113. struct efi_device_path **device_path,
  114. efi_handle_t *device);
  115. efi_status_t (EFIAPI *install_configuration_table)(
  116. efi_guid_t *guid, void *table);
  117. efi_status_t (EFIAPI *load_image)(bool boot_policiy,
  118. efi_handle_t parent_image,
  119. struct efi_device_path *file_path, void *source_buffer,
  120. efi_uintn_t source_size, efi_handle_t *image);
  121. efi_status_t (EFIAPI *start_image)(efi_handle_t handle,
  122. efi_uintn_t *exitdata_size,
  123. u16 **exitdata);
  124. efi_status_t (EFIAPI *exit)(efi_handle_t handle,
  125. efi_status_t exit_status,
  126. efi_uintn_t exitdata_size, u16 *exitdata);
  127. efi_status_t (EFIAPI *unload_image)(efi_handle_t image_handle);
  128. efi_status_t (EFIAPI *exit_boot_services)(efi_handle_t image_handle,
  129. efi_uintn_t map_key);
  130. efi_status_t (EFIAPI *get_next_monotonic_count)(u64 *count);
  131. efi_status_t (EFIAPI *stall)(unsigned long usecs);
  132. efi_status_t (EFIAPI *set_watchdog_timer)(unsigned long timeout,
  133. uint64_t watchdog_code, unsigned long data_size,
  134. uint16_t *watchdog_data);
  135. efi_status_t(EFIAPI *connect_controller)(efi_handle_t controller_handle,
  136. efi_handle_t *driver_image_handle,
  137. struct efi_device_path *remaining_device_path,
  138. bool recursive);
  139. efi_status_t (EFIAPI *disconnect_controller)(
  140. efi_handle_t controller_handle,
  141. efi_handle_t driver_image_handle,
  142. efi_handle_t child_handle);
  143. #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
  144. #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
  145. #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
  146. #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
  147. #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
  148. #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
  149. efi_status_t (EFIAPI *open_protocol)(efi_handle_t handle,
  150. const efi_guid_t *protocol, void **interface,
  151. efi_handle_t agent_handle,
  152. efi_handle_t controller_handle, u32 attributes);
  153. efi_status_t (EFIAPI *close_protocol)(
  154. efi_handle_t handle, const efi_guid_t *protocol,
  155. efi_handle_t agent_handle,
  156. efi_handle_t controller_handle);
  157. efi_status_t(EFIAPI *open_protocol_information)(efi_handle_t handle,
  158. const efi_guid_t *protocol,
  159. struct efi_open_protocol_info_entry **entry_buffer,
  160. efi_uintn_t *entry_count);
  161. efi_status_t (EFIAPI *protocols_per_handle)(efi_handle_t handle,
  162. efi_guid_t ***protocol_buffer,
  163. efi_uintn_t *protocols_buffer_count);
  164. efi_status_t (EFIAPI *locate_handle_buffer) (
  165. enum efi_locate_search_type search_type,
  166. const efi_guid_t *protocol, void *search_key,
  167. efi_uintn_t *no_handles, efi_handle_t **buffer);
  168. efi_status_t (EFIAPI *locate_protocol)(const efi_guid_t *protocol,
  169. void *registration, void **protocol_interface);
  170. efi_status_t (EFIAPI *install_multiple_protocol_interfaces)(
  171. efi_handle_t *handle, ...);
  172. efi_status_t (EFIAPI *uninstall_multiple_protocol_interfaces)(
  173. efi_handle_t handle, ...);
  174. efi_status_t (EFIAPI *calculate_crc32)(const void *data,
  175. efi_uintn_t data_size,
  176. u32 *crc32);
  177. void (EFIAPI *copy_mem)(void *destination, const void *source,
  178. size_t length);
  179. void (EFIAPI *set_mem)(void *buffer, size_t size, uint8_t value);
  180. efi_status_t (EFIAPI *create_event_ex)(
  181. uint32_t type, efi_uintn_t notify_tpl,
  182. void (EFIAPI *notify_function) (
  183. struct efi_event *event,
  184. void *context),
  185. void *notify_context,
  186. efi_guid_t *event_group,
  187. struct efi_event **event);
  188. };
  189. /* Types and defines for EFI ResetSystem */
  190. enum efi_reset_type {
  191. EFI_RESET_COLD = 0,
  192. EFI_RESET_WARM = 1,
  193. EFI_RESET_SHUTDOWN = 2,
  194. EFI_RESET_PLATFORM_SPECIFIC = 3,
  195. };
  196. /* EFI Runtime Services table */
  197. #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
  198. #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
  199. #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
  200. #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
  201. struct efi_capsule_header {
  202. efi_guid_t capsule_guid;
  203. u32 header_size;
  204. u32 flags;
  205. u32 capsule_image_size;
  206. } __packed;
  207. #define EFI_RT_SUPPORTED_GET_TIME 0x0001
  208. #define EFI_RT_SUPPORTED_SET_TIME 0x0002
  209. #define EFI_RT_SUPPORTED_GET_WAKEUP_TIME 0x0004
  210. #define EFI_RT_SUPPORTED_SET_WAKEUP_TIME 0x0008
  211. #define EFI_RT_SUPPORTED_GET_VARIABLE 0x0010
  212. #define EFI_RT_SUPPORTED_GET_NEXT_VARIABLE_NAME 0x0020
  213. #define EFI_RT_SUPPORTED_SET_VARIABLE 0x0040
  214. #define EFI_RT_SUPPORTED_SET_VIRTUAL_ADDRESS_MAP 0x0080
  215. #define EFI_RT_SUPPORTED_CONVERT_POINTER 0x0100
  216. #define EFI_RT_SUPPORTED_GET_NEXT_HIGH_MONOTONIC_COUNT 0x0200
  217. #define EFI_RT_SUPPORTED_RESET_SYSTEM 0x0400
  218. #define EFI_RT_SUPPORTED_UPDATE_CAPSULE 0x0800
  219. #define EFI_RT_SUPPORTED_QUERY_CAPSULE_CAPABILITIES 0x1000
  220. #define EFI_RT_SUPPORTED_QUERY_VARIABLE_INFO 0x2000
  221. #define EFI_RT_PROPERTIES_TABLE_GUID \
  222. EFI_GUID(0xeb66918a, 0x7eef, 0x402a, 0x84, 0x2e, \
  223. 0x93, 0x1d, 0x21, 0xc3, 0x8a, 0xe9)
  224. #define EFI_RT_PROPERTIES_TABLE_VERSION 0x1
  225. struct efi_rt_properties_table {
  226. u16 version;
  227. u16 length;
  228. u32 runtime_services_supported;
  229. };
  230. struct efi_runtime_services {
  231. struct efi_table_hdr hdr;
  232. efi_status_t (EFIAPI *get_time)(struct efi_time *time,
  233. struct efi_time_cap *capabilities);
  234. efi_status_t (EFIAPI *set_time)(struct efi_time *time);
  235. efi_status_t (EFIAPI *get_wakeup_time)(char *enabled, char *pending,
  236. struct efi_time *time);
  237. efi_status_t (EFIAPI *set_wakeup_time)(char enabled,
  238. struct efi_time *time);
  239. efi_status_t (EFIAPI *set_virtual_address_map)(
  240. efi_uintn_t memory_map_size,
  241. efi_uintn_t descriptor_size,
  242. uint32_t descriptor_version,
  243. struct efi_mem_desc *virtmap);
  244. efi_status_t (EFIAPI *convert_pointer)(
  245. efi_uintn_t debug_disposition, void **address);
  246. efi_status_t (EFIAPI *get_variable)(u16 *variable_name,
  247. const efi_guid_t *vendor,
  248. u32 *attributes,
  249. efi_uintn_t *data_size, void *data);
  250. efi_status_t (EFIAPI *get_next_variable_name)(
  251. efi_uintn_t *variable_name_size,
  252. u16 *variable_name, efi_guid_t *vendor);
  253. efi_status_t (EFIAPI *set_variable)(u16 *variable_name,
  254. const efi_guid_t *vendor,
  255. u32 attributes,
  256. efi_uintn_t data_size,
  257. const void *data);
  258. efi_status_t (EFIAPI *get_next_high_mono_count)(
  259. uint32_t *high_count);
  260. void (EFIAPI *reset_system)(enum efi_reset_type reset_type,
  261. efi_status_t reset_status,
  262. unsigned long data_size, void *reset_data);
  263. efi_status_t (EFIAPI *update_capsule)(
  264. struct efi_capsule_header **capsule_header_array,
  265. efi_uintn_t capsule_count,
  266. u64 scatter_gather_list);
  267. efi_status_t (EFIAPI *query_capsule_caps)(
  268. struct efi_capsule_header **capsule_header_array,
  269. efi_uintn_t capsule_count,
  270. u64 *maximum_capsule_size,
  271. u32 *reset_type);
  272. efi_status_t (EFIAPI *query_variable_info)(
  273. u32 attributes,
  274. u64 *maximum_variable_storage_size,
  275. u64 *remaining_variable_storage_size,
  276. u64 *maximum_variable_size);
  277. };
  278. /* EFI event group GUID definitions */
  279. #define EFI_EVENT_GROUP_EXIT_BOOT_SERVICES \
  280. EFI_GUID(0x27abf055, 0xb1b8, 0x4c26, 0x80, 0x48, \
  281. 0x74, 0x8f, 0x37, 0xba, 0xa2, 0xdf)
  282. #define EFI_EVENT_GROUP_VIRTUAL_ADDRESS_CHANGE \
  283. EFI_GUID(0x13fa7698, 0xc831, 0x49c7, 0x87, 0xea, \
  284. 0x8f, 0x43, 0xfc, 0xc2, 0x51, 0x96)
  285. #define EFI_EVENT_GROUP_MEMORY_MAP_CHANGE \
  286. EFI_GUID(0x78bee926, 0x692f, 0x48fd, 0x9e, 0xdb, \
  287. 0x01, 0x42, 0x2e, 0xf0, 0xd7, 0xab)
  288. #define EFI_EVENT_GROUP_READY_TO_BOOT \
  289. EFI_GUID(0x7ce88fb3, 0x4bd7, 0x4679, 0x87, 0xa8, \
  290. 0xa8, 0xd8, 0xde, 0xe5, 0x0d, 0x2b)
  291. #define EFI_EVENT_GROUP_RESET_SYSTEM \
  292. EFI_GUID(0x62da6a56, 0x13fb, 0x485a, 0xa8, 0xda, \
  293. 0xa3, 0xdd, 0x79, 0x12, 0xcb, 0x6b)
  294. /* EFI Configuration Table and GUID definitions */
  295. #define NULL_GUID \
  296. EFI_GUID(0x00000000, 0x0000, 0x0000, 0x00, 0x00, \
  297. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00)
  298. #define EFI_GLOBAL_VARIABLE_GUID \
  299. EFI_GUID(0x8be4df61, 0x93ca, 0x11d2, 0xaa, 0x0d, \
  300. 0x00, 0xe0, 0x98, 0x03, 0x2b, 0x8c)
  301. #define EFI_IMAGE_SECURITY_DATABASE_GUID \
  302. EFI_GUID(0xd719b2cb, 0x3d3a, 0x4596, 0xa3, 0xbc, \
  303. 0xda, 0xd0, 0x0e, 0x67, 0x65, 0x6f)
  304. #define EFI_FDT_GUID \
  305. EFI_GUID(0xb1b621d5, 0xf19c, 0x41a5, \
  306. 0x83, 0x0b, 0xd9, 0x15, 0x2c, 0x69, 0xaa, 0xe0)
  307. #define EFI_ACPI_TABLE_GUID \
  308. EFI_GUID(0x8868e871, 0xe4f1, 0x11d3, \
  309. 0xbc, 0x22, 0x00, 0x80, 0xc7, 0x3c, 0x88, 0x81)
  310. #define SMBIOS_TABLE_GUID \
  311. EFI_GUID(0xeb9d2d31, 0x2d88, 0x11d3, \
  312. 0x9a, 0x16, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
  313. #define EFI_LOAD_FILE_PROTOCOL_GUID \
  314. EFI_GUID(0x56ec3091, 0x954c, 0x11d2, \
  315. 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  316. #define EFI_LOAD_FILE2_PROTOCOL_GUID \
  317. EFI_GUID(0x4006c0c1, 0xfcb3, 0x403e, \
  318. 0x99, 0x6d, 0x4a, 0x6c, 0x87, 0x24, 0xe0, 0x6d)
  319. struct efi_configuration_table {
  320. efi_guid_t guid;
  321. void *table;
  322. } __packed;
  323. #define EFI_SYSTEM_TABLE_SIGNATURE ((u64)0x5453595320494249ULL)
  324. struct efi_system_table {
  325. struct efi_table_hdr hdr;
  326. u16 *fw_vendor; /* physical addr of wchar_t vendor string */
  327. u32 fw_revision;
  328. efi_handle_t con_in_handle;
  329. struct efi_simple_text_input_protocol *con_in;
  330. efi_handle_t con_out_handle;
  331. struct efi_simple_text_output_protocol *con_out;
  332. efi_handle_t stderr_handle;
  333. struct efi_simple_text_output_protocol *std_err;
  334. struct efi_runtime_services *runtime;
  335. struct efi_boot_services *boottime;
  336. efi_uintn_t nr_tables;
  337. struct efi_configuration_table *tables;
  338. };
  339. #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
  340. EFI_GUID(0x5b1b31a1, 0x9562, 0x11d2, \
  341. 0x8e, 0x3f, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  342. #define EFI_LOADED_IMAGE_DEVICE_PATH_PROTOCOL_GUID \
  343. EFI_GUID(0xbc62157e, 0x3e33, 0x4fec, \
  344. 0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf)
  345. #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
  346. struct efi_loaded_image {
  347. u32 revision;
  348. void *parent_handle;
  349. struct efi_system_table *system_table;
  350. efi_handle_t device_handle;
  351. struct efi_device_path *file_path;
  352. void *reserved;
  353. u32 load_options_size;
  354. void *load_options;
  355. void *image_base;
  356. aligned_u64 image_size;
  357. unsigned int image_code_type;
  358. unsigned int image_data_type;
  359. efi_status_t (EFIAPI *unload)(efi_handle_t image_handle);
  360. };
  361. #define EFI_DEVICE_PATH_PROTOCOL_GUID \
  362. EFI_GUID(0x09576e91, 0x6d3f, 0x11d2, \
  363. 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  364. #define DEVICE_PATH_TYPE_END 0x7f
  365. # define DEVICE_PATH_SUB_TYPE_INSTANCE_END 0x01
  366. # define DEVICE_PATH_SUB_TYPE_END 0xff
  367. struct efi_device_path {
  368. u8 type;
  369. u8 sub_type;
  370. u16 length;
  371. } __packed;
  372. struct efi_mac_addr {
  373. u8 addr[32];
  374. } __packed;
  375. #define DEVICE_PATH_TYPE_HARDWARE_DEVICE 0x01
  376. # define DEVICE_PATH_SUB_TYPE_MEMORY 0x03
  377. # define DEVICE_PATH_SUB_TYPE_VENDOR 0x04
  378. struct efi_device_path_memory {
  379. struct efi_device_path dp;
  380. u32 memory_type;
  381. u64 start_address;
  382. u64 end_address;
  383. } __packed;
  384. struct efi_device_path_vendor {
  385. struct efi_device_path dp;
  386. efi_guid_t guid;
  387. u8 vendor_data[];
  388. } __packed;
  389. #define DEVICE_PATH_TYPE_ACPI_DEVICE 0x02
  390. # define DEVICE_PATH_SUB_TYPE_ACPI_DEVICE 0x01
  391. #define EFI_PNP_ID(ID) (u32)(((ID) << 16) | 0x41D0)
  392. #define EISA_PNP_ID(ID) EFI_PNP_ID(ID)
  393. #define EISA_PNP_NUM(ID) ((ID) >> 16)
  394. struct efi_device_path_acpi_path {
  395. struct efi_device_path dp;
  396. u32 hid;
  397. u32 uid;
  398. } __packed;
  399. #define DEVICE_PATH_TYPE_MESSAGING_DEVICE 0x03
  400. # define DEVICE_PATH_SUB_TYPE_MSG_ATAPI 0x01
  401. # define DEVICE_PATH_SUB_TYPE_MSG_SCSI 0x02
  402. # define DEVICE_PATH_SUB_TYPE_MSG_USB 0x05
  403. # define DEVICE_PATH_SUB_TYPE_MSG_MAC_ADDR 0x0b
  404. # define DEVICE_PATH_SUB_TYPE_MSG_USB_CLASS 0x0f
  405. # define DEVICE_PATH_SUB_TYPE_MSG_SATA 0x12
  406. # define DEVICE_PATH_SUB_TYPE_MSG_NVME 0x17
  407. # define DEVICE_PATH_SUB_TYPE_MSG_SD 0x1a
  408. # define DEVICE_PATH_SUB_TYPE_MSG_MMC 0x1d
  409. struct efi_device_path_atapi {
  410. struct efi_device_path dp;
  411. u8 primary_secondary;
  412. u8 slave_master;
  413. u16 logical_unit_number;
  414. } __packed;
  415. struct efi_device_path_scsi {
  416. struct efi_device_path dp;
  417. u16 target_id;
  418. u16 logical_unit_number;
  419. } __packed;
  420. struct efi_device_path_usb {
  421. struct efi_device_path dp;
  422. u8 parent_port_number;
  423. u8 usb_interface;
  424. } __packed;
  425. struct efi_device_path_sata {
  426. struct efi_device_path dp;
  427. u16 hba_port;
  428. u16 port_multiplier_port;
  429. u16 logical_unit_number;
  430. } __packed;
  431. struct efi_device_path_mac_addr {
  432. struct efi_device_path dp;
  433. struct efi_mac_addr mac;
  434. u8 if_type;
  435. } __packed;
  436. struct efi_device_path_usb_class {
  437. struct efi_device_path dp;
  438. u16 vendor_id;
  439. u16 product_id;
  440. u8 device_class;
  441. u8 device_subclass;
  442. u8 device_protocol;
  443. } __packed;
  444. struct efi_device_path_sd_mmc_path {
  445. struct efi_device_path dp;
  446. u8 slot_number;
  447. } __packed;
  448. struct efi_device_path_nvme {
  449. struct efi_device_path dp;
  450. u32 ns_id;
  451. u8 eui64[8];
  452. } __packed;
  453. #define DEVICE_PATH_TYPE_MEDIA_DEVICE 0x04
  454. # define DEVICE_PATH_SUB_TYPE_HARD_DRIVE_PATH 0x01
  455. # define DEVICE_PATH_SUB_TYPE_CDROM_PATH 0x02
  456. # define DEVICE_PATH_SUB_TYPE_VENDOR_PATH 0x03
  457. # define DEVICE_PATH_SUB_TYPE_FILE_PATH 0x04
  458. struct efi_device_path_hard_drive_path {
  459. struct efi_device_path dp;
  460. u32 partition_number;
  461. u64 partition_start;
  462. u64 partition_end;
  463. u8 partition_signature[16];
  464. u8 partmap_type;
  465. u8 signature_type;
  466. } __packed;
  467. struct efi_device_path_cdrom_path {
  468. struct efi_device_path dp;
  469. u32 boot_entry;
  470. u64 partition_start;
  471. u64 partition_size;
  472. } __packed;
  473. struct efi_device_path_file_path {
  474. struct efi_device_path dp;
  475. u16 str[];
  476. } __packed;
  477. #define EFI_BLOCK_IO_PROTOCOL_GUID \
  478. EFI_GUID(0x964e5b21, 0x6459, 0x11d2, \
  479. 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  480. struct efi_block_io_media {
  481. u32 media_id;
  482. char removable_media;
  483. char media_present;
  484. char logical_partition;
  485. char read_only;
  486. char write_caching;
  487. u8 pad[3];
  488. u32 block_size;
  489. u32 io_align;
  490. u8 pad2[4];
  491. u64 last_block;
  492. /* Added in revision 2 of the protocol */
  493. u64 lowest_aligned_lba;
  494. u32 logical_blocks_per_physical_block;
  495. /* Added in revision 3 of the protocol */
  496. u32 optimal_transfer_length_granualarity;
  497. };
  498. #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
  499. #define EFI_BLOCK_IO_PROTOCOL_REVISION3 0x0002001f
  500. struct efi_block_io {
  501. u64 revision;
  502. struct efi_block_io_media *media;
  503. efi_status_t (EFIAPI *reset)(struct efi_block_io *this,
  504. char extended_verification);
  505. efi_status_t (EFIAPI *read_blocks)(struct efi_block_io *this,
  506. u32 media_id, u64 lba, efi_uintn_t buffer_size,
  507. void *buffer);
  508. efi_status_t (EFIAPI *write_blocks)(struct efi_block_io *this,
  509. u32 media_id, u64 lba, efi_uintn_t buffer_size,
  510. void *buffer);
  511. efi_status_t (EFIAPI *flush_blocks)(struct efi_block_io *this);
  512. };
  513. struct simple_text_output_mode {
  514. s32 max_mode;
  515. s32 mode;
  516. s32 attribute;
  517. s32 cursor_column;
  518. s32 cursor_row;
  519. bool cursor_visible;
  520. };
  521. #define EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID \
  522. EFI_GUID(0x387477c2, 0x69c7, 0x11d2, \
  523. 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  524. #define EFI_BLACK 0x00
  525. #define EFI_BLUE 0x01
  526. #define EFI_GREEN 0x02
  527. #define EFI_CYAN 0x03
  528. #define EFI_RED 0x04
  529. #define EFI_MAGENTA 0x05
  530. #define EFI_BROWN 0x06
  531. #define EFI_LIGHTGRAY 0x07
  532. #define EFI_BRIGHT 0x08
  533. #define EFI_DARKGRAY 0x08
  534. #define EFI_LIGHTBLUE 0x09
  535. #define EFI_LIGHTGREEN 0x0a
  536. #define EFI_LIGHTCYAN 0x0b
  537. #define EFI_LIGHTRED 0x0c
  538. #define EFI_LIGHTMAGENTA 0x0d
  539. #define EFI_YELLOW 0x0e
  540. #define EFI_WHITE 0x0f
  541. #define EFI_BACKGROUND_BLACK 0x00
  542. #define EFI_BACKGROUND_BLUE 0x10
  543. #define EFI_BACKGROUND_GREEN 0x20
  544. #define EFI_BACKGROUND_CYAN 0x30
  545. #define EFI_BACKGROUND_RED 0x40
  546. #define EFI_BACKGROUND_MAGENTA 0x50
  547. #define EFI_BACKGROUND_BROWN 0x60
  548. #define EFI_BACKGROUND_LIGHTGRAY 0x70
  549. /* extract foreground color from EFI attribute */
  550. #define EFI_ATTR_FG(attr) ((attr) & 0x07)
  551. /* treat high bit of FG as bright/bold (similar to edk2) */
  552. #define EFI_ATTR_BOLD(attr) (((attr) >> 3) & 0x01)
  553. /* extract background color from EFI attribute */
  554. #define EFI_ATTR_BG(attr) (((attr) >> 4) & 0x7)
  555. struct efi_simple_text_output_protocol {
  556. efi_status_t (EFIAPI *reset)(
  557. struct efi_simple_text_output_protocol *this,
  558. char extended_verification);
  559. efi_status_t (EFIAPI *output_string)(
  560. struct efi_simple_text_output_protocol *this,
  561. const efi_string_t str);
  562. efi_status_t (EFIAPI *test_string)(
  563. struct efi_simple_text_output_protocol *this,
  564. const efi_string_t str);
  565. efi_status_t(EFIAPI *query_mode)(
  566. struct efi_simple_text_output_protocol *this,
  567. unsigned long mode_number, unsigned long *columns,
  568. unsigned long *rows);
  569. efi_status_t(EFIAPI *set_mode)(
  570. struct efi_simple_text_output_protocol *this,
  571. unsigned long mode_number);
  572. efi_status_t(EFIAPI *set_attribute)(
  573. struct efi_simple_text_output_protocol *this,
  574. unsigned long attribute);
  575. efi_status_t(EFIAPI *clear_screen) (
  576. struct efi_simple_text_output_protocol *this);
  577. efi_status_t(EFIAPI *set_cursor_position) (
  578. struct efi_simple_text_output_protocol *this,
  579. unsigned long column, unsigned long row);
  580. efi_status_t(EFIAPI *enable_cursor)(
  581. struct efi_simple_text_output_protocol *this,
  582. bool enable);
  583. struct simple_text_output_mode *mode;
  584. };
  585. #define EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL_GUID \
  586. EFI_GUID(0xdd9e7534, 0x7762, 0x4698, \
  587. 0x8c, 0x14, 0xf5, 0x85, 0x17, 0xa6, 0x25, 0xaa)
  588. struct efi_input_key {
  589. u16 scan_code;
  590. s16 unicode_char;
  591. };
  592. #define EFI_SHIFT_STATE_INVALID 0x00000000
  593. #define EFI_RIGHT_SHIFT_PRESSED 0x00000001
  594. #define EFI_LEFT_SHIFT_PRESSED 0x00000002
  595. #define EFI_RIGHT_CONTROL_PRESSED 0x00000004
  596. #define EFI_LEFT_CONTROL_PRESSED 0x00000008
  597. #define EFI_RIGHT_ALT_PRESSED 0x00000010
  598. #define EFI_LEFT_ALT_PRESSED 0x00000020
  599. #define EFI_RIGHT_LOGO_PRESSED 0x00000040
  600. #define EFI_LEFT_LOGO_PRESSED 0x00000080
  601. #define EFI_MENU_KEY_PRESSED 0x00000100
  602. #define EFI_SYS_REQ_PRESSED 0x00000200
  603. #define EFI_SHIFT_STATE_VALID 0x80000000
  604. #define EFI_TOGGLE_STATE_INVALID 0x00
  605. #define EFI_SCROLL_LOCK_ACTIVE 0x01
  606. #define EFI_NUM_LOCK_ACTIVE 0x02
  607. #define EFI_CAPS_LOCK_ACTIVE 0x04
  608. #define EFI_KEY_STATE_EXPOSED 0x40
  609. #define EFI_TOGGLE_STATE_VALID 0x80
  610. struct efi_key_state {
  611. u32 key_shift_state;
  612. u8 key_toggle_state;
  613. };
  614. struct efi_key_data {
  615. struct efi_input_key key;
  616. struct efi_key_state key_state;
  617. };
  618. struct efi_simple_text_input_ex_protocol {
  619. efi_status_t (EFIAPI *reset) (
  620. struct efi_simple_text_input_ex_protocol *this,
  621. bool extended_verification);
  622. efi_status_t (EFIAPI *read_key_stroke_ex) (
  623. struct efi_simple_text_input_ex_protocol *this,
  624. struct efi_key_data *key_data);
  625. struct efi_event *wait_for_key_ex;
  626. efi_status_t (EFIAPI *set_state) (
  627. struct efi_simple_text_input_ex_protocol *this,
  628. u8 *key_toggle_state);
  629. efi_status_t (EFIAPI *register_key_notify) (
  630. struct efi_simple_text_input_ex_protocol *this,
  631. struct efi_key_data *key_data,
  632. efi_status_t (EFIAPI *key_notify_function)(
  633. struct efi_key_data *key_data),
  634. void **notify_handle);
  635. efi_status_t (EFIAPI *unregister_key_notify) (
  636. struct efi_simple_text_input_ex_protocol *this,
  637. void *notification_handle);
  638. };
  639. #define EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID \
  640. EFI_GUID(0x387477c1, 0x69c7, 0x11d2, \
  641. 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  642. struct efi_simple_text_input_protocol {
  643. efi_status_t(EFIAPI *reset)(struct efi_simple_text_input_protocol *this,
  644. bool extended_verification);
  645. efi_status_t(EFIAPI *read_key_stroke)(
  646. struct efi_simple_text_input_protocol *this,
  647. struct efi_input_key *key);
  648. struct efi_event *wait_for_key;
  649. };
  650. #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \
  651. EFI_GUID(0x8b843e20, 0x8132, 0x4852, \
  652. 0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c)
  653. struct efi_device_path_to_text_protocol {
  654. uint16_t *(EFIAPI *convert_device_node_to_text)(
  655. struct efi_device_path *device_node,
  656. bool display_only,
  657. bool allow_shortcuts);
  658. uint16_t *(EFIAPI *convert_device_path_to_text)(
  659. struct efi_device_path *device_path,
  660. bool display_only,
  661. bool allow_shortcuts);
  662. };
  663. #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \
  664. EFI_GUID(0x0379be4e, 0xd706, 0x437d, \
  665. 0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4)
  666. struct efi_device_path_utilities_protocol {
  667. efi_uintn_t (EFIAPI *get_device_path_size)(
  668. const struct efi_device_path *device_path);
  669. struct efi_device_path *(EFIAPI *duplicate_device_path)(
  670. const struct efi_device_path *device_path);
  671. struct efi_device_path *(EFIAPI *append_device_path)(
  672. const struct efi_device_path *src1,
  673. const struct efi_device_path *src2);
  674. struct efi_device_path *(EFIAPI *append_device_node)(
  675. const struct efi_device_path *device_path,
  676. const struct efi_device_path *device_node);
  677. struct efi_device_path *(EFIAPI *append_device_path_instance)(
  678. const struct efi_device_path *device_path,
  679. const struct efi_device_path *device_path_instance);
  680. struct efi_device_path *(EFIAPI *get_next_device_path_instance)(
  681. struct efi_device_path **device_path_instance,
  682. efi_uintn_t *device_path_instance_size);
  683. bool (EFIAPI *is_device_path_multi_instance)(
  684. const struct efi_device_path *device_path);
  685. struct efi_device_path *(EFIAPI *create_device_node)(
  686. uint8_t node_type,
  687. uint8_t node_sub_type,
  688. uint16_t node_length);
  689. };
  690. /*
  691. * Human Interface Infrastructure (HII)
  692. */
  693. struct efi_hii_package_list_header {
  694. efi_guid_t package_list_guid;
  695. u32 package_length;
  696. } __packed;
  697. /**
  698. * struct efi_hii_package_header - EFI HII package header
  699. *
  700. * @fields: 'fields' replaces the bit-fields defined in the EFI
  701. * specification to to avoid possible compiler incompatibilities::
  702. *
  703. * u32 length:24;
  704. * u32 type:8;
  705. */
  706. struct efi_hii_package_header {
  707. u32 fields;
  708. } __packed;
  709. #define __EFI_HII_PACKAGE_LEN_SHIFT 0
  710. #define __EFI_HII_PACKAGE_TYPE_SHIFT 24
  711. #define __EFI_HII_PACKAGE_LEN_MASK 0xffffff
  712. #define __EFI_HII_PACKAGE_TYPE_MASK 0xff
  713. #define EFI_HII_PACKAGE_TYPE_ALL 0x00
  714. #define EFI_HII_PACKAGE_TYPE_GUID 0x01
  715. #define EFI_HII_PACKAGE_FORMS 0x02
  716. #define EFI_HII_PACKAGE_STRINGS 0x04
  717. #define EFI_HII_PACKAGE_FONTS 0x05
  718. #define EFI_HII_PACKAGE_IMAGES 0x06
  719. #define EFI_HII_PACKAGE_SIMPLE_FONTS 0x07
  720. #define EFI_HII_PACKAGE_DEVICE_PATH 0x08
  721. #define EFI_HII_PACKAGE_KEYBOARD_LAYOUT 0x09
  722. #define EFI_HII_PACKAGE_ANIMATIONS 0x0A
  723. #define EFI_HII_PACKAGE_END 0xDF
  724. #define EFI_HII_PACKAGE_TYPE_SYSTEM_BEGIN 0xE0
  725. #define EFI_HII_PACKAGE_TYPE_SYSTEM_END 0xFF
  726. /*
  727. * HII GUID package
  728. */
  729. struct efi_hii_guid_package {
  730. struct efi_hii_package_header header;
  731. efi_guid_t guid;
  732. char data[];
  733. } __packed;
  734. /*
  735. * HII string package
  736. */
  737. struct efi_hii_strings_package {
  738. struct efi_hii_package_header header;
  739. u32 header_size;
  740. u32 string_info_offset;
  741. u16 language_window[16];
  742. efi_string_id_t language_name;
  743. u8 language[];
  744. } __packed;
  745. struct efi_hii_string_block {
  746. u8 block_type;
  747. /* u8 block_body[]; */
  748. } __packed;
  749. #define EFI_HII_SIBT_END 0x00
  750. #define EFI_HII_SIBT_STRING_SCSU 0x10
  751. #define EFI_HII_SIBT_STRING_SCSU_FONT 0x11
  752. #define EFI_HII_SIBT_STRINGS_SCSU 0x12
  753. #define EFI_HII_SIBT_STRINGS_SCSU_FONT 0x13
  754. #define EFI_HII_SIBT_STRING_UCS2 0x14
  755. #define EFI_HII_SIBT_STRING_UCS2_FONT 0x15
  756. #define EFI_HII_SIBT_STRINGS_UCS2 0x16
  757. #define EFI_HII_SIBT_STRINGS_UCS2_FONT 0x17
  758. #define EFI_HII_SIBT_DUPLICATE 0x20
  759. #define EFI_HII_SIBT_SKIP2 0x21
  760. #define EFI_HII_SIBT_SKIP1 0x22
  761. #define EFI_HII_SIBT_EXT1 0x30
  762. #define EFI_HII_SIBT_EXT2 0x31
  763. #define EFI_HII_SIBT_EXT4 0x32
  764. #define EFI_HII_SIBT_FONT 0x40
  765. struct efi_hii_sibt_string_ucs2_block {
  766. struct efi_hii_string_block header;
  767. u16 string_text[];
  768. } __packed;
  769. static inline struct efi_hii_string_block *
  770. efi_hii_sibt_string_ucs2_block_next(struct efi_hii_sibt_string_ucs2_block *blk)
  771. {
  772. return ((void *)blk) + sizeof(*blk) +
  773. (u16_strlen(blk->string_text) + 1) * 2;
  774. }
  775. /*
  776. * HII forms package
  777. * TODO: full scope of definitions
  778. */
  779. struct efi_hii_time {
  780. u8 hour;
  781. u8 minute;
  782. u8 second;
  783. };
  784. struct efi_hii_date {
  785. u16 year;
  786. u8 month;
  787. u8 day;
  788. };
  789. struct efi_hii_ref {
  790. efi_question_id_t question_id;
  791. efi_form_id_t form_id;
  792. efi_guid_t form_set_guid;
  793. efi_string_id_t device_path;
  794. };
  795. union efi_ifr_type_value {
  796. u8 u8; // EFI_IFR_TYPE_NUM_SIZE_8
  797. u16 u16; // EFI_IFR_TYPE_NUM_SIZE_16
  798. u32 u32; // EFI_IFR_TYPE_NUM_SIZE_32
  799. u64 u64; // EFI_IFR_TYPE_NUM_SIZE_64
  800. bool b; // EFI_IFR_TYPE_BOOLEAN
  801. struct efi_hii_time time; // EFI_IFR_TYPE_TIME
  802. struct efi_hii_date date; // EFI_IFR_TYPE_DATE
  803. efi_string_id_t string; // EFI_IFR_TYPE_STRING, EFI_IFR_TYPE_ACTION
  804. struct efi_hii_ref ref; // EFI_IFR_TYPE_REF
  805. // u8 buffer[]; // EFI_IFR_TYPE_BUFFER
  806. };
  807. #define EFI_IFR_TYPE_NUM_SIZE_8 0x00
  808. #define EFI_IFR_TYPE_NUM_SIZE_16 0x01
  809. #define EFI_IFR_TYPE_NUM_SIZE_32 0x02
  810. #define EFI_IFR_TYPE_NUM_SIZE_64 0x03
  811. #define EFI_IFR_TYPE_BOOLEAN 0x04
  812. #define EFI_IFR_TYPE_TIME 0x05
  813. #define EFI_IFR_TYPE_DATE 0x06
  814. #define EFI_IFR_TYPE_STRING 0x07
  815. #define EFI_IFR_TYPE_OTHER 0x08
  816. #define EFI_IFR_TYPE_UNDEFINED 0x09
  817. #define EFI_IFR_TYPE_ACTION 0x0A
  818. #define EFI_IFR_TYPE_BUFFER 0x0B
  819. #define EFI_IFR_TYPE_REF 0x0C
  820. #define EFI_IFR_OPTION_DEFAULT 0x10
  821. #define EFI_IFR_OPTION_DEFAULT_MFG 0x20
  822. #define EFI_IFR_ONE_OF_OPTION_OP 0x09
  823. struct efi_ifr_op_header {
  824. u8 opCode;
  825. u8 length:7;
  826. u8 scope:1;
  827. };
  828. struct efi_ifr_one_of_option {
  829. struct efi_ifr_op_header header;
  830. efi_string_id_t option;
  831. u8 flags;
  832. u8 type;
  833. union efi_ifr_type_value value;
  834. };
  835. typedef efi_uintn_t efi_browser_action_t;
  836. #define EFI_BROWSER_ACTION_REQUEST_NONE 0
  837. #define EFI_BROWSER_ACTION_REQUEST_RESET 1
  838. #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2
  839. #define EFI_BROWSER_ACTION_REQUEST_EXIT 3
  840. #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4
  841. #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5
  842. #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6
  843. #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7
  844. #define EFI_BROWSER_ACTION_REQUEST_RECONNECT 8
  845. typedef efi_uintn_t efi_browser_action_request_t;
  846. #define EFI_BROWSER_ACTION_CHANGING 0
  847. #define EFI_BROWSER_ACTION_CHANGED 1
  848. #define EFI_BROWSER_ACTION_RETRIEVE 2
  849. #define EFI_BROWSER_ACTION_FORM_OPEN 3
  850. #define EFI_BROWSER_ACTION_FORM_CLOSE 4
  851. #define EFI_BROWSER_ACTION_SUBMITTED 5
  852. #define EFI_BROWSER_ACTION_DEFAULT_STANDARD 0x1000
  853. #define EFI_BROWSER_ACTION_DEFAULT_MANUFACTURING 0x1001
  854. #define EFI_BROWSER_ACTION_DEFAULT_SAFE 0x1002
  855. #define EFI_BROWSER_ACTION_DEFAULT_PLATFORM 0x2000
  856. #define EFI_BROWSER_ACTION_DEFAULT_HARDWARE 0x3000
  857. #define EFI_BROWSER_ACTION_DEFAULT_FIRMWARE 0x4000
  858. /*
  859. * HII keyboard package
  860. */
  861. typedef enum {
  862. EFI_KEY_LCTRL, EFI_KEY_A0, EFI_KEY_LALT, EFI_KEY_SPACE_BAR,
  863. EFI_KEY_A2, EFI_KEY_A3, EFI_KEY_A4, EFI_KEY_RCTRL, EFI_KEY_LEFT_ARROW,
  864. EFI_KEY_DOWN_ARROW, EFI_KEY_RIGHT_ARROW, EFI_KEY_ZERO,
  865. EFI_KEY_PERIOD, EFI_KEY_ENTER, EFI_KEY_LSHIFT, EFI_KEY_B0,
  866. EFI_KEY_B1, EFI_KEY_B2, EFI_KEY_B3, EFI_KEY_B4, EFI_KEY_B5, EFI_KEY_B6,
  867. EFI_KEY_B7, EFI_KEY_B8, EFI_KEY_B9, EFI_KEY_B10, EFI_KEY_RSHIFT,
  868. EFI_KEY_UP_ARROW, EFI_KEY_ONE, EFI_KEY_TWO, EFI_KEY_THREE,
  869. EFI_KEY_CAPS_LOCK, EFI_KEY_C1, EFI_KEY_C2, EFI_KEY_C3, EFI_KEY_C4,
  870. EFI_KEY_C5, EFI_KEY_C6, EFI_KEY_C7, EFI_KEY_C8, EFI_KEY_C9,
  871. EFI_KEY_C10, EFI_KEY_C11, EFI_KEY_C12, EFI_KEY_FOUR, EFI_KEY_FIVE,
  872. EFI_KEY_SIX, EFI_KEY_PLUS, EFI_KEY_TAB, EFI_KEY_D1, EFI_KEY_D2,
  873. EFI_KEY_D3, EFI_KEY_D4, EFI_KEY_D5, EFI_KEY_D6, EFI_KEY_D7, EFI_KEY_D8,
  874. EFI_KEY_D9, EFI_KEY_D10, EFI_KEY_D11, EFI_KEY_D12, EFI_KEY_D13,
  875. EFI_KEY_DEL, EFI_KEY_END, EFI_KEY_PG_DN, EFI_KEY_SEVEN, EFI_KEY_EIGHT,
  876. EFI_KEY_NINE, EFI_KEY_E0, EFI_KEY_E1, EFI_KEY_E2, EFI_KEY_E3,
  877. EFI_KEY_E4, EFI_KEY_E5, EFI_KEY_E6, EFI_KEY_E7, EFI_KEY_E8, EFI_KEY_E9,
  878. EFI_KEY_E10, EFI_KEY_E11, EFI_KEY_E12, EFI_KEY_BACK_SPACE,
  879. EFI_KEY_INS, EFI_KEY_HOME, EFI_KEY_PG_UP, EFI_KEY_NLCK, EFI_KEY_SLASH,
  880. EFI_KEY_ASTERISK, EFI_KEY_MINUS, EFI_KEY_ESC, EFI_KEY_F1, EFI_KEY_F2,
  881. EFI_KEY_F3, EFI_KEY_F4, EFI_KEY_F5, EFI_KEY_F6, EFI_KEY_F7, EFI_KEY_F8,
  882. EFI_KEY_F9, EFI_KEY_F10, EFI_KEY_F11, EFI_KEY_F12, EFI_KEY_PRINT,
  883. EFI_KEY_SLCK, EFI_KEY_PAUSE,
  884. } efi_key;
  885. struct efi_key_descriptor {
  886. u32 key;
  887. u16 unicode;
  888. u16 shifted_unicode;
  889. u16 alt_gr_unicode;
  890. u16 shifted_alt_gr_unicode;
  891. u16 modifier;
  892. u16 affected_attribute;
  893. } __packed;
  894. struct efi_hii_keyboard_layout {
  895. u16 layout_length;
  896. efi_guid_t guid;
  897. u32 layout_descriptor_string_offset;
  898. u8 descriptor_count;
  899. struct efi_key_descriptor descriptors[];
  900. } __packed;
  901. struct efi_hii_keyboard_package {
  902. struct efi_hii_package_header header;
  903. u16 layout_count;
  904. struct efi_hii_keyboard_layout layout[];
  905. } __packed;
  906. /*
  907. * HII protocols
  908. */
  909. #define EFI_HII_STRING_PROTOCOL_GUID \
  910. EFI_GUID(0x0fd96974, 0x23aa, 0x4cdc, \
  911. 0xb9, 0xcb, 0x98, 0xd1, 0x77, 0x50, 0x32, 0x2a)
  912. struct efi_font_info {
  913. efi_hii_font_style_t font_style;
  914. u16 font_size;
  915. u16 font_name[1];
  916. };
  917. struct efi_hii_string_protocol {
  918. efi_status_t(EFIAPI *new_string)(
  919. const struct efi_hii_string_protocol *this,
  920. efi_hii_handle_t package_list,
  921. efi_string_id_t *string_id,
  922. const u8 *language,
  923. const u16 *language_name,
  924. const efi_string_t string,
  925. const struct efi_font_info *string_font_info);
  926. efi_status_t(EFIAPI *get_string)(
  927. const struct efi_hii_string_protocol *this,
  928. const u8 *language,
  929. efi_hii_handle_t package_list,
  930. efi_string_id_t string_id,
  931. efi_string_t string,
  932. efi_uintn_t *string_size,
  933. struct efi_font_info **string_font_info);
  934. efi_status_t(EFIAPI *set_string)(
  935. const struct efi_hii_string_protocol *this,
  936. efi_hii_handle_t package_list,
  937. efi_string_id_t string_id,
  938. const u8 *language,
  939. const efi_string_t string,
  940. const struct efi_font_info *string_font_info);
  941. efi_status_t(EFIAPI *get_languages)(
  942. const struct efi_hii_string_protocol *this,
  943. efi_hii_handle_t package_list,
  944. u8 *languages,
  945. efi_uintn_t *languages_size);
  946. efi_status_t(EFIAPI *get_secondary_languages)(
  947. const struct efi_hii_string_protocol *this,
  948. efi_hii_handle_t package_list,
  949. const u8 *primary_language,
  950. u8 *secondary_languages,
  951. efi_uintn_t *secondary_languages_size);
  952. };
  953. #define EFI_HII_DATABASE_PROTOCOL_GUID \
  954. EFI_GUID(0xef9fc172, 0xa1b2, 0x4693, \
  955. 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42)
  956. struct efi_hii_database_protocol {
  957. efi_status_t(EFIAPI *new_package_list)(
  958. const struct efi_hii_database_protocol *this,
  959. const struct efi_hii_package_list_header *package_list,
  960. const efi_handle_t driver_handle,
  961. efi_hii_handle_t *handle);
  962. efi_status_t(EFIAPI *remove_package_list)(
  963. const struct efi_hii_database_protocol *this,
  964. efi_hii_handle_t handle);
  965. efi_status_t(EFIAPI *update_package_list)(
  966. const struct efi_hii_database_protocol *this,
  967. efi_hii_handle_t handle,
  968. const struct efi_hii_package_list_header *package_list);
  969. efi_status_t(EFIAPI *list_package_lists)(
  970. const struct efi_hii_database_protocol *this,
  971. u8 package_type,
  972. const efi_guid_t *package_guid,
  973. efi_uintn_t *handle_buffer_length,
  974. efi_hii_handle_t *handle);
  975. efi_status_t(EFIAPI *export_package_lists)(
  976. const struct efi_hii_database_protocol *this,
  977. efi_hii_handle_t handle,
  978. efi_uintn_t *buffer_size,
  979. struct efi_hii_package_list_header *buffer);
  980. efi_status_t(EFIAPI *register_package_notify)(
  981. const struct efi_hii_database_protocol *this,
  982. u8 package_type,
  983. const efi_guid_t *package_guid,
  984. const void *package_notify_fn,
  985. efi_uintn_t notify_type,
  986. efi_handle_t *notify_handle);
  987. efi_status_t(EFIAPI *unregister_package_notify)(
  988. const struct efi_hii_database_protocol *this,
  989. efi_handle_t notification_handle
  990. );
  991. efi_status_t(EFIAPI *find_keyboard_layouts)(
  992. const struct efi_hii_database_protocol *this,
  993. u16 *key_guid_buffer_length,
  994. efi_guid_t *key_guid_buffer);
  995. efi_status_t(EFIAPI *get_keyboard_layout)(
  996. const struct efi_hii_database_protocol *this,
  997. efi_guid_t *key_guid,
  998. u16 *keyboard_layout_length,
  999. struct efi_hii_keyboard_layout *keyboard_layout);
  1000. efi_status_t(EFIAPI *set_keyboard_layout)(
  1001. const struct efi_hii_database_protocol *this,
  1002. efi_guid_t *key_guid);
  1003. efi_status_t(EFIAPI *get_package_list_handle)(
  1004. const struct efi_hii_database_protocol *this,
  1005. efi_hii_handle_t package_list_handle,
  1006. efi_handle_t *driver_handle);
  1007. };
  1008. #define EFI_HII_CONFIG_ROUTING_PROTOCOL_GUID \
  1009. EFI_GUID(0x587e72d7, 0xcc50, 0x4f79, \
  1010. 0x82, 0x09, 0xca, 0x29, 0x1f, 0xc1, 0xa1, 0x0f)
  1011. struct efi_hii_config_routing_protocol {
  1012. efi_status_t(EFIAPI *extract_config)(
  1013. const struct efi_hii_config_routing_protocol *this,
  1014. const efi_string_t request,
  1015. efi_string_t *progress,
  1016. efi_string_t *results);
  1017. efi_status_t(EFIAPI *export_config)(
  1018. const struct efi_hii_config_routing_protocol *this,
  1019. efi_string_t *results);
  1020. efi_status_t(EFIAPI *route_config)(
  1021. const struct efi_hii_config_routing_protocol *this,
  1022. const efi_string_t configuration,
  1023. efi_string_t *progress);
  1024. efi_status_t(EFIAPI *block_to_config)(
  1025. const struct efi_hii_config_routing_protocol *this,
  1026. const efi_string_t config_request,
  1027. const uint8_t *block,
  1028. const efi_uintn_t block_size,
  1029. efi_string_t *config,
  1030. efi_string_t *progress);
  1031. efi_status_t(EFIAPI *config_to_block)(
  1032. const struct efi_hii_config_routing_protocol *this,
  1033. const efi_string_t config_resp,
  1034. const uint8_t *block,
  1035. const efi_uintn_t *block_size,
  1036. efi_string_t *progress);
  1037. efi_status_t(EFIAPI *get_alt_config)(
  1038. const struct efi_hii_config_routing_protocol *this,
  1039. const efi_string_t config_resp,
  1040. const efi_guid_t *guid,
  1041. const efi_string_t name,
  1042. const struct efi_device_path *device_path,
  1043. const efi_string_t alt_cfg_id,
  1044. efi_string_t *alt_cfg_resp);
  1045. };
  1046. #define EFI_HII_CONFIG_ACCESS_PROTOCOL_GUID \
  1047. EFI_GUID(0x330d4706, 0xf2a0, 0x4e4f, \
  1048. 0xa3, 0x69, 0xb6, 0x6f, 0xa8, 0xd5, 0x43, 0x85)
  1049. struct efi_hii_config_access_protocol {
  1050. efi_status_t(EFIAPI *extract_config_access)(
  1051. const struct efi_hii_config_access_protocol *this,
  1052. const efi_string_t request,
  1053. efi_string_t *progress,
  1054. efi_string_t *results);
  1055. efi_status_t(EFIAPI *route_config_access)(
  1056. const struct efi_hii_config_access_protocol *this,
  1057. const efi_string_t configuration,
  1058. efi_string_t *progress);
  1059. efi_status_t(EFIAPI *form_callback)(
  1060. const struct efi_hii_config_access_protocol *this,
  1061. efi_browser_action_t action,
  1062. efi_question_id_t question_id,
  1063. u8 type,
  1064. union efi_ifr_type_value *value,
  1065. efi_browser_action_request_t *action_request);
  1066. };
  1067. #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
  1068. EFI_GUID(0x9042a9de, 0x23dc, 0x4a38, \
  1069. 0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a)
  1070. #define EFI_GOT_RGBA8 0
  1071. #define EFI_GOT_BGRA8 1
  1072. #define EFI_GOT_BITMASK 2
  1073. struct efi_gop_mode_info {
  1074. u32 version;
  1075. u32 width;
  1076. u32 height;
  1077. u32 pixel_format;
  1078. u32 pixel_bitmask[4];
  1079. u32 pixels_per_scanline;
  1080. };
  1081. struct efi_gop_mode {
  1082. u32 max_mode;
  1083. u32 mode;
  1084. struct efi_gop_mode_info *info;
  1085. unsigned long info_size;
  1086. efi_physical_addr_t fb_base;
  1087. unsigned long fb_size;
  1088. };
  1089. struct efi_gop_pixel {
  1090. u8 blue;
  1091. u8 green;
  1092. u8 red;
  1093. u8 reserved;
  1094. };
  1095. #define EFI_BLT_VIDEO_FILL 0
  1096. #define EFI_BLT_VIDEO_TO_BLT_BUFFER 1
  1097. #define EFI_BLT_BUFFER_TO_VIDEO 2
  1098. #define EFI_BLT_VIDEO_TO_VIDEO 3
  1099. struct efi_gop {
  1100. efi_status_t (EFIAPI *query_mode)(struct efi_gop *this, u32 mode_number,
  1101. efi_uintn_t *size_of_info,
  1102. struct efi_gop_mode_info **info);
  1103. efi_status_t (EFIAPI *set_mode)(struct efi_gop *this, u32 mode_number);
  1104. efi_status_t (EFIAPI *blt)(struct efi_gop *this,
  1105. struct efi_gop_pixel *buffer,
  1106. u32 operation, efi_uintn_t sx,
  1107. efi_uintn_t sy, efi_uintn_t dx,
  1108. efi_uintn_t dy, efi_uintn_t width,
  1109. efi_uintn_t height, efi_uintn_t delta);
  1110. struct efi_gop_mode *mode;
  1111. };
  1112. #define EFI_SIMPLE_NETWORK_PROTOCOL_GUID \
  1113. EFI_GUID(0xa19832b9, 0xac25, 0x11d3, \
  1114. 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
  1115. struct efi_mac_address {
  1116. char mac_addr[32];
  1117. };
  1118. struct efi_ip_address {
  1119. u8 ip_addr[16];
  1120. } __attribute__((aligned(4)));
  1121. enum efi_simple_network_state {
  1122. EFI_NETWORK_STOPPED,
  1123. EFI_NETWORK_STARTED,
  1124. EFI_NETWORK_INITIALIZED,
  1125. };
  1126. struct efi_simple_network_mode {
  1127. enum efi_simple_network_state state;
  1128. u32 hwaddr_size;
  1129. u32 media_header_size;
  1130. u32 max_packet_size;
  1131. u32 nvram_size;
  1132. u32 nvram_access_size;
  1133. u32 receive_filter_mask;
  1134. u32 receive_filter_setting;
  1135. u32 max_mcast_filter_count;
  1136. u32 mcast_filter_count;
  1137. struct efi_mac_address mcast_filter[16];
  1138. struct efi_mac_address current_address;
  1139. struct efi_mac_address broadcast_address;
  1140. struct efi_mac_address permanent_address;
  1141. u8 if_type;
  1142. u8 mac_changeable;
  1143. u8 multitx_supported;
  1144. u8 media_present_supported;
  1145. u8 media_present;
  1146. };
  1147. /* receive_filters bit mask */
  1148. #define EFI_SIMPLE_NETWORK_RECEIVE_UNICAST 0x01
  1149. #define EFI_SIMPLE_NETWORK_RECEIVE_MULTICAST 0x02
  1150. #define EFI_SIMPLE_NETWORK_RECEIVE_BROADCAST 0x04
  1151. #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS 0x08
  1152. #define EFI_SIMPLE_NETWORK_RECEIVE_PROMISCUOUS_MULTICAST 0x10
  1153. /* interrupt status bit mask */
  1154. #define EFI_SIMPLE_NETWORK_RECEIVE_INTERRUPT 0x01
  1155. #define EFI_SIMPLE_NETWORK_TRANSMIT_INTERRUPT 0x02
  1156. #define EFI_SIMPLE_NETWORK_COMMAND_INTERRUPT 0x04
  1157. #define EFI_SIMPLE_NETWORK_SOFTWARE_INTERRUPT 0x08
  1158. /* revision of the simple network protocol */
  1159. #define EFI_SIMPLE_NETWORK_PROTOCOL_REVISION 0x00010000
  1160. struct efi_simple_network {
  1161. u64 revision;
  1162. efi_status_t (EFIAPI *start)(struct efi_simple_network *this);
  1163. efi_status_t (EFIAPI *stop)(struct efi_simple_network *this);
  1164. efi_status_t (EFIAPI *initialize)(struct efi_simple_network *this,
  1165. ulong extra_rx, ulong extra_tx);
  1166. efi_status_t (EFIAPI *reset)(struct efi_simple_network *this,
  1167. int extended_verification);
  1168. efi_status_t (EFIAPI *shutdown)(struct efi_simple_network *this);
  1169. efi_status_t (EFIAPI *receive_filters)(struct efi_simple_network *this,
  1170. u32 enable, u32 disable, int reset_mcast_filter,
  1171. ulong mcast_filter_count,
  1172. struct efi_mac_address *mcast_filter);
  1173. efi_status_t (EFIAPI *station_address)(struct efi_simple_network *this,
  1174. int reset, struct efi_mac_address *new_mac);
  1175. efi_status_t (EFIAPI *statistics)(struct efi_simple_network *this,
  1176. int reset, ulong *stat_size, void *stat_table);
  1177. efi_status_t (EFIAPI *mcastiptomac)(struct efi_simple_network *this,
  1178. int ipv6, struct efi_ip_address *ip,
  1179. struct efi_mac_address *mac);
  1180. efi_status_t (EFIAPI *nvdata)(struct efi_simple_network *this,
  1181. int read_write, ulong offset, ulong buffer_size,
  1182. char *buffer);
  1183. efi_status_t (EFIAPI *get_status)(struct efi_simple_network *this,
  1184. u32 *int_status, void **txbuf);
  1185. efi_status_t (EFIAPI *transmit)(struct efi_simple_network *this,
  1186. size_t header_size, size_t buffer_size, void *buffer,
  1187. struct efi_mac_address *src_addr,
  1188. struct efi_mac_address *dest_addr, u16 *protocol);
  1189. efi_status_t (EFIAPI *receive)(struct efi_simple_network *this,
  1190. size_t *header_size, size_t *buffer_size, void *buffer,
  1191. struct efi_mac_address *src_addr,
  1192. struct efi_mac_address *dest_addr, u16 *protocol);
  1193. struct efi_event *wait_for_packet;
  1194. struct efi_simple_network_mode *mode;
  1195. /* private fields */
  1196. u32 int_status;
  1197. };
  1198. #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
  1199. EFI_GUID(0x03c4e603, 0xac28, 0x11d3, \
  1200. 0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
  1201. #define EFI_PXE_BASE_CODE_PROTOCOL_REVISION 0x00010000
  1202. #define EFI_PXE_BASE_CODE_MAX_IPCNT 8
  1203. struct efi_pxe_packet {
  1204. u8 packet[1472];
  1205. };
  1206. struct efi_pxe_mode {
  1207. u8 started;
  1208. u8 ipv6_available;
  1209. u8 ipv6_supported;
  1210. u8 using_ipv6;
  1211. u8 bis_supported;
  1212. u8 bis_detected;
  1213. u8 auto_arp;
  1214. u8 send_guid;
  1215. u8 dhcp_discover_valid;
  1216. u8 dhcp_ack_received;
  1217. u8 proxy_offer_received;
  1218. u8 pxe_discover_valid;
  1219. u8 pxe_reply_received;
  1220. u8 pxe_bis_reply_received;
  1221. u8 icmp_error_received;
  1222. u8 tftp_error_received;
  1223. u8 make_callbacks;
  1224. u8 ttl;
  1225. u8 tos;
  1226. u8 pad;
  1227. struct efi_ip_address station_ip;
  1228. struct efi_ip_address subnet_mask;
  1229. struct efi_pxe_packet dhcp_discover;
  1230. struct efi_pxe_packet dhcp_ack;
  1231. struct efi_pxe_packet proxy_offer;
  1232. struct efi_pxe_packet pxe_discover;
  1233. struct efi_pxe_packet pxe_reply;
  1234. };
  1235. struct efi_pxe_base_code_srvlist {
  1236. u16 type;
  1237. u8 accept_any_response;
  1238. u8 reserved;
  1239. struct efi_ip_address ip_addr;
  1240. };
  1241. struct efi_pxe_base_code_discover_info {
  1242. u8 use_m_cast;
  1243. u8 use_b_cast;
  1244. u8 use_u_cast;
  1245. u8 must_use_list;
  1246. struct efi_ip_address server_m_cast_ip;
  1247. u16 ip_cnt;
  1248. struct efi_pxe_base_code_srvlist srv_list[];
  1249. };
  1250. struct efi_pxe_base_code_mtftp_info {
  1251. struct efi_ip_address m_cast_ip;
  1252. u16 cport;
  1253. u16 sport;
  1254. u16 listen_timeout;
  1255. u16 transit_timeout;
  1256. };
  1257. struct efi_pxe_base_code_filter {
  1258. u8 filters;
  1259. u8 ip_cnt;
  1260. u16 reserved;
  1261. struct efi_ip_address ip_list[EFI_PXE_BASE_CODE_MAX_IPCNT];
  1262. };
  1263. struct efi_pxe_base_code_dhcpv4_packet {
  1264. u8 bootp_op_code;
  1265. u8 bootp_hw_type;
  1266. u8 bootp_addr_len;
  1267. u8 bootp_gate_hops;
  1268. u32 bootp_ident;
  1269. u16 bootp_seconds;
  1270. u16 bootp_flags;
  1271. u8 bootp_ci_addr[4];
  1272. u8 bootp_yi_addr[4];
  1273. u8 bootp_si_addr[4];
  1274. u8 bootp_gi_addr[4];
  1275. u8 bootp_hw_addr[16];
  1276. u8 bootp_srv_name[64];
  1277. u8 bootp_boot_file[128];
  1278. u32 dhcp_magick;
  1279. u8 dhcp_options[56];
  1280. };
  1281. struct efi_pxe_base_code_dhcpv6_packet {
  1282. u8 message_type;
  1283. u8 transaction_id[3];
  1284. u8 dhcp_options[1024];
  1285. };
  1286. typedef union {
  1287. u8 raw[1472];
  1288. struct efi_pxe_base_code_dhcpv4_packet dhcpv4;
  1289. struct efi_pxe_base_code_dhcpv6_packet dhcpv6;
  1290. } EFI_PXE_BASE_CODE_PACKET;
  1291. struct efi_pxe_base_code_protocol {
  1292. u64 revision;
  1293. efi_status_t (EFIAPI *start)(struct efi_pxe_base_code_protocol *this,
  1294. u8 use_ipv6);
  1295. efi_status_t (EFIAPI *stop)(struct efi_pxe_base_code_protocol *this);
  1296. efi_status_t (EFIAPI *dhcp)(struct efi_pxe_base_code_protocol *this,
  1297. u8 sort_offers);
  1298. efi_status_t (EFIAPI *discover)(
  1299. struct efi_pxe_base_code_protocol *this,
  1300. u16 type, u16 *layer, u8 bis,
  1301. struct efi_pxe_base_code_discover_info *info);
  1302. efi_status_t (EFIAPI *mtftp)(
  1303. struct efi_pxe_base_code_protocol *this,
  1304. u32 operation, void *buffer_ptr,
  1305. u8 overwrite, efi_uintn_t *buffer_size,
  1306. struct efi_ip_address server_ip, char *filename,
  1307. struct efi_pxe_base_code_mtftp_info *info,
  1308. u8 dont_use_buffer);
  1309. efi_status_t (EFIAPI *udp_write)(
  1310. struct efi_pxe_base_code_protocol *this,
  1311. u16 op_flags, struct efi_ip_address *dest_ip,
  1312. u16 *dest_port,
  1313. struct efi_ip_address *gateway_ip,
  1314. struct efi_ip_address *src_ip, u16 *src_port,
  1315. efi_uintn_t *header_size, void *header_ptr,
  1316. efi_uintn_t *buffer_size, void *buffer_ptr);
  1317. efi_status_t (EFIAPI *udp_read)(
  1318. struct efi_pxe_base_code_protocol *this,
  1319. u16 op_flags, struct efi_ip_address *dest_ip,
  1320. u16 *dest_port, struct efi_ip_address *src_ip,
  1321. u16 *src_port, efi_uintn_t *header_size,
  1322. void *header_ptr, efi_uintn_t *buffer_size,
  1323. void *buffer_ptr);
  1324. efi_status_t (EFIAPI *set_ip_filter)(
  1325. struct efi_pxe_base_code_protocol *this,
  1326. struct efi_pxe_base_code_filter *new_filter);
  1327. efi_status_t (EFIAPI *arp)(struct efi_pxe_base_code_protocol *this,
  1328. struct efi_ip_address *ip_addr,
  1329. struct efi_mac_address *mac_addr);
  1330. efi_status_t (EFIAPI *set_parameters)(
  1331. struct efi_pxe_base_code_protocol *this,
  1332. u8 *new_auto_arp, u8 *new_send_guid,
  1333. u8 *new_ttl, u8 *new_tos,
  1334. u8 *new_make_callback);
  1335. efi_status_t (EFIAPI *set_station_ip)(
  1336. struct efi_pxe_base_code_protocol *this,
  1337. struct efi_ip_address *new_station_ip,
  1338. struct efi_ip_address *new_subnet_mask);
  1339. efi_status_t (EFIAPI *set_packets)(
  1340. struct efi_pxe_base_code_protocol *this,
  1341. u8 *new_dhcp_discover_valid,
  1342. u8 *new_dhcp_ack_received,
  1343. u8 *new_proxy_offer_received,
  1344. u8 *new_pxe_discover_valid,
  1345. u8 *new_pxe_reply_received,
  1346. u8 *new_pxe_bis_reply_received,
  1347. EFI_PXE_BASE_CODE_PACKET *new_dchp_discover,
  1348. EFI_PXE_BASE_CODE_PACKET *new_dhcp_acc,
  1349. EFI_PXE_BASE_CODE_PACKET *new_proxy_offer,
  1350. EFI_PXE_BASE_CODE_PACKET *new_pxe_discover,
  1351. EFI_PXE_BASE_CODE_PACKET *new_pxe_reply,
  1352. EFI_PXE_BASE_CODE_PACKET *new_pxe_bis_reply);
  1353. struct efi_pxe_mode *mode;
  1354. };
  1355. #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
  1356. EFI_GUID(0x964e5b22, 0x6459, 0x11d2, \
  1357. 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  1358. #define EFI_FILE_PROTOCOL_REVISION 0x00010000
  1359. #define EFI_FILE_PROTOCOL_REVISION2 0x00020000
  1360. #define EFI_FILE_PROTOCOL_LATEST_REVISION EFI_FILE_PROTOCOL_REVISION2
  1361. struct efi_file_io_token {
  1362. struct efi_event *event;
  1363. efi_status_t status;
  1364. efi_uintn_t buffer_size;
  1365. void *buffer;};
  1366. struct efi_file_handle {
  1367. u64 rev;
  1368. efi_status_t (EFIAPI *open)(struct efi_file_handle *file,
  1369. struct efi_file_handle **new_handle,
  1370. u16 *file_name, u64 open_mode, u64 attributes);
  1371. efi_status_t (EFIAPI *close)(struct efi_file_handle *file);
  1372. efi_status_t (EFIAPI *delete)(struct efi_file_handle *file);
  1373. efi_status_t (EFIAPI *read)(struct efi_file_handle *file,
  1374. efi_uintn_t *buffer_size, void *buffer);
  1375. efi_status_t (EFIAPI *write)(struct efi_file_handle *file,
  1376. efi_uintn_t *buffer_size, void *buffer);
  1377. efi_status_t (EFIAPI *getpos)(struct efi_file_handle *file,
  1378. u64 *pos);
  1379. efi_status_t (EFIAPI *setpos)(struct efi_file_handle *file,
  1380. u64 pos);
  1381. efi_status_t (EFIAPI *getinfo)(struct efi_file_handle *file,
  1382. const efi_guid_t *info_type, efi_uintn_t *buffer_size,
  1383. void *buffer);
  1384. efi_status_t (EFIAPI *setinfo)(struct efi_file_handle *file,
  1385. const efi_guid_t *info_type, efi_uintn_t buffer_size,
  1386. void *buffer);
  1387. efi_status_t (EFIAPI *flush)(struct efi_file_handle *file);
  1388. efi_status_t (EFIAPI *open_ex)(struct efi_file_handle *file,
  1389. struct efi_file_handle **new_handle,
  1390. u16 *file_name, u64 open_mode, u64 attributes,
  1391. struct efi_file_io_token *token);
  1392. efi_status_t (EFIAPI *read_ex)(struct efi_file_handle *file,
  1393. struct efi_file_io_token *token);
  1394. efi_status_t (EFIAPI *write_ex)(struct efi_file_handle *file,
  1395. struct efi_file_io_token *token);
  1396. efi_status_t (EFIAPI *flush_ex)(struct efi_file_handle *file,
  1397. struct efi_file_io_token *token);
  1398. };
  1399. #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
  1400. struct efi_simple_file_system_protocol {
  1401. u64 rev;
  1402. efi_status_t (EFIAPI *open_volume)(struct efi_simple_file_system_protocol *this,
  1403. struct efi_file_handle **root);
  1404. };
  1405. #define EFI_FILE_INFO_GUID \
  1406. EFI_GUID(0x9576e92, 0x6d3f, 0x11d2, \
  1407. 0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  1408. #define EFI_FILE_SYSTEM_INFO_GUID \
  1409. EFI_GUID(0x09576e93, 0x6d3f, 0x11d2, \
  1410. 0x8e, 0x39, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b)
  1411. #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \
  1412. EFI_GUID(0xdb47d7d3, 0xfe81, 0x11d3, \
  1413. 0x9a, 0x35, 0x00, 0x90, 0x27, 0x3f, 0xC1, 0x4d)
  1414. #define EFI_FILE_MODE_READ 0x0000000000000001
  1415. #define EFI_FILE_MODE_WRITE 0x0000000000000002
  1416. #define EFI_FILE_MODE_CREATE 0x8000000000000000
  1417. #define EFI_FILE_READ_ONLY 0x0000000000000001
  1418. #define EFI_FILE_HIDDEN 0x0000000000000002
  1419. #define EFI_FILE_SYSTEM 0x0000000000000004
  1420. #define EFI_FILE_RESERVED 0x0000000000000008
  1421. #define EFI_FILE_DIRECTORY 0x0000000000000010
  1422. #define EFI_FILE_ARCHIVE 0x0000000000000020
  1423. #define EFI_FILE_VALID_ATTR 0x0000000000000037
  1424. struct efi_file_info {
  1425. u64 size;
  1426. u64 file_size;
  1427. u64 physical_size;
  1428. struct efi_time create_time;
  1429. struct efi_time last_access_time;
  1430. struct efi_time modification_time;
  1431. u64 attribute;
  1432. u16 file_name[0];
  1433. };
  1434. struct efi_file_system_info {
  1435. u64 size;
  1436. u8 read_only;
  1437. u64 volume_size;
  1438. u64 free_space;
  1439. u32 block_size;
  1440. u16 volume_label[0];
  1441. };
  1442. #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
  1443. EFI_GUID(0x18a031ab, 0xb443, 0x4d1a,\
  1444. 0xa5, 0xc0, 0x0c, 0x09, 0x26, 0x1e, 0x9f, 0x71)
  1445. struct efi_driver_binding_protocol {
  1446. efi_status_t (EFIAPI * supported)(
  1447. struct efi_driver_binding_protocol *this,
  1448. efi_handle_t controller_handle,
  1449. struct efi_device_path *remaining_device_path);
  1450. efi_status_t (EFIAPI * start)(
  1451. struct efi_driver_binding_protocol *this,
  1452. efi_handle_t controller_handle,
  1453. struct efi_device_path *remaining_device_path);
  1454. efi_status_t (EFIAPI * stop)(
  1455. struct efi_driver_binding_protocol *this,
  1456. efi_handle_t controller_handle,
  1457. efi_uintn_t number_of_children,
  1458. efi_handle_t *child_handle_buffer);
  1459. u32 version;
  1460. efi_handle_t image_handle;
  1461. efi_handle_t driver_binding_handle;
  1462. };
  1463. /* Deprecated version of the Unicode collation protocol */
  1464. #define EFI_UNICODE_COLLATION_PROTOCOL_GUID \
  1465. EFI_GUID(0x1d85cd7f, 0xf43d, 0x11d2, \
  1466. 0x9a, 0x0c, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d)
  1467. /* Current version of the Unicode collation protocol */
  1468. #define EFI_UNICODE_COLLATION_PROTOCOL2_GUID \
  1469. EFI_GUID(0xa4c751fc, 0x23ae, 0x4c3e, \
  1470. 0x92, 0xe9, 0x49, 0x64, 0xcf, 0x63, 0xf3, 0x49)
  1471. struct efi_unicode_collation_protocol {
  1472. efi_intn_t (EFIAPI *stri_coll)(
  1473. struct efi_unicode_collation_protocol *this, u16 *s1, u16 *s2);
  1474. bool (EFIAPI *metai_match)(struct efi_unicode_collation_protocol *this,
  1475. const u16 *string, const u16 *patter);
  1476. void (EFIAPI *str_lwr)(struct efi_unicode_collation_protocol
  1477. *this, u16 *string);
  1478. void (EFIAPI *str_upr)(struct efi_unicode_collation_protocol *this,
  1479. u16 *string);
  1480. void (EFIAPI *fat_to_str)(struct efi_unicode_collation_protocol *this,
  1481. efi_uintn_t fat_size, char *fat, u16 *string);
  1482. bool (EFIAPI *str_to_fat)(struct efi_unicode_collation_protocol *this,
  1483. const u16 *string, efi_uintn_t fat_size,
  1484. char *fat);
  1485. char *supported_languages;
  1486. };
  1487. struct efi_load_file_protocol {
  1488. efi_status_t (EFIAPI *load_file)(struct efi_load_file_protocol *this,
  1489. struct efi_device_path *file_path,
  1490. bool boot_policy,
  1491. efi_uintn_t *buffer_size,
  1492. void *buffer);
  1493. };
  1494. /* Boot manager load options */
  1495. #define LOAD_OPTION_ACTIVE 0x00000001
  1496. #define LOAD_OPTION_FORCE_RECONNECT 0x00000002
  1497. #define LOAD_OPTION_HIDDEN 0x00000008
  1498. /* All values 0x00000200-0x00001F00 are reserved */
  1499. #define LOAD_OPTION_CATEGORY 0x00001F00
  1500. #define LOAD_OPTION_CATEGORY_BOOT 0x00000000
  1501. #define LOAD_OPTION_CATEGORY_APP 0x00000100
  1502. /*
  1503. * System Resource Table
  1504. */
  1505. /* Firmware Type Definitions */
  1506. #define ESRT_FW_TYPE_UNKNOWN 0x00000000
  1507. #define ESRT_FW_TYPE_SYSTEMFIRMWARE 0x00000001
  1508. #define ESRT_FW_TYPE_DEVICEFIRMWARE 0x00000002
  1509. #define ESRT_FW_TYPE_UEFIDRIVER 0x00000003
  1510. /* Last Attempt Status Values */
  1511. #define LAST_ATTEMPT_STATUS_SUCCESS 0x00000000
  1512. #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL 0x00000001
  1513. #define LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES 0x00000002
  1514. #define LAST_ATTEMPT_STATUS_ERROR_INCORRECT_VERSION 0x00000003
  1515. #define LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT 0x00000004
  1516. #define LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR 0x00000005
  1517. #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_AC 0x00000006
  1518. #define LAST_ATTEMPT_STATUS_ERROR_PWR_EVT_BATT 0x00000007
  1519. #define LAST_ATTEMPT_STATUS_ERROR_UNSATISFIED_DEPENDENCIES 0x00000008
  1520. /*
  1521. * The LastAttemptStatus values of 0x1000 - 0x4000 are reserved for vendor
  1522. * usage.
  1523. */
  1524. #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MIN 0x00001000
  1525. #define LAST_ATTEMPT_STATUS_ERROR_UNSUCCESSFUL_VENDOR_RANGE_MAX 0x00004000
  1526. /* Certificate types in signature database */
  1527. #define EFI_CERT_SHA256_GUID \
  1528. EFI_GUID(0xc1c41626, 0x504c, 0x4092, 0xac, 0xa9, \
  1529. 0x41, 0xf9, 0x36, 0x93, 0x43, 0x28)
  1530. #define EFI_CERT_RSA2048_GUID \
  1531. EFI_GUID(0x3c5766e8, 0x269c, 0x4e34, 0xaa, 0x14, \
  1532. 0xed, 0x77, 0x6e, 0x85, 0xb3, 0xb6)
  1533. #define EFI_CERT_X509_GUID \
  1534. EFI_GUID(0xa5c059a1, 0x94e4, 0x4aa7, 0x87, 0xb5, \
  1535. 0xab, 0x15, 0x5c, 0x2b, 0xf0, 0x72)
  1536. #define EFI_CERT_X509_SHA256_GUID \
  1537. EFI_GUID(0x3bd2a492, 0x96c0, 0x4079, 0xb4, 0x20, \
  1538. 0xfc, 0xf9, 0x8e, 0xf1, 0x03, 0xed)
  1539. #define EFI_CERT_TYPE_PKCS7_GUID \
  1540. EFI_GUID(0x4aafd29d, 0x68df, 0x49ee, 0x8a, 0xa9, \
  1541. 0x34, 0x7d, 0x37, 0x56, 0x65, 0xa7)
  1542. /**
  1543. * win_certificate_uefi_guid - A certificate that encapsulates
  1544. * a GUID-specific signature
  1545. *
  1546. * @hdr: Windows certificate header
  1547. * @cert_type: Certificate type
  1548. * @cert_data: Certificate data
  1549. */
  1550. struct win_certificate_uefi_guid {
  1551. WIN_CERTIFICATE hdr;
  1552. efi_guid_t cert_type;
  1553. u8 cert_data[];
  1554. } __attribute__((__packed__));
  1555. /**
  1556. * efi_variable_authentication_2 - A time-based authentication method
  1557. * descriptor
  1558. *
  1559. * This structure describes an authentication information for
  1560. * a variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS
  1561. * and should be included as part of a variable's value.
  1562. * Only EFI_CERT_TYPE_PKCS7_GUID is accepted.
  1563. *
  1564. * @time_stamp: Descriptor's time stamp
  1565. * @auth_info: Authentication info
  1566. */
  1567. struct efi_variable_authentication_2 {
  1568. struct efi_time time_stamp;
  1569. struct win_certificate_uefi_guid auth_info;
  1570. } __attribute__((__packed__));
  1571. /**
  1572. * efi_signature_data - A format of signature
  1573. *
  1574. * This structure describes a single signature in signature database.
  1575. *
  1576. * @signature_owner: Signature owner
  1577. * @signature_data: Signature data
  1578. */
  1579. struct efi_signature_data {
  1580. efi_guid_t signature_owner;
  1581. u8 signature_data[];
  1582. } __attribute__((__packed__));
  1583. /**
  1584. * efi_signature_list - A format of signature database
  1585. *
  1586. * This structure describes a list of signatures with the same type.
  1587. * An authenticated variable's value is a concatenation of one or more
  1588. * efi_signature_list's.
  1589. *
  1590. * @signature_type: Signature type
  1591. * @signature_list_size: Size of signature list
  1592. * @signature_header_size: Size of signature header
  1593. * @signature_size: Size of signature
  1594. */
  1595. struct efi_signature_list {
  1596. efi_guid_t signature_type;
  1597. u32 signature_list_size;
  1598. u32 signature_header_size;
  1599. u32 signature_size;
  1600. /* u8 signature_header[signature_header_size]; */
  1601. /* struct efi_signature_data signatures[...][signature_size]; */
  1602. } __attribute__((__packed__));
  1603. #endif