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