xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/resources/rscalc.c (revision 9bd024edbe5d06358e4285100a3240e4d138a712)
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 - 2014, 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  *              ResourceListSize    - Size of the resource linked list
273  *              SizeNeeded          - Where the required size is returned
274  *
275  * RETURN:      Status
276  *
277  * DESCRIPTION: Takes a linked list of internal resource descriptors and
278  *              calculates the size buffer needed to hold the corresponding
279  *              external resource byte stream.
280  *
281  ******************************************************************************/
282 
283 ACPI_STATUS
284 AcpiRsGetAmlLength (
285     ACPI_RESOURCE           *Resource,
286     ACPI_SIZE               ResourceListSize,
287     ACPI_SIZE               *SizeNeeded)
288 {
289     ACPI_SIZE               AmlSizeNeeded = 0;
290     ACPI_RESOURCE           *ResourceEnd;
291     ACPI_RS_LENGTH          TotalSize;
292 
293 
294     ACPI_FUNCTION_TRACE (RsGetAmlLength);
295 
296 
297     /* Traverse entire list of internal resource descriptors */
298 
299     ResourceEnd = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, ResourceListSize);
300     while (Resource < ResourceEnd)
301     {
302         /* Validate the descriptor type */
303 
304         if (Resource->Type > ACPI_RESOURCE_TYPE_MAX)
305         {
306             return_ACPI_STATUS (AE_AML_INVALID_RESOURCE_TYPE);
307         }
308 
309         /* Sanity check the length. It must not be zero, or we loop forever */
310 
311         if (!Resource->Length)
312         {
313             return_ACPI_STATUS (AE_AML_BAD_RESOURCE_LENGTH);
314         }
315 
316         /* Get the base size of the (external stream) resource descriptor */
317 
318         TotalSize = AcpiGbl_AmlResourceSizes [Resource->Type];
319 
320         /*
321          * Augment the base size for descriptors with optional and/or
322          * variable-length fields
323          */
324         switch (Resource->Type)
325         {
326         case ACPI_RESOURCE_TYPE_IRQ:
327 
328             /* Length can be 3 or 2 */
329 
330             if (Resource->Data.Irq.DescriptorLength == 2)
331             {
332                 TotalSize--;
333             }
334             break;
335 
336 
337         case ACPI_RESOURCE_TYPE_START_DEPENDENT:
338 
339             /* Length can be 1 or 0 */
340 
341             if (Resource->Data.Irq.DescriptorLength == 0)
342             {
343                 TotalSize--;
344             }
345             break;
346 
347 
348         case ACPI_RESOURCE_TYPE_VENDOR:
349             /*
350              * Vendor Defined Resource:
351              * For a Vendor Specific resource, if the Length is between 1 and 7
352              * it will be created as a Small Resource data type, otherwise it
353              * is a Large Resource data type.
354              */
355             if (Resource->Data.Vendor.ByteLength > 7)
356             {
357                 /* Base size of a Large resource descriptor */
358 
359                 TotalSize = sizeof (AML_RESOURCE_LARGE_HEADER);
360             }
361 
362             /* Add the size of the vendor-specific data */
363 
364             TotalSize = (ACPI_RS_LENGTH)
365                 (TotalSize + Resource->Data.Vendor.ByteLength);
366             break;
367 
368 
369         case ACPI_RESOURCE_TYPE_END_TAG:
370             /*
371              * End Tag:
372              * We are done -- return the accumulated total size.
373              */
374             *SizeNeeded = AmlSizeNeeded + TotalSize;
375 
376             /* Normal exit */
377 
378             return_ACPI_STATUS (AE_OK);
379 
380 
381         case ACPI_RESOURCE_TYPE_ADDRESS16:
382             /*
383              * 16-Bit Address Resource:
384              * Add the size of the optional ResourceSource info
385              */
386             TotalSize = (ACPI_RS_LENGTH)
387                 (TotalSize + AcpiRsStructOptionLength (
388                                 &Resource->Data.Address16.ResourceSource));
389             break;
390 
391 
392         case ACPI_RESOURCE_TYPE_ADDRESS32:
393             /*
394              * 32-Bit Address Resource:
395              * Add the size of the optional ResourceSource info
396              */
397             TotalSize = (ACPI_RS_LENGTH)
398                 (TotalSize + AcpiRsStructOptionLength (
399                                 &Resource->Data.Address32.ResourceSource));
400             break;
401 
402 
403         case ACPI_RESOURCE_TYPE_ADDRESS64:
404             /*
405              * 64-Bit Address Resource:
406              * Add the size of the optional ResourceSource info
407              */
408             TotalSize = (ACPI_RS_LENGTH)
409                 (TotalSize + AcpiRsStructOptionLength (
410                                 &Resource->Data.Address64.ResourceSource));
411             break;
412 
413 
414         case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
415             /*
416              * Extended IRQ Resource:
417              * Add the size of each additional optional interrupt beyond the
418              * required 1 (4 bytes for each UINT32 interrupt number)
419              */
420             TotalSize = (ACPI_RS_LENGTH)
421                 (TotalSize +
422                 ((Resource->Data.ExtendedIrq.InterruptCount - 1) * 4) +
423 
424                 /* Add the size of the optional ResourceSource info */
425 
426                 AcpiRsStructOptionLength (
427                     &Resource->Data.ExtendedIrq.ResourceSource));
428             break;
429 
430 
431         case ACPI_RESOURCE_TYPE_GPIO:
432 
433             TotalSize = (ACPI_RS_LENGTH) (TotalSize + (Resource->Data.Gpio.PinTableLength * 2) +
434                 Resource->Data.Gpio.ResourceSource.StringLength +
435                 Resource->Data.Gpio.VendorLength);
436 
437             break;
438 
439 
440         case ACPI_RESOURCE_TYPE_SERIAL_BUS:
441 
442             TotalSize = AcpiGbl_AmlResourceSerialBusSizes [Resource->Data.CommonSerialBus.Type];
443 
444             TotalSize = (ACPI_RS_LENGTH) (TotalSize +
445                 Resource->Data.I2cSerialBus.ResourceSource.StringLength +
446                 Resource->Data.I2cSerialBus.VendorLength);
447 
448             break;
449 
450         default:
451 
452             break;
453         }
454 
455         /* Update the total */
456 
457         AmlSizeNeeded += TotalSize;
458 
459         /* Point to the next object */
460 
461         Resource = ACPI_ADD_PTR (ACPI_RESOURCE, Resource, Resource->Length);
462     }
463 
464     /* Did not find an EndTag resource descriptor */
465 
466     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
467 }
468 
469 
470 /*******************************************************************************
471  *
472  * FUNCTION:    AcpiRsGetListLength
473  *
474  * PARAMETERS:  AmlBuffer           - Pointer to the resource byte stream
475  *              AmlBufferLength     - Size of AmlBuffer
476  *              SizeNeeded          - Where the size needed is returned
477  *
478  * RETURN:      Status
479  *
480  * DESCRIPTION: Takes an external resource byte stream and calculates the size
481  *              buffer needed to hold the corresponding internal resource
482  *              descriptor linked list.
483  *
484  ******************************************************************************/
485 
486 ACPI_STATUS
487 AcpiRsGetListLength (
488     UINT8                   *AmlBuffer,
489     UINT32                  AmlBufferLength,
490     ACPI_SIZE               *SizeNeeded)
491 {
492     ACPI_STATUS             Status;
493     UINT8                   *EndAml;
494     UINT8                   *Buffer;
495     UINT32                  BufferSize;
496     UINT16                  Temp16;
497     UINT16                  ResourceLength;
498     UINT32                  ExtraStructBytes;
499     UINT8                   ResourceIndex;
500     UINT8                   MinimumAmlResourceLength;
501     AML_RESOURCE            *AmlResource;
502 
503 
504     ACPI_FUNCTION_TRACE (RsGetListLength);
505 
506 
507     *SizeNeeded = ACPI_RS_SIZE_MIN;         /* Minimum size is one EndTag */
508     EndAml = AmlBuffer + AmlBufferLength;
509 
510     /* Walk the list of AML resource descriptors */
511 
512     while (AmlBuffer < EndAml)
513     {
514         /* Validate the Resource Type and Resource Length */
515 
516         Status = AcpiUtValidateResource (NULL, AmlBuffer, &ResourceIndex);
517         if (ACPI_FAILURE (Status))
518         {
519             /*
520              * Exit on failure. Cannot continue because the descriptor length
521              * may be bogus also.
522              */
523             return_ACPI_STATUS (Status);
524         }
525 
526         AmlResource = (void *) AmlBuffer;
527 
528         /* Get the resource length and base (minimum) AML size */
529 
530         ResourceLength = AcpiUtGetResourceLength (AmlBuffer);
531         MinimumAmlResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex];
532 
533         /*
534          * Augment the size for descriptors with optional
535          * and/or variable length fields
536          */
537         ExtraStructBytes = 0;
538         Buffer = AmlBuffer + AcpiUtGetResourceHeaderLength (AmlBuffer);
539 
540         switch (AcpiUtGetResourceType (AmlBuffer))
541         {
542         case ACPI_RESOURCE_NAME_IRQ:
543             /*
544              * IRQ Resource:
545              * Get the number of bits set in the 16-bit IRQ mask
546              */
547             ACPI_MOVE_16_TO_16 (&Temp16, Buffer);
548             ExtraStructBytes = AcpiRsCountSetBits (Temp16);
549             break;
550 
551 
552         case ACPI_RESOURCE_NAME_DMA:
553             /*
554              * DMA Resource:
555              * Get the number of bits set in the 8-bit DMA mask
556              */
557             ExtraStructBytes = AcpiRsCountSetBits (*Buffer);
558             break;
559 
560 
561         case ACPI_RESOURCE_NAME_VENDOR_SMALL:
562         case ACPI_RESOURCE_NAME_VENDOR_LARGE:
563             /*
564              * Vendor Resource:
565              * Get the number of vendor data bytes
566              */
567             ExtraStructBytes = ResourceLength;
568 
569             /*
570              * There is already one byte included in the minimum
571              * descriptor size. If there are extra struct bytes,
572              * subtract one from the count.
573              */
574             if (ExtraStructBytes)
575             {
576                 ExtraStructBytes--;
577             }
578             break;
579 
580 
581         case ACPI_RESOURCE_NAME_END_TAG:
582             /*
583              * End Tag: This is the normal exit
584              */
585             return_ACPI_STATUS (AE_OK);
586 
587 
588         case ACPI_RESOURCE_NAME_ADDRESS32:
589         case ACPI_RESOURCE_NAME_ADDRESS16:
590         case ACPI_RESOURCE_NAME_ADDRESS64:
591             /*
592              * Address Resource:
593              * Add the size of the optional ResourceSource
594              */
595             ExtraStructBytes = AcpiRsStreamOptionLength (
596                 ResourceLength, MinimumAmlResourceLength);
597             break;
598 
599 
600         case ACPI_RESOURCE_NAME_EXTENDED_IRQ:
601             /*
602              * Extended IRQ Resource:
603              * Using the InterruptTableLength, add 4 bytes for each additional
604              * interrupt. Note: at least one interrupt is required and is
605              * included in the minimum descriptor size (reason for the -1)
606              */
607             ExtraStructBytes = (Buffer[1] - 1) * sizeof (UINT32);
608 
609             /* Add the size of the optional ResourceSource */
610 
611             ExtraStructBytes += AcpiRsStreamOptionLength (
612                 ResourceLength - ExtraStructBytes, MinimumAmlResourceLength);
613             break;
614 
615         case ACPI_RESOURCE_NAME_GPIO:
616 
617             /* Vendor data is optional */
618 
619             if (AmlResource->Gpio.VendorLength)
620             {
621                 ExtraStructBytes += AmlResource->Gpio.VendorOffset -
622                     AmlResource->Gpio.PinTableOffset + AmlResource->Gpio.VendorLength;
623             }
624             else
625             {
626                 ExtraStructBytes += AmlResource->LargeHeader.ResourceLength +
627                     sizeof (AML_RESOURCE_LARGE_HEADER) -
628                     AmlResource->Gpio.PinTableOffset;
629             }
630             break;
631 
632         case ACPI_RESOURCE_NAME_SERIAL_BUS:
633 
634             MinimumAmlResourceLength = AcpiGbl_ResourceAmlSerialBusSizes[
635                 AmlResource->CommonSerialBus.Type];
636             ExtraStructBytes += AmlResource->CommonSerialBus.ResourceLength -
637                 MinimumAmlResourceLength;
638             break;
639 
640         default:
641 
642             break;
643         }
644 
645         /*
646          * Update the required buffer size for the internal descriptor structs
647          *
648          * Important: Round the size up for the appropriate alignment. This
649          * is a requirement on IA64.
650          */
651         if (AcpiUtGetResourceType (AmlBuffer) == ACPI_RESOURCE_NAME_SERIAL_BUS)
652         {
653             BufferSize = AcpiGbl_ResourceStructSerialBusSizes[
654                 AmlResource->CommonSerialBus.Type] + ExtraStructBytes;
655         }
656         else
657         {
658             BufferSize = AcpiGbl_ResourceStructSizes[ResourceIndex] +
659                         ExtraStructBytes;
660         }
661         BufferSize = (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (BufferSize);
662 
663         *SizeNeeded += BufferSize;
664 
665         ACPI_DEBUG_PRINT ((ACPI_DB_RESOURCES,
666             "Type %.2X, AmlLength %.2X InternalLength %.2X\n",
667             AcpiUtGetResourceType (AmlBuffer),
668             AcpiUtGetDescriptorLength (AmlBuffer), BufferSize));
669 
670         /*
671          * Point to the next resource within the AML stream using the length
672          * contained in the resource descriptor header
673          */
674         AmlBuffer += AcpiUtGetDescriptorLength (AmlBuffer);
675     }
676 
677     /* Did not find an EndTag resource descriptor */
678 
679     return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG);
680 }
681 
682 
683 /*******************************************************************************
684  *
685  * FUNCTION:    AcpiRsGetPciRoutingTableLength
686  *
687  * PARAMETERS:  PackageObject           - Pointer to the package object
688  *              BufferSizeNeeded        - UINT32 pointer of the size buffer
689  *                                        needed to properly return the
690  *                                        parsed data
691  *
692  * RETURN:      Status
693  *
694  * DESCRIPTION: Given a package representing a PCI routing table, this
695  *              calculates the size of the corresponding linked list of
696  *              descriptions.
697  *
698  ******************************************************************************/
699 
700 ACPI_STATUS
701 AcpiRsGetPciRoutingTableLength (
702     ACPI_OPERAND_OBJECT     *PackageObject,
703     ACPI_SIZE               *BufferSizeNeeded)
704 {
705     UINT32                  NumberOfElements;
706     ACPI_SIZE               TempSizeNeeded = 0;
707     ACPI_OPERAND_OBJECT     **TopObjectList;
708     UINT32                  Index;
709     ACPI_OPERAND_OBJECT     *PackageElement;
710     ACPI_OPERAND_OBJECT     **SubObjectList;
711     BOOLEAN                 NameFound;
712     UINT32                  TableIndex;
713 
714 
715     ACPI_FUNCTION_TRACE (RsGetPciRoutingTableLength);
716 
717 
718     NumberOfElements = PackageObject->Package.Count;
719 
720     /*
721      * Calculate the size of the return buffer.
722      * The base size is the number of elements * the sizes of the
723      * structures. Additional space for the strings is added below.
724      * The minus one is to subtract the size of the UINT8 Source[1]
725      * member because it is added below.
726      *
727      * But each PRT_ENTRY structure has a pointer to a string and
728      * the size of that string must be found.
729      */
730     TopObjectList = PackageObject->Package.Elements;
731 
732     for (Index = 0; Index < NumberOfElements; Index++)
733     {
734         /* Dereference the subpackage */
735 
736         PackageElement = *TopObjectList;
737 
738         /* We must have a valid Package object */
739 
740         if (!PackageElement ||
741             (PackageElement->Common.Type != ACPI_TYPE_PACKAGE))
742         {
743             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
744         }
745 
746         /*
747          * The SubObjectList will now point to an array of the
748          * four IRQ elements: Address, Pin, Source and SourceIndex
749          */
750         SubObjectList = PackageElement->Package.Elements;
751 
752         /* Scan the IrqTableElements for the Source Name String */
753 
754         NameFound = FALSE;
755 
756         for (TableIndex = 0;
757              TableIndex < PackageElement->Package.Count && !NameFound;
758              TableIndex++)
759         {
760             if (*SubObjectList && /* Null object allowed */
761 
762                 ((ACPI_TYPE_STRING ==
763                     (*SubObjectList)->Common.Type) ||
764 
765                 ((ACPI_TYPE_LOCAL_REFERENCE ==
766                     (*SubObjectList)->Common.Type) &&
767 
768                     ((*SubObjectList)->Reference.Class ==
769                         ACPI_REFCLASS_NAME))))
770             {
771                 NameFound = TRUE;
772             }
773             else
774             {
775                 /* Look at the next element */
776 
777                 SubObjectList++;
778             }
779         }
780 
781         TempSizeNeeded += (sizeof (ACPI_PCI_ROUTING_TABLE) - 4);
782 
783         /* Was a String type found? */
784 
785         if (NameFound)
786         {
787             if ((*SubObjectList)->Common.Type == ACPI_TYPE_STRING)
788             {
789                 /*
790                  * The length String.Length field does not include the
791                  * terminating NULL, add 1
792                  */
793                 TempSizeNeeded += ((ACPI_SIZE)
794                     (*SubObjectList)->String.Length + 1);
795             }
796             else
797             {
798                 TempSizeNeeded += AcpiNsGetPathnameLength (
799                                     (*SubObjectList)->Reference.Node);
800             }
801         }
802         else
803         {
804             /*
805              * If no name was found, then this is a NULL, which is
806              * translated as a UINT32 zero.
807              */
808             TempSizeNeeded += sizeof (UINT32);
809         }
810 
811         /* Round up the size since each element must be aligned */
812 
813         TempSizeNeeded = ACPI_ROUND_UP_TO_64BIT (TempSizeNeeded);
814 
815         /* Point to the next ACPI_OPERAND_OBJECT */
816 
817         TopObjectList++;
818     }
819 
820     /*
821      * Add an extra element to the end of the list, essentially a
822      * NULL terminator
823      */
824     *BufferSizeNeeded = TempSizeNeeded + sizeof (ACPI_PCI_ROUTING_TABLE);
825     return_ACPI_STATUS (AE_OK);
826 }
827