1 /*******************************************************************************
3 * Module Name: rsmisc - Miscellaneous resource descriptors
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2015, 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,
140 ((ACPI_GET8(source) >> info->value) & 0x01));
143 case ACPI_RSC_2BITFLAG:
145 * Mask and shift the flag bits
147 ACPI_SET8(destination,
148 ((ACPI_GET8(source) >> info->value) & 0x03));
151 case ACPI_RSC_3BITFLAG:
153 * Mask and shift the flag bits
155 ACPI_SET8(destination,
156 ((ACPI_GET8(source) >> info->value) & 0x07));
161 item_count = ACPI_GET8(source);
162 ACPI_SET8(destination, 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, item_count);
192 resource->length = resource->length +
193 (info->value * item_count);
196 case ACPI_RSC_COUNT_GPIO_RES:
198 * Vendor data is optional (length/offset may both be zero)
199 * Examine vendor data length field first
201 target = ACPI_ADD_PTR(void, aml, (info->value + 2));
202 if (ACPI_GET16(target)) {
204 /* Use vendor offset to get resource source length */
206 target = ACPI_ADD_PTR(void, aml, info->value);
208 ACPI_GET16(target) - ACPI_GET16(source);
210 /* No vendor data to worry about */
212 item_count = aml->large_header.resource_length +
213 sizeof(struct aml_resource_large_header) -
217 resource->length = resource->length + item_count;
218 ACPI_SET16(destination, item_count);
221 case ACPI_RSC_COUNT_SERIAL_VEN:
223 item_count = ACPI_GET16(source) - info->value;
225 resource->length = resource->length + item_count;
226 ACPI_SET16(destination, item_count);
229 case ACPI_RSC_COUNT_SERIAL_RES:
231 item_count = (aml_resource_length +
232 sizeof(struct aml_resource_large_header))
233 - ACPI_GET16(source) - info->value;
235 resource->length = resource->length + item_count;
236 ACPI_SET16(destination, item_count);
239 case ACPI_RSC_LENGTH:
241 resource->length = resource->length + info->value;
245 case ACPI_RSC_MOVE16:
246 case ACPI_RSC_MOVE32:
247 case ACPI_RSC_MOVE64:
249 * Raw data move. Use the Info value field unless item_count has
250 * been previously initialized via a COUNT opcode
253 item_count = info->value;
255 acpi_rs_move_data(destination, source, item_count,
259 case ACPI_RSC_MOVE_GPIO_PIN:
261 /* Generate and set the PIN data pointer */
263 target = (char *)ACPI_ADD_PTR(void, resource,
266 *(u16 **)destination = ACPI_CAST_PTR(u16, target);
268 /* Copy the PIN data */
270 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
271 acpi_rs_move_data(target, source, item_count,
275 case ACPI_RSC_MOVE_GPIO_RES:
277 /* Generate and set the resource_source string pointer */
279 target = (char *)ACPI_ADD_PTR(void, resource,
282 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
284 /* Copy the resource_source string */
286 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
287 acpi_rs_move_data(target, source, item_count,
291 case ACPI_RSC_MOVE_SERIAL_VEN:
293 /* Generate and set the Vendor Data pointer */
295 target = (char *)ACPI_ADD_PTR(void, resource,
298 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
300 /* Copy the Vendor Data */
302 source = ACPI_ADD_PTR(void, aml, info->value);
303 acpi_rs_move_data(target, source, item_count,
307 case ACPI_RSC_MOVE_SERIAL_RES:
309 /* Generate and set the resource_source string pointer */
311 target = (char *)ACPI_ADD_PTR(void, resource,
314 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
316 /* Copy the resource_source string */
319 ACPI_ADD_PTR(void, aml,
320 (ACPI_GET16(source) + info->value));
321 acpi_rs_move_data(target, source, item_count,
327 ACPI_MEMSET(destination, info->aml_offset, info->value);
332 target = ACPI_ADD_PTR(char, resource, info->value);
333 ACPI_MEMCPY(destination, source, ACPI_GET16(target));
336 case ACPI_RSC_ADDRESS:
338 * Common handler for address descriptor flags
340 if (!acpi_rs_get_address_common(resource, aml)) {
342 (AE_AML_INVALID_RESOURCE_TYPE);
346 case ACPI_RSC_SOURCE:
348 * Optional resource_source (Index and String)
351 acpi_rs_get_resource_source(aml_resource_length,
353 destination, aml, NULL);
356 case ACPI_RSC_SOURCEX:
358 * Optional resource_source (Index and String). This is the more
359 * complicated case used by the Interrupt() macro
361 target = ACPI_ADD_PTR(char, resource,
366 acpi_rs_get_resource_source(aml_resource_length,
375 case ACPI_RSC_BITMASK:
377 * 8-bit encoded bitmask (DMA macro)
380 acpi_rs_decode_bitmask(ACPI_GET8(source),
383 resource->length += (item_count - 1);
386 target = ACPI_ADD_PTR(char, resource, info->value);
387 ACPI_SET8(target, item_count);
390 case ACPI_RSC_BITMASK16:
392 * 16-bit encoded bitmask (IRQ macro)
394 ACPI_MOVE_16_TO_16(&temp16, source);
397 acpi_rs_decode_bitmask(temp16, destination);
399 resource->length += (item_count - 1);
402 target = ACPI_ADD_PTR(char, resource, info->value);
403 ACPI_SET8(target, item_count);
406 case ACPI_RSC_EXIT_NE:
408 * control - Exit conversion if not equal
410 switch (info->resource_offset) {
411 case ACPI_RSC_COMPARE_AML_LENGTH:
413 if (aml_resource_length != info->value) {
418 case ACPI_RSC_COMPARE_VALUE:
420 if (ACPI_GET8(source) != info->value) {
428 "Invalid conversion sub-opcode"));
429 return_ACPI_STATUS(AE_BAD_PARAMETER);
435 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
436 return_ACPI_STATUS(AE_BAD_PARAMETER);
446 /* Round the resource struct length up to the next boundary (32 or 64) */
449 (u32) ACPI_ROUND_UP_TO_NATIVE_WORD(resource->length);
451 return_ACPI_STATUS(AE_OK);
454 /*******************************************************************************
456 * FUNCTION: acpi_rs_convert_resource_to_aml
458 * PARAMETERS: resource - Pointer to the resource descriptor
459 * aml - Where the AML descriptor is returned
460 * info - Pointer to appropriate conversion table
464 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
465 * external AML resource descriptor.
467 ******************************************************************************/
470 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
471 union aml_resource *aml,
472 struct acpi_rsconvert_info *info)
477 acpi_rsdesc_size aml_length = 0;
482 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
485 return_ACPI_STATUS(AE_BAD_PARAMETER);
489 * First table entry must be ACPI_RSC_INITxxx and must contain the
490 * table length (# of table entries)
492 count = INIT_TABLE_LENGTH(info);
496 * Source is the internal resource descriptor,
497 * destination is the external AML byte stream buffer
499 source = ACPI_ADD_PTR(void, resource, info->resource_offset);
500 destination = ACPI_ADD_PTR(void, aml, info->aml_offset);
502 switch (info->opcode) {
503 case ACPI_RSC_INITSET:
505 ACPI_MEMSET(aml, 0, INIT_RESOURCE_LENGTH(info));
506 aml_length = INIT_RESOURCE_LENGTH(info);
507 acpi_rs_set_resource_header(INIT_RESOURCE_TYPE(info),
511 case ACPI_RSC_INITGET:
514 case ACPI_RSC_FLAGINIT:
516 * Clear the flag byte
518 ACPI_SET8(destination, 0);
521 case ACPI_RSC_1BITFLAG:
523 * Mask and shift the flag bit
525 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
526 ((ACPI_GET8(source) & 0x01) << info->
530 case ACPI_RSC_2BITFLAG:
532 * Mask and shift the flag bits
534 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
535 ((ACPI_GET8(source) & 0x03) << info->
539 case ACPI_RSC_3BITFLAG:
541 * Mask and shift the flag bits
543 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
544 ((ACPI_GET8(source) & 0x07) << info->
550 item_count = ACPI_GET8(source);
551 ACPI_SET8(destination, item_count);
555 (info->value * (item_count - 1)));
558 case ACPI_RSC_COUNT16:
560 item_count = ACPI_GET16(source);
561 aml_length = (u16) (aml_length + item_count);
562 acpi_rs_set_resource_length(aml_length, aml);
565 case ACPI_RSC_COUNT_GPIO_PIN:
567 item_count = ACPI_GET16(source);
568 ACPI_SET16(destination, aml_length);
570 aml_length = (u16)(aml_length + item_count * 2);
571 target = ACPI_ADD_PTR(void, aml, info->value);
572 ACPI_SET16(target, aml_length);
573 acpi_rs_set_resource_length(aml_length, aml);
576 case ACPI_RSC_COUNT_GPIO_VEN:
578 item_count = ACPI_GET16(source);
579 ACPI_SET16(destination, item_count);
582 (u16)(aml_length + (info->value * item_count));
583 acpi_rs_set_resource_length(aml_length, aml);
586 case ACPI_RSC_COUNT_GPIO_RES:
588 /* Set resource source string length */
590 item_count = ACPI_GET16(source);
591 ACPI_SET16(destination, aml_length);
593 /* Compute offset for the Vendor Data */
595 aml_length = (u16)(aml_length + item_count);
596 target = ACPI_ADD_PTR(void, aml, info->value);
598 /* Set vendor offset only if there is vendor data */
600 if (resource->data.gpio.vendor_length) {
601 ACPI_SET16(target, aml_length);
604 acpi_rs_set_resource_length(aml_length, aml);
607 case ACPI_RSC_COUNT_SERIAL_VEN:
609 item_count = ACPI_GET16(source);
610 ACPI_SET16(destination, item_count + info->value);
611 aml_length = (u16)(aml_length + item_count);
612 acpi_rs_set_resource_length(aml_length, aml);
615 case ACPI_RSC_COUNT_SERIAL_RES:
617 item_count = ACPI_GET16(source);
618 aml_length = (u16)(aml_length + item_count);
619 acpi_rs_set_resource_length(aml_length, aml);
622 case ACPI_RSC_LENGTH:
624 acpi_rs_set_resource_length(info->value, aml);
628 case ACPI_RSC_MOVE16:
629 case ACPI_RSC_MOVE32:
630 case ACPI_RSC_MOVE64:
633 item_count = info->value;
635 acpi_rs_move_data(destination, source, item_count,
639 case ACPI_RSC_MOVE_GPIO_PIN:
641 destination = (char *)ACPI_ADD_PTR(void, aml,
644 source = *(u16 **)source;
645 acpi_rs_move_data(destination, source, item_count,
649 case ACPI_RSC_MOVE_GPIO_RES:
651 /* Used for both resource_source string and vendor_data */
653 destination = (char *)ACPI_ADD_PTR(void, aml,
656 source = *(u8 **)source;
657 acpi_rs_move_data(destination, source, item_count,
661 case ACPI_RSC_MOVE_SERIAL_VEN:
663 destination = (char *)ACPI_ADD_PTR(void, aml,
666 source = *(u8 **)source;
667 acpi_rs_move_data(destination, source, item_count,
671 case ACPI_RSC_MOVE_SERIAL_RES:
673 destination = (char *)ACPI_ADD_PTR(void, aml,
676 source = *(u8 **)source;
677 acpi_rs_move_data(destination, source, item_count,
681 case ACPI_RSC_ADDRESS:
683 /* Set the Resource Type, General Flags, and Type-Specific Flags */
685 acpi_rs_set_address_common(aml, resource);
688 case ACPI_RSC_SOURCEX:
690 * Optional resource_source (Index and String)
693 acpi_rs_set_resource_source(aml,
696 acpi_rs_set_resource_length(aml_length, aml);
699 case ACPI_RSC_SOURCE:
701 * Optional resource_source (Index and String). This is the more
702 * complicated case used by the Interrupt() macro
705 acpi_rs_set_resource_source(aml, info->value,
707 acpi_rs_set_resource_length(aml_length, aml);
710 case ACPI_RSC_BITMASK:
712 * 8-bit encoded bitmask (DMA macro)
714 ACPI_SET8(destination,
715 acpi_rs_encode_bitmask(source,
722 case ACPI_RSC_BITMASK16:
724 * 16-bit encoded bitmask (IRQ macro)
726 temp16 = acpi_rs_encode_bitmask(source,
731 ACPI_MOVE_16_TO_16(destination, &temp16);
734 case ACPI_RSC_EXIT_LE:
736 * control - Exit conversion if less than or equal
738 if (item_count <= info->value) {
743 case ACPI_RSC_EXIT_NE:
745 * control - Exit conversion if not equal
747 switch (COMPARE_OPCODE(info)) {
748 case ACPI_RSC_COMPARE_VALUE:
750 if (*ACPI_ADD_PTR(u8, resource,
751 COMPARE_TARGET(info)) !=
752 COMPARE_VALUE(info)) {
760 "Invalid conversion sub-opcode"));
761 return_ACPI_STATUS(AE_BAD_PARAMETER);
765 case ACPI_RSC_EXIT_EQ:
767 * control - Exit conversion if equal
769 if (*ACPI_ADD_PTR(u8, resource,
770 COMPARE_TARGET(info)) ==
771 COMPARE_VALUE(info)) {
778 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
779 return_ACPI_STATUS(AE_BAD_PARAMETER);
787 return_ACPI_STATUS(AE_OK);
791 /* Previous resource validations */
793 if (aml->ext_address64.revision_ID != AML_RESOURCE_EXTENDED_ADDRESS_REVISION) {
794 return_ACPI_STATUS(AE_SUPPORT);
797 if (resource->data.start_dpf.performance_robustness >= 3) {
798 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_VALUE);
801 if (((aml->irq.flags & 0x09) == 0x00) || ((aml->irq.flags & 0x09) == 0x09)) {
803 * Only [active_high, edge_sensitive] or [active_low, level_sensitive]
804 * polarity/trigger interrupts are allowed (ACPI spec, section
805 * "IRQ Format"), so 0x00 and 0x09 are illegal.
808 "Invalid interrupt polarity/trigger in resource list, 0x%X",
810 return_ACPI_STATUS(AE_BAD_DATA);
813 resource->data.extended_irq.interrupt_count = temp8;
816 /* Must have at least one IRQ */
818 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
821 if (resource->data.dma.transfer == 0x03) {
822 ACPI_ERROR((AE_INFO, "Invalid DMA.Transfer preference (3)"));
823 return_ACPI_STATUS(AE_BAD_DATA);