efi_api.h 56 KB

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