Macros

Macros
#define	BTM_BLE_LEGACY_AD_DATA_LEN   31
	Max legacy advertisement data len.
#define	BTM_AFH_CHNL_MAP_SIZE   HCI_AFH_CHANNEL_MAP_LEN
	AFH channel map size.
#define	BLE_CHANNEL_MAP_LEN   5
	AFH Channel Map len.
#define	BTM_BLE_DEFAULT_ADVERT_CHNL_MAP   (BTM_BLE_ADVERT_CHNL_37| BTM_BLE_ADVERT_CHNL_38| BTM_BLE_ADVERT_CHNL_39)
	default advertising channel map
#define	BTM_BLE_ADVERT_FILTER_DEFAULT   BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN
	default advertising filter policy
#define	BTM_BLE_ADVERT_INTERVAL_MIN   0x0020
	adv parameter Min value
#define	BTM_BLE_ADVERT_INTERVAL_MAX   0x4000
	adv parameter Max value
#define	BTM_BLE_SCAN_INTERVAL_MIN   0x0004
	Scan interval minimum value.
#define	BTM_BLE_SCAN_INTERVAL_MAX   0x4000
	Scan interval miximum value.
#define	BTM_BLE_SCAN_WINDOW_MIN   0x0004
	Scan window minimum value.
#define	BTM_BLE_SCAN_WINDOW_MAX   0x4000
	Scan window maximum value.
#define	BTM_BLE_CONN_INTERVAL_MIN   0x0006
	Connection interval minimum value.
#define	BTM_BLE_CONN_INTERVAL_MAX   0x0C80
	Connection interval maximum value.
#define	BTM_BLE_CONN_LATENCY_MAX   500
	Maximum Connection Latency.
#define	BTM_BLE_CONN_SUP_TOUT_MIN   0x000A
	Minimum Supervision Timeout.
#define	BTM_BLE_CONN_SUP_TOUT_MAX   0x0C80
	Maximum Supervision Timeout.
#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 Supervision Timeout.
#define	BTM_BLE_SCAN_FAST_INTERVAL   96
	default scan interval 30 ~ 60 ms (use 60) = 96 *0.625
#define	BTM_BLE_SCAN_FAST_WINDOW   48
	default scan window (in .625ms slots) for background auto connections 30 ms = 48 *0.625
#define	BTM_BLE_SCAN_SLOW_INTERVAL_1   2048
	default scan interval used in reduced power cycle (background scanning) 1.28 s = 2048 *0.625
#define	BTM_BLE_SCAN_SLOW_WINDOW_1   18
	default scan window used in reduced power cycle (background scanning) 11.25 ms = 18 *0.625
#define	BTM_BLE_SCAN_SLOW_INTERVAL_2   4096
	default scan interval used in reduced power cycle (background scanning) 2.56 s = 4096 *0.625
#define	BTM_BLE_SCAN_SLOW_WINDOW_2   36
	default scan window used in reduced power cycle (background scanning) 22.5 ms = 36 *0.625
#define	BTM_BLE_CONN_INTERVAL_MIN_DEF   24
	default connection interval min recommended min: 30ms = 24 * 1.25
#define	BTM_BLE_CONN_INTERVAL_MAX_DEF   40
	default connection interval max recommended max: 50 ms = 56 * 1.25
#define	BTM_BLE_CONN_PERIPHERAL_LATENCY_DEF   0
	default Peripheral latency
#define	BTM_BLE_CONN_TIMEOUT_DEF   2000
	default supervision timeout
#define	BTM_BLE_AUTH_SIGNATURE_SIZE   12
	LE Signature LE data signature length 8 Bytes + 4 bytes counter.
#define	BTM_BLE_POLICY_REJECT_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_ALLOW_ALL   0x03
	relevant to both
#define	BTM_BLE_LIMITED_DISCOVERABLE_FLAG   (0x01 << 0)
	Limited Discoverable.
#define	BTM_BLE_GENERAL_DISCOVERABLE_FLAG   (0x01 << 1)
	General Discoverable.
#define	BTM_BLE_BREDR_NOT_SUPPORTED   (0x01 << 2)
	BR/EDR Not Supported.
#define	BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_CONTROLLER_SUPPORTED   (0x01 << 3)
	Simultaneous LE and BR/EDR to Same Device Capable (Controller). More...
#define	BTM_BLE_SIMULTANEOUS_DUAL_MODE_TO_SAME_DEVICE_HOST_SUPPORTED   (0x01 << 4)
	Simultaneous LE and BR/EDR to Same Device Capable (Host). More...
#define	BTM_BLE_NON_LIMITED_DISCOVERABLE_FLAG   (0x00 )
	Non Discoverable.
#define	BTM_BLE_ADVERT_FLAG_MASK   (BTM_BLE_LIMITED_DISCOVERABLE_FLAG | BTM_BLE_BREDR_NOT_SUPPORTED | BTM_BLE_GENERAL_DISCOVERABLE_FLAG)
	LE adverisement mask.
#define	BTM_BLE_LIMITED_DISCOVERABLE_MASK   (BTM_BLE_LIMITED_DISCOVERABLE_FLAG )
	LE Limited discovery mask.
#define	BTM_BLE_PREFER_1M_PHY   0x01
	LE 1M PHY preference.
#define	BTM_BLE_PREFER_2M_PHY   0x02
	LE 2M PHY preference.
#define	BTM_BLE_PREFER_LELR_PHY   0x04
	LE LELR PHY preference.
#define	BTM_BLE_PREFER_NO_LELR   0x0000
	No preferred coding.
#define	BTM_BLE_PREFER_LELR_125K   0x0001
	Preferred coding is S=2.
#define	BTM_BLE_PREFER_LELR_512K   0x0002
	Preferred coding is S=8.
#define	MULTI_ADV_TX_POWER_MIN_INDEX   0
	Multi adv tx min power index.
#define	MULTI_ADV_TX_POWER_MAX_INDEX   4
	Multi adv tx max power index.
#define	IS_CONNECTABLE_ADV_REPORT(x)   (x & (1 << 0))
	adv is connectable
#define	IS_SCANNABLE_ADV_REPORT(x)   (x & (1 << 1))
	adv is scannable
#define	IS_DIRECTED_ADV_REPORT(x)   (x & (1 << 2))
	directed adv
#define	IS_SCAN_RSP_ADV_REPORT(x)   (x & (1 << 3))
	scan response
#define	IS_LEGACY_ADV_REPORT(x)   (x & (1 << 4))
	legacy adv
#define	IS_ADV_REPORT_DATA_STATUS_INCOMPLETE(x)   (x & (1 << 5))
	adv data incomplete, more data to come
#define	IS_ADV_REPORT_DATA_STATUS_TRUNCATED(x)   (x & (2 << 5))
	Incomplete, data truncated, no more to come.

Typedefs
typedef uint8_t	wiced_bt_ble_chnl_map_t [BLE_CHANNEL_MAP_LEN]
	LE Channel Map.
typedef uint8_t	wiced_bt_ble_scanner_filter_policy_t
	LE Scanner filter policy. More...
typedef uint8_t	wiced_bt_ble_advert_filter_policy_t
	Advertising filter policy (see wiced_bt_ble_advert_filter_policy_e)
typedef uint8_t	wiced_dev_ble_signature_t [BTM_BLE_AUTH_SIGNATURE_SIZE]
	Device address (see BTM_BLE_AUTH_SIGNATURE_SIZE)
typedef uint8_t	wiced_bt_ble_advert_type_t
	LE advertisement data type (see wiced_bt_ble_advert_type_e)

Enumerations
enum	wiced_bt_ble_scanner_filter_policy_e {   BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP, BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP, BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP, BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP,   BTM_BLE_SCAN_POLICY_MAX }
	Scanner filter policy. More...
enum	wiced_bt_ble_advert_filter_policy_e {   BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN = 0x00, BTM_BLE_ADV_POLICY_ACCEPT_CONN_FILTER_SCAN = 0x01, BTM_BLE_ADV_POLICY_FILTER_CONN_ACCEPT_SCAN = 0x02, BTM_BLE_ADV_POLICY_FILTER_CONN_FILTER_SCAN = 0x03,   BTM_BLE_ADV_POLICY_MAX }
	Advertising filter policy. More...
enum	wiced_bt_ble_advert_type_e {   BTM_BLE_ADVERT_TYPE_FLAG = 0x01, BTM_BLE_ADVERT_TYPE_16SRV_PARTIAL = 0x02, BTM_BLE_ADVERT_TYPE_16SRV_COMPLETE = 0x03, BTM_BLE_ADVERT_TYPE_32SRV_PARTIAL = 0x04,   BTM_BLE_ADVERT_TYPE_32SRV_COMPLETE = 0x05, BTM_BLE_ADVERT_TYPE_128SRV_PARTIAL = 0x06, BTM_BLE_ADVERT_TYPE_128SRV_COMPLETE = 0x07, BTM_BLE_ADVERT_TYPE_NAME_SHORT = 0x08,   BTM_BLE_ADVERT_TYPE_NAME_COMPLETE = 0x09, BTM_BLE_ADVERT_TYPE_TX_POWER = 0x0A, BTM_BLE_ADVERT_TYPE_DEV_CLASS = 0x0D, BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_HASH_C = 0x0E,   BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_RAND_C = 0x0F, BTM_BLE_ADVERT_TYPE_SM_TK = 0x10, BTM_BLE_ADVERT_TYPE_SM_OOB_FLAG = 0x11, BTM_BLE_ADVERT_TYPE_INTERVAL_RANGE = 0x12,   BTM_BLE_ADVERT_TYPE_SOLICITATION_SRV_UUID = 0x14, BTM_BLE_ADVERT_TYPE_128SOLICITATION_SRV_UUID = 0x15, BTM_BLE_ADVERT_TYPE_SERVICE_DATA = 0x16, BTM_BLE_ADVERT_TYPE_PUBLIC_TARGET = 0x17,   BTM_BLE_ADVERT_TYPE_RANDOM_TARGET = 0x18, BTM_BLE_ADVERT_TYPE_APPEARANCE = 0x19, BTM_BLE_ADVERT_TYPE_ADVERT_INTERVAL = 0x1a, BTM_BLE_ADVERT_TYPE_LE_BD_ADDR = 0x1b,   BTM_BLE_ADVERT_TYPE_LE_ROLE = 0x1c, BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_HASH = 0x1d, BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_RAND = 0x1e, BTM_BLE_ADVERT_TYPE_32SOLICITATION_SRV_UUID = 0x1f,   BTM_BLE_ADVERT_TYPE_32SERVICE_DATA = 0x20, BTM_BLE_ADVERT_TYPE_128SERVICE_DATA = 0x21, BTM_BLE_ADVERT_TYPE_CONN_CONFIRM_VAL = 0x22, BTM_BLE_ADVERT_TYPE_CONN_RAND_VAL = 0x23,   BTM_BLE_ADVERT_TYPE_URI = 0x24, BTM_BLE_ADVERT_TYPE_INDOOR_POS = 0x25, BTM_BLE_ADVERT_TYPE_TRANS_DISCOVER_DATA = 0x26, BTM_BLE_ADVERT_TYPE_SUPPORTED_FEATURES = 0x27,   BTM_BLE_ADVERT_TYPE_UPDATE_CH_MAP_IND = 0x28, BTM_BLE_ADVERT_TYPE_PB_ADV = 0x29, BTM_BLE_ADVERT_TYPE_MESH_MSG = 0x2A, BTM_BLE_ADVERT_TYPE_MESH_BEACON = 0x2B,   BTM_BLE_ADVERT_TYPE_PSRI = 0x2E, BTM_BLE_ADVERT_TYPE_3D_INFO_DATA = 0x3D, BTM_BLE_ADVERT_TYPE_MANUFACTURER = 0xFF }
	Advertisement data types. More...
enum	wiced_bt_ble_sec_flags_e { BTM_SEC_LE_LINK_ENCRYPTED = 0x01, BTM_SEC_LE_LINK_PAIRED_WITHOUT_MITM = 0x02, BTM_SEC_LE_LINK_PAIRED_WITH_MITM = 0x04 }
	security settings used with L2CAP LE COC More...

Detailed Description

Macro Definition Documentation

#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).

Typedef Documentation

typedef uint8_t wiced_bt_ble_scanner_filter_policy_t

LE Scanner filter policy.

Scanner filter policy (see wiced_bt_ble_scanner_filter_policy_e)

Enumeration Type Documentation

enum wiced_bt_ble_advert_filter_policy_e

Advertising filter policy.

Enumerator
BTM_BLE_ADV_POLICY_ACCEPT_CONN_AND_SCAN	Process scan and connection requests from all devices (i.e., the Filter Accept List is not in use) (default)
BTM_BLE_ADV_POLICY_ACCEPT_CONN_FILTER_SCAN	Process connection requests from all devices and only scan requests from devices that are in the Filter Accept List.
BTM_BLE_ADV_POLICY_FILTER_CONN_ACCEPT_SCAN	Process scan requests from all devices and only connection requests from devices that are in the Filter Accept List.
BTM_BLE_ADV_POLICY_FILTER_CONN_FILTER_SCAN	Process scan and connection requests only from devices in the Filter Accept List.
BTM_BLE_ADV_POLICY_MAX	Max Adv filter value.

enum wiced_bt_ble_advert_type_e

Advertisement data types.

Enumerator
BTM_BLE_ADVERT_TYPE_FLAG	Advertisement flags.
BTM_BLE_ADVERT_TYPE_16SRV_PARTIAL	List of supported services - 16 bit UUIDs (partial)
BTM_BLE_ADVERT_TYPE_16SRV_COMPLETE	List of supported services - 16 bit UUIDs (complete)
BTM_BLE_ADVERT_TYPE_32SRV_PARTIAL	List of supported services - 32 bit UUIDs (partial)
BTM_BLE_ADVERT_TYPE_32SRV_COMPLETE	List of supported services - 32 bit UUIDs (complete)
BTM_BLE_ADVERT_TYPE_128SRV_PARTIAL	List of supported services - 128 bit UUIDs (partial)
BTM_BLE_ADVERT_TYPE_128SRV_COMPLETE	List of supported services - 128 bit UUIDs (complete)
BTM_BLE_ADVERT_TYPE_NAME_SHORT	Short name.
BTM_BLE_ADVERT_TYPE_NAME_COMPLETE	Complete name.
BTM_BLE_ADVERT_TYPE_TX_POWER	TX Power level.
BTM_BLE_ADVERT_TYPE_DEV_CLASS	Device Class.
BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_HASH_C	Simple Pairing Hash C.
BTM_BLE_ADVERT_TYPE_SIMPLE_PAIRING_RAND_C	Simple Pairing Randomizer R.
BTM_BLE_ADVERT_TYPE_SM_TK	Security manager TK value.
BTM_BLE_ADVERT_TYPE_SM_OOB_FLAG	Security manager Out-of-Band data.
BTM_BLE_ADVERT_TYPE_INTERVAL_RANGE	Peripheral connection interval range.
BTM_BLE_ADVERT_TYPE_SOLICITATION_SRV_UUID	List of solicitated services - 16 bit UUIDs.
BTM_BLE_ADVERT_TYPE_128SOLICITATION_SRV_UUID	List of solicitated services - 128 bit UUIDs.
BTM_BLE_ADVERT_TYPE_SERVICE_DATA	Service data - 16 bit UUID.
BTM_BLE_ADVERT_TYPE_PUBLIC_TARGET	Public target address.
BTM_BLE_ADVERT_TYPE_RANDOM_TARGET	Random target address.
BTM_BLE_ADVERT_TYPE_APPEARANCE	Appearance.
BTM_BLE_ADVERT_TYPE_ADVERT_INTERVAL	Advertising interval.
BTM_BLE_ADVERT_TYPE_LE_BD_ADDR	LE device bluetooth address.
BTM_BLE_ADVERT_TYPE_LE_ROLE	LE role.
BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_HASH	Simple Pairing Hash C-256.
BTM_BLE_ADVERT_TYPE_256SIMPLE_PAIRING_RAND	Simple Pairing Randomizer R-256.
BTM_BLE_ADVERT_TYPE_32SOLICITATION_SRV_UUID	List of solicitated services - 32 bit UUIDs.
BTM_BLE_ADVERT_TYPE_32SERVICE_DATA	Service data - 32 bit UUID.
BTM_BLE_ADVERT_TYPE_128SERVICE_DATA	Service data - 128 bit UUID.
BTM_BLE_ADVERT_TYPE_CONN_CONFIRM_VAL	LE Secure Connections Confirmation Value.
BTM_BLE_ADVERT_TYPE_CONN_RAND_VAL	LE Secure Connections Random Value.
BTM_BLE_ADVERT_TYPE_URI	URI.
BTM_BLE_ADVERT_TYPE_INDOOR_POS	Indoor Positioning.
BTM_BLE_ADVERT_TYPE_TRANS_DISCOVER_DATA	Transport Discovery Data.
BTM_BLE_ADVERT_TYPE_SUPPORTED_FEATURES	LE Supported Features.
BTM_BLE_ADVERT_TYPE_UPDATE_CH_MAP_IND	Channel Map Update Indication.
BTM_BLE_ADVERT_TYPE_PB_ADV	PB-ADV.
BTM_BLE_ADVERT_TYPE_MESH_MSG	Mesh Message.
BTM_BLE_ADVERT_TYPE_MESH_BEACON	Mesh Beacon.
BTM_BLE_ADVERT_TYPE_PSRI	Generic Audio Provate Set Random Identifier.
BTM_BLE_ADVERT_TYPE_3D_INFO_DATA	3D Information Data
BTM_BLE_ADVERT_TYPE_MANUFACTURER	Manufacturer data.

enum wiced_bt_ble_scanner_filter_policy_e

Scanner filter policy.

Enumerator
BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP	accept adv packet from all, directed adv pkt not directed to local device is ignored
BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP	accept adv packet from device in filter Accept List, directed adv packet not directed to local device is ignored
BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP	accept adv packet from all, directed adv pkt not directed to local device is ignored except direct adv with RPA
BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP	accept adv packet from device in filter Accept List, directed adv pkt not directed to me is ignored except direct adv with RPA
BTM_BLE_SCAN_POLICY_MAX	Max Scan filter policy value.

enum wiced_bt_ble_sec_flags_e

security settings used with L2CAP LE COC

Enumerator
BTM_SEC_LE_LINK_ENCRYPTED	Link encrypted.
BTM_SEC_LE_LINK_PAIRED_WITHOUT_MITM	Paired without man-in-the-middle protection.
BTM_SEC_LE_LINK_PAIRED_WITH_MITM	Link with man-in-the-middle protection.