1 /*******************************************************************************
3 * Module Name: rsxface - Public interfaces to the resource manager
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2007, 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>
122 #include <contrib/dev/acpica/acnamesp.h>
124 #define _COMPONENT ACPI_RESOURCES
125 ACPI_MODULE_NAME ("rsxface")
127 /* Local macros for 16,32-bit to 64-bit conversion */
129 #define ACPI_COPY_FIELD(Out, In, Field) ((Out)->Field = (In)->Field)
130 #define ACPI_COPY_ADDRESS(Out, In) \
131 ACPI_COPY_FIELD(Out, In, ResourceType); \
132 ACPI_COPY_FIELD(Out, In, ProducerConsumer); \
133 ACPI_COPY_FIELD(Out, In, Decode); \
134 ACPI_COPY_FIELD(Out, In, MinAddressFixed); \
135 ACPI_COPY_FIELD(Out, In, MaxAddressFixed); \
136 ACPI_COPY_FIELD(Out, In, Info); \
137 ACPI_COPY_FIELD(Out, In, Granularity); \
138 ACPI_COPY_FIELD(Out, In, Minimum); \
139 ACPI_COPY_FIELD(Out, In, Maximum); \
140 ACPI_COPY_FIELD(Out, In, TranslationOffset); \
141 ACPI_COPY_FIELD(Out, In, AddressLength); \
142 ACPI_COPY_FIELD(Out, In, ResourceSource);
145 /* Local prototypes */
148 AcpiRsMatchVendorResource (
149 ACPI_RESOURCE *Resource,
153 AcpiRsValidateParameters (
154 ACPI_HANDLE DeviceHandle,
156 ACPI_NAMESPACE_NODE **ReturnNode);
159 /*******************************************************************************
161 * FUNCTION: AcpiRsValidateParameters
163 * PARAMETERS: DeviceHandle - Handle to a device
164 * Buffer - Pointer to a data buffer
165 * ReturnNode - Pointer to where the device node is returned
169 * DESCRIPTION: Common parameter validation for resource interfaces
171 ******************************************************************************/
174 AcpiRsValidateParameters (
175 ACPI_HANDLE DeviceHandle,
177 ACPI_NAMESPACE_NODE **ReturnNode)
180 ACPI_NAMESPACE_NODE *Node;
183 ACPI_FUNCTION_TRACE (RsValidateParameters);
187 * Must have a valid handle to an ACPI device
191 return_ACPI_STATUS (AE_BAD_PARAMETER);
194 Node = AcpiNsMapHandleToNode (DeviceHandle);
197 return_ACPI_STATUS (AE_BAD_PARAMETER);
200 if (Node->Type != ACPI_TYPE_DEVICE)
202 return_ACPI_STATUS (AE_TYPE);
206 * Validate the user buffer object
208 * if there is a non-zero buffer length we also need a valid pointer in
209 * the buffer. If it's a zero buffer length, we'll be returning the
210 * needed buffer size (later), so keep going.
212 Status = AcpiUtValidateBuffer (Buffer);
213 if (ACPI_FAILURE (Status))
215 return_ACPI_STATUS (Status);
219 return_ACPI_STATUS (AE_OK);
223 /*******************************************************************************
225 * FUNCTION: AcpiGetIrqRoutingTable
227 * PARAMETERS: DeviceHandle - Handle to the Bus device we are querying
228 * RetBuffer - Pointer to a buffer to receive the
229 * current resources for the device
233 * DESCRIPTION: This function is called to get the IRQ routing table for a
234 * specific bus. The caller must first acquire a handle for the
235 * desired bus. The routine table is placed in the buffer pointed
236 * to by the RetBuffer variable parameter.
238 * If the function fails an appropriate status will be returned
239 * and the value of RetBuffer is undefined.
241 * This function attempts to execute the _PRT method contained in
242 * the object indicated by the passed DeviceHandle.
244 ******************************************************************************/
247 AcpiGetIrqRoutingTable (
248 ACPI_HANDLE DeviceHandle,
249 ACPI_BUFFER *RetBuffer)
252 ACPI_NAMESPACE_NODE *Node;
255 ACPI_FUNCTION_TRACE (AcpiGetIrqRoutingTable);
258 /* Validate parameters then dispatch to internal routine */
260 Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);
261 if (ACPI_FAILURE (Status))
263 return_ACPI_STATUS (Status);
266 Status = AcpiRsGetPrtMethodData (Node, RetBuffer);
267 return_ACPI_STATUS (Status);
270 ACPI_EXPORT_SYMBOL (AcpiGetIrqRoutingTable)
273 /*******************************************************************************
275 * FUNCTION: AcpiGetCurrentResources
277 * PARAMETERS: DeviceHandle - Handle to the device object for the
278 * device we are querying
279 * RetBuffer - Pointer to a buffer to receive the
280 * current resources for the device
284 * DESCRIPTION: This function is called to get the current resources for a
285 * specific device. The caller must first acquire a handle for
286 * the desired device. The resource data is placed in the buffer
287 * pointed to by the RetBuffer variable parameter.
289 * If the function fails an appropriate status will be returned
290 * and the value of RetBuffer is undefined.
292 * This function attempts to execute the _CRS method contained in
293 * the object indicated by the passed DeviceHandle.
295 ******************************************************************************/
298 AcpiGetCurrentResources (
299 ACPI_HANDLE DeviceHandle,
300 ACPI_BUFFER *RetBuffer)
303 ACPI_NAMESPACE_NODE *Node;
306 ACPI_FUNCTION_TRACE (AcpiGetCurrentResources);
309 /* Validate parameters then dispatch to internal routine */
311 Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);
312 if (ACPI_FAILURE (Status))
314 return_ACPI_STATUS (Status);
317 Status = AcpiRsGetCrsMethodData (Node, RetBuffer);
318 return_ACPI_STATUS (Status);
321 ACPI_EXPORT_SYMBOL (AcpiGetCurrentResources)
324 /*******************************************************************************
326 * FUNCTION: AcpiGetPossibleResources
328 * PARAMETERS: DeviceHandle - Handle to the device object for the
329 * device we are querying
330 * RetBuffer - Pointer to a buffer to receive the
331 * resources for the device
335 * DESCRIPTION: This function is called to get a list of the possible resources
336 * for a specific device. The caller must first acquire a handle
337 * for the desired device. The resource data is placed in the
338 * buffer pointed to by the RetBuffer variable.
340 * If the function fails an appropriate status will be returned
341 * and the value of RetBuffer is undefined.
343 ******************************************************************************/
346 AcpiGetPossibleResources (
347 ACPI_HANDLE DeviceHandle,
348 ACPI_BUFFER *RetBuffer)
351 ACPI_NAMESPACE_NODE *Node;
354 ACPI_FUNCTION_TRACE (AcpiGetPossibleResources);
357 /* Validate parameters then dispatch to internal routine */
359 Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);
360 if (ACPI_FAILURE (Status))
362 return_ACPI_STATUS (Status);
365 Status = AcpiRsGetPrsMethodData (Node, RetBuffer);
366 return_ACPI_STATUS (Status);
369 ACPI_EXPORT_SYMBOL (AcpiGetPossibleResources)
372 /*******************************************************************************
374 * FUNCTION: AcpiSetCurrentResources
376 * PARAMETERS: DeviceHandle - Handle to the device object for the
377 * device we are setting resources
378 * InBuffer - Pointer to a buffer containing the
379 * resources to be set for the device
383 * DESCRIPTION: This function is called to set the current resources for a
384 * specific device. The caller must first acquire a handle for
385 * the desired device. The resource data is passed to the routine
386 * the buffer pointed to by the InBuffer variable.
388 ******************************************************************************/
391 AcpiSetCurrentResources (
392 ACPI_HANDLE DeviceHandle,
393 ACPI_BUFFER *InBuffer)
396 ACPI_NAMESPACE_NODE *Node;
399 ACPI_FUNCTION_TRACE (AcpiSetCurrentResources);
402 /* Validate the buffer, don't allow zero length */
405 (!InBuffer->Pointer) ||
408 return_ACPI_STATUS (AE_BAD_PARAMETER);
411 /* Validate parameters then dispatch to internal routine */
413 Status = AcpiRsValidateParameters (DeviceHandle, InBuffer, &Node);
414 if (ACPI_FAILURE (Status))
416 return_ACPI_STATUS (Status);
419 Status = AcpiRsSetSrsMethodData (Node, InBuffer);
420 return_ACPI_STATUS (Status);
423 ACPI_EXPORT_SYMBOL (AcpiSetCurrentResources)
426 /******************************************************************************
428 * FUNCTION: AcpiResourceToAddress64
430 * PARAMETERS: Resource - Pointer to a resource
431 * Out - Pointer to the users's return buffer
432 * (a struct acpi_resource_address64)
436 * DESCRIPTION: If the resource is an address16, address32, or address64,
437 * copy it to the address64 return buffer. This saves the
438 * caller from having to duplicate code for different-sized
441 ******************************************************************************/
444 AcpiResourceToAddress64 (
445 ACPI_RESOURCE *Resource,
446 ACPI_RESOURCE_ADDRESS64 *Out)
448 ACPI_RESOURCE_ADDRESS16 *Address16;
449 ACPI_RESOURCE_ADDRESS32 *Address32;
452 if (!Resource || !Out)
454 return (AE_BAD_PARAMETER);
457 /* Convert 16 or 32 address descriptor to 64 */
459 switch (Resource->Type)
461 case ACPI_RESOURCE_TYPE_ADDRESS16:
463 Address16 = (ACPI_RESOURCE_ADDRESS16 *) &Resource->Data;
464 ACPI_COPY_ADDRESS (Out, Address16);
467 case ACPI_RESOURCE_TYPE_ADDRESS32:
469 Address32 = (ACPI_RESOURCE_ADDRESS32 *) &Resource->Data;
470 ACPI_COPY_ADDRESS (Out, Address32);
473 case ACPI_RESOURCE_TYPE_ADDRESS64:
475 /* Simple copy for 64 bit source */
477 ACPI_MEMCPY (Out, &Resource->Data, sizeof (ACPI_RESOURCE_ADDRESS64));
481 return (AE_BAD_PARAMETER);
487 ACPI_EXPORT_SYMBOL (AcpiResourceToAddress64)
490 /*******************************************************************************
492 * FUNCTION: AcpiGetVendorResource
494 * PARAMETERS: DeviceHandle - Handle for the parent device object
495 * Name - Method name for the parent resource
496 * (METHOD_NAME__CRS or METHOD_NAME__PRS)
497 * Uuid - Pointer to the UUID to be matched.
498 * includes both subtype and 16-byte UUID
499 * RetBuffer - Where the vendor resource is returned
503 * DESCRIPTION: Walk a resource template for the specified evice to find a
504 * vendor-defined resource that matches the supplied UUID and
505 * UUID subtype. Returns a ACPI_RESOURCE of type Vendor.
507 ******************************************************************************/
510 AcpiGetVendorResource (
511 ACPI_HANDLE DeviceHandle,
513 ACPI_VENDOR_UUID *Uuid,
514 ACPI_BUFFER *RetBuffer)
516 ACPI_VENDOR_WALK_INFO Info;
520 /* Other parameters are validated by AcpiWalkResources */
522 if (!Uuid || !RetBuffer)
524 return (AE_BAD_PARAMETER);
528 Info.Buffer = RetBuffer;
529 Info.Status = AE_NOT_EXIST;
531 /* Walk the _CRS or _PRS resource list for this device */
533 Status = AcpiWalkResources (DeviceHandle, Name, AcpiRsMatchVendorResource,
535 if (ACPI_FAILURE (Status))
540 return (Info.Status);
543 ACPI_EXPORT_SYMBOL (AcpiGetVendorResource)
546 /*******************************************************************************
548 * FUNCTION: AcpiRsMatchVendorResource
550 * PARAMETERS: ACPI_WALK_RESOURCE_CALLBACK
554 * DESCRIPTION: Match a vendor resource via the ACPI 3.0 UUID
556 ******************************************************************************/
559 AcpiRsMatchVendorResource (
560 ACPI_RESOURCE *Resource,
563 ACPI_VENDOR_WALK_INFO *Info = Context;
564 ACPI_RESOURCE_VENDOR_TYPED *Vendor;
569 /* Ignore all descriptors except Vendor */
571 if (Resource->Type != ACPI_RESOURCE_TYPE_VENDOR)
576 Vendor = &Resource->Data.VendorTyped;
579 * For a valid match, these conditions must hold:
581 * 1) Length of descriptor data must be at least as long as a UUID struct
582 * 2) The UUID subtypes must match
583 * 3) The UUID data must match
585 if ((Vendor->ByteLength < (ACPI_UUID_LENGTH + 1)) ||
586 (Vendor->UuidSubtype != Info->Uuid->Subtype) ||
587 (ACPI_MEMCMP (Vendor->Uuid, Info->Uuid->Data, ACPI_UUID_LENGTH)))
592 /* Validate/Allocate/Clear caller buffer */
594 Buffer = Info->Buffer;
595 Status = AcpiUtInitializeBuffer (Buffer, Resource->Length);
596 if (ACPI_FAILURE (Status))
601 /* Found the correct resource, copy and return it */
603 ACPI_MEMCPY (Buffer->Pointer, Resource, Resource->Length);
604 Buffer->Length = Resource->Length;
606 /* Found the desired descriptor, terminate resource walk */
608 Info->Status = AE_OK;
609 return (AE_CTRL_TERMINATE);
613 /*******************************************************************************
615 * FUNCTION: AcpiWalkResources
617 * PARAMETERS: DeviceHandle - Handle to the device object for the
618 * device we are querying
619 * Name - Method name of the resources we want
620 * (METHOD_NAME__CRS or METHOD_NAME__PRS)
621 * UserFunction - Called for each resource
622 * Context - Passed to UserFunction
626 * DESCRIPTION: Retrieves the current or possible resource list for the
627 * specified device. The UserFunction is called once for
628 * each resource in the list.
630 ******************************************************************************/
634 ACPI_HANDLE DeviceHandle,
636 ACPI_WALK_RESOURCE_CALLBACK UserFunction,
641 ACPI_RESOURCE *Resource;
642 ACPI_RESOURCE *ResourceEnd;
645 ACPI_FUNCTION_TRACE (AcpiWalkResources);
648 /* Parameter validation */
650 if (!DeviceHandle || !UserFunction || !Name ||
651 (!ACPI_COMPARE_NAME (Name, METHOD_NAME__CRS) &&
652 !ACPI_COMPARE_NAME (Name, METHOD_NAME__PRS)))
654 return_ACPI_STATUS (AE_BAD_PARAMETER);
657 /* Get the _CRS or _PRS resource list */
659 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
660 Status = AcpiRsGetMethodData (DeviceHandle, Name, &Buffer);
661 if (ACPI_FAILURE (Status))
663 return_ACPI_STATUS (Status);
666 /* Buffer now contains the resource list */
668 Resource = ACPI_CAST_PTR (ACPI_RESOURCE, Buffer.Pointer);
669 ResourceEnd = ACPI_ADD_PTR (ACPI_RESOURCE, Buffer.Pointer, Buffer.Length);
671 /* Walk the resource list until the EndTag is found (or buffer end) */
673 while (Resource < ResourceEnd)
675 /* Sanity check the resource */
677 if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
679 Status = AE_AML_INVALID_RESOURCE_TYPE;
683 /* Invoke the user function, abort on any error returned */
685 Status = UserFunction (Resource, Context);
686 if (ACPI_FAILURE (Status))
688 if (Status == AE_CTRL_TERMINATE)
690 /* This is an OK termination by the user function */
697 /* EndTag indicates end-of-list */
699 if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)
704 /* Get the next resource descriptor */
706 Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
709 ACPI_FREE (Buffer.Pointer);
710 return_ACPI_STATUS (Status);
713 ACPI_EXPORT_SYMBOL (AcpiWalkResources)