efi_api.h 62 KB

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