Bluetooth: Audio: Volume Offset Control Service and Client
This commit implements the secondary service Volume Offset Control Service (VOCS) server and client. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
This commit is contained in:
Emil Gydesen
Anas Nashif
parent
cdd02a99a1
commit
ed2162c700
10 changed files with 1692 additions and 0 deletions
482
subsys/bluetooth/audio/vocs.c
Normal file
482
subsys/bluetooth/audio/vocs.c
Normal file
|
|
@ -0,0 +1,482 @@
|
|||
/* Bluetooth VOCS - Volume offset Control Service
|
||||
*
|
||||
* Copyright (c) 2021 Nordic Semiconductor ASA
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <zephyr.h>
|
||||
#include <sys/byteorder.h>
|
||||
#include <sys/check.h>
|
||||
|
||||
#include <device.h>
|
||||
#include <init.h>
|
||||
|
||||
#include <bluetooth/bluetooth.h>
|
||||
#include <bluetooth/conn.h>
|
||||
#include <bluetooth/gatt.h>
|
||||
#include <bluetooth/audio/vocs.h>
|
||||
|
||||
#include "vocs_internal.h"
|
||||
|
||||
#define BT_DBG_ENABLED IS_ENABLED(CONFIG_BT_DEBUG_VOCS)
|
||||
#define LOG_MODULE_NAME bt_vocs
|
||||
#include "common/log.h"
|
||||
|
||||
#define VALID_VOCS_OPCODE(opcode) ((opcode) == VOCS_OPCODE_SET_OFFSET)
|
||||
|
||||
#if defined(CONFIG_BT_VOCS)
|
||||
static void offset_state_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value)
|
||||
{
|
||||
BT_DBG("value 0x%04x", value);
|
||||
}
|
||||
|
||||
static ssize_t read_offset_state(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
void *buf, uint16_t len, uint16_t offset)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
|
||||
BT_DBG("offset %d, counter %u", inst->state.offset, inst->state.change_counter);
|
||||
return bt_gatt_attr_read(conn, attr, buf, len, offset, &inst->state, sizeof(inst->state));
|
||||
}
|
||||
|
||||
static void location_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value)
|
||||
{
|
||||
BT_DBG("value 0x%04x", value);
|
||||
}
|
||||
|
||||
#endif /* CONFIG_BT_VOCS */
|
||||
|
||||
static ssize_t write_location(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
const void *buf, uint16_t len, uint16_t offset, uint8_t flags)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
uint32_t old_location = inst->location;
|
||||
|
||||
if (len != sizeof(inst->location)) {
|
||||
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
|
||||
}
|
||||
|
||||
memcpy(&inst->location, buf, len);
|
||||
BT_DBG("%02x", inst->location);
|
||||
|
||||
if (old_location != inst->location) {
|
||||
bt_gatt_notify_uuid(NULL, BT_UUID_VOCS_LOCATION, inst->service_p->attrs,
|
||||
&inst->location, sizeof(inst->location));
|
||||
|
||||
if (inst->cb && inst->cb->location) {
|
||||
inst->cb->location(NULL, (struct bt_vocs *)inst, 0, inst->location);
|
||||
}
|
||||
}
|
||||
|
||||
return len;
|
||||
}
|
||||
|
||||
#if defined(CONFIG_BT_VOCS)
|
||||
static ssize_t read_location(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
void *buf, uint16_t len, uint16_t offset)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
|
||||
BT_DBG("0x%02x", inst->location);
|
||||
return bt_gatt_attr_read(conn, attr, buf, len, offset, &inst->location,
|
||||
sizeof(inst->location));
|
||||
}
|
||||
#endif /* CONFIG_BT_VOCS */
|
||||
|
||||
static ssize_t write_vocs_control(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
const void *buf, uint16_t len, uint16_t offset, uint8_t flags)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
const struct vocs_control_t *cp = buf;
|
||||
bool notify = false;
|
||||
|
||||
if (!len || !buf) {
|
||||
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
|
||||
}
|
||||
|
||||
/* Check opcode before length */
|
||||
if (!VALID_VOCS_OPCODE(cp->opcode)) {
|
||||
BT_DBG("Invalid opcode %u", cp->opcode);
|
||||
return BT_GATT_ERR(BT_VOCS_ERR_OP_NOT_SUPPORTED);
|
||||
}
|
||||
|
||||
if (offset) {
|
||||
return BT_GATT_ERR(BT_ATT_ERR_INVALID_OFFSET);
|
||||
}
|
||||
|
||||
if (len != sizeof(struct vocs_control_t)) {
|
||||
return BT_GATT_ERR(BT_ATT_ERR_INVALID_ATTRIBUTE_LEN);
|
||||
}
|
||||
|
||||
BT_DBG("Opcode %u, counter %u", cp->opcode, cp->counter);
|
||||
|
||||
|
||||
if (cp->counter != inst->state.change_counter) {
|
||||
return BT_GATT_ERR(BT_VOCS_ERR_INVALID_COUNTER);
|
||||
}
|
||||
|
||||
switch (cp->opcode) {
|
||||
case VOCS_OPCODE_SET_OFFSET:
|
||||
BT_DBG("Set offset %d", cp->offset);
|
||||
if (cp->offset > BT_VOCS_MAX_OFFSET || cp->offset < BT_VOCS_MIN_OFFSET) {
|
||||
return BT_GATT_ERR(BT_VOCS_ERR_OUT_OF_RANGE);
|
||||
}
|
||||
|
||||
if (inst->state.offset != sys_le16_to_cpu(cp->offset)) {
|
||||
inst->state.offset = sys_le16_to_cpu(cp->offset);
|
||||
notify = true;
|
||||
}
|
||||
break;
|
||||
default:
|
||||
return BT_GATT_ERR(BT_VOCS_ERR_OP_NOT_SUPPORTED);
|
||||
}
|
||||
|
||||
if (notify) {
|
||||
inst->state.change_counter++;
|
||||
BT_DBG("New state: offset %d, counter %u",
|
||||
inst->state.offset, inst->state.change_counter);
|
||||
bt_gatt_notify_uuid(NULL, BT_UUID_VOCS_STATE, inst->service_p->attrs,
|
||||
&inst->state, sizeof(inst->state));
|
||||
|
||||
if (inst->cb && inst->cb->state) {
|
||||
inst->cb->state(NULL, (struct bt_vocs *)inst, 0, inst->state.offset);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
return len;
|
||||
}
|
||||
|
||||
#if defined(CONFIG_BT_VOCS)
|
||||
static void output_desc_cfg_changed(const struct bt_gatt_attr *attr, uint16_t value)
|
||||
{
|
||||
BT_DBG("value 0x%04x", value);
|
||||
}
|
||||
#endif /* CONFIG_BT_VOCS */
|
||||
|
||||
static ssize_t write_output_desc(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
const void *buf, uint16_t len, uint16_t offset, uint8_t flags)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
|
||||
if (len >= sizeof(inst->output_desc)) {
|
||||
BT_DBG("Output desc was clipped from length %u to %zu",
|
||||
len, sizeof(inst->output_desc) - 1);
|
||||
/* We just clip the string value if it's too long */
|
||||
len = (uint16_t)sizeof(inst->output_desc) - 1;
|
||||
}
|
||||
|
||||
if (len != strlen(inst->output_desc) || memcmp(buf, inst->output_desc, len)) {
|
||||
memcpy(inst->output_desc, buf, len);
|
||||
inst->output_desc[len] = '\0';
|
||||
|
||||
bt_gatt_notify_uuid(NULL, BT_UUID_VOCS_DESCRIPTION, inst->service_p->attrs,
|
||||
&inst->output_desc, strlen(inst->output_desc));
|
||||
|
||||
if (inst->cb && inst->cb->description) {
|
||||
inst->cb->description(NULL, (struct bt_vocs *)inst, 0, inst->output_desc);
|
||||
}
|
||||
}
|
||||
|
||||
BT_DBG("%s", log_strdup(inst->output_desc));
|
||||
|
||||
return len;
|
||||
}
|
||||
|
||||
#if defined(CONFIG_BT_VOCS)
|
||||
static ssize_t read_output_desc(struct bt_conn *conn, const struct bt_gatt_attr *attr,
|
||||
void *buf, uint16_t len, uint16_t offset)
|
||||
{
|
||||
struct vocs_server *inst = attr->user_data;
|
||||
|
||||
BT_DBG("%s", log_strdup(inst->output_desc));
|
||||
return bt_gatt_attr_read(conn, attr, buf, len, offset, &inst->output_desc,
|
||||
strlen(inst->output_desc));
|
||||
}
|
||||
|
||||
#define BT_VOCS_SERVICE_DEFINITION(_vocs) { \
|
||||
BT_GATT_SECONDARY_SERVICE(BT_UUID_VOCS), \
|
||||
BT_GATT_CHARACTERISTIC(BT_UUID_VOCS_STATE, \
|
||||
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
|
||||
BT_GATT_PERM_READ_ENCRYPT, \
|
||||
read_offset_state, NULL, &_vocs), \
|
||||
BT_GATT_CCC(offset_state_cfg_changed, \
|
||||
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
|
||||
BT_GATT_CHARACTERISTIC(BT_UUID_VOCS_LOCATION, \
|
||||
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
|
||||
BT_GATT_PERM_READ_ENCRYPT, \
|
||||
read_location, NULL, &_vocs), \
|
||||
BT_GATT_CCC(location_cfg_changed, \
|
||||
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT), \
|
||||
BT_GATT_CHARACTERISTIC(BT_UUID_VOCS_CONTROL, \
|
||||
BT_GATT_CHRC_WRITE, \
|
||||
BT_GATT_PERM_WRITE_ENCRYPT, \
|
||||
NULL, write_vocs_control, &_vocs), \
|
||||
BT_GATT_CHARACTERISTIC(BT_UUID_VOCS_DESCRIPTION, \
|
||||
BT_GATT_CHRC_READ | BT_GATT_CHRC_NOTIFY, \
|
||||
BT_GATT_PERM_READ_ENCRYPT, \
|
||||
read_output_desc, NULL, &_vocs), \
|
||||
BT_GATT_CCC(output_desc_cfg_changed, \
|
||||
BT_GATT_PERM_READ | BT_GATT_PERM_WRITE_ENCRYPT) \
|
||||
}
|
||||
|
||||
static struct vocs_server vocs_insts[CONFIG_BT_VOCS_MAX_INSTANCE_COUNT];
|
||||
BT_GATT_SERVICE_INSTANCE_DEFINE(vocs_service_list, vocs_insts, CONFIG_BT_VOCS_MAX_INSTANCE_COUNT,
|
||||
BT_VOCS_SERVICE_DEFINITION);
|
||||
|
||||
struct bt_vocs *bt_vocs_free_instance_get(void)
|
||||
{
|
||||
static uint32_t instance_cnt;
|
||||
|
||||
if (instance_cnt >= CONFIG_BT_VOCS_MAX_INSTANCE_COUNT) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return (struct bt_vocs *)&vocs_insts[instance_cnt++];
|
||||
}
|
||||
|
||||
void *bt_vocs_svc_decl_get(struct bt_vocs *vocs)
|
||||
{
|
||||
CHECKIF(!vocs) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return vocs->srv.service_p->attrs;
|
||||
}
|
||||
|
||||
static void prepare_vocs_instances(void)
|
||||
{
|
||||
for (int i = 0; i < ARRAY_SIZE(vocs_insts); i++) {
|
||||
vocs_insts[i].service_p = &vocs_service_list[i];
|
||||
}
|
||||
}
|
||||
|
||||
int bt_vocs_init(struct bt_vocs *vocs, const struct bt_vocs_init_param *init)
|
||||
{
|
||||
int err;
|
||||
struct bt_gatt_attr *attr;
|
||||
struct bt_gatt_chrc *chrc;
|
||||
static bool instances_prepared;
|
||||
|
||||
CHECKIF(!vocs) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (!instances_prepared) {
|
||||
prepare_vocs_instances();
|
||||
instances_prepared = true;
|
||||
}
|
||||
|
||||
CHECKIF(vocs->srv.initialized) {
|
||||
BT_DBG("Already initialized VOCS instance");
|
||||
return -EALREADY;
|
||||
}
|
||||
|
||||
CHECKIF(init->offset > BT_VOCS_MAX_OFFSET || init->offset < BT_VOCS_MIN_OFFSET) {
|
||||
BT_DBG("Invalid offset %d", init->offset);
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
vocs->srv.location = init->location;
|
||||
vocs->srv.state.offset = init->offset;
|
||||
|
||||
if (init->output_desc) {
|
||||
strncpy(vocs->srv.output_desc, init->output_desc,
|
||||
sizeof(vocs->srv.output_desc) - 1);
|
||||
/* strncpy may not always null-terminate */
|
||||
vocs->srv.output_desc[sizeof(vocs->srv.output_desc) - 1] = '\0';
|
||||
if (IS_ENABLED(CONFIG_BT_DEBUG_VOCS) &&
|
||||
strcmp(vocs->srv.output_desc, init->output_desc)) {
|
||||
BT_DBG("Output desc clipped to %s", log_strdup(vocs->srv.output_desc));
|
||||
}
|
||||
}
|
||||
|
||||
/* Iterate over the attributes in VOCS (starting from i = 1 to skip the service declaration)
|
||||
* to find the BT_UUID_VOCS_DESCRIPTION or BT_UUID_VOCS_LOCATION and update the
|
||||
* characteristic value (at [i]), update with the write permission and callback, and
|
||||
* also update the characteristic declaration (always found at [i - 1]) with the
|
||||
* BT_GATT_CHRC_WRITE_WITHOUT_RESP property.
|
||||
*/
|
||||
for (int i = 1; i < vocs->srv.service_p->attr_count; i++) {
|
||||
attr = &vocs->srv.service_p->attrs[i];
|
||||
|
||||
if (init->location_writable && !bt_uuid_cmp(attr->uuid, BT_UUID_VOCS_LOCATION)) {
|
||||
/* Update attr and chrc to be writable */
|
||||
chrc = vocs->srv.service_p->attrs[i - 1].user_data;
|
||||
attr->write = write_location;
|
||||
attr->perm |= BT_GATT_PERM_WRITE_ENCRYPT;
|
||||
chrc->properties |= BT_GATT_CHRC_WRITE_WITHOUT_RESP;
|
||||
} else if (init->desc_writable &&
|
||||
!bt_uuid_cmp(attr->uuid, BT_UUID_VOCS_DESCRIPTION)) {
|
||||
/* Update attr and chrc to be writable */
|
||||
chrc = vocs->srv.service_p->attrs[i - 1].user_data;
|
||||
attr->write = write_output_desc;
|
||||
attr->perm |= BT_GATT_PERM_WRITE_ENCRYPT;
|
||||
chrc->properties |= BT_GATT_CHRC_WRITE_WITHOUT_RESP;
|
||||
}
|
||||
}
|
||||
|
||||
err = bt_gatt_service_register(vocs->srv.service_p);
|
||||
if (err) {
|
||||
BT_DBG("Could not register VOCS service");
|
||||
return err;
|
||||
}
|
||||
|
||||
vocs->srv.initialized = true;
|
||||
return 0;
|
||||
}
|
||||
#endif /* CONFIG_BT_VOCS */
|
||||
|
||||
#if defined(CONFIG_BT_VOCS) || defined(CONFIG_BT_VOCS_CLIENT)
|
||||
|
||||
int bt_vocs_state_get(struct bt_conn *conn, struct bt_vocs *inst)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_state_get(conn, inst);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
if (inst->srv.cb && inst->srv.cb->state) {
|
||||
inst->srv.cb->state(NULL, inst, 0, inst->srv.state.offset);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_location_get(struct bt_conn *conn, struct bt_vocs *inst)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_location_get(conn, inst);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
if (inst->srv.cb && inst->srv.cb->location) {
|
||||
inst->srv.cb->location(NULL, inst, 0, inst->srv.location);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_location_set(struct bt_conn *conn, struct bt_vocs *inst, uint32_t location)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_location_set(conn, inst, location);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
struct bt_gatt_attr attr;
|
||||
int err;
|
||||
|
||||
attr.user_data = inst;
|
||||
|
||||
err = write_location(NULL, &attr, &location, sizeof(location), 0, 0);
|
||||
|
||||
return err > 0 ? 0 : err;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_state_set(struct bt_conn *conn, struct bt_vocs *inst, int16_t offset)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_state_set(conn, inst, offset);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
struct bt_gatt_attr attr;
|
||||
struct vocs_control_t cp;
|
||||
int err;
|
||||
|
||||
cp.opcode = VOCS_OPCODE_SET_OFFSET;
|
||||
cp.counter = inst->srv.state.change_counter;
|
||||
cp.offset = sys_cpu_to_le16(offset);
|
||||
|
||||
attr.user_data = inst;
|
||||
|
||||
err = write_vocs_control(NULL, &attr, &cp, sizeof(cp), 0, 0);
|
||||
|
||||
return err > 0 ? 0 : err;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_description_get(struct bt_conn *conn, struct bt_vocs *inst)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_description_get(conn, inst);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
if (inst->srv.cb && inst->srv.cb->description) {
|
||||
inst->srv.cb->description(NULL, inst, 0, inst->srv.output_desc);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_description_set(struct bt_conn *conn, struct bt_vocs *inst, const char *description)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
CHECKIF(!description) {
|
||||
BT_DBG("Null description pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
if (IS_ENABLED(CONFIG_BT_VOCS_CLIENT) && conn) {
|
||||
return bt_vocs_client_description_set(conn, inst, description);
|
||||
} else if (IS_ENABLED(CONFIG_BT_VOCS) && !conn) {
|
||||
struct bt_gatt_attr attr;
|
||||
int err;
|
||||
|
||||
attr.user_data = inst;
|
||||
|
||||
err = write_output_desc(NULL, &attr, description, strlen(description), 0, 0);
|
||||
return err > 0 ? 0 : err;
|
||||
}
|
||||
|
||||
return -EOPNOTSUPP;
|
||||
}
|
||||
|
||||
int bt_vocs_cb_register(struct bt_vocs *inst, struct bt_vocs_cb *cb)
|
||||
{
|
||||
CHECKIF(!inst) {
|
||||
BT_DBG("Null VOCS pointer");
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
inst->srv.cb = cb;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
#endif /* CONFIG_BT_VOCS || CONFIG_BT_VOCS_CLIENT */
|
||||
Loading…
Add table
Add a link
Reference in a new issue