Zephyr API Documentation 4.2.0-rc3
A Scalable Open Source RTOS
 4.2.0-rc3
gatt.h
Go to the documentation of this file.
1
4
5/*
6 * Copyright (c) 2015-2016 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10#ifndef ZEPHYR_INCLUDE_BLUETOOTH_GATT_H_
11#define ZEPHYR_INCLUDE_BLUETOOTH_GATT_H_
12
22
23#include <stdint.h>
24#include <stddef.h>
25#include <string.h>
26
27#include <sys/types.h>
28
29#include <zephyr/autoconf.h>
34#include <zephyr/sys/atomic.h>
36#include <zephyr/sys/slist.h>
37#include <zephyr/sys/util.h>
39#include <zephyr/toolchain.h>
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
101
109#define BT_GATT_ERR(_att_err) (-(_att_err))
110
135
136/* Forward declaration of GATT Attribute structure */
137struct bt_gatt_attr;
138
169typedef ssize_t (*bt_gatt_attr_read_func_t)(struct bt_conn *conn,
170 const struct bt_gatt_attr *attr,
171 void *buf, uint16_t len,
172 uint16_t offset);
173
212typedef ssize_t (*bt_gatt_attr_write_func_t)(struct bt_conn *conn,
213 const struct bt_gatt_attr *attr,
214 const void *buf, uint16_t len,
215 uint16_t offset, uint8_t flags);
216
241 const struct bt_uuid *uuid;
242
255
268
281
291
300
309 bool _auto_assigned_handle: 1;
311};
312
321 const struct bt_gatt_attr *attrs;
324};
325
340 sys_snode_t node;
342};
343
355
370
382 void (*att_mtu_updated)(struct bt_conn *conn, uint16_t tx, uint16_t rx);
383
387 sys_snode_t node;
389};
390
404 bool (*read_authorize)(struct bt_conn *conn,
405 const struct bt_gatt_attr *attr);
406
418 bool (*write_authorize)(struct bt_conn *conn,
419 const struct bt_gatt_attr *attr);
420};
421
423
430#define BT_GATT_CHRC_BROADCAST 0x01
436#define BT_GATT_CHRC_READ 0x02
442#define BT_GATT_CHRC_WRITE_WITHOUT_RESP 0x04
448#define BT_GATT_CHRC_WRITE 0x08
455#define BT_GATT_CHRC_NOTIFY 0x10
461#define BT_GATT_CHRC_INDICATE 0x20
467#define BT_GATT_CHRC_AUTH 0x40
474#define BT_GATT_CHRC_EXT_PROP 0x80
475
489
491#define BT_GATT_CEP_RELIABLE_WRITE 0x0001
492#define BT_GATT_CEP_WRITABLE_AUX 0x0002
493
505
507
513#define BT_GATT_CCC_NOTIFY 0x0001
519#define BT_GATT_CCC_INDICATE 0x0002
520
529
531
538#define BT_GATT_SCC_BROADCAST 0x0001
539
548
588
594
611static inline const char *bt_gatt_err_to_str(int gatt_err)
612{
613 return bt_att_err_to_str((gatt_err) < 0 ? -(gatt_err) : (gatt_err));
614}
615
624
644
672
680
688
696
707typedef uint8_t (*bt_gatt_attr_func_t)(const struct bt_gatt_attr *attr,
709 void *user_data);
710
724void bt_gatt_foreach_attr_type(uint16_t start_handle, uint16_t end_handle,
725 const struct bt_uuid *uuid,
726 const void *attr_data, uint16_t num_matches,
728 void *user_data);
729
739static inline void bt_gatt_foreach_attr(uint16_t start_handle, uint16_t end_handle,
741 void *user_data)
742{
743 bt_gatt_foreach_attr_type(start_handle, end_handle, NULL, NULL, 0, func,
744 user_data);
745}
746
755struct bt_gatt_attr *bt_gatt_attr_next(const struct bt_gatt_attr *attr);
756
772 uint16_t attr_count,
773 const struct bt_uuid *uuid);
774
784
797
813ssize_t bt_gatt_attr_read(struct bt_conn *conn, const struct bt_gatt_attr *attr,
814 void *buf, uint16_t buf_len, uint16_t offset,
815 const void *value, uint16_t value_len);
816
833 const struct bt_gatt_attr *attr,
834 void *buf, uint16_t len, uint16_t offset);
835
843#define BT_GATT_SERVICE_DEFINE(_name, ...) \
844 const struct bt_gatt_attr attr_##_name[] = { __VA_ARGS__ }; \
845 const STRUCT_SECTION_ITERABLE(bt_gatt_service_static, _name) = \
846 BT_GATT_SERVICE(attr_##_name)
847
848#define _BT_GATT_ATTRS_ARRAY_DEFINE(n, _instances, _attrs_def) \
849 static struct bt_gatt_attr attrs_##n[] = _attrs_def(_instances[n])
850
851#define _BT_GATT_SERVICE_ARRAY_ITEM(_n, _) BT_GATT_SERVICE(attrs_##_n)
852
868#define BT_GATT_SERVICE_INSTANCE_DEFINE( \
869 _name, _instances, _instance_num, _attrs_def) \
870 BUILD_ASSERT(ARRAY_SIZE(_instances) == _instance_num, \
871 "The number of array elements does not match its size"); \
872 LISTIFY(_instance_num, _BT_GATT_ATTRS_ARRAY_DEFINE, (;), \
873 _instances, _attrs_def); \
874 static struct bt_gatt_service _name[] = { \
875 LISTIFY(_instance_num, _BT_GATT_SERVICE_ARRAY_ITEM, (,)) \
876 }
877
885#define BT_GATT_SERVICE(_attrs) \
886{ \
887 .attrs = _attrs, \
888 .attr_count = ARRAY_SIZE(_attrs), \
889}
890
898#define BT_GATT_PRIMARY_SERVICE(_service) \
899 BT_GATT_ATTRIBUTE(BT_UUID_GATT_PRIMARY, BT_GATT_PERM_READ, \
900 bt_gatt_attr_read_service, NULL, (void *)_service)
901
912#define BT_GATT_SECONDARY_SERVICE(_service) \
913 BT_GATT_ATTRIBUTE(BT_UUID_GATT_SECONDARY, BT_GATT_PERM_READ, \
914 bt_gatt_attr_read_service, NULL, (void *)_service)
915
933 const struct bt_gatt_attr *attr,
934 void *buf, uint16_t len, uint16_t offset);
935
943#define BT_GATT_INCLUDE_SERVICE(_service_incl) \
944 BT_GATT_ATTRIBUTE(BT_UUID_GATT_INCLUDE, BT_GATT_PERM_READ, \
945 bt_gatt_attr_read_included, NULL, _service_incl)
946
962ssize_t bt_gatt_attr_read_chrc(struct bt_conn *conn,
963 const struct bt_gatt_attr *attr, void *buf,
964 uint16_t len, uint16_t offset);
965
976#define BT_GATT_CHRC_INIT(_uuid, _handle, _props) \
977{ \
978 .uuid = _uuid, \
979 .value_handle = _handle, \
980 .properties = _props, \
981}
982
1000#define BT_GATT_CHARACTERISTIC(_uuid, _props, _perm, _read, _write, _user_data) \
1001 BT_GATT_ATTRIBUTE(BT_UUID_GATT_CHRC, BT_GATT_PERM_READ, \
1002 bt_gatt_attr_read_chrc, NULL, \
1003 ((struct bt_gatt_chrc[]) { \
1004 BT_GATT_CHRC_INIT(_uuid, 0U, _props), \
1005 })), \
1006 BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data)
1007
1019#if defined(CONFIG_BT_SETTINGS_CCC_LAZY_LOADING)
1020 #define BT_GATT_CCC_MAX (CONFIG_BT_MAX_CONN)
1021#elif defined(CONFIG_BT_CONN)
1022 #define BT_GATT_CCC_MAX (CONFIG_BT_MAX_PAIRED + CONFIG_BT_MAX_CONN)
1023#else
1024 #define BT_GATT_CCC_MAX 0
1025#endif
1026
1044
1046#define _bt_gatt_ccc bt_gatt_ccc_managed_user_data __DEPRECATED_MACRO
1047
1055
1058
1064 void (*cfg_changed)(const struct bt_gatt_attr *attr, uint16_t value);
1065
1075 ssize_t (*cfg_write)(struct bt_conn *conn,
1076 const struct bt_gatt_attr *attr, uint16_t value);
1077
1089 bool (*cfg_match)(struct bt_conn *conn,
1090 const struct bt_gatt_attr *attr);
1091};
1092
1112ssize_t bt_gatt_attr_read_ccc(struct bt_conn *conn,
1113 const struct bt_gatt_attr *attr, void *buf,
1114 uint16_t len, uint16_t offset);
1115
1135ssize_t bt_gatt_attr_write_ccc(struct bt_conn *conn,
1136 const struct bt_gatt_attr *attr, const void *buf,
1137 uint16_t len, uint16_t offset, uint8_t flags);
1138
1140#define BT_GATT_CCC_INITIALIZER BT_GATT_CCC_MANAGED_USER_DATA_INIT __DEPRECATED_MACRO
1141
1151#define BT_GATT_CCC_MANAGED_USER_DATA_INIT(_changed, _write, _match) \
1152 { \
1153 .cfg = {}, \
1154 .cfg_changed = _changed, \
1155 .cfg_write = _write, \
1156 .cfg_match = _match, \
1157 }
1158
1171#define BT_GATT_CCC_MANAGED(_ccc, _perm) \
1172 BT_GATT_ATTRIBUTE(BT_UUID_GATT_CCC, _perm, \
1173 bt_gatt_attr_read_ccc, bt_gatt_attr_write_ccc, \
1174 _ccc)
1175
1185#define BT_GATT_CCC(_changed, _perm) \
1186 BT_GATT_CCC_MANAGED(((struct bt_gatt_ccc_managed_user_data[]){ \
1187 BT_GATT_CCC_MANAGED_USER_DATA_INIT(_changed, NULL, NULL)}), \
1188 _perm)
1189
1200#define BT_GATT_CCC_WITH_WRITE_CB(_changed, _write, _perm) \
1201 BT_GATT_CCC_MANAGED(((struct bt_gatt_ccc_managed_user_data[]){ \
1202 BT_GATT_CCC_MANAGED_USER_DATA_INIT(_changed, _write, NULL)}), \
1203 _perm)
1204
1221ssize_t bt_gatt_attr_read_cep(struct bt_conn *conn,
1222 const struct bt_gatt_attr *attr, void *buf,
1223 uint16_t len, uint16_t offset);
1224
1232#define BT_GATT_CEP(_value) \
1233 BT_GATT_DESCRIPTOR(BT_UUID_GATT_CEP, BT_GATT_PERM_READ, \
1234 bt_gatt_attr_read_cep, NULL, (void *)_value)
1235
1253ssize_t bt_gatt_attr_read_cud(struct bt_conn *conn,
1254 const struct bt_gatt_attr *attr, void *buf,
1255 uint16_t len, uint16_t offset);
1256
1266#define BT_GATT_CUD(_value, _perm) \
1267 BT_GATT_DESCRIPTOR(BT_UUID_GATT_CUD, _perm, bt_gatt_attr_read_cud, \
1268 NULL, (void *)_value)
1269
1286ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn,
1287 const struct bt_gatt_attr *attr, void *buf,
1288 uint16_t len, uint16_t offset);
1289
1297#define BT_GATT_CPF(_value) \
1298 BT_GATT_DESCRIPTOR(BT_UUID_GATT_CPF, BT_GATT_PERM_READ, \
1299 bt_gatt_attr_read_cpf, NULL, (void *)_value)
1300
1315#define BT_GATT_DESCRIPTOR(_uuid, _perm, _read, _write, _user_data) \
1316 BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data)
1317
1330#define BT_GATT_ATTRIBUTE(_uuid, _perm, _read, _write, _user_data) \
1331{ \
1332 .uuid = _uuid, \
1333 .read = _read, \
1334 .write = _write, \
1335 .user_data = _user_data, \
1336 .handle = 0, \
1337 .perm = _perm, \
1338}
1339
1345typedef void (*bt_gatt_complete_func_t) (struct bt_conn *conn, void *user_data);
1346
1357 const struct bt_uuid *uuid;
1363 const struct bt_gatt_attr *attr;
1365 const void *data;
1372#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
1375#endif /* CONFIG_BT_EATT */
1376};
1377
1397int bt_gatt_notify_cb(struct bt_conn *conn,
1398 struct bt_gatt_notify_params *params);
1399
1451int bt_gatt_notify_multiple(struct bt_conn *conn,
1452 uint16_t num_params,
1453 struct bt_gatt_notify_params params[]);
1454
1474static inline int bt_gatt_notify(struct bt_conn *conn,
1475 const struct bt_gatt_attr *attr,
1476 const void *data, uint16_t len)
1477{
1478 struct bt_gatt_notify_params params;
1479
1480 memset(&params, 0, sizeof(params));
1481
1482 params.attr = attr;
1483 params.data = data;
1484 params.len = len;
1485#if defined(CONFIG_BT_EATT)
1487#endif /* CONFIG_BT_EATT */
1488
1489 return bt_gatt_notify_cb(conn, &params);
1490}
1491
1511static inline int bt_gatt_notify_uuid(struct bt_conn *conn,
1512 const struct bt_uuid *uuid,
1513 const struct bt_gatt_attr *attr,
1514 const void *data, uint16_t len)
1515{
1516 struct bt_gatt_notify_params params;
1517
1518 memset(&params, 0, sizeof(params));
1519
1520 params.uuid = uuid;
1521 params.attr = attr;
1522 params.data = data;
1523 params.len = len;
1524#if defined(CONFIG_BT_EATT)
1526#endif /* CONFIG_BT_EATT */
1527
1528 return bt_gatt_notify_cb(conn, &params);
1529}
1530
1531/* Forward declaration of the bt_gatt_indicate_params structure */
1533
1541typedef void (*bt_gatt_indicate_func_t)(struct bt_conn *conn,
1542 struct bt_gatt_indicate_params *params,
1543 uint8_t err);
1544
1554 struct bt_gatt_indicate_params *params);
1555
1567 const struct bt_uuid *uuid;
1573 const struct bt_gatt_attr *attr;
1579 const void *data;
1583 uint8_t _ref;
1584#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
1587#endif /* CONFIG_BT_EATT */
1588};
1589
1615int bt_gatt_indicate(struct bt_conn *conn,
1616 struct bt_gatt_indicate_params *params);
1617
1636bool bt_gatt_is_subscribed(struct bt_conn *conn,
1637 const struct bt_gatt_attr *attr, uint16_t ccc_type);
1638
1648uint16_t bt_gatt_get_mtu(struct bt_conn *conn);
1649
1665uint16_t bt_gatt_get_uatt_mtu(struct bt_conn *conn);
1666
1668
1674
1685 void (*func)(struct bt_conn *conn, uint8_t err,
1686 struct bt_gatt_exchange_params *params);
1687};
1688
1713int bt_gatt_exchange_mtu(struct bt_conn *conn,
1714 struct bt_gatt_exchange_params *params);
1715
1717
1767typedef uint8_t (*bt_gatt_discover_func_t)(struct bt_conn *conn,
1768 const struct bt_gatt_attr *attr,
1769 struct bt_gatt_discover_params *params);
1770
1814
1816#define BT_GATT_AUTO_DISCOVER_CCC_HANDLE 0x0000U
1817
1821 const struct bt_uuid *uuid;
1824 union {
1826 struct {
1833 } _included;
1835 uint16_t start_handle;
1836 };
1846#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__)
1849#endif /* defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__) */
1850#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
1853#endif /* CONFIG_BT_EATT */
1854};
1855
1889int bt_gatt_discover(struct bt_conn *conn,
1890 struct bt_gatt_discover_params *params);
1891
1892struct bt_gatt_read_params;
1893
1909typedef uint8_t (*bt_gatt_read_func_t)(struct bt_conn *conn, uint8_t err,
1910 struct bt_gatt_read_params *params,
1911 const void *data, uint16_t length);
1912
1922 union {
1923 struct {
1929 struct {
1946 struct {
1970 const struct bt_uuid *uuid;
1972 };
1973#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
1976#endif /* CONFIG_BT_EATT */
1978 uint16_t _att_mtu;
1979};
1980
2020int bt_gatt_read(struct bt_conn *conn, struct bt_gatt_read_params *params);
2021
2023
2031typedef void (*bt_gatt_write_func_t)(struct bt_conn *conn, uint8_t err,
2032 struct bt_gatt_write_params *params);
2033
2043 const void *data;
2046#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
2049#endif /* CONFIG_BT_EATT */
2050};
2051
2069int bt_gatt_write(struct bt_conn *conn, struct bt_gatt_write_params *params);
2070
2096int bt_gatt_write_without_response_cb(struct bt_conn *conn, uint16_t handle,
2097 const void *data, uint16_t length,
2098 bool sign, bt_gatt_complete_func_t func,
2099 void *user_data);
2100
2119static inline int bt_gatt_write_without_response(struct bt_conn *conn,
2120 uint16_t handle, const void *data,
2121 uint16_t length, bool sign)
2122{
2123 return bt_gatt_write_without_response_cb(conn, handle, data, length,
2124 sign, NULL, NULL);
2125}
2126
2128
2145typedef uint8_t (*bt_gatt_notify_func_t)(struct bt_conn *conn,
2146 struct bt_gatt_subscribe_params *params,
2147 const void *data, uint16_t length);
2148
2156typedef void (*bt_gatt_subscribe_func_t)(struct bt_conn *conn, uint8_t err,
2157 struct bt_gatt_subscribe_params *params);
2158
2209
2218
2223#if defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__)
2228#endif /* defined(CONFIG_BT_GATT_AUTO_DISCOVER_CCC) || defined(__DOXYGEN__) */
2231#if defined(CONFIG_BT_SMP)
2237#endif
2240
2244 sys_snode_t node;
2246#if defined(CONFIG_BT_EATT) || defined(__DOXYGEN__)
2249#endif /* CONFIG_BT_EATT */
2250};
2251
2286int bt_gatt_subscribe(struct bt_conn *conn,
2287 struct bt_gatt_subscribe_params *params);
2288
2306 struct bt_gatt_subscribe_params *params);
2307
2330int bt_gatt_unsubscribe(struct bt_conn *conn,
2331 struct bt_gatt_subscribe_params *params);
2332
2350void bt_gatt_cancel(struct bt_conn *conn, void *params);
2351
2353
2354#ifdef __cplusplus
2355}
2356#endif
2357
2361
2362#endif /* ZEPHYR_INCLUDE_BLUETOOTH_GATT_H_ */
Bluetooth device address definitions and utilities.
Attribute Protocol handling.
Bluetooth UUID handling.
Bluetooth connection handling.
#define ATOMIC_DEFINE(name, num_bits)
Define an array of atomic variables.
Definition atomic.h:111
bt_att_chan_opt
ATT channel option bit field values.
Definition att.h:177
static const char * bt_att_err_to_str(uint8_t att_err)
Converts a ATT error to string.
Definition att.h:127
@ BT_ATT_CHAN_OPT_NONE
Both Enhanced and Unenhanced channels can be used.
Definition att.h:179
bt_security_t
Security level.
Definition conn.h:814
int bt_gatt_exchange_mtu(struct bt_conn *conn, struct bt_gatt_exchange_params *params)
Exchange MTU.
int bt_gatt_read(struct bt_conn *conn, struct bt_gatt_read_params *params)
Read Attribute Value by handle.
uint8_t(* bt_gatt_read_func_t)(struct bt_conn *conn, uint8_t err, struct bt_gatt_read_params *params, const void *data, uint16_t length)
Read callback function.
Definition gatt.h:1909
void(* bt_gatt_write_func_t)(struct bt_conn *conn, uint8_t err, struct bt_gatt_write_params *params)
Write callback function.
Definition gatt.h:2031
void(* bt_gatt_subscribe_func_t)(struct bt_conn *conn, uint8_t err, struct bt_gatt_subscribe_params *params)
Subscription callback function.
Definition gatt.h:2156
int bt_gatt_write_without_response_cb(struct bt_conn *conn, uint16_t handle, const void *data, uint16_t length, bool sign, bt_gatt_complete_func_t func, void *user_data)
Write Attribute Value by handle without response with callback.
void bt_gatt_cancel(struct bt_conn *conn, void *params)
Try to cancel the first pending request identified by params.
int bt_gatt_unsubscribe(struct bt_conn *conn, struct bt_gatt_subscribe_params *params)
Unsubscribe Attribute Value Notification.
int bt_gatt_resubscribe(uint8_t id, const bt_addr_le_t *peer, struct bt_gatt_subscribe_params *params)
Resubscribe Attribute Value Notification subscription.
int bt_gatt_subscribe(struct bt_conn *conn, struct bt_gatt_subscribe_params *params)
Subscribe Attribute Value Notification.
int bt_gatt_write(struct bt_conn *conn, struct bt_gatt_write_params *params)
Write Attribute Value by handle.
static int bt_gatt_write_without_response(struct bt_conn *conn, uint16_t handle, const void *data, uint16_t length, bool sign)
Write Attribute Value by handle without response.
Definition gatt.h:2119
bt_gatt_sub_flag
Subscription flags.
Definition gatt.h:2160
uint8_t(* bt_gatt_notify_func_t)(struct bt_conn *conn, struct bt_gatt_subscribe_params *params, const void *data, uint16_t length)
Notification callback function.
Definition gatt.h:2145
uint8_t(* bt_gatt_discover_func_t)(struct bt_conn *conn, const struct bt_gatt_attr *attr, struct bt_gatt_discover_params *params)
Discover attribute callback function.
Definition gatt.h:1767
int bt_gatt_discover(struct bt_conn *conn, struct bt_gatt_discover_params *params)
GATT Discover function.
bt_gatt_discover_type
GATT Discover types.
Definition gatt.h:1772
@ BT_GATT_SUBSCRIBE_FLAG_NO_RESUB
No resubscribe flag.
Definition gatt.h:2184
@ BT_GATT_SUBSCRIBE_NUM_FLAGS
Definition gatt.h:2207
@ BT_GATT_SUBSCRIBE_FLAG_SENT
Sent flag.
Definition gatt.h:2205
@ BT_GATT_SUBSCRIBE_FLAG_VOLATILE
Persistence flag.
Definition gatt.h:2170
@ BT_GATT_SUBSCRIBE_FLAG_WRITE_PENDING
Write pending flag.
Definition gatt.h:2193
@ BT_GATT_DISCOVER_DESCRIPTOR
Discover Descriptors.
Definition gatt.h:1792
@ BT_GATT_DISCOVER_SECONDARY
Discover Secondary Services.
Definition gatt.h:1776
@ BT_GATT_DISCOVER_CHARACTERISTIC
Discover Characteristic Values.
Definition gatt.h:1783
@ BT_GATT_DISCOVER_INCLUDE
Discover Included Services.
Definition gatt.h:1778
@ BT_GATT_DISCOVER_STD_CHAR_DESC
Discover standard characteristic descriptor values.
Definition gatt.h:1812
@ BT_GATT_DISCOVER_PRIMARY
Discover Primary Services.
Definition gatt.h:1774
@ BT_GATT_DISCOVER_ATTRIBUTE
Discover Attributes.
Definition gatt.h:1801
void(* bt_gatt_indicate_func_t)(struct bt_conn *conn, struct bt_gatt_indicate_params *params, uint8_t err)
Indication complete result callback.
Definition gatt.h:1541
static int bt_gatt_notify_uuid(struct bt_conn *conn, const struct bt_uuid *uuid, const struct bt_gatt_attr *attr, const void *data, uint16_t len)
Notify attribute value change by UUID.
Definition gatt.h:1511
void bt_gatt_cb_register(struct bt_gatt_cb *cb)
Register GATT callbacks.
ssize_t bt_gatt_attr_read_cud(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Characteristic User Description Descriptor Attribute helper.
uint16_t bt_gatt_attr_get_handle(const struct bt_gatt_attr *attr)
Get Attribute handle.
ssize_t bt_gatt_attr_read_ccc(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Client Characteristic Configuration Attribute helper.
uint16_t bt_gatt_get_mtu(struct bt_conn *conn)
Get ATT MTU for a connection.
struct bt_gatt_attr * bt_gatt_attr_next(const struct bt_gatt_attr *attr)
Iterate to the next attribute.
ssize_t bt_gatt_attr_read_included(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Include Attribute helper.
int bt_gatt_indicate(struct bt_conn *conn, struct bt_gatt_indicate_params *params)
Indicate attribute value change.
int bt_gatt_notify_cb(struct bt_conn *conn, struct bt_gatt_notify_params *params)
Notify attribute value change.
ssize_t bt_gatt_attr_read_cep(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Characteristic Extended Properties Attribute helper.
ssize_t bt_gatt_attr_read_cpf(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Characteristic Presentation format Descriptor Attribute helper.
void(* bt_gatt_indicate_params_destroy_t)(struct bt_gatt_indicate_params *params)
Callback to destroy or clean up the GATT Indicate Value parameters.
Definition gatt.h:1553
int bt_gatt_authorization_cb_register(const struct bt_gatt_authorization_cb *cb)
Register GATT authorization callbacks.
uint8_t(* bt_gatt_attr_func_t)(const struct bt_gatt_attr *attr, uint16_t handle, void *user_data)
Attribute iterator callback.
Definition gatt.h:707
uint16_t bt_gatt_get_uatt_mtu(struct bt_conn *conn)
Get Unenhanced ATT (UATT) MTU for a connection.
static int bt_gatt_notify(struct bt_conn *conn, const struct bt_gatt_attr *attr, const void *data, uint16_t len)
Notify attribute value change.
Definition gatt.h:1474
int bt_gatt_notify_multiple(struct bt_conn *conn, uint16_t num_params, struct bt_gatt_notify_params params[])
Send multiple notifications in a single PDU.
uint16_t bt_gatt_attr_value_handle(const struct bt_gatt_attr *attr)
Get the handle of the characteristic value descriptor.
static void bt_gatt_foreach_attr(uint16_t start_handle, uint16_t end_handle, bt_gatt_attr_func_t func, void *user_data)
Attribute iterator.
Definition gatt.h:739
bt_gatt_iter
to be used as return values for bt_gatt_attr_func_t and bt_gatt_read_func_t type callbacks.
Definition gatt.h:692
int bt_gatt_service_register(struct bt_gatt_service *svc)
Register GATT service.
ssize_t bt_gatt_attr_write_ccc(struct bt_conn *conn, const struct bt_gatt_attr *attr, const void *buf, uint16_t len, uint16_t offset, uint8_t flags)
Write Client Characteristic Configuration Attribute helper.
bool bt_gatt_is_subscribed(struct bt_conn *conn, const struct bt_gatt_attr *attr, uint16_t ccc_type)
Check if connection have subscribed to attribute.
#define BT_GATT_CCC_MAX
BT_GATT_CCC_MAX is defined depending on whether CONFIG_BT_SETTINGS_CCC_LAZY_LOADING or CONFIG_BT_CONN...
Definition gatt.h:1024
void(* bt_gatt_complete_func_t)(struct bt_conn *conn, void *user_data)
Notification complete result callback.
Definition gatt.h:1345
ssize_t bt_gatt_attr_read_service(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Service Attribute helper.
struct bt_gatt_attr * bt_gatt_find_by_uuid(const struct bt_gatt_attr *attr, uint16_t attr_count, const struct bt_uuid *uuid)
Find Attribute by UUID.
ssize_t bt_gatt_attr_read_chrc(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Read Characteristic Attribute helper.
void bt_gatt_foreach_attr_type(uint16_t start_handle, uint16_t end_handle, const struct bt_uuid *uuid, const void *attr_data, uint16_t num_matches, bt_gatt_attr_func_t func, void *user_data)
Attribute iterator by type.
bool bt_gatt_service_is_registered(const struct bt_gatt_service *svc)
Check if GATT service is registered.
int bt_gatt_service_unregister(struct bt_gatt_service *svc)
Unregister GATT service.
ssize_t bt_gatt_attr_read(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t buf_len, uint16_t offset, const void *value, uint16_t value_len)
Generic Read Attribute value helper.
static const char * bt_gatt_err_to_str(int gatt_err)
Converts a GATT error to string.
Definition gatt.h:611
@ BT_GATT_ITER_STOP
Definition gatt.h:693
@ BT_GATT_ITER_CONTINUE
Definition gatt.h:694
ssize_t(* bt_gatt_attr_write_func_t)(struct bt_conn *conn, const struct bt_gatt_attr *attr, const void *buf, uint16_t len, uint16_t offset, uint8_t flags)
Attribute Value write implementation.
Definition gatt.h:212
ssize_t(* bt_gatt_attr_read_func_t)(struct bt_conn *conn, const struct bt_gatt_attr *attr, void *buf, uint16_t len, uint16_t offset)
Attribute read callback.
Definition gatt.h:169
bt_gatt_attr_write_flag
GATT attribute write flags.
Definition gatt.h:112
bt_gatt_perm
GATT attribute permission bit field values.
Definition gatt.h:46
@ BT_GATT_WRITE_FLAG_PREPARE
Attribute prepare write flag.
Definition gatt.h:118
@ BT_GATT_WRITE_FLAG_CMD
Attribute write command flag.
Definition gatt.h:125
@ BT_GATT_WRITE_FLAG_EXECUTE
Attribute write execute flag.
Definition gatt.h:133
@ BT_GATT_PERM_READ_ENCRYPT
Attribute read permission with encryption.
Definition gatt.h:60
@ BT_GATT_PERM_WRITE
Attribute write permission.
Definition gatt.h:54
@ BT_GATT_PERM_WRITE_ENCRYPT
Attribute write permission with encryption.
Definition gatt.h:66
@ BT_GATT_PERM_NONE
No operations supported, e.g.
Definition gatt.h:48
@ BT_GATT_PERM_READ
Attribute read permission.
Definition gatt.h:51
@ BT_GATT_PERM_PREPARE_WRITE
Attribute prepare write permission.
Definition gatt.h:87
@ BT_GATT_PERM_WRITE_LESC
Attribute write permission with LE Secure Connection encryption.
Definition gatt.h:99
@ BT_GATT_PERM_READ_AUTHEN
Attribute read permission with authentication.
Definition gatt.h:73
@ BT_GATT_PERM_WRITE_AUTHEN
Attribute write permission with authentication.
Definition gatt.h:80
@ BT_GATT_PERM_READ_LESC
Attribute read permission with LE Secure Connection encryption.
Definition gatt.h:93
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:39
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define NULL
Definition iar_missing_defs.h:20
__SIZE_TYPE__ ssize_t
Definition types.h:28
flags
Definition parser.h:97
#define bool
Definition stdbool.h:13
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
__INT8_TYPE__ int8_t
Definition stdint.h:72
void * memset(void *buf, int c, size_t n)
Bluetooth LE Device Address.
Definition addr.h:49
GATT Attribute.
Definition gatt.h:227
bt_gatt_attr_read_func_t read
Attribute Value read method.
Definition gatt.h:254
uint16_t perm
Attribute Permissions.
Definition gatt.h:299
bt_gatt_attr_write_func_t write
Attribute Value write method.
Definition gatt.h:267
const struct bt_uuid * uuid
Attribute Type.
Definition gatt.h:241
void * user_data
Private data for read() and write() implementation.
Definition gatt.h:280
uint16_t handle
Attribute Handle.
Definition gatt.h:290
GATT authorization callback structure.
Definition gatt.h:392
bool(* read_authorize)(struct bt_conn *conn, const struct bt_gatt_attr *attr)
Authorize the GATT read operation.
Definition gatt.h:404
bool(* write_authorize)(struct bt_conn *conn, const struct bt_gatt_attr *attr)
Authorize the GATT write operation.
Definition gatt.h:418
GATT callback structure.
Definition gatt.h:372
void(* att_mtu_updated)(struct bt_conn *conn, uint16_t tx, uint16_t rx)
The maximum ATT MTU on a connection has changed.
Definition gatt.h:382
GATT CCC configuration entry.
Definition gatt.h:1033
uint16_t value
Configuration value Value used to enable or disable notifications or indications for a specific chara...
Definition gatt.h:1042
bt_addr_le_t peer
Remote peer address.
Definition gatt.h:1037
uint8_t id
Local identity, BT_ID_DEFAULT in most cases.
Definition gatt.h:1035
Internal representation of CCC value.
Definition gatt.h:1052
void(* cfg_changed)(const struct bt_gatt_attr *attr, uint16_t value)
CCC attribute changed callback.
Definition gatt.h:1064
struct bt_gatt_ccc_cfg cfg[0]
Configuration for each connection.
Definition gatt.h:1054
ssize_t(* cfg_write)(struct bt_conn *conn, const struct bt_gatt_attr *attr, uint16_t value)
CCC attribute write validation callback.
Definition gatt.h:1075
uint16_t value
Highest value of all connected peer's subscriptions.
Definition gatt.h:1057
bool(* cfg_match)(struct bt_conn *conn, const struct bt_gatt_attr *attr)
CCC attribute match handler.
Definition gatt.h:1089
Client Characteristic Configuration Attribute Value.
Definition gatt.h:525
uint16_t flags
Client Characteristic Configuration flags, a bitmap of BT_GATT_CCC_* macros.
Definition gatt.h:527
Characteristic Extended Properties Attribute Value.
Definition gatt.h:501
uint16_t properties
Characteristic Extended properties, a bitmap of BT_GATT_CEP_* macros.
Definition gatt.h:503
Attribute Value of a Characteristic Declaration.
Definition gatt.h:481
uint16_t value_handle
Characteristic Value handle.
Definition gatt.h:485
uint8_t properties
Characteristic properties, a bitmap of BT_GATT_CHRC_* macros.
Definition gatt.h:487
const struct bt_uuid * uuid
Characteristic UUID.
Definition gatt.h:483
GATT Characteristic Presentation Format Attribute Value.
Definition gatt.h:554
uint8_t name_space
Name space of the description.
Definition gatt.h:579
uint16_t unit
UUID of the unit of the characteristic.
Definition gatt.h:572
int8_t exponent
Exponent field for value formatting.
Definition gatt.h:566
uint16_t description
Description of the characteristic as defined in a higher layer profile.
Definition gatt.h:586
uint8_t format
Format of the value of the characteristic.
Definition gatt.h:560
GATT Discover Attributes parameters.
Definition gatt.h:1819
uint16_t start_handle
Starting attribute handle for included service.
Definition gatt.h:1830
uint16_t end_handle
Ending attribute handle for included service.
Definition gatt.h:1832
bt_gatt_discover_func_t func
Discover attribute callback.
Definition gatt.h:1823
uint16_t attr_handle
Include service attribute declaration handle.
Definition gatt.h:1828
const struct bt_uuid * uuid
Discover UUID type.
Definition gatt.h:1821
struct bt_gatt_subscribe_params * sub_params
Only for stack-internal use, used for automatic discovery.
Definition gatt.h:1848
uint8_t type
Discover type.
Definition gatt.h:1845
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:1852
GATT Exchange MTU parameters.
Definition gatt.h:1683
void(* func)(struct bt_conn *conn, uint8_t err, struct bt_gatt_exchange_params *params)
Callback for MTU exchange response.
Definition gatt.h:1685
Include Attribute Value.
Definition gatt.h:362
uint16_t end_handle
Handle of the last attribute within the included service.
Definition gatt.h:368
uint16_t start_handle
Handle of the first attribute within the included service.
Definition gatt.h:366
const struct bt_uuid * uuid
Service UUID.
Definition gatt.h:364
GATT Indicate Value parameters.
Definition gatt.h:1561
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:1586
uint16_t len
Indicate Value length.
Definition gatt.h:1581
const struct bt_gatt_attr * attr
Indicate Attribute object.
Definition gatt.h:1573
const void * data
Indicate Value data.
Definition gatt.h:1579
bt_gatt_indicate_params_destroy_t destroy
Indicate operation complete callback.
Definition gatt.h:1577
bt_gatt_indicate_func_t func
Indicate Value callback.
Definition gatt.h:1575
const struct bt_uuid * uuid
Indicate Attribute UUID type.
Definition gatt.h:1567
GATT notification parameters.
Definition gatt.h:1351
const struct bt_uuid * uuid
Notification Attribute UUID type.
Definition gatt.h:1357
uint16_t len
Notification Value length.
Definition gatt.h:1367
const struct bt_gatt_attr * attr
Notification Attribute object.
Definition gatt.h:1363
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:1374
bt_gatt_complete_func_t func
Notification Value callback.
Definition gatt.h:1369
void * user_data
Notification Value callback user data.
Definition gatt.h:1371
const void * data
Notification Value data.
Definition gatt.h:1365
GATT Read parameters.
Definition gatt.h:1914
size_t handle_count
If equals to 1 single.handle and single.offset are used.
Definition gatt.h:1921
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:1975
uint16_t * handles
Attribute handles to read with Read Multiple Characteristic Values.
Definition gatt.h:1933
uint16_t offset
Attribute data offset.
Definition gatt.h:1927
bt_gatt_read_func_t func
Read attribute callback.
Definition gatt.h:1916
struct bt_gatt_read_params::@172336054125152351005356152301225305321016010030::@372352161252260236002106024214036013303007152222 single
struct bt_gatt_read_params::@172336054125152351005356152301225305321016010030::@371162354121151156017205063160212333251365073232 multiple
bool variable
If true use Read Multiple Variable Length Characteristic Values procedure.
Definition gatt.h:1944
struct bt_gatt_read_params::@172336054125152351005356152301225305321016010030::@261011265054333145327063036013076000041270205077 by_uuid
uint16_t end_handle
Requested end attribute handle number.
Definition gatt.h:1968
uint16_t start_handle
Requested start attribute handle number.
Definition gatt.h:1958
const struct bt_uuid * uuid
2 or 16 octet UUID.
Definition gatt.h:1970
uint16_t handle
Attribute handle.
Definition gatt.h:1925
Server Characteristic Configuration Attribute Value.
Definition gatt.h:544
uint16_t flags
Server Characteristic Configuration flags, a bitmap of BT_GATT_SCC_* macros.
Definition gatt.h:546
Static GATT Service structure.
Definition gatt.h:319
const struct bt_gatt_attr * attrs
Service Attributes.
Definition gatt.h:321
size_t attr_count
Service Attribute count.
Definition gatt.h:323
Service Attribute Value.
Definition gatt.h:349
const struct bt_uuid * uuid
Service UUID.
Definition gatt.h:351
uint16_t end_handle
Handle of the last Attribute within the Service.
Definition gatt.h:353
GATT Service structure.
Definition gatt.h:332
struct bt_gatt_attr * attrs
Service Attributes.
Definition gatt.h:334
size_t attr_count
Service Attribute count.
Definition gatt.h:336
GATT Subscribe parameters.
Definition gatt.h:2211
uint16_t value
Subscribe value.
Definition gatt.h:2230
bt_security_t min_security
Minimum required security for received notification.
Definition gatt.h:2236
uint16_t ccc_handle
Subscribe CCC handle.
Definition gatt.h:2222
bt_gatt_subscribe_func_t subscribe
Subscribe CCC write request response callback If given, called with the subscription parameters given...
Definition gatt.h:2217
uint16_t value_handle
Subscribe value handle.
Definition gatt.h:2220
bt_gatt_notify_func_t notify
Notification value callback.
Definition gatt.h:2213
struct bt_gatt_discover_params * disc_params
Discover parameters used when ccc_handle = BT_GATT_AUTO_DISCOVER_CCC_HANDLE.
Definition gatt.h:2227
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:2248
atomic_t flags[ATOMIC_BITMAP_SIZE(BT_GATT_SUBSCRIBE_NUM_FLAGS)]
Subscription flags, see bt_gatt_sub_flag.
Definition gatt.h:2239
uint16_t end_handle
Subscribe End handle (for automatic discovery)
Definition gatt.h:2225
GATT Write parameters.
Definition gatt.h:2035
bt_gatt_write_func_t func
Response callback.
Definition gatt.h:2037
uint16_t handle
Attribute handle.
Definition gatt.h:2039
const void * data
Data to be written.
Definition gatt.h:2043
enum bt_att_chan_opt chan_opt
Att channel options.
Definition gatt.h:2048
uint16_t offset
Attribute data offset.
Definition gatt.h:2041
uint16_t length
Length of the data.
Definition gatt.h:2045
This is a 'tentative' type and should be used as a pointer only.
Definition uuid.h:50
Binary representation of a UUID.
Definition uuid.h:48
Misc utilities.
Macros to abstract toolchain specific capabilities.
Macro utilities.