achware.h revision 167802 
1/******************************************************************************
2 *
3 * Name: achware.h -- hardware specific interfaces
4 *       $Revision: 1.83 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2007, 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 __ACHWARE_H__
118#define __ACHWARE_H__
119
120
121/* PM Timer ticks per second (HZ) */
122
123#define PM_TIMER_FREQUENCY  3579545
124
125/* Values for the _SST reserved method */
126
127#define ACPI_SST_INDICATOR_OFF  0
128#define ACPI_SST_WORKING        1
129#define ACPI_SST_WAKING         2
130#define ACPI_SST_SLEEPING       3
131#define ACPI_SST_SLEEP_CONTEXT  4
132
133
134/* Prototypes */
135
136
137/*
138 * hwacpi - high level functions
139 */
140ACPI_STATUS
141AcpiHwSetMode (
142    UINT32                  Mode);
143
144UINT32
145AcpiHwGetMode (
146    void);
147
148
149/*
150 * hwregs - ACPI Register I/O
151 */
152ACPI_BIT_REGISTER_INFO *
153AcpiHwGetBitRegisterInfo (
154    UINT32                  RegisterId);
155
156ACPI_STATUS
157AcpiHwRegisterRead (
158    BOOLEAN                 UseLock,
159    UINT32                  RegisterId,
160    UINT32                  *ReturnValue);
161
162ACPI_STATUS
163AcpiHwRegisterWrite (
164    BOOLEAN                 UseLock,
165    UINT32                  RegisterId,
166    UINT32                  Value);
167
168ACPI_STATUS
169AcpiHwLowLevelRead (
170    UINT32                  Width,
171    UINT32                  *Value,
172    ACPI_GENERIC_ADDRESS    *Reg);
173
174ACPI_STATUS
175AcpiHwLowLevelWrite (
176    UINT32                  Width,
177    UINT32                  Value,
178    ACPI_GENERIC_ADDRESS    *Reg);
179
180ACPI_STATUS
181AcpiHwClearAcpiStatus (
182    void);
183
184
185/*
186 * hwgpe - GPE support
187 */
188ACPI_STATUS
189AcpiHwWriteGpeEnableReg (
190    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
191
192ACPI_STATUS
193AcpiHwDisableGpeBlock (
194    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
195    ACPI_GPE_BLOCK_INFO     *GpeBlock);
196
197ACPI_STATUS
198AcpiHwClearGpe (
199    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
200
201ACPI_STATUS
202AcpiHwClearGpeBlock (
203    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
204    ACPI_GPE_BLOCK_INFO     *GpeBlock);
205
206ACPI_STATUS
207AcpiHwGetGpeStatus (
208    ACPI_GPE_EVENT_INFO     *GpeEventInfo,
209    ACPI_EVENT_STATUS       *EventStatus);
210
211ACPI_STATUS
212AcpiHwDisableAllGpes (
213    void);
214
215ACPI_STATUS
216AcpiHwEnableAllRuntimeGpes (
217    void);
218
219ACPI_STATUS
220AcpiHwEnableAllWakeupGpes (
221    void);
222
223ACPI_STATUS
224AcpiHwEnableRuntimeGpeBlock (
225    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
226    ACPI_GPE_BLOCK_INFO     *GpeBlock);
227
228
229/*
230 * hwtimer - ACPI Timer prototypes
231 */
232ACPI_STATUS
233AcpiGetTimerResolution (
234    UINT32                  *Resolution);
235
236ACPI_STATUS
237AcpiGetTimer (
238    UINT32                  *Ticks);
239
240ACPI_STATUS
241AcpiGetTimerDuration (
242    UINT32                  StartTicks,
243    UINT32                  EndTicks,
244    UINT32                  *TimeElapsed);
245
246
247#endif /* __ACHWARE_H__ */
248