bt_le_audio_tx.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _LE_AUDIO_TX_H_
#define _LE_AUDIO_TX_H_
 
#include <zephyr/net_buf.h>
#include <zephyr/sys/atomic.h>
#include <zephyr/bluetooth/audio/audio.h>
#include <zephyr/bluetooth/audio/bap.h>
#include <zephyr/bluetooth/audio/cap.h>
 
#include "le_audio.h"
 
struct le_audio_tx_info {
        struct stream_index idx;
        struct bt_cap_stream *cap_stream;
        uint8_t audio_location;
};
 
struct bt_le_audio_tx_ctx;
 
#define HCI_ISO_BUF_PER_CHAN 2
 
#if defined(CONFIG_BT_ISO_MAX_CIG) && defined(CONFIG_BT_ISO_MAX_BIG)
#define GROUP_MAX (CONFIG_BT_ISO_MAX_BIG + CONFIG_BT_ISO_MAX_CIG)
#elif defined(CONFIG_BT_ISO_MAX_CIG)
#define GROUP_MAX CONFIG_BT_ISO_MAX_CIG
#elif defined(CONFIG_BT_ISO_MAX_BIG)
#define GROUP_MAX CONFIG_BT_ISO_MAX_BIG
#else
#error Neither CIG nor BIG defined
#endif
 
#if (defined(CONFIG_BT_BAP_BROADCAST_SRC_SUBGROUP_COUNT) && defined(CONFIG_BT_BAP_UNICAST))
#define SUBGROUP_MAX (1 + CONFIG_BT_BAP_BROADCAST_SRC_SUBGROUP_COUNT)
#elif (defined(CONFIG_BT_BAP_BROADCAST_SRC_SUBGROUP_COUNT) && !defined(CONFIG_BT_BAP_UNICAST))
#define SUBGROUP_MAX CONFIG_BT_BAP_BROADCAST_SRC_SUBGROUP_COUNT
#else
#define SUBGROUP_MAX 1
#endif
 
#define TX_STREAMS_MAX CONFIG_BT_ISO_MAX_CHAN
 
#define TX_BUF_NUM (GROUP_MAX * SUBGROUP_MAX * TX_STREAMS_MAX * HCI_ISO_BUF_PER_CHAN)
 
enum bt_le_audio_tx_last_data_status {
        STATUS_NOT_SET = 0,               /* Initial status */
        STATUS_SENT_WITH_TS,              /* Data sent with timestamp */
        STATUS_SENT_WITHOUT_TS,           /* Data sent without timestamp */
        STATUS_OVERRUN_FLUSHED,           /* Data overrun, flushed */
        STATUS_UNDERRUN_EMPTY_SDU_ON_AIR, /* Data underrun, empty SDU on air */
};
 
struct tx_inf {
        uint16_t iso_conn_handle;
        struct bt_iso_tx_info iso_tx;
        struct bt_iso_tx_info iso_tx_readback;
        atomic_t iso_tx_pool_alloc;
        bool hci_wrn_printed;
};
 
struct bt_le_audio_tx_ctx {
        struct net_buf_pool *iso_tx_pool;
        struct tx_inf tx_info_arr[GROUP_MAX][SUBGROUP_MAX][TX_STREAMS_MAX];
        /* Estimated timestamp from the controller and validity */
        uint32_t ts_ctlr_esti_us;
        bool ts_ctlr_esti_us_valid;
        /* Real timestamp from the controller */
        uint32_t ts_ctlr_real_us_last;
        /* Timestamp - when the last correction was applied */
        uint32_t ts_last_correction;
        /* Counter to track subsequent rapid corrections. Indicates an error state */
        uint32_t subsequent_rapid_corrections;
        /* Correction between estimated and real timestamps */
        int64_t corr_diff_us;
        /* The previous "now" timestamp and validity */
        uint32_t ts_last_us;
        bool ts_last_us_valid;
        /* This device is Bluetooth clock master (central/unicast client or broadcast source) */
        bool is_ble_clock_master;
        /* Status of the last submitted data */
        enum bt_le_audio_tx_last_data_status last_data_status;
};
 
#define BT_LE_AUDIO_TX_DEFINE(name)                                                                \
        NET_BUF_POOL_FIXED_DEFINE(name##_cfg_buf, TX_BUF_NUM,                                      \
                                  BT_ISO_SDU_BUF_SIZE(CONFIG_BT_ISO_TX_MTU),                       \
                                  CONFIG_BT_CONN_TX_USER_DATA_SIZE, NULL);                         \
        static struct bt_le_audio_tx_ctx name##_ctx = {                                            \
                .iso_tx_pool = &name##_cfg_buf,                                                    \
        };                                                                                         \
        static struct bt_le_audio_tx_ctx *name = &name##_ctx
 
int bt_le_audio_tx_send(struct bt_le_audio_tx_ctx *ctx, struct net_buf const *const audio_frame,
                        struct le_audio_tx_info *tx, uint8_t num_tx);
 
int bt_le_audio_tx_stream_started(struct bt_le_audio_tx_ctx *ctx, struct stream_index stream_idx);
 
int bt_le_audio_tx_stream_sent(struct bt_le_audio_tx_ctx *ctx, struct stream_index stream_idx);
 
int bt_le_audio_tx_init(struct bt_le_audio_tx_ctx *ctx, bool is_clock_master);
 
#endif /* _LE_AUDIO_TX_H_ */