xref: /titanic_52/usr/src/uts/intel/sys/acpi/acresrc.h (revision fa9e4066f08beec538e775443c5be79dd423fcab)
1 /******************************************************************************
2  *
3  * Name: acresrc.h - Resource Manager function prototypes
4  *       $Revision: 42 $
5  *
6  *****************************************************************************/
7 
8 /******************************************************************************
9  *
10  * 1. Copyright Notice
11  *
12  * Some or all of this work - Copyright (c) 1999 - 2005, 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 
27  * make derivatives, distribute, use and display any portion of the Covered
28  * Code in any form, with the right to sublicense such rights; and
29  *
30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31  * license (with the right to sublicense), under only those claims of Intel
32  * patents that are infringed by the Original Intel Code, to make, use, sell,
33  * offer to sell, and import the Covered Code and derivative works thereof
34  * solely to the minimum extent necessary to exercise the above copyright
35  * license, and in no event shall the patent license extend to any additions
36  * to or modifications of the Original Intel Code.  No other license or right
37  * is granted directly or by implication, estoppel or otherwise;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45  * Redistribution of source code of any substantial portion of the Covered
46  * Code or modification with rights to further distribute source must include
47  * the above Copyright Notice, the above License, this list of Conditions,
48  * and the following Disclaimer and Export Compliance provision.  In addition,
49  * Licensee must cause all Covered Code to which Licensee contributes to
50  * contain a file documenting the changes Licensee made to create that Covered
51  * Code and the date of any change.  Licensee must include in that file the
52  * documentation of any changes made by any predecessor Licensee.  Licensee
53  * must include a prominent statement that the modification is derived,
54  * directly or indirectly, from Original Intel Code.
55  *
56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57  * Redistribution of source code of any substantial portion of the Covered
58  * Code or modification without rights to further distribute source must
59  * include the following Disclaimer and Export Compliance provision in the
60  * documentation and/or other materials provided with distribution.  In
61  * addition, Licensee may not authorize further sublicense of source of any
62  * portion of the Covered Code, and must include terms to the effect that the
63  * license from Licensee to its licensee is limited to the intellectual
64  * property embodied in the software Licensee provides to its licensee, and
65  * not to intellectual property embodied in modifications its licensee may
66  * make.
67  *
68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
69  * substantial portion of the Covered Code or modification must reproduce the
70  * above Copyright Notice, and the following Disclaimer and Export Compliance
71  * provision in the documentation and/or other materials provided with the
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78  * Intel shall be used in advertising or otherwise to promote the sale, use or
79  * other dealings in products derived from or relating to the Covered Code
80  * without prior written authorization from Intel.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90  * PARTICULAR PURPOSE.
91  *
92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99  * LIMITED REMEDY.
100  *
101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
102  * software or system incorporating such software without first obtaining any
103  * required license or other approval from the U. S. Department of Commerce or
104  * any other agency or department of the United States Government.  In the
105  * event Licensee exports any such software from the United States or
106  * re-exports any such software from a foreign destination, Licensee shall
107  * ensure that the distribution and export/re-export of the software is in
108  * compliance with all laws, regulations, orders, or other restrictions of the
109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110  * any of its subsidiaries will export/re-export any technical data, process,
111  * software, or service, directly or indirectly, to any country for which the
112  * United States government or any agency thereof requires an export license,
113  * other governmental approval, or letter of assurance, without first obtaining
114  * such license, approval or letter.
115  *
116  *****************************************************************************/
117 
118 #ifndef __ACRESRC_H__
119 #define __ACRESRC_H__
120 
121 
122 /*
123  *  Function prototypes called from Acpi* APIs
124  */
125 ACPI_STATUS
126 AcpiRsGetPrtMethodData (
127     ACPI_HANDLE             Handle,
128     ACPI_BUFFER             *RetBuffer);
129 
130 
131 ACPI_STATUS
132 AcpiRsGetCrsMethodData (
133     ACPI_HANDLE             Handle,
134     ACPI_BUFFER             *RetBuffer);
135 
136 ACPI_STATUS
137 AcpiRsGetPrsMethodData (
138     ACPI_HANDLE             Handle,
139     ACPI_BUFFER             *RetBuffer);
140 
141 ACPI_STATUS
142 AcpiRsGetMethodData (
143     ACPI_HANDLE             Handle,
144     char                    *Path,
145     ACPI_BUFFER             *RetBuffer);
146 
147 ACPI_STATUS
148 AcpiRsSetSrsMethodData (
149     ACPI_HANDLE             Handle,
150     ACPI_BUFFER             *RetBuffer);
151 
152 ACPI_STATUS
153 AcpiRsCreateResourceList (
154     ACPI_OPERAND_OBJECT     *ByteStreamBuffer,
155     ACPI_BUFFER             *OutputBuffer);
156 
157 ACPI_STATUS
158 AcpiRsCreateByteStream (
159     ACPI_RESOURCE           *LinkedListBuffer,
160     ACPI_BUFFER             *OutputBuffer);
161 
162 ACPI_STATUS
163 AcpiRsCreatePciRoutingTable (
164     ACPI_OPERAND_OBJECT     *PackageObject,
165     ACPI_BUFFER             *OutputBuffer);
166 
167 
168 /*
169  * rsdump
170  */
171 void
172 AcpiRsDumpResourceList (
173     ACPI_RESOURCE           *Resource);
174 
175 void
176 AcpiRsDumpIrqList (
177     UINT8                   *RouteTable);
178 
179 
180 /*
181  * rscalc
182  */
183 ACPI_STATUS
184 AcpiRsGetByteStreamStart (
185     UINT8                   *ByteStreamBuffer,
186     UINT8                   **ByteStreamStart,
187     UINT32                  *Size);
188 
189 ACPI_STATUS
190 AcpiRsGetListLength (
191     UINT8                   *ByteStreamBuffer,
192     UINT32                  ByteStreamBufferLength,
193     ACPI_SIZE               *SizeNeeded);
194 
195 ACPI_STATUS
196 AcpiRsGetByteStreamLength (
197     ACPI_RESOURCE           *LinkedListBuffer,
198     ACPI_SIZE               *SizeNeeded);
199 
200 ACPI_STATUS
201 AcpiRsGetPciRoutingTableLength (
202     ACPI_OPERAND_OBJECT     *PackageObject,
203     ACPI_SIZE               *BufferSizeNeeded);
204 
205 ACPI_STATUS
206 AcpiRsByteStreamToList (
207     UINT8                   *ByteStreamBuffer,
208     UINT32                  ByteStreamBufferLength,
209     UINT8                   *OutputBuffer);
210 
211 ACPI_STATUS
212 AcpiRsListToByteStream (
213     ACPI_RESOURCE           *LinkedList,
214     ACPI_SIZE               ByteStreamSizeNeeded,
215     UINT8                   *OutputBuffer);
216 
217 ACPI_STATUS
218 AcpiRsIoResource (
219     UINT8                   *ByteStreamBuffer,
220     ACPI_SIZE               *BytesConsumed,
221     UINT8                   **OutputBuffer,
222     ACPI_SIZE               *StructureSize);
223 
224 ACPI_STATUS
225 AcpiRsFixedIoResource (
226     UINT8                   *ByteStreamBuffer,
227     ACPI_SIZE               *BytesConsumed,
228     UINT8                   **OutputBuffer,
229     ACPI_SIZE               *StructureSize);
230 
231 ACPI_STATUS
232 AcpiRsIoStream (
233     ACPI_RESOURCE           *LinkedList,
234     UINT8                   **OutputBuffer,
235     ACPI_SIZE               *BytesConsumed);
236 
237 ACPI_STATUS
238 AcpiRsFixedIoStream (
239     ACPI_RESOURCE           *LinkedList,
240     UINT8                   **OutputBuffer,
241     ACPI_SIZE               *BytesConsumed);
242 
243 ACPI_STATUS
244 AcpiRsIrqResource (
245     UINT8                   *ByteStreamBuffer,
246     ACPI_SIZE               *BytesConsumed,
247     UINT8                   **OutputBuffer,
248     ACPI_SIZE               *StructureSize);
249 
250 ACPI_STATUS
251 AcpiRsIrqStream (
252     ACPI_RESOURCE           *LinkedList,
253     UINT8                   **OutputBuffer,
254     ACPI_SIZE               *BytesConsumed);
255 
256 ACPI_STATUS
257 AcpiRsDmaResource (
258     UINT8                   *ByteStreamBuffer,
259     ACPI_SIZE               *BytesConsumed,
260     UINT8                   **OutputBuffer,
261     ACPI_SIZE               *StructureSize);
262 
263 ACPI_STATUS
264 AcpiRsDmaStream (
265     ACPI_RESOURCE           *LinkedList,
266     UINT8                   **OutputBuffer,
267     ACPI_SIZE               *BytesConsumed);
268 
269 ACPI_STATUS
270 AcpiRsAddress16Resource (
271     UINT8                   *ByteStreamBuffer,
272     ACPI_SIZE               *BytesConsumed,
273     UINT8                   **OutputBuffer,
274     ACPI_SIZE               *StructureSize);
275 
276 ACPI_STATUS
277 AcpiRsAddress16Stream (
278     ACPI_RESOURCE           *LinkedList,
279     UINT8                   **OutputBuffer,
280     ACPI_SIZE               *BytesConsumed);
281 
282 ACPI_STATUS
283 AcpiRsAddress32Resource (
284     UINT8                   *ByteStreamBuffer,
285     ACPI_SIZE               *BytesConsumed,
286     UINT8                   **OutputBuffer,
287     ACPI_SIZE               *StructureSize);
288 
289 ACPI_STATUS
290 AcpiRsAddress32Stream (
291     ACPI_RESOURCE           *LinkedList,
292     UINT8                   **OutputBuffer,
293     ACPI_SIZE               *BytesConsumed);
294 
295 ACPI_STATUS
296 AcpiRsAddress64Resource (
297     UINT8                   *ByteStreamBuffer,
298     ACPI_SIZE               *BytesConsumed,
299     UINT8                   **OutputBuffer,
300     ACPI_SIZE               *StructureSize);
301 
302 ACPI_STATUS
303 AcpiRsAddress64Stream (
304     ACPI_RESOURCE           *LinkedList,
305     UINT8                   **OutputBuffer,
306     ACPI_SIZE               *BytesConsumed);
307 
308 ACPI_STATUS
309 AcpiRsStartDependFnsResource (
310     UINT8                   *ByteStreamBuffer,
311     ACPI_SIZE               *BytesConsumed,
312     UINT8                   **OutputBuffer,
313     ACPI_SIZE               *StructureSize);
314 
315 ACPI_STATUS
316 AcpiRsEndDependFnsResource (
317     UINT8                   *ByteStreamBuffer,
318     ACPI_SIZE               *BytesConsumed,
319     UINT8                   **OutputBuffer,
320     ACPI_SIZE               *StructureSize);
321 
322 ACPI_STATUS
323 AcpiRsStartDependFnsStream (
324     ACPI_RESOURCE           *LinkedList,
325     UINT8                   **OutputBuffer,
326     ACPI_SIZE               *BytesConsumed);
327 
328 ACPI_STATUS
329 AcpiRsEndDependFnsStream (
330     ACPI_RESOURCE           *LinkedList,
331     UINT8                   **OutputBuffer,
332     ACPI_SIZE               *BytesConsumed);
333 
334 ACPI_STATUS
335 AcpiRsMemory24Resource (
336     UINT8                   *ByteStreamBuffer,
337     ACPI_SIZE               *BytesConsumed,
338     UINT8                   **OutputBuffer,
339     ACPI_SIZE               *StructureSize);
340 
341 ACPI_STATUS
342 AcpiRsMemory24Stream (
343     ACPI_RESOURCE           *LinkedList,
344     UINT8                   **OutputBuffer,
345     ACPI_SIZE               *BytesConsumed);
346 
347 ACPI_STATUS
348 AcpiRsMemory32RangeResource (
349     UINT8                   *ByteStreamBuffer,
350     ACPI_SIZE               *BytesConsumed,
351     UINT8                   **OutputBuffer,
352     ACPI_SIZE               *StructureSize);
353 
354 ACPI_STATUS
355 AcpiRsFixedMemory32Resource (
356     UINT8                   *ByteStreamBuffer,
357     ACPI_SIZE               *BytesConsumed,
358     UINT8                   **OutputBuffer,
359     ACPI_SIZE               *StructureSize);
360 
361 ACPI_STATUS
362 AcpiRsMemory32RangeStream (
363     ACPI_RESOURCE           *LinkedList,
364     UINT8                   **OutputBuffer,
365     ACPI_SIZE               *BytesConsumed);
366 
367 ACPI_STATUS
368 AcpiRsFixedMemory32Stream (
369     ACPI_RESOURCE           *LinkedList,
370     UINT8                   **OutputBuffer,
371     ACPI_SIZE               *BytesConsumed);
372 
373 ACPI_STATUS
374 AcpiRsExtendedIrqResource (
375     UINT8                   *ByteStreamBuffer,
376     ACPI_SIZE               *BytesConsumed,
377     UINT8                   **OutputBuffer,
378     ACPI_SIZE               *StructureSize);
379 
380 ACPI_STATUS
381 AcpiRsExtendedIrqStream (
382     ACPI_RESOURCE           *LinkedList,
383     UINT8                   **OutputBuffer,
384     ACPI_SIZE               *BytesConsumed);
385 
386 ACPI_STATUS
387 AcpiRsEndTagResource (
388     UINT8                   *ByteStreamBuffer,
389     ACPI_SIZE               *BytesConsumed,
390     UINT8                   **OutputBuffer,
391     ACPI_SIZE               *StructureSize);
392 
393 ACPI_STATUS
394 AcpiRsEndTagStream (
395     ACPI_RESOURCE           *LinkedList,
396     UINT8                   **OutputBuffer,
397     ACPI_SIZE               *BytesConsumed);
398 
399 ACPI_STATUS
400 AcpiRsVendorResource (
401     UINT8                   *ByteStreamBuffer,
402     ACPI_SIZE               *BytesConsumed,
403     UINT8                   **OutputBuffer,
404     ACPI_SIZE               *StructureSize);
405 
406 ACPI_STATUS
407 AcpiRsVendorStream (
408     ACPI_RESOURCE           *LinkedList,
409     UINT8                   **OutputBuffer,
410     ACPI_SIZE               *BytesConsumed);
411 
412 UINT8
413 AcpiRsGetResourceType (
414     UINT8                   ResourceStartByte);
415 
416 #endif  /* __ACRESRC_H__ */
417