acresrc.h revision 102550 
1/******************************************************************************
2 *
3 * Name: acresrc.h - Resource Manager function prototypes
4 *       $Revision: 34 $
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 */
166void
167AcpiRsDumpIrq (
168    ACPI_RESOURCE_DATA      *Data);
169
170void
171AcpiRsDumpAddress16 (
172    ACPI_RESOURCE_DATA      *Data);
173
174void
175AcpiRsDumpAddress32 (
176    ACPI_RESOURCE_DATA      *Data);
177
178void
179AcpiRsDumpAddress64 (
180    ACPI_RESOURCE_DATA      *Data);
181
182void
183AcpiRsDumpDma (
184    ACPI_RESOURCE_DATA      *Data);
185
186void
187AcpiRsDumpIo (
188    ACPI_RESOURCE_DATA      *Data);
189
190void
191AcpiRsDumpExtendedIrq (
192    ACPI_RESOURCE_DATA      *Data);
193
194void
195AcpiRsDumpFixedIo (
196    ACPI_RESOURCE_DATA      *Data);
197
198void
199AcpiRsDumpFixedMemory32 (
200    ACPI_RESOURCE_DATA      *Data);
201
202void
203AcpiRsDumpMemory24 (
204    ACPI_RESOURCE_DATA      *Data);
205
206void
207AcpiRsDumpMemory32 (
208    ACPI_RESOURCE_DATA      *Data);
209
210void
211AcpiRsDumpStartDependFns (
212    ACPI_RESOURCE_DATA      *Data);
213
214void
215AcpiRsDumpVendorSpecific (
216    ACPI_RESOURCE_DATA      *Data);
217
218void
219AcpiRsDumpResourceList (
220    ACPI_RESOURCE           *Resource);
221
222void
223AcpiRsDumpIrqList (
224    UINT8                   *RouteTable);
225
226ACPI_STATUS
227AcpiRsGetByteStreamStart (
228    UINT8                   *ByteStreamBuffer,
229    UINT8                   **ByteStreamStart,
230    UINT32                  *Size);
231
232ACPI_STATUS
233AcpiRsGetListLength (
234    UINT8                   *ByteStreamBuffer,
235    UINT32                  ByteStreamBufferLength,
236    ACPI_SIZE               *SizeNeeded);
237
238ACPI_STATUS
239AcpiRsGetByteStreamLength (
240    ACPI_RESOURCE           *LinkedListBuffer,
241    ACPI_SIZE               *SizeNeeded);
242
243ACPI_STATUS
244AcpiRsGetPciRoutingTableLength (
245    ACPI_OPERAND_OBJECT     *PackageObject,
246    ACPI_SIZE               *BufferSizeNeeded);
247
248ACPI_STATUS
249AcpiRsByteStreamToList (
250    UINT8                   *ByteStreamBuffer,
251    UINT32                  ByteStreamBufferLength,
252    UINT8                   *OutputBuffer);
253
254ACPI_STATUS
255AcpiRsListToByteStream (
256    ACPI_RESOURCE           *LinkedList,
257    ACPI_SIZE               ByteStreamSizeNeeded,
258    UINT8                   *OutputBuffer);
259
260ACPI_STATUS
261AcpiRsIoResource (
262    UINT8                   *ByteStreamBuffer,
263    ACPI_SIZE               *BytesConsumed,
264    UINT8                   **OutputBuffer,
265    ACPI_SIZE               *StructureSize);
266
267ACPI_STATUS
268AcpiRsFixedIoResource (
269    UINT8                   *ByteStreamBuffer,
270    ACPI_SIZE               *BytesConsumed,
271    UINT8                   **OutputBuffer,
272    ACPI_SIZE               *StructureSize);
273
274ACPI_STATUS
275AcpiRsIoStream (
276    ACPI_RESOURCE           *LinkedList,
277    UINT8                   **OutputBuffer,
278    ACPI_SIZE               *BytesConsumed);
279
280ACPI_STATUS
281AcpiRsFixedIoStream (
282    ACPI_RESOURCE           *LinkedList,
283    UINT8                   **OutputBuffer,
284    ACPI_SIZE               *BytesConsumed);
285
286ACPI_STATUS
287AcpiRsIrqResource (
288    UINT8                   *ByteStreamBuffer,
289    ACPI_SIZE               *BytesConsumed,
290    UINT8                   **OutputBuffer,
291    ACPI_SIZE               *StructureSize);
292
293ACPI_STATUS
294AcpiRsIrqStream (
295    ACPI_RESOURCE           *LinkedList,
296    UINT8                   **OutputBuffer,
297    ACPI_SIZE               *BytesConsumed);
298
299ACPI_STATUS
300AcpiRsDmaResource (
301    UINT8                   *ByteStreamBuffer,
302    ACPI_SIZE               *BytesConsumed,
303    UINT8                   **OutputBuffer,
304    ACPI_SIZE               *StructureSize);
305
306ACPI_STATUS
307AcpiRsDmaStream (
308    ACPI_RESOURCE           *LinkedList,
309    UINT8                   **OutputBuffer,
310    ACPI_SIZE               *BytesConsumed);
311
312ACPI_STATUS
313AcpiRsAddress16Resource (
314    UINT8                   *ByteStreamBuffer,
315    ACPI_SIZE               *BytesConsumed,
316    UINT8                   **OutputBuffer,
317    ACPI_SIZE               *StructureSize);
318
319ACPI_STATUS
320AcpiRsAddress16Stream (
321    ACPI_RESOURCE           *LinkedList,
322    UINT8                   **OutputBuffer,
323    ACPI_SIZE               *BytesConsumed);
324
325ACPI_STATUS
326AcpiRsAddress32Resource (
327    UINT8                   *ByteStreamBuffer,
328    ACPI_SIZE               *BytesConsumed,
329    UINT8                   **OutputBuffer,
330    ACPI_SIZE               *StructureSize);
331
332ACPI_STATUS
333AcpiRsAddress32Stream (
334    ACPI_RESOURCE           *LinkedList,
335    UINT8                   **OutputBuffer,
336    ACPI_SIZE               *BytesConsumed);
337
338ACPI_STATUS
339AcpiRsAddress64Resource (
340    UINT8                   *ByteStreamBuffer,
341    ACPI_SIZE               *BytesConsumed,
342    UINT8                   **OutputBuffer,
343    ACPI_SIZE               *StructureSize);
344
345ACPI_STATUS
346AcpiRsAddress64Stream (
347    ACPI_RESOURCE           *LinkedList,
348    UINT8                   **OutputBuffer,
349    ACPI_SIZE               *BytesConsumed);
350
351ACPI_STATUS
352AcpiRsStartDependFnsResource (
353    UINT8                   *ByteStreamBuffer,
354    ACPI_SIZE               *BytesConsumed,
355    UINT8                   **OutputBuffer,
356    ACPI_SIZE               *StructureSize);
357
358ACPI_STATUS
359AcpiRsEndDependFnsResource (
360    UINT8                   *ByteStreamBuffer,
361    ACPI_SIZE               *BytesConsumed,
362    UINT8                   **OutputBuffer,
363    ACPI_SIZE               *StructureSize);
364
365ACPI_STATUS
366AcpiRsStartDependFnsStream (
367    ACPI_RESOURCE           *LinkedList,
368    UINT8                   **OutputBuffer,
369    ACPI_SIZE               *BytesConsumed);
370
371ACPI_STATUS
372AcpiRsEndDependFnsStream (
373    ACPI_RESOURCE           *LinkedList,
374    UINT8                   **OutputBuffer,
375    ACPI_SIZE               *BytesConsumed);
376
377ACPI_STATUS
378AcpiRsMemory24Resource (
379    UINT8                   *ByteStreamBuffer,
380    ACPI_SIZE               *BytesConsumed,
381    UINT8                   **OutputBuffer,
382    ACPI_SIZE               *StructureSize);
383
384ACPI_STATUS
385AcpiRsMemory24Stream (
386    ACPI_RESOURCE           *LinkedList,
387    UINT8                   **OutputBuffer,
388    ACPI_SIZE               *BytesConsumed);
389
390ACPI_STATUS
391AcpiRsMemory32RangeResource (
392    UINT8                   *ByteStreamBuffer,
393    ACPI_SIZE               *BytesConsumed,
394    UINT8                   **OutputBuffer,
395    ACPI_SIZE               *StructureSize);
396
397ACPI_STATUS
398AcpiRsFixedMemory32Resource (
399    UINT8                   *ByteStreamBuffer,
400    ACPI_SIZE               *BytesConsumed,
401    UINT8                   **OutputBuffer,
402    ACPI_SIZE               *StructureSize);
403
404ACPI_STATUS
405AcpiRsMemory32RangeStream (
406    ACPI_RESOURCE           *LinkedList,
407    UINT8                   **OutputBuffer,
408    ACPI_SIZE               *BytesConsumed);
409
410ACPI_STATUS
411AcpiRsFixedMemory32Stream (
412    ACPI_RESOURCE           *LinkedList,
413    UINT8                   **OutputBuffer,
414    ACPI_SIZE               *BytesConsumed);
415
416ACPI_STATUS
417AcpiRsExtendedIrqResource (
418    UINT8                   *ByteStreamBuffer,
419    ACPI_SIZE               *BytesConsumed,
420    UINT8                   **OutputBuffer,
421    ACPI_SIZE               *StructureSize);
422
423ACPI_STATUS
424AcpiRsExtendedIrqStream (
425    ACPI_RESOURCE           *LinkedList,
426    UINT8                   **OutputBuffer,
427    ACPI_SIZE               *BytesConsumed);
428
429ACPI_STATUS
430AcpiRsEndTagResource (
431    UINT8                   *ByteStreamBuffer,
432    ACPI_SIZE               *BytesConsumed,
433    UINT8                   **OutputBuffer,
434    ACPI_SIZE               *StructureSize);
435
436ACPI_STATUS
437AcpiRsEndTagStream (
438    ACPI_RESOURCE           *LinkedList,
439    UINT8                   **OutputBuffer,
440    ACPI_SIZE               *BytesConsumed);
441
442ACPI_STATUS
443AcpiRsVendorResource (
444    UINT8                   *ByteStreamBuffer,
445    ACPI_SIZE               *BytesConsumed,
446    UINT8                   **OutputBuffer,
447    ACPI_SIZE               *StructureSize);
448
449ACPI_STATUS
450AcpiRsVendorStream (
451    ACPI_RESOURCE           *LinkedList,
452    UINT8                   **OutputBuffer,
453    ACPI_SIZE               *BytesConsumed);
454
455UINT8
456AcpiRsGetResourceType (
457    UINT8                   ResourceStartByte);
458
459#endif  /* __ACRESRC_H__ */
460