Zephyr API Documentation 3.7.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
addr.h
Go to the documentation of this file.
1
5/*
6 * Copyright (c) 2019 Nordic Semiconductor ASA
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10#ifndef ZEPHYR_INCLUDE_BLUETOOTH_ADDR_H_
11#define ZEPHYR_INCLUDE_BLUETOOTH_ADDR_H_
12
13#include <stdint.h>
14#include <string.h>
15
16#include <zephyr/sys/printk.h>
17
18#ifdef __cplusplus
19extern "C" {
20#endif
21
29#define BT_ADDR_LE_PUBLIC 0x00
30#define BT_ADDR_LE_RANDOM 0x01
31#define BT_ADDR_LE_PUBLIC_ID 0x02
32#define BT_ADDR_LE_RANDOM_ID 0x03
33#define BT_ADDR_LE_UNRESOLVED 0xFE /* Resolvable Private Address
34 * (Controller unable to resolve)
35 */
36#define BT_ADDR_LE_ANONYMOUS 0xFF /* No address provided
37 * (anonymous advertisement)
38 */
39
41#define BT_ADDR_SIZE 6
42
44typedef struct {
47
48
50#define BT_ADDR_LE_SIZE 7
53typedef struct {
54 uint8_t type;
55 bt_addr_t a;
57
58/* Global Bluetooth address constants defined in bluetooth/common/addr.c */
59extern const bt_addr_t bt_addr_any;
60extern const bt_addr_t bt_addr_none;
62extern const bt_addr_le_t bt_addr_le_none;
65#define BT_ADDR_ANY (&bt_addr_any)
67#define BT_ADDR_NONE (&bt_addr_none)
69#define BT_ADDR_LE_ANY (&bt_addr_le_any)
71#define BT_ADDR_LE_NONE (&bt_addr_le_none)
72
80static inline int bt_addr_cmp(const bt_addr_t *a, const bt_addr_t *b)
81{
82 return memcmp(a, b, sizeof(*a));
83}
84
90static inline bool bt_addr_eq(const bt_addr_t *a, const bt_addr_t *b)
91{
92 return bt_addr_cmp(a, b) == 0;
93}
94
104static inline int bt_addr_le_cmp(const bt_addr_le_t *a, const bt_addr_le_t *b)
105{
106 return memcmp(a, b, sizeof(*a));
107}
108
117static inline bool bt_addr_le_eq(const bt_addr_le_t *a, const bt_addr_le_t *b)
118{
119 return bt_addr_le_cmp(a, b) == 0;
120}
121
127static inline void bt_addr_copy(bt_addr_t *dst, const bt_addr_t *src)
128{
129 memcpy(dst, src, sizeof(*dst));
130}
131
137static inline void bt_addr_le_copy(bt_addr_le_t *dst, const bt_addr_le_t *src)
138{
139 memcpy(dst, src, sizeof(*dst));
140}
141
143#define BT_ADDR_IS_RPA(a) (((a)->val[5] & 0xc0) == 0x40)
146#define BT_ADDR_IS_NRPA(a) (((a)->val[5] & 0xc0) == 0x00)
148#define BT_ADDR_IS_STATIC(a) (((a)->val[5] & 0xc0) == 0xc0)
151#define BT_ADDR_SET_RPA(a) ((a)->val[5] = (((a)->val[5] & 0x3f) | 0x40))
153#define BT_ADDR_SET_NRPA(a) ((a)->val[5] &= 0x3f)
155#define BT_ADDR_SET_STATIC(a) ((a)->val[5] |= 0xc0)
156
159
162
170static inline bool bt_addr_le_is_rpa(const bt_addr_le_t *addr)
171{
172 if (addr->type != BT_ADDR_LE_RANDOM) {
173 return false;
174 }
175
176 return BT_ADDR_IS_RPA(&addr->a);
177}
178
188static inline bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
189{
190 if (addr->type == BT_ADDR_LE_PUBLIC) {
191 return true;
192 }
193
194 return BT_ADDR_IS_STATIC(&addr->a);
195}
196
204#define BT_ADDR_STR_LEN 18
205
213#define BT_ADDR_LE_STR_LEN 30
214
225static inline int bt_addr_to_str(const bt_addr_t *addr, char *str, size_t len)
226{
227 return snprintk(str, len, "%02X:%02X:%02X:%02X:%02X:%02X",
228 addr->val[5], addr->val[4], addr->val[3],
229 addr->val[2], addr->val[1], addr->val[0]);
230}
231
242static inline int bt_addr_le_to_str(const bt_addr_le_t *addr, char *str,
243 size_t len)
244{
245 char type[10];
246
247 switch (addr->type) {
249 strcpy(type, "public");
250 break;
252 strcpy(type, "random");
253 break;
255 strcpy(type, "public-id");
256 break;
258 strcpy(type, "random-id");
259 break;
260 default:
261 snprintk(type, sizeof(type), "0x%02x", addr->type);
262 break;
263 }
264
265 return snprintk(str, len, "%02X:%02X:%02X:%02X:%02X:%02X (%s)",
266 addr->a.val[5], addr->a.val[4], addr->a.val[3],
267 addr->a.val[2], addr->a.val[1], addr->a.val[0], type);
268}
269
278int bt_addr_from_str(const char *str, bt_addr_t *addr);
279
289int bt_addr_le_from_str(const char *str, const char *type, bt_addr_le_t *addr);
290
295#ifdef __cplusplus
296}
297#endif
298
299#endif /* ZEPHYR_INCLUDE_BLUETOOTH_ADDR_H_ */
const bt_addr_t bt_addr_none
#define BT_ADDR_IS_STATIC(a)
Check if a Bluetooth LE random address is a static address.
Definition addr.h:144
static int bt_addr_to_str(const bt_addr_t *addr, char *str, size_t len)
Converts binary Bluetooth address to string.
Definition addr.h:221
#define BT_ADDR_LE_PUBLIC
Definition addr.h:29
#define BT_ADDR_LE_PUBLIC_ID
Definition addr.h:31
int bt_addr_le_from_str(const char *str, const char *type, bt_addr_le_t *addr)
Convert LE Bluetooth address from string to binary.
#define BT_ADDR_IS_RPA(a)
Check if a Bluetooth LE random address is resolvable private address.
Definition addr.h:139
const bt_addr_le_t bt_addr_le_any
static int bt_addr_cmp(const bt_addr_t *a, const bt_addr_t *b)
Compare Bluetooth device addresses.
Definition addr.h:76
static bool bt_addr_le_is_rpa(const bt_addr_le_t *addr)
Check if a Bluetooth LE address is a random private resolvable address.
Definition addr.h:166
static int bt_addr_le_cmp(const bt_addr_le_t *a, const bt_addr_le_t *b)
Compare Bluetooth LE device addresses.
Definition addr.h:100
static void bt_addr_copy(bt_addr_t *dst, const bt_addr_t *src)
Copy Bluetooth device address.
Definition addr.h:123
#define BT_ADDR_SIZE
Length in bytes of a standard Bluetooth address.
Definition addr.h:37
#define BT_ADDR_LE_RANDOM
Definition addr.h:30
static int bt_addr_le_to_str(const bt_addr_le_t *addr, char *str, size_t len)
Converts binary LE Bluetooth address to string.
Definition addr.h:238
static bool bt_addr_le_is_identity(const bt_addr_le_t *addr)
Check if a Bluetooth LE address is valid identity address.
Definition addr.h:184
static bool bt_addr_le_eq(const bt_addr_le_t *a, const bt_addr_le_t *b)
Determine equality of two Bluetooth LE device addresses.
Definition addr.h:113
static void bt_addr_le_copy(bt_addr_le_t *dst, const bt_addr_le_t *src)
Copy Bluetooth LE device address.
Definition addr.h:133
int bt_addr_le_create_static(bt_addr_le_t *addr)
Create a Bluetooth LE random static address.
int bt_addr_from_str(const char *str, bt_addr_t *addr)
Convert Bluetooth address from string to binary.
const bt_addr_t bt_addr_any
static bool bt_addr_eq(const bt_addr_t *a, const bt_addr_t *b)
Determine equality of two Bluetooth device addresses.
Definition addr.h:86
const bt_addr_le_t bt_addr_le_none
int bt_addr_le_create_nrpa(bt_addr_le_t *addr)
Create a Bluetooth LE random non-resolvable private address.
#define BT_ADDR_LE_RANDOM_ID
Definition addr.h:32
int snprintk(char *str, size_t size, const char *fmt,...)
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
char * strcpy(char *ZRESTRICT d, const char *ZRESTRICT s)
int memcmp(const void *m1, const void *m2, size_t n)
void * memcpy(void *ZRESTRICT d, const void *ZRESTRICT s, size_t n)
Bluetooth LE Device Address.
Definition addr.h:49
uint8_t type
Definition addr.h:50
bt_addr_t a
Definition addr.h:51
Bluetooth Device Address.
Definition addr.h:40
uint8_t val[6]
Definition addr.h:41