vcp.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2020-2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCP_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCP_H_
 
#include <stdint.h>
 
#include <zephyr/bluetooth/audio/aics.h>
#include <zephyr/bluetooth/audio/vocs.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CONFIG_BT_VCP_VOL_REND)
#define BT_VCP_VOL_REND_VOCS_CNT CONFIG_BT_VCP_VOL_REND_VOCS_INSTANCE_COUNT
#else
#define BT_VCP_VOL_REND_VOCS_CNT 0
#endif /* CONFIG_BT_VCP_VOL_REND */
 
#if defined(CONFIG_BT_VCP_VOL_REND)
#define BT_VCP_VOL_REND_AICS_CNT CONFIG_BT_VCP_VOL_REND_AICS_INSTANCE_COUNT
#else
#define BT_VCP_VOL_REND_AICS_CNT 0
#endif /* CONFIG_BT_VCP_VOL_REND */
 
#define BT_VCP_ERR_INVALID_COUNTER             0x80
#define BT_VCP_ERR_OP_NOT_SUPPORTED            0x81
#define BT_VCP_STATE_UNMUTED                   0x00
#define BT_VCP_STATE_MUTED                     0x01
struct bt_vcp_vol_ctlr;
 
struct bt_vcp_vol_rend_register_param {
        uint8_t step;
 
        uint8_t mute;
 
        uint8_t volume;
 
        struct bt_vocs_register_param vocs_param[BT_VCP_VOL_REND_VOCS_CNT];
 
        struct bt_aics_register_param aics_param[BT_VCP_VOL_REND_AICS_CNT];
 
        struct bt_vcp_vol_rend_cb *cb;
};
 
struct bt_vcp_included {
        uint8_t vocs_cnt;
        struct bt_vocs **vocs;
 
        uint8_t aics_cnt;
        struct bt_aics **aics;
};
 
int bt_vcp_vol_rend_included_get(struct bt_vcp_included *included);
 
int bt_vcp_vol_rend_register(struct bt_vcp_vol_rend_register_param *param);
 
struct bt_vcp_vol_rend_cb {
        void (*state)(int err, uint8_t volume, uint8_t mute);
 
        void (*flags)(int err, uint8_t flags);
};
 
int bt_vcp_vol_rend_set_step(uint8_t volume_step);
 
int bt_vcp_vol_rend_get_state(void);
 
int bt_vcp_vol_rend_get_flags(void);
 
int bt_vcp_vol_rend_vol_down(void);
 
int bt_vcp_vol_rend_vol_up(void);
 
int bt_vcp_vol_rend_unmute_vol_down(void);
 
int bt_vcp_vol_rend_unmute_vol_up(void);
 
int bt_vcp_vol_rend_set_vol(uint8_t volume);
 
int bt_vcp_vol_rend_unmute(void);
 
int bt_vcp_vol_rend_mute(void);
 
struct bt_vcp_vol_ctlr_cb {
        void (*state)(struct bt_vcp_vol_ctlr *vol_ctlr, int err, uint8_t volume,
                      uint8_t mute);
 
        void (*flags)(struct bt_vcp_vol_ctlr *vol_ctlr, int err, uint8_t flags);
 
        void (*discover)(struct bt_vcp_vol_ctlr *vol_ctlr, int err, uint8_t vocs_count,
                         uint8_t aics_count);
 
        void (*vol_down)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*vol_up)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*mute)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*unmute)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*vol_down_unmute)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*vol_up_unmute)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        void (*vol_set)(struct bt_vcp_vol_ctlr *vol_ctlr, int err);
 
        struct bt_vocs_cb             vocs_cb;
 
        struct bt_aics_cb             aics_cb;
 
        sys_snode_t _node;
};
 
int bt_vcp_vol_ctlr_cb_register(struct bt_vcp_vol_ctlr_cb *cb);
 
int bt_vcp_vol_ctlr_cb_unregister(struct bt_vcp_vol_ctlr_cb *cb);
 
int bt_vcp_vol_ctlr_discover(struct bt_conn *conn,
                             struct bt_vcp_vol_ctlr **vol_ctlr);
 
struct bt_vcp_vol_ctlr *bt_vcp_vol_ctlr_get_by_conn(const struct bt_conn *conn);
 
int bt_vcp_vol_ctlr_conn_get(const struct bt_vcp_vol_ctlr *vol_ctlr,
                             struct bt_conn **conn);
 
int bt_vcp_vol_ctlr_included_get(struct bt_vcp_vol_ctlr *vol_ctlr,
                                 struct bt_vcp_included *included);
 
int bt_vcp_vol_ctlr_read_state(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_read_flags(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_vol_down(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_vol_up(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_unmute_vol_down(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_unmute_vol_up(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_set_vol(struct bt_vcp_vol_ctlr *vol_ctlr, uint8_t volume);
 
int bt_vcp_vol_ctlr_unmute(struct bt_vcp_vol_ctlr *vol_ctlr);
 
int bt_vcp_vol_ctlr_mute(struct bt_vcp_vol_ctlr *vol_ctlr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_VCP_H_ */