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