ref: b4ff1f9ca24fa7ca7d89000cbd1402d120b0054e
src/libs/mynewt-nimble/nimble/host/mesh/src/heartbeat.c
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
/* * Copyright (c) 2020 Nordic Semiconductor ASA * * SPDX-License-Identifier: Apache-2.0 */ #define MESH_LOG_MODULE BLE_MESH_HEARTBEAT_LOG #include "mesh_priv.h" #include "net.h" #include "rpl.h" #include "access.h" #include "lpn.h" #include "settings.h" #include "transport.h" #include "heartbeat.h" #include "foundation.h" #include "mesh/glue.h" struct bt_mesh_hb_cb hb_cb; static struct bt_mesh_hb_pub pub; static struct bt_mesh_hb_sub sub; static struct k_delayed_work sub_timer; static struct k_delayed_work pub_timer; static int64_t sub_remaining(void) { if (sub.dst == BT_MESH_ADDR_UNASSIGNED) { return 0U; } return k_delayed_work_remaining_get(&sub_timer) / MSEC_PER_SEC; } static void hb_publish_end_cb(int err, void *cb_data) { if (pub.period && pub.count > 1) { k_delayed_work_submit(&pub_timer, K_SECONDS(pub.period)); } if (pub.count != 0xffff) { pub.count--; } } static void notify_recv(uint8_t hops, uint16_t feat) { sub.remaining = sub_remaining(); if (hb_cb.recv != NULL) { hb_cb.recv(&sub, hops, feat); } } static void notify_sub_end(void) { sub.remaining = 0; if (hb_cb.sub_end != NULL) { hb_cb.sub_end(&sub); } } static void sub_end(struct ble_npl_event *work) { notify_sub_end(); } static int heartbeat_send(const struct bt_mesh_send_cb *cb, void *cb_data) { uint16_t feat = 0U; struct __packed { uint8_t init_ttl; uint16_t feat; } hb; struct bt_mesh_msg_ctx ctx = { .net_idx = pub.net_idx, .app_idx = BT_MESH_KEY_UNUSED, .addr = pub.dst, .send_ttl = pub.ttl, }; struct bt_mesh_net_tx tx = { .sub = bt_mesh_subnet_get(pub.net_idx), .ctx = &ctx, .src = bt_mesh_primary_addr(), .xmit = bt_mesh_net_transmit_get(), }; /* Do nothing if heartbeat publication is not enabled */ if (pub.dst == BT_MESH_ADDR_UNASSIGNED) { return 0U; } hb.init_ttl = pub.ttl; if (bt_mesh_relay_get() == BT_MESH_RELAY_ENABLED) { feat |= BT_MESH_FEAT_RELAY; } if (bt_mesh_gatt_proxy_get() == BT_MESH_GATT_PROXY_ENABLED) { feat |= BT_MESH_FEAT_PROXY; } if (bt_mesh_friend_get() == BT_MESH_FRIEND_ENABLED) { feat |= BT_MESH_FEAT_FRIEND; } if (bt_mesh_lpn_established()) { feat |= BT_MESH_FEAT_LOW_POWER; } hb.feat = sys_cpu_to_be16(feat); BT_DBG("InitTTL %u feat 0x%04x", pub.ttl, feat); return bt_mesh_ctl_send(&tx, TRANS_CTL_OP_HEARTBEAT, &hb, sizeof(hb), cb, cb_data); } static void hb_publish_start_cb(uint16_t duration, int err, void *cb_data) { if (err) { hb_publish_end_cb(err, cb_data); } } static void hb_publish(struct ble_npl_event *work) { static const struct bt_mesh_send_cb publish_cb = { .start = hb_publish_start_cb, .end = hb_publish_end_cb, }; struct bt_mesh_subnet *sub; int err; BT_DBG("hb_pub.count: %u", pub.count); sub = bt_mesh_subnet_get(pub.net_idx); if (!sub) { BT_ERR("No matching subnet for idx 0x%02x", pub.net_idx); pub.dst = BT_MESH_ADDR_UNASSIGNED; return; } if (pub.count == 0U) { return; } err = heartbeat_send(&publish_cb, NULL); if (err) { hb_publish_end_cb(err, NULL); } } int bt_mesh_hb_recv(struct bt_mesh_net_rx *rx, struct os_mbuf *buf) { uint8_t init_ttl, hops; uint16_t feat; if (buf->om_len < 3) { BT_ERR("Too short heartbeat message"); return -EINVAL; } init_ttl = (net_buf_simple_pull_u8(buf) & 0x7f); feat = net_buf_simple_pull_be16(buf); hops = (init_ttl - rx->ctx.recv_ttl + 1); if (rx->ctx.addr != sub.src || rx->ctx.recv_dst != sub.dst) { BT_DBG("No subscription for received heartbeat"); return 0; } if (!k_delayed_work_pending(&sub_timer)) { BT_DBG("Heartbeat subscription period expired"); return 0; } sub.min_hops = MIN(sub.min_hops, hops); sub.max_hops = MAX(sub.max_hops, hops); if (sub.count < 0xffff) { sub.count++; } BT_DBG("src 0x%04x TTL %u InitTTL %u (%u hop%s) feat 0x%04x", rx->ctx.addr, rx->ctx.recv_ttl, init_ttl, hops, (hops == 1U) ? "" : "s", feat); notify_recv(hops, feat); return 0; } static void pub_disable(void) { BT_DBG(""); pub.dst = BT_MESH_ADDR_UNASSIGNED; pub.count = 0U; pub.ttl = 0U; pub.period = 0U; k_delayed_work_cancel(&pub_timer); } uint8_t bt_mesh_hb_pub_set(struct bt_mesh_hb_pub *new_pub) { if (!new_pub || new_pub->dst == BT_MESH_ADDR_UNASSIGNED) { pub_disable(); if (IS_ENABLED(CONFIG_BT_SETTINGS) && bt_mesh_is_provisioned()) { bt_mesh_store_hb_pub(); } return STATUS_SUCCESS; } if (!bt_mesh_subnet_get(new_pub->net_idx)) { BT_ERR("Unknown NetKey 0x%04x", new_pub->net_idx); return STATUS_INVALID_NETKEY; } new_pub->feat &= BT_MESH_FEAT_SUPPORTED; pub = *new_pub; if (!bt_mesh_is_provisioned()) { return STATUS_SUCCESS; } /* The first Heartbeat message shall be published as soon as possible * after the Heartbeat Publication Period state has been configured for * periodic publishing. */ if (pub.period && pub.count) { k_delayed_work_submit(&pub_timer, K_NO_WAIT); } else { k_delayed_work_cancel(&pub_timer); } if (IS_ENABLED(CONFIG_BT_SETTINGS)) { bt_mesh_store_hb_pub(); } return STATUS_SUCCESS; } void bt_mesh_hb_pub_get(struct bt_mesh_hb_pub *get) { *get = pub; } uint8_t bt_mesh_hb_sub_set(uint16_t src, uint16_t dst, uint32_t period) { if (src != BT_MESH_ADDR_UNASSIGNED && !BT_MESH_ADDR_IS_UNICAST(src)) { BT_WARN("Prohibited source address"); return STATUS_INVALID_ADDRESS; } if (BT_MESH_ADDR_IS_VIRTUAL(dst) || BT_MESH_ADDR_IS_RFU(dst) || (BT_MESH_ADDR_IS_UNICAST(dst) && dst != bt_mesh_primary_addr())) { BT_WARN("Prohibited destination address"); return STATUS_INVALID_ADDRESS; } if (period > (1U << 16)) { BT_WARN("Prohibited subscription period %u s", period); return STATUS_CANNOT_SET; } /* Only an explicit address change to unassigned should trigger clearing * of the values according to MESH/NODE/CFG/HBS/BV-02-C. */ if (src == BT_MESH_ADDR_UNASSIGNED || dst == BT_MESH_ADDR_UNASSIGNED) { sub.src = BT_MESH_ADDR_UNASSIGNED; sub.dst = BT_MESH_ADDR_UNASSIGNED; sub.min_hops = 0U; sub.max_hops = 0U; sub.count = 0U; sub.period = sub.period - sub_remaining(); k_delayed_work_cancel(&sub_timer); notify_sub_end(); } else if (period) { sub.src = src; sub.dst = dst; sub.min_hops = BT_MESH_TTL_MAX; sub.max_hops = 0U; sub.count = 0U; sub.period = period; k_delayed_work_submit(&sub_timer, K_SECONDS(period)); } else { /* Clearing the period should stop heartbeat subscription * without clearing the parameters, so we can still read them. */ sub.period = sub.period - sub_remaining(); k_delayed_work_cancel(&sub_timer); notify_sub_end(); } return STATUS_SUCCESS; } void bt_mesh_hb_sub_get(struct bt_mesh_hb_sub *get) { *get = sub; get->remaining = sub_remaining(); } void bt_mesh_hb_feature_changed(uint16_t features) { if (pub.dst == BT_MESH_ADDR_UNASSIGNED) { return; } if (!(pub.feat & features)) { return; } heartbeat_send(NULL, NULL); } void bt_mesh_hb_init(void) { pub.net_idx = BT_MESH_KEY_UNUSED; k_delayed_work_init(&pub_timer, hb_publish); k_delayed_work_init(&sub_timer, sub_end); } void bt_mesh_hb_start(void) { if (pub.count && pub.period) { BT_DBG("Starting heartbeat publication"); k_delayed_work_submit(&pub_timer, K_NO_WAIT); } } void bt_mesh_hb_suspend(void) { k_delayed_work_cancel(&pub_timer); } void bt_mesh_hb_resume(void) { if (pub.period && pub.count) { BT_DBG("Starting heartbeat publication"); k_delayed_work_submit(&pub_timer, K_NO_WAIT); } } |