efi_api.h 68 KB

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