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