123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677 |
- /**
- * Copyright (c) 2013 - 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_GATTS_APP_H__
- #define BLE_GATTS_APP_H__
- /**@file
- *
- * @defgroup ble_gatts_app GATTS Application command request encoders and command response decoders
- * @{
- * @ingroup ser_app_s130_codecs
- *
- * @brief GATTS Application command request encoders and command response decoders.
- */
- #include "ble_gatts.h"
- #include "ble.h"
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**@brief Encodes @ref sd_ble_gatts_value_get command request.
- *
- * @sa @ref ble_gatts_value_get_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] handle Attribute handle.
- * @param[in] p_value Pointer to attribute value information.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @note \p p_data_len and \p p_data will not be updated by the command
- * request encoder. Updated values are set by @ref ble_gatts_value_get_rsp_dec.
- *
- * @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_gatts_value_get_req_enc(uint16_t conn_handle,
- uint16_t handle,
- ble_gatts_value_t const * const p_value,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_value_get command.
- *
- * @sa @ref ble_gatts_value_get_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_value Pointer to structure where the attribute value will be stored.
- * @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_DATA_SIZE Length of \p p_value is too small to hold decoded
- * value from response.
- */
- uint32_t ble_gatts_value_get_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- ble_gatts_value_t * const p_value,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_hvx command request.
- *
- * @sa @ref ble_gatts_hvx_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] p_hvx_params Pointer to an HVx parameters structure to be encoded.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @note \p p_hvx_params will not be updated by the command
- * request encoder. Updated values are set by @ref ble_gatts_hvx_rsp_dec.
- *
- * @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_gatts_hvx_req_enc(uint16_t conn_handle,
- ble_gatts_hvx_params_t const * const p_hvx_params,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_hvx command.
- *
- * @sa @ref ble_gatts_hvx_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.
- * @param[out] pp_bytes_written Pointer to pointer to location where number of bytes is written.
- *
- * @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_gatts_hvx_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code,
- uint16_t * * const pp_bytes_written);
- /**@brief Encodes @ref sd_ble_gatts_characteristic_add command request.
- *
- * @sa @ref ble_gatts_characteristic_add_rsp_dec for command response decoder.
- *
- * @param[in] service_handle Handle of the service where the characteristic is to be placed.
- * If @ref BLE_GATT_HANDLE_INVALID is used, it will be placed
- * sequentially.
- * @param[in] p_char_md Pointer to a @ref ble_gatts_char_md_t structure, characteristic
- * metadata.
- * @param[in] p_attr_char_value Pointer to a @ref ble_gatts_attr_t structure, corresponding to
- * the characteristic value.
- * @param[in] p_handles Pointer to a @ref ble_gatts_char_handles_t structure, where the
- * assigned handles will be stored.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @note \p p_handles will not be updated by the command
- * request encoder. Updated values are set by @ref ble_gatts_characteristic_add_rsp_dec.
- *
- * @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_gatts_characteristic_add_req_enc
- (uint16_t service_handle,
- ble_gatts_char_md_t const * const p_char_md,
- ble_gatts_attr_t const * const p_attr_char_value,
- ble_gatts_char_handles_t const * const p_handles,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_characteristic_add command.
- *
- * @sa @ref ble_gatts_characteristic_add_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] pp_handles Pointer to pointer to location where handles should be decoded.
- * @param[out] p_result_code Pointer to command result code decode location.
- *
- * @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_gatts_characteristic_add_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * * const pp_handles,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_service_add command request.
- *
- * @sa @ref ble_gatts_service_add_rsp_dec for command response decoder.
- *
- * @param[in] type Toggles between primary and secondary services,
- * see @ref BLE_GATTS_SRVC_TYPES.
- * @param[in] p_uuid Pointer to service UUID.
- * @param[in] p_conn_handle Pointer to a 16-bit word where the assigned handle will be stored.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @param[in,out] p_buf_len \c in: Size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @note \p p_conn_handle will not be updated by the command
- * request encoder. Updated values are set by @ref ble_gatts_service_add_rsp_dec.
- *
- * @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_gatts_service_add_req_enc(uint8_t type,
- ble_uuid_t const * const p_uuid,
- uint16_t const * const p_conn_handle,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_service_add command.
- *
- * @sa @ref ble_gatts_service_add_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_conn_handle Connection handle.
- * @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_gatts_service_add_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * const p_conn_handle,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_sys_attr_set command request.
- *
- * @sa @ref ble_gatts_sys_attr_set_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] p_sys_attr_data Pointer to a buffer (at least \p sys_attr_data_len bytes long)
- * containing the attribute value to write.
- * @param[in] sys_attr_data_len Length (in bytes) of \p p_sys_attr_data.
- * @param[in] flags Optional additional flags.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_sys_attr_set_req_enc(uint16_t conn_handle,
- uint8_t const * const p_sys_attr_data,
- uint16_t sys_attr_data_len,
- uint32_t flags,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_sys_attr_set command.
- *
- * @sa @ref ble_gatts_sys_attr_set_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_gatts_sys_attr_set_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_value_set command request.
- *
- * @sa @ref ble_gatts_value_set_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] handle Attribute handle.
- * @param[in] p_value Pointer to attribute value information.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_value_set_req_enc(uint16_t conn_handle,
- uint16_t handle,
- ble_gatts_value_t * p_value,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_value_set command.
- *
- * @sa @ref ble_gatts_value_set_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_value Pointer to attribute value information.
- * @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_gatts_value_set_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- ble_gatts_value_t * const p_value,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_sys_attr_get command request.
- *
- * @sa @ref ble_gatts_sys_attr_get_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle of the connection.
- * @param[in] p_sys_attr_data Pointer to buffer where updated information about system
- * attributes will be stored. Can be NULL to calculate required
- * size.
- * @param[in] p_sys_attr_data_len Size of p_sys_attr_data buffer if \p p_sys_attr_data is
- * not NULL.
- * @param[in] flags Additional optional flags.
- * @param[in,out] p_buf Pointer to buffer where encoded data command will
- * be returned.
- * @param[in,out] p_buf_len \c in: size of \p p_buf buffer.
- * \c out: Length of encoded command packet.
- *
- * @note \p p_sys_attr_data and \p p_sys_attr_data_len will not be updated by the command
- * request encoder. Updated values are set by @ref ble_gatts_sys_attr_get_rsp_dec.
- *
- * @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_gatts_sys_attr_get_req_enc(uint16_t conn_handle,
- uint8_t const * const p_sys_attr_data,
- uint16_t const * const p_sys_attr_data_len,
- uint32_t flags,
- uint8_t * const p_buf,
- uint32_t * p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_sys_attr_get command.
- *
- * @sa @ref ble_gatts_sys_attr_get_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] pp_sys_attr_data Pointer to a buffer where updated information about system
- * attributes will be stored.
- * @param[in,out] pp_sys_attr_data_len \c in: Size (in bytes) of \p p_sys_attr_data buffer.
- * \c out: Length of decoded contents of \p p_sys_attr_data.
- * @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_DATA_SIZE Length of \p p_sys_attr_data is too small to hold decoded
- * value from response.
- * @retval NRF_ERROR_INVALID_DATA Decoding failure. Decoded operation code does not match
- * expected operation code.
- */
- uint32_t ble_gatts_sys_attr_get_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint8_t * * const pp_sys_attr_data,
- uint16_t * * const pp_sys_attr_data_len,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_descriptor_add command request.
- *
- * @sa @ref ble_gatts_descriptor_add_rsp_dec for command response decoder.
- *
- * @param[in] char_handle Handle of the characteristic where the description is to be placed.
- * If @ref BLE_GATT_HANDLE_INVALID is used, it will be placed
- * sequentially.
- * @param[in] p_attr Pointer to a @ref ble_gatts_attr_t structure, characteristic
- * metadata.
- * @param[in] p_handle Pointer to a @ref ble_gatts_char_handles_t structure, where the
- * assigned handles will be stored.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_descriptor_add_req_enc(uint16_t char_handle,
- ble_gatts_attr_t const * const p_attr,
- uint16_t * const p_handle,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_descriptor_add command.
- *
- * @sa @ref ble_gatts_descriptor_add_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_handle Pointer to bufer where descriptor handle will be
- returned.
- * @param[out] p_result_code Pointer to command result code decode location.
- *
- * @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_gatts_descriptor_add_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * const p_handle,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_include_add command request.
- *
- * @sa @ref ble_gatts_include_add_rsp_dec for command response decoder.
- *
- * @param[in] service_handle Handle of the service where the included service is to be placed.
- * @param[in] inc_srvc_handle Handle of the included service
- * @param[in] p_include_handle Pointer to Pointer to a 16-bit word where the assigned handle will be stored.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_include_add_req_enc(uint16_t service_handle,
- uint16_t inc_srvc_handle,
- uint16_t * const p_include_handle,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_include_add command.
- *
- * @sa @ref ble_gatts_include_add_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_include_handle Pointer to a 16-bit word where the assigned handle will be stored.
- * @param[out] p_result_code Pointer to command result code decode location.
- *
- * @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_gatts_include_add_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t * const p_include_handle,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_rw_authorize_reply command request.
- *
- * @sa @ref ble_gatts_rw_authorize_reply_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] p_reply_params Pointer to \ref ble_gatts_rw_authorize_reply_params_t
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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.
- * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Invalid param provided in p_reply_params.
- */
- uint32_t ble_gatts_rw_authorize_reply_req_enc(
- uint16_t conn_handle,
- ble_gatts_rw_authorize_reply_params_t const * const
- p_reply_params,
- uint8_t * const
- p_buf,
- uint32_t * const
- p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_rw_authorize_reply command.
- *
- * @sa @ref ble_gatts_rw_authorize_reply_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_gatts_rw_authorize_reply_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_service_changed command request.
- *
- * @sa @ref ble_gatts_service_changed_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] start_handle Start of affected attribute handle range.
- * @param[in] end_handle End of affected attribute handle range.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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.
- * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Invalid param provided in p_reply_params.
- */
- uint32_t ble_gatts_service_changed_req_enc(uint16_t conn_handle,
- uint16_t start_handle,
- uint16_t end_handle,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_service_changed command.
- *
- * @sa @ref ble_gatts_service_changed_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_gatts_service_changed_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_attr_get command request.
- *
- * @sa @ref ble_gatts_attr_get_rsp_dec for command response decoder.
- *
- * @param[in] handle See @ref sd_ble_gatts_attr_get.
- * @param[in] p_uuid See @ref sd_ble_gatts_attr_get.
- * @param[out] p_md See @ref sd_ble_gatts_attr_get.
- * @param[in,out] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_attr_get_req_enc(uint16_t handle,
- ble_uuid_t * p_uuid,
- ble_gatts_attr_md_t * p_md,
- uint8_t * const p_buf,
- uint32_t * p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_attr_get command.
- *
- * @sa @ref ble_gatts_attr_get_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] pp_uuid Pointer to address where to put output data.
- * @param[out] pp_md Pointer to address where to put output data.
- * @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_gatts_attr_get_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- ble_uuid_t ** pp_uuid,
- ble_gatts_attr_md_t ** pp_md,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_initial_user_handle_get command request.
- *
- * @sa @ref ble_gatts_initial_user_handle_get_rsp_dec for command response decoder.
- *
- * @param[out] p_handle See @ref sd_ble_gatts_initial_user_handle_get.
- * @param[in,out] p_buf Pointer to buffer where encoded data command will be returned.
- * @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_gatts_initial_user_handle_get_req_enc(uint16_t * p_handle,
- uint8_t * const p_buf,
- uint32_t * p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_initial_user_handle_get command.
- *
- * @sa @ref ble_gatts_initial_user_handle_get_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] pp_handle Pointer to address where to put output data.
- * @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_gatts_initial_user_handle_get_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint16_t ** pp_handle,
- uint32_t * const p_result_code);
- /**@brief Encodes @ref sd_ble_gatts_exchange_mtu_reply command request.
- *
- * @sa @ref ble_gatts_exchange_mtu_reply_rsp_dec for command response decoder.
- *
- * @param[in] conn_handle Connection handle.
- * @param[in] server_rx_mtu Server MTU Size.
- * @param[in] p_buf Pointer to buffer where encoded data command will be returned.
- * @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.
- * @retval NRF_ERROR_INVALID_PARAM Encoding failure. Invalid param provided in p_reply_params.
- */
- uint32_t ble_gatts_exchange_mtu_reply_req_enc(uint16_t conn_handle,
- uint16_t server_rx_mtu,
- uint8_t * const p_buf,
- uint32_t * const p_buf_len);
- /**@brief Decodes response to @ref sd_ble_gatts_exchange_mtu_reply command.
- *
- * @sa @ref ble_gatts_exchange_mtu_reply_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_gatts_exchange_mtu_reply_rsp_dec(uint8_t const * const p_buf,
- uint32_t packet_len,
- uint32_t * const p_result_code);
- /** @} */
- #ifdef __cplusplus
- }
- #endif
- #endif //BLE_GATTS_APP_H__
|