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);
74 * Source is the external AML byte stream buffer,
75 * destination is the internal resource descriptor
77 source = ACPI_ADD_PTR(void, aml, info->aml_offset);
79 ACPI_ADD_PTR(void, resource, info->resource_offset);
81 switch (info->opcode) {
82 case ACPI_RSC_INITGET:
84 * Get the resource type and the initial (minimum) length
86 memset(resource, 0, INIT_RESOURCE_LENGTH(info));
87 resource->type = INIT_RESOURCE_TYPE(info);
88 resource->length = INIT_RESOURCE_LENGTH(info);
91 case ACPI_RSC_INITSET:
94 case ACPI_RSC_FLAGINIT:
99 case ACPI_RSC_1BITFLAG:
101 * Mask and shift the flag bit
103 ACPI_SET8(destination,
104 ((ACPI_GET8(source) >> info->value) & 0x01));
107 case ACPI_RSC_2BITFLAG:
109 * Mask and shift the flag bits
111 ACPI_SET8(destination,
112 ((ACPI_GET8(source) >> info->value) & 0x03));
115 case ACPI_RSC_3BITFLAG:
117 * Mask and shift the flag bits
119 ACPI_SET8(destination,
120 ((ACPI_GET8(source) >> info->value) & 0x07));
125 item_count = ACPI_GET8(source);
126 ACPI_SET8(destination, item_count);
128 resource->length = resource->length +
129 (info->value * (item_count - 1));
132 case ACPI_RSC_COUNT16:
134 item_count = aml_resource_length;
135 ACPI_SET16(destination, item_count);
137 resource->length = resource->length +
138 (info->value * (item_count - 1));
141 case ACPI_RSC_COUNT_GPIO_PIN:
143 target = ACPI_ADD_PTR(void, aml, info->value);
144 item_count = ACPI_GET16(target) - ACPI_GET16(source);
146 resource->length = resource->length + item_count;
147 item_count = item_count / 2;
148 ACPI_SET16(destination, item_count);
151 case ACPI_RSC_COUNT_GPIO_VEN:
153 item_count = ACPI_GET8(source);
154 ACPI_SET8(destination, item_count);
157 resource->length + (info->value * item_count);
160 case ACPI_RSC_COUNT_GPIO_RES:
162 * Vendor data is optional (length/offset may both be zero)
163 * Examine vendor data length field first
165 target = ACPI_ADD_PTR(void, aml, (info->value + 2));
166 if (ACPI_GET16(target)) {
168 /* Use vendor offset to get resource source length */
170 target = ACPI_ADD_PTR(void, aml, info->value);
172 ACPI_GET16(target) - ACPI_GET16(source);
174 /* No vendor data to worry about */
176 item_count = aml->large_header.resource_length +
177 sizeof(struct aml_resource_large_header) -
181 resource->length = resource->length + item_count;
182 ACPI_SET16(destination, item_count);
185 case ACPI_RSC_COUNT_SERIAL_VEN:
187 item_count = ACPI_GET16(source) - info->value;
189 resource->length = resource->length + item_count;
190 ACPI_SET16(destination, item_count);
193 case ACPI_RSC_COUNT_SERIAL_RES:
195 item_count = (aml_resource_length +
196 sizeof(struct aml_resource_large_header))
197 - ACPI_GET16(source) - info->value;
199 resource->length = resource->length + item_count;
200 ACPI_SET16(destination, item_count);
203 case ACPI_RSC_LENGTH:
205 resource->length = resource->length + info->value;
209 case ACPI_RSC_MOVE16:
210 case ACPI_RSC_MOVE32:
211 case ACPI_RSC_MOVE64:
213 * Raw data move. Use the Info value field unless item_count has
214 * been previously initialized via a COUNT opcode
217 item_count = info->value;
219 acpi_rs_move_data(destination, source, item_count,
223 case ACPI_RSC_MOVE_GPIO_PIN:
225 /* Generate and set the PIN data pointer */
227 target = (char *)ACPI_ADD_PTR(void, resource,
230 *(u16 **)destination = ACPI_CAST_PTR(u16, target);
232 /* Copy the PIN data */
234 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
235 acpi_rs_move_data(target, source, item_count,
239 case ACPI_RSC_MOVE_GPIO_RES:
241 /* Generate and set the resource_source string pointer */
243 target = (char *)ACPI_ADD_PTR(void, resource,
246 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
248 /* Copy the resource_source string */
250 source = ACPI_ADD_PTR(void, aml, ACPI_GET16(source));
251 acpi_rs_move_data(target, source, item_count,
255 case ACPI_RSC_MOVE_SERIAL_VEN:
257 /* Generate and set the Vendor Data pointer */
259 target = (char *)ACPI_ADD_PTR(void, resource,
262 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
264 /* Copy the Vendor Data */
266 source = ACPI_ADD_PTR(void, aml, info->value);
267 acpi_rs_move_data(target, source, item_count,
271 case ACPI_RSC_MOVE_SERIAL_RES:
273 /* Generate and set the resource_source string pointer */
275 target = (char *)ACPI_ADD_PTR(void, resource,
278 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
280 /* Copy the resource_source string */
283 ACPI_ADD_PTR(void, aml,
284 (ACPI_GET16(source) + info->value));
285 acpi_rs_move_data(target, source, item_count,
291 memset(destination, info->aml_offset, info->value);
296 target = ACPI_ADD_PTR(char, resource, info->value);
297 memcpy(destination, source, ACPI_GET16(target));
300 case ACPI_RSC_ADDRESS:
302 * Common handler for address descriptor flags
304 if (!acpi_rs_get_address_common(resource, aml)) {
306 (AE_AML_INVALID_RESOURCE_TYPE);
310 case ACPI_RSC_SOURCE:
312 * Optional resource_source (Index and String)
315 acpi_rs_get_resource_source(aml_resource_length,
317 destination, aml, NULL);
320 case ACPI_RSC_SOURCEX:
322 * Optional resource_source (Index and String). This is the more
323 * complicated case used by the Interrupt() macro
325 target = ACPI_ADD_PTR(char, resource,
330 acpi_rs_get_resource_source(aml_resource_length,
339 case ACPI_RSC_BITMASK:
341 * 8-bit encoded bitmask (DMA macro)
344 acpi_rs_decode_bitmask(ACPI_GET8(source),
347 resource->length += (item_count - 1);
350 target = ACPI_ADD_PTR(char, resource, info->value);
351 ACPI_SET8(target, item_count);
354 case ACPI_RSC_BITMASK16:
356 * 16-bit encoded bitmask (IRQ macro)
358 ACPI_MOVE_16_TO_16(&temp16, source);
361 acpi_rs_decode_bitmask(temp16, destination);
363 resource->length += (item_count - 1);
366 target = ACPI_ADD_PTR(char, resource, info->value);
367 ACPI_SET8(target, item_count);
370 case ACPI_RSC_EXIT_NE:
372 * control - Exit conversion if not equal
374 switch (info->resource_offset) {
375 case ACPI_RSC_COMPARE_AML_LENGTH:
377 if (aml_resource_length != info->value) {
382 case ACPI_RSC_COMPARE_VALUE:
384 if (ACPI_GET8(source) != info->value) {
392 "Invalid conversion sub-opcode"));
393 return_ACPI_STATUS(AE_BAD_PARAMETER);
399 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
400 return_ACPI_STATUS(AE_BAD_PARAMETER);
410 /* Round the resource struct length up to the next boundary (32 or 64) */
412 resource->length = (u32)
413 ACPI_ROUND_UP_TO_NATIVE_WORD(resource->length);
415 return_ACPI_STATUS(AE_OK);
418 /*******************************************************************************
420 * FUNCTION: acpi_rs_convert_resource_to_aml
422 * PARAMETERS: resource - Pointer to the resource descriptor
423 * aml - Where the AML descriptor is returned
424 * info - Pointer to appropriate conversion table
428 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
429 * external AML resource descriptor.
431 ******************************************************************************/
434 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
435 union aml_resource *aml,
436 struct acpi_rsconvert_info *info)
441 acpi_rsdesc_size aml_length = 0;
446 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
449 return_ACPI_STATUS(AE_BAD_PARAMETER);
453 * First table entry must be ACPI_RSC_INITxxx and must contain the
454 * table length (# of table entries)
456 count = INIT_TABLE_LENGTH(info);
460 * Source is the internal resource descriptor,
461 * destination is the external AML byte stream buffer
463 source = ACPI_ADD_PTR(void, resource, info->resource_offset);
464 destination = ACPI_ADD_PTR(void, aml, info->aml_offset);
466 switch (info->opcode) {
467 case ACPI_RSC_INITSET:
469 memset(aml, 0, INIT_RESOURCE_LENGTH(info));
470 aml_length = INIT_RESOURCE_LENGTH(info);
471 acpi_rs_set_resource_header(INIT_RESOURCE_TYPE(info),
475 case ACPI_RSC_INITGET:
478 case ACPI_RSC_FLAGINIT:
480 * Clear the flag byte
482 ACPI_SET8(destination, 0);
485 case ACPI_RSC_1BITFLAG:
487 * Mask and shift the flag bit
489 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
490 ((ACPI_GET8(source) & 0x01) << info->
494 case ACPI_RSC_2BITFLAG:
496 * Mask and shift the flag bits
498 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
499 ((ACPI_GET8(source) & 0x03) << info->
503 case ACPI_RSC_3BITFLAG:
505 * Mask and shift the flag bits
507 ACPI_SET_BIT(*ACPI_CAST8(destination), (u8)
508 ((ACPI_GET8(source) & 0x07) << info->
514 item_count = ACPI_GET8(source);
515 ACPI_SET8(destination, item_count);
518 (aml_length + (info->value * (item_count - 1)));
521 case ACPI_RSC_COUNT16:
523 item_count = ACPI_GET16(source);
524 aml_length = (u16) (aml_length + item_count);
525 acpi_rs_set_resource_length(aml_length, aml);
528 case ACPI_RSC_COUNT_GPIO_PIN:
530 item_count = ACPI_GET16(source);
531 ACPI_SET16(destination, aml_length);
533 aml_length = (u16)(aml_length + item_count * 2);
534 target = ACPI_ADD_PTR(void, aml, info->value);
535 ACPI_SET16(target, aml_length);
536 acpi_rs_set_resource_length(aml_length, aml);
539 case ACPI_RSC_COUNT_GPIO_VEN:
541 item_count = ACPI_GET16(source);
542 ACPI_SET16(destination, item_count);
545 (u16)(aml_length + (info->value * item_count));
546 acpi_rs_set_resource_length(aml_length, aml);
549 case ACPI_RSC_COUNT_GPIO_RES:
551 /* Set resource source string length */
553 item_count = ACPI_GET16(source);
554 ACPI_SET16(destination, aml_length);
556 /* Compute offset for the Vendor Data */
558 aml_length = (u16)(aml_length + item_count);
559 target = ACPI_ADD_PTR(void, aml, info->value);
561 /* Set vendor offset only if there is vendor data */
563 ACPI_SET16(target, aml_length);
565 acpi_rs_set_resource_length(aml_length, aml);
568 case ACPI_RSC_COUNT_SERIAL_VEN:
570 item_count = ACPI_GET16(source);
571 ACPI_SET16(destination, item_count + info->value);
572 aml_length = (u16)(aml_length + item_count);
573 acpi_rs_set_resource_length(aml_length, aml);
576 case ACPI_RSC_COUNT_SERIAL_RES:
578 item_count = ACPI_GET16(source);
579 aml_length = (u16)(aml_length + item_count);
580 acpi_rs_set_resource_length(aml_length, aml);
583 case ACPI_RSC_LENGTH:
585 acpi_rs_set_resource_length(info->value, aml);
589 case ACPI_RSC_MOVE16:
590 case ACPI_RSC_MOVE32:
591 case ACPI_RSC_MOVE64:
594 item_count = info->value;
596 acpi_rs_move_data(destination, source, item_count,
600 case ACPI_RSC_MOVE_GPIO_PIN:
602 destination = (char *)ACPI_ADD_PTR(void, aml,
605 source = *(u16 **)source;
606 acpi_rs_move_data(destination, source, item_count,
610 case ACPI_RSC_MOVE_GPIO_RES:
612 /* Used for both resource_source string and vendor_data */
614 destination = (char *)ACPI_ADD_PTR(void, aml,
617 source = *(u8 **)source;
618 acpi_rs_move_data(destination, source, item_count,
622 case ACPI_RSC_MOVE_SERIAL_VEN:
624 destination = (char *)ACPI_ADD_PTR(void, aml,
627 source = *(u8 **)source;
628 acpi_rs_move_data(destination, source, item_count,
632 case ACPI_RSC_MOVE_SERIAL_RES:
634 destination = (char *)ACPI_ADD_PTR(void, aml,
637 source = *(u8 **)source;
638 acpi_rs_move_data(destination, source, item_count,
642 case ACPI_RSC_ADDRESS:
644 /* Set the Resource Type, General Flags, and Type-Specific Flags */
646 acpi_rs_set_address_common(aml, resource);
649 case ACPI_RSC_SOURCEX:
651 * Optional resource_source (Index and String)
654 acpi_rs_set_resource_source(aml,
657 acpi_rs_set_resource_length(aml_length, aml);
660 case ACPI_RSC_SOURCE:
662 * Optional resource_source (Index and String). This is the more
663 * complicated case used by the Interrupt() macro
666 acpi_rs_set_resource_source(aml, info->value,
668 acpi_rs_set_resource_length(aml_length, aml);
671 case ACPI_RSC_BITMASK:
673 * 8-bit encoded bitmask (DMA macro)
675 ACPI_SET8(destination,
676 acpi_rs_encode_bitmask(source,
683 case ACPI_RSC_BITMASK16:
685 * 16-bit encoded bitmask (IRQ macro)
688 acpi_rs_encode_bitmask(source,
689 *ACPI_ADD_PTR(u8, resource,
691 ACPI_MOVE_16_TO_16(destination, &temp16);
694 case ACPI_RSC_EXIT_LE:
696 * control - Exit conversion if less than or equal
698 if (item_count <= info->value) {
703 case ACPI_RSC_EXIT_NE:
705 * control - Exit conversion if not equal
707 switch (COMPARE_OPCODE(info)) {
708 case ACPI_RSC_COMPARE_VALUE:
710 if (*ACPI_ADD_PTR(u8, resource,
711 COMPARE_TARGET(info)) !=
712 COMPARE_VALUE(info)) {
720 "Invalid conversion sub-opcode"));
721 return_ACPI_STATUS(AE_BAD_PARAMETER);
725 case ACPI_RSC_EXIT_EQ:
727 * control - Exit conversion if equal
729 if (*ACPI_ADD_PTR(u8, resource,
730 COMPARE_TARGET(info)) ==
731 COMPARE_VALUE(info)) {
738 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
739 return_ACPI_STATUS(AE_BAD_PARAMETER);
747 return_ACPI_STATUS(AE_OK);
751 /* Previous resource validations */
753 if (aml->ext_address64.revision_ID != AML_RESOURCE_EXTENDED_ADDRESS_REVISION) {
754 return_ACPI_STATUS(AE_SUPPORT);
757 if (resource->data.start_dpf.performance_robustness >= 3) {
758 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_VALUE);
761 if (((aml->irq.flags & 0x09) == 0x00) || ((aml->irq.flags & 0x09) == 0x09)) {
763 * Only [active_high, edge_sensitive] or [active_low, level_sensitive]
764 * polarity/trigger interrupts are allowed (ACPI spec, section
765 * "IRQ Format"), so 0x00 and 0x09 are illegal.
768 "Invalid interrupt polarity/trigger in resource list, 0x%X",
770 return_ACPI_STATUS(AE_BAD_DATA);
773 resource->data.extended_irq.interrupt_count = temp8;
776 /* Must have at least one IRQ */
778 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH);
781 if (resource->data.dma.transfer == 0x03) {
782 ACPI_ERROR((AE_INFO, "Invalid DMA.Transfer preference (3)"));
783 return_ACPI_STATUS(AE_BAD_DATA);