vocs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VOCS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VOCS_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/conn.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_VOCS_ERR_INVALID_COUNTER 0x80
#define BT_VOCS_ERR_OP_NOT_SUPPORTED 0x81
#define BT_VOCS_ERR_OUT_OF_RANGE 0x82
 
#define BT_VOCS_MIN_OFFSET -255
#define BT_VOCS_MAX_OFFSET 255
 
struct bt_vocs;
 
struct bt_vocs_register_param {
 uint32_t location;
 
 bool location_writable;
 
 int16_t offset;
 
 char *output_desc;
 
 bool desc_writable;
 
 struct bt_vocs_cb *cb;
};
 
struct bt_vocs_discover_param {
 uint16_t start_handle;
 uint16_t end_handle;
};
 
struct bt_vocs *bt_vocs_free_instance_get(void);
 
void *bt_vocs_svc_decl_get(struct bt_vocs *vocs);
 
int bt_vocs_client_conn_get(const struct bt_vocs *vocs, struct bt_conn **conn);
 
int bt_vocs_register(struct bt_vocs *vocs,
 const struct bt_vocs_register_param *param);
 
typedef void (*bt_vocs_state_cb)(struct bt_vocs *inst, int err, int16_t offset);
 
typedef void (*bt_vocs_set_offset_cb)(struct bt_vocs *inst, int err);
 
typedef void (*bt_vocs_location_cb)(struct bt_vocs *inst, int err,
 uint32_t location);
 
typedef void (*bt_vocs_description_cb)(struct bt_vocs *inst, int err,
 char *description);
 
typedef void (*bt_vocs_discover_cb)(struct bt_vocs *inst, int err);
 
struct bt_vocs_cb {
 bt_vocs_state_cb state;
 bt_vocs_location_cb location;
 bt_vocs_description_cb description;
 
#if defined(CONFIG_BT_VOCS_CLIENT)
 /* Client only */
 bt_vocs_discover_cb discover;
 bt_vocs_set_offset_cb set_offset;
#endif /* CONFIG_BT_VOCS_CLIENT */
};
 
int bt_vocs_state_get(struct bt_vocs *inst);
 
int bt_vocs_state_set(struct bt_vocs *inst, int16_t offset);
 
int bt_vocs_location_get(struct bt_vocs *inst);
 
int bt_vocs_location_set(struct bt_vocs *inst, uint32_t location);
 
int bt_vocs_description_get(struct bt_vocs *inst);
 
int bt_vocs_description_set(struct bt_vocs *inst, const char *description);
 
void bt_vocs_client_cb_register(struct bt_vocs *inst, struct bt_vocs_cb *cb);
 
struct bt_vocs *bt_vocs_client_free_instance_get(void);
 
int bt_vocs_discover(struct bt_conn *conn, struct bt_vocs *inst,
 const struct bt_vocs_discover_param *param);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VOCS_H_ */