1 /****************************************************************************** 2 * 3 * Module Name: dmrestag - Add tags to resource descriptors (Application-level) 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2016, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #include "acpi.h" 45 #include "accommon.h" 46 #include "acparser.h" 47 #include "acdisasm.h" 48 #include "acnamesp.h" 49 #include "amlcode.h" 50 51 /* This module used for application-level code only */ 52 53 #define _COMPONENT ACPI_CA_DISASSEMBLER 54 ACPI_MODULE_NAME ("dmrestag") 55 56 /* Local prototypes */ 57 58 static void 59 AcpiDmUpdateResourceName ( 60 ACPI_NAMESPACE_NODE *ResourceNode); 61 62 static char * 63 AcpiDmSearchTagList ( 64 UINT32 BitIndex, 65 const ACPI_RESOURCE_TAG *TagList); 66 67 static char * 68 AcpiDmGetResourceTag ( 69 UINT32 BitIndex, 70 AML_RESOURCE *Resource, 71 UINT8 ResourceIndex); 72 73 static char * 74 AcpiGetTagPathname ( 75 ACPI_PARSE_OBJECT *Op, 76 ACPI_NAMESPACE_NODE *BufferNode, 77 ACPI_NAMESPACE_NODE *ResourceNode, 78 UINT32 BitIndex); 79 80 static ACPI_NAMESPACE_NODE * 81 AcpiDmGetResourceNode ( 82 ACPI_NAMESPACE_NODE *BufferNode, 83 UINT32 BitIndex); 84 85 static ACPI_STATUS 86 AcpiDmAddResourceToNamespace ( 87 UINT8 *Aml, 88 UINT32 Length, 89 UINT32 Offset, 90 UINT8 ResourceIndex, 91 void **Context); 92 93 static void 94 AcpiDmAddResourcesToNamespace ( 95 ACPI_NAMESPACE_NODE *BufferNode, 96 ACPI_PARSE_OBJECT *Op); 97 98 99 /****************************************************************************** 100 * 101 * Resource Tag tables 102 * 103 * These are the predefined tags that refer to elements of a resource 104 * descriptor. Each name and offset is defined in the ACPI specification. 105 * 106 * Each table entry contains the bit offset of the field and the associated 107 * name. 108 * 109 ******************************************************************************/ 110 111 static const ACPI_RESOURCE_TAG AcpiDmIrqTags[] = 112 { 113 {( 1 * 8), ACPI_RESTAG_INTERRUPT}, 114 {( 3 * 8) + 0, ACPI_RESTAG_INTERRUPTTYPE}, 115 {( 3 * 8) + 3, ACPI_RESTAG_INTERRUPTLEVEL}, 116 {( 3 * 8) + 4, ACPI_RESTAG_INTERRUPTSHARE}, 117 {0, NULL} 118 }; 119 120 static const ACPI_RESOURCE_TAG AcpiDmDmaTags[] = 121 { 122 {( 1 * 8), ACPI_RESTAG_DMA}, 123 {( 2 * 8) + 0, ACPI_RESTAG_XFERTYPE}, 124 {( 2 * 8) + 2, ACPI_RESTAG_BUSMASTER}, 125 {( 2 * 8) + 5, ACPI_RESTAG_DMATYPE}, 126 {0, NULL} 127 }; 128 129 static const ACPI_RESOURCE_TAG AcpiDmIoTags[] = 130 { 131 {( 1 * 8) + 0, ACPI_RESTAG_DECODE}, 132 {( 2 * 8), ACPI_RESTAG_MINADDR}, 133 {( 4 * 8), ACPI_RESTAG_MAXADDR}, 134 {( 6 * 8), ACPI_RESTAG_ALIGNMENT}, 135 {( 7 * 8), ACPI_RESTAG_LENGTH}, 136 {0, NULL} 137 }; 138 139 static const ACPI_RESOURCE_TAG AcpiDmFixedIoTags[] = 140 { 141 {( 1 * 8), ACPI_RESTAG_BASEADDRESS}, 142 {( 3 * 8), ACPI_RESTAG_LENGTH}, 143 {0, NULL} 144 }; 145 146 static const ACPI_RESOURCE_TAG AcpiDmFixedDmaTags[] = 147 { 148 {( 1 * 8), ACPI_RESTAG_DMA}, 149 {( 3 * 8), ACPI_RESTAG_DMATYPE}, 150 {( 5 * 8), ACPI_RESTAG_XFERTYPE}, 151 {0, NULL} 152 }; 153 154 static const ACPI_RESOURCE_TAG AcpiDmMemory24Tags[] = 155 { 156 {( 3 * 8) + 0, ACPI_RESTAG_READWRITETYPE}, 157 {( 4 * 8), ACPI_RESTAG_MINADDR}, 158 {( 6 * 8), ACPI_RESTAG_MAXADDR}, 159 {( 8 * 8), ACPI_RESTAG_ALIGNMENT}, 160 {(10 * 8), ACPI_RESTAG_LENGTH}, 161 {0, NULL} 162 }; 163 164 static const ACPI_RESOURCE_TAG AcpiDmRegisterTags[] = 165 { 166 {( 3 * 8), ACPI_RESTAG_ADDRESSSPACE}, 167 {( 4 * 8), ACPI_RESTAG_REGISTERBITWIDTH}, 168 {( 5 * 8), ACPI_RESTAG_REGISTERBITOFFSET}, 169 {( 6 * 8), ACPI_RESTAG_ACCESSSIZE}, 170 {( 7 * 8), ACPI_RESTAG_ADDRESS}, 171 {0, NULL} 172 }; 173 174 static const ACPI_RESOURCE_TAG AcpiDmMemory32Tags[] = 175 { 176 {( 3 * 8) + 0, ACPI_RESTAG_READWRITETYPE}, 177 {( 4 * 8), ACPI_RESTAG_MINADDR}, 178 {( 8 * 8), ACPI_RESTAG_MAXADDR}, 179 {(12 * 8), ACPI_RESTAG_ALIGNMENT}, 180 {(16 * 8), ACPI_RESTAG_LENGTH}, 181 {0, NULL} 182 }; 183 184 static const ACPI_RESOURCE_TAG AcpiDmFixedMemory32Tags[] = 185 { 186 {( 3 * 8) + 0, ACPI_RESTAG_READWRITETYPE}, 187 {( 4 * 8), ACPI_RESTAG_BASEADDRESS}, 188 {( 8 * 8), ACPI_RESTAG_LENGTH}, 189 {0, NULL} 190 }; 191 192 static const ACPI_RESOURCE_TAG AcpiDmInterruptTags[] = 193 { 194 {( 3 * 8) + 1, ACPI_RESTAG_INTERRUPTTYPE}, 195 {( 3 * 8) + 2, ACPI_RESTAG_INTERRUPTLEVEL}, 196 {( 3 * 8) + 3, ACPI_RESTAG_INTERRUPTSHARE}, 197 {( 5 * 8), ACPI_RESTAG_INTERRUPT}, 198 {0, NULL} 199 }; 200 201 static const ACPI_RESOURCE_TAG AcpiDmAddress16Tags[] = 202 { 203 {( 4 * 8) + 1, ACPI_RESTAG_DECODE}, 204 {( 4 * 8) + 2, ACPI_RESTAG_MINTYPE}, 205 {( 4 * 8) + 3, ACPI_RESTAG_MAXTYPE}, 206 {( 6 * 8), ACPI_RESTAG_GRANULARITY}, 207 {( 8 * 8), ACPI_RESTAG_MINADDR}, 208 {(10 * 8), ACPI_RESTAG_MAXADDR}, 209 {(12 * 8), ACPI_RESTAG_TRANSLATION}, 210 {(14 * 8), ACPI_RESTAG_LENGTH}, 211 {0, NULL} 212 }; 213 214 static const ACPI_RESOURCE_TAG AcpiDmAddress32Tags[] = 215 { 216 {( 4 * 8) + 1, ACPI_RESTAG_DECODE}, 217 {( 4 * 8) + 2, ACPI_RESTAG_MINTYPE}, 218 {( 4 * 8) + 3, ACPI_RESTAG_MAXTYPE}, 219 {( 6 * 8), ACPI_RESTAG_GRANULARITY}, 220 {(10 * 8), ACPI_RESTAG_MINADDR}, 221 {(14 * 8), ACPI_RESTAG_MAXADDR}, 222 {(18 * 8), ACPI_RESTAG_TRANSLATION}, 223 {(22 * 8), ACPI_RESTAG_LENGTH}, 224 {0, NULL} 225 }; 226 227 static const ACPI_RESOURCE_TAG AcpiDmAddress64Tags[] = 228 { 229 {( 4 * 8) + 1, ACPI_RESTAG_DECODE}, 230 {( 4 * 8) + 2, ACPI_RESTAG_MINTYPE}, 231 {( 4 * 8) + 3, ACPI_RESTAG_MAXTYPE}, 232 {( 6 * 8), ACPI_RESTAG_GRANULARITY}, 233 {(14 * 8), ACPI_RESTAG_MINADDR}, 234 {(22 * 8), ACPI_RESTAG_MAXADDR}, 235 {(30 * 8), ACPI_RESTAG_TRANSLATION}, 236 {(38 * 8), ACPI_RESTAG_LENGTH}, 237 {0, NULL} 238 }; 239 240 static const ACPI_RESOURCE_TAG AcpiDmExtendedAddressTags[] = 241 { 242 {( 4 * 8) + 1, ACPI_RESTAG_DECODE}, 243 {( 4 * 8) + 2, ACPI_RESTAG_MINTYPE}, 244 {( 4 * 8) + 3, ACPI_RESTAG_MAXTYPE}, 245 {( 8 * 8), ACPI_RESTAG_GRANULARITY}, 246 {(16 * 8), ACPI_RESTAG_MINADDR}, 247 {(24 * 8), ACPI_RESTAG_MAXADDR}, 248 {(32 * 8), ACPI_RESTAG_TRANSLATION}, 249 {(40 * 8), ACPI_RESTAG_LENGTH}, 250 {(48 * 8), ACPI_RESTAG_TYPESPECIFICATTRIBUTES}, 251 {0, NULL} 252 }; 253 254 /* Subtype tables for GPIO descriptors */ 255 256 static const ACPI_RESOURCE_TAG AcpiDmGpioIntTags[] = 257 { 258 {( 7 * 8) + 0, ACPI_RESTAG_MODE}, 259 {( 7 * 8) + 1, ACPI_RESTAG_POLARITY}, 260 {( 7 * 8) + 3, ACPI_RESTAG_INTERRUPTSHARE}, 261 {( 9 * 8), ACPI_RESTAG_PINCONFIG}, 262 {(10 * 8), ACPI_RESTAG_DRIVESTRENGTH}, 263 {(12 * 8), ACPI_RESTAG_DEBOUNCETIME}, 264 {0, NULL} 265 }; 266 267 static const ACPI_RESOURCE_TAG AcpiDmGpioIoTags[] = 268 { 269 {( 7 * 8) + 0, ACPI_RESTAG_IORESTRICTION}, 270 {( 7 * 8) + 3, ACPI_RESTAG_INTERRUPTSHARE}, 271 {( 9 * 8), ACPI_RESTAG_PINCONFIG}, 272 {(10 * 8), ACPI_RESTAG_DRIVESTRENGTH}, 273 {(12 * 8), ACPI_RESTAG_DEBOUNCETIME}, 274 {0, NULL} 275 }; 276 277 /* Subtype tables for SerialBus descriptors */ 278 279 static const ACPI_RESOURCE_TAG AcpiDmI2cSerialBusTags[] = 280 { 281 {( 6 * 8) + 0, ACPI_RESTAG_SLAVEMODE}, 282 {( 6 * 8) + 2, ACPI_RESTAG_INTERRUPTSHARE}, /* V2 - ACPI 6.0 */ 283 {( 7 * 8) + 0, ACPI_RESTAG_MODE}, 284 {(12 * 8), ACPI_RESTAG_SPEED}, 285 {(16 * 8), ACPI_RESTAG_ADDRESS}, 286 {0, NULL} 287 }; 288 289 static const ACPI_RESOURCE_TAG AcpiDmSpiSerialBusTags[] = 290 { 291 {( 6 * 8) + 0, ACPI_RESTAG_SLAVEMODE}, 292 {( 6 * 8) + 2, ACPI_RESTAG_INTERRUPTSHARE}, /* V2 - ACPI 6.0 */ 293 {( 7 * 8) + 0, ACPI_RESTAG_MODE}, 294 {( 7 * 8) + 1, ACPI_RESTAG_DEVICEPOLARITY}, 295 {(12 * 8), ACPI_RESTAG_SPEED}, 296 {(16 * 8), ACPI_RESTAG_LENGTH}, 297 {(17 * 8), ACPI_RESTAG_PHASE}, 298 {(18 * 8), ACPI_RESTAG_POLARITY}, 299 {(19 * 8), ACPI_RESTAG_ADDRESS}, 300 {0, NULL} 301 }; 302 303 static const ACPI_RESOURCE_TAG AcpiDmUartSerialBusTags[] = 304 { 305 {( 6 * 8) + 0, ACPI_RESTAG_SLAVEMODE}, /* Note: not part of original macro */ 306 {( 6 * 8) + 2, ACPI_RESTAG_INTERRUPTSHARE}, /* V2 - ACPI 6.0 */ 307 {( 7 * 8) + 0, ACPI_RESTAG_FLOWCONTROL}, 308 {( 7 * 8) + 2, ACPI_RESTAG_STOPBITS}, 309 {( 7 * 8) + 4, ACPI_RESTAG_LENGTH}, 310 {( 7 * 8) + 7, ACPI_RESTAG_ENDIANNESS}, 311 {(12 * 8), ACPI_RESTAG_SPEED}, 312 {(16 * 8), ACPI_RESTAG_LENGTH_RX}, 313 {(18 * 8), ACPI_RESTAG_LENGTH_TX}, 314 {(20 * 8), ACPI_RESTAG_PARITY}, 315 {(21 * 8), ACPI_RESTAG_LINE}, 316 {0, NULL} 317 }; 318 319 /* Subtype tables for Address descriptor type-specific flags */ 320 321 static const ACPI_RESOURCE_TAG AcpiDmMemoryFlagTags[] = 322 { 323 {( 5 * 8) + 0, ACPI_RESTAG_READWRITETYPE}, 324 {( 5 * 8) + 1, ACPI_RESTAG_MEMTYPE}, 325 {( 5 * 8) + 3, ACPI_RESTAG_MEMATTRIBUTES}, 326 {( 5 * 8) + 5, ACPI_RESTAG_TYPE}, 327 {0, NULL} 328 }; 329 330 static const ACPI_RESOURCE_TAG AcpiDmIoFlagTags[] = 331 { 332 {( 5 * 8) + 0, ACPI_RESTAG_RANGETYPE}, 333 {( 5 * 8) + 4, ACPI_RESTAG_TYPE}, 334 {( 5 * 8) + 5, ACPI_RESTAG_TRANSTYPE}, 335 {0, NULL} 336 }; 337 338 339 /* 340 * Dispatch table used to obtain the correct tag table for a descriptor. 341 * 342 * A NULL in this table means one of three things: 343 * 1) The descriptor ID is reserved and invalid 344 * 2) The descriptor has no tags associated with it 345 * 3) The descriptor has subtypes and a separate table will be used. 346 */ 347 static const ACPI_RESOURCE_TAG *AcpiGbl_ResourceTags[] = 348 { 349 /* Small descriptors */ 350 351 NULL, /* 0x00, Reserved */ 352 NULL, /* 0x01, Reserved */ 353 NULL, /* 0x02, Reserved */ 354 NULL, /* 0x03, Reserved */ 355 AcpiDmIrqTags, /* 0x04, ACPI_RESOURCE_NAME_IRQ_FORMAT */ 356 AcpiDmDmaTags, /* 0x05, ACPI_RESOURCE_NAME_DMA_FORMAT */ 357 NULL, /* 0x06, ACPI_RESOURCE_NAME_START_DEPENDENT */ 358 NULL, /* 0x07, ACPI_RESOURCE_NAME_END_DEPENDENT */ 359 AcpiDmIoTags, /* 0x08, ACPI_RESOURCE_NAME_IO_PORT */ 360 AcpiDmFixedIoTags, /* 0x09, ACPI_RESOURCE_NAME_FIXED_IO_PORT */ 361 AcpiDmFixedDmaTags, /* 0x0A, ACPI_RESOURCE_NAME_FIXED_DMA */ 362 NULL, /* 0x0B, Reserved */ 363 NULL, /* 0x0C, Reserved */ 364 NULL, /* 0x0D, Reserved */ 365 NULL, /* 0x0E, ACPI_RESOURCE_NAME_SMALL_VENDOR */ 366 NULL, /* 0x0F, ACPI_RESOURCE_NAME_END_TAG (not used) */ 367 368 /* Large descriptors */ 369 370 NULL, /* 0x00, Reserved */ 371 AcpiDmMemory24Tags, /* 0x01, ACPI_RESOURCE_NAME_MEMORY_24 */ 372 AcpiDmRegisterTags, /* 0x02, ACPI_RESOURCE_NAME_GENERIC_REGISTER */ 373 NULL, /* 0x03, Reserved */ 374 NULL, /* 0x04, ACPI_RESOURCE_NAME_LARGE_VENDOR */ 375 AcpiDmMemory32Tags, /* 0x05, ACPI_RESOURCE_NAME_MEMORY_32 */ 376 AcpiDmFixedMemory32Tags, /* 0x06, ACPI_RESOURCE_NAME_FIXED_MEMORY_32 */ 377 AcpiDmAddress32Tags, /* 0x07, ACPI_RESOURCE_NAME_DWORD_ADDRESS_SPACE */ 378 AcpiDmAddress16Tags, /* 0x08, ACPI_RESOURCE_NAME_WORD_ADDRESS_SPACE */ 379 AcpiDmInterruptTags, /* 0x09, ACPI_RESOURCE_NAME_EXTENDED_XRUPT */ 380 AcpiDmAddress64Tags, /* 0x0A, ACPI_RESOURCE_NAME_QWORD_ADDRESS_SPACE */ 381 AcpiDmExtendedAddressTags, /* 0x0B, ACPI_RESOURCE_NAME_EXTENDED_ADDRESS_SPACE */ 382 NULL, /* 0x0C, ACPI_RESOURCE_NAME_GPIO - Use Subtype table below */ 383 NULL, /* 0x0D, Reserved */ 384 NULL /* 0x0E, ACPI_RESOURCE_NAME_SERIAL_BUS - Use Subtype table below */ 385 }; 386 387 /* GPIO Subtypes */ 388 389 static const ACPI_RESOURCE_TAG *AcpiGbl_GpioResourceTags[] = 390 { 391 AcpiDmGpioIntTags, /* 0x00 Interrupt Connection */ 392 AcpiDmGpioIoTags /* 0x01 I/O Connection */ 393 }; 394 395 /* Serial Bus Subtypes */ 396 397 static const ACPI_RESOURCE_TAG *AcpiGbl_SerialResourceTags[] = 398 { 399 NULL, /* 0x00 Reserved */ 400 AcpiDmI2cSerialBusTags, /* 0x01 I2C SerialBus */ 401 AcpiDmSpiSerialBusTags, /* 0x02 SPI SerialBus */ 402 AcpiDmUartSerialBusTags /* 0x03 UART SerialBus */ 403 }; 404 405 /* 406 * Globals used to generate unique resource descriptor names. We use names that 407 * start with underscore and a prefix letter that is not used by other ACPI 408 * reserved names. To this, we append hex 0x00 through 0xFF. These 5 prefixes 409 * allow for 5*256 = 1280 unique names, probably sufficient for any single ASL 410 * file. If this becomes too small, we can use alpha+numerals for a total 411 * of 5*36*36 = 6480. 412 */ 413 #define ACPI_NUM_RES_PREFIX 5 414 415 static UINT32 AcpiGbl_NextResourceId = 0; 416 static UINT8 AcpiGbl_NextPrefix = 0; 417 static char AcpiGbl_Prefix[ACPI_NUM_RES_PREFIX] = 418 {'Y','Z','J','K','X'}; 419 420 421 /******************************************************************************* 422 * 423 * FUNCTION: AcpiDmCheckResourceReference 424 * 425 * PARAMETERS: Op - Parse Op for the AML opcode 426 * WalkState - Current walk state (with valid scope) 427 * 428 * RETURN: None 429 * 430 * DESCRIPTION: Convert a reference to a resource descriptor to a symbolic 431 * reference if possible 432 * 433 * NOTE: Bit index is used to transparently handle both resource bit 434 * fields and byte fields. 435 * 436 ******************************************************************************/ 437 438 void 439 AcpiDmCheckResourceReference ( 440 ACPI_PARSE_OBJECT *Op, 441 ACPI_WALK_STATE *WalkState) 442 { 443 ACPI_STATUS Status; 444 ACPI_PARSE_OBJECT *BufferNameOp; 445 ACPI_PARSE_OBJECT *IndexOp; 446 ACPI_NAMESPACE_NODE *BufferNode; 447 ACPI_NAMESPACE_NODE *ResourceNode; 448 const ACPI_OPCODE_INFO *OpInfo; 449 UINT32 BitIndex; 450 451 452 /* We are only interested in the CreateXxxxField opcodes */ 453 454 OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode); 455 if (OpInfo->Type != AML_TYPE_CREATE_FIELD) 456 { 457 return; 458 } 459 460 /* Get the buffer term operand */ 461 462 BufferNameOp = AcpiPsGetDepthNext (NULL, Op); 463 464 /* Must be a named buffer, not an arg or local or method call */ 465 466 if (BufferNameOp->Common.AmlOpcode != AML_INT_NAMEPATH_OP) 467 { 468 return; 469 } 470 471 /* Get the Index term, must be an integer constant to convert */ 472 473 IndexOp = BufferNameOp->Common.Next; 474 475 /* Major cheat: The Node field is also used for the Tag ptr. Clear it now */ 476 477 IndexOp->Common.Node = NULL; 478 479 OpInfo = AcpiPsGetOpcodeInfo (IndexOp->Common.AmlOpcode); 480 if (OpInfo->ObjectType != ACPI_TYPE_INTEGER) 481 { 482 return; 483 } 484 485 /* Get the bit offset of the descriptor within the buffer */ 486 487 if ((Op->Common.AmlOpcode == AML_CREATE_BIT_FIELD_OP) || 488 (Op->Common.AmlOpcode == AML_CREATE_FIELD_OP)) 489 { 490 /* Index operand is a bit offset */ 491 492 BitIndex = (UINT32) IndexOp->Common.Value.Integer; 493 } 494 else 495 { 496 /* Index operand is a byte offset, convert to bits */ 497 498 BitIndex = (UINT32) ACPI_MUL_8 (IndexOp->Common.Value.Integer); 499 } 500 501 /* Lookup the buffer in the namespace */ 502 503 Status = AcpiNsLookup (WalkState->ScopeInfo, 504 BufferNameOp->Common.Value.String, ACPI_TYPE_BUFFER, 505 ACPI_IMODE_EXECUTE, ACPI_NS_SEARCH_PARENT, WalkState, 506 &BufferNode); 507 if (ACPI_FAILURE (Status)) 508 { 509 return; 510 } 511 512 /* Validate object type, we must have a buffer */ 513 514 if (BufferNode->Type != ACPI_TYPE_BUFFER) 515 { 516 return; 517 } 518 519 /* Find the resource descriptor node corresponding to the index */ 520 521 ResourceNode = AcpiDmGetResourceNode (BufferNode, BitIndex); 522 if (!ResourceNode) 523 { 524 return; 525 } 526 527 /* Translate the Index to a resource tag pathname */ 528 529 AcpiGetTagPathname (IndexOp, BufferNode, ResourceNode, BitIndex); 530 } 531 532 533 /******************************************************************************* 534 * 535 * FUNCTION: AcpiDmGetResourceNode 536 * 537 * PARAMETERS: BufferNode - Node for the parent buffer 538 * BitIndex - Index into the resource descriptor 539 * 540 * RETURN: Namespace node for the resource descriptor. NULL if not found 541 * 542 * DESCRIPTION: Find a resource descriptor that corresponds to the bit index 543 * 544 ******************************************************************************/ 545 546 static ACPI_NAMESPACE_NODE * 547 AcpiDmGetResourceNode ( 548 ACPI_NAMESPACE_NODE *BufferNode, 549 UINT32 BitIndex) 550 { 551 ACPI_NAMESPACE_NODE *Node; 552 UINT32 ByteIndex = ACPI_DIV_8 (BitIndex); 553 554 555 /* 556 * Child list contains an entry for each resource descriptor. Find 557 * the descriptor that corresponds to the Index. 558 * 559 * If there are no children, this is not a resource template 560 */ 561 Node = BufferNode->Child; 562 while (Node) 563 { 564 /* 565 * Check if the Index falls within this resource. 566 * 567 * Value contains the resource offset, Object contains the resource 568 * length (both in bytes) 569 */ 570 if ((ByteIndex >= Node->Value) && 571 (ByteIndex < (Node->Value + Node->Length))) 572 { 573 return (Node); 574 } 575 576 Node = Node->Peer; 577 } 578 579 return (NULL); 580 } 581 582 583 /******************************************************************************* 584 * 585 * FUNCTION: AcpiGetTagPathname 586 * 587 * PARAMETERS: BufferNode - Node for the parent buffer 588 * ResourceNode - Node for a resource descriptor 589 * BitIndex - Index into the resource descriptor 590 * 591 * RETURN: Full pathname for a resource tag. NULL if no match. 592 * Path is returned in AML (packed) format. 593 * 594 * DESCRIPTION: Convert a BitIndex into a symbolic resource tag (full pathname) 595 * 596 ******************************************************************************/ 597 598 static char * 599 AcpiGetTagPathname ( 600 ACPI_PARSE_OBJECT *IndexOp, 601 ACPI_NAMESPACE_NODE *BufferNode, 602 ACPI_NAMESPACE_NODE *ResourceNode, 603 UINT32 BitIndex) 604 { 605 ACPI_STATUS Status; 606 UINT32 ResourceBitIndex; 607 UINT8 ResourceTableIndex; 608 ACPI_SIZE RequiredSize; 609 char *Pathname; 610 AML_RESOURCE *Aml; 611 ACPI_PARSE_OBJECT *Op; 612 char *InternalPath; 613 char *Tag; 614 615 616 /* Get the Op that contains the actual buffer data */ 617 618 Op = BufferNode->Op->Common.Value.Arg; 619 Op = Op->Common.Next; 620 if (!Op) 621 { 622 return (NULL); 623 } 624 625 /* Get the individual resource descriptor and validate it */ 626 627 Aml = ACPI_CAST_PTR ( 628 AML_RESOURCE, &Op->Named.Data[ResourceNode->Value]); 629 630 Status = AcpiUtValidateResource (NULL, Aml, &ResourceTableIndex); 631 if (ACPI_FAILURE (Status)) 632 { 633 return (NULL); 634 } 635 636 /* Get offset into this descriptor (from offset into entire buffer) */ 637 638 ResourceBitIndex = BitIndex - ACPI_MUL_8 (ResourceNode->Value); 639 640 /* Get the tag associated with this resource descriptor and offset */ 641 642 Tag = AcpiDmGetResourceTag (ResourceBitIndex, Aml, ResourceTableIndex); 643 if (!Tag) 644 { 645 return (NULL); 646 } 647 648 /* 649 * Now that we know that we have a reference that can be converted to a 650 * symbol, change the name of the resource to a unique name. 651 */ 652 AcpiDmUpdateResourceName (ResourceNode); 653 654 /* Get the full pathname to the parent buffer */ 655 656 RequiredSize = AcpiNsBuildNormalizedPath (BufferNode, NULL, 0, FALSE); 657 if (!RequiredSize) 658 { 659 return (NULL); 660 } 661 662 Pathname = ACPI_ALLOCATE_ZEROED (RequiredSize + ACPI_PATH_SEGMENT_LENGTH); 663 if (!Pathname) 664 { 665 return (NULL); 666 } 667 668 (void) AcpiNsBuildNormalizedPath (BufferNode, Pathname, 669 RequiredSize, FALSE); 670 671 /* 672 * Create the full path to the resource and tag by: remove the buffer name, 673 * append the resource descriptor name, append a dot, append the tag name. 674 * 675 * TBD: Always using the full path is a bit brute force, the path can be 676 * often be optimized with carats (if the original buffer namepath is a 677 * single nameseg). This doesn't really matter, because these paths do not 678 * end up in the final compiled AML, it's just an appearance issue for the 679 * disassembled code. 680 */ 681 Pathname[strlen (Pathname) - ACPI_NAME_SIZE] = 0; 682 strncat (Pathname, ResourceNode->Name.Ascii, ACPI_NAME_SIZE); 683 strcat (Pathname, "."); 684 strncat (Pathname, Tag, ACPI_NAME_SIZE); 685 686 /* Internalize the namepath to AML format */ 687 688 AcpiNsInternalizeName (Pathname, &InternalPath); 689 ACPI_FREE (Pathname); 690 691 /* Update the Op with the symbol */ 692 693 AcpiPsInitOp (IndexOp, AML_INT_NAMEPATH_OP); 694 IndexOp->Common.Value.String = InternalPath; 695 696 /* We will need the tag later. Cheat by putting it in the Node field */ 697 698 IndexOp->Common.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Tag); 699 return (InternalPath); 700 } 701 702 703 /******************************************************************************* 704 * 705 * FUNCTION: AcpiDmUpdateResourceName 706 * 707 * PARAMETERS: ResourceNode - Node for a resource descriptor 708 * 709 * RETURN: Stores new name in the ResourceNode 710 * 711 * DESCRIPTION: Create a new, unique name for a resource descriptor. Used by 712 * both the disassembly of the descriptor itself and any symbolic 713 * references to the descriptor. Ignored if a unique name has 714 * already been assigned to the resource. 715 * 716 * NOTE: Single threaded, suitable for applications only! 717 * 718 ******************************************************************************/ 719 720 static void 721 AcpiDmUpdateResourceName ( 722 ACPI_NAMESPACE_NODE *ResourceNode) 723 { 724 char Name[ACPI_NAME_SIZE]; 725 726 727 /* Ignore if a unique name has already been assigned */ 728 729 if (ResourceNode->Name.Integer != ACPI_DEFAULT_RESNAME) 730 { 731 return; 732 } 733 734 /* Generate a new ACPI name for the descriptor */ 735 736 Name[0] = '_'; 737 Name[1] = AcpiGbl_Prefix[AcpiGbl_NextPrefix]; 738 Name[2] = AcpiUtHexToAsciiChar ((UINT64) AcpiGbl_NextResourceId, 4); 739 Name[3] = AcpiUtHexToAsciiChar ((UINT64) AcpiGbl_NextResourceId, 0); 740 741 /* Update globals for next name */ 742 743 AcpiGbl_NextResourceId++; 744 if (AcpiGbl_NextResourceId >= 256) 745 { 746 AcpiGbl_NextResourceId = 0; 747 AcpiGbl_NextPrefix++; 748 749 if (AcpiGbl_NextPrefix > ACPI_NUM_RES_PREFIX) 750 { 751 AcpiGbl_NextPrefix = 0; 752 } 753 } 754 755 /* Change the resource descriptor name */ 756 757 ResourceNode->Name.Integer = *ACPI_CAST_PTR (UINT32, &Name[0]); 758 } 759 760 761 /******************************************************************************* 762 * 763 * FUNCTION: AcpiDmGetResourceTag 764 * 765 * PARAMETERS: BitIndex - Index into the resource descriptor 766 * Resource - Pointer to the raw resource data 767 * ResourceIndex - Index correspoinding to the resource type 768 * 769 * RETURN: Pointer to the resource tag (ACPI_NAME). NULL if no match. 770 * 771 * DESCRIPTION: Convert a BitIndex into a symbolic resource tag. 772 * 773 * Note: ResourceIndex should be previously validated and guaranteed to ve 774 * valid. 775 * 776 ******************************************************************************/ 777 778 static char * 779 AcpiDmGetResourceTag ( 780 UINT32 BitIndex, 781 AML_RESOURCE *Resource, 782 UINT8 ResourceIndex) 783 { 784 const ACPI_RESOURCE_TAG *TagList; 785 char *Tag = NULL; 786 787 788 /* Get the tag list for this resource descriptor type */ 789 790 TagList = AcpiGbl_ResourceTags[ResourceIndex]; 791 792 /* 793 * Handle descriptors that have multiple subtypes 794 */ 795 switch (Resource->DescriptorType) 796 { 797 case ACPI_RESOURCE_NAME_ADDRESS16: 798 case ACPI_RESOURCE_NAME_ADDRESS32: 799 case ACPI_RESOURCE_NAME_ADDRESS64: 800 case ACPI_RESOURCE_NAME_EXTENDED_ADDRESS64: 801 /* 802 * Subtype differentiation is the flags. 803 * Kindof brute force, but just blindly search for an index match 804 */ 805 if (Resource->Address.ResourceType == ACPI_ADDRESS_TYPE_MEMORY_RANGE) 806 { 807 Tag = AcpiDmSearchTagList (BitIndex, AcpiDmMemoryFlagTags); 808 } 809 else if (Resource->Address.ResourceType == ACPI_ADDRESS_TYPE_IO_RANGE) 810 { 811 Tag = AcpiDmSearchTagList (BitIndex, AcpiDmIoFlagTags); 812 } 813 814 /* If we found a match, all done. Else, drop to normal search below */ 815 816 if (Tag) 817 { 818 return (Tag); 819 } 820 break; 821 822 case ACPI_RESOURCE_NAME_GPIO: 823 824 /* GPIO connection has 2 subtypes: Interrupt and I/O */ 825 826 if (Resource->Gpio.ConnectionType > AML_RESOURCE_MAX_GPIOTYPE) 827 { 828 return (NULL); 829 } 830 831 TagList = AcpiGbl_GpioResourceTags[Resource->Gpio.ConnectionType]; 832 break; 833 834 case ACPI_RESOURCE_NAME_SERIAL_BUS: 835 836 /* SerialBus has 3 subtypes: I2C, SPI, and UART */ 837 838 if ((Resource->CommonSerialBus.Type == 0) || 839 (Resource->CommonSerialBus.Type > AML_RESOURCE_MAX_SERIALBUSTYPE)) 840 { 841 return (NULL); 842 } 843 844 TagList = AcpiGbl_SerialResourceTags[Resource->CommonSerialBus.Type]; 845 break; 846 847 default: 848 849 break; 850 } 851 852 /* Search for a match against the BitIndex */ 853 854 if (TagList) 855 { 856 Tag = AcpiDmSearchTagList (BitIndex, TagList); 857 } 858 859 return (Tag); 860 } 861 862 863 /******************************************************************************* 864 * 865 * FUNCTION: AcpiDmSearchTagList 866 * 867 * PARAMETERS: BitIndex - Index into the resource descriptor 868 * TagList - List to search 869 * 870 * RETURN: Pointer to a tag (ACPI_NAME). NULL if no match found. 871 * 872 * DESCRIPTION: Search a tag list for a match to the input BitIndex. Matches 873 * a fixed offset to a symbolic resource tag name. 874 * 875 ******************************************************************************/ 876 877 static char * 878 AcpiDmSearchTagList ( 879 UINT32 BitIndex, 880 const ACPI_RESOURCE_TAG *TagList) 881 { 882 883 /* 884 * Walk the null-terminated tag list to find a matching bit offset. 885 * We are looking for an exact match. 886 */ 887 for ( ; TagList->Tag; TagList++) 888 { 889 if (BitIndex == TagList->BitIndex) 890 { 891 return (TagList->Tag); 892 } 893 } 894 895 /* A matching offset was not found */ 896 897 return (NULL); 898 } 899 900 901 /******************************************************************************* 902 * 903 * FUNCTION: AcpiDmFindResources 904 * 905 * PARAMETERS: Root - Root of the parse tree 906 * 907 * RETURN: None 908 * 909 * DESCRIPTION: Add all ResourceTemplate declarations to the namespace. Each 910 * resource descriptor in each template is given a node -- used 911 * for later conversion of resource references to symbolic refs. 912 * 913 ******************************************************************************/ 914 915 void 916 AcpiDmFindResources ( 917 ACPI_PARSE_OBJECT *Root) 918 { 919 ACPI_PARSE_OBJECT *Op = Root; 920 ACPI_PARSE_OBJECT *Parent; 921 922 923 /* Walk the entire parse tree */ 924 925 while (Op) 926 { 927 /* We are interested in Buffer() declarations */ 928 929 if (Op->Common.AmlOpcode == AML_BUFFER_OP) 930 { 931 /* And only declarations of the form Name (XXXX, Buffer()... ) */ 932 933 Parent = Op->Common.Parent; 934 if (Parent->Common.AmlOpcode == AML_NAME_OP) 935 { 936 /* 937 * If the buffer is a resource template, add the individual 938 * resource descriptors to the namespace, as children of the 939 * buffer node. 940 */ 941 if (ACPI_SUCCESS (AcpiDmIsResourceTemplate (NULL, Op))) 942 { 943 Op->Common.DisasmOpcode = ACPI_DASM_RESOURCE; 944 AcpiDmAddResourcesToNamespace (Parent->Common.Node, Op); 945 } 946 } 947 } 948 949 Op = AcpiPsGetDepthNext (Root, Op); 950 } 951 } 952 953 954 /******************************************************************************* 955 * 956 * FUNCTION: AcpiDmAddResourcesToNamespace 957 * 958 * PARAMETERS: BufferNode - Node for the parent buffer 959 * Op - Parse op for the buffer 960 * 961 * RETURN: None 962 * 963 * DESCRIPTION: Add an entire resource template to the namespace. Each 964 * resource descriptor is added as a namespace node. 965 * 966 ******************************************************************************/ 967 968 static void 969 AcpiDmAddResourcesToNamespace ( 970 ACPI_NAMESPACE_NODE *BufferNode, 971 ACPI_PARSE_OBJECT *Op) 972 { 973 ACPI_PARSE_OBJECT *NextOp; 974 975 976 /* Get to the ByteData list */ 977 978 NextOp = Op->Common.Value.Arg; 979 NextOp = NextOp->Common.Next; 980 if (!NextOp) 981 { 982 return; 983 } 984 985 /* Set Node and Op to point to each other */ 986 987 BufferNode->Op = Op; 988 Op->Common.Node = BufferNode; 989 990 /* 991 * Insert each resource into the namespace 992 * NextOp contains the Aml pointer and the Aml length 993 */ 994 AcpiUtWalkAmlResources (NULL, (UINT8 *) NextOp->Named.Data, 995 (ACPI_SIZE) NextOp->Common.Value.Integer, 996 AcpiDmAddResourceToNamespace, (void **) BufferNode); 997 } 998 999 1000 /******************************************************************************* 1001 * 1002 * FUNCTION: AcpiDmAddResourceToNamespace 1003 * 1004 * PARAMETERS: ACPI_WALK_AML_CALLBACK 1005 * BufferNode - Node for the parent buffer 1006 * 1007 * RETURN: Status 1008 * 1009 * DESCRIPTION: Add one resource descriptor to the namespace as a child of the 1010 * parent buffer. The same name is used for each descriptor. This 1011 * is changed later to a unique name if the resource is actually 1012 * referenced by an AML operator. 1013 * 1014 ******************************************************************************/ 1015 1016 static ACPI_STATUS 1017 AcpiDmAddResourceToNamespace ( 1018 UINT8 *Aml, 1019 UINT32 Length, 1020 UINT32 Offset, 1021 UINT8 ResourceIndex, 1022 void **Context) 1023 { 1024 ACPI_STATUS Status; 1025 ACPI_GENERIC_STATE ScopeInfo; 1026 ACPI_NAMESPACE_NODE *Node; 1027 1028 1029 /* TBD: Don't need to add descriptors that have no tags defined? */ 1030 1031 /* Add the resource to the namespace, as child of the buffer */ 1032 1033 ScopeInfo.Scope.Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Context); 1034 Status = AcpiNsLookup (&ScopeInfo, "_TMP", ACPI_TYPE_LOCAL_RESOURCE, 1035 ACPI_IMODE_LOAD_PASS2, 1036 ACPI_NS_NO_UPSEARCH | ACPI_NS_DONT_OPEN_SCOPE | ACPI_NS_PREFIX_IS_SCOPE, 1037 NULL, &Node); 1038 if (ACPI_FAILURE (Status)) 1039 { 1040 return (AE_OK); 1041 } 1042 1043 /* Set the name to the default, changed later if resource is referenced */ 1044 1045 Node->Name.Integer = ACPI_DEFAULT_RESNAME; 1046 1047 /* Save the offset of the descriptor (within the original buffer) */ 1048 1049 Node->Value = Offset; 1050 Node->Length = Length; 1051 return (AE_OK); 1052 } 1053