14a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/*---------------------------------------------------------------------------* 24a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * pcputimer.h * 34a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 44a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Copyright 2007, 2008 Nuance Communciations, Inc. * 54a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 64a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the 'License'); * 74a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * you may not use this file except in compliance with the License. * 84a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 94a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * You may obtain a copy of the License at * 104a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 * 114a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 124a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Unless required by applicable law or agreed to in writing, software * 134a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * distributed under the License is distributed on an 'AS IS' BASIS, * 144a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * 154a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * See the License for the specific language governing permissions and * 164a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * limitations under the License. * 174a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * * 184a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project *---------------------------------------------------------------------------*/ 194a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 204a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#ifndef PCPUTIMER_H 214a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#define PCPUTIMER_H 224a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 234a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 244a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 254a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "PortPrefix.h" 264a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#include "ptypes.h" 274a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 284a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 294a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @addtogroup PCPUTimerModule PCPUTimer API functions 304a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 314a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @{ 324a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 334a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 344a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** Typedef */ 354a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Projecttypedef struct PCPUTimer_t PCPUTimer; 364a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 374a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 384a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Creates a new timer object. 394a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 404a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param timer PCPUTimer handle 414a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer is value it points to is null 424a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 434a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerCreate(PCPUTimer **timer); 444a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 454a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 464a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 474a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Destroys timer object. 484a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 494a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @param timer PCPUTimer handle 504a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer is null 514a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 524a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerDestroy(PCPUTimer *timer); 534a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 544a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 554a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Starts the timer. This sets the reference time from which all new elapsed 564a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * time are computed. This does not reset the elapsed time to 0. This is 574a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * useful to pause the timer. 584a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 594a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer is null; ESR_FATAL_ERROR if OS timer is available 604a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 614a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerStart(PCPUTimer *timer); 624a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 634a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 644a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Stops the timer. 654a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 664a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer is null; ESR_FATAL_ERROR if OS timer is available 674a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 684a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerStop(PCPUTimer *timer); 694a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 704a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 714a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Returns the timer elapsed time. If the Timer is in the stopped state, 724a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * successive calls to getElapsed() will always return the same value. If the 734a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Timer is in the started state, successive calls will return the elapsed 744a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * time since the last time PCPUTimerStart() was called. 754a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 764a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer or elapsed to is null; ESR_FATAL_ERROR if OS timer is available 774a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 784a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerGetElapsed(PCPUTimer *timer, 794a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project asr_uint32_t* elapsed); 804a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 814a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 824a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * Resets the elapsed time to 0 and resets the reference time of the Timer. 834a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * This effectively reset the timer in the same state it was right after 844a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * creation. 854a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * 864a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @return ESR_INVALID_ARGUMENT if timer is null 874a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 884a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source ProjectPORTABLE_API ESR_ReturnCode PCPUTimerReset(PCPUTimer *timer); 894a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 904a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project/** 914a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project * @} 924a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project */ 934a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 944a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project 954a68b3365c8c50aa93505e99ead2565ab73dcdb0The Android Open Source Project#endif 96