Bluetooth Host Stack Library
Data Structures | Typedefs | Enumerations | Functions
wiced_bt_cfg.h File Reference

Runtime Bluetooth configuration parameters. More...

Data Structures

struct  wiced_bt_cfg_ble_scan_settings_t
 LE Scan settings. More...
 
struct  wiced_bt_cfg_ble_advert_settings_t
 Advertising settings. More...
 
struct  wiced_bt_cfg_gatt_t
 GATT settings. More...
 
struct  wiced_bt_cfg_avdt_t
 Audio/Video Distribution configuration. More...
 
struct  wiced_bt_cfg_avrc_t
 Audio/Video Remote Control configuration. More...
 
struct  wiced_bt_cfg_rfcomm_t
 RFCOMM configuration. More...
 
struct  wiced_bt_cfg_isoc_t
 Isochronous Connection configuration settings. More...
 
struct  wiced_bt_cfg_br_t
 BR/EDR configuration settings. More...
 
struct  wiced_bt_cfg_ble_t
 LE configuration settings. More...
 
struct  wiced_bt_cfg_l2cap_application_t
 Settings for application managed L2CAP protocols (optional) More...
 
struct  wiced_bt_cfg_settings_t
 Bluetooth stack configuration. More...
 

Macros

Bluetooth Configuration Default Values

Bluetooth Configuration Default Values

Note
These are typical values for config parameters used for some common LE, BR/EDR use cases.
#define WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_INTERVAL   0x0800
 Inquiry scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_WINDOW   0x0012
 Inquiry scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_PAGE_SCAN_INTERVAL   0x0800
 Page scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_PAGE_SCAN_WINDOW   0x0012
 Page scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_INTERVAL   96
 High duty scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_WINDOW   48
 High duty scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_INTERVAL   2048
 Low duty scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_WINDOW   18
 Low duty scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_INTERVAL   96
 High duty cycle connection scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_WINDOW   48
 High duty cycle connection scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_INTERVAL   2048
 Low duty cycle connection scan interval (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_WINDOW   18
 Low duty cycle connection scan window (in slots (1 slot = 0.625 ms)) More...
 
#define WICED_BT_CFG_DEFAULT_CONN_MIN_INTERVAL   80
 Minimum connection event interval ( in 1.25 msec) More...
 
#define WICED_BT_CFG_DEFAULT_CONN_MAX_INTERVAL   80
 Maximum connection event interval ( in 1.25 msec) More...
 
#define WICED_BT_CFG_DEFAULT_CONN_LATENCY   0
 Connection latency (in number of LL connection events) More...
 
#define WICED_BT_CFG_DEFAULT_CONN_SUPERVISION_TIMEOUT   700
 Connection link supervision timeout (in 10 msec) More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MIN_INTERVAL   48
 Tgap(adv_fast_interval1) = 48 *0.625 = 30ms. More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MAX_INTERVAL   48
 Tgap(adv_fast_interval1) = 48 *0.625 = 30ms. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MIN_INTERVAL   2048
 Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MAX_INTERVAL   2048
 Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s. More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MIN_INTERVAL   160
 Tgap(adv_fast_interval2) = 160 * 0.625 = 100 ms. More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MAX_INTERVAL   160
 Tgap(adv_fast_interval2) = 160 * 0.625 = 100 ms. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MIN_INTERVAL   2048
 Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MAX_INTERVAL   2048
 Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s. More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MIN_INTERVAL   400
 Tgap(dir_conn_adv_int_max) = 400 * 0.625 = 250 ms. More...
 
#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MAX_INTERVAL   800
 Tgap(dir_conn_adv_int_min) = 800 * 0.625 = 500 ms. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MIN_INTERVAL   48
 Tgap(adv_fast_interval1) = 48 * 0.625 = 30 ms. More...
 
#define WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MAX_INTERVAL   48
 Tgap(adv_fast_interval1) = 48 * 0.625 = 30 ms. More...
 
#define WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_CHANGE_TIMEOUT   900
 default refreshment timing interval 900secs More...
 
#define WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_NEVER_CHANGE   0
 value for disabling random address refresh More...
 
#define WICED_BT_CFG_MAX_RANDOM_ADDRESS_CHANGE_TIMEOUT   3600
 max refreshment timing interval 3600secs More...
 

Typedefs

typedef uint8_t wiced_bt_ble_scan_mode_t
 scan mode (see wiced_bt_ble_scan_mode_e) More...
 
typedef uint8_t wiced_bt_sec_level_t
 Required security level. More...
 
typedef uint8_t wiced_bt_ble_advert_chnl_map_t
 LE advertisement channel map (see wiced_bt_ble_advert_chnl_map_e) More...
 
typedef uint16_t wiced_bt_gatt_appearance_t
 GATT appearance (see gatt_appearance_e in gattdefs.h) More...
 

Enumerations

enum  wiced_bt_ble_scan_mode_e {
  BTM_BLE_SCAN_MODE_PASSIVE = 0,
  BTM_BLE_SCAN_MODE_ACTIVE = 1,
  BTM_BLE_SCAN_MODE_NONE = 0xff
}
 Scan modes. More...
 
enum  wiced_bt_sec_level_e {
  BTM_SEC_BEST_EFFORT = 1,
  BTM_SEC_SC_REQUIRED = 2,
  BTM_SEC_AUTH_REQUIRED = 4,
  BTM_SEC_SC_AUTH_REQUIRED = (BTM_SEC_SC_REQUIRED | 4)
}
 Security Service Levels (bit fields) More...
 
enum  wiced_bt_ble_advert_chnl_map_e {
  BTM_BLE_ADVERT_CHNL_37 = (0x01 << 0),
  BTM_BLE_ADVERT_CHNL_38 = (0x01 << 1),
  BTM_BLE_ADVERT_CHNL_39 = (0x01 << 2)
}
 advertising channel map More...
 

Functions

int32_t wiced_bt_stack_get_dynamic_memory_size_for_config (const wiced_bt_cfg_settings_t *p_bt_cfg_settings)
 Returns the expected dynamic memory size required for the stack based on the p_bt_cfg_settings. More...
 

Detailed Description

Runtime Bluetooth configuration parameters.

Macro Definition Documentation

◆ WICED_BT_CFG_DEFAULT_CONN_LATENCY

#define WICED_BT_CFG_DEFAULT_CONN_LATENCY   0

Connection latency (in number of LL connection events)

◆ WICED_BT_CFG_DEFAULT_CONN_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_CONN_MAX_INTERVAL   80

Maximum connection event interval ( in 1.25 msec)

◆ WICED_BT_CFG_DEFAULT_CONN_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_CONN_MIN_INTERVAL   80

Minimum connection event interval ( in 1.25 msec)

◆ WICED_BT_CFG_DEFAULT_CONN_SUPERVISION_TIMEOUT

#define WICED_BT_CFG_DEFAULT_CONN_SUPERVISION_TIMEOUT   700

Connection link supervision timeout (in 10 msec)

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MAX_INTERVAL   48

Tgap(adv_fast_interval1) = 48 *0.625 = 30ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_ADV_MIN_INTERVAL   48

Tgap(adv_fast_interval1) = 48 *0.625 = 30ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_INTERVAL   96

High duty cycle connection scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_CONN_SCAN_WINDOW   48

High duty cycle connection scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MAX_INTERVAL   800

Tgap(dir_conn_adv_int_min) = 800 * 0.625 = 500 ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_DIRECTED_ADV_MIN_INTERVAL   400

Tgap(dir_conn_adv_int_max) = 400 * 0.625 = 250 ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MAX_INTERVAL   160

Tgap(adv_fast_interval2) = 160 * 0.625 = 100 ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_NONCONN_ADV_MIN_INTERVAL   160

Tgap(adv_fast_interval2) = 160 * 0.625 = 100 ms.

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_INTERVAL   96

High duty scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_HIGH_DUTY_SCAN_WINDOW   48

High duty scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_INTERVAL   0x0800

Inquiry scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_INQUIRY_SCAN_WINDOW   0x0012

Inquiry scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MAX_INTERVAL   2048

Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_ADV_MIN_INTERVAL   2048

Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_INTERVAL   2048

Low duty cycle connection scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_CONN_SCAN_WINDOW   18

Low duty cycle connection scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MAX_INTERVAL   48

Tgap(adv_fast_interval1) = 48 * 0.625 = 30 ms.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_DIRECTED_ADV_MIN_INTERVAL   48

Tgap(adv_fast_interval1) = 48 * 0.625 = 30 ms.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MAX_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MAX_INTERVAL   2048

Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MIN_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_NONCONN_ADV_MIN_INTERVAL   2048

Tgap(adv_slow_interval) = 2048 * 0.625 = 1.28s.

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_INTERVAL   2048

Low duty scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_LOW_DUTY_SCAN_WINDOW   18

Low duty scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_PAGE_SCAN_INTERVAL

#define WICED_BT_CFG_DEFAULT_PAGE_SCAN_INTERVAL   0x0800

Page scan interval (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_PAGE_SCAN_WINDOW

#define WICED_BT_CFG_DEFAULT_PAGE_SCAN_WINDOW   0x0012

Page scan window (in slots (1 slot = 0.625 ms))

◆ WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_CHANGE_TIMEOUT

#define WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_CHANGE_TIMEOUT   900

default refreshment timing interval 900secs

◆ WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_NEVER_CHANGE

#define WICED_BT_CFG_DEFAULT_RANDOM_ADDRESS_NEVER_CHANGE   0

value for disabling random address refresh

◆ WICED_BT_CFG_MAX_RANDOM_ADDRESS_CHANGE_TIMEOUT

#define WICED_BT_CFG_MAX_RANDOM_ADDRESS_CHANGE_TIMEOUT   3600

max refreshment timing interval 3600secs

Typedef Documentation

◆ wiced_bt_ble_advert_chnl_map_t

typedef uint8_t wiced_bt_ble_advert_chnl_map_t

LE advertisement channel map (see wiced_bt_ble_advert_chnl_map_e)

◆ wiced_bt_ble_scan_mode_t

typedef uint8_t wiced_bt_ble_scan_mode_t

scan mode (see wiced_bt_ble_scan_mode_e)

◆ wiced_bt_gatt_appearance_t

typedef uint16_t wiced_bt_gatt_appearance_t

GATT appearance (see gatt_appearance_e in gattdefs.h)

◆ wiced_bt_sec_level_t

typedef uint8_t wiced_bt_sec_level_t

Required security level.

Enumeration Type Documentation

◆ wiced_bt_ble_advert_chnl_map_e

enum wiced_bt_ble_advert_chnl_map_e

advertising channel map

Enumerator
BTM_BLE_ADVERT_CHNL_37 

ADV channel.

BTM_BLE_ADVERT_CHNL_38 

ADV channel.

BTM_BLE_ADVERT_CHNL_39 

ADV channel.

◆ wiced_bt_ble_scan_mode_e

enum wiced_bt_ble_scan_mode_e

Scan modes.

Enumerator
BTM_BLE_SCAN_MODE_PASSIVE 

Passive scan mode.

BTM_BLE_SCAN_MODE_ACTIVE 

Active scan mode.

BTM_BLE_SCAN_MODE_NONE 

None.

◆ wiced_bt_sec_level_e

enum wiced_bt_sec_level_e

Security Service Levels (bit fields)

Enumerator
BTM_SEC_BEST_EFFORT 

BTM_SEC_BEST_EFFORT : Recommended choice for most applications, to connect to the widest range of devices.

Allows stack to choose the highest level of security possible between the two devices

BTM_SEC_SC_REQUIRED 

BTM_SEC_SC_REQUIRED : Can be set by applications which need to enforce secure connections.

Note: If this bit is set, the stack will only allow connections to devices paired using Secure Connections

BTM_SEC_AUTH_REQUIRED 

BTM_SEC_AUTH_REQUIRED - Can be set by applications which need to enforce Authentication Note: If this bit is set, the stack will only allow connections to devices paired using authentication.

BTM_SEC_SC_AUTH_REQUIRED 

BTM_SEC_SC_AUTH_REQUIRED : Can be set by applications which need to enforce secure connections with MITM protection.

Note: If this bit is set, the stack will only allow connections to devices paired using Secure Connections with Man In The Middle (MITM) protection