michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: Add GATT skeleton

Browse source 
This adds initial API and definitions to create a database.

Change-Id: I69d5b3f5fd2f04cc309c2f76a84581673aa54e7b
Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2015-05-12 16:03:09 +03:00 • committed by Anas Nashif
commit de52b09a3f
4 changed files with 435 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

272
include/bluetooth/gatt.h Normal file
View file

@ -0,0 +1,272 @@
/* gatt.h - Generic Attribute Profile handling */
/*
* Copyright (c) 2015 Intel Corporation
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1) Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2) Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3) Neither the name of Intel Corporation nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __BT_GATT_H
#define __BT_GATT_H
/* GATT Attribute structure */
struct bt_gatt_attr {
uint16_t handle;
const struct bt_uuid *uuid;
int (*read)(const struct bt_gatt_attr *attr,
void *buf, uint8_t len,
uint16_t offset);
int (*write)(const struct bt_gatt_attr *attr,
const void *buf, uint8_t len,
uint16_t offset);
void *user_data;
};
/* Service Attribute Value */
struct bt_gatt_service {
const struct bt_uuid *uuid;
};
/* Include Attribute Value */
struct bt_gatt_include {
uint16_t start_handle;
uint16_t end_handle;
const struct bt_uuid *uuid;
};
/* Characteristic Properties Bitfield values */
#define BT_GATT_CHRC_BROADCAST 0x01
#define BT_GATT_CHRC_READ 0x02
#define BT_GATT_CHRC_WRITE_WITHOUT_RESP 0x04
#define BT_GATT_CHRC_WRITE 0x08
#define BT_GATT_CHRC_NOTIFY 0x10
#define BT_GATT_CHRC_INDICATE 0x20
#define BT_GATT_CHRC_AUTH 0x40
#define BT_GATT_CHRC_EXT_PROP 0x80
/* Characteristic Attribute Value */
struct bt_gatt_chrc {
uint8_t properties;
uint16_t value_handle;
const struct bt_uuid *uuid;
};
/* Characteristic Extended Properties Bitfield values */
#define BT_GATT_CEP_RELIABLE_WRITE 0x01
#define BT_GATT_CEP_WRITABLE_AUX 0x02
/* Characteristic Extended Properties Attribute Value */
struct bt_gatt_cep {
uint8_t properties;
};
/* Characteristic User Description Attribute Value */
struct bt_gatt_cud {
char *string;
};
/* Client Characteristic Configuration.user_datas */
#define BT_GATT_CCC_NOTIFY 0x0001
#define BT_GATT_CCC_INDICATE 0x0002
/* Client Characteristic Configuration Attribute Value */
struct bt_gatt_ccc {
uint16_t flags;
};
/* Server API */
/** @brief Register attribute database
*
* Register GATT attribute database table. Applications can make use of
* macros such as BT_GATT_PRIMARY_SERVICE, BT_GATT_CHARACTERISTIC,
* BT_GATT_DESCRIPTOR, etc.
*
* @param attrs dabase table containing the available attributes
* @param count size of database table
*/
void bt_gatt_register(const struct bt_gatt_attr *attrs, size_t count);
/** @brief Generic Read Attribute value helper
*
* Read attribute value storing the result into buffer.
*
* @param attr attribute to read
* @param buf buffer to store the value
* @param buf_len buffer length
* @param offset start offset
* @param value attribute value
* @param value_len length of the attribute value
*
* @return int number of bytes read in case of success or negative values in
* case of error.
*/
int bt_gatt_attr_read(const struct bt_gatt_attr *attr, void *buf,
uint8_t buf_len, uint16_t offset, const void *value,
uint8_t value_len);
/** @brief Read Service Attribute helper
*
* Read service attribute value storing the result into buffer after
* enconding it.
* NOTE: Only use this with attributes which user_data is a bt_uuid.
*
* @param attr attribute to read
* @param buf buffer to store the value read
* @param len buffer length
* @param offset start offset
*
* @return int number of bytes read in case of success or negative values in
* case of error.
*/
int bt_gatt_attr_read_service(const struct bt_gatt_attr *attr,
void *buf, uint8_t len, uint16_t offset);
/** @brief Generic Service Declaration Macro
*
* Helper macro to declare a service attribute.
*
* @param _handle service attribute handle
* @param _uuid service attribute type
* @param _data service attribute value
*/
#define BT_GATT_SERVICE(_handle, _uuid, _service) \
{ \
.handle = _handle, \
.uuid = _uuid, \
.read = bt_gatt_attr_read_service, \
.user_data = _service, \
}
/** @brief Primary Service Declaration Macro
*
* Helper macro to declare a primary service attribute.
*
* @param _handle service attribute handle
* @param _service service attribute value
*/
#define BT_GATT_PRIMARY_SERVICE(_handle, _service) \
{ \
.handle = _handle, \
.uuid = (&(struct bt_uuid) { .type = BT_UUID_16, \
.u16 = BT_UUID_GATT_PRIMARY }), \
.read = bt_gatt_attr_read_service, \
.user_data = _service, \
}
/** @brief Secondary Service Declaration Macro
*
* Helper macro to declare a secondary service attribute.
*
* @param _handle service attribute handle
* @param _service service attribute value
*/
#define BT_GATT_SECONDARY_SERVICE(_handle, _service) \
{ \
.handle = _handle, \
.uuid = (&(struct bt_uuid) { .type = BT_UUID_16, \
.u16 = BT_UUID_GATT_SECONDARY }), \
.read = bt_gatt_attr_read_service, \
.user_data = _service, \
}
/** @brief Read Include Attribute helper
*
* Read include service attribute value storing the result into buffer after
* enconding it.
* NOTE: Only use this with attributes which user_data is a bt_gatt_include.
*
* @param attr attribute to read
* @param buf buffer to store the value read
* @param len buffer length
* @param offset start offset
*
* @return int number of bytes read in case of success or negative values in
* case of error.
*/
int bt_gatt_attr_read_included(const struct bt_gatt_attr *attr,
void *buf, uint8_t len, uint16_t offset);
/* Include Service Declaration */
#define BT_GATT_INCLUDE_SERVICE(_handle, _service) \
{ \
.handle = _handle, \
.uuid = (&(struct bt_uuid) { .type = BT_UUID_16, \
.u16 = BT_UUID_GATT_INCLUDE }), \
.read = bt_gatt_attr_read_included, \
.user_data = _service, \
}
/** @brief Read Characteristic Attribute helper
*
* Read characteristic attribute value storing the result into buffer after
* enconding it.
* NOTE: Only use this with attributes which user_data is a bt_gatt_chrc.
*
* @param attr attribute to read
* @param buf buffer to store the value read
* @param len buffer length
* @param offset start offset
*
* @return number of bytes read in case of success or negative values in
* case of error.
*/
int bt_gatt_attr_read_chrc(const struct bt_gatt_attr *attr, void *buf,
uint8_t len, uint16_t offset);
/** @brief Characteristic Declaration Macro
*
* Helper macro to declare a characteristic attribute.
*
* @param _handle characteristic attribute handle
* @param _value characteristic attribute value
*/
#define BT_GATT_CHARACTERISTIC(_handle, _value) \
{ \
.handle = _handle, \
.uuid = (&(struct bt_uuid) { .type = BT_UUID_16, \
.u16 = BT_UUID_GATT_CHRC }), \
.read = bt_gatt_attr_read_chrc, \
.user_data = _value, \
}
/** @brief Descriptor Declaration Macro
*
* Helper macro to declare a descriptor attribute.
*
* @param _handle descriptor attribute handle
* @param _value descriptor attribute value
*/
#define BT_GATT_DESCRIPTOR(_handle, _uuid, _read, _write, _value) \
{ \
.handle = _handle, \
.uuid = _uuid, \
.read = _read, \
.write = _write, \
.user_data = _value, \
}
#endif /* __BT_GATT_H */

12
include/bluetooth/uuid.h
View file

@ -32,6 +32,18 @@
#ifndef __BT_UUID_H
#define __BT_UUID_H
#define BT_UUID_GAP 0x1800
#define BT_UUID_GATT 0x1801
#define BT_UUID_GATT_PRIMARY 0x2800
#define BT_UUID_GATT_SECONDARY 0x2801
#define BT_UUID_GATT_INCLUDE 0x2802
#define BT_UUID_GATT_CHRC 0x2803
#define BT_UUID_GATT_CEP 0x2900
#define BT_UUID_GATT_CUD 0x2901
#define BT_UUID_GATT_CCC 0x2902
#define BT_UUID_GAP_DEVICE_NAME 0x2a00
#define BT_UUID_GAP_APPEARANCE 0x2a01
/* Bluetooth UUID types */
enum bt_uuid_type {
BT_UUID_16,