1 /* 2 * Copyright (c) 2019, 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 * This file includes compile-time configurations for the Time Sync service. 32 */ 33 34 #ifndef CONFIG_TIME_SYNC_H_ 35 #define CONFIG_TIME_SYNC_H_ 36 37 /** 38 * @addtogroup config-time-sync 39 * 40 * @brief 41 * This module includes configuration variables for the Time Sync service. 42 * 43 * @{ 44 */ 45 46 /** 47 * @def OPENTHREAD_CONFIG_TIME_SYNC_ENABLE 48 * 49 * Define as 1 to enable the time synchronization service feature. 50 */ 51 #ifndef OPENTHREAD_CONFIG_TIME_SYNC_ENABLE 52 #define OPENTHREAD_CONFIG_TIME_SYNC_ENABLE 0 53 #endif 54 55 /** 56 * @def OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED 57 * 58 * Define as 1 to require time synchronization when attaching to a network. If the device is router capable 59 * and cannot find a neighboring router supporting time synchronization, the device will form a new partition. 60 * If the device is not router capable, the device will remain an orphan. 61 * 62 * Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set) 63 */ 64 #ifndef OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED 65 #define OPENTHREAD_CONFIG_TIME_SYNC_REQUIRED 0 66 #endif 67 68 /** 69 * @def OPENTHREAD_CONFIG_TIME_SYNC_PERIOD 70 * 71 * Specifies the default period of time synchronization, in seconds. 72 * 73 * Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set). 74 */ 75 #ifndef OPENTHREAD_CONFIG_TIME_SYNC_PERIOD 76 #define OPENTHREAD_CONFIG_TIME_SYNC_PERIOD 30 77 #endif 78 79 /** 80 * @def OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD 81 * 82 * Specifies the default XTAL threshold for a device to become Router in time synchronization enabled network, in PPM. 83 * 84 * Applicable only if time synchronization service feature is enabled (i.e., OPENTHREAD_CONFIG_TIME_SYNC_ENABLE is set) 85 */ 86 #ifndef OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD 87 #define OPENTHREAD_CONFIG_TIME_SYNC_XTAL_THRESHOLD 300 88 #endif 89 90 /** 91 * @def OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 92 * 93 * This setting sets the minimum amount of time (in microseconds) that the network time must jump due to 94 * a time sync event for listeners to be notified of the new network time. 95 */ 96 #ifndef OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 97 #define OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 10000 98 #endif 99 100 /** 101 * @} 102 */ 103 104 #endif // CONFIG_TIME_SYNC_H_ 105