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
|
/*
* 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_COMM_HPP_
#define HCI_COMM_HPP_
#include <cstring>
#include <string>
#include <cstdint>
#include <memory>
#include <mutex>
#include <jau/basic_types.hpp>
#include <jau/function_def.hpp>
#include "HCIIoctl.hpp"
/**
* - - - - - - - - - - - - - - -
*
* Module HCIComm:
*
* - BT Core Spec v5.2: Vol 4, Part E Host Controller Interface (HCI)
*/
namespace direct_bt {
/** \addtogroup DBTSystemAPI
*
* @{
*/
/**
* Read/Write HCI communication channel.
*/
class HCIComm {
public:
/** Utilized to query for external interruption, whether device is still connected etc. */
typedef jau::FunctionDef<bool, int /* dummy*/> get_boolean_callback_t;
const uint16_t dev_id;
const uint16_t channel;
private:
static int hci_open_dev(const uint16_t dev_id, const uint16_t channel) noexcept;
static int hci_close_dev(int dd) noexcept;
std::recursive_mutex mtx_write;
jau::relaxed_atomic_int socket_descriptor; // the hci socket
jau::sc_atomic_bool interrupted_intern; // for forced disconnect and read interruption via close()
get_boolean_callback_t is_interrupted_extern; // for forced disconnect and read interruption via external event
std::atomic<pthread_t> tid_read;
public:
/** Constructing a newly opened HCI communication channel instance */
HCIComm(const uint16_t dev_id, const uint16_t channel) noexcept;
HCIComm(const HCIComm&) = delete;
void operator=(const HCIComm&) = delete;
/**
* Releases this instance after issuing {@link #close()}.
*/
~HCIComm() noexcept { close(); }
bool is_open() const noexcept { return 0 <= socket_descriptor; }
/** The external `is interrupted` callback is used until close(), thereafter it is removed. */
void set_interrupted_query(get_boolean_callback_t is_interrupted_cb) { is_interrupted_extern = is_interrupted_cb; }
/** Returns true if interrupted by internal or external cause, hence shall stop connecting and reading. */
bool interrupted() const noexcept { return interrupted_intern || ( !is_interrupted_extern.isNullType() && is_interrupted_extern(0/*dummy*/) ); }
/** Closing the HCI channel, locking {@link #mutex_write()}. */
void close() noexcept;
/** Return this HCI socket descriptor. */
inline int socket() const noexcept { return socket_descriptor; }
/** Return the recursive write mutex for multithreading access. */
inline std::recursive_mutex & mutex_write() noexcept { return mtx_write; }
/** Generic read w/ own timeout, w/o locking suitable for a unique ringbuffer sink. */
jau::snsize_t read(uint8_t* buffer, const jau::nsize_t capacity, const jau::fraction_i64& timeout) noexcept;
/** Generic write, locking {@link #mutex_write()}. */
jau::snsize_t write(const uint8_t* buffer, const jau::nsize_t size) noexcept;
private:
static inline void setu32_bit(int nr, void *addr) noexcept
{
*((uint32_t *) addr + (nr >> 5)) |= (1 << (nr & 31));
}
static inline void clearu32_bit(int nr, void *addr) noexcept
{
*((uint32_t *) addr + (nr >> 5)) &= ~(1 << (nr & 31));
}
static inline int testu32_bit(int nr, void *addr) noexcept
{
return *((uint32_t *) addr + (nr >> 5)) & (1 << (nr & 31));
}
public:
static inline void filter_clear(hci_ufilter *f) noexcept
{
bzero(f, sizeof(*f));
}
static inline void filter_set_ptype(int t, hci_ufilter *f) noexcept
{
setu32_bit((t == HCI_VENDOR_PKT) ? 0 : (t & HCI_FLT_TYPE_BITS), &f->type_mask);
}
static inline void filter_clear_ptype(int t, hci_ufilter *f) noexcept
{
clearu32_bit((t == HCI_VENDOR_PKT) ? 0 : (t & HCI_FLT_TYPE_BITS), &f->type_mask);
}
static inline int filter_test_ptype(int t, hci_ufilter *f) noexcept
{
return testu32_bit((t == HCI_VENDOR_PKT) ? 0 : (t & HCI_FLT_TYPE_BITS), &f->type_mask);
}
static inline void filter_all_ptypes(hci_ufilter *f) noexcept
{
memset((void *) &f->type_mask, 0xff, sizeof(f->type_mask));
}
static inline void filter_set_event(int e, hci_ufilter *f) noexcept
{
setu32_bit((e & HCI_FLT_EVENT_BITS), &f->event_mask);
}
static inline void filter_clear_event(int e, hci_ufilter *f) noexcept
{
clearu32_bit((e & HCI_FLT_EVENT_BITS), &f->event_mask);
}
static inline int filter_test_event(int e, hci_ufilter *f) noexcept
{
return testu32_bit((e & HCI_FLT_EVENT_BITS), &f->event_mask);
}
static inline void filter_all_events(hci_ufilter *f) noexcept
{
memset((void *) f->event_mask, 0xff, sizeof(f->event_mask));
}
static inline void filter_set_opcode(uint16_t opcode, hci_ufilter *f) noexcept
{
f->opcode = opcode;
}
static inline void filter_clear_opcode(hci_ufilter *f) noexcept
{
f->opcode = 0;
}
static inline int filter_test_opcode(uint16_t opcode, hci_ufilter *f) noexcept
{
return (f->opcode == opcode);
}
};
/**@}*/
} // namespace direct_bt
#endif /* HCI_COMM_HPP_ */
|
