1 /*******************************************************************************
3 * Module Name: rsmisc - Miscellaneous resource descriptors
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2007, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/acresrc.h>
47 #define _COMPONENT ACPI_RESOURCES
48 ACPI_MODULE_NAME("rsmisc")
50 #define INIT_RESOURCE_TYPE(i) i->resource_offset
51 #define INIT_RESOURCE_LENGTH(i) i->aml_offset
52 #define INIT_TABLE_LENGTH(i) i->value
53 #define COMPARE_OPCODE(i) i->resource_offset
54 #define COMPARE_TARGET(i) i->aml_offset
55 #define COMPARE_VALUE(i) i->value
56 /*******************************************************************************
58 * FUNCTION: acpi_rs_convert_aml_to_resource
60 * PARAMETERS: Resource - Pointer to the resource descriptor
61 * Aml - Where the AML descriptor is returned
62 * Info - Pointer to appropriate conversion table
66 * DESCRIPTION: Convert an external AML resource descriptor to the corresponding
67 * internal resource descriptor
69 ******************************************************************************/
71 acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
72 union aml_resource *aml,
73 struct acpi_rsconvert_info *info)
75 acpi_rs_length aml_resource_length;
80 u8 flags_mode = FALSE;
84 ACPI_FUNCTION_TRACE(rs_convert_aml_to_resource);
86 if (((acpi_native_uint) resource) & 0x3) {
88 /* Each internal resource struct is expected to be 32-bit aligned */
90 ACPI_WARNING((AE_INFO,
91 "Misaligned resource pointer (get): %p Type %2.2X Len %X",
92 resource, resource->type, resource->length));
95 /* Extract the resource Length field (does not include header length) */
97 aml_resource_length = acpi_ut_get_resource_length(aml);
100 * First table entry must be ACPI_RSC_INITxxx and must contain the
101 * table length (# of table entries)
103 count = INIT_TABLE_LENGTH(info);
107 * Source is the external AML byte stream buffer,
108 * destination is the internal resource descriptor
110 source = ACPI_ADD_PTR(void, aml, info->aml_offset);
112 ACPI_ADD_PTR(void, resource, info->resource_offset);
114 switch (info->opcode) {
115 case ACPI_RSC_INITGET:
117 * Get the resource type and the initial (minimum) length
119 ACPI_MEMSET(resource, 0, INIT_RESOURCE_LENGTH(info));
120 resource->type = INIT_RESOURCE_TYPE(info);
121 resource->length = INIT_RESOURCE_LENGTH(info);
124 case ACPI_RSC_INITSET:
127 case ACPI_RSC_FLAGINIT:
132 case ACPI_RSC_1BITFLAG:
134 * Mask and shift the flag bit
136 ACPI_SET8(destination) = (u8)
137 ((ACPI_GET8(source) >> info->value) & 0x01);
140 case ACPI_RSC_2BITFLAG:
142 * Mask and shift the flag bits
144 ACPI_SET8(destination) = (u8)
145 ((ACPI_GET8(source) >> info->value) & 0x03);
150 item_count = ACPI_GET8(source);
151 ACPI_SET8(destination) = (u8) item_count;
153 resource->length = resource->length +
154 (info->value * (item_count - 1));
157 case ACPI_RSC_COUNT16:
159 item_count = aml_resource_length;
160 ACPI_SET16(destination) = item_count;
162 resource->length = resource->length +
163 (info->value * (item_count - 1));
166 case ACPI_RSC_LENGTH:
168 resource->length = resource->length + info->value;
172 case ACPI_RSC_MOVE16:
173 case ACPI_RSC_MOVE32:
174 case ACPI_RSC_MOVE64:
176 * Raw data move. Use the Info value field unless item_count has
177 * been previously initialized via a COUNT opcode
180 item_count = info->value;
182 acpi_rs_move_data(destination, source, item_count,
188 ACPI_MEMSET(destination, info->aml_offset, info->value);
193 target = ACPI_ADD_PTR(char, resource, info->value);
194 ACPI_MEMCPY(destination, source, ACPI_GET16(target));
197 case ACPI_RSC_ADDRESS:
199 * Common handler for address descriptor flags
201 if (!acpi_rs_get_address_common(resource, aml)) {
203 (AE_AML_INVALID_RESOURCE_TYPE);
207 case ACPI_RSC_SOURCE:
209 * Optional resource_source (Index and String)
212 acpi_rs_get_resource_source(aml_resource_length,
214 destination, aml, NULL);
217 case ACPI_RSC_SOURCEX:
219 * Optional resource_source (Index and String). This is the more
220 * complicated case used by the Interrupt() macro
223 ACPI_ADD_PTR(char, resource,
224 info->aml_offset + (item_count * 4));
227 acpi_rs_get_resource_source(aml_resource_length,
228 (acpi_rs_length) (((item_count - 1) * sizeof(u32)) + info->value), destination, aml, target);
231 case ACPI_RSC_BITMASK:
233 * 8-bit encoded bitmask (DMA macro)
236 acpi_rs_decode_bitmask(ACPI_GET8(source),
239 resource->length += (item_count - 1);
242 target = ACPI_ADD_PTR(char, resource, info->value);
243 ACPI_SET8(target) = (u8) item_count;
246 case ACPI_RSC_BITMASK16:
248 * 16-bit encoded bitmask (IRQ macro)
250 ACPI_MOVE_16_TO_16(&temp16, source);
253 acpi_rs_decode_bitmask(temp16, destination);
255 resource->length += (item_count - 1);
258 target = ACPI_ADD_PTR(char, resource, info->value);
259 ACPI_SET8(target) = (u8) item_count;
262 case ACPI_RSC_EXIT_NE:
264 * Control - Exit conversion if not equal
266 switch (info->resource_offset) {
267 case ACPI_RSC_COMPARE_AML_LENGTH:
268 if (aml_resource_length != info->value) {
273 case ACPI_RSC_COMPARE_VALUE:
274 if (ACPI_GET8(source) != info->value) {
282 "Invalid conversion sub-opcode"));
283 return_ACPI_STATUS(AE_BAD_PARAMETER);
289 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
290 return_ACPI_STATUS(AE_BAD_PARAMETER);
300 /* Round the resource struct length up to the next boundary (32 or 64) */
303 (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(resource->length);
305 return_ACPI_STATUS(AE_OK);
308 /*******************************************************************************
310 * FUNCTION: acpi_rs_convert_resource_to_aml
312 * PARAMETERS: Resource - Pointer to the resource descriptor
313 * Aml - Where the AML descriptor is returned
314 * Info - Pointer to appropriate conversion table
318 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
319 * external AML resource descriptor.
321 ******************************************************************************/
324 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
325 union aml_resource *aml,
326 struct acpi_rsconvert_info *info)
330 acpi_rsdesc_size aml_length = 0;
335 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
338 * First table entry must be ACPI_RSC_INITxxx and must contain the
339 * table length (# of table entries)
341 count = INIT_TABLE_LENGTH(info);
345 * Source is the internal resource descriptor,
346 * destination is the external AML byte stream buffer
348 source = ACPI_ADD_PTR(void, resource, info->resource_offset);
349 destination = ACPI_ADD_PTR(void, aml, info->aml_offset);
351 switch (info->opcode) {
352 case ACPI_RSC_INITSET:
354 ACPI_MEMSET(aml, 0, INIT_RESOURCE_LENGTH(info));
355 aml_length = INIT_RESOURCE_LENGTH(info);
356 acpi_rs_set_resource_header(INIT_RESOURCE_TYPE(info),
360 case ACPI_RSC_INITGET:
363 case ACPI_RSC_FLAGINIT:
365 * Clear the flag byte
367 ACPI_SET8(destination) = 0;
370 case ACPI_RSC_1BITFLAG:
372 * Mask and shift the flag bit
374 ACPI_SET8(destination) |= (u8)
375 ((ACPI_GET8(source) & 0x01) << info->value);
378 case ACPI_RSC_2BITFLAG:
380 * Mask and shift the flag bits
382 ACPI_SET8(destination) |= (u8)
383 ((ACPI_GET8(source) & 0x03) << info->value);
388 item_count = ACPI_GET8(source);
389 ACPI_SET8(destination) = (u8) item_count;
393 (info->value * (item_count - 1)));
396 case ACPI_RSC_COUNT16:
398 item_count = ACPI_GET16(source);
399 aml_length = (u16) (aml_length + item_count);
400 acpi_rs_set_resource_length(aml_length, aml);
403 case ACPI_RSC_LENGTH:
405 acpi_rs_set_resource_length(info->value, aml);
409 case ACPI_RSC_MOVE16:
410 case ACPI_RSC_MOVE32:
411 case ACPI_RSC_MOVE64:
414 item_count = info->value;
416 acpi_rs_move_data(destination, source, item_count,
420 case ACPI_RSC_ADDRESS:
422 /* Set the Resource Type, General Flags, and Type-Specific Flags */
424 acpi_rs_set_address_common(aml, resource);
427 case ACPI_RSC_SOURCEX:
429 * Optional resource_source (Index and String)
432 acpi_rs_set_resource_source(aml,
435 acpi_rs_set_resource_length(aml_length, aml);
438 case ACPI_RSC_SOURCE:
440 * Optional resource_source (Index and String). This is the more
441 * complicated case used by the Interrupt() macro
444 acpi_rs_set_resource_source(aml, info->value,
446 acpi_rs_set_resource_length(aml_length, aml);
449 case ACPI_RSC_BITMASK:
451 * 8-bit encoded bitmask (DMA macro)
453 ACPI_SET8(destination) = (u8)
454 acpi_rs_encode_bitmask(source,
455 *ACPI_ADD_PTR(u8, resource,
459 case ACPI_RSC_BITMASK16:
461 * 16-bit encoded bitmask (IRQ macro)
463 temp16 = acpi_rs_encode_bitmask(source,
468 ACPI_MOVE_16_TO_16(destination, &temp16);
471 case ACPI_RSC_EXIT_LE:
473 * Control - Exit conversion if less than or equal
475 if (item_count <= info->value) {
480 case ACPI_RSC_EXIT_NE:
482 * Control - Exit conversion if not equal
484 switch (COMPARE_OPCODE(info)) {
485 case ACPI_RSC_COMPARE_VALUE:
487 if (*ACPI_ADD_PTR(u8, resource,
488 COMPARE_TARGET(info)) !=
489 COMPARE_VALUE(info)) {
497 "Invalid conversion sub-opcode"));
498 return_ACPI_STATUS(AE_BAD_PARAMETER);
504 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
505 return_ACPI_STATUS(AE_BAD_PARAMETER);
513 return_ACPI_STATUS(AE_OK);
517 /* Previous resource validations */
519 if (aml->ext_address64.revision_iD != AML_RESOURCE_EXTENDED_ADDRESS_REVISION) {
520 return_ACPI_STATUS(AE_SUPPORT);
523 if (resource->data.start_dpf.performance_robustness >= 3) {
524 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_VALUE);
527 if (((aml->irq.flags & 0x09) == 0x00) || ((aml->irq.flags & 0x09) == 0x09)) {
529 * Only [active_high, edge_sensitive] or [active_low, level_sensitive]
530 * polarity/trigger interrupts are allowed (ACPI spec, section
531 * "IRQ Format"), so 0x00 and 0x09 are illegal.
534 "Invalid interrupt polarity/trigger in resource list, %X",
536 return_ACPI_STATUS(AE_BAD_DATA);
539 resource->data.extended_irq.interrupt_count = temp8;
542 /* Must have at least one IRQ */
544 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
547 if (resource->data.dma.transfer == 0x03) {
548 ACPI_ERROR((AE_INFO, "Invalid DMA.Transfer preference (3)"));
549 return_ACPI_STATUS(AE_BAD_DATA);