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