1 /****************************************************************************** 2 * 3 * Module Name: aslrestype2 - Miscellaneous Large resource descriptors 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2020, 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 <contrib/dev/acpica/compiler/aslcompiler.h> 153 #include "aslcompiler.y.h" 154 #include <contrib/dev/acpica/include/amlcode.h> 155 156 #define _COMPONENT ACPI_COMPILER 157 ACPI_MODULE_NAME ("aslrestype2") 158 159 /* 160 * This module contains miscellaneous large resource descriptors: 161 * 162 * Register 163 * Interrupt 164 * VendorLong 165 */ 166 167 /******************************************************************************* 168 * 169 * FUNCTION: RsDoGeneralRegisterDescriptor 170 * 171 * PARAMETERS: Info - Parse Op and resource template offset 172 * 173 * RETURN: Completed resource node 174 * 175 * DESCRIPTION: Construct a long "Register" descriptor 176 * 177 ******************************************************************************/ 178 179 ASL_RESOURCE_NODE * 180 RsDoGeneralRegisterDescriptor ( 181 ASL_RESOURCE_INFO *Info) 182 { 183 AML_RESOURCE *Descriptor; 184 ACPI_PARSE_OBJECT *InitializerOp; 185 ASL_RESOURCE_NODE *Rnode; 186 UINT32 CurrentByteOffset; 187 UINT32 i; 188 189 190 InitializerOp = Info->DescriptorTypeOp->Asl.Child; 191 CurrentByteOffset = Info->CurrentByteOffset; 192 Rnode = RsAllocateResourceNode (sizeof (AML_RESOURCE_GENERIC_REGISTER)); 193 194 Descriptor = Rnode->Buffer; 195 Descriptor->GenericReg.DescriptorType = ACPI_RESOURCE_NAME_GENERIC_REGISTER; 196 Descriptor->GenericReg.ResourceLength = 12; 197 198 /* Process all child initialization nodes */ 199 200 for (i = 0; InitializerOp; i++) 201 { 202 switch (i) 203 { 204 case 0: /* Address space */ 205 206 Descriptor->GenericReg.AddressSpaceId = (UINT8) InitializerOp->Asl.Value.Integer; 207 RsCreateByteField (InitializerOp, ACPI_RESTAG_ADDRESSSPACE, 208 CurrentByteOffset + ASL_RESDESC_OFFSET (GenericReg.AddressSpaceId)); 209 break; 210 211 case 1: /* Register Bit Width */ 212 213 Descriptor->GenericReg.BitWidth = (UINT8) InitializerOp->Asl.Value.Integer; 214 RsCreateByteField (InitializerOp, ACPI_RESTAG_REGISTERBITWIDTH, 215 CurrentByteOffset + ASL_RESDESC_OFFSET (GenericReg.BitWidth)); 216 break; 217 218 case 2: /* Register Bit Offset */ 219 220 Descriptor->GenericReg.BitOffset = (UINT8) InitializerOp->Asl.Value.Integer; 221 RsCreateByteField (InitializerOp, ACPI_RESTAG_REGISTERBITOFFSET, 222 CurrentByteOffset + ASL_RESDESC_OFFSET (GenericReg.BitOffset)); 223 break; 224 225 case 3: /* Register Address */ 226 227 Descriptor->GenericReg.Address = InitializerOp->Asl.Value.Integer; 228 RsCreateQwordField (InitializerOp, ACPI_RESTAG_ADDRESS, 229 CurrentByteOffset + ASL_RESDESC_OFFSET (GenericReg.Address)); 230 break; 231 232 case 4: /* Access Size (ACPI 3.0) */ 233 234 Descriptor->GenericReg.AccessSize = (UINT8) InitializerOp->Asl.Value.Integer; 235 RsCreateByteField (InitializerOp, ACPI_RESTAG_ACCESSSIZE, 236 CurrentByteOffset + ASL_RESDESC_OFFSET (GenericReg.AccessSize)); 237 238 if (Descriptor->GenericReg.AddressSpaceId == ACPI_ADR_SPACE_PLATFORM_COMM) 239 { 240 break; 241 } 242 243 if (Descriptor->GenericReg.AccessSize > AML_FIELD_ACCESS_QWORD) 244 { 245 AslError (ASL_ERROR, ASL_MSG_INVALID_ACCESS_SIZE, 246 InitializerOp, NULL); 247 } 248 break; 249 250 case 5: /* ResourceTag (ACPI 3.0b) */ 251 252 UtAttachNamepathToOwner (Info->DescriptorTypeOp, InitializerOp); 253 break; 254 255 default: 256 257 AslError (ASL_ERROR, ASL_MSG_RESOURCE_LIST, InitializerOp, NULL); 258 break; 259 } 260 261 InitializerOp = RsCompleteNodeAndGetNext (InitializerOp); 262 } 263 264 return (Rnode); 265 } 266 267 268 /******************************************************************************* 269 * 270 * FUNCTION: RsDoInterruptDescriptor 271 * 272 * PARAMETERS: Info - Parse Op and resource template offset 273 * 274 * RETURN: Completed resource node 275 * 276 * DESCRIPTION: Construct a long "Interrupt" descriptor 277 * 278 ******************************************************************************/ 279 280 ASL_RESOURCE_NODE * 281 RsDoInterruptDescriptor ( 282 ASL_RESOURCE_INFO *Info) 283 { 284 AML_RESOURCE *Descriptor; 285 AML_RESOURCE *Rover = NULL; 286 ACPI_PARSE_OBJECT *InitializerOp; 287 ASL_RESOURCE_NODE *Rnode; 288 UINT16 StringLength = 0; 289 UINT32 OptionIndex = 0; 290 UINT32 CurrentByteOffset; 291 UINT32 i; 292 BOOLEAN HasResSourceIndex = FALSE; 293 UINT8 ResSourceIndex = 0; 294 UINT8 *ResSourceString = NULL; 295 296 297 InitializerOp = Info->DescriptorTypeOp->Asl.Child; 298 CurrentByteOffset = Info->CurrentByteOffset; 299 StringLength = RsGetStringDataLength (InitializerOp); 300 301 /* Count the interrupt numbers */ 302 303 for (i = 0; InitializerOp; i++) 304 { 305 InitializerOp = ASL_GET_PEER_NODE (InitializerOp); 306 307 if (i <= 6) 308 { 309 if (i == 3 && 310 InitializerOp->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) 311 { 312 /* 313 * ResourceSourceIndex was specified, always make room for 314 * it, even if the ResourceSource was omitted. 315 */ 316 OptionIndex++; 317 } 318 319 continue; 320 } 321 322 OptionIndex += 4; 323 } 324 325 InitializerOp = Info->DescriptorTypeOp->Asl.Child; 326 Rnode = RsAllocateResourceNode (sizeof (AML_RESOURCE_EXTENDED_IRQ) + 327 1 + OptionIndex + StringLength); 328 329 Descriptor = Rnode->Buffer; 330 Descriptor->ExtendedIrq.DescriptorType = ACPI_RESOURCE_NAME_EXTENDED_IRQ; 331 332 /* 333 * Initial descriptor length -- may be enlarged if there are 334 * optional fields present 335 */ 336 Descriptor->ExtendedIrq.ResourceLength = 2; /* Flags and table length byte */ 337 Descriptor->ExtendedIrq.InterruptCount = 0; 338 339 Rover = ACPI_CAST_PTR (AML_RESOURCE, 340 (&(Descriptor->ExtendedIrq.Interrupts[0]))); 341 342 /* Process all child initialization nodes */ 343 344 for (i = 0; InitializerOp; i++) 345 { 346 switch (i) 347 { 348 case 0: /* Resource Usage (Default: consumer (1) */ 349 350 RsSetFlagBits (&Descriptor->ExtendedIrq.Flags, InitializerOp, 0, 1); 351 break; 352 353 case 1: /* Interrupt Type (or Mode - edge/level) */ 354 355 RsSetFlagBits (&Descriptor->ExtendedIrq.Flags, InitializerOp, 1, 0); 356 RsCreateBitField (InitializerOp, ACPI_RESTAG_INTERRUPTTYPE, 357 CurrentByteOffset + ASL_RESDESC_OFFSET (ExtendedIrq.Flags), 1); 358 break; 359 360 case 2: /* Interrupt Level (or Polarity - Active high/low) */ 361 362 RsSetFlagBits (&Descriptor->ExtendedIrq.Flags, InitializerOp, 2, 0); 363 RsCreateBitField (InitializerOp, ACPI_RESTAG_INTERRUPTLEVEL, 364 CurrentByteOffset + ASL_RESDESC_OFFSET (ExtendedIrq.Flags), 2); 365 break; 366 367 case 3: /* Share Type - Default: exclusive (0) */ 368 369 RsSetFlagBits (&Descriptor->ExtendedIrq.Flags, InitializerOp, 3, 0); 370 RsCreateBitField (InitializerOp, ACPI_RESTAG_INTERRUPTSHARE, 371 CurrentByteOffset + ASL_RESDESC_OFFSET (ExtendedIrq.Flags), 3); 372 break; 373 374 case 4: /* ResSourceIndex [Optional Field - BYTE] */ 375 376 if (InitializerOp->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) 377 { 378 HasResSourceIndex = TRUE; 379 ResSourceIndex = (UINT8) InitializerOp->Asl.Value.Integer; 380 } 381 break; 382 383 case 5: /* ResSource [Optional Field - STRING] */ 384 385 if ((InitializerOp->Asl.ParseOpcode != PARSEOP_DEFAULT_ARG) && 386 (InitializerOp->Asl.Value.String)) 387 { 388 if (StringLength) 389 { 390 ResSourceString = (UINT8 *) InitializerOp->Asl.Value.String; 391 } 392 393 /* ResourceSourceIndex must also be valid */ 394 395 if (!HasResSourceIndex) 396 { 397 AslError (ASL_ERROR, ASL_MSG_RESOURCE_INDEX, 398 InitializerOp, NULL); 399 } 400 } 401 402 #if 0 403 /* 404 * Not a valid ResourceSource, ResourceSourceIndex must also 405 * be invalid 406 */ 407 else if (HasResSourceIndex) 408 { 409 AslError (ASL_ERROR, ASL_MSG_RESOURCE_SOURCE, 410 InitializerOp, NULL); 411 } 412 #endif 413 break; 414 415 case 6: /* ResourceTag */ 416 417 UtAttachNamepathToOwner (Info->DescriptorTypeOp, InitializerOp); 418 break; 419 420 default: 421 /* 422 * Interrupt Numbers come through here, repeatedly 423 */ 424 425 /* Maximum 255 interrupts allowed for this descriptor */ 426 427 if (Descriptor->ExtendedIrq.InterruptCount == 255) 428 { 429 AslError (ASL_ERROR, ASL_MSG_EX_INTERRUPT_LIST, 430 InitializerOp, NULL); 431 return (Rnode); 432 } 433 434 /* Each interrupt number must be a 32-bit value */ 435 436 if (InitializerOp->Asl.Value.Integer > ACPI_UINT32_MAX) 437 { 438 AslError (ASL_ERROR, ASL_MSG_EX_INTERRUPT_NUMBER, 439 InitializerOp, NULL); 440 } 441 442 /* Save the integer and move pointer to the next one */ 443 444 Rover->DwordItem = (UINT32) InitializerOp->Asl.Value.Integer; 445 Rover = ACPI_ADD_PTR (AML_RESOURCE, &(Rover->DwordItem), 4); 446 Descriptor->ExtendedIrq.InterruptCount++; 447 Descriptor->ExtendedIrq.ResourceLength += 4; 448 449 /* Case 7: First interrupt number in list */ 450 451 if (i == 7) 452 { 453 if (InitializerOp->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG) 454 { 455 /* Must be at least one interrupt */ 456 457 AslError (ASL_ERROR, ASL_MSG_EX_INTERRUPT_LIST_MIN, 458 InitializerOp, NULL); 459 } 460 461 /* Check now for duplicates in list */ 462 463 RsCheckListForDuplicates (InitializerOp); 464 465 /* Create a named field at the start of the list */ 466 467 RsCreateDwordField (InitializerOp, ACPI_RESTAG_INTERRUPT, 468 CurrentByteOffset + 469 ASL_RESDESC_OFFSET (ExtendedIrq.Interrupts[0])); 470 } 471 } 472 473 InitializerOp = RsCompleteNodeAndGetNext (InitializerOp); 474 } 475 476 477 /* Add optional ResSourceIndex if present */ 478 479 if (HasResSourceIndex) 480 { 481 Rover->ByteItem = ResSourceIndex; 482 Rover = ACPI_ADD_PTR (AML_RESOURCE, &(Rover->ByteItem), 1); 483 Descriptor->ExtendedIrq.ResourceLength += 1; 484 } 485 486 /* Add optional ResSource string if present */ 487 488 if (StringLength && ResSourceString) 489 { 490 strcpy ((char *) Rover, (char *) ResSourceString); 491 492 Descriptor->ExtendedIrq.ResourceLength = (UINT16) 493 (Descriptor->ExtendedIrq.ResourceLength + StringLength); 494 } 495 496 Rnode->BufferLength = 497 (ASL_RESDESC_OFFSET (ExtendedIrq.Interrupts[0]) - 498 ASL_RESDESC_OFFSET (ExtendedIrq.DescriptorType)) 499 + OptionIndex + StringLength; 500 return (Rnode); 501 } 502 503 504 /******************************************************************************* 505 * 506 * FUNCTION: RsDoVendorLargeDescriptor 507 * 508 * PARAMETERS: Info - Parse Op and resource template offset 509 * 510 * RETURN: Completed resource node 511 * 512 * DESCRIPTION: Construct a long "VendorLong" descriptor 513 * 514 ******************************************************************************/ 515 516 ASL_RESOURCE_NODE * 517 RsDoVendorLargeDescriptor ( 518 ASL_RESOURCE_INFO *Info) 519 { 520 AML_RESOURCE *Descriptor; 521 ACPI_PARSE_OBJECT *InitializerOp; 522 ASL_RESOURCE_NODE *Rnode; 523 UINT8 *VendorData; 524 UINT32 i; 525 526 527 /* Count the number of data bytes */ 528 529 InitializerOp = Info->DescriptorTypeOp->Asl.Child; 530 InitializerOp = RsCompleteNodeAndGetNext (InitializerOp); 531 532 for (i = 0; InitializerOp; i++) 533 { 534 if (InitializerOp->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG) 535 { 536 break; 537 } 538 InitializerOp = InitializerOp->Asl.Next; 539 } 540 541 InitializerOp = Info->DescriptorTypeOp->Asl.Child; 542 InitializerOp = RsCompleteNodeAndGetNext (InitializerOp); 543 Rnode = RsAllocateResourceNode (sizeof (AML_RESOURCE_VENDOR_LARGE) + i); 544 545 Descriptor = Rnode->Buffer; 546 Descriptor->VendorLarge.DescriptorType = ACPI_RESOURCE_NAME_VENDOR_LARGE; 547 Descriptor->VendorLarge.ResourceLength = (UINT16) i; 548 549 /* Point to end-of-descriptor for vendor data */ 550 551 VendorData = ((UINT8 *) Descriptor) + sizeof (AML_RESOURCE_LARGE_HEADER); 552 553 /* Process all child initialization nodes */ 554 555 for (i = 0; InitializerOp; i++) 556 { 557 if (InitializerOp->Asl.ParseOpcode == PARSEOP_DEFAULT_ARG) 558 { 559 break; 560 } 561 562 VendorData[i] = (UINT8) InitializerOp->Asl.Value.Integer; 563 InitializerOp = RsCompleteNodeAndGetNext (InitializerOp); 564 } 565 566 return (Rnode); 567 } 568