1 /* 2 * Copyright (c) 2016, 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 millisecond alarm service. 33 */ 34 35 #ifndef OPENTHREAD_PLATFORM_ALARM_MILLI_H_ 36 #define OPENTHREAD_PLATFORM_ALARM_MILLI_H_ 37 38 #include <stdint.h> 39 40 #include <openthread/instance.h> 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /** 47 * @addtogroup plat-alarm 48 * 49 * @brief 50 * This module includes the platform abstraction for the alarm service. 51 * 52 * @{ 53 */ 54 55 /** 56 * Set the alarm to fire at @p aDt milliseconds after @p aT0. 57 * 58 * For @p aT0 the platform MUST support all values in [0, 2^32-1]. 59 * For @p aDt, the platform MUST support all values in [0, 2^31-1]. 60 * 61 * @param[in] aInstance The OpenThread instance structure. 62 * @param[in] aT0 The reference time. 63 * @param[in] aDt The time delay in milliseconds from @p aT0. 64 */ 65 void otPlatAlarmMilliStartAt(otInstance *aInstance, uint32_t aT0, uint32_t aDt); 66 67 /** 68 * Stop the alarm. 69 * 70 * @param[in] aInstance The OpenThread instance structure. 71 */ 72 void otPlatAlarmMilliStop(otInstance *aInstance); 73 74 /** 75 * Get the current time. 76 * 77 * The current time MUST represent a free-running timer. When maintaining current time, the time value MUST utilize the 78 * entire range [0, 2^32-1] and MUST NOT wrap before 2^32. 79 * 80 * @returns The current time in milliseconds. 81 */ 82 uint32_t otPlatAlarmMilliGetNow(void); 83 84 /** 85 * Signal that the alarm has fired. 86 * 87 * @param[in] aInstance The OpenThread instance structure. 88 */ 89 extern void otPlatAlarmMilliFired(otInstance *aInstance); 90 91 /** 92 * Signal diagnostics module that the alarm has fired. 93 * 94 * @param[in] aInstance The OpenThread instance structure. 95 */ 96 extern void otPlatDiagAlarmFired(otInstance *aInstance); 97 98 /** 99 * @} 100 */ 101 102 #ifdef __cplusplus 103 } // extern "C" 104 #endif 105 106 #endif // OPENTHREAD_PLATFORM_ALARM_MILLI_H_ 107
