rslist.c

  1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
  2/*******************************************************************************
  3 *
  4 * Module Name: rslist - Linked list utilities
  5 *
  6 ******************************************************************************/
  7
  8#include <acpi/acpi.h>
  9#include "accommon.h"
 10#include "acresrc.h"
 11
 12#define _COMPONENT          ACPI_RESOURCES
 13ACPI_MODULE_NAME("rslist")
 14
 15/*******************************************************************************
 16 *
 17 * FUNCTION:    acpi_rs_convert_aml_to_resources
 18 *
 19 * PARAMETERS:  acpi_walk_aml_callback
 20 *              resource_ptr            - Pointer to the buffer that will
 21 *                                        contain the output structures
 22 *
 23 * RETURN:      Status
 24 *
 25 * DESCRIPTION: Convert an AML resource to an internal representation of the
 26 *              resource that is aligned and easier to access.
 27 *
 28 ******************************************************************************/
 29acpi_status
 30acpi_rs_convert_aml_to_resources(u8 * aml,
 31				 u32 length,
 32				 u32 offset, u8 resource_index, void **context)
 33{
 34	struct acpi_resource **resource_ptr =
 35	    ACPI_CAST_INDIRECT_PTR(struct acpi_resource, context);
 36	struct acpi_resource *resource;
 37	union aml_resource *aml_resource;
 38	struct acpi_rsconvert_info *conversion_table;
 39	acpi_status status;
 40
 41	ACPI_FUNCTION_TRACE(rs_convert_aml_to_resources);
 42
 43	/*
 44	 * Check that the input buffer and all subsequent pointers into it
 45	 * are aligned on a native word boundary. Most important on IA64
 46	 */
 47	resource = *resource_ptr;
 48	if (ACPI_IS_MISALIGNED(resource)) {
 49		ACPI_WARNING((AE_INFO,
 50			      "Misaligned resource pointer %p", resource));
 51	}
 52
 53	/* Get the appropriate conversion info table */
 54
 55	aml_resource = ACPI_CAST_PTR(union aml_resource, aml);
 56
 57	if (acpi_ut_get_resource_type(aml) == ACPI_RESOURCE_NAME_SERIAL_BUS) {
 58		if (aml_resource->common_serial_bus.type >
 59		    AML_RESOURCE_MAX_SERIALBUSTYPE) {
 60			conversion_table = NULL;
 61		} else {
 62			/* This is an I2C, SPI, UART, or CSI2 serial_bus descriptor */
 63
 64			conversion_table =
 65			    acpi_gbl_convert_resource_serial_bus_dispatch
 66			    [aml_resource->common_serial_bus.type];
 67		}
 68	} else {
 69		conversion_table =
 70		    acpi_gbl_get_resource_dispatch[resource_index];
 71	}
 72
 73	if (!conversion_table) {
 74		ACPI_ERROR((AE_INFO,
 75			    "Invalid/unsupported resource descriptor: Type 0x%2.2X",
 76			    resource_index));
 77		return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
 78	}
 79
 80	/* Convert the AML byte stream resource to a local resource struct */
 81
 82	status =
 83	    acpi_rs_convert_aml_to_resource(resource, aml_resource,
 84					    conversion_table);
 85	if (ACPI_FAILURE(status)) {
 86		ACPI_EXCEPTION((AE_INFO, status,
 87				"Could not convert AML resource (Type 0x%X)",
 88				*aml));
 89		return_ACPI_STATUS(status);
 90	}
 91
 92	if (!resource->length) {
 93		ACPI_EXCEPTION((AE_INFO, status,
 94				"Zero-length resource returned from RsConvertAmlToResource"));
 95	}
 96
 97	ACPI_DEBUG_PRINT((ACPI_DB_RESOURCES,
 98			  "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
 99			  acpi_ut_get_resource_type(aml), length,
100			  resource->length));
101
102	/* Point to the next structure in the output buffer */
103
104	*resource_ptr = ACPI_NEXT_RESOURCE(resource);
105	return_ACPI_STATUS(AE_OK);
106}
107
108/*******************************************************************************
109 *
110 * FUNCTION:    acpi_rs_convert_resources_to_aml
111 *
112 * PARAMETERS:  resource            - Pointer to the resource linked list
113 *              aml_size_needed     - Calculated size of the byte stream
114 *                                    needed from calling acpi_rs_get_aml_length()
115 *                                    The size of the output_buffer is
116 *                                    guaranteed to be >= aml_size_needed
117 *              output_buffer       - Pointer to the buffer that will
118 *                                    contain the byte stream
119 *
120 * RETURN:      Status
121 *
122 * DESCRIPTION: Takes the resource linked list and parses it, creating a
123 *              byte stream of resources in the caller's output buffer
124 *
125 ******************************************************************************/
126
127acpi_status
128acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
129				 acpi_size aml_size_needed, u8 * output_buffer)
130{
131	u8 *aml = output_buffer;
132	u8 *end_aml = output_buffer + aml_size_needed;
133	struct acpi_rsconvert_info *conversion_table;
134	acpi_status status;
135
136	ACPI_FUNCTION_TRACE(rs_convert_resources_to_aml);
137
138	/* Walk the resource descriptor list, convert each descriptor */
139
140	while (aml < end_aml) {
141
142		/* Validate the (internal) Resource Type */
143
144		if (resource->type > ACPI_RESOURCE_TYPE_MAX) {
145			ACPI_ERROR((AE_INFO,
146				    "Invalid descriptor type (0x%X) in resource list",
147				    resource->type));
148			return_ACPI_STATUS(AE_BAD_DATA);
149		}
150
151		/* Sanity check the length. It must not be zero, or we loop forever */
152
153		if (!resource->length) {
154			ACPI_ERROR((AE_INFO,
155				    "Invalid zero length descriptor in resource list\n"));
156			return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
157		}
158
159		/* Perform the conversion */
160
161		if (resource->type == ACPI_RESOURCE_TYPE_SERIAL_BUS) {
162			if (resource->data.common_serial_bus.type >
163			    AML_RESOURCE_MAX_SERIALBUSTYPE) {
164				conversion_table = NULL;
165			} else {
166				/* This is an I2C, SPI, UART or CSI2 serial_bus descriptor */
167
168				conversion_table =
169				    acpi_gbl_convert_resource_serial_bus_dispatch
170				    [resource->data.common_serial_bus.type];
171			}
172		} else {
173			conversion_table =
174			    acpi_gbl_set_resource_dispatch[resource->type];
175		}
176
177		if (!conversion_table) {
178			ACPI_ERROR((AE_INFO,
179				    "Invalid/unsupported resource descriptor: Type 0x%2.2X",
180				    resource->type));
181			return_ACPI_STATUS(AE_AML_INVALID_RESOURCE_TYPE);
182		}
183
184		status = acpi_rs_convert_resource_to_aml(resource,
185						         ACPI_CAST_PTR(union
186								       aml_resource,
187								       aml),
188							 conversion_table);
189		if (ACPI_FAILURE(status)) {
190			ACPI_EXCEPTION((AE_INFO, status,
191					"Could not convert resource (type 0x%X) to AML",
192					resource->type));
193			return_ACPI_STATUS(status);
194		}
195
196		/* Perform final sanity check on the new AML resource descriptor */
197
198		status =
199		    acpi_ut_validate_resource(NULL,
200					      ACPI_CAST_PTR(union aml_resource,
201							    aml), NULL);
202		if (ACPI_FAILURE(status)) {
203			return_ACPI_STATUS(status);
204		}
205
206		/* Check for end-of-list, normal exit */
207
208		if (resource->type == ACPI_RESOURCE_TYPE_END_TAG) {
209
210			/* An End Tag indicates the end of the input Resource Template */
211
212			return_ACPI_STATUS(AE_OK);
213		}
214
215		/*
216		 * Extract the total length of the new descriptor and set the
217		 * Aml to point to the next (output) resource descriptor
218		 */
219		aml += acpi_ut_get_descriptor_length(aml);
220
221		/* Point to the next input resource descriptor */
222
223		resource = ACPI_NEXT_RESOURCE(resource);
224	}
225
226	/* Completed buffer, but did not find an end_tag resource descriptor */
227
228	return_ACPI_STATUS(AE_AML_NO_RESOURCE_END_TAG);
229}