|
14 | 14 | * @defgroup bt_fast_pair_fmdn Fast Pair FMDN API |
15 | 15 | * @brief Fast Pair FMDN API |
16 | 16 | * |
17 | | - * It is required to use the Fast Pair FMDN API in the cooperative thread context |
18 | | - * (for example, system workqueue thread). Following this requirement guarantees |
19 | | - * a proper synchronization between the user operations and the module operations. |
| 17 | + * It is required to use the Fast Pair FMDN API in the cooperative thread context. |
| 18 | + * API function exceptions that do not follow this rule mention alternative requirements |
| 19 | + * explicitly in their API documentation. Following the cooperative thread context |
| 20 | + * requirement guarantees proper synchronization between the user operations and the |
| 21 | + * module operations. |
20 | 22 | * |
21 | 23 | * @{ |
22 | 24 | */ |
@@ -234,6 +236,9 @@ struct bt_fast_pair_fmdn_ring_cb { |
234 | 236 | * You can call this function only in the disabled state of the FMDN module |
235 | 237 | * (see @ref bt_fast_pair_is_ready function). |
236 | 238 | * |
| 239 | + * This function must be called in the cooperative thread context or in the system initialization |
| 240 | + * context (@ref SYS_INIT macro). |
| 241 | + * |
237 | 242 | * @param cb Ringing callback structure. |
238 | 243 | * |
239 | 244 | * @return 0 if the operation was successful. Otherwise, a (negative) error code is returned. |
@@ -355,6 +360,9 @@ struct bt_fast_pair_fmdn_motion_detector_cb { |
355 | 360 | * You can call this function only in the disabled state of the FMDN module |
356 | 361 | * (see @ref bt_fast_pair_is_ready function). |
357 | 362 | * |
| 363 | + * This function must be called in the cooperative thread context or in the system initialization |
| 364 | + * context (@ref SYS_INIT macro). |
| 365 | + * |
358 | 366 | * @param cb Motion detector callback structure. |
359 | 367 | * |
360 | 368 | * @return 0 if the operation was successful. Otherwise, a (negative) error code is returned. |
@@ -529,6 +537,9 @@ struct bt_fast_pair_fmdn_info_cb { |
529 | 537 | * This API for callback registration is optional and does not have to be used. You can |
530 | 538 | * register multiple instances of information callbacks. |
531 | 539 | * |
| 540 | + * This function must be called in the cooperative thread context or in the system initialization |
| 541 | + * context (@ref SYS_INIT macro). |
| 542 | + * |
532 | 543 | * @param cb Information callback structure. |
533 | 544 | * |
534 | 545 | * @return 0 if the operation was successful. Otherwise, a (negative) error code is returned. |
@@ -565,6 +576,9 @@ struct bt_fast_pair_fmdn_read_mode_cb { |
565 | 576 | * You can call this function only in the disabled state of the FMDN module |
566 | 577 | * (see @ref bt_fast_pair_is_ready function). |
567 | 578 | * |
| 579 | + * This function must be called in the cooperative thread context or in the system initialization |
| 580 | + * context (@ref SYS_INIT macro). |
| 581 | + * |
568 | 582 | * @param cb Read mode callback structure. |
569 | 583 | * |
570 | 584 | * @return 0 if the operation was successful. Otherwise, a (negative) error code is returned. |
|
0 commit comments