tkl_bluetooth_bredr.h

浏览该文件的文档.

 
#ifndef __TKL_BLUETOOTH_BREDR_H__
#define __TKL_BLUETOOTH_BREDR_H__
 
#include "tuya_cloud_types.h"
#include "tuya_error_code.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
* 统一蓝牙BREDR接口，主要应用场景如下：
* 1，作为蓝牙音箱设备（Sink），由手机端（Source）播放音频于设备上。如：涂鸦智能音箱，涂鸦wifi语音音箱等
* 2，作为蓝牙耳机（Sink），由手机端或移动终端（Sink）播放音频于设备上。如：涂鸦蓝牙耳机
*
* 注：制定该接口主要应用场景为Sink端，由于暂无Source需求，我们将专注于Sink端接口规范，且无需关心音频数据流。
* 如：将音箱数据送入下一个音频播放设备等不在我们考虑范围，协议不支持点到多点连接，故暂不考虑。
*
* 规范蓝牙BREDR接口目的：
* 1，剥离业务到驱动接口，最大限度规范上下层行为。
* 2，更好地按需进行业务与驱动拓展，避免无效的接口导入与应用。
* 3，更好地拓展TuyaOS在蓝牙业务上的需求点。
* 4，轻量化接口便于理解。
*/
 
/***********************************************************************
 ********************* constant ( macro and enum ) *********************
 **********************************************************************/
typedef enum {
    TUYA_BT_BREDR_STACK_INIT  = 0x01 ,                  
    TUYA_BT_BREDR_STACK_DEINIT,                         
    TUYA_BT_BREDR_STACK_RESET,                          
    TUYA_BT_BREDR_GAP_EVT_CONNECT,                      
    TUYA_BT_BREDR_GAP_EVT_DISCONNECT,                   
    TUYA_BT_BREDR_GAP_EVT_PAIR,                         
    TUYA_BT_BREDR_GAP_INFO_INQUIRY,                     
    TUYA_BT_BREDR_STREAM_STATUS,                        
    TUYA_BT_BREDR_PHONE_STATUS,                         
} TUYA_BT_BREDR_EVENT_TYPE_E;
 
typedef enum {
    TUYA_BT_BREDR_MODE_IDLE = 0x00,                     
    TUYA_BT_BREDR_MODE_SCAN_INQUIRY_ONLY,               
    TUYA_BT_BREDR_MODE_SCAN_PAGE_ONLY,                  
    TUYA_BT_BREDR_MODE_SCAN_INQUIRY_AND_SCAN_PAGE,      
} TUYA_BT_SCAN_MODE_E;
 
typedef enum {
    TUYA_BT_PAIR_BOND_START = 0x01,                     
    TUYA_BT_PAIR_BOND_REQUEST,                          
    TUYA_BT_PAIR_BOND_CONFIRM,                          
    TUYA_BT_PAIR_BOND_SUCCESS,                          
    TUYA_BT_PAIR_BOND_FAIL,                             
} TUYA_BT_PAIR_EVENT_TYPE_E;
 
typedef enum {
    // [AVRCP], Audio/Video Remote Control, 4.6.X Support level in CT&TG
    TUYA_BT_BREDR_RCP_START = 0x01,                    
    TUYA_BT_BREDR_RCP_PLAY,                             
    TUYA_BT_BREDR_RCP_STOP,                             
    TUYA_BT_BREDR_RCP_PAUSE,                            
    TUYA_BT_BREDR_RCP_NEXT,                             
    TUYA_BT_BREDR_RCP_PREV,                             
    TUYA_BT_BREDR_RCP_FORWARD,                          
    TUYA_BT_BREDR_RCP_REWIND,                           
    TUYA_BT_BREDR_RCP_REPEAT,                           
    TUYA_BT_BREDR_RCP_MUTE,                             
    TUYA_BT_BREDR_RCP_VOLUME_UP,                        
    TUYA_BT_BREDR_RCP_VOLUME_DOWN,                      
    // [HFP], Hands-Free Profile
    TUYA_BT_BREDR_HFP_START,                            
    TUYA_BT_BREDR_HFP_ANSWER,                           
    TUYA_BT_BREDR_HFP_HANGUP,                           
    TUYA_BT_BREDR_HFP_REJECT,                           
    TUYA_BT_BREDR_HFP_CALL,                             
    // [HFP], Need to post the data
    TUYA_BT_BREDR_HFP_UPDATE_BATTERY,                   
    TUYA_BT_BREDR_HFP_VOLUME_UP,                        
    TUYA_BT_BREDR_HFP_VOLUME_DOWN,                      
    TUYA_BT_BREDR_HFP_SET_VOLUME,                       
    TUYA_BT_BREDR_HFP_GET_VOLUME,                       
    TUYA_BT_BREDR_A2DP_DISCONNECT,                      
    TUYA_BT_BREDR_HFP_DISCONNECT,                       
    TUYA_BT_BREDR_START_CONNECTION,                     
    TUYA_BT_BREDR_CANCEL_CONNECTION,                    
} TUYA_BT_BREDR_CONTROL_E;
 
typedef enum {
    TUYA_BT_BREDR_ROLE_MASTER = 0x01,                   
    TUYA_BT_BREDR_ROLE_SLAVE  = 0x02,                   
} TUYA_BT_BREDR_ROLE_E;
 
typedef enum {
    TUYA_BT_STREAM_STATUS_IDLE = 0x01,                  
    TUYA_BT_STREAM_STATUS_CONNECTED,                    
    TUYA_BT_STREAM_STATUS_DISCONNECTED,                 
    TUYA_BT_STREAM_STATUS_START,                        
    TUYA_BT_STREAM_STATUS_SUSPENDING,                   
    TUYA_BT_STREAM_STATUS_STOP,                         
} TUYA_BT_BREDR_STEAM_STATUS_E;
 
typedef enum {
    TUYA_BT_PHONE_STATUS_IDLE = 0x01,                   
    TUYA_BT_PHONE_STATUS_CONNECTED,                     
    TUYA_BT_PHONE_STATUS_DISCONNECTED,                  
    TUYA_BT_PHONE_INCOMING,                             
    TUYA_BT_PHONE_OUTGOING,                             
    TUYA_BT_PHONE_ACTIVE,                               
    TUYA_BT_PHONE_HANGUP,                               
    TUYA_BT_PHONE_VOLOUME_CHANGED,                      
    TUYA_BT_PHONE_UPDATE_BATTERY,                       
} TUYA_BT_BREDR_PHONE_STATUS_E;
 
typedef enum {
    TUYA_BT_PAIR_MODE_NO_PAIRING,                       
    TUYA_BT_PAIR_MODE_WAIT_FOR_REQ,                     
    TUYA_BT_PAIR_MODE_INITIATE,                         
} TUYA_BT_PAIR_MODE_E;
 
typedef enum {
    TUYA_BT_IO_CAP_DISPLAY_ONLY,                        
    TUYA_BT_IO_CAP_DISPLAY_YES_NO,                      
    TUYA_BT_IO_CAP_KEYBOARD_ONLY,                       
    TUYA_BT_IO_CAP_NO_INPUT_NO_OUTPUT,                  
    TUYA_BT_IO_CAP_KEYBOARD_DISPLAY,                    
} TUYA_BT_PAIR_IO_CAP_E;
 
typedef enum {
    TUYA_BT_PAIR_REQUEST_CONFIRMATION,                  
    TUYA_BT_PAIR_REQUEST_PASSKEY,                       
    TUYA_BT_PAIR_REQUEST_PRESSKEY,                      
    TUYA_BT_PAIR_REQUEST_PIN,                           
} TUYA_BT_PAIR_REQUEST_T;
 
/***********************************************************************
 ********************* struct ******************************************
 **********************************************************************/
typedef struct {
    UCHAR_T                             type;           
    UCHAR_T                             addr[6];        
} TUYA_BT_GAP_ADDR_T;
 
typedef struct {
    TUYA_BT_PAIR_MODE_E                 mode;           
    TUYA_BT_PAIR_IO_CAP_E               io_cap;         
    UCHAR_T                             oob_data;
    UCHAR_T                             mitm;           
    BOOL_T                              ble_secure_conn;
    UINT_T                              passkey;        
} TUYA_BT_PAIR_INIT_PARAM_T;
 
typedef struct {
    TUYA_BT_GAP_ADDR_T                  addr;           
    UCHAR_T                             link_key[16];   
    VOID                                *user_data;
} TUYA_BT_PAIR_BOND_INFO_T;
 
typedef struct {
    TUYA_BT_GAP_ADDR_T                  addr;           
    UINT_T                              passkey;        
    VOID                                *user_data;
} TUYA_BT_PAIR_DEVICE_T;
 
typedef struct {
    TUYA_BT_GAP_ADDR_T                  addr;           
    UINT_T                              reason;         
    VOID                                *user_data;
} TUYA_BT_DISCONNECT_EVT_T;
 
typedef struct {
    TUYA_BT_PAIR_REQUEST_T              req;            
    UINT_T                              passkey;        
    VOID                                *user_data;
} TUYA_BT_PAIR_BOND_EVT_T;
 
typedef struct {
    TUYA_BT_GAP_ADDR_T                  addr;           
    UCHAR_T                             *name;          
    UCHAR_T                             name_len;
    VOID                                *user_data;
} TUYA_BT_PAIR_INQUIRY_EVT_T;
 
 
typedef struct {
    TUYA_BT_BREDR_STEAM_STATUS_E        status;         
    VOID_T                              *p_endpoint;    
    VOID_T                              *p_connection;  
    VOID_T                              *user_data;     
} TUYA_BT_BREDR_STEAM_T;
 
typedef struct {
    TUYA_BT_BREDR_PHONE_STATUS_E        status;         
    UINT8_T                             user_data_len;  
    VOID_T                              *user_data;     
} TUYA_BT_BREDR_PHONE_T;
 
typedef struct {
    TUYA_BT_BREDR_EVENT_TYPE_E          type;           
    INT_T                               result;         
    union {
        TUYA_BT_PAIR_BOND_EVT_T         pair;           
        TUYA_BT_PAIR_INQUIRY_EVT_T      device;         
        TUYA_BT_DISCONNECT_EVT_T        disconnect;     
        TUYA_BT_PAIR_BOND_INFO_T        bond;           
        TUYA_BT_BREDR_STEAM_T           audio;          
        TUYA_BT_BREDR_PHONE_T           phone;          
    } profile_event;
} TUYA_BT_BREDR_EVENT_T;
 
 
/***********************************************************************
 ********************* variable ****************************************
 **********************************************************************/
typedef VOID(*TUYA_BT_BREDR_EVT_FUNC_CB)(TUYA_BT_BREDR_EVENT_T *p_event);
 
/***********************************************************************
 ********************* function ****************************************
 **********************************************************************/
 
 
 
OPERATE_RET tkl_bt_bredr_init(TUYA_BT_BREDR_ROLE_E role, TUYA_BT_BREDR_EVT_FUNC_CB p_event, VOID_T *user_data);
 
OPERATE_RET tkl_bt_bredr_deinit(TUYA_BT_BREDR_ROLE_E role);
 
OPERATE_RET tkl_bt_bredr_reset(TUYA_BT_BREDR_ROLE_E role);
 
OPERATE_RET tkl_bt_bredr_pair_set(TUYA_BT_PAIR_INIT_PARAM_T pair);
 
OPERATE_RET tkl_bt_bredr_enable(TUYA_BT_SCAN_MODE_E mode);
 
OPERATE_RET tkl_bt_bredr_page_enable(BOOL_T enable, TUYA_BT_GAP_ADDR_T *p_peer_addr);
 
OPERATE_RET tkl_bt_bredr_inquiry_enable(BOOL_T enable);
 
OPERATE_RET tkl_bt_gap_address_set(TUYA_BT_GAP_ADDR_T CONST *p_peer_addr);
 
OPERATE_RET tkl_bt_gap_address_get(TUYA_BT_GAP_ADDR_T *p_peer_addr);
 
OPERATE_RET tkl_bt_gap_name_set(CHAR_T *name);
 
OPERATE_RET tkl_bt_gap_name_get(CHAR_T *name);
 
OPERATE_RET tkl_bt_gap_paring_request(TUYA_BT_PAIR_DEVICE_T *p_device);
 
OPERATE_RET tkl_bt_gap_paring_passkey_send(UINT_T passkey);
 
OPERATE_RET tkl_bt_gap_paring_enable_send(BOOL_T en);
 
OPERATE_RET tkl_bt_gap_paring_delete(TUYA_BT_PAIR_BOND_INFO_T *bond_info);
 
BOOL_T tkl_bt_pairing_status_get(VOID_T);
 
OPERATE_RET tkl_bt_gap_disconnect(TUYA_BT_PAIR_BOND_INFO_T *bond_info);
 
OPERATE_RET tkl_bt_bredr_control(TUYA_BT_BREDR_CONTROL_E crtl_event, UCHAR_T *user_data, USHORT_T data_len);
 
OPERATE_RET tkl_bt_bredr_equalizer_set(UCHAR_T eq_mode, UCHAR_T *eq_data, USHORT_T eq_data_len);
 
OPERATE_RET tkl_bt_bredr_equalizer_switch(UCHAR_T eq_mode, BOOL_T enable);
 
OPERATE_RET tkl_bt_bredr_noise_set(UCHAR_T noise_mode, USHORT_T noise_data);
 
OPERATE_RET tkl_bt_bredr_noise_switch(UCHAR_T noise_mode, BOOL_T enable);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* __TKL_BLUETOOTH_BREDR_H__ */