hwtimer.c revision 114237
171867Smsmith 271867Smsmith/****************************************************************************** 371867Smsmith * 471867Smsmith * Name: hwtimer.c - ACPI Power Management Timer Interface 5114237Snjl * $Revision: 24 $ 671867Smsmith * 771867Smsmith *****************************************************************************/ 871867Smsmith 971867Smsmith/****************************************************************************** 1071867Smsmith * 1171867Smsmith * 1. Copyright Notice 1271867Smsmith * 13114237Snjl * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 1471867Smsmith * All rights reserved. 1571867Smsmith * 1671867Smsmith * 2. License 1771867Smsmith * 1871867Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1971867Smsmith * rights. You may have additional license terms from the party that provided 2071867Smsmith * you this software, covering your right to use that party's intellectual 2171867Smsmith * property rights. 2271867Smsmith * 2371867Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2471867Smsmith * copy of the source code appearing in this file ("Covered Code") an 2571867Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2671867Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2771867Smsmith * make derivatives, distribute, use and display any portion of the Covered 2871867Smsmith * Code in any form, with the right to sublicense such rights; and 2971867Smsmith * 3071867Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3171867Smsmith * license (with the right to sublicense), under only those claims of Intel 3271867Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3371867Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3471867Smsmith * solely to the minimum extent necessary to exercise the above copyright 3571867Smsmith * license, and in no event shall the patent license extend to any additions 3671867Smsmith * to or modifications of the Original Intel Code. No other license or right 3771867Smsmith * is granted directly or by implication, estoppel or otherwise; 3871867Smsmith * 3971867Smsmith * The above copyright and patent license is granted only if the following 4071867Smsmith * conditions are met: 4171867Smsmith * 4271867Smsmith * 3. Conditions 4371867Smsmith * 4471867Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4571867Smsmith * Redistribution of source code of any substantial portion of the Covered 4671867Smsmith * Code or modification with rights to further distribute source must include 4771867Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4871867Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4971867Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 5071867Smsmith * contain a file documenting the changes Licensee made to create that Covered 5171867Smsmith * Code and the date of any change. Licensee must include in that file the 5271867Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5371867Smsmith * must include a prominent statement that the modification is derived, 5471867Smsmith * directly or indirectly, from Original Intel Code. 5571867Smsmith * 5671867Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5771867Smsmith * Redistribution of source code of any substantial portion of the Covered 5871867Smsmith * Code or modification without rights to further distribute source must 5971867Smsmith * include the following Disclaimer and Export Compliance provision in the 6071867Smsmith * documentation and/or other materials provided with distribution. In 6171867Smsmith * addition, Licensee may not authorize further sublicense of source of any 6271867Smsmith * portion of the Covered Code, and must include terms to the effect that the 6371867Smsmith * license from Licensee to its licensee is limited to the intellectual 6471867Smsmith * property embodied in the software Licensee provides to its licensee, and 6571867Smsmith * not to intellectual property embodied in modifications its licensee may 6671867Smsmith * make. 6771867Smsmith * 6871867Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6971867Smsmith * substantial portion of the Covered Code or modification must reproduce the 7071867Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7171867Smsmith * provision in the documentation and/or other materials provided with the 7271867Smsmith * distribution. 7371867Smsmith * 7471867Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7571867Smsmith * Intel Code. 7671867Smsmith * 7771867Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7871867Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7971867Smsmith * other dealings in products derived from or relating to the Covered Code 8071867Smsmith * without prior written authorization from Intel. 8171867Smsmith * 8271867Smsmith * 4. Disclaimer and Export Compliance 8371867Smsmith * 8471867Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8571867Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8671867Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8771867Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8871867Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8971867Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 9071867Smsmith * PARTICULAR PURPOSE. 9171867Smsmith * 9271867Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9371867Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9471867Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9571867Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9671867Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9771867Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9871867Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9971867Smsmith * LIMITED REMEDY. 10071867Smsmith * 10171867Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10271867Smsmith * software or system incorporating such software without first obtaining any 10371867Smsmith * required license or other approval from the U. S. Department of Commerce or 10471867Smsmith * any other agency or department of the United States Government. In the 10571867Smsmith * event Licensee exports any such software from the United States or 10671867Smsmith * re-exports any such software from a foreign destination, Licensee shall 10771867Smsmith * ensure that the distribution and export/re-export of the software is in 10871867Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10971867Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 11071867Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11171867Smsmith * software, or service, directly or indirectly, to any country for which the 11271867Smsmith * United States government or any agency thereof requires an export license, 11371867Smsmith * other governmental approval, or letter of assurance, without first obtaining 11471867Smsmith * such license, approval or letter. 11571867Smsmith * 11671867Smsmith *****************************************************************************/ 11771867Smsmith 11871867Smsmith#include "acpi.h" 11971867Smsmith 12077424Smsmith#define _COMPONENT ACPI_HARDWARE 12191116Smsmith ACPI_MODULE_NAME ("hwtimer") 12271867Smsmith 12371867Smsmith 12471867Smsmith/****************************************************************************** 12571867Smsmith * 12671867Smsmith * FUNCTION: AcpiGetTimerResolution 12771867Smsmith * 12871867Smsmith * PARAMETERS: none 12971867Smsmith * 13071867Smsmith * RETURN: Number of bits of resolution in the PM Timer (24 or 32). 13171867Smsmith * 13271867Smsmith * DESCRIPTION: Obtains resolution of the ACPI PM Timer. 13371867Smsmith * 13471867Smsmith ******************************************************************************/ 13571867Smsmith 13671867SmsmithACPI_STATUS 13771867SmsmithAcpiGetTimerResolution ( 13871867Smsmith UINT32 *Resolution) 13971867Smsmith{ 14091116Smsmith ACPI_FUNCTION_TRACE ("AcpiGetTimerResolution"); 14171867Smsmith 14277424Smsmith 14371867Smsmith if (!Resolution) 14471867Smsmith { 14571867Smsmith return_ACPI_STATUS (AE_BAD_PARAMETER); 14671867Smsmith } 14771867Smsmith 14871867Smsmith if (0 == AcpiGbl_FADT->TmrValExt) 14971867Smsmith { 15071867Smsmith *Resolution = 24; 15171867Smsmith } 15271867Smsmith else 15371867Smsmith { 15471867Smsmith *Resolution = 32; 15571867Smsmith } 15671867Smsmith 15771867Smsmith return_ACPI_STATUS (AE_OK); 15871867Smsmith} 15971867Smsmith 16071867Smsmith 16171867Smsmith/****************************************************************************** 16271867Smsmith * 16371867Smsmith * FUNCTION: AcpiGetTimer 16471867Smsmith * 16571867Smsmith * PARAMETERS: none 16671867Smsmith * 16771867Smsmith * RETURN: Current value of the ACPI PM Timer (in ticks). 16871867Smsmith * 16971867Smsmith * DESCRIPTION: Obtains current value of ACPI PM Timer. 17071867Smsmith * 17171867Smsmith ******************************************************************************/ 17271867Smsmith 17371867SmsmithACPI_STATUS 17471867SmsmithAcpiGetTimer ( 17571867Smsmith UINT32 *Ticks) 17671867Smsmith{ 17799679Siwasaki ACPI_STATUS Status; 17899679Siwasaki 17999679Siwasaki 18091116Smsmith ACPI_FUNCTION_TRACE ("AcpiGetTimer"); 18171867Smsmith 18283174Smsmith 18371867Smsmith if (!Ticks) 18471867Smsmith { 18571867Smsmith return_ACPI_STATUS (AE_BAD_PARAMETER); 18671867Smsmith } 18771867Smsmith 18899679Siwasaki Status = AcpiHwLowLevelRead (32, Ticks, &AcpiGbl_FADT->XPmTmrBlk, 0); 18971867Smsmith 19099679Siwasaki return_ACPI_STATUS (Status); 19171867Smsmith} 19271867Smsmith 19371867Smsmith 19471867Smsmith/****************************************************************************** 19571867Smsmith * 19671867Smsmith * FUNCTION: AcpiGetTimerDuration 19771867Smsmith * 19871867Smsmith * PARAMETERS: StartTicks 19971867Smsmith * EndTicks 20071867Smsmith * TimeElapsed 20171867Smsmith * 20277424Smsmith * RETURN: TimeElapsed 20371867Smsmith * 20471867Smsmith * DESCRIPTION: Computes the time elapsed (in microseconds) between two 20571867Smsmith * PM Timer time stamps, taking into account the possibility of 20677424Smsmith * rollovers, the timer resolution, and timer frequency. 20777424Smsmith * 20877424Smsmith * The PM Timer's clock ticks at roughly 3.6 times per 20971867Smsmith * _microsecond_, and its clock continues through Cx state 21071867Smsmith * transitions (unlike many CPU timestamp counters) -- making it 21171867Smsmith * a versatile and accurate timer. 21271867Smsmith * 213114237Snjl * Note that this function accommodates only a single timer 21471867Smsmith * rollover. Thus for 24-bit timers, this function should only 21577424Smsmith * be used for calculating durations less than ~4.6 seconds 216114237Snjl * (~20 minutes for 32-bit timers) -- calculations below 21771867Smsmith * 218114237Snjl * 2**24 Ticks / 3,600,000 Ticks/Sec = 4.66 sec 219114237Snjl * 2**32 Ticks / 3,600,000 Ticks/Sec = 1193 sec or 19.88 minutes 220114237Snjl * 22171867Smsmith ******************************************************************************/ 22271867Smsmith 22371867SmsmithACPI_STATUS 22471867SmsmithAcpiGetTimerDuration ( 22571867Smsmith UINT32 StartTicks, 22671867Smsmith UINT32 EndTicks, 22771867Smsmith UINT32 *TimeElapsed) 22871867Smsmith{ 22971867Smsmith UINT32 DeltaTicks = 0; 23091116Smsmith UINT64_OVERLAY NormalizedTicks; 23191116Smsmith ACPI_STATUS Status; 23291116Smsmith ACPI_INTEGER OutQuotient; 23371867Smsmith 23478986Smsmith 23591116Smsmith ACPI_FUNCTION_TRACE ("AcpiGetTimerDuration"); 23671867Smsmith 23780062Smsmith 23877424Smsmith if (!TimeElapsed) 23971867Smsmith { 24071867Smsmith return_ACPI_STATUS (AE_BAD_PARAMETER); 24171867Smsmith } 24271867Smsmith 24377424Smsmith /* 24471867Smsmith * Compute Tick Delta: 24571867Smsmith * ------------------- 24673561Smsmith * Handle (max one) timer rollovers on 24- versus 32-bit timers. 24771867Smsmith */ 24871867Smsmith if (StartTicks < EndTicks) 24971867Smsmith { 25071867Smsmith DeltaTicks = EndTicks - StartTicks; 25171867Smsmith } 25277424Smsmith else if (StartTicks > EndTicks) 25371867Smsmith { 25471867Smsmith if (0 == AcpiGbl_FADT->TmrValExt) 25571867Smsmith { 25691116Smsmith /* 24-bit Timer */ 25791116Smsmith 25873561Smsmith DeltaTicks = (((0x00FFFFFF - StartTicks) + EndTicks) & 0x00FFFFFF); 25971867Smsmith } 26077424Smsmith else 26171867Smsmith { 26291116Smsmith /* 32-bit Timer */ 26391116Smsmith 26471867Smsmith DeltaTicks = (0xFFFFFFFF - StartTicks) + EndTicks; 26571867Smsmith } 26671867Smsmith } 26773561Smsmith else 26873561Smsmith { 26973561Smsmith *TimeElapsed = 0; 27073561Smsmith return_ACPI_STATUS (AE_OK); 27173561Smsmith } 27271867Smsmith 27377424Smsmith /* 27471867Smsmith * Compute Duration: 27571867Smsmith * ----------------- 27671867Smsmith * 27791116Smsmith * Requires a 64-bit divide: 27877424Smsmith * 27991116Smsmith * TimeElapsed = (DeltaTicks * 1000000) / PM_TIMER_FREQUENCY; 28071867Smsmith */ 28191116Smsmith NormalizedTicks.Full = ((UINT64) DeltaTicks) * 1000000; 28271867Smsmith 28391116Smsmith Status = AcpiUtShortDivide (&NormalizedTicks.Full, PM_TIMER_FREQUENCY, 28491116Smsmith &OutQuotient, NULL); 28580062Smsmith 28691116Smsmith *TimeElapsed = (UINT32) OutQuotient; 28791116Smsmith return_ACPI_STATUS (Status); 28871867Smsmith} 28971867Smsmith 29071867Smsmith 291