1 /* 2 * Copyright (c) 2018, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * @brief 32 * This file includes the platform abstraction for the time service. 33 */ 34 35 #ifndef OPENTHREAD_PLATFORM_TIME_H_ 36 #define OPENTHREAD_PLATFORM_TIME_H_ 37 38 #include <stdint.h> 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 #define OT_MS_PER_S 1000 ///< Number of milliseconds per second 45 #define OT_US_PER_MS 1000 ///< Number of microseconds per millisecond 46 #define OT_US_PER_S 1000000 ///< Number of microseconds per second 47 #define OT_NS_PER_US 1000 ///< Number of nanoseconds per microsecond 48 49 /** 50 * @addtogroup plat-time 51 * 52 * @brief 53 * This module includes the platform abstraction for the time service. 54 * 55 * @{ 56 */ 57 58 /** 59 * Get the current platform time in microseconds referenced to a continuous 60 * monotonic local clock (64 bits width). 61 * 62 * The clock SHALL NOT wrap during the device's uptime. Implementations SHALL 63 * therefore identify and compensate for internal counter overflows. The clock 64 * does not have a defined epoch and it SHALL NOT introduce any continuous or 65 * discontinuous adjustments (e.g. leap seconds). Implementations SHALL 66 * compensate for any sleep times of the device. 67 * 68 * Implementations MAY choose to discipline the platform clock and compensate 69 * for sleep times by any means (e.g. by combining a high precision/low power 70 * RTC with a high resolution counter) as long as the exposed combined clock 71 * provides continuous monotonic microsecond resolution ticks within the 72 * accuracy limits announced by @ref otPlatTimeGetXtalAccuracy. 73 * 74 * @returns The current time in microseconds. 75 */ 76 uint64_t otPlatTimeGet(void); 77 78 /** 79 * Get the current estimated worst case accuracy (maximum ± deviation from the 80 * nominal frequency) of the local platform clock in units of PPM. 81 * 82 * @note Implementations MAY estimate this value based on current operating 83 * conditions (e.g. temperature). 84 * 85 * In case the implementation does not estimate the current value but returns a 86 * fixed value, this value MUST be the worst-case accuracy over all possible 87 * foreseen operating conditions (temperature, pressure, etc) of the 88 * implementation. 89 * 90 * @returns The current platform clock accuracy, in PPM. 91 */ 92 uint16_t otPlatTimeGetXtalAccuracy(void); 93 94 /** 95 * @} 96 */ 97 98 #ifdef __cplusplus 99 } // extern "C" 100 #endif 101 102 #endif // OPENTHREAD_PLATFORM_TIME_H_ 103
