efi_api.h 63 KB

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