blob: ae84ec2bc528b00f2e3116d9e7ef805b83ed956c [file] [log] [blame]
Andre Eisenbach89ba5282016-10-13 15:45:02 -07001/*
2 * Copyright (C) 2016 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#define LOG_TAG "bluetooth_hidl_hal_test"
18#include <android-base/logging.h>
19
20#include <android/hardware/bluetooth/1.0/IBluetoothHci.h>
21#include <android/hardware/bluetooth/1.0/IBluetoothHciCallbacks.h>
22#include <android/hardware/bluetooth/1.0/types.h>
23#include <hardware/bluetooth.h>
Andre Eisenbach89ba5282016-10-13 15:45:02 -070024#include <utils/Log.h>
25
Yuexi Ma51d023c2017-03-29 16:49:59 -070026#include <VtsHalHidlTargetCallbackBase.h>
Yuexi Ma6b872012017-03-10 00:42:13 -080027#include <VtsHalHidlTargetTestBase.h>
Zhuoyao Zhang7a727ff2018-02-08 20:36:19 -080028#include <VtsHalHidlTargetTestEnvBase.h>
Andre Eisenbach89ba5282016-10-13 15:45:02 -070029#include <queue>
30
Jack Hecaeab052018-10-23 18:13:51 -070031using ::android::sp;
Andre Eisenbach89ba5282016-10-13 15:45:02 -070032using ::android::hardware::hidl_vec;
33using ::android::hardware::Return;
34using ::android::hardware::Void;
Jack Hecaeab052018-10-23 18:13:51 -070035using ::android::hardware::bluetooth::V1_0::IBluetoothHci;
36using ::android::hardware::bluetooth::V1_0::IBluetoothHciCallbacks;
37using ::android::hardware::bluetooth::V1_0::Status;
Andre Eisenbach89ba5282016-10-13 15:45:02 -070038
Andre Eisenbach89ba5282016-10-13 15:45:02 -070039#define HCI_MINIMUM_HCI_VERSION 5 // Bluetooth Core Specification 3.0 + HS
40#define HCI_MINIMUM_LMP_VERSION 5 // Bluetooth Core Specification 3.0 + HS
41#define NUM_HCI_COMMANDS_BANDWIDTH 1000
42#define NUM_SCO_PACKETS_BANDWIDTH 1000
43#define NUM_ACL_PACKETS_BANDWIDTH 1000
Andre Eisenbach9041d972017-01-17 18:23:12 -080044#define WAIT_FOR_INIT_TIMEOUT std::chrono::milliseconds(2000)
Andre Eisenbach89ba5282016-10-13 15:45:02 -070045#define WAIT_FOR_HCI_EVENT_TIMEOUT std::chrono::milliseconds(2000)
46#define WAIT_FOR_SCO_DATA_TIMEOUT std::chrono::milliseconds(1000)
47#define WAIT_FOR_ACL_DATA_TIMEOUT std::chrono::milliseconds(1000)
48
49#define COMMAND_HCI_SHOULD_BE_UNKNOWN \
50 { 0xff, 0x3B, 0x08, 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07 }
51#define COMMAND_HCI_READ_LOCAL_VERSION_INFORMATION \
52 { 0x01, 0x10, 0x00 }
53#define COMMAND_HCI_READ_BUFFER_SIZE \
54 { 0x05, 0x10, 0x00 }
55#define COMMAND_HCI_WRITE_LOOPBACK_MODE_LOCAL \
56 { 0x02, 0x18, 0x01, 0x01 }
57#define COMMAND_HCI_RESET \
58 { 0x03, 0x0c, 0x00 }
59#define COMMAND_HCI_WRITE_LOCAL_NAME \
60 { 0x13, 0x0c, 0xf8 }
61#define HCI_STATUS_SUCCESS 0x00
62#define HCI_STATUS_UNKNOWN_HCI_COMMAND 0x01
63
64#define EVENT_CONNECTION_COMPLETE 0x03
65#define EVENT_COMMAND_COMPLETE 0x0e
66#define EVENT_COMMAND_STATUS 0x0f
67#define EVENT_NUMBER_OF_COMPLETED_PACKETS 0x13
68#define EVENT_LOOPBACK_COMMAND 0x19
69
70#define EVENT_CODE_BYTE 0
71#define EVENT_LENGTH_BYTE 1
72#define EVENT_FIRST_PAYLOAD_BYTE 2
73#define EVENT_COMMAND_STATUS_STATUS_BYTE 2
74#define EVENT_COMMAND_STATUS_ALLOWED_PACKETS_BYTE 3
75#define EVENT_COMMAND_STATUS_OPCODE_LSBYTE 4 // Bytes 4 and 5
76#define EVENT_COMMAND_COMPLETE_ALLOWED_PACKETS_BYTE 2
77#define EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE 3 // Bytes 3 and 4
78#define EVENT_COMMAND_COMPLETE_STATUS_BYTE 5
79#define EVENT_COMMAND_COMPLETE_FIRST_PARAM_BYTE 6
80#define EVENT_LOCAL_HCI_VERSION_BYTE EVENT_COMMAND_COMPLETE_FIRST_PARAM_BYTE
81#define EVENT_LOCAL_LMP_VERSION_BYTE EVENT_LOCAL_HCI_VERSION_BYTE + 3
82
83#define EVENT_CONNECTION_COMPLETE_PARAM_LENGTH 11
84#define EVENT_CONNECTION_COMPLETE_TYPE 11
85#define EVENT_CONNECTION_COMPLETE_TYPE_SCO 0
86#define EVENT_CONNECTION_COMPLETE_TYPE_ACL 1
87#define EVENT_CONNECTION_COMPLETE_HANDLE_LSBYTE 3
88#define EVENT_COMMAND_STATUS_LENGTH 4
89
90#define EVENT_NUMBER_OF_COMPLETED_PACKETS_NUM_HANDLES 2
91
Stanley Tng7915b712017-07-19 10:55:01 -070092#define ACL_BROADCAST_FLAG_OFFSET 6
Myles Watson72382e32017-11-28 17:38:29 -080093#define ACL_BROADCAST_FLAG_POINT_TO_POINT 0x0
94#define ACL_BROADCAST_POINT_TO_POINT \
95 (ACL_BROADCAST_FLAG_POINT_TO_POINT << ACL_BROADCAST_FLAG_OFFSET)
Stanley Tng7915b712017-07-19 10:55:01 -070096
97#define ACL_PACKET_BOUNDARY_FLAG_OFFSET 4
Myles Watson72382e32017-11-28 17:38:29 -080098#define ACL_PACKET_BOUNDARY_FLAG_FIRST_AUTO_FLUSHABLE 0x2
99#define ACL_PACKET_BOUNDARY_FIRST_AUTO_FLUSHABLE \
100 (ACL_PACKET_BOUNDARY_FLAG_FIRST_AUTO_FLUSHABLE \
101 << ACL_PACKET_BOUNDARY_FLAG_OFFSET)
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700102
Yuexi Ma51d023c2017-03-29 16:49:59 -0700103constexpr char kCallbackNameAclEventReceived[] = "aclDataReceived";
104constexpr char kCallbackNameHciEventReceived[] = "hciEventReceived";
105constexpr char kCallbackNameInitializationComplete[] = "initializationComplete";
106constexpr char kCallbackNameScoEventReceived[] = "scoDataReceived";
107
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700108class ThroughputLogger {
109 public:
110 ThroughputLogger(std::string task)
111 : task_(task), start_time_(std::chrono::steady_clock::now()) {}
112
113 ~ThroughputLogger() {
114 if (total_bytes_ == 0) return;
115 std::chrono::duration<double> duration =
116 std::chrono::steady_clock::now() - start_time_;
117 double s = duration.count();
118 if (s == 0) return;
119 double rate_kb = (static_cast<double>(total_bytes_) / s) / 1024;
120 ALOGD("%s %.1f KB/s (%zu bytes in %.3fs)", task_.c_str(), rate_kb,
121 total_bytes_, s);
122 }
123
124 void setTotalBytes(size_t total_bytes) { total_bytes_ = total_bytes; }
125
126 private:
127 size_t total_bytes_;
128 std::string task_;
129 std::chrono::steady_clock::time_point start_time_;
130};
131
Zhuoyao Zhang7a727ff2018-02-08 20:36:19 -0800132// Test environment for Bluetooth HIDL HAL.
133class BluetoothHidlEnvironment : public ::testing::VtsHalHidlTargetTestEnvBase {
134 public:
135 // get the test environment singleton
136 static BluetoothHidlEnvironment* Instance() {
137 static BluetoothHidlEnvironment* instance = new BluetoothHidlEnvironment;
138 return instance;
139 }
140
141 virtual void registerTestServices() override {
142 registerTestService<IBluetoothHci>();
143 }
144
145 private:
146 BluetoothHidlEnvironment() {}
147};
148
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700149// The main test class for Bluetooth HIDL HAL.
Yuexi Ma6b872012017-03-10 00:42:13 -0800150class BluetoothHidlTest : public ::testing::VtsHalHidlTargetTestBase {
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700151 public:
152 virtual void SetUp() override {
153 // currently test passthrough mode only
Yuexi Ma51d023c2017-03-29 16:49:59 -0700154 bluetooth =
155 ::testing::VtsHalHidlTargetTestBase::getService<IBluetoothHci>();
Myles Watsondbbdf3e2017-02-13 10:57:47 -0800156 ASSERT_NE(bluetooth, nullptr);
Myles Watsonbc7e5872017-02-17 09:14:21 -0800157 ALOGI("%s: getService() for bluetooth is %s", __func__,
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700158 bluetooth->isRemote() ? "remote" : "local");
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700159
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700160 bluetooth_cb = new BluetoothHciCallbacks(*this);
161 ASSERT_NE(bluetooth_cb, nullptr);
162
163 max_acl_data_packet_length = 0;
164 max_sco_data_packet_length = 0;
165 max_acl_data_packets = 0;
166 max_sco_data_packets = 0;
167
Andre Eisenbach9041d972017-01-17 18:23:12 -0800168 initialized = false;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700169 event_cb_count = 0;
170 acl_cb_count = 0;
171 sco_cb_count = 0;
172
Jack He4b50fcd2018-10-04 18:42:37 -0700173 ASSERT_FALSE(initialized);
174 // Should not be checked in production code
175 ASSERT_TRUE(bluetooth->initialize(bluetooth_cb).isOk());
Andre Eisenbach9041d972017-01-17 18:23:12 -0800176
Yuexi Ma51d023c2017-03-29 16:49:59 -0700177 bluetooth_cb->SetWaitTimeout(kCallbackNameInitializationComplete,
178 WAIT_FOR_INIT_TIMEOUT);
179 bluetooth_cb->SetWaitTimeout(kCallbackNameHciEventReceived,
180 WAIT_FOR_HCI_EVENT_TIMEOUT);
181 bluetooth_cb->SetWaitTimeout(kCallbackNameAclEventReceived,
182 WAIT_FOR_ACL_DATA_TIMEOUT);
183 bluetooth_cb->SetWaitTimeout(kCallbackNameScoEventReceived,
184 WAIT_FOR_SCO_DATA_TIMEOUT);
185
186 EXPECT_TRUE(
187 bluetooth_cb->WaitForCallback(kCallbackNameInitializationComplete)
Yuexi Mab8012eb2017-03-31 16:26:18 -0700188 .no_timeout);
Andre Eisenbach9041d972017-01-17 18:23:12 -0800189
Jack He4b50fcd2018-10-04 18:42:37 -0700190 ASSERT_TRUE(initialized);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700191 }
192
193 virtual void TearDown() override {
Jack Hecaeab052018-10-23 18:13:51 -0700194 // Should not be checked in production code
195 ASSERT_TRUE(bluetooth->close().isOk());
196 handle_no_ops();
197 EXPECT_EQ(static_cast<size_t>(0), event_queue.size());
198 EXPECT_EQ(static_cast<size_t>(0), sco_queue.size());
199 EXPECT_EQ(static_cast<size_t>(0), acl_queue.size());
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700200 }
201
202 void setBufferSizes();
203
204 // Functions called from within tests in loopback mode
205 void sendAndCheckHCI(int num_packets);
206 void sendAndCheckSCO(int num_packets, size_t size, uint16_t handle);
207 void sendAndCheckACL(int num_packets, size_t size, uint16_t handle);
208
209 // Helper functions to try to get a handle on verbosity
210 void enterLoopbackMode(std::vector<uint16_t>& sco_handles,
211 std::vector<uint16_t>& acl_handles);
Myles Watson72382e32017-11-28 17:38:29 -0800212 void handle_no_ops();
213 void wait_for_event(bool timeout_is_error);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700214 void wait_for_command_complete_event(hidl_vec<uint8_t> cmd);
215 int wait_for_completed_packets_event(uint16_t handle);
216
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700217 // A simple test implementation of BluetoothHciCallbacks.
Yuexi Ma51d023c2017-03-29 16:49:59 -0700218 class BluetoothHciCallbacks
219 : public ::testing::VtsHalHidlTargetCallbackBase<BluetoothHidlTest>,
220 public IBluetoothHciCallbacks {
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700221 BluetoothHidlTest& parent_;
222
223 public:
224 BluetoothHciCallbacks(BluetoothHidlTest& parent) : parent_(parent){};
225
226 virtual ~BluetoothHciCallbacks() = default;
227
Andre Eisenbach9041d972017-01-17 18:23:12 -0800228 Return<void> initializationComplete(Status status) override {
Myles Watsonbc7e5872017-02-17 09:14:21 -0800229 parent_.initialized = (status == Status::SUCCESS);
Yuexi Ma51d023c2017-03-29 16:49:59 -0700230 NotifyFromCallback(kCallbackNameInitializationComplete);
Andre Eisenbach9041d972017-01-17 18:23:12 -0800231 ALOGV("%s (status = %d)", __func__, static_cast<int>(status));
232 return Void();
233 };
234
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700235 Return<void> hciEventReceived(
236 const ::android::hardware::hidl_vec<uint8_t>& event) override {
237 parent_.event_cb_count++;
238 parent_.event_queue.push(event);
Yuexi Ma51d023c2017-03-29 16:49:59 -0700239 NotifyFromCallback(kCallbackNameHciEventReceived);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700240 ALOGV("Event received (length = %d)", static_cast<int>(event.size()));
241 return Void();
242 };
243
244 Return<void> aclDataReceived(
245 const ::android::hardware::hidl_vec<uint8_t>& data) override {
246 parent_.acl_cb_count++;
247 parent_.acl_queue.push(data);
Yuexi Ma51d023c2017-03-29 16:49:59 -0700248 NotifyFromCallback(kCallbackNameAclEventReceived);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700249 return Void();
250 };
251
252 Return<void> scoDataReceived(
253 const ::android::hardware::hidl_vec<uint8_t>& data) override {
254 parent_.sco_cb_count++;
255 parent_.sco_queue.push(data);
Yuexi Ma51d023c2017-03-29 16:49:59 -0700256 NotifyFromCallback(kCallbackNameScoEventReceived);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700257 return Void();
258 };
259 };
260
261 sp<IBluetoothHci> bluetooth;
Yuexi Ma51d023c2017-03-29 16:49:59 -0700262 sp<BluetoothHciCallbacks> bluetooth_cb;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700263 std::queue<hidl_vec<uint8_t>> event_queue;
264 std::queue<hidl_vec<uint8_t>> acl_queue;
265 std::queue<hidl_vec<uint8_t>> sco_queue;
266
Andre Eisenbach9041d972017-01-17 18:23:12 -0800267 bool initialized;
268
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700269 int event_cb_count;
270 int sco_cb_count;
271 int acl_cb_count;
272
273 int max_acl_data_packet_length;
274 int max_sco_data_packet_length;
275 int max_acl_data_packets;
276 int max_sco_data_packets;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700277};
278
Myles Watson72382e32017-11-28 17:38:29 -0800279// Discard NO-OPs from the event queue.
280void BluetoothHidlTest::handle_no_ops() {
281 while (event_queue.size() > 0) {
282 hidl_vec<uint8_t> event = event_queue.front();
283 EXPECT_GE(event.size(),
284 static_cast<size_t>(EVENT_COMMAND_COMPLETE_STATUS_BYTE));
285 bool event_is_no_op =
286 (event[EVENT_CODE_BYTE] == EVENT_COMMAND_COMPLETE) &&
287 (event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE] == 0x00) &&
288 (event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1] == 0x00);
289 event_is_no_op |= (event[EVENT_CODE_BYTE] == EVENT_COMMAND_STATUS) &&
290 (event[EVENT_COMMAND_STATUS_OPCODE_LSBYTE] == 0x00) &&
291 (event[EVENT_COMMAND_STATUS_OPCODE_LSBYTE + 1] == 0x00);
292 if (event_is_no_op) {
293 event_queue.pop();
294 } else {
295 return;
296 }
297 }
298}
299
300// Receive an event, discarding NO-OPs.
301void BluetoothHidlTest::wait_for_event(bool timeout_is_error = true) {
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700302 hidl_vec<uint8_t> event;
303 do {
Myles Watson72382e32017-11-28 17:38:29 -0800304 bool no_timeout =
305 bluetooth_cb->WaitForCallback(kCallbackNameHciEventReceived).no_timeout;
306 EXPECT_TRUE(no_timeout || !timeout_is_error);
307 if (no_timeout && timeout_is_error) {
Yuexi Mab8012eb2017-03-31 16:26:18 -0700308 EXPECT_LT(static_cast<size_t>(0), event_queue.size());
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700309 }
Myles Watson72382e32017-11-28 17:38:29 -0800310 if (event_queue.size() == 0) {
311 // WaitForCallback timed out.
312 return;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700313 }
Myles Watson72382e32017-11-28 17:38:29 -0800314 handle_no_ops();
315 } while (event_queue.size() == 0);
316}
317
318// Wait until a COMMAND_COMPLETE is received.
319void BluetoothHidlTest::wait_for_command_complete_event(hidl_vec<uint8_t> cmd) {
320 wait_for_event();
321 hidl_vec<uint8_t> event = event_queue.front();
322 event_queue.pop();
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700323
324 EXPECT_GT(event.size(),
325 static_cast<size_t>(EVENT_COMMAND_COMPLETE_STATUS_BYTE));
326 EXPECT_EQ(EVENT_COMMAND_COMPLETE, event[EVENT_CODE_BYTE]);
327 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE]);
328 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1]);
329 EXPECT_EQ(HCI_STATUS_SUCCESS, event[EVENT_COMMAND_COMPLETE_STATUS_BYTE]);
330}
331
332// Send the command to read the controller's buffer sizes.
333void BluetoothHidlTest::setBufferSizes() {
334 hidl_vec<uint8_t> cmd = COMMAND_HCI_READ_BUFFER_SIZE;
335 bluetooth->sendHciCommand(cmd);
336
Myles Watson72382e32017-11-28 17:38:29 -0800337 wait_for_event();
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700338 if (event_queue.size() == 0) return;
339
340 hidl_vec<uint8_t> event = event_queue.front();
341 event_queue.pop();
342
343 EXPECT_EQ(EVENT_COMMAND_COMPLETE, event[EVENT_CODE_BYTE]);
344 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE]);
345 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1]);
346 EXPECT_EQ(HCI_STATUS_SUCCESS, event[EVENT_COMMAND_COMPLETE_STATUS_BYTE]);
347
348 max_acl_data_packet_length =
349 event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 1] +
350 (event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 2] << 8);
351 max_sco_data_packet_length = event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 3];
352 max_acl_data_packets = event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 4] +
353 (event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 5] << 8);
354 max_sco_data_packets = event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 6] +
355 (event[EVENT_COMMAND_COMPLETE_STATUS_BYTE + 7] << 8);
356
357 ALOGD("%s: ACL max %d num %d SCO max %d num %d", __func__,
358 static_cast<int>(max_acl_data_packet_length),
359 static_cast<int>(max_acl_data_packets),
360 static_cast<int>(max_sco_data_packet_length),
361 static_cast<int>(max_sco_data_packets));
362}
363
364// Send an HCI command (in Loopback mode) and check the response.
365void BluetoothHidlTest::sendAndCheckHCI(int num_packets) {
366 ThroughputLogger logger = {__func__};
Myles Watson72382e32017-11-28 17:38:29 -0800367 int command_size = 0;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700368 for (int n = 0; n < num_packets; n++) {
369 // Send an HCI packet
370 std::vector<uint8_t> write_name = COMMAND_HCI_WRITE_LOCAL_NAME;
371 // With a name
372 char new_name[] = "John Jacob Jingleheimer Schmidt ___________________0";
373 size_t new_name_length = strlen(new_name);
374 for (size_t i = 0; i < new_name_length; i++)
375 write_name.push_back(static_cast<uint8_t>(new_name[i]));
376 // And the packet number
Myles Watson72382e32017-11-28 17:38:29 -0800377 size_t i = new_name_length - 1;
378 for (int digits = n; digits > 0; digits = digits / 10, i--)
379 write_name[i] = static_cast<uint8_t>('0' + digits % 10);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700380 // And padding
381 for (size_t i = 0; i < 248 - new_name_length; i++)
382 write_name.push_back(static_cast<uint8_t>(0));
383
384 hidl_vec<uint8_t> cmd = write_name;
385 bluetooth->sendHciCommand(cmd);
386
387 // Check the loopback of the HCI packet
Myles Watson72382e32017-11-28 17:38:29 -0800388 wait_for_event();
389 if (event_queue.size() == 0) return;
390
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700391 hidl_vec<uint8_t> event = event_queue.front();
392 event_queue.pop();
393 size_t compare_length =
394 (cmd.size() > static_cast<size_t>(0xff) ? static_cast<size_t>(0xff)
395 : cmd.size());
396 EXPECT_GT(event.size(), compare_length + EVENT_FIRST_PAYLOAD_BYTE - 1);
397
398 EXPECT_EQ(EVENT_LOOPBACK_COMMAND, event[EVENT_CODE_BYTE]);
399 EXPECT_EQ(compare_length, event[EVENT_LENGTH_BYTE]);
Myles Watson72382e32017-11-28 17:38:29 -0800400
401 // Don't compare past the end of the event.
402 if (compare_length + EVENT_FIRST_PAYLOAD_BYTE > event.size()) {
403 compare_length = event.size() - EVENT_FIRST_PAYLOAD_BYTE;
404 ALOGE("Only comparing %d bytes", static_cast<int>(compare_length));
405 }
406
407 if (n == num_packets - 1) {
408 command_size = cmd.size();
409 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700410
411 for (size_t i = 0; i < compare_length; i++)
412 EXPECT_EQ(cmd[i], event[EVENT_FIRST_PAYLOAD_BYTE + i]);
413 }
Myles Watson72382e32017-11-28 17:38:29 -0800414 logger.setTotalBytes(command_size * num_packets * 2);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700415}
416
417// Send a SCO data packet (in Loopback mode) and check the response.
418void BluetoothHidlTest::sendAndCheckSCO(int num_packets, size_t size,
419 uint16_t handle) {
420 ThroughputLogger logger = {__func__};
421 for (int n = 0; n < num_packets; n++) {
422 // Send a SCO packet
423 hidl_vec<uint8_t> sco_packet;
424 std::vector<uint8_t> sco_vector;
425 sco_vector.push_back(static_cast<uint8_t>(handle & 0xff));
426 sco_vector.push_back(static_cast<uint8_t>((handle & 0x0f00) >> 8));
427 sco_vector.push_back(static_cast<uint8_t>(size & 0xff));
428 sco_vector.push_back(static_cast<uint8_t>((size & 0xff00) >> 8));
429 for (size_t i = 0; i < size; i++) {
430 sco_vector.push_back(static_cast<uint8_t>(i + n));
431 }
432 sco_packet = sco_vector;
433 bluetooth->sendScoData(sco_vector);
434
435 // Check the loopback of the SCO packet
Yuexi Mab8012eb2017-03-31 16:26:18 -0700436 EXPECT_TRUE(bluetooth_cb->WaitForCallback(kCallbackNameScoEventReceived)
437 .no_timeout);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700438 hidl_vec<uint8_t> sco_loopback = sco_queue.front();
439 sco_queue.pop();
440
441 EXPECT_EQ(sco_packet.size(), sco_loopback.size());
442 size_t successful_bytes = 0;
443
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700444 for (size_t i = 0; i < sco_packet.size(); i++) {
445 if (sco_packet[i] == sco_loopback[i]) {
446 successful_bytes = i;
447 } else {
448 ALOGE("Miscompare at %d (expected %x, got %x)", static_cast<int>(i),
449 sco_packet[i], sco_loopback[i]);
450 ALOGE("At %d (expected %x, got %x)", static_cast<int>(i + 1),
451 sco_packet[i + 1], sco_loopback[i + 1]);
452 break;
453 }
454 }
455 EXPECT_EQ(sco_packet.size(), successful_bytes + 1);
456 }
Myles Watson72382e32017-11-28 17:38:29 -0800457 logger.setTotalBytes(num_packets * size * 2);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700458}
459
460// Send an ACL data packet (in Loopback mode) and check the response.
461void BluetoothHidlTest::sendAndCheckACL(int num_packets, size_t size,
462 uint16_t handle) {
463 ThroughputLogger logger = {__func__};
464 for (int n = 0; n < num_packets; n++) {
465 // Send an ACL packet
466 hidl_vec<uint8_t> acl_packet;
467 std::vector<uint8_t> acl_vector;
468 acl_vector.push_back(static_cast<uint8_t>(handle & 0xff));
469 acl_vector.push_back(static_cast<uint8_t>((handle & 0x0f00) >> 8) |
Myles Watson72382e32017-11-28 17:38:29 -0800470 ACL_BROADCAST_POINT_TO_POINT |
471 ACL_PACKET_BOUNDARY_FIRST_AUTO_FLUSHABLE);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700472 acl_vector.push_back(static_cast<uint8_t>(size & 0xff));
473 acl_vector.push_back(static_cast<uint8_t>((size & 0xff00) >> 8));
474 for (size_t i = 0; i < size; i++) {
475 acl_vector.push_back(static_cast<uint8_t>(i + n));
476 }
477 acl_packet = acl_vector;
478 bluetooth->sendAclData(acl_vector);
479
480 // Check the loopback of the ACL packet
Yuexi Mab8012eb2017-03-31 16:26:18 -0700481 EXPECT_TRUE(bluetooth_cb->WaitForCallback(kCallbackNameAclEventReceived)
482 .no_timeout);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700483 hidl_vec<uint8_t> acl_loopback = acl_queue.front();
484 acl_queue.pop();
485
486 EXPECT_EQ(acl_packet.size(), acl_loopback.size());
487 size_t successful_bytes = 0;
488
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700489 for (size_t i = 0; i < acl_packet.size(); i++) {
490 if (acl_packet[i] == acl_loopback[i]) {
491 successful_bytes = i;
492 } else {
493 ALOGE("Miscompare at %d (expected %x, got %x)", static_cast<int>(i),
494 acl_packet[i], acl_loopback[i]);
495 ALOGE("At %d (expected %x, got %x)", static_cast<int>(i + 1),
496 acl_packet[i + 1], acl_loopback[i + 1]);
497 break;
498 }
499 }
500 EXPECT_EQ(acl_packet.size(), successful_bytes + 1);
501 }
Myles Watson72382e32017-11-28 17:38:29 -0800502 logger.setTotalBytes(num_packets * size * 2);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700503}
504
505// Return the number of completed packets reported by the controller.
506int BluetoothHidlTest::wait_for_completed_packets_event(uint16_t handle) {
Myles Watson72382e32017-11-28 17:38:29 -0800507 int packets_processed = 0;
508 wait_for_event(false);
509 if (event_queue.size() == 0) {
510 ALOGW("%s: WaitForCallback timed out.", __func__);
511 return packets_processed;
512 }
513 while (event_queue.size() > 0) {
514 hidl_vec<uint8_t> event = event_queue.front();
515 event_queue.pop();
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700516
Myles Watson72382e32017-11-28 17:38:29 -0800517 EXPECT_EQ(EVENT_NUMBER_OF_COMPLETED_PACKETS, event[EVENT_CODE_BYTE]);
518 EXPECT_EQ(1, event[EVENT_NUMBER_OF_COMPLETED_PACKETS_NUM_HANDLES]);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700519
Myles Watson72382e32017-11-28 17:38:29 -0800520 uint16_t event_handle = event[3] + (event[4] << 8);
521 EXPECT_EQ(handle, event_handle);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700522
Myles Watson72382e32017-11-28 17:38:29 -0800523 packets_processed += event[5] + (event[6] << 8);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700524 }
525 return packets_processed;
526}
527
528// Send local loopback command and initialize SCO and ACL handles.
529void BluetoothHidlTest::enterLoopbackMode(std::vector<uint16_t>& sco_handles,
530 std::vector<uint16_t>& acl_handles) {
531 hidl_vec<uint8_t> cmd = COMMAND_HCI_WRITE_LOOPBACK_MODE_LOCAL;
532 bluetooth->sendHciCommand(cmd);
533
534 // Receive connection complete events with data channels
535 int connection_event_count = 0;
Myles Watson72382e32017-11-28 17:38:29 -0800536 bool command_complete_received = false;
537 while (true) {
538 wait_for_event(false);
539 if (event_queue.size() == 0) {
540 // Fail if there was no event received or no connections completed.
541 EXPECT_TRUE(command_complete_received);
542 EXPECT_LT(0, connection_event_count);
543 return;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700544 }
Myles Watson72382e32017-11-28 17:38:29 -0800545 hidl_vec<uint8_t> event = event_queue.front();
546 event_queue.pop();
547 EXPECT_GT(event.size(),
548 static_cast<size_t>(EVENT_COMMAND_COMPLETE_STATUS_BYTE));
549 if (event[EVENT_CODE_BYTE] == EVENT_CONNECTION_COMPLETE) {
550 EXPECT_GT(event.size(),
551 static_cast<size_t>(EVENT_CONNECTION_COMPLETE_TYPE));
552 EXPECT_EQ(event[EVENT_LENGTH_BYTE],
553 EVENT_CONNECTION_COMPLETE_PARAM_LENGTH);
554 uint8_t connection_type = event[EVENT_CONNECTION_COMPLETE_TYPE];
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700555
Myles Watson72382e32017-11-28 17:38:29 -0800556 EXPECT_TRUE(connection_type == EVENT_CONNECTION_COMPLETE_TYPE_SCO ||
557 connection_type == EVENT_CONNECTION_COMPLETE_TYPE_ACL);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700558
Myles Watson72382e32017-11-28 17:38:29 -0800559 // Save handles
560 uint16_t handle = event[EVENT_CONNECTION_COMPLETE_HANDLE_LSBYTE] |
561 event[EVENT_CONNECTION_COMPLETE_HANDLE_LSBYTE + 1] << 8;
562 if (connection_type == EVENT_CONNECTION_COMPLETE_TYPE_SCO)
563 sco_handles.push_back(handle);
564 else
565 acl_handles.push_back(handle);
566
567 ALOGD("Connect complete type = %d handle = %d",
568 event[EVENT_CONNECTION_COMPLETE_TYPE], handle);
569 connection_event_count++;
570 } else {
571 EXPECT_EQ(EVENT_COMMAND_COMPLETE, event[EVENT_CODE_BYTE]);
572 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE]);
573 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1]);
574 EXPECT_EQ(HCI_STATUS_SUCCESS, event[EVENT_COMMAND_COMPLETE_STATUS_BYTE]);
575 command_complete_received = true;
576 }
577 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700578}
579
580// Empty test: Initialize()/Close() are called in SetUp()/TearDown().
Yuexi Ma51d023c2017-03-29 16:49:59 -0700581TEST_F(BluetoothHidlTest, InitializeAndClose) {}
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700582
583// Send an HCI Reset with sendHciCommand and wait for a command complete event.
584TEST_F(BluetoothHidlTest, HciReset) {
585 hidl_vec<uint8_t> cmd = COMMAND_HCI_RESET;
586 bluetooth->sendHciCommand(cmd);
587
588 wait_for_command_complete_event(cmd);
589}
590
591// Read and check the HCI version of the controller.
592TEST_F(BluetoothHidlTest, HciVersionTest) {
593 hidl_vec<uint8_t> cmd = COMMAND_HCI_READ_LOCAL_VERSION_INFORMATION;
594 bluetooth->sendHciCommand(cmd);
595
Myles Watson72382e32017-11-28 17:38:29 -0800596 wait_for_event();
597 if (event_queue.size() == 0) return;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700598
599 hidl_vec<uint8_t> event = event_queue.front();
600 event_queue.pop();
601 EXPECT_GT(event.size(), static_cast<size_t>(EVENT_LOCAL_LMP_VERSION_BYTE));
602
603 EXPECT_EQ(EVENT_COMMAND_COMPLETE, event[EVENT_CODE_BYTE]);
604 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE]);
605 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1]);
606 EXPECT_EQ(HCI_STATUS_SUCCESS, event[EVENT_COMMAND_COMPLETE_STATUS_BYTE]);
607
608 EXPECT_LE(HCI_MINIMUM_HCI_VERSION, event[EVENT_LOCAL_HCI_VERSION_BYTE]);
609 EXPECT_LE(HCI_MINIMUM_LMP_VERSION, event[EVENT_LOCAL_LMP_VERSION_BYTE]);
610}
611
612// Send an unknown HCI command and wait for the error message.
613TEST_F(BluetoothHidlTest, HciUnknownCommand) {
614 hidl_vec<uint8_t> cmd = COMMAND_HCI_SHOULD_BE_UNKNOWN;
615 bluetooth->sendHciCommand(cmd);
616
Myles Watson72382e32017-11-28 17:38:29 -0800617 wait_for_event();
618 if (event_queue.size() == 0) return;
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700619
620 hidl_vec<uint8_t> event = event_queue.front();
621 event_queue.pop();
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700622
Myles Watson72382e32017-11-28 17:38:29 -0800623 EXPECT_GT(event.size(),
624 static_cast<size_t>(EVENT_COMMAND_COMPLETE_STATUS_BYTE));
625 if (event[EVENT_CODE_BYTE] == EVENT_COMMAND_COMPLETE) {
626 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE]);
627 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_COMPLETE_OPCODE_LSBYTE + 1]);
628 EXPECT_EQ(HCI_STATUS_UNKNOWN_HCI_COMMAND,
629 event[EVENT_COMMAND_COMPLETE_STATUS_BYTE]);
630 } else {
631 EXPECT_EQ(EVENT_COMMAND_STATUS, event[EVENT_CODE_BYTE]);
632 EXPECT_EQ(cmd[0], event[EVENT_COMMAND_STATUS_OPCODE_LSBYTE]);
633 EXPECT_EQ(cmd[1], event[EVENT_COMMAND_STATUS_OPCODE_LSBYTE + 1]);
634 EXPECT_EQ(HCI_STATUS_UNKNOWN_HCI_COMMAND,
635 event[EVENT_COMMAND_STATUS_STATUS_BYTE]);
636 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700637}
638
639// Enter loopback mode, but don't send any packets.
640TEST_F(BluetoothHidlTest, WriteLoopbackMode) {
641 std::vector<uint16_t> sco_connection_handles;
642 std::vector<uint16_t> acl_connection_handles;
643 enterLoopbackMode(sco_connection_handles, acl_connection_handles);
644}
645
646// Enter loopback mode and send single packets.
647TEST_F(BluetoothHidlTest, LoopbackModeSinglePackets) {
648 setBufferSizes();
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700649
650 std::vector<uint16_t> sco_connection_handles;
651 std::vector<uint16_t> acl_connection_handles;
652 enterLoopbackMode(sco_connection_handles, acl_connection_handles);
653
654 sendAndCheckHCI(1);
655
656 // This should work, but breaks on some current platforms. Figure out how to
657 // grandfather older devices but test new ones.
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700658 if (0 && sco_connection_handles.size() > 0) {
Myles Watson72382e32017-11-28 17:38:29 -0800659 EXPECT_LT(0, max_sco_data_packet_length);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700660 sendAndCheckSCO(1, max_sco_data_packet_length, sco_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700661 int sco_packets_sent = 1;
Jack Hecaeab052018-10-23 18:13:51 -0700662 int completed_packets =
663 wait_for_completed_packets_event(sco_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700664 if (sco_packets_sent != completed_packets) {
Jack Hecaeab052018-10-23 18:13:51 -0700665 ALOGW("%s: packets_sent (%d) != completed_packets (%d)", __func__,
666 sco_packets_sent, completed_packets);
Myles Watson0e06a632017-09-06 16:26:49 -0700667 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700668 }
669
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700670 if (acl_connection_handles.size() > 0) {
Myles Watson72382e32017-11-28 17:38:29 -0800671 EXPECT_LT(0, max_acl_data_packet_length);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700672 sendAndCheckACL(1, max_acl_data_packet_length, acl_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700673 int acl_packets_sent = 1;
Jack Hecaeab052018-10-23 18:13:51 -0700674 int completed_packets =
675 wait_for_completed_packets_event(acl_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700676 if (acl_packets_sent != completed_packets) {
Jack Hecaeab052018-10-23 18:13:51 -0700677 ALOGW("%s: packets_sent (%d) != completed_packets (%d)", __func__,
678 acl_packets_sent, completed_packets);
Myles Watson0e06a632017-09-06 16:26:49 -0700679 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700680 }
681}
682
683// Enter loopback mode and send packets for bandwidth measurements.
684TEST_F(BluetoothHidlTest, LoopbackModeBandwidth) {
685 setBufferSizes();
686
687 std::vector<uint16_t> sco_connection_handles;
688 std::vector<uint16_t> acl_connection_handles;
689 enterLoopbackMode(sco_connection_handles, acl_connection_handles);
690
691 sendAndCheckHCI(NUM_HCI_COMMANDS_BANDWIDTH);
692
693 // This should work, but breaks on some current platforms. Figure out how to
694 // grandfather older devices but test new ones.
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700695 if (0 && sco_connection_handles.size() > 0) {
Myles Watson72382e32017-11-28 17:38:29 -0800696 EXPECT_LT(0, max_sco_data_packet_length);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700697 sendAndCheckSCO(NUM_SCO_PACKETS_BANDWIDTH, max_sco_data_packet_length,
698 sco_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700699 int sco_packets_sent = NUM_SCO_PACKETS_BANDWIDTH;
Jack Hecaeab052018-10-23 18:13:51 -0700700 int completed_packets =
701 wait_for_completed_packets_event(sco_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700702 if (sco_packets_sent != completed_packets) {
Jack Hecaeab052018-10-23 18:13:51 -0700703 ALOGW("%s: packets_sent (%d) != completed_packets (%d)", __func__,
704 sco_packets_sent, completed_packets);
Myles Watson0e06a632017-09-06 16:26:49 -0700705 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700706 }
707
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700708 if (acl_connection_handles.size() > 0) {
Myles Watson72382e32017-11-28 17:38:29 -0800709 EXPECT_LT(0, max_acl_data_packet_length);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700710 sendAndCheckACL(NUM_ACL_PACKETS_BANDWIDTH, max_acl_data_packet_length,
711 acl_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700712 int acl_packets_sent = NUM_ACL_PACKETS_BANDWIDTH;
Jack Hecaeab052018-10-23 18:13:51 -0700713 int completed_packets =
714 wait_for_completed_packets_event(acl_connection_handles[0]);
Myles Watson0e06a632017-09-06 16:26:49 -0700715 if (acl_packets_sent != completed_packets) {
Jack Hecaeab052018-10-23 18:13:51 -0700716 ALOGW("%s: packets_sent (%d) != completed_packets (%d)", __func__,
717 acl_packets_sent, completed_packets);
Myles Watson0e06a632017-09-06 16:26:49 -0700718 }
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700719 }
720}
721
722int main(int argc, char** argv) {
Zhuoyao Zhang7a727ff2018-02-08 20:36:19 -0800723 ::testing::AddGlobalTestEnvironment(BluetoothHidlEnvironment::Instance());
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700724 ::testing::InitGoogleTest(&argc, argv);
Zhuoyao Zhang7a727ff2018-02-08 20:36:19 -0800725 BluetoothHidlEnvironment::Instance()->init(&argc, argv);
Andre Eisenbach89ba5282016-10-13 15:45:02 -0700726 int status = RUN_ALL_TESTS();
727 ALOGI("Test result = %d", status);
728 return status;
729}