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
|
/*
* 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 BT_ADDRESS_HPP_
#define BT_ADDRESS_HPP_
#include <cstring>
#include <string>
#include <cstdint>
namespace direct_bt {
/**
* BT Core Spec v5.2: Vol 3, Part C Generic Access Profile (GAP): 15.1.1.1 Public Bluetooth address
* <pre>
* 1) BT public address used as BD_ADDR for BR/EDR physical channel is defined in Vol 2, Part B 1.2
* - EUI-48 or MAC (6 octets)
*
* 2) BT public address used as BD_ADDR for the LE physical channel is defined in Vol 6, Part B 1.3
* BT Core Spec v5.2: Vol 3, Part C Generic Access Profile (GAP): 15.1.1.2 Random Bluetooth address
*
* 3) BT random address used as BD_ADDR on the LE physical channel is defined in Vol 3, Part C 10.8
* </pre>
*/
enum BDAddressType : uint8_t {
/** Bluetooth BREDR address */
BDADDR_BREDR = 0x00,
/** Bluetooth LE public address */
BDADDR_LE_PUBLIC = 0x01,
/** Bluetooth LE random address, see {@link BLERandomAddressType} */
BDADDR_LE_RANDOM = 0x02,
/** Undefined */
BDADDR_UNDEFINED = 0xff
};
std::string getBDAddressTypeString(const BDAddressType type);
/**
* BT Core Spec v5.2: Vol 6 LE, Part B Link Layer Specification: 1.3 Device Address
* <p>
* BT Core Spec v5.2: Vol 6 LE, Part B Link Layer Specification: 1.3.2 Random device Address
* </p>
* <p>
* Table 1.2, address bits [47:46]
* </p>
* <p>
* If {@link BDAddressType} is {@link BDAddressType::BDADDR_LE_RANDOM},
* its value shall be different than {@link BLERandomAddressType::UNDEFINED}.
* </p>
* <p>
* If {@link BDAddressType} is not {@link BDAddressType::BDADDR_LE_RANDOM},
* its value shall be {@link BLERandomAddressType::UNDEFINED}.
* </p>
*/
enum class BLERandomAddressType : uint8_t {
/** Non-resolvable private random device address 0b00 */
UNRESOLVABLE_PRIVAT = 0x00,
/** Resolvable private random device address 0b01 */
RESOLVABLE_PRIVAT = 0x01,
/** Reserved for future use 0b10 */
RESERVED = 0x02,
/** Static public 'random' device address 0b11 */
STATIC_PUBLIC = 0x03,
/** Undefined, e.g. address not of type {@link BDAddressType::BDADDR_LE_RANDOM} */
UNDEFINED = 0xff
};
std::string getBLERandomAddressTypeString(const BLERandomAddressType type);
/**
* HCI LE Address-Type is PUBLIC: 0x00, RANDOM: 0x01
* <p>
* BT Core Spec v5.2: Vol 4, Part E Host Controller Interface (HCI) Functionality:
* <pre>
* > 7.8.5: LE Set Advertising Parameters command
* -- Own_Address_Type: public: 0x00 (default), random: 0x01, resolvable-1: 0x02, resolvable-2: 0x03
* > 7.8.10: LE Set Scan Parameters command
* -- Own_Address_Type: public: 0x00 (default), random: 0x01, resolvable-1: 0x02, resolvable-2: 0x03
* > 7.8.12: LE Create Connection command
* -- Own_Address_Type: public: 0x00 (default), random: 0x01,
* Public Identity Address (resolvable-1, any not supporting LE_Set_Privacy_Mode command): 0x02,
* Random (static) Identity Address (resolvable-2, any not supporting LE_Set_Privacy_Mode command): 0x03
* </pre>
* </p>
*/
enum class HCILEPeerAddressType : uint8_t {
/** Public Device Address */
PUBLIC = 0x00,
/** Random Device Address */
RANDOM = 0x01,
/** Public Resolved Identity Address */
PUBLIC_IDENTITY = 0x02,
/** Resolved Random (Static) Identity Address */
RANDOM_STATIC_IDENTITY = 0x03,
UNDEFINED = 0xff /**< HCIADDR_UNDEFINED */
};
BDAddressType getBDAddressType(const HCILEPeerAddressType hciPeerAddrType);
std::string getHCILEPeerAddressTypeString(const HCILEPeerAddressType type);
enum class HCILEOwnAddressType : uint8_t {
/** Public Device Address */
PUBLIC = 0x00,
/** Random Device Address */
RANDOM = 0x01,
/** Controller Resolved Private Address or Public Address */
RESOLVABLE_OR_PUBLIC = 0x02,
/** Controller Resolved Private Address or Random Address */
RESOLVABLE_OR_RANDOM = 0x03,
UNDEFINED = 0xff
};
BDAddressType getBDAddressType(const HCILEOwnAddressType hciOwnAddrType);
std::string getHCILEOwnAddressTypeString(const HCILEOwnAddressType type);
/**
* A packed 48 bit EUI-48 identifier, formerly known as MAC-48
* or simply network device MAC address (Media Access Control address).
* <p>
* Since we utilize this type within *ioctl* _and_ our high-level *types*,
* declaration is not within our *direct_bt* namespace.
* </p>
*/
struct __attribute__((packed)) EUI48 {
uint8_t b[6]; // == sizeof(EUI48)
EUI48() { bzero(b, sizeof(EUI48)); }
EUI48(const uint8_t * b);
EUI48(const std::string mac);
EUI48(const EUI48 &o) noexcept = default;
EUI48(EUI48 &&o) noexcept = default;
EUI48& operator=(const EUI48 &o) noexcept = default;
EUI48& operator=(EUI48 &&o) noexcept = default;
BLERandomAddressType getBLERandomAddressType(const BDAddressType addressType) const;
std::string toString() const;
};
inline bool operator<(const EUI48& lhs, const EUI48& rhs)
{ return memcmp(&lhs, &rhs, sizeof(EUI48))<0; }
inline bool operator==(const EUI48& lhs, const EUI48& rhs)
{ return !memcmp(&lhs, &rhs, sizeof(EUI48)); }
inline bool operator!=(const EUI48& lhs, const EUI48& rhs)
{ return !(lhs == rhs); }
/** EUI48 MAC address matching any device, i.e. '0:0:0:0:0:0'. */
extern const EUI48 EUI48_ANY_DEVICE;
/** EUI48 MAC address matching all device, i.e. 'ff:ff:ff:ff:ff:ff'. */
extern const EUI48 EUI48_ALL_DEVICE;
/** EUI48 MAC address matching local device, i.e. '0:0:0:ff:ff:ff'. */
extern const EUI48 EUI48_LOCAL_DEVICE;
} // namespace direct_bt
#endif /* BT_ADDRESS_HPP_ */
|
