Jinu Andrews / nRF51

lib/codecs/inc/ble_l2cap_evt_app.h@0:6ba9b94b8997, 2017-02-09 (annotated)

Committer:
jinu
Date:
Thu Feb 09 06:08:17 2017 +0000
Revision:
0:6ba9b94b8997
NRF51 serialization libraries for mDot

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jinu 0:6ba9b94b8997 1 /* Copyright (c) Nordic Semiconductor ASA
jinu 0:6ba9b94b8997 2 * All rights reserved.
jinu 0:6ba9b94b8997 3 *
jinu 0:6ba9b94b8997 4 * Redistribution and use in source and binary forms, with or without modification,
jinu 0:6ba9b94b8997 5 * are permitted provided that the following conditions are met:
jinu 0:6ba9b94b8997 6 *
jinu 0:6ba9b94b8997 7 * 1. Redistributions of source code must retain the above copyright notice, this
jinu 0:6ba9b94b8997 8 * list of conditions and the following disclaimer.
jinu 0:6ba9b94b8997 9 *
jinu 0:6ba9b94b8997 10 * 2. Redistributions in binary form must reproduce the above copyright notice, this
jinu 0:6ba9b94b8997 11 * list of conditions and the following disclaimer in the documentation and/or
jinu 0:6ba9b94b8997 12 * other materials provided with the distribution.
jinu 0:6ba9b94b8997 13 *
jinu 0:6ba9b94b8997 14 * 3. Neither the name of Nordic Semiconductor ASA nor the names of other
jinu 0:6ba9b94b8997 15 * contributors to this software may be used to endorse or promote products
jinu 0:6ba9b94b8997 16 * derived from this software without specific prior written permission.
jinu 0:6ba9b94b8997 17 *
jinu 0:6ba9b94b8997 18 * 4. This software must only be used in a processor manufactured by Nordic
jinu 0:6ba9b94b8997 19 * Semiconductor ASA, or in a processor manufactured by a third party that
jinu 0:6ba9b94b8997 20 * is used in combination with a processor manufactured by Nordic Semiconductor.
jinu 0:6ba9b94b8997 21 *
jinu 0:6ba9b94b8997 22 *
jinu 0:6ba9b94b8997 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
jinu 0:6ba9b94b8997 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
jinu 0:6ba9b94b8997 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
jinu 0:6ba9b94b8997 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
jinu 0:6ba9b94b8997 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
jinu 0:6ba9b94b8997 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
jinu 0:6ba9b94b8997 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
jinu 0:6ba9b94b8997 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
jinu 0:6ba9b94b8997 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
jinu 0:6ba9b94b8997 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
jinu 0:6ba9b94b8997 33 */
jinu 0:6ba9b94b8997 34 #ifndef BLE_L2CAP_EVT_APP_H__
jinu 0:6ba9b94b8997 35 #define BLE_L2CAP_EVT_APP_H__
jinu 0:6ba9b94b8997 36 /**@file
jinu 0:6ba9b94b8997 37 *
jinu 0:6ba9b94b8997 38 * @defgroup ble_l2cap_evt_app L2CAP Application event decoders
jinu 0:6ba9b94b8997 39 * @{
jinu 0:6ba9b94b8997 40 * @ingroup ble_sdk_lib_serialization
jinu 0:6ba9b94b8997 41 *
jinu 0:6ba9b94b8997 42 * @brief L2CAP Application event decoders.
jinu 0:6ba9b94b8997 43 */
jinu 0:6ba9b94b8997 44 #include "ble.h"
jinu 0:6ba9b94b8997 45
jinu 0:6ba9b94b8997 46 /**
jinu 0:6ba9b94b8997 47 * @brief Decodes ble_l2cap_evt_rx event.
jinu 0:6ba9b94b8997 48 *
jinu 0:6ba9b94b8997 49 * @sa @ref nrf51_l2cap_evt_rx_encoding for packet format.
jinu 0:6ba9b94b8997 50 *
jinu 0:6ba9b94b8997 51 * If \p p_event is null, the required length of \p p_event is returned in \p p_event_len.
jinu 0:6ba9b94b8997 52 *
jinu 0:6ba9b94b8997 53 * @param[in] p_buf Pointer to the beginning of an event packet.
jinu 0:6ba9b94b8997 54 * @param[in] packet_len Length (in bytes) of the event packet.
jinu 0:6ba9b94b8997 55 * @param[in,out] p_event Pointer to a \ref ble_evt_t buffer where the decoded event will be
jinu 0:6ba9b94b8997 56 * stored. If NULL, required length will be returned in \p p_event_len.
jinu 0:6ba9b94b8997 57 * @param[in,out] p_event_len \c in: Size (in bytes) of \p p_event buffer.
jinu 0:6ba9b94b8997 58 * \c out: Length of decoded contents of \p p_event.
jinu 0:6ba9b94b8997 59 *
jinu 0:6ba9b94b8997 60 * @retval NRF_SUCCESS Decoding success.
jinu 0:6ba9b94b8997 61 * @retval NRF_ERROR_NULL Decoding failure. NULL pointer supplied.
jinu 0:6ba9b94b8997 62 * @retval NRF_ERROR_INVALID_LENGTH Decoding failure. Incorrect buffer length.
jinu 0:6ba9b94b8997 63 * @retval NRF_ERROR_DATA_SIZE Decoding failure. Length of \p p_event is too small to
jinu 0:6ba9b94b8997 64 * hold decoded event.
jinu 0:6ba9b94b8997 65 */
jinu 0:6ba9b94b8997 66 uint32_t ble_l2cap_evt_rx_dec(uint8_t const * const p_buf,
jinu 0:6ba9b94b8997 67 uint32_t packet_len,
jinu 0:6ba9b94b8997 68 ble_evt_t * const p_event,
jinu 0:6ba9b94b8997 69 uint32_t * const p_event_len);
jinu 0:6ba9b94b8997 70
jinu 0:6ba9b94b8997 71 /** @} */
jinu 0:6ba9b94b8997 72 #endif
jinu 0:6ba9b94b8997 73