[linux-2.6-block.git] / drivers / acpi / acpica / rscreate.c

/*******************************************************************************
 *
 * Module Name: rscreate - Create resource lists/tables
 *
 ******************************************************************************/

/*
 * 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"
#include "acnamesp.h"

#define _COMPONENT          ACPI_RESOURCES
ACPI_MODULE_NAME("rscreate")

/*******************************************************************************
 *
 * FUNCTION:    acpi_buffer_to_resource
 *
 * PARAMETERS:  aml_buffer          - Pointer to the resource byte stream
 *              aml_buffer_length   - Length of the aml_buffer
 *              resource_ptr        - Where the converted resource is returned
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Convert a raw AML buffer to a resource list
 *
 ******************************************************************************/
acpi_status
acpi_buffer_to_resource(u8 *aml_buffer,
			u16 aml_buffer_length,
			struct acpi_resource **resource_ptr)
{
	acpi_status status;
	acpi_size list_size_needed;
	void *resource;
	void *current_resource_ptr;

	ACPI_FUNCTION_TRACE(acpi_buffer_to_resource);

	/*
	 * Note: we allow AE_AML_NO_RESOURCE_END_TAG, since an end tag
	 * is not required here.
	 */

	/* Get the required length for the converted resource */

	status =
	    acpi_rs_get_list_length(aml_buffer, aml_buffer_length,
				    &list_size_needed);
	if (status == AE_AML_NO_RESOURCE_END_TAG) {
		status = AE_OK;
	}
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Allocate a buffer for the converted resource */

	resource = ACPI_ALLOCATE_ZEROED(list_size_needed);
	current_resource_ptr = resource;
	if (!resource) {
		return_ACPI_STATUS(AE_NO_MEMORY);
	}

	/* Perform the AML-to-Resource conversion */

	status = acpi_ut_walk_aml_resources(NULL, aml_buffer, aml_buffer_length,
					    acpi_rs_convert_aml_to_resources,
					    &current_resource_ptr);
	if (status == AE_AML_NO_RESOURCE_END_TAG) {
		status = AE_OK;
	}
	if (ACPI_FAILURE(status)) {
		ACPI_FREE(resource);
	} else {
		*resource_ptr = resource;
	}

	return_ACPI_STATUS(status);
}

ACPI_EXPORT_SYMBOL(acpi_buffer_to_resource)

/*******************************************************************************
 *
 * FUNCTION:    acpi_rs_create_resource_list
 *
 * PARAMETERS:  aml_buffer          - Pointer to the resource byte stream
 *              output_buffer       - Pointer to the user's buffer
 *
 * RETURN:      Status: AE_OK if okay, else a valid acpi_status code
 *              If output_buffer is not large enough, output_buffer_length
 *              indicates how large output_buffer should be, else it
 *              indicates how may u8 elements of output_buffer are valid.
 *
 * DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
 *              execution and parses the stream to create a linked list
 *              of device resources.
 *
 ******************************************************************************/
acpi_status
acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
			     struct acpi_buffer *output_buffer)
{

	acpi_status status;
	u8 *aml_start;
	acpi_size list_size_needed = 0;
	u32 aml_buffer_length;
	void *resource;

	ACPI_FUNCTION_TRACE(rs_create_resource_list);

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer));

	/* Params already validated, so we don't re-validate here */

	aml_buffer_length = aml_buffer->buffer.length;
	aml_start = aml_buffer->buffer.pointer;

	/*
	 * Pass the aml_buffer into a module that can calculate
	 * the buffer size needed for the linked list
	 */
	status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
					 &list_size_needed);

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
			  status, (u32) list_size_needed));
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Validate/Allocate/Clear caller buffer */

	status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Do the conversion */

	resource = output_buffer->pointer;
	status = acpi_ut_walk_aml_resources(NULL, aml_start, aml_buffer_length,
					    acpi_rs_convert_aml_to_resources,
					    &resource);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
			  output_buffer->pointer, (u32) output_buffer->length));
	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_rs_create_pci_routing_table
 *
 * PARAMETERS:  package_object          - Pointer to a package containing one
 *                                        of more ACPI_OPERAND_OBJECTs
 *              output_buffer           - Pointer to the user's buffer
 *
 * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
 *              If the output_buffer is too small, the error will be
 *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
 *              to the size buffer needed.
 *
 * DESCRIPTION: Takes the union acpi_operand_object package and creates a
 *              linked list of PCI interrupt descriptions
 *
 * NOTE: It is the caller's responsibility to ensure that the start of the
 * output buffer is aligned properly (if necessary).
 *
 ******************************************************************************/

acpi_status
acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
				 struct acpi_buffer *output_buffer)
{
	u8 *buffer;
	union acpi_operand_object **top_object_list;
	union acpi_operand_object **sub_object_list;
	union acpi_operand_object *obj_desc;
	acpi_size buffer_size_needed = 0;
	u32 number_of_elements;
	u32 index;
	struct acpi_pci_routing_table *user_prt;
	struct acpi_namespace_node *node;
	acpi_status status;
	struct acpi_buffer path_buffer;

	ACPI_FUNCTION_TRACE(rs_create_pci_routing_table);

	/* Params already validated, so we don't re-validate here */

	/* Get the required buffer length */

	status =
	    acpi_rs_get_pci_routing_table_length(package_object,
						 &buffer_size_needed);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
			  (u32) buffer_size_needed));

	/* Validate/Allocate/Clear caller buffer */

	status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/*
	 * Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
	 * package that in turn contains an u64 Address, a u8 Pin,
	 * a Name, and a u8 source_index.
	 */
	top_object_list = package_object->package.elements;
	number_of_elements = package_object->package.count;
	buffer = output_buffer->pointer;
	user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);

	for (index = 0; index < number_of_elements; index++) {

		/*
		 * Point user_prt past this current structure
		 *
		 * NOTE: On the first iteration, user_prt->Length will
		 * be zero because we cleared the return buffer earlier
		 */
		buffer += user_prt->length;
		user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);

		/*
		 * Fill in the Length field with the information we have at this
		 * point. The minus four is to subtract the size of the u8
		 * Source[4] member because it is added below.
		 */
		user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);

		/* Each subpackage must be of length 4 */

		if ((*top_object_list)->package.count != 4) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%u]) Need package of length 4, found length %u",
				    index, (*top_object_list)->package.count));
			return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
		}

		/*
		 * Dereference the subpackage.
		 * The sub_object_list will now point to an array of the four IRQ
		 * elements: [Address, Pin, Source, source_index]
		 */
		sub_object_list = (*top_object_list)->package.elements;

		/* 1) First subobject: Dereference the PRT.Address */

		obj_desc = sub_object_list[0];
		if (!obj_desc || obj_desc->common.type != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%u].Address) Need Integer, found %s",
				    index,
				    acpi_ut_get_object_type_name(obj_desc)));
			return_ACPI_STATUS(AE_BAD_DATA);
		}

		user_prt->address = obj_desc->integer.value;

		/* 2) Second subobject: Dereference the PRT.Pin */

		obj_desc = sub_object_list[1];
		if (!obj_desc || obj_desc->common.type != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%u].Pin) Need Integer, found %s",
				    index,
				    acpi_ut_get_object_type_name(obj_desc)));
			return_ACPI_STATUS(AE_BAD_DATA);
		}

		user_prt->pin = (u32) obj_desc->integer.value;

		/*
		 * 3) Third subobject: Dereference the PRT.source_name
		 * The name may be unresolved (slack mode), so allow a null object
		 */
		obj_desc = sub_object_list[2];
		if (obj_desc) {
			switch (obj_desc->common.type) {
			case ACPI_TYPE_LOCAL_REFERENCE:

				if (obj_desc->reference.class !=
				    ACPI_REFCLASS_NAME) {
					ACPI_ERROR((AE_INFO,
						    "(PRT[%u].Source) Need name, found Reference Class 0x%X",
						    index,
						    obj_desc->reference.class));
					return_ACPI_STATUS(AE_BAD_DATA);
				}

				node = obj_desc->reference.node;

				/* Use *remaining* length of the buffer as max for pathname */

				path_buffer.length = output_buffer->length -
				    (u32) ((u8 *) user_prt->source -
					   (u8 *) output_buffer->pointer);
				path_buffer.pointer = user_prt->source;

				status = acpi_ns_handle_to_pathname((acpi_handle) node, &path_buffer, FALSE);

				/* +1 to include null terminator */

				user_prt->length +=
				    (u32)strlen(user_prt->source) + 1;
				break;

			case ACPI_TYPE_STRING:

				strcpy(user_prt->source,
				       obj_desc->string.pointer);

				/*
				 * Add to the Length field the length of the string
				 * (add 1 for terminator)
				 */
				user_prt->length += obj_desc->string.length + 1;
				break;

			case ACPI_TYPE_INTEGER:
				/*
				 * If this is a number, then the Source Name is NULL, since
				 * the entire buffer was zeroed out, we can leave this alone.
				 *
				 * Add to the Length field the length of the u32 NULL
				 */
				user_prt->length += sizeof(u32);
				break;

			default:

				ACPI_ERROR((AE_INFO,
					    "(PRT[%u].Source) Need Ref/String/Integer, found %s",
					    index,
					    acpi_ut_get_object_type_name
					    (obj_desc)));
				return_ACPI_STATUS(AE_BAD_DATA);
			}
		}

		/* Now align the current length */

		user_prt->length =
		    (u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length);

		/* 4) Fourth subobject: Dereference the PRT.source_index */

		obj_desc = sub_object_list[3];
		if (!obj_desc || obj_desc->common.type != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%u].SourceIndex) Need Integer, found %s",
				    index,
				    acpi_ut_get_object_type_name(obj_desc)));
			return_ACPI_STATUS(AE_BAD_DATA);
		}

		user_prt->source_index = (u32) obj_desc->integer.value;

		/* Point to the next union acpi_operand_object in the top level package */

		top_object_list++;
	}

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
			  output_buffer->pointer, (u32) output_buffer->length));
	return_ACPI_STATUS(AE_OK);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_rs_create_aml_resources
 *
 * PARAMETERS:  resource_list           - Pointer to the resource list buffer
 *              output_buffer           - Where the AML buffer is returned
 *
 * RETURN:      Status  AE_OK if okay, else a valid acpi_status code.
 *              If the output_buffer is too small, the error will be
 *              AE_BUFFER_OVERFLOW and output_buffer->Length will point
 *              to the size buffer needed.
 *
 * DESCRIPTION: Converts a list of device resources to an AML bytestream
 *              to be used as input for the _SRS control method.
 *
 ******************************************************************************/

acpi_status
acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
			     struct acpi_buffer *output_buffer)
{
	acpi_status status;
	acpi_size aml_size_needed = 0;

	ACPI_FUNCTION_TRACE(rs_create_aml_resources);

	/* Params already validated, no need to re-validate here */

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "ResourceList Buffer = %p\n",
			  resource_list->pointer));

	/* Get the buffer size needed for the AML byte stream */

	status =
	    acpi_rs_get_aml_length(resource_list->pointer,
				   resource_list->length, &aml_size_needed);

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
			  (u32)aml_size_needed, acpi_format_exception(status)));
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Validate/Allocate/Clear caller buffer */

	status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	/* Do the conversion */

	status = acpi_rs_convert_resources_to_aml(resource_list->pointer,
						  aml_size_needed,
						  output_buffer->pointer);
	if (ACPI_FAILURE(status)) {
		return_ACPI_STATUS(status);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
			  output_buffer->pointer, (u32) output_buffer->length));
	return_ACPI_STATUS(AE_OK);
}
Commit	Line	Data
1da177e4 LT	1	/*******************************************************************************
	2	*
	3	* Module Name: rscreate - Create resource lists/tables
	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"
	46	#include "acresrc.h"
	47	#include "acnamesp.h"
1da177e4 LT	48
1da177e4 LT	49	#define _COMPONENT ACPI_RESOURCES
4be44fcd	50	ACPI_MODULE_NAME("rscreate")
1da177e4	51
0e243178 BM	52	/*******************************************************************************
	53	*
	54	* FUNCTION: acpi_buffer_to_resource
	55	*
	56	* PARAMETERS: aml_buffer - Pointer to the resource byte stream
	57	* aml_buffer_length - Length of the aml_buffer
	58	* resource_ptr - Where the converted resource is returned
	59	*
	60	* RETURN: Status
	61	*
	62	* DESCRIPTION: Convert a raw AML buffer to a resource list
	63	*
	64	******************************************************************************/
	65	acpi_status
	66	acpi_buffer_to_resource(u8 *aml_buffer,
	67	u16 aml_buffer_length,
	68	struct acpi_resource **resource_ptr)
	69	{
	70	acpi_status status;
	71	acpi_size list_size_needed;
	72	void *resource;
	73	void *current_resource_ptr;
	74
51e35823 BM	75	ACPI_FUNCTION_TRACE(acpi_buffer_to_resource);
51e35823 BM	76
0e243178 BM	77	/*
	78	* Note: we allow AE_AML_NO_RESOURCE_END_TAG, since an end tag
	79	* is not required here.
	80	*/
	81
	82	/* Get the required length for the converted resource */
	83
1fad8738 BM	84	status =
	85	acpi_rs_get_list_length(aml_buffer, aml_buffer_length,
	86	&list_size_needed);
0e243178 BM	87	if (status == AE_AML_NO_RESOURCE_END_TAG) {
	88	status = AE_OK;
	89	}
	90	if (ACPI_FAILURE(status)) {
51e35823	91	return_ACPI_STATUS(status);
0e243178 BM	92	}
	93
	94	/* Allocate a buffer for the converted resource */
	95
	96	resource = ACPI_ALLOCATE_ZEROED(list_size_needed);
	97	current_resource_ptr = resource;
	98	if (!resource) {
51e35823	99	return_ACPI_STATUS(AE_NO_MEMORY);
0e243178 BM	100	}
	101
	102	/* Perform the AML-to-Resource conversion */
	103
886308ec	104	status = acpi_ut_walk_aml_resources(NULL, aml_buffer, aml_buffer_length,
0e243178 BM	105	acpi_rs_convert_aml_to_resources,
	106	&current_resource_ptr);
	107	if (status == AE_AML_NO_RESOURCE_END_TAG) {
	108	status = AE_OK;
	109	}
	110	if (ACPI_FAILURE(status)) {
	111	ACPI_FREE(resource);
	112	} else {
	113	*resource_ptr = resource;
	114	}
	115
51e35823	116	return_ACPI_STATUS(status);
0e243178 BM	117	}
0e243178 BM	118
51e35823 BM	119	ACPI_EXPORT_SYMBOL(acpi_buffer_to_resource)
51e35823 BM	120
1da177e4 LT	121	/*******************************************************************************
	122	*
	123	* FUNCTION: acpi_rs_create_resource_list
	124	*
50eca3eb BM	125	* PARAMETERS: aml_buffer - Pointer to the resource byte stream
50eca3eb BM	126	* output_buffer - Pointer to the user's buffer
1da177e4	127	*
50eca3eb	128	* RETURN: Status: AE_OK if okay, else a valid acpi_status code
1da177e4 LT	129	* If output_buffer is not large enough, output_buffer_length
	130	* indicates how large output_buffer should be, else it
	131	* indicates how may u8 elements of output_buffer are valid.
	132	*
	133	* DESCRIPTION: Takes the byte stream returned from a _CRS, _PRS control method
	134	* execution and parses the stream to create a linked list
	135	* of device resources.
	136	*
	137	******************************************************************************/
1da177e4	138	acpi_status
50eca3eb	139	acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
51e35823	140	struct acpi_buffer *output_buffer)
1da177e4 LT	141	{
1da177e4 LT	142
4be44fcd	143	acpi_status status;
50eca3eb	144	u8 *aml_start;
4be44fcd	145	acpi_size list_size_needed = 0;
50eca3eb	146	u32 aml_buffer_length;
61686124	147	void *resource;
1da177e4	148
b229cf92	149	ACPI_FUNCTION_TRACE(rs_create_resource_list);
1da177e4	150
b229cf92	151	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlBuffer = %p\n", aml_buffer));
1da177e4	152
44f6c012 RM	153	/* Params already validated, so we don't re-validate here */
44f6c012 RM	154
50eca3eb BM	155	aml_buffer_length = aml_buffer->buffer.length;
50eca3eb BM	156	aml_start = aml_buffer->buffer.pointer;
1da177e4 LT	157
1da177e4 LT	158	/*
50eca3eb	159	* Pass the aml_buffer into a module that can calculate
1da177e4 LT	160	* the buffer size needed for the linked list
1da177e4 LT	161	*/
50eca3eb BM	162	status = acpi_rs_get_list_length(aml_start, aml_buffer_length,
50eca3eb BM	163	&list_size_needed);
4be44fcd	164
b229cf92	165	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Status=%X ListSizeNeeded=%X\n",
4be44fcd LB	166	status, (u32) list_size_needed));
	167	if (ACPI_FAILURE(status)) {
	168	return_ACPI_STATUS(status);
1da177e4 LT	169	}
	170
	171	/* Validate/Allocate/Clear caller buffer */
	172
4be44fcd LB	173	status = acpi_ut_initialize_buffer(output_buffer, list_size_needed);
	174	if (ACPI_FAILURE(status)) {
	175	return_ACPI_STATUS(status);
1da177e4 LT	176	}
	177
	178	/* Do the conversion */
	179
61686124	180	resource = output_buffer->pointer;
886308ec	181	status = acpi_ut_walk_aml_resources(NULL, aml_start, aml_buffer_length,
61686124 BM	182	acpi_rs_convert_aml_to_resources,
61686124 BM	183	&resource);
4be44fcd LB	184	if (ACPI_FAILURE(status)) {
4be44fcd LB	185	return_ACPI_STATUS(status);
1da177e4 LT	186	}
1da177e4 LT	187
b229cf92	188	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
4be44fcd LB	189	output_buffer->pointer, (u32) output_buffer->length));
4be44fcd LB	190	return_ACPI_STATUS(AE_OK);
1da177e4 LT	191	}
1da177e4 LT	192
1da177e4 LT	193	/*******************************************************************************
	194	*
	195	* FUNCTION: acpi_rs_create_pci_routing_table
	196	*
cf48958e BM	197	* PARAMETERS: package_object - Pointer to a package containing one
cf48958e BM	198	* of more ACPI_OPERAND_OBJECTs
1da177e4 LT	199	* output_buffer - Pointer to the user's buffer
	200	*
	201	* RETURN: Status AE_OK if okay, else a valid acpi_status code.
	202	* If the output_buffer is too small, the error will be
	203	* AE_BUFFER_OVERFLOW and output_buffer->Length will point
	204	* to the size buffer needed.
	205	*
cf48958e	206	* DESCRIPTION: Takes the union acpi_operand_object package and creates a
1da177e4 LT	207	* linked list of PCI interrupt descriptions
	208	*
	209	* NOTE: It is the caller's responsibility to ensure that the start of the
	210	* output buffer is aligned properly (if necessary).
	211	*
	212	******************************************************************************/
	213
	214	acpi_status
4be44fcd LB	215	acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
4be44fcd LB	216	struct acpi_buffer *output_buffer)
1da177e4	217	{
4be44fcd LB	218	u8 *buffer;
	219	union acpi_operand_object **top_object_list;
	220	union acpi_operand_object **sub_object_list;
	221	union acpi_operand_object *obj_desc;
	222	acpi_size buffer_size_needed = 0;
	223	u32 number_of_elements;
	224	u32 index;
	225	struct acpi_pci_routing_table *user_prt;
	226	struct acpi_namespace_node *node;
	227	acpi_status status;
	228	struct acpi_buffer path_buffer;
	229
b229cf92	230	ACPI_FUNCTION_TRACE(rs_create_pci_routing_table);
1da177e4 LT	231
	232	/* Params already validated, so we don't re-validate here */
	233
44f6c012 RM	234	/* Get the required buffer length */
44f6c012 RM	235
1fad8738 BM	236	status =
	237	acpi_rs_get_pci_routing_table_length(package_object,
	238	&buffer_size_needed);
4be44fcd LB	239	if (ACPI_FAILURE(status)) {
4be44fcd LB	240	return_ACPI_STATUS(status);
1da177e4 LT	241	}
1da177e4 LT	242
b229cf92	243	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "BufferSizeNeeded = %X\n",
4be44fcd	244	(u32) buffer_size_needed));
1da177e4 LT	245
	246	/* Validate/Allocate/Clear caller buffer */
	247
4be44fcd LB	248	status = acpi_ut_initialize_buffer(output_buffer, buffer_size_needed);
	249	if (ACPI_FAILURE(status)) {
	250	return_ACPI_STATUS(status);
1da177e4 LT	251	}
	252
	253	/*
fd0a4327	254	* Loop through the ACPI_INTERNAL_OBJECTS - Each object should be a
5df7e6cb	255	* package that in turn contains an u64 Address, a u8 Pin,
fd0a4327	256	* a Name, and a u8 source_index.
1da177e4	257	*/
4be44fcd	258	top_object_list = package_object->package.elements;
1da177e4	259	number_of_elements = package_object->package.count;
4be44fcd LB	260	buffer = output_buffer->pointer;
4be44fcd LB	261	user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
1da177e4 LT	262
1da177e4 LT	263	for (index = 0; index < number_of_elements; index++) {
2f894ef9	264
1da177e4 LT	265	/*
	266	* Point user_prt past this current structure
	267	*
	268	* NOTE: On the first iteration, user_prt->Length will
	269	* be zero because we cleared the return buffer earlier
	270	*/
	271	buffer += user_prt->length;
4be44fcd	272	user_prt = ACPI_CAST_PTR(struct acpi_pci_routing_table, buffer);
1da177e4 LT	273
1da177e4 LT	274	/*
1fad8738 BM	275	* Fill in the Length field with the information we have at this
	276	* point. The minus four is to subtract the size of the u8
	277	* Source[4] member because it is added below.
1da177e4	278	*/
4be44fcd	279	user_prt->length = (sizeof(struct acpi_pci_routing_table) - 4);
1da177e4	280
0a16d12a	281	/* Each subpackage must be of length 4 */
1da177e4 LT	282
1da177e4 LT	283	if ((*top_object_list)->package.count != 4) {
b8e4d893	284	ACPI_ERROR((AE_INFO,
f6a22b0b	285	"(PRT[%u]) Need package of length 4, found length %u",
b8e4d893	286	index, (*top_object_list)->package.count));
4be44fcd	287	return_ACPI_STATUS(AE_AML_PACKAGE_LIMIT);
1da177e4 LT	288	}
	289
	290	/*
0a16d12a	291	* Dereference the subpackage.
1da177e4 LT	292	* The sub_object_list will now point to an array of the four IRQ
	293	* elements: [Address, Pin, Source, source_index]
	294	*/
	295	sub_object_list = (*top_object_list)->package.elements;
	296
44f6c012 RM	297	/* 1) First subobject: Dereference the PRT.Address */
44f6c012 RM	298
1da177e4	299	obj_desc = sub_object_list[0];
83130649	300	if (!obj_desc \|\| obj_desc->common.type != ACPI_TYPE_INTEGER) {
b8e4d893	301	ACPI_ERROR((AE_INFO,
f6a22b0b	302	"(PRT[%u].Address) Need Integer, found %s",
b8e4d893 BM	303	index,
b8e4d893 BM	304	acpi_ut_get_object_type_name(obj_desc)));
4be44fcd	305	return_ACPI_STATUS(AE_BAD_DATA);
1da177e4 LT	306	}
1da177e4 LT	307
fd0a4327 BM	308	user_prt->address = obj_desc->integer.value;
fd0a4327 BM	309
44f6c012 RM	310	/* 2) Second subobject: Dereference the PRT.Pin */
44f6c012 RM	311
1da177e4	312	obj_desc = sub_object_list[1];
83130649	313	if (!obj_desc \|\| obj_desc->common.type != ACPI_TYPE_INTEGER) {
b8e4d893	314	ACPI_ERROR((AE_INFO,
f6a22b0b	315	"(PRT[%u].Pin) Need Integer, found %s",
b8e4d893 BM	316	index,
b8e4d893 BM	317	acpi_ut_get_object_type_name(obj_desc)));
4be44fcd	318	return_ACPI_STATUS(AE_BAD_DATA);
1da177e4 LT	319	}
1da177e4 LT	320
fd0a4327 BM	321	user_prt->pin = (u32) obj_desc->integer.value;
fd0a4327 BM	322
b8e4d893 BM	323	/*
	324	* 3) Third subobject: Dereference the PRT.source_name
	325	* The name may be unresolved (slack mode), so allow a null object
	326	*/
82babbb3	327	obj_desc = sub_object_list[2];
b8e4d893	328	if (obj_desc) {
3371c19c	329	switch (obj_desc->common.type) {
b8e4d893 BM	330	case ACPI_TYPE_LOCAL_REFERENCE:
b8e4d893 BM	331
1044f1f6 BM	332	if (obj_desc->reference.class !=
1044f1f6 BM	333	ACPI_REFCLASS_NAME) {
b8e4d893	334	ACPI_ERROR((AE_INFO,
f6a22b0b	335	"(PRT[%u].Source) Need name, found Reference Class 0x%X",
b8e4d893	336	index,
1044f1f6	337	obj_desc->reference.class));
b8e4d893 BM	338	return_ACPI_STATUS(AE_BAD_DATA);
	339	}
	340
	341	node = obj_desc->reference.node;
	342
	343	/* Use remaining length of the buffer as max for pathname */
	344
	345	path_buffer.length = output_buffer->length -
	346	(u32) ((u8 *) user_prt->source -
	347	(u8 *) output_buffer->pointer);
	348	path_buffer.pointer = user_prt->source;
	349
1fad8738	350	status = acpi_ns_handle_to_pathname((acpi_handle) node, &path_buffer, FALSE);
b8e4d893 BM	351
	352	/* +1 to include null terminator */
	353
	354	user_prt->length +=
4fa4616e	355	(u32)strlen(user_prt->source) + 1;
b8e4d893 BM	356	break;
	357
	358	case ACPI_TYPE_STRING:
	359
4fa4616e BM	360	strcpy(user_prt->source,
4fa4616e BM	361	obj_desc->string.pointer);
b8e4d893 BM	362
	363	/*
	364	* Add to the Length field the length of the string
	365	* (add 1 for terminator)
	366	*/
	367	user_prt->length += obj_desc->string.length + 1;
	368	break;
	369
	370	case ACPI_TYPE_INTEGER:
	371	/*
1fad8738 BM	372	* If this is a number, then the Source Name is NULL, since
1fad8738 BM	373	* the entire buffer was zeroed out, we can leave this alone.
b8e4d893 BM	374	*
	375	* Add to the Length field the length of the u32 NULL
	376	*/
	377	user_prt->length += sizeof(u32);
	378	break;
	379
	380	default:
	381
	382	ACPI_ERROR((AE_INFO,
f6a22b0b	383	"(PRT[%u].Source) Need Ref/String/Integer, found %s",
b8e4d893 BM	384	index,
	385	acpi_ut_get_object_type_name
	386	(obj_desc)));
4be44fcd	387	return_ACPI_STATUS(AE_BAD_DATA);
1da177e4	388	}
1da177e4 LT	389	}
	390
	391	/* Now align the current length */
	392
4be44fcd	393	user_prt->length =
958dd242	394	(u32) ACPI_ROUND_UP_TO_64BIT(user_prt->length);
1da177e4	395
44f6c012 RM	396	/* 4) Fourth subobject: Dereference the PRT.source_index */
44f6c012 RM	397
82babbb3	398	obj_desc = sub_object_list[3];
83130649	399	if (!obj_desc \|\| obj_desc->common.type != ACPI_TYPE_INTEGER) {
b8e4d893	400	ACPI_ERROR((AE_INFO,
f6a22b0b	401	"(PRT[%u].SourceIndex) Need Integer, found %s",
b8e4d893 BM	402	index,
b8e4d893 BM	403	acpi_ut_get_object_type_name(obj_desc)));
4be44fcd	404	return_ACPI_STATUS(AE_BAD_DATA);
1da177e4 LT	405	}
1da177e4 LT	406
fd0a4327 BM	407	user_prt->source_index = (u32) obj_desc->integer.value;
fd0a4327 BM	408
1da177e4 LT	409	/* Point to the next union acpi_operand_object in the top level package */
	410
	411	top_object_list++;
	412	}
	413
b229cf92	414	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
4be44fcd LB	415	output_buffer->pointer, (u32) output_buffer->length));
4be44fcd LB	416	return_ACPI_STATUS(AE_OK);
1da177e4 LT	417	}
1da177e4 LT	418
1da177e4 LT	419	/*******************************************************************************
1da177e4 LT	420	*
50eca3eb	421	* FUNCTION: acpi_rs_create_aml_resources
1da177e4	422	*
9a0a3597 LZ	423	* PARAMETERS: resource_list - Pointer to the resource list buffer
9a0a3597 LZ	424	* output_buffer - Where the AML buffer is returned
1da177e4 LT	425	*
	426	* RETURN: Status AE_OK if okay, else a valid acpi_status code.
	427	* If the output_buffer is too small, the error will be
	428	* AE_BUFFER_OVERFLOW and output_buffer->Length will point
	429	* to the size buffer needed.
	430	*
9a0a3597 LZ	431	* DESCRIPTION: Converts a list of device resources to an AML bytestream
9a0a3597 LZ	432	* to be used as input for the _SRS control method.
1da177e4 LT	433	*
	434	******************************************************************************/
	435
	436	acpi_status
9a0a3597	437	acpi_rs_create_aml_resources(struct acpi_buffer *resource_list,
50eca3eb	438	struct acpi_buffer *output_buffer)
1da177e4	439	{
4be44fcd	440	acpi_status status;
50eca3eb	441	acpi_size aml_size_needed = 0;
1da177e4	442
b229cf92	443	ACPI_FUNCTION_TRACE(rs_create_aml_resources);
1da177e4	444
9a0a3597	445	/* Params already validated, no need to re-validate here */
1da177e4	446
9a0a3597 LZ	447	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "ResourceList Buffer = %p\n",
	448	resource_list->pointer));
	449
	450	/* Get the buffer size needed for the AML byte stream */
	451
1fad8738 BM	452	status =
	453	acpi_rs_get_aml_length(resource_list->pointer,
	454	resource_list->length, &aml_size_needed);
4be44fcd	455
b229cf92	456	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "AmlSizeNeeded=%X, %s\n",
3e8214e5	457	(u32)aml_size_needed, acpi_format_exception(status)));
4be44fcd LB	458	if (ACPI_FAILURE(status)) {
4be44fcd LB	459	return_ACPI_STATUS(status);
1da177e4 LT	460	}
	461
	462	/* Validate/Allocate/Clear caller buffer */
	463
50eca3eb	464	status = acpi_ut_initialize_buffer(output_buffer, aml_size_needed);
4be44fcd LB	465	if (ACPI_FAILURE(status)) {
4be44fcd LB	466	return_ACPI_STATUS(status);
1da177e4 LT	467	}
	468
	469	/* Do the conversion */
	470
9a0a3597 LZ	471	status = acpi_rs_convert_resources_to_aml(resource_list->pointer,
	472	aml_size_needed,
	473	output_buffer->pointer);
4be44fcd LB	474	if (ACPI_FAILURE(status)) {
4be44fcd LB	475	return_ACPI_STATUS(status);
1da177e4 LT	476	}
1da177e4 LT	477
b229cf92	478	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "OutputBuffer %p Length %X\n",
4be44fcd LB	479	output_buffer->pointer, (u32) output_buffer->length));
4be44fcd LB	480	return_ACPI_STATUS(AE_OK);
1da177e4	481	}