Merge from vendor branch LIBPCAP:
[dragonfly.git] / sys / contrib / dev / acpica-unix-20031203 / hardware / hwtimer.c
1
2 /******************************************************************************
3  *
4  * Name: hwtimer.c - ACPI Power Management Timer Interface
5  *              $Revision: 25 $
6  *
7  *****************************************************************************/
8
9 /******************************************************************************
10  *
11  * 1. Copyright Notice
12  *
13  * Some or all of this work - Copyright (c) 1999 - 2003, 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 #include "acpi.h"
119
120 #define _COMPONENT          ACPI_HARDWARE
121         ACPI_MODULE_NAME    ("hwtimer")
122
123
124 /******************************************************************************
125  *
126  * FUNCTION:    AcpiGetTimerResolution
127  *
128  * PARAMETERS:  none
129  *
130  * RETURN:      Number of bits of resolution in the PM Timer (24 or 32).
131  *
132  * DESCRIPTION: Obtains resolution of the ACPI PM Timer.
133  *
134  ******************************************************************************/
135
136 ACPI_STATUS
137 AcpiGetTimerResolution (
138     UINT32                  *Resolution)
139 {
140     ACPI_FUNCTION_TRACE ("AcpiGetTimerResolution");
141
142
143     if (!Resolution)
144     {
145         return_ACPI_STATUS (AE_BAD_PARAMETER);
146     }
147
148     if (0 == AcpiGbl_FADT->TmrValExt)
149     {
150         *Resolution = 24;
151     }
152     else
153     {
154         *Resolution = 32;
155     }
156
157     return_ACPI_STATUS (AE_OK);
158 }
159
160
161 /******************************************************************************
162  *
163  * FUNCTION:    AcpiGetTimer
164  *
165  * PARAMETERS:  none
166  *
167  * RETURN:      Current value of the ACPI PM Timer (in ticks).
168  *
169  * DESCRIPTION: Obtains current value of ACPI PM Timer.
170  *
171  ******************************************************************************/
172
173 ACPI_STATUS
174 AcpiGetTimer (
175     UINT32                  *Ticks)
176 {
177     ACPI_STATUS             Status;
178
179
180     ACPI_FUNCTION_TRACE ("AcpiGetTimer");
181
182
183     if (!Ticks)
184     {
185         return_ACPI_STATUS (AE_BAD_PARAMETER);
186     }
187
188     Status = AcpiHwLowLevelRead (32, Ticks, &AcpiGbl_FADT->XPmTmrBlk);
189
190     return_ACPI_STATUS (Status);
191 }
192
193
194 /******************************************************************************
195  *
196  * FUNCTION:    AcpiGetTimerDuration
197  *
198  * PARAMETERS:  StartTicks
199  *              EndTicks
200  *              TimeElapsed
201  *
202  * RETURN:      TimeElapsed
203  *
204  * DESCRIPTION: Computes the time elapsed (in microseconds) between two
205  *              PM Timer time stamps, taking into account the possibility of
206  *              rollovers, the timer resolution, and timer frequency.
207  *
208  *              The PM Timer's clock ticks at roughly 3.6 times per
209  *              _microsecond_, and its clock continues through Cx state
210  *              transitions (unlike many CPU timestamp counters) -- making it
211  *              a versatile and accurate timer.
212  *
213  *              Note that this function accommodates only a single timer
214  *              rollover.  Thus for 24-bit timers, this function should only
215  *              be used for calculating durations less than ~4.6 seconds
216  *              (~20 minutes for 32-bit timers) -- calculations below
217  *
218  *              2**24 Ticks / 3,600,000 Ticks/Sec = 4.66 sec
219  *              2**32 Ticks / 3,600,000 Ticks/Sec = 1193 sec or 19.88 minutes
220  *
221  ******************************************************************************/
222
223 ACPI_STATUS
224 AcpiGetTimerDuration (
225     UINT32                  StartTicks,
226     UINT32                  EndTicks,
227     UINT32                  *TimeElapsed)
228 {
229     UINT32                  DeltaTicks = 0;
230     UINT64_OVERLAY          NormalizedTicks;
231     ACPI_STATUS             Status;
232     ACPI_INTEGER            OutQuotient;
233
234
235     ACPI_FUNCTION_TRACE ("AcpiGetTimerDuration");
236
237
238     if (!TimeElapsed)
239     {
240         return_ACPI_STATUS (AE_BAD_PARAMETER);
241     }
242
243     /*
244      * Compute Tick Delta:
245      * -------------------
246      * Handle (max one) timer rollovers on 24- versus 32-bit timers.
247      */
248     if (StartTicks < EndTicks)
249     {
250         DeltaTicks = EndTicks - StartTicks;
251     }
252     else if (StartTicks > EndTicks)
253     {
254         if (0 == AcpiGbl_FADT->TmrValExt)
255         {
256             /* 24-bit Timer */
257
258             DeltaTicks = (((0x00FFFFFF - StartTicks) + EndTicks) & 0x00FFFFFF);
259         }
260         else
261         {
262             /* 32-bit Timer */
263
264             DeltaTicks = (0xFFFFFFFF - StartTicks) + EndTicks;
265         }
266     }
267     else
268     {
269         *TimeElapsed = 0;
270         return_ACPI_STATUS (AE_OK);
271     }
272
273     /*
274      * Compute Duration:
275      * -----------------
276      *
277      * Requires a 64-bit divide:
278      *
279      * TimeElapsed = (DeltaTicks * 1000000) / PM_TIMER_FREQUENCY;
280      */
281     NormalizedTicks.Full = ((UINT64) DeltaTicks) * 1000000;
282
283     Status = AcpiUtShortDivide (&NormalizedTicks.Full, PM_TIMER_FREQUENCY,
284                                     &OutQuotient, NULL);
285
286     *TimeElapsed = (UINT32) OutQuotient;
287     return_ACPI_STATUS (Status);
288 }
289
290