actypes.h revision 126372
1/******************************************************************************
2 *
3 * Name: actypes.h - Common data types for the entire ACPI subsystem
4 *       $Revision: 264 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 UINT16                          UINT16_BIT;
285typedef UINT32                          UINT32_BIT;
286typedef ACPI_NATIVE_UINT                ACPI_PTRDIFF;
287
288/*
289 * Pointer overlays to avoid lots of typecasting for
290 * code that accepts both physical and logical pointers.
291 */
292typedef union acpi_pointers
293{
294    ACPI_PHYSICAL_ADDRESS       Physical;
295    void                        *Logical;
296    ACPI_TABLE_PTR              Value;
297
298} ACPI_POINTERS;
299
300typedef struct acpi_pointer
301{
302    UINT32                      PointerType;
303    union acpi_pointers         Pointer;
304
305} ACPI_POINTER;
306
307/* PointerTypes for above */
308
309#define ACPI_PHYSICAL_POINTER           0x01
310#define ACPI_LOGICAL_POINTER            0x02
311
312/* Processor mode */
313
314#define ACPI_PHYSICAL_ADDRESSING        0x04
315#define ACPI_LOGICAL_ADDRESSING         0x08
316#define ACPI_MEMORY_MODE                0x0C
317
318#define ACPI_PHYSMODE_PHYSPTR           ACPI_PHYSICAL_ADDRESSING | ACPI_PHYSICAL_POINTER
319#define ACPI_LOGMODE_PHYSPTR            ACPI_LOGICAL_ADDRESSING  | ACPI_PHYSICAL_POINTER
320#define ACPI_LOGMODE_LOGPTR             ACPI_LOGICAL_ADDRESSING  | ACPI_LOGICAL_POINTER
321
322
323/*
324 * Useful defines
325 */
326#ifdef FALSE
327#undef FALSE
328#endif
329#define FALSE                           (1 == 0)
330
331#ifdef TRUE
332#undef TRUE
333#endif
334#define TRUE                            (1 == 1)
335
336#ifndef NULL
337#define NULL                            (void *) 0
338#endif
339
340
341/*
342 * Local datatypes
343 */
344typedef UINT32                          ACPI_STATUS;    /* All ACPI Exceptions */
345typedef UINT32                          ACPI_NAME;      /* 4-byte ACPI name */
346typedef char *                          ACPI_STRING;    /* Null terminated ASCII string */
347typedef void *                          ACPI_HANDLE;    /* Actually a ptr to an Node */
348
349typedef struct uint64_struct
350{
351    UINT32                      Lo;
352    UINT32                      Hi;
353
354} UINT64_STRUCT;
355
356typedef union uint64_overlay
357{
358    UINT64                      Full;
359    UINT64_STRUCT               Part;
360
361} UINT64_OVERLAY;
362
363typedef struct uint32_struct
364{
365    UINT32                      Lo;
366    UINT32                      Hi;
367
368} UINT32_STRUCT;
369
370
371/*
372 * Acpi integer width. In ACPI version 1, integers are
373 * 32 bits.  In ACPI version 2, integers are 64 bits.
374 * Note that this pertains to the ACPI integer type only, not
375 * other integers used in the implementation of the ACPI CA
376 * subsystem.
377 */
378#ifdef ACPI_NO_INTEGER64_SUPPORT
379
380/* 32-bit integers only, no 64-bit support */
381
382typedef UINT32                          ACPI_INTEGER;
383#define ACPI_INTEGER_MAX                ACPI_UINT32_MAX
384#define ACPI_INTEGER_BIT_SIZE           32
385#define ACPI_MAX_DECIMAL_DIGITS         10
386
387#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 32-bit divide */
388
389
390#else
391
392/* 64-bit integers */
393
394typedef UINT64                          ACPI_INTEGER;
395#define ACPI_INTEGER_MAX                ACPI_UINT64_MAX
396#define ACPI_INTEGER_BIT_SIZE           64
397#define ACPI_MAX_DECIMAL_DIGITS         19
398
399#if ACPI_MACHINE_WIDTH == 64
400#define ACPI_USE_NATIVE_DIVIDE          /* Use compiler native 64-bit divide */
401#endif
402#endif
403
404
405/*
406 * Constants with special meanings
407 */
408#define ACPI_ROOT_OBJECT                (ACPI_HANDLE) ACPI_PTR_ADD (char, NULL, ACPI_MAX_PTR)
409
410
411/*
412 * Initialization sequence
413 */
414#define ACPI_FULL_INITIALIZATION        0x00
415#define ACPI_NO_ADDRESS_SPACE_INIT      0x01
416#define ACPI_NO_HARDWARE_INIT           0x02
417#define ACPI_NO_EVENT_INIT              0x04
418#define ACPI_NO_HANDLER_INIT            0x08
419#define ACPI_NO_ACPI_ENABLE             0x10
420#define ACPI_NO_DEVICE_INIT             0x20
421#define ACPI_NO_OBJECT_INIT             0x40
422
423/*
424 * Initialization state
425 */
426#define ACPI_INITIALIZED_OK             0x01
427
428/*
429 * Power state values
430 */
431
432#define ACPI_STATE_UNKNOWN              (UINT8) 0xFF
433
434#define ACPI_STATE_S0                   (UINT8) 0
435#define ACPI_STATE_S1                   (UINT8) 1
436#define ACPI_STATE_S2                   (UINT8) 2
437#define ACPI_STATE_S3                   (UINT8) 3
438#define ACPI_STATE_S4                   (UINT8) 4
439#define ACPI_STATE_S5                   (UINT8) 5
440#define ACPI_S_STATES_MAX               ACPI_STATE_S5
441#define ACPI_S_STATE_COUNT              6
442
443#define ACPI_STATE_D0                   (UINT8) 0
444#define ACPI_STATE_D1                   (UINT8) 1
445#define ACPI_STATE_D2                   (UINT8) 2
446#define ACPI_STATE_D3                   (UINT8) 3
447#define ACPI_D_STATES_MAX               ACPI_STATE_D3
448#define ACPI_D_STATE_COUNT              4
449
450#define ACPI_STATE_C0                   (UINT8) 0
451#define ACPI_STATE_C1                   (UINT8) 1
452#define ACPI_STATE_C2                   (UINT8) 2
453#define ACPI_STATE_C3                   (UINT8) 3
454#define ACPI_C_STATES_MAX               ACPI_STATE_C3
455#define ACPI_C_STATE_COUNT              4
456
457/*
458 * Sleep type invalid value
459 */
460#define ACPI_SLEEP_TYPE_MAX             0x7
461#define ACPI_SLEEP_TYPE_INVALID         0xFF
462
463/*
464 * Standard notify values
465 */
466#define ACPI_NOTIFY_BUS_CHECK           (UINT8) 0
467#define ACPI_NOTIFY_DEVICE_CHECK        (UINT8) 1
468#define ACPI_NOTIFY_DEVICE_WAKE         (UINT8) 2
469#define ACPI_NOTIFY_EJECT_REQUEST       (UINT8) 3
470#define ACPI_NOTIFY_DEVICE_CHECK_LIGHT  (UINT8) 4
471#define ACPI_NOTIFY_FREQUENCY_MISMATCH  (UINT8) 5
472#define ACPI_NOTIFY_BUS_MODE_MISMATCH   (UINT8) 6
473#define ACPI_NOTIFY_POWER_FAULT         (UINT8) 7
474
475
476/*
477 *  Table types.  These values are passed to the table related APIs
478 */
479typedef UINT32                          ACPI_TABLE_TYPE;
480
481#define ACPI_TABLE_RSDP                 (ACPI_TABLE_TYPE) 0
482#define ACPI_TABLE_DSDT                 (ACPI_TABLE_TYPE) 1
483#define ACPI_TABLE_FADT                 (ACPI_TABLE_TYPE) 2
484#define ACPI_TABLE_FACS                 (ACPI_TABLE_TYPE) 3
485#define ACPI_TABLE_PSDT                 (ACPI_TABLE_TYPE) 4
486#define ACPI_TABLE_SSDT                 (ACPI_TABLE_TYPE) 5
487#define ACPI_TABLE_XSDT                 (ACPI_TABLE_TYPE) 6
488#define ACPI_TABLE_MAX                  6
489#define NUM_ACPI_TABLE_TYPES            (ACPI_TABLE_MAX+1)
490
491
492/*
493 * Types associated with ACPI names and objects.  The first group of
494 * values (up to ACPI_TYPE_EXTERNAL_MAX) correspond to the definition
495 * of the ACPI ObjectType() operator (See the ACPI Spec).  Therefore,
496 * only add to the first group if the spec changes.
497 *
498 * Types must be kept in sync with the global AcpiNsProperties
499 * and AcpiNsTypeNames arrays.
500 */
501typedef UINT32                          ACPI_OBJECT_TYPE;
502
503#define ACPI_TYPE_ANY                   0x00
504#define ACPI_TYPE_INTEGER               0x01  /* Byte/Word/Dword/Zero/One/Ones */
505#define ACPI_TYPE_STRING                0x02
506#define ACPI_TYPE_BUFFER                0x03
507#define ACPI_TYPE_PACKAGE               0x04  /* ByteConst, multiple DataTerm/Constant/SuperName */
508#define ACPI_TYPE_FIELD_UNIT            0x05
509#define ACPI_TYPE_DEVICE                0x06  /* Name, multiple Node */
510#define ACPI_TYPE_EVENT                 0x07
511#define ACPI_TYPE_METHOD                0x08  /* Name, ByteConst, multiple Code */
512#define ACPI_TYPE_MUTEX                 0x09
513#define ACPI_TYPE_REGION                0x0A
514#define ACPI_TYPE_POWER                 0x0B  /* Name,ByteConst,WordConst,multi Node */
515#define ACPI_TYPE_PROCESSOR             0x0C  /* Name,ByteConst,DWordConst,ByteConst,multi NmO */
516#define ACPI_TYPE_THERMAL               0x0D  /* Name, multiple Node */
517#define ACPI_TYPE_BUFFER_FIELD          0x0E
518#define ACPI_TYPE_DDB_HANDLE            0x0F
519#define ACPI_TYPE_DEBUG_OBJECT          0x10
520
521#define ACPI_TYPE_EXTERNAL_MAX          0x10
522
523/*
524 * These are object types that do not map directly to the ACPI
525 * ObjectType() operator. They are used for various internal purposes only.
526 * If new predefined ACPI_TYPEs are added (via the ACPI specification), these
527 * internal types must move upwards. (There is code that depends on these
528 * values being contiguous with the external types above.)
529 */
530#define ACPI_TYPE_LOCAL_REGION_FIELD    0x11
531#define ACPI_TYPE_LOCAL_BANK_FIELD      0x12
532#define ACPI_TYPE_LOCAL_INDEX_FIELD     0x13
533#define ACPI_TYPE_LOCAL_REFERENCE       0x14  /* Arg#, Local#, Name, Debug, RefOf, Index */
534#define ACPI_TYPE_LOCAL_ALIAS           0x15
535#define ACPI_TYPE_LOCAL_NOTIFY          0x16
536#define ACPI_TYPE_LOCAL_ADDRESS_HANDLER 0x17
537#define ACPI_TYPE_LOCAL_RESOURCE        0x18
538#define ACPI_TYPE_LOCAL_RESOURCE_FIELD  0x19
539#define ACPI_TYPE_LOCAL_SCOPE           0x1A  /* 1 Name, multiple ObjectList Nodes */
540
541#define ACPI_TYPE_NS_NODE_MAX           0x1A  /* Last typecode used within a NS Node */
542
543/*
544 * These are special object types that never appear in
545 * a Namespace node, only in an ACPI_OPERAND_OBJECT
546 */
547#define ACPI_TYPE_LOCAL_EXTRA           0x1B
548#define ACPI_TYPE_LOCAL_DATA            0x1C
549
550#define ACPI_TYPE_LOCAL_MAX             0x1C
551
552/* All types above here are invalid */
553
554#define ACPI_TYPE_INVALID               0x1D
555#define ACPI_TYPE_NOT_FOUND             0xFF
556
557
558/*
559 * Bitmapped ACPI types.  Used internally only
560 */
561#define ACPI_BTYPE_ANY                  0x00000000
562#define ACPI_BTYPE_INTEGER              0x00000001
563#define ACPI_BTYPE_STRING               0x00000002
564#define ACPI_BTYPE_BUFFER               0x00000004
565#define ACPI_BTYPE_PACKAGE              0x00000008
566#define ACPI_BTYPE_FIELD_UNIT           0x00000010
567#define ACPI_BTYPE_DEVICE               0x00000020
568#define ACPI_BTYPE_EVENT                0x00000040
569#define ACPI_BTYPE_METHOD               0x00000080
570#define ACPI_BTYPE_MUTEX                0x00000100
571#define ACPI_BTYPE_REGION               0x00000200
572#define ACPI_BTYPE_POWER                0x00000400
573#define ACPI_BTYPE_PROCESSOR            0x00000800
574#define ACPI_BTYPE_THERMAL              0x00001000
575#define ACPI_BTYPE_BUFFER_FIELD         0x00002000
576#define ACPI_BTYPE_DDB_HANDLE           0x00004000
577#define ACPI_BTYPE_DEBUG_OBJECT         0x00008000
578#define ACPI_BTYPE_REFERENCE            0x00010000
579#define ACPI_BTYPE_RESOURCE             0x00020000
580
581#define ACPI_BTYPE_COMPUTE_DATA         (ACPI_BTYPE_INTEGER | ACPI_BTYPE_STRING | ACPI_BTYPE_BUFFER)
582
583#define ACPI_BTYPE_DATA                 (ACPI_BTYPE_COMPUTE_DATA  | ACPI_BTYPE_PACKAGE)
584#define ACPI_BTYPE_DATA_REFERENCE       (ACPI_BTYPE_DATA | ACPI_BTYPE_REFERENCE | ACPI_BTYPE_DDB_HANDLE)
585#define ACPI_BTYPE_DEVICE_OBJECTS       (ACPI_BTYPE_DEVICE | ACPI_BTYPE_THERMAL | ACPI_BTYPE_PROCESSOR)
586#define ACPI_BTYPE_OBJECTS_AND_REFS     0x0001FFFF  /* ARG or LOCAL */
587#define ACPI_BTYPE_ALL_OBJECTS          0x0000FFFF
588
589/*
590 * All I/O
591 */
592#define ACPI_READ                       0
593#define ACPI_WRITE                      1
594#define ACPI_IO_MASK                    1
595
596
597/*
598 * Acpi Event Types: Fixed & General Purpose
599 */
600typedef UINT32                          ACPI_EVENT_TYPE;
601
602/*
603 * Fixed events
604 */
605#define ACPI_EVENT_PMTIMER              0
606#define ACPI_EVENT_GLOBAL               1
607#define ACPI_EVENT_POWER_BUTTON         2
608#define ACPI_EVENT_SLEEP_BUTTON         3
609#define ACPI_EVENT_RTC                  4
610#define ACPI_EVENT_MAX                  4
611#define ACPI_NUM_FIXED_EVENTS           ACPI_EVENT_MAX + 1
612
613#define ACPI_GPE_INVALID                0xFF
614#define ACPI_GPE_MAX                    0xFF
615#define ACPI_NUM_GPE                    256
616
617#define ACPI_EVENT_LEVEL_TRIGGERED      1
618#define ACPI_EVENT_EDGE_TRIGGERED       2
619
620/*
621 * Flags for GPE and Lock interfaces
622 */
623#define ACPI_EVENT_WAKE_ENABLE          0x2
624#define ACPI_EVENT_WAKE_DISABLE         0x2
625
626#define ACPI_NOT_ISR                    0x1
627#define ACPI_ISR                        0x0
628
629
630/*
631 * AcpiEvent Status:
632 * -------------
633 * The encoding of ACPI_EVENT_STATUS is illustrated below.
634 * Note that a set bit (1) indicates the property is TRUE
635 * (e.g. if bit 0 is set then the event is enabled).
636 * +-------------+-+-+-+
637 * |   Bits 31:3 |2|1|0|
638 * +-------------+-+-+-+
639 *          |     | | |
640 *          |     | | +- Enabled?
641 *          |     | +--- Enabled for wake?
642 *          |     +----- Set?
643 *          +----------- <Reserved>
644 */
645typedef UINT32                          ACPI_EVENT_STATUS;
646
647#define ACPI_EVENT_FLAG_DISABLED        (ACPI_EVENT_STATUS) 0x00
648#define ACPI_EVENT_FLAG_ENABLED         (ACPI_EVENT_STATUS) 0x01
649#define ACPI_EVENT_FLAG_WAKE_ENABLED    (ACPI_EVENT_STATUS) 0x02
650#define ACPI_EVENT_FLAG_SET             (ACPI_EVENT_STATUS) 0x04
651
652
653/* Notify types */
654
655#define ACPI_SYSTEM_NOTIFY              0
656#define ACPI_DEVICE_NOTIFY              1
657#define ACPI_MAX_NOTIFY_HANDLER_TYPE    1
658
659#define ACPI_MAX_SYS_NOTIFY             0x7f
660
661
662/* Address Space (Operation Region) Types */
663
664typedef UINT8                           ACPI_ADR_SPACE_TYPE;
665
666#define ACPI_ADR_SPACE_SYSTEM_MEMORY    (ACPI_ADR_SPACE_TYPE) 0
667#define ACPI_ADR_SPACE_SYSTEM_IO        (ACPI_ADR_SPACE_TYPE) 1
668#define ACPI_ADR_SPACE_PCI_CONFIG       (ACPI_ADR_SPACE_TYPE) 2
669#define ACPI_ADR_SPACE_EC               (ACPI_ADR_SPACE_TYPE) 3
670#define ACPI_ADR_SPACE_SMBUS            (ACPI_ADR_SPACE_TYPE) 4
671#define ACPI_ADR_SPACE_CMOS             (ACPI_ADR_SPACE_TYPE) 5
672#define ACPI_ADR_SPACE_PCI_BAR_TARGET   (ACPI_ADR_SPACE_TYPE) 6
673#define ACPI_ADR_SPACE_DATA_TABLE       (ACPI_ADR_SPACE_TYPE) 7
674#define ACPI_ADR_SPACE_FIXED_HARDWARE   (ACPI_ADR_SPACE_TYPE) 127
675
676
677/*
678 * BitRegister IDs
679 * These are bitfields defined within the full ACPI registers
680 */
681#define ACPI_BITREG_TIMER_STATUS                0x00
682#define ACPI_BITREG_BUS_MASTER_STATUS           0x01
683#define ACPI_BITREG_GLOBAL_LOCK_STATUS          0x02
684#define ACPI_BITREG_POWER_BUTTON_STATUS         0x03
685#define ACPI_BITREG_SLEEP_BUTTON_STATUS         0x04
686#define ACPI_BITREG_RT_CLOCK_STATUS             0x05
687#define ACPI_BITREG_WAKE_STATUS                 0x06
688
689#define ACPI_BITREG_TIMER_ENABLE                0x07
690#define ACPI_BITREG_GLOBAL_LOCK_ENABLE          0x08
691#define ACPI_BITREG_POWER_BUTTON_ENABLE         0x09
692#define ACPI_BITREG_SLEEP_BUTTON_ENABLE         0x0A
693#define ACPI_BITREG_RT_CLOCK_ENABLE             0x0B
694#define ACPI_BITREG_WAKE_ENABLE                 0x0C
695
696#define ACPI_BITREG_SCI_ENABLE                  0x0D
697#define ACPI_BITREG_BUS_MASTER_RLD              0x0E
698#define ACPI_BITREG_GLOBAL_LOCK_RELEASE         0x0F
699#define ACPI_BITREG_SLEEP_TYPE_A                0x10
700#define ACPI_BITREG_SLEEP_TYPE_B                0x11
701#define ACPI_BITREG_SLEEP_ENABLE                0x12
702
703#define ACPI_BITREG_ARB_DISABLE                 0x13
704
705#define ACPI_BITREG_MAX                         0x13
706#define ACPI_NUM_BITREG                         ACPI_BITREG_MAX + 1
707
708
709/*
710 * External ACPI object definition
711 */
712typedef union acpi_object
713{
714    ACPI_OBJECT_TYPE            Type;   /* See definition of AcpiNsType for values */
715    struct
716    {
717        ACPI_OBJECT_TYPE            Type;
718        ACPI_INTEGER                Value;      /* The actual number */
719    } Integer;
720
721    struct
722    {
723        ACPI_OBJECT_TYPE            Type;
724        UINT32                      Length;     /* # of bytes in string, excluding trailing null */
725        char                        *Pointer;   /* points to the string value */
726    } String;
727
728    struct
729    {
730        ACPI_OBJECT_TYPE            Type;
731        UINT32                      Length;     /* # of bytes in buffer */
732        UINT8                       *Pointer;   /* points to the buffer */
733    } Buffer;
734
735    struct
736    {
737        ACPI_OBJECT_TYPE            Type;
738        UINT32                      Fill1;
739        ACPI_HANDLE                 Handle;     /* object reference */
740    } Reference;
741
742    struct
743    {
744        ACPI_OBJECT_TYPE            Type;
745        UINT32                      Count;      /* # of elements in package */
746        union acpi_object           *Elements;  /* Pointer to an array of ACPI_OBJECTs */
747    } Package;
748
749    struct
750    {
751        ACPI_OBJECT_TYPE            Type;
752        UINT32                      ProcId;
753        ACPI_IO_ADDRESS             PblkAddress;
754        UINT32                      PblkLength;
755    } Processor;
756
757    struct
758    {
759        ACPI_OBJECT_TYPE            Type;
760        UINT32                      SystemLevel;
761        UINT32                      ResourceOrder;
762    } PowerResource;
763
764} ACPI_OBJECT;
765
766
767/*
768 * List of objects, used as a parameter list for control method evaluation
769 */
770typedef struct acpi_object_list
771{
772    UINT32                      Count;
773    ACPI_OBJECT                 *Pointer;
774
775} ACPI_OBJECT_LIST;
776
777
778/*
779 * Miscellaneous common Data Structures used by the interfaces
780 */
781#define ACPI_NO_BUFFER              0
782#define ACPI_ALLOCATE_BUFFER        (ACPI_SIZE) (-1)
783#define ACPI_ALLOCATE_LOCAL_BUFFER  (ACPI_SIZE) (-2)
784
785typedef struct acpi_buffer
786{
787    ACPI_SIZE                   Length;         /* Length in bytes of the buffer */
788    void                        *Pointer;       /* pointer to buffer */
789
790} ACPI_BUFFER;
791
792
793/*
794 * NameType for AcpiGetName
795 */
796#define ACPI_FULL_PATHNAME              0
797#define ACPI_SINGLE_NAME                1
798#define ACPI_NAME_TYPE_MAX              1
799
800
801/*
802 * Structure and flags for AcpiGetSystemInfo
803 */
804#define ACPI_SYS_MODE_UNKNOWN           0x0000
805#define ACPI_SYS_MODE_ACPI              0x0001
806#define ACPI_SYS_MODE_LEGACY            0x0002
807#define ACPI_SYS_MODES_MASK             0x0003
808
809
810/*
811 * ACPI Table Info.  One per ACPI table _type_
812 */
813typedef struct acpi_table_info
814{
815    UINT32                      Count;
816
817} ACPI_TABLE_INFO;
818
819
820/*
821 * System info returned by AcpiGetSystemInfo()
822 */
823typedef struct acpi_system_info
824{
825    UINT32                      AcpiCaVersion;
826    UINT32                      Flags;
827    UINT32                      TimerResolution;
828    UINT32                      Reserved1;
829    UINT32                      Reserved2;
830    UINT32                      DebugLevel;
831    UINT32                      DebugLayer;
832    UINT32                      NumTableTypes;
833    ACPI_TABLE_INFO             TableInfo [NUM_ACPI_TABLE_TYPES];
834
835} ACPI_SYSTEM_INFO;
836
837
838/*
839 * Types specific to the OS service interfaces
840 */
841
842typedef UINT32
843(ACPI_SYSTEM_XFACE *OSD_HANDLER) (
844    void                    *Context);
845
846typedef void
847(ACPI_SYSTEM_XFACE *OSD_EXECUTION_CALLBACK) (
848    void                    *Context);
849
850/*
851 * Various handlers and callback procedures
852 */
853typedef
854UINT32 (*ACPI_EVENT_HANDLER) (
855    void                        *Context);
856
857typedef
858void (*ACPI_GPE_HANDLER) (
859    void                        *Context);
860
861typedef
862void (*ACPI_NOTIFY_HANDLER) (
863    ACPI_HANDLE                 Device,
864    UINT32                      Value,
865    void                        *Context);
866
867typedef
868void (*ACPI_OBJECT_HANDLER) (
869    ACPI_HANDLE                 Object,
870    UINT32                      Function,
871    void                        *Data);
872
873typedef
874ACPI_STATUS (*ACPI_INIT_HANDLER) (
875    ACPI_HANDLE                 Object,
876    UINT32                      Function);
877
878#define ACPI_INIT_DEVICE_INI        1
879
880
881/* Address Spaces (Operation Regions */
882
883typedef
884ACPI_STATUS (*ACPI_ADR_SPACE_HANDLER) (
885    UINT32                      Function,
886    ACPI_PHYSICAL_ADDRESS       Address,
887    UINT32                      BitWidth,
888    ACPI_INTEGER                *Value,
889    void                        *HandlerContext,
890    void                        *RegionContext);
891
892#define ACPI_DEFAULT_HANDLER        NULL
893
894
895typedef
896ACPI_STATUS (*ACPI_ADR_SPACE_SETUP) (
897    ACPI_HANDLE                 RegionHandle,
898    UINT32                      Function,
899    void                        *HandlerContext,
900    void                        **RegionContext);
901
902#define ACPI_REGION_ACTIVATE    0
903#define ACPI_REGION_DEACTIVATE  1
904
905typedef
906ACPI_STATUS (*ACPI_WALK_CALLBACK) (
907    ACPI_HANDLE                 ObjHandle,
908    UINT32                      NestingLevel,
909    void                        *Context,
910    void                        **ReturnValue);
911
912
913/* Interrupt handler return values */
914
915#define ACPI_INTERRUPT_NOT_HANDLED      0x00
916#define ACPI_INTERRUPT_HANDLED          0x01
917
918
919/* Common string version of device HIDs and UIDs */
920
921typedef struct acpi_device_id
922{
923    char                    Value[ACPI_DEVICE_ID_LENGTH];
924
925} ACPI_DEVICE_ID;
926
927/* Common string version of device CIDs */
928
929typedef struct acpi_compatible_id
930{
931    char                    Value[ACPI_MAX_CID_LENGTH];
932
933} ACPI_COMPATIBLE_ID;
934
935typedef struct acpi_compatible_id_list
936{
937    UINT32                  Count;
938    UINT32                  Size;
939    ACPI_COMPATIBLE_ID      Id[1];
940
941} ACPI_COMPATIBLE_ID_LIST;
942
943
944/* Structure and flags for AcpiGetObjectInfo */
945
946#define ACPI_VALID_STA                  0x0001
947#define ACPI_VALID_ADR                  0x0002
948#define ACPI_VALID_HID                  0x0004
949#define ACPI_VALID_UID                  0x0008
950#define ACPI_VALID_CID                  0x0010
951
952
953#define ACPI_COMMON_OBJ_INFO \
954    ACPI_OBJECT_TYPE            Type;           /* ACPI object type */ \
955    ACPI_NAME                   Name            /* ACPI object Name */
956
957
958typedef struct acpi_obj_info_header
959{
960    ACPI_COMMON_OBJ_INFO;
961
962} ACPI_OBJ_INFO_HEADER;
963
964
965/* Structure returned from Get Object Info */
966
967typedef struct acpi_device_info
968{
969    ACPI_COMMON_OBJ_INFO;
970
971    UINT8                       HighestDstates[4];  /* _SxD values 0xFF indicates not valid */
972    UINT32                      Valid;              /* Indicates which fields below are valid */
973    UINT32                      CurrentStatus;      /* _STA value */
974    ACPI_INTEGER                Address;            /* _ADR value if any */
975    ACPI_DEVICE_ID              HardwareId;         /* _HID value if any */
976    ACPI_DEVICE_ID              UniqueId;           /* _UID value if any */
977    ACPI_COMPATIBLE_ID_LIST     CompatibilityId;    /* List of _CIDs if any */
978
979} ACPI_DEVICE_INFO;
980
981
982/* Context structs for address space handlers */
983
984typedef struct acpi_pci_id
985{
986    UINT16                      Segment;
987    UINT16                      Bus;
988    UINT16                      Device;
989    UINT16                      Function;
990
991} ACPI_PCI_ID;
992
993
994typedef struct acpi_mem_space_context
995{
996    UINT32                      Length;
997    ACPI_PHYSICAL_ADDRESS       Address;
998    ACPI_PHYSICAL_ADDRESS       MappedPhysicalAddress;
999    UINT8                       *MappedLogicalAddress;
1000    ACPI_SIZE                   MappedLength;
1001
1002} ACPI_MEM_SPACE_CONTEXT;
1003
1004
1005/*
1006 * Definitions for Resource Attributes
1007 */
1008
1009/*
1010 *  Memory Attributes
1011 */
1012#define ACPI_READ_ONLY_MEMORY           (UINT8) 0x00
1013#define ACPI_READ_WRITE_MEMORY          (UINT8) 0x01
1014
1015#define ACPI_NON_CACHEABLE_MEMORY       (UINT8) 0x00
1016#define ACPI_CACHABLE_MEMORY            (UINT8) 0x01
1017#define ACPI_WRITE_COMBINING_MEMORY     (UINT8) 0x02
1018#define ACPI_PREFETCHABLE_MEMORY        (UINT8) 0x03
1019
1020/*
1021 *  IO Attributes
1022 *  The ISA IO ranges are:     n000-n0FFh,  n400-n4FFh, n800-n8FFh, nC00-nCFFh.
1023 *  The non-ISA IO ranges are: n100-n3FFh,  n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
1024 */
1025#define ACPI_NON_ISA_ONLY_RANGES        (UINT8) 0x01
1026#define ACPI_ISA_ONLY_RANGES            (UINT8) 0x02
1027#define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
1028
1029#define ACPI_SPARSE_TRANSLATION         (UINT8) 0x03
1030
1031/*
1032 *  IO Port Descriptor Decode
1033 */
1034#define ACPI_DECODE_10                  (UINT8) 0x00    /* 10-bit IO address decode */
1035#define ACPI_DECODE_16                  (UINT8) 0x01    /* 16-bit IO address decode */
1036
1037/*
1038 *  IRQ Attributes
1039 */
1040#define ACPI_EDGE_SENSITIVE             (UINT8) 0x00
1041#define ACPI_LEVEL_SENSITIVE            (UINT8) 0x01
1042
1043#define ACPI_ACTIVE_HIGH                (UINT8) 0x00
1044#define ACPI_ACTIVE_LOW                 (UINT8) 0x01
1045
1046#define ACPI_EXCLUSIVE                  (UINT8) 0x00
1047#define ACPI_SHARED                     (UINT8) 0x01
1048
1049/*
1050 *  DMA Attributes
1051 */
1052#define ACPI_COMPATIBILITY              (UINT8) 0x00
1053#define ACPI_TYPE_A                     (UINT8) 0x01
1054#define ACPI_TYPE_B                     (UINT8) 0x02
1055#define ACPI_TYPE_F                     (UINT8) 0x03
1056
1057#define ACPI_NOT_BUS_MASTER             (UINT8) 0x00
1058#define ACPI_BUS_MASTER                 (UINT8) 0x01
1059
1060#define ACPI_TRANSFER_8                 (UINT8) 0x00
1061#define ACPI_TRANSFER_8_16              (UINT8) 0x01
1062#define ACPI_TRANSFER_16                (UINT8) 0x02
1063
1064/*
1065 * Start Dependent Functions Priority definitions
1066 */
1067#define ACPI_GOOD_CONFIGURATION         (UINT8) 0x00
1068#define ACPI_ACCEPTABLE_CONFIGURATION   (UINT8) 0x01
1069#define ACPI_SUB_OPTIMAL_CONFIGURATION  (UINT8) 0x02
1070
1071/*
1072 *  16, 32 and 64-bit Address Descriptor resource types
1073 */
1074#define ACPI_MEMORY_RANGE               (UINT8) 0x00
1075#define ACPI_IO_RANGE                   (UINT8) 0x01
1076#define ACPI_BUS_NUMBER_RANGE           (UINT8) 0x02
1077
1078#define ACPI_ADDRESS_NOT_FIXED          (UINT8) 0x00
1079#define ACPI_ADDRESS_FIXED              (UINT8) 0x01
1080
1081#define ACPI_POS_DECODE                 (UINT8) 0x00
1082#define ACPI_SUB_DECODE                 (UINT8) 0x01
1083
1084#define ACPI_PRODUCER                   (UINT8) 0x00
1085#define ACPI_CONSUMER                   (UINT8) 0x01
1086
1087
1088/*
1089 *  Structures used to describe device resources
1090 */
1091typedef struct acpi_resource_irq
1092{
1093    UINT32                      EdgeLevel;
1094    UINT32                      ActiveHighLow;
1095    UINT32                      SharedExclusive;
1096    UINT32                      NumberOfInterrupts;
1097    UINT32                      Interrupts[1];
1098
1099} ACPI_RESOURCE_IRQ;
1100
1101typedef struct ACPI_RESOURCE_DMA
1102{
1103    UINT32                      Type;
1104    UINT32                      BusMaster;
1105    UINT32                      Transfer;
1106    UINT32                      NumberOfChannels;
1107    UINT32                      Channels[1];
1108
1109} ACPI_RESOURCE_DMA;
1110
1111typedef struct acpi_resource_start_dpf
1112{
1113    UINT32                      CompatibilityPriority;
1114    UINT32                      PerformanceRobustness;
1115
1116} ACPI_RESOURCE_START_DPF;
1117
1118/*
1119 * END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
1120 * needed because it has no fields
1121 */
1122
1123typedef struct acpi_resource_io
1124{
1125    UINT32                      IoDecode;
1126    UINT32                      MinBaseAddress;
1127    UINT32                      MaxBaseAddress;
1128    UINT32                      Alignment;
1129    UINT32                      RangeLength;
1130
1131} ACPI_RESOURCE_IO;
1132
1133typedef struct acpi_resource_fixed_io
1134{
1135    UINT32                      BaseAddress;
1136    UINT32                      RangeLength;
1137
1138} ACPI_RESOURCE_FIXED_IO;
1139
1140typedef struct acpi_resource_vendor
1141{
1142    UINT32                      Length;
1143    UINT8                       Reserved[1];
1144
1145} ACPI_RESOURCE_VENDOR;
1146
1147typedef struct acpi_resource_end_tag
1148{
1149    UINT8                       Checksum;
1150
1151} ACPI_RESOURCE_END_TAG;
1152
1153typedef struct acpi_resource_mem24
1154{
1155    UINT32                      ReadWriteAttribute;
1156    UINT32                      MinBaseAddress;
1157    UINT32                      MaxBaseAddress;
1158    UINT32                      Alignment;
1159    UINT32                      RangeLength;
1160
1161} ACPI_RESOURCE_MEM24;
1162
1163typedef struct acpi_resource_mem32
1164{
1165    UINT32                      ReadWriteAttribute;
1166    UINT32                      MinBaseAddress;
1167    UINT32                      MaxBaseAddress;
1168    UINT32                      Alignment;
1169    UINT32                      RangeLength;
1170
1171} ACPI_RESOURCE_MEM32;
1172
1173typedef struct acpi_resource_fixed_mem32
1174{
1175    UINT32                      ReadWriteAttribute;
1176    UINT32                      RangeBaseAddress;
1177    UINT32                      RangeLength;
1178
1179} ACPI_RESOURCE_FIXED_MEM32;
1180
1181typedef struct acpi_memory_attribute
1182{
1183    UINT16                      CacheAttribute;
1184    UINT16                      ReadWriteAttribute;
1185
1186} ACPI_MEMORY_ATTRIBUTE;
1187
1188typedef struct acpi_io_attribute
1189{
1190    UINT16                      RangeAttribute;
1191    UINT16                      TranslationAttribute;
1192
1193} ACPI_IO_ATTRIBUTE;
1194
1195typedef struct acpi_bus_attribute
1196{
1197    UINT16                      Reserved1;
1198    UINT16                      Reserved2;
1199
1200} ACPI_BUS_ATTRIBUTE;
1201
1202typedef union acpi_resource_attribute
1203{
1204    ACPI_MEMORY_ATTRIBUTE       Memory;
1205    ACPI_IO_ATTRIBUTE           Io;
1206    ACPI_BUS_ATTRIBUTE          Bus;
1207
1208} ACPI_RESOURCE_ATTRIBUTE;
1209
1210typedef struct acpi_resource_source
1211{
1212    UINT32                      Index;
1213    UINT32                      StringLength;
1214    char                        *StringPtr;
1215
1216} ACPI_RESOURCE_SOURCE;
1217
1218typedef struct acpi_resource_address16
1219{
1220    UINT32                      ResourceType;
1221    UINT32                      ProducerConsumer;
1222    UINT32                      Decode;
1223    UINT32                      MinAddressFixed;
1224    UINT32                      MaxAddressFixed;
1225    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1226    UINT32                      Granularity;
1227    UINT32                      MinAddressRange;
1228    UINT32                      MaxAddressRange;
1229    UINT32                      AddressTranslationOffset;
1230    UINT32                      AddressLength;
1231    ACPI_RESOURCE_SOURCE        ResourceSource;
1232
1233} ACPI_RESOURCE_ADDRESS16;
1234
1235typedef struct acpi_resource_address32
1236{
1237    UINT32                      ResourceType;
1238    UINT32                      ProducerConsumer;
1239    UINT32                      Decode;
1240    UINT32                      MinAddressFixed;
1241    UINT32                      MaxAddressFixed;
1242    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1243    UINT32                      Granularity;
1244    UINT32                      MinAddressRange;
1245    UINT32                      MaxAddressRange;
1246    UINT32                      AddressTranslationOffset;
1247    UINT32                      AddressLength;
1248    ACPI_RESOURCE_SOURCE        ResourceSource;
1249
1250} ACPI_RESOURCE_ADDRESS32;
1251
1252typedef struct acpi_resource_address64
1253{
1254    UINT32                      ResourceType;
1255    UINT32                      ProducerConsumer;
1256    UINT32                      Decode;
1257    UINT32                      MinAddressFixed;
1258    UINT32                      MaxAddressFixed;
1259    ACPI_RESOURCE_ATTRIBUTE     Attribute;
1260    UINT64                      Granularity;
1261    UINT64                      MinAddressRange;
1262    UINT64                      MaxAddressRange;
1263    UINT64                      AddressTranslationOffset;
1264    UINT64                      AddressLength;
1265    ACPI_RESOURCE_SOURCE        ResourceSource;
1266
1267} ACPI_RESOURCE_ADDRESS64;
1268
1269typedef struct acpi_resource_ext_irq
1270{
1271    UINT32                      ProducerConsumer;
1272    UINT32                      EdgeLevel;
1273    UINT32                      ActiveHighLow;
1274    UINT32                      SharedExclusive;
1275    UINT32                      NumberOfInterrupts;
1276    ACPI_RESOURCE_SOURCE        ResourceSource;
1277    UINT32                      Interrupts[1];
1278
1279} ACPI_RESOURCE_EXT_IRQ;
1280
1281
1282/* ACPI_RESOURCE_TYPEs */
1283
1284#define ACPI_RSTYPE_IRQ                 0
1285#define ACPI_RSTYPE_DMA                 1
1286#define ACPI_RSTYPE_START_DPF           2
1287#define ACPI_RSTYPE_END_DPF             3
1288#define ACPI_RSTYPE_IO                  4
1289#define ACPI_RSTYPE_FIXED_IO            5
1290#define ACPI_RSTYPE_VENDOR              6
1291#define ACPI_RSTYPE_END_TAG             7
1292#define ACPI_RSTYPE_MEM24               8
1293#define ACPI_RSTYPE_MEM32               9
1294#define ACPI_RSTYPE_FIXED_MEM32         10
1295#define ACPI_RSTYPE_ADDRESS16           11
1296#define ACPI_RSTYPE_ADDRESS32           12
1297#define ACPI_RSTYPE_ADDRESS64           13
1298#define ACPI_RSTYPE_EXT_IRQ             14
1299
1300typedef UINT32                          ACPI_RESOURCE_TYPE;
1301
1302typedef union acpi_resource_data
1303{
1304    ACPI_RESOURCE_IRQ           Irq;
1305    ACPI_RESOURCE_DMA           Dma;
1306    ACPI_RESOURCE_START_DPF     StartDpf;
1307    ACPI_RESOURCE_IO            Io;
1308    ACPI_RESOURCE_FIXED_IO      FixedIo;
1309    ACPI_RESOURCE_VENDOR        VendorSpecific;
1310    ACPI_RESOURCE_END_TAG       EndTag;
1311    ACPI_RESOURCE_MEM24         Memory24;
1312    ACPI_RESOURCE_MEM32         Memory32;
1313    ACPI_RESOURCE_FIXED_MEM32   FixedMemory32;
1314    ACPI_RESOURCE_ADDRESS16     Address16;
1315    ACPI_RESOURCE_ADDRESS32     Address32;
1316    ACPI_RESOURCE_ADDRESS64     Address64;
1317    ACPI_RESOURCE_EXT_IRQ       ExtendedIrq;
1318
1319} ACPI_RESOURCE_DATA;
1320
1321typedef struct acpi_resource
1322{
1323    ACPI_RESOURCE_TYPE          Id;
1324    UINT32                      Length;
1325    ACPI_RESOURCE_DATA          Data;
1326
1327} ACPI_RESOURCE;
1328
1329#define ACPI_RESOURCE_LENGTH                12
1330#define ACPI_RESOURCE_LENGTH_NO_DATA        8       /* Id + Length fields */
1331
1332#define ACPI_SIZEOF_RESOURCE(Type)          (ACPI_RESOURCE_LENGTH_NO_DATA + sizeof (Type))
1333
1334#define ACPI_NEXT_RESOURCE(Res)             (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length)
1335
1336#ifdef ACPI_MISALIGNED_TRANSFERS
1337#define ACPI_ALIGN_RESOURCE_SIZE(Length)    (Length)
1338#else
1339#define ACPI_ALIGN_RESOURCE_SIZE(Length)    ACPI_ROUND_UP_TO_NATIVE_WORD(Length)
1340#endif
1341
1342/*
1343 * END: of definitions for Resource Attributes
1344 */
1345
1346
1347typedef struct acpi_pci_routing_table
1348{
1349    UINT32                      Length;
1350    UINT32                      Pin;
1351    ACPI_INTEGER                Address;        /* here for 64-bit alignment */
1352    UINT32                      SourceIndex;
1353    char                        Source[4];      /* pad to 64 bits so sizeof() works in all cases */
1354
1355} ACPI_PCI_ROUTING_TABLE;
1356
1357/*
1358 * END: of definitions for PCI Routing tables
1359 */
1360
1361
1362#endif /* __ACTYPES_H__ */
1363