xref: /titanic_51/usr/src/uts/intel/io/acpica/utilities/utstate.c (revision c10c16dec587a0662068f6e2991c29ed3a9db943)
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 - 2009, 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_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 
206 ACPI_GENERIC_STATE *
207 AcpiUtPopGenericState (
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 
243 ACPI_GENERIC_STATE *
244 AcpiUtCreateGenericState (
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 
277 ACPI_THREAD_STATE *
278 AcpiUtCreateThreadState (
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 
327 ACPI_GENERIC_STATE *
328 AcpiUtCreateUpdateState (
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 
369 ACPI_GENERIC_STATE *
370 AcpiUtCreatePkgState (
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 
414 ACPI_GENERIC_STATE *
415 AcpiUtCreateControlState (
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 
454 void
455 AcpiUtDeleteGenericState (
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