WIP FPC-III support
[linux/fpc-iii.git] / drivers / acpi / acpica / rsmisc.c
blob1763a3dbc9b15497cb60c3b210320ed9ed50bb9d
1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /*******************************************************************************
4 * Module Name: rsmisc - Miscellaneous resource descriptors
6 ******************************************************************************/
8 #include <acpi/acpi.h>
9 #include "accommon.h"
10 #include "acresrc.h"
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
28 * RETURN: Status
30 * DESCRIPTION: Convert an external AML resource descriptor to the corresponding
31 * internal resource descriptor
33 ******************************************************************************/
34 acpi_status
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;
40 void *source;
41 void *destination;
42 char *target;
43 u8 count;
44 u8 flags_mode = FALSE;
45 u16 item_count = 0;
46 u16 temp16 = 0;
48 ACPI_FUNCTION_TRACE(rs_convert_aml_to_resource);
50 if (!info) {
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);
72 while (count) {
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);
78 destination =
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);
89 break;
91 case ACPI_RSC_INITSET:
92 break;
94 case ACPI_RSC_FLAGINIT:
96 flags_mode = TRUE;
97 break;
99 case ACPI_RSC_1BITFLAG:
101 * Mask and shift the flag bit
103 ACPI_SET8(destination,
104 ((ACPI_GET8(source) >> info->value) & 0x01));
105 break;
107 case ACPI_RSC_2BITFLAG:
109 * Mask and shift the flag bits
111 ACPI_SET8(destination,
112 ((ACPI_GET8(source) >> info->value) & 0x03));
113 break;
115 case ACPI_RSC_3BITFLAG:
117 * Mask and shift the flag bits
119 ACPI_SET8(destination,
120 ((ACPI_GET8(source) >> info->value) & 0x07));
121 break;
123 case ACPI_RSC_COUNT:
125 item_count = ACPI_GET8(source);
126 ACPI_SET8(destination, item_count);
128 resource->length = resource->length +
129 (info->value * (item_count - 1));
130 break;
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));
139 break;
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);
149 break;
151 case ACPI_RSC_COUNT_GPIO_VEN:
153 item_count = ACPI_GET8(source);
154 ACPI_SET8(destination, item_count);
156 resource->length =
157 resource->length + (info->value * item_count);
158 break;
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);
171 item_count =
172 ACPI_GET16(target) - ACPI_GET16(source);
173 } else {
174 /* No vendor data to worry about */
176 item_count = aml->large_header.resource_length +
177 sizeof(struct aml_resource_large_header) -
178 ACPI_GET16(source);
181 resource->length = resource->length + item_count;
182 ACPI_SET16(destination, item_count);
183 break;
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);
191 break;
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);
201 break;
203 case ACPI_RSC_LENGTH:
205 resource->length = resource->length + info->value;
206 break;
208 case ACPI_RSC_MOVE8:
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
216 if (info->value) {
217 item_count = info->value;
219 acpi_rs_move_data(destination, source, item_count,
220 info->opcode);
221 break;
223 case ACPI_RSC_MOVE_GPIO_PIN:
225 /* Generate and set the PIN data pointer */
227 target = (char *)ACPI_ADD_PTR(void, resource,
228 (resource->length -
229 item_count * 2));
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,
236 info->opcode);
237 break;
239 case ACPI_RSC_MOVE_GPIO_RES:
241 /* Generate and set the resource_source string pointer */
243 target = (char *)ACPI_ADD_PTR(void, resource,
244 (resource->length -
245 item_count));
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,
252 info->opcode);
253 break;
255 case ACPI_RSC_MOVE_SERIAL_VEN:
257 /* Generate and set the Vendor Data pointer */
259 target = (char *)ACPI_ADD_PTR(void, resource,
260 (resource->length -
261 item_count));
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,
268 info->opcode);
269 break;
271 case ACPI_RSC_MOVE_SERIAL_RES:
273 /* Generate and set the resource_source string pointer */
275 target = (char *)ACPI_ADD_PTR(void, resource,
276 (resource->length -
277 item_count));
278 *(u8 **)destination = ACPI_CAST_PTR(u8, target);
280 /* Copy the resource_source string */
282 source =
283 ACPI_ADD_PTR(void, aml,
284 (ACPI_GET16(source) + info->value));
285 acpi_rs_move_data(target, source, item_count,
286 info->opcode);
287 break;
289 case ACPI_RSC_SET8:
291 memset(destination, info->aml_offset, info->value);
292 break;
294 case ACPI_RSC_DATA8:
296 target = ACPI_ADD_PTR(char, resource, info->value);
297 memcpy(destination, source, ACPI_GET16(target));
298 break;
300 case ACPI_RSC_ADDRESS:
302 * Common handler for address descriptor flags
304 if (!acpi_rs_get_address_common(resource, aml)) {
305 return_ACPI_STATUS
306 (AE_AML_INVALID_RESOURCE_TYPE);
308 break;
310 case ACPI_RSC_SOURCE:
312 * Optional resource_source (Index and String)
314 resource->length +=
315 acpi_rs_get_resource_source(aml_resource_length,
316 info->value,
317 destination, aml, NULL);
318 break;
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,
326 info->aml_offset +
327 (item_count * 4));
329 resource->length +=
330 acpi_rs_get_resource_source(aml_resource_length,
331 (acpi_rs_length)
332 (((item_count -
333 1) * sizeof(u32)) +
334 info->value),
335 destination, aml,
336 target);
337 break;
339 case ACPI_RSC_BITMASK:
341 * 8-bit encoded bitmask (DMA macro)
343 item_count =
344 acpi_rs_decode_bitmask(ACPI_GET8(source),
345 destination);
346 if (item_count) {
347 resource->length += (item_count - 1);
350 target = ACPI_ADD_PTR(char, resource, info->value);
351 ACPI_SET8(target, item_count);
352 break;
354 case ACPI_RSC_BITMASK16:
356 * 16-bit encoded bitmask (IRQ macro)
358 ACPI_MOVE_16_TO_16(&temp16, source);
360 item_count =
361 acpi_rs_decode_bitmask(temp16, destination);
362 if (item_count) {
363 resource->length += (item_count - 1);
366 target = ACPI_ADD_PTR(char, resource, info->value);
367 ACPI_SET8(target, item_count);
368 break;
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) {
378 goto exit;
380 break;
382 case ACPI_RSC_COMPARE_VALUE:
384 if (ACPI_GET8(source) != info->value) {
385 goto exit;
387 break;
389 default:
391 ACPI_ERROR((AE_INFO,
392 "Invalid conversion sub-opcode"));
393 return_ACPI_STATUS(AE_BAD_PARAMETER);
395 break;
397 default:
399 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
400 return_ACPI_STATUS(AE_BAD_PARAMETER);
403 count--;
404 info++;
407 exit:
408 if (!flags_mode) {
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
426 * RETURN: Status
428 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
429 * external AML resource descriptor.
431 ******************************************************************************/
433 acpi_status
434 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
435 union aml_resource *aml,
436 struct acpi_rsconvert_info *info)
438 void *source = NULL;
439 void *destination;
440 char *target;
441 acpi_rsdesc_size aml_length = 0;
442 u8 count;
443 u16 temp16 = 0;
444 u16 item_count = 0;
446 ACPI_FUNCTION_TRACE(rs_convert_resource_to_aml);
448 if (!info) {
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);
458 while (count) {
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),
472 aml_length, aml);
473 break;
475 case ACPI_RSC_INITGET:
476 break;
478 case ACPI_RSC_FLAGINIT:
480 * Clear the flag byte
482 ACPI_SET8(destination, 0);
483 break;
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->
491 value));
492 break;
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->
500 value));
501 break;
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->
509 value));
510 break;
512 case ACPI_RSC_COUNT:
514 item_count = ACPI_GET8(source);
515 ACPI_SET8(destination, item_count);
517 aml_length = (u16)
518 (aml_length + (info->value * (item_count - 1)));
519 break;
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);
526 break;
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);
537 break;
539 case ACPI_RSC_COUNT_GPIO_VEN:
541 item_count = ACPI_GET16(source);
542 ACPI_SET16(destination, item_count);
544 aml_length =
545 (u16)(aml_length + (info->value * item_count));
546 acpi_rs_set_resource_length(aml_length, aml);
547 break;
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);
566 break;
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);
574 break;
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);
581 break;
583 case ACPI_RSC_LENGTH:
585 acpi_rs_set_resource_length(info->value, aml);
586 break;
588 case ACPI_RSC_MOVE8:
589 case ACPI_RSC_MOVE16:
590 case ACPI_RSC_MOVE32:
591 case ACPI_RSC_MOVE64:
593 if (info->value) {
594 item_count = info->value;
596 acpi_rs_move_data(destination, source, item_count,
597 info->opcode);
598 break;
600 case ACPI_RSC_MOVE_GPIO_PIN:
602 destination = (char *)ACPI_ADD_PTR(void, aml,
603 ACPI_GET16
604 (destination));
605 source = *(u16 **)source;
606 acpi_rs_move_data(destination, source, item_count,
607 info->opcode);
608 break;
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,
615 ACPI_GET16
616 (destination));
617 source = *(u8 **)source;
618 acpi_rs_move_data(destination, source, item_count,
619 info->opcode);
620 break;
622 case ACPI_RSC_MOVE_SERIAL_VEN:
624 destination = (char *)ACPI_ADD_PTR(void, aml,
625 (aml_length -
626 item_count));
627 source = *(u8 **)source;
628 acpi_rs_move_data(destination, source, item_count,
629 info->opcode);
630 break;
632 case ACPI_RSC_MOVE_SERIAL_RES:
634 destination = (char *)ACPI_ADD_PTR(void, aml,
635 (aml_length -
636 item_count));
637 source = *(u8 **)source;
638 acpi_rs_move_data(destination, source, item_count,
639 info->opcode);
640 break;
642 case ACPI_RSC_ADDRESS:
644 /* Set the Resource Type, General Flags, and Type-Specific Flags */
646 acpi_rs_set_address_common(aml, resource);
647 break;
649 case ACPI_RSC_SOURCEX:
651 * Optional resource_source (Index and String)
653 aml_length =
654 acpi_rs_set_resource_source(aml,
655 (acpi_rs_length)
656 aml_length, source);
657 acpi_rs_set_resource_length(aml_length, aml);
658 break;
660 case ACPI_RSC_SOURCE:
662 * Optional resource_source (Index and String). This is the more
663 * complicated case used by the Interrupt() macro
665 aml_length =
666 acpi_rs_set_resource_source(aml, info->value,
667 source);
668 acpi_rs_set_resource_length(aml_length, aml);
669 break;
671 case ACPI_RSC_BITMASK:
673 * 8-bit encoded bitmask (DMA macro)
675 ACPI_SET8(destination,
676 acpi_rs_encode_bitmask(source,
677 *ACPI_ADD_PTR(u8,
678 resource,
679 info->
680 value)));
681 break;
683 case ACPI_RSC_BITMASK16:
685 * 16-bit encoded bitmask (IRQ macro)
687 temp16 =
688 acpi_rs_encode_bitmask(source,
689 *ACPI_ADD_PTR(u8, resource,
690 info->value));
691 ACPI_MOVE_16_TO_16(destination, &temp16);
692 break;
694 case ACPI_RSC_EXIT_LE:
696 * control - Exit conversion if less than or equal
698 if (item_count <= info->value) {
699 goto exit;
701 break;
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)) {
713 goto exit;
715 break;
717 default:
719 ACPI_ERROR((AE_INFO,
720 "Invalid conversion sub-opcode"));
721 return_ACPI_STATUS(AE_BAD_PARAMETER);
723 break;
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)) {
732 goto exit;
734 break;
736 default:
738 ACPI_ERROR((AE_INFO, "Invalid conversion opcode"));
739 return_ACPI_STATUS(AE_BAD_PARAMETER);
742 count--;
743 info++;
746 exit:
747 return_ACPI_STATUS(AE_OK);
750 #if 0
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.
767 ACPI_ERROR((AE_INFO,
768 "Invalid interrupt polarity/trigger in resource list, 0x%X",
769 aml->irq.flags));
770 return_ACPI_STATUS(AE_BAD_DATA);
773 resource->data.extended_irq.interrupt_count = temp8;
774 if (temp8 < 1) {
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);
785 #endif