1 /*******************************************************************************
3 * Module Name: utresrc - Resource management utilities
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2013, 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.
52 #define _COMPONENT ACPI_UTILITIES
53 ACPI_MODULE_NAME ("utresrc")
56 #if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
59 * Strings used to decode resource descriptors.
60 * Used by both the disassembler and the debugger resource dump routines
62 const char *AcpiGbl_BmDecode
[] =
68 const char *AcpiGbl_ConfigDecode
[] =
70 "0 - Good Configuration",
71 "1 - Acceptable Configuration",
72 "2 - Suboptimal Configuration",
73 "3 - ***Invalid Configuration***",
76 const char *AcpiGbl_ConsumeDecode
[] =
82 const char *AcpiGbl_DecDecode
[] =
88 const char *AcpiGbl_HeDecode
[] =
94 const char *AcpiGbl_IoDecode
[] =
100 const char *AcpiGbl_LlDecode
[] =
106 const char *AcpiGbl_MaxDecode
[] =
112 const char *AcpiGbl_MemDecode
[] =
120 const char *AcpiGbl_MinDecode
[] =
126 const char *AcpiGbl_MtpDecode
[] =
128 "AddressRangeMemory",
129 "AddressRangeReserved",
134 const char *AcpiGbl_RngDecode
[] =
142 const char *AcpiGbl_RwDecode
[] =
148 const char *AcpiGbl_ShrDecode
[] =
152 "ExclusiveAndWake", /* ACPI 5.0 */
153 "SharedAndWake" /* ACPI 5.0 */
156 const char *AcpiGbl_SizDecode
[] =
164 const char *AcpiGbl_TrsDecode
[] =
170 const char *AcpiGbl_TtpDecode
[] =
176 const char *AcpiGbl_TypDecode
[] =
184 const char *AcpiGbl_PpcDecode
[] =
192 const char *AcpiGbl_IorDecode
[] =
195 "IoRestrictionInputOnly",
196 "IoRestrictionOutputOnly",
197 "IoRestrictionNoneAndPreserve"
200 const char *AcpiGbl_DtsDecode
[] =
210 /* GPIO connection type */
212 const char *AcpiGbl_CtDecode
[] =
218 /* Serial bus type */
220 const char *AcpiGbl_SbtDecode
[] =
222 "/* UNKNOWN serial bus type */",
228 /* I2C serial bus access mode */
230 const char *AcpiGbl_AmDecode
[] =
232 "AddressingMode7Bit",
233 "AddressingMode10Bit"
236 /* I2C serial bus slave mode */
238 const char *AcpiGbl_SmDecode
[] =
240 "ControllerInitiated",
244 /* SPI serial bus wire mode */
246 const char *AcpiGbl_WmDecode
[] =
252 /* SPI serial clock phase */
254 const char *AcpiGbl_CphDecode
[] =
260 /* SPI serial bus clock polarity */
262 const char *AcpiGbl_CpoDecode
[] =
268 /* SPI serial bus device polarity */
270 const char *AcpiGbl_DpDecode
[] =
276 /* UART serial bus endian */
278 const char *AcpiGbl_EdDecode
[] =
284 /* UART serial bus bits per byte */
286 const char *AcpiGbl_BpbDecode
[] =
293 "/* UNKNOWN Bits per byte */",
294 "/* UNKNOWN Bits per byte */",
295 "/* UNKNOWN Bits per byte */"
298 /* UART serial bus stop bits */
300 const char *AcpiGbl_SbDecode
[] =
304 "StopBitsOnePlusHalf",
308 /* UART serial bus flow control */
310 const char *AcpiGbl_FcDecode
[] =
313 "FlowControlHardware",
315 "/* UNKNOWN flow control keyword */"
318 /* UART serial bus parity type */
320 const char *AcpiGbl_PtDecode
[] =
327 "/* UNKNOWN parity keyword */",
328 "/* UNKNOWN parity keyword */",
329 "/* UNKNOWN parity keyword */"
336 * Base sizes of the raw AML resource descriptors, indexed by resource type.
337 * Zero indicates a reserved (and therefore invalid) resource type.
339 const UINT8 AcpiGbl_ResourceAmlSizes
[] =
341 /* Small descriptors */
347 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IRQ
),
348 ACPI_AML_SIZE_SMALL (AML_RESOURCE_DMA
),
349 ACPI_AML_SIZE_SMALL (AML_RESOURCE_START_DEPENDENT
),
350 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_DEPENDENT
),
351 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IO
),
352 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_IO
),
353 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_DMA
),
357 ACPI_AML_SIZE_SMALL (AML_RESOURCE_VENDOR_SMALL
),
358 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_TAG
),
360 /* Large descriptors */
363 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY24
),
364 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GENERIC_REGISTER
),
366 ACPI_AML_SIZE_LARGE (AML_RESOURCE_VENDOR_LARGE
),
367 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY32
),
368 ACPI_AML_SIZE_LARGE (AML_RESOURCE_FIXED_MEMORY32
),
369 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS32
),
370 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS16
),
371 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_IRQ
),
372 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS64
),
373 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_ADDRESS64
),
374 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GPIO
),
376 ACPI_AML_SIZE_LARGE (AML_RESOURCE_COMMON_SERIALBUS
),
379 const UINT8 AcpiGbl_ResourceAmlSerialBusSizes
[] =
382 ACPI_AML_SIZE_LARGE (AML_RESOURCE_I2C_SERIALBUS
),
383 ACPI_AML_SIZE_LARGE (AML_RESOURCE_SPI_SERIALBUS
),
384 ACPI_AML_SIZE_LARGE (AML_RESOURCE_UART_SERIALBUS
),
389 * Resource types, used to validate the resource length field.
390 * The length of fixed-length types must match exactly, variable
391 * lengths must meet the minimum required length, etc.
392 * Zero indicates a reserved (and therefore invalid) resource type.
394 static const UINT8 AcpiGbl_ResourceTypes
[] =
396 /* Small descriptors */
402 ACPI_SMALL_VARIABLE_LENGTH
, /* 04 IRQ */
403 ACPI_FIXED_LENGTH
, /* 05 DMA */
404 ACPI_SMALL_VARIABLE_LENGTH
, /* 06 StartDependentFunctions */
405 ACPI_FIXED_LENGTH
, /* 07 EndDependentFunctions */
406 ACPI_FIXED_LENGTH
, /* 08 IO */
407 ACPI_FIXED_LENGTH
, /* 09 FixedIO */
408 ACPI_FIXED_LENGTH
, /* 0A FixedDMA */
412 ACPI_VARIABLE_LENGTH
, /* 0E VendorShort */
413 ACPI_FIXED_LENGTH
, /* 0F EndTag */
415 /* Large descriptors */
418 ACPI_FIXED_LENGTH
, /* 01 Memory24 */
419 ACPI_FIXED_LENGTH
, /* 02 GenericRegister */
421 ACPI_VARIABLE_LENGTH
, /* 04 VendorLong */
422 ACPI_FIXED_LENGTH
, /* 05 Memory32 */
423 ACPI_FIXED_LENGTH
, /* 06 Memory32Fixed */
424 ACPI_VARIABLE_LENGTH
, /* 07 Dword* address */
425 ACPI_VARIABLE_LENGTH
, /* 08 Word* address */
426 ACPI_VARIABLE_LENGTH
, /* 09 ExtendedIRQ */
427 ACPI_VARIABLE_LENGTH
, /* 0A Qword* address */
428 ACPI_FIXED_LENGTH
, /* 0B Extended* address */
429 ACPI_VARIABLE_LENGTH
, /* 0C Gpio* */
431 ACPI_VARIABLE_LENGTH
/* 0E *SerialBus */
435 /*******************************************************************************
437 * FUNCTION: AcpiUtWalkAmlResources
439 * PARAMETERS: WalkState - Current walk info
440 * PARAMETERS: Aml - Pointer to the raw AML resource template
441 * AmlLength - Length of the entire template
442 * UserFunction - Called once for each descriptor found. If
443 * NULL, a pointer to the EndTag is returned
444 * Context - Passed to UserFunction
448 * DESCRIPTION: Walk a raw AML resource list(buffer). User function called
449 * once for each resource found.
451 ******************************************************************************/
454 AcpiUtWalkAmlResources (
455 ACPI_WALK_STATE
*WalkState
,
458 ACPI_WALK_AML_CALLBACK UserFunction
,
466 UINT8 EndTag
[2] = {0x79, 0x00};
469 ACPI_FUNCTION_TRACE (UtWalkAmlResources
);
472 /* The absolute minimum resource template is one EndTag descriptor */
474 if (AmlLength
< sizeof (AML_RESOURCE_END_TAG
))
476 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG
);
479 /* Point to the end of the resource template buffer */
481 EndAml
= Aml
+ AmlLength
;
483 /* Walk the byte list, abort on any invalid descriptor type or length */
487 /* Validate the Resource Type and Resource Length */
489 Status
= AcpiUtValidateResource (WalkState
, Aml
, &ResourceIndex
);
490 if (ACPI_FAILURE (Status
))
493 * Exit on failure. Cannot continue because the descriptor length
496 return_ACPI_STATUS (Status
);
499 /* Get the length of this descriptor */
501 Length
= AcpiUtGetDescriptorLength (Aml
);
503 /* Invoke the user function */
507 Status
= UserFunction (Aml
, Length
, Offset
, ResourceIndex
, Context
);
508 if (ACPI_FAILURE (Status
))
510 return_ACPI_STATUS (Status
);
514 /* An EndTag descriptor terminates this resource template */
516 if (AcpiUtGetResourceType (Aml
) == ACPI_RESOURCE_NAME_END_TAG
)
519 * There must be at least one more byte in the buffer for
520 * the 2nd byte of the EndTag
522 if ((Aml
+ 1) >= EndAml
)
524 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG
);
527 /* Return the pointer to the EndTag if requested */
536 return_ACPI_STATUS (AE_OK
);
543 /* Did not find an EndTag descriptor */
547 /* Insert an EndTag anyway. AcpiRsGetListLength always leaves room */
549 (void) AcpiUtValidateResource (WalkState
, EndTag
, &ResourceIndex
);
550 Status
= UserFunction (EndTag
, 2, Offset
, ResourceIndex
, Context
);
551 if (ACPI_FAILURE (Status
))
553 return_ACPI_STATUS (Status
);
557 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG
);
561 /*******************************************************************************
563 * FUNCTION: AcpiUtValidateResource
565 * PARAMETERS: WalkState - Current walk info
566 * Aml - Pointer to the raw AML resource descriptor
567 * ReturnIndex - Where the resource index is returned. NULL
568 * if the index is not required.
570 * RETURN: Status, and optionally the Index into the global resource tables
572 * DESCRIPTION: Validate an AML resource descriptor by checking the Resource
573 * Type and Resource Length. Returns an index into the global
574 * resource information/dispatch tables for later use.
576 ******************************************************************************/
579 AcpiUtValidateResource (
580 ACPI_WALK_STATE
*WalkState
,
584 AML_RESOURCE
*AmlResource
;
587 ACPI_RS_LENGTH ResourceLength
;
588 ACPI_RS_LENGTH MinimumResourceLength
;
591 ACPI_FUNCTION_ENTRY ();
595 * 1) Validate the ResourceType field (Byte 0)
597 ResourceType
= ACPI_GET8 (Aml
);
600 * Byte 0 contains the descriptor name (Resource Type)
601 * Examine the large/small bit in the resource header
603 if (ResourceType
& ACPI_RESOURCE_NAME_LARGE
)
605 /* Verify the large resource type (name) against the max */
607 if (ResourceType
> ACPI_RESOURCE_NAME_LARGE_MAX
)
609 goto InvalidResource
;
613 * Large Resource Type -- bits 6:0 contain the name
614 * Translate range 0x80-0x8B to index range 0x10-0x1B
616 ResourceIndex
= (UINT8
) (ResourceType
- 0x70);
621 * Small Resource Type -- bits 6:3 contain the name
622 * Shift range to index range 0x00-0x0F
624 ResourceIndex
= (UINT8
)
625 ((ResourceType
& ACPI_RESOURCE_NAME_SMALL_MASK
) >> 3);
629 * Check validity of the resource type, via AcpiGbl_ResourceTypes. Zero
630 * indicates an invalid resource.
632 if (!AcpiGbl_ResourceTypes
[ResourceIndex
])
634 goto InvalidResource
;
638 * Validate the ResourceLength field. This ensures that the length
639 * is at least reasonable, and guarantees that it is non-zero.
641 ResourceLength
= AcpiUtGetResourceLength (Aml
);
642 MinimumResourceLength
= AcpiGbl_ResourceAmlSizes
[ResourceIndex
];
644 /* Validate based upon the type of resource - fixed length or variable */
646 switch (AcpiGbl_ResourceTypes
[ResourceIndex
])
648 case ACPI_FIXED_LENGTH
:
650 /* Fixed length resource, length must match exactly */
652 if (ResourceLength
!= MinimumResourceLength
)
654 goto BadResourceLength
;
658 case ACPI_VARIABLE_LENGTH
:
660 /* Variable length resource, length must be at least the minimum */
662 if (ResourceLength
< MinimumResourceLength
)
664 goto BadResourceLength
;
668 case ACPI_SMALL_VARIABLE_LENGTH
:
670 /* Small variable length resource, length can be (Min) or (Min-1) */
672 if ((ResourceLength
> MinimumResourceLength
) ||
673 (ResourceLength
< (MinimumResourceLength
- 1)))
675 goto BadResourceLength
;
681 /* Shouldn't happen (because of validation earlier), but be sure */
683 goto InvalidResource
;
686 AmlResource
= ACPI_CAST_PTR (AML_RESOURCE
, Aml
);
687 if (ResourceType
== ACPI_RESOURCE_NAME_SERIAL_BUS
)
689 /* Validate the BusType field */
691 if ((AmlResource
->CommonSerialBus
.Type
== 0) ||
692 (AmlResource
->CommonSerialBus
.Type
> AML_RESOURCE_MAX_SERIALBUSTYPE
))
696 ACPI_ERROR ((AE_INFO
,
697 "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X",
698 AmlResource
->CommonSerialBus
.Type
));
700 return (AE_AML_INVALID_RESOURCE_TYPE
);
704 /* Optionally return the resource table index */
708 *ReturnIndex
= ResourceIndex
;
718 ACPI_ERROR ((AE_INFO
,
719 "Invalid/unsupported resource descriptor: Type 0x%2.2X",
722 return (AE_AML_INVALID_RESOURCE_TYPE
);
728 ACPI_ERROR ((AE_INFO
,
729 "Invalid resource descriptor length: Type "
730 "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X",
731 ResourceType
, ResourceLength
, MinimumResourceLength
));
733 return (AE_AML_BAD_RESOURCE_LENGTH
);
737 /*******************************************************************************
739 * FUNCTION: AcpiUtGetResourceType
741 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
743 * RETURN: The Resource Type with no extraneous bits (except the
744 * Large/Small descriptor bit -- this is left alone)
746 * DESCRIPTION: Extract the Resource Type/Name from the first byte of
747 * a resource descriptor.
749 ******************************************************************************/
752 AcpiUtGetResourceType (
755 ACPI_FUNCTION_ENTRY ();
759 * Byte 0 contains the descriptor name (Resource Type)
760 * Examine the large/small bit in the resource header
762 if (ACPI_GET8 (Aml
) & ACPI_RESOURCE_NAME_LARGE
)
764 /* Large Resource Type -- bits 6:0 contain the name */
766 return (ACPI_GET8 (Aml
));
770 /* Small Resource Type -- bits 6:3 contain the name */
772 return ((UINT8
) (ACPI_GET8 (Aml
) & ACPI_RESOURCE_NAME_SMALL_MASK
));
777 /*******************************************************************************
779 * FUNCTION: AcpiUtGetResourceLength
781 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
783 * RETURN: Byte Length
785 * DESCRIPTION: Get the "Resource Length" of a raw AML descriptor. By
786 * definition, this does not include the size of the descriptor
787 * header or the length field itself.
789 ******************************************************************************/
792 AcpiUtGetResourceLength (
795 ACPI_RS_LENGTH ResourceLength
;
798 ACPI_FUNCTION_ENTRY ();
802 * Byte 0 contains the descriptor name (Resource Type)
803 * Examine the large/small bit in the resource header
805 if (ACPI_GET8 (Aml
) & ACPI_RESOURCE_NAME_LARGE
)
807 /* Large Resource type -- bytes 1-2 contain the 16-bit length */
809 ACPI_MOVE_16_TO_16 (&ResourceLength
, ACPI_ADD_PTR (UINT8
, Aml
, 1));
814 /* Small Resource type -- bits 2:0 of byte 0 contain the length */
816 ResourceLength
= (UINT16
) (ACPI_GET8 (Aml
) &
817 ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK
);
820 return (ResourceLength
);
824 /*******************************************************************************
826 * FUNCTION: AcpiUtGetResourceHeaderLength
828 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
830 * RETURN: Length of the AML header (depends on large/small descriptor)
832 * DESCRIPTION: Get the length of the header for this resource.
834 ******************************************************************************/
837 AcpiUtGetResourceHeaderLength (
840 ACPI_FUNCTION_ENTRY ();
843 /* Examine the large/small bit in the resource header */
845 if (ACPI_GET8 (Aml
) & ACPI_RESOURCE_NAME_LARGE
)
847 return (sizeof (AML_RESOURCE_LARGE_HEADER
));
851 return (sizeof (AML_RESOURCE_SMALL_HEADER
));
856 /*******************************************************************************
858 * FUNCTION: AcpiUtGetDescriptorLength
860 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor
862 * RETURN: Byte length
864 * DESCRIPTION: Get the total byte length of a raw AML descriptor, including the
865 * length of the descriptor header and the length field itself.
866 * Used to walk descriptor lists.
868 ******************************************************************************/
871 AcpiUtGetDescriptorLength (
874 ACPI_FUNCTION_ENTRY ();
878 * Get the Resource Length (does not include header length) and add
879 * the header length (depends on if this is a small or large resource)
881 return (AcpiUtGetResourceLength (Aml
) +
882 AcpiUtGetResourceHeaderLength (Aml
));
886 /*******************************************************************************
888 * FUNCTION: AcpiUtGetResourceEndTag
890 * PARAMETERS: ObjDesc - The resource template buffer object
891 * EndTag - Where the pointer to the EndTag is returned
893 * RETURN: Status, pointer to the end tag
895 * DESCRIPTION: Find the EndTag resource descriptor in an AML resource template
896 * Note: allows a buffer length of zero.
898 ******************************************************************************/
901 AcpiUtGetResourceEndTag (
902 ACPI_OPERAND_OBJECT
*ObjDesc
,
908 ACPI_FUNCTION_TRACE (UtGetResourceEndTag
);
911 /* Allow a buffer length of zero */
913 if (!ObjDesc
->Buffer
.Length
)
915 *EndTag
= ObjDesc
->Buffer
.Pointer
;
916 return_ACPI_STATUS (AE_OK
);
919 /* Validate the template and get a pointer to the EndTag */
921 Status
= AcpiUtWalkAmlResources (NULL
, ObjDesc
->Buffer
.Pointer
,
922 ObjDesc
->Buffer
.Length
, NULL
, (void **) EndTag
);
924 return_ACPI_STATUS (Status
);