1 /*******************************************************************************
3 * Module Name: rsmisc - Miscellaneous resource descriptors
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2012, Intel Corp.
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>
48 #define _COMPONENT ACPI_RESOURCES
49 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);
87 return_ACPI_STATUS(AE_BAD_PARAMETER);
90 if (((acpi_size) resource) & 0x3) {
92 /* Each internal resource struct is expected to be 32-bit aligned */
94 ACPI_WARNING((AE_INFO,
95 "Misaligned resource pointer (get): %p Type 0x%2.2X Length %u",
96 resource, resource->type, resource->length));
99 /* Extract the resource Length field (does not include header length) */
101 aml_resource_length = acpi_ut_get_resource_length(aml);
104 * First table entry must be ACPI_RSC_INITxxx and must contain the
105 * table length (# of table entries)
107 count = INIT_TABLE_LENGTH(info);
110 * Source is the external AML byte stream buffer,
111 * destination is the internal resource descriptor
113 source = ACPI_ADD_PTR(void, aml, info->aml_offset);
115 ACPI_ADD_PTR(void, resource, info->resource_offset);
117 switch (info->opcode) {
118 case ACPI_RSC_INITGET:
120 * Get the resource type and the initial (minimum) length
122 ACPI_MEMSET(resource, 0, INIT_RESOURCE_LENGTH(info));
123 resource->type = INIT_RESOURCE_TYPE(info);
124 resource->length = INIT_RESOURCE_LENGTH(info);
127 case ACPI_RSC_INITSET:
130 case ACPI_RSC_FLAGINIT:
135 case ACPI_RSC_1BITFLAG:
137 * Mask and shift the flag bit
139 ACPI_SET8(destination) = (u8)
140 ((ACPI_GET8(source) >> info->value) & 0x01);
143 case ACPI_RSC_2BITFLAG:
145 * Mask and shift the flag bits
147 ACPI_SET8(destination) = (u8)
148 ((ACPI_GET8(source) >> info->value) & 0x03);
151 case ACPI_RSC_3BITFLAG:
153 * Mask and shift the flag bits
155 ACPI_SET8(destination) = (u8)
156 ((ACPI_GET8(source) >> info->value) & 0x07);
161 item_count = ACPI_GET8(source);
162 ACPI_SET8(destination) = (u8) item_count;
164 resource->length = resource->length +
165 (info->value * (item_count - 1));
168 case ACPI_RSC_COUNT16:
170 item_count = aml_resource_length;
171 ACPI_SET16(destination) = item_count;
173 resource->length = resource->length +
174 (info->value * (item_count - 1));
177 case ACPI_RSC_COUNT_GPIO_PIN:
179 target = ACPI_ADD_PTR(void, aml, info->value);
180 item_count = ACPI_GET16(target) - ACPI_GET16(source);
182 resource->length = resource->length + item_count;
183 item_count = item_count / 2;
184 ACPI_SET16(destination) = item_count;
187 case ACPI_RSC_COUNT_GPIO_VEN:
189 item_count = ACPI_GET8(source);
190 ACPI_SET8(destination) = (u8)item_count;
192 resource->length = resource->length +
193 (info->value * item_count);
196 case ACPI_RSC_COUNT_GPIO_RES:
199 * Vendor data is optional (length/offset may both be zero)
200 * Examine vendor data length field first
202 target = ACPI_ADD_PTR(void, aml, (info->value + 2));
203 if (ACPI_GET16(target)) {
205 /* Use vendor offset to get resource source length */
207 target = ACPI_ADD_PTR(void, aml, info->value);
209 ACPI_GET16(target) - ACPI_GET16(source);
211 /* No vendor data to worry about */
213 item_count = aml->large_header.resource_length +
214 sizeof(struct aml_resource_large_header) -
218 resource->length = resource->length + item_count;
219 ACPI_SET16(destination) = item_count;
222 case ACPI_RSC_COUNT_SERIAL_VEN:
224 item_count = ACPI_GET16(source) - info->value;
226 resource->length = resource->length + item_count;
227 ACPI_SET16(destination) = item_count;
230 case ACPI_RSC_COUNT_SERIAL_RES:
232 item_count = (aml_resource_length +
233 sizeof(struct aml_resource_large_header))
234 - ACPI_GET16(source) - info->value;
236 resource->length = resource->length + item_count;
237 ACPI_SET16(destination) = item_count;
240 case ACPI_RSC_LENGTH:
242 resource->length = resource->length + info->value;
246 case ACPI_RSC_MOVE16:
247 case ACPI_RSC_MOVE32:
248 case ACPI_RSC_MOVE64:
250 * Raw data move. Use the Info value field unless item_count has
251 * been previously initialized via a COUNT opcode
254 item_count = info->value;
256 acpi_rs_move_data(destination, source, item_count,
260 case ACPI_RSC_MOVE_GPIO_PIN:
262 /* Generate and set the PIN data pointer */
264 target = (char *)ACPI_ADD_PTR(void, resource,
267 *(u16 **)destination = ACPI_CAST_PTR(u16, target);
269 /* Copy the PIN data */
271 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
272 acpi_rs_move_data(target, source, item_count,
276 case ACPI_RSC_MOVE_GPIO_RES:
278 /* Generate and set the resource_source string pointer */
280 target = (char *)ACPI_ADD_PTR(void, resource,
283 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
285 /* Copy the resource_source string */
287 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
288 acpi_rs_move_data(target, source, item_count,
292 case ACPI_RSC_MOVE_SERIAL_VEN:
294 /* Generate and set the Vendor Data pointer */
296 target = (char *)ACPI_ADD_PTR(void, resource,
299 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
301 /* Copy the Vendor Data */
303 source = ACPI_ADD_PTR(void, aml, info->value);
304 acpi_rs_move_data(target, source, item_count,
308 case ACPI_RSC_MOVE_SERIAL_RES:
310 /* Generate and set the resource_source string pointer */
312 target = (char *)ACPI_ADD_PTR(void, resource,
315 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
317 /* Copy the resource_source string */
320 ACPI_ADD_PTR(void, aml,
321 (ACPI_GET16(source) + info->value));
322 acpi_rs_move_data(target, source, item_count,
328 ACPI_MEMSET(destination, info->aml_offset, info->value);
333 target = ACPI_ADD_PTR(char, resource, info->value);
334 ACPI_MEMCPY(destination, source, ACPI_GET16(target));
337 case ACPI_RSC_ADDRESS:
339 * Common handler for address descriptor flags
341 if (!acpi_rs_get_address_common(resource, aml)) {
343 (AE_AML_INVALID_RESOURCE_TYPE);
347 case ACPI_RSC_SOURCE:
349 * Optional resource_source (Index and String)
352 acpi_rs_get_resource_source(aml_resource_length,
354 destination, aml, NULL);
357 case ACPI_RSC_SOURCEX:
359 * Optional resource_source (Index and String). This is the more
360 * complicated case used by the Interrupt() macro
362 target = ACPI_ADD_PTR(char, resource,
367 acpi_rs_get_resource_source(aml_resource_length,
376 case ACPI_RSC_BITMASK:
378 * 8-bit encoded bitmask (DMA macro)
381 acpi_rs_decode_bitmask(ACPI_GET8(source),
384 resource->length += (item_count - 1);
387 target = ACPI_ADD_PTR(char, resource, info->value);
388 ACPI_SET8(target) = (u8) item_count;
391 case ACPI_RSC_BITMASK16:
393 * 16-bit encoded bitmask (IRQ macro)
395 ACPI_MOVE_16_TO_16(&temp16, source);
398 acpi_rs_decode_bitmask(temp16, destination);
400 resource->length += (item_count - 1);
403 target = ACPI_ADD_PTR(char, resource, info->value);
404 ACPI_SET8(target) = (u8) item_count;
407 case ACPI_RSC_EXIT_NE:
409 * Control - Exit conversion if not equal
411 switch (info->resource_offset) {
412 case ACPI_RSC_COMPARE_AML_LENGTH:
413 if (aml_resource_length != info->value) {
418 case ACPI_RSC_COMPARE_VALUE:
419 if (ACPI_GET8(source) != info->value) {
427 "Invalid conversion sub-opcode"));
428 return_ACPI_STATUS(AE_BAD_PARAMETER);
434 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
435 return_ACPI_STATUS(AE_BAD_PARAMETER);
445 /* Round the resource struct length up to the next boundary (32 or 64) */
448 (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(resource->length);
450 return_ACPI_STATUS(AE_OK);
453 /*******************************************************************************
455 * FUNCTION: acpi_rs_convert_resource_to_aml
457 * PARAMETERS: Resource - Pointer to the resource descriptor
458 * Aml - Where the AML descriptor is returned
459 * Info - Pointer to appropriate conversion table
463 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
464 * external AML resource descriptor.
466 ******************************************************************************/
469 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
470 union aml_resource *aml,
471 struct acpi_rsconvert_info *info)
476 acpi_rsdesc_size aml_length = 0;
481 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
484 return_ACPI_STATUS(AE_BAD_PARAMETER);
488 * First table entry must be ACPI_RSC_INITxxx and must contain the
489 * table length (# of table entries)
491 count = INIT_TABLE_LENGTH(info);
495 * Source is the internal resource descriptor,
496 * destination is the external AML byte stream buffer
498 source = ACPI_ADD_PTR(void, resource, info->resource_offset);
499 destination = ACPI_ADD_PTR(void, aml, info->aml_offset);
501 switch (info->opcode) {
502 case ACPI_RSC_INITSET:
504 ACPI_MEMSET(aml, 0, INIT_RESOURCE_LENGTH(info));
505 aml_length = INIT_RESOURCE_LENGTH(info);
506 acpi_rs_set_resource_header(INIT_RESOURCE_TYPE(info),
510 case ACPI_RSC_INITGET:
513 case ACPI_RSC_FLAGINIT:
515 * Clear the flag byte
517 ACPI_SET8(destination) = 0;
520 case ACPI_RSC_1BITFLAG:
522 * Mask and shift the flag bit
524 ACPI_SET8(destination) |= (u8)
525 ((ACPI_GET8(source) & 0x01) << info->value);
528 case ACPI_RSC_2BITFLAG:
530 * Mask and shift the flag bits
532 ACPI_SET8(destination) |= (u8)
533 ((ACPI_GET8(source) & 0x03) << info->value);
536 case ACPI_RSC_3BITFLAG:
538 * Mask and shift the flag bits
540 ACPI_SET8(destination) |= (u8)
541 ((ACPI_GET8(source) & 0x07) << info->value);
546 item_count = ACPI_GET8(source);
547 ACPI_SET8(destination) = (u8) item_count;
551 (info->value * (item_count - 1)));
554 case ACPI_RSC_COUNT16:
556 item_count = ACPI_GET16(source);
557 aml_length = (u16) (aml_length + item_count);
558 acpi_rs_set_resource_length(aml_length, aml);
561 case ACPI_RSC_COUNT_GPIO_PIN:
563 item_count = ACPI_GET16(source);
564 ACPI_SET16(destination) = (u16)aml_length;
566 aml_length = (u16)(aml_length + item_count * 2);
567 target = ACPI_ADD_PTR(void, aml, info->value);
568 ACPI_SET16(target) = (u16)aml_length;
569 acpi_rs_set_resource_length(aml_length, aml);
572 case ACPI_RSC_COUNT_GPIO_VEN:
574 item_count = ACPI_GET16(source);
575 ACPI_SET16(destination) = (u16)item_count;
578 (u16)(aml_length + (info->value * item_count));
579 acpi_rs_set_resource_length(aml_length, aml);
582 case ACPI_RSC_COUNT_GPIO_RES:
584 /* Set resource source string length */
586 item_count = ACPI_GET16(source);
587 ACPI_SET16(destination) = (u16)aml_length;
589 /* Compute offset for the Vendor Data */
591 aml_length = (u16)(aml_length + item_count);
592 target = ACPI_ADD_PTR(void, aml, info->value);
594 /* Set vendor offset only if there is vendor data */
596 if (resource->data.gpio.vendor_length) {
597 ACPI_SET16(target) = (u16)aml_length;
600 acpi_rs_set_resource_length(aml_length, aml);
603 case ACPI_RSC_COUNT_SERIAL_VEN:
605 item_count = ACPI_GET16(source);
606 ACPI_SET16(destination) = item_count + info->value;
607 aml_length = (u16)(aml_length + item_count);
608 acpi_rs_set_resource_length(aml_length, aml);
611 case ACPI_RSC_COUNT_SERIAL_RES:
613 item_count = ACPI_GET16(source);
614 aml_length = (u16)(aml_length + item_count);
615 acpi_rs_set_resource_length(aml_length, aml);
618 case ACPI_RSC_LENGTH:
620 acpi_rs_set_resource_length(info->value, aml);
624 case ACPI_RSC_MOVE16:
625 case ACPI_RSC_MOVE32:
626 case ACPI_RSC_MOVE64:
629 item_count = info->value;
631 acpi_rs_move_data(destination, source, item_count,
635 case ACPI_RSC_MOVE_GPIO_PIN:
637 destination = (char *)ACPI_ADD_PTR(void, aml,
640 source = *(u16 **)source;
641 acpi_rs_move_data(destination, source, item_count,
645 case ACPI_RSC_MOVE_GPIO_RES:
647 /* Used for both resource_source string and vendor_data */
649 destination = (char *)ACPI_ADD_PTR(void, aml,
652 source = *(u8 **)source;
653 acpi_rs_move_data(destination, source, item_count,
657 case ACPI_RSC_MOVE_SERIAL_VEN:
659 destination = (char *)ACPI_ADD_PTR(void, aml,
662 source = *(u8 **)source;
663 acpi_rs_move_data(destination, source, item_count,
667 case ACPI_RSC_MOVE_SERIAL_RES:
669 destination = (char *)ACPI_ADD_PTR(void, aml,
672 source = *(u8 **)source;
673 acpi_rs_move_data(destination, source, item_count,
677 case ACPI_RSC_ADDRESS:
679 /* Set the Resource Type, General Flags, and Type-Specific Flags */
681 acpi_rs_set_address_common(aml, resource);
684 case ACPI_RSC_SOURCEX:
686 * Optional resource_source (Index and String)
689 acpi_rs_set_resource_source(aml, (acpi_rs_length)
691 acpi_rs_set_resource_length(aml_length, aml);
694 case ACPI_RSC_SOURCE:
696 * Optional resource_source (Index and String). This is the more
697 * complicated case used by the Interrupt() macro
700 acpi_rs_set_resource_source(aml, info->value,
702 acpi_rs_set_resource_length(aml_length, aml);
705 case ACPI_RSC_BITMASK:
707 * 8-bit encoded bitmask (DMA macro)
709 ACPI_SET8(destination) = (u8)
710 acpi_rs_encode_bitmask(source,
711 *ACPI_ADD_PTR(u8, resource,
715 case ACPI_RSC_BITMASK16:
717 * 16-bit encoded bitmask (IRQ macro)
719 temp16 = acpi_rs_encode_bitmask(source,
724 ACPI_MOVE_16_TO_16(destination, &temp16);
727 case ACPI_RSC_EXIT_LE:
729 * Control - Exit conversion if less than or equal
731 if (item_count <= info->value) {
736 case ACPI_RSC_EXIT_NE:
738 * Control - Exit conversion if not equal
740 switch (COMPARE_OPCODE(info)) {
741 case ACPI_RSC_COMPARE_VALUE:
743 if (*ACPI_ADD_PTR(u8, resource,
744 COMPARE_TARGET(info)) !=
745 COMPARE_VALUE(info)) {
753 "Invalid conversion sub-opcode"));
754 return_ACPI_STATUS(AE_BAD_PARAMETER);
758 case ACPI_RSC_EXIT_EQ:
760 * Control - Exit conversion if equal
762 if (*ACPI_ADD_PTR(u8, resource,
763 COMPARE_TARGET(info)) ==
764 COMPARE_VALUE(info)) {
771 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
772 return_ACPI_STATUS(AE_BAD_PARAMETER);
780 return_ACPI_STATUS(AE_OK);
784 /* Previous resource validations */
786 if (aml->ext_address64.revision_iD != AML_RESOURCE_EXTENDED_ADDRESS_REVISION) {
787 return_ACPI_STATUS(AE_SUPPORT);
790 if (resource->data.start_dpf.performance_robustness >= 3) {
791 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_VALUE);
794 if (((aml->irq.flags & 0x09) == 0x00) || ((aml->irq.flags & 0x09) == 0x09)) {
796 * Only [active_high, edge_sensitive] or [active_low, level_sensitive]
797 * polarity/trigger interrupts are allowed (ACPI spec, section
798 * "IRQ Format"), so 0x00 and 0x09 are illegal.
801 "Invalid interrupt polarity/trigger in resource list, 0x%X",
803 return_ACPI_STATUS(AE_BAD_DATA);
806 resource->data.extended_irq.interrupt_count = temp8;
809 /* Must have at least one IRQ */
811 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
814 if (resource->data.dma.transfer == 0x03) {
815 ACPI_ERROR((AE_INFO, "Invalid DMA.Transfer preference (3)"));
816 return_ACPI_STATUS(AE_BAD_DATA);