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_ENABLE
40  *
41  * Define to 1 to enable Child Supervision support.
42  *
43  */
44 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE
45 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE 0
46 #endif
47 
48 /**
49  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
50  *
51  * The default supervision interval in seconds used by parent. Set to zero to disable the supervision process on the
52  * parent.
53  *
54  * Applicable only if child supervision feature is enabled (i.e.,
55  * `OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE ` is set).
56  *
57  * Child supervision feature provides a mechanism for parent to ensure that a message is sent to each sleepy child
58  * within the supervision interval. If there is no transmission to the child within the supervision interval, child
59  * supervisor will enqueue and send a supervision message (a data message with empty payload) to the child.
60  *
61  */
62 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL
63 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_INTERVAL 129
64 #endif
65 
66 /**
67  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT
68  *
69  * The default supervision check timeout interval (in seconds) used by a device in child state. Set to zero to disable
70  * the supervision check process on the child.
71  *
72  * Applicable only if child supervision feature is enabled (i.e., `OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE` is set).
73  *
74  * If the sleepy child does not hear from its parent within the specified timeout interval, it initiates the re-attach
75  * process (MLE Child Update Request/Response exchange with its parent).
76  *
77  */
78 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT
79 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_CHECK_TIMEOUT 190
80 #endif
81 
82 /**
83  * @def OPENTHREAD_CONFIG_CHILD_SUPERVISION_MSG_NO_ACK_REQUEST
84  *
85  * Define as 1 to clear/disable 15.4 ack request in the MAC header of a supervision message.
86  *
87  * Applicable only if child supervision feature is enabled (i.e., `OPENTHREAD_CONFIG_CHILD_SUPERVISION_ENABLE` is set).
88  *
89  */
90 #ifndef OPENTHREAD_CONFIG_CHILD_SUPERVISION_MSG_NO_ACK_REQUEST
91 #define OPENTHREAD_CONFIG_CHILD_SUPERVISION_MSG_NO_ACK_REQUEST 0
92 #endif
93 
94 #endif // CONFIG_CHILD_SUPERVISION_H_
95