xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/executer/exsystem.c (revision 986e4abce4efeccd9418eb8cdc7a710487f093b9)
1 /******************************************************************************
2  *
3  * Module Name: exsystem - Interface to OS services
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2013, 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 #define __EXSYSTEM_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 #include "acinterp.h"
121 
122 #define _COMPONENT          ACPI_EXECUTER
123         ACPI_MODULE_NAME    ("exsystem")
124 
125 
126 /*******************************************************************************
127  *
128  * FUNCTION:    AcpiExSystemWaitSemaphore
129  *
130  * PARAMETERS:  Semaphore       - Semaphore to wait on
131  *              Timeout         - Max time to wait
132  *
133  * RETURN:      Status
134  *
135  * DESCRIPTION: Implements a semaphore wait with a check to see if the
136  *              semaphore is available immediately. If it is not, the
137  *              interpreter is released before waiting.
138  *
139  ******************************************************************************/
140 
141 ACPI_STATUS
142 AcpiExSystemWaitSemaphore (
143     ACPI_SEMAPHORE          Semaphore,
144     UINT16                  Timeout)
145 {
146     ACPI_STATUS             Status;
147 
148 
149     ACPI_FUNCTION_TRACE (ExSystemWaitSemaphore);
150 
151 
152     Status = AcpiOsWaitSemaphore (Semaphore, 1, ACPI_DO_NOT_WAIT);
153     if (ACPI_SUCCESS (Status))
154     {
155         return_ACPI_STATUS (Status);
156     }
157 
158     if (Status == AE_TIME)
159     {
160         /* We must wait, so unlock the interpreter */
161 
162         AcpiExRelinquishInterpreter ();
163 
164         Status = AcpiOsWaitSemaphore (Semaphore, 1, Timeout);
165 
166         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
167             "*** Thread awake after blocking, %s\n",
168             AcpiFormatException (Status)));
169 
170         /* Reacquire the interpreter */
171 
172        AcpiExReacquireInterpreter ();
173     }
174 
175     return_ACPI_STATUS (Status);
176 }
177 
178 
179 /*******************************************************************************
180  *
181  * FUNCTION:    AcpiExSystemWaitMutex
182  *
183  * PARAMETERS:  Mutex           - Mutex to wait on
184  *              Timeout         - Max time to wait
185  *
186  * RETURN:      Status
187  *
188  * DESCRIPTION: Implements a mutex wait with a check to see if the
189  *              mutex is available immediately. If it is not, the
190  *              interpreter is released before waiting.
191  *
192  ******************************************************************************/
193 
194 ACPI_STATUS
195 AcpiExSystemWaitMutex (
196     ACPI_MUTEX              Mutex,
197     UINT16                  Timeout)
198 {
199     ACPI_STATUS             Status;
200 
201 
202     ACPI_FUNCTION_TRACE (ExSystemWaitMutex);
203 
204 
205     Status = AcpiOsAcquireMutex (Mutex, ACPI_DO_NOT_WAIT);
206     if (ACPI_SUCCESS (Status))
207     {
208         return_ACPI_STATUS (Status);
209     }
210 
211     if (Status == AE_TIME)
212     {
213         /* We must wait, so unlock the interpreter */
214 
215         AcpiExRelinquishInterpreter ();
216 
217         Status = AcpiOsAcquireMutex (Mutex, Timeout);
218 
219         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
220             "*** Thread awake after blocking, %s\n",
221             AcpiFormatException (Status)));
222 
223         /* Reacquire the interpreter */
224 
225         AcpiExReacquireInterpreter ();
226     }
227 
228     return_ACPI_STATUS (Status);
229 }
230 
231 
232 /*******************************************************************************
233  *
234  * FUNCTION:    AcpiExSystemDoStall
235  *
236  * PARAMETERS:  HowLong         - The amount of time to stall,
237  *                                in microseconds
238  *
239  * RETURN:      Status
240  *
241  * DESCRIPTION: Suspend running thread for specified amount of time.
242  *              Note: ACPI specification requires that Stall() does not
243  *              relinquish the processor, and delays longer than 100 usec
244  *              should use Sleep() instead. We allow stalls up to 255 usec
245  *              for compatibility with other interpreters and existing BIOSs.
246  *
247  ******************************************************************************/
248 
249 ACPI_STATUS
250 AcpiExSystemDoStall (
251     UINT32                  HowLong)
252 {
253     ACPI_STATUS             Status = AE_OK;
254 
255 
256     ACPI_FUNCTION_ENTRY ();
257 
258 
259     if (HowLong > 255) /* 255 microseconds */
260     {
261         /*
262          * Longer than 255 usec, this is an error
263          *
264          * (ACPI specifies 100 usec as max, but this gives some slack in
265          * order to support existing BIOSs)
266          */
267         ACPI_ERROR ((AE_INFO, "Time parameter is too large (%u)",
268             HowLong));
269         Status = AE_AML_OPERAND_VALUE;
270     }
271     else
272     {
273         AcpiOsStall (HowLong);
274     }
275 
276     return (Status);
277 }
278 
279 
280 /*******************************************************************************
281  *
282  * FUNCTION:    AcpiExSystemDoSleep
283  *
284  * PARAMETERS:  HowLong         - The amount of time to sleep,
285  *                                in milliseconds
286  *
287  * RETURN:      None
288  *
289  * DESCRIPTION: Sleep the running thread for specified amount of time.
290  *
291  ******************************************************************************/
292 
293 ACPI_STATUS
294 AcpiExSystemDoSleep (
295     UINT64                  HowLong)
296 {
297     ACPI_FUNCTION_ENTRY ();
298 
299 
300     /* Since this thread will sleep, we must release the interpreter */
301 
302     AcpiExRelinquishInterpreter ();
303 
304     /*
305      * For compatibility with other ACPI implementations and to prevent
306      * accidental deep sleeps, limit the sleep time to something reasonable.
307      */
308     if (HowLong > ACPI_MAX_SLEEP)
309     {
310         HowLong = ACPI_MAX_SLEEP;
311     }
312 
313     AcpiOsSleep (HowLong);
314 
315     /* And now we must get the interpreter again */
316 
317     AcpiExReacquireInterpreter ();
318     return (AE_OK);
319 }
320 
321 
322 /*******************************************************************************
323  *
324  * FUNCTION:    AcpiExSystemSignalEvent
325  *
326  * PARAMETERS:  ObjDesc         - The object descriptor for this op
327  *
328  * RETURN:      Status
329  *
330  * DESCRIPTION: Provides an access point to perform synchronization operations
331  *              within the AML.
332  *
333  ******************************************************************************/
334 
335 ACPI_STATUS
336 AcpiExSystemSignalEvent (
337     ACPI_OPERAND_OBJECT     *ObjDesc)
338 {
339     ACPI_STATUS             Status = AE_OK;
340 
341 
342     ACPI_FUNCTION_TRACE (ExSystemSignalEvent);
343 
344 
345     if (ObjDesc)
346     {
347         Status = AcpiOsSignalSemaphore (ObjDesc->Event.OsSemaphore, 1);
348     }
349 
350     return_ACPI_STATUS (Status);
351 }
352 
353 
354 /*******************************************************************************
355  *
356  * FUNCTION:    AcpiExSystemWaitEvent
357  *
358  * PARAMETERS:  TimeDesc        - The 'time to delay' object descriptor
359  *              ObjDesc         - The object descriptor for this op
360  *
361  * RETURN:      Status
362  *
363  * DESCRIPTION: Provides an access point to perform synchronization operations
364  *              within the AML. This operation is a request to wait for an
365  *              event.
366  *
367  ******************************************************************************/
368 
369 ACPI_STATUS
370 AcpiExSystemWaitEvent (
371     ACPI_OPERAND_OBJECT     *TimeDesc,
372     ACPI_OPERAND_OBJECT     *ObjDesc)
373 {
374     ACPI_STATUS             Status = AE_OK;
375 
376 
377     ACPI_FUNCTION_TRACE (ExSystemWaitEvent);
378 
379 
380     if (ObjDesc)
381     {
382         Status = AcpiExSystemWaitSemaphore (ObjDesc->Event.OsSemaphore,
383                     (UINT16) TimeDesc->Integer.Value);
384     }
385 
386     return_ACPI_STATUS (Status);
387 }
388 
389 
390 /*******************************************************************************
391  *
392  * FUNCTION:    AcpiExSystemResetEvent
393  *
394  * PARAMETERS:  ObjDesc         - The object descriptor for this op
395  *
396  * RETURN:      Status
397  *
398  * DESCRIPTION: Reset an event to a known state.
399  *
400  ******************************************************************************/
401 
402 ACPI_STATUS
403 AcpiExSystemResetEvent (
404     ACPI_OPERAND_OBJECT     *ObjDesc)
405 {
406     ACPI_STATUS             Status = AE_OK;
407     ACPI_SEMAPHORE          TempSemaphore;
408 
409 
410     ACPI_FUNCTION_ENTRY ();
411 
412 
413     /*
414      * We are going to simply delete the existing semaphore and
415      * create a new one!
416      */
417     Status = AcpiOsCreateSemaphore (ACPI_NO_UNIT_LIMIT, 0, &TempSemaphore);
418     if (ACPI_SUCCESS (Status))
419     {
420         (void) AcpiOsDeleteSemaphore (ObjDesc->Event.OsSemaphore);
421         ObjDesc->Event.OsSemaphore = TempSemaphore;
422     }
423 
424     return (Status);
425 }
426