efi_api.h 51 KB

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