has.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2022 Codecoup
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_HAS_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_HAS_H_
 
#include <stdint.h>
#include <stdbool.h>
 
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/sys/util.h>
#include <zephyr/sys/util_macro.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_HAS_PRESET_INDEX_NONE 0x00
#define BT_HAS_PRESET_INDEX_FIRST 0x01
#define BT_HAS_PRESET_INDEX_LAST 0xFF
#define BT_HAS_PRESET_NAME_MIN 1
#define BT_HAS_PRESET_NAME_MAX 40
 
struct bt_has;
 
enum bt_has_hearing_aid_type {
        BT_HAS_HEARING_AID_TYPE_BINAURAL = 0x00,
        BT_HAS_HEARING_AID_TYPE_MONAURAL = 0x01,
        BT_HAS_HEARING_AID_TYPE_BANDED = 0x02,
};
 
enum bt_has_properties {
        BT_HAS_PROP_NONE = 0,
 
        BT_HAS_PROP_WRITABLE = BIT(0),
 
        BT_HAS_PROP_AVAILABLE = BIT(1),
};
 
enum bt_has_capabilities {
        BT_HAS_PRESET_SUPPORT = BIT(0),
};
 
struct bt_has_features_param {
        enum bt_has_hearing_aid_type type;
 
        bool preset_sync_support;
 
        bool independent_presets;
};
 
struct bt_has_preset_record {
        uint8_t index;
 
        enum bt_has_properties properties;
 
        const char *name;
};
 
struct bt_has_client_cb {
        void (*discover)(struct bt_conn *conn, int err, struct bt_has *has,
                         enum bt_has_hearing_aid_type type, enum bt_has_capabilities caps);
 
        void (*preset_switch)(struct bt_has *has, int err, uint8_t index);
 
        void (*preset_read_rsp)(struct bt_has *has, int err,
                                const struct bt_has_preset_record *record, bool is_last);
 
        void (*preset_update)(struct bt_has *has, uint8_t index_prev,
                              const struct bt_has_preset_record *record, bool is_last);
 
        void (*preset_deleted)(struct bt_has *has, uint8_t index, bool is_last);
 
        void (*preset_availability)(struct bt_has *has, uint8_t index, bool available,
                                    bool is_last);
};
 
int bt_has_client_cb_register(const struct bt_has_client_cb *cb);
 
int bt_has_client_discover(struct bt_conn *conn);
 
int bt_has_client_conn_get(const struct bt_has *has, struct bt_conn **conn);
 
int bt_has_client_presets_read(struct bt_has *has, uint8_t index, uint8_t max_count);
 
int bt_has_client_preset_set(struct bt_has *has, uint8_t index, bool sync);
 
int bt_has_client_preset_next(struct bt_has *has, bool sync);
 
int bt_has_client_preset_prev(struct bt_has *has, bool sync);
 
struct bt_has_preset_ops {
        int (*select)(uint8_t index, bool sync);
 
        void (*name_changed)(uint8_t index, const char *name);
};
 
struct bt_has_preset_register_param {
        uint8_t index;
 
        enum bt_has_properties properties;
 
        const char *name;
 
        const struct bt_has_preset_ops *ops;
};
 
int bt_has_register(const struct bt_has_features_param *features);
 
int bt_has_preset_register(const struct bt_has_preset_register_param *param);
 
int bt_has_preset_unregister(uint8_t index);
 
int bt_has_preset_available(uint8_t index);
 
int bt_has_preset_unavailable(uint8_t index);
 
enum {
        BT_HAS_PRESET_ITER_STOP = 0,
        BT_HAS_PRESET_ITER_CONTINUE,
};
 
typedef uint8_t (*bt_has_preset_func_t)(uint8_t index, enum bt_has_properties properties,
                                        const char *name, void *user_data);
 
void bt_has_preset_foreach(uint8_t index, bt_has_preset_func_t func, void *user_data);
 
int bt_has_preset_active_set(uint8_t index);
 
uint8_t bt_has_preset_active_get(void);
 
static inline int bt_has_preset_active_clear(void)
{
        return bt_has_preset_active_set(BT_HAS_PRESET_INDEX_NONE);
}
 
int bt_has_preset_name_change(uint8_t index, const char *name);
 
int bt_has_features_set(const struct bt_has_features_param *features);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_AUDIO_HAS_H_ */