1 /****************************************************************************** 2 * 3 * Module Name: psscope - Parser scope stack management routines 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 <contrib/dev/acpica/include/acpi.h> 153 #include <contrib/dev/acpica/include/accommon.h> 154 #include <contrib/dev/acpica/include/acparser.h> 155 156 #define _COMPONENT ACPI_PARSER 157 ACPI_MODULE_NAME ("psscope") 158 159 160 /******************************************************************************* 161 * 162 * FUNCTION: AcpiPsGetParentScope 163 * 164 * PARAMETERS: ParserState - Current parser state object 165 * 166 * RETURN: Pointer to an Op object 167 * 168 * DESCRIPTION: Get parent of current op being parsed 169 * 170 ******************************************************************************/ 171 172 ACPI_PARSE_OBJECT * 173 AcpiPsGetParentScope ( 174 ACPI_PARSE_STATE *ParserState) 175 { 176 177 return (ParserState->Scope->ParseScope.Op); 178 } 179 180 181 /******************************************************************************* 182 * 183 * FUNCTION: AcpiPsHasCompletedScope 184 * 185 * PARAMETERS: ParserState - Current parser state object 186 * 187 * RETURN: Boolean, TRUE = scope completed. 188 * 189 * DESCRIPTION: Is parsing of current argument complete? Determined by 190 * 1) AML pointer is at or beyond the end of the scope 191 * 2) The scope argument count has reached zero. 192 * 193 ******************************************************************************/ 194 195 BOOLEAN 196 AcpiPsHasCompletedScope ( 197 ACPI_PARSE_STATE *ParserState) 198 { 199 200 return ((BOOLEAN) 201 ((ParserState->Aml >= ParserState->Scope->ParseScope.ArgEnd || 202 !ParserState->Scope->ParseScope.ArgCount))); 203 } 204 205 206 /******************************************************************************* 207 * 208 * FUNCTION: AcpiPsInitScope 209 * 210 * PARAMETERS: ParserState - Current parser state object 211 * Root - the Root Node of this new scope 212 * 213 * RETURN: Status 214 * 215 * DESCRIPTION: Allocate and init a new scope object 216 * 217 ******************************************************************************/ 218 219 ACPI_STATUS 220 AcpiPsInitScope ( 221 ACPI_PARSE_STATE *ParserState, 222 ACPI_PARSE_OBJECT *RootOp) 223 { 224 ACPI_GENERIC_STATE *Scope; 225 226 227 ACPI_FUNCTION_TRACE_PTR (PsInitScope, RootOp); 228 229 230 Scope = AcpiUtCreateGenericState (); 231 if (!Scope) 232 { 233 return_ACPI_STATUS (AE_NO_MEMORY); 234 } 235 236 Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_RPSCOPE; 237 Scope->ParseScope.Op = RootOp; 238 Scope->ParseScope.ArgCount = ACPI_VAR_ARGS; 239 Scope->ParseScope.ArgEnd = ParserState->AmlEnd; 240 Scope->ParseScope.PkgEnd = ParserState->AmlEnd; 241 242 ParserState->Scope = Scope; 243 ParserState->StartOp = RootOp; 244 245 return_ACPI_STATUS (AE_OK); 246 } 247 248 249 /******************************************************************************* 250 * 251 * FUNCTION: AcpiPsPushScope 252 * 253 * PARAMETERS: ParserState - Current parser state object 254 * Op - Current op to be pushed 255 * RemainingArgs - List of args remaining 256 * ArgCount - Fixed or variable number of args 257 * 258 * RETURN: Status 259 * 260 * DESCRIPTION: Push current op to begin parsing its argument 261 * 262 ******************************************************************************/ 263 264 ACPI_STATUS 265 AcpiPsPushScope ( 266 ACPI_PARSE_STATE *ParserState, 267 ACPI_PARSE_OBJECT *Op, 268 UINT32 RemainingArgs, 269 UINT32 ArgCount) 270 { 271 ACPI_GENERIC_STATE *Scope; 272 273 274 ACPI_FUNCTION_TRACE_PTR (PsPushScope, Op); 275 276 277 Scope = AcpiUtCreateGenericState (); 278 if (!Scope) 279 { 280 return_ACPI_STATUS (AE_NO_MEMORY); 281 } 282 283 Scope->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PSCOPE; 284 Scope->ParseScope.Op = Op; 285 Scope->ParseScope.ArgList = RemainingArgs; 286 Scope->ParseScope.ArgCount = ArgCount; 287 Scope->ParseScope.PkgEnd = ParserState->PkgEnd; 288 289 /* Push onto scope stack */ 290 291 AcpiUtPushGenericState (&ParserState->Scope, Scope); 292 293 if (ArgCount == ACPI_VAR_ARGS) 294 { 295 /* Multiple arguments */ 296 297 Scope->ParseScope.ArgEnd = ParserState->PkgEnd; 298 } 299 else 300 { 301 /* Single argument */ 302 303 Scope->ParseScope.ArgEnd = ACPI_TO_POINTER (ACPI_MAX_PTR); 304 } 305 306 return_ACPI_STATUS (AE_OK); 307 } 308 309 310 /******************************************************************************* 311 * 312 * FUNCTION: AcpiPsPopScope 313 * 314 * PARAMETERS: ParserState - Current parser state object 315 * Op - Where the popped op is returned 316 * ArgList - Where the popped "next argument" is 317 * returned 318 * ArgCount - Count of objects in ArgList 319 * 320 * RETURN: Status 321 * 322 * DESCRIPTION: Return to parsing a previous op 323 * 324 ******************************************************************************/ 325 326 void 327 AcpiPsPopScope ( 328 ACPI_PARSE_STATE *ParserState, 329 ACPI_PARSE_OBJECT **Op, 330 UINT32 *ArgList, 331 UINT32 *ArgCount) 332 { 333 ACPI_GENERIC_STATE *Scope = ParserState->Scope; 334 335 336 ACPI_FUNCTION_TRACE (PsPopScope); 337 338 339 /* Only pop the scope if there is in fact a next scope */ 340 341 if (Scope->Common.Next) 342 { 343 Scope = AcpiUtPopGenericState (&ParserState->Scope); 344 345 /* Return to parsing previous op */ 346 347 *Op = Scope->ParseScope.Op; 348 *ArgList = Scope->ParseScope.ArgList; 349 *ArgCount = Scope->ParseScope.ArgCount; 350 ParserState->PkgEnd = Scope->ParseScope.PkgEnd; 351 352 /* All done with this scope state structure */ 353 354 AcpiUtDeleteGenericState (Scope); 355 } 356 else 357 { 358 /* Empty parse stack, prepare to fetch next opcode */ 359 360 *Op = NULL; 361 *ArgList = 0; 362 *ArgCount = 0; 363 } 364 365 ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, 366 "Popped Op %p Args %X\n", *Op, *ArgCount)); 367 return_VOID; 368 } 369 370 371 /******************************************************************************* 372 * 373 * FUNCTION: AcpiPsCleanupScope 374 * 375 * PARAMETERS: ParserState - Current parser state object 376 * 377 * RETURN: None 378 * 379 * DESCRIPTION: Destroy available list, remaining stack levels, and return 380 * root scope 381 * 382 ******************************************************************************/ 383 384 void 385 AcpiPsCleanupScope ( 386 ACPI_PARSE_STATE *ParserState) 387 { 388 ACPI_GENERIC_STATE *Scope; 389 390 391 ACPI_FUNCTION_TRACE_PTR (PsCleanupScope, ParserState); 392 393 394 if (!ParserState) 395 { 396 return_VOID; 397 } 398 399 /* Delete anything on the scope stack */ 400 401 while (ParserState->Scope) 402 { 403 Scope = AcpiUtPopGenericState (&ParserState->Scope); 404 AcpiUtDeleteGenericState (Scope); 405 } 406 407 return_VOID; 408 } 409