Chameleon

Chameleon Svn Source Tree

Root/branches/cparm/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//
75// Modifiers for EFI Runtime and Boot Services
76//
77#define EFI_RUNTIMESERVICE
78#define EFIAPI
79#define IN
80#define OUT
81#define OPTIONAL
82
83#define EFI_MAX_BIT 0x80000000
84
85//
86// Set the upper bit to indicate EFI Error.
87//
88#define EFIERR(a) (EFI_MAX_BIT | (a))
89
90#define EFIWARN(a) (a)
91#define EFI_ERROR(a) (((INTN) (a)) < 0)
92
93#define EFI_SUCCESS 0
94#define EFI_LOAD_ERROR EFIERR (1)
95#define EFI_INVALID_PARAMETER EFIERR (2)
96#define EFI_UNSUPPORTED EFIERR (3)
97#define EFI_BAD_BUFFER_SIZE EFIERR (4)
98#define EFI_BUFFER_TOO_SMALL EFIERR (5)
99#define EFI_NOT_READY EFIERR (6)
100#define EFI_DEVICE_ERROR EFIERR (7)
101#define EFI_WRITE_PROTECTED EFIERR (8)
102#define EFI_OUT_OF_RESOURCES EFIERR (9)
103#define EFI_VOLUME_CORRUPTED EFIERR (10)
104#define EFI_VOLUME_FULL EFIERR (11)
105#define EFI_NO_MEDIA EFIERR (12)
106#define EFI_MEDIA_CHANGED EFIERR (13)
107#define EFI_NOT_FOUND EFIERR (14)
108#define EFI_ACCESS_DENIED EFIERR (15)
109#define EFI_NO_RESPONSE EFIERR (16)
110#define EFI_NO_MAPPING EFIERR (17)
111#define EFI_TIMEOUT EFIERR (18)
112#define EFI_NOT_STARTED EFIERR (19)
113#define EFI_ALREADY_STARTED EFIERR (20)
114#define EFI_ABORTED EFIERR (21)
115#define EFI_ICMP_ERROR EFIERR (22)
116#define EFI_TFTP_ERROR EFIERR (23)
117#define EFI_PROTOCOL_ERROR EFIERR (24)
118#define EFI_INCOMPATIBLE_VERSION EFIERR (25)
119#define EFI_SECURITY_VIOLATION EFIERR (26)
120#define EFI_CRC_ERROR EFIERR (27)
121
122#define EFI_WARN_UNKNOWN_GLYPH EFIWARN (1)
123#define EFI_WARN_DELETE_FAILURE EFIWARN (2)
124#define EFI_WARN_WRITE_FAILURE EFIWARN (3)
125#define EFI_WARN_BUFFER_TOO_SMALL EFIWARN (4)
126
127//
128// EFI Specification Revision information
129//
130#define EFI_SPECIFICATION_MAJOR_REVISION 1
131#define EFI_SPECIFICATION_MINOR_REVISION 10
132
133typedef struct {
134 EFI_UINT32 Data1;
135 EFI_UINT16 Data2;
136 EFI_UINT16 Data3;
137 EFI_UINT8 Data4[8];
138} EFI_GUID;
139
140#define APPLE_VENDOR_GUID \
141 {0xAC39C713, 0x7E50, 0x423D, {0x88, 0x9D, 0x27,0x8F, 0xCC, 0x34, 0x22, 0xB6} }
142
143#define EFI_GLOBAL_VARIABLE_GUID \
144 {0x8BE4DF61, 0x93CA, 0x11d2, {0xAA, 0x0D, 0x00, 0xE0, 0x98, 0x03, 0x2B, 0x8C} }
145
146typedef union {
147 EFI_GUID Guid;
148 EFI_UINT8 Raw[16];
149} EFI_GUID_UNION;
150
151//
152// EFI Time Abstraction:
153// Year: 2000 - 20XX
154// Month: 1 - 12
155// Day: 1 - 31
156// Hour: 0 - 23
157// Minute: 0 - 59
158// Second: 0 - 59
159// Nanosecond: 0 - 999,999,999
160// TimeZone: -1440 to 1440 or 2047
161//
162typedef struct {
163 EFI_UINT16 Year;
164 EFI_UINT8 Month;
165 EFI_UINT8 Day;
166 EFI_UINT8 Hour;
167 EFI_UINT8 Minute;
168 EFI_UINT8 Second;
169 EFI_UINT8 Pad1;
170 EFI_UINT32 Nanosecond;
171 EFI_INT16 TimeZone;
172 EFI_UINT8 Daylight;
173 EFI_UINT8 Pad2;
174} EFI_TIME;
175
176//
177// Bit definitions for EFI_TIME.Daylight
178//
179#define EFI_TIME_ADJUST_DAYLIGHT 0x01
180#define EFI_TIME_IN_DAYLIGHT 0x02
181
182//
183// Value definition for EFI_TIME.TimeZone
184//
185#define EFI_UNSPECIFIED_TIMEZONE 0x07FF
186
187typedef enum {
188 EfiReservedMemoryType,
189 EfiLoaderCode,
190 EfiLoaderData,
191 EfiBootServicesCode,
192 EfiBootServicesData,
193 EfiRuntimeServicesCode,
194 EfiRuntimeServicesData,
195 EfiConventionalMemory,
196 EfiUnusableMemory,
197 EfiACPIReclaimMemory,
198 EfiACPIMemoryNVS,
199 EfiMemoryMappedIO,
200 EfiMemoryMappedIOPortSpace,
201 EfiPalCode,
202 EfiMaxMemoryType
203} EFI_MEMORY_TYPE;
204
205typedef struct {
206 EFI_UINT64 Signature;
207 EFI_UINT32 Revision;
208 EFI_UINT32 HeaderSize;
209 EFI_UINT32 CRC32;
210 EFI_UINT32 Reserved;
211} __attribute__((aligned(8))) EFI_TABLE_HEADER;
212
213#define STRUCT_EFI_TABLE_HEADER EFI_TABLE_HEADER Hdr;
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
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 ) __attribute__((regparm(0)));
258
259typedef
260EFI_RUNTIMESERVICE
261EFI_STATUS
262(EFIAPI *EFI_CONVERT_POINTER) (
263 IN EFI_UINTN DebugDisposition,
264 IN OUT VOID **Address
265 ) __attribute__((regparm(0)));
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 ) __attribute__((regparm(0)));
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 ) __attribute__((regparm(0)));
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 ) __attribute__((regparm(0)));
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 ) __attribute__((regparm(0)));
322
323typedef
324EFI_RUNTIMESERVICE
325EFI_STATUS
326(EFIAPI *EFI_SET_TIME) (
327 IN EFI_TIME * Time
328 ) __attribute__((regparm(0)));
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 ) __attribute__((regparm(0)));
338
339typedef
340EFI_RUNTIMESERVICE
341EFI_STATUS
342(EFIAPI *EFI_SET_WAKEUP_TIME) (
343 IN EFI_BOOLEAN Enable,
344 IN EFI_TIME * Time OPTIONAL
345 ) __attribute((regparm(0)));
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 ) __attribute__((regparm(0)));
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//
376// Definition of Status Code extended data header
377//
378// HeaderSize The size of the architecture. This is specified to enable
379// the future expansion
380//
381// Size The size of the data in bytes. This does not include the size
382// of the header structure.
383//
384// Type A GUID defining the type of the data
385//
386//
387#ifdef TIANO_EXTENSION_FLAG
388
389typedef
390EFI_RUNTIMESERVICE
391EFI_STATUS
392(EFIAPI *EFI_REPORT_STATUS_CODE) (
393 IN EFI_STATUS_CODE_TYPE Type,
394 IN EFI_STATUS_CODE_VALUE Value,
395 IN EFI_UINT32 Instance,
396 IN EFI_GUID * CallerId OPTIONAL,
397 IN EFI_STATUS_CODE_DATA * Data OPTIONAL
398 ) __attribute__((regparm(0)));
399
400#endif
401//
402// EFI Runtime Services Table
403//
404#define EFI_RUNTIME_SERVICES_SIGNATURE 0x56524553544e5552ULL
405#define EFI_RUNTIME_SERVICES_REVISION ((EFI_SPECIFICATION_MAJOR_REVISION << 16) | (EFI_SPECIFICATION_MINOR_REVISION))
406
407typedef struct {
408 STRUCT_EFI_TABLE_HEADER
409 //
410 // Time services
411 //
412 EFI_PTR32 GetTime;
413 EFI_PTR32 SetTime;
414 EFI_PTR32 GetWakeupTime;
415 EFI_PTR32 SetWakeupTime;
416
417 //
418 // Virtual memory services
419 //
420 EFI_PTR32 SetVirtualAddressMap;
421 EFI_PTR32 ConvertPointer;
422
423 //
424 // Variable services
425 //
426 EFI_PTR32 GetVariable;
427 EFI_PTR32 GetNextVariableName;
428 EFI_PTR32 SetVariable;
429
430 //
431 // Misc
432 //
433 EFI_PTR32 GetNextHighMonotonicCount;
434 EFI_PTR32 ResetSystem;
435
436#ifdef TIANO_EXTENSION_FLAG
437 //
438 // ////////////////////////////////////////////////////
439 // Extended EFI Services
440 //////////////////////////////////////////////////////
441 //
442 EFI_PTR32 ReportStatusCode;
443#endif
444
445} __attribute__((aligned(8))) EFI_RUNTIME_SERVICES_32;
446
447typedef struct {
448 STRUCT_EFI_TABLE_HEADER
449 //
450 // Time services
451 //
452 EFI_PTR64 GetTime;
453 EFI_PTR64 SetTime;
454 EFI_PTR64 GetWakeupTime;
455 EFI_PTR64 SetWakeupTime;
456
457 //
458 // Virtual memory services
459 //
460 EFI_PTR64 SetVirtualAddressMap;
461 EFI_PTR64 ConvertPointer;
462
463 //
464 // Variable services
465 //
466 EFI_PTR64 GetVariable;
467 EFI_PTR64 GetNextVariableName;
468 EFI_PTR64 SetVariable;
469
470 //
471 // Misc
472 //
473 EFI_PTR64 GetNextHighMonotonicCount;
474 EFI_PTR64 ResetSystem;
475
476#ifdef TIANO_EXTENSION_FLAG
477 //
478 // ////////////////////////////////////////////////////
479 // Extended EFI Services
480 //////////////////////////////////////////////////////
481 //
482 EFI_PTR64 ReportStatusCode;
483#endif
484
485} __attribute__((aligned(8))) EFI_RUNTIME_SERVICES_64;
486
487//
488// EFI Configuration Table
489//
490typedef struct {
491 EFI_GUID VendorGuid;
492 EFI_PTR32 VendorTable;
493} EFI_CONFIGURATION_TABLE_32;
494
495typedef struct {
496 EFI_GUID VendorGuid;
497 EFI_PTR64 VendorTable;
498} __attribute__((aligned(8))) EFI_CONFIGURATION_TABLE_64;
499
500//
501// EFI System Table
502//
503#define EFI_SYSTEM_TABLE_SIGNATURE 0x5453595320494249ULL
504#define EFI_SYSTEM_TABLE_REVISION ((EFI_SPECIFICATION_MAJOR_REVISION << 16) | (EFI_SPECIFICATION_MINOR_REVISION))
505#define EFI_2_00_SYSTEM_TABLE_REVISION ((2 << 16) | 00)
506#define EFI_1_02_SYSTEM_TABLE_REVISION ((1 << 16) | 02)
507#define EFI_1_10_SYSTEM_TABLE_REVISION ((1 << 16) | 10)
508
509typedef struct EFI_SYSTEM_TABLE_32 {
510 STRUCT_EFI_TABLE_HEADER
511 EFI_PTR32 FirmwareVendor;
512 EFI_UINT32 FirmwareRevision;
513
514 EFI_HANDLE32 ConsoleInHandle;
515 EFI_PTR32 ConIn;
516
517 EFI_HANDLE32 ConsoleOutHandle;
518 EFI_PTR32 ConOut;
519
520 EFI_HANDLE32 StandardErrorHandle;
521 EFI_PTR32 StdErr;
522
523 EFI_PTR32 RuntimeServices;
524 EFI_PTR32 BootServices;
525
526 EFI_UINT32 NumberOfTableEntries;
527 EFI_PTR32 ConfigurationTable;
528
529} __attribute__((aligned(8))) EFI_SYSTEM_TABLE_32;
530
531typedef struct EFI_SYSTEM_TABLE_64 {
532 STRUCT_EFI_TABLE_HEADER
533 EFI_PTR64 FirmwareVendor;
534 EFI_UINT32 FirmwareRevision;
535
536 EFI_UINT32 __pad;
537
538 EFI_HANDLE64 ConsoleInHandle;
539 EFI_PTR64 ConIn;
540
541 EFI_HANDLE64 ConsoleOutHandle;
542 EFI_PTR64 ConOut;
543
544 EFI_HANDLE64 StandardErrorHandle;
545 EFI_PTR64 StdErr;
546
547 EFI_PTR64 RuntimeServices;
548 EFI_PTR64 BootServices;
549
550 EFI_UINT64 NumberOfTableEntries;
551 EFI_PTR64 ConfigurationTable;
552
553} __attribute__((aligned(8))) EFI_SYSTEM_TABLE_64;
554
555#endif /* _PEXPERT_I386_EFI_H */
556

Archive Download this file

Revision: 789