acresrc.h revision 91116 
1/******************************************************************************
2 *
3 * Name: acresrc.h - Resource Manager function prototypes
4 *       $Revision: 30 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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
126ACPI_STATUS
127AcpiRsGetPrtMethodData (
128    ACPI_HANDLE             Handle,
129    ACPI_BUFFER             *RetBuffer);
130
131
132ACPI_STATUS
133AcpiRsGetCrsMethodData (
134    ACPI_HANDLE             Handle,
135    ACPI_BUFFER             *RetBuffer);
136
137ACPI_STATUS
138AcpiRsGetPrsMethodData (
139    ACPI_HANDLE             Handle,
140    ACPI_BUFFER             *RetBuffer);
141
142ACPI_STATUS
143AcpiRsSetSrsMethodData (
144    ACPI_HANDLE             Handle,
145    ACPI_BUFFER             *RetBuffer);
146
147ACPI_STATUS
148AcpiRsCreateResourceList (
149    ACPI_OPERAND_OBJECT     *ByteStreamBuffer,
150    ACPI_BUFFER             *OutputBuffer);
151
152ACPI_STATUS
153AcpiRsCreateByteStream (
154    ACPI_RESOURCE           *LinkedListBuffer,
155    ACPI_BUFFER             *OutputBuffer);
156
157ACPI_STATUS
158AcpiRsCreatePciRoutingTable (
159    ACPI_OPERAND_OBJECT     *PackageObject,
160    ACPI_BUFFER             *OutputBuffer);
161
162
163/*
164 *Function prototypes called from AcpiRsCreate*
165 */
166
167void
168AcpiRsDumpResourceList (
169    ACPI_RESOURCE           *Resource);
170
171void
172AcpiRsDumpIrqList (
173    UINT8                   *RouteTable);
174
175ACPI_STATUS
176AcpiRsGetByteStreamStart (
177    UINT8                   *ByteStreamBuffer,
178    UINT8                   **ByteStreamStart,
179    UINT32                  *Size);
180
181ACPI_STATUS
182AcpiRsCalculateListLength (
183    UINT8                   *ByteStreamBuffer,
184    UINT32                  ByteStreamBufferLength,
185    ACPI_SIZE               *SizeNeeded);
186
187ACPI_STATUS
188AcpiRsCalculateByteStreamLength (
189    ACPI_RESOURCE           *LinkedListBuffer,
190    ACPI_SIZE               *SizeNeeded);
191
192ACPI_STATUS
193AcpiRsCalculatePciRoutingTableLength (
194    ACPI_OPERAND_OBJECT     *PackageObject,
195    ACPI_SIZE               *BufferSizeNeeded);
196
197ACPI_STATUS
198AcpiRsByteStreamToList (
199    UINT8                   *ByteStreamBuffer,
200    UINT32                  ByteStreamBufferLength,
201    UINT8                   *OutputBuffer);
202
203ACPI_STATUS
204AcpiRsListToByteStream (
205    ACPI_RESOURCE           *LinkedList,
206    UINT32                  ByteStreamSizeNeeded,
207    UINT8                   *OutputBuffer);
208
209ACPI_STATUS
210AcpiRsIoResource (
211    UINT8                   *ByteStreamBuffer,
212    ACPI_SIZE               *BytesConsumed,
213    UINT8                   **OutputBuffer,
214    ACPI_SIZE               *StructureSize);
215
216ACPI_STATUS
217AcpiRsFixedIoResource (
218    UINT8                   *ByteStreamBuffer,
219    ACPI_SIZE               *BytesConsumed,
220    UINT8                   **OutputBuffer,
221    ACPI_SIZE               *StructureSize);
222
223ACPI_STATUS
224AcpiRsIoStream (
225    ACPI_RESOURCE           *LinkedList,
226    UINT8                   **OutputBuffer,
227    ACPI_SIZE               *BytesConsumed);
228
229ACPI_STATUS
230AcpiRsFixedIoStream (
231    ACPI_RESOURCE           *LinkedList,
232    UINT8                   **OutputBuffer,
233    ACPI_SIZE               *BytesConsumed);
234
235ACPI_STATUS
236AcpiRsIrqResource (
237    UINT8                   *ByteStreamBuffer,
238    ACPI_SIZE               *BytesConsumed,
239    UINT8                   **OutputBuffer,
240    ACPI_SIZE               *StructureSize);
241
242ACPI_STATUS
243AcpiRsIrqStream (
244    ACPI_RESOURCE           *LinkedList,
245    UINT8                   **OutputBuffer,
246    ACPI_SIZE               *BytesConsumed);
247
248ACPI_STATUS
249AcpiRsDmaResource (
250    UINT8                   *ByteStreamBuffer,
251    ACPI_SIZE               *BytesConsumed,
252    UINT8                   **OutputBuffer,
253    ACPI_SIZE               *StructureSize);
254
255ACPI_STATUS
256AcpiRsDmaStream (
257    ACPI_RESOURCE           *LinkedList,
258    UINT8                   **OutputBuffer,
259    ACPI_SIZE               *BytesConsumed);
260
261ACPI_STATUS
262AcpiRsAddress16Resource (
263    UINT8                   *ByteStreamBuffer,
264    ACPI_SIZE               *BytesConsumed,
265    UINT8                   **OutputBuffer,
266    ACPI_SIZE               *StructureSize);
267
268ACPI_STATUS
269AcpiRsAddress16Stream (
270    ACPI_RESOURCE           *LinkedList,
271    UINT8                   **OutputBuffer,
272    ACPI_SIZE               *BytesConsumed);
273
274ACPI_STATUS
275AcpiRsAddress32Resource (
276    UINT8                   *ByteStreamBuffer,
277    ACPI_SIZE               *BytesConsumed,
278    UINT8                   **OutputBuffer,
279    ACPI_SIZE               *StructureSize);
280
281ACPI_STATUS
282AcpiRsAddress32Stream (
283    ACPI_RESOURCE           *LinkedList,
284    UINT8                   **OutputBuffer,
285    ACPI_SIZE               *BytesConsumed);
286
287ACPI_STATUS
288AcpiRsAddress64Resource (
289    UINT8                   *ByteStreamBuffer,
290    ACPI_SIZE               *BytesConsumed,
291    UINT8                   **OutputBuffer,
292    ACPI_SIZE               *StructureSize);
293
294ACPI_STATUS
295AcpiRsAddress64Stream (
296    ACPI_RESOURCE           *LinkedList,
297    UINT8                   **OutputBuffer,
298    ACPI_SIZE               *BytesConsumed);
299
300ACPI_STATUS
301AcpiRsStartDependFnsResource (
302    UINT8                   *ByteStreamBuffer,
303    ACPI_SIZE               *BytesConsumed,
304    UINT8                   **OutputBuffer,
305    ACPI_SIZE               *StructureSize);
306
307ACPI_STATUS
308AcpiRsEndDependFnsResource (
309    UINT8                   *ByteStreamBuffer,
310    ACPI_SIZE               *BytesConsumed,
311    UINT8                   **OutputBuffer,
312    ACPI_SIZE               *StructureSize);
313
314ACPI_STATUS
315AcpiRsStartDependFnsStream (
316    ACPI_RESOURCE           *LinkedList,
317    UINT8                   **OutputBuffer,
318    ACPI_SIZE               *BytesConsumed);
319
320ACPI_STATUS
321AcpiRsEndDependFnsStream (
322    ACPI_RESOURCE           *LinkedList,
323    UINT8                   **OutputBuffer,
324    ACPI_SIZE               *BytesConsumed);
325
326ACPI_STATUS
327AcpiRsMemory24Resource (
328    UINT8                   *ByteStreamBuffer,
329    ACPI_SIZE               *BytesConsumed,
330    UINT8                   **OutputBuffer,
331    ACPI_SIZE               *StructureSize);
332
333ACPI_STATUS
334AcpiRsMemory24Stream (
335    ACPI_RESOURCE           *LinkedList,
336    UINT8                   **OutputBuffer,
337    ACPI_SIZE               *BytesConsumed);
338
339ACPI_STATUS
340AcpiRsMemory32RangeResource (
341    UINT8                   *ByteStreamBuffer,
342    ACPI_SIZE               *BytesConsumed,
343    UINT8                   **OutputBuffer,
344    ACPI_SIZE               *StructureSize);
345
346ACPI_STATUS
347AcpiRsFixedMemory32Resource (
348    UINT8                   *ByteStreamBuffer,
349    ACPI_SIZE               *BytesConsumed,
350    UINT8                   **OutputBuffer,
351    ACPI_SIZE               *StructureSize);
352
353ACPI_STATUS
354AcpiRsMemory32RangeStream (
355    ACPI_RESOURCE           *LinkedList,
356    UINT8                   **OutputBuffer,
357    ACPI_SIZE               *BytesConsumed);
358
359ACPI_STATUS
360AcpiRsFixedMemory32Stream (
361    ACPI_RESOURCE           *LinkedList,
362    UINT8                   **OutputBuffer,
363    ACPI_SIZE               *BytesConsumed);
364
365ACPI_STATUS
366AcpiRsExtendedIrqResource (
367    UINT8                   *ByteStreamBuffer,
368    ACPI_SIZE               *BytesConsumed,
369    UINT8                   **OutputBuffer,
370    ACPI_SIZE               *StructureSize);
371
372ACPI_STATUS
373AcpiRsExtendedIrqStream (
374    ACPI_RESOURCE           *LinkedList,
375    UINT8                   **OutputBuffer,
376    ACPI_SIZE               *BytesConsumed);
377
378ACPI_STATUS
379AcpiRsEndTagResource (
380    UINT8                   *ByteStreamBuffer,
381    ACPI_SIZE               *BytesConsumed,
382    UINT8                   **OutputBuffer,
383    ACPI_SIZE               *StructureSize);
384
385ACPI_STATUS
386AcpiRsEndTagStream (
387    ACPI_RESOURCE           *LinkedList,
388    UINT8                   **OutputBuffer,
389    ACPI_SIZE               *BytesConsumed);
390
391ACPI_STATUS
392AcpiRsVendorResource (
393    UINT8                   *ByteStreamBuffer,
394    ACPI_SIZE               *BytesConsumed,
395    UINT8                   **OutputBuffer,
396    ACPI_SIZE               *StructureSize);
397
398ACPI_STATUS
399AcpiRsVendorStream (
400    ACPI_RESOURCE           *LinkedList,
401    UINT8                   **OutputBuffer,
402    ACPI_SIZE               *BytesConsumed);
403
404UINT8
405AcpiRsGetResourceType (
406    UINT8                   ResourceStartByte);
407
408#endif  /* __ACRESRC_H__ */
409