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 Child Supervision.
32  *
33  */
34 
35 #ifndef CONFIG_CHILD_SUPERVISION_H_
36 #define CONFIG_CHILD_SUPERVISION_H_
37 
38 /**
39  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
40  *
41  * The default supervision interval in seconds to use when in child state. Zero indicates no supervision needed.
42  *
43  * The current supervision interval can be changed using `otChildSupervisionSetInterval()`.
44  *
45  * Child supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child
46  * within the supervision interval. If there is no transmission to the child within the supervision interval, child
47  * supervisor will enqueue and send a supervision message (a data message with empty payload) to the child.
48  *
49  */
50 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
51 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL 129
52 #endif
53 
54 /**
55  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT
56  *
57  * The default supervision check timeout interval (in seconds) used by a device in child state. Set to zero to disable
58  * the supervision check process on the child.
59  *
60  * The check timeout interval can be changed using `otChildSupervisionSetCheckTimeout()`.
61  *
62  * If the sleepy child does not hear from its parent within the specified timeout interval, it initiates the re-attach
63  * process (MLE Child Update Request/Response exchange with its parent).
64  *
65  */
66 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT
67 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT 190
68 #endif
69 
70 /**
71  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL
72  *
73  * Specifies the default supervision interval to use on parent for children that do not explicitly indicate their
74  * desired supervision internal (do not include a "Supervision Interval TLV") and are running older Thread versions
75  * (version <= 1.3.0).
76  *
77  * This config is added to allow backward compatibility on parent with SED children that used Child Supervision
78  * feature in OT stack before adoption of it by Thread specification and addition of the "Supervision Interval TLV" as
79  * the mechanism for child to inform the parent of its desired supervision interval.
80  *
81  * The config can be set to zero to effectively disable it, i.e., if a child does not provide "Supervision Interval TLV"
82  * it indicates that it does not want to be supervised and then parent will use zero interval for the child.
83  *
84  */
85 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL
86 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_OLDER_VERSION_CHILD_DEFAULT_INTERVAL 129
87 #endif
88 
89 #endif // CONFIG_CHILD_SUPERVISION_H_
90