xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/resources/rscalc.c (revision 7a74a5df454197933bc6e80a542102362ee98703)
1 /*******************************************************************************
2  *
3  * Module Name: rscalc - Calculate stream and list lengths
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights.  You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code.  No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision.  In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change.  Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee.  Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution.  In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government.  In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define __RSCALC_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acresrc.h"
121 #include "acnamesp.h"
122 
123 
124 #define _COMPONENT          ACPI_RESOURCES
125         ACPI_MODULE_NAME    ("rscalc")
126 
127 
128 /* Local prototypes */
129 
130 static UINT8
131 AcpiRsCountSetBits (
132     UINT16                  BitField);
133 
134 static ACPI_RS_LENGTH
135 AcpiRsStructOptionLength (
136     ACPI_RESOURCE_SOURCE    *ResourceSource);
137 
138 static UINT32
139 AcpiRsStreamOptionLength (
140     UINT32                  ResourceLength,
141     UINT32                  MinimumTotalLength);
142 
143 
144 /*******************************************************************************
145  *
146  * FUNCTION:    AcpiRsCountSetBits
147  *
148  * PARAMETERS:  BitField        - Field in which to count bits
149  *
150  * RETURN:      Number of bits set within the field
151  *
152  * DESCRIPTION: Count the number of bits set in a resource field. Used for
153  *              (Short descriptor) interrupt and DMA lists.
154  *
155  ******************************************************************************/
156 
157 static UINT8
158 AcpiRsCountSetBits (
159     UINT16                  BitField)
160 {
161     UINT8                   BitsSet;
162 
163 
164     ACPI_FUNCTION_ENTRY ();
165 
166 
167     for (BitsSet = 0; BitField; BitsSet++)
168     {
169         /* Zero the least significant bit that is set */
170 
171         BitField &= (UINT16) (BitField - 1);
172     }
173 
174     return (BitsSet);
175 }
176 
177 
178 /*******************************************************************************
179  *
180  * FUNCTION:    AcpiRsStructOptionLength
181  *
182  * PARAMETERS:  ResourceSource      - Pointer to optional descriptor field
183  *
184  * RETURN:      Status
185  *
186  * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
187  *              ResourceSource fields in some Large descriptors. Used during
188  *              list-to-stream conversion
189  *
190  ******************************************************************************/
191 
192 static ACPI_RS_LENGTH
193 AcpiRsStructOptionLength (
194     ACPI_RESOURCE_SOURCE    *ResourceSource)
195 {
196     ACPI_FUNCTION_ENTRY ();
197 
198 
199     /*
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).
203      */
204     if (ResourceSource->StringPtr)
205     {
206         return ((ACPI_RS_LENGTH) (ResourceSource->StringLength + 1));
207     }
208 
209     return (0);
210 }
211 
212 
213 /*******************************************************************************
214  *
215  * FUNCTION:    AcpiRsStreamOptionLength
216  *
217  * PARAMETERS:  ResourceLength      - Length from the resource header
218  *              MinimumTotalLength  - Minimum length of this resource, before
219  *                                    any optional fields. Includes header size
220  *
221  * RETURN:      Length of optional string (0 if no string present)
222  *
223  * DESCRIPTION: Common code to handle optional ResourceSourceIndex and
224  *              ResourceSource fields in some Large descriptors. Used during
225  *              stream-to-list conversion
226  *
227  ******************************************************************************/
228 
229 static UINT32
230 AcpiRsStreamOptionLength (
231     UINT32                  ResourceLength,
232     UINT32                  MinimumAmlResourceLength)
233 {
234     UINT32                  StringLength = 0;
235 
236 
237     ACPI_FUNCTION_ENTRY ();
238 
239 
240     /*
241      * The ResourceSourceIndex and ResourceSource are optional elements of some
242      * Large-type resource descriptors.
243      */
244 
245     /*
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.
251      */
252     if (ResourceLength > MinimumAmlResourceLength)
253     {
254         /* Compute the length of the optional string */
255 
256         StringLength = ResourceLength - MinimumAmlResourceLength - 1;
257     }
258 
259     /*
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
262      */
263     return ((UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (StringLength));
264 }
265 
266 
267 /*******************************************************************************
268  *
269  * FUNCTION:    AcpiRsGetAmlLength
270  *
271  * PARAMETERS:  Resource            - Pointer to the resource linked list
272  *              SizeNeeded          - Where the required size is returned
273  *
274  * RETURN:      Status
275  *
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.
279  *
280  ******************************************************************************/
281 
282 ACPI_STATUS
283 AcpiRsGetAmlLength (
284     ACPI_RESOURCE           *Resource,
285     ACPI_SIZE               *SizeNeeded)
286 {
287     ACPI_SIZE               AmlSizeNeeded = 0;
288     ACPI_RS_LENGTH          TotalSize;
289 
290 
291     ACPI_FUNCTION_TRACE (RsGetAmlLength);
292 
293 
294     /* Traverse entire list of internal resource descriptors */
295 
296     while (Resource)
297     {
298         /* Validate the descriptor type */
299 
300         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
301         {
302             return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
303         }
304 
305         /* Get the base size of the (external stream) resource descriptor */
306 
307         TotalSize = AcpiGbl_AmlResourceSizes [Resource->Type];
308 
309         /*
310          * Augment the base size for descriptors with optional and/or
311          * variable-length fields
312          */
313         switch (Resource->Type)
314         {
315         case ACPI_RESOURCE_TYPE_IRQ:
316 
317             /* Length can be 3 or 2 */
318 
319             if (Resource->Data.Irq.DescriptorLength == 2)
320             {
321                 TotalSize--;
322             }
323             break;
324 
325 
326         case ACPI_RESOURCE_TYPE_START_DEPENDENT:
327 
328             /* Length can be 1 or 0 */
329 
330             if (Resource->Data.Irq.DescriptorLength == 0)
331             {
332                 TotalSize--;
333             }
334             break;
335 
336 
337         case ACPI_RESOURCE_TYPE_VENDOR:
338             /*
339              * Vendor Defined Resource:
340              * For a Vendor Specific resource, if the Length is between 1 and 7
341              * it will be created as a Small Resource data type, otherwise it
342              * is a Large Resource data type.
343              */
344             if (Resource->Data.Vendor.ByteLength > 7)
345             {
346                 /* Base size of a Large resource descriptor */
347 
348                 TotalSize = sizeof (AML_RESOURCE_LARGE_HEADER);
349             }
350 
351             /* Add the size of the vendor-specific data */
352 
353             TotalSize = (ACPI_RS_LENGTH)
354                 (TotalSize + Resource->Data.Vendor.ByteLength);
355             break;
356 
357 
358         case ACPI_RESOURCE_TYPE_END_TAG:
359             /*
360              * End Tag:
361              * We are done -- return the accumulated total size.
362              */
363             *SizeNeeded = AmlSizeNeeded + TotalSize;
364 
365             /* Normal exit */
366 
367             return_ACPI_STATUS (AE_OK);
368 
369 
370         case ACPI_RESOURCE_TYPE_ADDRESS16:
371             /*
372              * 16-Bit Address Resource:
373              * Add the size of the optional ResourceSource info
374              */
375             TotalSize = (ACPI_RS_LENGTH)
376                 (TotalSize + AcpiRsStructOptionLength (
377                                 &Resource->Data.Address16.ResourceSource));
378             break;
379 
380 
381         case ACPI_RESOURCE_TYPE_ADDRESS32:
382             /*
383              * 32-Bit Address Resource:
384              * Add the size of the optional ResourceSource info
385              */
386             TotalSize = (ACPI_RS_LENGTH)
387                 (TotalSize + AcpiRsStructOptionLength (
388                                 &Resource->Data.Address32.ResourceSource));
389             break;
390 
391 
392         case ACPI_RESOURCE_TYPE_ADDRESS64:
393             /*
394              * 64-Bit Address Resource:
395              * Add the size of the optional ResourceSource info
396              */
397             TotalSize = (ACPI_RS_LENGTH)
398                 (TotalSize + AcpiRsStructOptionLength (
399                                 &Resource->Data.Address64.ResourceSource));
400             break;
401 
402 
403         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
404             /*
405              * Extended IRQ Resource:
406              * Add the size of each additional optional interrupt beyond the
407              * required 1 (4 bytes for each UINT32 interrupt number)
408              */
409             TotalSize = (ACPI_RS_LENGTH)
410                 (TotalSize +
411                 ((Resource->Data.ExtendedIrq.InterruptCount - 1) * 4) +
412 
413                 /* Add the size of the optional ResourceSource info */
414 
415                 AcpiRsStructOptionLength (
416                     &Resource->Data.ExtendedIrq.ResourceSource));
417             break;
418 
419 
420         case ACPI_RESOURCE_TYPE_GPIO:
421 
422             TotalSize = (ACPI_RS_LENGTH) (TotalSize + (Resource->Data.Gpio.PinTableLength * 2) +
423                 Resource->Data.Gpio.ResourceSource.StringLength +
424                 Resource->Data.Gpio.VendorLength);
425 
426             break;
427 
428 
429         case ACPI_RESOURCE_TYPE_SERIAL_BUS:
430 
431             TotalSize = AcpiGbl_AmlResourceSerialBusSizes [Resource->Data.CommonSerialBus.Type];
432 
433             TotalSize = (ACPI_RS_LENGTH) (TotalSize +
434                 Resource->Data.I2cSerialBus.ResourceSource.StringLength +
435                 Resource->Data.I2cSerialBus.VendorLength);
436 
437             break;
438 
439 
440         default:
441             break;
442         }
443 
444         /* Update the total */
445 
446         AmlSizeNeeded += TotalSize;
447 
448         /* Point to the next object */
449 
450         Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
451     }
452 
453     /* Did not find an EndTag resource descriptor */
454 
455     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
456 }
457 
458 
459 /*******************************************************************************
460  *
461  * FUNCTION:    AcpiRsGetListLength
462  *
463  * PARAMETERS:  AmlBuffer           - Pointer to the resource byte stream
464  *              AmlBufferLength     - Size of AmlBuffer
465  *              SizeNeeded          - Where the size needed is returned
466  *
467  * RETURN:      Status
468  *
469  * DESCRIPTION: Takes an external resource byte stream and calculates the size
470  *              buffer needed to hold the corresponding internal resource
471  *              descriptor linked list.
472  *
473  ******************************************************************************/
474 
475 ACPI_STATUS
476 AcpiRsGetListLength (
477     UINT8                   *AmlBuffer,
478     UINT32                  AmlBufferLength,
479     ACPI_SIZE               *SizeNeeded)
480 {
481     ACPI_STATUS             Status;
482     UINT8                   *EndAml;
483     UINT8                   *Buffer;
484     UINT32                  BufferSize;
485     UINT16                  Temp16;
486     UINT16                  ResourceLength;
487     UINT32                  ExtraStructBytes;
488     UINT8                   ResourceIndex;
489     UINT8                   MinimumAmlResourceLength;
490     AML_RESOURCE            *AmlResource;
491 
492 
493     ACPI_FUNCTION_TRACE (RsGetListLength);
494 
495 
496     *SizeNeeded = ACPI_RS_SIZE_MIN;         /* Minimum size is one EndTag */
497     EndAml = AmlBuffer + AmlBufferLength;
498 
499     /* Walk the list of AML resource descriptors */
500 
501     while (AmlBuffer < EndAml)
502     {
503         /* Validate the Resource Type and Resource Length */
504 
505         Status = AcpiUtValidateResource (AmlBuffer, &ResourceIndex);
506         if (ACPI_FAILURE (Status))
507         {
508             /*
509              * Exit on failure. Cannot continue because the descriptor length
510              * may be bogus also.
511              */
512             return_ACPI_STATUS (Status);
513         }
514 
515         AmlResource = (void *) AmlBuffer;
516 
517         /* Get the resource length and base (minimum) AML size */
518 
519         ResourceLength = AcpiUtGetResourceLength (AmlBuffer);
520         MinimumAmlResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
521 
522         /*
523          * Augment the size for descriptors with optional
524          * and/or variable length fields
525          */
526         ExtraStructBytes = 0;
527         Buffer = AmlBuffer + AcpiUtGetResourceHeaderLength (AmlBuffer);
528 
529         switch (AcpiUtGetResourceType (AmlBuffer))
530         {
531         case ACPI_RESOURCE_NAME_IRQ:
532             /*
533              * IRQ Resource:
534              * Get the number of bits set in the 16-bit IRQ mask
535              */
536             ACPI_MOVE_16_TO_16 (&Temp16, Buffer);
537             ExtraStructBytes = AcpiRsCountSetBits (Temp16);
538             break;
539 
540 
541         case ACPI_RESOURCE_NAME_DMA:
542             /*
543              * DMA Resource:
544              * Get the number of bits set in the 8-bit DMA mask
545              */
546             ExtraStructBytes = AcpiRsCountSetBits (*Buffer);
547             break;
548 
549 
550         case ACPI_RESOURCE_NAME_VENDOR_SMALL:
551         case ACPI_RESOURCE_NAME_VENDOR_LARGE:
552             /*
553              * Vendor Resource:
554              * Get the number of vendor data bytes
555              */
556             ExtraStructBytes = ResourceLength;
557             break;
558 
559 
560         case ACPI_RESOURCE_NAME_END_TAG:
561             /*
562              * End Tag: This is the normal exit
563              */
564             return_ACPI_STATUS (AE_OK);
565 
566 
567         case ACPI_RESOURCE_NAME_ADDRESS32:
568         case ACPI_RESOURCE_NAME_ADDRESS16:
569         case ACPI_RESOURCE_NAME_ADDRESS64:
570             /*
571              * Address Resource:
572              * Add the size of the optional ResourceSource
573              */
574             ExtraStructBytes = AcpiRsStreamOptionLength (
575                 ResourceLength, MinimumAmlResourceLength);
576             break;
577 
578 
579         case ACPI_RESOURCE_NAME_EXTENDED_IRQ:
580             /*
581              * Extended IRQ Resource:
582              * Using the InterruptTableLength, add 4 bytes for each additional
583              * interrupt. Note: at least one interrupt is required and is
584              * included in the minimum descriptor size (reason for the -1)
585              */
586             ExtraStructBytes = (Buffer[1] - 1) * sizeof (UINT32);
587 
588             /* Add the size of the optional ResourceSource */
589 
590             ExtraStructBytes += AcpiRsStreamOptionLength (
591                 ResourceLength - ExtraStructBytes, MinimumAmlResourceLength);
592             break;
593 
594         case ACPI_RESOURCE_NAME_GPIO:
595 
596             /* Vendor data is optional */
597 
598             if (AmlResource->Gpio.VendorLength)
599             {
600                 ExtraStructBytes += AmlResource->Gpio.VendorOffset -
601                     AmlResource->Gpio.PinTableOffset + AmlResource->Gpio.VendorLength;
602             }
603             else
604             {
605                 ExtraStructBytes += AmlResource->LargeHeader.ResourceLength +
606                     sizeof (AML_RESOURCE_LARGE_HEADER) -
607                     AmlResource->Gpio.PinTableOffset;
608             }
609             break;
610 
611         case ACPI_RESOURCE_NAME_SERIAL_BUS:
612 
613             MinimumAmlResourceLength = AcpiGbl_ResourceAmlSerialBusSizes[
614                 AmlResource->CommonSerialBus.Type];
615             ExtraStructBytes += AmlResource->CommonSerialBus.ResourceLength -
616                 MinimumAmlResourceLength;
617             break;
618 
619         default:
620             break;
621         }
622 
623         /*
624          * Update the required buffer size for the internal descriptor structs
625          *
626          * Important: Round the size up for the appropriate alignment. This
627          * is a requirement on IA64.
628          */
629         if (AcpiUtGetResourceType (AmlBuffer) == ACPI_RESOURCE_NAME_SERIAL_BUS)
630         {
631             BufferSize = AcpiGbl_ResourceStructSerialBusSizes[
632                 AmlResource->CommonSerialBus.Type] + ExtraStructBytes;
633         }
634         else
635         {
636             BufferSize = AcpiGbl_ResourceStructSizes[ResourceIndex] +
637                         ExtraStructBytes;
638         }
639         BufferSize = (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (BufferSize);
640 
641         *SizeNeeded += BufferSize;
642 
643         ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
644             "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
645             AcpiUtGetResourceType (AmlBuffer),
646             AcpiUtGetDescriptorLength (AmlBuffer), BufferSize));
647 
648         /*
649          * Point to the next resource within the AML stream using the length
650          * contained in the resource descriptor header
651          */
652         AmlBuffer += AcpiUtGetDescriptorLength (AmlBuffer);
653     }
654 
655     /* Did not find an EndTag resource descriptor */
656 
657     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
658 }
659 
660 
661 /*******************************************************************************
662  *
663  * FUNCTION:    AcpiRsGetPciRoutingTableLength
664  *
665  * PARAMETERS:  PackageObject           - Pointer to the package object
666  *              BufferSizeNeeded        - UINT32 pointer of the size buffer
667  *                                        needed to properly return the
668  *                                        parsed data
669  *
670  * RETURN:      Status
671  *
672  * DESCRIPTION: Given a package representing a PCI routing table, this
673  *              calculates the size of the corresponding linked list of
674  *              descriptions.
675  *
676  ******************************************************************************/
677 
678 ACPI_STATUS
679 AcpiRsGetPciRoutingTableLength (
680     ACPI_OPERAND_OBJECT     *PackageObject,
681     ACPI_SIZE               *BufferSizeNeeded)
682 {
683     UINT32                  NumberOfElements;
684     ACPI_SIZE               TempSizeNeeded = 0;
685     ACPI_OPERAND_OBJECT     **TopObjectList;
686     UINT32                  Index;
687     ACPI_OPERAND_OBJECT     *PackageElement;
688     ACPI_OPERAND_OBJECT     **SubObjectList;
689     BOOLEAN                 NameFound;
690     UINT32                  TableIndex;
691 
692 
693     ACPI_FUNCTION_TRACE (RsGetPciRoutingTableLength);
694 
695 
696     NumberOfElements = PackageObject->Package.Count;
697 
698     /*
699      * Calculate the size of the return buffer.
700      * The base size is the number of elements * the sizes of the
701      * structures.  Additional space for the strings is added below.
702      * The minus one is to subtract the size of the UINT8 Source[1]
703      * member because it is added below.
704      *
705      * But each PRT_ENTRY structure has a pointer to a string and
706      * the size of that string must be found.
707      */
708     TopObjectList = PackageObject->Package.Elements;
709 
710     for (Index = 0; Index < NumberOfElements; Index++)
711     {
712         /* Dereference the sub-package */
713 
714         PackageElement = *TopObjectList;
715 
716         /* We must have a valid Package object */
717 
718         if (!PackageElement ||
719             (PackageElement->Common.Type != ACPI_TYPE_PACKAGE))
720         {
721             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
722         }
723 
724         /*
725          * The SubObjectList will now point to an array of the
726          * four IRQ elements: Address, Pin, Source and SourceIndex
727          */
728         SubObjectList = PackageElement->Package.Elements;
729 
730         /* Scan the IrqTableElements for the Source Name String */
731 
732         NameFound = FALSE;
733 
734         for (TableIndex = 0; TableIndex < 4 && !NameFound; TableIndex++)
735         {
736             if (*SubObjectList && /* Null object allowed */
737 
738                 ((ACPI_TYPE_STRING ==
739                     (*SubObjectList)->Common.Type) ||
740 
741                 ((ACPI_TYPE_LOCAL_REFERENCE ==
742                     (*SubObjectList)->Common.Type) &&
743 
744                     ((*SubObjectList)->Reference.Class ==
745                         ACPI_REFCLASS_NAME))))
746             {
747                 NameFound = TRUE;
748             }
749             else
750             {
751                 /* Look at the next element */
752 
753                 SubObjectList++;
754             }
755         }
756 
757         TempSizeNeeded += (sizeof (ACPI_PCI_ROUTING_TABLE) - 4);
758 
759         /* Was a String type found? */
760 
761         if (NameFound)
762         {
763             if ((*SubObjectList)->Common.Type == ACPI_TYPE_STRING)
764             {
765                 /*
766                  * The length String.Length field does not include the
767                  * terminating NULL, add 1
768                  */
769                 TempSizeNeeded += ((ACPI_SIZE)
770                     (*SubObjectList)->String.Length + 1);
771             }
772             else
773             {
774                 TempSizeNeeded += AcpiNsGetPathnameLength (
775                                     (*SubObjectList)->Reference.Node);
776             }
777         }
778         else
779         {
780             /*
781              * If no name was found, then this is a NULL, which is
782              * translated as a UINT32 zero.
783              */
784             TempSizeNeeded += sizeof (UINT32);
785         }
786 
787         /* Round up the size since each element must be aligned */
788 
789         TempSizeNeeded = ACPI_ROUND_UP_TO_64BIT (TempSizeNeeded);
790 
791         /* Point to the next ACPI_OPERAND_OBJECT */
792 
793         TopObjectList++;
794     }
795 
796     /*
797      * Add an extra element to the end of the list, essentially a
798      * NULL terminator
799      */
800     *BufferSizeNeeded = TempSizeNeeded + sizeof (ACPI_PCI_ROUTING_TABLE);
801     return_ACPI_STATUS (AE_OK);
802 }
803