1 /*******************************************************************************
3 * Module Name: rscalc - Calculate stream and list lengths
6 ******************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
122 #include "acnamesp.h"
124 #define _COMPONENT ACPI_RESOURCES
125 ACPI_MODULE_NAME ("rscalc")
128 /* Local prototypes */
134 static ACPI_RS_LENGTH
135 AcpiRsStructOptionLength (
136 ACPI_RESOURCE_SOURCE
*ResourceSource
);
139 AcpiRsStreamOptionLength (
140 UINT32 ResourceLength
,
141 UINT32 MinimumTotalLength
);
144 /*******************************************************************************
146 * FUNCTION: AcpiRsCountSetBits
148 * PARAMETERS: BitField - Field in which to count bits
150 * RETURN: Number of bits set within the field
152 * DESCRIPTION: Count the number of bits set in a resource field. Used for
153 * (Short descriptor) interrupt and DMA lists.
155 ******************************************************************************/
164 ACPI_FUNCTION_ENTRY ();
167 for (BitsSet
= 0; BitField
; BitsSet
++)
169 /* Zero the least significant bit that is set */
171 BitField
&= (BitField
- 1);
178 /*******************************************************************************
180 * FUNCTION: AcpiRsStructOptionLength
182 * PARAMETERS: ResourceSource - Pointer to optional descriptor field
186 * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
187 * ResourceSource fields in some Large descriptors. Used during
188 * list-to-stream conversion
190 ******************************************************************************/
192 static ACPI_RS_LENGTH
193 AcpiRsStructOptionLength (
194 ACPI_RESOURCE_SOURCE
*ResourceSource
)
196 ACPI_FUNCTION_ENTRY ();
200 * If the ResourceSource string is valid, return the size of the string
201 * (StringLength includes the NULL terminator) plus the size of the
202 * ResourceSourceIndex (1).
204 if (ResourceSource
->StringPtr
)
206 return ((ACPI_RS_LENGTH
) (ResourceSource
->StringLength
+ 1));
213 /*******************************************************************************
215 * FUNCTION: AcpiRsStreamOptionLength
217 * PARAMETERS: ResourceLength - Length from the resource header
218 * MinimumTotalLength - Minimum length of this resource, before
219 * any optional fields. Includes header size
221 * RETURN: Length of optional string (0 if no string present)
223 * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
224 * ResourceSource fields in some Large descriptors. Used during
225 * stream-to-list conversion
227 ******************************************************************************/
230 AcpiRsStreamOptionLength (
231 UINT32 ResourceLength
,
232 UINT32 MinimumAmlResourceLength
)
234 UINT32 StringLength
= 0;
237 ACPI_FUNCTION_ENTRY ();
241 * The ResourceSourceIndex and ResourceSource are optional elements of some
242 * Large-type resource descriptors.
246 * If the length of the actual resource descriptor is greater than the ACPI
247 * spec-defined minimum length, it means that a ResourceSourceIndex exists
248 * and is followed by a (required) null terminated string. The string length
249 * (including the null terminator) is the resource length minus the minimum
250 * length, minus one byte for the ResourceSourceIndex itself.
252 if (ResourceLength
> MinimumAmlResourceLength
)
254 /* Compute the length of the optional string */
256 StringLength
= ResourceLength
- MinimumAmlResourceLength
- 1;
260 * Round the length up to a multiple of the native word in order to
261 * guarantee that the entire resource descriptor is native word aligned
263 return ((UINT32
) ACPI_ROUND_UP_TO_NATIVE_WORD (StringLength
));
267 /*******************************************************************************
269 * FUNCTION: AcpiRsGetAmlLength
271 * PARAMETERS: Resource - Pointer to the resource linked list
272 * SizeNeeded - Where the required size is returned
276 * DESCRIPTION: Takes a linked list of internal resource descriptors and
277 * calculates the size buffer needed to hold the corresponding
278 * external resource byte stream.
280 ******************************************************************************/
284 ACPI_RESOURCE
*Resource
,
285 ACPI_SIZE
*SizeNeeded
)
287 ACPI_SIZE AmlSizeNeeded
= 0;
288 ACPI_RS_LENGTH TotalSize
;
291 ACPI_FUNCTION_TRACE (RsGetAmlLength
);
294 /* Traverse entire list of internal resource descriptors */
298 /* Validate the descriptor type */
300 if (Resource
->Type
> ACPI_RESOURCE_TYPE_MAX
)
302 return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE
);
305 /* Get the base size of the (external stream) resource descriptor */
307 TotalSize
= AcpiGbl_AmlResourceSizes
[Resource
->Type
];
310 * Augment the base size for descriptors with optional and/or
311 * variable-length fields
313 switch (Resource
->Type
)
315 case ACPI_RESOURCE_TYPE_VENDOR
:
317 * Vendor Defined Resource:
318 * For a Vendor Specific resource, if the Length is between 1 and 7
319 * it will be created as a Small Resource data type, otherwise it
320 * is a Large Resource data type.
322 if (Resource
->Data
.Vendor
.ByteLength
> 7)
324 /* Base size of a Large resource descriptor */
326 TotalSize
= sizeof (AML_RESOURCE_LARGE_HEADER
);
329 /* Add the size of the vendor-specific data */
331 TotalSize
= (ACPI_RS_LENGTH
)
332 (TotalSize
+ Resource
->Data
.Vendor
.ByteLength
);
336 case ACPI_RESOURCE_TYPE_END_TAG
:
339 * We are done -- return the accumulated total size.
341 *SizeNeeded
= AmlSizeNeeded
+ TotalSize
;
345 return_ACPI_STATUS (AE_OK
);
348 case ACPI_RESOURCE_TYPE_ADDRESS16
:
350 * 16-Bit Address Resource:
351 * Add the size of the optional ResourceSource info
353 TotalSize
= (ACPI_RS_LENGTH
)
354 (TotalSize
+ AcpiRsStructOptionLength (
355 &Resource
->Data
.Address16
.ResourceSource
));
359 case ACPI_RESOURCE_TYPE_ADDRESS32
:
361 * 32-Bit Address Resource:
362 * Add the size of the optional ResourceSource info
364 TotalSize
= (ACPI_RS_LENGTH
)
365 (TotalSize
+ AcpiRsStructOptionLength (
366 &Resource
->Data
.Address32
.ResourceSource
));
370 case ACPI_RESOURCE_TYPE_ADDRESS64
:
372 * 64-Bit Address Resource:
373 * Add the size of the optional ResourceSource info
375 TotalSize
= (ACPI_RS_LENGTH
)
376 (TotalSize
+ AcpiRsStructOptionLength (
377 &Resource
->Data
.Address64
.ResourceSource
));
381 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ
:
383 * Extended IRQ Resource:
384 * Add the size of each additional optional interrupt beyond the
385 * required 1 (4 bytes for each UINT32 interrupt number)
387 TotalSize
= (ACPI_RS_LENGTH
)
389 ((Resource
->Data
.ExtendedIrq
.InterruptCount
- 1) * 4) +
391 /* Add the size of the optional ResourceSource info */
393 AcpiRsStructOptionLength (
394 &Resource
->Data
.ExtendedIrq
.ResourceSource
));
402 /* Update the total */
404 AmlSizeNeeded
+= TotalSize
;
406 /* Point to the next object */
408 Resource
= ACPI_ADD_PTR (ACPI_RESOURCE
, Resource
, Resource
->Length
);
411 /* Did not find an EndTag resource descriptor */
413 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG
);
417 /*******************************************************************************
419 * FUNCTION: AcpiRsGetListLength
421 * PARAMETERS: AmlBuffer - Pointer to the resource byte stream
422 * AmlBufferLength - Size of AmlBuffer
423 * SizeNeeded - Where the size needed is returned
427 * DESCRIPTION: Takes an external resource byte stream and calculates the size
428 * buffer needed to hold the corresponding internal resource
429 * descriptor linked list.
431 ******************************************************************************/
434 AcpiRsGetListLength (
436 UINT32 AmlBufferLength
,
437 ACPI_SIZE
*SizeNeeded
)
444 UINT16 ResourceLength
;
445 UINT32 ExtraStructBytes
;
447 UINT8 MinimumAmlResourceLength
;
450 ACPI_FUNCTION_TRACE (RsGetListLength
);
454 EndAml
= AmlBuffer
+ AmlBufferLength
;
456 /* Walk the list of AML resource descriptors */
458 while (AmlBuffer
< EndAml
)
460 /* Validate the Resource Type and Resource Length */
462 Status
= AcpiUtValidateResource (AmlBuffer
, &ResourceIndex
);
463 if (ACPI_FAILURE (Status
))
465 return_ACPI_STATUS (Status
);
468 /* Get the resource length and base (minimum) AML size */
470 ResourceLength
= AcpiUtGetResourceLength (AmlBuffer
);
471 MinimumAmlResourceLength
= AcpiGbl_ResourceAmlSizes
[ResourceIndex
];
474 * Augment the size for descriptors with optional
475 * and/or variable length fields
477 ExtraStructBytes
= 0;
478 Buffer
= AmlBuffer
+ AcpiUtGetResourceHeaderLength (AmlBuffer
);
480 switch (AcpiUtGetResourceType (AmlBuffer
))
482 case ACPI_RESOURCE_NAME_IRQ
:
485 * Get the number of bits set in the 16-bit IRQ mask
487 ACPI_MOVE_16_TO_16 (&Temp16
, Buffer
);
488 ExtraStructBytes
= AcpiRsCountSetBits (Temp16
);
492 case ACPI_RESOURCE_NAME_DMA
:
495 * Get the number of bits set in the 8-bit DMA mask
497 ExtraStructBytes
= AcpiRsCountSetBits (*Buffer
);
501 case ACPI_RESOURCE_NAME_VENDOR_SMALL
:
502 case ACPI_RESOURCE_NAME_VENDOR_LARGE
:
505 * Get the number of vendor data bytes
507 ExtraStructBytes
= ResourceLength
;
511 case ACPI_RESOURCE_NAME_END_TAG
:
514 * This is the normal exit, add size of EndTag
516 *SizeNeeded
+= ACPI_RS_SIZE_MIN
;
517 return_ACPI_STATUS (AE_OK
);
520 case ACPI_RESOURCE_NAME_ADDRESS32
:
521 case ACPI_RESOURCE_NAME_ADDRESS16
:
522 case ACPI_RESOURCE_NAME_ADDRESS64
:
525 * Add the size of the optional ResourceSource
527 ExtraStructBytes
= AcpiRsStreamOptionLength (
528 ResourceLength
, MinimumAmlResourceLength
);
532 case ACPI_RESOURCE_NAME_EXTENDED_IRQ
:
534 * Extended IRQ Resource:
535 * Using the InterruptTableLength, add 4 bytes for each additional
536 * interrupt. Note: at least one interrupt is required and is
537 * included in the minimum descriptor size (reason for the -1)
539 ExtraStructBytes
= (Buffer
[1] - 1) * sizeof (UINT32
);
541 /* Add the size of the optional ResourceSource */
543 ExtraStructBytes
+= AcpiRsStreamOptionLength (
544 ResourceLength
- ExtraStructBytes
, MinimumAmlResourceLength
);
553 * Update the required buffer size for the internal descriptor structs
555 * Important: Round the size up for the appropriate alignment. This
556 * is a requirement on IA64.
558 BufferSize
= AcpiGbl_ResourceStructSizes
[ResourceIndex
] +
560 BufferSize
= (UINT32
) ACPI_ROUND_UP_TO_NATIVE_WORD (BufferSize
);
562 *SizeNeeded
+= BufferSize
;
564 ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES
,
565 "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
566 AcpiUtGetResourceType (AmlBuffer
),
567 AcpiUtGetDescriptorLength (AmlBuffer
), BufferSize
));
570 * Point to the next resource within the AML stream using the length
571 * contained in the resource descriptor header
573 AmlBuffer
+= AcpiUtGetDescriptorLength (AmlBuffer
);
576 /* Did not find an EndTag resource descriptor */
578 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG
);
582 /*******************************************************************************
584 * FUNCTION: AcpiRsGetPciRoutingTableLength
586 * PARAMETERS: PackageObject - Pointer to the package object
587 * BufferSizeNeeded - UINT32 pointer of the size buffer
588 * needed to properly return the
593 * DESCRIPTION: Given a package representing a PCI routing table, this
594 * calculates the size of the corresponding linked list of
597 ******************************************************************************/
600 AcpiRsGetPciRoutingTableLength (
601 ACPI_OPERAND_OBJECT
*PackageObject
,
602 ACPI_SIZE
*BufferSizeNeeded
)
604 UINT32 NumberOfElements
;
605 ACPI_SIZE TempSizeNeeded
= 0;
606 ACPI_OPERAND_OBJECT
**TopObjectList
;
608 ACPI_OPERAND_OBJECT
*PackageElement
;
609 ACPI_OPERAND_OBJECT
**SubObjectList
;
614 ACPI_FUNCTION_TRACE (RsGetPciRoutingTableLength
);
617 NumberOfElements
= PackageObject
->Package
.Count
;
620 * Calculate the size of the return buffer.
621 * The base size is the number of elements * the sizes of the
622 * structures. Additional space for the strings is added below.
623 * The minus one is to subtract the size of the UINT8 Source[1]
624 * member because it is added below.
626 * But each PRT_ENTRY structure has a pointer to a string and
627 * the size of that string must be found.
629 TopObjectList
= PackageObject
->Package
.Elements
;
631 for (Index
= 0; Index
< NumberOfElements
; Index
++)
633 /* Dereference the sub-package */
635 PackageElement
= *TopObjectList
;
638 * The SubObjectList will now point to an array of the
639 * four IRQ elements: Address, Pin, Source and SourceIndex
641 SubObjectList
= PackageElement
->Package
.Elements
;
643 /* Scan the IrqTableElements for the Source Name String */
647 for (TableIndex
= 0; TableIndex
< 4 && !NameFound
; TableIndex
++)
649 if (*SubObjectList
&& /* Null object allowed */
651 ((ACPI_TYPE_STRING
==
652 ACPI_GET_OBJECT_TYPE (*SubObjectList
)) ||
654 ((ACPI_TYPE_LOCAL_REFERENCE
==
655 ACPI_GET_OBJECT_TYPE (*SubObjectList
)) &&
657 ((*SubObjectList
)->Reference
.Opcode
==
658 AML_INT_NAMEPATH_OP
))))
664 /* Look at the next element */
670 TempSizeNeeded
+= (sizeof (ACPI_PCI_ROUTING_TABLE
) - 4);
672 /* Was a String type found? */
676 if (ACPI_GET_OBJECT_TYPE (*SubObjectList
) == ACPI_TYPE_STRING
)
679 * The length String.Length field does not include the
680 * terminating NULL, add 1
682 TempSizeNeeded
+= ((ACPI_SIZE
)
683 (*SubObjectList
)->String
.Length
+ 1);
687 TempSizeNeeded
+= AcpiNsGetPathnameLength (
688 (*SubObjectList
)->Reference
.Node
);
694 * If no name was found, then this is a NULL, which is
695 * translated as a UINT32 zero.
697 TempSizeNeeded
+= sizeof (UINT32
);
700 /* Round up the size since each element must be aligned */
702 TempSizeNeeded
= ACPI_ROUND_UP_TO_64BIT (TempSizeNeeded
);
704 /* Point to the next ACPI_OPERAND_OBJECT */
710 * Add an extra element to the end of the list, essentially a
713 *BufferSizeNeeded
= TempSizeNeeded
+ sizeof (ACPI_PCI_ROUTING_TABLE
);
714 return_ACPI_STATUS (AE_OK
);