[deliverable/linux.git] / drivers / acpi / resources / rscreate.c

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

/*
 * Copyright (C) 2000 - 2008, 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 <acpi/accommon.h>
#include <acpi/acresrc.h>
#include <acpi/acnamesp.h>

#define _COMPONENT          ACPI_RESOURCES
ACPI_MODULE_NAME("rscreate")

/*******************************************************************************
 *
 * 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(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 an union acpi_operand_object
 *                                        package
 *              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 acpi_integer 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++) {
		int source_name_index = 2;
		int source_index_index = 3;

		/*
		 * 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 element of the top-level package must also be a package */

		if (ACPI_GET_OBJECT_TYPE(*top_object_list) != ACPI_TYPE_PACKAGE) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%X]) Need sub-package, found %s",
				    index,
				    acpi_ut_get_object_type_name
				    (*top_object_list)));
			return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
		}

		/* Each sub-package must be of length 4 */

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

		/*
		 * Dereference the sub-package.
		 * 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 (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%X].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 (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%X].Pin) Need Integer, found %s",
				    index,
				    acpi_ut_get_object_type_name(obj_desc)));
			return_ACPI_STATUS(AE_BAD_DATA);
		}

		/*
		 * If BIOS erroneously reversed the _PRT source_name and source_index,
		 * then reverse them back.
		 */
		if (ACPI_GET_OBJECT_TYPE(sub_object_list[3]) !=
		    ACPI_TYPE_INTEGER) {
			if (acpi_gbl_enable_interpreter_slack) {
				source_name_index = 3;
				source_index_index = 2;
				printk(KERN_WARNING
				       "ACPI: Handling Garbled _PRT entry\n");
			} else {
				ACPI_ERROR((AE_INFO,
					    "(PRT[%X].source_index) Need Integer, found %s",
					    index,
					    acpi_ut_get_object_type_name
					    (sub_object_list[3])));
				return_ACPI_STATUS(AE_BAD_DATA);
			}
		}

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

		/*
		 * If the BIOS has erroneously reversed the _PRT source_name (index 2)
		 * and the source_index (index 3), fix it. _PRT is important enough to
		 * workaround this BIOS error. This also provides compatibility with
		 * other ACPI implementations.
		 */
		obj_desc = sub_object_list[3];
		if (!obj_desc
		    || (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER)) {
			sub_object_list[3] = sub_object_list[2];
			sub_object_list[2] = obj_desc;

			ACPI_WARNING((AE_INFO,
				      "(PRT[%X].Source) SourceName and SourceIndex are reversed, fixed",
				      index));
		}

		/*
		 * 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[source_name_index];
		if (obj_desc) {
			switch (ACPI_GET_OBJECT_TYPE(obj_desc)) {
			case ACPI_TYPE_LOCAL_REFERENCE:

				if (obj_desc->reference.class !=
				    ACPI_REFCLASS_NAME) {
					ACPI_ERROR((AE_INFO,
						    "(PRT[%X].Source) Need name, found Reference Class %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);

				/* +1 to include null terminator */

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

			case ACPI_TYPE_STRING:

				ACPI_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[%X].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[source_index_index];
		if (ACPI_GET_OBJECT_TYPE(obj_desc) != ACPI_TYPE_INTEGER) {
			ACPI_ERROR((AE_INFO,
				    "(PRT[%X].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:  linked_list_buffer      - Pointer to the resource linked list
 *              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 linked list of device resources and
 *              creates a bytestream to be used as input for the
 *              _SRS control method.
 *
 ******************************************************************************/

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

	ACPI_FUNCTION_TRACE(rs_create_aml_resources);

	ACPI_DEBUG_PRINT((ACPI_DB_INFO, "LinkedListBuffer = %p\n",
			  linked_list_buffer));

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