Skip to content

Commit

Permalink
bluetooth: fast_pair: fmdn: improve callback API doc
Browse files Browse the repository at this point in the history
Improved the documentation for the callback registrations APIs in the
Fast Pair FMDN header.

Ref: NCSDK-30487

Signed-off-by: Kamil Piszczek <[email protected]>
  • Loading branch information
kapi-no committed Jan 8, 2025
1 parent 59be6ed commit 0825ffb
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions include/bluetooth/services/fast_pair/fmdn.h
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@
* @defgroup bt_fast_pair_fmdn Fast Pair FMDN API
* @brief Fast Pair FMDN API
*
* It is required to use the Fast Pair FMDN API in the cooperative thread context
* (for example, system workqueue thread). Following this requirement guarantees
* a proper synchronization between the user operations and the module operations.
* It is required to use the Fast Pair FMDN API in the cooperative thread context.
* API function exceptions that do not follow this rule mention alternative requirements
* explicitly in their API documentation. Following the cooperative thread context
* requirement guarantees proper synchronization between the user operations and the
* module operations.
*
* @{
*/
Expand Down Expand Up @@ -234,6 +236,9 @@ struct bt_fast_pair_fmdn_ring_cb {
* You can call this function only in the disabled state of the FMDN module
* (see @ref bt_fast_pair_is_ready function).
*
* This function must be called in the cooperative thread context or in the system initialization
* context (@ref SYS_INIT macro).
*
* @param cb Ringing callback structure.
*
* @return 0 if the operation was successful. Otherwise, a (negative) error code is returned.
Expand Down Expand Up @@ -355,6 +360,9 @@ struct bt_fast_pair_fmdn_motion_detector_cb {
* You can call this function only in the disabled state of the FMDN module
* (see @ref bt_fast_pair_is_ready function).
*
* This function must be called in the cooperative thread context or in the system initialization
* context (@ref SYS_INIT macro).
*
* @param cb Motion detector callback structure.
*
* @return 0 if the operation was successful. Otherwise, a (negative) error code is returned.
Expand Down Expand Up @@ -529,6 +537,9 @@ struct bt_fast_pair_fmdn_info_cb {
* This API for callback registration is optional and does not have to be used. You can
* register multiple instances of information callbacks.
*
* This function must be called in the cooperative thread context or in the system initialization
* context (@ref SYS_INIT macro).
*
* @param cb Information callback structure.
*
* @return 0 if the operation was successful. Otherwise, a (negative) error code is returned.
Expand Down Expand Up @@ -565,6 +576,9 @@ struct bt_fast_pair_fmdn_read_mode_cb {
* You can call this function only in the disabled state of the FMDN module
* (see @ref bt_fast_pair_is_ready function).
*
* This function must be called in the cooperative thread context or in the system initialization
* context (@ref SYS_INIT macro).
*
* @param cb Read mode callback structure.
*
* @return 0 if the operation was successful. Otherwise, a (negative) error code is returned.
Expand Down

0 comments on commit 0825ffb

Please sign in to comment.