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