hfp_hf.h

Go to the documentation of this file.

 
/*
 * Copyright (c) 2015-2016 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_HFP_HF_H_
#define ZEPHYR_INCLUDE_BLUETOOTH_HFP_HF_H_

 
#include <zephyr/bluetooth/bluetooth.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* HFP CODEC IDs */
#define BT_HFP_HF_CODEC_CVSD    0x01
#define BT_HFP_HF_CODEC_MSBC    0x02
#define BT_HFP_HF_CODEC_LC3_SWB 0x03

struct bt_hfp_hf;

struct bt_hfp_hf_call;

enum __packed bt_hfp_hf_call_status {
        BT_HFP_HF_CALL_STATUS_ACTIVE = 0,
        BT_HFP_HF_CALL_STATUS_HELD = 1,
        BT_HFP_HF_CALL_STATUS_DIALING = 2,
        BT_HFP_HF_CALL_STATUS_ALERTING = 3,
        BT_HFP_HF_CALL_STATUS_INCOMING = 4,
        BT_HFP_HF_CALL_STATUS_WAITING = 5,
        BT_HFP_HF_CALL_STATUS_INCOMING_HELD = 6
};

enum __packed bt_hfp_hf_call_dir {
        BT_HFP_HF_CALL_DIR_OUTGOING = 0,
        BT_HFP_HF_CALL_DIR_INCOMING = 1,
};

enum __packed bt_hfp_hf_call_mode {
        BT_HFP_HF_CALL_MODE_VOICE = 0,
        BT_HFP_HF_CALL_MODE_DATA = 1,
        BT_HFP_HF_CALL_MODE_FAX = 2,
};

struct bt_hfp_hf_current_call {
        uint8_t index;
        enum bt_hfp_hf_call_dir dir;
        enum bt_hfp_hf_call_status status;
        enum bt_hfp_hf_call_mode mode;
        bool multiparty;
        const char *number;
        uint8_t type;
};

struct bt_hfp_hf_cb {
        void (*connected)(struct bt_conn *conn, struct bt_hfp_hf *hf);
        void (*disconnected)(struct bt_hfp_hf *hf);
        void (*sco_connected)(struct bt_hfp_hf *hf, struct bt_conn *sco_conn);
        void (*sco_disconnected)(struct bt_conn *sco_conn, uint8_t reason);
        void (*service)(struct bt_hfp_hf *hf, uint32_t value);
        void (*outgoing)(struct bt_hfp_hf *hf, struct bt_hfp_hf_call *call);
        void (*remote_ringing)(struct bt_hfp_hf_call *call);
        void (*incoming)(struct bt_hfp_hf *hf, struct bt_hfp_hf_call *call);
        void (*incoming_held)(struct bt_hfp_hf_call *call);
        void (*accept)(struct bt_hfp_hf_call *call);
        void (*reject)(struct bt_hfp_hf_call *call);
        void (*terminate)(struct bt_hfp_hf_call *call);
        void (*held)(struct bt_hfp_hf_call *call);
        void (*retrieve)(struct bt_hfp_hf_call *call);
        void (*signal)(struct bt_hfp_hf *hf, uint32_t value);
        void (*roam)(struct bt_hfp_hf *hf, uint32_t value);
        void (*battery)(struct bt_hfp_hf *hf, uint32_t value);
        void (*ring_indication)(struct bt_hfp_hf_call *call);
        void (*dialing)(struct bt_hfp_hf *hf, int err);
        void (*clip)(struct bt_hfp_hf_call *call, const char *number, uint8_t type);
        void (*vgm)(struct bt_hfp_hf *hf, uint8_t gain);
        void (*vgs)(struct bt_hfp_hf *hf, uint8_t gain);
        void (*inband_ring)(struct bt_hfp_hf *hf, bool inband);
        void (*operator)(struct bt_hfp_hf *hf, uint8_t mode, uint8_t format, const char *operator);
        void (*codec_negotiate)(struct bt_hfp_hf *hf, uint8_t id);
        void (*ecnr_turn_off)(struct bt_hfp_hf *hf, int err);
        void (*call_waiting)(struct bt_hfp_hf_call *call, const char *number, uint8_t type);
        void (*voice_recognition)(struct bt_hfp_hf *hf, bool activate);
        void (*vre_state)(struct bt_hfp_hf *hf, uint8_t state);
        void (*textual_representation)(struct bt_hfp_hf *hf, char *id, uint8_t type,
                                       uint8_t operation, const char *text);
        void (*request_phone_number)(struct bt_hfp_hf *hf, const char *number);

        void (*subscriber_number)(struct bt_hfp_hf *hf, const char *number, uint8_t type,
                                  uint8_t service);

        void (*query_call)(struct bt_hfp_hf *hf, struct bt_hfp_hf_current_call *call);
};

int bt_hfp_hf_register(struct bt_hfp_hf_cb *cb);

int bt_hfp_hf_connect(struct bt_conn *conn, struct bt_hfp_hf **hf, uint8_t channel);

int bt_hfp_hf_disconnect(struct bt_hfp_hf *hf);

int bt_hfp_hf_cli(struct bt_hfp_hf *hf, bool enable);

int bt_hfp_hf_vgm(struct bt_hfp_hf *hf, uint8_t gain);

int bt_hfp_hf_vgs(struct bt_hfp_hf *hf, uint8_t gain);

int bt_hfp_hf_get_operator(struct bt_hfp_hf *hf);

int bt_hfp_hf_accept(struct bt_hfp_hf_call *call);

int bt_hfp_hf_reject(struct bt_hfp_hf_call *call);

int bt_hfp_hf_terminate(struct bt_hfp_hf_call *call);

int bt_hfp_hf_hold_incoming(struct bt_hfp_hf_call *call);

int bt_hfp_hf_query_respond_hold_status(struct bt_hfp_hf *hf);

int bt_hfp_hf_number_call(struct bt_hfp_hf *hf, const char *number);

int bt_hfp_hf_memory_dial(struct bt_hfp_hf *hf, const char *location);

int bt_hfp_hf_redial(struct bt_hfp_hf *hf);

int bt_hfp_hf_audio_connect(struct bt_hfp_hf *hf);

int bt_hfp_hf_select_codec(struct bt_hfp_hf *hf, uint8_t codec_id);

int bt_hfp_hf_set_codecs(struct bt_hfp_hf *hf, uint8_t codec_ids);

int bt_hfp_hf_turn_off_ecnr(struct bt_hfp_hf *hf);

int bt_hfp_hf_call_waiting_notify(struct bt_hfp_hf *hf, bool enable);

int bt_hfp_hf_release_all_held(struct bt_hfp_hf *hf);

int bt_hfp_hf_set_udub(struct bt_hfp_hf *hf);

int bt_hfp_hf_release_active_accept_other(struct bt_hfp_hf *hf);

int bt_hfp_hf_hold_active_accept_other(struct bt_hfp_hf *hf);

int bt_hfp_hf_join_conversation(struct bt_hfp_hf *hf);

int bt_hfp_hf_explicit_call_transfer(struct bt_hfp_hf *hf);

int bt_hfp_hf_release_specified_call(struct bt_hfp_hf_call *call);

int bt_hfp_hf_private_consultation_mode(struct bt_hfp_hf_call *call);

int bt_hfp_hf_voice_recognition(struct bt_hfp_hf *hf, bool activate);

int bt_hfp_hf_ready_to_accept_audio(struct bt_hfp_hf *hf);

int bt_hfp_hf_request_phone_number(struct bt_hfp_hf *hf);

int bt_hfp_hf_transmit_dtmf_code(struct bt_hfp_hf_call *call, char code);

int bt_hfp_hf_query_subscriber(struct bt_hfp_hf *hf);
 
/* HFP HF Indicators */
enum hfp_hf_ag_indicators {
        HF_SERVICE_IND = 0, /* AG service indicator */
        HF_CALL_IND,        /* AG call indicator */
        HF_CALL_SETUP_IND,  /* AG call setup indicator */
        HF_CALL_HELD_IND,   /* AG call held indicator */
        HF_SIGNAL_IND,      /* AG signal indicator */
        HF_ROAM_IND,        /* AG roaming indicator */
        HF_BATTERY_IND      /* AG battery indicator */
};

int bt_hfp_hf_indicator_status(struct bt_hfp_hf *hf, uint8_t status);

int bt_hfp_hf_enhanced_safety(struct bt_hfp_hf *hf, bool enable);

int bt_hfp_hf_battery(struct bt_hfp_hf *hf, uint8_t level);

int bt_hfp_hf_query_list_of_current_calls(struct bt_hfp_hf *hf);
 
#ifdef __cplusplus
}
#endif

 
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_HFP_HF_H_ */