efiapi.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. #ifndef _EFI_API_H
  2. #define _EFI_API_H
  3. /*++
  4. Copyright (c) 1998 Intel Corporation
  5. Module Name:
  6. efiapi.h
  7. Abstract:
  8. Global EFI runtime & boot service interfaces
  9. Revision History
  10. --*/
  11. //
  12. // EFI Specification Revision
  13. //
  14. #define EFI_SPECIFICATION_MAJOR_REVISION 1
  15. #define EFI_SPECIFICATION_MINOR_REVISION 02
  16. //
  17. // Declare forward referenced data structures
  18. //
  19. INTERFACE_DECL(_EFI_SYSTEM_TABLE);
  20. //
  21. // EFI Memory
  22. //
  23. typedef
  24. EFI_STATUS
  25. (EFIAPI *EFI_ALLOCATE_PAGES) (
  26. IN EFI_ALLOCATE_TYPE Type,
  27. IN EFI_MEMORY_TYPE MemoryType,
  28. IN UINTN NoPages,
  29. OUT EFI_PHYSICAL_ADDRESS *Memory
  30. );
  31. typedef
  32. EFI_STATUS
  33. (EFIAPI *EFI_FREE_PAGES) (
  34. IN EFI_PHYSICAL_ADDRESS Memory,
  35. IN UINTN NoPages
  36. );
  37. typedef
  38. EFI_STATUS
  39. (EFIAPI *EFI_GET_MEMORY_MAP) (
  40. IN OUT UINTN *MemoryMapSize,
  41. IN OUT EFI_MEMORY_DESCRIPTOR *MemoryMap,
  42. OUT UINTN *MapKey,
  43. OUT UINTN *DescriptorSize,
  44. OUT UINT32 *DescriptorVersion
  45. );
  46. #define NextMemoryDescriptor(Ptr,Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) Ptr) + Size))
  47. typedef
  48. EFI_STATUS
  49. (EFIAPI *EFI_ALLOCATE_POOL) (
  50. IN EFI_MEMORY_TYPE PoolType,
  51. IN UINTN Size,
  52. OUT VOID **Buffer
  53. );
  54. typedef
  55. EFI_STATUS
  56. (EFIAPI *EFI_FREE_POOL) (
  57. IN VOID *Buffer
  58. );
  59. typedef
  60. EFI_STATUS
  61. (EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP) (
  62. IN UINTN MemoryMapSize,
  63. IN UINTN DescriptorSize,
  64. IN UINT32 DescriptorVersion,
  65. IN EFI_MEMORY_DESCRIPTOR *VirtualMap
  66. );
  67. #define EFI_OPTIONAL_PTR 0x00000001
  68. #define EFI_INTERNAL_FNC 0x00000002 // Pointer to internal runtime fnc
  69. #define EFI_INTERNAL_PTR 0x00000004 // Pointer to internal runtime data
  70. typedef
  71. EFI_STATUS
  72. (EFIAPI *EFI_CONVERT_POINTER) (
  73. IN UINTN DebugDisposition,
  74. IN OUT VOID **Address
  75. );
  76. //
  77. // EFI Events
  78. //
  79. #define EVT_TIMER 0x80000000
  80. #define EVT_RUNTIME 0x40000000
  81. #define EVT_RUNTIME_CONTEXT 0x20000000
  82. #define EVT_NOTIFY_WAIT 0x00000100
  83. #define EVT_NOTIFY_SIGNAL 0x00000200
  84. #define EVT_SIGNAL_EXIT_BOOT_SERVICES 0x00000201
  85. #define EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE 0x60000202
  86. #define EVT_EFI_SIGNAL_MASK 0x000000FF
  87. #define EVT_EFI_SIGNAL_MAX 4
  88. #define EFI_EVENT_TIMER EVT_TIMER
  89. #define EFI_EVENT_RUNTIME EVT_RUNTIME
  90. #define EFI_EVENT_RUNTIME_CONTEXT EVT_RUNTIME_CONTEXT
  91. #define EFI_EVENT_NOTIFY_WAIT EVT_NOTIFY_WAIT
  92. #define EFI_EVENT_NOTIFY_SIGNAL EVT_NOTIFY_SIGNAL
  93. #define EFI_EVENT_SIGNAL_EXIT_BOOT_SERVICES EVT_SIGNAL_EXIT_BOOT_SERVICES
  94. #define EFI_EVENT_SIGNAL_VIRTUAL_ADDRESS_CHANGE EVT_SIGNAL_VIRTUAL_ADDRESS_CHANGE
  95. #define EFI_EVENT_EFI_SIGNAL_MASK EVT_EFI_SIGNAL_MASK
  96. #define EFI_EVENT_EFI_SIGNAL_MAX EVT_EFI_SIGNAL_MAX
  97. typedef
  98. VOID
  99. (EFIAPI *EFI_EVENT_NOTIFY) (
  100. IN EFI_EVENT Event,
  101. IN VOID *Context
  102. );
  103. typedef
  104. EFI_STATUS
  105. (EFIAPI *EFI_CREATE_EVENT) (
  106. IN UINT32 Type,
  107. IN EFI_TPL NotifyTpl,
  108. IN EFI_EVENT_NOTIFY NotifyFunction,
  109. IN VOID *NotifyContext,
  110. OUT EFI_EVENT *Event
  111. );
  112. typedef enum {
  113. TimerCancel,
  114. TimerPeriodic,
  115. TimerRelative,
  116. TimerTypeMax
  117. } EFI_TIMER_DELAY;
  118. typedef
  119. EFI_STATUS
  120. (EFIAPI *EFI_SET_TIMER) (
  121. IN EFI_EVENT Event,
  122. IN EFI_TIMER_DELAY Type,
  123. IN UINT64 TriggerTime
  124. );
  125. typedef
  126. EFI_STATUS
  127. (EFIAPI *EFI_SIGNAL_EVENT) (
  128. IN EFI_EVENT Event
  129. );
  130. typedef
  131. EFI_STATUS
  132. (EFIAPI *EFI_WAIT_FOR_EVENT) (
  133. IN UINTN NumberOfEvents,
  134. IN EFI_EVENT *Event,
  135. OUT UINTN *Index
  136. );
  137. typedef
  138. EFI_STATUS
  139. (EFIAPI *EFI_CLOSE_EVENT) (
  140. IN EFI_EVENT Event
  141. );
  142. typedef
  143. EFI_STATUS
  144. (EFIAPI *EFI_CHECK_EVENT) (
  145. IN EFI_EVENT Event
  146. );
  147. //
  148. // Task priority level
  149. //
  150. #define TPL_APPLICATION 4
  151. #define TPL_CALLBACK 8
  152. #define TPL_NOTIFY 16
  153. #define TPL_HIGH_LEVEL 31
  154. #define EFI_TPL_APPLICATION TPL_APPLICATION
  155. #define EFI_TPL_CALLBACK TPL_CALLBACK
  156. #define EFI_TPL_NOTIFY TPL_NOTIFY
  157. #define EFI_TPL_HIGH_LEVEL TPL_HIGH_LEVEL
  158. typedef
  159. EFI_TPL
  160. (EFIAPI *EFI_RAISE_TPL) (
  161. IN EFI_TPL NewTpl
  162. );
  163. typedef
  164. VOID
  165. (EFIAPI *EFI_RESTORE_TPL) (
  166. IN EFI_TPL OldTpl
  167. );
  168. //
  169. // EFI platform varibles
  170. //
  171. #define EFI_GLOBAL_VARIABLE \
  172. { 0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C} }
  173. // Variable attributes
  174. #define EFI_VARIABLE_NON_VOLATILE 0x00000001
  175. #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
  176. #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
  177. #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
  178. #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
  179. #define EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS 0x00000020
  180. #define EFI_VARIABLE_APPEND_WRITE 0x00000040
  181. // Variable size limitation
  182. #define EFI_MAXIMUM_VARIABLE_SIZE 1024
  183. typedef
  184. EFI_STATUS
  185. (EFIAPI *EFI_GET_VARIABLE) (
  186. IN CHAR16 *VariableName,
  187. IN EFI_GUID *VendorGuid,
  188. OUT UINT32 *Attributes OPTIONAL,
  189. IN OUT UINTN *DataSize,
  190. OUT VOID *Data
  191. );
  192. typedef
  193. EFI_STATUS
  194. (EFIAPI *EFI_GET_NEXT_VARIABLE_NAME) (
  195. IN OUT UINTN *VariableNameSize,
  196. IN OUT CHAR16 *VariableName,
  197. IN OUT EFI_GUID *VendorGuid
  198. );
  199. typedef
  200. EFI_STATUS
  201. (EFIAPI *EFI_SET_VARIABLE) (
  202. IN CHAR16 *VariableName,
  203. IN EFI_GUID *VendorGuid,
  204. IN UINT32 Attributes,
  205. IN UINTN DataSize,
  206. IN VOID *Data
  207. );
  208. //
  209. // EFI Time
  210. //
  211. typedef struct {
  212. UINT32 Resolution; // 1e-6 parts per million
  213. UINT32 Accuracy; // hertz
  214. BOOLEAN SetsToZero; // Set clears sub-second time
  215. } EFI_TIME_CAPABILITIES;
  216. typedef
  217. EFI_STATUS
  218. (EFIAPI *EFI_GET_TIME) (
  219. OUT EFI_TIME *Time,
  220. OUT EFI_TIME_CAPABILITIES *Capabilities OPTIONAL
  221. );
  222. typedef
  223. EFI_STATUS
  224. (EFIAPI *EFI_SET_TIME) (
  225. IN EFI_TIME *Time
  226. );
  227. typedef
  228. EFI_STATUS
  229. (EFIAPI *EFI_GET_WAKEUP_TIME) (
  230. OUT BOOLEAN *Enabled,
  231. OUT BOOLEAN *Pending,
  232. OUT EFI_TIME *Time
  233. );
  234. typedef
  235. EFI_STATUS
  236. (EFIAPI *EFI_SET_WAKEUP_TIME) (
  237. IN BOOLEAN Enable,
  238. IN EFI_TIME *Time OPTIONAL
  239. );
  240. //
  241. // Image functions
  242. //
  243. // PE32+ Subsystem type for EFI images
  244. #if !defined(IMAGE_SUBSYSTEM_EFI_APPLICATION)
  245. #define IMAGE_SUBSYSTEM_EFI_APPLICATION 10
  246. #define IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER 11
  247. #define IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER 12
  248. #endif
  249. // PE32+ Machine type for EFI images
  250. #if !defined(EFI_IMAGE_MACHINE_IA32)
  251. #define EFI_IMAGE_MACHINE_IA32 0x014c
  252. #endif
  253. #if !defined(EFI_IMAGE_MACHINE_IA64)
  254. #define EFI_IMAGE_MACHINE_IA64 0x0200
  255. #endif
  256. #if !defined(EFI_IMAGE_MACHINE_EBC)
  257. #define EFI_IMAGE_MACHINE_EBC 0x0EBC
  258. #endif
  259. #if !defined(EFI_IMAGE_MACHINE_X64)
  260. #define EFI_IMAGE_MACHINE_X64 0x8664
  261. #endif
  262. #if !defined(EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)
  263. #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2
  264. #endif
  265. #if !defined(EFI_IMAGE_MACHINE_AARCH64)
  266. #define EFI_IMAGE_MACHINE_AARCH64 0xAA64
  267. #endif
  268. // Image Entry prototype
  269. typedef
  270. EFI_STATUS
  271. (EFIAPI *EFI_IMAGE_ENTRY_POINT) (
  272. IN EFI_HANDLE ImageHandle,
  273. IN struct _EFI_SYSTEM_TABLE *SystemTable
  274. );
  275. typedef
  276. EFI_STATUS
  277. (EFIAPI *EFI_IMAGE_LOAD) (
  278. IN BOOLEAN BootPolicy,
  279. IN EFI_HANDLE ParentImageHandle,
  280. IN EFI_DEVICE_PATH *FilePath,
  281. IN VOID *SourceBuffer OPTIONAL,
  282. IN UINTN SourceSize,
  283. OUT EFI_HANDLE *ImageHandle
  284. );
  285. typedef
  286. EFI_STATUS
  287. (EFIAPI *EFI_IMAGE_START) (
  288. IN EFI_HANDLE ImageHandle,
  289. OUT UINTN *ExitDataSize,
  290. OUT CHAR16 **ExitData OPTIONAL
  291. );
  292. typedef
  293. EFI_STATUS
  294. (EFIAPI *EFI_EXIT) (
  295. IN EFI_HANDLE ImageHandle,
  296. IN EFI_STATUS ExitStatus,
  297. IN UINTN ExitDataSize,
  298. IN CHAR16 *ExitData OPTIONAL
  299. );
  300. // Image handle
  301. /*#define LOADED_IMAGE_PROTOCOL \
  302. { 0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B} }
  303. #define EFI_IMAGE_INFORMATION_REVISION 0x1000
  304. typedef struct {
  305. UINT32 Revision;
  306. EFI_HANDLE ParentHandle;
  307. struct _EFI_SYSTEM_TABLE *SystemTable;
  308. // Source location of image
  309. EFI_HANDLE DeviceHandle;
  310. EFI_DEVICE_PATH *FilePath;
  311. VOID *Reserved;
  312. // Images load options
  313. UINT32 LoadOptionsSize;
  314. VOID *LoadOptions;
  315. // Location of where image was loaded
  316. VOID *ImageBase;
  317. UINT64 ImageSize;
  318. EFI_MEMORY_TYPE ImageCodeType;
  319. EFI_MEMORY_TYPE ImageDataType;
  320. // If the driver image supports a dynamic unload request
  321. EFI_IMAGE_UNLOAD Unload;
  322. } EFI_LOADED_IMAGE;*/
  323. typedef
  324. EFI_STATUS
  325. (EFIAPI *EFI_EXIT_BOOT_SERVICES) (
  326. IN EFI_HANDLE ImageHandle,
  327. IN UINTN MapKey
  328. );
  329. //
  330. // Misc
  331. //
  332. typedef
  333. EFI_STATUS
  334. (EFIAPI *EFI_STALL) (
  335. IN UINTN Microseconds
  336. );
  337. typedef
  338. EFI_STATUS
  339. (EFIAPI *EFI_SET_WATCHDOG_TIMER) (
  340. IN UINTN Timeout,
  341. IN UINT64 WatchdogCode,
  342. IN UINTN DataSize,
  343. IN CHAR16 *WatchdogData OPTIONAL
  344. );
  345. typedef
  346. EFI_STATUS
  347. (EFIAPI *EFI_CONNECT_CONTROLLER) (
  348. IN EFI_HANDLE ControllerHandle,
  349. IN EFI_HANDLE *DriverImageHandle OPTIONAL,
  350. IN EFI_DEVICE_PATH *RemainingDevicePath OPTIONAL,
  351. IN BOOLEAN Recursive
  352. );
  353. typedef
  354. EFI_STATUS
  355. (EFIAPI *EFI_DISCONNECT_CONTROLLER) (
  356. IN EFI_HANDLE ControllerHandle,
  357. IN EFI_HANDLE DriverImageHandle OPTIONAL,
  358. IN EFI_HANDLE ChildHandle OPTIONAL
  359. );
  360. #define EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL 0x00000001
  361. #define EFI_OPEN_PROTOCOL_GET_PROTOCOL 0x00000002
  362. #define EFI_OPEN_PROTOCOL_TEST_PROTOCOL 0x00000004
  363. #define EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER 0x00000008
  364. #define EFI_OPEN_PROTOCOL_BY_DRIVER 0x00000010
  365. #define EFI_OPEN_PROTOCOL_EXCLUSIVE 0x00000020
  366. typedef
  367. EFI_STATUS
  368. (EFIAPI *EFI_OPEN_PROTOCOL) (
  369. IN EFI_HANDLE Handle,
  370. IN EFI_GUID *Protocol,
  371. OUT VOID **Interface OPTIONAL,
  372. IN EFI_HANDLE AgentHandle,
  373. IN EFI_HANDLE ControllerHandle,
  374. IN UINT32 Attributes
  375. );
  376. typedef
  377. EFI_STATUS
  378. (EFIAPI *EFI_CLOSE_PROTOCOL) (
  379. IN EFI_HANDLE Handle,
  380. IN EFI_GUID *Protocol,
  381. IN EFI_HANDLE AgentHandle,
  382. IN EFI_HANDLE ControllerHandle
  383. );
  384. typedef struct {
  385. EFI_HANDLE AgentHandle;
  386. EFI_HANDLE ControllerHandle;
  387. UINT32 Attributes;
  388. UINT32 OpenCount;
  389. } EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;
  390. typedef
  391. EFI_STATUS
  392. (EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION) (
  393. IN EFI_HANDLE Handle,
  394. IN EFI_GUID *Protocol,
  395. OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,
  396. OUT UINTN *EntryCount
  397. );
  398. typedef
  399. EFI_STATUS
  400. (EFIAPI *EFI_PROTOCOLS_PER_HANDLE) (
  401. IN EFI_HANDLE Handle,
  402. OUT EFI_GUID ***ProtocolBuffer,
  403. OUT UINTN *ProtocolBufferCount
  404. );
  405. typedef enum {
  406. AllHandles,
  407. ByRegisterNotify,
  408. ByProtocol
  409. } EFI_LOCATE_SEARCH_TYPE;
  410. typedef
  411. EFI_STATUS
  412. (EFIAPI *EFI_LOCATE_HANDLE_BUFFER) (
  413. IN EFI_LOCATE_SEARCH_TYPE SearchType,
  414. IN EFI_GUID *Protocol OPTIONAL,
  415. IN VOID *SearchKey OPTIONAL,
  416. IN OUT UINTN *NoHandles,
  417. OUT EFI_HANDLE **Buffer
  418. );
  419. typedef
  420. EFI_STATUS
  421. (EFIAPI *EFI_LOCATE_PROTOCOL) (
  422. IN EFI_GUID *Protocol,
  423. IN VOID *Registration OPTIONAL,
  424. OUT VOID **Interface
  425. );
  426. typedef
  427. EFI_STATUS
  428. (EFIAPI *EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
  429. IN OUT EFI_HANDLE *Handle,
  430. ...
  431. );
  432. typedef
  433. EFI_STATUS
  434. (EFIAPI *EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES) (
  435. IN OUT EFI_HANDLE Handle,
  436. ...
  437. );
  438. typedef
  439. EFI_STATUS
  440. (EFIAPI *EFI_CALCULATE_CRC32) (
  441. IN VOID *Data,
  442. IN UINTN DataSize,
  443. OUT UINT32 *Crc32
  444. );
  445. typedef
  446. VOID
  447. (EFIAPI *EFI_COPY_MEM) (
  448. IN VOID *Destination,
  449. IN VOID *Source,
  450. IN UINTN Length
  451. );
  452. typedef
  453. VOID
  454. (EFIAPI *EFI_SET_MEM) (
  455. IN VOID *Buffer,
  456. IN UINTN Size,
  457. IN UINT8 Value
  458. );
  459. typedef
  460. EFI_STATUS
  461. (EFIAPI *EFI_CREATE_EVENT_EX) (
  462. IN UINT32 Type,
  463. IN EFI_TPL NotifyTpl,
  464. IN EFI_EVENT_NOTIFY NotifyFunction OPTIONAL,
  465. IN const VOID *NotifyContext OPTIONAL,
  466. IN const EFI_GUID EventGroup OPTIONAL,
  467. OUT EFI_EVENT *Event
  468. );
  469. typedef enum {
  470. EfiResetCold,
  471. EfiResetWarm,
  472. EfiResetShutdown
  473. } EFI_RESET_TYPE;
  474. typedef
  475. EFI_STATUS
  476. (EFIAPI *EFI_RESET_SYSTEM) (
  477. IN EFI_RESET_TYPE ResetType,
  478. IN EFI_STATUS ResetStatus,
  479. IN UINTN DataSize,
  480. IN CHAR16 *ResetData OPTIONAL
  481. );
  482. typedef
  483. EFI_STATUS
  484. (EFIAPI *EFI_GET_NEXT_MONOTONIC_COUNT) (
  485. OUT UINT64 *Count
  486. );
  487. typedef
  488. EFI_STATUS
  489. (EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT) (
  490. OUT UINT32 *HighCount
  491. );
  492. typedef struct {
  493. UINT64 Length;
  494. union {
  495. EFI_PHYSICAL_ADDRESS DataBlock;
  496. EFI_PHYSICAL_ADDRESS ContinuationPointer;
  497. } Union;
  498. } EFI_CAPSULE_BLOCK_DESCRIPTOR;
  499. typedef struct {
  500. EFI_GUID CapsuleGuid;
  501. UINT32 HeaderSize;
  502. UINT32 Flags;
  503. UINT32 CapsuleImageSize;
  504. } EFI_CAPSULE_HEADER;
  505. #define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
  506. #define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
  507. #define CAPSULE_FLAGS_INITIATE_RESET 0x00040000
  508. typedef
  509. EFI_STATUS
  510. (EFIAPI *EFI_UPDATE_CAPSULE) (
  511. IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
  512. IN UINTN CapsuleCount,
  513. IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
  514. );
  515. typedef
  516. EFI_STATUS
  517. (EFIAPI *EFI_QUERY_CAPSULE_CAPABILITIES) (
  518. IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
  519. IN UINTN CapsuleCount,
  520. OUT UINT64 *MaximumCapsuleSize,
  521. OUT EFI_RESET_TYPE *ResetType
  522. );
  523. typedef
  524. EFI_STATUS
  525. (EFIAPI *EFI_QUERY_VARIABLE_INFO) (
  526. IN UINT32 Attributes,
  527. OUT UINT64 *MaximumVariableStorageSize,
  528. OUT UINT64 *RemainingVariableStorageSize,
  529. OUT UINT64 *MaximumVariableSize
  530. );
  531. //
  532. // Protocol handler functions
  533. //
  534. typedef enum {
  535. EFI_NATIVE_INTERFACE,
  536. EFI_PCODE_INTERFACE
  537. } EFI_INTERFACE_TYPE;
  538. typedef
  539. EFI_STATUS
  540. (EFIAPI *EFI_INSTALL_PROTOCOL_INTERFACE) (
  541. IN OUT EFI_HANDLE *Handle,
  542. IN EFI_GUID *Protocol,
  543. IN EFI_INTERFACE_TYPE InterfaceType,
  544. IN VOID *Interface
  545. );
  546. typedef
  547. EFI_STATUS
  548. (EFIAPI *EFI_REINSTALL_PROTOCOL_INTERFACE) (
  549. IN EFI_HANDLE Handle,
  550. IN EFI_GUID *Protocol,
  551. IN VOID *OldInterface,
  552. IN VOID *NewInterface
  553. );
  554. typedef
  555. EFI_STATUS
  556. (EFIAPI *EFI_UNINSTALL_PROTOCOL_INTERFACE) (
  557. IN EFI_HANDLE Handle,
  558. IN EFI_GUID *Protocol,
  559. IN VOID *Interface
  560. );
  561. typedef
  562. EFI_STATUS
  563. (EFIAPI *EFI_HANDLE_PROTOCOL) (
  564. IN EFI_HANDLE Handle,
  565. IN EFI_GUID *Protocol,
  566. OUT VOID **Interface
  567. );
  568. typedef
  569. EFI_STATUS
  570. (EFIAPI *EFI_REGISTER_PROTOCOL_NOTIFY) (
  571. IN EFI_GUID *Protocol,
  572. IN EFI_EVENT Event,
  573. OUT VOID **Registration
  574. );
  575. typedef
  576. EFI_STATUS
  577. (EFIAPI *EFI_LOCATE_HANDLE) (
  578. IN EFI_LOCATE_SEARCH_TYPE SearchType,
  579. IN EFI_GUID *Protocol OPTIONAL,
  580. IN VOID *SearchKey OPTIONAL,
  581. IN OUT UINTN *BufferSize,
  582. OUT EFI_HANDLE *Buffer
  583. );
  584. typedef
  585. EFI_STATUS
  586. (EFIAPI *EFI_LOCATE_DEVICE_PATH) (
  587. IN EFI_GUID *Protocol,
  588. IN OUT EFI_DEVICE_PATH **DevicePath,
  589. OUT EFI_HANDLE *Device
  590. );
  591. typedef
  592. EFI_STATUS
  593. (EFIAPI *EFI_INSTALL_CONFIGURATION_TABLE) (
  594. IN EFI_GUID *Guid,
  595. IN VOID *Table
  596. );
  597. typedef
  598. EFI_STATUS
  599. (EFIAPI *EFI_RESERVED_SERVICE) (
  600. );
  601. //
  602. // Standard EFI table header
  603. //
  604. typedef struct _EFI_TABLE_HEADER {
  605. UINT64 Signature;
  606. UINT32 Revision;
  607. UINT32 HeaderSize;
  608. UINT32 CRC32;
  609. UINT32 Reserved;
  610. } EFI_TABLE_HEADER;
  611. //
  612. // EFI Runtime Serivces Table
  613. //
  614. #define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552
  615. #define EFI_RUNTIME_SERVICES_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
  616. typedef struct {
  617. EFI_TABLE_HEADER Hdr;
  618. //
  619. // Time services
  620. //
  621. EFI_GET_TIME GetTime;
  622. EFI_SET_TIME SetTime;
  623. EFI_GET_WAKEUP_TIME GetWakeupTime;
  624. EFI_SET_WAKEUP_TIME SetWakeupTime;
  625. //
  626. // Virtual memory services
  627. //
  628. EFI_SET_VIRTUAL_ADDRESS_MAP SetVirtualAddressMap;
  629. EFI_CONVERT_POINTER ConvertPointer;
  630. //
  631. // Variable serviers
  632. //
  633. EFI_GET_VARIABLE GetVariable;
  634. EFI_GET_NEXT_VARIABLE_NAME GetNextVariableName;
  635. EFI_SET_VARIABLE SetVariable;
  636. //
  637. // Misc
  638. //
  639. EFI_GET_NEXT_HIGH_MONO_COUNT GetNextHighMonotonicCount;
  640. EFI_RESET_SYSTEM ResetSystem;
  641. EFI_UPDATE_CAPSULE UpdateCapsule;
  642. EFI_QUERY_CAPSULE_CAPABILITIES QueryCapsuleCapabilities;
  643. EFI_QUERY_VARIABLE_INFO QueryVariableInfo;
  644. } EFI_RUNTIME_SERVICES;
  645. //
  646. // EFI Boot Services Table
  647. //
  648. #define EFI_BOOT_SERVICES_SIGNATURE 0x56524553544f4f42
  649. #define EFI_BOOT_SERVICES_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
  650. typedef struct _EFI_BOOT_SERVICES {
  651. EFI_TABLE_HEADER Hdr;
  652. //
  653. // Task priority functions
  654. //
  655. EFI_RAISE_TPL RaiseTPL;
  656. EFI_RESTORE_TPL RestoreTPL;
  657. //
  658. // Memory functions
  659. //
  660. EFI_ALLOCATE_PAGES AllocatePages;
  661. EFI_FREE_PAGES FreePages;
  662. EFI_GET_MEMORY_MAP GetMemoryMap;
  663. EFI_ALLOCATE_POOL AllocatePool;
  664. EFI_FREE_POOL FreePool;
  665. //
  666. // Event & timer functions
  667. //
  668. EFI_CREATE_EVENT CreateEvent;
  669. EFI_SET_TIMER SetTimer;
  670. EFI_WAIT_FOR_EVENT WaitForEvent;
  671. EFI_SIGNAL_EVENT SignalEvent;
  672. EFI_CLOSE_EVENT CloseEvent;
  673. EFI_CHECK_EVENT CheckEvent;
  674. //
  675. // Protocol handler functions
  676. //
  677. EFI_INSTALL_PROTOCOL_INTERFACE InstallProtocolInterface;
  678. EFI_REINSTALL_PROTOCOL_INTERFACE ReinstallProtocolInterface;
  679. EFI_UNINSTALL_PROTOCOL_INTERFACE UninstallProtocolInterface;
  680. EFI_HANDLE_PROTOCOL HandleProtocol;
  681. EFI_HANDLE_PROTOCOL PCHandleProtocol;
  682. EFI_REGISTER_PROTOCOL_NOTIFY RegisterProtocolNotify;
  683. EFI_LOCATE_HANDLE LocateHandle;
  684. EFI_LOCATE_DEVICE_PATH LocateDevicePath;
  685. EFI_INSTALL_CONFIGURATION_TABLE InstallConfigurationTable;
  686. //
  687. // Image functions
  688. //
  689. EFI_IMAGE_LOAD LoadImage;
  690. EFI_IMAGE_START StartImage;
  691. EFI_EXIT Exit;
  692. EFI_IMAGE_UNLOAD UnloadImage;
  693. EFI_EXIT_BOOT_SERVICES ExitBootServices;
  694. //
  695. // Misc functions
  696. //
  697. EFI_GET_NEXT_MONOTONIC_COUNT GetNextMonotonicCount;
  698. EFI_STALL Stall;
  699. EFI_SET_WATCHDOG_TIMER SetWatchdogTimer;
  700. //
  701. // DriverSupport Services
  702. //
  703. EFI_CONNECT_CONTROLLER ConnectController;
  704. EFI_DISCONNECT_CONTROLLER DisconnectController;
  705. //
  706. // Open and Close Protocol Services
  707. //
  708. EFI_OPEN_PROTOCOL OpenProtocol;
  709. EFI_CLOSE_PROTOCOL CloseProtocol;
  710. EFI_OPEN_PROTOCOL_INFORMATION OpenProtocolInformation;
  711. //
  712. // Library Services
  713. //
  714. EFI_PROTOCOLS_PER_HANDLE ProtocolsPerHandle;
  715. EFI_LOCATE_HANDLE_BUFFER LocateHandleBuffer;
  716. EFI_LOCATE_PROTOCOL LocateProtocol;
  717. EFI_INSTALL_MULTIPLE_PROTOCOL_INTERFACES InstallMultipleProtocolInterfaces;
  718. EFI_UNINSTALL_MULTIPLE_PROTOCOL_INTERFACES UninstallMultipleProtocolInterfaces;
  719. //
  720. // 32-bit CRC Services
  721. //
  722. EFI_CALCULATE_CRC32 CalculateCrc32;
  723. //
  724. // Misc Services
  725. //
  726. EFI_COPY_MEM CopyMem;
  727. EFI_SET_MEM SetMem;
  728. EFI_CREATE_EVENT_EX CreateEventEx;
  729. } EFI_BOOT_SERVICES;
  730. //
  731. // EFI Configuration Table and GUID definitions
  732. //
  733. #define MPS_TABLE_GUID \
  734. { 0xeb9d2d2f, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  735. #define ACPI_TABLE_GUID \
  736. { 0xeb9d2d30, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  737. #define ACPI_20_TABLE_GUID \
  738. { 0x8868e871, 0xe4f1, 0x11d3, {0xbc, 0x22, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81} }
  739. #define SMBIOS_TABLE_GUID \
  740. { 0xeb9d2d31, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  741. #define SMBIOS3_TABLE_GUID \
  742. { 0xf2fd1544, 0x9794, 0x4a2c, {0x99, 0x2e, 0xe5, 0xbb, 0xcf, 0x20, 0xe3, 0x94} }
  743. #define SAL_SYSTEM_TABLE_GUID \
  744. { 0xeb9d2d32, 0x2d88, 0x11d3, {0x9a, 0x16, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  745. typedef struct _EFI_CONFIGURATION_TABLE {
  746. EFI_GUID VendorGuid;
  747. VOID *VendorTable;
  748. } EFI_CONFIGURATION_TABLE;
  749. //
  750. // EFI System Table
  751. //
  752. #define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249
  753. #define EFI_SYSTEM_TABLE_REVISION (EFI_SPECIFICATION_MAJOR_REVISION<<16) | (EFI_SPECIFICATION_MINOR_REVISION)
  754. typedef struct _EFI_SYSTEM_TABLE {
  755. EFI_TABLE_HEADER Hdr;
  756. CHAR16 *FirmwareVendor;
  757. UINT32 FirmwareRevision;
  758. EFI_HANDLE ConsoleInHandle;
  759. SIMPLE_INPUT_INTERFACE *ConIn;
  760. EFI_HANDLE ConsoleOutHandle;
  761. SIMPLE_TEXT_OUTPUT_INTERFACE *ConOut;
  762. EFI_HANDLE StandardErrorHandle;
  763. SIMPLE_TEXT_OUTPUT_INTERFACE *StdErr;
  764. EFI_RUNTIME_SERVICES *RuntimeServices;
  765. EFI_BOOT_SERVICES *BootServices;
  766. UINTN NumberOfTableEntries;
  767. EFI_CONFIGURATION_TABLE *ConfigurationTable;
  768. } EFI_SYSTEM_TABLE;
  769. #endif