Enumerated Types

Macros
#define	BTM_BLE_SCAN_MODES
	Scan modes.
#define	BTM_BLE_CONN_TYPES
	Background connection type.
#define	BTM_BLE_SEC_ACTION_TYPES
	LE encryption method.

Typedefs
typedef uint8_t	wiced_bt_ble_chnl_map_t [BTM_AFH_CHNL_MAP_SIZE]
	LE AFH Channel map.
typedef uint8_t	wiced_dev_ble_signature_t [BTM_BLE_AUTH_SIGNATURE_SIZE]
	Auth signature BTM_BLE_AUTH_SIGNATURE_SIZE.
typedef int8_t	wiced_bt_ble_adv_tx_power_t
	Transmit Power in dBm (MULTI_ADV_TX_POWER_MIN to MULTI_ADV_TX_POWER_MAX)
typedef uint8_t	wiced_bt_ble_advert_filter_policy_t
	wiced_bt_ble_advert_filter_policy_e
typedef uint8_t	wiced_bt_ble_advert_chnl_map_t
	wiced_bt_ble_advert_chnl_map_e
typedef uint8_t	wiced_bt_ble_advert_type_t
	wiced_bt_ble_advert_type_e
typedef uint8_t	wiced_bt_ble_multi_advert_type_t
	wiced_bt_ble_multi_advert_type_e
typedef uint8_t	wiced_bt_ble_multi_advert_filtering_policy_t
	wiced_bt_ble_multi_advert_filtering_policy_e
typedef uint8_t	wiced_bt_ble_privacy_mode_t
	wiced_bt_ble_privacy_mode_e
typedef uint8_t	wiced_bt_ble_host_phy_preferences_t
	wiced_bt_ble_host_phy_preferences_e
typedef uint16_t	wiced_bt_ble_coded_phy_preferences_t
	wiced_bt_ble_coded_phy_preferences_e
typedef uint8_t	wiced_bt_ble_scan_mode_t
	wiced_bt_ble_scan_mode_e
typedef uint8_t	wiced_bt_ble_scanner_filter_policy_t
	wiced_bt_ble_scanner_filter_policy_e
typedef uint8_t	wiced_bt_dev_ble_evt_type_t
	wiced_bt_dev_ble_evt_type_e
typedef uint8_t	wiced_bt_ble_conn_type_t
	wiced_bt_ble_conn_type_e
typedef uint8_t	wiced_bt_ble_sec_action_type_t

Enumerations
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_ADV_NOTIFICATION_READY, WICED_BT_ADV_NOTIFICATION_DONE }
enum	wiced_bt_ble_advert_chnl_map_e { BTM_BLE_ADVERT_CHNL_37 = 0x01, BTM_BLE_ADVERT_CHNL_38 = 0x02, BTM_BLE_ADVERT_CHNL_39 = 0x04 }
	Advertising channel map. 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_3D_INFO_DATA = 0x3D, BTM_BLE_ADVERT_TYPE_MANUFACTURER = 0xFF }
	Advertisement data types. More...
enum	wiced_bt_ble_multi_advert_start_e { MULTI_ADVERT_STOP = 0x00, MULTI_ADVERT_START = 0x01 }
	Multi-advertisement start/stop. More...
enum	wiced_bt_ble_multi_advert_type_e {   MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT = 0x00, MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT = 0x01, MULTI_ADVERT_DISCOVERABLE_EVENT = 0x02, MULTI_ADVERT_NONCONNECTABLE_EVENT = 0x03,   MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT = 0x04 }
	Multi-advertisement type. More...
enum	wiced_bt_ble_multi_advert_filtering_policy_e { MULTI_ADVERT_FILTER_POLICY_FILTER_ACCEPT_LIST_NOT_USED = 0x00, MULTI_ADVERT_FILTER_ACCEPT_LIST_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION = 0x01, MULTI_ADVERT_FILTER_ACCEPT_LIST_POLICY_ADV_ALLOW_UNKNOWN_SCANNING = 0x02, MULTI_ADVERT_FILTER_POLICY_FILTER_ACCEPT_LIST_USED_FOR_ALL = 0x03 }
	Multi-advertisement Filtering policy. More...
enum	wiced_bt_ble_privacy_mode_e { BTM_BLE_PRIVACY_MODE_NETWORK = 0x00, BTM_BLE_PRIVACY_MODE_DEVICE = 0x01 }
	Privacy mode introduced in 5.0. More...
enum	wiced_bt_ble_host_phy_preferences_e { BTM_BLE_PREFER_1M_PHY = 0x01, BTM_BLE_PREFER_2M_PHY = 0x02, BTM_BLE_PREFER_LELR_PHY = 0x04 }
	PHY Settings (bits 3-7 reserved) More...
enum	wiced_bt_ble_lelr_phy_preferences_e { BTM_BLE_PREFER_CODED_PHY_NONE = 0x00, BTM_BLE_PREFER_CODED_125K = 0x01, BTM_BLE_PREFER_CODED_512K = 0x02 }
	Coded PHY Sub-setting (bits 2-15 reserved) More...
enum	wiced_bt_ble_scan_mode_e { BTM_BLE_SCAN_MODE_PASSIVE = 0x00, BTM_BLE_SCAN_MODE_ACTIVE = 0x01, BTM_BLE_SCAN_MODE_NONE = 0xff }
enum	wiced_bt_ble_scanner_filter_policy_e {   BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP = 0x00, BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP = 0x01, BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP = 0x02, BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP = 0x03,   BTM_BLE_SCAN_POLICY_MAX }
	Filter Accept List filter policy. More...
enum	wiced_bt_dev_ble_evt_type_e {   BTM_BLE_EVT_CONNECTABLE_ADVERTISEMENT = 0x00, BTM_BLE_EVT_CONNECTABLE_DIRECTED_ADVERTISEMENT = 0x01, BTM_BLE_EVT_SCANNABLE_ADVERTISEMENT = 0x02, BTM_BLE_EVT_NON_CONNECTABLE_ADVERTISEMENT = 0x03,   BTM_BLE_EVT_SCAN_RSP = 0x04 }
	Scan result event type. More...
enum	wiced_bt_ble_conn_type_e { BTM_BLE_CONN_NONE = 0x00, BTM_BLE_CONN_AUTO = 0x01, BTM_BLE_CONN_SELECTIVE = 0x02 }
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...
enum	{ BTM_BLE_SEC_NONE = 0x00, BTM_BLE_SEC_ENCRYPT = 0x01, BTM_BLE_SEC_ENCRYPT_NO_MITM = 0x02, BTM_BLE_SEC_ENCRYPT_MITM = 0x03 }

Detailed Description

Enumeration Type Documentation

anonymous enum

Enumerator
WICED_BT_ADV_NOTIFICATION_READY	Ready to send out an adv in the next few mS. App can change ADV data if required. Typically invoked about 2.5mS before te ADV. If there are other higher priority tasks or other events in the app thread event queue, this will be delayed. Notification is best effort.
WICED_BT_ADV_NOTIFICATION_DONE	Just completed transmitting an ADV packet.

anonymous enum

Enumerator
BTM_BLE_SEC_NONE	No encryption.
BTM_BLE_SEC_ENCRYPT	encrypt the link using current key
BTM_BLE_SEC_ENCRYPT_NO_MITM	encryption without MITM
BTM_BLE_SEC_ENCRYPT_MITM	encryption with MITM

enum wiced_bt_ble_advert_chnl_map_e

Advertising channel map.

Enumerator
BTM_BLE_ADVERT_CHNL_37	Channel 37.
BTM_BLE_ADVERT_CHNL_38	Channel 38.
BTM_BLE_ADVERT_CHNL_39	Channel 39.

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.

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_3D_INFO_DATA	3D Information Data
BTM_BLE_ADVERT_TYPE_MANUFACTURER	Manufacturer data.

enum wiced_bt_ble_conn_type_e

Enumerator
BTM_BLE_CONN_NONE	No background connection.
BTM_BLE_CONN_AUTO	Auto connection.
BTM_BLE_CONN_SELECTIVE	Selective connection.

enum wiced_bt_ble_host_phy_preferences_e

PHY Settings (bits 3-7 reserved)

Enumerator
BTM_BLE_PREFER_1M_PHY	Baseline PHY used by all LE devices.
BTM_BLE_PREFER_2M_PHY	2M PHY optional in 5.0
BTM_BLE_PREFER_LELR_PHY	Coded PHY optional in 5.0.

enum wiced_bt_ble_lelr_phy_preferences_e

Coded PHY Sub-setting (bits 2-15 reserved)

Enumerator
BTM_BLE_PREFER_CODED_PHY_NONE	Coded PHY not used.
BTM_BLE_PREFER_CODED_125K	S8 coding, 128K rate.
BTM_BLE_PREFER_CODED_512K	S2 Coding, 512K rate.

enum wiced_bt_ble_multi_advert_filtering_policy_e

Multi-advertisement Filtering policy.

Enumerator
MULTI_ADVERT_FILTER_POLICY_FILTER_ACCEPT_LIST_NOT_USED	Filter Accept List not used.
MULTI_ADVERT_FILTER_ACCEPT_LIST_POLICY_ADV_ALLOW_UNKNOWN_CONNECTION	Filter Accept List for scan request.
MULTI_ADVERT_FILTER_ACCEPT_LIST_POLICY_ADV_ALLOW_UNKNOWN_SCANNING	Filter Accept List for connection request.

enum wiced_bt_ble_multi_advert_start_e

Multi-advertisement start/stop.

Enumerator
MULTI_ADVERT_STOP	Stop Multi-advertisement.
MULTI_ADVERT_START	Start Multi-advertisement.

enum wiced_bt_ble_multi_advert_type_e

Multi-advertisement type.

Enumerator
MULTI_ADVERT_CONNECTABLE_UNDIRECT_EVENT	Connectable undirected.
MULTI_ADVERT_CONNECTABLE_DIRECT_EVENT	Connectable directed.
MULTI_ADVERT_DISCOVERABLE_EVENT	Discoverable.
MULTI_ADVERT_NONCONNECTABLE_EVENT	Non-connectable.
MULTI_ADVERT_LOW_DUTY_CYCLE_DIRECT_EVENT	Low-duty directed.

enum wiced_bt_ble_privacy_mode_e

Privacy mode introduced in 5.0.

Enumerator
BTM_BLE_PRIVACY_MODE_NETWORK	network privacy mode
BTM_BLE_PRIVACY_MODE_DEVICE	device privacy mode

enum wiced_bt_ble_scan_mode_e

Enumerator
BTM_BLE_SCAN_MODE_PASSIVE	Passive does not send scan request.
BTM_BLE_SCAN_MODE_ACTIVE	Active sends scan request to advertiser.
BTM_BLE_SCAN_MODE_NONE	Disable scans.

enum wiced_bt_ble_scanner_filter_policy_e

Filter Accept List filter policy.

Enumerator
BTM_BLE_SCAN_POLICY_ACCEPT_ADV_RSP	Filter Accept List OFF (directed ADV to mismatched BD_ADDR ignored)
BTM_BLE_SCAN_POLICY_FILTER_ADV_RSP	Whtelist ON (directed ADV to mismatched BD_ADDR ignored)
BTM_BLE_SCAN_POLICY_ACCEPT_RPA_DIR_ADV_RSP	Filter Accept List OFF (accepts directed ADV to mismatched BD_ADDR address if RPA)
BTM_BLE_SCAN_POLICY_FILTER_RPA_DIR_ADV_RSP	Filter Accept List ON (accepts directed ADV to mismatched BD_ADDR address if RPA)

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.

enum wiced_bt_dev_ble_evt_type_e

Scan result event type.

Enumerator
BTM_BLE_EVT_CONNECTABLE_ADVERTISEMENT	Connectable advertisement.
BTM_BLE_EVT_CONNECTABLE_DIRECTED_ADVERTISEMENT	Connectable Directed advertisement.
BTM_BLE_EVT_SCANNABLE_ADVERTISEMENT	Scannable advertisement.
BTM_BLE_EVT_NON_CONNECTABLE_ADVERTISEMENT	Non connectable advertisement.
BTM_BLE_EVT_SCAN_RSP	Scan response.