bt_gap.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __BT_GAP_H__
#define __BT_GAP_H__

#include "bt_type.h"
#include "bt_system.h"

BT_EXTERN_C_BEGIN

#define BT_GAP_LINK_STATUS_UPDATED_IND              (BT_MODULE_GAP | 0x0101)    
#define BT_GAP_IO_CAPABILITY_REQ_IND                (BT_MODULE_GAP | 0x0103)    
#define BT_GAP_USER_CONFIRM_REQ_IND                 (BT_MODULE_GAP | 0x0104)    
#define BT_GAP_USER_PASSKEY_NOTIFICATION_IND        (BT_MODULE_GAP | 0x0105)    
#define BT_GAP_USER_PASSKEY_NOTIFICATION_END_IND    (BT_MODULE_GAP | 0x0106)    
#define BT_GAP_LINK_KEY_NOTIFICATION_IND            (BT_MODULE_GAP | 0x0107)    
#define BT_GAP_USER_REPLY_PASSKEY_IND               (BT_MODULE_GAP | 0x0108)    
#define BT_GAP_SET_SCAN_MODE_CNF                    (BT_MODULE_GAP | 0x0109)    
#define BT_GAP_INQUIRY_CNF                          (BT_MODULE_GAP | 0x010A)    
#define BT_GAP_CANCEL_INQUIRY_CNF                   (BT_MODULE_GAP | 0x010B)    
#define BT_GAP_INQUIRY_IND                          (BT_MODULE_GAP | 0x010C)    
#define BT_GAP_INQUIRY_COMPLETE_IND                 (BT_MODULE_GAP | 0x010D)    
#define BT_GAP_SET_ROLE_CNF                         (BT_MODULE_GAP | 0x010E)    
#define BT_GAP_ROLE_CHANGED_IND                     (BT_MODULE_GAP | 0x010F)    
#define BT_GAP_READ_REMOTE_NAME_CNF                 (BT_MODULE_GAP | 0x0110)    
#define BT_GAP_READ_REMOTE_NAME_COMPLETE_IND        (BT_MODULE_GAP | 0x0111)    
#define BT_GAP_READ_CANCEL_REMOTE_NAME_CNF          (BT_MODULE_GAP | 0x0112)    
#define BT_GAP_ENTER_TEST_MODE_CNF                  (BT_MODULE_GAP | 0x0113)    
#define BT_GAP_WRITE_INQUIRY_TX_PWR_CNF             (BT_MODULE_GAP | 0x0114)    
#define BT_GAP_READ_INQUIRY_RESPONSE_TX_CNF         (BT_MODULE_GAP | 0x0115)    
#define BT_GAP_READ_RSSI_CNF                        (BT_MODULE_GAP | 0x0116)    
#define BT_GAP_GET_ROLE_CNF                         (BT_MODULE_GAP | 0x0117)    
#define BT_GAP_SET_EIR_CNF                          (BT_MODULE_GAP | 0x0118)    
#define BT_GAP_BONDING_START_IND                    (BT_MODULE_GAP | 0x0119)    
#define BT_GAP_BONDING_COMPLETE_IND                 (BT_MODULE_GAP | 0x011A)    
#define BT_GAP_WRITING_PAGE_SCAN_CNF                (BT_MODULE_GAP | 0x011B)    
#define BT_GAP_WRITING_INQUIRY_SCAN_CNF             (BT_MODULE_GAP | 0x011C)    
#define BT_GAP_SNIFF_MODE_CHANGE_IND                (BT_MODULE_GAP | 0x011F)          
#define BT_GAP_SCAN_MODE_NOT_ACCESSIBLE              0x00       
#define BT_GAP_SCAN_MODE_DISCOVERABLE_ONLY           0x01       
#define BT_GAP_SCAN_MODE_CONNECTABLE_ONLY            0x02       
#define BT_GAP_SCAN_MODE_GENERAL_ACCESSIBLE          0x03       
typedef uint8_t bt_gap_scan_mode_t;                             
#define BT_GAP_MAX_PIN_CODE_LENGTH          16  
#define BT_GAP_MAX_DEVICE_NAME_LENGTH       31  
#define BT_GAP_OOB_DATA_PRESENTED_NONE               0x00       
#define BT_GAP_OOB_DATA_PRESENTED_P192               0x01       
#define BT_GAP_OOB_DATA_PRESENTED_P256               0x02       
#define BT_GAP_OOB_DATA_PRESENTED_P192_AND_P256      0x03       
typedef uint8_t bt_gap_oob_data_presented_t;                    
#define BT_GAP_IO_CAPABILITY_DISPLAY_ONLY            0x00       
#define BT_GAP_IO_CAPABILITY_DISPLAY_YES_NO          0x01       
#define BT_GAP_IO_CAPABILITY_KEYBOARD_ONLY           0x02       
#define BT_GAP_IO_CAPABILITY_NO_INPUT_NO_OUTPUT      0x03       
typedef uint8_t bt_gap_io_capability_t;                         
#define BT_GAP_SECURITY_LEVEL_0         0x8000             
#define BT_GAP_SECURITY_LEVEL_1         0x9000             
#define BT_GAP_SECURITY_LEVEL_2         0xA000             
#define BT_GAP_SECURITY_LEVEL_3         0xB000             
#define BT_GAP_SECURITY_LEVEL_4         0xC000             
typedef uint16_t bt_gap_security_level_t;                  
#define BT_GAP_LINK_STATUS_NONE                 0x0000                        
#define BT_GAP_LINK_STATUS_DISCONNECTED         0x0004                        
#define BT_GAP_LINK_STATUS_CONNECTED_0          BT_GAP_SECURITY_LEVEL_0       
#define BT_GAP_LINK_STATUS_CONNECTED_1          BT_GAP_SECURITY_LEVEL_1       
#define BT_GAP_LINK_STATUS_CONNECTED_2          BT_GAP_SECURITY_LEVEL_2       
#define BT_GAP_LINK_STATUS_CONNECTED_3          BT_GAP_SECURITY_LEVEL_3       
#define BT_GAP_LINK_STATUS_CONNECTED_4          BT_GAP_SECURITY_LEVEL_4       
typedef uint16_t             bt_gap_link_status_t;                            
#define BT_GAP_SECURITY_AUTH_REQUEST_NO_BONDING_AUTO_ACCEPTED           0x00    
#define BT_GAP_SECURITY_AUTH_REQUEST_MITM_NO_BONDING                    0x01    
#define BT_GAP_SECURITY_AUTH_REQUEST_DEDICATED_BONDING_AUTO_ACCEPTED    0x02    
#define BT_GAP_SECURITY_AUTH_REQUEST_MITM_DEDICATED_BONDING             0x03    
#define BT_GAP_SECURITY_AUTH_REQUEST_GENERAL_BONDING_AUTO_ACCEPTED      0x04    
#define BT_GAP_SECURITY_AUTH_REQUEST_MITM_GENERAL_BONDING               0x05    
typedef uint8_t bt_gap_security_auth_request_t;                                 
#define BT_GAP_LINK_KEY_TYPE_COMBINATION           0x00   
#define BT_GAP_LINK_KEY_TYPE_LOCAL_UNIT            0x01   
#define BT_GAP_LINK_KEY_TYPE_REMOTE_UNIT           0x02   
#define BT_GAP_LINK_KEY_TYPE_DEBUG                 0x03   
#define BT_GAP_LINK_KEY_TYPE_UNAUTH_P192           0x04   
#define BT_GAP_LINK_KEY_TYPE_AUTH_P192             0x05   
#define BT_GAP_LINK_KEY_TYPE_CHANGED               0x06   
#define BT_GAP_LINK_KEY_TYPE_UNAUTH_P256           0x07   
#define BT_GAP_LINK_KEY_TYPE_AUTH_P256             0x08   
#define BT_GAP_LINK_KEY_TYPE_INVAILIDE             0xFF   
#define BT_GAP_LINK_KEY_TYPE_INVALID               0xFF   
typedef uint8_t bt_gap_link_key_type_t;                   
#define BT_GAP_INQUIRY_MODE_STANDARD               0x00   
#define BT_GAP_INQUIRY_MODE_RSSI                   0x01   
#define BT_GAP_INQUIRY_MODE_RSSI_EIR               0x02   
typedef uint8_t bt_gap_inquiry_mode_t;                    
#define BT_GAP_LINK_SNIFF_TYPE_ACTIVE                  0x00     
#define BT_GAP_LINK_SNIFF_TYPE_SNIFFED                 0x02     
#define BT_GAP_LINK_SNIFF_TYPE_SUB_SNIFFED             0x03     
typedef uint8_t bt_gap_link_sniff_status_t;                     
#define BT_GAP_ACCEPT_AS_MASTER                               0x00       
#define BT_GAP_ACCEPT_AS_SLAVE                                0x01       
#define BT_GAP_REJECTED_DUE_TO_LIMITED_RESOURCES              0x0D       
#define BT_GAP_REJECTED_DUE_TO_SECURITY_REASONS               0x0E       
#define BT_GAP_ACCEPT_REJECTED_DUE_TO_UNACCEPTABLE_BDADDR     0x0F       
typedef uint8_t bt_gap_accept_connection_status_t;              
typedef uint32_t bt_gap_connection_handle_t;              
typedef struct {
    bt_gap_connection_handle_t      handle;                 
    bt_role_t                       local_role;             
} bt_gap_role_changed_ind_t;

typedef bt_gap_role_changed_ind_t bt_gap_get_role_cnf_t;   
typedef struct {
    uint16_t    max_sniff_interval; 
    uint16_t    min_sniff_interval; 
    uint16_t    sniff_attempt;      
    uint16_t    sniff_timeout;      
} bt_gap_default_sniff_params_t;

typedef struct {
    bt_gap_connection_handle_t    handle;         
    bt_gap_link_sniff_status_t    sniff_status;   
    uint16_t                      sniff_interval; 
} bt_gap_sniff_mode_changed_ind_t;

typedef struct {
    uint16_t    latency;              
    uint16_t    min_remote_timeout;   
    uint16_t    min_local_timeout;    
} bt_gap_default_sniff_subrating_params_t;

typedef struct {
    bt_gap_connection_handle_t      handle;                 
    bt_gap_link_status_t            link_status;            
    const bt_bd_addr_t*             address;                
} bt_gap_link_status_updated_ind_t;

typedef struct {
    bt_gap_connection_handle_t      handle;                 
    int8_t                          rssi;                   
} bt_gap_read_rssi_cnf_t;

BT_PACKED (
typedef struct {
    uint8_t                pin_len;                                    
    uint8_t                pin_code[BT_GAP_MAX_PIN_CODE_LENGTH];       
}) bt_gap_pin_code_information_t;

typedef struct {
    const bt_bd_addr_t*         address;            
    uint32_t                    cod;                
    const uint8_t*              rssi;               
    const uint8_t*              eir;                
} bt_gap_inquiry_ind_t;

typedef struct {
    const bt_bd_addr_t*         address;            
    const char*                 name;               
} bt_gap_read_remote_name_complete_ind_t;

BT_PACKED (
typedef struct {
    bt_bd_addr_t             address;            
    bt_key_t                 key;                
    bt_gap_link_key_type_t   key_type;           
}) bt_gap_link_key_notification_ind_t;

typedef struct {
    bt_gap_inquiry_mode_t    inquiry_mode;                 
    bt_gap_io_capability_t    io_capability;               
    uint32_t   cod;                                        
    char       device_name[BT_GAP_MAX_DEVICE_NAME_LENGTH]; 
} bt_gap_config_t;

bt_status_t bt_gap_set_scan_mode(bt_gap_scan_mode_t mode);

bt_status_t bt_gap_inquiry(uint8_t duration, uint8_t max_count);

bt_status_t bt_gap_cancel_inquiry(void);

bt_status_t bt_gap_exit_sniff_mode(bt_gap_connection_handle_t handle);

bt_status_t bt_gap_disconnect(bt_gap_connection_handle_t handle);

bt_status_t bt_gap_set_role(bt_gap_connection_handle_t handle, bt_role_t role);

bt_status_t bt_gap_get_role(bt_gap_connection_handle_t handle);

bt_status_t bt_gap_read_remote_name(const bt_bd_addr_t* address);

bt_status_t bt_gap_cancel_name_request(const bt_bd_addr_t* address);

bt_status_t bt_gap_enter_test_mode(void);

bt_status_t bt_gap_set_extended_inquiry_response(uint8_t* eir_data, uint32_t data_length);

bt_status_t bt_gap_write_inquiry_tx(int8_t tx_power);

bt_status_t bt_gap_read_inquiry_response_tx(void);

bt_status_t bt_gap_write_page_scan_activity(uint16_t interval, uint16_t window);

bt_status_t bt_gap_write_inquiry_scan_activity(uint16_t interval, uint16_t window);

const bt_bd_addr_t* bt_gap_get_remote_address(bt_gap_connection_handle_t handle);

bt_status_t bt_gap_read_rssi(bt_gap_connection_handle_t handle);

const bt_gap_pin_code_information_t* bt_gap_get_pin_code(void);

bt_status_t bt_gap_reply_io_capability_request(bt_gap_oob_data_presented_t oob_present, bt_gap_security_auth_request_t auth_request);

bt_status_t bt_gap_reject_io_capability_request(void);

bt_status_t bt_gap_reply_passkey_request(const uint32_t* passkey);

bt_status_t bt_gap_reply_user_confirm_request(bool accept);

void bt_gap_get_link_key(bt_gap_link_key_notification_ind_t* key_information);

const bt_gap_config_t* bt_gap_get_local_configuration(void);

bt_status_t bt_gap_set_default_sniff_parameters(const bt_gap_default_sniff_params_t* sniff_params);

bt_status_t bt_gap_set_default_sniff_subrating_parameters(const bt_gap_default_sniff_subrating_params_t* sniff_subrating_params);

bt_gap_accept_connection_status_t bt_gap_check_connect_request(bt_bd_addr_ptr_t address, uint32_t cod);

BT_EXTERN_C_END

#endif