[deliverable/linux.git] / drivers / acpi / acpica / rslist.c

/*******************************************************************************
 *
 * Module Name: rslist - Linked list utilities
 *
 ******************************************************************************/

/*
 * 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/acpi.h>
#include "accommon.h"
#include "acresrc.h"

#define _COMPONENT          ACPI_RESOURCES
ACPI_MODULE_NAME("rslist")

/*******************************************************************************
 *
 * FUNCTION:    acpi_rs_convert_aml_to_resources
 *
 * PARAMETERS:  acpi_walk_aml_callback
 *              resource_ptr            - Pointer to the buffer that will
 *                                        contain the output structures
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Convert an AML resource to an internal representation of the
 *              resource that is aligned and easier to access.
 *
 ******************************************************************************/
acpi_status
acpi_rs_convert_aml_to_resources(u8 * aml,
				 u32 length,
				 u32 offset, u8 resource_index, void **context)
{
	struct acpi_resource **resource_ptr =
	    ACPI_CAST_INDIRECT_PTR(struct acpi_resource, context);
	struct acpi_resource *resource;
	union aml_resource *aml_resource;
	struct acpi_rsconvert_info *conversion_table;
	acpi_status status;

	ACPI_FUNCTION_TRACE(rs_convert_aml_to_resources);

	/*
	 * Check that the input buffer and all subsequent pointers into it
	 * are aligned on a native word boundary. Most important on IA64
	 */
	resource = *resource_ptr;
	if (ACPI_IS_MISALIGNED(resource)) {
		ACPI_WARNING((AE_INFO,
			      "Misaligned resource pointer %p", resource));
	}

	/* Get the appropriate conversion info table */

	aml_resource = ACPI_CAST_PTR(union aml_resource, aml);

	if (acpi_ut_get_resource_type(aml) == ACPI_RESOURCE_NAME_SERIAL_BUS) {
		if (aml_resource->common_serial_bus.type >
		    AML_RESOURCE_MAX_SERIALBUSTYPE) {
			conversion_table = NULL;
		} else {
			/* This is an I2C, SPI, or UART serial_bus descriptor */

			conversion_table =
			    acpi_gbl_convert_resource_serial_bus_dispatch
			    [aml_resource->common_serial_bus.type];
		}
	} else {
		conversion_table =
		    acpi_gbl_get_resource_dispatch[resource_index];
	}

	if (!conversion_table) {
		ACPI_ERROR((AE_INFO,
			    "Invalid/unsupported resource descriptor: Type 0x%2.2X",
			    resource_index));
		return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
	}

	/* Convert the AML byte stream resource to a local resource struct */

	status =
	    acpi_rs_convert_aml_to_resource(resource, aml_resource,
					    conversion_table);
	if (ACPI_FAILURE(status)) {
		ACPI_EXCEPTION((AE_INFO, status,
				"Could not convert AML resource (Type 0x%X)",
				*aml));
		return_ACPI_STATUS(status);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES,
			  "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
			  acpi_ut_get_resource_type(aml), length,
			  resource->length));

	/* Point to the next structure in the output buffer */

	*resource_ptr = ACPI_NEXT_RESOURCE(resource);
	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_rs_convert_resources_to_aml
 *
 * PARAMETERS:  resource            - Pointer to the resource linked list
 *              aml_size_needed     - Calculated size of the byte stream
 *                                    needed from calling acpi_rs_get_aml_length()
 *                                    The size of the output_buffer is
 *                                    guaranteed to be >= aml_size_needed
 *              output_buffer       - Pointer to the buffer that will
 *                                    contain the byte stream
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Takes the resource linked list and parses it, creating a
 *              byte stream of resources in the caller's output buffer
 *
 ******************************************************************************/

acpi_status
acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
				 acpi_size aml_size_needed, u8 * output_buffer)
{
	u8 *aml = output_buffer;
	u8 *end_aml = output_buffer + aml_size_needed;
	struct acpi_rsconvert_info *conversion_table;
	acpi_status status;

	ACPI_FUNCTION_TRACE(rs_convert_resources_to_aml);

	/* Walk the resource descriptor list, convert each descriptor */

	while (aml < end_aml) {

		/* Validate the (internal) Resource Type */

		if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
			ACPI_ERROR((AE_INFO,
				    "Invalid descriptor type (0x%X) in resource list",
				    resource->type));
			return_ACPI_STATUS(AE_BAD_DATA);
		}

		/* Sanity check the length. It must not be zero, or we loop forever */

		if (!resource->length) {
			ACPI_ERROR((AE_INFO,
				    "Invalid zero length descriptor in resource list\n"));
			return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
		}

		/* Perform the conversion */

		if (resource->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
			if (resource->data.common_serial_bus.type >
			    AML_RESOURCE_MAX_SERIALBUSTYPE) {
				conversion_table = NULL;
			} else {
				/* This is an I2C, SPI, or UART serial_bus descriptor */

				conversion_table =
				    acpi_gbl_convert_resource_serial_bus_dispatch
				    [resource->data.common_serial_bus.type];
			}
		} else {
			conversion_table =
			    acpi_gbl_set_resource_dispatch[resource->type];
		}

		if (!conversion_table) {
			ACPI_ERROR((AE_INFO,
				    "Invalid/unsupported resource descriptor: Type 0x%2.2X",
				    resource->type));
			return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
		}

		status = acpi_rs_convert_resource_to_aml(resource,
						         ACPI_CAST_PTR(union
								       aml_resource,
								       aml),
							 conversion_table);
		if (ACPI_FAILURE(status)) {
			ACPI_EXCEPTION((AE_INFO, status,
					"Could not convert resource (type 0x%X) to AML",
					resource->type));
			return_ACPI_STATUS(status);
		}

		/* Perform final sanity check on the new AML resource descriptor */

		status =
		    acpi_ut_validate_resource(NULL,
					      ACPI_CAST_PTR(union aml_resource,
							    aml), NULL);
		if (ACPI_FAILURE(status)) {
			return_ACPI_STATUS(status);
		}

		/* Check for end-of-list, normal exit */

		if (resource->type == ACPI_RESOURCE_TYPE_END_TAG) {

			/* An End Tag indicates the end of the input Resource Template */

			return_ACPI_STATUS(AE_OK);
		}

		/*
		 * Extract the total length of the new descriptor and set the
		 * Aml to point to the next (output) resource descriptor
		 */
		aml += acpi_ut_get_descriptor_length(aml);

		/* Point to the next input resource descriptor */

		resource = ACPI_NEXT_RESOURCE(resource);
	}

	/* Completed buffer, but did not find an end_tag resource descriptor */

	return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
}
Commit	Line	Data
1da177e4 LT	1	/*******************************************************************************
	2	*
	3	* Module Name: rslist - Linked list utilities
	4	*
	5	******************************************************************************/
	6
	7	/*
c8100dc4	8	* Copyright (C) 2000 - 2016, Intel Corp.
1da177e4 LT	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
1da177e4	44	#include <acpi/acpi.h>
e2f7a777 LB	45	#include "accommon.h"
e2f7a777 LB	46	#include "acresrc.h"
1da177e4 LT	47
1da177e4 LT	48	#define _COMPONENT ACPI_RESOURCES
4be44fcd	49	ACPI_MODULE_NAME("rslist")
1da177e4	50
1da177e4 LT	51	/*******************************************************************************
1da177e4 LT	52	*
50eca3eb	53	* FUNCTION: acpi_rs_convert_aml_to_resources
1da177e4	54	*
61686124 BM	55	* PARAMETERS: acpi_walk_aml_callback
	56	* resource_ptr - Pointer to the buffer that will
	57	* contain the output structures
1da177e4 LT	58	*
	59	* RETURN: Status
	60	*
61686124 BM	61	* DESCRIPTION: Convert an AML resource to an internal representation of the
61686124 BM	62	* resource that is aligned and easier to access.
1da177e4 LT	63	*
1da177e4 LT	64	******************************************************************************/
1da177e4	65	acpi_status
61686124 BM	66	acpi_rs_convert_aml_to_resources(u8 * aml,
61686124 BM	67	u32 length,
793c2388	68	u32 offset, u8 resource_index, void **context)
1da177e4	69	{
793c2388 BM	70	struct acpi_resource **resource_ptr =
	71	ACPI_CAST_INDIRECT_PTR(struct acpi_resource, context);
	72	struct acpi_resource *resource;
e0fe0a8d LM	73	union aml_resource *aml_resource;
e0fe0a8d LM	74	struct acpi_rsconvert_info *conversion_table;
4be44fcd	75	acpi_status status;
4be44fcd	76
b229cf92	77	ACPI_FUNCTION_TRACE(rs_convert_aml_to_resources);
4be44fcd	78
61686124 BM	79	/*
	80	* Check that the input buffer and all subsequent pointers into it
	81	* are aligned on a native word boundary. Most important on IA64
	82	*/
793c2388	83	resource = *resource_ptr;
61686124 BM	84	if (ACPI_IS_MISALIGNED(resource)) {
	85	ACPI_WARNING((AE_INFO,
	86	"Misaligned resource pointer %p", resource));
	87	}
44f6c012	88
e0fe0a8d LM	89	/* Get the appropriate conversion info table */
	90
	91	aml_resource = ACPI_CAST_PTR(union aml_resource, aml);
1fad8738	92
e0fe0a8d LM	93	if (acpi_ut_get_resource_type(aml) == ACPI_RESOURCE_NAME_SERIAL_BUS) {
	94	if (aml_resource->common_serial_bus.type >
	95	AML_RESOURCE_MAX_SERIALBUSTYPE) {
	96	conversion_table = NULL;
	97	} else {
	98	/* This is an I2C, SPI, or UART serial_bus descriptor */
	99
	100	conversion_table =
	101	acpi_gbl_convert_resource_serial_bus_dispatch
	102	[aml_resource->common_serial_bus.type];
	103	}
	104	} else {
	105	conversion_table =
	106	acpi_gbl_get_resource_dispatch[resource_index];
	107	}
	108
	109	if (!conversion_table) {
	110	ACPI_ERROR((AE_INFO,
	111	"Invalid/unsupported resource descriptor: Type 0x%2.2X",
	112	resource_index));
68aafc35	113	return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
e0fe0a8d LM	114	}
e0fe0a8d LM	115
61686124 BM	116	/* Convert the AML byte stream resource to a local resource struct */
	117
	118	status =
e0fe0a8d LM	119	acpi_rs_convert_aml_to_resource(resource, aml_resource,
e0fe0a8d LM	120	conversion_table);
61686124 BM	121	if (ACPI_FAILURE(status)) {
61686124 BM	122	ACPI_EXCEPTION((AE_INFO, status,
f6a22b0b	123	"Could not convert AML resource (Type 0x%X)",
61686124 BM	124	*aml));
61686124 BM	125	return_ACPI_STATUS(status);
44f6c012	126	}
1da177e4	127
61686124	128	ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES,
b229cf92	129	"Type %.2X, AmlLength %.2X InternalLength %.2X\n",
61686124 BM	130	acpi_ut_get_resource_type(aml), length,
	131	resource->length));
	132
	133	/* Point to the next structure in the output buffer */
1da177e4	134
e0fe0a8d	135	*resource_ptr = ACPI_NEXT_RESOURCE(resource);
61686124	136	return_ACPI_STATUS(AE_OK);
1da177e4 LT	137	}
1da177e4 LT	138
1da177e4 LT	139	/*******************************************************************************
1da177e4 LT	140	*
50eca3eb	141	* FUNCTION: acpi_rs_convert_resources_to_aml
1da177e4	142	*
ba494bee	143	* PARAMETERS: resource - Pointer to the resource linked list
50eca3eb BM	144	* aml_size_needed - Calculated size of the byte stream
	145	* needed from calling acpi_rs_get_aml_length()
	146	* The size of the output_buffer is
	147	* guaranteed to be >= aml_size_needed
	148	* output_buffer - Pointer to the buffer that will
	149	* contain the byte stream
1da177e4 LT	150	*
	151	* RETURN: Status
	152	*
	153	* DESCRIPTION: Takes the resource linked list and parses it, creating a
	154	* byte stream of resources in the caller's output buffer
	155	*
	156	******************************************************************************/
	157
	158	acpi_status
50eca3eb BM	159	acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
50eca3eb BM	160	acpi_size aml_size_needed, u8 * output_buffer)
1da177e4	161	{
96db255c BM	162	u8 *aml = output_buffer;
96db255c BM	163	u8 *end_aml = output_buffer + aml_size_needed;
e0fe0a8d	164	struct acpi_rsconvert_info *conversion_table;
bda663d3	165	acpi_status status;
1da177e4	166
b229cf92	167	ACPI_FUNCTION_TRACE(rs_convert_resources_to_aml);
1da177e4	168
0897831b	169	/* Walk the resource descriptor list, convert each descriptor */
1da177e4	170
96db255c	171	while (aml < end_aml) {
52fc0b02	172
96db255c	173	/* Validate the (internal) Resource Type */
44f6c012	174
50eca3eb	175	if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
b8e4d893	176	ACPI_ERROR((AE_INFO,
f6a22b0b	177	"Invalid descriptor type (0x%X) in resource list",
b8e4d893	178	resource->type));
bda663d3	179	return_ACPI_STATUS(AE_BAD_DATA);
44f6c012	180	}
1da177e4	181
c13085e5 BM	182	/* Sanity check the length. It must not be zero, or we loop forever */
	183
	184	if (!resource->length) {
	185	ACPI_ERROR((AE_INFO,
	186	"Invalid zero length descriptor in resource list\n"));
	187	return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
	188	}
	189
0897831b	190	/* Perform the conversion */
50eca3eb	191
e0fe0a8d LM	192	if (resource->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
	193	if (resource->data.common_serial_bus.type >
	194	AML_RESOURCE_MAX_SERIALBUSTYPE) {
	195	conversion_table = NULL;
	196	} else {
	197	/* This is an I2C, SPI, or UART serial_bus descriptor */
	198
	199	conversion_table =
	200	acpi_gbl_convert_resource_serial_bus_dispatch
	201	[resource->data.common_serial_bus.type];
	202	}
	203	} else {
	204	conversion_table =
	205	acpi_gbl_set_resource_dispatch[resource->type];
	206	}
	207
	208	if (!conversion_table) {
	209	ACPI_ERROR((AE_INFO,
	210	"Invalid/unsupported resource descriptor: Type 0x%2.2X",
	211	resource->type));
68aafc35	212	return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
e0fe0a8d LM	213	}
	214
	215	status = acpi_rs_convert_resource_to_aml(resource,
	216	ACPI_CAST_PTR(union
	217	aml_resource,
	218	aml),
	219	conversion_table);
50eca3eb	220	if (ACPI_FAILURE(status)) {
b8e4d893	221	ACPI_EXCEPTION((AE_INFO, status,
f6a22b0b	222	"Could not convert resource (type 0x%X) to AML",
b8e4d893	223	resource->type));
50eca3eb BM	224	return_ACPI_STATUS(status);
	225	}
	226
	227	/* Perform final sanity check on the new AML resource descriptor */
bda663d3	228
1fad8738 BM	229	status =
	230	acpi_ut_validate_resource(NULL,
	231	ACPI_CAST_PTR(union aml_resource,
	232	aml), NULL);
4be44fcd LB	233	if (ACPI_FAILURE(status)) {
4be44fcd LB	234	return_ACPI_STATUS(status);
1da177e4 LT	235	}
1da177e4 LT	236
50eca3eb	237	/* Check for end-of-list, normal exit */
bda663d3	238
50eca3eb	239	if (resource->type == ACPI_RESOURCE_TYPE_END_TAG) {
52fc0b02	240
50eca3eb	241	/* An End Tag indicates the end of the input Resource Template */
bda663d3 RM	242
	243	return_ACPI_STATUS(AE_OK);
	244	}
	245
0897831b BM	246	/*
0897831b BM	247	* Extract the total length of the new descriptor and set the
96db255c	248	* Aml to point to the next (output) resource descriptor
0897831b	249	*/
96db255c	250	aml += acpi_ut_get_descriptor_length(aml);
1da177e4	251
50eca3eb	252	/* Point to the next input resource descriptor */
44f6c012	253
e0fe0a8d	254	resource = ACPI_NEXT_RESOURCE(resource);
1da177e4	255	}
0897831b BM	256
	257	/* Completed buffer, but did not find an end_tag resource descriptor */
	258
	259	return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
1da177e4	260	}