Stuart Northfield / mbed-src

mbed library sources

Fork of mbed-src by mbed official

targets/hal/TARGET_NORDIC/TARGET_MCU_NRF51822/Lib/s110_nrf51822_7_1_0/s110_nrf51822_7.1.0_API/include/ble_l2cap.h@357:d73ca02bc818, 2014-10-17 (annotated)

Committer:
mbed_official
Date:
Fri Oct 17 14:15:08 2014 +0100
Revision:
357:d73ca02bc818
Parent:
targets/hal/TARGET_NORDIC/TARGET_MCU_NRF51822/Lib/s110_nrf51822_7_0_0/s110_nrf51822_7.0.0_API/include/ble_l2cap.h@277:0dffe5d9e928 
Synchronized with git revision 74cc430faad92b2df0cd91d78a074ec315ad7533



Full URL: https://github.com/mbedmicro/mbed/commit/74cc430faad92b2df0cd91d78a074ec315ad7533/



updating to v7.1.0 of the Nordic soft-device.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 277:0dffe5d9e928 1 /* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved.
mbed_official 277:0dffe5d9e928 2 *
mbed_official 277:0dffe5d9e928 3 * The information contained herein is confidential property of Nordic Semiconductor. The use,
mbed_official 277:0dffe5d9e928 4 * copying, transfer or disclosure of such information is prohibited except by express written
mbed_official 277:0dffe5d9e928 5 * agreement with Nordic Semiconductor.
mbed_official 277:0dffe5d9e928 6 *
mbed_official 277:0dffe5d9e928 7 */
mbed_official 277:0dffe5d9e928 8 /**
mbed_official 277:0dffe5d9e928 9 @addtogroup BLE_L2CAP Logical Link Control and Adaptation Protocol (L2CAP)
mbed_official 277:0dffe5d9e928 10 @{
mbed_official 277:0dffe5d9e928 11 @brief Definitions and prototypes for the L2CAP interface.
mbed_official 277:0dffe5d9e928 12 */
mbed_official 277:0dffe5d9e928 13
mbed_official 277:0dffe5d9e928 14 #ifndef BLE_L2CAP_H__
mbed_official 277:0dffe5d9e928 15 #define BLE_L2CAP_H__
mbed_official 277:0dffe5d9e928 16
mbed_official 277:0dffe5d9e928 17 #include "ble_types.h"
mbed_official 277:0dffe5d9e928 18 #include "ble_ranges.h"
mbed_official 277:0dffe5d9e928 19 #include "ble_err.h"
mbed_official 277:0dffe5d9e928 20 #include "nrf_svc.h"
mbed_official 277:0dffe5d9e928 21
mbed_official 277:0dffe5d9e928 22 /**@addtogroup BLE_L2CAP_ENUMERATIONS Enumerations
mbed_official 277:0dffe5d9e928 23 * @{ */
mbed_official 277:0dffe5d9e928 24
mbed_official 277:0dffe5d9e928 25 /**@brief L2CAP API SVC numbers. */
mbed_official 277:0dffe5d9e928 26 enum BLE_L2CAP_SVCS
mbed_official 277:0dffe5d9e928 27 {
mbed_official 277:0dffe5d9e928 28 SD_BLE_L2CAP_CID_REGISTER = BLE_L2CAP_SVC_BASE, /**< Register a CID. */
mbed_official 277:0dffe5d9e928 29 SD_BLE_L2CAP_CID_UNREGISTER, /**< Unregister a CID. */
mbed_official 277:0dffe5d9e928 30 SD_BLE_L2CAP_TX /**< Transmit a packet. */
mbed_official 277:0dffe5d9e928 31 };
mbed_official 277:0dffe5d9e928 32
mbed_official 277:0dffe5d9e928 33 /** @} */
mbed_official 277:0dffe5d9e928 34
mbed_official 277:0dffe5d9e928 35 /**@addtogroup BLE_L2CAP_DEFINES Defines
mbed_official 277:0dffe5d9e928 36 * @{ */
mbed_official 277:0dffe5d9e928 37
mbed_official 277:0dffe5d9e928 38 /**@defgroup BLE_ERRORS_L2CAP SVC return values specific to L2CAP
mbed_official 277:0dffe5d9e928 39 * @{ */
mbed_official 277:0dffe5d9e928 40 #define BLE_ERROR_L2CAP_CID_IN_USE (NRF_L2CAP_ERR_BASE + 0x000) /**< CID already in use. */
mbed_official 277:0dffe5d9e928 41 /** @} */
mbed_official 277:0dffe5d9e928 42
mbed_official 277:0dffe5d9e928 43 /**@brief Default L2CAP MTU. */
mbed_official 277:0dffe5d9e928 44 #define BLE_L2CAP_MTU_DEF (23)
mbed_official 277:0dffe5d9e928 45
mbed_official 277:0dffe5d9e928 46 /**@brief Invalid Channel Identifier. */
mbed_official 277:0dffe5d9e928 47 #define BLE_L2CAP_CID_INVALID (0x0000)
mbed_official 277:0dffe5d9e928 48
mbed_official 277:0dffe5d9e928 49 /**@brief Dynamic Channel Identifier base. */
mbed_official 277:0dffe5d9e928 50 #define BLE_L2CAP_CID_DYN_BASE (0x0040)
mbed_official 277:0dffe5d9e928 51
mbed_official 277:0dffe5d9e928 52 /**@brief Maximum amount of dynamic CIDs. */
mbed_official 277:0dffe5d9e928 53 #define BLE_L2CAP_CID_DYN_MAX (8)
mbed_official 277:0dffe5d9e928 54
mbed_official 277:0dffe5d9e928 55 /** @} */
mbed_official 277:0dffe5d9e928 56
mbed_official 277:0dffe5d9e928 57 /**@addtogroup BLE_L2CAP_STRUCTURES Structures
mbed_official 277:0dffe5d9e928 58 * @{ */
mbed_official 277:0dffe5d9e928 59
mbed_official 277:0dffe5d9e928 60 /**@brief Packet header format for L2CAP transmission. */
mbed_official 277:0dffe5d9e928 61 typedef struct
mbed_official 277:0dffe5d9e928 62 {
mbed_official 277:0dffe5d9e928 63 uint16_t len; /**< Length of valid info in data member. */
mbed_official 277:0dffe5d9e928 64 uint16_t cid; /**< Channel ID on which packet is transmitted. */
mbed_official 277:0dffe5d9e928 65 } ble_l2cap_header_t;
mbed_official 277:0dffe5d9e928 66
mbed_official 277:0dffe5d9e928 67 /**@brief L2CAP Event IDs. */
mbed_official 277:0dffe5d9e928 68 enum BLE_L2CAP_EVTS
mbed_official 277:0dffe5d9e928 69 {
mbed_official 277:0dffe5d9e928 70 BLE_L2CAP_EVT_RX = BLE_L2CAP_EVT_BASE /**< L2CAP packet received. */
mbed_official 277:0dffe5d9e928 71 };
mbed_official 277:0dffe5d9e928 72
mbed_official 277:0dffe5d9e928 73
mbed_official 277:0dffe5d9e928 74 /**@brief L2CAP Received packet event report. */
mbed_official 277:0dffe5d9e928 75 typedef struct
mbed_official 277:0dffe5d9e928 76 {
mbed_official 277:0dffe5d9e928 77 ble_l2cap_header_t header; /** L2CAP packet header. */
mbed_official 277:0dffe5d9e928 78 uint8_t data[1]; /**< Packet data, variable length. */
mbed_official 277:0dffe5d9e928 79 } ble_l2cap_evt_rx_t;
mbed_official 277:0dffe5d9e928 80
mbed_official 277:0dffe5d9e928 81
mbed_official 277:0dffe5d9e928 82 /**@brief L2CAP event callback event structure. */
mbed_official 277:0dffe5d9e928 83 typedef struct
mbed_official 277:0dffe5d9e928 84 {
mbed_official 277:0dffe5d9e928 85 uint16_t conn_handle; /**< Connection Handle on which event occured. */
mbed_official 277:0dffe5d9e928 86 union
mbed_official 277:0dffe5d9e928 87 {
mbed_official 277:0dffe5d9e928 88 ble_l2cap_evt_rx_t rx; /**< RX Event parameters. */
mbed_official 277:0dffe5d9e928 89 } params;
mbed_official 277:0dffe5d9e928 90 } ble_l2cap_evt_t;
mbed_official 277:0dffe5d9e928 91
mbed_official 277:0dffe5d9e928 92
mbed_official 277:0dffe5d9e928 93 /**@brief Register a CID with L2CAP.
mbed_official 277:0dffe5d9e928 94 *
mbed_official 277:0dffe5d9e928 95 * @details This registers a higher protocol layer with the L2CAP multiplexer, and is requried prior to all operations on the CID.
mbed_official 277:0dffe5d9e928 96 *
mbed_official 277:0dffe5d9e928 97 * @param[in] cid L2CAP CID.
mbed_official 277:0dffe5d9e928 98 *
mbed_official 277:0dffe5d9e928 99 * @return @ref NRF_SUCCESS Successfully registered a CID with the L2CAP layer.
mbed_official 277:0dffe5d9e928 100 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, CID must be above @ref BLE_L2CAP_CID_DYN_BASE.
mbed_official 277:0dffe5d9e928 101 * @return @ref BLE_ERROR_L2CAP_CID_IN_USE L2CAP CID already in use.
mbed_official 277:0dffe5d9e928 102 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
mbed_official 277:0dffe5d9e928 103 */
mbed_official 277:0dffe5d9e928 104 SVCALL(SD_BLE_L2CAP_CID_REGISTER, uint32_t, sd_ble_l2cap_cid_register(uint16_t cid));
mbed_official 277:0dffe5d9e928 105
mbed_official 277:0dffe5d9e928 106 /**@brief Unregister a CID with L2CAP.
mbed_official 277:0dffe5d9e928 107 *
mbed_official 277:0dffe5d9e928 108 * @details This unregisters a previously registerd higher protocol layer with the L2CAP multiplexer.
mbed_official 277:0dffe5d9e928 109 *
mbed_official 277:0dffe5d9e928 110 * @param[in] cid L2CAP CID.
mbed_official 277:0dffe5d9e928 111 *
mbed_official 277:0dffe5d9e928 112 * @return @ref NRF_SUCCESS Successfully unregistered the CID.
mbed_official 277:0dffe5d9e928 113 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied.
mbed_official 277:0dffe5d9e928 114 * @return @ref NRF_ERROR_NOT_FOUND CID not previously registered.
mbed_official 277:0dffe5d9e928 115 */
mbed_official 277:0dffe5d9e928 116 SVCALL(SD_BLE_L2CAP_CID_UNREGISTER, uint32_t, sd_ble_l2cap_cid_unregister(uint16_t cid));
mbed_official 277:0dffe5d9e928 117
mbed_official 277:0dffe5d9e928 118 /**@brief Transmit an L2CAP packet.
mbed_official 277:0dffe5d9e928 119 *
mbed_official 277:0dffe5d9e928 120 * @note It is important to note that a call to this function will <b>consume an application buffer</b>, and will therefore
mbed_official 277:0dffe5d9e928 121 * generate a @ref BLE_EVT_TX_COMPLETE event when the packet has been transmitted.
mbed_official 277:0dffe5d9e928 122 * Please see the documentation of @ref sd_ble_tx_buffer_count_get for more details.
mbed_official 277:0dffe5d9e928 123 *
mbed_official 277:0dffe5d9e928 124 * @param[in] conn_handle Connection Handle.
mbed_official 277:0dffe5d9e928 125 * @param[in] p_header Pointer to a packet header containing length and CID.
mbed_official 277:0dffe5d9e928 126 * @param[in] p_data Pointer to the data to be transmitted.
mbed_official 277:0dffe5d9e928 127 *
mbed_official 277:0dffe5d9e928 128 * @return @ref NRF_SUCCESS Successfully queued an L2CAP packet for transmission.
mbed_official 277:0dffe5d9e928 129 * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
mbed_official 277:0dffe5d9e928 130 * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, CIDs must be registered beforehand with @ref sd_ble_l2cap_cid_register.
mbed_official 277:0dffe5d9e928 131 * @return @ref NRF_ERROR_NOT_FOUND CID not found.
mbed_official 277:0dffe5d9e928 132 * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation.
mbed_official 277:0dffe5d9e928 133 * @return @ref BLE_ERROR_NO_TX_BUFFERS Not enough application buffers available.
mbed_official 277:0dffe5d9e928 134 * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, see @ref BLE_L2CAP_MTU_DEF.
mbed_official 277:0dffe5d9e928 135 */
mbed_official 277:0dffe5d9e928 136 SVCALL(SD_BLE_L2CAP_TX, uint32_t, sd_ble_l2cap_tx(uint16_t conn_handle, ble_l2cap_header_t const * const p_header, uint8_t const * const p_data));
mbed_official 277:0dffe5d9e928 137
mbed_official 277:0dffe5d9e928 138 /** @} */
mbed_official 277:0dffe5d9e928 139
mbed_official 277:0dffe5d9e928 140 #endif // BLE_L2CAP_H__
mbed_official 277:0dffe5d9e928 141
mbed_official 277:0dffe5d9e928 142 /**
mbed_official 277:0dffe5d9e928 143 @}
mbed_official 277:0dffe5d9e928 144 */