Data Types

Data Types for Logical Link Control and Adaptation Layer Protocol (L2CAP). More...

Data Structures
struct	wiced_bt_l2cap_fcr_options_t
	Structure for Enhanced Retransmission Mode Options Refer to Volume 3, Part A, section 5.4 of Bluetooth Core specification for details. More...
struct	wiced_bt_l2cap_cfg_information_t
	Define a structure to hold the configuration parameters. More...
struct	wiced_bt_l2cap_ertm_information_t
	Structure that applications use to create or accept connections with enhanced retransmission mode. More...

Macros
#define	L2CAP_MINIMUM_OFFSET   13
	The minimum offset that L2CAP needs in a buffer. More...
#define	L2CAP_BLE_CONN_MIN_OFFSET   9
	HCI type(1), len(2), handle(2), L2CAP len(2) and CID(2)
#define	L2CAP_BROADCAST_MIN_OFFSET   11
	Minimum offset for broadcast needs another two bytes for the PSM.
#define	L2CAP_BLE_COC_SDU_OFFSET   4
	To provide upper layer minimal offset required to process incoming packets.
#define	L2CAP_DEFAULT_BLE_CB_POOL_ID   0xFF
	Use the default HCI ACL buffer pool.
#define	L2CAP_PING_RESULT_OK   0
	Ping reply received OK.
#define	L2CAP_PING_RESULT_NO_LINK   1
	Link could not be setup.
#define	L2CAP_PING_RESULT_NO_RESPONSE   2
	Remote L2CAP did not reply.
#define	L2CAP_DATAWRITE_FAILED   FALSE
	wiced_bt_l2cap_data_write() was failure
#define	L2CAP_DATAWRITE_SUCCESS   TRUE
	wiced_bt_l2cap_data_write() was successful
#define	L2CAP_DATAWRITE_CONGESTED   2
	wiced_bt_l2cap_data_write() was congested
#define	L2CAP_PRIORITY_NORMAL   0
	Values for priority parameter to wiced_bt_l2cap_set_acl_priority.
#define	L2CAP_PRIORITY_HIGH   1
	Values for priority parameter to wiced_bt_l2cap_set_acl_priority.
#define	L2CAP_DIRECTION_IGNORE   0
	Set ACL priority direction as ignore.
#define	L2CAP_DIRECTION_DATA_SOURCE   1
	Set ACL priority direction as source.
#define	L2CAP_DIRECTION_DATA_SINK   2
	Set ACL priority direction as sink.
#define	L2CAP_CHNL_PRIORITY_HIGH   0
	Values for priority parameter to wiced_bt_l2cap_set_tx_priority.
#define	L2CAP_CHNL_PRIORITY_MEDIUM   1
	Values for priority parameter to wiced_bt_l2cap_set_tx_priority.
#define	L2CAP_CHNL_PRIORITY_LOW   2
	Values for priority parameter to wiced_bt_l2cap_set_tx_priority.
#define	L2CAP_CHNL_DATA_RATE_HIGH   3
	Values for Tx/Rx data rate parameter to wiced_bt_l2cap_set_chnl_data_rate.
#define	L2CAP_CHNL_DATA_RATE_MEDIUM   2
	Values for Tx/Rx data rate parameter to wiced_bt_l2cap_set_chnl_data_rate.
#define	L2CAP_CHNL_DATA_RATE_LOW   1
	Values for Tx/Rx data rate parameter to wiced_bt_l2cap_set_chnl_data_rate.
#define	L2CAP_CHNL_DATA_RATE_NO_TRAFFIC   0
	Values for Tx/Rx data rate parameter to wiced_bt_l2cap_set_chnl_data_rate.
#define	L2CAP_FLUSHABLE_MASK   0x0003
	Data Packet Flags (bits 2-15 are reserved) layer specific 14-15 bits are used for FCR SAR. More...
#define	L2CAP_FLUSHABLE_CH_BASED   0x0000
#define	L2CAP_FLUSHABLE_PACKET   0x0001
#define	L2CAP_NON_FLUSHABLE_PACKET   0x0002
#define	L2CAP_FLUSH_CHANNELS_ALL   0xffff
	Used in wiced_bt_l2cap_flush_channel num_to_flush definitions.
#define	L2CAP_FLUSH_CHANNELS_GET   0x0000
#define	L2CAP_ROLE_PERIPHERAL   HCI_ROLE_PERIPHERAL
	Set this if the desired role of device is slave.
#define	L2CAP_ROLE_CENTRAL   HCI_ROLE_CENTRAL
	Set this if the desired role of device is master.
#define	L2CAP_ROLE_ALLOW_SWITCH   0x80
	Set this bit to allow switch at create conn.
#define	L2CAP_ROLE_DISALLOW_SWITCH   0x40
	Set this bit to disallow switch at create conn.
#define	L2CAP_ROLE_CHECK_SWITCH   0xC0
	Set this bit if you want to skip checking if role switch is allowed.
#define	L2CAP_FCR_CHAN_OPT_BASIC   (1 << L2CAP_FCR_BASIC_MODE)
	Values for 'allowed_modes' field passed in structure wiced_bt_l2cap_ertm_information_t.
#define	L2CAP_FCR_CHAN_OPT_ERTM   (1 << L2CAP_FCR_ERTM_MODE)
	Values for 'allowed_modes' field passed in structure wiced_bt_l2cap_ertm_information_t.
#define	L2CAP_FCR_CHAN_OPT_STREAM   (1 << L2CAP_FCR_STREAM_MODE)
	Values for 'allowed_modes' field passed in structure wiced_bt_l2cap_ertm_information_t.
#define	L2CAP_FCR_CHAN_OPT_ALL_MASK   (L2CAP_FCR_CHAN_OPT_BASIC | L2CAP_FCR_CHAN_OPT_ERTM | L2CAP_FCR_CHAN_OPT_STREAM)
	Validity check for PSM. More...
#define	L2C_INVALID_PSM(psm)   (((psm) & 0x0101) != 0x0001)
	Validity check for PSM. More...
#define	L2C_IS_VALID_PSM(psm)   (((psm) & 0x0101) == 0x0001)
#define	MINIMIUM_DYNAMIC_LE_PSM   0x0080
	Dynamic LE_PSM are in the range 0x0080 - 0x00FF.
#define	MAXIMUM_LE_PSM   0x00FF
	Dynamic LE_PSM are in the range 0x0080 - 0x00FF.
#define	L2C_BLE_INVALID_PSM(le_psm)   (!(le_psm) || (le_psm) > MAX_LE_PSM)
	Validity check for PSM.
#define	L2C_BLE_IS_VALID_PSM(le_psm)   (((le_psm) != 0) && ((le_psm) <= MAX_LE_PSM))
	Validity check for PSM.
#define	L2CAP_CH_CFG_MASK_MTU   0x0001
	L2CAP channel configured field bitmap.
#define	L2CAP_CH_CFG_MASK_QOS   0x0002
	L2CAP channel configured field bitmap.
#define	L2CAP_CH_CFG_MASK_FLUSH_TO   0x0004
	L2CAP channel configured field bitmap.
#define	L2CAP_CH_CFG_MASK_FCR   0x0008
	L2CAP channel configured field bitmap.
#define	L2CAP_CH_CFG_MASK_FCS   0x0010
	L2CAP channel configured field bitmap.
#define	L2CAP_CH_CFG_MASK_EXT_FLOW_SPEC   0x0020
	L2CAP channel configured field bitmap.

Typedefs
typedef uint8_t	wiced_bt_l2cap_chnl_priority_t
typedef uint8_t	wiced_bt_l2cap_chnl_data_rate_t
typedef uint16_t	wiced_bt_l2cap_ch_cfg_bits_t

Detailed Description

Data Types for Logical Link Control and Adaptation Layer Protocol (L2CAP).

Macro Definition Documentation

#define L2C_INVALID_PSM

(

psm

)

(((psm) & 0x0101) != 0x0001)

Validity check for PSM.

PSM values must be odd. Also, all PSM values must be assigned such that the least significant bit of the most significant octet equals zero.

#define L2CAP_FCR_CHAN_OPT_ALL_MASK   (L2CAP_FCR_CHAN_OPT_BASIC | L2CAP_FCR_CHAN_OPT_ERTM | L2CAP_FCR_CHAN_OPT_STREAM)

Validity check for PSM.

PSM values must be odd. Also, all PSM values must be assigned such that the least significant bit of the most significant octet equals zero.

#define L2CAP_FLUSHABLE_MASK   0x0003

Data Packet Flags (bits 2-15 are reserved) layer specific 14-15 bits are used for FCR SAR.

Used in call to wiced_bt_l2cap_data_write()

#define L2CAP_MINIMUM_OFFSET   13

The minimum offset that L2CAP needs in a buffer.

This is made up of HCI type(1), len(2), handle(2), L2CAP len(2) and CID(2) control(2), SDU length(2)