1 /*
2 * Copyright (c) 2018 Intel Corporation
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7 #include <zephyr/kernel.h>
8 #include <errno.h>
9 #include <sys/types.h>
10 #include <zephyr/sys/util.h>
11
12 #include <zephyr/bluetooth/hci.h>
13
14 #include <zephyr/settings/settings.h>
15 #include <common/bt_settings_commit.h>
16 #include <zephyr/bluetooth/mesh.h>
17
18 #include "host/hci_core.h"
19 #include "mesh.h"
20 #include "subnet.h"
21 #include "app_keys.h"
22 #include "net.h"
23 #include "cdb.h"
24 #include "crypto.h"
25 #include "rpl.h"
26 #include "transport.h"
27 #include "heartbeat.h"
28 #include "access.h"
29 #include "proxy.h"
30 #include "pb_gatt_srv.h"
31 #include "settings.h"
32 #include "cfg.h"
33 #include "brg_cfg.h"
34 #include "solicitation.h"
35 #include "va.h"
36
37 #define LOG_LEVEL CONFIG_BT_MESH_SETTINGS_LOG_LEVEL
38 #include <zephyr/logging/log.h>
39 LOG_MODULE_REGISTER(bt_mesh_settings);
40
41 #ifdef CONFIG_BT_MESH_RPL_STORE_TIMEOUT
42 #define RPL_STORE_TIMEOUT CONFIG_BT_MESH_RPL_STORE_TIMEOUT
43 #else
44 #define RPL_STORE_TIMEOUT (-1)
45 #endif
46
47 #ifdef CONFIG_BT_MESH_SETTINGS_WORKQ_PRIO
48 #define SETTINGS_WORKQ_PRIO CONFIG_BT_MESH_SETTINGS_WORKQ_PRIO
49 #else
50 #define SETTINGS_WORKQ_PRIO 1
51 #endif
52
53 #ifdef CONFIG_BT_MESH_SETTINGS_WORKQ_STACK_SIZE
54 #define SETTINGS_WORKQ_STACK_SIZE CONFIG_BT_MESH_SETTINGS_WORKQ_STACK_SIZE
55 #else
56 #define SETTINGS_WORKQ_STACK_SIZE 0
57 #endif
58
59 static struct k_work_q settings_work_q;
60 static K_THREAD_STACK_DEFINE(settings_work_stack, SETTINGS_WORKQ_STACK_SIZE);
61
62 static struct k_work_delayable pending_store;
63 static ATOMIC_DEFINE(pending_flags, BT_MESH_SETTINGS_FLAG_COUNT);
64
bt_mesh_settings_set(settings_read_cb read_cb,void * cb_arg,void * out,size_t read_len)65 int bt_mesh_settings_set(settings_read_cb read_cb, void *cb_arg,
66 void *out, size_t read_len)
67 {
68 ssize_t len;
69
70 len = read_cb(cb_arg, out, read_len);
71 if (len < 0) {
72 LOG_ERR("Failed to read value (err %zd)", len);
73 return len;
74 }
75
76 LOG_HEXDUMP_DBG(out, len, "val");
77
78 if (len != read_len) {
79 LOG_ERR("Unexpected value length (%zd != %zu)", len, read_len);
80 return -EINVAL;
81 }
82
83 return 0;
84 }
85
mesh_commit(void)86 static int mesh_commit(void)
87 {
88 if (!atomic_test_bit(bt_mesh.flags, BT_MESH_INIT)) {
89 return 0;
90 }
91
92 if (!atomic_test_bit(bt_dev.flags, BT_DEV_ENABLE)) {
93 /* The Bluetooth Mesh settings loader calls bt_mesh_start() immediately
94 * after loading the settings. This is not intended to work before
95 * bt_enable(). The doc on @ref bt_enable requires the "bt/" settings
96 * tree to be loaded after @ref bt_enable is completed, so this handler
97 * will be called again later.
98 */
99 return 0;
100 }
101
102 if (!bt_mesh_subnet_next(NULL)) {
103 /* Nothing to do since we're not yet provisioned */
104 return 0;
105 }
106
107 bt_mesh_net_settings_commit();
108 bt_mesh_model_settings_commit();
109
110 atomic_set_bit(bt_mesh.flags, BT_MESH_VALID);
111
112 bt_mesh_start();
113
114 return 0;
115 }
116
117 SETTINGS_STATIC_HANDLER_DEFINE_WITH_CPRIO(bt_mesh, "bt/mesh", NULL, NULL, mesh_commit, NULL,
118 BT_SETTINGS_CPRIO_2);
119
120 /* Pending flags that use K_NO_WAIT as the storage timeout */
121 #define NO_WAIT_PENDING_BITS (BIT(BT_MESH_SETTINGS_NET_PENDING) | \
122 BIT(BT_MESH_SETTINGS_IV_PENDING) | \
123 BIT(BT_MESH_SETTINGS_SEQ_PENDING) | \
124 BIT(BT_MESH_SETTINGS_CDB_PENDING))
125
126 /* Pending flags that use CONFIG_BT_MESH_STORE_TIMEOUT */
127 #define GENERIC_PENDING_BITS \
128 (BIT(BT_MESH_SETTINGS_NET_KEYS_PENDING) | BIT(BT_MESH_SETTINGS_APP_KEYS_PENDING) | \
129 BIT(BT_MESH_SETTINGS_HB_PUB_PENDING) | BIT(BT_MESH_SETTINGS_CFG_PENDING) | \
130 BIT(BT_MESH_SETTINGS_MOD_PENDING) | BIT(BT_MESH_SETTINGS_VA_PENDING) | \
131 BIT(BT_MESH_SETTINGS_SSEQ_PENDING) | BIT(BT_MESH_SETTINGS_COMP_PENDING) | \
132 BIT(BT_MESH_SETTINGS_DEV_KEY_CAND_PENDING) | BIT(BT_MESH_SETTINGS_BRG_PENDING))
133
bt_mesh_settings_store_schedule(enum bt_mesh_settings_flag flag)134 void bt_mesh_settings_store_schedule(enum bt_mesh_settings_flag flag)
135 {
136 uint32_t timeout_ms, remaining_ms;
137
138 atomic_set_bit(pending_flags, flag);
139
140 if (atomic_get(pending_flags) & NO_WAIT_PENDING_BITS) {
141 timeout_ms = 0;
142 } else if (IS_ENABLED(CONFIG_BT_MESH_RPL_STORAGE_MODE_SETTINGS) && RPL_STORE_TIMEOUT >= 0 &&
143 (atomic_test_bit(pending_flags, BT_MESH_SETTINGS_RPL_PENDING) ||
144 atomic_test_bit(pending_flags, BT_MESH_SETTINGS_SRPL_PENDING)) &&
145 !(atomic_get(pending_flags) & GENERIC_PENDING_BITS)) {
146 timeout_ms = RPL_STORE_TIMEOUT * MSEC_PER_SEC;
147 } else {
148 timeout_ms = CONFIG_BT_MESH_STORE_TIMEOUT * MSEC_PER_SEC;
149 }
150
151 remaining_ms = k_ticks_to_ms_floor32(k_work_delayable_remaining_get(&pending_store));
152 LOG_DBG("Waiting %u ms vs rem %u ms", timeout_ms, remaining_ms);
153
154 /* If the new deadline is sooner, override any existing
155 * deadline; otherwise schedule without changing any existing
156 * deadline.
157 */
158 if (timeout_ms < remaining_ms) {
159 if (IS_ENABLED(CONFIG_BT_MESH_SETTINGS_WORKQ)) {
160 k_work_reschedule_for_queue(&settings_work_q, &pending_store,
161 K_MSEC(timeout_ms));
162 } else {
163 k_work_reschedule(&pending_store, K_MSEC(timeout_ms));
164 }
165 } else {
166 if (IS_ENABLED(CONFIG_BT_MESH_SETTINGS_WORKQ)) {
167 k_work_schedule_for_queue(&settings_work_q, &pending_store,
168 K_MSEC(timeout_ms));
169 } else {
170 k_work_schedule(&pending_store, K_MSEC(timeout_ms));
171 }
172 }
173 }
174
bt_mesh_settings_store_cancel(enum bt_mesh_settings_flag flag)175 void bt_mesh_settings_store_cancel(enum bt_mesh_settings_flag flag)
176 {
177 atomic_clear_bit(pending_flags, flag);
178 }
179
store_pending(struct k_work * work)180 static void store_pending(struct k_work *work)
181 {
182 LOG_DBG("");
183
184 static const struct {
185 void (*handler)(void);
186 } handlers[BT_MESH_SETTINGS_FLAG_COUNT] = {
187 [BT_MESH_SETTINGS_RPL_PENDING] = { bt_mesh_rpl_pending_store_all_nodes },
188 [BT_MESH_SETTINGS_NET_KEYS_PENDING] = { bt_mesh_subnet_pending_store },
189 [BT_MESH_SETTINGS_APP_KEYS_PENDING] = { bt_mesh_app_key_pending_store },
190 [BT_MESH_SETTINGS_NET_PENDING] = { bt_mesh_net_pending_net_store },
191 [BT_MESH_SETTINGS_IV_PENDING] = { bt_mesh_net_pending_iv_store },
192 [BT_MESH_SETTINGS_SEQ_PENDING] = { bt_mesh_net_pending_seq_store },
193 [BT_MESH_SETTINGS_DEV_KEY_CAND_PENDING] = {
194 bt_mesh_net_pending_dev_key_cand_store },
195 [BT_MESH_SETTINGS_HB_PUB_PENDING] = { bt_mesh_hb_pub_pending_store },
196 [BT_MESH_SETTINGS_CFG_PENDING] = { bt_mesh_cfg_pending_store },
197 [BT_MESH_SETTINGS_COMP_PENDING] = { bt_mesh_comp_data_pending_clear },
198 [BT_MESH_SETTINGS_MOD_PENDING] = { bt_mesh_model_pending_store },
199 [BT_MESH_SETTINGS_VA_PENDING] = { bt_mesh_va_pending_store },
200 [BT_MESH_SETTINGS_CDB_PENDING] = {
201 IS_ENABLED(CONFIG_BT_MESH_CDB) ?
202 bt_mesh_cdb_pending_store : NULL },
203 [BT_MESH_SETTINGS_SRPL_PENDING] = {
204 IS_ENABLED(CONFIG_BT_MESH_OD_PRIV_PROXY_SRV) ?
205 bt_mesh_srpl_pending_store : NULL },
206 [BT_MESH_SETTINGS_SSEQ_PENDING] = {
207 IS_ENABLED(CONFIG_BT_MESH_PROXY_SOLICITATION) ?
208 bt_mesh_sseq_pending_store : NULL },
209 [BT_MESH_SETTINGS_BRG_PENDING] = {
210 IS_ENABLED(CONFIG_BT_MESH_BRG_CFG_SRV) ?
211 bt_mesh_brg_cfg_pending_store : NULL },
212 };
213
214 for (int i = 0; i < ARRAY_SIZE(handlers); i++) {
215 if (!handlers[i].handler) {
216 continue;
217 }
218
219 if (atomic_test_and_clear_bit(pending_flags, i)) {
220 handlers[i].handler();
221 }
222 }
223 }
224
bt_mesh_settings_init(void)225 void bt_mesh_settings_init(void)
226 {
227 if (IS_ENABLED(CONFIG_BT_MESH_SETTINGS_WORKQ)) {
228 k_work_queue_start(&settings_work_q, settings_work_stack,
229 K_THREAD_STACK_SIZEOF(settings_work_stack),
230 K_PRIO_COOP(SETTINGS_WORKQ_PRIO), NULL);
231 k_thread_name_set(&settings_work_q.thread, "BT Mesh settings workq");
232 }
233
234 k_work_init_delayable(&pending_store, store_pending);
235 }
236
bt_mesh_settings_store_pending(void)237 void bt_mesh_settings_store_pending(void)
238 {
239 (void)k_work_cancel_delayable(&pending_store);
240
241 store_pending(&pending_store.work);
242 }
243