1 /****************************************************************************** 2 * 3 * Module Name: dswscope - Scope stack manipulation 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2017, 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/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acdispat.h> 155 156 157 #define _COMPONENT ACPI_DISPATCHER 158 ACPI_MODULE_NAME ("dswscope") 159 160 161 /**************************************************************************** 162 * 163 * FUNCTION: AcpiDsScopeStackClear 164 * 165 * PARAMETERS: WalkState - Current state 166 * 167 * RETURN: None 168 * 169 * DESCRIPTION: Pop (and free) everything on the scope stack except the 170 * root scope object (which remains at the stack top.) 171 * 172 ***************************************************************************/ 173 174 void 175 AcpiDsScopeStackClear ( 176 ACPI_WALK_STATE *WalkState) 177 { 178 ACPI_GENERIC_STATE *ScopeInfo; 179 180 ACPI_FUNCTION_NAME (DsScopeStackClear); 181 182 183 while (WalkState->ScopeInfo) 184 { 185 /* Pop a scope off the stack */ 186 187 ScopeInfo = WalkState->ScopeInfo; 188 WalkState->ScopeInfo = ScopeInfo->Scope.Next; 189 190 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 191 "Popped object type (%s)\n", 192 AcpiUtGetTypeName (ScopeInfo->Common.Value))); 193 194 AcpiUtDeleteGenericState (ScopeInfo); 195 } 196 } 197 198 199 /**************************************************************************** 200 * 201 * FUNCTION: AcpiDsScopeStackPush 202 * 203 * PARAMETERS: Node - Name to be made current 204 * Type - Type of frame being pushed 205 * WalkState - Current state 206 * 207 * RETURN: Status 208 * 209 * DESCRIPTION: Push the current scope on the scope stack, and make the 210 * passed Node current. 211 * 212 ***************************************************************************/ 213 214 ACPI_STATUS 215 AcpiDsScopeStackPush ( 216 ACPI_NAMESPACE_NODE *Node, 217 ACPI_OBJECT_TYPE Type, 218 ACPI_WALK_STATE *WalkState) 219 { 220 ACPI_GENERIC_STATE *ScopeInfo; 221 ACPI_GENERIC_STATE *OldScopeInfo; 222 223 224 ACPI_FUNCTION_TRACE (DsScopeStackPush); 225 226 227 if (!Node) 228 { 229 /* Invalid scope */ 230 231 ACPI_ERROR ((AE_INFO, "Null scope parameter")); 232 return_ACPI_STATUS (AE_BAD_PARAMETER); 233 } 234 235 /* Make sure object type is valid */ 236 237 if (!AcpiUtValidObjectType (Type)) 238 { 239 ACPI_WARNING ((AE_INFO, 240 "Invalid object type: 0x%X", Type)); 241 } 242 243 /* Allocate a new scope object */ 244 245 ScopeInfo = AcpiUtCreateGenericState (); 246 if (!ScopeInfo) 247 { 248 return_ACPI_STATUS (AE_NO_MEMORY); 249 } 250 251 /* Init new scope object */ 252 253 ScopeInfo->Common.DescriptorType = ACPI_DESC_TYPE_STATE_WSCOPE; 254 ScopeInfo->Scope.Node = Node; 255 ScopeInfo->Common.Value = (UINT16) Type; 256 257 WalkState->ScopeDepth++; 258 259 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 260 "[%.2d] Pushed scope ", (UINT32) WalkState->ScopeDepth)); 261 262 OldScopeInfo = WalkState->ScopeInfo; 263 if (OldScopeInfo) 264 { 265 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, 266 "[%4.4s] (%s)", 267 AcpiUtGetNodeName (OldScopeInfo->Scope.Node), 268 AcpiUtGetTypeName (OldScopeInfo->Common.Value))); 269 } 270 else 271 { 272 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, 273 "[\\___] (%s)", "ROOT")); 274 } 275 276 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, 277 ", New scope -> [%4.4s] (%s)\n", 278 AcpiUtGetNodeName (ScopeInfo->Scope.Node), 279 AcpiUtGetTypeName (ScopeInfo->Common.Value))); 280 281 /* Push new scope object onto stack */ 282 283 AcpiUtPushGenericState (&WalkState->ScopeInfo, ScopeInfo); 284 return_ACPI_STATUS (AE_OK); 285 } 286 287 288 /**************************************************************************** 289 * 290 * FUNCTION: AcpiDsScopeStackPop 291 * 292 * PARAMETERS: WalkState - Current state 293 * 294 * RETURN: Status 295 * 296 * DESCRIPTION: Pop the scope stack once. 297 * 298 ***************************************************************************/ 299 300 ACPI_STATUS 301 AcpiDsScopeStackPop ( 302 ACPI_WALK_STATE *WalkState) 303 { 304 ACPI_GENERIC_STATE *ScopeInfo; 305 ACPI_GENERIC_STATE *NewScopeInfo; 306 307 308 ACPI_FUNCTION_TRACE (DsScopeStackPop); 309 310 311 /* 312 * Pop scope info object off the stack. 313 */ 314 ScopeInfo = AcpiUtPopGenericState (&WalkState->ScopeInfo); 315 if (!ScopeInfo) 316 { 317 return_ACPI_STATUS (AE_STACK_UNDERFLOW); 318 } 319 320 WalkState->ScopeDepth--; 321 322 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 323 "[%.2d] Popped scope [%4.4s] (%s), New scope -> ", 324 (UINT32) WalkState->ScopeDepth, 325 AcpiUtGetNodeName (ScopeInfo->Scope.Node), 326 AcpiUtGetTypeName (ScopeInfo->Common.Value))); 327 328 NewScopeInfo = WalkState->ScopeInfo; 329 if (NewScopeInfo) 330 { 331 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, 332 "[%4.4s] (%s)\n", 333 AcpiUtGetNodeName (NewScopeInfo->Scope.Node), 334 AcpiUtGetTypeName (NewScopeInfo->Common.Value))); 335 } 336 else 337 { 338 ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EXEC, 339 "[\\___] (ROOT)\n")); 340 } 341 342 AcpiUtDeleteGenericState (ScopeInfo); 343 return_ACPI_STATUS (AE_OK); 344 } 345