1 /**
2  * Common functions and helpers for BSIM audio tests
3  *
4  * Copyright (c) 2019 Bose Corporation
5  * Copyright (c) 2020-2022 Nordic Semiconductor ASA
6  *
7  * SPDX-License-Identifier: Apache-2.0
8  */
9 
10 #ifndef ZEPHYR_TEST_BSIM_BT_AUDIO_TEST_
11 #define ZEPHYR_TEST_BSIM_BT_AUDIO_TEST_
12 
13 #include <stdbool.h>
14 #include <stddef.h>
15 #include <stdint.h>
16 
17 #include <zephyr/bluetooth/audio/audio.h>
18 #include <zephyr/bluetooth/audio/bap.h>
19 #include <zephyr/bluetooth/audio/cap.h>
20 #include <zephyr/bluetooth/audio/csip.h>
21 #include <zephyr/bluetooth/bluetooth.h>
22 #include <zephyr/bluetooth/hci.h>
23 #include <zephyr/bluetooth/conn.h>
24 #include <zephyr/bluetooth/iso.h>
25 #include <zephyr/bluetooth/uuid.h>
26 #include <zephyr/bluetooth/gatt.h>
27 #include <zephyr/kernel.h>
28 #include <zephyr/sys/atomic_types.h>
29 #include <zephyr/sys/util.h>
30 #include <zephyr/sys/util_macro.h>
31 #include <zephyr/sys_clock.h>
32 #include <zephyr/types.h>
33 
34 #include "bstests.h"
35 #include "bs_types.h"
36 #include "bs_tracing.h"
37 
38 static const uint8_t mock_iso_data[] = {
39 	0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
40 	0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e,
41 	0x1f, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
42 	0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c,
43 	0x3d, 0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b,
44 	0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a,
45 	0x5b, 0x5c, 0x5d, 0x5e, 0x5f, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69,
46 	0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,
47 	0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
48 	0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96,
49 	0x97, 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5,
50 	0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, 0xb0, 0xb1, 0xb2, 0xb3, 0xb4,
51 	0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0, 0xc1, 0xc2, 0xc3,
52 	0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, 0xd0, 0xd1, 0xd2,
53 	0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0xe0, 0xe1,
54 	0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef, 0xf0,
55 	0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff,
56 	0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
57 	0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e,
58 	0x1f, 0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d,
59 	0x2e, 0x2f, 0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c,
60 	0x3d, 0x3e, 0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b,
61 	0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a,
62 	0x5b, 0x5c, 0x5d, 0x5e, 0x5f, 0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69,
63 	0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,
64 	0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87,
65 	0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f, 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96,
66 	0x97, 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5,
67 	0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf, 0xb0, 0xb1, 0xb2, 0xb3, 0xb4,
68 	0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf, 0xc0, 0xc1, 0xc2, 0xc3,
69 	0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf, 0xd0, 0xd1, 0xd2,
70 	0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf, 0xe0, 0xe1,
71 	0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef, 0xf0,
72 	0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff,
73 };
74 
75 #define MIN_SEND_COUNT 100
76 #define WAIT_SECONDS   100                           /* seconds */
77 #define WAIT_TIME (WAIT_SECONDS * USEC_PER_SEC) /* microseconds*/
78 
79 #define WAIT_FOR_COND(cond) while (!(cond)) { k_sleep(K_MSEC(1)); }
80 
81 #define CREATE_FLAG(flag) static atomic_t flag = (atomic_t)false
82 #define SET_FLAG(flag) (void)atomic_set(&flag, (atomic_t)true)
83 #define UNSET_FLAG(flag) (void)atomic_clear(&flag)
84 #define TEST_FLAG(flag) (atomic_get(&flag) == (atomic_t)true)
85 #define WAIT_FOR_FLAG(flag)                                                                        \
86 	while (!(bool)atomic_get(&flag)) {                                                         \
87 		(void)k_sleep(K_MSEC(1));                                                          \
88 	}
89 #define WAIT_FOR_AND_CLEAR_FLAG(flag)                                                              \
90 	while (!(bool)atomic_clear(&flag)) {                                                       \
91 		(void)k_sleep(K_MSEC(1));                                                          \
92 	}
93 #define WAIT_FOR_UNSET_FLAG(flag) \
94 	while (atomic_get(&flag) != (atomic_t)false) { \
95 		(void)k_sleep(K_MSEC(1)); \
96 	}
97 
98 extern enum bst_result_t bst_result;
99 #define FAIL(...) \
100 	do { \
101 		bst_result = Failed; \
102 		bs_trace_error_time_line(__VA_ARGS__); \
103 	} while (0)
104 
105 #define PASS(...) \
106 	do { \
107 		bst_result = Passed; \
108 		bs_trace_info_time(1, "PASSED: " __VA_ARGS__); \
109 	} while (0)
110 
111 #define PA_SYNC_INTERVAL_TO_TIMEOUT_RATIO 20 /* Set the timeout relative to interval */
112 #define PA_SYNC_SKIP         5
113 
114 #define PBP_STREAMS_TO_SEND 2
115 
116 #define SINK_CONTEXT                                                                               \
117 	(BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED | BT_AUDIO_CONTEXT_TYPE_MEDIA |                         \
118 	 BT_AUDIO_CONTEXT_TYPE_CONVERSATIONAL)
119 #define SOURCE_CONTEXT                                                                             \
120 	(BT_AUDIO_CONTEXT_TYPE_UNSPECIFIED | BT_AUDIO_CONTEXT_TYPE_CONVERSATIONAL |                \
121 	 BT_AUDIO_CONTEXT_TYPE_NOTIFICATIONS)
122 
123 #define TMAP_ROLE_SUPPORTED                                                                        \
124 	((IS_ENABLED(CONFIG_BT_TMAP_CG_SUPPORTED) ? BT_TMAP_ROLE_CG : 0U) |                        \
125 	 (IS_ENABLED(CONFIG_BT_TMAP_CT_SUPPORTED) ? BT_TMAP_ROLE_CT : 0U) |                        \
126 	 (IS_ENABLED(CONFIG_BT_TMAP_UMS_SUPPORTED) ? BT_TMAP_ROLE_UMS : 0U) |                      \
127 	 (IS_ENABLED(CONFIG_BT_TMAP_UMR_SUPPORTED) ? BT_TMAP_ROLE_UMR : 0U) |                      \
128 	 (IS_ENABLED(CONFIG_BT_TMAP_BMS_SUPPORTED) ? BT_TMAP_ROLE_BMS : 0U) |                      \
129 	 (IS_ENABLED(CONFIG_BT_TMAP_BMR_SUPPORTED) ? BT_TMAP_ROLE_BMR : 0U))
130 
131 extern struct bt_le_scan_cb common_scan_cb;
132 extern struct bt_conn *default_conn;
133 extern atomic_t flag_connected;
134 extern atomic_t flag_disconnected;
135 extern atomic_t flag_conn_updated;
136 extern atomic_t flag_audio_received;
137 extern volatile bt_security_t security_level;
138 extern uint8_t csip_rsi[BT_CSIP_RSI_SIZE];
139 
140 void disconnected(struct bt_conn *conn, uint8_t reason);
141 void setup_connectable_adv(struct bt_le_ext_adv **ext_adv);
142 void setup_broadcast_adv(struct bt_le_ext_adv **adv);
143 void test_tick(bs_time_t HW_device_time);
144 void test_init(void);
145 uint16_t get_dev_cnt(void);
146 uint16_t interval_to_sync_timeout(uint16_t pa_interval);
147 void backchannel_sync_send(uint dev);
148 void backchannel_sync_send_all(void);
149 void backchannel_sync_wait(uint dev);
150 void backchannel_sync_wait_all(void);
151 void backchannel_sync_wait_any(void);
152 void backchannel_sync_clear(uint dev);
153 void backchannel_sync_clear_all(void);
154 
155 struct audio_test_stream {
156 	struct bt_cap_stream stream;
157 
158 	uint16_t seq_num;
159 	size_t tx_cnt;
160 	uint16_t tx_sdu_size;
161 
162 	struct bt_iso_recv_info last_info;
163 	size_t rx_cnt;
164 	size_t valid_rx_cnt;
165 };
166 
cap_stream_from_bap_stream(struct bt_bap_stream * bap_stream)167 static inline struct bt_cap_stream *cap_stream_from_bap_stream(struct bt_bap_stream *bap_stream)
168 {
169 	return CONTAINER_OF(bap_stream, struct bt_cap_stream, bap_stream);
170 }
171 
bap_stream_from_cap_stream(struct bt_cap_stream * cap_stream)172 static inline struct bt_bap_stream *bap_stream_from_cap_stream(struct bt_cap_stream *cap_stream)
173 {
174 	return &cap_stream->bap_stream;
175 }
176 
177 static inline struct audio_test_stream *
audio_test_stream_from_cap_stream(struct bt_cap_stream * cap_stream)178 audio_test_stream_from_cap_stream(struct bt_cap_stream *cap_stream)
179 {
180 	return CONTAINER_OF(cap_stream, struct audio_test_stream, stream);
181 }
182 
183 static inline struct audio_test_stream *
audio_test_stream_from_bap_stream(struct bt_bap_stream * bap_stream)184 audio_test_stream_from_bap_stream(struct bt_bap_stream *bap_stream)
185 {
186 	return audio_test_stream_from_cap_stream(cap_stream_from_bap_stream(bap_stream));
187 }
188 
189 static inline struct bt_cap_stream *
cap_stream_from_audio_test_stream(struct audio_test_stream * test_stream)190 cap_stream_from_audio_test_stream(struct audio_test_stream *test_stream)
191 {
192 	return &test_stream->stream;
193 }
194 
195 static inline struct bt_bap_stream *
bap_stream_from_audio_test_stream(struct audio_test_stream * test_stream)196 bap_stream_from_audio_test_stream(struct audio_test_stream *test_stream)
197 {
198 	return bap_stream_from_cap_stream(cap_stream_from_audio_test_stream(test_stream));
199 }
200 
201 #endif /* ZEPHYR_TEST_BSIM_BT_AUDIO_TEST_ */
202