att.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_ATT_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_ATT_H_
 
#include <stdint.h>
#include <stddef.h>
 
#include <zephyr/bluetooth/conn.h>
#include <zephyr/sys/slist.h>
#include <zephyr/sys/util_macro.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Error codes for Error response PDU
 *
 * Defined by The Bluetooth Core Specification, Version 5.4, Vol 3, Part F, Section 3.4.1.1
 */
#define BT_ATT_ERR_SUCCESS                      0x00
#define BT_ATT_ERR_INVALID_HANDLE               0x01
#define BT_ATT_ERR_READ_NOT_PERMITTED           0x02
#define BT_ATT_ERR_WRITE_NOT_PERMITTED          0x03
#define BT_ATT_ERR_INVALID_PDU                  0x04
#define BT_ATT_ERR_AUTHENTICATION               0x05
#define BT_ATT_ERR_NOT_SUPPORTED                0x06
#define BT_ATT_ERR_INVALID_OFFSET               0x07
#define BT_ATT_ERR_AUTHORIZATION                0x08
#define BT_ATT_ERR_PREPARE_QUEUE_FULL           0x09
#define BT_ATT_ERR_ATTRIBUTE_NOT_FOUND          0x0a
#define BT_ATT_ERR_ATTRIBUTE_NOT_LONG           0x0b
#define BT_ATT_ERR_ENCRYPTION_KEY_SIZE          0x0c
#define BT_ATT_ERR_INVALID_ATTRIBUTE_LEN        0x0d
#define BT_ATT_ERR_UNLIKELY                     0x0e
#define BT_ATT_ERR_INSUFFICIENT_ENCRYPTION      0x0f
#define BT_ATT_ERR_UNSUPPORTED_GROUP_TYPE       0x10
#define BT_ATT_ERR_INSUFFICIENT_RESOURCES       0x11
#define BT_ATT_ERR_DB_OUT_OF_SYNC               0x12
#define BT_ATT_ERR_VALUE_NOT_ALLOWED            0x13
 
/* Common Profile Error Codes
 *
 * Defined by the Supplement to the Bluetooth Core Specification (CSS), v11, Part B, Section 1.2.
 */
#define BT_ATT_ERR_WRITE_REQ_REJECTED           0xfc
#define BT_ATT_ERR_CCC_IMPROPER_CONF            0xfd
#define BT_ATT_ERR_PROCEDURE_IN_PROGRESS        0xfe
#define BT_ATT_ERR_OUT_OF_RANGE                 0xff
 
/* Version 5.2, Vol 3, Part F, 3.2.9 defines maximum attribute length to 512 */
#define BT_ATT_MAX_ATTRIBUTE_LEN                512
 
/* Handle 0x0000 is reserved for future use */
#define BT_ATT_FIRST_ATTRIBUTE_HANDLE           0x0001
/* 0xffff is defined as the maximum, and thus last, valid attribute handle */
#define BT_ATT_LAST_ATTRIBUTE_HANDLE            0xffff
 
#if defined(CONFIG_BT_ATT_ERR_TO_STR)
const char *bt_att_err_to_str(uint8_t att_err);
#else
#include <zephyr/toolchain.h>
 
static inline const char *bt_att_err_to_str(uint8_t att_err)
{
        ARG_UNUSED(att_err);
 
        return "";
}
#endif
 
#if defined(CONFIG_BT_EATT)
#if defined(CONFIG_BT_TESTING)
 
int bt_eatt_disconnect_one(struct bt_conn *conn);
 
/* Reconfigure all EATT channels on connection */
int bt_eatt_reconfigure(struct bt_conn *conn, uint16_t mtu);
 
#endif /* CONFIG_BT_TESTING */
 
int bt_eatt_connect(struct bt_conn *conn, size_t num_channels);
 
size_t bt_eatt_count(struct bt_conn *conn);
 
#endif /* CONFIG_BT_EATT */
 
enum bt_att_chan_opt {
        BT_ATT_CHAN_OPT_NONE = 0x0,
        BT_ATT_CHAN_OPT_UNENHANCED_ONLY = BIT(0),
        BT_ATT_CHAN_OPT_ENHANCED_ONLY = BIT(1),
};
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_ATT_H_ */