Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2
Dependencies: BLE_API_Native_blog
mbed/TARGET_NRF51822/ble_l2cap.h
- Committer:
- gkroussos
- Date:
- 2015-03-07
- Revision:
- 0:e8fdba0ed044
File content as of revision 0:e8fdba0ed044:
/* Copyright (c) 2011 Nordic Semiconductor. All Rights Reserved. * * The information contained herein is confidential property of Nordic Semiconductor. The use, * copying, transfer or disclosure of such information is prohibited except by express written * agreement with Nordic Semiconductor. * */ /** @addtogroup BLE_L2CAP Logical Link Control and Adaptation Protocol (L2CAP) @{ @brief Definitions and prototypes for the L2CAP interface. */ #ifndef BLE_L2CAP_H__ #define BLE_L2CAP_H__ #include "ble_types.h" #include "ble_ranges.h" #include "ble_err.h" #include "nrf_svc.h" /**@brief L2CAP API SVC numbers. */ enum BLE_L2CAP_SVCS { SD_BLE_L2CAP_CID_REGISTER = BLE_L2CAP_SVC_BASE, /**< Register a CID. */ SD_BLE_L2CAP_CID_UNREGISTER, /**< Unregister a CID. */ SD_BLE_L2CAP_TX /**< Transmit a packet. */ }; /**@addtogroup BLE_L2CAP_DEFINES Defines * @{ */ /**@defgroup BLE_ERRORS_L2CAP SVC return values specific to L2CAP * @{ */ #define BLE_ERROR_L2CAP_CID_IN_USE (NRF_L2CAP_ERR_BASE + 0x000) /**< CID already in use. */ /** @} */ /**@brief Default L2CAP MTU. */ #define BLE_L2CAP_MTU_DEF (23) /**@brief Invalid Channel Identifier. */ #define BLE_L2CAP_CID_INVALID (0x0000) /**@brief Dynamic Channel Identifier base. */ #define BLE_L2CAP_CID_DYN_BASE (0x0040) /**@brief Maximum amount of dynamic CIDs. */ #define BLE_L2CAP_CID_DYN_MAX (8) /** @} */ /**@brief Packet header format for L2CAP transmission. */ typedef struct { uint16_t len; /**< Length of valid info in data member. */ uint16_t cid; /**< Channel ID on which packet is transmitted. */ } ble_l2cap_header_t; /**@brief L2CAP Event IDs. */ enum BLE_L2CAP_EVTS { BLE_L2CAP_EVT_RX = BLE_L2CAP_EVT_BASE /**< L2CAP packet received. */ }; /**@brief L2CAP Received packet event report. */ typedef struct { ble_l2cap_header_t header; /** L2CAP packet header. */ uint8_t data[1]; /**< Packet data, variable length. */ } ble_l2cap_evt_rx_t; /**@brief L2CAP event callback event structure. */ typedef struct { uint16_t conn_handle; /**< Connection Handle on which event occured. */ union { ble_l2cap_evt_rx_t rx; /**< RX Event parameters. */ } params; } ble_l2cap_evt_t; /**@brief Register a CID with L2CAP. * * @details This registers a higher protocol layer with the L2CAP multiplexer, and is requried prior to all operations on the CID. * * @param[in] cid L2CAP CID. * * @return @ref NRF_SUCCESS Successfully registered a CID with the L2CAP layer. * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, CID must be above @ref BLE_L2CAP_CID_DYN_BASE. * @return @ref BLE_ERROR_L2CAP_CID_IN_USE L2CAP CID already in use. * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. */ SVCALL(SD_BLE_L2CAP_CID_REGISTER, uint32_t, sd_ble_l2cap_cid_register(uint16_t cid)); /**@brief Unregister a CID with L2CAP. * * @details This unregisters a previously registerd higher protocol layer with the L2CAP multiplexer. * * @param[in] cid L2CAP CID. * * @return @ref NRF_SUCCESS Successfully unregistered the CID. * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied. * @return @ref NRF_ERROR_NOT_FOUND CID not previously registered. */ SVCALL(SD_BLE_L2CAP_CID_UNREGISTER, uint32_t, sd_ble_l2cap_cid_unregister(uint16_t cid)); /**@brief Transmit an L2CAP packet. * * @note It is important to note that a call to this function will <b>consume an application buffer</b>, and will therefore * generate a @ref BLE_EVT_TX_COMPLETE event when the packet has been transmitted. * Please see the documentation of @ref sd_ble_tx_buffer_count_get for more details. * * @param[in] conn_handle Connection Handle. * @param[in] p_header Pointer to a packet header containing length and CID. * @param[in] p_data Pointer to the data to be transmitted. * * @return @ref NRF_SUCCESS Successfully queued an L2CAP packet for transmission. * @return @ref NRF_ERROR_INVALID_ADDR Invalid pointer supplied. * @return @ref NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, CIDs must be registered beforehand with @ref sd_ble_l2cap_cid_register. * @return @ref NRF_ERROR_NOT_FOUND CID not found. * @return @ref NRF_ERROR_NO_MEM Not enough memory to complete operation. * @return @ref BLE_ERROR_NO_TX_BUFFERS Not enough application buffers available. * @return @ref NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, see @ref BLE_L2CAP_MTU_DEF. */ 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)); #endif // BLE_L2CAP_H__ /** @} */