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