summaryrefslogtreecommitdiffstats
path: root/sys/contrib/dev/acpica/Subsystem/Include/actbl2.h
blob: 9b71c5c95bb9d44f7aae1ee71cbf8bcc546fc258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/******************************************************************************
 *
 * Name: actbl2.h - ACPI Specification Revision 2.0 Tables
 *       $Revision: 20 $
 *
 *****************************************************************************/

/******************************************************************************
 *
 * 1. Copyright Notice
 *
 * Some or all of this work - Copyright (c) 1999, 2000, Intel Corp.
 * All rights reserved.
 *
 * 2. License
 *
 * 2.1. This is your license from Intel Corp. under its intellectual property
 * rights.  You may have additional license terms from the party that provided
 * you this software, covering your right to use that party's intellectual
 * property rights.
 *
 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
 * copy of the source code appearing in this file ("Covered Code") an
 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
 * base code distributed originally by Intel ("Original Intel Code") to copy,
 * make derivatives, distribute, use and display any portion of the Covered
 * Code in any form, with the right to sublicense such rights; and
 *
 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
 * license (with the right to sublicense), under only those claims of Intel
 * patents that are infringed by the Original Intel Code, to make, use, sell,
 * offer to sell, and import the Covered Code and derivative works thereof
 * solely to the minimum extent necessary to exercise the above copyright
 * license, and in no event shall the patent license extend to any additions
 * to or modifications of the Original Intel Code.  No other license or right
 * is granted directly or by implication, estoppel or otherwise;
 *
 * The above copyright and patent license is granted only if the following
 * conditions are met:
 *
 * 3. Conditions
 *
 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification with rights to further distribute source must include
 * the above Copyright Notice, the above License, this list of Conditions,
 * and the following Disclaimer and Export Compliance provision.  In addition,
 * Licensee must cause all Covered Code to which Licensee contributes to
 * contain a file documenting the changes Licensee made to create that Covered
 * Code and the date of any change.  Licensee must include in that file the
 * documentation of any changes made by any predecessor Licensee.  Licensee
 * must include a prominent statement that the modification is derived,
 * directly or indirectly, from Original Intel Code.
 *
 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
 * Redistribution of source code of any substantial portion of the Covered
 * Code or modification without rights to further distribute source must
 * include the following Disclaimer and Export Compliance provision in the
 * documentation and/or other materials provided with distribution.  In
 * addition, Licensee may not authorize further sublicense of source of any
 * portion of the Covered Code, and must include terms to the effect that the
 * license from Licensee to its licensee is limited to the intellectual
 * property embodied in the software Licensee provides to its licensee, and
 * not to intellectual property embodied in modifications its licensee may
 * make.
 *
 * 3.3. Redistribution of Executable. Redistribution in executable form of any
 * substantial portion of the Covered Code or modification must reproduce the
 * above Copyright Notice, and the following Disclaimer and Export Compliance
 * provision in the documentation and/or other materials provided with the
 * distribution.
 *
 * 3.4. Intel retains all right, title, and interest in and to the Original
 * Intel Code.
 *
 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
 * Intel shall be used in advertising or otherwise to promote the sale, use or
 * other dealings in products derived from or relating to the Covered Code
 * without prior written authorization from Intel.
 *
 * 4. Disclaimer and Export Compliance
 *
 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
 * PARTICULAR PURPOSE.
 *
 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
 * LIMITED REMEDY.
 *
 * 4.3. Licensee shall not export, either directly or indirectly, any of this
 * software or system incorporating such software without first obtaining any
 * required license or other approval from the U. S. Department of Commerce or
 * any other agency or department of the United States Government.  In the
 * event Licensee exports any such software from the United States or
 * re-exports any such software from a foreign destination, Licensee shall
 * ensure that the distribution and export/re-export of the software is in
 * compliance with all laws, regulations, orders, or other restrictions of the
 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 * any of its subsidiaries will export/re-export any technical data, process,
 * software, or service, directly or indirectly, to any country for which the
 * United States government or any agency thereof requires an export license,
 * other governmental approval, or letter of assurance, without first obtaining
 * such license, approval or letter.
 *
 *****************************************************************************/

#ifndef __ACTBL2_H__
#define __ACTBL2_H__

/**************************************/
/* Prefered Power Management Profiles */
/**************************************/
#define PM_UNSPECIFIED        0
#define PM_DESKTOP            1
#define PM_MOBILE             2
#define PM_WORKSTATION        3
#define PM_ENTERPRISE_SERVER  4
#define PM_SOHO_SERVER        5
#define PM_APPLIANCE_PC       6

/*********************************************/
/* ACPI Boot Arch Flags, See spec Table 5-10 */
/*********************************************/
#define BAF_LEGACY_DEVICES             0x0001
#define BAF_8042_KEYBOARD_CONTROLLER   0x0002

#define FADT2_REVISION_ID     3

#pragma pack(1)

/*************************************/
/* ACPI Specification Rev 2.0 for    */
/* the Root System Description Table */
/*************************************/
typedef struct
{
    ACPI_TABLE_HEADER   header;                 /* Table header */
    UINT32              TableOffsetEntry [1];   /* Array of pointers to  */
                                                /* other tables' headers */
} RSDT_DESCRIPTOR_REV2;


/********************************************/
/* ACPI Specification Rev 2.0 for the       */
/* Extended System Description Table (XSDT) */
/********************************************/
typedef struct
{
    ACPI_TABLE_HEADER   Header;                 /* Table header */
    UINT64              TableOffsetEntry [1];   /* Array of pointers to  */
                                                /* other tables' headers */
} XSDT_DESCRIPTOR_REV2;

/***************************************/
/* ACPI Specification Rev 2.0 for      */
/* the Firmware ACPI Control Structure */
/***************************************/
typedef struct
{
    NATIVE_CHAR         Signature[4];           /* signature "FACS" */
    UINT32              Length;                 /* length of structure, in bytes */
    UINT32              HardwareSignature;      /* hardware configuration signature */
    UINT32              FirmwareWakingVector;   /* 32bit physical address of the Firmware Waking Vector. */
    UINT32              GlobalLock;             /* Global Lock used to synchronize access to shared hardware resources */
    UINT32_BIT          S4Bios_f        : 1;    /* Indicates if S4BIOS support is present */
    UINT32_BIT          Reserved1       : 31;   /* must be 0 */
    UINT64              XFirmwareWakingVector;  /* 64bit physical address of the Firmware Waking Vector. */
    UINT8               Version;                /* Version of this table */
    UINT8               Reserved3 [31];         /* reserved - must be zero */

} FACS_DESCRIPTOR_REV2;


/***************************************/
/* ACPI Specification Rev 2.0 for      */
/* the Generic Address Structure (GAS) */
/***************************************/
typedef struct
{
    UINT8               AddressSpaceId;     /* Address space where struct or register exists. */
    UINT8               RegisterBitWidth;   /* Size in bits of given register */
    UINT8               RegisterBitOffset;  /* Bit offset within the register */
    UINT8               Reserved;           /* Must be 0 */
    UINT64              Address;            /* 64-bit address of struct or register */

} ACPI_GAS;


/************************************/
/* ACPI Specification Rev 2.0 for   */
/* the Fixed ACPI Description Table */
/************************************/
typedef struct
{
    ACPI_TABLE_HEADER   header;            /* table header */
    UINT32              V1_FirmwareCtrl;   /* 32-bit physical address of FACS */
    UINT32              V1_Dsdt;           /* 32-bit physical address of DSDT */
    UINT8               Reserved1;         /* System Interrupt Model isn't used in ACPI 2.0*/
    UINT8               Prefer_PM_Profile; /* Conveys preferred power management profile to OSPM. */
    UINT16              SciInt;            /* System vector of SCI interrupt */
    UINT32              SmiCmd;            /* Port address of SMI command port */
    UINT8               AcpiEnable;        /* value to write to smi_cmd to enable ACPI */
    UINT8               AcpiDisable;       /* value to write to smi_cmd to disable ACPI */
    UINT8               S4BiosReq;         /* Value to write to SMI CMD to enter S4BIOS state */
    UINT8               PstateCnt;         /* processor performance state control*/
    UINT32              V1_Pm1aEvtBlk;     /* Port address of Power Mgt 1a AcpiEvent Reg Blk */
    UINT32              V1_Pm1bEvtBlk;     /* Port address of Power Mgt 1b AcpiEvent Reg Blk */
    UINT32              V1_Pm1aCntBlk;     /* Port address of Power Mgt 1a Control Reg Blk */
    UINT32              V1_Pm1bCntBlk;     /* Port address of Power Mgt 1b Control Reg Blk */
    UINT32              V1_Pm2CntBlk;      /* Port address of Power Mgt 2 Control Reg Blk */
    UINT32              V1_PmTmrBlk;       /* Port address of Power Mgt Timer Ctrl Reg Blk */
    UINT32              V1_Gpe0Blk;        /* Port addr of General Purpose AcpiEvent 0 Reg Blk */
    UINT32              V1_Gpe1Blk;        /* Port addr of General Purpose AcpiEvent 1 Reg Blk */
    UINT8               Pm1EvtLen;         /* Byte Length of ports at pm1X_evt_blk */
    UINT8               Pm1CntLen;         /* Byte Length of ports at pm1X_cnt_blk */
    UINT8               Pm2CntLen;         /* Byte Length of ports at pm2_cnt_blk */
    UINT8               PmTmLen;           /* Byte Length of ports at pm_tm_blk */
    UINT8               Gpe0BlkLen;        /* Byte Length of ports at gpe0_blk */
    UINT8               Gpe1BlkLen;        /* Byte Length of ports at gpe1_blk */
    UINT8               Gpe1Base;          /* offset in gpe model where gpe1 events start */
    UINT8               CstCnt;            /* Support for the _CST object and C States change notification.*/
    UINT16              Plvl2Lat;          /* worst case HW latency to enter/exit C2 state */
    UINT16              Plvl3Lat;          /* worst case HW latency to enter/exit C3 state */
    UINT16              FlushSize;         /* number of flush strides that need to be read */
    UINT16              FlushStride;       /* Processor's memory cache line width, in bytes */
    UINT8               DutyOffset;        /* Processor’s duty cycle index in processor's P_CNT reg*/
    UINT8               DutyWidth;         /* Processor’s duty cycle value bit width in P_CNT register.*/
    UINT8               DayAlrm;           /* index to day-of-month alarm in RTC CMOS RAM */
    UINT8               MonAlrm;           /* index to month-of-year alarm in RTC CMOS RAM */
    UINT8               Century;           /* index to century in RTC CMOS RAM */
    UINT16              IapcBootArch;      /* IA-PC Boot Architecture Flags. See Table 5-10 for description*/
    UINT8               Reserved2;         /* reserved */
    UINT32_BIT          WbInvd      : 1;   /* wbinvd instruction works properly */
    UINT32_BIT          WbInvdFlush : 1;   /* wbinvd flushes but does not invalidate */
    UINT32_BIT          ProcC1      : 1;   /* all processors support C1 state */
    UINT32_BIT          Plvl2Up     : 1;   /* C2 state works on MP system */
    UINT32_BIT          PwrButton   : 1;   /* Power button is handled as a generic feature */
    UINT32_BIT          SleepButton : 1;   /* Sleep button is handled as a generic feature, or not present */
    UINT32_BIT          FixedRTC    : 1;   /* RTC wakeup stat not in fixed register space */
    UINT32_BIT          Rtcs4       : 1;   /* RTC wakeup stat not possible from S4 */
    UINT32_BIT          TmrValExt   : 1;   /* tmr_val is 32 bits */
    UINT32_BIT          DockCap     : 1;   /* Supports Docking */
    UINT32_BIT          ResetRegSup : 1;   /* Indicates system supports system reset via the FADT RESET_REG*/
    UINT32_BIT          SealedCase  : 1;   /* Indicates system has no internal expansion capabilities and case is sealed. */
    UINT32_BIT          Headless    : 1;   /* Indicates system does not have local video capabilities or local input devices.*/
    UINT32_BIT          CpuSwSleep  : 1;   /* Indicates to OSPM that a processor native instruction */
                                           /* must be executed after writing the SLP_TYPx register. */
    UINT32_BIT          Reserved6   : 18;  /* reserved - must be zero */

    ACPI_GAS            ResetRegister;     /* Reset register address in GAS format */
    UINT8               ResetValue;        /* Value to write to the ResetRegister port to reset the system. */
    UINT8               Reserved7[3];      /* These three bytes must be zero */
    UINT64              XFirmwareCtrl;      /* 64-bit physical address of FACS */
    UINT64              XDsdt;              /* 64-bit physical address of DSDT */
    ACPI_GAS            XPm1aEvtBlk;        /* Extended Power Mgt 1a AcpiEvent Reg Blk address */
    ACPI_GAS            XPm1bEvtBlk;        /* Extended Power Mgt 1b AcpiEvent Reg Blk address */
    ACPI_GAS            XPm1aCntBlk;        /* Extended Power Mgt 1a Control Reg Blk address */
    ACPI_GAS            XPm1bCntBlk;        /* Extended Power Mgt 1b Control Reg Blk address */
    ACPI_GAS            XPm2CntBlk;         /* Extended Power Mgt 2 Control Reg Blk address */
    ACPI_GAS            XPmTmrBlk;          /* Extended Power Mgt Timer Ctrl Reg Blk address */
    ACPI_GAS            XGpe0Blk;           /* Extended General Purpose AcpiEvent 0 Reg Blk address */
    ACPI_GAS            XGpe1Blk;           /* Extended General Purpose AcpiEvent 1 Reg Blk address */

}  FADT_DESCRIPTOR_REV2;


#pragma pack()

#endif /* __ACTBL2_H__ */

OpenPOWER on IntegriCloud