RTEMS 6.3
Loading...
Searching...
No Matches
achware.h
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 - 2024, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152#ifndef __ACHWARE_H__
153#define __ACHWARE_H__
154
155
156/* Values for the _SST predefined method */
157
158#define ACPI_SST_INDICATOR_OFF 0
159#define ACPI_SST_WORKING 1
160#define ACPI_SST_WAKING 2
161#define ACPI_SST_SLEEPING 3
162#define ACPI_SST_SLEEP_CONTEXT 4
163
164
165/*
166 * hwacpi - high level functions
167 */
168ACPI_STATUS
169AcpiHwSetMode (
170 UINT32 Mode);
171
172UINT32
173AcpiHwGetMode (
174 void);
175
176
177/*
178 * hwregs - ACPI Register I/O
179 */
180ACPI_STATUS
181AcpiHwValidateRegister (
182 ACPI_GENERIC_ADDRESS *Reg,
183 UINT8 MaxBitWidth,
184 UINT64 *Address);
185
186ACPI_STATUS
187AcpiHwRead (
188 UINT64 *Value,
189 ACPI_GENERIC_ADDRESS *Reg);
190
191ACPI_STATUS
192AcpiHwWrite (
193 UINT64 Value,
194 ACPI_GENERIC_ADDRESS *Reg);
195
196ACPI_BIT_REGISTER_INFO *
197AcpiHwGetBitRegisterInfo (
198 UINT32 RegisterId);
199
200ACPI_STATUS
201AcpiHwWritePm1Control (
202 UINT32 Pm1aControl,
203 UINT32 Pm1bControl);
204
205ACPI_STATUS
206AcpiHwRegisterRead (
207 UINT32 RegisterId,
208 UINT32 *ReturnValue);
209
210ACPI_STATUS
211AcpiHwRegisterWrite (
212 UINT32 RegisterId,
213 UINT32 Value);
214
215ACPI_STATUS
216AcpiHwClearAcpiStatus (
217 void);
218
219
220/*
221 * hwsleep - sleep/wake support (Legacy sleep registers)
222 */
223ACPI_STATUS
224AcpiHwLegacySleep (
225 UINT8 SleepState);
226
227ACPI_STATUS
228AcpiHwLegacyWakePrep (
229 UINT8 SleepState);
230
231ACPI_STATUS
232AcpiHwLegacyWake (
233 UINT8 SleepState);
234
235
236/*
237 * hwesleep - sleep/wake support (Extended FADT-V5 sleep registers)
238 */
239void
240AcpiHwExecuteSleepMethod (
241 char *MethodName,
242 UINT32 IntegerArgument);
243
244ACPI_STATUS
245AcpiHwExtendedSleep (
246 UINT8 SleepState);
247
248ACPI_STATUS
249AcpiHwExtendedWakePrep (
250 UINT8 SleepState);
251
252ACPI_STATUS
253AcpiHwExtendedWake (
254 UINT8 SleepState);
255
256
257/*
258 * hwvalid - Port I/O with validation
259 */
260ACPI_STATUS
261AcpiHwReadPort (
262 ACPI_IO_ADDRESS Address,
263 UINT32 *Value,
264 UINT32 Width);
265
266ACPI_STATUS
267AcpiHwWritePort (
268 ACPI_IO_ADDRESS Address,
269 UINT32 Value,
270 UINT32 Width);
271
272
273/*
274 * hwgpe - GPE support
275 */
276UINT32
277AcpiHwGetGpeRegisterBit (
278 ACPI_GPE_EVENT_INFO *GpeEventInfo);
279
280ACPI_STATUS
281AcpiHwLowSetGpe (
282 ACPI_GPE_EVENT_INFO *GpeEventInfo,
283 UINT32 Action);
284
285ACPI_STATUS
286AcpiHwDisableGpeBlock (
287 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
288 ACPI_GPE_BLOCK_INFO *GpeBlock,
289 void *Context);
290
291ACPI_STATUS
292AcpiHwClearGpe (
293 ACPI_GPE_EVENT_INFO *GpeEventInfo);
294
295ACPI_STATUS
296AcpiHwClearGpeBlock (
297 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
298 ACPI_GPE_BLOCK_INFO *GpeBlock,
299 void *Context);
300
301ACPI_STATUS
302AcpiHwGetGpeStatus (
303 ACPI_GPE_EVENT_INFO *GpeEventInfo,
304 ACPI_EVENT_STATUS *EventStatus);
305
306ACPI_STATUS
307AcpiHwDisableAllGpes (
308 void);
309
310ACPI_STATUS
311AcpiHwEnableAllRuntimeGpes (
312 void);
313
314ACPI_STATUS
315AcpiHwEnableAllWakeupGpes (
316 void);
317
318UINT8
319AcpiHwCheckAllGpes (
320 void);
321
322ACPI_STATUS
323AcpiHwEnableRuntimeGpeBlock (
324 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
325 ACPI_GPE_BLOCK_INFO *GpeBlock,
326 void *Context);
327
328
329/*
330 * hwpci - PCI configuration support
331 */
332ACPI_STATUS
333AcpiHwDerivePciId (
334 ACPI_PCI_ID *PciId,
335 ACPI_HANDLE RootPciDevice,
336 ACPI_HANDLE PciRegion);
337
338
339#endif /* __ACHWARE_H__ */
Generated by doxygen 1.18.0