xref: /titanic_44/usr/src/uts/intel/sys/acpi/achware.h (revision 5fd03bc0f2e00e7ba02316c2e08f45d52aab15db)
1 /******************************************************************************
2  *
3  * Name: achware.h -- hardware specific interfaces
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2011, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43 
44 #ifndef __ACHWARE_H__
45 #define __ACHWARE_H__
46 
47 
48 /* Values for the _SST predefined method */
49 
50 #define ACPI_SST_INDICATOR_OFF  0
51 #define ACPI_SST_WORKING        1
52 #define ACPI_SST_WAKING         2
53 #define ACPI_SST_SLEEPING       3
54 #define ACPI_SST_SLEEP_CONTEXT  4
55 
56 
57 /*
58  * hwacpi - high level functions
59  */
60 ACPI_STATUS
61 AcpiHwSetMode (
62     UINT32                  Mode);
63 
64 UINT32
65 AcpiHwGetMode (
66     void);
67 
68 
69 /*
70  * hwregs - ACPI Register I/O
71  */
72 ACPI_STATUS
73 AcpiHwValidateRegister (
74     ACPI_GENERIC_ADDRESS    *Reg,
75     UINT8                   MaxBitWidth,
76     UINT64                  *Address);
77 
78 ACPI_STATUS
79 AcpiHwRead (
80     UINT32                  *Value,
81     ACPI_GENERIC_ADDRESS    *Reg);
82 
83 ACPI_STATUS
84 AcpiHwWrite (
85     UINT32                  Value,
86     ACPI_GENERIC_ADDRESS    *Reg);
87 
88 ACPI_BIT_REGISTER_INFO *
89 AcpiHwGetBitRegisterInfo (
90     UINT32                  RegisterId);
91 
92 ACPI_STATUS
93 AcpiHwWritePm1Control (
94     UINT32                  Pm1aControl,
95     UINT32                  Pm1bControl);
96 
97 ACPI_STATUS
98 AcpiHwRegisterRead (
99     UINT32                  RegisterId,
100     UINT32                  *ReturnValue);
101 
102 ACPI_STATUS
103 AcpiHwRegisterWrite (
104     UINT32                  RegisterId,
105     UINT32                  Value);
106 
107 ACPI_STATUS
108 AcpiHwClearAcpiStatus (
109     void);
110 
111 
112 /*
113  * hwvalid - Port I/O with validation
114  */
115 ACPI_STATUS
116 AcpiHwReadPort (
117     ACPI_IO_ADDRESS         Address,
118     UINT32                  *Value,
119     UINT32                  Width);
120 
121 ACPI_STATUS
122 AcpiHwWritePort (
123     ACPI_IO_ADDRESS         Address,
124     UINT32                  Value,
125     UINT32                  Width);
126 
127 
128 /*
129  * hwgpe - GPE support
130  */
131 UINT32
132 AcpiHwGetGpeRegisterBit (
133     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
134     ACPI_GPE_REGISTER_INFO  *GpeRegisterInfo);
135 
136 ACPI_STATUS
137 AcpiHwLowSetGpe (
138     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
139     UINT32                  Action);
140 
141 ACPI_STATUS
142 AcpiHwDisableGpeBlock (
143     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
144     ACPI_GPE_BLOCK_INFO     *GpeBlock,
145     void                    *Context);
146 
147 ACPI_STATUS
148 AcpiHwClearGpe (
149     ACPI_GPE_EVENT_INFO     *GpeEventInfo);
150 
151 ACPI_STATUS
152 AcpiHwClearGpeBlock (
153     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
154     ACPI_GPE_BLOCK_INFO     *GpeBlock,
155     void                    *Context);
156 
157 ACPI_STATUS
158 AcpiHwGetGpeStatus (
159     ACPI_GPE_EVENT_INFO     *GpeEventInfo,
160     ACPI_EVENT_STATUS       *EventStatus);
161 
162 ACPI_STATUS
163 AcpiHwDisableAllGpes (
164     void);
165 
166 ACPI_STATUS
167 AcpiHwEnableAllRuntimeGpes (
168     void);
169 
170 ACPI_STATUS
171 AcpiHwEnableAllWakeupGpes (
172     void);
173 
174 ACPI_STATUS
175 AcpiHwEnableRuntimeGpeBlock (
176     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo,
177     ACPI_GPE_BLOCK_INFO     *GpeBlock,
178     void                    *Context);
179 
180 
181 /*
182  * hwpci - PCI configuration support
183  */
184 ACPI_STATUS
185 AcpiHwDerivePciId (
186     ACPI_PCI_ID             *PciId,
187     ACPI_HANDLE             RootPciDevice,
188     ACPI_HANDLE             PciRegion);
189 
190 
191 /*
192  * hwtimer - ACPI Timer prototypes
193  */
194 ACPI_STATUS
195 AcpiGetTimerResolution (
196     UINT32                  *Resolution);
197 
198 ACPI_STATUS
199 AcpiGetTimer (
200     UINT32                  *Ticks);
201 
202 ACPI_STATUS
203 AcpiGetTimerDuration (
204     UINT32                  StartTicks,
205     UINT32                  EndTicks,
206     UINT32                  *TimeElapsed);
207 
208 
209 #endif /* __ACHWARE_H__ */
210