1 /*******************************************************************************
3 * Module Name: rscalc - Calculate stream and list lengths
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_RESOURCES
53 ACPI_MODULE_NAME ("rscalc")
56 /* Local prototypes */
63 AcpiRsStructOptionLength (
64 ACPI_RESOURCE_SOURCE *ResourceSource);
67 AcpiRsStreamOptionLength (
68 UINT32 ResourceLength,
69 UINT32 MinimumTotalLength);
72 /*******************************************************************************
74 * FUNCTION: AcpiRsCountSetBits
76 * PARAMETERS: BitField - Field in which to count bits
78 * RETURN: Number of bits set within the field
80 * DESCRIPTION: Count the number of bits set in a resource field. Used for
81 * (Short descriptor) interrupt and DMA lists.
83 ******************************************************************************/
92 ACPI_FUNCTION_ENTRY ();
95 for (BitsSet = 0; BitField; BitsSet++)
97 /* Zero the least significant bit that is set */
99 BitField &= (UINT16) (BitField - 1);
106 /*******************************************************************************
108 * FUNCTION: AcpiRsStructOptionLength
110 * PARAMETERS: ResourceSource - Pointer to optional descriptor field
114 * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
115 * ResourceSource fields in some Large descriptors. Used during
116 * list-to-stream conversion
118 ******************************************************************************/
120 static ACPI_RS_LENGTH
121 AcpiRsStructOptionLength (
122 ACPI_RESOURCE_SOURCE *ResourceSource)
124 ACPI_FUNCTION_ENTRY ();
128 * If the ResourceSource string is valid, return the size of the string
129 * (StringLength includes the NULL terminator) plus the size of the
130 * ResourceSourceIndex (1).
132 if (ResourceSource->StringPtr)
134 return ((ACPI_RS_LENGTH) (ResourceSource->StringLength + 1));
141 /*******************************************************************************
143 * FUNCTION: AcpiRsStreamOptionLength
145 * PARAMETERS: ResourceLength - Length from the resource header
146 * MinimumTotalLength - Minimum length of this resource, before
147 * any optional fields. Includes header size
149 * RETURN: Length of optional string (0 if no string present)
151 * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
152 * ResourceSource fields in some Large descriptors. Used during
153 * stream-to-list conversion
155 ******************************************************************************/
158 AcpiRsStreamOptionLength (
159 UINT32 ResourceLength,
160 UINT32 MinimumAmlResourceLength)
162 UINT32 StringLength = 0;
165 ACPI_FUNCTION_ENTRY ();
169 * The ResourceSourceIndex and ResourceSource are optional elements of some
170 * Large-type resource descriptors.
174 * If the length of the actual resource descriptor is greater than the ACPI
175 * spec-defined minimum length, it means that a ResourceSourceIndex exists
176 * and is followed by a (required) null terminated string. The string length
177 * (including the null terminator) is the resource length minus the minimum
178 * length, minus one byte for the ResourceSourceIndex itself.
180 if (ResourceLength > MinimumAmlResourceLength)
182 /* Compute the length of the optional string */
184 StringLength = ResourceLength - MinimumAmlResourceLength - 1;
188 * Round the length up to a multiple of the native word in order to
189 * guarantee that the entire resource descriptor is native word aligned
191 return ((UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (StringLength));
195 /*******************************************************************************
197 * FUNCTION: AcpiRsGetAmlLength
199 * PARAMETERS: Resource - Pointer to the resource linked list
200 * SizeNeeded - Where the required size is returned
204 * DESCRIPTION: Takes a linked list of internal resource descriptors and
205 * calculates the size buffer needed to hold the corresponding
206 * external resource byte stream.
208 ******************************************************************************/
212 ACPI_RESOURCE *Resource,
213 ACPI_SIZE *SizeNeeded)
215 ACPI_SIZE AmlSizeNeeded = 0;
216 ACPI_RS_LENGTH TotalSize;
219 ACPI_FUNCTION_TRACE (RsGetAmlLength);
222 /* Traverse entire list of internal resource descriptors */
226 /* Validate the descriptor type */
228 if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
230 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
233 /* Sanity check the length. It must not be zero, or we loop forever */
235 if (!Resource->Length)
237 return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
240 /* Get the base size of the (external stream) resource descriptor */
242 TotalSize = AcpiGbl_AmlResourceSizes [Resource->Type];
245 * Augment the base size for descriptors with optional and/or
246 * variable-length fields
248 switch (Resource->Type)
250 case ACPI_RESOURCE_TYPE_IRQ:
252 /* Length can be 3 or 2 */
254 if (Resource->Data.Irq.DescriptorLength == 2)
261 case ACPI_RESOURCE_TYPE_START_DEPENDENT:
263 /* Length can be 1 or 0 */
265 if (Resource->Data.Irq.DescriptorLength == 0)
272 case ACPI_RESOURCE_TYPE_VENDOR:
274 * Vendor Defined Resource:
275 * For a Vendor Specific resource, if the Length is between 1 and 7
276 * it will be created as a Small Resource data type, otherwise it
277 * is a Large Resource data type.
279 if (Resource->Data.Vendor.ByteLength > 7)
281 /* Base size of a Large resource descriptor */
283 TotalSize = sizeof (AML_RESOURCE_LARGE_HEADER);
286 /* Add the size of the vendor-specific data */
288 TotalSize = (ACPI_RS_LENGTH)
289 (TotalSize + Resource->Data.Vendor.ByteLength);
293 case ACPI_RESOURCE_TYPE_END_TAG:
296 * We are done -- return the accumulated total size.
298 *SizeNeeded = AmlSizeNeeded + TotalSize;
302 return_ACPI_STATUS (AE_OK);
305 case ACPI_RESOURCE_TYPE_ADDRESS16:
307 * 16-Bit Address Resource:
308 * Add the size of the optional ResourceSource info
310 TotalSize = (ACPI_RS_LENGTH)
311 (TotalSize + AcpiRsStructOptionLength (
312 &Resource->Data.Address16.ResourceSource));
316 case ACPI_RESOURCE_TYPE_ADDRESS32:
318 * 32-Bit Address Resource:
319 * Add the size of the optional ResourceSource info
321 TotalSize = (ACPI_RS_LENGTH)
322 (TotalSize + AcpiRsStructOptionLength (
323 &Resource->Data.Address32.ResourceSource));
327 case ACPI_RESOURCE_TYPE_ADDRESS64:
329 * 64-Bit Address Resource:
330 * Add the size of the optional ResourceSource info
332 TotalSize = (ACPI_RS_LENGTH)
333 (TotalSize + AcpiRsStructOptionLength (
334 &Resource->Data.Address64.ResourceSource));
338 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
340 * Extended IRQ Resource:
341 * Add the size of each additional optional interrupt beyond the
342 * required 1 (4 bytes for each UINT32 interrupt number)
344 TotalSize = (ACPI_RS_LENGTH)
346 ((Resource->Data.ExtendedIrq.InterruptCount - 1) * 4) +
348 /* Add the size of the optional ResourceSource info */
350 AcpiRsStructOptionLength (
351 &Resource->Data.ExtendedIrq.ResourceSource));
355 case ACPI_RESOURCE_TYPE_GPIO:
357 TotalSize = (ACPI_RS_LENGTH) (TotalSize + (Resource->Data.Gpio.PinTableLength * 2) +
358 Resource->Data.Gpio.ResourceSource.StringLength +
359 Resource->Data.Gpio.VendorLength);
364 case ACPI_RESOURCE_TYPE_SERIAL_BUS:
366 TotalSize = AcpiGbl_AmlResourceSerialBusSizes [Resource->Data.CommonSerialBus.Type];
368 TotalSize = (ACPI_RS_LENGTH) (TotalSize +
369 Resource->Data.I2cSerialBus.ResourceSource.StringLength +
370 Resource->Data.I2cSerialBus.VendorLength);
379 /* Update the total */
381 AmlSizeNeeded += TotalSize;
383 /* Point to the next object */
385 Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
388 /* Did not find an EndTag resource descriptor */
390 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
394 /*******************************************************************************
396 * FUNCTION: AcpiRsGetListLength
398 * PARAMETERS: AmlBuffer - Pointer to the resource byte stream
399 * AmlBufferLength - Size of AmlBuffer
400 * SizeNeeded - Where the size needed is returned
404 * DESCRIPTION: Takes an external resource byte stream and calculates the size
405 * buffer needed to hold the corresponding internal resource
406 * descriptor linked list.
408 ******************************************************************************/
411 AcpiRsGetListLength (
413 UINT32 AmlBufferLength,
414 ACPI_SIZE *SizeNeeded)
421 UINT16 ResourceLength;
422 UINT32 ExtraStructBytes;
424 UINT8 MinimumAmlResourceLength;
425 AML_RESOURCE *AmlResource;
428 ACPI_FUNCTION_TRACE (RsGetListLength);
431 *SizeNeeded = ACPI_RS_SIZE_MIN; /* Minimum size is one EndTag */
432 EndAml = AmlBuffer + AmlBufferLength;
434 /* Walk the list of AML resource descriptors */
436 while (AmlBuffer < EndAml)
438 /* Validate the Resource Type and Resource Length */
440 Status = AcpiUtValidateResource (NULL, AmlBuffer, &ResourceIndex);
441 if (ACPI_FAILURE (Status))
444 * Exit on failure. Cannot continue because the descriptor length
447 return_ACPI_STATUS (Status);
450 AmlResource = (void *) AmlBuffer;
452 /* Get the resource length and base (minimum) AML size */
454 ResourceLength = AcpiUtGetResourceLength (AmlBuffer);
455 MinimumAmlResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
458 * Augment the size for descriptors with optional
459 * and/or variable length fields
461 ExtraStructBytes = 0;
462 Buffer = AmlBuffer + AcpiUtGetResourceHeaderLength (AmlBuffer);
464 switch (AcpiUtGetResourceType (AmlBuffer))
466 case ACPI_RESOURCE_NAME_IRQ:
469 * Get the number of bits set in the 16-bit IRQ mask
471 ACPI_MOVE_16_TO_16 (&Temp16, Buffer);
472 ExtraStructBytes = AcpiRsCountSetBits (Temp16);
476 case ACPI_RESOURCE_NAME_DMA:
479 * Get the number of bits set in the 8-bit DMA mask
481 ExtraStructBytes = AcpiRsCountSetBits (*Buffer);
485 case ACPI_RESOURCE_NAME_VENDOR_SMALL:
486 case ACPI_RESOURCE_NAME_VENDOR_LARGE:
489 * Get the number of vendor data bytes
491 ExtraStructBytes = ResourceLength;
494 * There is already one byte included in the minimum
495 * descriptor size. If there are extra struct bytes,
496 * subtract one from the count.
498 if (ExtraStructBytes)
505 case ACPI_RESOURCE_NAME_END_TAG:
507 * End Tag: This is the normal exit
509 return_ACPI_STATUS (AE_OK);
512 case ACPI_RESOURCE_NAME_ADDRESS32:
513 case ACPI_RESOURCE_NAME_ADDRESS16:
514 case ACPI_RESOURCE_NAME_ADDRESS64:
517 * Add the size of the optional ResourceSource
519 ExtraStructBytes = AcpiRsStreamOptionLength (
520 ResourceLength, MinimumAmlResourceLength);
524 case ACPI_RESOURCE_NAME_EXTENDED_IRQ:
526 * Extended IRQ Resource:
527 * Using the InterruptTableLength, add 4 bytes for each additional
528 * interrupt. Note: at least one interrupt is required and is
529 * included in the minimum descriptor size (reason for the -1)
531 ExtraStructBytes = (Buffer[1] - 1) * sizeof (UINT32);
533 /* Add the size of the optional ResourceSource */
535 ExtraStructBytes += AcpiRsStreamOptionLength (
536 ResourceLength - ExtraStructBytes, MinimumAmlResourceLength);
539 case ACPI_RESOURCE_NAME_GPIO:
541 /* Vendor data is optional */
543 if (AmlResource->Gpio.VendorLength)
545 ExtraStructBytes += AmlResource->Gpio.VendorOffset -
546 AmlResource->Gpio.PinTableOffset + AmlResource->Gpio.VendorLength;
550 ExtraStructBytes += AmlResource->LargeHeader.ResourceLength +
551 sizeof (AML_RESOURCE_LARGE_HEADER) -
552 AmlResource->Gpio.PinTableOffset;
556 case ACPI_RESOURCE_NAME_SERIAL_BUS:
558 MinimumAmlResourceLength = AcpiGbl_ResourceAmlSerialBusSizes[
559 AmlResource->CommonSerialBus.Type];
560 ExtraStructBytes += AmlResource->CommonSerialBus.ResourceLength -
561 MinimumAmlResourceLength;
569 * Update the required buffer size for the internal descriptor structs
571 * Important: Round the size up for the appropriate alignment. This
572 * is a requirement on IA64.
574 if (AcpiUtGetResourceType (AmlBuffer) == ACPI_RESOURCE_NAME_SERIAL_BUS)
576 BufferSize = AcpiGbl_ResourceStructSerialBusSizes[
577 AmlResource->CommonSerialBus.Type] + ExtraStructBytes;
581 BufferSize = AcpiGbl_ResourceStructSizes[ResourceIndex] +
584 BufferSize = (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (BufferSize);
586 *SizeNeeded += BufferSize;
588 ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
589 "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
590 AcpiUtGetResourceType (AmlBuffer),
591 AcpiUtGetDescriptorLength (AmlBuffer), BufferSize));
594 * Point to the next resource within the AML stream using the length
595 * contained in the resource descriptor header
597 AmlBuffer += AcpiUtGetDescriptorLength (AmlBuffer);
600 /* Did not find an EndTag resource descriptor */
602 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
606 /*******************************************************************************
608 * FUNCTION: AcpiRsGetPciRoutingTableLength
610 * PARAMETERS: PackageObject - Pointer to the package object
611 * BufferSizeNeeded - UINT32 pointer of the size buffer
612 * needed to properly return the
617 * DESCRIPTION: Given a package representing a PCI routing table, this
618 * calculates the size of the corresponding linked list of
621 ******************************************************************************/
624 AcpiRsGetPciRoutingTableLength (
625 ACPI_OPERAND_OBJECT *PackageObject,
626 ACPI_SIZE *BufferSizeNeeded)
628 UINT32 NumberOfElements;
629 ACPI_SIZE TempSizeNeeded = 0;
630 ACPI_OPERAND_OBJECT **TopObjectList;
632 ACPI_OPERAND_OBJECT *PackageElement;
633 ACPI_OPERAND_OBJECT **SubObjectList;
638 ACPI_FUNCTION_TRACE (RsGetPciRoutingTableLength);
641 NumberOfElements = PackageObject->Package.Count;
644 * Calculate the size of the return buffer.
645 * The base size is the number of elements * the sizes of the
646 * structures. Additional space for the strings is added below.
647 * The minus one is to subtract the size of the UINT8 Source[1]
648 * member because it is added below.
650 * But each PRT_ENTRY structure has a pointer to a string and
651 * the size of that string must be found.
653 TopObjectList = PackageObject->Package.Elements;
655 for (Index = 0; Index < NumberOfElements; Index++)
657 /* Dereference the sub-package */
659 PackageElement = *TopObjectList;
661 /* We must have a valid Package object */
663 if (!PackageElement ||
664 (PackageElement->Common.Type != ACPI_TYPE_PACKAGE))
666 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
670 * The SubObjectList will now point to an array of the
671 * four IRQ elements: Address, Pin, Source and SourceIndex
673 SubObjectList = PackageElement->Package.Elements;
675 /* Scan the IrqTableElements for the Source Name String */
679 for (TableIndex = 0; TableIndex < 4 && !NameFound; TableIndex++)
681 if (*SubObjectList && /* Null object allowed */
683 ((ACPI_TYPE_STRING ==
684 (*SubObjectList)->Common.Type) ||
686 ((ACPI_TYPE_LOCAL_REFERENCE ==
687 (*SubObjectList)->Common.Type) &&
689 ((*SubObjectList)->Reference.Class ==
690 ACPI_REFCLASS_NAME))))
696 /* Look at the next element */
702 TempSizeNeeded += (sizeof (ACPI_PCI_ROUTING_TABLE) - 4);
704 /* Was a String type found? */
708 if ((*SubObjectList)->Common.Type == ACPI_TYPE_STRING)
711 * The length String.Length field does not include the
712 * terminating NULL, add 1
714 TempSizeNeeded += ((ACPI_SIZE)
715 (*SubObjectList)->String.Length + 1);
719 TempSizeNeeded += AcpiNsGetPathnameLength (
720 (*SubObjectList)->Reference.Node);
726 * If no name was found, then this is a NULL, which is
727 * translated as a UINT32 zero.
729 TempSizeNeeded += sizeof (UINT32);
732 /* Round up the size since each element must be aligned */
734 TempSizeNeeded = ACPI_ROUND_UP_TO_64BIT (TempSizeNeeded);
736 /* Point to the next ACPI_OPERAND_OBJECT */
742 * Add an extra element to the end of the list, essentially a
745 *BufferSizeNeeded = TempSizeNeeded + sizeof (ACPI_PCI_ROUTING_TABLE);
746 return_ACPI_STATUS (AE_OK);