Home | History | Annotate | Line # | Download | only in hardware
hwtimer.c revision 1.1.1.2.8.2
      1  1.1.1.2.8.2  jruoho 
      2  1.1.1.2.8.2  jruoho /******************************************************************************
      3  1.1.1.2.8.2  jruoho  *
      4  1.1.1.2.8.2  jruoho  * Name: hwtimer.c - ACPI Power Management Timer Interface
      5  1.1.1.2.8.2  jruoho  *
      6  1.1.1.2.8.2  jruoho  *****************************************************************************/
      7  1.1.1.2.8.2  jruoho 
      8  1.1.1.2.8.2  jruoho /*
      9  1.1.1.2.8.2  jruoho  * Copyright (C) 2000 - 2011, Intel Corp.
     10  1.1.1.2.8.2  jruoho  * All rights reserved.
     11  1.1.1.2.8.2  jruoho  *
     12  1.1.1.2.8.2  jruoho  * Redistribution and use in source and binary forms, with or without
     13  1.1.1.2.8.2  jruoho  * modification, are permitted provided that the following conditions
     14  1.1.1.2.8.2  jruoho  * are met:
     15  1.1.1.2.8.2  jruoho  * 1. Redistributions of source code must retain the above copyright
     16  1.1.1.2.8.2  jruoho  *    notice, this list of conditions, and the following disclaimer,
     17  1.1.1.2.8.2  jruoho  *    without modification.
     18  1.1.1.2.8.2  jruoho  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
     19  1.1.1.2.8.2  jruoho  *    substantially similar to the "NO WARRANTY" disclaimer below
     20  1.1.1.2.8.2  jruoho  *    ("Disclaimer") and any redistribution must be conditioned upon
     21  1.1.1.2.8.2  jruoho  *    including a substantially similar Disclaimer requirement for further
     22  1.1.1.2.8.2  jruoho  *    binary redistribution.
     23  1.1.1.2.8.2  jruoho  * 3. Neither the names of the above-listed copyright holders nor the names
     24  1.1.1.2.8.2  jruoho  *    of any contributors may be used to endorse or promote products derived
     25  1.1.1.2.8.2  jruoho  *    from this software without specific prior written permission.
     26  1.1.1.2.8.2  jruoho  *
     27  1.1.1.2.8.2  jruoho  * Alternatively, this software may be distributed under the terms of the
     28  1.1.1.2.8.2  jruoho  * GNU General Public License ("GPL") version 2 as published by the Free
     29  1.1.1.2.8.2  jruoho  * Software Foundation.
     30  1.1.1.2.8.2  jruoho  *
     31  1.1.1.2.8.2  jruoho  * NO WARRANTY
     32  1.1.1.2.8.2  jruoho  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     33  1.1.1.2.8.2  jruoho  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     34  1.1.1.2.8.2  jruoho  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
     35  1.1.1.2.8.2  jruoho  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     36  1.1.1.2.8.2  jruoho  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     37  1.1.1.2.8.2  jruoho  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     38  1.1.1.2.8.2  jruoho  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     39  1.1.1.2.8.2  jruoho  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     40  1.1.1.2.8.2  jruoho  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
     41  1.1.1.2.8.2  jruoho  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     42  1.1.1.2.8.2  jruoho  * POSSIBILITY OF SUCH DAMAGES.
     43  1.1.1.2.8.2  jruoho  */
     44  1.1.1.2.8.2  jruoho 
     45  1.1.1.2.8.2  jruoho #include "acpi.h"
     46  1.1.1.2.8.2  jruoho #include "accommon.h"
     47  1.1.1.2.8.2  jruoho 
     48  1.1.1.2.8.2  jruoho #define _COMPONENT          ACPI_HARDWARE
     49  1.1.1.2.8.2  jruoho         ACPI_MODULE_NAME    ("hwtimer")
     50  1.1.1.2.8.2  jruoho 
     51  1.1.1.2.8.2  jruoho 
     52  1.1.1.2.8.2  jruoho /******************************************************************************
     53  1.1.1.2.8.2  jruoho  *
     54  1.1.1.2.8.2  jruoho  * FUNCTION:    AcpiGetTimerResolution
     55  1.1.1.2.8.2  jruoho  *
     56  1.1.1.2.8.2  jruoho  * PARAMETERS:  Resolution          - Where the resolution is returned
     57  1.1.1.2.8.2  jruoho  *
     58  1.1.1.2.8.2  jruoho  * RETURN:      Status and timer resolution
     59  1.1.1.2.8.2  jruoho  *
     60  1.1.1.2.8.2  jruoho  * DESCRIPTION: Obtains resolution of the ACPI PM Timer (24 or 32 bits).
     61  1.1.1.2.8.2  jruoho  *
     62  1.1.1.2.8.2  jruoho  ******************************************************************************/
     63  1.1.1.2.8.2  jruoho 
     64  1.1.1.2.8.2  jruoho ACPI_STATUS
     65  1.1.1.2.8.2  jruoho AcpiGetTimerResolution (
     66  1.1.1.2.8.2  jruoho     UINT32                  *Resolution)
     67  1.1.1.2.8.2  jruoho {
     68  1.1.1.2.8.2  jruoho     ACPI_FUNCTION_TRACE (AcpiGetTimerResolution);
     69  1.1.1.2.8.2  jruoho 
     70  1.1.1.2.8.2  jruoho 
     71  1.1.1.2.8.2  jruoho     if (!Resolution)
     72  1.1.1.2.8.2  jruoho     {
     73  1.1.1.2.8.2  jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
     74  1.1.1.2.8.2  jruoho     }
     75  1.1.1.2.8.2  jruoho 
     76  1.1.1.2.8.2  jruoho     if ((AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
     77  1.1.1.2.8.2  jruoho     {
     78  1.1.1.2.8.2  jruoho         *Resolution = 24;
     79  1.1.1.2.8.2  jruoho     }
     80  1.1.1.2.8.2  jruoho     else
     81  1.1.1.2.8.2  jruoho     {
     82  1.1.1.2.8.2  jruoho         *Resolution = 32;
     83  1.1.1.2.8.2  jruoho     }
     84  1.1.1.2.8.2  jruoho 
     85  1.1.1.2.8.2  jruoho     return_ACPI_STATUS (AE_OK);
     86  1.1.1.2.8.2  jruoho }
     87  1.1.1.2.8.2  jruoho 
     88  1.1.1.2.8.2  jruoho ACPI_EXPORT_SYMBOL (AcpiGetTimerResolution)
     89  1.1.1.2.8.2  jruoho 
     90  1.1.1.2.8.2  jruoho 
     91  1.1.1.2.8.2  jruoho /******************************************************************************
     92  1.1.1.2.8.2  jruoho  *
     93  1.1.1.2.8.2  jruoho  * FUNCTION:    AcpiGetTimer
     94  1.1.1.2.8.2  jruoho  *
     95  1.1.1.2.8.2  jruoho  * PARAMETERS:  Ticks               - Where the timer value is returned
     96  1.1.1.2.8.2  jruoho  *
     97  1.1.1.2.8.2  jruoho  * RETURN:      Status and current timer value (ticks)
     98  1.1.1.2.8.2  jruoho  *
     99  1.1.1.2.8.2  jruoho  * DESCRIPTION: Obtains current value of ACPI PM Timer (in ticks).
    100  1.1.1.2.8.2  jruoho  *
    101  1.1.1.2.8.2  jruoho  ******************************************************************************/
    102  1.1.1.2.8.2  jruoho 
    103  1.1.1.2.8.2  jruoho ACPI_STATUS
    104  1.1.1.2.8.2  jruoho AcpiGetTimer (
    105  1.1.1.2.8.2  jruoho     UINT32                  *Ticks)
    106  1.1.1.2.8.2  jruoho {
    107  1.1.1.2.8.2  jruoho     ACPI_STATUS             Status;
    108  1.1.1.2.8.2  jruoho 
    109  1.1.1.2.8.2  jruoho 
    110  1.1.1.2.8.2  jruoho     ACPI_FUNCTION_TRACE (AcpiGetTimer);
    111  1.1.1.2.8.2  jruoho 
    112  1.1.1.2.8.2  jruoho 
    113  1.1.1.2.8.2  jruoho     if (!Ticks)
    114  1.1.1.2.8.2  jruoho     {
    115  1.1.1.2.8.2  jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    116  1.1.1.2.8.2  jruoho     }
    117  1.1.1.2.8.2  jruoho 
    118  1.1.1.2.8.2  jruoho     Status = AcpiHwRead (Ticks, &AcpiGbl_FADT.XPmTimerBlock);
    119  1.1.1.2.8.2  jruoho 
    120  1.1.1.2.8.2  jruoho     return_ACPI_STATUS (Status);
    121  1.1.1.2.8.2  jruoho }
    122  1.1.1.2.8.2  jruoho 
    123  1.1.1.2.8.2  jruoho ACPI_EXPORT_SYMBOL (AcpiGetTimer)
    124  1.1.1.2.8.2  jruoho 
    125  1.1.1.2.8.2  jruoho 
    126  1.1.1.2.8.2  jruoho /******************************************************************************
    127  1.1.1.2.8.2  jruoho  *
    128  1.1.1.2.8.2  jruoho  * FUNCTION:    AcpiGetTimerDuration
    129  1.1.1.2.8.2  jruoho  *
    130  1.1.1.2.8.2  jruoho  * PARAMETERS:  StartTicks          - Starting timestamp
    131  1.1.1.2.8.2  jruoho  *              EndTicks            - End timestamp
    132  1.1.1.2.8.2  jruoho  *              TimeElapsed         - Where the elapsed time is returned
    133  1.1.1.2.8.2  jruoho  *
    134  1.1.1.2.8.2  jruoho  * RETURN:      Status and TimeElapsed
    135  1.1.1.2.8.2  jruoho  *
    136  1.1.1.2.8.2  jruoho  * DESCRIPTION: Computes the time elapsed (in microseconds) between two
    137  1.1.1.2.8.2  jruoho  *              PM Timer time stamps, taking into account the possibility of
    138  1.1.1.2.8.2  jruoho  *              rollovers, the timer resolution, and timer frequency.
    139  1.1.1.2.8.2  jruoho  *
    140  1.1.1.2.8.2  jruoho  *              The PM Timer's clock ticks at roughly 3.6 times per
    141  1.1.1.2.8.2  jruoho  *              _microsecond_, and its clock continues through Cx state
    142  1.1.1.2.8.2  jruoho  *              transitions (unlike many CPU timestamp counters) -- making it
    143  1.1.1.2.8.2  jruoho  *              a versatile and accurate timer.
    144  1.1.1.2.8.2  jruoho  *
    145  1.1.1.2.8.2  jruoho  *              Note that this function accommodates only a single timer
    146  1.1.1.2.8.2  jruoho  *              rollover.  Thus for 24-bit timers, this function should only
    147  1.1.1.2.8.2  jruoho  *              be used for calculating durations less than ~4.6 seconds
    148  1.1.1.2.8.2  jruoho  *              (~20 minutes for 32-bit timers) -- calculations below:
    149  1.1.1.2.8.2  jruoho  *
    150  1.1.1.2.8.2  jruoho  *              2**24 Ticks / 3,600,000 Ticks/Sec = 4.66 sec
    151  1.1.1.2.8.2  jruoho  *              2**32 Ticks / 3,600,000 Ticks/Sec = 1193 sec or 19.88 minutes
    152  1.1.1.2.8.2  jruoho  *
    153  1.1.1.2.8.2  jruoho  ******************************************************************************/
    154  1.1.1.2.8.2  jruoho 
    155  1.1.1.2.8.2  jruoho ACPI_STATUS
    156  1.1.1.2.8.2  jruoho AcpiGetTimerDuration (
    157  1.1.1.2.8.2  jruoho     UINT32                  StartTicks,
    158  1.1.1.2.8.2  jruoho     UINT32                  EndTicks,
    159  1.1.1.2.8.2  jruoho     UINT32                  *TimeElapsed)
    160  1.1.1.2.8.2  jruoho {
    161  1.1.1.2.8.2  jruoho     ACPI_STATUS             Status;
    162  1.1.1.2.8.2  jruoho     UINT32                  DeltaTicks;
    163  1.1.1.2.8.2  jruoho     UINT64                  Quotient;
    164  1.1.1.2.8.2  jruoho 
    165  1.1.1.2.8.2  jruoho 
    166  1.1.1.2.8.2  jruoho     ACPI_FUNCTION_TRACE (AcpiGetTimerDuration);
    167  1.1.1.2.8.2  jruoho 
    168  1.1.1.2.8.2  jruoho 
    169  1.1.1.2.8.2  jruoho     if (!TimeElapsed)
    170  1.1.1.2.8.2  jruoho     {
    171  1.1.1.2.8.2  jruoho         return_ACPI_STATUS (AE_BAD_PARAMETER);
    172  1.1.1.2.8.2  jruoho     }
    173  1.1.1.2.8.2  jruoho 
    174  1.1.1.2.8.2  jruoho     /*
    175  1.1.1.2.8.2  jruoho      * Compute Tick Delta:
    176  1.1.1.2.8.2  jruoho      * Handle (max one) timer rollovers on 24-bit versus 32-bit timers.
    177  1.1.1.2.8.2  jruoho      */
    178  1.1.1.2.8.2  jruoho     if (StartTicks < EndTicks)
    179  1.1.1.2.8.2  jruoho     {
    180  1.1.1.2.8.2  jruoho         DeltaTicks = EndTicks - StartTicks;
    181  1.1.1.2.8.2  jruoho     }
    182  1.1.1.2.8.2  jruoho     else if (StartTicks > EndTicks)
    183  1.1.1.2.8.2  jruoho     {
    184  1.1.1.2.8.2  jruoho         if ((AcpiGbl_FADT.Flags & ACPI_FADT_32BIT_TIMER) == 0)
    185  1.1.1.2.8.2  jruoho         {
    186  1.1.1.2.8.2  jruoho             /* 24-bit Timer */
    187  1.1.1.2.8.2  jruoho 
    188  1.1.1.2.8.2  jruoho             DeltaTicks = (((0x00FFFFFF - StartTicks) + EndTicks) & 0x00FFFFFF);
    189  1.1.1.2.8.2  jruoho         }
    190  1.1.1.2.8.2  jruoho         else
    191  1.1.1.2.8.2  jruoho         {
    192  1.1.1.2.8.2  jruoho             /* 32-bit Timer */
    193  1.1.1.2.8.2  jruoho 
    194  1.1.1.2.8.2  jruoho             DeltaTicks = (0xFFFFFFFF - StartTicks) + EndTicks;
    195  1.1.1.2.8.2  jruoho         }
    196  1.1.1.2.8.2  jruoho     }
    197  1.1.1.2.8.2  jruoho     else /* StartTicks == EndTicks */
    198  1.1.1.2.8.2  jruoho     {
    199  1.1.1.2.8.2  jruoho         *TimeElapsed = 0;
    200  1.1.1.2.8.2  jruoho         return_ACPI_STATUS (AE_OK);
    201  1.1.1.2.8.2  jruoho     }
    202  1.1.1.2.8.2  jruoho 
    203  1.1.1.2.8.2  jruoho     /*
    204  1.1.1.2.8.2  jruoho      * Compute Duration (Requires a 64-bit multiply and divide):
    205  1.1.1.2.8.2  jruoho      *
    206  1.1.1.2.8.2  jruoho      * TimeElapsed = (DeltaTicks * 1000000) / PM_TIMER_FREQUENCY;
    207  1.1.1.2.8.2  jruoho      */
    208  1.1.1.2.8.2  jruoho     Status = AcpiUtShortDivide (((UINT64) DeltaTicks) * 1000000,
    209  1.1.1.2.8.2  jruoho                 PM_TIMER_FREQUENCY, &Quotient, NULL);
    210  1.1.1.2.8.2  jruoho 
    211  1.1.1.2.8.2  jruoho     *TimeElapsed = (UINT32) Quotient;
    212  1.1.1.2.8.2  jruoho     return_ACPI_STATUS (Status);
    213  1.1.1.2.8.2  jruoho }
    214  1.1.1.2.8.2  jruoho 
    215  1.1.1.2.8.2  jruoho ACPI_EXPORT_SYMBOL (AcpiGetTimerDuration)
    216  1.1.1.2.8.2  jruoho 
    217