1 /******************************************************************************* 2 * 3 * Module Name: utmisc - common utility procedures 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2013, 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 117 #define __UTMISC_C__ 118 119 #include "acpi.h" 120 #include "accommon.h" 121 #include "acnamesp.h" 122 123 124 #define _COMPONENT ACPI_UTILITIES 125 ACPI_MODULE_NAME ("utmisc") 126 127 128 /******************************************************************************* 129 * 130 * FUNCTION: AcpiUtIsPciRootBridge 131 * 132 * PARAMETERS: Id - The HID/CID in string format 133 * 134 * RETURN: TRUE if the Id is a match for a PCI/PCI-Express Root Bridge 135 * 136 * DESCRIPTION: Determine if the input ID is a PCI Root Bridge ID. 137 * 138 ******************************************************************************/ 139 140 BOOLEAN 141 AcpiUtIsPciRootBridge ( 142 char *Id) 143 { 144 145 /* 146 * Check if this is a PCI root bridge. 147 * ACPI 3.0+: check for a PCI Express root also. 148 */ 149 if (!(ACPI_STRCMP (Id, 150 PCI_ROOT_HID_STRING)) || 151 152 !(ACPI_STRCMP (Id, 153 PCI_EXPRESS_ROOT_HID_STRING))) 154 { 155 return (TRUE); 156 } 157 158 return (FALSE); 159 } 160 161 162 /******************************************************************************* 163 * 164 * FUNCTION: AcpiUtIsAmlTable 165 * 166 * PARAMETERS: Table - An ACPI table 167 * 168 * RETURN: TRUE if table contains executable AML; FALSE otherwise 169 * 170 * DESCRIPTION: Check ACPI Signature for a table that contains AML code. 171 * Currently, these are DSDT,SSDT,PSDT. All other table types are 172 * data tables that do not contain AML code. 173 * 174 ******************************************************************************/ 175 176 BOOLEAN 177 AcpiUtIsAmlTable ( 178 ACPI_TABLE_HEADER *Table) 179 { 180 181 /* These are the only tables that contain executable AML */ 182 183 if (ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_DSDT) || 184 ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_PSDT) || 185 ACPI_COMPARE_NAME (Table->Signature, ACPI_SIG_SSDT)) 186 { 187 return (TRUE); 188 } 189 190 return (FALSE); 191 } 192 193 194 /******************************************************************************* 195 * 196 * FUNCTION: AcpiUtDwordByteSwap 197 * 198 * PARAMETERS: Value - Value to be converted 199 * 200 * RETURN: UINT32 integer with bytes swapped 201 * 202 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes) 203 * 204 ******************************************************************************/ 205 206 UINT32 207 AcpiUtDwordByteSwap ( 208 UINT32 Value) 209 { 210 union 211 { 212 UINT32 Value; 213 UINT8 Bytes[4]; 214 } Out; 215 union 216 { 217 UINT32 Value; 218 UINT8 Bytes[4]; 219 } In; 220 221 222 ACPI_FUNCTION_ENTRY (); 223 224 225 In.Value = Value; 226 227 Out.Bytes[0] = In.Bytes[3]; 228 Out.Bytes[1] = In.Bytes[2]; 229 Out.Bytes[2] = In.Bytes[1]; 230 Out.Bytes[3] = In.Bytes[0]; 231 232 return (Out.Value); 233 } 234 235 236 /******************************************************************************* 237 * 238 * FUNCTION: AcpiUtSetIntegerWidth 239 * 240 * PARAMETERS: Revision From DSDT header 241 * 242 * RETURN: None 243 * 244 * DESCRIPTION: Set the global integer bit width based upon the revision 245 * of the DSDT. For Revision 1 and 0, Integers are 32 bits. 246 * For Revision 2 and above, Integers are 64 bits. Yes, this 247 * makes a difference. 248 * 249 ******************************************************************************/ 250 251 void 252 AcpiUtSetIntegerWidth ( 253 UINT8 Revision) 254 { 255 256 if (Revision < 2) 257 { 258 /* 32-bit case */ 259 260 AcpiGbl_IntegerBitWidth = 32; 261 AcpiGbl_IntegerNybbleWidth = 8; 262 AcpiGbl_IntegerByteWidth = 4; 263 } 264 else 265 { 266 /* 64-bit case (ACPI 2.0+) */ 267 268 AcpiGbl_IntegerBitWidth = 64; 269 AcpiGbl_IntegerNybbleWidth = 16; 270 AcpiGbl_IntegerByteWidth = 8; 271 } 272 } 273 274 275 /******************************************************************************* 276 * 277 * FUNCTION: AcpiUtCreateUpdateStateAndPush 278 * 279 * PARAMETERS: Object - Object to be added to the new state 280 * Action - Increment/Decrement 281 * StateList - List the state will be added to 282 * 283 * RETURN: Status 284 * 285 * DESCRIPTION: Create a new state and push it 286 * 287 ******************************************************************************/ 288 289 ACPI_STATUS 290 AcpiUtCreateUpdateStateAndPush ( 291 ACPI_OPERAND_OBJECT *Object, 292 UINT16 Action, 293 ACPI_GENERIC_STATE **StateList) 294 { 295 ACPI_GENERIC_STATE *State; 296 297 298 ACPI_FUNCTION_ENTRY (); 299 300 301 /* Ignore null objects; these are expected */ 302 303 if (!Object) 304 { 305 return (AE_OK); 306 } 307 308 State = AcpiUtCreateUpdateState (Object, Action); 309 if (!State) 310 { 311 return (AE_NO_MEMORY); 312 } 313 314 AcpiUtPushGenericState (StateList, State); 315 return (AE_OK); 316 } 317 318 319 /******************************************************************************* 320 * 321 * FUNCTION: AcpiUtWalkPackageTree 322 * 323 * PARAMETERS: SourceObject - The package to walk 324 * TargetObject - Target object (if package is being copied) 325 * WalkCallback - Called once for each package element 326 * Context - Passed to the callback function 327 * 328 * RETURN: Status 329 * 330 * DESCRIPTION: Walk through a package 331 * 332 ******************************************************************************/ 333 334 ACPI_STATUS 335 AcpiUtWalkPackageTree ( 336 ACPI_OPERAND_OBJECT *SourceObject, 337 void *TargetObject, 338 ACPI_PKG_CALLBACK WalkCallback, 339 void *Context) 340 { 341 ACPI_STATUS Status = AE_OK; 342 ACPI_GENERIC_STATE *StateList = NULL; 343 ACPI_GENERIC_STATE *State; 344 UINT32 ThisIndex; 345 ACPI_OPERAND_OBJECT *ThisSourceObj; 346 347 348 ACPI_FUNCTION_TRACE (UtWalkPackageTree); 349 350 351 State = AcpiUtCreatePkgState (SourceObject, TargetObject, 0); 352 if (!State) 353 { 354 return_ACPI_STATUS (AE_NO_MEMORY); 355 } 356 357 while (State) 358 { 359 /* Get one element of the package */ 360 361 ThisIndex = State->Pkg.Index; 362 ThisSourceObj = (ACPI_OPERAND_OBJECT *) 363 State->Pkg.SourceObject->Package.Elements[ThisIndex]; 364 365 /* 366 * Check for: 367 * 1) An uninitialized package element. It is completely 368 * legal to declare a package and leave it uninitialized 369 * 2) Not an internal object - can be a namespace node instead 370 * 3) Any type other than a package. Packages are handled in else 371 * case below. 372 */ 373 if ((!ThisSourceObj) || 374 (ACPI_GET_DESCRIPTOR_TYPE (ThisSourceObj) != ACPI_DESC_TYPE_OPERAND) || 375 (ThisSourceObj->Common.Type != ACPI_TYPE_PACKAGE)) 376 { 377 Status = WalkCallback (ACPI_COPY_TYPE_SIMPLE, ThisSourceObj, 378 State, Context); 379 if (ACPI_FAILURE (Status)) 380 { 381 return_ACPI_STATUS (Status); 382 } 383 384 State->Pkg.Index++; 385 while (State->Pkg.Index >= State->Pkg.SourceObject->Package.Count) 386 { 387 /* 388 * We've handled all of the objects at this level, This means 389 * that we have just completed a package. That package may 390 * have contained one or more packages itself. 391 * 392 * Delete this state and pop the previous state (package). 393 */ 394 AcpiUtDeleteGenericState (State); 395 State = AcpiUtPopGenericState (&StateList); 396 397 /* Finished when there are no more states */ 398 399 if (!State) 400 { 401 /* 402 * We have handled all of the objects in the top level 403 * package just add the length of the package objects 404 * and exit 405 */ 406 return_ACPI_STATUS (AE_OK); 407 } 408 409 /* 410 * Go back up a level and move the index past the just 411 * completed package object. 412 */ 413 State->Pkg.Index++; 414 } 415 } 416 else 417 { 418 /* This is a subobject of type package */ 419 420 Status = WalkCallback (ACPI_COPY_TYPE_PACKAGE, ThisSourceObj, 421 State, Context); 422 if (ACPI_FAILURE (Status)) 423 { 424 return_ACPI_STATUS (Status); 425 } 426 427 /* 428 * Push the current state and create a new one 429 * The callback above returned a new target package object. 430 */ 431 AcpiUtPushGenericState (&StateList, State); 432 State = AcpiUtCreatePkgState (ThisSourceObj, 433 State->Pkg.ThisTargetObj, 0); 434 if (!State) 435 { 436 /* Free any stacked Update State objects */ 437 438 while (StateList) 439 { 440 State = AcpiUtPopGenericState (&StateList); 441 AcpiUtDeleteGenericState (State); 442 } 443 return_ACPI_STATUS (AE_NO_MEMORY); 444 } 445 } 446 } 447 448 /* We should never get here */ 449 450 return_ACPI_STATUS (AE_AML_INTERNAL); 451 } 452 453 454 #ifdef ACPI_DEBUG_OUTPUT 455 /******************************************************************************* 456 * 457 * FUNCTION: AcpiUtDisplayInitPathname 458 * 459 * PARAMETERS: Type - Object type of the node 460 * ObjHandle - Handle whose pathname will be displayed 461 * Path - Additional path string to be appended. 462 * (NULL if no extra path) 463 * 464 * RETURN: ACPI_STATUS 465 * 466 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY 467 * 468 ******************************************************************************/ 469 470 void 471 AcpiUtDisplayInitPathname ( 472 UINT8 Type, 473 ACPI_NAMESPACE_NODE *ObjHandle, 474 char *Path) 475 { 476 ACPI_STATUS Status; 477 ACPI_BUFFER Buffer; 478 479 480 ACPI_FUNCTION_ENTRY (); 481 482 483 /* Only print the path if the appropriate debug level is enabled */ 484 485 if (!(AcpiDbgLevel & ACPI_LV_INIT_NAMES)) 486 { 487 return; 488 } 489 490 /* Get the full pathname to the node */ 491 492 Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER; 493 Status = AcpiNsHandleToPathname (ObjHandle, &Buffer); 494 if (ACPI_FAILURE (Status)) 495 { 496 return; 497 } 498 499 /* Print what we're doing */ 500 501 switch (Type) 502 { 503 case ACPI_TYPE_METHOD: 504 505 AcpiOsPrintf ("Executing "); 506 break; 507 508 default: 509 510 AcpiOsPrintf ("Initializing "); 511 break; 512 } 513 514 /* Print the object type and pathname */ 515 516 AcpiOsPrintf ("%-12s %s", 517 AcpiUtGetTypeName (Type), (char *) Buffer.Pointer); 518 519 /* Extra path is used to append names like _STA, _INI, etc. */ 520 521 if (Path) 522 { 523 AcpiOsPrintf (".%s", Path); 524 } 525 AcpiOsPrintf ("\n"); 526 527 ACPI_FREE (Buffer.Pointer); 528 } 529 #endif 530