efiprot.h 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221
  1. #ifndef _EFI_PROT_H
  2. #define _EFI_PROT_H
  3. /*++
  4. Copyright (c) 1998 Intel Corporation
  5. Module Name:
  6. efiprot.h
  7. Abstract:
  8. EFI Protocols
  9. Revision History
  10. --*/
  11. //
  12. // FPSWA library protocol
  13. //
  14. #define EFI_FPSWA_PROTOCOL_GUID \
  15. { 0xc41b6531, 0x97b9, 0x11d3, {0x9a, 0x29, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  16. #define FPSWA_PROTOCOL EFI_FPSWA_PROTOCOL_GUID
  17. //
  18. // Device Path protocol
  19. //
  20. #define EFI_DEVICE_PATH_PROTOCOL_GUID \
  21. { 0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  22. #define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID
  23. //
  24. // Block IO protocol
  25. //
  26. #define EFI_BLOCK_IO_PROTOCOL_GUID \
  27. { 0x964e5b21, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  28. #define BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL_GUID
  29. #define EFI_BLOCK_IO_PROTOCOL_REVISION 0x00010000
  30. #define EFI_BLOCK_IO_PROTOCOL_REVISION2 0x00020001
  31. #define EFI_BLOCK_IO_PROTOCOL_REVISION3 ((2<<16) | 31)
  32. #define EFI_BLOCK_IO_INTERFACE_REVISION EFI_BLOCK_IO_PROTOCOL_REVISION
  33. #define EFI_BLOCK_IO_INTERFACE_REVISION2 EFI_BLOCK_IO_PROTOCOL_REVISION2
  34. #define EFI_BLOCK_IO_INTERFACE_REVISION3 EFI_BLOCK_IO_PROTOCOL_REVISION3
  35. INTERFACE_DECL(_EFI_BLOCK_IO_PROTOCOL);
  36. typedef
  37. EFI_STATUS
  38. (EFIAPI *EFI_BLOCK_RESET) (
  39. IN struct _EFI_BLOCK_IO_PROTOCOL *This,
  40. IN BOOLEAN ExtendedVerification
  41. );
  42. typedef
  43. EFI_STATUS
  44. (EFIAPI *EFI_BLOCK_READ) (
  45. IN struct _EFI_BLOCK_IO_PROTOCOL *This,
  46. IN UINT32 MediaId,
  47. IN EFI_LBA LBA,
  48. IN UINTN BufferSize,
  49. OUT VOID *Buffer
  50. );
  51. typedef
  52. EFI_STATUS
  53. (EFIAPI *EFI_BLOCK_WRITE) (
  54. IN struct _EFI_BLOCK_IO_PROTOCOL *This,
  55. IN UINT32 MediaId,
  56. IN EFI_LBA LBA,
  57. IN UINTN BufferSize,
  58. IN VOID *Buffer
  59. );
  60. typedef
  61. EFI_STATUS
  62. (EFIAPI *EFI_BLOCK_FLUSH) (
  63. IN struct _EFI_BLOCK_IO_PROTOCOL *This
  64. );
  65. typedef struct {
  66. UINT32 MediaId;
  67. BOOLEAN RemovableMedia;
  68. BOOLEAN MediaPresent;
  69. BOOLEAN LogicalPartition;
  70. BOOLEAN ReadOnly;
  71. BOOLEAN WriteCaching;
  72. UINT32 BlockSize;
  73. UINT32 IoAlign;
  74. EFI_LBA LastBlock;
  75. /* revision 2 */
  76. EFI_LBA LowestAlignedLba;
  77. UINT32 LogicalBlocksPerPhysicalBlock;
  78. /* revision 3 */
  79. UINT32 OptimalTransferLengthGranularity;
  80. } EFI_BLOCK_IO_MEDIA;
  81. typedef struct _EFI_BLOCK_IO_PROTOCOL {
  82. UINT64 Revision;
  83. EFI_BLOCK_IO_MEDIA *Media;
  84. EFI_BLOCK_RESET Reset;
  85. EFI_BLOCK_READ ReadBlocks;
  86. EFI_BLOCK_WRITE WriteBlocks;
  87. EFI_BLOCK_FLUSH FlushBlocks;
  88. } EFI_BLOCK_IO_PROTOCOL;
  89. typedef struct _EFI_BLOCK_IO_PROTOCOL _EFI_BLOCK_IO;
  90. typedef EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO;
  91. //
  92. // Disk Block IO protocol
  93. //
  94. #define EFI_DISK_IO_PROTOCOL_GUID \
  95. { 0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  96. #define DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL_GUID
  97. #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000
  98. #define EFI_DISK_IO_INTERFACE_REVISION EFI_DISK_IO_PROTOCOL_REVISION
  99. INTERFACE_DECL(_EFI_DISK_IO_PROTOCOL);
  100. typedef
  101. EFI_STATUS
  102. (EFIAPI *EFI_DISK_READ) (
  103. IN struct _EFI_DISK_IO_PROTOCOL *This,
  104. IN UINT32 MediaId,
  105. IN UINT64 Offset,
  106. IN UINTN BufferSize,
  107. OUT VOID *Buffer
  108. );
  109. typedef
  110. EFI_STATUS
  111. (EFIAPI *EFI_DISK_WRITE) (
  112. IN struct _EFI_DISK_IO_PROTOCOL *This,
  113. IN UINT32 MediaId,
  114. IN UINT64 Offset,
  115. IN UINTN BufferSize,
  116. IN VOID *Buffer
  117. );
  118. typedef struct _EFI_DISK_IO_PROTOCOL {
  119. UINT64 Revision;
  120. EFI_DISK_READ ReadDisk;
  121. EFI_DISK_WRITE WriteDisk;
  122. } EFI_DISK_IO_PROTOCOL;
  123. typedef struct _EFI_DISK_IO_PROTOCOL _EFI_DISK_IO;
  124. typedef EFI_DISK_IO_PROTOCOL EFI_DISK_IO;
  125. //
  126. // Simple file system protocol
  127. //
  128. #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID \
  129. { 0x964e5b22, 0x6459, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  130. #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID
  131. INTERFACE_DECL(_EFI_SIMPLE_FILE_SYSTEM_PROTOCOL);
  132. INTERFACE_DECL(_EFI_FILE_HANDLE);
  133. typedef
  134. EFI_STATUS
  135. (EFIAPI *EFI_VOLUME_OPEN) (
  136. IN struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *This,
  137. OUT struct _EFI_FILE_HANDLE **Root
  138. );
  139. #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000
  140. #define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION
  141. typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {
  142. UINT64 Revision;
  143. EFI_VOLUME_OPEN OpenVolume;
  144. } EFI_SIMPLE_FILE_SYSTEM_PROTOCOL;
  145. typedef struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL _EFI_FILE_IO_INTERFACE;
  146. typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE;
  147. //
  148. //
  149. //
  150. typedef
  151. EFI_STATUS
  152. (EFIAPI *EFI_FILE_OPEN) (
  153. IN struct _EFI_FILE_HANDLE *File,
  154. OUT struct _EFI_FILE_HANDLE **NewHandle,
  155. IN CHAR16 *FileName,
  156. IN UINT64 OpenMode,
  157. IN UINT64 Attributes
  158. );
  159. // Open modes
  160. #define EFI_FILE_MODE_READ 0x0000000000000001
  161. #define EFI_FILE_MODE_WRITE 0x0000000000000002
  162. #define EFI_FILE_MODE_CREATE 0x8000000000000000
  163. // File attributes
  164. #define EFI_FILE_READ_ONLY 0x0000000000000001
  165. #define EFI_FILE_HIDDEN 0x0000000000000002
  166. #define EFI_FILE_SYSTEM 0x0000000000000004
  167. #define EFI_FILE_RESERVIED 0x0000000000000008
  168. #define EFI_FILE_DIRECTORY 0x0000000000000010
  169. #define EFI_FILE_ARCHIVE 0x0000000000000020
  170. #define EFI_FILE_VALID_ATTR 0x0000000000000037
  171. typedef
  172. EFI_STATUS
  173. (EFIAPI *EFI_FILE_CLOSE) (
  174. IN struct _EFI_FILE_HANDLE *File
  175. );
  176. typedef
  177. EFI_STATUS
  178. (EFIAPI *EFI_FILE_DELETE) (
  179. IN struct _EFI_FILE_HANDLE *File
  180. );
  181. typedef
  182. EFI_STATUS
  183. (EFIAPI *EFI_FILE_READ) (
  184. IN struct _EFI_FILE_HANDLE *File,
  185. IN OUT UINTN *BufferSize,
  186. OUT VOID *Buffer
  187. );
  188. typedef
  189. EFI_STATUS
  190. (EFIAPI *EFI_FILE_WRITE) (
  191. IN struct _EFI_FILE_HANDLE *File,
  192. IN OUT UINTN *BufferSize,
  193. IN VOID *Buffer
  194. );
  195. typedef
  196. EFI_STATUS
  197. (EFIAPI *EFI_FILE_SET_POSITION) (
  198. IN struct _EFI_FILE_HANDLE *File,
  199. IN UINT64 Position
  200. );
  201. typedef
  202. EFI_STATUS
  203. (EFIAPI *EFI_FILE_GET_POSITION) (
  204. IN struct _EFI_FILE_HANDLE *File,
  205. OUT UINT64 *Position
  206. );
  207. typedef
  208. EFI_STATUS
  209. (EFIAPI *EFI_FILE_GET_INFO) (
  210. IN struct _EFI_FILE_HANDLE *File,
  211. IN EFI_GUID *InformationType,
  212. IN OUT UINTN *BufferSize,
  213. OUT VOID *Buffer
  214. );
  215. typedef
  216. EFI_STATUS
  217. (EFIAPI *EFI_FILE_SET_INFO) (
  218. IN struct _EFI_FILE_HANDLE *File,
  219. IN EFI_GUID *InformationType,
  220. IN UINTN BufferSize,
  221. IN VOID *Buffer
  222. );
  223. typedef
  224. EFI_STATUS
  225. (EFIAPI *EFI_FILE_FLUSH) (
  226. IN struct _EFI_FILE_HANDLE *File
  227. );
  228. #define EFI_FILE_HANDLE_REVISION 0x00010000
  229. typedef struct _EFI_FILE_HANDLE {
  230. UINT64 Revision;
  231. EFI_FILE_OPEN Open;
  232. EFI_FILE_CLOSE Close;
  233. EFI_FILE_DELETE Delete;
  234. EFI_FILE_READ Read;
  235. EFI_FILE_WRITE Write;
  236. EFI_FILE_GET_POSITION GetPosition;
  237. EFI_FILE_SET_POSITION SetPosition;
  238. EFI_FILE_GET_INFO GetInfo;
  239. EFI_FILE_SET_INFO SetInfo;
  240. EFI_FILE_FLUSH Flush;
  241. } EFI_FILE, *EFI_FILE_HANDLE;
  242. //
  243. // File information types
  244. //
  245. #define EFI_FILE_INFO_ID \
  246. { 0x9576e92, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  247. typedef struct {
  248. UINT64 Size;
  249. UINT64 FileSize;
  250. UINT64 PhysicalSize;
  251. EFI_TIME CreateTime;
  252. EFI_TIME LastAccessTime;
  253. EFI_TIME ModificationTime;
  254. UINT64 Attribute;
  255. CHAR16 FileName[1];
  256. } EFI_FILE_INFO;
  257. //
  258. // The FileName field of the EFI_FILE_INFO data structure is variable length.
  259. // Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to
  260. // be the size of the data structure without the FileName field. The following macro
  261. // computes this size correctly no matter how big the FileName array is declared.
  262. // This is required to make the EFI_FILE_INFO data structure ANSI compilant.
  263. //
  264. #define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET(EFI_FILE_INFO,FileName)
  265. #define EFI_FILE_SYSTEM_INFO_ID \
  266. { 0x9576e93, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  267. typedef struct {
  268. UINT64 Size;
  269. BOOLEAN ReadOnly;
  270. UINT64 VolumeSize;
  271. UINT64 FreeSpace;
  272. UINT32 BlockSize;
  273. CHAR16 VolumeLabel[1];
  274. } EFI_FILE_SYSTEM_INFO;
  275. //
  276. // The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.
  277. // Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs
  278. // to be the size of the data structure without the VolumeLable field. The following macro
  279. // computes this size correctly no matter how big the VolumeLable array is declared.
  280. // This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.
  281. //
  282. #define SIZE_OF_EFI_FILE_SYSTEM_INFO EFI_FIELD_OFFSET(EFI_FILE_SYSTEM_INFO,VolumeLabel)
  283. #define EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID \
  284. { 0xDB47D7D3,0xFE81, 0x11d3, {0x9A, 0x35, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D} }
  285. typedef struct {
  286. CHAR16 VolumeLabel[1];
  287. } EFI_FILE_SYSTEM_VOLUME_LABEL_INFO;
  288. #define SIZE_OF_EFI_FILE_SYSTEM_VOLUME_LABEL_INFO EFI_FIELD_OFFSET(EFI_FILE_SYSTEM_VOLUME_LABEL_INFO,VolumeLabel)
  289. //
  290. // Load file protocol
  291. //
  292. #define EFI_LOAD_FILE_PROTOCOL_GUID \
  293. { 0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B} }
  294. #define LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL_GUID
  295. INTERFACE_DECL(_EFI_LOAD_FILE_PROTOCOL);
  296. typedef
  297. EFI_STATUS
  298. (EFIAPI *EFI_LOAD_FILE) (
  299. IN struct _EFI_LOAD_FILE_PROTOCOL *This,
  300. IN EFI_DEVICE_PATH *FilePath,
  301. IN BOOLEAN BootPolicy,
  302. IN OUT UINTN *BufferSize,
  303. IN VOID *Buffer OPTIONAL
  304. );
  305. typedef struct _EFI_LOAD_FILE_PROTOCOL {
  306. EFI_LOAD_FILE LoadFile;
  307. } EFI_LOAD_FILE_PROTOCOL;
  308. typedef struct _EFI_LOAD_FILE_PROTOCOL _EFI_LOAD_FILE_INTERFACE;
  309. typedef EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE;
  310. //
  311. // Device IO protocol
  312. //
  313. #define EFI_DEVICE_IO_PROTOCOL_GUID \
  314. { 0xaf6ac311, 0x84c3, 0x11d2, {0x8e, 0x3c, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b} }
  315. #define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID
  316. INTERFACE_DECL(_EFI_DEVICE_IO_PROTOCOL);
  317. typedef enum {
  318. IO_UINT8,
  319. IO_UINT16,
  320. IO_UINT32,
  321. IO_UINT64,
  322. //
  323. // Specification Change: Copy from MMIO to MMIO vs. MMIO to buffer, buffer to MMIO
  324. //
  325. MMIO_COPY_UINT8,
  326. MMIO_COPY_UINT16,
  327. MMIO_COPY_UINT32,
  328. MMIO_COPY_UINT64
  329. } EFI_IO_WIDTH;
  330. #define EFI_PCI_ADDRESS(_bus,_dev,_func) \
  331. ( (UINT64) ( (((UINTN)_bus) << 24) + (((UINTN)_dev) << 16) + (((UINTN)_func) << 8) ) )
  332. typedef
  333. EFI_STATUS
  334. (EFIAPI *EFI_DEVICE_IO) (
  335. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  336. IN EFI_IO_WIDTH Width,
  337. IN UINT64 Address,
  338. IN UINTN Count,
  339. IN OUT VOID *Buffer
  340. );
  341. typedef struct {
  342. EFI_DEVICE_IO Read;
  343. EFI_DEVICE_IO Write;
  344. } EFI_IO_ACCESS;
  345. typedef
  346. EFI_STATUS
  347. (EFIAPI *EFI_PCI_DEVICE_PATH) (
  348. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  349. IN UINT64 Address,
  350. IN OUT EFI_DEVICE_PATH **PciDevicePath
  351. );
  352. typedef enum {
  353. EfiBusMasterRead,
  354. EfiBusMasterWrite,
  355. EfiBusMasterCommonBuffer
  356. } EFI_IO_OPERATION_TYPE;
  357. typedef
  358. EFI_STATUS
  359. (EFIAPI *EFI_IO_MAP) (
  360. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  361. IN EFI_IO_OPERATION_TYPE Operation,
  362. IN EFI_PHYSICAL_ADDRESS *HostAddress,
  363. IN OUT UINTN *NumberOfBytes,
  364. OUT EFI_PHYSICAL_ADDRESS *DeviceAddress,
  365. OUT VOID **Mapping
  366. );
  367. typedef
  368. EFI_STATUS
  369. (EFIAPI *EFI_IO_UNMAP) (
  370. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  371. IN VOID *Mapping
  372. );
  373. typedef
  374. EFI_STATUS
  375. (EFIAPI *EFI_IO_ALLOCATE_BUFFER) (
  376. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  377. IN EFI_ALLOCATE_TYPE Type,
  378. IN EFI_MEMORY_TYPE MemoryType,
  379. IN UINTN Pages,
  380. IN OUT EFI_PHYSICAL_ADDRESS *HostAddress
  381. );
  382. typedef
  383. EFI_STATUS
  384. (EFIAPI *EFI_IO_FLUSH) (
  385. IN struct _EFI_DEVICE_IO_PROTOCOL *This
  386. );
  387. typedef
  388. EFI_STATUS
  389. (EFIAPI *EFI_IO_FREE_BUFFER) (
  390. IN struct _EFI_DEVICE_IO_PROTOCOL *This,
  391. IN UINTN Pages,
  392. IN EFI_PHYSICAL_ADDRESS HostAddress
  393. );
  394. typedef struct _EFI_DEVICE_IO_PROTOCOL {
  395. EFI_IO_ACCESS Mem;
  396. EFI_IO_ACCESS Io;
  397. EFI_IO_ACCESS Pci;
  398. EFI_IO_MAP Map;
  399. EFI_PCI_DEVICE_PATH PciDevicePath;
  400. EFI_IO_UNMAP Unmap;
  401. EFI_IO_ALLOCATE_BUFFER AllocateBuffer;
  402. EFI_IO_FLUSH Flush;
  403. EFI_IO_FREE_BUFFER FreeBuffer;
  404. } EFI_DEVICE_IO_PROTOCOL;
  405. typedef struct _EFI_DEVICE_IO_PROTOCOL _EFI_DEVICE_IO_INTERFACE;
  406. typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE;
  407. //
  408. // Unicode Collation protocol
  409. //
  410. #define EFI_UNICODE_COLLATION_PROTOCOL_GUID \
  411. { 0x1d85cd7f, 0xf43d, 0x11d2, {0x9a, 0xc, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  412. #define UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL_GUID
  413. #define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16)(0xfeff)
  414. #define UNICODE_BYTE_ORDER_MARK EFI_UNICODE_BYTE_ORDER_MARK
  415. INTERFACE_DECL(_EFI_UNICODE_COLLATION_PROTOCOL);
  416. typedef
  417. INTN
  418. (EFIAPI *EFI_UNICODE_STRICOLL) (
  419. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  420. IN CHAR16 *s1,
  421. IN CHAR16 *s2
  422. );
  423. typedef
  424. BOOLEAN
  425. (EFIAPI *EFI_UNICODE_METAIMATCH) (
  426. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  427. IN CHAR16 *String,
  428. IN CHAR16 *Pattern
  429. );
  430. typedef
  431. VOID
  432. (EFIAPI *EFI_UNICODE_STRLWR) (
  433. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  434. IN OUT CHAR16 *Str
  435. );
  436. typedef
  437. VOID
  438. (EFIAPI *EFI_UNICODE_STRUPR) (
  439. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  440. IN OUT CHAR16 *Str
  441. );
  442. typedef
  443. VOID
  444. (EFIAPI *EFI_UNICODE_FATTOSTR) (
  445. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  446. IN UINTN FatSize,
  447. IN CHAR8 *Fat,
  448. OUT CHAR16 *String
  449. );
  450. typedef
  451. BOOLEAN
  452. (EFIAPI *EFI_UNICODE_STRTOFAT) (
  453. IN struct _EFI_UNICODE_COLLATION_PROTOCOL *This,
  454. IN CHAR16 *String,
  455. IN UINTN FatSize,
  456. OUT CHAR8 *Fat
  457. );
  458. //
  459. // Hash Protocol
  460. //
  461. #define EFI_HASH_PROTOCOL_GUID \
  462. { 0xC5184932, 0xDBA5, 0x46DB, { 0xA5, 0xBA, 0xCC, 0x0B, 0xDA, 0x9C, 0x14, 0x35 } }
  463. #define HASH_PROTOCOL EFI_HASH_PROTOCOL_GUID
  464. #define EFI_HASH_ALGORITHM_SHA1_GUID \
  465. { 0x2AE9D80F, 0x3FB2, 0x4095, { 0xB7, 0xB1, 0xE9, 0x31, 0x57, 0xB9, 0x46, 0xB6 } } // Deprecated
  466. #define EFI_HASH_ALGORITHM_SHA1 EFI_HASH_ALGORITHM_SHA1_GUID
  467. #define EFI_HASH_ALGORITHM_SHA224_GUID \
  468. { 0x8DF01A06, 0x9BD5, 0x4BF7, { 0xB0, 0x21, 0xDB, 0x4F, 0xD9, 0xCC, 0xF4, 0x5B } } // Deprecated
  469. #define EFI_HASH_ALGORITHM_SHA224 EFI_HASH_ALGORITHM_SHA224_GUID
  470. #define EFI_HASH_ALGORITHM_SHA256_GUID \
  471. { 0x51AA59DE, 0xFDF2, 0x4EA3, { 0xBC, 0x63, 0x87, 0x5F, 0xB7, 0x84, 0x2E, 0xE9 } } // Deprecated
  472. #define EFI_HASH_ALGORITHM_SHA256 EFI_HASH_ALGORITHM_SHA256_GUID
  473. #define EFI_HASH_ALGORITHM_SHA384_GUID \
  474. { 0xEFA96432, 0xDE33, 0x4DD2, { 0xAE, 0xE6, 0x32, 0x8C, 0x33, 0xDF, 0x77, 0x7A } } // Deprecated
  475. #define EFI_HASH_ALGORITHM_SHA384 EFI_HASH_ALGORITHM_SHA384_GUID
  476. #define EFI_HASH_ALGORITHM_SHA512_GUID \
  477. { 0xCAA4381E, 0x750C, 0x4770, { 0xB8, 0x70, 0x7A, 0x23, 0xB4, 0xE4, 0x21, 0x30 } } // Deprecated
  478. #define EFI_HASH_ALGORITHM_SHA512 EFI_HASH_ALGORITHM_SHA512_GUID
  479. #define EFI_HASH_ALGORITHM_MD5_GUID \
  480. { 0x0AF7C79C, 0x65B5, 0x4319, { 0xB0, 0xAE, 0x44, 0xEC, 0x48, 0x4E, 0x4A, 0xD7 } } // Deprecated
  481. #define EFI_HASH_ALGORITHM_MD5 EFI_HASH_ALGORITHM_MD5_GUID
  482. #define EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID \
  483. { 0x24C5DC2F, 0x53E2, 0x40CA, { 0x9E, 0xD6, 0xA5, 0xD9, 0xA4, 0x9F, 0x46, 0x3B } }
  484. #define EFI_HASH_ALGORITHM_SHA1_NOPAD EFI_HASH_ALGORITHM_SHA1_NOPAD_GUID
  485. #define EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID \
  486. { 0x8628752A, 0x6CB7, 0x4814, { 0x96, 0xFC, 0x24, 0xA8, 0x15, 0xAC, 0x22, 0x26 } }
  487. #define EFI_HASH_ALGORITHM_SHA256_NOPAD EFI_HASH_ALGORITHM_SHA256_NOPAD_GUID
  488. INTERFACE_DECL(_EFI_HASH_PROTOCOL);
  489. typedef UINT8 EFI_MD5_HASH[16];
  490. typedef UINT8 EFI_SHA1_HASH[20];
  491. typedef UINT8 EFI_SHA224_HASH[28];
  492. typedef UINT8 EFI_SHA256_HASH[32];
  493. typedef UINT8 EFI_SHA384_HASH[48];
  494. typedef UINT8 EFI_SHA512_HASH[64];
  495. typedef union _EFI_HASH_OUTPUT {
  496. EFI_MD5_HASH *Md5Hash;
  497. EFI_SHA1_HASH *Sha1Hash;
  498. EFI_SHA224_HASH *Sha224Hash;
  499. EFI_SHA256_HASH *Sha256Hash;
  500. EFI_SHA384_HASH *Sha384Hash;
  501. EFI_SHA512_HASH *Sha512Hash;
  502. } EFI_HASH_OUTPUT;
  503. typedef
  504. EFI_STATUS
  505. (EFIAPI *EFI_HASH_GET_HASH_SIZE) (
  506. IN CONST struct _EFI_HASH_PROTOCOL *This,
  507. IN CONST EFI_GUID *HashAlgorithm,
  508. OUT UINTN *HashSize);
  509. typedef
  510. EFI_STATUS
  511. (EFIAPI *EFI_HASH_HASH) (
  512. IN CONST struct _EFI_HASH_PROTOCOL *This,
  513. IN CONST EFI_GUID *HashAlgorithm,
  514. IN BOOLEAN Extend,
  515. IN CONST UINT8 *Message,
  516. IN UINT64 MessageSize,
  517. IN OUT EFI_HASH_OUTPUT *Hash);
  518. typedef struct _EFI_HASH_PROTOCOL {
  519. EFI_HASH_GET_HASH_SIZE GetHashSize;
  520. EFI_HASH_HASH Hash;
  521. } EFI_HASH_PROTOCOL;
  522. typedef struct _EFI_HASH_PROTOCOL _EFI_HASH;
  523. typedef EFI_HASH_PROTOCOL EFI_HASH;
  524. typedef struct _EFI_UNICODE_COLLATION_PROTOCOL {
  525. // general
  526. EFI_UNICODE_STRICOLL StriColl;
  527. EFI_UNICODE_METAIMATCH MetaiMatch;
  528. EFI_UNICODE_STRLWR StrLwr;
  529. EFI_UNICODE_STRUPR StrUpr;
  530. // for supporting fat volumes
  531. EFI_UNICODE_FATTOSTR FatToStr;
  532. EFI_UNICODE_STRTOFAT StrToFat;
  533. CHAR8 *SupportedLanguages;
  534. } EFI_UNICODE_COLLATION_PROTOCOL;
  535. typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL;
  536. typedef EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_INTERFACE;
  537. /* Graphics output protocol */
  538. #define EFI_GRAPHICS_OUTPUT_PROTOCOL_GUID \
  539. { 0x9042a9de, 0x23dc, 0x4a38, {0x96, 0xfb, 0x7a, 0xde, 0xd0, 0x80, 0x51, 0x6a } }
  540. typedef struct _EFI_GRAPHICS_OUTPUT_PROTOCOL EFI_GRAPHICS_OUTPUT_PROTOCOL;
  541. typedef struct {
  542. UINT32 RedMask;
  543. UINT32 GreenMask;
  544. UINT32 BlueMask;
  545. UINT32 ReservedMask;
  546. } EFI_PIXEL_BITMASK;
  547. typedef enum {
  548. PixelRedGreenBlueReserved8BitPerColor,
  549. PixelBlueGreenRedReserved8BitPerColor,
  550. PixelBitMask,
  551. PixelBltOnly,
  552. PixelFormatMax
  553. } EFI_GRAPHICS_PIXEL_FORMAT;
  554. typedef struct {
  555. UINT32 Version;
  556. UINT32 HorizontalResolution;
  557. UINT32 VerticalResolution;
  558. EFI_GRAPHICS_PIXEL_FORMAT PixelFormat;
  559. EFI_PIXEL_BITMASK PixelInformation;
  560. UINT32 PixelsPerScanLine;
  561. } EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
  562. /**
  563. Return the current video mode information.
  564. @param This Protocol instance pointer.
  565. @param ModeNumber The mode number to return information on.
  566. @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
  567. @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
  568. @retval EFI_SUCCESS Mode information returned.
  569. @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.
  570. @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the video mode.
  571. @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()
  572. @retval EFI_INVALID_PARAMETER One of the input args was NULL.
  573. **/
  574. typedef
  575. EFI_STATUS
  576. (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE) (
  577. IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
  578. IN UINT32 ModeNumber,
  579. OUT UINTN *SizeOfInfo,
  580. OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info
  581. )
  582. ;
  583. /**
  584. Return the current video mode information.
  585. @param This Protocol instance pointer.
  586. @param ModeNumber The mode number to be set.
  587. @retval EFI_SUCCESS Graphics mode was changed.
  588. @retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
  589. @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
  590. **/
  591. typedef
  592. EFI_STATUS
  593. (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE) (
  594. IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
  595. IN UINT32 ModeNumber
  596. );
  597. typedef struct {
  598. UINT8 Blue;
  599. UINT8 Green;
  600. UINT8 Red;
  601. UINT8 Reserved;
  602. } EFI_GRAPHICS_OUTPUT_BLT_PIXEL;
  603. typedef union {
  604. EFI_GRAPHICS_OUTPUT_BLT_PIXEL Pixel;
  605. UINT32 Raw;
  606. } EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION;
  607. typedef enum {
  608. EfiBltVideoFill,
  609. EfiBltVideoToBltBuffer,
  610. EfiBltBufferToVideo,
  611. EfiBltVideoToVideo,
  612. EfiGraphicsOutputBltOperationMax
  613. } EFI_GRAPHICS_OUTPUT_BLT_OPERATION;
  614. /**
  615. The following table defines actions for BltOperations:
  616. <B>EfiBltVideoFill</B> - Write data from the BltBuffer pixel (SourceX, SourceY)
  617. directly to every pixel of the video display rectangle
  618. (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
  619. Only one pixel will be used from the BltBuffer. Delta is NOT used.
  620. <B>EfiBltVideoToBltBuffer</B> - Read data from the video display rectangle
  621. (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in
  622. the BltBuffer rectangle (DestinationX, DestinationY )
  623. (DestinationX + Width, DestinationY + Height). If DestinationX or
  624. DestinationY is not zero then Delta must be set to the length in bytes
  625. of a row in the BltBuffer.
  626. <B>EfiBltBufferToVideo</B> - Write data from the BltBuffer rectangle
  627. (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the
  628. video display rectangle (DestinationX, DestinationY)
  629. (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is
  630. not zero then Delta must be set to the length in bytes of a row in the
  631. BltBuffer.
  632. <B>EfiBltVideoToVideo</B> - Copy from the video display rectangle (SourceX, SourceY)
  633. (SourceX + Width, SourceY + Height) .to the video display rectangle
  634. (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height).
  635. The BltBuffer and Delta are not used in this mode.
  636. @param This Protocol instance pointer.
  637. @param BltBuffer Buffer containing data to blit into video buffer. This
  638. buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)
  639. @param BltOperation Operation to perform on BlitBuffer and video memory
  640. @param SourceX X coordinate of source for the BltBuffer.
  641. @param SourceY Y coordinate of source for the BltBuffer.
  642. @param DestinationX X coordinate of destination for the BltBuffer.
  643. @param DestinationY Y coordinate of destination for the BltBuffer.
  644. @param Width Width of rectangle in BltBuffer in pixels.
  645. @param Height Hight of rectangle in BltBuffer in pixels.
  646. @param Delta OPTIONAL
  647. @retval EFI_SUCCESS The Blt operation completed.
  648. @retval EFI_INVALID_PARAMETER BltOperation is not valid.
  649. @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer.
  650. **/
  651. typedef
  652. EFI_STATUS
  653. (EFIAPI *EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT) (
  654. IN EFI_GRAPHICS_OUTPUT_PROTOCOL *This,
  655. IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer, OPTIONAL
  656. IN EFI_GRAPHICS_OUTPUT_BLT_OPERATION BltOperation,
  657. IN UINTN SourceX,
  658. IN UINTN SourceY,
  659. IN UINTN DestinationX,
  660. IN UINTN DestinationY,
  661. IN UINTN Width,
  662. IN UINTN Height,
  663. IN UINTN Delta OPTIONAL
  664. );
  665. typedef struct {
  666. UINT32 MaxMode;
  667. UINT32 Mode;
  668. EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *Info;
  669. UINTN SizeOfInfo;
  670. EFI_PHYSICAL_ADDRESS FrameBufferBase;
  671. UINTN FrameBufferSize;
  672. } EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE;
  673. struct _EFI_GRAPHICS_OUTPUT_PROTOCOL {
  674. EFI_GRAPHICS_OUTPUT_PROTOCOL_QUERY_MODE QueryMode;
  675. EFI_GRAPHICS_OUTPUT_PROTOCOL_SET_MODE SetMode;
  676. EFI_GRAPHICS_OUTPUT_PROTOCOL_BLT Blt;
  677. EFI_GRAPHICS_OUTPUT_PROTOCOL_MODE *Mode;
  678. };
  679. /*
  680. * EFI EDID Discovered Protocol
  681. * UEFI Specification Version 2.5 Section 11.9
  682. */
  683. #define EFI_EDID_DISCOVERED_PROTOCOL_GUID \
  684. { 0x1C0C34F6, 0xD380, 0x41FA, { 0xA0, 0x49, 0x8a, 0xD0, 0x6C, 0x1A, 0x66, 0xAA} }
  685. typedef struct _EFI_EDID_DISCOVERED_PROTOCOL {
  686. UINT32 SizeOfEdid;
  687. UINT8 *Edid;
  688. } EFI_EDID_DISCOVERED_PROTOCOL;
  689. /*
  690. * EFI EDID Active Protocol
  691. * UEFI Specification Version 2.5 Section 11.9
  692. */
  693. #define EFI_EDID_ACTIVE_PROTOCOL_GUID \
  694. { 0xBD8C1056, 0x9F36, 0x44EC, { 0x92, 0xA8, 0xA6, 0x33, 0x7F, 0x81, 0x79, 0x86} }
  695. typedef struct _EFI_EDID_ACTIVE_PROTOCOL {
  696. UINT32 SizeOfEdid;
  697. UINT8 *Edid;
  698. } EFI_EDID_ACTIVE_PROTOCOL;
  699. /*
  700. * EFI EDID Override Protocol
  701. * UEFI Specification Version 2.5 Section 11.9
  702. */
  703. #define EFI_EDID_OVERRIDE_PROTOCOL_GUID \
  704. { 0x48ECB431, 0xFB72, 0x45C0, { 0xA9, 0x22, 0xF4, 0x58, 0xFE, 0x04, 0x0B, 0xD5} }
  705. INTERFACE_DECL(_EFI_EDID_OVERRIDE_PROTOCOL);
  706. typedef
  707. EFI_STATUS
  708. (EFIAPI *EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID) (
  709. IN struct _EFI_EDID_OVERRIDE_PROTOCOL *This,
  710. IN EFI_HANDLE *ChildHandle,
  711. OUT UINT32 *Attributes,
  712. IN OUT UINTN *EdidSize,
  713. IN OUT UINT8 **Edid);
  714. typedef struct _EFI_EDID_OVERRIDE_PROTOCOL {
  715. EFI_EDID_OVERRIDE_PROTOCOL_GET_EDID GetEdid;
  716. } EFI_EDID_OVERRIDE_PROTOCOL;
  717. INTERFACE_DECL(_EFI_SERVICE_BINDING);
  718. typedef
  719. EFI_STATUS
  720. (EFIAPI *EFI_SERVICE_BINDING_CREATE_CHILD) (
  721. IN struct _EFI_SERVICE_BINDING *This,
  722. IN EFI_HANDLE *ChildHandle
  723. );
  724. typedef
  725. EFI_STATUS
  726. (EFIAPI *EFI_SERVICE_BINDING_DESTROY_CHILD) (
  727. IN struct _EFI_SERVICE_BINDING *This,
  728. IN EFI_HANDLE ChildHandle
  729. );
  730. typedef struct _EFI_SERVICE_BINDING {
  731. EFI_SERVICE_BINDING_CREATE_CHILD CreateChild;
  732. EFI_SERVICE_BINDING_DESTROY_CHILD DestroyChild;
  733. } EFI_SERVICE_BINDING;
  734. /*
  735. * EFI Driver Binding Protocol
  736. * UEFI Specification Version 2.5 Section 10.1
  737. */
  738. #define EFI_DRIVER_BINDING_PROTOCOL_GUID \
  739. { 0x18A031AB, 0xB443, 0x4D1A, { 0xA5, 0xC0, 0x0C, 0x09, 0x26, 0x1E, 0x9F, 0x71} }
  740. #define DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING_PROTOCOL_GUID
  741. INTERFACE_DECL(_EFI_DRIVER_BINDING_PROTOCOL);
  742. typedef
  743. EFI_STATUS
  744. (EFIAPI *EFI_DRIVER_BINDING_PROTOCOL_SUPPORTED) (
  745. IN struct _EFI_DRIVER_BINDING_PROTOCOL *This,
  746. IN EFI_HANDLE ControllerHandle,
  747. IN EFI_DEVICE_PATH *RemainingDevicePath OPTIONAL);
  748. typedef
  749. EFI_STATUS
  750. (EFIAPI *EFI_DRIVER_BINDING_PROTOCOL_START) (
  751. IN struct _EFI_DRIVER_BINDING_PROTOCOL *This,
  752. IN EFI_HANDLE ControllerHandle,
  753. IN EFI_DEVICE_PATH *RemainingDevicePath OPTIONAL);
  754. typedef
  755. EFI_STATUS
  756. (EFIAPI *EFI_DRIVER_BINDING_PROTOCOL_STOP) (
  757. IN struct _EFI_DRIVER_BINDING_PROTOCOL *This,
  758. IN EFI_HANDLE ControllerHandle,
  759. IN UINTN NumberOfChildren,
  760. IN EFI_HANDLE *ChildHandleBuffer OPTIONAL);
  761. typedef struct _EFI_DRIVER_BINDING_PROTOCOL {
  762. EFI_DRIVER_BINDING_PROTOCOL_SUPPORTED Supported;
  763. EFI_DRIVER_BINDING_PROTOCOL_START Start;
  764. EFI_DRIVER_BINDING_PROTOCOL_STOP Stop;
  765. UINT32 Version;
  766. EFI_HANDLE ImageHandle;
  767. EFI_HANDLE DriverBindingHandle;
  768. } EFI_DRIVER_BINDING_PROTOCOL;
  769. typedef struct _EFI_DRIVER_BINDING_PROTOCOL _EFI_DRIVER_BINDING;
  770. typedef EFI_DRIVER_BINDING_PROTOCOL EFI_DRIVER_BINDING;
  771. /*
  772. * Backwards compatibility with older GNU-EFI versions. Deprecated.
  773. */
  774. #define EFI_DRIVER_SUPPORTED EFI_DRIVER_BINDING_PROTOCOL_SUPPORTED
  775. #define EFI_DRIVER_START EFI_DRIVER_BINDING_PROTOCOL_START
  776. #define EFI_DRIVER_STOP EFI_DRIVER_BINDING_PROTOCOL_STOP
  777. /*
  778. * EFI Component Name Protocol
  779. * Deprecated - use EFI Component Name 2 Protocol instead
  780. */
  781. #define EFI_COMPONENT_NAME_PROTOCOL_GUID \
  782. {0x107A772C, 0xD5E1, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D} }
  783. #define COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME_PROTOCOL_GUID
  784. INTERFACE_DECL(_EFI_COMPONENT_NAME_PROTOCOL);
  785. typedef
  786. EFI_STATUS
  787. (EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME) (
  788. IN struct _EFI_COMPONENT_NAME_PROTOCOL *This,
  789. IN CHAR8 *Language,
  790. OUT CHAR16 **DriverName);
  791. typedef
  792. EFI_STATUS
  793. (EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME) (
  794. IN struct _EFI_COMPONENT_NAME_PROTOCOL *This,
  795. IN EFI_HANDLE ControllerHandle,
  796. IN EFI_HANDLE ChildHandle OPTIONAL,
  797. IN CHAR8 *Language,
  798. OUT CHAR16 **ControllerName);
  799. typedef struct _EFI_COMPONENT_NAME_PROTOCOL {
  800. EFI_COMPONENT_NAME_GET_DRIVER_NAME GetDriverName;
  801. EFI_COMPONENT_NAME_GET_CONTROLLER_NAME GetControllerName;
  802. CHAR8 *SupportedLanguages;
  803. } EFI_COMPONENT_NAME_PROTOCOL;
  804. typedef struct _EFI_COMPONENT_NAME_PROTOCOL _EFI_COMPONENT_NAME;
  805. typedef EFI_COMPONENT_NAME_PROTOCOL EFI_COMPONENT_NAME;
  806. /*
  807. * EFI Component Name 2 Protocol
  808. * UEFI Specification Version 2.5 Section 10.5
  809. */
  810. #define EFI_COMPONENT_NAME2_PROTOCOL_GUID \
  811. {0x6A7A5CFF, 0xE8D9, 0x4F70, { 0xBA, 0xDA, 0x75, 0xAB, 0x30, 0x25, 0xCE, 0x14} }
  812. #define COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2_PROTOCOL_GUID
  813. INTERFACE_DECL(_EFI_COMPONENT_NAME2_PROTOCOL);
  814. typedef
  815. EFI_STATUS
  816. (EFIAPI *EFI_COMPONENT_NAME2_GET_DRIVER_NAME) (
  817. IN struct _EFI_COMPONENT_NAME2_PROTOCOL *This,
  818. IN CHAR8 *Language,
  819. OUT CHAR16 **DriverName);
  820. typedef
  821. EFI_STATUS
  822. (EFIAPI *EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) (
  823. IN struct _EFI_COMPONENT_NAME2_PROTOCOL *This,
  824. IN EFI_HANDLE ControllerHandle,
  825. IN EFI_HANDLE ChildHandle OPTIONAL,
  826. IN CHAR8 *Language,
  827. OUT CHAR16 **ControllerName);
  828. typedef struct _EFI_COMPONENT_NAME2_PROTOCOL {
  829. EFI_COMPONENT_NAME2_GET_DRIVER_NAME GetDriverName;
  830. EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME GetControllerName;
  831. CHAR8 *SupportedLanguages;
  832. } EFI_COMPONENT_NAME2_PROTOCOL;
  833. typedef struct _EFI_COMPONENT_NAME2_PROTOCOL _EFI_COMPONENT_NAME2;
  834. typedef EFI_COMPONENT_NAME2_PROTOCOL EFI_COMPONENT_NAME2;
  835. /*
  836. * EFI Loaded Image Protocol
  837. * UEFI Specification Version 2.5 Section 8.1
  838. */
  839. #define EFI_LOADED_IMAGE_PROTOCOL_GUID \
  840. { 0x5B1B31A1, 0x9562, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B} }
  841. #define LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE_PROTOCOL_GUID
  842. #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000
  843. #define EFI_IMAGE_INFORMATION_REVISION EFI_LOADED_IMAGE_PROTOCOL_REVISION
  844. typedef
  845. EFI_STATUS
  846. (EFIAPI *EFI_IMAGE_UNLOAD) (
  847. IN EFI_HANDLE ImageHandle
  848. );
  849. typedef struct {
  850. UINT32 Revision;
  851. EFI_HANDLE ParentHandle;
  852. struct _EFI_SYSTEM_TABLE *SystemTable;
  853. // Source location of image
  854. EFI_HANDLE DeviceHandle;
  855. EFI_DEVICE_PATH *FilePath;
  856. VOID *Reserved;
  857. // Images load options
  858. UINT32 LoadOptionsSize;
  859. VOID *LoadOptions;
  860. // Location of where image was loaded
  861. VOID *ImageBase;
  862. UINT64 ImageSize;
  863. EFI_MEMORY_TYPE ImageCodeType;
  864. EFI_MEMORY_TYPE ImageDataType;
  865. // If the driver image supports a dynamic unload request
  866. EFI_IMAGE_UNLOAD Unload;
  867. } EFI_LOADED_IMAGE_PROTOCOL;
  868. typedef EFI_LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE;
  869. /*
  870. * Random Number Generator Protocol
  871. * UEFI Specification Version 2.5 Section 35.5
  872. */
  873. #define EFI_RNG_PROTOCOL_GUID \
  874. { 0x3152bca5, 0xeade, 0x433d, {0x86, 0x2e, 0xc0, 0x1c, 0xdc, 0x29, 0x1f, 0x44} }
  875. typedef EFI_GUID EFI_RNG_ALGORITHM;
  876. #define EFI_RNG_ALGORITHM_SP800_90_HASH_256_GUID \
  877. {0xa7af67cb, 0x603b, 0x4d42, {0xba, 0x21, 0x70, 0xbf, 0xb6, 0x29, 0x3f, 0x96} }
  878. #define EFI_RNG_ALGORITHM_SP800_90_HMAC_256_GUID \
  879. {0xc5149b43, 0xae85, 0x4f53, {0x99, 0x82, 0xb9, 0x43, 0x35, 0xd3, 0xa9, 0xe7} }
  880. #define EFI_RNG_ALGORITHM_SP800_90_CTR_256_GUID \
  881. {0x44f0de6e, 0x4d8c, 0x4045, {0xa8, 0xc7, 0x4d, 0xd1, 0x68, 0x85, 0x6b, 0x9e} }
  882. #define EFI_RNG_ALGORITHM_X9_31_3DES_GUID \
  883. {0x63c4785a, 0xca34, 0x4012, {0xa3, 0xc8, 0x0b, 0x6a, 0x32, 0x4f, 0x55, 0x46} }
  884. #define EFI_RNG_ALGORITHM_X9_31_AES_GUID \
  885. {0xacd03321, 0x777e, 0x4d3d, {0xb1, 0xc8, 0x20, 0xcf, 0xd8, 0x88, 0x20, 0xc9} }
  886. #define EFI_RNG_ALGORITHM_RAW \
  887. {0xe43176d7, 0xb6e8, 0x4827, {0xb7, 0x84, 0x7f, 0xfd, 0xc4, 0xb6, 0x85, 0x61} }
  888. INTERFACE_DECL(_EFI_RNG_PROTOCOL);
  889. typedef
  890. EFI_STATUS
  891. (EFIAPI *EFI_RNG_GET_INFO) (
  892. IN struct _EFI_RNG_PROTOCOL *This,
  893. IN OUT UINTN *RNGAlgorithmListSize,
  894. OUT EFI_RNG_ALGORITHM *RNGAlgorithmList
  895. );
  896. typedef
  897. EFI_STATUS
  898. (EFIAPI *EFI_RNG_GET_RNG) (
  899. IN struct _EFI_RNG_PROTOCOL *This,
  900. IN EFI_RNG_ALGORITHM *RNGAlgorithm, OPTIONAL
  901. IN UINTN RNGValueLength,
  902. OUT UINT8 *RNGValue
  903. );
  904. typedef struct _EFI_RNG_PROTOCOL {
  905. EFI_RNG_GET_INFO GetInfo;
  906. EFI_RNG_GET_RNG GetRNG;
  907. } EFI_RNG_PROTOCOL;
  908. //
  909. // EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL
  910. //
  911. #define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \
  912. { 0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d} }
  913. INTERFACE_DECL(_EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL);
  914. typedef
  915. EFI_STATUS
  916. (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER) (
  917. IN struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
  918. IN EFI_HANDLE ControllerHandle,
  919. IN OUT EFI_HANDLE *DriverImageHandle);
  920. typedef
  921. EFI_STATUS
  922. (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH) (
  923. IN struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
  924. IN EFI_HANDLE ControllerHandle,
  925. IN OUT EFI_DEVICE_PATH **DriverImagePath);
  926. typedef
  927. EFI_STATUS
  928. (EFIAPI *EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED) (
  929. IN struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL *This,
  930. IN EFI_HANDLE ControllerHandle,
  931. IN EFI_DEVICE_PATH *DriverImagePath,
  932. IN EFI_HANDLE DriverImageHandle);
  933. typedef struct _EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL {
  934. EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
  935. EFI_PLATFORM_DRIVER_OVERRIDE_GET_DRIVER_PATH GetDriverPath;
  936. EFI_PLATFORM_DRIVER_OVERRIDE_DRIVER_LOADED DriverLoaded;
  937. } EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL;
  938. //
  939. // EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL
  940. //
  941. #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \
  942. { 0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65} }
  943. INTERFACE_DECL(_EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL);
  944. typedef
  945. EFI_STATUS
  946. (EFIAPI *EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER) (
  947. IN struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL *This,
  948. IN OUT EFI_HANDLE *DriverImageHandle);
  949. typedef struct _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL {
  950. EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_GET_DRIVER GetDriver;
  951. } EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL;
  952. //
  953. // EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL
  954. //
  955. #define EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL_GUID \
  956. { 0xb1ee129e, 0xda36, 0x4181, {0x91, 0xf8, 0x04, 0xa4, 0x92, 0x37, 0x66, 0xa7} }
  957. INTERFACE_DECL(_EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL);
  958. typedef
  959. UINT32
  960. (EFIAPI *EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION) (
  961. IN struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL *This);
  962. typedef struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL {
  963. EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion;
  964. } EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL;
  965. #endif