Revision control

Copy as Markdown

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef BLUEZ_DATA_P_H
#define BLUEZ_DATA_P_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/private/qglobal_p.h>
#include <QtCore/qendian.h>
#include <sys/socket.h>
#include <QtBluetooth/QBluetoothUuid>
#include <QtCore/qtmetamacros.h>
QT_BEGIN_NAMESPACE
#define ATTRIBUTE_CHANNEL_ID 4
#define SIGNALING_CHANNEL_ID 5
#define SECURITY_CHANNEL_ID 6
#define BTPROTO_L2CAP 0
#define BTPROTO_HCI 1
#define BTPROTO_RFCOMM 3
#define SOL_HCI 0
#define SOL_L2CAP 6
#define SOL_RFCOMM 18
#ifndef SOL_BLUETOOTH
#define SOL_BLUETOOTH 274
#endif
#define RFCOMM_LM 0x03
#define RFCOMM_LM_AUTH 0x0002
#define RFCOMM_LM_ENCRYPT 0x0004
#define RFCOMM_LM_TRUSTED 0x0008
#define RFCOMM_LM_SECURE 0x0020
#define L2CAP_LM 0x03
#define L2CAP_LM_AUTH 0x0002
#define L2CAP_LM_ENCRYPT 0x0004
#define L2CAP_LM_TRUSTED 0x0008
#define L2CAP_LM_SECURE 0x0020
#define BT_SECURITY 4
struct bt_security {
quint8 level;
quint8 key_size;
};
#define BT_SECURITY_SDP 0
#define BT_SECURITY_LOW 1
#define BT_SECURITY_MEDIUM 2
#define BT_SECURITY_HIGH 3
#define BDADDR_LE_PUBLIC 0x01
#define BDADDR_LE_RANDOM 0x02
#define SCO_LINK 0x00
#define ACL_LINK 0x01
#define ESCO_LINK 0x02
#define LE_LINK 0x80 // based on hcitool.c -> no fixed constant available
/* Byte order conversions */
#if __BYTE_ORDER == __LITTLE_ENDIAN
#define htobs(d) (d)
#define htobl(d) (d)
#define htobll(d) (d)
#define btohs(d) (d)
#define btohl(d) (d)
#define btohll(d) (d)
#elif __BYTE_ORDER == __BIG_ENDIAN
#define htobs(d) qbswap((quint16)(d))
#define htobl(d) qbswap((quint32)(d))
#define htobll(d) qbswap((quint64)(d))
#define btohs(d) qbswap((quint16)(d))
#define btohl(d) qbswap((quint32)(d))
#define btohll(d) qbswap((quint64)(d))
#else
#error "Unknown byte order"
#endif
#define HCIGETCONNLIST _IOR('H', 212, int)
#define HCIGETDEVINFO _IOR('H', 211, int)
#define HCIGETDEVLIST _IOR('H', 210, int)
// Generic 128 bits of data
typedef QUuid::Id128Bytes BluezUint128;
// Bluetooth address
typedef struct {
quint8 b[6];
} __attribute__((packed)) bdaddr_t;
// L2CP socket
struct sockaddr_l2 {
sa_family_t l2_family;
unsigned short l2_psm;
bdaddr_t l2_bdaddr;
unsigned short l2_cid;
#if !defined(QT_BLUEZ_NO_BTLE)
quint8 l2_bdaddr_type;
#endif
};
// RFCOMM socket
struct sockaddr_rc {
sa_family_t rc_family;
bdaddr_t rc_bdaddr;
quint8 rc_channel;
};
// Bt Low Energy related
template<typename T> inline T getBtData(const void *ptr)
{
return qFromLittleEndian<T>(reinterpret_cast<const uchar *>(ptr));
}
static inline quint16 bt_get_le16(const void *ptr)
{
return getBtData<quint16>(ptr);
}
template<typename T> inline void putBtData(T src, void *dst)
{
qToLittleEndian(src, reinterpret_cast<uchar *>(dst));
}
// HCI related
#define HCI_MAX_DEV 16
#define HCI_DEV_NONE 0xffff
#define HCI_CHANNEL_CONTROL 0x3
#define HCI_MAX_EVENT_SIZE 260
// HCI sockopts
#define HCI_FILTER 2
// HCI packet types
#define HCI_COMMAND_PKT 0x01
#define HCI_ACL_PKT 0x02
#define HCI_EVENT_PKT 0x04
#define HCI_VENDOR_PKT 0xff
#define HCI_FLT_TYPE_BITS 31
#define HCI_FLT_EVENT_BITS 63
struct sockaddr_hci {
sa_family_t hci_family;
unsigned short hci_dev;
unsigned short hci_channel;
};
struct hci_dev_req {
quint16 dev_id;
quint32 dev_opt;
};
struct hci_dev_list_req {
quint16 dev_num;
struct hci_dev_req dev_req[0];
};
struct hci_dev_stats {
quint32 err_rx;
quint32 err_tx;
quint32 cmd_tx;
quint32 evt_rx;
quint32 acl_tx;
quint32 acl_rx;
quint32 sco_tx;
quint32 sco_rx;
quint32 byte_rx;
quint32 byte_tx;
};
struct hci_dev_info {
quint16 dev_id;
char name[8];
bdaddr_t bdaddr;
quint32 flags;
quint8 type;
quint8 features[8];
quint32 pkt_type;
quint32 link_policy;
quint32 link_mode;
quint16 acl_mtu;
quint16 acl_pkts;
quint16 sco_mtu;
quint16 sco_pkts;
struct hci_dev_stats stat;
};
struct hci_conn_info {
quint16 handle;
bdaddr_t bdaddr;
quint8 type;
quint8 out;
quint16 state;
quint32 link_mode;
};
struct hci_conn_list_req {
quint16 dev_id;
quint16 conn_num;
struct hci_conn_info conn_info[0];
};
struct hci_filter {
quint32 type_mask;
quint32 event_mask[2];
quint16 opcode;
};
static inline void hci_set_bit(int nr, void *addr)
{
*((quint32 *) addr + (nr >> 5)) |= (1 << (nr & 31));
}
static inline void hci_clear_bit(int nr, void *addr)
{
*((quint32 *) addr + (nr >> 5)) &= ~(1 << (nr & 31));
}
static inline void hci_filter_clear(struct hci_filter *f)
{
memset(f, 0, sizeof(*f));
}
static inline void hci_filter_set_ptype(int t, struct hci_filter *f)
{
hci_set_bit((t == HCI_VENDOR_PKT) ? 0 : (t & HCI_FLT_TYPE_BITS), &f->type_mask);
}
static inline void hci_filter_clear_ptype(int t, struct hci_filter *f)
{
hci_clear_bit((t == HCI_VENDOR_PKT) ? 0 : (t & HCI_FLT_TYPE_BITS), &f->type_mask);
}
static inline void hci_filter_set_event(int e, struct hci_filter *f)
{
hci_set_bit((e & HCI_FLT_EVENT_BITS), &f->event_mask);
}
static inline void hci_filter_clear_event(int e, struct hci_filter *f)
{
hci_clear_bit((e & HCI_FLT_EVENT_BITS), &f->event_mask);
}
static inline void hci_filter_all_ptypes(struct hci_filter *f)
{
memset((void *) &f->type_mask, 0xff, sizeof(f->type_mask));
}
static inline void hci_filter_all_events(struct hci_filter *f)
{
memset((void *) f->event_mask, 0xff, sizeof(f->event_mask));
}
typedef struct {
quint8 evt;
quint8 plen;
} __attribute__ ((packed)) hci_event_hdr;
#define HCI_EVENT_HDR_SIZE 2
typedef struct {
quint8 status;
quint16 handle;
quint8 encrypt;
} __attribute__ ((packed)) evt_encrypt_change;
#define EVT_ENCRYPT_CHANGE_SIZE 4
struct evt_cmd_complete {
quint8 ncmd;
quint16 opcode;
} __attribute__ ((packed));
struct AclData {
quint16 handle: 12;
quint16 pbFlag: 2;
quint16 bcFlag: 2;
quint16 dataLen;
};
struct L2CapHeader {
quint16 length;
quint16 channelId;
};
struct hci_command_hdr {
quint16 opcode; /* OCF & OGF */
quint8 plen;
} __attribute__ ((packed));
namespace QBluezConst {
Q_NAMESPACE
enum OpCodeGroupField {
OgfLinkControl = 0x8,
};
Q_ENUM_NS(OpCodeGroupField)
enum OpCodeCommandField {
OcfLeSetAdvParams = 0x6,
OcfLeReadTxPowerLevel = 0x7,
OcfLeSetAdvData = 0x8,
OcfLeSetScanResponseData = 0x9,
OcfLeSetAdvEnable = 0xa,
OcfLeClearWhiteList = 0x10,
OcfLeAddToWhiteList = 0x11,
OcfLeConnectionUpdate = 0x13,
};
Q_ENUM_NS(OpCodeCommandField)
enum class AttCommand : quint8 {
ATT_OP_ERROR_RESPONSE = 0x01,
ATT_OP_EXCHANGE_MTU_REQUEST = 0x02, //send own mtu
ATT_OP_EXCHANGE_MTU_RESPONSE = 0x03, //receive server MTU
ATT_OP_FIND_INFORMATION_REQUEST = 0x04, //discover individual attribute info
ATT_OP_FIND_INFORMATION_RESPONSE = 0x05,
ATT_OP_FIND_BY_TYPE_VALUE_REQUEST = 0x06,
ATT_OP_FIND_BY_TYPE_VALUE_RESPONSE = 0x07,
ATT_OP_READ_BY_TYPE_REQUEST = 0x08, //discover characteristics
ATT_OP_READ_BY_TYPE_RESPONSE = 0x09,
ATT_OP_READ_REQUEST = 0x0A, //read characteristic & descriptor values
ATT_OP_READ_RESPONSE = 0x0B,
ATT_OP_READ_BLOB_REQUEST = 0x0C, //read values longer than MTU-1
ATT_OP_READ_BLOB_RESPONSE = 0x0D,
ATT_OP_READ_MULTIPLE_REQUEST = 0x0E,
ATT_OP_READ_MULTIPLE_RESPONSE = 0x0F,
ATT_OP_READ_BY_GROUP_REQUEST = 0x10, //discover services
ATT_OP_READ_BY_GROUP_RESPONSE = 0x11,
ATT_OP_WRITE_REQUEST = 0x12, //write characteristic with response
ATT_OP_WRITE_RESPONSE = 0x13,
ATT_OP_PREPARE_WRITE_REQUEST = 0x16, //write values longer than MTU-3 -> queueing
ATT_OP_PREPARE_WRITE_RESPONSE = 0x17,
ATT_OP_EXECUTE_WRITE_REQUEST = 0x18, //write values longer than MTU-3 -> execute queue
ATT_OP_EXECUTE_WRITE_RESPONSE = 0x19,
ATT_OP_HANDLE_VAL_NOTIFICATION = 0x1b, //informs about value change
ATT_OP_HANDLE_VAL_INDICATION = 0x1d, //informs about value change -> requires reply
ATT_OP_HANDLE_VAL_CONFIRMATION = 0x1e, //answer for ATT_OP_HANDLE_VAL_INDICATION
ATT_OP_WRITE_COMMAND = 0x52, //write characteristic without response
ATT_OP_SIGNED_WRITE_COMMAND = 0xD2
};
Q_ENUM_NS(AttCommand)
enum class AttError : quint8 {
ATT_ERROR_NO_ERROR = 0x00,
ATT_ERROR_INVALID_HANDLE = 0x01,
ATT_ERROR_READ_NOT_PERM = 0x02,
ATT_ERROR_WRITE_NOT_PERM = 0x03,
ATT_ERROR_INVALID_PDU = 0x04,
ATT_ERROR_INSUF_AUTHENTICATION = 0x05,
ATT_ERROR_REQUEST_NOT_SUPPORTED = 0x06,
ATT_ERROR_INVALID_OFFSET = 0x07,
ATT_ERROR_INSUF_AUTHORIZATION = 0x08,
ATT_ERROR_PREPARE_QUEUE_FULL = 0x09,
ATT_ERROR_ATTRIBUTE_NOT_FOUND = 0x0A,
ATT_ERROR_ATTRIBUTE_NOT_LONG = 0x0B,
ATT_ERROR_INSUF_ENCR_KEY_SIZE = 0x0C,
ATT_ERROR_INVAL_ATTR_VALUE_LEN = 0x0D,
ATT_ERROR_UNLIKELY = 0x0E,
ATT_ERROR_INSUF_ENCRYPTION = 0x0F,
ATT_ERROR_UNSUPPRTED_GROUP_TYPE = 0x10,
ATT_ERROR_INSUF_RESOURCES = 0x11,
ATT_ERROR_APPLICATION_START = 0x80,
//------------------------------------------
// The error codes in this block are
// implementation specific errors
ATT_ERROR_REQUEST_STALLED = 0x81,
//------------------------------------------
ATT_ERROR_APPLICATION_END = 0x9f
};
Q_ENUM_NS(AttError)
}
/* Command opcode pack/unpack */
#define opCodePack(ogf, ocf) (quint16(((ocf) & 0x03ff)|((ogf) << 10)))
#define ogfFromOpCode(op) ((op) >> 10)
#define ocfFromOpCode(op) ((op) & 0x03ff)
QT_END_NAMESPACE
#endif // BLUEZ_DATA_P_H