11#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_TBS_H_
12#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_TBS_H_
45#define BT_TBS_CALL_STATE_INCOMING 0x00
50#define BT_TBS_CALL_STATE_DIALING 0x01
52#define BT_TBS_CALL_STATE_ALERTING 0x02
54#define BT_TBS_CALL_STATE_ACTIVE 0x03
59#define BT_TBS_CALL_STATE_LOCALLY_HELD 0x04
64#define BT_TBS_CALL_STATE_REMOTELY_HELD 0x05
66#define BT_TBS_CALL_STATE_LOCALLY_AND_REMOTELY_HELD 0x06
74#define BT_TBS_REASON_BAD_REMOTE_URI 0x00
76#define BT_TBS_REASON_CALL_FAILED 0x01
78#define BT_TBS_REASON_REMOTE_ENDED_CALL 0x02
80#define BT_TBS_REASON_SERVER_ENDED_CALL 0x03
82#define BT_TBS_REASON_LINE_BUSY 0x04
84#define BT_TBS_REASON_NETWORK_CONGESTED 0x05
86#define BT_TBS_REASON_CLIENT_TERMINATED 0x06
88#define BT_TBS_REASON_NO_SERVICE 0x07
90#define BT_TBS_REASON_NO_ANSWER 0x08
92#define BT_TBS_REASON_UNSPECIFIED 0x09
100#define BT_TBS_RESULT_CODE_SUCCESS 0x00
102#define BT_TBS_RESULT_CODE_OPCODE_NOT_SUPPORTED 0x01
104#define BT_TBS_RESULT_CODE_OPERATION_NOT_POSSIBLE 0x02
106#define BT_TBS_RESULT_CODE_INVALID_CALL_INDEX 0x03
111#define BT_TBS_RESULT_CODE_STATE_MISMATCH 0x04
113#define BT_TBS_RESULT_CODE_OUT_OF_RESOURCES 0x05
115#define BT_TBS_RESULT_CODE_INVALID_URI 0x06
126#define BT_TBS_FEATURE_HOLD BIT(0)
128#define BT_TBS_FEATURE_JOIN BIT(1)
130#define BT_TBS_FEATURE_ALL (BT_TBS_FEATURE_HOLD | BT_TBS_FEATURE_JOIN)
138#define BT_TBS_SIGNAL_STRENGTH_NO_SERVICE 0
140#define BT_TBS_SIGNAL_STRENGTH_MAX 100
142#define BT_TBS_SIGNAL_STRENGTH_UNKNOWN 255
150#define BT_TBS_TECHNOLOGY_3G 0x01
152#define BT_TBS_TECHNOLOGY_4G 0x02
154#define BT_TBS_TECHNOLOGY_LTE 0x03
156#define BT_TBS_TECHNOLOGY_WIFI 0x04
158#define BT_TBS_TECHNOLOGY_5G 0x05
160#define BT_TBS_TECHNOLOGY_GSM 0x06
162#define BT_TBS_TECHNOLOGY_CDMA 0x07
164#define BT_TBS_TECHNOLOGY_2G 0x08
166#define BT_TBS_TECHNOLOGY_WCDMA 0x09
174#define BT_TBS_STATUS_FLAG_INBAND_RINGTONE BIT(0)
176#define BT_TBS_STATUS_FLAG_SILENT_MOD BIT(1)
184#define BT_TBS_CALL_FLAG_OUTGOING BIT(0)
186#define BT_TBS_CALL_FLAG_WITHHELD BIT(1)
188#define BT_TBS_CALL_FLAG_WITHHELD_BY_NETWORK BIT(2)
197#define BT_TBS_GTBS_INDEX 0xFF
200struct bt_tbs_instance;
396 const char *from,
const char *friendly_name);
589 uint8_t tbs_count,
bool gtbs_found);
696#if defined(CONFIG_BT_TBS_CLIENT_ORIGINATE_CALL) || defined(__DOXYGEN__)
700#if defined(CONFIG_BT_TBS_CLIENT_TERMINATE_CALL) || defined(__DOXYGEN__)
704#if defined(CONFIG_BT_TBS_CLIENT_HOLD_CALL) || defined(__DOXYGEN__)
708#if defined(CONFIG_BT_TBS_CLIENT_ACCEPT_CALL) || defined(__DOXYGEN__)
712#if defined(CONFIG_BT_TBS_CLIENT_RETRIEVE_CALL) || defined(__DOXYGEN__)
716#if defined(CONFIG_BT_TBS_CLIENT_JOIN_CALLS) || defined(__DOXYGEN__)
720#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME) || defined(__DOXYGEN__)
724#if defined(CONFIG_BT_TBS_CLIENT_BEARER_UCI) || defined(__DOXYGEN__)
728#if defined(CONFIG_BT_TBS_CLIENT_BEARER_TECHNOLOGY) || defined(__DOXYGEN__)
732#if defined(CONFIG_BT_TBS_CLIENT_BEARER_URI_SCHEMES_SUPPORTED_LIST) || defined(__DOXYGEN__)
736#if defined(CONFIG_BT_TBS_CLIENT_BEARER_SIGNAL_STRENGTH) || defined(__DOXYGEN__)
740#if defined(CONFIG_BT_TBS_CLIENT_READ_BEARER_SIGNAL_INTERVAL) || defined(__DOXYGEN__)
744#if defined(CONFIG_BT_TBS_CLIENT_BEARER_LIST_CURRENT_CALLS) || defined(__DOXYGEN__)
748#if defined(CONFIG_BT_TBS_CLIENT_CCID) || defined(__DOXYGEN__)
752#if defined(CONFIG_BT_TBS_CLIENT_INCOMING_URI) || defined(__DOXYGEN__)
756#if defined(CONFIG_BT_TBS_CLIENT_STATUS_FLAGS) || defined(__DOXYGEN__)
762#if defined(CONFIG_BT_TBS_CLIENT_OPTIONAL_OPCODES) || defined(__DOXYGEN__)
768#if defined(CONFIG_BT_TBS_CLIENT_INCOMING_CALL) || defined(__DOXYGEN__)
772#if defined(CONFIG_BT_TBS_CLIENT_CALL_FRIENDLY_NAME) || defined(__DOXYGEN__)
Bluetooth connection handling.
int bt_tbs_remote_retrieve(uint8_t call_index)
Notify the server that the remote party retrieved the call.
int bt_tbs_client_originate_call(struct bt_conn *conn, uint8_t inst_index, const char *uri)
Request to originate a call.
int bt_tbs_accept(uint8_t call_index)
Accept an alerting call.
bool(* bt_tbs_authorize_cb)(struct bt_conn *conn)
Callback function for authorizing a client.
Definition tbs.h:256
int bt_tbs_client_read_bearer_provider_name(struct bt_conn *conn, uint8_t inst_index)
Read the bearer provider name of a TBS instance.
int bt_tbs_join(uint8_t call_index_cnt, uint8_t *call_indexes)
Join calls.
int bt_tbs_client_hold_call(struct bt_conn *conn, uint8_t inst_index, uint8_t call_index)
Request to hold a call.
int bt_tbs_client_terminate_call(struct bt_conn *conn, uint8_t inst_index, uint8_t call_index)
Request to terminate a call.
void(* bt_tbs_client_call_states_cb)(struct bt_conn *conn, int err, uint8_t inst_index, uint8_t call_count, const struct bt_tbs_client_call_state *call_states)
Callback function for ccp_read_call_state.
Definition tbs.h:683
void(* bt_tbs_call_change_cb)(struct bt_conn *conn, uint8_t call_index)
Callback function for client request call state change.
Definition tbs.h:246
int bt_tbs_client_read_signal_interval(struct bt_conn *conn, uint8_t inst_index)
Read the signal strength reporting interval of a TBS instance.
int bt_tbs_client_set_outgoing_uri(struct bt_conn *conn, uint8_t inst_index, const char *uri)
Set the outgoing URI for a TBS instance on the peer device.
void(* bt_tbs_client_cp_cb)(struct bt_conn *conn, int err, uint8_t inst_index, uint8_t call_index)
Callback function for the CCP call control functions.
Definition tbs.h:612
int bt_tbs_client_read_call_uri(struct bt_conn *conn, uint8_t inst_index)
Read the call target URI of a TBS instance.
int bt_tbs_remote_incoming(uint8_t bearer_index, const char *to, const char *from, const char *friendly_name)
Notify the server of an incoming call.
void(* bt_tbs_client_read_string_cb)(struct bt_conn *conn, int err, uint8_t inst_index, const char *value)
Callback function for functions that read a string value.
Definition tbs.h:625
int bt_tbs_set_bearer_provider_name(uint8_t bearer_index, const char *name)
Set a new bearer provider.
int bt_tbs_remote_terminate(uint8_t call_index)
Notify the server that the remote party terminated the call.
int bt_tbs_remote_hold(uint8_t call_index)
Notify the server that the remote party held the call.
void(* bt_tbs_client_read_value_cb)(struct bt_conn *conn, int err, uint8_t inst_index, uint32_t value)
Callback function for functions that read an integer value.
Definition tbs.h:638
bool(* bt_tbs_originate_call_cb)(struct bt_conn *conn, uint8_t call_index, const char *uri)
Callback function for client originating a call.
Definition tbs.h:212
int bt_tbs_client_accept_call(struct bt_conn *conn, uint8_t inst_index, uint8_t call_index)
Accept an incoming call.
void bt_tbs_dbg_print_calls(void)
Prints all calls of all services to the debug log.
void(* bt_tbs_terminate_call_cb)(struct bt_conn *conn, uint8_t call_index, uint8_t reason)
Callback function for client terminating a call.
Definition tbs.h:225
int bt_tbs_client_read_technology(struct bt_conn *conn, uint8_t inst_index)
Read the technology of a TBS instance.
void bt_tbs_register_cb(struct bt_tbs_cb *cbs)
Register the callbacks for TBS.
void(* bt_tbs_client_current_calls_cb)(struct bt_conn *conn, int err, uint8_t inst_index, uint8_t call_count, const struct bt_tbs_client_call *calls)
Callback function for ccp_read_current_calls.
Definition tbs.h:667
int bt_tbs_terminate(uint8_t call_index)
Terminate a call.
int bt_tbs_set_status_flags(uint8_t bearer_index, uint16_t status_flags)
Sets the feature and status value.
int bt_tbs_remote_answer(uint8_t call_index)
Notify the server that the remote party answered the call.
int bt_tbs_client_read_current_calls(struct bt_conn *conn, uint8_t inst_index)
Read the list of current calls of a TBS instance.
int bt_tbs_unregister_bearer(uint8_t bearer_index)
Unregister a Telephone Bearer.
int bt_tbs_set_uri_scheme_list(uint8_t bearer_index, const char **uri_list, uint8_t uri_count)
Sets the URI scheme list of a bearer.
int bt_tbs_register_bearer(const struct bt_tbs_register_param *param)
Register a Telephone Bearer.
int bt_tbs_client_read_friendly_name(struct bt_conn *conn, uint8_t inst_index)
Read the friendly name of a call for a TBS instance.
void(* bt_tbs_client_discover_cb)(struct bt_conn *conn, int err, uint8_t tbs_count, bool gtbs_found)
Callback function for ccp_discover.
Definition tbs.h:588
int bt_tbs_client_read_status_flags(struct bt_conn *conn, uint8_t inst_index)
Read the feature and status value of a TBS instance.
int bt_tbs_client_set_signal_strength_interval(struct bt_conn *conn, uint8_t inst_index, uint8_t interval)
Set the signal strength reporting interval for a TBS instance.
void(* bt_tbs_join_calls_cb)(struct bt_conn *conn, uint8_t call_index_count, const uint8_t *call_indexes)
Callback function for client joining calls.
Definition tbs.h:236
int bt_tbs_client_read_signal_strength(struct bt_conn *conn, uint8_t inst_index)
Read the current signal strength of a TBS instance.
struct bt_tbs_instance * bt_tbs_client_get_by_ccid(const struct bt_conn *conn, uint8_t ccid)
Look up Telephone Bearer Service instance by CCID.
int bt_tbs_client_join_calls(struct bt_conn *conn, uint8_t inst_index, const uint8_t *call_indexes, uint8_t count)
Join multiple calls.
int bt_tbs_client_read_remote_uri(struct bt_conn *conn, uint8_t inst_index)
Read the remote URI of a TBS instance.
int bt_tbs_hold(uint8_t call_index)
Hold a call.
void(* bt_tbs_client_termination_reason_cb)(struct bt_conn *conn, int err, uint8_t inst_index, uint8_t call_index, uint8_t reason)
Callback function for ccp_read_termination_reason.
Definition tbs.h:651
int bt_tbs_client_read_bearer_uci(struct bt_conn *conn, uint8_t inst_index)
Read the UCI of a TBS instance.
int bt_tbs_client_retrieve_call(struct bt_conn *conn, uint8_t inst_index, uint8_t call_index)
Retrieve call from (local) hold.
int bt_tbs_client_register_cb(struct bt_tbs_client_cb *cbs)
Register the callbacks for CCP.
int bt_tbs_client_read_ccid(struct bt_conn *conn, uint8_t inst_index)
Read the content ID of a TBS instance.
int bt_tbs_set_signal_strength(uint8_t bearer_index, uint8_t new_signal_strength)
Update the signal strength reported by the server.
int bt_tbs_client_discover(struct bt_conn *conn)
Discover TBS for a connection.
int bt_tbs_retrieve(uint8_t call_index)
Retrieve a call.
int bt_tbs_client_read_uri_list(struct bt_conn *conn, uint8_t inst_index)
Read the URI schemes list of a TBS instance.
int bt_tbs_originate(uint8_t bearer_index, char *uri, uint8_t *call_index)
Originate a call.
int bt_tbs_set_bearer_technology(uint8_t bearer_index, uint8_t new_technology)
Set a new bearer technology.
int bt_tbs_client_read_optional_opcodes(struct bt_conn *conn, uint8_t inst_index)
Read the supported opcode of a TBS instance.
void(* bt_tbs_client_write_value_cb)(struct bt_conn *conn, int err, uint8_t inst_index)
Callback function for writing values to peer device.
Definition tbs.h:599
int bt_tbs_client_read_call_state(struct bt_conn *conn, uint8_t inst_index)
Read the states of the current calls of a TBS instance.
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define bool
Definition stdbool.h:13
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Struct to hold the Telephone Bearer Service callbacks.
Definition tbs.h:263
bt_tbs_originate_call_cb originate_call
Client originating call.
Definition tbs.h:265
bt_tbs_call_change_cb accept_call
Client accepting call.
Definition tbs.h:271
bt_tbs_call_change_cb hold_call
Client holding call.
Definition tbs.h:269
bt_tbs_terminate_call_cb terminate_call
Client terminating call.
Definition tbs.h:267
bt_tbs_authorize_cb authorize
Callback to authorize a client.
Definition tbs.h:277
bt_tbs_join_calls_cb join_calls
Client joining calls.
Definition tbs.h:275
bt_tbs_call_change_cb retrieve_call
Client retrieving call.
Definition tbs.h:273
Struct to hold a call state.
Definition tbs.h:561
uint8_t index
Index of the call.
Definition tbs.h:563
uint8_t state
State of the call (see BT_TBS_CALL_STATE_*)
Definition tbs.h:565
uint8_t flags
Call flags (see BT_TBS_CALL_FLAG_*)
Definition tbs.h:567
Struct to hold a call as the Telephone Bearer Service client.
Definition tbs.h:571
struct bt_tbs_client_call_state call_info
Call information.
Definition tbs.h:573
char * remote_uri
The remove URI.
Definition tbs.h:575
Struct to hold the Telephone Bearer Service client callbacks.
Definition tbs.h:693
bt_tbs_client_read_value_cb signal_interval
Bearer signal interval has been read.
Definition tbs.h:742
bt_tbs_client_cp_cb originate_call
Originate call has completed.
Definition tbs.h:698
bt_tbs_client_current_calls_cb current_calls
Bearer current calls has been read.
Definition tbs.h:746
bt_tbs_client_read_string_cb bearer_uci
Bearer UCI has been read.
Definition tbs.h:726
bt_tbs_client_cp_cb retrieve_call
Retrieve call has completed.
Definition tbs.h:714
bt_tbs_client_cp_cb join_calls
Join calls has completed.
Definition tbs.h:718
bt_tbs_client_cp_cb hold_call
Hold call has completed.
Definition tbs.h:706
bt_tbs_client_read_string_cb remote_uri
Bearer remote URI has been read.
Definition tbs.h:770
bt_tbs_client_read_string_cb bearer_provider_name
Bearer provider name has been read.
Definition tbs.h:722
bt_tbs_client_cp_cb accept_call
Accept call has completed.
Definition tbs.h:710
bt_tbs_client_read_string_cb uri_list
Bearer URI list has been read.
Definition tbs.h:734
bt_tbs_client_read_value_cb technology
Bearer technology has been read.
Definition tbs.h:730
bt_tbs_client_call_states_cb call_state
Bearer call states has been read.
Definition tbs.h:761
bt_tbs_client_read_value_cb ccid
Bearer CCID has been read.
Definition tbs.h:750
bt_tbs_client_read_value_cb optional_opcodes
Bearer optional opcodes has been read.
Definition tbs.h:764
bt_tbs_client_read_value_cb status_flags
Bearer status flags has been read.
Definition tbs.h:758
bt_tbs_client_read_value_cb signal_strength
Bearer signal strength has been read.
Definition tbs.h:738
bt_tbs_client_cp_cb terminate_call
Terminate call has completed.
Definition tbs.h:702
bt_tbs_client_discover_cb discover
Discovery has completed.
Definition tbs.h:695
bt_tbs_client_read_string_cb friendly_name
Bearer friendly name has been read.
Definition tbs.h:774
bt_tbs_client_termination_reason_cb termination_reason
Bearer terminate reason has been read.
Definition tbs.h:767
bt_tbs_client_read_string_cb call_uri
Bearer call URI has been read.
Definition tbs.h:754
uint8_t technology
The technology of the bearer.
Definition tbs.h:504
uint8_t supported_features
The optional supported features of the bearer.
Definition tbs.h:511
char * uri_schemes_supported
The Uniform Resource Identifiers schemes supported by this bearer as an UTF-8 string.
Definition tbs.h:482
char * provider_name
The name of the provider, for example a cellular service provider.
Definition tbs.h:467
bool gtbs
Whether this bearer shall be registered as a Generic Telephone Bearer server.
Definition tbs.h:490
char * uci
The Uniform Caller Identifier of the bearer.
Definition tbs.h:474
bool authorization_required
Whether the application will need to authorize changes to calls.
Definition tbs.h:497