Skip to content

Commit 14caa79

Browse files
Thalleynashif
authored andcommitted
Bluetooth: TMAP: Add missing documentation in tmap.h
Add missing documentation for some defintions in tmap.h Signed-off-by: Emil Gydesen <[email protected]>
1 parent 1751a7f commit 14caa79

File tree

1 file changed

+49
-8
lines changed
  • include/zephyr/bluetooth/audio

1 file changed

+49
-8
lines changed

include/zephyr/bluetooth/audio/tmap.h

Lines changed: 49 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
/** @file
2-
* @brief Header for Bluetooth TMAP.
1+
/**
2+
* @file
3+
* @brief Header for Bluetooth TMAP.
34
*
45
* Copyright 2023 NXP
6+
* Copyright (c) 2024 Nordic Semiconductor ASA
57
*
68
* SPDX-License-Identifier: Apache-2.0
79
*/
@@ -47,24 +49,63 @@
4749

4850
/** @brief TMAP Role characteristic */
4951
enum bt_tmap_role {
52+
/**
53+
* @brief TMAP Call Gateway role
54+
*
55+
* This role is defined to telephone and VoIP applications using the Call Control Profile
56+
* to control calls on a remote TMAP Call Terminal.
57+
* Audio streams in this role are typically bi-directional.
58+
*/
5059
BT_TMAP_ROLE_CG = BIT(0),
60+
/**
61+
* @brief TMAP Call Terminal role
62+
*
63+
* This role is defined to telephone and VoIP applications using the Call Control Profile
64+
* to expose calls to remote TMAP Call Gateways.
65+
* Audio streams in this role are typically bi-directional.
66+
*/
5167
BT_TMAP_ROLE_CT = BIT(1),
68+
/**
69+
* @brief TMAP Unicast Media Sender role
70+
*
71+
* This role is defined send media audio to TMAP Unicast Media Receivers.
72+
* Audio streams in this role are typically uni-directional.
73+
*/
5274
BT_TMAP_ROLE_UMS = BIT(2),
75+
/**
76+
* @brief TMAP Unicast Media Receiver role
77+
*
78+
* This role is defined receive media audio to TMAP Unicast Media Senders.
79+
* Audio streams in this role are typically uni-directional.
80+
*/
5381
BT_TMAP_ROLE_UMR = BIT(3),
82+
/**
83+
* @brief TMAP Broadcast Media Sender role
84+
*
85+
* This role is defined send media audio to TMAP Broadcast Media Receivers.
86+
* Audio streams in this role are always uni-directional.
87+
*/
5488
BT_TMAP_ROLE_BMS = BIT(4),
89+
/**
90+
* @brief TMAP Broadcast Media Receiver role
91+
*
92+
* This role is defined send media audio to TMAP Broadcast Media Senders.
93+
* Audio streams in this role are always uni-directional.
94+
*/
5595
BT_TMAP_ROLE_BMR = BIT(5),
5696
};
5797

5898
/** @brief TMAP callback structure. */
5999
struct bt_tmap_cb {
60-
/** @brief TMAP discovery complete callback
100+
/**
101+
* @brief TMAP discovery complete callback
61102
*
62-
* This callback notifies the application about the value of the
63-
* TMAP Role characteristic on the peer.
103+
* This callback notifies the application about the value of the
104+
* TMAP Role characteristic on the peer.
64105
*
65-
* @param role Peer TMAP role(s).
66-
* @param conn Pointer to the connection
67-
* @param err 0 if success, ATT error received from server otherwise.
106+
* @param role Peer TMAP role(s).
107+
* @param conn Pointer to the connection
108+
* @param err 0 if success, ATT error received from server otherwise.
68109
*/
69110
void (*discovery_complete)(enum bt_tmap_role role, struct bt_conn *conn, int err);
70111
};

0 commit comments

Comments
 (0)