/* Bluetooth VOCS - Volume Offset Control Service - Client */ /* * Copyright (c) 2021-2022 Nordic Semiconductor ASA * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "vocs_internal.h" LOG_MODULE_REGISTER(bt_vocs_client, CONFIG_BT_VOCS_CLIENT_LOG_LEVEL); static struct bt_vocs_client insts[CONFIG_BT_MAX_CONN * CONFIG_BT_VOCS_CLIENT_MAX_INSTANCE_COUNT]; static struct bt_vocs_client *lookup_vocs_by_handle(struct bt_conn *conn, uint16_t handle) { __ASSERT(handle != 0, "Handle cannot be 0"); __ASSERT(conn, "Conn cannot be NULL"); for (int i = 0; i < ARRAY_SIZE(insts); i++) { if (insts[i].conn == conn && atomic_test_bit(insts[i].flags, BT_VOCS_CLIENT_FLAG_ACTIVE) && insts[i].start_handle <= handle && insts[i].end_handle >= handle) { return &insts[i]; } } LOG_DBG("Could not find VOCS instance with handle 0x%04x", handle); return NULL; } uint8_t vocs_client_notify_handler(struct bt_conn *conn, struct bt_gatt_subscribe_params *params, const void *data, uint16_t length) { uint16_t handle = params->value_handle; struct bt_vocs_client *inst; if (conn == NULL) { return BT_GATT_ITER_CONTINUE; } inst = lookup_vocs_by_handle(conn, handle); if (!inst) { LOG_DBG("Instance not found"); return BT_GATT_ITER_STOP; } if (!data || !length) { return BT_GATT_ITER_CONTINUE; } if (handle == inst->state_handle) { if (length == sizeof(inst->state)) { memcpy(&inst->state, data, length); LOG_DBG("Inst %p: Offset %d, counter %u", inst, inst->state.offset, inst->state.change_counter); if (inst->cb && inst->cb->state) { inst->cb->state(&inst->vocs, 0, inst->state.offset); } } else { LOG_DBG("Invalid state length %u", length); } } else if (handle == inst->desc_handle) { char desc[MIN(BT_L2CAP_RX_MTU, BT_ATT_MAX_ATTRIBUTE_LEN) + 1]; /* Truncate if too large */ if (length > sizeof(desc) - 1) { LOG_DBG("Description truncated from %u to %zu octets", length, sizeof(desc) - 1); } length = MIN(sizeof(desc) - 1, length); memcpy(desc, data, length); desc[length] = '\0'; LOG_DBG("Inst %p: Output description: %s", inst, desc); if (inst->cb && inst->cb->description) { inst->cb->description(&inst->vocs, 0, desc); } } else if (handle == inst->location_handle) { if (length == sizeof(inst->location)) { memcpy(&inst->location, data, length); LOG_DBG("Inst %p: Location %u", inst, inst->location); if (inst->cb && inst->cb->location) { inst->cb->location(&inst->vocs, 0, inst->location); } } else { LOG_DBG("Invalid location length %u", length); } } return BT_GATT_ITER_CONTINUE; } static uint8_t vocs_client_read_offset_state_cb(struct bt_conn *conn, uint8_t err, struct bt_gatt_read_params *params, const void *data, uint16_t length) { int cb_err = err; struct bt_vocs_client *inst = lookup_vocs_by_handle(conn, params->single.handle); memset(params, 0, sizeof(*params)); if (!inst) { LOG_DBG("Instance not found"); return BT_GATT_ITER_STOP; } LOG_DBG("Inst %p: err: 0x%02X", inst, err); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); if (cb_err) { LOG_DBG("Offset state read failed: %d", err); } else if (data) { if (length == sizeof(inst->state)) { memcpy(&inst->state, data, length); LOG_DBG("Offset %d, counter %u", inst->state.offset, inst->state.change_counter); } else { LOG_DBG("Invalid length %u (expected %zu)", length, sizeof(inst->state)); cb_err = BT_ATT_ERR_INVALID_ATTRIBUTE_LEN; } } else { LOG_DBG("Invalid state"); cb_err = BT_ATT_ERR_UNLIKELY; } if (inst->cb && inst->cb->state) { inst->cb->state(&inst->vocs, cb_err, cb_err ? 0 : inst->state.offset); } return BT_GATT_ITER_STOP; } static uint8_t vocs_client_read_location_cb(struct bt_conn *conn, uint8_t err, struct bt_gatt_read_params *params, const void *data, uint16_t length) { int cb_err = err; struct bt_vocs_client *inst = lookup_vocs_by_handle(conn, params->single.handle); memset(params, 0, sizeof(*params)); if (!inst) { LOG_DBG("Instance not found"); return BT_GATT_ITER_STOP; } LOG_DBG("Inst %p: err: 0x%02X", inst, err); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); if (cb_err) { LOG_DBG("Offset state read failed: %d", err); } else if (data) { if (length == sizeof(inst->location)) { memcpy(&inst->location, data, length); LOG_DBG("Location %u", inst->location); } else { LOG_DBG("Invalid length %u (expected %zu)", length, sizeof(inst->location)); cb_err = BT_ATT_ERR_INVALID_ATTRIBUTE_LEN; } } else { LOG_DBG("Invalid location"); cb_err = BT_ATT_ERR_UNLIKELY; } if (inst->cb && inst->cb->location) { inst->cb->location(&inst->vocs, cb_err, cb_err ? 0 : inst->location); } return BT_GATT_ITER_STOP; } static uint8_t internal_read_volume_offset_state_cb(struct bt_conn *conn, uint8_t err, struct bt_gatt_read_params *params, const void *data, uint16_t length) { int cb_err = err; struct bt_vocs_client *inst = lookup_vocs_by_handle(conn, params->single.handle); memset(params, 0, sizeof(*params)); if (!inst) { LOG_ERR("Instance not found"); return BT_GATT_ITER_STOP; } if (err) { LOG_WRN("Volume offset state read failed: %d", err); cb_err = BT_ATT_ERR_UNLIKELY; } else if (data) { if (length == sizeof(inst->state)) { int write_err; memcpy(&inst->state, data, length); LOG_DBG("Offset %d, counter %u", inst->state.offset, inst->state.change_counter); /* clear busy flag to reuse function */ atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); write_err = bt_vocs_client_state_set(inst, inst->cp.offset); if (write_err) { cb_err = BT_ATT_ERR_UNLIKELY; } } else { LOG_DBG("Invalid length %u (expected %zu)", length, sizeof(inst->state)); cb_err = BT_ATT_ERR_UNLIKELY; } } else { LOG_DBG("Invalid (empty) offset state read"); cb_err = BT_ATT_ERR_UNLIKELY; } if (cb_err) { atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); if (inst->cb && inst->cb->set_offset) { inst->cb->set_offset(&inst->vocs, err); } } return BT_GATT_ITER_STOP; } static void vocs_client_write_vocs_cp_cb(struct bt_conn *conn, uint8_t err, struct bt_gatt_write_params *params) { int cb_err = err; struct bt_vocs_client *inst = lookup_vocs_by_handle(conn, params->handle); memset(params, 0, sizeof(*params)); if (!inst) { LOG_DBG("Instance not found"); return; } LOG_DBG("Inst %p: err: 0x%02X", inst, err); /* If the change counter is out of data when a write was attempted from the application, * we automatically initiate a read to get the newest state and try again. Once the * change counter has been read, we restart the applications write request. If it fails * the second time, we return an error to the application. */ if (cb_err == BT_VOCS_ERR_INVALID_COUNTER && atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_CP_RETRIED)) { cb_err = BT_ATT_ERR_UNLIKELY; } else if (cb_err == BT_VOCS_ERR_INVALID_COUNTER && inst->state_handle) { LOG_DBG("Invalid change counter. Reading volume offset state from server."); inst->read_params.func = internal_read_volume_offset_state_cb; inst->read_params.handle_count = 1; inst->read_params.single.handle = inst->state_handle; atomic_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_CP_RETRIED); cb_err = bt_gatt_read(conn, &inst->read_params); if (cb_err) { LOG_WRN("Could not read Volume offset state: %d", cb_err); } else { /* Wait for read callback */ return; } } atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_CP_RETRIED); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); if (inst->cb && inst->cb->set_offset) { inst->cb->set_offset(&inst->vocs, cb_err); } } static uint8_t vocs_client_read_output_desc_cb(struct bt_conn *conn, uint8_t err, struct bt_gatt_read_params *params, const void *data, uint16_t length) { int cb_err = err; struct bt_vocs_client *inst = lookup_vocs_by_handle(conn, params->single.handle); char desc[MIN(BT_L2CAP_RX_MTU, BT_ATT_MAX_ATTRIBUTE_LEN) + 1]; memset(params, 0, sizeof(*params)); if (!inst) { LOG_DBG("Instance not found"); return BT_GATT_ITER_STOP; } LOG_DBG("Inst %p: err: 0x%02X", inst, err); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); if (cb_err) { LOG_DBG("Description read failed: %d", err); } else { if (data) { LOG_HEXDUMP_DBG(data, length, "Output description read"); if (length > sizeof(desc) - 1) { LOG_DBG("Description truncated from %u to %zu octets", length, sizeof(desc) - 1); } length = MIN(sizeof(desc) - 1, length); /* TODO: Handle long reads */ memcpy(desc, data, length); } desc[length] = '\0'; LOG_DBG("Output description: %s", desc); } if (inst->cb && inst->cb->description) { inst->cb->description(&inst->vocs, cb_err, cb_err ? NULL : desc); } return BT_GATT_ITER_STOP; } static bool valid_inst_discovered(struct bt_vocs_client *inst) { return inst->state_handle && inst->control_handle && inst->location_handle && inst->desc_handle; } static uint8_t vocs_discover_func(struct bt_conn *conn, const struct bt_gatt_attr *attr, struct bt_gatt_discover_params *params) { struct bt_vocs_client *inst = CONTAINER_OF(params, struct bt_vocs_client, discover_params); if (!attr) { LOG_DBG("Discovery complete for VOCS %p", inst); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); (void)memset(params, 0, sizeof(*params)); if (inst->cb && inst->cb->discover) { int err = valid_inst_discovered(inst) ? 0 : -ENOENT; inst->cb->discover(&inst->vocs, err); } return BT_GATT_ITER_STOP; } LOG_DBG("[ATTRIBUTE] handle 0x%04X", attr->handle); if (params->type == BT_GATT_DISCOVER_CHARACTERISTIC) { struct bt_gatt_subscribe_params *sub_params = NULL; struct bt_gatt_chrc *chrc; chrc = (struct bt_gatt_chrc *)attr->user_data; if (inst->start_handle == 0) { inst->start_handle = chrc->value_handle; } inst->end_handle = chrc->value_handle; if (!bt_uuid_cmp(chrc->uuid, BT_UUID_VOCS_STATE)) { LOG_DBG("Volume offset state"); inst->state_handle = chrc->value_handle; sub_params = &inst->state_sub_params; } else if (!bt_uuid_cmp(chrc->uuid, BT_UUID_VOCS_LOCATION)) { LOG_DBG("Location"); inst->location_handle = chrc->value_handle; if (chrc->properties & BT_GATT_CHRC_NOTIFY) { sub_params = &inst->location_sub_params; } if (chrc->properties & BT_GATT_CHRC_WRITE_WITHOUT_RESP) { atomic_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_LOC_WRITABLE); } } else if (!bt_uuid_cmp(chrc->uuid, BT_UUID_VOCS_CONTROL)) { LOG_DBG("Control point"); inst->control_handle = chrc->value_handle; } else if (!bt_uuid_cmp(chrc->uuid, BT_UUID_VOCS_DESCRIPTION)) { LOG_DBG("Description"); inst->desc_handle = chrc->value_handle; if (chrc->properties & BT_GATT_CHRC_NOTIFY) { sub_params = &inst->desc_sub_params; } if (chrc->properties & BT_GATT_CHRC_WRITE_WITHOUT_RESP) { atomic_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_DESC_WRITABLE); } } if (sub_params) { int err; sub_params->value = BT_GATT_CCC_NOTIFY; sub_params->value_handle = chrc->value_handle; /* * TODO: Don't assume that CCC is at handle + 2; * do proper discovery; */ sub_params->ccc_handle = attr->handle + 2; sub_params->notify = vocs_client_notify_handler; atomic_set_bit(sub_params->flags, BT_GATT_SUBSCRIBE_FLAG_VOLATILE); err = bt_gatt_subscribe(conn, sub_params); if (err != 0 && err != -EALREADY) { LOG_WRN("Could not subscribe to handle %u", sub_params->ccc_handle); inst->cb->discover(&inst->vocs, err); return BT_GATT_ITER_STOP; } } } return BT_GATT_ITER_CONTINUE; } int bt_vocs_client_state_get(struct bt_vocs_client *inst) { int err; CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } if (!inst->state_handle) { LOG_DBG("Handle not set"); return -EINVAL; } if (atomic_test_and_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } inst->read_params.func = vocs_client_read_offset_state_cb; inst->read_params.handle_count = 1; inst->read_params.single.handle = inst->state_handle; inst->read_params.single.offset = 0U; err = bt_gatt_read(inst->conn, &inst->read_params); if (err != 0) { atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); } return err; } int bt_vocs_client_location_set(struct bt_vocs_client *inst, uint32_t location) { CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } CHECKIF(location > BT_AUDIO_LOCATION_ANY) { LOG_DBG("Invalid location 0x%08X", location); return -EINVAL; } if (!inst->location_handle) { LOG_DBG("Handle not set"); return -EINVAL; } else if (!atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_LOC_WRITABLE)) { LOG_DBG("Location is not writable on peer service instance"); return -EPERM; } else if (atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } /* When using write without response we do not set the busy flag */ return bt_gatt_write_without_response(inst->conn, inst->location_handle, &location, sizeof(location), false); } int bt_vocs_client_location_get(struct bt_vocs_client *inst) { int err; CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } if (!inst->location_handle) { LOG_DBG("Handle not set"); return -EINVAL; } else if (atomic_test_and_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } inst->read_params.func = vocs_client_read_location_cb; inst->read_params.handle_count = 1; inst->read_params.single.handle = inst->location_handle; inst->read_params.single.offset = 0U; err = bt_gatt_read(inst->conn, &inst->read_params); if (err != 0) { atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); } return err; } int bt_vocs_client_state_set(struct bt_vocs_client *inst, int16_t offset) { int err; CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } CHECKIF(!IN_RANGE(offset, BT_VOCS_MIN_OFFSET, BT_VOCS_MAX_OFFSET)) { LOG_DBG("Invalid offset: %d", offset); return -EINVAL; } if (!inst->control_handle) { LOG_DBG("Handle not set"); return -EINVAL; } else if (atomic_test_and_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } inst->cp.opcode = BT_VOCS_OPCODE_SET_OFFSET; inst->cp.counter = inst->state.change_counter; inst->cp.offset = offset; inst->write_params.offset = 0; inst->write_params.data = &inst->cp; inst->write_params.length = sizeof(inst->cp); inst->write_params.handle = inst->control_handle; inst->write_params.func = vocs_client_write_vocs_cp_cb; err = bt_gatt_write(inst->conn, &inst->write_params); if (err != 0) { atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); } return err; } int bt_vocs_client_description_get(struct bt_vocs_client *inst) { int err; CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } if (!inst->desc_handle) { LOG_DBG("Handle not set"); return -EINVAL; } else if (atomic_test_and_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } inst->read_params.func = vocs_client_read_output_desc_cb; inst->read_params.handle_count = 1; inst->read_params.single.handle = inst->desc_handle; inst->read_params.single.offset = 0U; err = bt_gatt_read(inst->conn, &inst->read_params); if (err != 0) { atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); } return err; } int bt_vocs_client_description_set(struct bt_vocs_client *inst, const char *description) { CHECKIF(!inst) { LOG_DBG("NULL instance"); return -EINVAL; } CHECKIF(inst->conn == NULL) { LOG_DBG("NULL conn"); return -EINVAL; } if (!inst->desc_handle) { LOG_DBG("Handle not set"); return -EINVAL; } else if (!atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_DESC_WRITABLE)) { LOG_DBG("Description is not writable on peer service instance"); return -EPERM; } else if (atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } /* When using write without response we do not set the busy flag */ return bt_gatt_write_without_response(inst->conn, inst->desc_handle, description, strlen(description), false); } struct bt_vocs *bt_vocs_client_free_instance_get(void) { for (int i = 0; i < ARRAY_SIZE(insts); i++) { if (!atomic_test_and_set_bit(insts[i].flags, BT_VOCS_CLIENT_FLAG_ACTIVE)) { insts[i].vocs.client_instance = true; return &insts[i].vocs; } } return NULL; } int bt_vocs_client_conn_get(const struct bt_vocs *vocs, struct bt_conn **conn) { struct bt_vocs_client *inst; CHECKIF(vocs == NULL) { LOG_DBG("NULL vocs pointer"); return -EINVAL; } CHECKIF(!vocs->client_instance) { LOG_DBG("vocs pointer shall be client instance"); return -EINVAL; } inst = CONTAINER_OF(vocs, struct bt_vocs_client, vocs); if (inst->conn == NULL) { LOG_DBG("vocs pointer not associated with a connection. " "Do discovery first"); return -ENOTCONN; } *conn = inst->conn; return 0; } static void vocs_client_reset(struct bt_vocs_client *inst) { memset(&inst->state, 0, sizeof(inst->state)); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_LOC_WRITABLE); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_DESC_WRITABLE); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_CP_RETRIED); inst->location = 0; inst->start_handle = 0; inst->end_handle = 0; inst->state_handle = 0; inst->location_handle = 0; inst->control_handle = 0; inst->desc_handle = 0; if (inst->conn != NULL) { struct bt_conn *conn = inst->conn; bt_conn_unref(conn); inst->conn = NULL; } } int bt_vocs_discover(struct bt_conn *conn, struct bt_vocs *vocs, const struct bt_vocs_discover_param *param) { struct bt_vocs_client *inst; int err = 0; CHECKIF(!vocs || !conn || !param) { LOG_DBG("%s cannot be NULL", vocs == NULL ? "vocs" : conn == NULL ? "conn" : "param"); return -EINVAL; } CHECKIF(!vocs->client_instance) { LOG_DBG("vocs pointer shall be client instance"); return -EINVAL; } CHECKIF(param->end_handle < param->start_handle) { LOG_DBG("start_handle (%u) shall be less than end_handle (%u)", param->start_handle, param->end_handle); return -EINVAL; } inst = CONTAINER_OF(vocs, struct bt_vocs_client, vocs); if (!atomic_test_bit(inst->flags, BT_VOCS_CLIENT_FLAG_ACTIVE)) { LOG_DBG("Inactive instance"); return -EINVAL; } else if (atomic_test_and_set_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY)) { LOG_DBG("Instance is busy"); return -EBUSY; } vocs_client_reset(inst); inst->conn = bt_conn_ref(conn); inst->discover_params.start_handle = param->start_handle; inst->discover_params.end_handle = param->end_handle; inst->discover_params.type = BT_GATT_DISCOVER_CHARACTERISTIC; inst->discover_params.func = vocs_discover_func; err = bt_gatt_discover(conn, &inst->discover_params); if (err != 0) { LOG_DBG("Discover failed (err %d)", err); atomic_clear_bit(inst->flags, BT_VOCS_CLIENT_FLAG_BUSY); } return err; } void bt_vocs_client_cb_register(struct bt_vocs *vocs, struct bt_vocs_cb *cb) { struct bt_vocs_client *inst; CHECKIF(!vocs) { LOG_DBG("inst cannot be NULL"); return; } CHECKIF(!vocs->client_instance) { LOG_DBG("vocs pointer shall be client instance"); return; } inst = CONTAINER_OF(vocs, struct bt_vocs_client, vocs); inst->cb = cb; }