dmrestag.c revision 199767f8919635c4928607450d9e0abb932109ce
/******************************************************************************
*
* Module Name: dmrestag - Add tags to resource descriptors (Application-level)
*
*****************************************************************************/
/*
* Copyright (C) 2000 - 2015, 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.
*/
/* This module used for application-level code only */
#define _COMPONENT ACPI_CA_DISASSEMBLER
ACPI_MODULE_NAME ("dmrestag")
/* Local prototypes */
static void
static char *
const ACPI_RESOURCE_TAG *TagList);
static char *
static char *
static ACPI_NAMESPACE_NODE *
static ACPI_STATUS
void **Context);
static void
/******************************************************************************
*
* Resource Tag tables
*
* These are the predefined tags that refer to elements of a resource
* descriptor. Each name and offset is defined in the ACPI specification.
*
* Each table entry contains the bit offset of the field and the associated
* name.
*
******************************************************************************/
static const ACPI_RESOURCE_TAG AcpiDmIrqTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmDmaTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmIoTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmFixedIoTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmFixedDmaTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmMemory24Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmRegisterTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmMemory32Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmFixedMemory32Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmInterruptTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmAddress16Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmAddress32Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmAddress64Tags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmExtendedAddressTags[] =
{
{0, NULL}
};
/* Subtype tables for GPIO descriptors */
static const ACPI_RESOURCE_TAG AcpiDmGpioIntTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmGpioIoTags[] =
{
{0, NULL}
};
/* Subtype tables for SerialBus descriptors */
static const ACPI_RESOURCE_TAG AcpiDmI2cSerialBusTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmSpiSerialBusTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmUartSerialBusTags[] =
{
{0, NULL}
};
/* Subtype tables for Address descriptor type-specific flags */
static const ACPI_RESOURCE_TAG AcpiDmMemoryFlagTags[] =
{
{0, NULL}
};
static const ACPI_RESOURCE_TAG AcpiDmIoFlagTags[] =
{
{0, NULL}
};
/*
* Dispatch table used to obtain the correct tag table for a descriptor.
*
* A NULL in this table means one of three things:
* 1) The descriptor ID is reserved and invalid
* 2) The descriptor has no tags associated with it
* 3) The descriptor has subtypes and a separate table will be used.
*/
static const ACPI_RESOURCE_TAG *AcpiGbl_ResourceTags[] =
{
/* Small descriptors */
NULL, /* 0x00, Reserved */
NULL, /* 0x01, Reserved */
NULL, /* 0x02, Reserved */
NULL, /* 0x03, Reserved */
AcpiDmIrqTags, /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */
AcpiDmDmaTags, /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */
NULL, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */
NULL, /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */
AcpiDmIoTags, /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */
AcpiDmFixedIoTags, /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */
AcpiDmFixedDmaTags, /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */
NULL, /* 0x0B, Reserved */
NULL, /* 0x0C, Reserved */
NULL, /* 0x0D, Reserved */
NULL, /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */
NULL, /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */
/* Large descriptors */
NULL, /* 0x00, Reserved */
AcpiDmMemory24Tags, /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */
AcpiDmRegisterTags, /* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */
NULL, /* 0x03, Reserved */
NULL, /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */
AcpiDmMemory32Tags, /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */
AcpiDmFixedMemory32Tags, /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */
AcpiDmAddress32Tags, /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */
AcpiDmAddress16Tags, /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */
AcpiDmInterruptTags, /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */
AcpiDmAddress64Tags, /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */
AcpiDmExtendedAddressTags, /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */
NULL, /* 0x0C, ACPI_RESOURCE_NAME_GPIO - Use Subtype table below */
NULL, /* 0x0D, Reserved */
NULL /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use Subtype table below */
};
/* GPIO Subtypes */
static const ACPI_RESOURCE_TAG *AcpiGbl_GpioResourceTags[] =
{
AcpiDmGpioIntTags, /* 0x00 Interrupt Connection */
AcpiDmGpioIoTags /* 0x01 I/O Connection */
};
/* Serial Bus Subtypes */
static const ACPI_RESOURCE_TAG *AcpiGbl_SerialResourceTags[] =
{
NULL, /* 0x00 Reserved */
AcpiDmI2cSerialBusTags, /* 0x01 I2C SerialBus */
AcpiDmSpiSerialBusTags, /* 0x02 SPI SerialBus */
AcpiDmUartSerialBusTags /* 0x03 UART SerialBus */
};
/*
* Globals used to generate unique resource descriptor names. We use names that
* start with underscore and a prefix letter that is not used by other ACPI
* reserved names. To this, we append hex 0x00 through 0xFF. These 5 prefixes
* allow for 5*256 = 1280 unique names, probably sufficient for any single ASL
* file. If this becomes too small, we can use alpha+numerals for a total
* of 5*36*36 = 6480.
*/
#define ACPI_NUM_RES_PREFIX 5
static UINT32 AcpiGbl_NextResourceId = 0;
static UINT8 AcpiGbl_NextPrefix = 0;
static char AcpiGbl_Prefix[ACPI_NUM_RES_PREFIX] =
{'Y','Z','J','K','X'};
/*******************************************************************************
*
* FUNCTION: AcpiDmCheckResourceReference
*
* PARAMETERS: Op - Parse Op for the AML opcode
* WalkState - Current walk state (with valid scope)
*
* RETURN: None
*
* DESCRIPTION: Convert a reference to a resource descriptor to a symbolic
* reference if possible
*
* NOTE: Bit index is used to transparently handle both resource bit
* fields and byte fields.
*
******************************************************************************/
void
{
const ACPI_OPCODE_INFO *OpInfo;
/* We are only interested in the CreateXxxxField opcodes */
{
return;
}
/* Get the buffer term operand */
/* Must be a named buffer, not an arg or local or method call */
{
return;
}
/* Get the Index term, must be an integer constant to convert */
/* Major cheat: The Node field is also used for the Tag ptr. Clear it now */
{
return;
}
/* Get the bit offset of the descriptor within the buffer */
{
/* Index operand is a bit offset */
}
else
{
/* Index operand is a byte offset, convert to bits */
}
/* Lookup the buffer in the namespace */
&BufferNode);
if (ACPI_FAILURE (Status))
{
return;
}
/* Validate object type, we must have a buffer */
{
return;
}
/* Find the resource descriptor node corresponding to the index */
if (!ResourceNode)
{
return;
}
/* Translate the Index to a resource tag pathname */
}
/*******************************************************************************
*
* FUNCTION: AcpiDmGetResourceNode
*
* PARAMETERS: BufferNode - Node for the parent buffer
* BitIndex - Index into the resource descriptor
*
* RETURN: Namespace node for the resource descriptor. NULL if not found
*
* DESCRIPTION: Find a resource descriptor that corresponds to the bit index
*
******************************************************************************/
static ACPI_NAMESPACE_NODE *
{
/*
* Child list contains an entry for each resource descriptor. Find
* the descriptor that corresponds to the Index.
*
* If there are no children, this is not a resource template
*/
while (Node)
{
/*
* Check if the Index falls within this resource.
*
* Value contains the resource offset, Object contains the resource
* length (both in bytes)
*/
{
return (Node);
}
}
return (NULL);
}
/*******************************************************************************
*
* FUNCTION: AcpiGetTagPathname
*
* PARAMETERS: BufferNode - Node for the parent buffer
* ResourceNode - Node for a resource descriptor
* BitIndex - Index into the resource descriptor
*
* RETURN: Full pathname for a resource tag. NULL if no match.
* Path is returned in AML (packed) format.
*
* DESCRIPTION: Convert a BitIndex into a symbolic resource tag (full pathname)
*
******************************************************************************/
static char *
{
char *Pathname;
char *InternalPath;
char *Tag;
/* Get the Op that contains the actual buffer data */
if (!Op)
{
return (NULL);
}
/* Get the individual resource descriptor and validate it */
if (ACPI_FAILURE (Status))
{
return (NULL);
}
/* Get offset into this descriptor (from offset into entire buffer) */
/* Get the tag associated with this resource descriptor and offset */
if (!Tag)
{
return (NULL);
}
/*
* Now that we know that we have a reference that can be converted to a
* symbol, change the name of the resource to a unique name.
*/
/* Get the full pathname to the parent buffer */
if (!RequiredSize)
{
return (NULL);
}
if (!Pathname)
{
return (NULL);
}
/*
* Create the full path to the resource and tag by: remove the buffer name,
* append the resource descriptor name, append a dot, append the tag name.
*
* TBD: Always using the full path is a bit brute force, the path can be
* often be optimized with carats (if the original buffer namepath is a
* single nameseg). This doesn't really matter, because these paths do not
* end up in the final compiled AML, it's just an appearance issue for the
* disassembled code.
*/
/* Internalize the namepath to AML format */
/* Update the Op with the symbol */
/* We will need the tag later. Cheat by putting it in the Node field */
return (InternalPath);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmUpdateResourceName
*
* PARAMETERS: ResourceNode - Node for a resource descriptor
*
* RETURN: Stores new name in the ResourceNode
*
* DESCRIPTION: Create a new, unique name for a resource descriptor. Used by
* both the disassembly of the descriptor itself and any symbolic
* references to the descriptor. Ignored if a unique name has
* already been assigned to the resource.
*
* NOTE: Single threaded, suitable for applications only!
*
******************************************************************************/
static void
{
char Name[ACPI_NAME_SIZE];
/* Ignore if a unique name has already been assigned */
{
return;
}
/* Generate a new ACPI name for the descriptor */
Name[0] = '_';
/* Update globals for next name */
if (AcpiGbl_NextResourceId >= 256)
{
{
AcpiGbl_NextPrefix = 0;
}
}
/* Change the resource descriptor name */
}
/*******************************************************************************
*
* FUNCTION: AcpiDmGetResourceTag
*
* PARAMETERS: BitIndex - Index into the resource descriptor
* Resource - Pointer to the raw resource data
* ResourceIndex - Index correspoinding to the resource type
*
* RETURN: Pointer to the resource tag (ACPI_NAME). NULL if no match.
*
* DESCRIPTION: Convert a BitIndex into a symbolic resource tag.
*
* Note: ResourceIndex should be previously validated and guaranteed to ve
* valid.
*
******************************************************************************/
static char *
{
const ACPI_RESOURCE_TAG *TagList;
/* Get the tag list for this resource descriptor type */
/*
* Handle descriptors that have multiple subtypes
*/
switch (Resource->DescriptorType)
{
/*
* Subtype differentiation is the flags.
* Kindof brute force, but just blindly search for an index match
*/
{
}
{
}
/* If we found a match, all done. Else, drop to normal search below */
if (Tag)
{
return (Tag);
}
break;
case ACPI_RESOURCE_NAME_GPIO:
/* GPIO connection has 2 subtypes: Interrupt and I/O */
{
return (NULL);
}
break;
/* SerialBus has 3 subtypes: I2C, SPI, and UART */
{
return (NULL);
}
break;
default:
break;
}
/* Search for a match against the BitIndex */
if (TagList)
{
}
return (Tag);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmSearchTagList
*
* PARAMETERS: BitIndex - Index into the resource descriptor
* TagList - List to search
*
* RETURN: Pointer to a tag (ACPI_NAME). NULL if no match found.
*
* DESCRIPTION: Search a tag list for a match to the input BitIndex. Matches
* a fixed offset to a symbolic resource tag name.
*
******************************************************************************/
static char *
const ACPI_RESOURCE_TAG *TagList)
{
/*
* Walk the null-terminated tag list to find a matching bit offset.
* We are looking for an exact match.
*/
{
{
}
}
/* A matching offset was not found */
return (NULL);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmFindResources
*
* PARAMETERS: Root - Root of the parse tree
*
* RETURN: None
*
* DESCRIPTION: Add all ResourceTemplate declarations to the namespace. Each
* resource descriptor in each template is given a node -- used
* for later conversion of resource references to symbolic refs.
*
******************************************************************************/
void
{
/* Walk the entire parse tree */
while (Op)
{
/* We are interested in Buffer() declarations */
{
/* And only declarations of the form Name (XXXX, Buffer()... ) */
{
/*
* If the buffer is a resource template, add the individual
* resource descriptors to the namespace, as children of the
* buffer node.
*/
{
}
}
}
}
}
/*******************************************************************************
*
* FUNCTION: AcpiDmAddResourcesToNamespace
*
* PARAMETERS: BufferNode - Node for the parent buffer
* Op - Parse op for the buffer
*
* RETURN: None
*
* DESCRIPTION: Add an entire resource template to the namespace. Each
* resource descriptor is added as a namespace node.
*
******************************************************************************/
static void
{
/* Get to the ByteData list */
if (!NextOp)
{
return;
}
/* Set Node and Op to point to each other */
/*
* Insert each resource into the namespace
* NextOp contains the Aml pointer and the Aml length
*/
AcpiDmAddResourceToNamespace, (void **) BufferNode);
}
/*******************************************************************************
*
* FUNCTION: AcpiDmAddResourceToNamespace
*
* PARAMETERS: ACPI_WALK_AML_CALLBACK
* BufferNode - Node for the parent buffer
*
* RETURN: Status
*
* DESCRIPTION: Add one resource descriptor to the namespace as a child of the
* parent buffer. The same name is used for each descriptor. This
* is changed later to a unique name if the resource is actually
* referenced by an AML operator.
*
******************************************************************************/
static ACPI_STATUS
void **Context)
{
/* TBD: Don't need to add descriptors that have no tags defined? */
/* Add the resource to the namespace, as child of the buffer */
if (ACPI_FAILURE (Status))
{
return (AE_OK);
}
/* Set the name to the default, changed later if resource is referenced */
/* Save the offset of the descriptor (within the original buffer) */
return (AE_OK);
}