xiaozhengsheng 6df0f7d96e 初始版本
2025-08-19 09:49:41 +08:00

139 lines
6.2 KiB
C

/**
* 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.
*
*/
#ifndef BLE_EVT_CONN_H__
#define BLE_EVT_CONN_H__
/**@file
*
* @defgroup ble_evt_conn Connectivity event encoders
* @{
* @ingroup ser_conn_s130_codecs
*
* @brief Connectivity event encoders.
*/
#include "ble.h"
#ifdef __cplusplus
extern "C" {
#endif
#if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
/**
* @brief Encodes ble_evt_tx_complete event.
*
* @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
* @param[in] event_len Size (in bytes) of \p p_event buffer.
* @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
* @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
* \c out: Length of encoded contents in \p p_buf.
*
* @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_evt_tx_complete_enc(ble_evt_t const * const p_event,
uint32_t event_len,
uint8_t * const p_buf,
uint32_t * const p_buf_len);
#endif
/**
* @brief Encodes ble_evt_user_mem_release event.
*
* @param[in] p_event Pointer to the \ref ble_evt_t buffer that shall be encoded.
* @param[in] event_len Size (in bytes) of \p p_event buffer.
* @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
* @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
* \c out: Length of encoded contents in \p p_buf.
*
* @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_evt_user_mem_release_enc(ble_evt_t const * const p_event,
uint32_t event_len,
uint8_t * const p_buf,
uint32_t * const p_buf_len);
/**
* @brief Encodes ble_evt_user_mem_request event.
*
* @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
* @param[in] event_len Size (in bytes) of \p p_event buffer.
* @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
* @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
* \c out: Length of encoded contents in \p p_buf.
*
* @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_evt_user_mem_request_enc(ble_evt_t const * const p_event,
uint32_t event_len,
uint8_t * const p_buf,
uint32_t * const p_buf_len);
#if defined(NRF_SD_BLE_API_VERSION) && NRF_SD_BLE_API_VERSION < 4
/**
* @brief Encodes ble_evt_data_length_changed event.
*
* @param[in] p_event Pointer to the \ref ble_evt_t buffer that will be encoded.
* @param[in] event_len Size (in bytes) of \p p_event buffer.
* @param[out] p_buf Pointer to the beginning of a buffer for encoded event packet.
* @param[in,out] p_buf_len \c in: Size (in bytes) of \p p_buf buffer.
* \c out: Length of encoded contents in \p p_buf.
*
* @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_evt_data_length_changed_enc(ble_evt_t const * const p_event,
uint32_t event_len,
uint8_t * const p_buf,
uint32_t * const p_buf_len);
#endif
/** @} */
#ifdef __cplusplus
}
#endif
#endif