Chameleon

Chameleon Svn Source Tree

Root/trunk/i386/libsaio/efi.h

1/*␊
2 * Copyright (c) 2005 Apple Computer, Inc. All rights reserved.␊
3 *␊
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@␊
5 * ␊
6 * This file contains Original Code and/or Modifications of Original Code␊
7 * as defined in and that are subject to the Apple Public Source License␊
8 * Version 2.0 (the 'License'). You may not use this file except in␊
9 * compliance with the License. The rights granted to you under the License␊
10 * may not be used to create, or enable the creation or redistribution of,␊
11 * unlawful or unlicensed copies of an Apple operating system, or to␊
12 * circumvent, violate, or enable the circumvention or violation of, any␊
13 * terms of an Apple operating system software license agreement.␊
14 * ␊
15 * Please obtain a copy of the License at␊
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.␊
17 * ␊
18 * The Original Code and all software distributed under the License are␊
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER␊
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,␊
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,␊
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.␊
23 * Please see the License for the specific language governing rights and␊
24 * limitations under the License.␊
25 * ␊
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@␊
27 */␊
28␊
29#ifndef _PEXPERT_I386_EFI_H␊
30#define _PEXPERT_I386_EFI_H␊
31␊
32#include <stdint.h>␊
33␊
34typedef uint8_t EFI_UINT8;␊
35typedef uint16_t EFI_UINT16;␊
36typedef uint32_t EFI_UINT32;␊
37typedef uint64_t EFI_UINT64;␊
38␊
39typedef uint32_t EFI_UINTN; /* natural size for firmware, not kernel */␊
40␊
41typedef int8_t EFI_INT8;␊
42typedef int16_t EFI_INT16;␊
43typedef int32_t EFI_INT32;␊
44typedef int64_t EFI_INT64;␊
45␊
46typedef int8_t EFI_CHAR8;␊
47typedef int16_t EFI_CHAR16;␊
48typedef int32_t EFI_CHAR32;␊
49typedef int64_t EFI_CHAR64;␊
50␊
51typedef uint32_t EFI_STATUS;␊
52typedef uint8_t EFI_BOOLEAN;␊
53typedef void VOID;␊
54␊
55typedef uint32_t EFI_PTR32;␊
56typedef uint32_t EFI_HANDLE32;␊
57␊
58typedef uint64_t EFI_PTR64;␊
59typedef uint64_t EFI_HANDLE64;␊
60/*␊
61␊
62Portions Copyright 2004, Intel Corporation␊
63All rights reserved. This program and the accompanying materials␊
64are licensed and made available under the terms and conditions of the BSD License␊
65which accompanies this distribution. The full text of the license may be found at␊
66 http://opensource.org/licenses/bsd-license.php␊
67␊
68THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,␊
69WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.␊
70␊
71*/␊
72␊
73␊
74// Modifiers for EFI Runtime and Boot Services␊
75␊
76#define EFI_RUNTIMESERVICE␊
77#define EFIAPI␊
78#define IN␊
79#define OUT␊
80#define OPTIONAL␊
81␊
82#define EFI_MAX_BIT 0x80000000␊
83␊
84// Set the upper bit to indicate EFI Error.␊
85#define EFIERR(a) (EFI_MAX_BIT | (a))␊
86␊
87#define EFIWARN(a) (a)␊
88#define EFI_ERROR(a) (((INTN) (a)) < 0)␊
89␊
90#define EFI_SUCCESS 0␊
91#define EFI_LOAD_ERROR EFIERR (1)␊
92#define EFI_INVALID_PARAMETER EFIERR (2)␊
93#define EFI_UNSUPPORTED EFIERR (3)␊
94#define EFI_BAD_BUFFER_SIZE EFIERR (4)␊
95#define EFI_BUFFER_TOO_SMALL EFIERR (5)␊
96#define EFI_NOT_READY EFIERR (6)␊
97#define EFI_DEVICE_ERROR EFIERR (7)␊
98#define EFI_WRITE_PROTECTED EFIERR (8)␊
99#define EFI_OUT_OF_RESOURCES EFIERR (9)␊
100#define EFI_VOLUME_CORRUPTED EFIERR (10)␊
101#define EFI_VOLUME_FULL EFIERR (11)␊
102#define EFI_NO_MEDIA EFIERR (12)␊
103#define EFI_MEDIA_CHANGED EFIERR (13)␊
104#define EFI_NOT_FOUND EFIERR (14)␊
105#define EFI_ACCESS_DENIED EFIERR (15)␊
106#define EFI_NO_RESPONSE EFIERR (16)␊
107#define EFI_NO_MAPPING EFIERR (17)␊
108#define EFI_TIMEOUT EFIERR (18)␊
109#define EFI_NOT_STARTED EFIERR (19)␊
110#define EFI_ALREADY_STARTED EFIERR (20)␊
111#define EFI_ABORTED EFIERR (21)␊
112#define EFI_ICMP_ERROR EFIERR (22)␊
113#define EFI_TFTP_ERROR EFIERR (23)␊
114#define EFI_PROTOCOL_ERROR EFIERR (24)␊
115#define EFI_INCOMPATIBLE_VERSION EFIERR (25)␊
116#define EFI_SECURITY_VIOLATION EFIERR (26)␊
117#define EFI_CRC_ERROR EFIERR (27)␊
118#define EFI_END_OF_MEDIA EFIERR (28)␊
119#define EFI_END_OF_FILE EFIERR (31)␊
120#define EFI_INVALID_LANGUAGE EFIERR (32)␊
121#define EFI_COMPROMISED_DATA EFIERR (33)␊
122␊
123#define EFI_WARN_UNKNOWN_GLYPH EFIWARN (1)␊
124#define EFI_WARN_DELETE_FAILURE EFIWARN (2)␊
125#define EFI_WARN_WRITE_FAILURE EFIWARN (3)␊
126#define EFI_WARN_BUFFER_TOO_SMALL EFIWARN (4)␊
127#define EFI_WARN_STALE_DATA EFIWARN (5)␊
128␊
129//␊
130// EFI Specification Revision information␊
131//␊
132#define EFI_SPECIFICATION_MAJOR_REVISION 1␊
133#define EFI_SPECIFICATION_MINOR_REVISION 10␊
134␊
135typedef struct {␊
136 EFI_UINT32 Data1;␊
137 EFI_UINT16 Data2;␊
138 EFI_UINT16 Data3;␊
139 EFI_UINT8 Data4[8];␊
140} EFI_GUID;␊
141␊
142#define APPLE_VENDOR_GUID \␊
143 {0xAC39C713, 0x7E50, 0x423D, {0x88, 0x9D, 0x27,0x8F, 0xCC, 0x34, 0x22, 0xB6} }␊
144␊
145#define EFI_GLOBAL_VARIABLE_GUID \␊
146 {0x8BE4DF61, 0x93CA, 0x11D2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C} }␊
147␊
148typedef union {␊
149 EFI_GUID Guid;␊
150 EFI_UINT8 Raw[16];␊
151} EFI_GUID_UNION;␊
152␊
153//␊
154// EFI Time Abstraction:␊
155// Year: 2000 - 20XX␊
156// Month: 1 - 12␊
157// Day: 1 - 31␊
158// Hour: 0 - 23␊
159// Minute: 0 - 59␊
160// Second: 0 - 59␊
161// Nanosecond: 0 - 999,999,999␊
162// TimeZone: -1440 to 1440 or 2047␊
163//␊
164typedef struct {␊
165␉EFI_UINT16 Year;␊
166␉EFI_UINT8 Month;␊
167␉EFI_UINT8 Day;␊
168␉EFI_UINT8 Hour;␊
169␉EFI_UINT8 Minute;␊
170␉EFI_UINT8 Second;␊
171␉EFI_UINT8 Pad1;␊
172␉EFI_UINT32 Nanosecond;␊
173␉EFI_INT16 TimeZone;␊
174␉EFI_UINT8 Daylight;␊
175␉EFI_UINT8 Pad2;␊
176} EFI_TIME;␊
177␊
178␊
179// Bit definitions for EFI_TIME.Daylight␊
180␊
181#define EFI_TIME_ADJUST_DAYLIGHT 0x01␊
182#define EFI_TIME_IN_DAYLIGHT 0x02␊
183␊
184␊
185// Value definition for EFI_TIME.TimeZone␊
186␊
187#define EFI_UNSPECIFIED_TIMEZONE 0x07FF␊
188␊
189typedef enum {␊
190␉EfiReservedMemoryType,␊
191␉EfiLoaderCode,␊
192␉EfiLoaderData,␊
193␉EfiBootServicesCode,␊
194␉EfiBootServicesData,␊
195␉EfiRuntimeServicesCode,␊
196␉EfiRuntimeServicesData,␊
197␉EfiConventionalMemory,␊
198␉EfiUnusableMemory,␊
199␉EfiACPIReclaimMemory,␊
200␉EfiACPIMemoryNVS,␊
201␉EfiMemoryMappedIO,␊
202␉EfiMemoryMappedIOPortSpace,␊
203␉EfiPalCode,␊
204␉EfiMaxMemoryType␊
205} EFI_MEMORY_TYPE;␊
206␊
207typedef struct {␊
208␉EFI_UINT64␉␉␉␉Signature;␊
209␉EFI_UINT32␉␉␉␉Revision;␊
210␉EFI_UINT32␉␉␉␉HeaderSize;␊
211␉EFI_UINT32␉␉␉␉CRC32;␊
212␉EFI_UINT32␉␉␉␉Reserved;␊
213} __attribute__((aligned(8))) EFI_TABLE_HEADER;␊
214␊
215// possible caching types for the memory range␊
216␊
217#define EFI_MEMORY_UC 0x0000000000000001ULL␊
218#define EFI_MEMORY_WC 0x0000000000000002ULL␊
219#define EFI_MEMORY_WT 0x0000000000000004ULL␊
220#define EFI_MEMORY_WB 0x0000000000000008ULL␊
221#define EFI_MEMORY_UCE 0x0000000000000010ULL␊
222␊
223␊
224// physical memory protection on range␊
225␊
226#define EFI_MEMORY_WP 0x0000000000001000ULL␊
227#define EFI_MEMORY_RP 0x0000000000002000ULL␊
228#define EFI_MEMORY_XP 0x0000000000004000ULL␊
229␊
230␊
231// range requires a runtime mapping␊
232␊
233#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL␊
234#define EFI_MEMORY_KERN_RESERVED (1ULL << 59)␊
235typedef EFI_UINT64 EFI_PHYSICAL_ADDRESS;␊
236typedef EFI_UINT64 EFI_VIRTUAL_ADDRESS;␊
237␊
238#define EFI_MEMORY_DESCRIPTOR_VERSION 1␊
239typedef struct {␊
240␉EFI_UINT32 Type;␊
241␉EFI_UINT32 Pad;␊
242␉EFI_PHYSICAL_ADDRESS PhysicalStart;␊
243␉EFI_VIRTUAL_ADDRESS VirtualStart;␊
244␉EFI_UINT64 NumberOfPages;␊
245␉EFI_UINT64 Attribute;␊
246} __attribute__((aligned(8))) EFI_MEMORY_DESCRIPTOR;␊
247␊
248␊
249typedef␊
250EFI_RUNTIMESERVICE␊
251EFI_STATUS␊
252(EFIAPI *EFI_SET_VIRTUAL_ADDRESS_MAP) (␊
253 IN EFI_UINTN MemoryMapSize,␊
254 IN EFI_UINTN DescriptorSize,␊
255 IN EFI_UINT32 DescriptorVersion,␊
256 IN EFI_MEMORY_DESCRIPTOR * VirtualMap␊
257 );␊
258␊
259typedef␊
260EFI_RUNTIMESERVICE␊
261EFI_STATUS␊
262(EFIAPI *EFI_CONVERT_POINTER) (␊
263 IN EFI_UINTN DebugDisposition,␊
264 IN OUT VOID **Address␊
265 );␊
266␊
267␊
268// Variable attributes␊
269␊
270#define EFI_VARIABLE_NON_VOLATILE 0x00000001␊
271#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002␊
272#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004␊
273#define EFI_VARIABLE_READ_ONLY 0x00000008␊
274␊
275typedef␊
276EFI_RUNTIMESERVICE␊
277EFI_STATUS␊
278(EFIAPI *EFI_GET_VARIABLE) (␊
279 IN EFI_CHAR16 * VariableName,␊
280 IN EFI_GUID * VendorGuid,␊
281 OUT EFI_UINT32 * Attributes OPTIONAL,␊
282 IN OUT EFI_UINTN * DataSize,␊
283 OUT VOID * Data␊
284 );␊
285␊
286typedef␊
287EFI_RUNTIMESERVICE␊
288EFI_STATUS␊
289(EFIAPI *EFI_GET_NEXT_VARIABLE_NAME) (␊
290 IN OUT EFI_UINTN * VariableNameSize,␊
291 IN OUT EFI_CHAR16 * VariableName,␊
292 IN OUT EFI_GUID * VendorGuid␊
293 );␊
294␊
295typedef␊
296EFI_RUNTIMESERVICE␊
297EFI_STATUS␊
298(EFIAPI *EFI_SET_VARIABLE) (␊
299 IN EFI_CHAR16 * VariableName,␊
300 IN EFI_GUID * VendorGuid,␊
301 IN EFI_UINT32 Attributes,␊
302 IN EFI_UINTN DataSize,␊
303 IN VOID * Data␊
304 );␊
305␊
306␊
307// EFI Time␊
308␊
309typedef struct {␊
310␉EFI_UINT32 Resolution;␊
311␉EFI_UINT32 Accuracy;␊
312␉EFI_BOOLEAN SetsToZero;␊
313} __attribute__((aligned(4))) EFI_TIME_CAPABILITIES;␊
314␊
315typedef␊
316EFI_RUNTIMESERVICE␊
317EFI_STATUS␊
318(EFIAPI *EFI_GET_TIME) (␊
319 OUT EFI_TIME * Time,␊
320 OUT EFI_TIME_CAPABILITIES * Capabilities OPTIONAL␊
321 );␊
322␊
323typedef␊
324EFI_RUNTIMESERVICE␊
325EFI_STATUS␊
326(EFIAPI *EFI_SET_TIME) (␊
327 IN EFI_TIME * Time␊
328 );␊
329␊
330typedef␊
331EFI_RUNTIMESERVICE␊
332EFI_STATUS␊
333(EFIAPI *EFI_GET_WAKEUP_TIME) (␊
334 OUT EFI_BOOLEAN * Enabled,␊
335 OUT EFI_BOOLEAN * Pending,␊
336 OUT EFI_TIME * Time␊
337 );␊
338␊
339typedef␊
340EFI_RUNTIMESERVICE␊
341EFI_STATUS␊
342(EFIAPI *EFI_SET_WAKEUP_TIME) (␊
343 IN EFI_BOOLEAN Enable,␊
344 IN EFI_TIME * Time OPTIONAL␊
345 );␊
346␊
347typedef enum {␊
348 EfiResetCold,␊
349 EfiResetWarm,␊
350 EfiResetShutdown,␊
351␊
352#ifdef TIANO_EXTENSION_FLAG␊
353 EfiResetUpdate␊
354#endif␊
355␊
356} EFI_RESET_TYPE;␊
357␊
358typedef␊
359EFI_RUNTIMESERVICE␊
360VOID␊
361(EFIAPI *EFI_RESET_SYSTEM) (␊
362 IN EFI_RESET_TYPE ResetType,␊
363 IN EFI_STATUS ResetStatus,␊
364 IN EFI_UINTN DataSize,␊
365 IN EFI_CHAR16 * ResetData OPTIONAL␊
366 );␊
367␊
368typedef␊
369EFI_RUNTIMESERVICE␊
370EFI_STATUS␊
371(EFIAPI *EFI_GET_NEXT_HIGH_MONO_COUNT) (␊
372 OUT EFI_UINT32 * HighCount␊
373 ) __attribute__((regparm(0)));␊
374␊
375// Definition of Status Code extended data header␊
376␊
377// HeaderSize The size of the architecture. This is specified to enable the future expansion␊
378␊
379// Size The size of the data in bytes. This does not include the size of the header structure.␊
380␊
381// Type A GUID defining the type of the data␊
382␊
383#ifdef TIANO_EXTENSION_FLAG␊
384␊
385typedef␊
386EFI_RUNTIMESERVICE␊
387EFI_STATUS␊
388(EFIAPI *EFI_REPORT_STATUS_CODE) (␊
389 IN EFI_STATUS_CODE_TYPE Type,␊
390 IN EFI_STATUS_CODE_VALUE Value,␊
391 IN EFI_UINT32 Instance,␊
392 IN EFI_GUID * CallerId OPTIONAL,␊
393 IN EFI_STATUS_CODE_DATA * Data OPTIONAL␊
394 );␊
395␊
396#endif␊
397//␊
398// EFI Runtime Services Table␊
399//␊
400#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL␊
401#define EFI_RUNTIME_SERVICES_REVISION ((EFI_SPECIFICATION_MAJOR_REVISION << 16) | (EFI_SPECIFICATION_MINOR_REVISION))␊
402␊
403typedef struct {␊
404␉EFI_TABLE_HEADER␉␉Hdr;␊
405␊
406␉// Time Services␊
407␉EFI_PTR32␉␉␉␉GetTime;␊
408␉EFI_PTR32␉␉␉␉SetTime;␊
409␉EFI_PTR32␉␉␉␉GetWakeupTime;␊
410␉EFI_PTR32␉␉␉␉SetWakeupTime;␊
411␊
412␉// Virtual Memory Services␊
413␊
414␉EFI_PTR32 SetVirtualAddressMap;␊
415␉EFI_PTR32 ConvertPointer;␊
416␊
417␊
418␉// Variable Services␊
419␉EFI_PTR32 GetVariable;␊
420␉EFI_PTR32 GetNextVariableName;␊
421␉EFI_PTR32 SetVariable;␊
422␊
423␉// Miscellaneous Services␊
424␉EFI_PTR32 GetNextHighMonotonicCount;␊
425␉EFI_PTR32 ResetSystem;␊
426␊
427#ifdef TIANO_EXTENSION_FLAG␊
428␊
429␉// ////////////////////////////////////////////////////␊
430␉// Extended EFI Services␊
431␉//////////////////////////////////////////////////////␊
432␊
433␉EFI_PTR32 ReportStatusCode;␊
434#endif␊
435␊
436} __attribute__((aligned(8))) EFI_RUNTIME_SERVICES_32;␊
437␊
438typedef struct {␊
439␉EFI_TABLE_HEADER Hdr;␊
440␊
441␊
442␉// Time services␊
443␊
444␉EFI_PTR64 GetTime;␊
445␉EFI_PTR64 SetTime;␊
446␉EFI_PTR64 GetWakeupTime;␊
447␉EFI_PTR64 SetWakeupTime;␊
448␊
449␉// Virtual memory services␊
450␊
451␉EFI_PTR64 SetVirtualAddressMap;␊
452␉EFI_PTR64 ConvertPointer;␊
453␊
454␉// Variable services␊
455␊
456␉EFI_PTR64 GetVariable;␊
457␉EFI_PTR64 GetNextVariableName;␊
458␉EFI_PTR64 SetVariable;␊
459␊
460␉// Misc␊
461␊
462␉EFI_PTR64 GetNextHighMonotonicCount;␊
463␉EFI_PTR64 ResetSystem;␊
464␊
465#ifdef TIANO_EXTENSION_FLAG␊
466␊
467␉// ////////////////////////////////////////////////////␊
468␉// Extended EFI Services␊
469␉//////////////////////////////////////////////////////␊
470␊
471␉EFI_PTR64 ReportStatusCode;␊
472#endif␊
473␊
474} __attribute__((aligned(8))) EFI_RUNTIME_SERVICES_64;␊
475␊
476//␊
477// EFI Configuration Table␊
478//␊
479typedef struct {␊
480␉EFI_GUID VendorGuid;␊
481␉EFI_PTR32 VendorTable;␊
482} EFI_CONFIGURATION_TABLE_32;␊
483␊
484typedef struct {␊
485␉EFI_GUID VendorGuid;␊
486␉EFI_PTR64 VendorTable;␊
487} __attribute__((aligned(8))) EFI_CONFIGURATION_TABLE_64;␊
488␊
489␊
490// EFI System Table␊
491␊
492#define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249ULL␊
493#define EFI_SYSTEM_TABLE_REVISION ((EFI_SPECIFICATION_MAJOR_REVISION << 16) | (EFI_SPECIFICATION_MINOR_REVISION))␊
494#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | 00)␊
495#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | 02)␊
496#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | 10)␊
497␊
498typedef struct EFI_SYSTEM_TABLE_32 {␊
499␉EFI_TABLE_HEADER Hdr;␊
500␊
501␉EFI_PTR32 FirmwareVendor;␊
502␉EFI_UINT32 FirmwareRevision;␊
503␊
504␉EFI_HANDLE32 ConsoleInHandle;␊
505␉EFI_PTR32 ConIn;␊
506␊
507␉EFI_HANDLE32 ConsoleOutHandle;␊
508␉EFI_PTR32 ConOut;␊
509␊
510␉EFI_HANDLE32 StandardErrorHandle;␊
511␉EFI_PTR32 StdErr;␊
512␊
513␉EFI_PTR32 RuntimeServices;␊
514␉EFI_PTR32 BootServices;␊
515␊
516␉EFI_UINT32 NumberOfTableEntries;␊
517␉EFI_PTR32 ConfigurationTable;␊
518␊
519} __attribute__((aligned(8))) EFI_SYSTEM_TABLE_32;␊
520␊
521typedef struct EFI_SYSTEM_TABLE_64 {␊
522␉EFI_TABLE_HEADER Hdr;␊
523␊
524␉EFI_PTR64 FirmwareVendor;␊
525␉EFI_UINT32 FirmwareRevision;␊
526␊
527␉EFI_UINT32 __pad;␊
528␉EFI_HANDLE64 ConsoleInHandle;␊
529␉EFI_PTR64 ConIn;␊
530␊
531␉EFI_HANDLE64 ConsoleOutHandle;␊
532␉EFI_PTR64 ConOut;␊
533␊
534␉EFI_HANDLE64 StandardErrorHandle;␊
535␉EFI_PTR64 StdErr;␊
536␊
537␉EFI_PTR64 RuntimeServices;␊
538␉EFI_PTR64 BootServices;␊
539␊
540␉EFI_UINT64 NumberOfTableEntries;␊
541␉EFI_PTR64 ConfigurationTable;␊
542} __attribute__((aligned(8))) EFI_SYSTEM_TABLE_64;␊
543␊
544#endif /* _PEXPERT_I386_EFI_H */␊
545

Archive Download this file

Revision: 2425