achware.h revision 70243 
1/******************************************************************************
2 *
3 * Name: achware.h -- hardware specific interfaces
4 *       $Revision: 49 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999, 2000, 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/* Prototypes */
122
123
124ACPI_STATUS
125AcpiHwInitialize (
126    void);
127
128ACPI_STATUS
129AcpiHwShutdown (
130    void);
131
132ACPI_STATUS
133AcpiHwInitializeSystemInfo (
134    void);
135
136ACPI_STATUS
137AcpiHwSetMode (
138    UINT32                  Mode);
139
140UINT32
141AcpiHwGetMode (
142    void);
143
144UINT32
145AcpiHwGetModeCapabilities (
146    void);
147
148/* Register I/O Prototypes */
149
150
151UINT32
152AcpiHwRegisterBitAccess (
153    NATIVE_UINT             ReadWrite,
154    BOOLEAN                 UseLock,
155    UINT32                  RegisterId,
156    ... /* DWORD Write Value */);
157
158UINT32
159AcpiHwRegisterRead (
160    BOOLEAN                 UseLock,
161    UINT32                  RegisterId);
162
163void
164AcpiHwRegisterWrite (
165    BOOLEAN                 UseLock,
166    UINT32                  RegisterId,
167    UINT32                  Value);
168
169UINT32
170AcpiHwLowLevelRead (
171    UINT32                  Width,
172    ACPI_GAS                *Reg,
173    UINT32                  Offset);
174
175void
176AcpiHwLowLevelWrite (
177    UINT32                  Width,
178    UINT32                  Value,
179    ACPI_GAS                *Reg,
180    UINT32                  Offset);
181
182void
183AcpiHwClearAcpiStatus (
184   void);
185
186
187/* GPE support */
188
189void
190AcpiHwEnableGpe (
191    UINT32                  GpeIndex);
192
193void
194AcpiHwDisableGpe (
195    UINT32                  GpeIndex);
196
197void
198AcpiHwClearGpe (
199    UINT32                  GpeIndex);
200
201void
202AcpiHwGetGpeStatus (
203    UINT32                  GpeNumber,
204    ACPI_EVENT_STATUS       *EventStatus);
205
206/* Sleep Prototypes */
207
208ACPI_STATUS
209AcpiHwObtainSleepTypeRegisterData (
210    UINT8                   SleepState,
211    UINT8                   *Slp_TypA,
212    UINT8                   *Slp_TypB);
213
214
215/* Cx State Prototypes */
216
217ACPI_STATUS
218AcpiHwEnterC1(
219    ACPI_IO_ADDRESS         PblkAddress,
220    UINT32                  *PmTimerTicks);
221
222ACPI_STATUS
223AcpiHwEnterC2(
224    ACPI_IO_ADDRESS         PblkAddress,
225    UINT32                  *PmTimerTicks);
226
227ACPI_STATUS
228AcpiHwEnterC3(
229    ACPI_IO_ADDRESS         PblkAddress,
230    UINT32                  *PmTimerTicks);
231
232ACPI_STATUS
233AcpiHwEnterCx (
234    ACPI_IO_ADDRESS         PblkAddress,
235    UINT32                  *PmTimerTicks);
236
237ACPI_STATUS
238AcpiHwSetCx (
239    UINT32                  CxState);
240
241ACPI_STATUS
242AcpiHwGetCxInfo (
243    UINT32                  CxStates[]);
244
245ACPI_STATUS
246AcpiHwGetCxHandler (
247    UINT32                  CxState,
248    ACPI_C_STATE_HANDLER    *Handler);
249
250ACPI_STATUS
251AcpiHwSetCxHandler (
252    UINT32                  CxState,
253    ACPI_C_STATE_HANDLER    Handler);
254
255
256/* Throttling Prototypes */
257
258void
259AcpiHwEnableThrottling (
260    ACPI_IO_ADDRESS         PblkAddress);
261
262void
263AcpiHwDisableThrottling (
264    ACPI_IO_ADDRESS         PblkAddress);
265
266UINT32
267AcpiHwGetDutyCycle (
268    UINT8                   DutyOffset,
269    ACPI_IO_ADDRESS         PblkAddress,
270    UINT32                  NumThrottleStates);
271
272void
273AcpiHwProgramDutyCycle (
274    UINT8                   DutyOffset,
275    UINT32                  DutyCycle,
276    ACPI_IO_ADDRESS         PblkAddress,
277    UINT32                  NumThrottleStates);
278
279NATIVE_UINT
280AcpiHwLocalPow (
281    NATIVE_UINT             x,
282    NATIVE_UINT             y);
283
284
285/* ACPI Timer prototypes */
286
287UINT32
288AcpiHwPmtTicks (
289    void);
290
291UINT32
292AcpiHwPmtResolution (
293    void);
294
295ACPI_STATUS
296AcpiGetTimer (
297    UINT32                  *OutTicks);
298
299
300#endif /* __ACHWARE_H__ */
301