achware.h revision 202771 
1/******************************************************************************
2 *
3 * Name: achware.h -- hardware specific interfaces
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
13 *
14 * 2. License
15 *
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights.  You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
19 * property rights.
20 *
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
27 *
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code.  No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
36 *
37 * The above copyright and patent license is granted only if the following
38 * conditions are met:
39 *
40 * 3. Conditions
41 *
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision.  In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change.  Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee.  Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
53 *
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution.  In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
64 * make.
65 *
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3.4. Intel retains all right, title, and interest in and to the Original
73 * Intel Code.
74 *
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
79 *
80 * 4. Disclaimer and Export Compliance
81 *
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88 * PARTICULAR PURPOSE.
89 *
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97 * LIMITED REMEDY.
98 *
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government.  In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
113 *
114 *****************************************************************************/
115
116#ifndef __ACHWARE_H__
117#define __ACHWARE_H__
118
119
120/* Values for the _SST predefined method */
121
122#define ACPI_SST_INDICATOR_OFF  0
123#define ACPI_SST_WORKING        1
124#define ACPI_SST_WAKING         2
125#define ACPI_SST_SLEEPING       3
126#define ACPI_SST_SLEEP_CONTEXT  4
127
128
129/*
130 * hwacpi - high level functions
131 */
132ACPI_STATUS
133AcpiHwSetMode (
134    UINT32                  Mode);
135
136UINT32
137AcpiHwGetMode (
138    void);
139
140
141/*
142 * hwregs - ACPI Register I/O
143 */
144ACPI_STATUS
145AcpiHwValidateRegister (
146    ACPI_GENERIC_ADDRESS    *Reg,
147    UINT8                   MaxBitWidth,
148    UINT64                  *Address);
149
150ACPI_STATUS
151AcpiHwRead (
152    UINT32                  *Value,
153    ACPI_GENERIC_ADDRESS    *Reg);
154
155ACPI_STATUS
156AcpiHwWrite (
157    UINT32                  Value,
158    ACPI_GENERIC_ADDRESS    *Reg);
159
160ACPI_BIT_REGISTER_INFO *
161AcpiHwGetBitRegisterInfo (
162    UINT32                  RegisterId);
163
164ACPI_STATUS
165AcpiHwWritePm1Control (
166    UINT32                  Pm1aControl,
167    UINT32                  Pm1bControl);
168
169ACPI_STATUS
170AcpiHwRegisterRead (
171    UINT32                  RegisterId,
172    UINT32                  *ReturnValue);
173
174ACPI_STATUS
175AcpiHwRegisterWrite (
176    UINT32                  RegisterId,
177    UINT32                  Value);
178
179ACPI_STATUS
180AcpiHwClearAcpiStatus (
181    void);
182
183
184/*
185 * hwvalid - Port I/O with validation
186 */
187ACPI_STATUS
188AcpiHwReadPort (
189    ACPI_IO_ADDRESS         Address,
190    UINT32                  *Value,
191    UINT32                  Width);
192
193ACPI_STATUS
194AcpiHwWritePort (
195    ACPI_IO_ADDRESS         Address,
196    UINT32                  Value,
197    UINT32                  Width);
198
199
200/*
201 * hwgpe - GPE support
202 */
203ACPI_STATUS
204AcpiHwLowDisableGpe (
205    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
206
207ACPI_STATUS
208AcpiHwWriteGpeEnableReg (
209    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
210
211ACPI_STATUS
212AcpiHwDisableGpeBlock (
213    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
214    ACPI_GPE_BLOCK_INFO     *GpeBlock,
215    void                    *Context);
216
217ACPI_STATUS
218AcpiHwClearGpe (
219    ACPI_GPE_EVENT_INFO     *GpeEventInfo);
220
221ACPI_STATUS
222AcpiHwClearGpeBlock (
223    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
224    ACPI_GPE_BLOCK_INFO     *GpeBlock,
225    void                    *Context);
226
227ACPI_STATUS
228AcpiHwGetGpeStatus (
229    ACPI_GPE_EVENT_INFO     *GpeEventInfo,
230    ACPI_EVENT_STATUS       *EventStatus);
231
232ACPI_STATUS
233AcpiHwDisableAllGpes (
234    void);
235
236ACPI_STATUS
237AcpiHwEnableAllRuntimeGpes (
238    void);
239
240ACPI_STATUS
241AcpiHwEnableAllWakeupGpes (
242    void);
243
244ACPI_STATUS
245AcpiHwEnableRuntimeGpeBlock (
246    ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
247    ACPI_GPE_BLOCK_INFO     *GpeBlock,
248    void                    *Context);
249
250
251/*
252 * hwtimer - ACPI Timer prototypes
253 */
254ACPI_STATUS
255AcpiGetTimerResolution (
256    UINT32                  *Resolution);
257
258ACPI_STATUS
259AcpiGetTimer (
260    UINT32                  *Ticks);
261
262ACPI_STATUS
263AcpiGetTimerDuration (
264    UINT32                  StartTicks,
265    UINT32                  EndTicks,
266    UINT32                  *TimeElapsed);
267
268
269#endif /* __ACHWARE_H__ */
270