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