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