actypes.h revision 117521
1/******************************************************************************
2 *
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
4 *       $Revision: 261 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#ifndef __ACTYPES_H__
118#define __ACTYPES_H__
119
120/*! [Begin] no source code translation (keep the typedefs) */
121
122
123
124/*
125 * Data type ranges
126 * Note: These macros are designed to be compiler independent as well as
127 * working around problems that some 32-bit compilers have with 64-bit
128 * constants.
129 */
130#define ACPI_UINT8_MAX                  (UINT8) (~((UINT8)  0)) /* 0xFF               */
131#define ACPI_UINT16_MAX                 (UINT16)(~((UINT16) 0)) /* 0xFFFF             */
132#define ACPI_UINT32_MAX                 (UINT32)(~((UINT32) 0)) /* 0xFFFFFFFF         */
133#define ACPI_UINT64_MAX                 (UINT64)(~((UINT64) 0)) /* 0xFFFFFFFFFFFFFFFF */
134#define ACPI_ASCII_MAX                  0x7F
135
136
137#ifdef DEFINE_ALTERNATE_TYPES
138/*
139 * Types used only in translated source, defined here to enable
140 * cross-platform compilation only.
141 */
142typedef int                             s32;
143typedef unsigned char                   u8;
144typedef unsigned short                  u16;
145typedef unsigned int                    u32;
146typedef COMPILER_DEPENDENT_UINT64       u64;
147
148#endif
149
150
151/*
152 * Data types - Fixed across all compilation models (16/32/64)
153 *
154 * BOOLEAN          Logical Boolean.
155 * INT8             8-bit  (1 byte) signed value
156 * UINT8            8-bit  (1 byte) unsigned value
157 * INT16            16-bit (2 byte) signed value
158 * UINT16           16-bit (2 byte) unsigned value
159 * INT32            32-bit (4 byte) signed value
160 * UINT32           32-bit (4 byte) unsigned value
161 * INT64            64-bit (8 byte) signed value
162 * UINT64           64-bit (8 byte) unsigned value
163 * ACPI_NATIVE_INT  32-bit on IA-32, 64-bit on IA-64 signed value
164 * ACPI_NATIVE_UINT 32-bit on IA-32, 64-bit on IA-64 unsigned value
165 */
166
167#ifndef ACPI_MACHINE_WIDTH
168#error ACPI_MACHINE_WIDTH not defined
169#endif
170
171#if ACPI_MACHINE_WIDTH == 64
172
173/*! [Begin] no source code translation (keep the typedefs) */
174
175/*
176 * 64-bit type definitions
177 */
178typedef unsigned char                   UINT8;
179typedef unsigned char                   BOOLEAN;
180typedef unsigned short                  UINT16;
181typedef int                             INT32;
182typedef unsigned int                    UINT32;
183typedef COMPILER_DEPENDENT_INT64        INT64;
184typedef COMPILER_DEPENDENT_UINT64       UINT64;
185
186/*! [End] no source code translation !*/
187
188typedef INT64                           ACPI_NATIVE_INT;
189typedef UINT64                          ACPI_NATIVE_UINT;
190
191typedef UINT64                          ACPI_TABLE_PTR;
192typedef UINT64                          ACPI_IO_ADDRESS;
193typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
194typedef UINT64                          ACPI_SIZE;
195
196#define ALIGNED_ADDRESS_BOUNDARY        0x00000008      /* No hardware alignment support in IA64 */
197#define ACPI_USE_NATIVE_DIVIDE                          /* Native 64-bit integer support */
198#define ACPI_MAX_PTR                    ACPI_UINT64_MAX
199#define ACPI_SIZE_MAX                   ACPI_UINT64_MAX
200
201
202#elif ACPI_MACHINE_WIDTH == 16
203
204/*! [Begin] no source code translation (keep the typedefs) */
205
206/*
207 * 16-bit type definitions
208 */
209typedef unsigned char                   UINT8;
210typedef unsigned char                   BOOLEAN;
211typedef unsigned int                    UINT16;
212typedef long                            INT32;
213typedef int                             INT16;
214typedef unsigned long                   UINT32;
215
216typedef struct
217{
218    UINT32                                  Lo;
219    UINT32                                  Hi;
220
221} UINT64;
222
223/*! [End] no source code translation !*/
224
225typedef UINT16                          ACPI_NATIVE_UINT;
226typedef INT16                           ACPI_NATIVE_INT;
227
228typedef UINT32                          ACPI_TABLE_PTR;
229typedef UINT32                          ACPI_IO_ADDRESS;
230typedef char                            *ACPI_PHYSICAL_ADDRESS;
231typedef UINT16                          ACPI_SIZE;
232
233#define ALIGNED_ADDRESS_BOUNDARY        0x00000002
234#define ACPI_MISALIGNED_TRANSFERS
235#define ACPI_USE_NATIVE_DIVIDE                          /* No 64-bit integers, ok to use native divide */
236#define ACPI_MAX_PTR                    ACPI_UINT16_MAX
237#define ACPI_SIZE_MAX                   ACPI_UINT16_MAX
238
239/*
240 * (16-bit only) internal integers must be 32-bits, so
241 * 64-bit integers cannot be supported
242 */
243#define ACPI_NO_INTEGER64_SUPPORT
244
245
246#elif ACPI_MACHINE_WIDTH == 32
247
248/*! [Begin] no source code translation (keep the typedefs) */
249
250/*
251 * 32-bit type definitions (default)
252 */
253typedef unsigned char                   UINT8;
254typedef unsigned char                   BOOLEAN;
255typedef unsigned short                  UINT16;
256typedef int                             INT32;
257typedef unsigned int                    UINT32;
258typedef COMPILER_DEPENDENT_INT64        INT64;
259typedef COMPILER_DEPENDENT_UINT64       UINT64;
260
261/*! [End] no source code translation !*/
262
263typedef INT32                           ACPI_NATIVE_INT;
264typedef UINT32                          ACPI_NATIVE_UINT;
265
266typedef UINT64                          ACPI_TABLE_PTR;
267typedef UINT32                          ACPI_IO_ADDRESS;
268typedef UINT64                          ACPI_PHYSICAL_ADDRESS;
269typedef UINT32                          ACPI_SIZE;
270
271#define ALIGNED_ADDRESS_BOUNDARY        0x00000004
272#define ACPI_MISALIGNED_TRANSFERS
273#define ACPI_MAX_PTR                    ACPI_UINT32_MAX
274#define ACPI_SIZE_MAX                   ACPI_UINT32_MAX
275
276#else
277#error unknown ACPI_MACHINE_WIDTH
278#endif
279
280
281/*
282 * Miscellaneous common types
283 */
284typedef UINT32                          UINT32_BIT;
285typedef ACPI_NATIVE_UINT                ACPI_PTRDIFF;
286
287/*
288 * Pointer overlays to avoid lots of typecasting for
289 * code that accepts both physical and logical pointers.
290 */
291typedef union acpi_pointers
292{
293    ACPI_PHYSICAL_ADDRESS       Physical;
294    void                        *Logical;
295    ACPI_TABLE_PTR              Value;
296
297} ACPI_POINTERS;
298
299typedef struct acpi_pointer
300{
301    UINT32                      PointerType;
302    union acpi_pointers         Pointer;
303
304} ACPI_POINTER;
305
306/* PointerTypes for above */
307
308#define ACPI_PHYSICAL_POINTER           0x01
309#define ACPI_LOGICAL_POINTER            0x02
310
311/* Processor mode */
312
313#define ACPI_PHYSICAL_ADDRESSING        0x04
314#define ACPI_LOGICAL_ADDRESSING         0x08
315#define ACPI_MEMORY_MODE                0x0C
316
317#define ACPI_PHYSMODE_PHYSPTR           ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
318#define ACPI_LOGMODE_PHYSPTR            ACPI_LOGICAL_ADDRESSING  | ACPI_PHYSICAL_POINTER
319#define ACPI_LOGMODE_LOGPTR             ACPI_LOGICAL_ADDRESSING  | ACPI_LOGICAL_POINTER
320
321
322/*
323 * Useful defines
324 */
325#ifdef FALSE
326#undef FALSE
327#endif
328#define FALSE                           (1 == 0)
329
330#ifdef TRUE
331#undef TRUE
332#endif
333#define TRUE                            (1 == 1)
334
335#ifndef NULL
336#define NULL                            (void *) 0
337#endif
338
339
340/*
341 * Local datatypes
342 */
343typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
344typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
345typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
346typedef void *                          ACPI_HANDLE;    /* Actually a ptr to an Node */
347
348typedef struct uint64_struct
349{
350    UINT32                      Lo;
351    UINT32                      Hi;
352
353} UINT64_STRUCT;
354
355typedef union uint64_overlay
356{
357    UINT64                      Full;
358    UINT64_STRUCT               Part;
359
360} UINT64_OVERLAY;
361
362typedef struct uint32_struct
363{
364    UINT32                      Lo;
365    UINT32                      Hi;
366
367} UINT32_STRUCT;
368
369
370/*
371 * Acpi integer width. In ACPI version 1, integers are
372 * 32 bits.  In ACPI version 2, integers are 64 bits.
373 * Note that this pertains to the ACPI integer type only, not
374 * other integers used in the implementation of the ACPI CA
375 * subsystem.
376 */
377#ifdef ACPI_NO_INTEGER64_SUPPORT
378
379/* 32-bit integers only, no 64-bit support */
380
381typedef UINT32                          ACPI_INTEGER;
382#define ACPI_INTEGER_MAX                ACPI_UINT32_MAX
383#define ACPI_INTEGER_BIT_SIZE           32
384#define ACPI_MAX_DECIMAL_DIGITS         10
385
386#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 32-bit divide */
387
388
389#else
390
391/* 64-bit integers */
392
393typedef UINT64                          ACPI_INTEGER;
394#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
395#define ACPI_INTEGER_BIT_SIZE           64
396#define ACPI_MAX_DECIMAL_DIGITS         19
397
398#if ACPI_MACHINE_WIDTH == 64
399#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 64-bit divide */
400#endif
401#endif
402
403
404/*
405 * Constants with special meanings
406 */
407#define ACPI_ROOT_OBJECT                (ACPI_HANDLE) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)
408
409
410/*
411 * Initialization sequence
412 */
413#define ACPI_FULL_INITIALIZATION        0x00
414#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
415#define ACPI_NO_HARDWARE_INIT           0x02
416#define ACPI_NO_EVENT_INIT              0x04
417#define ACPI_NO_HANDLER_INIT            0x08
418#define ACPI_NO_ACPI_ENABLE             0x10
419#define ACPI_NO_DEVICE_INIT             0x20
420#define ACPI_NO_OBJECT_INIT             0x40
421
422/*
423 * Initialization state
424 */
425#define ACPI_INITIALIZED_OK             0x01
426
427/*
428 * Power state values
429 */
430
431#define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
432
433#define ACPI_STATE_S0                   (UINT8) 0
434#define ACPI_STATE_S1                   (UINT8) 1
435#define ACPI_STATE_S2                   (UINT8) 2
436#define ACPI_STATE_S3                   (UINT8) 3
437#define ACPI_STATE_S4                   (UINT8) 4
438#define ACPI_STATE_S5                   (UINT8) 5
439#define ACPI_S_STATES_MAX               ACPI_STATE_S5
440#define ACPI_S_STATE_COUNT              6
441
442#define ACPI_STATE_D0                   (UINT8) 0
443#define ACPI_STATE_D1                   (UINT8) 1
444#define ACPI_STATE_D2                   (UINT8) 2
445#define ACPI_STATE_D3                   (UINT8) 3
446#define ACPI_D_STATES_MAX               ACPI_STATE_D3
447#define ACPI_D_STATE_COUNT              4
448
449#define ACPI_STATE_C0                   (UINT8) 0
450#define ACPI_STATE_C1                   (UINT8) 1
451#define ACPI_STATE_C2                   (UINT8) 2
452#define ACPI_STATE_C3                   (UINT8) 3
453#define ACPI_C_STATES_MAX               ACPI_STATE_C3
454#define ACPI_C_STATE_COUNT              4
455
456/*
457 * Sleep type invalid value
458 */
459#define ACPI_SLEEP_TYPE_MAX             0x7
460#define ACPI_SLEEP_TYPE_INVALID         0xFF
461
462/*
463 * Standard notify values
464 */
465#define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0
466#define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 1
467#define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 2
468#define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 3
469#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 4
470#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 5
471#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 6
472#define ACPI_NOTIFY_POWER_FAULT         (UINT8) 7
473
474
475/*
476 *  Table types.  These values are passed to the table related APIs
477 */
478typedef UINT32                          ACPI_TABLE_TYPE;
479
480#define ACPI_TABLE_RSDP                 (ACPI_TABLE_TYPE) 0
481#define ACPI_TABLE_DSDT                 (ACPI_TABLE_TYPE) 1
482#define ACPI_TABLE_FADT                 (ACPI_TABLE_TYPE) 2
483#define ACPI_TABLE_FACS                 (ACPI_TABLE_TYPE) 3
484#define ACPI_TABLE_PSDT                 (ACPI_TABLE_TYPE) 4
485#define ACPI_TABLE_SSDT                 (ACPI_TABLE_TYPE) 5
486#define ACPI_TABLE_XSDT                 (ACPI_TABLE_TYPE) 6
487#define ACPI_TABLE_MAX                  6
488#define NUM_ACPI_TABLE_TYPES            (ACPI_TABLE_MAX+1)
489
490
491/*
492 * Types associated with ACPI names and objects.  The first group of
493 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
494 * of the ACPI ObjectType() operator (See the ACPI Spec).  Therefore,
495 * only add to the first group if the spec changes.
496 *
497 * Types must be kept in sync with the global AcpiNsProperties
498 * and AcpiNsTypeNames arrays.
499 */
500typedef UINT32                          ACPI_OBJECT_TYPE;
501
502#define ACPI_TYPE_ANY                   0x00
503#define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
504#define ACPI_TYPE_STRING                0x02
505#define ACPI_TYPE_BUFFER                0x03
506#define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
507#define ACPI_TYPE_FIELD_UNIT            0x05
508#define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
509#define ACPI_TYPE_EVENT                 0x07
510#define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
511#define ACPI_TYPE_MUTEX                 0x09
512#define ACPI_TYPE_REGION                0x0A
513#define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
514#define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
515#define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
516#define ACPI_TYPE_BUFFER_FIELD          0x0E
517#define ACPI_TYPE_DDB_HANDLE            0x0F
518#define ACPI_TYPE_DEBUG_OBJECT          0x10
519
520#define ACPI_TYPE_EXTERNAL_MAX          0x10
521
522/*
523 * These are object types that do not map directly to the ACPI
524 * ObjectType() operator. They are used for various internal purposes only.
525 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
526 * internal types must move upwards. (There is code that depends on these
527 * values being contiguous with the external types above.)
528 */
529#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
530#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
531#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
532#define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
533#define ACPI_TYPE_LOCAL_ALIAS           0x15
534#define ACPI_TYPE_LOCAL_NOTIFY          0x16
535#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x17
536#define ACPI_TYPE_LOCAL_RESOURCE        0x18
537#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x19
538#define ACPI_TYPE_LOCAL_SCOPE           0x1A  /* 1 Name, multiple ObjectList Nodes */
539
540#define ACPI_TYPE_NS_NODE_MAX           0x1A  /* Last typecode used within a NS Node */
541
542/*
543 * These are special object types that never appear in
544 * a Namespace node, only in an ACPI_OPERAND_OBJECT
545 */
546#define ACPI_TYPE_LOCAL_EXTRA           0x1B
547#define ACPI_TYPE_LOCAL_DATA            0x1C
548
549#define ACPI_TYPE_LOCAL_MAX             0x1C
550
551/* All types above here are invalid */
552
553#define ACPI_TYPE_INVALID               0x1D
554#define ACPI_TYPE_NOT_FOUND             0xFF
555
556
557/*
558 * Bitmapped ACPI types.  Used internally only
559 */
560#define ACPI_BTYPE_ANY                  0x00000000
561#define ACPI_BTYPE_INTEGER              0x00000001
562#define ACPI_BTYPE_STRING               0x00000002
563#define ACPI_BTYPE_BUFFER               0x00000004
564#define ACPI_BTYPE_PACKAGE              0x00000008
565#define ACPI_BTYPE_FIELD_UNIT           0x00000010
566#define ACPI_BTYPE_DEVICE               0x00000020
567#define ACPI_BTYPE_EVENT                0x00000040
568#define ACPI_BTYPE_METHOD               0x00000080
569#define ACPI_BTYPE_MUTEX                0x00000100
570#define ACPI_BTYPE_REGION               0x00000200
571#define ACPI_BTYPE_POWER                0x00000400
572#define ACPI_BTYPE_PROCESSOR            0x00000800
573#define ACPI_BTYPE_THERMAL              0x00001000
574#define ACPI_BTYPE_BUFFER_FIELD         0x00002000
575#define ACPI_BTYPE_DDB_HANDLE           0x00004000
576#define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
577#define ACPI_BTYPE_REFERENCE            0x00010000
578#define ACPI_BTYPE_RESOURCE             0x00020000
579
580#define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
581
582#define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
583#define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
584#define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
585#define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
586#define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
587
588/*
589 * All I/O
590 */
591#define ACPI_READ                       0
592#define ACPI_WRITE                      1
593#define ACPI_IO_MASK                    1
594
595
596/*
597 * Acpi Event Types: Fixed & General Purpose
598 */
599typedef UINT32                          ACPI_EVENT_TYPE;
600
601/*
602 * Fixed events
603 */
604#define ACPI_EVENT_PMTIMER              0
605#define ACPI_EVENT_GLOBAL               1
606#define ACPI_EVENT_POWER_BUTTON         2
607#define ACPI_EVENT_SLEEP_BUTTON         3
608#define ACPI_EVENT_RTC                  4
609#define ACPI_EVENT_MAX                  4
610#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
611
612#define ACPI_GPE_INVALID                0xFF
613#define ACPI_GPE_MAX                    0xFF
614#define ACPI_NUM_GPE                    256
615
616#define ACPI_EVENT_LEVEL_TRIGGERED      1
617#define ACPI_EVENT_EDGE_TRIGGERED       2
618
619/*
620 * Flags for GPE and Lock interfaces
621 */
622#define ACPI_EVENT_WAKE_ENABLE          0x2
623#define ACPI_EVENT_WAKE_DISABLE         0x2
624
625#define ACPI_NOT_ISR                    0x1
626#define ACPI_ISR                        0x0
627
628
629/*
630 * AcpiEvent Status:
631 * -------------
632 * The encoding of ACPI_EVENT_STATUS is illustrated below.
633 * Note that a set bit (1) indicates the property is TRUE
634 * (e.g. if bit 0 is set then the event is enabled).
635 * +-------------+-+-+-+
636 * |   Bits 31:3 |2|1|0|
637 * +-------------+-+-+-+
638 *          |     | | |
639 *          |     | | +- Enabled?
640 *          |     | +--- Enabled for wake?
641 *          |     +----- Set?
642 *          +----------- <Reserved>
643 */
644typedef UINT32                          ACPI_EVENT_STATUS;
645
646#define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
647#define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
648#define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
649#define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
650
651
652/* Notify types */
653
654#define ACPI_SYSTEM_NOTIFY              0
655#define ACPI_DEVICE_NOTIFY              1
656#define ACPI_MAX_NOTIFY_HANDLER_TYPE    1
657
658#define ACPI_MAX_SYS_NOTIFY             0x7f
659
660
661/* Address Space (Operation Region) Types */
662
663typedef UINT8                           ACPI_ADR_SPACE_TYPE;
664
665#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
666#define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
667#define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
668#define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
669#define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
670#define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
671#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
672#define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 7
673#define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 127
674
675
676/*
677 * BitRegister IDs
678 * These are bitfields defined within the full ACPI registers
679 */
680#define ACPI_BITREG_TIMER_STATUS                0x00
681#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
682#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
683#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
684#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
685#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
686#define ACPI_BITREG_WAKE_STATUS                 0x06
687
688#define ACPI_BITREG_TIMER_ENABLE                0x07
689#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x08
690#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x09
691#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0A
692#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0B
693#define ACPI_BITREG_WAKE_ENABLE                 0x0C
694
695#define ACPI_BITREG_SCI_ENABLE                  0x0D
696#define ACPI_BITREG_BUS_MASTER_RLD              0x0E
697#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x0F
698#define ACPI_BITREG_SLEEP_TYPE_A                0x10
699#define ACPI_BITREG_SLEEP_TYPE_B                0x11
700#define ACPI_BITREG_SLEEP_ENABLE                0x12
701
702#define ACPI_BITREG_ARB_DISABLE                 0x13
703
704#define ACPI_BITREG_MAX                         0x13
705#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
706
707
708/*
709 * External ACPI object definition
710 */
711typedef union acpi_object
712{
713    ACPI_OBJECT_TYPE            Type;   /* See definition of AcpiNsType for values */
714    struct
715    {
716        ACPI_OBJECT_TYPE            Type;
717        ACPI_INTEGER                Value;      /* The actual number */
718    } Integer;
719
720    struct
721    {
722        ACPI_OBJECT_TYPE            Type;
723        UINT32                      Length;     /* # of bytes in string, excluding trailing null */
724        char                        *Pointer;   /* points to the string value */
725    } String;
726
727    struct
728    {
729        ACPI_OBJECT_TYPE            Type;
730        UINT32                      Length;     /* # of bytes in buffer */
731        UINT8                       *Pointer;   /* points to the buffer */
732    } Buffer;
733
734    struct
735    {
736        ACPI_OBJECT_TYPE            Type;
737        UINT32                      Fill1;
738        ACPI_HANDLE                 Handle;     /* object reference */
739    } Reference;
740
741    struct
742    {
743        ACPI_OBJECT_TYPE            Type;
744        UINT32                      Count;      /* # of elements in package */
745        union acpi_object           *Elements;  /* Pointer to an array of ACPI_OBJECTs */
746    } Package;
747
748    struct
749    {
750        ACPI_OBJECT_TYPE            Type;
751        UINT32                      ProcId;
752        ACPI_IO_ADDRESS             PblkAddress;
753        UINT32                      PblkLength;
754    } Processor;
755
756    struct
757    {
758        ACPI_OBJECT_TYPE            Type;
759        UINT32                      SystemLevel;
760        UINT32                      ResourceOrder;
761    } PowerResource;
762
763} ACPI_OBJECT;
764
765
766/*
767 * List of objects, used as a parameter list for control method evaluation
768 */
769typedef struct acpi_object_list
770{
771    UINT32                      Count;
772    ACPI_OBJECT                 *Pointer;
773
774} ACPI_OBJECT_LIST;
775
776
777/*
778 * Miscellaneous common Data Structures used by the interfaces
779 */
780#define ACPI_NO_BUFFER              0
781#define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
782#define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
783
784typedef struct acpi_buffer
785{
786    ACPI_SIZE                   Length;         /* Length in bytes of the buffer */
787    void                        *Pointer;       /* pointer to buffer */
788
789} ACPI_BUFFER;
790
791
792/*
793 * NameType for AcpiGetName
794 */
795#define ACPI_FULL_PATHNAME              0
796#define ACPI_SINGLE_NAME                1
797#define ACPI_NAME_TYPE_MAX              1
798
799
800/*
801 * Structure and flags for AcpiGetSystemInfo
802 */
803#define ACPI_SYS_MODE_UNKNOWN           0x0000
804#define ACPI_SYS_MODE_ACPI              0x0001
805#define ACPI_SYS_MODE_LEGACY            0x0002
806#define ACPI_SYS_MODES_MASK             0x0003
807
808
809/*
810 * ACPI Table Info.  One per ACPI table _type_
811 */
812typedef struct acpi_table_info
813{
814    UINT32                      Count;
815
816} ACPI_TABLE_INFO;
817
818
819/*
820 * System info returned by AcpiGetSystemInfo()
821 */
822typedef struct acpi_system_info
823{
824    UINT32                      AcpiCaVersion;
825    UINT32                      Flags;
826    UINT32                      TimerResolution;
827    UINT32                      Reserved1;
828    UINT32                      Reserved2;
829    UINT32                      DebugLevel;
830    UINT32                      DebugLayer;
831    UINT32                      NumTableTypes;
832    ACPI_TABLE_INFO             TableInfo [NUM_ACPI_TABLE_TYPES];
833
834} ACPI_SYSTEM_INFO;
835
836
837/*
838 * Types specific to the OS service interfaces
839 */
840
841typedef UINT32
842(ACPI_SYSTEM_XFACE *OSD_HANDLER) (
843    void                    *Context);
844
845typedef void
846(ACPI_SYSTEM_XFACE *OSD_EXECUTION_CALLBACK) (
847    void                    *Context);
848
849/*
850 * Various handlers and callback procedures
851 */
852typedef
853UINT32 (*ACPI_EVENT_HANDLER) (
854    void                        *Context);
855
856typedef
857void (*ACPI_GPE_HANDLER) (
858    void                        *Context);
859
860typedef
861void (*ACPI_NOTIFY_HANDLER) (
862    ACPI_HANDLE                 Device,
863    UINT32                      Value,
864    void                        *Context);
865
866typedef
867void (*ACPI_OBJECT_HANDLER) (
868    ACPI_HANDLE                 Object,
869    UINT32                      Function,
870    void                        *Data);
871
872typedef
873ACPI_STATUS (*ACPI_INIT_HANDLER) (
874    ACPI_HANDLE                 Object,
875    UINT32                      Function);
876
877#define ACPI_INIT_DEVICE_INI        1
878
879
880/* Address Spaces (Operation Regions */
881
882typedef
883ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
884    UINT32                      Function,
885    ACPI_PHYSICAL_ADDRESS       Address,
886    UINT32                      BitWidth,
887    ACPI_INTEGER                *Value,
888    void                        *HandlerContext,
889    void                        *RegionContext);
890
891#define ACPI_DEFAULT_HANDLER        NULL
892
893
894typedef
895ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
896    ACPI_HANDLE                 RegionHandle,
897    UINT32                      Function,
898    void                        *HandlerContext,
899    void                        **RegionContext);
900
901#define ACPI_REGION_ACTIVATE    0
902#define ACPI_REGION_DEACTIVATE  1
903
904typedef
905ACPI_STATUS (*ACPI_WALK_CALLBACK) (
906    ACPI_HANDLE                 ObjHandle,
907    UINT32                      NestingLevel,
908    void                        *Context,
909    void                        **ReturnValue);
910
911
912/* Interrupt handler return values */
913
914#define ACPI_INTERRUPT_NOT_HANDLED      0x00
915#define ACPI_INTERRUPT_HANDLED          0x01
916
917
918/* Common string version of device HIDs and UIDs */
919
920typedef struct acpi_device_id
921{
922    char                    Value[ACPI_DEVICE_ID_LENGTH];
923
924} ACPI_DEVICE_ID;
925
926/* Common string version of device CIDs */
927
928typedef struct acpi_compatible_id
929{
930    char                    Value[ACPI_MAX_CID_LENGTH];
931
932} ACPI_COMPATIBLE_ID;
933
934typedef struct acpi_compatible_id_list
935{
936    UINT32                  Count;
937    UINT32                  Size;
938    ACPI_COMPATIBLE_ID      Id[1];
939
940} ACPI_COMPATIBLE_ID_LIST;
941
942
943/* Structure and flags for AcpiGetObjectInfo */
944
945#define ACPI_VALID_STA                  0x0001
946#define ACPI_VALID_ADR                  0x0002
947#define ACPI_VALID_HID                  0x0004
948#define ACPI_VALID_UID                  0x0008
949#define ACPI_VALID_CID                  0x0010
950
951
952#define ACPI_COMMON_OBJ_INFO \
953    ACPI_OBJECT_TYPE            Type;           /* ACPI object type */ \
954    ACPI_NAME                   Name            /* ACPI object Name */
955
956
957typedef struct acpi_obj_info_header
958{
959    ACPI_COMMON_OBJ_INFO;
960
961} ACPI_OBJ_INFO_HEADER;
962
963
964/* Structure returned from Get Object Info */
965
966typedef struct acpi_device_info
967{
968    ACPI_COMMON_OBJ_INFO;
969
970    UINT32                      Valid;              /* Indicates which fields are valid */
971    UINT32                      CurrentStatus;      /* _STA value */
972    ACPI_INTEGER                Address;            /* _ADR value if any */
973    ACPI_DEVICE_ID              HardwareId;         /* _HID value if any */
974    ACPI_DEVICE_ID              UniqueId;           /* _UID value if any */
975    ACPI_COMPATIBLE_ID_LIST     CompatibilityId;    /* List of _CIDs if any */
976
977} ACPI_DEVICE_INFO;
978
979
980/* Context structs for address space handlers */
981
982typedef struct acpi_pci_id
983{
984    UINT16                      Segment;
985    UINT16                      Bus;
986    UINT16                      Device;
987    UINT16                      Function;
988
989} ACPI_PCI_ID;
990
991
992typedef struct acpi_mem_space_context
993{
994    UINT32                      Length;
995    ACPI_PHYSICAL_ADDRESS       Address;
996    ACPI_PHYSICAL_ADDRESS       MappedPhysicalAddress;
997    UINT8                       *MappedLogicalAddress;
998    ACPI_SIZE                   MappedLength;
999
1000} ACPI_MEM_SPACE_CONTEXT;
1001
1002
1003/*
1004 * Definitions for Resource Attributes
1005 */
1006
1007/*
1008 *  Memory Attributes
1009 */
1010#define ACPI_READ_ONLY_MEMORY           (UINT8) 0x00
1011#define ACPI_READ_WRITE_MEMORY          (UINT8) 0x01
1012
1013#define ACPI_NON_CACHEABLE_MEMORY       (UINT8) 0x00
1014#define ACPI_CACHABLE_MEMORY            (UINT8) 0x01
1015#define ACPI_WRITE_COMBINING_MEMORY     (UINT8) 0x02
1016#define ACPI_PREFETCHABLE_MEMORY        (UINT8) 0x03
1017
1018/*
1019 *  IO Attributes
1020 *  The ISA IO ranges are:     n000-n0FFh,  n400-n4FFh, n800-n8FFh, nC00-nCFFh.
1021 *  The non-ISA IO ranges are: n100-n3FFh,  n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
1022 */
1023#define ACPI_NON_ISA_ONLY_RANGES        (UINT8) 0x01
1024#define ACPI_ISA_ONLY_RANGES            (UINT8) 0x02
1025#define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
1026
1027#define ACPI_SPARSE_TRANSLATION         (UINT8) 0x03
1028
1029/*
1030 *  IO Port Descriptor Decode
1031 */
1032#define ACPI_DECODE_10                  (UINT8) 0x00    /* 10-bit IO address decode */
1033#define ACPI_DECODE_16                  (UINT8) 0x01    /* 16-bit IO address decode */
1034
1035/*
1036 *  IRQ Attributes
1037 */
1038#define ACPI_EDGE_SENSITIVE             (UINT8) 0x00
1039#define ACPI_LEVEL_SENSITIVE            (UINT8) 0x01
1040
1041#define ACPI_ACTIVE_HIGH                (UINT8) 0x00
1042#define ACPI_ACTIVE_LOW                 (UINT8) 0x01
1043
1044#define ACPI_EXCLUSIVE                  (UINT8) 0x00
1045#define ACPI_SHARED                     (UINT8) 0x01
1046
1047/*
1048 *  DMA Attributes
1049 */
1050#define ACPI_COMPATIBILITY              (UINT8) 0x00
1051#define ACPI_TYPE_A                     (UINT8) 0x01
1052#define ACPI_TYPE_B                     (UINT8) 0x02
1053#define ACPI_TYPE_F                     (UINT8) 0x03
1054
1055#define ACPI_NOT_BUS_MASTER             (UINT8) 0x00
1056#define ACPI_BUS_MASTER                 (UINT8) 0x01
1057
1058#define ACPI_TRANSFER_8                 (UINT8) 0x00
1059#define ACPI_TRANSFER_8_16              (UINT8) 0x01
1060#define ACPI_TRANSFER_16                (UINT8) 0x02
1061
1062/*
1063 * Start Dependent Functions Priority definitions
1064 */
1065#define ACPI_GOOD_CONFIGURATION         (UINT8) 0x00
1066#define ACPI_ACCEPTABLE_CONFIGURATION   (UINT8) 0x01
1067#define ACPI_SUB_OPTIMAL_CONFIGURATION  (UINT8) 0x02
1068
1069/*
1070 *  16, 32 and 64-bit Address Descriptor resource types
1071 */
1072#define ACPI_MEMORY_RANGE               (UINT8) 0x00
1073#define ACPI_IO_RANGE                   (UINT8) 0x01
1074#define ACPI_BUS_NUMBER_RANGE           (UINT8) 0x02
1075
1076#define ACPI_ADDRESS_NOT_FIXED          (UINT8) 0x00
1077#define ACPI_ADDRESS_FIXED              (UINT8) 0x01
1078
1079#define ACPI_POS_DECODE                 (UINT8) 0x00
1080#define ACPI_SUB_DECODE                 (UINT8) 0x01
1081
1082#define ACPI_PRODUCER                   (UINT8) 0x00
1083#define ACPI_CONSUMER                   (UINT8) 0x01
1084
1085
1086/*
1087 *  Structures used to describe device resources
1088 */
1089typedef struct acpi_resource_irq
1090{
1091    UINT32                      EdgeLevel;
1092    UINT32                      ActiveHighLow;
1093    UINT32                      SharedExclusive;
1094    UINT32                      NumberOfInterrupts;
1095    UINT32                      Interrupts[1];
1096
1097} ACPI_RESOURCE_IRQ;
1098
1099typedef struct ACPI_RESOURCE_DMA
1100{
1101    UINT32                      Type;
1102    UINT32                      BusMaster;
1103    UINT32                      Transfer;
1104    UINT32                      NumberOfChannels;
1105    UINT32                      Channels[1];
1106
1107} ACPI_RESOURCE_DMA;
1108
1109typedef struct acpi_resource_start_dpf
1110{
1111    UINT32                      CompatibilityPriority;
1112    UINT32                      PerformanceRobustness;
1113
1114} ACPI_RESOURCE_START_DPF;
1115
1116/*
1117 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1118 * needed because it has no fields
1119 */
1120
1121typedef struct acpi_resource_io
1122{
1123    UINT32                      IoDecode;
1124    UINT32                      MinBaseAddress;
1125    UINT32                      MaxBaseAddress;
1126    UINT32                      Alignment;
1127    UINT32                      RangeLength;
1128
1129} ACPI_RESOURCE_IO;
1130
1131typedef struct acpi_resource_fixed_io
1132{
1133    UINT32                      BaseAddress;
1134    UINT32                      RangeLength;
1135
1136} ACPI_RESOURCE_FIXED_IO;
1137
1138typedef struct acpi_resource_vendor
1139{
1140    UINT32                      Length;
1141    UINT8                       Reserved[1];
1142
1143} ACPI_RESOURCE_VENDOR;
1144
1145typedef struct acpi_resource_end_tag
1146{
1147    UINT8                       Checksum;
1148
1149} ACPI_RESOURCE_END_TAG;
1150
1151typedef struct acpi_resource_mem24
1152{
1153    UINT32                      ReadWriteAttribute;
1154    UINT32                      MinBaseAddress;
1155    UINT32                      MaxBaseAddress;
1156    UINT32                      Alignment;
1157    UINT32                      RangeLength;
1158
1159} ACPI_RESOURCE_MEM24;
1160
1161typedef struct acpi_resource_mem32
1162{
1163    UINT32                      ReadWriteAttribute;
1164    UINT32                      MinBaseAddress;
1165    UINT32                      MaxBaseAddress;
1166    UINT32                      Alignment;
1167    UINT32                      RangeLength;
1168
1169} ACPI_RESOURCE_MEM32;
1170
1171typedef struct acpi_resource_fixed_mem32
1172{
1173    UINT32                      ReadWriteAttribute;
1174    UINT32                      RangeBaseAddress;
1175    UINT32                      RangeLength;
1176
1177} ACPI_RESOURCE_FIXED_MEM32;
1178
1179typedef struct acpi_memory_attribute
1180{
1181    UINT16                      CacheAttribute;
1182    UINT16                      ReadWriteAttribute;
1183
1184} ACPI_MEMORY_ATTRIBUTE;
1185
1186typedef struct acpi_io_attribute
1187{
1188    UINT16                      RangeAttribute;
1189    UINT16                      TranslationAttribute;
1190
1191} ACPI_IO_ATTRIBUTE;
1192
1193typedef struct acpi_bus_attribute
1194{
1195    UINT16                      Reserved1;
1196    UINT16                      Reserved2;
1197
1198} ACPI_BUS_ATTRIBUTE;
1199
1200typedef union acpi_resource_attribute
1201{
1202    ACPI_MEMORY_ATTRIBUTE       Memory;
1203    ACPI_IO_ATTRIBUTE           Io;
1204    ACPI_BUS_ATTRIBUTE          Bus;
1205
1206} ACPI_RESOURCE_ATTRIBUTE;
1207
1208typedef struct acpi_resource_source
1209{
1210    UINT32                      Index;
1211    UINT32                      StringLength;
1212    char                        *StringPtr;
1213
1214} ACPI_RESOURCE_SOURCE;
1215
1216typedef struct acpi_resource_address16
1217{
1218    UINT32                      ResourceType;
1219    UINT32                      ProducerConsumer;
1220    UINT32                      Decode;
1221    UINT32                      MinAddressFixed;
1222    UINT32                      MaxAddressFixed;
1223    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1224    UINT32                      Granularity;
1225    UINT32                      MinAddressRange;
1226    UINT32                      MaxAddressRange;
1227    UINT32                      AddressTranslationOffset;
1228    UINT32                      AddressLength;
1229    ACPI_RESOURCE_SOURCE        ResourceSource;
1230
1231} ACPI_RESOURCE_ADDRESS16;
1232
1233typedef struct acpi_resource_address32
1234{
1235    UINT32                      ResourceType;
1236    UINT32                      ProducerConsumer;
1237    UINT32                      Decode;
1238    UINT32                      MinAddressFixed;
1239    UINT32                      MaxAddressFixed;
1240    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1241    UINT32                      Granularity;
1242    UINT32                      MinAddressRange;
1243    UINT32                      MaxAddressRange;
1244    UINT32                      AddressTranslationOffset;
1245    UINT32                      AddressLength;
1246    ACPI_RESOURCE_SOURCE        ResourceSource;
1247
1248} ACPI_RESOURCE_ADDRESS32;
1249
1250typedef struct acpi_resource_address64
1251{
1252    UINT32                      ResourceType;
1253    UINT32                      ProducerConsumer;
1254    UINT32                      Decode;
1255    UINT32                      MinAddressFixed;
1256    UINT32                      MaxAddressFixed;
1257    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1258    UINT64                      Granularity;
1259    UINT64                      MinAddressRange;
1260    UINT64                      MaxAddressRange;
1261    UINT64                      AddressTranslationOffset;
1262    UINT64                      AddressLength;
1263    ACPI_RESOURCE_SOURCE        ResourceSource;
1264
1265} ACPI_RESOURCE_ADDRESS64;
1266
1267typedef struct acpi_resource_ext_irq
1268{
1269    UINT32                      ProducerConsumer;
1270    UINT32                      EdgeLevel;
1271    UINT32                      ActiveHighLow;
1272    UINT32                      SharedExclusive;
1273    UINT32                      NumberOfInterrupts;
1274    ACPI_RESOURCE_SOURCE        ResourceSource;
1275    UINT32                      Interrupts[1];
1276
1277} ACPI_RESOURCE_EXT_IRQ;
1278
1279
1280/* ACPI_RESOURCE_TYPEs */
1281
1282#define ACPI_RSTYPE_IRQ                 0
1283#define ACPI_RSTYPE_DMA                 1
1284#define ACPI_RSTYPE_START_DPF           2
1285#define ACPI_RSTYPE_END_DPF             3
1286#define ACPI_RSTYPE_IO                  4
1287#define ACPI_RSTYPE_FIXED_IO            5
1288#define ACPI_RSTYPE_VENDOR              6
1289#define ACPI_RSTYPE_END_TAG             7
1290#define ACPI_RSTYPE_MEM24               8
1291#define ACPI_RSTYPE_MEM32               9
1292#define ACPI_RSTYPE_FIXED_MEM32         10
1293#define ACPI_RSTYPE_ADDRESS16           11
1294#define ACPI_RSTYPE_ADDRESS32           12
1295#define ACPI_RSTYPE_ADDRESS64           13
1296#define ACPI_RSTYPE_EXT_IRQ             14
1297
1298typedef UINT32                          ACPI_RESOURCE_TYPE;
1299
1300typedef union acpi_resource_data
1301{
1302    ACPI_RESOURCE_IRQ           Irq;
1303    ACPI_RESOURCE_DMA           Dma;
1304    ACPI_RESOURCE_START_DPF     StartDpf;
1305    ACPI_RESOURCE_IO            Io;
1306    ACPI_RESOURCE_FIXED_IO      FixedIo;
1307    ACPI_RESOURCE_VENDOR        VendorSpecific;
1308    ACPI_RESOURCE_END_TAG       EndTag;
1309    ACPI_RESOURCE_MEM24         Memory24;
1310    ACPI_RESOURCE_MEM32         Memory32;
1311    ACPI_RESOURCE_FIXED_MEM32   FixedMemory32;
1312    ACPI_RESOURCE_ADDRESS16     Address16;
1313    ACPI_RESOURCE_ADDRESS32     Address32;
1314    ACPI_RESOURCE_ADDRESS64     Address64;
1315    ACPI_RESOURCE_EXT_IRQ       ExtendedIrq;
1316
1317} ACPI_RESOURCE_DATA;
1318
1319typedef struct acpi_resource
1320{
1321    ACPI_RESOURCE_TYPE          Id;
1322    UINT32                      Length;
1323    ACPI_RESOURCE_DATA          Data;
1324
1325} ACPI_RESOURCE;
1326
1327#define ACPI_RESOURCE_LENGTH                12
1328#define ACPI_RESOURCE_LENGTH_NO_DATA        8       /* Id + Length fields */
1329
1330#define ACPI_SIZEOF_RESOURCE(Type)          (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (Type))
1331
1332#define ACPI_NEXT_RESOURCE(Res)             (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length)
1333
1334#ifdef ACPI_MISALIGNED_TRANSFERS
1335#define ACPI_ALIGN_RESOURCE_SIZE(Length)    (Length)
1336#else
1337#define ACPI_ALIGN_RESOURCE_SIZE(Length)    ACPI_ROUND_UP_TO_NATIVE_WORD(Length)
1338#endif
1339
1340/*
1341 * END: of definitions for Resource Attributes
1342 */
1343
1344
1345typedef struct acpi_pci_routing_table
1346{
1347    UINT32                      Length;
1348    UINT32                      Pin;
1349    ACPI_INTEGER                Address;        /* here for 64-bit alignment */
1350    UINT32                      SourceIndex;
1351    char                        Source[4];      /* pad to 64 bits so sizeof() works in all cases */
1352
1353} ACPI_PCI_ROUTING_TABLE;
1354
1355/*
1356 * END: of definitions for PCI Routing tables
1357 */
1358
1359
1360#endif /* __ACTYPES_H__ */
1361