xref: /titanic_50/usr/src/uts/intel/io/acpica/executer/exsystem.c (revision dd52495f0d9ba8ff6d84921ec0500be837896554)
1 
2 /******************************************************************************
3  *
4  * Module Name: exsystem - Interface to OS services
5  *              $Revision: 1.95 $
6  *
7  *****************************************************************************/
8 
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2008, Intel Corp.
14  * All rights reserved.
15  *
16  * 2. License
17  *
18  * 2.1. This is your license from Intel Corp. under its intellectual property
19  * rights.  You may have additional license terms from the party that provided
20  * you this software, covering your right to use that party's intellectual
21  * property rights.
22  *
23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24  * copy of the source code appearing in this file ("Covered Code") an
25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26  * base code distributed originally by Intel ("Original Intel Code") to copy,
27  * make derivatives, distribute, use and display any portion of the Covered
28  * Code in any form, with the right to sublicense such rights; and
29  *
30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31  * license (with the right to sublicense), under only those claims of Intel
32  * patents that are infringed by the Original Intel Code, to make, use, sell,
33  * offer to sell, and import the Covered Code and derivative works thereof
34  * solely to the minimum extent necessary to exercise the above copyright
35  * license, and in no event shall the patent license extend to any additions
36  * to or modifications of the Original Intel Code.  No other license or right
37  * is granted directly or by implication, estoppel or otherwise;
38  *
39  * The above copyright and patent license is granted only if the following
40  * conditions are met:
41  *
42  * 3. Conditions
43  *
44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45  * Redistribution of source code of any substantial portion of the Covered
46  * Code or modification with rights to further distribute source must include
47  * the above Copyright Notice, the above License, this list of Conditions,
48  * and the following Disclaimer and Export Compliance provision.  In addition,
49  * Licensee must cause all Covered Code to which Licensee contributes to
50  * contain a file documenting the changes Licensee made to create that Covered
51  * Code and the date of any change.  Licensee must include in that file the
52  * documentation of any changes made by any predecessor Licensee.  Licensee
53  * must include a prominent statement that the modification is derived,
54  * directly or indirectly, from Original Intel Code.
55  *
56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57  * Redistribution of source code of any substantial portion of the Covered
58  * Code or modification without rights to further distribute source must
59  * include the following Disclaimer and Export Compliance provision in the
60  * documentation and/or other materials provided with distribution.  In
61  * addition, Licensee may not authorize further sublicense of source of any
62  * portion of the Covered Code, and must include terms to the effect that the
63  * license from Licensee to its licensee is limited to the intellectual
64  * property embodied in the software Licensee provides to its licensee, and
65  * not to intellectual property embodied in modifications its licensee may
66  * make.
67  *
68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
69  * substantial portion of the Covered Code or modification must reproduce the
70  * above Copyright Notice, and the following Disclaimer and Export Compliance
71  * provision in the documentation and/or other materials provided with the
72  * distribution.
73  *
74  * 3.4. Intel retains all right, title, and interest in and to the Original
75  * Intel Code.
76  *
77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78  * Intel shall be used in advertising or otherwise to promote the sale, use or
79  * other dealings in products derived from or relating to the Covered Code
80  * without prior written authorization from Intel.
81  *
82  * 4. Disclaimer and Export Compliance
83  *
84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90  * PARTICULAR PURPOSE.
91  *
92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99  * LIMITED REMEDY.
100  *
101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
102  * software or system incorporating such software without first obtaining any
103  * required license or other approval from the U. S. Department of Commerce or
104  * any other agency or department of the United States Government.  In the
105  * event Licensee exports any such software from the United States or
106  * re-exports any such software from a foreign destination, Licensee shall
107  * ensure that the distribution and export/re-export of the software is in
108  * compliance with all laws, regulations, orders, or other restrictions of the
109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110  * any of its subsidiaries will export/re-export any technical data, process,
111  * software, or service, directly or indirectly, to any country for which the
112  * United States government or any agency thereof requires an export license,
113  * other governmental approval, or letter of assurance, without first obtaining
114  * such license, approval or letter.
115  *
116  *****************************************************************************/
117 
118 #define __EXSYSTEM_C__
119 
120 #include "acpi.h"
121 #include "acinterp.h"
122 
123 #define _COMPONENT          ACPI_EXECUTER
124         ACPI_MODULE_NAME    ("exsystem")
125 
126 
127 /*******************************************************************************
128  *
129  * FUNCTION:    AcpiExSystemWaitSemaphore
130  *
131  * PARAMETERS:  Semaphore       - Semaphore to wait on
132  *              Timeout         - Max time to wait
133  *
134  * RETURN:      Status
135  *
136  * DESCRIPTION: Implements a semaphore wait with a check to see if the
137  *              semaphore is available immediately.  If it is not, the
138  *              interpreter is released before waiting.
139  *
140  ******************************************************************************/
141 
142 ACPI_STATUS
143 AcpiExSystemWaitSemaphore (
144     ACPI_SEMAPHORE          Semaphore,
145     UINT16                  Timeout)
146 {
147     ACPI_STATUS             Status;
148 
149 
150     ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore);
151 
152 
153     Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT);
154     if (ACPI_SUCCESS (Status))
155     {
156         return_ACPI_STATUS (Status);
157     }
158 
159     if (Status == AE_TIME)
160     {
161         /* We must wait, so unlock the interpreter */
162 
163         AcpiExRelinquishInterpreter ();
164 
165         Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout);
166 
167         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
168             "*** Thread awake after blocking, %s\n",
169             AcpiFormatException (Status)));
170 
171         /* Reacquire the interpreter */
172 
173        AcpiExReacquireInterpreter ();
174     }
175 
176     return_ACPI_STATUS (Status);
177 }
178 
179 
180 /*******************************************************************************
181  *
182  * FUNCTION:    AcpiExSystemWaitMutex
183  *
184  * PARAMETERS:  Mutex           - Mutex to wait on
185  *              Timeout         - Max time to wait
186  *
187  * RETURN:      Status
188  *
189  * DESCRIPTION: Implements a mutex wait with a check to see if the
190  *              mutex is available immediately.  If it is not, the
191  *              interpreter is released before waiting.
192  *
193  ******************************************************************************/
194 
195 ACPI_STATUS
196 AcpiExSystemWaitMutex (
197     ACPI_MUTEX              Mutex,
198     UINT16                  Timeout)
199 {
200     ACPI_STATUS             Status;
201 
202 
203     ACPI_FUNCTION_TRACE (ExSystemWaitMutex);
204 
205 
206     Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT);
207     if (ACPI_SUCCESS (Status))
208     {
209         return_ACPI_STATUS (Status);
210     }
211 
212     if (Status == AE_TIME)
213     {
214         /* We must wait, so unlock the interpreter */
215 
216         AcpiExRelinquishInterpreter ();
217 
218         Status = AcpiOsAcquireMutex (Mutex, Timeout);
219 
220         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
221             "*** Thread awake after blocking, %s\n",
222             AcpiFormatException (Status)));
223 
224         /* Reacquire the interpreter */
225 
226         AcpiExReacquireInterpreter ();
227     }
228 
229     return_ACPI_STATUS (Status);
230 }
231 
232 
233 /*******************************************************************************
234  *
235  * FUNCTION:    AcpiExSystemDoStall
236  *
237  * PARAMETERS:  HowLong         - The amount of time to stall,
238  *                                in microseconds
239  *
240  * RETURN:      Status
241  *
242  * DESCRIPTION: Suspend running thread for specified amount of time.
243  *              Note: ACPI specification requires that Stall() does not
244  *              relinquish the processor, and delays longer than 100 usec
245  *              should use Sleep() instead.  We allow stalls up to 255 usec
246  *              for compatibility with other interpreters and existing BIOSs.
247  *
248  ******************************************************************************/
249 
250 ACPI_STATUS
251 AcpiExSystemDoStall (
252     UINT32                  HowLong)
253 {
254     ACPI_STATUS             Status = AE_OK;
255 
256 
257     ACPI_FUNCTION_ENTRY ();
258 
259 
260     if (HowLong > 255) /* 255 microseconds */
261     {
262         /*
263          * Longer than 255 usec, this is an error
264          *
265          * (ACPI specifies 100 usec as max, but this gives some slack in
266          * order to support existing BIOSs)
267          */
268         ACPI_ERROR ((AE_INFO, "Time parameter is too large (%d)",
269             HowLong));
270         Status = AE_AML_OPERAND_VALUE;
271     }
272     else
273     {
274         AcpiOsStall (HowLong);
275     }
276 
277     return (Status);
278 }
279 
280 
281 /*******************************************************************************
282  *
283  * FUNCTION:    AcpiExSystemDoSuspend
284  *
285  * PARAMETERS:  HowLong         - The amount of time to suspend,
286  *                                in milliseconds
287  *
288  * RETURN:      None
289  *
290  * DESCRIPTION: Suspend running thread for specified amount of time.
291  *
292  ******************************************************************************/
293 
294 ACPI_STATUS
295 AcpiExSystemDoSuspend (
296     ACPI_INTEGER            HowLong)
297 {
298     ACPI_FUNCTION_ENTRY ();
299 
300 
301     /* Since this thread will sleep, we must release the interpreter */
302 
303     AcpiExRelinquishInterpreter ();
304 
305     AcpiOsSleep (HowLong);
306 
307     /* And now we must get the interpreter again */
308 
309     AcpiExReacquireInterpreter ();
310     return (AE_OK);
311 }
312 
313 
314 /*******************************************************************************
315  *
316  * FUNCTION:    AcpiExSystemSignalEvent
317  *
318  * PARAMETERS:  ObjDesc         - The object descriptor for this op
319  *
320  * RETURN:      Status
321  *
322  * DESCRIPTION: Provides an access point to perform synchronization operations
323  *              within the AML.
324  *
325  ******************************************************************************/
326 
327 ACPI_STATUS
328 AcpiExSystemSignalEvent (
329     ACPI_OPERAND_OBJECT     *ObjDesc)
330 {
331     ACPI_STATUS             Status = AE_OK;
332 
333 
334     ACPI_FUNCTION_TRACE (ExSystemSignalEvent);
335 
336 
337     if (ObjDesc)
338     {
339         Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1);
340     }
341 
342     return_ACPI_STATUS (Status);
343 }
344 
345 
346 /*******************************************************************************
347  *
348  * FUNCTION:    AcpiExSystemWaitEvent
349  *
350  * PARAMETERS:  TimeDesc        - The 'time to delay' object descriptor
351  *              ObjDesc         - The object descriptor for this op
352  *
353  * RETURN:      Status
354  *
355  * DESCRIPTION: Provides an access point to perform synchronization operations
356  *              within the AML.  This operation is a request to wait for an
357  *              event.
358  *
359  ******************************************************************************/
360 
361 ACPI_STATUS
362 AcpiExSystemWaitEvent (
363     ACPI_OPERAND_OBJECT     *TimeDesc,
364     ACPI_OPERAND_OBJECT     *ObjDesc)
365 {
366     ACPI_STATUS             Status = AE_OK;
367 
368 
369     ACPI_FUNCTION_TRACE (ExSystemWaitEvent);
370 
371 
372     if (ObjDesc)
373     {
374         Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore,
375                     (UINT16) TimeDesc->Integer.Value);
376     }
377 
378     return_ACPI_STATUS (Status);
379 }
380 
381 
382 /*******************************************************************************
383  *
384  * FUNCTION:    AcpiExSystemResetEvent
385  *
386  * PARAMETERS:  ObjDesc         - The object descriptor for this op
387  *
388  * RETURN:      Status
389  *
390  * DESCRIPTION: Reset an event to a known state.
391  *
392  ******************************************************************************/
393 
394 ACPI_STATUS
395 AcpiExSystemResetEvent (
396     ACPI_OPERAND_OBJECT     *ObjDesc)
397 {
398     ACPI_STATUS             Status = AE_OK;
399     ACPI_SEMAPHORE          TempSemaphore;
400 
401 
402     ACPI_FUNCTION_ENTRY ();
403 
404 
405     /*
406      * We are going to simply delete the existing semaphore and
407      * create a new one!
408      */
409     Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore);
410     if (ACPI_SUCCESS (Status))
411     {
412         (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore);
413         ObjDesc->Event.OsSemaphore = TempSemaphore;
414     }
415 
416     return (Status);
417 }
418 
419