utstate.c revision 151937
1/******************************************************************************* 2 * 3 * Module Name: utstate - state object support procedures 4 * $Revision: 1.2 $ 5 * 6 ******************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 118#define __UTSTATE_C__ 119 120#include <contrib/dev/acpica/acpi.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 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.DataType = 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.DataType = ACPI_DESC_TYPE_STATE_THREAD; 298 State->Thread.ThreadId = AcpiOsGetThreadId (); 299 300 return_PTR ((ACPI_THREAD_STATE *) State); 301} 302 303 304/******************************************************************************* 305 * 306 * FUNCTION: AcpiUtCreateUpdateState 307 * 308 * PARAMETERS: Object - Initial Object to be installed in the state 309 * Action - Update action to be performed 310 * 311 * RETURN: New state object, null on failure 312 * 313 * DESCRIPTION: Create an "Update State" - a flavor of the generic state used 314 * to update reference counts and delete complex objects such 315 * as packages. 316 * 317 ******************************************************************************/ 318 319ACPI_GENERIC_STATE * 320AcpiUtCreateUpdateState ( 321 ACPI_OPERAND_OBJECT *Object, 322 UINT16 Action) 323{ 324 ACPI_GENERIC_STATE *State; 325 326 327 ACPI_FUNCTION_TRACE_PTR ("UtCreateUpdateState", Object); 328 329 330 /* Create the generic state object */ 331 332 State = AcpiUtCreateGenericState (); 333 if (!State) 334 { 335 return_PTR (NULL); 336 } 337 338 /* Init fields specific to the update struct */ 339 340 State->Common.DataType = ACPI_DESC_TYPE_STATE_UPDATE; 341 State->Update.Object = Object; 342 State->Update.Value = Action; 343 344 return_PTR (State); 345} 346 347 348/******************************************************************************* 349 * 350 * FUNCTION: AcpiUtCreatePkgState 351 * 352 * PARAMETERS: Object - Initial Object to be installed in the state 353 * Action - Update action to be performed 354 * 355 * RETURN: New state object, null on failure 356 * 357 * DESCRIPTION: Create a "Package State" 358 * 359 ******************************************************************************/ 360 361ACPI_GENERIC_STATE * 362AcpiUtCreatePkgState ( 363 void *InternalObject, 364 void *ExternalObject, 365 UINT16 Index) 366{ 367 ACPI_GENERIC_STATE *State; 368 369 370 ACPI_FUNCTION_TRACE_PTR ("UtCreatePkgState", InternalObject); 371 372 373 /* Create the generic state object */ 374 375 State = AcpiUtCreateGenericState (); 376 if (!State) 377 { 378 return_PTR (NULL); 379 } 380 381 /* Init fields specific to the update struct */ 382 383 State->Common.DataType = ACPI_DESC_TYPE_STATE_PACKAGE; 384 State->Pkg.SourceObject = (ACPI_OPERAND_OBJECT *) InternalObject; 385 State->Pkg.DestObject = ExternalObject; 386 State->Pkg.Index = Index; 387 State->Pkg.NumPackages = 1; 388 389 return_PTR (State); 390} 391 392 393/******************************************************************************* 394 * 395 * FUNCTION: AcpiUtCreateControlState 396 * 397 * PARAMETERS: None 398 * 399 * RETURN: New state object, null on failure 400 * 401 * DESCRIPTION: Create a "Control State" - a flavor of the generic state used 402 * to support nested IF/WHILE constructs in the AML. 403 * 404 ******************************************************************************/ 405 406ACPI_GENERIC_STATE * 407AcpiUtCreateControlState ( 408 void) 409{ 410 ACPI_GENERIC_STATE *State; 411 412 413 ACPI_FUNCTION_TRACE ("UtCreateControlState"); 414 415 416 /* Create the generic state object */ 417 418 State = AcpiUtCreateGenericState (); 419 if (!State) 420 { 421 return_PTR (NULL); 422 } 423 424 /* Init fields specific to the control struct */ 425 426 State->Common.DataType = ACPI_DESC_TYPE_STATE_CONTROL; 427 State->Common.State = ACPI_CONTROL_CONDITIONAL_EXECUTING; 428 429 return_PTR (State); 430} 431 432 433/******************************************************************************* 434 * 435 * FUNCTION: AcpiUtDeleteGenericState 436 * 437 * PARAMETERS: State - The state object to be deleted 438 * 439 * RETURN: None 440 * 441 * DESCRIPTION: Put a state object back into the global state cache. The object 442 * is not actually freed at this time. 443 * 444 ******************************************************************************/ 445 446void 447AcpiUtDeleteGenericState ( 448 ACPI_GENERIC_STATE *State) 449{ 450 ACPI_FUNCTION_TRACE ("UtDeleteGenericState"); 451 452 453 (void) AcpiOsReleaseObject (AcpiGbl_StateCache, State); 454 return_VOID; 455} 456 457 458