123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242 |
- /**
- * Copyright (c) 2014 - 2020, Nordic Semiconductor ASA
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice, this
- * list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form, except as embedded into a Nordic
- * Semiconductor ASA integrated circuit in a product or a software update for
- * such product, must reproduce the above copyright notice, this list of
- * conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution.
- *
- * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
- * contributors may be used to endorse or promote products derived from this
- * software without specific prior written permission.
- *
- * 4. This software, with or without modification, must only be used with a
- * Nordic Semiconductor ASA integrated circuit.
- *
- * 5. Any software provided in binary form under this license must not be reverse
- * engineered, decompiled, modified and/or disassembled.
- *
- * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
- * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
- * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
- * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
- * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
- * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- */
- /**@file
- *
- * @defgroup ble_l2cap_app L2CAP Application command request encoders and command response decoders
- * @{
- * @ingroup ser_app_s130_codecs
- *
- * @brief L2CAP Application command request encoders and command response decoders.
- */
- #ifndef BLE_L2CAP_APP_H__
- #define BLE_L2CAP_APP_H__
- #include "ble.h"
- #include "ble_types.h"
- #include "ble_ranges.h"
- #include "ble_err.h"
- #include "ble_l2cap.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- #if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
- /**@brief Register a CID with L2CAP.
- *
- * @details This registers a higher protocol layer with the L2CAP multiplexer, and is required prior to all operations on the CID.
- *
- * @param[in] cid L2CAP CID.
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @retval NRF_SUCCESS Encoding success.
- * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
- * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
- */
- uint32_t ble_l2cap_cid_register_req_enc(uint16_t cid,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**
- * @brief Decodes response to @ref sd_ble_l2cap_cid_register command.
- *
- * @sa @ref ble_l2cap_cid_register_req_enc for command request encoder.
- *
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in] packet_len Length (in bytes) of response packet.
- * @param[out] p_result_code Command result code.
- *
- * @retval NRF_SUCCESS Decoding success.
- * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
- * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
- * @retval NRF_ERROR_INVALID_DATA Decoding failure. Decoded operation code does not match
- * expected operation code.
- */
- uint32_t ble_l2cap_cid_register_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /**@brief Unregister a CID with L2CAP.
- *
- * @details This unregisters a previously registered higher protocol layer with the L2CAP multiplexer.
- *
- * @param[in] cid L2CAP CID.
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @retval NRF_SUCCESS Encoding success.
- * @retval NRF_ERROR_NULL Encoding failure. NULL pointer supplied.
- * @retval NRF_ERROR_INVALID_LENGTH Encoding failure. Incorrect buffer length.
- */
- uint32_t ble_l2cap_cid_unregister_req_enc(uint16_t cid,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**
- * @brief Decodes response to @ref sd_ble_l2cap_cid_unregister command.
- *
- * @sa @ref ble_l2cap_cid_unregister_req_enc for command request encoder.
- *
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in] packet_len Length (in bytes) of response packet.
- * @param[out] p_result_code Command result code.
- *
- * @retval NRF_SUCCESS Decoding success.
- * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
- * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
- * @retval NRF_ERROR_INVALID_DATA Decoding failure. Decoded operation code does not match
- * expected operation code.
- */
- uint32_t ble_l2cap_cid_unregister_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /**@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.
- * See the documentation of @ref sd_ble_tx_packet_count_get for more details.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] p_l2cap_header Pointer to a packet header containing length and CID.
- * @param[in] p_data Pointer to the data to be transmitted.
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in,out] p_buf_len\ c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @retval NRF_SUCCESS Successfully queued an L2CAP packet for transmission.
- * @retval NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
- * @retval NRF_ERROR_INVALID_PARAM Invalid parameter(s) supplied, CIDs must be registered beforehand with @ref sd_ble_l2cap_cid_register.
- * @retval NRF_ERROR_NOT_FOUND CID not found.
- * @retval NRF_ERROR_NO_MEM Not enough memory to complete operation.
- * @retval NRF_ERROR_DATA_SIZE Invalid data size(s) supplied, see @ref BLE_L2CAP_MTU_DEF.
- */
- uint32_t ble_l2cap_tx_req_enc(uint16_t conn_handle,
- ble_l2cap_header_t const * const p_l2cap_header,
- uint8_t const * const p_data,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**
- * @brief Decodes response to @ref sd_ble_l2cap_tx command.
- *
- * @sa @ref ble_l2cap_tx_req_enc for command request encoder.
- *
- * @param[in] p_buf Pointer to beginning of command response packet.
- * @param[in] packet_len Length (in bytes) of response packet.
- * @param[out] p_result_code Command result code.
- *
- * @retval NRF_SUCCESS Decoding success.
- * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
- * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
- * @retval NRF_ERROR_INVALID_DATA Decoding failure. Decoded operation code does not match
- * expected operation code.
- */
- uint32_t ble_l2cap_tx_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- #endif
- #if NRF_SD_BLE_API_VERSION >= 5
- uint32_t ble_l2cap_ch_setup_req_enc(uint16_t conn_handle,
- uint16_t * p_local_cid,
- ble_l2cap_ch_setup_params_t const *p_params,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- uint32_t ble_l2cap_ch_setup_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * p_local_cid,
- uint32_t * const p_result_code);
- uint32_t ble_l2cap_ch_release_req_enc(uint16_t conn_handle,
- uint16_t local_cid,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- uint32_t ble_l2cap_ch_release_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- uint32_t ble_l2cap_ch_rx_req_enc(uint16_t conn_handle,
- uint16_t local_cid,
- ble_data_t const *p_sdu_buf,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- uint32_t ble_l2cap_ch_rx_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- uint32_t ble_l2cap_ch_tx_req_enc(uint16_t conn_handle,
- uint16_t local_cid,
- ble_data_t const *p_sdu_buf,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- uint32_t ble_l2cap_ch_tx_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- uint32_t ble_l2cap_ch_flow_control_req_enc(uint16_t conn_handle,
- uint16_t local_cid,
- uint16_t credits,
- uint16_t *p_credits,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- uint32_t ble_l2cap_ch_flow_control_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * p_credits,
- uint32_t * const p_result_code);
- #endif //NRF_SD_BLE_API_VERSION >= 5
- #ifdef __cplusplus
- }
- #endif
- #endif //BLE_L2CAP_APP_H__
- /**
- @}
- */
|