George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/TARGET_NRF51822/ble_l2cap.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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