1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: rsmisc - Miscellaneous resource descriptors
6 ******************************************************************************/
12 #define _COMPONENT ACPI_RESOURCES
13 ACPI_MODULE_NAME("rsmisc")
14 #define INIT_RESOURCE_TYPE(i) i->resource_offset
15 #define INIT_RESOURCE_LENGTH(i) i->aml_offset
16 #define INIT_TABLE_LENGTH(i) i->value
17 #define COMPARE_OPCODE(i) i->resource_offset
18 #define COMPARE_TARGET(i) i->aml_offset
19 #define COMPARE_VALUE(i) i->value
20 /*******************************************************************************
22 * FUNCTION: acpi_rs_convert_aml_to_resource
24 * PARAMETERS: resource - Pointer to the resource descriptor
25 * aml - Where the AML descriptor is returned
26 * info - Pointer to appropriate conversion table
30 * DESCRIPTION: Convert an external AML resource descriptor to the corresponding
31 * internal resource descriptor
33 ******************************************************************************/
35 acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
36 union aml_resource *aml,
37 struct acpi_rsconvert_info *info)
39 acpi_rs_length aml_resource_length;
44 u8 flags_mode = FALSE;
48 ACPI_FUNCTION_TRACE(rs_convert_aml_to_resource);
51 return_ACPI_STATUS(AE_BAD_PARAMETER);
54 if (((acpi_size)resource) & 0x3) {
56 /* Each internal resource struct is expected to be 32-bit aligned */
58 ACPI_WARNING((AE_INFO,
59 "Misaligned resource pointer (get): %p Type 0x%2.2X Length %u",
60 resource, resource->type, resource->length));
63 /* Extract the resource Length field (does not include header length) */
65 aml_resource_length = acpi_ut_get_resource_length(aml);
68 * First table entry must be ACPI_RSC_INITxxx and must contain the
69 * table length (# of table entries)
71 count = INIT_TABLE_LENGTH(info);
76 * Source is the external AML byte stream buffer,
77 * destination is the internal resource descriptor
79 source = ACPI_ADD_PTR(void, aml, info->aml_offset);
81 ACPI_ADD_PTR(void, resource, info->resource_offset);
83 switch (info->opcode) {
84 case ACPI_RSC_INITGET:
86 * Get the resource type and the initial (minimum) length
88 memset(resource, 0, INIT_RESOURCE_LENGTH(info));
89 resource->type = INIT_RESOURCE_TYPE(info);
90 resource->length = INIT_RESOURCE_LENGTH(info);
93 case ACPI_RSC_INITSET:
96 case ACPI_RSC_FLAGINIT:
101 case ACPI_RSC_1BITFLAG:
103 * Mask and shift the flag bit
105 ACPI_SET8(destination,
106 ((ACPI_GET8(source) >> info->value) & 0x01));
109 case ACPI_RSC_2BITFLAG:
111 * Mask and shift the flag bits
113 ACPI_SET8(destination,
114 ((ACPI_GET8(source) >> info->value) & 0x03));
117 case ACPI_RSC_3BITFLAG:
119 * Mask and shift the flag bits
121 ACPI_SET8(destination,
122 ((ACPI_GET8(source) >> info->value) & 0x07));
125 case ACPI_RSC_6BITFLAG:
127 * Mask and shift the flag bits
129 ACPI_SET8(destination,
130 ((ACPI_GET8(source) >> info->value) & 0x3F));
135 item_count = ACPI_GET8(source);
136 ACPI_SET8(destination, item_count);
138 resource->length = resource->length +
139 (info->value * (item_count - 1));
142 case ACPI_RSC_COUNT16:
144 item_count = aml_resource_length;
145 ACPI_SET16(destination, item_count);
147 resource->length = resource->length +
148 (info->value * (item_count - 1));
151 case ACPI_RSC_COUNT_GPIO_PIN:
153 target = ACPI_ADD_PTR(void, aml, info->value);
154 item_count = ACPI_GET16(target) - ACPI_GET16(source);
156 resource->length = resource->length + item_count;
157 item_count = item_count / 2;
158 ACPI_SET16(destination, item_count);
161 case ACPI_RSC_COUNT_GPIO_VEN:
163 item_count = ACPI_GET8(source);
164 ACPI_SET8(destination, item_count);
167 resource->length + (info->value * item_count);
170 case ACPI_RSC_COUNT_GPIO_RES:
172 * Vendor data is optional (length/offset may both be zero)
173 * Examine vendor data length field first
175 target = ACPI_ADD_PTR(void, aml, (info->value + 2));
176 if (ACPI_GET16(target)) {
178 /* Use vendor offset to get resource source length */
180 target = ACPI_ADD_PTR(void, aml, info->value);
182 ACPI_GET16(target) - ACPI_GET16(source);
184 /* No vendor data to worry about */
186 item_count = aml->large_header.resource_length +
187 sizeof(struct aml_resource_large_header) -
191 resource->length = resource->length + item_count;
192 ACPI_SET16(destination, item_count);
195 case ACPI_RSC_COUNT_SERIAL_VEN:
197 item_count = ACPI_GET16(source) - info->value;
199 resource->length = resource->length + item_count;
200 ACPI_SET16(destination, item_count);
203 case ACPI_RSC_COUNT_SERIAL_RES:
205 item_count = (aml_resource_length +
206 sizeof(struct aml_resource_large_header))
207 - ACPI_GET16(source) - info->value;
209 resource->length = resource->length + item_count;
210 ACPI_SET16(destination, item_count);
213 case ACPI_RSC_LENGTH:
215 resource->length = resource->length + info->value;
219 case ACPI_RSC_MOVE16:
220 case ACPI_RSC_MOVE32:
221 case ACPI_RSC_MOVE64:
223 * Raw data move. Use the Info value field unless item_count has
224 * been previously initialized via a COUNT opcode
227 item_count = info->value;
229 acpi_rs_move_data(destination, source, item_count,
233 case ACPI_RSC_MOVE_GPIO_PIN:
235 /* Generate and set the PIN data pointer */
237 target = (char *)ACPI_ADD_PTR(void, resource,
240 *(u16 **)destination = ACPI_CAST_PTR(u16, target);
242 /* Copy the PIN data */
244 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
245 acpi_rs_move_data(target, source, item_count,
249 case ACPI_RSC_MOVE_GPIO_RES:
251 /* Generate and set the resource_source string pointer */
253 target = (char *)ACPI_ADD_PTR(void, resource,
256 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
258 /* Copy the resource_source string */
260 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
261 acpi_rs_move_data(target, source, item_count,
265 case ACPI_RSC_MOVE_SERIAL_VEN:
267 /* Generate and set the Vendor Data pointer */
269 target = (char *)ACPI_ADD_PTR(void, resource,
272 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
274 /* Copy the Vendor Data */
276 source = ACPI_ADD_PTR(void, aml, info->value);
277 acpi_rs_move_data(target, source, item_count,
281 case ACPI_RSC_MOVE_SERIAL_RES:
283 /* Generate and set the resource_source string pointer */
285 target = (char *)ACPI_ADD_PTR(void, resource,
288 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
290 /* Copy the resource_source string */
293 ACPI_ADD_PTR(void, aml,
294 (ACPI_GET16(source) + info->value));
295 acpi_rs_move_data(target, source, item_count,
301 memset(destination, info->aml_offset, info->value);
306 target = ACPI_ADD_PTR(char, resource, info->value);
307 memcpy(destination, source, ACPI_GET16(target));
310 case ACPI_RSC_ADDRESS:
312 * Common handler for address descriptor flags
314 if (!acpi_rs_get_address_common(resource, aml)) {
316 (AE_AML_INVALID_RESOURCE_TYPE);
320 case ACPI_RSC_SOURCE:
322 * Optional resource_source (Index and String)
325 acpi_rs_get_resource_source(aml_resource_length,
327 destination, aml, NULL);
330 case ACPI_RSC_SOURCEX:
332 * Optional resource_source (Index and String). This is the more
333 * complicated case used by the Interrupt() macro
335 target = ACPI_ADD_PTR(char, resource,
340 acpi_rs_get_resource_source(aml_resource_length,
349 case ACPI_RSC_BITMASK:
351 * 8-bit encoded bitmask (DMA macro)
354 acpi_rs_decode_bitmask(ACPI_GET8(source),
357 resource->length += (item_count - 1);
360 target = ACPI_ADD_PTR(char, resource, info->value);
361 ACPI_SET8(target, item_count);
364 case ACPI_RSC_BITMASK16:
366 * 16-bit encoded bitmask (IRQ macro)
368 ACPI_MOVE_16_TO_16(&temp16, source);
371 acpi_rs_decode_bitmask(temp16, destination);
373 resource->length += (item_count - 1);
376 target = ACPI_ADD_PTR(char, resource, info->value);
377 ACPI_SET8(target, item_count);
380 case ACPI_RSC_EXIT_NE:
382 * control - Exit conversion if not equal
384 switch (info->resource_offset) {
385 case ACPI_RSC_COMPARE_AML_LENGTH:
387 if (aml_resource_length != info->value) {
392 case ACPI_RSC_COMPARE_VALUE:
394 if (ACPI_GET8(source) != info->value) {
402 "Invalid conversion sub-opcode"));
403 return_ACPI_STATUS(AE_BAD_PARAMETER);
409 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
410 return_ACPI_STATUS(AE_BAD_PARAMETER);
420 /* Round the resource struct length up to the next boundary (32 or 64) */
422 resource->length = (u32)
423 ACPI_ROUND_UP_TO_NATIVE_WORD(resource->length);
425 return_ACPI_STATUS(AE_OK);
428 /*******************************************************************************
430 * FUNCTION: acpi_rs_convert_resource_to_aml
432 * PARAMETERS: resource - Pointer to the resource descriptor
433 * aml - Where the AML descriptor is returned
434 * info - Pointer to appropriate conversion table
438 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
439 * external AML resource descriptor.
441 ******************************************************************************/
444 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
445 union aml_resource *aml,
446 struct acpi_rsconvert_info *info)
451 acpi_rsdesc_size aml_length = 0;
456 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
459 return_ACPI_STATUS(AE_BAD_PARAMETER);
463 * First table entry must be ACPI_RSC_INITxxx and must contain the
464 * table length (# of table entries)
466 count = INIT_TABLE_LENGTH(info);
470 * Source is the internal resource descriptor,
471 * destination is the external AML byte stream buffer
473 source = ACPI_ADD_PTR(void, resource, info->resource_offset);
474 destination = ACPI_ADD_PTR(void, aml, info->aml_offset);
476 switch (info->opcode) {
477 case ACPI_RSC_INITSET:
479 memset(aml, 0, INIT_RESOURCE_LENGTH(info));
480 aml_length = INIT_RESOURCE_LENGTH(info);
481 acpi_rs_set_resource_header(INIT_RESOURCE_TYPE(info),
485 case ACPI_RSC_INITGET:
488 case ACPI_RSC_FLAGINIT:
490 * Clear the flag byte
492 ACPI_SET8(destination, 0);
495 case ACPI_RSC_1BITFLAG:
497 * Mask and shift the flag bit
499 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
500 ((ACPI_GET8(source) & 0x01) << info->
504 case ACPI_RSC_2BITFLAG:
506 * Mask and shift the flag bits
508 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
509 ((ACPI_GET8(source) & 0x03) << info->
513 case ACPI_RSC_3BITFLAG:
515 * Mask and shift the flag bits
517 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
518 ((ACPI_GET8(source) & 0x07) << info->
522 case ACPI_RSC_6BITFLAG:
524 * Mask and shift the flag bits
526 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
527 ((ACPI_GET8(source) & 0x3F) << info->
533 item_count = ACPI_GET8(source);
534 ACPI_SET8(destination, item_count);
537 (aml_length + (info->value * (item_count - 1)));
540 case ACPI_RSC_COUNT16:
542 item_count = ACPI_GET16(source);
543 aml_length = (u16) (aml_length + item_count);
544 acpi_rs_set_resource_length(aml_length, aml);
547 case ACPI_RSC_COUNT_GPIO_PIN:
549 item_count = ACPI_GET16(source);
550 ACPI_SET16(destination, aml_length);
552 aml_length = (u16)(aml_length + item_count * 2);
553 target = ACPI_ADD_PTR(void, aml, info->value);
554 ACPI_SET16(target, aml_length);
555 acpi_rs_set_resource_length(aml_length, aml);
558 case ACPI_RSC_COUNT_GPIO_VEN:
560 item_count = ACPI_GET16(source);
561 ACPI_SET16(destination, item_count);
564 (u16)(aml_length + (info->value * item_count));
565 acpi_rs_set_resource_length(aml_length, aml);
568 case ACPI_RSC_COUNT_GPIO_RES:
570 /* Set resource source string length */
572 item_count = ACPI_GET16(source);
573 ACPI_SET16(destination, aml_length);
575 /* Compute offset for the Vendor Data */
577 aml_length = (u16)(aml_length + item_count);
578 target = ACPI_ADD_PTR(void, aml, info->value);
580 /* Set vendor offset only if there is vendor data */
582 ACPI_SET16(target, aml_length);
584 acpi_rs_set_resource_length(aml_length, aml);
587 case ACPI_RSC_COUNT_SERIAL_VEN:
589 item_count = ACPI_GET16(source);
590 ACPI_SET16(destination, item_count + info->value);
591 aml_length = (u16)(aml_length + item_count);
592 acpi_rs_set_resource_length(aml_length, aml);
595 case ACPI_RSC_COUNT_SERIAL_RES:
597 item_count = ACPI_GET16(source);
598 aml_length = (u16)(aml_length + item_count);
599 acpi_rs_set_resource_length(aml_length, aml);
602 case ACPI_RSC_LENGTH:
604 acpi_rs_set_resource_length(info->value, aml);
608 case ACPI_RSC_MOVE16:
609 case ACPI_RSC_MOVE32:
610 case ACPI_RSC_MOVE64:
613 item_count = info->value;
615 acpi_rs_move_data(destination, source, item_count,
619 case ACPI_RSC_MOVE_GPIO_PIN:
621 destination = (char *)ACPI_ADD_PTR(void, aml,
624 source = *(u16 **)source;
625 acpi_rs_move_data(destination, source, item_count,
629 case ACPI_RSC_MOVE_GPIO_RES:
631 /* Used for both resource_source string and vendor_data */
633 destination = (char *)ACPI_ADD_PTR(void, aml,
636 source = *(u8 **)source;
637 acpi_rs_move_data(destination, source, item_count,
641 case ACPI_RSC_MOVE_SERIAL_VEN:
643 destination = (char *)ACPI_ADD_PTR(void, aml,
646 source = *(u8 **)source;
647 acpi_rs_move_data(destination, source, item_count,
651 case ACPI_RSC_MOVE_SERIAL_RES:
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_ADDRESS:
663 /* Set the Resource Type, General Flags, and Type-Specific Flags */
665 acpi_rs_set_address_common(aml, resource);
668 case ACPI_RSC_SOURCEX:
670 * Optional resource_source (Index and String)
673 acpi_rs_set_resource_source(aml,
676 acpi_rs_set_resource_length(aml_length, aml);
679 case ACPI_RSC_SOURCE:
681 * Optional resource_source (Index and String). This is the more
682 * complicated case used by the Interrupt() macro
685 acpi_rs_set_resource_source(aml, info->value,
687 acpi_rs_set_resource_length(aml_length, aml);
690 case ACPI_RSC_BITMASK:
692 * 8-bit encoded bitmask (DMA macro)
694 ACPI_SET8(destination,
695 acpi_rs_encode_bitmask(source,
702 case ACPI_RSC_BITMASK16:
704 * 16-bit encoded bitmask (IRQ macro)
707 acpi_rs_encode_bitmask(source,
708 *ACPI_ADD_PTR(u8, resource,
710 ACPI_MOVE_16_TO_16(destination, &temp16);
713 case ACPI_RSC_EXIT_LE:
715 * control - Exit conversion if less than or equal
717 if (item_count <= info->value) {
722 case ACPI_RSC_EXIT_NE:
724 * control - Exit conversion if not equal
726 switch (COMPARE_OPCODE(info)) {
727 case ACPI_RSC_COMPARE_VALUE:
729 if (*ACPI_ADD_PTR(u8, resource,
730 COMPARE_TARGET(info)) !=
731 COMPARE_VALUE(info)) {
739 "Invalid conversion sub-opcode"));
740 return_ACPI_STATUS(AE_BAD_PARAMETER);
744 case ACPI_RSC_EXIT_EQ:
746 * control - Exit conversion if equal
748 if (*ACPI_ADD_PTR(u8, resource,
749 COMPARE_TARGET(info)) ==
750 COMPARE_VALUE(info)) {
757 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
758 return_ACPI_STATUS(AE_BAD_PARAMETER);
766 return_ACPI_STATUS(AE_OK);
770 /* Previous resource validations */
772 if (aml->ext_address64.revision_ID != AML_RESOURCE_EXTENDED_ADDRESS_REVISION) {
773 return_ACPI_STATUS(AE_SUPPORT);
776 if (resource->data.start_dpf.performance_robustness >= 3) {
777 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_VALUE);
780 if (((aml->irq.flags & 0x09) == 0x00) || ((aml->irq.flags & 0x09) == 0x09)) {
782 * Only [active_high, edge_sensitive] or [active_low, level_sensitive]
783 * polarity/trigger interrupts are allowed (ACPI spec, section
784 * "IRQ Format"), so 0x00 and 0x09 are illegal.
787 "Invalid interrupt polarity/trigger in resource list, 0x%X",
789 return_ACPI_STATUS(AE_BAD_DATA);
792 resource->data.extended_irq.interrupt_count = temp8;
795 /* Must have at least one IRQ */
797 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
800 if (resource->data.dma.transfer == 0x03) {
801 ACPI_ERROR((AE_INFO, "Invalid DMA.Transfer preference (3)"));
802 return_ACPI_STATUS(AE_BAD_DATA);