/*******************************************************************************
*
* Module Name: rsutils - Utilities for the resource manager
*
******************************************************************************/
/*
* Copyright (C) 2000 - 2016, Intel Corp.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce at minimum a disclaimer
* substantially similar to the "NO WARRANTY" disclaimer below
* ("Disclaimer") and any redistribution must be conditioned upon
* including a substantially similar Disclaimer requirement for further
* binary redistribution.
* 3. Neither the names of the above-listed copyright holders nor the names
* of any contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* Alternatively, this software may be distributed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*
* NO WARRANTY
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGES.
*/
#include "acpi.h"
#include "accommon.h"
#include "acnamesp.h"
#include "acresrc.h"
ACPI_MODULE_NAME ("rsutils")
/*******************************************************************************
*
* FUNCTION: AcpiRsDecodeBitmask
*
* PARAMETERS: Mask - Bitmask to decode
* List - Where the converted list is returned
*
* RETURN: Count of bits set (length of list)
*
* DESCRIPTION: Convert a bit mask into a list of values
*
******************************************************************************/
{
UINT8 i;
/* Decode the mask bits */
{
if (Mask & 0x0001)
{
BitCount++;
}
Mask >>= 1;
}
return (BitCount);
}
/*******************************************************************************
*
* FUNCTION: AcpiRsEncodeBitmask
*
* PARAMETERS: List - List of values to encode
* Count - Length of list
*
* RETURN: Encoded bitmask
*
* DESCRIPTION: Convert a list of values to an encoded bitmask
*
******************************************************************************/
{
UINT32 i;
/* Encode the list into a single bitmask */
{
}
return (Mask);
}
/*******************************************************************************
*
* FUNCTION: AcpiRsMoveData
*
* PARAMETERS: Destination - Pointer to the destination descriptor
* Source - Pointer to the source descriptor
* ItemCount - How many items to move
* MoveType - Byte width
*
* RETURN: None
*
* DESCRIPTION: Move multiple data items from one descriptor to another. Handles
* alignment issues and endian issues if necessary, as configured
* via the ACPI_MOVE_* macros. (This is why a memcpy is not used)
*
******************************************************************************/
void
void *Destination,
void *Source,
{
UINT32 i;
/* One move per item */
for (i = 0; i < ItemCount; i++)
{
switch (MoveType)
{
/*
* For the 8-bit case, we can perform the move all at once
* since there are no alignment or endian issues
*/
case ACPI_RSC_MOVE8:
case ACPI_RSC_MOVE_GPIO_RES:
case ACPI_RSC_MOVE_SERIAL_VEN:
case ACPI_RSC_MOVE_SERIAL_RES:
return;
/*
* 16-, 32-, and 64-bit cases must use the move macros that perform
* misaligned memory transfers
*/
case ACPI_RSC_MOVE16:
case ACPI_RSC_MOVE_GPIO_PIN:
break;
case ACPI_RSC_MOVE32:
break;
case ACPI_RSC_MOVE64:
break;
default:
return;
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiRsSetResourceLength
*
* PARAMETERS: TotalLength - Length of the AML descriptor, including
* the header and length fields.
* Aml - Pointer to the raw AML descriptor
*
* RETURN: None
*
* DESCRIPTION: Set the ResourceLength field of an AML
* resource descriptor, both Large and Small descriptors are
* supported automatically. Note: Descriptor Type field must
* be valid.
*
******************************************************************************/
void
{
/* Length is the total descriptor length minus the header length */
/* Length is stored differently for large and small descriptors */
{
/* Large descriptor -- bytes 1-2 contain the 16-bit length */
}
else
{
/*
* Small descriptor -- bits 2:0 of byte 0 contain the length
* Clear any existing length, preserving descriptor type bits
*/
| ResourceLength);
}
}
/*******************************************************************************
*
* FUNCTION: AcpiRsSetResourceHeader
*
* PARAMETERS: DescriptorType - Byte to be inserted as the type
* TotalLength - Length of the AML descriptor, including
* the header and length fields.
* Aml - Pointer to the raw AML descriptor
*
* RETURN: None
*
* DESCRIPTION: Set the DescriptorType and ResourceLength fields of an AML
* resource descriptor, both Large and Small descriptors are
* supported automatically
*
******************************************************************************/
void
{
/* Set the Resource Type */
/* Set the Resource Length */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsStrcpy
*
* PARAMETERS: Destination - Pointer to the destination string
* Source - Pointer to the source string
*
* RETURN: String length, including NULL terminator
*
* DESCRIPTION: Local string copy that returns the string length, saving a
* strcpy followed by a strlen.
*
******************************************************************************/
static UINT16
char *Destination,
char *Source)
{
UINT16 i;
for (i = 0; Source[i]; i++)
{
Destination[i] = Source[i];
}
Destination[i] = 0;
/* Return string length including the NULL terminator */
return ((UINT16) (i + 1));
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetResourceSource
*
* PARAMETERS: ResourceLength - Length field of the descriptor
* MinimumLength - Minimum length of the descriptor (minus
* any optional fields)
* ResourceSource - Where the ResourceSource is returned
* Aml - Pointer to the raw AML descriptor
* StringPtr - (optional) where to store the actual
* ResourceSource string
*
* RETURN: Length of the string plus NULL terminator, rounded up to native
* word boundary
*
* DESCRIPTION: Copy the optional ResourceSource data from a raw AML descriptor
* to an internal resource descriptor
*
******************************************************************************/
char *StringPtr)
{
/*
* ResourceSource is present if the length of the descriptor is longer
* than the minimum length.
*
* Note: Some resource descriptors will have an additional null, so
* we add 1 to the minimum length.
*/
{
/* Get the ResourceSourceIndex */
if (!StringPtr)
{
/*
* String destination pointer is not specified; Set the String
* pointer to the end of the current ResourceSource structure.
*/
char, ResourceSource, sizeof (ACPI_RESOURCE_SOURCE));
}
/*
* In order for the Resource length to be a multiple of the native
* word, calculate the length of the string (+1 for NULL terminator)
* and expand to the next word multiple.
*
* Zero the entire area of the buffer.
*/
/* Copy the ResourceSource string to the destination */
return ((ACPI_RS_LENGTH) TotalLength);
}
/* ResourceSource is not present */
ResourceSource->Index = 0;
ResourceSource->StringLength = 0;
return (0);
}
/*******************************************************************************
*
* FUNCTION: AcpiRsSetResourceSource
*
* PARAMETERS: Aml - Pointer to the raw AML descriptor
* MinimumLength - Minimum length of the descriptor (minus
* any optional fields)
* ResourceSource - Internal ResourceSource
*
* RETURN: Total length of the AML descriptor
*
* DESCRIPTION: Convert an optional ResourceSource from internal format to a
* raw AML resource descriptor
*
******************************************************************************/
{
/* Non-zero string length indicates presence of a ResourceSource */
if (ResourceSource->StringLength)
{
/* Point to the end of the AML descriptor */
/* Copy the ResourceSourceIndex */
/* Copy the ResourceSource string */
/*
* Add the length of the string (+ 1 for null terminator) to the
* final descriptor length
*/
}
/* Return the new total length of the AML descriptor */
return (DescriptorLength);
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetPrtMethodData
*
* PARAMETERS: Node - Device node
* RetBuffer - Pointer to a buffer structure for the
* results
*
* RETURN: Status
*
* DESCRIPTION: This function is called to get the _PRT value of an object
* contained in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
******************************************************************************/
{
/* Parameters guaranteed valid by caller */
/* Execute the method, no parameters */
if (ACPI_FAILURE (Status))
{
}
/*
* Create a resource linked list from the byte stream buffer that comes
* back from the _CRS method execution.
*/
/* On exit, we must delete the object returned by EvaluateObject */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetCrsMethodData
*
* PARAMETERS: Node - Device node
* RetBuffer - Pointer to a buffer structure for the
* results
*
* RETURN: Status
*
* DESCRIPTION: This function is called to get the _CRS value of an object
* contained in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
******************************************************************************/
{
/* Parameters guaranteed valid by caller */
/* Execute the method, no parameters */
if (ACPI_FAILURE (Status))
{
}
/*
* Make the call to create a resource linked list from the
* byte stream buffer that comes back from the _CRS method
* execution.
*/
/* On exit, we must delete the object returned by evaluateObject */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetPrsMethodData
*
* PARAMETERS: Node - Device node
* RetBuffer - Pointer to a buffer structure for the
* results
*
* RETURN: Status
*
* DESCRIPTION: This function is called to get the _PRS value of an object
* contained in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
******************************************************************************/
{
/* Parameters guaranteed valid by caller */
/* Execute the method, no parameters */
if (ACPI_FAILURE (Status))
{
}
/*
* Make the call to create a resource linked list from the
* byte stream buffer that comes back from the _CRS method
* execution.
*/
/* On exit, we must delete the object returned by evaluateObject */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetAeiMethodData
*
* PARAMETERS: Node - Device node
* RetBuffer - Pointer to a buffer structure for the
* results
*
* RETURN: Status
*
* DESCRIPTION: This function is called to get the _AEI value of an object
* contained in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
******************************************************************************/
{
/* Parameters guaranteed valid by caller */
/* Execute the method, no parameters */
if (ACPI_FAILURE (Status))
{
}
/*
* Make the call to create a resource linked list from the
* byte stream buffer that comes back from the _CRS method
* execution.
*/
/* On exit, we must delete the object returned by evaluateObject */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsGetMethodData
*
* PARAMETERS: Handle - Handle to the containing object
* Path - Path to method, relative to Handle
* RetBuffer - Pointer to a buffer structure for the
* results
*
* RETURN: Status
*
* DESCRIPTION: This function is called to get the _CRS or _PRS value of an
* object contained in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
******************************************************************************/
const char *Path,
{
/* Parameters guaranteed valid by caller */
/* Execute the method, no parameters */
if (ACPI_FAILURE (Status))
{
}
/*
* Make the call to create a resource linked list from the
* byte stream buffer that comes back from the method
* execution.
*/
/* On exit, we must delete the object returned by EvaluateObject */
}
/*******************************************************************************
*
* FUNCTION: AcpiRsSetSrsMethodData
*
* PARAMETERS: Node - Device node
* InBuffer - Pointer to a buffer structure of the
* parameter
*
* RETURN: Status
*
* DESCRIPTION: This function is called to set the _SRS of an object contained
* in an object specified by the handle passed in
*
* If the function fails an appropriate status will be returned
* and the contents of the callers buffer is undefined.
*
* Note: Parameters guaranteed valid by caller
*
******************************************************************************/
{
/* Allocate and initialize the evaluation information block */
if (!Info)
{
}
/*
* The InBuffer parameter will point to a linked list of
* resource parameters. It needs to be formatted into a
* byte stream to be sent in as an input parameter to _SRS
*
* Convert the linked list into a byte stream
*/
if (ACPI_FAILURE (Status))
{
goto Cleanup;
}
/* Create and initialize the method parameter object */
if (!Args[0])
{
/*
* Must free the buffer allocated above (otherwise it is freed
* later)
*/
goto Cleanup;
}
/* Execute the method, no return value is expected */
/* Clean up and return the status from AcpiNsEvaluate */
AcpiUtRemoveReference (Args[0]);
}