Back to home page

Quest Cross Reference

 
 

    


Warning, cross-references for /kernel/drivers/acpica/hwtimer.c need to be fixed.

0001 
0002 /******************************************************************************
0003  *
0004  * Name: hwtimer.c - ACPI Power Management Timer Interface
0005  *
0006  *****************************************************************************/
0007 
0008 /******************************************************************************
0009  *
0010  * 1. Copyright Notice
0011  *
0012  * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
0013  * All rights reserved.
0014  *
0015  * 2. License
0016  *
0017  * 2.1. This is your license from Intel Corp. under its intellectual property
0018  * rights.  You may have additional license terms from the party that provided
0019  * you this software, covering your right to use that party's intellectual
0020  * property rights.
0021  *
0022  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0023  * copy of the source code appearing in this file ("Covered Code") an
0024  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0025  * base code distributed originally by Intel ("Original Intel Code") to copy,
0026  * make derivatives, distribute, use and display any portion of the Covered
0027  * Code in any form, with the right to sublicense such rights; and
0028  *
0029  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0030  * license (with the right to sublicense), under only those claims of Intel
0031  * patents that are infringed by the Original Intel Code, to make, use, sell,
0032  * offer to sell, and import the Covered Code and derivative works thereof
0033  * solely to the minimum extent necessary to exercise the above copyright
0034  * license, and in no event shall the patent license extend to any additions
0035  * to or modifications of the Original Intel Code.  No other license or right
0036  * is granted directly or by implication, estoppel or otherwise;
0037  *
0038  * The above copyright and patent license is granted only if the following
0039  * conditions are met:
0040  *
0041  * 3. Conditions
0042  *
0043  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0044  * Redistribution of source code of any substantial portion of the Covered
0045  * Code or modification with rights to further distribute source must include
0046  * the above Copyright Notice, the above License, this list of Conditions,
0047  * and the following Disclaimer and Export Compliance provision.  In addition,
0048  * Licensee must cause all Covered Code to which Licensee contributes to
0049  * contain a file documenting the changes Licensee made to create that Covered
0050  * Code and the date of any change.  Licensee must include in that file the
0051  * documentation of any changes made by any predecessor Licensee.  Licensee
0052  * must include a prominent statement that the modification is derived,
0053  * directly or indirectly, from Original Intel Code.
0054  *
0055  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0056  * Redistribution of source code of any substantial portion of the Covered
0057  * Code or modification without rights to further distribute source must
0058  * include the following Disclaimer and Export Compliance provision in the
0059  * documentation and/or other materials provided with distribution.  In
0060  * addition, Licensee may not authorize further sublicense of source of any
0061  * portion of the Covered Code, and must include terms to the effect that the
0062  * license from Licensee to its licensee is limited to the intellectual
0063  * property embodied in the software Licensee provides to its licensee, and
0064  * not to intellectual property embodied in modifications its licensee may
0065  * make.
0066  *
0067  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0068  * substantial portion of the Covered Code or modification must reproduce the
0069  * above Copyright Notice, and the following Disclaimer and Export Compliance
0070  * provision in the documentation and/or other materials provided with the
0071  * distribution.
0072  *
0073  * 3.4. Intel retains all right, title, and interest in and to the Original
0074  * Intel Code.
0075  *
0076  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0077  * Intel shall be used in advertising or otherwise to promote the sale, use or
0078  * other dealings in products derived from or relating to the Covered Code
0079  * without prior written authorization from Intel.
0080  *
0081  * 4. Disclaimer and Export Compliance
0082  *
0083  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0084  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0085  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
0086  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
0087  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
0088  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0089  * PARTICULAR PURPOSE.
0090  *
0091  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0092  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0093  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0094  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0095  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0096  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
0097  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0098  * LIMITED REMEDY.
0099  *
0100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0101  * software or system incorporating such software without first obtaining any
0102  * required license or other approval from the U. S. Department of Commerce or
0103  * any other agency or department of the United States Government.  In the
0104  * event Licensee exports any such software from the United States or
0105  * re-exports any such software from a foreign destination, Licensee shall
0106  * ensure that the distribution and export/re-export of the software is in
0107  * compliance with all laws, regulations, orders, or other restrictions of the
0108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0109  * any of its subsidiaries will export/re-export any technical data, process,
0110  * software, or service, directly or indirectly, to any country for which the
0111  * United States government or any agency thereof requires an export license,
0112  * other governmental approval, or letter of assurance, without first obtaining
0113  * such license, approval or letter.
0114  *
0115  *****************************************************************************/
0116 
0117 #include "acpi.h"
0118 #include "accommon.h"
0119 
0120 #define _COMPONENT          ACPI_HARDWARE
0121         ACPI_MODULE_NAME    ("hwtimer")
0122 
0123 
0124 /******************************************************************************
0125  *
0126  * FUNCTION:    AcpiGetTimerResolution
0127  *
0128  * PARAMETERS:  Resolution          - Where the resolution is returned
0129  *
0130  * RETURN:      Status and timer resolution
0131  *
0132  * DESCRIPTION: Obtains resolution of the ACPI PM Timer (24 or 32 bits).
0133  *
0134  ******************************************************************************/
0135 
0136 ACPI_STATUS
0137 AcpiGetTimerResolution (
0138     UINT32                  *Resolution)
0139 {
0140     ACPI_FUNCTION_TRACE (AcpiGetTimerResolution);
0141 
0142 
0143     if (!Resolution)
0144     {
0145         return_ACPI_STATUS (AE_BAD_PARAMETER);
0146     }
0147 
0148     if ((AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
0149     {
0150         *Resolution = 24;
0151     }
0152     else
0153     {
0154         *Resolution = 32;
0155     }
0156 
0157     return_ACPI_STATUS (AE_OK);
0158 }
0159 
0160 ACPI_EXPORT_SYMBOL (AcpiGetTimerResolution)
0161 
0162 
0163 /******************************************************************************
0164  *
0165  * FUNCTION:    AcpiGetTimer
0166  *
0167  * PARAMETERS:  Ticks               - Where the timer value is returned
0168  *
0169  * RETURN:      Status and current timer value (ticks)
0170  *
0171  * DESCRIPTION: Obtains current value of ACPI PM Timer (in ticks).
0172  *
0173  ******************************************************************************/
0174 
0175 ACPI_STATUS
0176 AcpiGetTimer (
0177     UINT32                  *Ticks)
0178 {
0179     ACPI_STATUS             Status;
0180 
0181 
0182     ACPI_FUNCTION_TRACE (AcpiGetTimer);
0183 
0184 
0185     if (!Ticks)
0186     {
0187         return_ACPI_STATUS (AE_BAD_PARAMETER);
0188     }
0189 
0190     Status = AcpiHwRead (Ticks, &AcpiGbl_FADT.XPmTimerBlock);
0191 
0192     return_ACPI_STATUS (Status);
0193 }
0194 
0195 ACPI_EXPORT_SYMBOL (AcpiGetTimer)
0196 
0197 
0198 /******************************************************************************
0199  *
0200  * FUNCTION:    AcpiGetTimerDuration
0201  *
0202  * PARAMETERS:  StartTicks          - Starting timestamp
0203  *              EndTicks            - End timestamp
0204  *              TimeElapsed         - Where the elapsed time is returned
0205  *
0206  * RETURN:      Status and TimeElapsed
0207  *
0208  * DESCRIPTION: Computes the time elapsed (in microseconds) between two
0209  *              PM Timer time stamps, taking into account the possibility of
0210  *              rollovers, the timer resolution, and timer frequency.
0211  *
0212  *              The PM Timer's clock ticks at roughly 3.6 times per
0213  *              _microsecond_, and its clock continues through Cx state
0214  *              transitions (unlike many CPU timestamp counters) -- making it
0215  *              a versatile and accurate timer.
0216  *
0217  *              Note that this function accommodates only a single timer
0218  *              rollover.  Thus for 24-bit timers, this function should only
0219  *              be used for calculating durations less than ~4.6 seconds
0220  *              (~20 minutes for 32-bit timers) -- calculations below:
0221  *
0222  *              2**24 Ticks / 3,600,000 Ticks/Sec = 4.66 sec
0223  *              2**32 Ticks / 3,600,000 Ticks/Sec = 1193 sec or 19.88 minutes
0224  *
0225  ******************************************************************************/
0226 
0227 ACPI_STATUS
0228 AcpiGetTimerDuration (
0229     UINT32                  StartTicks,
0230     UINT32                  EndTicks,
0231     UINT32                  *TimeElapsed)
0232 {
0233     ACPI_STATUS             Status;
0234     UINT32                  DeltaTicks;
0235     ACPI_INTEGER            Quotient;
0236 
0237 
0238     ACPI_FUNCTION_TRACE (AcpiGetTimerDuration);
0239 
0240 
0241     if (!TimeElapsed)
0242     {
0243         return_ACPI_STATUS (AE_BAD_PARAMETER);
0244     }
0245 
0246     /*
0247      * Compute Tick Delta:
0248      * Handle (max one) timer rollovers on 24-bit versus 32-bit timers.
0249      */
0250     if (StartTicks < EndTicks)
0251     {
0252         DeltaTicks = EndTicks - StartTicks;
0253     }
0254     else if (StartTicks > EndTicks)
0255     {
0256         if ((AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
0257         {
0258             /* 24-bit Timer */
0259 
0260             DeltaTicks = (((0x00FFFFFF - StartTicks) + EndTicks) & 0x00FFFFFF);
0261         }
0262         else
0263         {
0264             /* 32-bit Timer */
0265 
0266             DeltaTicks = (0xFFFFFFFF - StartTicks) + EndTicks;
0267         }
0268     }
0269     else /* StartTicks == EndTicks */
0270     {
0271         *TimeElapsed = 0;
0272         return_ACPI_STATUS (AE_OK);
0273     }
0274 
0275     /*
0276      * Compute Duration (Requires a 64-bit multiply and divide):
0277      *
0278      * TimeElapsed = (DeltaTicks * 1000000) / PM_TIMER_FREQUENCY;
0279      */
0280     Status = AcpiUtShortDivide (((UINT64) DeltaTicks) * 1000000,
0281                 PM_TIMER_FREQUENCY, &Quotient, NULL);
0282 
0283     *TimeElapsed = (UINT32) Quotient;
0284     return_ACPI_STATUS (Status);
0285 }
0286 
0287 ACPI_EXPORT_SYMBOL (AcpiGetTimerDuration)
0288