1 /******************************************************************************* 2 * 3 * Module Name: utstate - state object support procedures 4 * 5 ******************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2018, 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 "acpi.h" 153 #include "accommon.h" 154 155 #define _COMPONENT ACPI_UTILITIES 156 ACPI_MODULE_NAME ("utstate") 157 158 159 /******************************************************************************* 160 * 161 * FUNCTION: AcpiUtPushGenericState 162 * 163 * PARAMETERS: ListHead - Head of the state stack 164 * State - State object to push 165 * 166 * RETURN: None 167 * 168 * DESCRIPTION: Push a state object onto a state stack 169 * 170 ******************************************************************************/ 171 172 void 173 AcpiUtPushGenericState ( 174 ACPI_GENERIC_STATE **ListHead, 175 ACPI_GENERIC_STATE *State) 176 { 177 ACPI_FUNCTION_ENTRY (); 178 179 180 /* Push the state object onto the front of the list (stack) */ 181 182 State->Common.Next = *ListHead; 183 *ListHead = State; 184 return; 185 } 186 187 188 /******************************************************************************* 189 * 190 * FUNCTION: AcpiUtPopGenericState 191 * 192 * PARAMETERS: ListHead - Head of the state stack 193 * 194 * RETURN: The popped state object 195 * 196 * DESCRIPTION: Pop a state object from a state stack 197 * 198 ******************************************************************************/ 199 200 ACPI_GENERIC_STATE * 201 AcpiUtPopGenericState ( 202 ACPI_GENERIC_STATE **ListHead) 203 { 204 ACPI_GENERIC_STATE *State; 205 206 207 ACPI_FUNCTION_ENTRY (); 208 209 210 /* Remove the state object at the head of the list (stack) */ 211 212 State = *ListHead; 213 if (State) 214 { 215 /* Update the list head */ 216 217 *ListHead = State->Common.Next; 218 } 219 220 return (State); 221 } 222 223 224 /******************************************************************************* 225 * 226 * FUNCTION: AcpiUtCreateGenericState 227 * 228 * PARAMETERS: None 229 * 230 * RETURN: The new state object. NULL on failure. 231 * 232 * DESCRIPTION: Create a generic state object. Attempt to obtain one from 233 * the global state cache; If none available, create a new one. 234 * 235 ******************************************************************************/ 236 237 ACPI_GENERIC_STATE * 238 AcpiUtCreateGenericState ( 239 void) 240 { 241 ACPI_GENERIC_STATE *State; 242 243 244 ACPI_FUNCTION_ENTRY (); 245 246 247 State = AcpiOsAcquireObject (AcpiGbl_StateCache); 248 if (State) 249 { 250 /* Initialize */ 251 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE; 252 } 253 254 return (State); 255 } 256 257 258 /******************************************************************************* 259 * 260 * FUNCTION: AcpiUtCreateThreadState 261 * 262 * PARAMETERS: None 263 * 264 * RETURN: New Thread State. NULL on failure 265 * 266 * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used 267 * to track per-thread info during method execution 268 * 269 ******************************************************************************/ 270 271 ACPI_THREAD_STATE * 272 AcpiUtCreateThreadState ( 273 void) 274 { 275 ACPI_GENERIC_STATE *State; 276 277 278 ACPI_FUNCTION_ENTRY (); 279 280 281 /* Create the generic state object */ 282 283 State = AcpiUtCreateGenericState (); 284 if (!State) 285 { 286 return (NULL); 287 } 288 289 /* Init fields specific to the update struct */ 290 291 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_THREAD; 292 State->Thread.ThreadId = AcpiOsGetThreadId (); 293 294 /* Check for invalid thread ID - zero is very bad, it will break things */ 295 296 if (!State->Thread.ThreadId) 297 { 298 ACPI_ERROR ((AE_INFO, "Invalid zero ID from AcpiOsGetThreadId")); 299 State->Thread.ThreadId = (ACPI_THREAD_ID) 1; 300 } 301 302 return ((ACPI_THREAD_STATE *) State); 303 } 304 305 306 /******************************************************************************* 307 * 308 * FUNCTION: AcpiUtCreateUpdateState 309 * 310 * PARAMETERS: Object - Initial Object to be installed in the state 311 * Action - Update action to be performed 312 * 313 * RETURN: New state object, null on failure 314 * 315 * DESCRIPTION: Create an "Update State" - a flavor of the generic state used 316 * to update reference counts and delete complex objects such 317 * as packages. 318 * 319 ******************************************************************************/ 320 321 ACPI_GENERIC_STATE * 322 AcpiUtCreateUpdateState ( 323 ACPI_OPERAND_OBJECT *Object, 324 UINT16 Action) 325 { 326 ACPI_GENERIC_STATE *State; 327 328 329 ACPI_FUNCTION_ENTRY (); 330 331 332 /* Create the generic state object */ 333 334 State = AcpiUtCreateGenericState (); 335 if (!State) 336 { 337 return (NULL); 338 } 339 340 /* Init fields specific to the update struct */ 341 342 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_UPDATE; 343 State->Update.Object = Object; 344 State->Update.Value = Action; 345 return (State); 346 } 347 348 349 /******************************************************************************* 350 * 351 * FUNCTION: AcpiUtCreatePkgState 352 * 353 * PARAMETERS: Object - Initial Object to be installed in the state 354 * Action - Update action to be performed 355 * 356 * RETURN: New state object, null on failure 357 * 358 * DESCRIPTION: Create a "Package State" 359 * 360 ******************************************************************************/ 361 362 ACPI_GENERIC_STATE * 363 AcpiUtCreatePkgState ( 364 void *InternalObject, 365 void *ExternalObject, 366 UINT32 Index) 367 { 368 ACPI_GENERIC_STATE *State; 369 370 371 ACPI_FUNCTION_ENTRY (); 372 373 374 /* Create the generic state object */ 375 376 State = AcpiUtCreateGenericState (); 377 if (!State) 378 { 379 return (NULL); 380 } 381 382 /* Init fields specific to the update struct */ 383 384 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PACKAGE; 385 State->Pkg.SourceObject = (ACPI_OPERAND_OBJECT *) InternalObject; 386 State->Pkg.DestObject = ExternalObject; 387 State->Pkg.Index= Index; 388 State->Pkg.NumPackages = 1; 389 390 return (State); 391 } 392 393 394 /******************************************************************************* 395 * 396 * FUNCTION: AcpiUtCreateControlState 397 * 398 * PARAMETERS: None 399 * 400 * RETURN: New state object, null on failure 401 * 402 * DESCRIPTION: Create a "Control State" - a flavor of the generic state used 403 * to support nested IF/WHILE constructs in the AML. 404 * 405 ******************************************************************************/ 406 407 ACPI_GENERIC_STATE * 408 AcpiUtCreateControlState ( 409 void) 410 { 411 ACPI_GENERIC_STATE *State; 412 413 414 ACPI_FUNCTION_ENTRY (); 415 416 417 /* Create the generic state object */ 418 419 State = AcpiUtCreateGenericState (); 420 if (!State) 421 { 422 return (NULL); 423 } 424 425 /* Init fields specific to the control struct */ 426 427 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_CONTROL; 428 State->Common.State = ACPI_CONTROL_CONDITIONAL_EXECUTING; 429 430 return (State); 431 } 432 433 434 /******************************************************************************* 435 * 436 * FUNCTION: AcpiUtDeleteGenericState 437 * 438 * PARAMETERS: State - The state object to be deleted 439 * 440 * RETURN: None 441 * 442 * DESCRIPTION: Release a state object to the state cache. NULL state objects 443 * are ignored. 444 * 445 ******************************************************************************/ 446 447 void 448 AcpiUtDeleteGenericState ( 449 ACPI_GENERIC_STATE *State) 450 { 451 ACPI_FUNCTION_ENTRY (); 452 453 454 /* Ignore null state */ 455 456 if (State) 457 { 458 (void) AcpiOsReleaseObject (AcpiGbl_StateCache, State); 459 } 460 461 return; 462 } 463