1/******************************************************************************* 2 * 3 * Module Name: utresrc - Resource management utilities 4 * 5 ******************************************************************************/ 6 7/****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the 117 * following license: 118 * 119 * Redistribution and use in source and binary forms, with or without 120 * modification, are permitted provided that the following conditions 121 * are met: 122 * 1. Redistributions of source code must retain the above copyright 123 * notice, this list of conditions, and the following disclaimer, 124 * without modification. 125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 126 * substantially similar to the "NO WARRANTY" disclaimer below 127 * ("Disclaimer") and any redistribution must be conditioned upon 128 * including a substantially similar Disclaimer requirement for further 129 * binary redistribution. 130 * 3. Neither the names of the above-listed copyright holders nor the names 131 * of any contributors may be used to endorse or promote products derived 132 * from this software without specific prior written permission. 133 * 134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 145 * 146 * Alternatively, you may choose to be licensed under the terms of the 147 * GNU General Public License ("GPL") version 2 as published by the Free 148 * Software Foundation. 149 * 150 *****************************************************************************/ 151 152#include "acpi.h" 153#include "accommon.h" 154#include "acresrc.h" 155 156 157#define _COMPONENT ACPI_UTILITIES 158 ACPI_MODULE_NAME ("utresrc") 159 160 161/* 162 * Base sizes of the raw AML resource descriptors, indexed by resource type. 163 * Zero indicates a reserved (and therefore invalid) resource type. 164 */ 165const UINT8 AcpiGbl_ResourceAmlSizes[] = 166{ 167 /* Small descriptors */ 168 169 0, 170 0, 171 0, 172 0, 173 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IRQ), 174 ACPI_AML_SIZE_SMALL (AML_RESOURCE_DMA), 175 ACPI_AML_SIZE_SMALL (AML_RESOURCE_START_DEPENDENT), 176 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_DEPENDENT), 177 ACPI_AML_SIZE_SMALL (AML_RESOURCE_IO), 178 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_IO), 179 ACPI_AML_SIZE_SMALL (AML_RESOURCE_FIXED_DMA), 180 0, 181 0, 182 0, 183 ACPI_AML_SIZE_SMALL (AML_RESOURCE_VENDOR_SMALL), 184 ACPI_AML_SIZE_SMALL (AML_RESOURCE_END_TAG), 185 186 /* Large descriptors */ 187 188 0, 189 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY24), 190 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GENERIC_REGISTER), 191 0, 192 ACPI_AML_SIZE_LARGE (AML_RESOURCE_VENDOR_LARGE), 193 ACPI_AML_SIZE_LARGE (AML_RESOURCE_MEMORY32), 194 ACPI_AML_SIZE_LARGE (AML_RESOURCE_FIXED_MEMORY32), 195 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS32), 196 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS16), 197 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_IRQ), 198 ACPI_AML_SIZE_LARGE (AML_RESOURCE_ADDRESS64), 199 ACPI_AML_SIZE_LARGE (AML_RESOURCE_EXTENDED_ADDRESS64), 200 ACPI_AML_SIZE_LARGE (AML_RESOURCE_GPIO), 201 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_FUNCTION), 202 ACPI_AML_SIZE_LARGE (AML_RESOURCE_COMMON_SERIALBUS), 203 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_CONFIG), 204 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP), 205 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_FUNCTION), 206 ACPI_AML_SIZE_LARGE (AML_RESOURCE_PIN_GROUP_CONFIG), 207 ACPI_AML_SIZE_LARGE (AML_RESOURCE_CLOCK_INPUT), 208 209}; 210 211const UINT8 AcpiGbl_ResourceAmlSerialBusSizes[] = 212{ 213 0, 214 ACPI_AML_SIZE_LARGE (AML_RESOURCE_I2C_SERIALBUS), 215 ACPI_AML_SIZE_LARGE (AML_RESOURCE_SPI_SERIALBUS), 216 ACPI_AML_SIZE_LARGE (AML_RESOURCE_UART_SERIALBUS), 217 ACPI_AML_SIZE_LARGE (AML_RESOURCE_CSI2_SERIALBUS), 218}; 219 220 221/* 222 * Resource types, used to validate the resource length field. 223 * The length of fixed-length types must match exactly, variable 224 * lengths must meet the minimum required length, etc. 225 * Zero indicates a reserved (and therefore invalid) resource type. 226 */ 227static const UINT8 AcpiGbl_ResourceTypes[] = 228{ 229 /* Small descriptors */ 230 231 0, 232 0, 233 0, 234 0, 235 ACPI_SMALL_VARIABLE_LENGTH, /* 04 IRQ */ 236 ACPI_FIXED_LENGTH, /* 05 DMA */ 237 ACPI_SMALL_VARIABLE_LENGTH, /* 06 StartDependentFunctions */ 238 ACPI_FIXED_LENGTH, /* 07 EndDependentFunctions */ 239 ACPI_FIXED_LENGTH, /* 08 IO */ 240 ACPI_FIXED_LENGTH, /* 09 FixedIO */ 241 ACPI_FIXED_LENGTH, /* 0A FixedDMA */ 242 0, 243 0, 244 0, 245 ACPI_VARIABLE_LENGTH, /* 0E VendorShort */ 246 ACPI_FIXED_LENGTH, /* 0F EndTag */ 247 248 /* Large descriptors */ 249 250 0, 251 ACPI_FIXED_LENGTH, /* 01 Memory24 */ 252 ACPI_FIXED_LENGTH, /* 02 GenericRegister */ 253 0, 254 ACPI_VARIABLE_LENGTH, /* 04 VendorLong */ 255 ACPI_FIXED_LENGTH, /* 05 Memory32 */ 256 ACPI_FIXED_LENGTH, /* 06 Memory32Fixed */ 257 ACPI_VARIABLE_LENGTH, /* 07 Dword* address */ 258 ACPI_VARIABLE_LENGTH, /* 08 Word* address */ 259 ACPI_VARIABLE_LENGTH, /* 09 ExtendedIRQ */ 260 ACPI_VARIABLE_LENGTH, /* 0A Qword* address */ 261 ACPI_FIXED_LENGTH, /* 0B Extended* address */ 262 ACPI_VARIABLE_LENGTH, /* 0C Gpio* */ 263 ACPI_VARIABLE_LENGTH, /* 0D PinFunction */ 264 ACPI_VARIABLE_LENGTH, /* 0E *SerialBus */ 265 ACPI_VARIABLE_LENGTH, /* 0F PinConfig */ 266 ACPI_VARIABLE_LENGTH, /* 10 PinGroup */ 267 ACPI_VARIABLE_LENGTH, /* 11 PinGroupFunction */ 268 ACPI_VARIABLE_LENGTH, /* 12 PinGroupConfig */ 269 ACPI_VARIABLE_LENGTH, /* 13 ClockInput */ 270}; 271 272 273/******************************************************************************* 274 * 275 * FUNCTION: AcpiUtWalkAmlResources 276 * 277 * PARAMETERS: WalkState - Current walk info 278 * PARAMETERS: Aml - Pointer to the raw AML resource template 279 * AmlLength - Length of the entire template 280 * UserFunction - Called once for each descriptor found. If 281 * NULL, a pointer to the EndTag is returned 282 * Context - Passed to UserFunction 283 * 284 * RETURN: Status 285 * 286 * DESCRIPTION: Walk a raw AML resource list(buffer). User function called 287 * once for each resource found. 288 * 289 ******************************************************************************/ 290 291ACPI_STATUS 292AcpiUtWalkAmlResources ( 293 ACPI_WALK_STATE *WalkState, 294 UINT8 *Aml, 295 ACPI_SIZE AmlLength, 296 ACPI_WALK_AML_CALLBACK UserFunction, 297 void **Context) 298{ 299 ACPI_STATUS Status; 300 UINT8 *EndAml; 301 UINT8 ResourceIndex; 302 UINT32 Length; 303 UINT32 Offset = 0; 304 UINT8 EndTag[2] = {0x79, 0x00}; 305 306 307 ACPI_FUNCTION_TRACE (UtWalkAmlResources); 308 309 310 /* The absolute minimum resource template is one EndTag descriptor */ 311 312 if (AmlLength < sizeof (AML_RESOURCE_END_TAG)) 313 { 314 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG); 315 } 316 317 /* Point to the end of the resource template buffer */ 318 319 EndAml = Aml + AmlLength; 320 321 /* Walk the byte list, abort on any invalid descriptor type or length */ 322 323 while (Aml < EndAml) 324 { 325 /* Validate the Resource Type and Resource Length */ 326 327 Status = AcpiUtValidateResource (WalkState, Aml, &ResourceIndex); 328 if (ACPI_FAILURE (Status)) 329 { 330 /* 331 * Exit on failure. Cannot continue because the descriptor 332 * length may be bogus also. 333 */ 334 return_ACPI_STATUS (Status); 335 } 336 337 /* Get the length of this descriptor */ 338 339 Length = AcpiUtGetDescriptorLength (Aml); 340 341 /* Invoke the user function */ 342 343 if (UserFunction) 344 { 345 Status = UserFunction ( 346 Aml, Length, Offset, ResourceIndex, Context); 347 if (ACPI_FAILURE (Status)) 348 { 349 return_ACPI_STATUS (Status); 350 } 351 } 352 353 /* An EndTag descriptor terminates this resource template */ 354 355 if (AcpiUtGetResourceType (Aml) == ACPI_RESOURCE_NAME_END_TAG) 356 { 357 /* 358 * There must be at least one more byte in the buffer for 359 * the 2nd byte of the EndTag 360 */ 361 if ((Aml + 1) >= EndAml) 362 { 363 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG); 364 } 365 366 /* 367 * Don't attempt to perform any validation on the 2nd byte. 368 * Although all known ASL compilers insert a zero for the 2nd 369 * byte, it can also be a checksum (as per the ACPI spec), 370 * and this is occasionally seen in the field. July 2017. 371 */ 372 373 /* Return the pointer to the EndTag if requested */ 374 375 if (!UserFunction) 376 { 377 *Context = Aml; 378 } 379 380 /* Normal exit */ 381 382 return_ACPI_STATUS (AE_OK); 383 } 384 385 Aml += Length; 386 Offset += Length; 387 } 388 389 /* Did not find an EndTag descriptor */ 390 391 if (UserFunction) 392 { 393 /* Insert an EndTag anyway. AcpiRsGetListLength always leaves room */ 394 395 (void) AcpiUtValidateResource (WalkState, EndTag, &ResourceIndex); 396 Status = UserFunction (EndTag, 2, Offset, ResourceIndex, Context); 397 if (ACPI_FAILURE (Status)) 398 { 399 return_ACPI_STATUS (Status); 400 } 401 } 402 403 return_ACPI_STATUS (AE_AML_NO_RESOURCE_END_TAG); 404} 405 406 407/******************************************************************************* 408 * 409 * FUNCTION: AcpiUtValidateResource 410 * 411 * PARAMETERS: WalkState - Current walk info 412 * Aml - Pointer to the raw AML resource descriptor 413 * ReturnIndex - Where the resource index is returned. NULL 414 * if the index is not required. 415 * 416 * RETURN: Status, and optionally the Index into the global resource tables 417 * 418 * DESCRIPTION: Validate an AML resource descriptor by checking the Resource 419 * Type and Resource Length. Returns an index into the global 420 * resource information/dispatch tables for later use. 421 * 422 ******************************************************************************/ 423 424ACPI_STATUS 425AcpiUtValidateResource ( 426 ACPI_WALK_STATE *WalkState, 427 void *Aml, 428 UINT8 *ReturnIndex) 429{ 430 AML_RESOURCE *AmlResource; 431 UINT8 ResourceType; 432 UINT8 ResourceIndex; 433 ACPI_RS_LENGTH ResourceLength; 434 ACPI_RS_LENGTH MinimumResourceLength; 435 436 437 ACPI_FUNCTION_ENTRY (); 438 439 440 /* 441 * 1) Validate the ResourceType field (Byte 0) 442 */ 443 ResourceType = ACPI_GET8 (Aml); 444 445 /* 446 * Byte 0 contains the descriptor name (Resource Type) 447 * Examine the large/small bit in the resource header 448 */ 449 if (ResourceType & ACPI_RESOURCE_NAME_LARGE) 450 { 451 /* Verify the large resource type (name) against the max */ 452 453 if (ResourceType > ACPI_RESOURCE_NAME_LARGE_MAX) 454 { 455 goto InvalidResource; 456 } 457 458 /* 459 * Large Resource Type -- bits 6:0 contain the name 460 * Translate range 0x80-0x8B to index range 0x10-0x1B 461 */ 462 ResourceIndex = (UINT8) (ResourceType - 0x70); 463 } 464 else 465 { 466 /* 467 * Small Resource Type -- bits 6:3 contain the name 468 * Shift range to index range 0x00-0x0F 469 */ 470 ResourceIndex = (UINT8) 471 ((ResourceType & ACPI_RESOURCE_NAME_SMALL_MASK) >> 3); 472 } 473 474 /* 475 * Check validity of the resource type, via AcpiGbl_ResourceTypes. 476 * Zero indicates an invalid resource. 477 */ 478 if (!AcpiGbl_ResourceTypes[ResourceIndex]) 479 { 480 goto InvalidResource; 481 } 482 483 /* 484 * Validate the ResourceLength field. This ensures that the length 485 * is at least reasonable, and guarantees that it is non-zero. 486 */ 487 ResourceLength = AcpiUtGetResourceLength (Aml); 488 MinimumResourceLength = AcpiGbl_ResourceAmlSizes[ResourceIndex]; 489 490 /* Validate based upon the type of resource - fixed length or variable */ 491 492 switch (AcpiGbl_ResourceTypes[ResourceIndex]) 493 { 494 case ACPI_FIXED_LENGTH: 495 496 /* Fixed length resource, length must match exactly */ 497 498 if (ResourceLength != MinimumResourceLength) 499 { 500 goto BadResourceLength; 501 } 502 break; 503 504 case ACPI_VARIABLE_LENGTH: 505 506 /* Variable length resource, length must be at least the minimum */ 507 508 if (ResourceLength < MinimumResourceLength) 509 { 510 goto BadResourceLength; 511 } 512 break; 513 514 case ACPI_SMALL_VARIABLE_LENGTH: 515 516 /* Small variable length resource, length can be (Min) or (Min-1) */ 517 518 if ((ResourceLength > MinimumResourceLength) || 519 (ResourceLength < (MinimumResourceLength - 1))) 520 { 521 goto BadResourceLength; 522 } 523 break; 524 525 default: 526 527 /* Shouldn't happen (because of validation earlier), but be sure */ 528 529 goto InvalidResource; 530 } 531 532 AmlResource = ACPI_CAST_PTR (AML_RESOURCE, Aml); 533 if (ResourceType == ACPI_RESOURCE_NAME_SERIAL_BUS) 534 { 535 /* Avoid undefined behavior: member access within misaligned address */ 536 537 AML_RESOURCE_COMMON_SERIALBUS CommonSerialBus; 538 memcpy(&CommonSerialBus, AmlResource, sizeof(CommonSerialBus)); 539 540 /* Validate the BusType field */ 541 542 if ((CommonSerialBus.Type == 0) || 543 (CommonSerialBus.Type > AML_RESOURCE_MAX_SERIALBUSTYPE)) 544 { 545 if (WalkState) 546 { 547 ACPI_ERROR ((AE_INFO, 548 "Invalid/unsupported SerialBus resource descriptor: BusType 0x%2.2X", 549 CommonSerialBus.Type)); 550 } 551 return (AE_AML_INVALID_RESOURCE_TYPE); 552 } 553 } 554 555 /* Optionally return the resource table index */ 556 557 if (ReturnIndex) 558 { 559 *ReturnIndex = ResourceIndex; 560 } 561 562 return (AE_OK); 563 564 565InvalidResource: 566 567 if (WalkState) 568 { 569 ACPI_ERROR ((AE_INFO, 570 "Invalid/unsupported resource descriptor: Type 0x%2.2X", 571 ResourceType)); 572 } 573 return (AE_AML_INVALID_RESOURCE_TYPE); 574 575BadResourceLength: 576 577 if (WalkState) 578 { 579 ACPI_ERROR ((AE_INFO, 580 "Invalid resource descriptor length: Type " 581 "0x%2.2X, Length 0x%4.4X, MinLength 0x%4.4X", 582 ResourceType, ResourceLength, MinimumResourceLength)); 583 } 584 return (AE_AML_BAD_RESOURCE_LENGTH); 585} 586 587 588/******************************************************************************* 589 * 590 * FUNCTION: AcpiUtGetResourceType 591 * 592 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor 593 * 594 * RETURN: The Resource Type with no extraneous bits (except the 595 * Large/Small descriptor bit -- this is left alone) 596 * 597 * DESCRIPTION: Extract the Resource Type/Name from the first byte of 598 * a resource descriptor. 599 * 600 ******************************************************************************/ 601 602UINT8 603AcpiUtGetResourceType ( 604 void *Aml) 605{ 606 ACPI_FUNCTION_ENTRY (); 607 608 609 /* 610 * Byte 0 contains the descriptor name (Resource Type) 611 * Examine the large/small bit in the resource header 612 */ 613 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE) 614 { 615 /* Large Resource Type -- bits 6:0 contain the name */ 616 617 return (ACPI_GET8 (Aml)); 618 } 619 else 620 { 621 /* Small Resource Type -- bits 6:3 contain the name */ 622 623 return ((UINT8) (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_SMALL_MASK)); 624 } 625} 626 627 628/******************************************************************************* 629 * 630 * FUNCTION: AcpiUtGetResourceLength 631 * 632 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor 633 * 634 * RETURN: Byte Length 635 * 636 * DESCRIPTION: Get the "Resource Length" of a raw AML descriptor. By 637 * definition, this does not include the size of the descriptor 638 * header or the length field itself. 639 * 640 ******************************************************************************/ 641 642UINT16 643AcpiUtGetResourceLength ( 644 void *Aml) 645{ 646 ACPI_RS_LENGTH ResourceLength; 647 648 649 ACPI_FUNCTION_ENTRY (); 650 651 652 /* 653 * Byte 0 contains the descriptor name (Resource Type) 654 * Examine the large/small bit in the resource header 655 */ 656 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE) 657 { 658 /* Large Resource type -- bytes 1-2 contain the 16-bit length */ 659 660 ACPI_MOVE_16_TO_16 (&ResourceLength, ACPI_ADD_PTR (UINT8, Aml, 1)); 661 662 } 663 else 664 { 665 /* Small Resource type -- bits 2:0 of byte 0 contain the length */ 666 667 ResourceLength = (UINT16) (ACPI_GET8 (Aml) & 668 ACPI_RESOURCE_NAME_SMALL_LENGTH_MASK); 669 } 670 671 return (ResourceLength); 672} 673 674 675/******************************************************************************* 676 * 677 * FUNCTION: AcpiUtGetResourceHeaderLength 678 * 679 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor 680 * 681 * RETURN: Length of the AML header (depends on large/small descriptor) 682 * 683 * DESCRIPTION: Get the length of the header for this resource. 684 * 685 ******************************************************************************/ 686 687UINT8 688AcpiUtGetResourceHeaderLength ( 689 void *Aml) 690{ 691 ACPI_FUNCTION_ENTRY (); 692 693 694 /* Examine the large/small bit in the resource header */ 695 696 if (ACPI_GET8 (Aml) & ACPI_RESOURCE_NAME_LARGE) 697 { 698 return (sizeof (AML_RESOURCE_LARGE_HEADER)); 699 } 700 else 701 { 702 return (sizeof (AML_RESOURCE_SMALL_HEADER)); 703 } 704} 705 706 707/******************************************************************************* 708 * 709 * FUNCTION: AcpiUtGetDescriptorLength 710 * 711 * PARAMETERS: Aml - Pointer to the raw AML resource descriptor 712 * 713 * RETURN: Byte length 714 * 715 * DESCRIPTION: Get the total byte length of a raw AML descriptor, including the 716 * length of the descriptor header and the length field itself. 717 * Used to walk descriptor lists. 718 * 719 ******************************************************************************/ 720 721UINT32 722AcpiUtGetDescriptorLength ( 723 void *Aml) 724{ 725 ACPI_FUNCTION_ENTRY (); 726 727 728 /* 729 * Get the Resource Length (does not include header length) and add 730 * the header length (depends on if this is a small or large resource) 731 */ 732 return (AcpiUtGetResourceLength (Aml) + 733 AcpiUtGetResourceHeaderLength (Aml)); 734} 735 736 737/******************************************************************************* 738 * 739 * FUNCTION: AcpiUtGetResourceEndTag 740 * 741 * PARAMETERS: ObjDesc - The resource template buffer object 742 * EndTag - Where the pointer to the EndTag is returned 743 * 744 * RETURN: Status, pointer to the end tag 745 * 746 * DESCRIPTION: Find the EndTag resource descriptor in an AML resource template 747 * Note: allows a buffer length of zero. 748 * 749 ******************************************************************************/ 750 751ACPI_STATUS 752AcpiUtGetResourceEndTag ( 753 ACPI_OPERAND_OBJECT *ObjDesc, 754 UINT8 **EndTag) 755{ 756 ACPI_STATUS Status; 757 758 759 ACPI_FUNCTION_TRACE (UtGetResourceEndTag); 760 761 762 /* Allow a buffer length of zero */ 763 764 if (!ObjDesc->Buffer.Length) 765 { 766 *EndTag = ObjDesc->Buffer.Pointer; 767 return_ACPI_STATUS (AE_OK); 768 } 769 770 /* Validate the template and get a pointer to the EndTag */ 771 772 Status = AcpiUtWalkAmlResources (NULL, ObjDesc->Buffer.Pointer, 773 ObjDesc->Buffer.Length, NULL, (void **) EndTag); 774 775 return_ACPI_STATUS (Status); 776} 777