Subversion Repositories Kolibri OS

/*******************************************************************************

 *

 * Module Name: rsxface - Public interfaces to the resource manager

 *

 ******************************************************************************/

/******************************************************************************

 *

 * 1. Copyright Notice

 *

 * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.

 * All rights reserved.

 *

 * 2. License

 *

 * 2.1. This is your license from Intel Corp. under its intellectual property

 * rights.  You may have additional license terms from the party that provided

 * you this software, covering your right to use that party's intellectual

 * property rights.

 *

 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a

 * copy of the source code appearing in this file ("Covered Code") an

 * irrevocable, perpetual, worldwide license under Intel's copyrights in the

 * base code distributed originally by Intel ("Original Intel Code") to copy,

 * make derivatives, distribute, use and display any portion of the Covered

 * Code in any form, with the right to sublicense such rights; and

 *

 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent

 * license (with the right to sublicense), under only those claims of Intel

 * patents that are infringed by the Original Intel Code, to make, use, sell,

 * offer to sell, and import the Covered Code and derivative works thereof

 * solely to the minimum extent necessary to exercise the above copyright

 * license, and in no event shall the patent license extend to any additions

 * to or modifications of the Original Intel Code.  No other license or right

 * is granted directly or by implication, estoppel or otherwise;

 *

 * The above copyright and patent license is granted only if the following

 * conditions are met:

 *

 * 3. Conditions

 *

 * 3.1. Redistribution of Source with Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification with rights to further distribute source must include

 * the above Copyright Notice, the above License, this list of Conditions,

 * and the following Disclaimer and Export Compliance provision.  In addition,

 * Licensee must cause all Covered Code to which Licensee contributes to

 * contain a file documenting the changes Licensee made to create that Covered

 * Code and the date of any change.  Licensee must include in that file the

 * documentation of any changes made by any predecessor Licensee.  Licensee

 * must include a prominent statement that the modification is derived,

 * directly or indirectly, from Original Intel Code.

 *

 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.

 * Redistribution of source code of any substantial portion of the Covered

 * Code or modification without rights to further distribute source must

 * include the following Disclaimer and Export Compliance provision in the

 * documentation and/or other materials provided with distribution.  In

 * addition, Licensee may not authorize further sublicense of source of any

 * portion of the Covered Code, and must include terms to the effect that the

 * license from Licensee to its licensee is limited to the intellectual

 * property embodied in the software Licensee provides to its licensee, and

 * not to intellectual property embodied in modifications its licensee may

 * make.

 *

 * 3.3. Redistribution of Executable. Redistribution in executable form of any

 * substantial portion of the Covered Code or modification must reproduce the

 * above Copyright Notice, and the following Disclaimer and Export Compliance

 * provision in the documentation and/or other materials provided with the

 * distribution.

 *

 * 3.4. Intel retains all right, title, and interest in and to the Original

 * Intel Code.

 *

 * 3.5. Neither the name Intel nor any other trademark owned or controlled by

 * Intel shall be used in advertising or otherwise to promote the sale, use or

 * other dealings in products derived from or relating to the Covered Code

 * without prior written authorization from Intel.

 *

 * 4. Disclaimer and Export Compliance

 *

 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED

 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE

 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,

 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY

 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY

 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A

 * PARTICULAR PURPOSE.

 *

 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES

 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR

 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,

 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY

 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL

 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS

 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY

 * LIMITED REMEDY.

 *

 * 4.3. Licensee shall not export, either directly or indirectly, any of this

 * software or system incorporating such software without first obtaining any

 * required license or other approval from the U. S. Department of Commerce or

 * any other agency or department of the United States Government.  In the

 * event Licensee exports any such software from the United States or

 * re-exports any such software from a foreign destination, Licensee shall

 * ensure that the distribution and export/re-export of the software is in

 * compliance with all laws, regulations, orders, or other restrictions of the

 * U.S. Export Administration Regulations. Licensee agrees that neither it nor

 * any of its subsidiaries will export/re-export any technical data, process,

 * software, or service, directly or indirectly, to any country for which the

 * United States government or any agency thereof requires an export license,

 * other governmental approval, or letter of assurance, without first obtaining

 * such license, approval or letter.

 *

 *****************************************************************************/

#define __RSXFACE_C__

#include "acpi.h"

#include "accommon.h"

#include "acresrc.h"

#include "acnamesp.h"

#define _COMPONENT          ACPI_RESOURCES

        ACPI_MODULE_NAME    ("rsxface")

/* Local macros for 16,32-bit to 64-bit conversion */

#define ACPI_COPY_FIELD(Out, In, Field)  ((Out)->Field = (In)->Field)

#define ACPI_COPY_ADDRESS(Out, In)                      \

    ACPI_COPY_FIELD(Out, In, ResourceType);              \

    ACPI_COPY_FIELD(Out, In, ProducerConsumer);          \

    ACPI_COPY_FIELD(Out, In, Decode);                    \

    ACPI_COPY_FIELD(Out, In, MinAddressFixed);           \

    ACPI_COPY_FIELD(Out, In, MaxAddressFixed);           \

    ACPI_COPY_FIELD(Out, In, Info);                      \

    ACPI_COPY_FIELD(Out, In, Granularity);               \

    ACPI_COPY_FIELD(Out, In, Minimum);                   \

    ACPI_COPY_FIELD(Out, In, Maximum);                   \

    ACPI_COPY_FIELD(Out, In, TranslationOffset);         \

    ACPI_COPY_FIELD(Out, In, AddressLength);             \

    ACPI_COPY_FIELD(Out, In, ResourceSource);

/* Local prototypes */

static ACPI_STATUS

AcpiRsMatchVendorResource (

    ACPI_RESOURCE           *Resource,

    void                    *Context);

static ACPI_STATUS

AcpiRsValidateParameters (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *Buffer,

    ACPI_NAMESPACE_NODE     **ReturnNode);

/*******************************************************************************

 *

 * FUNCTION:    AcpiRsValidateParameters

 *

 * PARAMETERS:  DeviceHandle    - Handle to a device

 *              Buffer          - Pointer to a data buffer

 *              ReturnNode      - Pointer to where the device node is returned

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Common parameter validation for resource interfaces

 *

 ******************************************************************************/

static ACPI_STATUS

AcpiRsValidateParameters (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *Buffer,

    ACPI_NAMESPACE_NODE     **ReturnNode)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node;

    ACPI_FUNCTION_TRACE (RsValidateParameters);

    /*

     * Must have a valid handle to an ACPI device

     */

    if (!DeviceHandle)

    {

        return_ACPI_STATUS (AE_BAD_PARAMETER);

    }

    Node = AcpiNsValidateHandle (DeviceHandle);

    if (!Node)

    {

        return_ACPI_STATUS (AE_BAD_PARAMETER);

    }

    if (Node->Type != ACPI_TYPE_DEVICE)

    {

        return_ACPI_STATUS (AE_TYPE);

    }

    /*

     * Validate the user buffer object

     *

     * if there is a non-zero buffer length we also need a valid pointer in

     * the buffer. If it's a zero buffer length, we'll be returning the

     * needed buffer size (later), so keep going.

     */

    Status = AcpiUtValidateBuffer (Buffer);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    *ReturnNode = Node;

    return_ACPI_STATUS (AE_OK);

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiGetIrqRoutingTable

 *

 * PARAMETERS:  DeviceHandle    - Handle to the Bus device we are querying

 *              RetBuffer       - Pointer to a buffer to receive the

 *                                current resources for the device

 *

 * RETURN:      Status

 *

 * DESCRIPTION: This function is called to get the IRQ routing table for a

 *              specific bus. The caller must first acquire a handle for the

 *              desired bus. The routine table is placed in the buffer pointed

 *              to by the RetBuffer variable parameter.

 *

 *              If the function fails an appropriate status will be returned

 *              and the value of RetBuffer is undefined.

 *

 *              This function attempts to execute the _PRT method contained in

 *              the object indicated by the passed DeviceHandle.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiGetIrqRoutingTable  (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *RetBuffer)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node;

    ACPI_FUNCTION_TRACE (AcpiGetIrqRoutingTable);

    /* Validate parameters then dispatch to internal routine */

    Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    Status = AcpiRsGetPrtMethodData (Node, RetBuffer);

    return_ACPI_STATUS (Status);

}

ACPI_EXPORT_SYMBOL (AcpiGetIrqRoutingTable)

/*******************************************************************************

 *

 * FUNCTION:    AcpiGetCurrentResources

 *

 * PARAMETERS:  DeviceHandle    - Handle to the device object for the

 *                                device we are querying

 *              RetBuffer       - Pointer to a buffer to receive the

 *                                current resources for the device

 *

 * RETURN:      Status

 *

 * DESCRIPTION: This function is called to get the current resources for a

 *              specific device. The caller must first acquire a handle for

 *              the desired device. The resource data is placed in the buffer

 *              pointed to by the RetBuffer variable parameter.

 *

 *              If the function fails an appropriate status will be returned

 *              and the value of RetBuffer is undefined.

 *

 *              This function attempts to execute the _CRS method contained in

 *              the object indicated by the passed DeviceHandle.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiGetCurrentResources (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *RetBuffer)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node;

    ACPI_FUNCTION_TRACE (AcpiGetCurrentResources);

    /* Validate parameters then dispatch to internal routine */

    Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    Status = AcpiRsGetCrsMethodData (Node, RetBuffer);

    return_ACPI_STATUS (Status);

}

ACPI_EXPORT_SYMBOL (AcpiGetCurrentResources)

/*******************************************************************************

 *

 * FUNCTION:    AcpiGetPossibleResources

 *

 * PARAMETERS:  DeviceHandle    - Handle to the device object for the

 *                                device we are querying

 *              RetBuffer       - Pointer to a buffer to receive the

 *                                resources for the device

 *

 * RETURN:      Status

 *

 * DESCRIPTION: This function is called to get a list of the possible resources

 *              for a specific device. The caller must first acquire a handle

 *              for the desired device. The resource data is placed in the

 *              buffer pointed to by the RetBuffer variable.

 *

 *              If the function fails an appropriate status will be returned

 *              and the value of RetBuffer is undefined.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiGetPossibleResources (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *RetBuffer)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node;

    ACPI_FUNCTION_TRACE (AcpiGetPossibleResources);

    /* Validate parameters then dispatch to internal routine */

    Status = AcpiRsValidateParameters (DeviceHandle, RetBuffer, &Node);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    Status = AcpiRsGetPrsMethodData (Node, RetBuffer);

    return_ACPI_STATUS (Status);

}

ACPI_EXPORT_SYMBOL (AcpiGetPossibleResources)

/*******************************************************************************

 *

 * FUNCTION:    AcpiSetCurrentResources

 *

 * PARAMETERS:  DeviceHandle    - Handle to the device object for the

 *                                device we are setting resources

 *              InBuffer        - Pointer to a buffer containing the

 *                                resources to be set for the device

 *

 * RETURN:      Status

 *

 * DESCRIPTION: This function is called to set the current resources for a

 *              specific device. The caller must first acquire a handle for

 *              the desired device. The resource data is passed to the routine

 *              the buffer pointed to by the InBuffer variable.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiSetCurrentResources (

    ACPI_HANDLE             DeviceHandle,

    ACPI_BUFFER             *InBuffer)

{

    ACPI_STATUS             Status;

    ACPI_NAMESPACE_NODE     *Node;

    ACPI_FUNCTION_TRACE (AcpiSetCurrentResources);

    /* Validate the buffer, don't allow zero length */

    if ((!InBuffer) ||

        (!InBuffer->Pointer) ||

        (!InBuffer->Length))

    {

        return_ACPI_STATUS (AE_BAD_PARAMETER);

    }

    /* Validate parameters then dispatch to internal routine */

    Status = AcpiRsValidateParameters (DeviceHandle, InBuffer, &Node);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    Status = AcpiRsSetSrsMethodData (Node, InBuffer);

    return_ACPI_STATUS (Status);

}

ACPI_EXPORT_SYMBOL (AcpiSetCurrentResources)

/******************************************************************************

 *

 * FUNCTION:    AcpiResourceToAddress64

 *

 * PARAMETERS:  Resource        - Pointer to a resource

 *              Out             - Pointer to the users's return buffer

 *                                (a struct acpi_resource_address64)

 *

 * RETURN:      Status

 *

 * DESCRIPTION: If the resource is an address16, address32, or address64,

 *              copy it to the address64 return buffer. This saves the

 *              caller from having to duplicate code for different-sized

 *              addresses.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiResourceToAddress64 (

    ACPI_RESOURCE               *Resource,

    ACPI_RESOURCE_ADDRESS64     *Out)

{

    ACPI_RESOURCE_ADDRESS16     *Address16;

    ACPI_RESOURCE_ADDRESS32     *Address32;

    if (!Resource || !Out)

    {

        return (AE_BAD_PARAMETER);

    }

    /* Convert 16 or 32 address descriptor to 64 */

    switch (Resource->Type)

    {

    case ACPI_RESOURCE_TYPE_ADDRESS16:

        Address16 = ACPI_CAST_PTR (ACPI_RESOURCE_ADDRESS16, &Resource->Data);

        ACPI_COPY_ADDRESS (Out, Address16);

        break;

    case ACPI_RESOURCE_TYPE_ADDRESS32:

        Address32 = ACPI_CAST_PTR (ACPI_RESOURCE_ADDRESS32, &Resource->Data);

        ACPI_COPY_ADDRESS (Out, Address32);

        break;

    case ACPI_RESOURCE_TYPE_ADDRESS64:

        /* Simple copy for 64 bit source */

        ACPI_MEMCPY (Out, &Resource->Data, sizeof (ACPI_RESOURCE_ADDRESS64));

        break;

    default:

        return (AE_BAD_PARAMETER);

    }

    return (AE_OK);

}

ACPI_EXPORT_SYMBOL (AcpiResourceToAddress64)

/*******************************************************************************

 *

 * FUNCTION:    AcpiGetVendorResource

 *

 * PARAMETERS:  DeviceHandle    - Handle for the parent device object

 *              Name            - Method name for the parent resource

 *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)

 *              Uuid            - Pointer to the UUID to be matched.

 *                                includes both subtype and 16-byte UUID

 *              RetBuffer       - Where the vendor resource is returned

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Walk a resource template for the specified evice to find a

 *              vendor-defined resource that matches the supplied UUID and

 *              UUID subtype. Returns a ACPI_RESOURCE of type Vendor.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiGetVendorResource (

    ACPI_HANDLE             DeviceHandle,

    char                    *Name,

    ACPI_VENDOR_UUID        *Uuid,

    ACPI_BUFFER             *RetBuffer)

{

    ACPI_VENDOR_WALK_INFO   Info;

    ACPI_STATUS             Status;

    /* Other parameters are validated by AcpiWalkResources */

    if (!Uuid || !RetBuffer)

    {

        return (AE_BAD_PARAMETER);

    }

    Info.Uuid = Uuid;

    Info.Buffer = RetBuffer;

    Info.Status = AE_NOT_EXIST;

    /* Walk the _CRS or _PRS resource list for this device */

    Status = AcpiWalkResources (DeviceHandle, Name, AcpiRsMatchVendorResource,

                &Info);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    return (Info.Status);

}

ACPI_EXPORT_SYMBOL (AcpiGetVendorResource)

/*******************************************************************************

 *

 * FUNCTION:    AcpiRsMatchVendorResource

 *

 * PARAMETERS:  ACPI_WALK_RESOURCE_CALLBACK

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Match a vendor resource via the ACPI 3.0 UUID

 *

 ******************************************************************************/

static ACPI_STATUS

AcpiRsMatchVendorResource (

    ACPI_RESOURCE           *Resource,

    void                    *Context)

{

    ACPI_VENDOR_WALK_INFO       *Info = Context;

    ACPI_RESOURCE_VENDOR_TYPED  *Vendor;

    ACPI_BUFFER                 *Buffer;

    ACPI_STATUS                 Status;

    /* Ignore all descriptors except Vendor */

    if (Resource->Type != ACPI_RESOURCE_TYPE_VENDOR)

    {

        return (AE_OK);

    }

    Vendor = &Resource->Data.VendorTyped;

    /*

     * For a valid match, these conditions must hold:

     *

     * 1) Length of descriptor data must be at least as long as a UUID struct

     * 2) The UUID subtypes must match

     * 3) The UUID data must match

     */

    if ((Vendor->ByteLength < (ACPI_UUID_LENGTH + 1)) ||

        (Vendor->UuidSubtype != Info->Uuid->Subtype)  ||

        (ACPI_MEMCMP (Vendor->Uuid, Info->Uuid->Data, ACPI_UUID_LENGTH)))

    {

        return (AE_OK);

    }

    /* Validate/Allocate/Clear caller buffer */

    Buffer = Info->Buffer;

    Status = AcpiUtInitializeBuffer (Buffer, Resource->Length);

    if (ACPI_FAILURE (Status))

    {

        return (Status);

    }

    /* Found the correct resource, copy and return it */

    ACPI_MEMCPY (Buffer->Pointer, Resource, Resource->Length);

    Buffer->Length = Resource->Length;

    /* Found the desired descriptor, terminate resource walk */

    Info->Status = AE_OK;

    return (AE_CTRL_TERMINATE);

}

/*******************************************************************************

 *

 * FUNCTION:    AcpiWalkResources

 *

 * PARAMETERS:  DeviceHandle    - Handle to the device object for the

 *                                device we are querying

 *              Name            - Method name of the resources we want

 *                                (METHOD_NAME__CRS or METHOD_NAME__PRS)

 *              UserFunction    - Called for each resource

 *              Context         - Passed to UserFunction

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Retrieves the current or possible resource list for the

 *              specified device. The UserFunction is called once for

 *              each resource in the list.

 *

 ******************************************************************************/

ACPI_STATUS

AcpiWalkResources (

    ACPI_HANDLE                 DeviceHandle,

    char                        *Name,

    ACPI_WALK_RESOURCE_CALLBACK UserFunction,

    void                        *Context)

{

    ACPI_STATUS                 Status;

    ACPI_BUFFER                 Buffer;

    ACPI_RESOURCE               *Resource;

    ACPI_RESOURCE               *ResourceEnd;

    ACPI_FUNCTION_TRACE (AcpiWalkResources);

    /* Parameter validation */

    if (!DeviceHandle || !UserFunction || !Name ||

        (!ACPI_COMPARE_NAME (Name, METHOD_NAME__CRS) &&

         !ACPI_COMPARE_NAME (Name, METHOD_NAME__PRS)))

    {

        return_ACPI_STATUS (AE_BAD_PARAMETER);

    }

    /* Get the _CRS or _PRS resource list */

    Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;

    Status = AcpiRsGetMethodData (DeviceHandle, Name, &Buffer);

    if (ACPI_FAILURE (Status))

    {

        return_ACPI_STATUS (Status);

    }

    /* Buffer now contains the resource list */

    Resource = ACPI_CAST_PTR (ACPI_RESOURCE, Buffer.Pointer);

    ResourceEnd = ACPI_ADD_PTR (ACPI_RESOURCE, Buffer.Pointer, Buffer.Length);

    /* Walk the resource list until the EndTag is found (or buffer end) */

    while (Resource < ResourceEnd)

    {

        /* Sanity check the resource */

        if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)

        {

            Status = AE_AML_INVALID_RESOURCE_TYPE;

            break;

        }

        /* Invoke the user function, abort on any error returned */

        Status = UserFunction (Resource, Context);

        if (ACPI_FAILURE (Status))

        {

            if (Status == AE_CTRL_TERMINATE)

            {

                /* This is an OK termination by the user function */

                Status = AE_OK;

            }

            break;

        }

        /* EndTag indicates end-of-list */

        if (Resource->Type == ACPI_RESOURCE_TYPE_END_TAG)

        {

            break;

        }

        /* Get the next resource descriptor */

        Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);

    }

    ACPI_FREE (Buffer.Pointer);

    return_ACPI_STATUS (Status);

}

ACPI_EXPORT_SYMBOL (AcpiWalkResources)