bass.h

Go to the documentation of this file.

 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_BASS_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_BASS_
#include <zephyr/types.h>
#include <zephyr/bluetooth/conn.h>
 
#if IS_ENABLED(CONFIG_BT_BASS)
#define BT_BASS_MAX_METADATA_LEN CONFIG_BT_BASS_MAX_METADATA_LEN
#define BT_BASS_MAX_SUBGROUPS    CONFIG_BT_BASS_MAX_SUBGROUPS
#else
#define BT_BASS_MAX_METADATA_LEN 0
#define BT_BASS_MAX_SUBGROUPS    0
#endif
 
#define BT_BASS_BROADCAST_CODE_SIZE        16
 
#define BT_BASS_PA_STATE_NOT_SYNCED        0x00
#define BT_BASS_PA_STATE_INFO_REQ          0x01
#define BT_BASS_PA_STATE_SYNCED            0x02
#define BT_BASS_PA_STATE_FAILED            0x03
#define BT_BASS_PA_STATE_NO_PAST           0x04
 
#define BT_BASS_BIG_ENC_STATE_NO_ENC       0x00
#define BT_BASS_BIG_ENC_STATE_BCODE_REQ    0x01
#define BT_BASS_BIG_ENC_STATE_DEC          0x02
#define BT_BASS_BIG_ENC_STATE_BAD_CODE     0x03
 
#define BT_BASS_ERR_OPCODE_NOT_SUPPORTED   0x80
#define BT_BASS_ERR_INVALID_SRC_ID         0x81
 
#define BT_BASS_PA_INTERVAL_UNKNOWN        0xFFFF
 
#define BT_BASS_BROADCAST_MAX_ID           0xFFFFFF
 
#define BT_BASS_BIS_SYNC_NO_PREF           0xFFFFFFFF
 
struct bt_bass_subgroup {
        uint32_t bis_sync;
        uint32_t requested_bis_sync;
        uint8_t metadata_len;
        uint8_t metadata[BT_BASS_MAX_METADATA_LEN];
};
 
/* TODO: Only expose this as an opaque type */
struct bt_bass_recv_state {
        uint8_t src_id;
        bt_addr_le_t addr;
        uint8_t adv_sid;
        uint8_t req_pa_sync_value;
        uint8_t pa_sync_state;
        uint8_t encrypt_state;
        uint32_t broadcast_id; /* 24 bits */
        uint8_t bad_code[BT_BASS_BROADCAST_CODE_SIZE];
        uint8_t num_subgroups;
        struct bt_bass_subgroup subgroups[BT_BASS_MAX_SUBGROUPS];
};
 
struct bt_bass_cb {
        void (*pa_synced)(struct bt_bass_recv_state *recv_state,
                          const struct bt_le_per_adv_sync_synced_info *info);
        void (*pa_term)(struct bt_bass_recv_state *recv_state,
                        const struct bt_le_per_adv_sync_term_info *info);
        void (*pa_recv)(struct bt_bass_recv_state *recv_state,
                        const struct bt_le_per_adv_sync_recv_info *info,
                        struct net_buf_simple *buf);
        void (*biginfo)(struct bt_bass_recv_state *recv_state,
                        const struct bt_iso_biginfo *biginfo);
};
 
void bt_bass_register_cb(struct bt_bass_cb *cb);
 
int bt_bass_set_sync_state(uint8_t src_id, uint8_t pa_sync_state,
                           uint32_t bis_synced[BT_BASS_MAX_SUBGROUPS],
                           uint8_t encrypted);
 
/******************************** CLIENT API ********************************/
 
typedef void (*bt_bass_client_discover_cb)(struct bt_conn *conn, int err,
                                           uint8_t recv_state_count);
 
typedef void (*bt_bass_client_scan_cb)(const struct bt_le_scan_recv_info *info,
                                       uint32_t broadcast_id);
 
typedef void (*bt_bass_client_recv_state_cb)(struct bt_conn *conn, int err,
                                             const struct bt_bass_recv_state *state);
 
typedef void (*bt_bass_client_recv_state_rem_cb)(struct bt_conn *conn, int err,
                                                 uint8_t src_id);
 
typedef void (*bt_bass_client_write_cb)(struct bt_conn *conn, int err);
 
struct bt_bass_client_cb {
        bt_bass_client_discover_cb        discover;
        bt_bass_client_scan_cb            scan;
        bt_bass_client_recv_state_cb      recv_state;
        bt_bass_client_recv_state_rem_cb  recv_state_removed;
 
        bt_bass_client_write_cb           scan_start;
        bt_bass_client_write_cb           scan_stop;
        bt_bass_client_write_cb           add_src;
        bt_bass_client_write_cb           mod_src;
        bt_bass_client_write_cb           broadcast_code;
        bt_bass_client_write_cb           rem_src;
};
 
int bt_bass_client_discover(struct bt_conn *conn);
 
int bt_bass_client_scan_start(struct bt_conn *conn, bool start_scan);
 
int bt_bass_client_scan_stop(struct bt_conn *conn);
 
void bt_bass_client_register_cb(struct bt_bass_client_cb *cb);
 
struct bt_bass_add_src_param {
        bt_addr_le_t addr;
        uint8_t adv_sid;
        uint8_t pa_sync;
        uint32_t broadcast_id;
        uint16_t pa_interval;
        uint8_t num_subgroups;
        struct bt_bass_subgroup *subgroups;
};
 
int bt_bass_client_add_src(struct bt_conn *conn,
                           struct bt_bass_add_src_param *param);
 
struct bt_bass_mod_src_param {
        uint8_t src_id;
        uint8_t pa_sync;
        uint16_t pa_interval;
        uint8_t num_subgroups;
        struct bt_bass_subgroup *subgroups;
};
 
int bt_bass_client_mod_src(struct bt_conn *conn,
                           struct bt_bass_mod_src_param *param);
 
int bt_bass_client_set_broadcast_code(struct bt_conn *conn, uint8_t src_id,
                                      uint8_t broadcast_code[BT_BASS_BROADCAST_CODE_SIZE]);
 
int bt_bass_client_rem_src(struct bt_conn *conn, uint8_t src_id);
 
int bt_bass_client_read_recv_state(struct bt_conn *conn, uint8_t idx);
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_BASS_ */