efi_api.h 62 KB

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