ref: 6c678e872d51247f5e47730218598209e96bdd0a
src/libs/mynewt-nimble/nimble/host/mesh/include/mesh/access.h
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 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 |
/** @file * @brief Bluetooth Mesh Access Layer APIs. */ /* * Copyright (c) 2017 Intel Corporation * * SPDX-License-Identifier: Apache-2.0 */ #ifndef __BT_MESH_ACCESS_H #define __BT_MESH_ACCESS_H /** * @brief Bluetooth Mesh Access Layer * @defgroup bt_mesh_access Bluetooth Mesh Access Layer * @ingroup bt_mesh * @{ */ #ifdef __cplusplus extern "C" { #endif #define BT_MESH_ADDR_UNASSIGNED 0x0000 #define BT_MESH_ADDR_ALL_NODES 0xffff #define BT_MESH_ADDR_PROXIES 0xfffc #define BT_MESH_ADDR_FRIENDS 0xfffd #define BT_MESH_ADDR_RELAYS 0xfffe #define BT_MESH_KEY_UNUSED 0xffff #define BT_MESH_KEY_DEV 0xfffe #define BT_MESH_KEY_DEV_LOCAL BT_MESH_KEY_DEV #define BT_MESH_KEY_DEV_REMOTE 0xfffd #define BT_MESH_KEY_DEV_ANY 0xfffc #define BT_MESH_IS_DEV_KEY(key) (key == BT_MESH_KEY_DEV_LOCAL || \ key == BT_MESH_KEY_DEV_REMOTE) /** Helper to define a mesh element within an array. * * In case the element has no SIG or Vendor models the helper * macro BT_MESH_MODEL_NONE can be given instead. * * @param _loc Location Descriptor. * @param _mods Array of models. * @param _vnd_mods Array of vendor models. */ #define BT_MESH_ELEM(_loc, _mods, _vnd_mods) \ { \ .loc = (_loc), \ .model_count = ARRAY_SIZE(_mods), \ .models = (_mods), \ .vnd_model_count = ARRAY_SIZE(_vnd_mods), \ .vnd_models = (_vnd_mods), \ } /** Abstraction that describes a Mesh Element */ struct bt_mesh_elem { /* Unicast Address. Set at runtime during provisioning. */ u16_t addr; /* Location Descriptor (GATT Bluetooth Namespace Descriptors) */ const u16_t loc; const u8_t model_count; const u8_t vnd_model_count; struct bt_mesh_model * const models; struct bt_mesh_model * const vnd_models; }; /* Foundation Models */ #define BT_MESH_MODEL_ID_CFG_SRV 0x0000 #define BT_MESH_MODEL_ID_CFG_CLI 0x0001 #define BT_MESH_MODEL_ID_HEALTH_SRV 0x0002 #define BT_MESH_MODEL_ID_HEALTH_CLI 0x0003 /* Models from the Mesh Model Specification */ #define BT_MESH_MODEL_ID_GEN_ONOFF_SRV 0x1000 #define BT_MESH_MODEL_ID_GEN_ONOFF_CLI 0x1001 #define BT_MESH_MODEL_ID_GEN_LEVEL_SRV 0x1002 #define BT_MESH_MODEL_ID_GEN_LEVEL_CLI 0x1003 #define BT_MESH_MODEL_ID_GEN_DEF_TRANS_TIME_SRV 0x1004 #define BT_MESH_MODEL_ID_GEN_DEF_TRANS_TIME_CLI 0x1005 #define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_SRV 0x1006 #define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_SETUP_SRV 0x1007 #define BT_MESH_MODEL_ID_GEN_POWER_ONOFF_CLI 0x1008 #define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_SRV 0x1009 #define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_SETUP_SRV 0x100a #define BT_MESH_MODEL_ID_GEN_POWER_LEVEL_CLI 0x100b #define BT_MESH_MODEL_ID_GEN_BATTERY_SRV 0x100c #define BT_MESH_MODEL_ID_GEN_BATTERY_CLI 0x100d #define BT_MESH_MODEL_ID_GEN_LOCATION_SRV 0x100e #define BT_MESH_MODEL_ID_GEN_LOCATION_SETUPSRV 0x100f #define BT_MESH_MODEL_ID_GEN_LOCATION_CLI 0x1010 #define BT_MESH_MODEL_ID_GEN_ADMIN_PROP_SRV 0x1011 #define BT_MESH_MODEL_ID_GEN_MANUFACTURER_PROP_SRV 0x1012 #define BT_MESH_MODEL_ID_GEN_USER_PROP_SRV 0x1013 #define BT_MESH_MODEL_ID_GEN_CLIENT_PROP_SRV 0x1014 #define BT_MESH_MODEL_ID_GEN_PROP_CLI 0x1015 #define BT_MESH_MODEL_ID_SENSOR_SRV 0x1100 #define BT_MESH_MODEL_ID_SENSOR_SETUP_SRV 0x1101 #define BT_MESH_MODEL_ID_SENSOR_CLI 0x1102 #define BT_MESH_MODEL_ID_TIME_SRV 0x1200 #define BT_MESH_MODEL_ID_TIME_SETUP_SRV 0x1201 #define BT_MESH_MODEL_ID_TIME_CLI 0x1202 #define BT_MESH_MODEL_ID_SCENE_SRV 0x1203 #define BT_MESH_MODEL_ID_SCENE_SETUP_SRV 0x1204 #define BT_MESH_MODEL_ID_SCENE_CLI 0x1205 #define BT_MESH_MODEL_ID_SCHEDULER_SRV 0x1206 #define BT_MESH_MODEL_ID_SCHEDULER_SETUP_SRV 0x1207 #define BT_MESH_MODEL_ID_SCHEDULER_CLI 0x1208 #define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_SRV 0x1300 #define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_SETUP_SRV 0x1301 #define BT_MESH_MODEL_ID_LIGHT_LIGHTNESS_CLI 0x1302 #define BT_MESH_MODEL_ID_LIGHT_CTL_SRV 0x1303 #define BT_MESH_MODEL_ID_LIGHT_CTL_SETUP_SRV 0x1304 #define BT_MESH_MODEL_ID_LIGHT_CTL_CLI 0x1305 #define BT_MESH_MODEL_ID_LIGHT_CTL_TEMP_SRV 0x1306 #define BT_MESH_MODEL_ID_LIGHT_HSL_SRV 0x1307 #define BT_MESH_MODEL_ID_LIGHT_HSL_SETUP_SRV 0x1308 #define BT_MESH_MODEL_ID_LIGHT_HSL_CLI 0x1309 #define BT_MESH_MODEL_ID_LIGHT_HSL_HUE_SRV 0x130a #define BT_MESH_MODEL_ID_LIGHT_HSL_SAT_SRV 0x130b #define BT_MESH_MODEL_ID_LIGHT_XYL_SRV 0x130c #define BT_MESH_MODEL_ID_LIGHT_XYL_SETUP_SRV 0x130d #define BT_MESH_MODEL_ID_LIGHT_XYL_CLI 0x130e #define BT_MESH_MODEL_ID_LIGHT_LC_SRV 0x130f #define BT_MESH_MODEL_ID_LIGHT_LC_SETUPSRV 0x1310 #define BT_MESH_MODEL_ID_LIGHT_LC_CLI 0x1311 /** Message sending context. */ struct bt_mesh_msg_ctx { /** NetKey Index of the subnet to send the message on. */ u16_t net_idx; /** AppKey Index to encrypt the message with. */ u16_t app_idx; /** Remote address. */ u16_t addr; /** Destination address of a received message. Not used for sending. */ u16_t recv_dst; /** RSSI of received packet. Not used for sending. */ s8_t recv_rssi; /** Received TTL value. Not used for sending. */ u8_t recv_ttl; /** Force sending reliably by using segment acknowledgement */ bool send_rel; /** TTL, or BT_MESH_TTL_DEFAULT for default TTL. */ u8_t send_ttl; }; struct bt_mesh_model_op { /* OpCode encoded using the BT_MESH_MODEL_OP_* macros */ const u32_t opcode; /* Minimum required message length */ const size_t min_len; /* Message handler for the opcode */ void (*const func)(struct bt_mesh_model *model, struct bt_mesh_msg_ctx *ctx, struct os_mbuf *buf); }; #define BT_MESH_MODEL_OP_1(b0) (b0) #define BT_MESH_MODEL_OP_2(b0, b1) (((b0) << 8) | (b1)) #define BT_MESH_MODEL_OP_3(b0, cid) ((((b0) << 16) | 0xc00000) | (cid)) #define BT_MESH_MODEL_OP_END { 0, 0, NULL } #define BT_MESH_MODEL_NO_OPS ((struct bt_mesh_model_op []) \ { BT_MESH_MODEL_OP_END }) /** Helper to define an empty model array */ #define BT_MESH_MODEL_NONE ((struct bt_mesh_model []){}) /** Length of a short Mesh MIC. */ #define BT_MESH_MIC_SHORT 4 /** Length of a long Mesh MIC. */ #define BT_MESH_MIC_LONG 8 /** @def BT_MESH_MODEL_OP_LEN * * @brief Helper to determine the length of an opcode. * * @param _op Opcode. */ #define BT_MESH_MODEL_OP_LEN(_op) ((_op) <= 0xff ? 1 : (_op) <= 0xffff ? 2 : 3) /** @def BT_MESH_MODEL_BUF_LEN * * @brief Helper for model message buffer length. * * Returns the length of a Mesh model message buffer, including the opcode * length and a short MIC. * * @param _op Opcode of the message. * @param _payload_len Length of the model payload. */ #define BT_MESH_MODEL_BUF_LEN(_op, _payload_len) \ (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_SHORT) /** @def BT_MESH_MODEL_BUF_LEN_LONG_MIC * * @brief Helper for model message buffer length. * * Returns the length of a Mesh model message buffer, including the opcode * length and a long MIC. * * @param _op Opcode of the message. * @param _payload_len Length of the model payload. */ #define BT_MESH_MODEL_BUF_LEN_LONG_MIC(_op, _payload_len) \ (BT_MESH_MODEL_OP_LEN(_op) + (_payload_len) + BT_MESH_MIC_LONG) /** @def BT_MESH_MODEL_BUF_DEFINE * * @brief Define a Mesh model message buffer using @ref NET_BUF_SIMPLE. * * @param _op Opcode of the message. * @param _payload_len Length of the model message payload. */ #define BT_MESH_MODEL_BUF(_op, _payload_len) \ NET_BUF_SIMPLE(BT_MESH_MODEL_BUF_LEN(_op, (_payload_len))) /** @def BT_MESH_MODEL_CB * * @brief Composition data SIG model entry with callback functions. * * @param _id Model ID. * @param _op Array of model opcode handlers. * @param _pub Model publish parameters. * @param _user_data User data for the model. * @param _cb Callback structure, or NULL to keep no callbacks. */ #define BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, _cb) \ { \ .id = (_id), \ .op = _op, \ .keys = { [0 ... (CONFIG_BT_MESH_MODEL_KEY_COUNT - 1)] = \ BT_MESH_KEY_UNUSED }, \ .pub = _pub, \ .groups = { [0 ... (CONFIG_BT_MESH_MODEL_GROUP_COUNT - 1)] = \ BT_MESH_ADDR_UNASSIGNED }, \ .user_data = _user_data, \ .cb = _cb, \ } /** @def BT_MESH_MODEL_VND_CB * * @brief Composition data vendor model entry with callback functions. * * @param _company Company ID. * @param _id Model ID. * @param _op Array of model opcode handlers. * @param _pub Model publish parameters. * @param _user_data User data for the model. * @param _cb Callback structure, or NULL to keep no callbacks. */ #define BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, _cb) \ { \ .vnd.company = (_company), \ .vnd.id = (_id), \ .op = _op, \ .pub = _pub, \ .keys = { [0 ... (CONFIG_BT_MESH_MODEL_KEY_COUNT - 1)] = \ BT_MESH_KEY_UNUSED }, \ .groups = { [0 ... (CONFIG_BT_MESH_MODEL_GROUP_COUNT - 1)] = \ BT_MESH_ADDR_UNASSIGNED }, \ .user_data = _user_data, \ .cb = _cb, \ } /** @def BT_MESH_MODEL * * @brief Composition data SIG model entry. * * @param _id Model ID. * @param _op Array of model opcode handlers. * @param _pub Model publish parameters. * @param _user_data User data for the model. */ #define BT_MESH_MODEL(_id, _op, _pub, _user_data) \ BT_MESH_MODEL_CB(_id, _op, _pub, _user_data, NULL) /** @def BT_MESH_MODEL_VND * * @brief Composition data vendor model entry. * * @param _company Company ID. * @param _id Model ID. * @param _op Array of model opcode handlers. * @param _pub Model publish parameters. * @param _user_data User data for the model. */ #define BT_MESH_MODEL_VND(_company, _id, _op, _pub, _user_data) \ BT_MESH_MODEL_VND_CB(_company, _id, _op, _pub, _user_data, NULL) /** @def BT_MESH_TRANSMIT * * @brief Encode transmission count & interval steps. * * @param count Number of retransmissions (first transmission is excluded). * @param int_ms Interval steps in milliseconds. Must be greater than 0, * less than or equal to 320, and a multiple of 10. * * @return Mesh transmit value that can be used e.g. for the default * values of the configuration model data. */ #define BT_MESH_TRANSMIT(count, int_ms) ((count) | (((int_ms / 10) - 1) << 3)) /** @def BT_MESH_TRANSMIT_COUNT * * @brief Decode transmit count from a transmit value. * * @param transmit Encoded transmit count & interval value. * * @return Transmission count (actual transmissions is N + 1). */ #define BT_MESH_TRANSMIT_COUNT(transmit) (((transmit) & (u8_t)BIT_MASK(3))) /** @def BT_MESH_TRANSMIT_INT * * @brief Decode transmit interval from a transmit value. * * @param transmit Encoded transmit count & interval value. * * @return Transmission interval in milliseconds. */ #define BT_MESH_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 10) /** @def BT_MESH_PUB_TRANSMIT * * @brief Encode Publish Retransmit count & interval steps. * * @param count Number of retransmissions (first transmission is excluded). * @param int_ms Interval steps in milliseconds. Must be greater than 0 * and a multiple of 50. * * @return Mesh transmit value that can be used e.g. for the default * values of the configuration model data. */ #define BT_MESH_PUB_TRANSMIT(count, int_ms) BT_MESH_TRANSMIT(count, \ (int_ms) / 5) /** @def BT_MESH_PUB_TRANSMIT_COUNT * * @brief Decode Pubhlish Retransmit count from a given value. * * @param transmit Encoded Publish Retransmit count & interval value. * * @return Retransmission count (actual transmissions is N + 1). */ #define BT_MESH_PUB_TRANSMIT_COUNT(transmit) BT_MESH_TRANSMIT_COUNT(transmit) /** @def BT_MESH_PUB_TRANSMIT_INT * * @brief Decode Publish Retransmit interval from a given value. * * @param transmit Encoded Publish Retransmit count & interval value. * * @return Transmission interval in milliseconds. */ #define BT_MESH_PUB_TRANSMIT_INT(transmit) ((((transmit) >> 3) + 1) * 50) /** Model publication context. */ struct bt_mesh_model_pub { /** The model the context belongs to. Initialized by the stack. */ struct bt_mesh_model *mod; u16_t addr; /**< Publish Address. */ u16_t key; /**< Publish AppKey Index. */ u8_t ttl; /**< Publish Time to Live. */ u8_t retransmit; /**< Retransmit Count & Interval Steps. */ u8_t period; /**< Publish Period. */ u8_t period_div:4, /**< Divisor for the Period. */ cred:1, /**< Friendship Credentials Flag. */ fast_period:1,/**< Use FastPeriodDivisor */ count:3; /**< Retransmissions left. */ u32_t period_start; /**< Start of the current period. */ /** @brief Publication buffer, containing the publication message. * * The application is expected to initialize this with * a valid net_buf_simple pointer, with the help of e.g. * the NET_BUF_SIMPLE() macro. The publication buffer must * contain a valid publication message before calling the * bt_mesh_model_publish() API or after the publication's * @ref bt_mesh_model_pub.update callback has been called * and returned success. The buffer must be created outside * of function context, i.e. it must not be on the stack. * This is most conveniently acheived by creating it inline * when declaring the publication context: * * static struct bt_mesh_model_pub my_pub = { * .msg = NET_BUF_SIMPLE(size), * }; */ struct os_mbuf *msg; /** @brief Callback for updating the publication buffer. * * When set to NULL, the model is assumed not to support * periodic publishing. When set to non-NULL the callback * will be called periodically and is expected to update * @ref bt_mesh_model_pub.msg with a valid publication * message. * * @param mod The Model the Publication Context belogs to. * * @return Zero on success or (negative) error code otherwise. */ int (*update)(struct bt_mesh_model *mod); /** Publish Period Timer. Only for stack-internal use. */ struct k_delayed_work timer; }; /** Model callback functions. */ struct bt_mesh_model_cb { /** @brief Set value handler of user data tied to the model. * * @sa settings_handler::h_set * * @param model Model to set the persistent data of. * @param val Data from the backend. * * @return 0 on success, error otherwise. */ int (*const settings_set)(struct bt_mesh_model *model, char *val); /** @brief Callback called when all settings have been loaded. * * This handler gets called after the settings have been loaded in * full. * * @sa settings_handler::h_commit * * @param model Model this callback belongs to. * * @return 0 on success, error otherwise. */ int (*const settings_commit)(struct bt_mesh_model *model); /** @brief Model init callback. * * Called on every model instance during mesh initialization. * * @param model Model to be initialized. * * @return 0 on success, error otherwise. */ int (*const init)(struct bt_mesh_model *model); /** @brief Model reset callback. * * Called when the mesh node is reset. All model data is deleted on * reset, and the model should clear its state. * * @param model Model this callback belongs to. */ void (*const reset)(struct bt_mesh_model *model); }; /** Abstraction that describes a Mesh Model instance */ struct bt_mesh_model { union { const u16_t id; struct { u16_t company; u16_t id; } vnd; }; /* Internal information, mainly for persistent storage */ u8_t elem_idx; /* Belongs to Nth element */ u8_t mod_idx; /* Is the Nth model in the element */ u16_t flags; /* Model flags for internal bookkeeping */ /* Model Publication */ struct bt_mesh_model_pub * const pub; /* AppKey List */ u16_t keys[CONFIG_BT_MESH_MODEL_KEY_COUNT]; /* Subscription List (group or virtual addresses) */ u16_t groups[CONFIG_BT_MESH_MODEL_GROUP_COUNT]; const struct bt_mesh_model_op * const op; /* Model callback structure. */ const struct bt_mesh_model_cb * const cb; #if MYNEWT_VAL(BLE_MESH_MODEL_EXTENSIONS) /* Pointer to the next model in a model extension tree. */ struct bt_mesh_model *next; /* Pointer to the first model this model extends. */ struct bt_mesh_model *extends; #endif /* Model-specific user data */ void *user_data; }; struct bt_mesh_send_cb { void (*start)(u16_t duration, int err, void *cb_data); void (*end)(int err, void *cb_data); }; void bt_mesh_model_msg_init(struct os_mbuf *msg, u32_t opcode); /** Special TTL value to request using configured default TTL */ #define BT_MESH_TTL_DEFAULT 0xff /** Maximum allowed TTL value */ #define BT_MESH_TTL_MAX 0x7f /** * @brief Send an Access Layer message. * * @param model Mesh (client) Model that the message belongs to. * @param ctx Message context, includes keys, TTL, etc. * @param msg Access Layer payload (the actual message to be sent). * @param cb Optional "message sent" callback. * @param cb_data User data to be passed to the callback. * * @return 0 on success, or (negative) error code on failure. */ int bt_mesh_model_send(struct bt_mesh_model *model, struct bt_mesh_msg_ctx *ctx, struct os_mbuf *msg, const struct bt_mesh_send_cb *cb, void *cb_data); /** * @brief Send a model publication message. * * Before calling this function, the user needs to ensure that the model * publication message (@ref bt_mesh_model_pub.msg) contains a valid * message to be sent. Note that this API is only to be used for * non-period publishing. For periodic publishing the app only needs * to make sure that @ref bt_mesh_model_pub.msg contains a valid message * whenever the @ref bt_mesh_model_pub.update callback is called. * * @param model Mesh (client) Model that's publishing the message. * * @return 0 on success, or (negative) error code on failure. */ int bt_mesh_model_publish(struct bt_mesh_model *model); /** * @brief Get the element that a model belongs to. * * @param mod Mesh model. * * @return Pointer to the element that the given model belongs to. */ struct bt_mesh_elem *bt_mesh_model_elem(struct bt_mesh_model *mod); /** @brief Find a SIG model. * * @param elem Element to search for the model in. * @param id Model ID of the model. * * @return A pointer to the Mesh model matching the given parameters, or NULL * if no SIG model with the given ID exists in the given element. */ struct bt_mesh_model *bt_mesh_model_find(const struct bt_mesh_elem *elem, u16_t id); /** @brief Find a vendor model. * * @param elem Element to search for the model in. * @param company Company ID of the model. * @param id Model ID of the model. * * @return A pointer to the Mesh model matching the given parameters, or NULL * if no vendor model with the given ID exists in the given element. */ struct bt_mesh_model *bt_mesh_model_find_vnd(const struct bt_mesh_elem *elem, u16_t company, u16_t id); /** @brief Get whether the model is in the primary element of the device. * * @param mod Mesh model. * * @return true if the model is on the primary element, false otherwise. */ static inline bool bt_mesh_model_in_primary(const struct bt_mesh_model *mod) { return (mod->elem_idx == 0); } /** @brief Immediately store the model's user data in persistent storage. * * @param mod Mesh model. * @param vnd This is a vendor model. * @param data Model data to store, or NULL to delete any model data. * @param data_len Length of the model data. * * @return 0 on success, or (negative) error code on failure. */ int bt_mesh_model_data_store(struct bt_mesh_model *mod, bool vnd, const void *data, size_t data_len); /** @brief Let a model extend another. * * Mesh models may be extended to reuse their functionality, forming a more * complex model. A Mesh model may extend any number of models, in any element. * The extensions may also be nested, ie a model that extends another may itself * be extended. Extensions may not be cyclical, and a model can only be extended * by one other model. * * A set of models that extend each other form a model extension tree. * * All models in an extension tree share one subscription list per element. The * access layer will utilize the combined subscription list of all models in an * extension tree and element, giving the models extended subscription list * capacity. * * @param[in] mod Mesh model. * @param[in] base_mod The model being extended. * * @retval 0 Successfully extended the base_mod model. * @retval -EALREADY The base_mod model is already extended. */ int bt_mesh_model_extend(struct bt_mesh_model *mod, struct bt_mesh_model *base_mod); /** Node Composition */ struct bt_mesh_comp { u16_t cid; u16_t pid; u16_t vid; size_t elem_count; struct bt_mesh_elem *elem; }; #ifdef __cplusplus } #endif /** * @} */ #endif /* __BT_MESH_ACCESS_H */ |