bts_le_gap.h

浏览该文件的文档.

 
#ifndef BTS_LE_GAP_H
#define BTS_LE_GAP_H
 
#include <stdint.h>
#include "errcode.h"
#include "bts_def.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    GAP_BLE_APPEARANCE_TYPE_UNKNOWN = 00,                  
    GAP_BLE_APPEARANCE_TYPE_GENERIC_PHONE = 64,            
    GAP_BLE_APPEARANCE_TYPE_GENERIC_COMPUTER = 128,        
    GAP_BLE_APPEARANCE_TYPE_GENERIC_WATCH = 192,           
    GAP_BLE_APPEARANCE_TYPE_GENERIC_DISPLAY = 320,         
    GAP_BLE_APPEARANCE_TYPE_GENERIC_HID = 960,             
    GAP_BLE_APPEARANCE_TYPE_KEYBOARD = 961,                
    GAP_BLE_APPEARANCE_TYPE_MOUSE = 962,                   
    GAP_BLE_APPEARANCE_TYPE_DIGITAL_PEN = 967,             
} gap_ble_appearance_type_t;
 
typedef enum {
    GAP_BLE_ADV_FILTER_ALLOW_SCAN_ANY_CON_ANY = 0x00,   
    GAP_BLE_ADV_FILTER_ALLOW_SCAN_WLST_CON_ANY = 0x01,  
    GAP_BLE_ADV_FILTER_ALLOW_SCAN_ANY_CON_WLST = 0x02,  
    GAP_BLE_ADV_FILTER_ALLOW_SCAN_WLST_CON_WLST = 0x03, 
} gap_ble_adv_filter_allow_scan_t;
 
typedef enum {
    GAP_BLE_ADV_CONN_SCAN_UNDIR = 0,        
    GAP_BLE_ADV_CONN_NONSCAN_DIR,           
    GAP_BLE_ADV_NONCONN_SCAN_UNDIR,         
    GAP_BLE_ADV_NONCONN_NONSCAN_UNDIR,      
    GAP_BLE_ADV_CONN_NONSCAN_DIR_LOW_DUTY,  
} gap_ble_adv_type_t;
 
typedef enum {
    GAP_BLE_SCAN_TYPE_PASSIVE = 0x00, 
    GAP_BLE_SCAN_TYPE_ACTIVE,         
} gap_ble_scan_type_t;
 
typedef enum {
    GAP_BLE_SCAN_FILTER_POLICY_ACCEPT_ALL = 0x00,       
    GAP_BLE_SCAN_FILTER_POLICY_ONLY_WHITE_LIST,         
    GAP_BLE_SCAN_FILTER_POLICY_ACCEPT_ALL_AND_RPA,      
    GAP_BLE_SCAN_FILTER_POLICY_ONLY_WHITE_LIST_AND_RPA, 
} gap_ble_scan_filter_policy_t;
 
typedef enum {
    GAP_BLE_EVT_NON_CONNECTABLE_NON_SCANNABLE = 0x00,          
    GAP_BLE_EVT_NON_CONNECTABLE_NON_SCANNABLE_DIRECTED = 0x04, 
    GAP_BLE_EVT_CONNECTABLE = 0x01,                            
    GAP_BLE_EVT_CONNECTABLE_DIRECTED = 0x05,                   
    GAP_BLE_EVT_SCANNABLE = 0x02,                              
    GAP_BLE_EVT_SCANNABLE_DIRECTED = 0x06,                     
    GAP_BLE_EVT_LEGACY_NON_CONNECTABLE = 0x10,                 
    GAP_BLE_EVT_LEGACY_SCANNABLE = 0x12,                       
    GAP_BLE_EVT_LEGACY_CONNECTABLE = 0x13,                     
    GAP_BLE_EVT_LEGACY_CONNECTABLE_DIRECTED = 0x15,            
    GAP_BLE_EVT_LEGACY_SCAN_RSP_TO_ADV_SCAN = 0x1A,            
    GAP_BLE_EVT_LEGACY_SCAN_RSP_TO_ADV = 0x1B                  
} gap_ble_scan_result_evt_type_t;
 
typedef struct {
    uint16_t conn_handle;        
    uint16_t interval_min;       
    uint16_t interval_max;       
    uint16_t slave_latency;      
    uint16_t timeout_multiplier; 
} gap_conn_param_update_t;
 
typedef struct {
    uint16_t conn_handle;       
    uint8_t all_phys;           
    uint8_t tx_phys;            
    uint8_t rx_phys;            
    uint16_t phy_options;       
} gap_le_set_phy_t;
 
typedef struct {
    uint16_t conn_handle;       
    uint16_t maxtxoctets;           
    uint16_t maxtxtime;            
} gap_le_set_data_length_t;
 
typedef enum {
    GAP_BLE_DATA_COMPLETE = 0x00,                
    GAP_BLE_DATA_INCOMPLETE_MORE_TO_COME = 0x01, 
    GAP_BLE_DATA_INCOMPLETE_TRUNCATED = 0x02,    
} gap_ble_scan_result_data_status_t;
 
typedef enum {
    GAP_BLE_PHY_NO_PACKET = 0x00, 
    GAP_BLE_PHY_1M = 0x01,        
    GAP_BLE_PHY_2M = 0x02,        
    GAP_BLE_PHY_CODED = 0x03      
} gap_ble_phy_type_t;
 
typedef enum {
    ADV_STATUS_STOPPED = 0x00, 
    ADV_STATUS_ADVERTISING,    
} adv_status_t;
 
typedef struct {
    uint16_t adv_length;      
    uint8_t *adv_data;        
    uint16_t scan_rsp_length; 
    uint8_t *scan_rsp_data;   
} gap_ble_config_adv_data_t;
 
typedef struct {
    uint8_t *filter_key;        
    uint8_t filter_key_len;     
    uint8_t filter_key_offset;  
} gap_ble_adv_data_filter_t;
 
typedef struct {
    uint32_t min_interval;     
    uint32_t max_interval;     
    uint8_t adv_type;          
    bd_addr_t own_addr;       
    bd_addr_t peer_addr;       
    uint8_t channel_map;       
    uint8_t adv_filter_policy; 
    int8_t   tx_power;         
    uint32_t duration;         
} gap_ble_adv_params_t;
 
typedef enum {
    GAP_BLE_GAP_SECURITY_MODE1_LEVEL1 = 0,     
    GAP_BLE_GAP_SECURITY_MODE1_LEVEL2,         
    GAP_BLE_GAP_SECURITY_MODE1_LEVEL3,         
    GAP_BLE_GAP_SECURITY_MODE1_LEVEL4,         
    GAP_BLE_GAP_SECURITY_MODE2_LEVEL1,         
    GAP_BLE_GAP_SECURITY_MODE2_LEVEL2,         
} gap_ble_sec_mode_t;
 
typedef enum {
    GAP_BLE_IO_CAPABILITY_DISPLAYONLY = 0,     
    GAP_BLE_IO_CAPABILITY_DISPLAYYESNO,        
    GAP_BLE_IO_CAPABILITY_KEYBOARDONLY,        
    GAP_BLE_IO_CAPABILITY_NOINPUTNOOUTPUT,     
    GAP_BLE_IO_CAPABILITY_KEYBOARDDISPLAY,     
} gap_ble_io_ability_t;
 
typedef struct {
    uint16_t scan_interval;     
    uint16_t scan_window;       
    uint8_t scan_type;          
    uint8_t scan_phy;           
    uint8_t scan_filter_policy; 
} gap_ble_scan_params_t;
 
typedef struct {
    uint8_t event_type;             
    uint8_t data_status;            
    bd_addr_t addr;                 
    uint8_t primary_phy;            
    uint8_t secondary_phy;          
    uint8_t adv_sid;                
    int8_t tx_power;                
    int8_t rssi;                    
    uint16_t periodic_adv_interval; 
    bd_addr_t direct_addr;          
    uint8_t adv_len;                
    uint8_t *adv_data;              
} gap_scan_result_data_t;
 
typedef enum {
    GAP_BLE_FILTER_DUPLICATES_DISABLE = 0,       
    GAP_BLE_FILTER_DUPLICATES_ENABLE,            
    GAP_BLE_FILTER_DUPLICATES_ENABLE_FOR_PERIOD, 
} gap_ble_filter_duplicates_t;
 
typedef struct {
    uint8_t filter_duplicate; 
    uint8_t limited;          
    uint16_t duration;        
    uint16_t period;          
} gap_ble_extern_scan_params_t;
 
typedef enum {
    GAP_BLE_PAIR_NONE = 0x01,    
    GAP_BLE_PAIR_PAIRING = 0x02, 
    GAP_BLE_PAIR_PAIRED = 0x03   
} gap_ble_pair_state_t;
 
typedef enum {
    GAP_BLE_DISCONN_UNKNOWN              = 0x00,    
    GAP_BLE_ERR_CONN_TIMEOUT             = 0x8,     
    GAP_BLE_DICSCONNECT_BY_REMOTE_USER   = 0x13,    
    GAP_BLE_CONN_TERMINATE_BY_LOCAL_HOST = 0x16,    
} gap_ble_disc_reason_t;
 
typedef enum {
    GAP_BLE_STATE_DISCONNECTED,
    GAP_BLE_STATE_CONNECTED    
} gap_ble_conn_state_t;
 
 
typedef struct {
    uint16_t interval;          
    uint16_t latency;           
    uint16_t timeout;           
} gap_ble_conn_param_update_t;
 
typedef struct {
    uint8_t bondable;          
    uint8_t io_capability;     
    uint8_t sc_enable;         
    uint8_t sc_mode;           
} gap_ble_sec_params_t;
 
#define BLE_PAIRED_LTK_LEN 16
 
typedef struct {
    uint8_t ltk_len;                            
    uint8_t ltk[BLE_PAIRED_LTK_LEN];            
} ble_auth_info_evt_t;
 
typedef void (*gap_ble_enable_callback)(errcode_t status);
 
typedef void (*gap_ble_disable_callback)(errcode_t status);
 
typedef void (*gap_ble_start_adv_callback)(uint8_t adv_id, adv_status_t status);
 
typedef void (*gap_ble_stop_adv_callback)(uint8_t adv_id, adv_status_t status);
 
typedef void (*gap_ble_set_adv_data_callback)(uint8_t adv_id, errcode_t status);
 
typedef void (*gap_ble_set_adv_param_callback)(uint8_t adv_id, errcode_t status);
 
typedef void (*gap_ble_scan_result_callback)(gap_scan_result_data_t *scan_result_data);
 
typedef void (*gap_ble_set_scan_param_callback)(errcode_t status);
 
typedef void (*gap_ble_connect_state_changed_callback)(uint16_t conn_id, bd_addr_t *addr,
    gap_ble_conn_state_t conn_state, gap_ble_pair_state_t pair_state, gap_ble_disc_reason_t disc_reason);
 
typedef void (*gap_ble_paired_complete_callback)(uint16_t conn_id, const bd_addr_t *addr, errcode_t status);
 
typedef void (*gap_ble_terminate_adv_callback)(uint8_t adv_id, adv_status_t status);
 
typedef void (*gap_ble_read_rssi_callback)(uint16_t conn_id, int8_t rssi, errcode_t status);
 
typedef void (*gap_ble_auth_complete_callback)(uint16_t conn_id, const bd_addr_t *addr, errcode_t status,
    const ble_auth_info_evt_t* evt);
 
typedef void (*gap_ble_connect_param_update_callback)(uint16_t conn_id, errcode_t status,
    const gap_ble_conn_param_update_t *param);
 
typedef struct {
    gap_ble_enable_callback ble_enable_cb;                       
    gap_ble_disable_callback ble_disable_cb;                     
    gap_ble_set_adv_data_callback set_adv_data_cb;               
    gap_ble_set_adv_param_callback set_adv_param_cb;             
    gap_ble_set_scan_param_callback set_scan_param_cb;           
    gap_ble_start_adv_callback start_adv_cb;                     
    gap_ble_stop_adv_callback stop_adv_cb;                       
    gap_ble_scan_result_callback scan_result_cb;                 
    gap_ble_connect_state_changed_callback conn_state_change_cb; 
    gap_ble_paired_complete_callback pair_result_cb;             
    gap_ble_read_rssi_callback read_rssi_cb;                     
    gap_ble_terminate_adv_callback terminate_adv_cb;             
    gap_ble_auth_complete_callback auth_complete_cb;             
    gap_ble_connect_param_update_callback conn_param_update_cb;  
} gap_ble_callbacks_t;
 
errcode_t enable_ble(void);
 
errcode_t disable_ble(void);
 
errcode_t gap_ble_set_local_addr(const bd_addr_t *addr);
 
errcode_t gap_ble_get_local_addr(bd_addr_t *addr);
 
errcode_t gap_ble_set_local_appearance(uint16_t appearance);
 
errcode_t gap_ble_set_local_name(const uint8_t *name, const uint8_t len);
 
errcode_t gap_ble_get_local_name(uint8_t *name, uint8_t *len);
 
errcode_t gap_ble_set_adv_data(uint8_t adv_id, const gap_ble_config_adv_data_t *data);
 
errcode_t gap_ble_set_adv_param(uint8_t adv_id, const gap_ble_adv_params_t *param);
 
errcode_t gap_ble_start_adv(uint8_t adv_id);
 
errcode_t gap_ble_stop_adv(uint8_t adv_id);
 
errcode_t gap_ble_set_scan_parameters(const gap_ble_scan_params_t *param);
 
errcode_t gap_ble_set_scan_extern_parameters(const gap_ble_extern_scan_params_t *param);
 
errcode_t gap_ble_set_adv_data_filter(uint8_t filter_count, gap_ble_adv_data_filter_t *filter_key);
 
errcode_t gap_ble_clean_adv_data_filter(void);
 
errcode_t gap_ble_start_scan(void);
 
errcode_t gap_ble_stop_scan(void);
 
errcode_t gap_ble_set_phy(gap_le_set_phy_t *param);
 
errcode_t gap_ble_set_data_length(gap_le_set_data_length_t *param);
 
errcode_t gap_ble_pair_remote_device(const bd_addr_t *addr);
 
errcode_t gap_ble_get_paired_devices_num(uint16_t *number);
 
errcode_t gap_ble_get_paired_devices(bd_addr_t *addr, uint16_t *number);
 
errcode_t gap_ble_get_pair_state(const bd_addr_t *addr, gap_ble_pair_state_t *status);
 
errcode_t gap_ble_remove_pair(const bd_addr_t *addr);
 
errcode_t gap_ble_remove_all_pairs(void);
 
errcode_t gap_ble_get_bonded_devices(bd_addr_t *addr, uint16_t *number);
 
errcode_t gap_ble_connect_param_update(gap_conn_param_update_t *params);
 
errcode_t gap_ble_connect_remote_device(const bd_addr_t *addr);
 
errcode_t gap_ble_disconnect_remote_device(const bd_addr_t *addr);
 
errcode_t gap_ble_set_sec_param(gap_ble_sec_params_t *params);
 
errcode_t gap_ble_read_remote_device_rssi(uint16_t conn_id);
 
errcode_t gap_ble_register_callbacks(gap_ble_callbacks_t *func);
 
errcode_t bth_ota_init(void);
 
errcode_t ble_customize_max_pwr(int8_t ble_pwr, int8_t sle_pwr);
 
#ifdef __cplusplus
}
#endif
#endif