S132 SoftDevice v5.0.0-1.alpha
Functions

Functions

uint32_t sd_ble_l2cap_cid_register (uint16_t cid)
 Register a CID with L2CAP. More...
 
uint32_t sd_ble_l2cap_cid_unregister (uint16_t cid)
 Unregister a CID with L2CAP. More...
 
uint32_t sd_ble_l2cap_tx (uint16_t conn_handle, ble_l2cap_header_t const *p_header, uint8_t const *p_data)
 Transmit an L2CAP packet. More...
 

Detailed Description

Function Documentation

uint32_t sd_ble_l2cap_cid_register ( uint16_t  cid)

Register a CID with L2CAP.

This registers a higher protocol layer with the L2CAP multiplexer, and is requried prior to all operations on the CID.

Relevant Message Sequence Charts
L2CAP API
Parameters
[in]cidL2CAP CID.
Return values
NRF_SUCCESSSuccessfully registered a CID with the L2CAP layer.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied, CID must be above BLE_L2CAP_CID_DYN_BASE.
BLE_ERROR_L2CAP_CID_IN_USEL2CAP CID already in use.
NRF_ERROR_NO_MEMNot enough memory to complete operation.
uint32_t sd_ble_l2cap_cid_unregister ( uint16_t  cid)

Unregister a CID with L2CAP.

This unregisters a previously registerd higher protocol layer with the L2CAP multiplexer.

Relevant Message Sequence Charts
L2CAP API
Parameters
[in]cidL2CAP CID.
Return values
NRF_SUCCESSSuccessfully unregistered the CID.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied.
NRF_ERROR_NOT_FOUNDCID not previously registered.
uint32_t sd_ble_l2cap_tx ( uint16_t  conn_handle,
ble_l2cap_header_t const *  p_header,
uint8_t const *  p_data 
)

Transmit an L2CAP packet.

Note
It is important to note that a call to this function will consume an application packet, and will therefore generate a BLE_EVT_TX_COMPLETE event when the packet has been transmitted. Please see the documentation of sd_ble_tx_packet_count_get for more details.
Events generated
BLE_EVT_TX_COMPLETE
BLE_L2CAP_EVT_RX
Relevant Message Sequence Charts
L2CAP API
Parameters
[in]conn_handleConnection Handle.
[in]p_headerPointer to a packet header containing length and CID.
[in]p_dataPointer to the data to be transmitted.
Return values
NRF_SUCCESSSuccessfully queued an L2CAP packet for transmission.
NRF_ERROR_INVALID_ADDRInvalid pointer supplied.
NRF_ERROR_INVALID_PARAMInvalid parameter(s) supplied, CIDs must be registered beforehand with sd_ble_l2cap_cid_register.
NRF_ERROR_NOT_FOUNDCID not found.
NRF_ERROR_NO_MEMNot enough memory to complete operation.
BLE_ERROR_NO_TX_PACKETSNot enough application packets available.
NRF_ERROR_DATA_SIZEInvalid data size(s) supplied, see BLE_L2CAP_MTU_DEF.

Documentation feedback | Developer Zone | Subscribe | Updated