1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/*
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
* Copyright (c) 2020 ZAFENA AB
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef HCI_HANDLER_HPP_
#define HCI_HANDLER_HPP_
#include <cstring>
#include <string>
#include <cstdint>
#include <array>
#include <mutex>
#include <atomic>
#include <thread>
#include "BTTypes.hpp"
#include "BTIoctl.hpp"
#include "OctetTypes.hpp"
#include "HCIComm.hpp"
#include "JavaUplink.hpp"
#include "HCITypes.hpp"
#include "MgmtTypes.hpp"
#include "LFRingbuffer.hpp"
/**
* - - - - - - - - - - - - - - -
*
* Module HCIHandler:
*
* - BT Core Spec v5.2: Vol 4, Part E Host Controller Interface (HCI)
*/
namespace direct_bt {
/**
* A thread safe singleton handler of the HCI control channel to one controller (BT adapter)
* <p>
* Implementation utilizes a lock free ringbuffer receiving data within its separate thread.
* </p>
*/
class HCIHandler {
public:
enum Defaults : int {
HCI_MAX_MTU = static_cast<uint8_t>(HCIConstU8::PACKET_MAX_SIZE),
/** 10s poll timeout for HCI reader thread */
HCI_READER_THREAD_POLL_TIMEOUT = 10000,
/** 3s timeout for HCI command replies. This timeout is rather longer, as it may include waiting for pending command complete. */
HCI_COMMAND_REPLY_TIMEOUT = 3000,
HCI_EVT_RING_CAPACITY = 128,
/** Maximum number of packets to wait for until matching a sequential command. Won't block as timeout will limit. */
HCI_READ_PACKET_MAX_RETRY = HCI_EVT_RING_CAPACITY
};
static const pid_t pidSelf;
private:
const bool pass_replies_only_filter;
const BTMode btMode;
const uint16_t dev_id;
POctets rbuffer;
HCIComm comm;
const int replyTimeoutMS;
std::recursive_mutex mtx;
hci_ufilter filter_mask;
std::atomic<uint32_t> metaev_filter_mask;
inline bool filter_test_metaev(HCIMetaEventType mec) { return 0 != test_bit_uint32(number(mec)-1, metaev_filter_mask); }
inline void filter_put_metaevs(const uint32_t mask) { metaev_filter_mask=mask; }
inline void filter_clear_metaevs(uint32_t &mask) { mask=0; }
inline void filter_all_metaevs(uint32_t &mask) { mask=0xffff; }
inline void filter_set_metaev(HCIMetaEventType mec, uint32_t &mask) { set_bit_uint32(number(mec)-1, mask); }
LFRingbuffer<std::shared_ptr<HCIEvent>, nullptr> hciEventRing;
std::atomic<pthread_t> hciReaderThreadId;
std::atomic<bool> hciReaderRunning;
std::atomic<bool> hciReaderShallStop;
void hciReaderThreadImpl();
bool sendCommand(HCICommand &req);
std::shared_ptr<HCIEvent> getNextReply(HCICommand &req, int & retryCount);
std::shared_ptr<HCIEvent> sendWithReply(HCICommand &req);
std::shared_ptr<HCIEvent> sendWithCmdCompleteReply(HCICommand &req, HCICommandCompleteEvent **res);
template<typename hci_cmd_event_struct>
std::shared_ptr<HCIEvent> processSimpleCommand(HCIOpcode opc, const hci_cmd_event_struct **res, HCIStatusCode *status);
template<typename hci_command_struct, typename hci_cmd_event_struct>
std::shared_ptr<HCIEvent> processStructCommand(HCIStructCommand<hci_command_struct> &req,
HCIEventType evc, const hci_cmd_event_struct **res,
HCIStatusCode *status);
template<typename hci_command_struct, typename hci_cmd_event_struct>
std::shared_ptr<HCIEvent> processStructMetaCmd(HCIStructCommand<hci_command_struct> &req,
HCIMetaEventType mec, const hci_cmd_event_struct **res,
HCIStatusCode *status);
HCIHandler(const HCIHandler&) = delete;
void operator=(const HCIHandler&) = delete;
public:
HCIHandler(const BTMode btMode, const uint16_t dev_id, const int replyTimeoutMS=Defaults::HCI_COMMAND_REPLY_TIMEOUT);
/**
* Releases this instance after issuing {@link #close()}.
*/
~HCIHandler() { close(); }
void close();
BTMode getBTMode() { return btMode; }
/** Returns true if this mgmt instance is open and hence valid, otherwise false */
bool isOpen() const {
return comm.isOpen();
}
std::string toString() const { return "HCIHandler[BTMode "+BTModeString(btMode)+", dev_id "+std::to_string(dev_id)+"]"; }
/**
* BT Core Spec v5.2: Vol 4, Part E HCI: 7.3.2 Reset command
*/
HCIStatusCode reset();
/**
* Establish a connection to the given LE peer.
* <p>
* BT Core Spec v5.2: Vol 4, Part E HCI: 7.8.12 LE Create Connection command
* </p>
* <p>
* Even if not utilizing a HCI channel, it has been observed that maintaining such
* enhanced performance on subsequent communication, i.e. GATT over L2CAP.
* </p>
* <p>
* Set window to the same value as the interval, enables continuous scanning.
* </p>
*
* @param handle_return
* @param peer_bdaddr
* @param peer_mac_type
* @param own_mac_type
* @param le_scan_interval in units of 0.625ms, default value 48 for 30ms, min value 4 for 2.5ms -> 0x4000 for 10.24s
* @param le_scan_window in units of 0.625ms, default value 48 for 30ms, min value 4 for 2.5ms -> 0x4000 for 10.24s. Shall be <= le_scan_interval
* @param conn_interval_min in units of 1.25ms, default value 15 for 19.75ms
* @param conn_interval_max in units of 1.25ms, default value 15 for 19.75ms
* @param conn_latency slave latency in units of connection events, default value 0
* @param supervision_timeout in units of 10ms, default value 1000 for 10000ms or 10s.
* @return
*/
HCIStatusCode le_create_conn(uint16_t * handle_return, const EUI48 &peer_bdaddr,
const HCIAddressType peer_mac_type=HCIAddressType::HCIADDR_LE_PUBLIC,
const HCIAddressType own_mac_type=HCIAddressType::HCIADDR_LE_PUBLIC,
const uint16_t le_scan_interval=48, const uint16_t le_scan_window=48,
const uint16_t conn_interval_min=0x000F, const uint16_t conn_interval_max=0x000F,
const uint16_t conn_latency=0x0000, const uint16_t supervision_timeout=number(HCIConstInt::LE_CONN_TIMEOUT_MS)/10);
/**
* Establish a connection to the given BREDR (non LE).
* <p>
* BT Core Spec v5.2: Vol 4, Part E HCI: 7.1.5 Create Connection command
* </p>
*/
HCIStatusCode create_conn(uint16_t * handle_return, const EUI48 &bdaddr,
const uint16_t pkt_type=HCI_DM1 | HCI_DM3 | HCI_DM5 | HCI_DH1 | HCI_DH3 | HCI_DH5,
const uint16_t clock_offset=0x0000, const uint8_t role_switch=0x01);
/**
* Disconnect an established connection.
* <p>
* BT Core Spec v5.2: Vol 4, Part E HCI: 7.1.6 Disconnect command
* </p>
*/
HCIStatusCode disconnect(const uint16_t conn_handle, const HCIStatusCode reason=HCIStatusCode::REMOTE_USER_TERMINATED_CONNECTION);
};
} // namespace direct_bt
#endif /* DBT_HANDLER_HPP_ */
|
