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 <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acresrc.h>
48 #define _COMPONENT ACPI_RESOURCES
49 ACPI_MODULE_NAME ("rsmisc")
52 #define INIT_RESOURCE_TYPE(i) i->ResourceOffset
53 #define INIT_RESOURCE_LENGTH(i) i->AmlOffset
54 #define INIT_TABLE_LENGTH(i) i->Value
56 #define COMPARE_OPCODE(i) i->ResourceOffset
57 #define COMPARE_TARGET(i) i->AmlOffset
58 #define COMPARE_VALUE(i) i->Value
61 /*******************************************************************************
63 * FUNCTION: AcpiRsConvertAmlToResource
65 * PARAMETERS: Resource - Pointer to the resource descriptor
66 * Aml - Where the AML descriptor is returned
67 * Info - Pointer to appropriate conversion table
71 * DESCRIPTION: Convert an external AML resource descriptor to the corresponding
72 * internal resource descriptor
74 ******************************************************************************/
77 AcpiRsConvertAmlToResource (
78 ACPI_RESOURCE *Resource,
80 ACPI_RSCONVERT_INFO *Info)
82 ACPI_RS_LENGTH AmlResourceLength;
87 UINT8 FlagsMode = FALSE;
92 ACPI_FUNCTION_TRACE (RsConvertAmlToResource);
97 return_ACPI_STATUS (AE_BAD_PARAMETER);
100 if (((ACPI_SIZE) Resource) & 0x3)
102 /* Each internal resource struct is expected to be 32-bit aligned */
104 ACPI_WARNING ((AE_INFO,
105 "Misaligned resource pointer (get): %p Type 0x%2.2X Length %u",
106 Resource, Resource->Type, Resource->Length));
109 /* Extract the resource Length field (does not include header length) */
111 AmlResourceLength = AcpiUtGetResourceLength (Aml);
114 * First table entry must be ACPI_RSC_INITxxx and must contain the
115 * table length (# of table entries)
117 Count = INIT_TABLE_LENGTH (Info);
121 * Source is the external AML byte stream buffer,
122 * destination is the internal resource descriptor
124 Source = ACPI_ADD_PTR (void, Aml, Info->AmlOffset);
125 Destination = ACPI_ADD_PTR (void, Resource, Info->ResourceOffset);
127 switch (Info->Opcode)
129 case ACPI_RSC_INITGET:
131 * Get the resource type and the initial (minimum) length
133 ACPI_MEMSET (Resource, 0, INIT_RESOURCE_LENGTH (Info));
134 Resource->Type = INIT_RESOURCE_TYPE (Info);
135 Resource->Length = INIT_RESOURCE_LENGTH (Info);
138 case ACPI_RSC_INITSET:
141 case ACPI_RSC_FLAGINIT:
146 case ACPI_RSC_1BITFLAG:
148 * Mask and shift the flag bit
150 ACPI_SET8 (Destination,
151 ((ACPI_GET8 (Source) >> Info->Value) & 0x01));
154 case ACPI_RSC_2BITFLAG:
156 * Mask and shift the flag bits
158 ACPI_SET8 (Destination,
159 ((ACPI_GET8 (Source) >> Info->Value) & 0x03));
162 case ACPI_RSC_3BITFLAG:
164 * Mask and shift the flag bits
166 ACPI_SET8 (Destination,
167 ((ACPI_GET8 (Source) >> Info->Value) & 0x07));
172 ItemCount = ACPI_GET8 (Source);
173 ACPI_SET8 (Destination, ItemCount);
175 Resource->Length = Resource->Length +
176 (Info->Value * (ItemCount - 1));
179 case ACPI_RSC_COUNT16:
181 ItemCount = AmlResourceLength;
182 ACPI_SET16 (Destination, ItemCount);
184 Resource->Length = Resource->Length +
185 (Info->Value * (ItemCount - 1));
188 case ACPI_RSC_COUNT_GPIO_PIN:
190 Target = ACPI_ADD_PTR (void, Aml, Info->Value);
191 ItemCount = ACPI_GET16 (Target) - ACPI_GET16 (Source);
193 Resource->Length = Resource->Length + ItemCount;
194 ItemCount = ItemCount / 2;
195 ACPI_SET16 (Destination, ItemCount);
198 case ACPI_RSC_COUNT_GPIO_VEN:
200 ItemCount = ACPI_GET8 (Source);
201 ACPI_SET8 (Destination, ItemCount);
203 Resource->Length = Resource->Length +
204 (Info->Value * ItemCount);
207 case ACPI_RSC_COUNT_GPIO_RES:
209 * Vendor data is optional (length/offset may both be zero)
210 * Examine vendor data length field first
212 Target = ACPI_ADD_PTR (void, Aml, (Info->Value + 2));
213 if (ACPI_GET16 (Target))
215 /* Use vendor offset to get resource source length */
217 Target = ACPI_ADD_PTR (void, Aml, Info->Value);
218 ItemCount = ACPI_GET16 (Target) - ACPI_GET16 (Source);
222 /* No vendor data to worry about */
224 ItemCount = Aml->LargeHeader.ResourceLength +
225 sizeof (AML_RESOURCE_LARGE_HEADER) -
229 Resource->Length = Resource->Length + ItemCount;
230 ACPI_SET16 (Destination, ItemCount);
233 case ACPI_RSC_COUNT_SERIAL_VEN:
235 ItemCount = ACPI_GET16 (Source) - Info->Value;
237 Resource->Length = Resource->Length + ItemCount;
238 ACPI_SET16 (Destination, ItemCount);
241 case ACPI_RSC_COUNT_SERIAL_RES:
243 ItemCount = (AmlResourceLength +
244 sizeof (AML_RESOURCE_LARGE_HEADER)) -
245 ACPI_GET16 (Source) - Info->Value;
247 Resource->Length = Resource->Length + ItemCount;
248 ACPI_SET16 (Destination, ItemCount);
251 case ACPI_RSC_LENGTH:
253 Resource->Length = Resource->Length + Info->Value;
257 case ACPI_RSC_MOVE16:
258 case ACPI_RSC_MOVE32:
259 case ACPI_RSC_MOVE64:
261 * Raw data move. Use the Info value field unless ItemCount has
262 * been previously initialized via a COUNT opcode
266 ItemCount = Info->Value;
268 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
271 case ACPI_RSC_MOVE_GPIO_PIN:
273 /* Generate and set the PIN data pointer */
275 Target = (char *) ACPI_ADD_PTR (void, Resource,
276 (Resource->Length - ItemCount * 2));
277 *(UINT16 **) Destination = ACPI_CAST_PTR (UINT16, Target);
279 /* Copy the PIN data */
281 Source = ACPI_ADD_PTR (void, Aml, ACPI_GET16 (Source));
282 AcpiRsMoveData (Target, Source, ItemCount, Info->Opcode);
285 case ACPI_RSC_MOVE_GPIO_RES:
287 /* Generate and set the ResourceSource string pointer */
289 Target = (char *) ACPI_ADD_PTR (void, Resource,
290 (Resource->Length - ItemCount));
291 *(UINT8 **) Destination = ACPI_CAST_PTR (UINT8, Target);
293 /* Copy the ResourceSource string */
295 Source = ACPI_ADD_PTR (void, Aml, ACPI_GET16 (Source));
296 AcpiRsMoveData (Target, Source, ItemCount, Info->Opcode);
299 case ACPI_RSC_MOVE_SERIAL_VEN:
301 /* Generate and set the Vendor Data pointer */
303 Target = (char *) ACPI_ADD_PTR (void, Resource,
304 (Resource->Length - ItemCount));
305 *(UINT8 **) Destination = ACPI_CAST_PTR (UINT8, Target);
307 /* Copy the Vendor Data */
309 Source = ACPI_ADD_PTR (void, Aml, Info->Value);
310 AcpiRsMoveData (Target, Source, ItemCount, Info->Opcode);
313 case ACPI_RSC_MOVE_SERIAL_RES:
315 /* Generate and set the ResourceSource string pointer */
317 Target = (char *) ACPI_ADD_PTR (void, Resource,
318 (Resource->Length - ItemCount));
319 *(UINT8 **) Destination = ACPI_CAST_PTR (UINT8, Target);
321 /* Copy the ResourceSource string */
323 Source = ACPI_ADD_PTR (void, Aml, (ACPI_GET16 (Source) + Info->Value));
324 AcpiRsMoveData (Target, Source, ItemCount, Info->Opcode);
329 ACPI_MEMSET (Destination, Info->AmlOffset, Info->Value);
334 Target = ACPI_ADD_PTR (char, Resource, Info->Value);
335 ACPI_MEMCPY (Destination, Source, ACPI_GET16 (Target));
338 case ACPI_RSC_ADDRESS:
340 * Common handler for address descriptor flags
342 if (!AcpiRsGetAddressCommon (Resource, Aml))
344 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
348 case ACPI_RSC_SOURCE:
350 * Optional ResourceSource (Index and String)
353 AcpiRsGetResourceSource (AmlResourceLength, Info->Value,
354 Destination, Aml, NULL);
357 case ACPI_RSC_SOURCEX:
359 * Optional ResourceSource (Index and String). This is the more
360 * complicated case used by the Interrupt() macro
362 Target = ACPI_ADD_PTR (char, Resource,
363 Info->AmlOffset + (ItemCount * 4));
366 AcpiRsGetResourceSource (AmlResourceLength, (ACPI_RS_LENGTH)
367 (((ItemCount - 1) * sizeof (UINT32)) + Info->Value),
368 Destination, Aml, Target);
371 case ACPI_RSC_BITMASK:
373 * 8-bit encoded bitmask (DMA macro)
375 ItemCount = AcpiRsDecodeBitmask (ACPI_GET8 (Source), Destination);
378 Resource->Length += (ItemCount - 1);
381 Target = ACPI_ADD_PTR (char, Resource, Info->Value);
382 ACPI_SET8 (Target, ItemCount);
385 case ACPI_RSC_BITMASK16:
387 * 16-bit encoded bitmask (IRQ macro)
389 ACPI_MOVE_16_TO_16 (&Temp16, Source);
391 ItemCount = AcpiRsDecodeBitmask (Temp16, Destination);
394 Resource->Length += (ItemCount - 1);
397 Target = ACPI_ADD_PTR (char, Resource, Info->Value);
398 ACPI_SET8 (Target, ItemCount);
401 case ACPI_RSC_EXIT_NE:
403 * Control - Exit conversion if not equal
405 switch (Info->ResourceOffset)
407 case ACPI_RSC_COMPARE_AML_LENGTH:
409 if (AmlResourceLength != Info->Value)
415 case ACPI_RSC_COMPARE_VALUE:
417 if (ACPI_GET8 (Source) != Info->Value)
425 ACPI_ERROR ((AE_INFO, "Invalid conversion sub-opcode"));
426 return_ACPI_STATUS (AE_BAD_PARAMETER);
432 ACPI_ERROR ((AE_INFO, "Invalid conversion opcode"));
433 return_ACPI_STATUS (AE_BAD_PARAMETER);
443 /* Round the resource struct length up to the next boundary (32 or 64) */
445 Resource->Length = (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (Resource->Length);
447 return_ACPI_STATUS (AE_OK);
451 /*******************************************************************************
453 * FUNCTION: AcpiRsConvertResourceToAml
455 * PARAMETERS: Resource - Pointer to the resource descriptor
456 * Aml - Where the AML descriptor is returned
457 * Info - Pointer to appropriate conversion table
461 * DESCRIPTION: Convert an internal resource descriptor to the corresponding
462 * external AML resource descriptor.
464 ******************************************************************************/
467 AcpiRsConvertResourceToAml (
468 ACPI_RESOURCE *Resource,
470 ACPI_RSCONVERT_INFO *Info)
475 ACPI_RSDESC_SIZE AmlLength = 0;
478 UINT16 ItemCount = 0;
481 ACPI_FUNCTION_TRACE (RsConvertResourceToAml);
486 return_ACPI_STATUS (AE_BAD_PARAMETER);
490 * First table entry must be ACPI_RSC_INITxxx and must contain the
491 * table length (# of table entries)
493 Count = INIT_TABLE_LENGTH (Info);
498 * Source is the internal resource descriptor,
499 * destination is the external AML byte stream buffer
501 Source = ACPI_ADD_PTR (void, Resource, Info->ResourceOffset);
502 Destination = ACPI_ADD_PTR (void, Aml, Info->AmlOffset);
504 switch (Info->Opcode)
506 case ACPI_RSC_INITSET:
508 ACPI_MEMSET (Aml, 0, INIT_RESOURCE_LENGTH (Info));
509 AmlLength = INIT_RESOURCE_LENGTH (Info);
510 AcpiRsSetResourceHeader (INIT_RESOURCE_TYPE (Info), AmlLength, Aml);
513 case ACPI_RSC_INITGET:
516 case ACPI_RSC_FLAGINIT:
518 * Clear the flag byte
520 ACPI_SET8 (Destination, 0);
523 case ACPI_RSC_1BITFLAG:
525 * Mask and shift the flag bit
527 ACPI_SET_BIT (*ACPI_CAST8 (Destination), (UINT8)
528 ((ACPI_GET8 (Source) & 0x01) << Info->Value));
531 case ACPI_RSC_2BITFLAG:
533 * Mask and shift the flag bits
535 ACPI_SET_BIT (*ACPI_CAST8 (Destination), (UINT8)
536 ((ACPI_GET8 (Source) & 0x03) << Info->Value));
539 case ACPI_RSC_3BITFLAG:
541 * Mask and shift the flag bits
543 ACPI_SET_BIT (*ACPI_CAST8 (Destination), (UINT8)
544 ((ACPI_GET8 (Source) & 0x07) << Info->Value));
549 ItemCount = ACPI_GET8 (Source);
550 ACPI_SET8 (Destination, ItemCount);
552 AmlLength = (UINT16) (AmlLength + (Info->Value * (ItemCount - 1)));
555 case ACPI_RSC_COUNT16:
557 ItemCount = ACPI_GET16 (Source);
558 AmlLength = (UINT16) (AmlLength + ItemCount);
559 AcpiRsSetResourceLength (AmlLength, Aml);
562 case ACPI_RSC_COUNT_GPIO_PIN:
564 ItemCount = ACPI_GET16 (Source);
565 ACPI_SET16 (Destination, AmlLength);
567 AmlLength = (UINT16) (AmlLength + ItemCount * 2);
568 Target = ACPI_ADD_PTR (void, Aml, Info->Value);
569 ACPI_SET16 (Target, AmlLength);
570 AcpiRsSetResourceLength (AmlLength, Aml);
573 case ACPI_RSC_COUNT_GPIO_VEN:
575 ItemCount = ACPI_GET16 (Source);
576 ACPI_SET16 (Destination, ItemCount);
578 AmlLength = (UINT16) (AmlLength + (Info->Value * ItemCount));
579 AcpiRsSetResourceLength (AmlLength, Aml);
582 case ACPI_RSC_COUNT_GPIO_RES:
584 /* Set resource source string length */
586 ItemCount = ACPI_GET16 (Source);
587 ACPI_SET16 (Destination, AmlLength);
589 /* Compute offset for the Vendor Data */
591 AmlLength = (UINT16) (AmlLength + ItemCount);
592 Target = ACPI_ADD_PTR (void, Aml, Info->Value);
594 /* Set vendor offset only if there is vendor data */
596 if (Resource->Data.Gpio.VendorLength)
598 ACPI_SET16 (Target, AmlLength);
601 AcpiRsSetResourceLength (AmlLength, Aml);
604 case ACPI_RSC_COUNT_SERIAL_VEN:
606 ItemCount = ACPI_GET16 (Source);
607 ACPI_SET16 (Destination, ItemCount + Info->Value);
608 AmlLength = (UINT16) (AmlLength + ItemCount);
609 AcpiRsSetResourceLength (AmlLength, Aml);
612 case ACPI_RSC_COUNT_SERIAL_RES:
614 ItemCount = ACPI_GET16 (Source);
615 AmlLength = (UINT16) (AmlLength + ItemCount);
616 AcpiRsSetResourceLength (AmlLength, Aml);
619 case ACPI_RSC_LENGTH:
621 AcpiRsSetResourceLength (Info->Value, Aml);
625 case ACPI_RSC_MOVE16:
626 case ACPI_RSC_MOVE32:
627 case ACPI_RSC_MOVE64:
631 ItemCount = Info->Value;
633 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
636 case ACPI_RSC_MOVE_GPIO_PIN:
638 Destination = (char *) ACPI_ADD_PTR (void, Aml,
639 ACPI_GET16 (Destination));
640 Source = * (UINT16 **) Source;
641 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
644 case ACPI_RSC_MOVE_GPIO_RES:
646 /* Used for both ResourceSource string and VendorData */
648 Destination = (char *) ACPI_ADD_PTR (void, Aml,
649 ACPI_GET16 (Destination));
650 Source = * (UINT8 **) Source;
651 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
654 case ACPI_RSC_MOVE_SERIAL_VEN:
656 Destination = (char *) ACPI_ADD_PTR (void, Aml,
657 (AmlLength - ItemCount));
658 Source = * (UINT8 **) Source;
659 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
662 case ACPI_RSC_MOVE_SERIAL_RES:
664 Destination = (char *) ACPI_ADD_PTR (void, Aml,
665 (AmlLength - ItemCount));
666 Source = * (UINT8 **) Source;
667 AcpiRsMoveData (Destination, Source, ItemCount, Info->Opcode);
670 case ACPI_RSC_ADDRESS:
672 /* Set the Resource Type, General Flags, and Type-Specific Flags */
674 AcpiRsSetAddressCommon (Aml, Resource);
677 case ACPI_RSC_SOURCEX:
679 * Optional ResourceSource (Index and String)
681 AmlLength = AcpiRsSetResourceSource (
682 Aml, (ACPI_RS_LENGTH) AmlLength, Source);
683 AcpiRsSetResourceLength (AmlLength, Aml);
686 case ACPI_RSC_SOURCE:
688 * Optional ResourceSource (Index and String). This is the more
689 * complicated case used by the Interrupt() macro
691 AmlLength = AcpiRsSetResourceSource (Aml, Info->Value, Source);
692 AcpiRsSetResourceLength (AmlLength, Aml);
695 case ACPI_RSC_BITMASK:
697 * 8-bit encoded bitmask (DMA macro)
699 ACPI_SET8 (Destination,
700 AcpiRsEncodeBitmask (Source,
701 *ACPI_ADD_PTR (UINT8, Resource, Info->Value)));
704 case ACPI_RSC_BITMASK16:
706 * 16-bit encoded bitmask (IRQ macro)
708 Temp16 = AcpiRsEncodeBitmask (Source,
709 *ACPI_ADD_PTR (UINT8, Resource, Info->Value));
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 (ItemCount <= Info->Value)
723 case ACPI_RSC_EXIT_NE:
725 * Control - Exit conversion if not equal
727 switch (COMPARE_OPCODE (Info))
729 case ACPI_RSC_COMPARE_VALUE:
731 if (*ACPI_ADD_PTR (UINT8, Resource,
732 COMPARE_TARGET (Info)) != COMPARE_VALUE (Info))
740 ACPI_ERROR ((AE_INFO, "Invalid conversion sub-opcode"));
741 return_ACPI_STATUS (AE_BAD_PARAMETER);
745 case ACPI_RSC_EXIT_EQ:
747 * Control - Exit conversion if equal
749 if (*ACPI_ADD_PTR (UINT8, Resource,
750 COMPARE_TARGET (Info)) == COMPARE_VALUE (Info))
758 ACPI_ERROR ((AE_INFO, "Invalid conversion opcode"));
759 return_ACPI_STATUS (AE_BAD_PARAMETER);
767 return_ACPI_STATUS (AE_OK);
772 /* Previous resource validations */
774 if (Aml->ExtAddress64.RevisionID != AML_RESOURCE_EXTENDED_ADDRESS_REVISION)
776 return_ACPI_STATUS (AE_SUPPORT);
779 if (Resource->Data.StartDpf.PerformanceRobustness >= 3)
781 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_VALUE);
784 if (((Aml->Irq.Flags & 0x09) == 0x00) ||
785 ((Aml->Irq.Flags & 0x09) == 0x09))
788 * Only [ActiveHigh, EdgeSensitive] or [ActiveLow, LevelSensitive]
789 * polarity/trigger interrupts are allowed (ACPI spec, section
790 * "IRQ Format"), so 0x00 and 0x09 are illegal.
792 ACPI_ERROR ((AE_INFO,
793 "Invalid interrupt polarity/trigger in resource list, 0x%X",
795 return_ACPI_STATUS (AE_BAD_DATA);
798 Resource->Data.ExtendedIrq.InterruptCount = Temp8;
801 /* Must have at least one IRQ */
803 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
806 if (Resource->Data.Dma.Transfer == 0x03)
808 ACPI_ERROR ((AE_INFO,
809 "Invalid DMA.Transfer preference (3)"));
810 return_ACPI_STATUS (AE_BAD_DATA);