1 /*******************************************************************************
3 * Module Name: rsxface - Public interfaces to the resource manager
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/rsxface.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
119 #define __RSXFACE_C__
124 #define _COMPONENT ACPI_RESOURCES
125 ACPI_MODULE_NAME ("rsxface")
128 /*******************************************************************************
130 * FUNCTION: AcpiGetIrqRoutingTable
132 * PARAMETERS: DeviceHandle - a handle to the Bus device we are querying
133 * RetBuffer - a pointer to a buffer to receive the
134 * current resources for the device
138 * DESCRIPTION: This function is called to get the IRQ routing table for a
139 * specific bus. The caller must first acquire a handle for the
140 * desired bus. The routine table is placed in the buffer pointed
141 * to by the RetBuffer variable parameter.
143 * If the function fails an appropriate status will be returned
144 * and the value of RetBuffer is undefined.
146 * This function attempts to execute the _PRT method contained in
147 * the object indicated by the passed DeviceHandle.
149 ******************************************************************************/
152 AcpiGetIrqRoutingTable (
153 ACPI_HANDLE DeviceHandle,
154 ACPI_BUFFER *RetBuffer)
159 ACPI_FUNCTION_TRACE ("AcpiGetIrqRoutingTable ");
163 * Must have a valid handle and buffer, So we have to have a handle
164 * and a return buffer structure, and if there is a non-zero buffer length
165 * we also need a valid pointer in the buffer. If it's a zero buffer length,
166 * we'll be returning the needed buffer size, so keep going.
170 return_ACPI_STATUS (AE_BAD_PARAMETER);
173 Status = AcpiUtValidateBuffer (RetBuffer);
174 if (ACPI_FAILURE (Status))
176 return_ACPI_STATUS (Status);
179 Status = AcpiRsGetPrtMethodData (DeviceHandle, RetBuffer);
180 return_ACPI_STATUS (Status);
184 /*******************************************************************************
186 * FUNCTION: AcpiGetCurrentResources
188 * PARAMETERS: DeviceHandle - a handle to the device object for the
189 * device we are querying
190 * RetBuffer - a pointer to a buffer to receive the
191 * current resources for the device
195 * DESCRIPTION: This function is called to get the current resources for a
196 * specific device. The caller must first acquire a handle for
197 * the desired device. The resource data is placed in the buffer
198 * pointed to by the RetBuffer variable parameter.
200 * If the function fails an appropriate status will be returned
201 * and the value of RetBuffer is undefined.
203 * This function attempts to execute the _CRS method contained in
204 * the object indicated by the passed DeviceHandle.
206 ******************************************************************************/
209 AcpiGetCurrentResources (
210 ACPI_HANDLE DeviceHandle,
211 ACPI_BUFFER *RetBuffer)
216 ACPI_FUNCTION_TRACE ("AcpiGetCurrentResources");
220 * Must have a valid handle and buffer, So we have to have a handle
221 * and a return buffer structure, and if there is a non-zero buffer length
222 * we also need a valid pointer in the buffer. If it's a zero buffer length,
223 * we'll be returning the needed buffer size, so keep going.
227 return_ACPI_STATUS (AE_BAD_PARAMETER);
230 Status = AcpiUtValidateBuffer (RetBuffer);
231 if (ACPI_FAILURE (Status))
233 return_ACPI_STATUS (Status);
236 Status = AcpiRsGetCrsMethodData (DeviceHandle, RetBuffer);
237 return_ACPI_STATUS (Status);
241 /*******************************************************************************
243 * FUNCTION: AcpiGetPossibleResources
245 * PARAMETERS: DeviceHandle - a handle to the device object for the
246 * device we are querying
247 * RetBuffer - a pointer to a buffer to receive the
248 * resources for the device
252 * DESCRIPTION: This function is called to get a list of the possible resources
253 * for a specific device. The caller must first acquire a handle
254 * for the desired device. The resource data is placed in the
255 * buffer pointed to by the RetBuffer variable.
257 * If the function fails an appropriate status will be returned
258 * and the value of RetBuffer is undefined.
260 ******************************************************************************/
263 AcpiGetPossibleResources (
264 ACPI_HANDLE DeviceHandle,
265 ACPI_BUFFER *RetBuffer)
270 ACPI_FUNCTION_TRACE ("AcpiGetPossibleResources");
274 * Must have a valid handle and buffer, So we have to have a handle
275 * and a return buffer structure, and if there is a non-zero buffer length
276 * we also need a valid pointer in the buffer. If it's a zero buffer length,
277 * we'll be returning the needed buffer size, so keep going.
281 return_ACPI_STATUS (AE_BAD_PARAMETER);
284 Status = AcpiUtValidateBuffer (RetBuffer);
285 if (ACPI_FAILURE (Status))
287 return_ACPI_STATUS (Status);
290 Status = AcpiRsGetPrsMethodData (DeviceHandle, RetBuffer);
291 return_ACPI_STATUS (Status);
295 /*******************************************************************************
297 * FUNCTION: AcpiWalkResources
299 * PARAMETERS: DeviceHandle - a handle to the device object for the
300 * device we are querying
301 * Path - method name of the resources we want
302 * (METHOD_NAME__CRS or METHOD_NAME__PRS)
303 * UserFunction - called for each resource
304 * Context - passed to UserFunction
308 * DESCRIPTION: Retrieves the current or possible resource list for the
309 * specified device. The UserFunction is called once for
310 * each resource in the list.
312 ******************************************************************************/
316 ACPI_HANDLE DeviceHandle,
318 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
322 ACPI_BUFFER Buffer = {ACPI_ALLOCATE_BUFFER, NULL};
323 ACPI_RESOURCE *Resource;
326 ACPI_FUNCTION_TRACE ("AcpiWalkResources");
330 (ACPI_STRNCMP (Path, METHOD_NAME__CRS, sizeof (METHOD_NAME__CRS)) &&
331 ACPI_STRNCMP (Path, METHOD_NAME__PRS, sizeof (METHOD_NAME__PRS))))
333 return_ACPI_STATUS (AE_BAD_PARAMETER);
336 Status = AcpiRsGetMethodData (DeviceHandle, Path, &Buffer);
337 if (ACPI_FAILURE (Status))
339 return_ACPI_STATUS (Status);
342 Resource = (ACPI_RESOURCE *) Buffer.Pointer;
345 if (!Resource || Resource->Id == ACPI_RSTYPE_END_TAG)
350 Status = UserFunction (Resource, Context);
357 /* Just keep going */
361 case AE_CTRL_TERMINATE:
363 /* Exit now, with OK stats */
370 /* All others are valid exceptions */
375 Resource = ACPI_NEXT_RESOURCE (Resource);
380 AcpiOsFree (Buffer.Pointer);
381 return_ACPI_STATUS (Status);
385 /*******************************************************************************
387 * FUNCTION: AcpiSetCurrentResources
389 * PARAMETERS: DeviceHandle - a handle to the device object for the
390 * device we are changing the resources of
391 * InBuffer - a pointer to a buffer containing the
392 * resources to be set for the device
396 * DESCRIPTION: This function is called to set the current resources for a
397 * specific device. The caller must first acquire a handle for
398 * the desired device. The resource data is passed to the routine
399 * the buffer pointed to by the InBuffer variable.
401 ******************************************************************************/
404 AcpiSetCurrentResources (
405 ACPI_HANDLE DeviceHandle,
406 ACPI_BUFFER *InBuffer)
411 ACPI_FUNCTION_TRACE ("AcpiSetCurrentResources");
415 * Must have a valid handle and buffer
417 if ((!DeviceHandle) ||
419 (!InBuffer->Pointer) ||
422 return_ACPI_STATUS (AE_BAD_PARAMETER);
425 Status = AcpiRsSetSrsMethodData (DeviceHandle, InBuffer);
426 return_ACPI_STATUS (Status);
431 #define COPY_FIELD(Out, In, Field) Out->Field = In->Field
432 #define COPY_ADDRESS(Out, In) \
433 COPY_FIELD(Out, In, ResourceType); \
434 COPY_FIELD(Out, In, ProducerConsumer); \
435 COPY_FIELD(Out, In, Decode); \
436 COPY_FIELD(Out, In, MinAddressFixed); \
437 COPY_FIELD(Out, In, MaxAddressFixed); \
438 COPY_FIELD(Out, In, Attribute); \
439 COPY_FIELD(Out, In, Granularity); \
440 COPY_FIELD(Out, In, MinAddressRange); \
441 COPY_FIELD(Out, In, MaxAddressRange); \
442 COPY_FIELD(Out, In, AddressTranslationOffset); \
443 COPY_FIELD(Out, In, AddressLength); \
444 COPY_FIELD(Out, In, ResourceSource);
446 /******************************************************************************
448 * FUNCTION: AcpiResourceToAddress64
450 * PARAMETERS: resource - Pointer to a resource
451 * out - Pointer to the users's return
453 * acpi_resource_address64)
457 * DESCRIPTION: If the resource is an address16, address32, or address64,
458 * copy it to the address64 return buffer. This saves the
459 * caller from having to duplicate code for different-sized
462 ******************************************************************************/
465 AcpiResourceToAddress64 (
466 ACPI_RESOURCE *Resource,
467 ACPI_RESOURCE_ADDRESS64 *Out)
469 ACPI_RESOURCE_ADDRESS16 *Address16;
470 ACPI_RESOURCE_ADDRESS32 *Address32;
471 ACPI_RESOURCE_ADDRESS64 *Address64;
474 switch (Resource->Id) {
475 case ACPI_RSTYPE_ADDRESS16:
476 Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data;
477 COPY_ADDRESS(Out, Address16);
480 case ACPI_RSTYPE_ADDRESS32:
481 Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data;
482 COPY_ADDRESS(Out, Address32);
485 case ACPI_RSTYPE_ADDRESS64:
486 Address64 = (ACPI_RESOURCE_ADDRESS64 *) &Resource->Data;
487 COPY_ADDRESS(Out, Address64);
491 return (AE_BAD_PARAMETER);