efi_api.h 65 KB

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