hfp_ag.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016 Intel Corporation
 * Copyright 2023-2024 NXP
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_HFP_AG_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_HFP_AG_H_
 
#include <zephyr/bluetooth/bluetooth.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* HFP AG Indicators */
enum bt_hfp_ag_indicator {
        BT_HFP_AG_SERVICE_IND = 0,    /* Service availability indicator */
        BT_HFP_AG_CALL_IND = 1,       /* call status indicator */
        BT_HFP_AG_CALL_SETUP_IND = 2, /* Call set up status indicator */
        BT_HFP_AG_CALL_HELD_IND = 3,  /* Call hold status indicator */
        BT_HFP_AG_SIGNAL_IND = 4,    /* Signal strength indicator */
        BT_HFP_AG_ROAM_IND = 5,       /* Roaming status indicator */
        BT_HFP_AG_BATTERY_IND = 6,    /* Battery change indicator */
        BT_HFP_AG_IND_MAX             /* Indicator MAX value */
};
 
/* HFP CODEC */
#define BT_HFP_AG_CODEC_CVSD    0x01
#define BT_HFP_AG_CODEC_MSBC    0x02
#define BT_HFP_AG_CODEC_LC3_SWB 0x03
 
struct bt_hfp_ag;
struct bt_hfp_ag_call;
 
typedef int (*bt_hfp_ag_query_subscriber_func_t)(struct bt_hfp_ag *ag, char *number, uint8_t type,
                                                 uint8_t service);
 
/* HF indicators */
enum hfp_ag_hf_indicators {
        HFP_AG_ENHANCED_SAFETY_IND = 1, /* Enhanced Safety */
        HFP_AG_BATTERY_LEVEL_IND = 2,   /* Remaining level of Battery */
};
 
/* The status of the call */
enum __packed bt_hfp_ag_call_status {
        BT_HFP_AG_CALL_STATUS_ACTIVE = 0,       /* Call is active */
        BT_HFP_AG_CALL_STATUS_HELD = 1,         /* Call is on hold */
        BT_HFP_AG_CALL_STATUS_DIALING = 2,      /* Outgoing call is being dialed */
        BT_HFP_AG_CALL_STATUS_ALERTING = 3,     /* Outgoing call is being alerted */
        BT_HFP_AG_CALL_STATUS_INCOMING = 4,     /* Incoming call is came */
        BT_HFP_AG_CALL_STATUS_WAITING = 5,      /* Incoming call is waiting */
        BT_HFP_AG_CALL_STATUS_INCOMING_HELD = 6 /* Call held by Response and Hold */
};
 
/* The direction of the call */
enum __packed bt_hfp_ag_call_dir {
        BT_HFP_AG_CALL_DIR_OUTGOING = 0, /* It is a outgoing call */
        BT_HFP_AG_CALL_DIR_INCOMING = 1, /* It is a incoming call */
};
 
struct bt_hfp_ag_ongoing_call {
        char number[CONFIG_BT_HFP_AG_PHONE_NUMBER_MAX_LEN + 1];
        uint8_t type;
        enum bt_hfp_ag_call_dir dir;
        enum bt_hfp_ag_call_status status;
};
 
struct bt_hfp_ag_cb {
        void (*connected)(struct bt_conn *conn, struct bt_hfp_ag *ag);
        void (*disconnected)(struct bt_hfp_ag *ag);
        void (*sco_connected)(struct bt_hfp_ag *ag, struct bt_conn *sco_conn);
        void (*sco_disconnected)(struct bt_conn *sco_conn, uint8_t reason);
 
        int (*get_ongoing_call)(struct bt_hfp_ag *ag);
 
        int (*memory_dial)(struct bt_hfp_ag *ag, const char *location, char **number);
 
        int (*number_call)(struct bt_hfp_ag *ag, const char *number);
 
        void (*outgoing)(struct bt_hfp_ag *ag, struct bt_hfp_ag_call *call, const char *number);
 
        void (*incoming)(struct bt_hfp_ag *ag, struct bt_hfp_ag_call *call, const char *number);
 
        void (*incoming_held)(struct bt_hfp_ag_call *call);
 
        void (*ringing)(struct bt_hfp_ag_call *call, bool in_band);
 
        void (*accept)(struct bt_hfp_ag_call *call);
 
        void (*held)(struct bt_hfp_ag_call *call);
 
        void (*retrieve)(struct bt_hfp_ag_call *call);
 
        void (*reject)(struct bt_hfp_ag_call *call);
 
        void (*terminate)(struct bt_hfp_ag_call *call);
 
        void (*codec)(struct bt_hfp_ag *ag, uint32_t ids);
 
        void (*codec_negotiate)(struct bt_hfp_ag *ag, int err);
 
        void (*audio_connect_req)(struct bt_hfp_ag *ag);
 
        void (*vgm)(struct bt_hfp_ag *ag, uint8_t gain);
 
        void (*vgs)(struct bt_hfp_ag *ag, uint8_t gain);
 
        void (*ecnr_turn_off)(struct bt_hfp_ag *ag);
 
        void (*explicit_call_transfer)(struct bt_hfp_ag *ag);
 
        void (*voice_recognition)(struct bt_hfp_ag *ag, bool activate);
 
        void (*ready_to_accept_audio)(struct bt_hfp_ag *ag);
 
        int (*request_phone_number)(struct bt_hfp_ag *ag, char **number);
 
        void (*transmit_dtmf_code)(struct bt_hfp_ag *ag, char code);
 
        int (*subscriber_number)(struct bt_hfp_ag *ag, bt_hfp_ag_query_subscriber_func_t func);
 
        void (*hf_indicator_value)(struct bt_hfp_ag *ag, enum hfp_ag_hf_indicators indicator,
                                   uint32_t value);
};
 
int bt_hfp_ag_register(struct bt_hfp_ag_cb *cb);
 
int bt_hfp_ag_connect(struct bt_conn *conn, struct bt_hfp_ag **ag, uint8_t channel);
 
int bt_hfp_ag_disconnect(struct bt_hfp_ag *ag);
 
int bt_hfp_ag_remote_incoming(struct bt_hfp_ag *ag, const char *number);
 
int bt_hfp_ag_hold_incoming(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_reject(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_accept(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_terminate(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_retrieve(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_hold(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_outgoing(struct bt_hfp_ag *ag, const char *number);
 
int bt_hfp_ag_remote_ringing(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_remote_reject(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_remote_accept(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_remote_terminate(struct bt_hfp_ag_call *call);
 
int bt_hfp_ag_explicit_call_transfer(struct bt_hfp_ag *ag);
 
int bt_hfp_ag_vgm(struct bt_hfp_ag *ag, uint8_t vgm);
 
int bt_hfp_ag_vgs(struct bt_hfp_ag *ag, uint8_t vgs);
 
int bt_hfp_ag_set_operator(struct bt_hfp_ag *ag, uint8_t mode, char *name);
 
int bt_hfp_ag_audio_connect(struct bt_hfp_ag *ag, uint8_t id);
 
int bt_hfp_ag_inband_ringtone(struct bt_hfp_ag *ag, bool inband);
 
int bt_hfp_ag_voice_recognition(struct bt_hfp_ag *ag, bool activate);
 
int bt_hfp_ag_vre_state(struct bt_hfp_ag *ag, uint8_t state);
 
int bt_hfp_ag_vre_textual_representation(struct bt_hfp_ag *ag, uint8_t state, const char *id,
                                         uint8_t type, uint8_t operation, const char *text);
 
int bt_hfp_ag_signal_strength(struct bt_hfp_ag *ag, uint8_t strength);
 
int bt_hfp_ag_roaming_status(struct bt_hfp_ag *ag, uint8_t status);
 
int bt_hfp_ag_battery_level(struct bt_hfp_ag *ag, uint8_t level);
 
int bt_hfp_ag_service_availability(struct bt_hfp_ag *ag, bool available);
 
int bt_hfp_ag_hf_indicator(struct bt_hfp_ag *ag, enum hfp_ag_hf_indicators indicator, bool enable);
 
int bt_hfp_ag_ongoing_calls(struct bt_hfp_ag *ag, struct bt_hfp_ag_ongoing_call *calls,
                            size_t count);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_HFP_HF_H_ */