1 /*******************************************************************************
3 * Module Name: rsxface - Public interfaces to the resource manager
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2004, 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 *****************************************************************************/
118 #define __RSXFACE_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/acresrc.h>
123 #define _COMPONENT ACPI_RESOURCES
124 ACPI_MODULE_NAME ("rsxface")
127 /*******************************************************************************
129 * FUNCTION: AcpiGetIrqRoutingTable
131 * PARAMETERS: DeviceHandle - a handle to the Bus device we are querying
132 * RetBuffer - a pointer to a buffer to receive the
133 * current resources for the device
137 * DESCRIPTION: This function is called to get the IRQ routing table for a
138 * specific bus. The caller must first acquire a handle for the
139 * desired bus. The routine table is placed in the buffer pointed
140 * to by the RetBuffer variable parameter.
142 * If the function fails an appropriate status will be returned
143 * and the value of RetBuffer is undefined.
145 * This function attempts to execute the _PRT method contained in
146 * the object indicated by the passed DeviceHandle.
148 ******************************************************************************/
151 AcpiGetIrqRoutingTable (
152 ACPI_HANDLE DeviceHandle,
153 ACPI_BUFFER *RetBuffer)
158 ACPI_FUNCTION_TRACE ("AcpiGetIrqRoutingTable ");
162 * Must have a valid handle and buffer, So we have to have a handle
163 * and a return buffer structure, and if there is a non-zero buffer length
164 * we also need a valid pointer in the buffer. If it's a zero buffer length,
165 * we'll be returning the needed buffer size, so keep going.
169 return_ACPI_STATUS (AE_BAD_PARAMETER);
172 Status = AcpiUtValidateBuffer (RetBuffer);
173 if (ACPI_FAILURE (Status))
175 return_ACPI_STATUS (Status);
178 Status = AcpiRsGetPrtMethodData (DeviceHandle, RetBuffer);
179 return_ACPI_STATUS (Status);
183 /*******************************************************************************
185 * FUNCTION: AcpiGetCurrentResources
187 * PARAMETERS: DeviceHandle - a handle to the device object for the
188 * device we are querying
189 * RetBuffer - a pointer to a buffer to receive the
190 * current resources for the device
194 * DESCRIPTION: This function is called to get the current resources for a
195 * specific device. The caller must first acquire a handle for
196 * the desired device. The resource data is placed in the buffer
197 * pointed to by the RetBuffer variable parameter.
199 * If the function fails an appropriate status will be returned
200 * and the value of RetBuffer is undefined.
202 * This function attempts to execute the _CRS method contained in
203 * the object indicated by the passed DeviceHandle.
205 ******************************************************************************/
208 AcpiGetCurrentResources (
209 ACPI_HANDLE DeviceHandle,
210 ACPI_BUFFER *RetBuffer)
215 ACPI_FUNCTION_TRACE ("AcpiGetCurrentResources");
219 * Must have a valid handle and buffer, So we have to have a handle
220 * and a return buffer structure, and if there is a non-zero buffer length
221 * we also need a valid pointer in the buffer. If it's a zero buffer length,
222 * we'll be returning the needed buffer size, so keep going.
226 return_ACPI_STATUS (AE_BAD_PARAMETER);
229 Status = AcpiUtValidateBuffer (RetBuffer);
230 if (ACPI_FAILURE (Status))
232 return_ACPI_STATUS (Status);
235 Status = AcpiRsGetCrsMethodData (DeviceHandle, RetBuffer);
236 return_ACPI_STATUS (Status);
240 /*******************************************************************************
242 * FUNCTION: AcpiGetPossibleResources
244 * PARAMETERS: DeviceHandle - a handle to the device object for the
245 * device we are querying
246 * RetBuffer - a pointer to a buffer to receive the
247 * resources for the device
251 * DESCRIPTION: This function is called to get a list of the possible resources
252 * for a specific device. The caller must first acquire a handle
253 * for the desired device. The resource data is placed in the
254 * buffer pointed to by the RetBuffer variable.
256 * If the function fails an appropriate status will be returned
257 * and the value of RetBuffer is undefined.
259 ******************************************************************************/
262 AcpiGetPossibleResources (
263 ACPI_HANDLE DeviceHandle,
264 ACPI_BUFFER *RetBuffer)
269 ACPI_FUNCTION_TRACE ("AcpiGetPossibleResources");
273 * Must have a valid handle and buffer, So we have to have a handle
274 * and a return buffer structure, and if there is a non-zero buffer length
275 * we also need a valid pointer in the buffer. If it's a zero buffer length,
276 * we'll be returning the needed buffer size, so keep going.
280 return_ACPI_STATUS (AE_BAD_PARAMETER);
283 Status = AcpiUtValidateBuffer (RetBuffer);
284 if (ACPI_FAILURE (Status))
286 return_ACPI_STATUS (Status);
289 Status = AcpiRsGetPrsMethodData (DeviceHandle, RetBuffer);
290 return_ACPI_STATUS (Status);
294 /*******************************************************************************
296 * FUNCTION: AcpiWalkResources
298 * PARAMETERS: DeviceHandle - a handle to the device object for the
299 * device we are querying
300 * Path - method name of the resources we want
301 * (METHOD_NAME__CRS or METHOD_NAME__PRS)
302 * UserFunction - called for each resource
303 * Context - passed to UserFunction
307 * DESCRIPTION: Retrieves the current or possible resource list for the
308 * specified device. The UserFunction is called once for
309 * each resource in the list.
311 ******************************************************************************/
315 ACPI_HANDLE DeviceHandle,
317 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
321 ACPI_BUFFER Buffer = {ACPI_ALLOCATE_BUFFER, NULL};
322 ACPI_RESOURCE *Resource;
323 ACPI_RESOURCE *BufferEnd;
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);
344 Resource = (ACPI_RESOURCE *) Buffer.Pointer;
345 BufferEnd = ACPI_CAST_PTR (ACPI_RESOURCE,
346 ((UINT8 *) Buffer.Pointer + Buffer.Length));
348 /* Walk the resource list */
352 if (!Resource || Resource->Id == ACPI_RSTYPE_END_TAG)
357 Status = UserFunction (Resource, Context);
364 /* Just keep going */
369 case AE_CTRL_TERMINATE:
371 /* Exit now, with OK stats */
378 /* All others are valid exceptions */
383 /* Get the next resource descriptor */
385 Resource = ACPI_NEXT_RESOURCE (Resource);
387 /* Check for end-of-buffer */
389 if (Resource >= BufferEnd)
397 AcpiOsFree (Buffer.Pointer);
398 return_ACPI_STATUS (Status);
402 /*******************************************************************************
404 * FUNCTION: AcpiSetCurrentResources
406 * PARAMETERS: DeviceHandle - a handle to the device object for the
407 * device we are changing the resources of
408 * InBuffer - a pointer to a buffer containing the
409 * resources to be set for the device
413 * DESCRIPTION: This function is called to set the current resources for a
414 * specific device. The caller must first acquire a handle for
415 * the desired device. The resource data is passed to the routine
416 * the buffer pointed to by the InBuffer variable.
418 ******************************************************************************/
421 AcpiSetCurrentResources (
422 ACPI_HANDLE DeviceHandle,
423 ACPI_BUFFER *InBuffer)
428 ACPI_FUNCTION_TRACE ("AcpiSetCurrentResources");
432 * Must have a valid handle and buffer
434 if ((!DeviceHandle) ||
436 (!InBuffer->Pointer) ||
439 return_ACPI_STATUS (AE_BAD_PARAMETER);
442 Status = AcpiRsSetSrsMethodData (DeviceHandle, InBuffer);
443 return_ACPI_STATUS (Status);
447 #define ACPI_COPY_FIELD(Out, In, Field) ((Out)->Field = (In)->Field)
448 #define ACPI_COPY_ADDRESS(Out, In) \
449 ACPI_COPY_FIELD(Out, In, ResourceType); \
450 ACPI_COPY_FIELD(Out, In, ProducerConsumer); \
451 ACPI_COPY_FIELD(Out, In, Decode); \
452 ACPI_COPY_FIELD(Out, In, MinAddressFixed); \
453 ACPI_COPY_FIELD(Out, In, MaxAddressFixed); \
454 ACPI_COPY_FIELD(Out, In, Attribute); \
455 ACPI_COPY_FIELD(Out, In, Granularity); \
456 ACPI_COPY_FIELD(Out, In, MinAddressRange); \
457 ACPI_COPY_FIELD(Out, In, MaxAddressRange); \
458 ACPI_COPY_FIELD(Out, In, AddressTranslationOffset); \
459 ACPI_COPY_FIELD(Out, In, AddressLength); \
460 ACPI_COPY_FIELD(Out, In, ResourceSource);
462 /******************************************************************************
464 * FUNCTION: AcpiResourceToAddress64
466 * PARAMETERS: resource - Pointer to a resource
467 * out - Pointer to the users's return
469 * acpi_resource_address64)
473 * DESCRIPTION: If the resource is an address16, address32, or address64,
474 * copy it to the address64 return buffer. This saves the
475 * caller from having to duplicate code for different-sized
478 ******************************************************************************/
481 AcpiResourceToAddress64 (
482 ACPI_RESOURCE *Resource,
483 ACPI_RESOURCE_ADDRESS64 *Out)
485 ACPI_RESOURCE_ADDRESS16 *Address16;
486 ACPI_RESOURCE_ADDRESS32 *Address32;
489 switch (Resource->Id) {
490 case ACPI_RSTYPE_ADDRESS16:
492 Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data;
493 ACPI_COPY_ADDRESS(Out, Address16);
497 case ACPI_RSTYPE_ADDRESS32:
499 Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data;
500 ACPI_COPY_ADDRESS(Out, Address32);
504 case ACPI_RSTYPE_ADDRESS64:
506 /* Simple copy for 64 bit source */
508 ACPI_MEMCPY (Out, &Resource->Data, sizeof (ACPI_RESOURCE_ADDRESS64));
513 return (AE_BAD_PARAMETER);