/**
* UNPUBLISHED PROPRIETARY SOURCE CODE
* Copyright (c) 2016 MXCHIP Inc.
*
* The contents of this file may not be disclosed to third parties, copied or
* duplicated in any form, in whole or in part, without the prior written
* permission of MXCHIP Corporation.
*
*/
/** @file
*
* MiCO Bluetooth Low Energy (BLE) Functions
*
*/
#pragma once
#include "mico_bt_dev.h"
#define CHNL_MAP_LEN 5
typedef uint8_t mico_bt_ble_chnl_map_t[CHNL_MAP_LEN];
/** Scan modes */
enum mico_bt_ble_scan_mode_e
{
BTM_BLE_SCAN_MODE_PASSIVE = 0, /**< Passive scan mode */
BTM_BLE_SCAN_MODE_ACTIVE = 1, /**< Active scan mode */
BTM_BLE_SCAN_MODE_NONE = 0xff /**< None */
};
typedef uint8_t mico_bt_ble_scan_mode_t; /**< scan mode (see #mico_bt_ble_scan_mode_e) */
/** Scan filter policy */
enum mico_bt_ble_scan_filter_policy_e
{
BTM_BLE_SCAN_FILTER_POLICY_NONE = 0, /**< Not use White List for Scanning Procedure. */
BTM_BLE_SCAN_FILTER_POLICY_WHITE_LIST = 1, /**< Use White List for Scanning Procedure. */
};
typedef uint8_t mico_bt_ble_scan_filter_policy_t; /**< scan filter policy (see #mico_bt_ble_scan_filter_policy_e) */
/** advertising channel map */
enum mico_bt_ble_advert_chnl_map_e
{
BTM_BLE_ADVERT_CHNL_37 = (0x01 << 0), /**< ADV channel */
BTM_BLE_ADVERT_CHNL_38 = (0x01 << 1), /**< ADV channel */
BTM_BLE_ADVERT_CHNL_39 = (0x01 << 2) /**< ADV channel */
};
typedef uint8_t mico_bt_ble_advert_chnl_map_t; /**< BLE advertisement channel map (see #mico_bt_ble_advert_chnl_map_e) */
/* default advertising channel map */
#ifndef BTM_BLE_DEFAULT_ADVERT_CHNL_MAP
#define BTM_BLE_DEFAULT_ADVERT_CHNL_MAP (BTM_BLE_ADVERT_CHNL_37| BTM_BLE_ADVERT_CHNL_38| BTM_BLE_ADVERT_CHNL_39)
#endif
/** Advertising filter policy */
enum mico_bt_ble_advert_filter_policy_e {
BTM_BLE_ADVERT_FILTER_ALL_CONNECTION_REQ_ALL_SCAN_REQ = 0x00, /**< Process scan and connection requests from all devices (i.e., the White List is not in use) (default) */
BTM_BLE_ADVERT_FILTER_ALL_CONNECTION_REQ_WHITELIST_SCAN_REQ = 0x01, /**< Process connection requests from all devices and only scan requests from devices that are in the White List. */
BTM_BLE_ADVERT_FILTER_WHITELIST_CONNECTION_REQ_ALL_SCAN_REQ = 0x02, /**< Process scan requests from all devices and only connection requests from devices that are in the White List */
BTM_BLE_ADVERT_FILTER_WHITELIST_CONNECTION_REQ_WHITELIST_SCAN_REQ = 0x03, /**< Process scan and connection requests only from devices in the White List. */
BTM_BLE_ADVERT_FILTER_MAX
};
typedef uint8_t mico_bt_ble_advert_filter_policy_t; /**< Advertising filter policy (see #mico_bt_ble_advert_filter_policy_e) */
/* default advertising filter policy */
#define BTM_BLE_ADVERT_FILTER_DEFAULT BTM_BLE_ADVERT_FILTER_ALL_CONNECTION_REQ_ALL_SCAN_REQ
/* adv parameter boundary values */
#define BTM_BLE_ADVERT_INTERVAL_MIN 0x0020
#define BTM_BLE_ADVERT_INTERVAL_MAX 0x4000
/* connection parameter boundary values */
#define BTM_BLE_SCAN_INTERVAL_MIN 0x0004
#define BTM_BLE_SCAN_INTERVAL_MAX 0x4000
#define BTM_BLE_SCAN_WINDOW_MIN 0x0004
#define BTM_BLE_SCAN_WINDOW_MAX 0x4000
#define BTM_BLE_CONN_INTERVAL_MIN 0x0006
#define BTM_BLE_CONN_INTERVAL_MAX 0x0C80
#define BTM_BLE_CONN_LATENCY_MAX 500
#define BTM_BLE_CONN_SUP_TOUT_MIN 0x000A
#define BTM_BLE_CONN_SUP_TOUT_MAX 0x0C80
#define BTM_BLE_CONN_PARAM_UNDEF 0xffff /* use this value when a specific value not to be overwritten */
#define BTM_BLE_CONN_SUP_TOUT_DEF 700
/* default connection parameters if not configured, use GAP recommend value for auto/selective connection */
/* default scan interval */
#define BTM_BLE_SCAN_FAST_INTERVAL 96 /* 30 ~ 60 ms (use 60) = 96 *0.625 */
/* default scan window for background connection, applicable for auto connection or selective conenction */
#define BTM_BLE_SCAN_FAST_WINDOW 48 /* 30 ms = 48 *0.625 */
/* default scan paramter used in reduced power cycle (background scanning) */
#define BTM_BLE_SCAN_SLOW_INTERVAL_1 2048 /* 1.28 s = 2048 *0.625 */
#define BTM_BLE_SCAN_SLOW_WINDOW_1 18 /* 11.25 ms = 18 *0.625 */
/* default scan paramter used in reduced power cycle (background scanning) */
#define BTM_BLE_SCAN_SLOW_INTERVAL_2 4096 /* 2.56 s = 4096 *0.625 */
#define BTM_BLE_SCAN_SLOW_WINDOW_2 36 /* 22.5 ms = 36 *0.625 */
/* default connection interval min */
#define BTM_BLE_CONN_INTERVAL_MIN_DEF 24 /* recommended min: 30ms = 24 * 1.25 */
/* default connectino interval max */
#define BTM_BLE_CONN_INTERVAL_MAX_DEF 40 /* recommended max: 50 ms = 56 * 1.25 */
/* default slave latency */
#define BTM_BLE_CONN_SLAVE_LATENCY_DEF 0 /* 0 */
/* default supervision timeout */
#define BTM_BLE_CONN_TIMEOUT_DEF 2000
#define BTM_BLE_DIR_CONN_FALLBACK_UNDIR 1
#define BTM_BLE_DIR_CONN_FALLBACK_NO_ADV 2
#define BTM_BLE_DIR_CONN_FALLBACK BTM_BLE_DIR_CONN_FALLBACK_UNDIR
/** BLE Signature */
#define BTM_BLE_AUTH_SIGNATURE_SIZE 12 /**< BLE data signature length 8 Bytes + 4 bytes counter*/
typedef uint8_t mico_dev_ble_signature_t[BTM_BLE_AUTH_SIGNATURE_SIZE]; /**< Device address (see #BTM_BLE_AUTH_SIGNATURE_SIZE) */
#define BTM_BLE_POLICY_BLACK_ALL 0x00 /* relevant to both */
#define BTM_BLE_POLICY_ALLOW_SCAN 0x01 /* relevant to advertiser */
#define BTM_BLE_POLICY_ALLOW_CONN 0x02 /* relevant to advertiser */
#define BTM_BLE_POLICY_WHITE_ALL 0x03 /* relevant to both */
/* ADV data flag bit definition used for BTM_BLE_ADVERT_TYPE_FLAG */
#define BTM_BLE_LIMITED_DISCOVERABLE_FLAG (0x01 << 0)
#define BTM_BLE_GENERAL_DISCOVERABLE_FLAG (0x01 << 1)
#define BTM_BLE_BREDR_NOT_SUPPORTED (0x01 << 2)
/* 4.1 spec adv flag for simultaneous BR/EDR+LE connection support (see) */
#define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED (0x01 << 3) /**< Simultaneous LE and BR/EDR to Same Device Capable (Controller). */
#define BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED (0x01 << 4) /**< Simultaneous LE and BR/EDR to Same Device Capable (Host). */
#define BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG (0x00 ) /* lowest bit unset */
#define BTM_BLE_ADVERT_FLAG_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG | BTM_BLE_BREDR_NOT_SUPPORTED | BTM_BLE_GENERAL_DISCOVERABLE_FLAG)
#define BTM_BLE_LIMITED_DISCOVERABLE_MASK (BTM_BLE_LIMITED_DISCOVERABLE_FLAG )
/** Advertisement Data bit masks */
enum mico_bt_ble_advert_mask_e {
BTM_BLE_ADVERT_BIT_DEV_NAME = (0x00000001 << 0), /**< Device Name */
BTM_BLE_ADVERT_BIT_FLAGS = (0x00000001 << 1), /**< Flags */
BTM_BLE_ADVERT_BIT_MANUFACTURER = (0x00000001 << 2), /**< Manufacturer Specific Data */
BTM_BLE_ADVERT_BIT_TX_POWER = (0x00000001 << 3), /**< Transmit Power Level */
BTM_BLE_ADVERT_BIT_INTERVAL_RANGE = (0x00000001 << 5), /**< Slave preferred connection interval range */
BTM_BLE_ADVERT_BIT_SERVICE = (0x00000001 << 6), /**< Service UUID (16-bit) */
BTM_BLE_ADVERT_BIT_SERVICE_SOLICITATION = (0x00000001 << 7), /**< Service Solicitation (16-bit) */
BTM_BLE_ADVERT_BIT_SERVICE_DATA = (0x00000001 << 8), /**< Service Data */
BTM_BLE_ADVERT_BIT_SIGN_DATA = (0x00000001 << 9), /**< Signed data */
BTM_BLE_ADVERT_BIT_SERVICE_128SOLICITATION = (0x00000001 << 10), /**< Service Solicitation (128-bit) */
BTM_BLE_ADVERT_BIT_APPEARANCE = (0x00000001 << 11), /**< Appearance */
BTM_BLE_ADVERT_BIT_PUBLIC_ADDR = (0x00000001 << 12), /**< Public Target Address */
BTM_BLE_ADVERT_BIT_RANDOM_ADDR = (0x00000001 << 13), /**< Random Target Address */
BTM_BLE_ADVERT_BIT_SERVICE_32 = (0x00000001 << 4), /**< Service UUIDs (32-bit) */
BTM_BLE_ADVERT_BIT_SERVICE_32SOLICITATION = (0x00000001 << 14), /**< Service Solicitation (32-bit) */
BTM_BLE_ADVERT_BIT_PROPRIETARY = (0x00000001 << 15), /**< Priorpietary */
BTM_BLE_ADVERT_BIT_SERVICE_128 = (0x00000001 << 16) /**< Service UUIDs (128-bit) */
};
typedef uint32_t mico_bt_ble_advert_mask_t; /**< BLE advertisement mask (see #mico_bt_ble_advert_mask_e) */
/** Advertisement data types */
enum mico_bt_ble_advert_type_e {
BTM_BLE_ADVERT_TYPE_FLAG = 0x01, /**< Advertisement flags */
BTM_BLE_ADVERT_TYPE_16SRV_PARTIAL = 0x02, /**< List of supported services - 16 bit UUIDs (partial) */
BTM_BLE_ADVERT_TYPE_16SRV_COMPLETE = 0x03, /**< List of supported services - 16 bit UUIDs (complete) */
BTM_BLE_ADVERT_TYPE_32SRV_PARTIAL = 0x04, /**< List of supported services - 32 bit UUIDs (partial) */
BTM_BLE_ADVERT_TYPE_32SRV_COMPLETE = 0x05, /**< List of supported services - 32 bit UUIDs (complete) */
BTM_BLE_ADVERT_TYPE_128SRV_PARTIAL = 0x06, /**< List of supported services - 128 bit UUIDs (partial) */
BTM_BLE_ADVERT_TYPE_128SRV_COMPLETE = 0x07, /**< List of supported services - 128 bit UUIDs (complete) */
BTM_BLE_ADVERT_TYPE_NAME_SHORT = 0x08, /**< Short name */
BTM_BLE_ADVERT_TYPE_NAME_COMPLETE = 0x09, /**< Complete name */
BTM_BLE_ADVERT_TYPE_TX_POWER = 0x0A, /**< TX Power level */
BTM_BLE_ADVERT_TYPE_DEV_CLASS = 0x0D, /**< Device Class */
BTM_BLE_ADVERT_TYPE_SM_TK = 0x10, /**< Security manager TK value */
BTM_BLE_ADVERT_TYPE_SM_OOB_FLAG = 0x11, /**< Security manager Out-of-Band data */
BTM_BLE_ADVERT_TYPE_INTERVAL_RANGE = 0x12, /**< Slave connection interval range */
BTM_BLE_ADVERT_TYPE_SOLICITATION_SRV_UUID = 0x14, /**< List of solicitated services - 16 bit UUIDs */
BTM_BLE_ADVERT_TYPE_128SOLICITATION_SRV_UUID = 0x15, /**< List of solicitated services - 128 bit UUIDs */
BTM_BLE_ADVERT_TYPE_SERVICE_DATA = 0x16, /**< Service data - 16 bit UUID */
BTM_BLE_ADVERT_TYPE_PUBLIC_TARGET = 0x17, /**< Public target address */
BTM_BLE_ADVERT_TYPE_RANDOM_TARGET = 0x18, /**< Random target address */
BTM_BLE_ADVERT_TYPE_APPEARANCE = 0x19, /**< Appearance */
BTM_BLE_ADVERT_TYPE_ADVERT_INTERVAL = 0x1a, /**< Advertising interval */
BTM_BLE_ADVERT_TYPE_32SOLICITATION_SRV_UUID = 0x1b, /**< List of solicitated services - 32 bit UUIDs */
BTM_BLE_ADVERT_TYPE_32SERVICE_DATA = 0x1c, /**< Service data - 32 bit UUID */
BTM_BLE_ADVERT_TYPE_128SERVICE_DATA = 0x1d, /**< Service data - 128 bit UUID */
BTM_BLE_ADVERT_TYPE_MANUFACTURER = 0xFF /**< Manufacturer data */
};
typedef uint8_t mico_bt_ble_advert_type_t; /**< BLE advertisement data type (see #mico_bt_ble_advert_type_e) */
/** security settings used with L2CAP LE COC */
enum mico_bt_ble_sec_flags_e
{
BTM_SEC_LE_LINK_ENCRYPTED = 0x01, /**< Link encrypted */
BTM_SEC_LE_LINK_PAIRED_WITHOUT_MITM = 0x02, /**< Paired without man-in-the-middle protection */
BTM_SEC_LE_LINK_PAIRED_WITH_MITM = 0x04 /**< Link with man-in-the-middle protection */
};
/** Slave preferred connection interval range */
typedef struct
{
uint16_t low; /**< Preferred low connection interval */
uint16_t hi; /**< Preferred high connection interval */
}mico_bt_ble_int_range_t;
/** Service tag supported in the device */
typedef struct
{
uint8_t num_service; /**< Number of services */
mico_bool_t list_cmpl; /**< Complete list or not */
uint16_t *p_uuid; /**< 16-bit UUID data */
}mico_bt_ble_service_t;
/** 32 bits Service supported in the device */
typedef struct
{
uint8_t num_service; /**< Number of services */
mico_bool_t list_cmpl; /**< Complete list or not */
uint32_t *p_uuid; /**< 32-bit UUID data */
}mico_bt_ble_32service_t;
/** 128 bits Service supported in the device */
typedef struct
{
mico_bool_t list_cmpl; /**< Complete list or not */
uint8_t uuid128[MAX_UUID_SIZE]; /**< 128-bit UUID data */
}mico_bt_ble_128service_t;
/** Manufacturer data supported in the device */
typedef struct
{
uint8_t len; /**< Length of manufacturer data */
uint8_t *p_val; /**< Manufacturer data */
}mico_bt_ble_manu_t;
/** Service data supported in the device */
typedef struct
{
mico_bt_uuid_t service_uuid; /**< Service UUID data */
uint8_t len; /**< Service UUID length */
uint8_t *p_val; /**< Service data value */
}mico_bt_ble_service_data_t;
/** Proprietary data element supported in the device */
typedef struct
{
uint8_t advert_type; /**< Advertisement type */
uint8_t len; /**< Advertisement length */
uint8_t *p_val; /**< Element data */
}mico_bt_ble_prop_elem_t;
/** Proprietary data elements structure supported in the device */
typedef struct
{
uint8_t num_elem; /**< Number of elements */
mico_bt_ble_prop_elem_t *p_elem; /**< Proprietary elements */
}mico_bt_ble_proprietary_t;
/** Advertising data */
typedef struct
{
mico_bt_ble_int_range_t int_range; /**< slave preferred connection interval range (BTM_BLE_ADVERT_BIT_INTERVAL_RANGE) */
mico_bt_ble_manu_t *p_manu; /**< manufacturer data (BTM_BLE_ADVERT_BIT_MANUFACTURER) */
mico_bt_ble_service_t *p_services; /**< list of supported services - 16 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE) */
mico_bt_ble_128service_t *p_services_128b; /**< list of supported services - 128 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE_128) */
mico_bt_ble_32service_t *p_service_32b; /**< list of supported services - 32 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE_32) */
mico_bt_ble_service_t *p_sol_services; /**< list of solicited services - 16 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE_SOLICITATION) */
mico_bt_ble_32service_t *p_sol_service_32b; /**< list of solicited services - 32 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE_32SOLICITATION) */
mico_bt_ble_128service_t *p_sol_service_128b; /**< list of solicited services - 128 bit UUIDs (BTM_BLE_ADVERT_BIT_SERVICE_128SOLICITATION) */
mico_bt_ble_proprietary_t *p_proprietary; /**< list of proprietary data elements (BTM_BLE_ADVERT_BIT_PROPRIETARY) */
mico_bt_ble_service_data_t *p_service_data; /**< service data (BTM_BLE_ADVERT_BIT_SERVICE_DATA) */
uint16_t appearance; /**< appearance (BTM_BLE_ADVERT_BIT_APPEARANCE) */
uint8_t flag; /**< flag (BTM_BLE_ADVERT_BIT_FLAGS) */
uint8_t tx_power; /**< transmit power (BTM_BLE_ADVERT_BIT_TX_POWER) */
}mico_bt_ble_advert_data_t;
/** Scan result event type */
enum mico_bt_dev_ble_evt_type_e {
BTM_BLE_EVT_CONNECTABLE_ADVERTISEMENT = 0x00, /**< Connectable advertisement */
BTM_BLE_EVT_CONNECTABLE_DIRECTED_ADVERTISEMENT = 0x01, /**< Connectable Directed advertisement */
BTM_BLE_EVT_SCANNABLE_ADVERTISEMENT = 0x02, /**< Scannable advertisement */
BTM_BLE_EVT_NON_CONNECTABLE_ADVERTISEMENT = 0x03, /**< Non connectable advertisement */
BTM_BLE_EVT_SCAN_RSP = 0x04 /**< Scan response */
};
typedef uint8_t mico_bt_dev_ble_evt_type_t; /**< Scan result event value (see #mico_bt_dev_ble_evt_type_e) */
/** Background connection type */
enum mico_bt_ble_conn_type_e
{
BTM_BLE_CONN_NONE, /**< No background connection */
BTM_BLE_CONN_AUTO, /**< Auto connection */
BTM_BLE_CONN_SELECTIVE /**< Selective connection */
};
typedef uint8_t mico_bt_ble_conn_type_t; /**< Connection type (see #mico_bt_ble_conn_type_e) */
/** LE inquiry result type */
typedef struct
{
mico_bt_device_address_t remote_bd_addr; /**< Device address */
uint8_t ble_addr_type; /**< LE Address type */
mico_bt_dev_ble_evt_type_t ble_evt_type; /**< Scan result event type */
int8_t rssi; /**< Set to #BTM_INQ_RES_IGNORE_RSSI, if not valid */
uint8_t flag;
uint8_t length;
} mico_bt_ble_scan_results_t;
/**
* Callback mico_bt_ble_selective_conn_cback_t
*
* Selective connection callback (registered with #mico_bt_ble_set_background_connection_type)
*
* @param remote_bda : remote device
* @param p_remote_name : remote device name
*
* @return
*/
typedef bool (mico_bt_ble_selective_conn_cback_t)(mico_bt_device_address_t remote_bda, uint8_t *p_remote_name, const uint8_t *p_data, uint8_t length);
/**
* Callback mico_bt_ble_scan_result_cback_t
*
* Scan result callback (from calling #mico_bt_ble_scan)
*
* @param p_scan_result : scan result data (NULL indicates end of scanning)
* @param p_adv_data : Advertisement data (parse using #mico_bt_ble_check_advertising_data)
*
* @return Nothing
*/
typedef void (mico_bt_ble_scan_result_cback_t) (mico_bt_ble_scan_results_t *p_scan_result, uint8_t *p_adv_data);
/******************************************************
* Function Declarations
*
******************************************************/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @addtogroup btm_ble_api_functions BLE (Bluetooth Low Energy)
* @ingroup micobt_DeviceManagement
*
* BLE (Bluetooth Low Energy) Functions.
*
* @{
*/
/**
*
* Function mico_bt_start_advertisements
*
* Start advertising.
*
* Use #mico_bt_ble_set_advertisement_data to configure advertising data
* prior to starting avertisements.
*
* The advert_mode parameter determines what advertising parameters and durations
* to use (as specified by the application configuration).
*
* @param[in] advert_mode : advertisement mode
* @param[in] directed_advertisement_bdaddr_type : BLE_ADDR_PUBLIC or BLE_ADDR_RANDOM (if using directed advertisement mode)
* @param[in] directed_advertisement_bdaddr_ptr : Directed advertisement address (NULL if not using directed advertisement)
*
* @return status
*
*/
mico_bt_result_t mico_bt_start_advertisements(mico_bt_ble_advert_mode_t advert_mode, mico_bt_ble_address_type_t directed_advertisement_bdaddr_type, mico_bt_device_address_ptr_t directed_advertisement_bdaddr_ptr);
/**
*
* Function mico_bt_ble_get_current_advert_mode
*
* Get current advertising mode
*
* @return Current advertising mode
*
*/
mico_bt_ble_advert_mode_t mico_bt_ble_get_current_advert_mode(void);
/**
*
* Function mico_bt_ble_set_advertisement_data
*
* Set advertisement data.
*
* @param[in] data_mask : mask of data types to include in the advertisement data
* @param[in] p_data : advertisement data
*
* @return void
*
*/
mico_bt_result_t mico_bt_ble_set_advertisement_data(mico_bt_ble_advert_mask_t data_mask,
mico_bt_ble_advert_data_t *p_data);
/**
*
* Function mico_bt_ble_set_scan_response_data
*
* Set scan response data
*
* @param[in] data_mask : mask of data types to include in the scan response data
* @param[in] p_data : scan response data
*
* @return status of the operation
*
*/
mico_bt_dev_status_t mico_bt_ble_set_scan_response_data(mico_bt_ble_advert_mask_t data_mask,
mico_bt_ble_advert_data_t *p_data);
/**
* Function mico_bt_ble_scan
*
* Start LE scanning
*
* The scan_type parameter determines what scanning parameters and durations
* to use (as specified by the application configuration).
*
* Scan results are notified using p_scan_result_cback
*
* @param[in] scan_type : BTM_BLE_SCAN_TYPE_NONE, BTM_BLE_SCAN_TYPE_HIGH_DUTY, BTM_BLE_SCAN_TYPE_LOW_DUTY
* @param[in] duplicate_filter_enable : TRUE or FALSE to enable or disable duplicate filtering
*
* @param[in] p_scan_result_cback : scan result callback
*
* @return mico_bt_result_t
*
* MICO_BT_PENDING if successfully initiated
* MICO_BT_BUSY if already in progress
* MICO_BT_ILLEGAL_VALUE if parameter(s) are out of range
* MICO_BT_NO_RESOURCES if could not allocate resources to start the command
* MICO_BT_WRONG_MODE if the device is not up.
*/
mico_bt_result_t mico_bt_ble_scan (mico_bt_ble_scan_type_t scan_type, mico_bool_t duplicate_filter_enable, mico_bt_ble_scan_result_cback_t *p_scan_result_cback);
/**
*
* Function mico_bt_ble_get_current_scan_state
*
* Get current scan state
*
* @return mico_bt_ble_scan_type_t
*
* BTM_BLE_SCAN_TYPE_NONE Not scanning
* BTM_BLE_SCAN_TYPE_HIGH_DUTY High duty cycle scan
* BTM_BLE_SCAN_TYPE_LOW_DUTY Low duty cycle scan
*/
mico_bt_ble_scan_type_t mico_bt_ble_get_current_scan_state(void);
/**
*
* Function mico_bt_ble_security_grant
*
* Grant or deny access. Used in response to an BTM_SECURITY_REQUEST_EVT event.
*
* @param[in] bd_addr : peer device bd address.
* @param[in] res : BTM_SUCCESS to grant access; BTM_REPEATED_ATTEMPTS otherwise
*
* @return None
*
*/
void mico_bt_ble_security_grant(mico_bt_device_address_t bd_addr, uint8_t res);
/**
*
* Function mico_bt_ble_data_signature
*
* Sign the data using AES128 CMAC algorith.
*
* @param[in] bd_addr: target device the data to be signed for.
* @param[in] p_text: signing data
* @param[in] len: length of the signing data
* @param[in] signature: output parameter where data signature is going to be stored
*
* @return TRUE if signing successful, otherwise FALSE.
*
*/
mico_bool_t mico_bt_ble_data_signature (mico_bt_device_address_t bd_addr, uint8_t *p_text, uint16_t len,
mico_dev_ble_signature_t signature);
/**
*
* Function mico_bt_ble_verify_signature
*
* Verify the data signature
*
* @param[in] bd_addr: target device the data to be signed for.
* @param[in] p_orig: original data before signature.
* @param[in] len: length of the signing data
* @param[in] counter: counter used when doing data signing
* @param[in] p_comp: signature to be compared against.
*
* @return TRUE if signature verified correctly; otherwise FALSE.
*
*/
mico_bool_t mico_bt_ble_verify_signature (mico_bt_device_address_t bd_addr, uint8_t *p_orig,
uint16_t len, uint32_t counter,
uint8_t *p_comp);
/**
*
* Function mico_bt_ble_set_background_connection_type
*
* Set BLE background connection procedure type.
*
* @param[in] conn_type: BTM_BLE_CONN_NONE, BTM_BLE_CONN_AUTO, or BTM_BLE_CONN_SELECTIVE
* @param[in] p_select_cback: callback for BTM_BLE_CONN_SELECTIVE
*
* @return TRUE if background connection set
*
*/
mico_bool_t mico_bt_ble_set_background_connection_type (mico_bt_ble_conn_type_t conn_type, mico_bt_ble_selective_conn_cback_t *p_select_cback);
/**
*
* Function mico_bt_ble_update_background_connection_device
*
* This function is called to add or remove a device into/from
* background connection procedure. The background connection
* procedure is decided by the background connection type, it can be
* auto connection, or selective connection.
*
* @param[in] add_remove: TRUE to add; FALSE to remove.
* @param[in] remote_bda: device address to add/remove.
*
* @return TRUE if successful
*
*/
mico_bool_t mico_bt_ble_update_background_connection_device(mico_bool_t add_remove, mico_bt_device_address_t remote_bda);
/**
*
* Function mico_bt_ble_get_background_connection_device_size
*
* Get a size of white list for the AUTO or SELECTIVE Connection Procedure.
*
* @param[out] size: white list size
*
* @return MICO_TRUE or MICO_FALSE
*/
mico_bool_t mico_bt_ble_get_background_connection_device_size(uint8_t *size);
/**
*
* Function mico_bt_ble_check_advertising_data
*
* Parse advertising data (returned from scan results callback #mico_bt_ble_scan_result_cback_t).
* Look for specified advertisement data type.
*
* @param[in] p_adv : pointer to advertisement data
* @param[in] type : advertisement data type to look for
* @param[out] p_length : length of advertisement data (if found)
*
* @return pointer to start of requested advertisement data (if found). NULL if requested data type not found.
*
*/
uint8_t *mico_bt_ble_check_advertising_data( uint8_t *p_adv, mico_bt_ble_advert_type_t type, uint8_t *p_length);
/**
*
* Function mico_bt_ble_enable_privacy
*
* This function is called to enable or disable the privacy in
* the local device.
*
* @param[in] enable: TRUE to enable it; FALSE to disable it.
*
* @return void
*
*/
void mico_bt_ble_enable_privacy (mico_bool_t enable);
/**
*
* Function mico_bt_ble_enable_mixed_privacy_mode
*
* This function is called to enabled Mixed mode if privacy 1.2
* is applicable in controller.
*
* @param[in] mixed_on: mixed mode to be used or not.
*
* @return void
*
*/
void mico_bt_ble_enable_mixed_privacy_mode(mico_bool_t mixed_on);
/**
*
* Function mico_bt_ble_get_security_state
*
* Get security mode 1 flags and encryption key size for LE peer.
*
* @param[in] bd_addr : peer address
* @param[out] p_le_sec_flags : security flags (see #mico_bt_ble_sec_flags_e)
* @param[out] p_le_key_size : encryption key size
*
* @return TRUE if successful
*
*/
mico_bool_t mico_bt_ble_get_security_state (mico_bt_device_address_t bd_addr, uint8_t *p_le_sec_flags, uint8_t *p_le_key_size);
/**
*
* Function mico_bt_ble_update_advertising_white_list
*
* Add or remove device from advertising white list
*
* @param[in] add: TRUE to add; FALSE to remove
* @param[in] remote_bda: remote device address.
*
* @return void
*
*/
mico_bool_t mico_bt_ble_update_advertising_white_list(mico_bool_t add, const mico_bt_device_address_t remote_bda);
/**
*
* Function mico_bt_ble_update_advertisement_filter_policy
*
* Update the filter policy of advertiser.
*
* @param[in] advertising_policy: advertising filter policy
*
* @return void
*/
mico_bool_t mico_bt_ble_update_advertisement_filter_policy(mico_bt_ble_advert_filter_policy_t advertising_policy);
/**
*
* Function mico_bt_ble_get_advertisement_white_list_size
*
* Get advertisement white list size.
*
* @param[out] size: white list size
*
* @return MICO_TRUE or MICO_FALSE
*/
mico_bool_t mico_bt_ble_get_advertisement_white_list_size(uint8_t *size);
/**
*
* Function mico_bt_ble_get_white_list_capability
*
* Get All white list size.
*
* @param[out] size: white list size
*
* @return MICO_TRUE or MICO_FALSE
*/
mico_bool_t mico_bt_ble_get_white_list_capability(uint8_t *size);
/**
*
* Function mico_bt_ble_clear_white_list
*
* Clear white list (Advertisement & background connection).
*
* @param none
*
* @return MICO_TRUE or MICO_FALSE
*/
mico_bool_t mico_bt_ble_clear_white_list(void);
/**@} btm_ble_api_functions */
#ifdef __cplusplus
}
#endif