@@ -2321,7 +2321,13 @@ struct bt_bap_broadcast_assistant_cb {
2321
2321
* new connection, will delete all previous data.
2322
2322
*
2323
2323
* @param conn The connection
2324
- * @return int Error value. 0 on success, GATT error or ERRNO on fail.
2324
+ *
2325
+ * @retval 0 Success
2326
+ * @retval -EINVAL @p conn is NULL
2327
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2328
+ * @retval -ENOTCONN @p conn is not connected
2329
+ * @retval -ENOMEM Could not allocated memory for the request
2330
+ * @retval -ENOEXEC Unexpected GATT error
2325
2331
*/
2326
2332
int bt_bap_broadcast_assistant_discover (struct bt_conn * conn );
2327
2333
@@ -2340,7 +2346,14 @@ int bt_bap_broadcast_assistant_discover(struct bt_conn *conn);
2340
2346
* Used to let the server know that we are scanning.
2341
2347
* @param start_scan Start scanning if true. If false, the application should
2342
2348
* enable scan itself.
2343
- * @return int Error value. 0 on success, GATT error or ERRNO on fail.
2349
+
2350
+ * @retval 0 Success
2351
+ * @retval -EINVAL @p conn is NULL of if @p conn has not done discovery
2352
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2353
+ * @retval -EAGAIN Bluetooth has not been enabled.
2354
+ * @retval -ENOTCONN @p conn is not connected
2355
+ * @retval -ENOMEM Could not allocated memory for the request
2356
+ * @retval -ENOEXEC Unexpected scan or GATT error
2344
2357
*/
2345
2358
int bt_bap_broadcast_assistant_scan_start (struct bt_conn * conn ,
2346
2359
bool start_scan );
@@ -2349,7 +2362,14 @@ int bt_bap_broadcast_assistant_scan_start(struct bt_conn *conn,
2349
2362
* @brief Stop remote scanning for BISes for a server.
2350
2363
*
2351
2364
* @param conn Connection to the server.
2352
- * @return int Error value. 0 on success, GATT error or ERRNO on fail.
2365
+
2366
+ * @retval 0 Success
2367
+ * @retval -EINVAL @p conn is NULL of if @p conn has not done discovery
2368
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2369
+ * @retval -EAGAIN Bluetooth has not been enabled.
2370
+ * @retval -ENOTCONN @p conn is not connected
2371
+ * @retval -ENOMEM Could not allocated memory for the request
2372
+ * @retval -ENOEXEC Unexpected scan or GATT error
2353
2373
*/
2354
2374
int bt_bap_broadcast_assistant_scan_stop (struct bt_conn * conn );
2355
2375
@@ -2410,7 +2430,12 @@ struct bt_bap_broadcast_assistant_add_src_param {
2410
2430
* @param conn Connection to the server.
2411
2431
* @param param Parameter struct.
2412
2432
*
2413
- * @return Error value. 0 on success, GATT error or ERRNO on fail.
2433
+ * @retval 0 Success
2434
+ * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or if @p param is invalid
2435
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2436
+ * @retval -ENOTCONN @p conn is not connected
2437
+ * @retval -ENOMEM Could not allocated memory for the request
2438
+ * @retval -ENOEXEC Unexpected scan or GATT error
2414
2439
*/
2415
2440
int bt_bap_broadcast_assistant_add_src (
2416
2441
struct bt_conn * conn , const struct bt_bap_broadcast_assistant_add_src_param * param );
@@ -2443,7 +2468,12 @@ struct bt_bap_broadcast_assistant_mod_src_param {
2443
2468
* @param conn Connection to the server.
2444
2469
* @param param Parameter struct.
2445
2470
*
2446
- * @return Error value. 0 on success, GATT error or ERRNO on fail.
2471
+ * @retval 0 Success
2472
+ * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or if @p param is invalid
2473
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2474
+ * @retval -ENOTCONN @p conn is not connected
2475
+ * @retval -ENOMEM Could not allocated memory for the request
2476
+ * @retval -ENOEXEC Unexpected scan or GATT error
2447
2477
*/
2448
2478
int bt_bap_broadcast_assistant_mod_src (
2449
2479
struct bt_conn * conn , const struct bt_bap_broadcast_assistant_mod_src_param * param );
@@ -2455,7 +2485,12 @@ int bt_bap_broadcast_assistant_mod_src(
2455
2485
* @param src_id Source ID of the receive state.
2456
2486
* @param broadcast_code The broadcast code.
2457
2487
*
2458
- * @return Error value. 0 on success, GATT error or ERRNO on fail.
2488
+ * @retval 0 Success
2489
+ * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2490
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2491
+ * @retval -ENOTCONN @p conn is not connected
2492
+ * @retval -ENOMEM Could not allocated memory for the request
2493
+ * @retval -ENOEXEC Unexpected scan or GATT error
2459
2494
*/
2460
2495
int bt_bap_broadcast_assistant_set_broadcast_code (
2461
2496
struct bt_conn * conn , uint8_t src_id ,
@@ -2467,7 +2502,12 @@ int bt_bap_broadcast_assistant_set_broadcast_code(
2467
2502
* @param conn Connection to the server.
2468
2503
* @param src_id Source ID of the receive state.
2469
2504
*
2470
- * @return Error value. 0 on success, GATT error or ERRNO on fail.
2505
+ * @retval 0 Success
2506
+ * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2507
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2508
+ * @retval -ENOTCONN @p conn is not connected
2509
+ * @retval -ENOMEM Could not allocated memory for the request
2510
+ * @retval -ENOEXEC Unexpected scan or GATT error
2471
2511
*/
2472
2512
int bt_bap_broadcast_assistant_rem_src (struct bt_conn * conn , uint8_t src_id );
2473
2513
@@ -2478,7 +2518,12 @@ int bt_bap_broadcast_assistant_rem_src(struct bt_conn *conn, uint8_t src_id);
2478
2518
* @param idx The index of the receive start (0 up to the value from
2479
2519
* bt_bap_broadcast_assistant_discover_cb)
2480
2520
*
2481
- * @return Error value. 0 on success, GATT error or ERRNO on fail.
2521
+ * @retval 0 Success
2522
+ * @retval -EINVAL @p conn is NULL or %p conn has not done discovery or @p src_id is invalid
2523
+ * @retval -EBUSY Another operation is already in progress for this @p conn
2524
+ * @retval -ENOTCONN @p conn is not connected
2525
+ * @retval -ENOMEM Could not allocated memory for the request
2526
+ * @retval -ENOEXEC Unexpected scan or GATT error
2482
2527
*/
2483
2528
int bt_bap_broadcast_assistant_read_recv_state (struct bt_conn * conn , uint8_t idx );
2484
2529
0 commit comments