bluenrg_gap_aci.h

Go to the documentation of this file.

/******************** (C) COPYRIGHT 2014 STMicroelectronics ********************
* File Name          : bluenrg_gap_aci.h
* Author             : AMS - AAS
* Version            : V1.0.0
* Date               : 26-Jun-2014
* Description        : Header file with GAP commands for BlueNRG FW6.3.
********************************************************************************
* THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
* WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME.
* AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT,
* INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE
* CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING
* INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
*******************************************************************************/

#ifndef __BLUENRG_GAP_ACI_H__
#define __BLUENRG_GAP_ACI_H__

tBleStatus aci_gap_init_IDB05A1(uint8_t role, uint8_t privacy_enabled,
                        uint8_t device_name_char_len,
                        uint16_t* service_handle,
                        uint16_t* dev_name_char_handle,
                        uint16_t* appearance_char_handle);

tBleStatus aci_gap_init_IDB04A1(uint8_t role,
                 uint16_t* service_handle,
                 uint16_t* dev_name_char_handle,
                 uint16_t* appearance_char_handle);

tBleStatus aci_gap_set_non_discoverable(void);

tBleStatus aci_gap_set_limited_discoverable(uint8_t AdvType, uint16_t AdvIntervMin, uint16_t AdvIntervMax,
                        uint8_t OwnAddrType, uint8_t AdvFilterPolicy, uint8_t LocalNameLen,
                        const char *LocalName, uint8_t ServiceUUIDLen, uint8_t* ServiceUUIDList,
                        uint16_t SlaveConnIntervMin, uint16_t SlaveConnIntervMax);
tBleStatus aci_gap_set_discoverable(uint8_t AdvType, uint16_t AdvIntervMin, uint16_t AdvIntervMax,
                             uint8_t OwnAddrType, uint8_t AdvFilterPolicy, uint8_t LocalNameLen,
                             const char *LocalName, uint8_t ServiceUUIDLen, uint8_t* ServiceUUIDList,
                             uint16_t SlaveConnIntervMin, uint16_t SlaveConnIntervMax);

tBleStatus aci_gap_set_direct_connectable_IDB05A1(uint8_t own_addr_type, uint8_t directed_adv_type, uint8_t initiator_addr_type,
                                          const uint8_t *initiator_addr, uint16_t adv_interv_min, uint16_t adv_interv_max);

tBleStatus aci_gap_set_direct_connectable_IDB04A1(uint8_t own_addr_type, uint8_t initiator_addr_type, const uint8_t *initiator_addr);

tBleStatus aci_gap_set_io_capability(uint8_t io_capability);

tBleStatus aci_gap_set_auth_requirement(uint8_t mitm_mode,
                                        uint8_t oob_enable,
                                        uint8_t oob_data[16],
                                        uint8_t min_encryption_key_size,
                                        uint8_t max_encryption_key_size,
                                        uint8_t use_fixed_pin,
                                        uint32_t fixed_pin,
                                        uint8_t bonding_mode);
tBleStatus aci_gap_set_author_requirement(uint16_t conn_handle, uint8_t authorization_enable);

tBleStatus aci_gap_pass_key_response(uint16_t conn_handle, uint32_t passkey);

tBleStatus aci_gap_authorization_response(uint16_t conn_handle, uint8_t authorize);

tBleStatus aci_gap_set_non_connectable_IDB05A1(uint8_t adv_type, uint8_t own_address_type);

tBleStatus aci_gap_set_non_connectable_IDB04A1(uint8_t adv_type);

tBleStatus aci_gap_set_undirected_connectable(uint8_t own_addr_type, uint8_t adv_filter_policy);

tBleStatus aci_gap_slave_security_request(uint16_t conn_handle, uint8_t bonding, uint8_t mitm_protection);

tBleStatus aci_gap_update_adv_data(uint8_t AdvLen, const uint8_t *AdvData);

tBleStatus aci_gap_delete_ad_type(uint8_t ad_type);

tBleStatus aci_gap_get_security_level(uint8_t* mitm_protection, uint8_t* bonding,
                                      uint8_t* oob_data, uint8_t* passkey_required);

tBleStatus aci_gap_configure_whitelist(void);

tBleStatus aci_gap_terminate(uint16_t conn_handle, uint8_t reason);

tBleStatus aci_gap_clear_security_database(void);

tBleStatus aci_gap_allow_rebond_IDB05A1(uint16_t conn_handle);

tBleStatus aci_gap_allow_rebond_IDB04A1(void);

tBleStatus aci_gap_start_limited_discovery_proc(uint16_t scanInterval, uint16_t scanWindow,
                        uint8_t own_address_type, uint8_t filterDuplicates);

tBleStatus aci_gap_start_general_discovery_proc(uint16_t scanInterval, uint16_t scanWindow,
                        uint8_t own_address_type, uint8_t filterDuplicates);

tBleStatus aci_gap_start_name_discovery_proc(uint16_t scanInterval, uint16_t scanWindow,
                     uint8_t peer_bdaddr_type, tBDAddr peer_bdaddr, 
                     uint8_t own_bdaddr_type, uint16_t conn_min_interval,   
                     uint16_t conn_max_interval, uint16_t conn_latency, 
                     uint16_t supervision_timeout, uint16_t min_conn_length, 
                     uint16_t max_conn_length);

tBleStatus aci_gap_start_auto_conn_establish_proc_IDB05A1(uint16_t scanInterval, uint16_t scanWindow,
                         uint8_t own_bdaddr_type, uint16_t conn_min_interval,   
                         uint16_t conn_max_interval, uint16_t conn_latency, 
                         uint16_t supervision_timeout, uint16_t min_conn_length, 
                         uint16_t max_conn_length,
                         uint8_t num_whitelist_entries,
                         const uint8_t *addr_array);

tBleStatus aci_gap_start_auto_conn_establish_proc_IDB04A1(uint16_t scanInterval, uint16_t scanWindow,
                         uint8_t own_bdaddr_type, uint16_t conn_min_interval,   
                         uint16_t conn_max_interval, uint16_t conn_latency, 
                         uint16_t supervision_timeout, uint16_t min_conn_length, 
                         uint16_t max_conn_length,
                                                 uint8_t use_reconn_addr,
                                                 const tBDAddr reconn_addr,
                                                 uint8_t num_whitelist_entries,
                                                 const uint8_t *addr_array);
tBleStatus aci_gap_start_general_conn_establish_proc_IDB05A1(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window,
                         uint8_t own_address_type, uint8_t filter_duplicates);
tBleStatus aci_gap_start_general_conn_establish_proc_IDB04A1(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window,
                         uint8_t own_address_type, uint8_t filter_duplicates, uint8_t use_reconn_addr, const tBDAddr reconn_addr);

tBleStatus aci_gap_start_selective_conn_establish_proc(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window,
                         uint8_t own_address_type, uint8_t filter_duplicates, uint8_t num_whitelist_entries,
                         const uint8_t *addr_array);

tBleStatus aci_gap_create_connection(uint16_t scanInterval, uint16_t scanWindow,
                     uint8_t peer_bdaddr_type, tBDAddr peer_bdaddr, 
                     uint8_t own_bdaddr_type, uint16_t conn_min_interval,   
                     uint16_t conn_max_interval, uint16_t conn_latency, 
                     uint16_t supervision_timeout, uint16_t min_conn_length, 
                     uint16_t max_conn_length);

tBleStatus aci_gap_terminate_gap_procedure(uint8_t procedure_code);

tBleStatus aci_gap_start_connection_update(uint16_t conn_handle, uint16_t conn_min_interval,    
                                           uint16_t conn_max_interval, uint16_t conn_latency,   
                                           uint16_t supervision_timeout, uint16_t min_conn_length, 
                                           uint16_t max_conn_length);

tBleStatus aci_gap_send_pairing_request(uint16_t conn_handle, uint8_t force_rebond);

tBleStatus aci_gap_resolve_private_address_IDB05A1(const tBDAddr private_address, tBDAddr actual_address);

tBleStatus aci_gap_resolve_private_address_IDB04A1(const tBDAddr private_address);

tBleStatus aci_gap_get_bonded_devices(uint8_t *num_devices, uint8_t *device_list, uint8_t device_list_size);

tBleStatus aci_gap_set_broadcast_mode(uint16_t adv_interv_min, uint16_t adv_interv_max, uint8_t adv_type,
                                      uint8_t own_addr_type, uint8_t adv_data_length, const uint8_t *adv_data,  uint8_t num_whitelist_entries,
                                      const uint8_t *addr_array);

tBleStatus aci_gap_start_observation_procedure(uint16_t scan_interval, uint16_t scan_window, uint8_t scan_type,
                         uint8_t own_address_type, uint8_t filter_duplicates);

tBleStatus aci_gap_is_device_bonded(uint8_t peer_address_type, const tBDAddr peer_address);

#define EVT_BLUE_GAP_LIMITED_DISCOVERABLE     (0x0400)


#define EVT_BLUE_GAP_PAIRING_CMPLT                (0x0401)
typedef __packed struct _evt_gap_pairing_cmplt{
  uint16_t conn_handle; 
  uint8_t  status;
} PACKED evt_gap_pairing_cmplt;


#define EVT_BLUE_GAP_PASS_KEY_REQUEST             (0x0402)
typedef __packed struct _evt_gap_pass_key_req{
  uint16_t conn_handle; 
} PACKED evt_gap_pass_key_req;


#define EVT_BLUE_GAP_AUTHORIZATION_REQUEST        (0x0403)
typedef __packed struct _evt_gap_author_req{
  uint16_t conn_handle; 
} PACKED evt_gap_author_req;

#define EVT_BLUE_GAP_SLAVE_SECURITY_INITIATED     (0X0404)

#define EVT_BLUE_GAP_BOND_LOST                    (0X0405)

#define EVT_BLUE_GAP_DEVICE_FOUND                 (0x0406)
typedef __packed struct _evt_gap_device_found{
    uint8_t     evt_type;     
    uint8_t     bdaddr_type;  
    tBDAddr bdaddr;       
    uint8_t     data_length;  
    uint8_t     data_RSSI[VARIABLE_SIZE]; 
} PACKED evt_gap_device_found;

#define EVT_BLUE_GAP_PROCEDURE_COMPLETE           (0x0407)
typedef __packed struct _evt_gap_procedure_complete{
  uint8_t procedure_code; 
  uint8_t status;
  uint8_t data[VARIABLE_SIZE];
} PACKED evt_gap_procedure_complete;

#define EVT_BLUE_GAP_ADDR_NOT_RESOLVED_IDB05A1          (0x0408)
typedef __packed struct _evt_gap_addr_not_resolved_IDB05A1{
  uint16_t conn_handle; 
} PACKED evt_gap_addr_not_resolved_IDB05A1;

#define EVT_BLUE_GAP_RECONNECTION_ADDRESS_IDB04A1       (0x0408)
typedef __packed struct _evt_gap_reconnection_addr_IDB04A1{
  uint8_t reconnection_address[6]; 
} PACKED evt_gap_reconnection_addr_IDB04A1;

#endif /* __BLUENRG_GAP_ACI_H__ */