Zephyr API Documentation 4.3.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
classic.h
Go to the documentation of this file.
1
4
5/*
6 * Copyright (c) 2015-2016 Intel Corporation
7 * Copyright 2024 NXP
8 *
9 * SPDX-License-Identifier: Apache-2.0
10 */
11#ifndef ZEPHYR_INCLUDE_BLUETOOTH_CLASSIC_H_
12#define ZEPHYR_INCLUDE_BLUETOOTH_CLASSIC_H_
13
20
21#include <stdbool.h>
22#include <string.h>
23
24#include <zephyr/sys/util.h>
25#include <zephyr/net_buf.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
41
46struct bt_br_discovery_priv {
48 uint16_t clock_offset;
50 uint8_t pscan_rep_mode;
52 uint8_t resolve_state;
53};
54
56#define BT_BR_EIR_SIZE_MAX 240
57
61 struct bt_br_discovery_priv _priv;
62
65
68
71
74};
75
86
105 struct bt_br_discovery_result *results, size_t count);
106
117
119
125 void (*recv)(const struct bt_br_discovery_result *result);
126
132 void (*timeout)(const struct bt_br_discovery_result *results,
133 size_t count);
134
136};
137
150
159
164
174
192int bt_br_set_discoverable(bool enable, bool limited);
193
212
227typedef enum bt_br_conn_req_rsp (*bt_br_conn_req_func_t)(const bt_addr_t *addr, uint32_t cod);
228
250
252#define BT_BR_SCAN_INTERVAL_MIN 0x0012
254#define BT_BR_SCAN_INTERVAL_MAX 0x1000
255
257#define BT_BR_SCAN_WINDOW_MIN 0x0011
259#define BT_BR_SCAN_WINDOW_MAX 0x1000
260
265
267#define BT_BR_PAGE_SCAN_INTERVAL_R0 0x0800
269#define BT_BR_PAGE_SCAN_WINDOW_R0 0x0800
270
272#define BT_BR_PAGE_SCAN_FAST_INTERVAL_R1 0x00a0
274#define BT_BR_PAGE_SCAN_FAST_WINDOW_R1 0x0011
275
277#define BT_BR_PAGE_SCAN_MEDIUM_INTERVAL_R1 0x0800
279#define BT_BR_PAGE_SCAN_MEDIUM_WINDOW_R1 0x0011
280
282#define BT_BR_PAGE_SCAN_SLOW_INTERVAL_R1 0x0800
284#define BT_BR_PAGE_SCAN_SLOW_WINDOW_R1 0x0011
285
287#define BT_BR_PAGE_SCAN_FAST_INTERVAL_R2 0x1000
289#define BT_BR_PAGE_SCAN_FAST_WINDOW_R2 0x0011
290
292#define BT_BR_PAGE_SCAN_SLOW_INTERVAL_R2 0x1000
294#define BT_BR_PAGE_SCAN_SLOW_WINDOW_R2 0x0011
295
299
308
329
337
338#define BT_BR_SCAN_INIT(_interval, _window, _type) \
339{ \
340 .interval = (_interval), \
341 .window = (_window), \
342 .type = (_type) \
343}
344
352
353#define BT_BR_PAGE_SCAN_PARAM(_interval, _window, _type) \
354 ((const struct bt_br_page_scan_param[]) { \
355 BT_BR_SCAN_INIT(_interval, _window, _type) \
356 })
357
364#define BT_BR_PAGE_SCAN_PARAM_R0 BT_BR_PAGE_SCAN_PARAM(BT_BR_PAGE_SCAN_INTERVAL_R0, \
365 BT_BR_PAGE_SCAN_WINDOW_R0, \
366 BT_BR_SCAN_TYPE_STANDARD)
367
375#define BT_BR_PAGE_SCAN_PARAM_FAST_R1 \
376 BT_BR_PAGE_SCAN_PARAM(BT_BR_PAGE_SCAN_FAST_INTERVAL_R1, \
377 BT_BR_PAGE_SCAN_FAST_WINDOW_R1, \
378 BT_BR_SCAN_TYPE_INTERLACED)
379
387#define BT_BR_PAGE_SCAN_PARAM_MEDIUM_R1 \
388 BT_BR_PAGE_SCAN_PARAM( \
389 BT_BR_PAGE_SCAN_MEDIUM_INTERVAL_R1, \
390 BT_BR_PAGE_SCAN_MEDIUM_WINDOW_R1, \
391 BT_BR_SCAN_TYPE_INTERLACED)
392
400#define BT_BR_PAGE_SCAN_PARAM_SLOW_R1 \
401 BT_BR_PAGE_SCAN_PARAM( \
402 BT_BR_PAGE_SCAN_SLOW_INTERVAL_R1, \
403 BT_BR_PAGE_SCAN_SLOW_WINDOW_R1, \
404 BT_BR_SCAN_TYPE_STANDARD)
405
413#define BT_BR_PAGE_SCAN_PARAM_FAST_R2 \
414 BT_BR_PAGE_SCAN_PARAM( \
415 BT_BR_PAGE_SCAN_FAST_INTERVAL_R2, \
416 BT_BR_PAGE_SCAN_FAST_WINDOW_R2, \
417 BT_BR_SCAN_TYPE_INTERLACED)
418
426#define BT_BR_PAGE_SCAN_PARAM_SLOW_R2 \
427 BT_BR_PAGE_SCAN_PARAM( \
428 BT_BR_PAGE_SCAN_SLOW_INTERVAL_R2, \
429 BT_BR_PAGE_SCAN_SLOW_WINDOW_R2, \
430 BT_BR_SCAN_TYPE_STANDARD)
431
471
496
501
503#define BT_BR_INQUIRY_SCAN_INTERVAL_DEFAULT 0x1000
505#define BT_BR_INQUIRY_SCAN_WINDOW_DEFAULT 0x0012
506
510
518#define BT_BR_INQUIRY_SCAN_PARAM(_interval, _window, _type) \
519 ((const struct bt_br_inquiry_scan_param[]){BT_BR_SCAN_INIT(_interval, _window, _type)})
520
528#define BT_BR_INQUIRY_SCAN_PARAM_DEFAULT \
529 BT_BR_INQUIRY_SCAN_PARAM(BT_BR_INQUIRY_SCAN_INTERVAL_DEFAULT, \
530 BT_BR_INQUIRY_SCAN_WINDOW_DEFAULT, BT_BR_SCAN_TYPE_STANDARD)
531
564
592
604
611bool bt_br_bond_exists(const bt_addr_t *addr);
612
620int bt_br_unpair(const bt_addr_t *addr);
621
627
634void bt_br_foreach_bond(void (*func)(const struct bt_br_bond_info *info, void *user_data),
635 void *user_data);
636
640
641#ifdef __cplusplus
642}
643#endif
647
648#endif /* ZEPHYR_INCLUDE_BLUETOOTH_CLASSIC_H_ */
Bluetooth device address definitions and utilities.
bt_br_scan_type
Page scan type.
Definition classic.h:301
int bt_br_set_class_of_device(uint32_t cod)
Set the Class of Device of the local BR/EDR Controller.
void bt_br_discovery_cb_unregister(struct bt_br_discovery_cb *cb)
Unregister discovery packet callbacks.
int bt_br_oob_get_local(struct bt_br_oob *oob)
Get BR/EDR local Out Of Band information.
void bt_br_discovery_cb_register(struct bt_br_discovery_cb *cb)
Register discovery packet callbacks.
void bt_br_foreach_bond(void(*func)(const struct bt_br_bond_info *info, void *user_data), void *user_data)
Iterate through all existing bonds of Classic.
int bt_br_discovery_stop(void)
Stop BR/EDR discovery.
int bt_br_set_connectable(bool enable, bt_br_conn_req_func_t func)
Enable/disable set controller in connectable state.
int bt_br_inquiry_scan_update_param(const struct bt_br_inquiry_scan_param *param)
Update BR/EDR inquiry scan parameters.
int bt_br_page_scan_update_param(const struct bt_br_page_scan_param *param)
Update BR/EDR page scan parameters.
#define BT_BR_EIR_SIZE_MAX
Maximum size of Extended Inquiry Response.
Definition classic.h:56
int bt_br_discovery_start(const struct bt_br_discovery_param *param, struct bt_br_discovery_result *results, size_t count)
Start BR/EDR discovery.
int bt_br_get_class_of_device(uint32_t *cod)
Get the Class of Device of the local BR/EDR Controller.
enum bt_br_conn_req_rsp(* bt_br_conn_req_func_t)(const bt_addr_t *addr, uint32_t cod)
Callback type for incoming BR/EDR connection requests.
Definition classic.h:227
bt_br_conn_req_rsp
BR/EDR connection request response codes.
Definition classic.h:200
int bt_br_unpair(const bt_addr_t *addr)
Clear classic pairing information .
bool bt_br_bond_exists(const bt_addr_t *addr)
Check if a Bluetooth classic device address is bonded.
int bt_br_set_discoverable(bool enable, bool limited)
Enable/disable set controller in discoverable state.
@ BT_BR_SCAN_TYPE_STANDARD
Standard scan (default).
Definition classic.h:303
@ BT_BR_SCAN_TYPE_INTERLACED
Interlaced scan (1.2 devices only).
Definition classic.h:306
@ BT_BR_CONN_REQ_REJECT_SECURITY
Reject connection due to insufficient security.
Definition classic.h:208
@ BT_BR_CONN_REQ_ACCEPT_PERIPHERAL
Accept connection as peripheral role.
Definition classic.h:204
@ BT_BR_CONN_REQ_ACCEPT_CENTRAL
Accept connection as central role.
Definition classic.h:202
@ BT_BR_CONN_REQ_REJECT_ADDR
Reject connection due to unacceptable device address.
Definition classic.h:210
@ BT_BR_CONN_REQ_REJECT_NO_RESOURCES
Reject connection due to insufficient resources.
Definition classic.h:206
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define BT_HCI_ERR_INSUFFICIENT_SECURITY
Definition hci_types.h:4318
#define BT_HCI_ERR_INSUFFICIENT_RESOURCES
Definition hci_types.h:4317
#define BT_HCI_ROLE_CENTRAL
Definition hci_types.h:3316
#define BT_HCI_ERR_BD_ADDR_UNACCEPTABLE
Definition hci_types.h:4319
#define BT_HCI_ROLE_PERIPHERAL
Definition hci_types.h:3317
Buffer management.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
Bluetooth Device Address.
Definition addr.h:40
Information about a bond with a remote device.
Definition classic.h:623
bt_addr_t addr
Address of the remote device.
Definition classic.h:625
Definition classic.h:118
void(* timeout)(const struct bt_br_discovery_result *results, size_t count)
The inquiry has stopped after discovery timeout.
Definition classic.h:132
void(* recv)(const struct bt_br_discovery_result *result)
An inquiry response received callback.
Definition classic.h:125
sys_snode_t node
Definition classic.h:135
BR/EDR discovery parameters.
Definition classic.h:77
uint8_t length
Maximum length of the discovery in units of 1.28 seconds.
Definition classic.h:81
bool limited
True if limited discovery procedure is to be used.
Definition classic.h:84
BR/EDR discovery result structure.
Definition classic.h:59
uint8_t eir[240]
Extended Inquiry Response.
Definition classic.h:73
bt_addr_t addr
Remote device address.
Definition classic.h:64
int8_t rssi
RSSI from inquiry.
Definition classic.h:67
uint8_t cod[3]
Class of Device.
Definition classic.h:70
BR/EDR inquiry scan parameters.
Definition classic.h:477
enum bt_br_scan_type type
Inquiry scan type.
Definition classic.h:494
uint16_t interval
Inquiry scan interval in 0.625 ms units Range: 0x0012 to 0x1000.
Definition classic.h:486
uint16_t window
Inquiry scan window in 0.625 ms units Range: 0x0011 to 0x1000.
Definition classic.h:491
Definition classic.h:160
bt_addr_t addr
BR/EDR address.
Definition classic.h:162
Page scan parameters.
Definition classic.h:310
uint16_t window
Page scan window in 0.625 ms units Range: 0x0011 to 0x1000.
Definition classic.h:324
uint16_t interval
Page scan interval in 0.625 ms units Range: 0x0012 to 0x1000.
Definition classic.h:319
enum bt_br_scan_type type
Page scan type.
Definition classic.h:327
Misc utilities.