tbs.h

Go to the documentation of this file.

 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_TBS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_TBS_H_

 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/conn.h>
#include <zephyr/sys/slist.h>
#include <zephyr/sys/util_macro.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define BT_TBS_ERR_VAL_CHANGED 0x80

#define BT_TBS_CALL_STATE_INCOMING                      0x00
#define BT_TBS_CALL_STATE_DIALING                       0x01
#define BT_TBS_CALL_STATE_ALERTING                      0x02
#define BT_TBS_CALL_STATE_ACTIVE                        0x03
#define BT_TBS_CALL_STATE_LOCALLY_HELD                  0x04
#define BT_TBS_CALL_STATE_REMOTELY_HELD                 0x05
#define BT_TBS_CALL_STATE_LOCALLY_AND_REMOTELY_HELD     0x06

#define BT_TBS_REASON_BAD_REMOTE_URI                    0x00
#define BT_TBS_REASON_CALL_FAILED                       0x01
#define BT_TBS_REASON_REMOTE_ENDED_CALL                 0x02
#define BT_TBS_REASON_SERVER_ENDED_CALL                 0x03
#define BT_TBS_REASON_LINE_BUSY                         0x04
#define BT_TBS_REASON_NETWORK_CONGESTED                 0x05
#define BT_TBS_REASON_CLIENT_TERMINATED                 0x06
#define BT_TBS_REASON_NO_SERVICE                        0x07
#define BT_TBS_REASON_NO_ANSWER                         0x08
#define BT_TBS_REASON_UNSPECIFIED                       0x09

#define BT_TBS_RESULT_CODE_SUCCESS                0x00
#define BT_TBS_RESULT_CODE_OPCODE_NOT_SUPPORTED   0x01
#define BT_TBS_RESULT_CODE_OPERATION_NOT_POSSIBLE 0x02
#define BT_TBS_RESULT_CODE_INVALID_CALL_INDEX     0x03
#define BT_TBS_RESULT_CODE_STATE_MISMATCH         0x04
#define BT_TBS_RESULT_CODE_OUT_OF_RESOURCES       0x05
#define BT_TBS_RESULT_CODE_INVALID_URI            0x06

#define BT_TBS_FEATURE_HOLD BIT(0)
#define BT_TBS_FEATURE_JOIN BIT(1)
#define BT_TBS_FEATURE_ALL  (BT_TBS_FEATURE_HOLD | BT_TBS_FEATURE_JOIN)

#define BT_TBS_SIGNAL_STRENGTH_NO_SERVICE               0
#define BT_TBS_SIGNAL_STRENGTH_MAX                      100
#define BT_TBS_SIGNAL_STRENGTH_UNKNOWN                  255

#define BT_TBS_TECHNOLOGY_3G                       0x01
#define BT_TBS_TECHNOLOGY_4G                       0x02
#define BT_TBS_TECHNOLOGY_LTE                      0x03
#define BT_TBS_TECHNOLOGY_WIFI                     0x04
#define BT_TBS_TECHNOLOGY_5G                       0x05
#define BT_TBS_TECHNOLOGY_GSM                      0x06
#define BT_TBS_TECHNOLOGY_CDMA                     0x07
#define BT_TBS_TECHNOLOGY_2G                       0x08
#define BT_TBS_TECHNOLOGY_WCDMA                    0x09

#define BT_TBS_STATUS_FLAG_INBAND_RINGTONE BIT(0)
#define BT_TBS_STATUS_FLAG_SILENT_MOD      BIT(1)

#define BT_TBS_CALL_FLAG_OUTGOING            BIT(0)
#define BT_TBS_CALL_FLAG_WITHHELD            BIT(1)
#define BT_TBS_CALL_FLAG_WITHHELD_BY_NETWORK BIT(2)

#define BT_TBS_GTBS_INDEX 0xFF

#define BT_TBS_MAX_UCI_SIZE 6

struct bt_tbs_instance;

typedef bool (*bt_tbs_originate_call_cb)(struct bt_conn *conn,
                                         uint8_t call_index,
                                         const char *uri);

typedef void (*bt_tbs_terminate_call_cb)(struct bt_conn *conn,
                                         uint8_t call_index,
                                         uint8_t reason);

typedef void (*bt_tbs_join_calls_cb)(struct bt_conn *conn,
                                     uint8_t call_index_count,
                                     const uint8_t *call_indexes);

typedef void (*bt_tbs_call_change_cb)(struct bt_conn *conn,
                                      uint8_t call_index);

typedef bool (*bt_tbs_authorize_cb)(struct bt_conn *conn);

struct bt_tbs_cb {
        bt_tbs_originate_call_cb      originate_call;
        bt_tbs_terminate_call_cb      terminate_call;
        bt_tbs_call_change_cb         hold_call;
        bt_tbs_call_change_cb         accept_call;
        bt_tbs_call_change_cb         retrieve_call;
        bt_tbs_join_calls_cb          join_calls;
        bt_tbs_authorize_cb           authorize;
};

int bt_tbs_accept(uint8_t call_index);

int bt_tbs_hold(uint8_t call_index);

int bt_tbs_retrieve(uint8_t call_index);

int bt_tbs_terminate(uint8_t call_index);

int bt_tbs_originate(uint8_t bearer_index, char *uri, uint8_t *call_index);

int bt_tbs_join(uint8_t call_index_cnt, uint8_t *call_indexes);

int bt_tbs_remote_answer(uint8_t call_index);

int bt_tbs_remote_hold(uint8_t call_index);

int bt_tbs_remote_retrieve(uint8_t call_index);

int bt_tbs_remote_terminate(uint8_t call_index);

int bt_tbs_remote_incoming(uint8_t bearer_index, const char *to,
                           const char *from, const char *friendly_name);

int bt_tbs_set_bearer_provider_name(uint8_t bearer_index, const char *name);

int bt_tbs_set_bearer_technology(uint8_t bearer_index, uint8_t new_technology);

int bt_tbs_set_signal_strength(uint8_t bearer_index,
                               uint8_t new_signal_strength);

int bt_tbs_set_status_flags(uint8_t bearer_index, uint16_t status_flags);

int bt_tbs_set_uri_scheme_list(uint8_t bearer_index, const char *uri_scheme_list);
void bt_tbs_register_cb(struct bt_tbs_cb *cbs);

struct bt_tbs_register_param {
        char *provider_name;

        char *uci;

        char *uri_schemes_supported;

        bool gtbs;

        bool authorization_required;

        uint8_t technology;

        uint8_t supported_features;
};

int bt_tbs_register_bearer(const struct bt_tbs_register_param *param);

int bt_tbs_unregister_bearer(uint8_t bearer_index);

void bt_tbs_dbg_print_calls(void);

struct bt_tbs_client_call_state {
        uint8_t index;
        uint8_t state;
        uint8_t flags;
} __packed;

struct bt_tbs_client_call {
        struct bt_tbs_client_call_state call_info;
        char *remote_uri;
};

typedef void (*bt_tbs_client_discover_cb)(struct bt_conn *conn, int err,
                                          uint8_t tbs_count, bool gtbs_found);

typedef void (*bt_tbs_client_write_value_cb)(struct bt_conn *conn, int err,
                                             uint8_t inst_index);

typedef void (*bt_tbs_client_cp_cb)(struct bt_conn *conn, int err,
                                    uint8_t inst_index, uint8_t call_index);

typedef void (*bt_tbs_client_read_string_cb)(struct bt_conn *conn, int err,
                                             uint8_t inst_index,
                                             const char *value);

typedef void (*bt_tbs_client_read_value_cb)(struct bt_conn *conn, int err,
                                            uint8_t inst_index, uint32_t value);

typedef void (*bt_tbs_client_termination_reason_cb)(struct bt_conn *conn,
                                                    int err, uint8_t inst_index,
                                                    uint8_t call_index,
                                                    uint8_t reason);

typedef 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);

typedef 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);

struct bt_tbs_client_cb {
        bt_tbs_client_discover_cb            discover;
#if defined(CONFIG_BT_TBS_CLIENT_ORIGINATE_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  originate_call;
#endif /* defined(CONFIG_BT_TBS_CLIENT_ORIGINATE_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_TERMINATE_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  terminate_call;
#endif /* defined(CONFIG_BT_TBS_CLIENT_TERMINATE_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_HOLD_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  hold_call;
#endif /* defined(CONFIG_BT_TBS_CLIENT_HOLD_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_ACCEPT_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  accept_call;
#endif /* defined(CONFIG_BT_TBS_CLIENT_ACCEPT_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_RETRIEVE_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  retrieve_call;
#endif /* defined(CONFIG_BT_TBS_CLIENT_RETRIEVE_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_JOIN_CALLS) || defined(__DOXYGEN__)
        bt_tbs_client_cp_cb                  join_calls;
#endif /* defined(CONFIG_BT_TBS_CLIENT_JOIN_CALLS) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         bearer_provider_name;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_UCI) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         bearer_uci;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_UCI) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_TECHNOLOGY) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          technology;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_TECHNOLOGY) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_URI_SCHEMES_SUPPORTED_LIST) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         uri_list;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_URI_SCHEMES_SUPPORTED_LIST) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_SIGNAL_STRENGTH) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          signal_strength;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_SIGNAL_STRENGTH) */
#if defined(CONFIG_BT_TBS_CLIENT_READ_BEARER_SIGNAL_INTERVAL) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          signal_interval;
#endif /* defined(CONFIG_BT_TBS_CLIENT_READ_BEARER_SIGNAL_INTERVAL) */
#if defined(CONFIG_BT_TBS_CLIENT_BEARER_LIST_CURRENT_CALLS) || defined(__DOXYGEN__)
        bt_tbs_client_current_calls_cb       current_calls;
#endif /* defined(CONFIG_BT_TBS_CLIENT_BEARER_LIST_CURRENT_CALLS) */
#if defined(CONFIG_BT_TBS_CLIENT_CCID) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          ccid;
#endif /* defined(CONFIG_BT_TBS_CLIENT_CCID) */
#if defined(CONFIG_BT_TBS_CLIENT_INCOMING_URI) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         call_uri;
#endif /* defined(CONFIG_BT_TBS_CLIENT_INCOMING_URI) */
#if defined(CONFIG_BT_TBS_CLIENT_STATUS_FLAGS) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          status_flags;
#endif /* defined(CONFIG_BT_TBS_CLIENT_STATUS_FLAGS) */
        bt_tbs_client_call_states_cb         call_state;
#if defined(CONFIG_BT_TBS_CLIENT_OPTIONAL_OPCODES) || defined(__DOXYGEN__)
        bt_tbs_client_read_value_cb          optional_opcodes;
#endif /* defined(CONFIG_BT_TBS_CLIENT_OPTIONAL_OPCODES) */
        bt_tbs_client_termination_reason_cb  termination_reason;
#if defined(CONFIG_BT_TBS_CLIENT_INCOMING_CALL) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         remote_uri;
#endif /* defined(CONFIG_BT_TBS_CLIENT_INCOMING_CALL) */
#if defined(CONFIG_BT_TBS_CLIENT_CALL_FRIENDLY_NAME) || defined(__DOXYGEN__)
        bt_tbs_client_read_string_cb         friendly_name;
#endif /* defined(CONFIG_BT_TBS_CLIENT_CALL_FRIENDLY_NAME) */

        sys_snode_t _node;
};

int bt_tbs_client_discover(struct bt_conn *conn);

int bt_tbs_client_set_outgoing_uri(struct bt_conn *conn, uint8_t inst_index,
                                   const char *uri);

int bt_tbs_client_set_signal_strength_interval(struct bt_conn *conn,
                                               uint8_t inst_index,
                                               uint8_t interval);

int bt_tbs_client_originate_call(struct bt_conn *conn, uint8_t inst_index,
                                 const char *uri);

int bt_tbs_client_terminate_call(struct bt_conn *conn, uint8_t inst_index,
                                 uint8_t call_index);

int bt_tbs_client_hold_call(struct bt_conn *conn, uint8_t inst_index,
                            uint8_t call_index);

int bt_tbs_client_accept_call(struct bt_conn *conn, uint8_t inst_index,
                              uint8_t call_index);

int bt_tbs_client_retrieve_call(struct bt_conn *conn, uint8_t inst_index,
                                uint8_t call_index);

int bt_tbs_client_join_calls(struct bt_conn *conn, uint8_t inst_index,
                             const uint8_t *call_indexes, uint8_t count);

int bt_tbs_client_read_bearer_provider_name(struct bt_conn *conn,
                                            uint8_t inst_index);

int bt_tbs_client_read_bearer_uci(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_technology(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_uri_list(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_signal_strength(struct bt_conn *conn,
                                       uint8_t inst_index);

int bt_tbs_client_read_signal_interval(struct bt_conn *conn,
                                       uint8_t inst_index);

int bt_tbs_client_read_current_calls(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_ccid(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_call_uri(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_status_flags(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_call_state(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_remote_uri(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_friendly_name(struct bt_conn *conn, uint8_t inst_index);

int bt_tbs_client_read_optional_opcodes(struct bt_conn *conn,
                                        uint8_t inst_index);

int bt_tbs_client_register_cb(struct bt_tbs_client_cb *cbs);

struct bt_tbs_instance *bt_tbs_client_get_by_ccid(const struct bt_conn *conn,
                                                  uint8_t ccid);

struct bt_tbs_instance *bt_tbs_client_get_by_index(const struct bt_conn *conn, uint8_t index);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_TBS_H_ */