1 /*
2  *  Copyright (c) 2020, 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 configuration constants for OpenThread.
32  */
33 
34 #ifndef OPENTHREAD_SPINEL_CONFIG_H_
35 #define OPENTHREAD_SPINEL_CONFIG_H_
36 
37 /**
38  * Include project specific lib config file if defined.
39  *
40  */
41 #ifdef OPENTHREAD_PROJECT_LIB_CONFIG_FILE
42 #include OPENTHREAD_PROJECT_LIB_CONFIG_FILE
43 #endif
44 
45 /**
46  * @def OPENTHREAD_LIB_SPINEL_RX_FRAME_BUFFER_SIZE
47  *
48  * Specifies the rx frame buffer size used by `SpinelInterface` in RCP host (posix) code. This is applicable/used when
49  * `RadioSpinel` platform is used.
50  *
51  */
52 #ifndef OPENTHREAD_LIB_SPINEL_RX_FRAME_BUFFER_SIZE
53 #define OPENTHREAD_LIB_SPINEL_RX_FRAME_BUFFER_SIZE 8192
54 #endif
55 
56 /**
57  * @def OPENTHREAD_LIB_SPINEL_LOG_MAX_SIZE
58  *
59  * The maximum log string size (number of chars).
60  *
61  */
62 #ifndef OPENTHREAD_LIB_SPINEL_LOG_MAX_SIZE
63 #define OPENTHREAD_LIB_SPINEL_LOG_MAX_SIZE 1024
64 #endif
65 
66 /**
67  * @def OPENTHREAD_LIB_SPINEL_NCP_LOG_MAX_SIZE
68  *
69  * The maximum OpenThread log string size (number of chars) supported by NCP using Spinel `StreamWrite`.
70  *
71  */
72 #ifndef OPENTHREAD_LIB_SPINEL_NCP_LOG_MAX_SIZE
73 #define OPENTHREAD_LIB_SPINEL_NCP_LOG_MAX_SIZE 150
74 #endif
75 
76 /**
77  * @def OPENTHREAD_SPINEL_CONFIG_OPENTHREAD_MESSAGE_ENABLE
78  *
79  * Define 1 to enable feeding an OpenThread message to encoder/decoder.
80  *
81  */
82 #ifndef OPENTHREAD_SPINEL_CONFIG_OPENTHREAD_MESSAGE_ENABLE
83 #define OPENTHREAD_SPINEL_CONFIG_OPENTHREAD_MESSAGE_ENABLE 0
84 #endif
85 
86 /**
87  * @def OPENTHREAD_SPINEL_CONFIG_RCP_RESTORATION_MAX_COUNT
88  *
89  * Defines the max count of RCP failures allowed to be recovered.
90  * 0 means to disable RCP failure recovering.
91  *
92  */
93 #ifndef OPENTHREAD_SPINEL_CONFIG_RCP_RESTORATION_MAX_COUNT
94 #define OPENTHREAD_SPINEL_CONFIG_RCP_RESTORATION_MAX_COUNT 0
95 #endif
96 
97 /**
98  * @def OPENTHREAD_SPINEL_CONFIG_ABORT_ON_UNEXPECTED_RCP_RESET_ENABLE
99  *
100  * Define 1 to abort the host when receiving unexpected reset from RCP.
101  *
102  */
103 #ifndef OPENTHREAD_SPINEL_CONFIG_ABORT_ON_UNEXPECTED_RCP_RESET_ENABLE
104 #define OPENTHREAD_SPINEL_CONFIG_ABORT_ON_UNEXPECTED_RCP_RESET_ENABLE 0
105 #endif
106 
107 /**
108  * @def OPENTHREAD_SPINEL_CONFIG_RCP_TIME_SYNC_INTERVAL
109  *
110  * This setting configures the interval (in units of microseconds) for host-rcp
111  * time sync. The host will recalculate the time offset between host and RCP
112  * every interval.
113  *
114  */
115 #ifndef OPENTHREAD_SPINEL_CONFIG_RCP_TIME_SYNC_INTERVAL
116 #define OPENTHREAD_SPINEL_CONFIG_RCP_TIME_SYNC_INTERVAL (60 * 1000 * 1000)
117 #endif
118 
119 /**
120  * @def OPENTHREAD_SPINEL_CONFIG_BROADCAST_IID
121  *
122  * Define broadcast IID for spinel frames dedicated to all hosts in multipan configuration.
123  *
124  */
125 #ifndef OPENTHREAD_SPINEL_CONFIG_BROADCAST_IID
126 #define OPENTHREAD_SPINEL_CONFIG_BROADCAST_IID SPINEL_HEADER_IID_3
127 #endif
128 
129 /**
130  * @def OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_ENABLE
131  *
132  * Enables compilation of vendor specific code for Spinel
133  *
134  */
135 #ifndef OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_ENABLE
136 #define OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_ENABLE 0
137 #endif
138 
139 /**
140  * @def OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_HEADER
141  *
142  * Header file defining class VendorRadioSpinel
143  *
144  */
145 #ifndef OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_HEADER
146 #define OPENTHREAD_SPINEL_CONFIG_VENDOR_HOOK_HEADER "lib/spinel/example_vendor_hook.hpp"
147 #endif
148 
149 /**
150  * @def OPENTHREAD_SPINEL_CONFIG_RCP_TX_WAIT_TIME_SECS
151  *
152  * Defines the Tx wait duration in seconds.
153  *
154  */
155 #ifndef OPENTHREAD_SPINEL_CONFIG_RCP_TX_WAIT_TIME_SECS
156 #define OPENTHREAD_SPINEL_CONFIG_RCP_TX_WAIT_TIME_SECS 5
157 #endif
158 
159 #endif // OPENTHREAD_SPINEL_CONFIG_H_
160