utstate.c revision 193335
1226031Sstas/******************************************************************************* 2226031Sstas * 3226031Sstas * Module Name: utstate - state object support procedures 4226031Sstas * 5226031Sstas ******************************************************************************/ 6226031Sstas 7226031Sstas/****************************************************************************** 8226031Sstas * 9226031Sstas * 1. Copyright Notice 10226031Sstas * 11226031Sstas * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp. 12226031Sstas * All rights reserved. 13226031Sstas * 14226031Sstas * 2. License 15226031Sstas * 16226031Sstas * 2.1. This is your license from Intel Corp. under its intellectual property 17226031Sstas * rights. You may have additional license terms from the party that provided 18226031Sstas * you this software, covering your right to use that party's intellectual 19226031Sstas * property rights. 20226031Sstas * 21226031Sstas * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22226031Sstas * copy of the source code appearing in this file ("Covered Code") an 23226031Sstas * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24226031Sstas * base code distributed originally by Intel ("Original Intel Code") to copy, 25226031Sstas * make derivatives, distribute, use and display any portion of the Covered 26226031Sstas * Code in any form, with the right to sublicense such rights; and 27226031Sstas * 28226031Sstas * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29226031Sstas * license (with the right to sublicense), under only those claims of Intel 30226031Sstas * patents that are infringed by the Original Intel Code, to make, use, sell, 31226031Sstas * offer to sell, and import the Covered Code and derivative works thereof 32226031Sstas * solely to the minimum extent necessary to exercise the above copyright 33226031Sstas * license, and in no event shall the patent license extend to any additions 34226031Sstas * to or modifications of the Original Intel Code. No other license or right 35226031Sstas * is granted directly or by implication, estoppel or otherwise; 36226031Sstas * 37226031Sstas * The above copyright and patent license is granted only if the following 38226031Sstas * conditions are met: 39226031Sstas * 40226031Sstas * 3. Conditions 41226031Sstas * 42226031Sstas * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43226031Sstas * Redistribution of source code of any substantial portion of the Covered 44226031Sstas * Code or modification with rights to further distribute source must include 45226031Sstas * the above Copyright Notice, the above License, this list of Conditions, 46226031Sstas * and the following Disclaimer and Export Compliance provision. In addition, 47226031Sstas * Licensee must cause all Covered Code to which Licensee contributes to 48226031Sstas * contain a file documenting the changes Licensee made to create that Covered 49226031Sstas * Code and the date of any change. Licensee must include in that file the 50226031Sstas * documentation of any changes made by any predecessor Licensee. Licensee 51226031Sstas * must include a prominent statement that the modification is derived, 52226031Sstas * directly or indirectly, from Original Intel Code. 53226031Sstas * 54226031Sstas * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55226031Sstas * Redistribution of source code of any substantial portion of the Covered 56226031Sstas * Code or modification without rights to further distribute source must 57226031Sstas * include the following Disclaimer and Export Compliance provision in the 58226031Sstas * documentation and/or other materials provided with distribution. In 59226031Sstas * addition, Licensee may not authorize further sublicense of source of any 60226031Sstas * portion of the Covered Code, and must include terms to the effect that the 61226031Sstas * license from Licensee to its licensee is limited to the intellectual 62226031Sstas * property embodied in the software Licensee provides to its licensee, and 63226031Sstas * not to intellectual property embodied in modifications its licensee may 64226031Sstas * make. 65226031Sstas * 66226031Sstas * 3.3. Redistribution of Executable. Redistribution in executable form of any 67226031Sstas * substantial portion of the Covered Code or modification must reproduce the 68226031Sstas * above Copyright Notice, and the following Disclaimer and Export Compliance 69226031Sstas * provision in the documentation and/or other materials provided with the 70226031Sstas * distribution. 71226031Sstas * 72226031Sstas * 3.4. Intel retains all right, title, and interest in and to the Original 73226031Sstas * Intel Code. 74226031Sstas * 75226031Sstas * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76226031Sstas * Intel shall be used in advertising or otherwise to promote the sale, use or 77226031Sstas * other dealings in products derived from or relating to the Covered Code 78226031Sstas * without prior written authorization from Intel. 79226031Sstas * 80226031Sstas * 4. Disclaimer and Export Compliance 81226031Sstas * 82226031Sstas * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83226031Sstas * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84226031Sstas * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85226031Sstas * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86226031Sstas * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87226031Sstas * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88226031Sstas * PARTICULAR PURPOSE. 89226031Sstas * 90226031Sstas * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91226031Sstas * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92226031Sstas * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93226031Sstas * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94226031Sstas * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95226031Sstas * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96226031Sstas * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97226031Sstas * LIMITED REMEDY. 98226031Sstas * 99226031Sstas * 4.3. Licensee shall not export, either directly or indirectly, any of this 100226031Sstas * software or system incorporating such software without first obtaining any 101226031Sstas * required license or other approval from the U. S. Department of Commerce or 102226031Sstas * any other agency or department of the United States Government. In the 103226031Sstas * event Licensee exports any such software from the United States or 104226031Sstas * re-exports any such software from a foreign destination, Licensee shall 105226031Sstas * ensure that the distribution and export/re-export of the software is in 106226031Sstas * compliance with all laws, regulations, orders, or other restrictions of the 107226031Sstas * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108226031Sstas * any of its subsidiaries will export/re-export any technical data, process, 109226031Sstas * software, or service, directly or indirectly, to any country for which the 110226031Sstas * United States government or any agency thereof requires an export license, 111226031Sstas * other governmental approval, or letter of assurance, without first obtaining 112226031Sstas * such license, approval or letter. 113226031Sstas * 114226031Sstas *****************************************************************************/ 115226031Sstas 116226031Sstas 117226031Sstas#define __UTSTATE_C__ 118226031Sstas 119226031Sstas#include "acpi.h" 120226031Sstas#include "accommon.h" 121226031Sstas 122226031Sstas#define _COMPONENT ACPI_UTILITIES 123226031Sstas ACPI_MODULE_NAME ("utstate") 124226031Sstas 125226031Sstas 126226031Sstas/******************************************************************************* 127226031Sstas * 128226031Sstas * FUNCTION: AcpiUtCreatePkgStateAndPush 129226031Sstas * 130226031Sstas * PARAMETERS: Object - Object to be added to the new state 131226031Sstas * Action - Increment/Decrement 132226031Sstas * StateList - List the state will be added to 133226031Sstas * 134226031Sstas * RETURN: Status 135226031Sstas * 136226031Sstas * DESCRIPTION: Create a new state and push it 137 * 138 ******************************************************************************/ 139 140ACPI_STATUS 141AcpiUtCreatePkgStateAndPush ( 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 177void 178AcpiUtPushGenericState ( 179 ACPI_GENERIC_STATE **ListHead, 180 ACPI_GENERIC_STATE *State) 181{ 182 ACPI_FUNCTION_TRACE (UtPushGenericState); 183 184 185 /* Push the state object onto the front of the list (stack) */ 186 187 State->Common.Next = *ListHead; 188 *ListHead = State; 189 190 return_VOID; 191} 192 193 194/******************************************************************************* 195 * 196 * FUNCTION: AcpiUtPopGenericState 197 * 198 * PARAMETERS: ListHead - Head of the state stack 199 * 200 * RETURN: The popped state object 201 * 202 * DESCRIPTION: Pop a state object from a state stack 203 * 204 ******************************************************************************/ 205 206ACPI_GENERIC_STATE * 207AcpiUtPopGenericState ( 208 ACPI_GENERIC_STATE **ListHead) 209{ 210 ACPI_GENERIC_STATE *State; 211 212 213 ACPI_FUNCTION_TRACE (UtPopGenericState); 214 215 216 /* Remove the state object at the head of the list (stack) */ 217 218 State = *ListHead; 219 if (State) 220 { 221 /* Update the list head */ 222 223 *ListHead = State->Common.Next; 224 } 225 226 return_PTR (State); 227} 228 229 230/******************************************************************************* 231 * 232 * FUNCTION: AcpiUtCreateGenericState 233 * 234 * PARAMETERS: None 235 * 236 * RETURN: The new state object. NULL on failure. 237 * 238 * DESCRIPTION: Create a generic state object. Attempt to obtain one from 239 * the global state cache; If none available, create a new one. 240 * 241 ******************************************************************************/ 242 243ACPI_GENERIC_STATE * 244AcpiUtCreateGenericState ( 245 void) 246{ 247 ACPI_GENERIC_STATE *State; 248 249 250 ACPI_FUNCTION_ENTRY (); 251 252 253 State = AcpiOsAcquireObject (AcpiGbl_StateCache); 254 if (State) 255 { 256 /* Initialize */ 257 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE; 258 } 259 260 return (State); 261} 262 263 264/******************************************************************************* 265 * 266 * FUNCTION: AcpiUtCreateThreadState 267 * 268 * PARAMETERS: None 269 * 270 * RETURN: New Thread State. NULL on failure 271 * 272 * DESCRIPTION: Create a "Thread State" - a flavor of the generic state used 273 * to track per-thread info during method execution 274 * 275 ******************************************************************************/ 276 277ACPI_THREAD_STATE * 278AcpiUtCreateThreadState ( 279 void) 280{ 281 ACPI_GENERIC_STATE *State; 282 283 284 ACPI_FUNCTION_TRACE (UtCreateThreadState); 285 286 287 /* Create the generic state object */ 288 289 State = AcpiUtCreateGenericState (); 290 if (!State) 291 { 292 return_PTR (NULL); 293 } 294 295 /* Init fields specific to the update struct */ 296 297 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_THREAD; 298 State->Thread.ThreadId = AcpiOsGetThreadId (); 299 300 /* Check for invalid thread ID - zero is very bad, it will break things */ 301 302 if (!State->Thread.ThreadId) 303 { 304 ACPI_ERROR ((AE_INFO, "Invalid zero ID from AcpiOsGetThreadId")); 305 State->Thread.ThreadId = (ACPI_THREAD_ID) 1; 306 } 307 308 return_PTR ((ACPI_THREAD_STATE *) State); 309} 310 311 312/******************************************************************************* 313 * 314 * FUNCTION: AcpiUtCreateUpdateState 315 * 316 * PARAMETERS: Object - Initial Object to be installed in the state 317 * Action - Update action to be performed 318 * 319 * RETURN: New state object, null on failure 320 * 321 * DESCRIPTION: Create an "Update State" - a flavor of the generic state used 322 * to update reference counts and delete complex objects such 323 * as packages. 324 * 325 ******************************************************************************/ 326 327ACPI_GENERIC_STATE * 328AcpiUtCreateUpdateState ( 329 ACPI_OPERAND_OBJECT *Object, 330 UINT16 Action) 331{ 332 ACPI_GENERIC_STATE *State; 333 334 335 ACPI_FUNCTION_TRACE_PTR (UtCreateUpdateState, Object); 336 337 338 /* Create the generic state object */ 339 340 State = AcpiUtCreateGenericState (); 341 if (!State) 342 { 343 return_PTR (NULL); 344 } 345 346 /* Init fields specific to the update struct */ 347 348 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_UPDATE; 349 State->Update.Object = Object; 350 State->Update.Value = Action; 351 352 return_PTR (State); 353} 354 355 356/******************************************************************************* 357 * 358 * FUNCTION: AcpiUtCreatePkgState 359 * 360 * PARAMETERS: Object - Initial Object to be installed in the state 361 * Action - Update action to be performed 362 * 363 * RETURN: New state object, null on failure 364 * 365 * DESCRIPTION: Create a "Package State" 366 * 367 ******************************************************************************/ 368 369ACPI_GENERIC_STATE * 370AcpiUtCreatePkgState ( 371 void *InternalObject, 372 void *ExternalObject, 373 UINT16 Index) 374{ 375 ACPI_GENERIC_STATE *State; 376 377 378 ACPI_FUNCTION_TRACE_PTR (UtCreatePkgState, InternalObject); 379 380 381 /* Create the generic state object */ 382 383 State = AcpiUtCreateGenericState (); 384 if (!State) 385 { 386 return_PTR (NULL); 387 } 388 389 /* Init fields specific to the update struct */ 390 391 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_PACKAGE; 392 State->Pkg.SourceObject = (ACPI_OPERAND_OBJECT *) InternalObject; 393 State->Pkg.DestObject = ExternalObject; 394 State->Pkg.Index= Index; 395 State->Pkg.NumPackages = 1; 396 397 return_PTR (State); 398} 399 400 401/******************************************************************************* 402 * 403 * FUNCTION: AcpiUtCreateControlState 404 * 405 * PARAMETERS: None 406 * 407 * RETURN: New state object, null on failure 408 * 409 * DESCRIPTION: Create a "Control State" - a flavor of the generic state used 410 * to support nested IF/WHILE constructs in the AML. 411 * 412 ******************************************************************************/ 413 414ACPI_GENERIC_STATE * 415AcpiUtCreateControlState ( 416 void) 417{ 418 ACPI_GENERIC_STATE *State; 419 420 421 ACPI_FUNCTION_TRACE (UtCreateControlState); 422 423 424 /* Create the generic state object */ 425 426 State = AcpiUtCreateGenericState (); 427 if (!State) 428 { 429 return_PTR (NULL); 430 } 431 432 /* Init fields specific to the control struct */ 433 434 State->Common.DescriptorType = ACPI_DESC_TYPE_STATE_CONTROL; 435 State->Common.State = ACPI_CONTROL_CONDITIONAL_EXECUTING; 436 437 return_PTR (State); 438} 439 440 441/******************************************************************************* 442 * 443 * FUNCTION: AcpiUtDeleteGenericState 444 * 445 * PARAMETERS: State - The state object to be deleted 446 * 447 * RETURN: None 448 * 449 * DESCRIPTION: Release a state object to the state cache. NULL state objects 450 * are ignored. 451 * 452 ******************************************************************************/ 453 454void 455AcpiUtDeleteGenericState ( 456 ACPI_GENERIC_STATE *State) 457{ 458 ACPI_FUNCTION_TRACE (UtDeleteGenericState); 459 460 461 /* Ignore null state */ 462 463 if (State) 464 { 465 (void) AcpiOsReleaseObject (AcpiGbl_StateCache, State); 466 } 467 return_VOID; 468} 469 470 471