efiprot.h 43 KB

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