efi_api.h 56 KB

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