aics.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_AICS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_AICS_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/autoconf.h>
#include <zephyr/bluetooth/bluetooth.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_AICS_STATE_UNMUTED                      0x00
#define BT_AICS_STATE_MUTED                        0x01
#define BT_AICS_STATE_MUTE_DISABLED                0x02
#define BT_AICS_MODE_MANUAL_ONLY                   0x00
#define BT_AICS_MODE_AUTO_ONLY                     0x01
#define BT_AICS_MODE_MANUAL                        0x02
#define BT_AICS_MODE_AUTO                          0x03
#define BT_AICS_INPUT_TYPE_UNSPECIFIED             0x00
#define BT_AICS_INPUT_TYPE_BLUETOOTH               0x01
#define BT_AICS_INPUT_TYPE_MICROPHONE              0x02
#define BT_AICS_INPUT_TYPE_ANALOG                  0x03
#define BT_AICS_INPUT_TYPE_DIGITAL                 0x04
#define BT_AICS_INPUT_TYPE_RADIO                   0x05
#define BT_AICS_INPUT_TYPE_STREAMING               0x06
#define BT_AICS_INPUT_TYPE_AMBIENT                 0x07
#define BT_AICS_ERR_INVALID_COUNTER                0x80
#define BT_AICS_ERR_OP_NOT_SUPPORTED               0x81
#define BT_AICS_ERR_MUTE_DISABLED                  0x82
#define BT_AICS_ERR_OUT_OF_RANGE                   0x83
#define BT_AICS_ERR_GAIN_MODE_NOT_ALLOWED          0x84
struct bt_aics;
 
struct bt_aics_register_param {
        int8_t gain;
 
        uint8_t mute;
 
        uint8_t gain_mode;
 
        uint8_t units;
 
        int8_t min_gain;
 
        int8_t max_gain;
 
        uint8_t type;
 
        bool status;
 
        bool desc_writable;
 
        char *description;
 
        struct bt_aics_cb *cb;
};
 
struct bt_aics_discover_param {
        uint16_t start_handle;
        uint16_t end_handle;
};
 
struct bt_aics *bt_aics_free_instance_get(void);
 
void *bt_aics_svc_decl_get(struct bt_aics *aics);
 
int bt_aics_client_conn_get(const struct bt_aics *aics, struct bt_conn **conn);
 
int bt_aics_register(struct bt_aics *aics, struct bt_aics_register_param *param);
 
typedef void (*bt_aics_write_cb)(struct bt_aics *inst, int err);
 
typedef void (*bt_aics_state_cb)(struct bt_aics *inst, int err, int8_t gain,
                                 uint8_t mute, uint8_t mode);
 
typedef void (*bt_aics_gain_setting_cb)(struct bt_aics *inst, int err,
                                        uint8_t units, int8_t minimum,
                                        int8_t maximum);
 
typedef void (*bt_aics_type_cb)(struct bt_aics *inst, int err, uint8_t type);
 
typedef void (*bt_aics_status_cb)(struct bt_aics *inst, int err, bool active);
 
typedef void (*bt_aics_description_cb)(struct bt_aics *inst, int err,
                                       char *description);
 
typedef void (*bt_aics_discover_cb)(struct bt_aics *inst, int err);
 
struct bt_aics_cb {
        bt_aics_state_cb                 state;
        bt_aics_gain_setting_cb          gain_setting;
        bt_aics_type_cb                  type;
        bt_aics_status_cb                status;
        bt_aics_description_cb           description;
 
#if defined(CONFIG_BT_AICS_CLIENT) || defined(__DOXYGEN__)
        bt_aics_discover_cb              discover;
        bt_aics_write_cb                 set_gain;
        bt_aics_write_cb                 unmute;
        bt_aics_write_cb                 mute;
        bt_aics_write_cb                 set_manual_mode;
        bt_aics_write_cb                 set_auto_mode;
#endif /* CONFIG_BT_AICS_CLIENT */
};
 
 
int bt_aics_discover(struct bt_conn *conn, struct bt_aics *inst,
                     const struct bt_aics_discover_param *param);
 
int bt_aics_deactivate(struct bt_aics *inst);
 
int bt_aics_activate(struct bt_aics *inst);
 
int bt_aics_state_get(struct bt_aics *inst);
 
int bt_aics_gain_setting_get(struct bt_aics *inst);
 
int bt_aics_type_get(struct bt_aics *inst);
 
int bt_aics_status_get(struct bt_aics *inst);
 
int bt_aics_disable_mute(struct bt_aics *inst);
 
int bt_aics_unmute(struct bt_aics *inst);
 
int bt_aics_mute(struct bt_aics *inst);
 
int bt_aics_gain_set_manual_only(struct bt_aics *inst);
 
int bt_aics_gain_set_auto_only(struct bt_aics *inst);
 
int bt_aics_manual_gain_set(struct bt_aics *inst);
 
int bt_aics_automatic_gain_set(struct bt_aics *inst);
 
int bt_aics_gain_set(struct bt_aics *inst, int8_t gain);
 
int bt_aics_description_get(struct bt_aics *inst);
 
int bt_aics_description_set(struct bt_aics *inst, const char *description);
 
struct bt_aics *bt_aics_client_free_instance_get(void);
 
void bt_aics_client_cb_register(struct bt_aics *inst, struct bt_aics_cb *cb);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_SERVICES_AICS_H_ */