drivers/acpi/hardware/hwtimer.c

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