Skip to content

Commit 0825ffb

Browse files
committed
bluetooth: fast_pair: fmdn: improve callback API doc
Improved the documentation for the callback registrations APIs in the Fast Pair FMDN header. Ref: NCSDK-30487 Signed-off-by: Kamil Piszczek <[email protected]>
1 parent 59be6ed commit 0825ffb

File tree

1 file changed

+17
-3
lines changed
  • include/bluetooth/services/fast_pair

1 file changed

+17
-3
lines changed

include/bluetooth/services/fast_pair/fmdn.h

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414
* @defgroup bt_fast_pair_fmdn Fast Pair FMDN API
1515
* @brief Fast Pair FMDN API
1616
*
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.
2022
*
2123
* @{
2224
*/
@@ -234,6 +236,9 @@ struct bt_fast_pair_fmdn_ring_cb {
234236
* You can call this function only in the disabled state of the FMDN module
235237
* (see @ref bt_fast_pair_is_ready function).
236238
*
239+
* This function must be called in the cooperative thread context or in the system initialization
240+
* context (@ref SYS_INIT macro).
241+
*
237242
* @param cb Ringing callback structure.
238243
*
239244
* @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 {
355360
* You can call this function only in the disabled state of the FMDN module
356361
* (see @ref bt_fast_pair_is_ready function).
357362
*
363+
* This function must be called in the cooperative thread context or in the system initialization
364+
* context (@ref SYS_INIT macro).
365+
*
358366
* @param cb Motion detector callback structure.
359367
*
360368
* @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 {
529537
* This API for callback registration is optional and does not have to be used. You can
530538
* register multiple instances of information callbacks.
531539
*
540+
* This function must be called in the cooperative thread context or in the system initialization
541+
* context (@ref SYS_INIT macro).
542+
*
532543
* @param cb Information callback structure.
533544
*
534545
* @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 {
565576
* You can call this function only in the disabled state of the FMDN module
566577
* (see @ref bt_fast_pair_is_ready function).
567578
*
579+
* This function must be called in the cooperative thread context or in the system initialization
580+
* context (@ref SYS_INIT macro).
581+
*
568582
* @param cb Read mode callback structure.
569583
*
570584
* @return 0 if the operation was successful. Otherwise, a (negative) error code is returned.

0 commit comments

Comments
 (0)