mirror of
https://github.com/jam422470459/EPD-nRF52-hema213.git
synced 2025-12-19 14:53:19 +08:00
move components to SDK dir
This commit is contained in:
405
SDK/12.3.0_d7731ad/components/ble/nrf_ble_qwr/nrf_ble_qwr.c
Normal file
405
SDK/12.3.0_d7731ad/components/ble/nrf_ble_qwr/nrf_ble_qwr.c
Normal file
@@ -0,0 +1,405 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, 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.
|
||||
*
|
||||
*/
|
||||
#include "sdk_common.h"
|
||||
#if NRF_MODULE_ENABLED(NRF_BLE_QWR)
|
||||
#include <stdlib.h>
|
||||
#include "nrf_ble_qwr.h"
|
||||
#include "ble.h"
|
||||
#include "ble_srv_common.h"
|
||||
|
||||
#define NRF_BLE_QWR_INITIALIZED 0xDE // Non-zero value used to make sure the given structure has been initialized by the module.
|
||||
#define MODULE_INITIALIZED (p_qwr->initialized == NRF_BLE_QWR_INITIALIZED)
|
||||
#include "sdk_macros.h"
|
||||
|
||||
ret_code_t nrf_ble_qwr_init(nrf_ble_qwr_t * p_qwr,
|
||||
nrf_ble_qwr_init_t const * p_qwr_init)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_qwr);
|
||||
VERIFY_PARAM_NOT_NULL(p_qwr_init);
|
||||
if (MODULE_INITIALIZED)
|
||||
{
|
||||
return NRF_ERROR_INVALID_STATE;
|
||||
}
|
||||
|
||||
memset(p_qwr->attr_handles, 0, sizeof(p_qwr->attr_handles));
|
||||
p_qwr->nb_registered_attr = 0;
|
||||
p_qwr->error_handler = p_qwr_init->error_handler;
|
||||
p_qwr->is_user_mem_reply_pending = false;
|
||||
p_qwr->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_qwr->initialized = NRF_BLE_QWR_INITIALIZED;
|
||||
p_qwr->mem_buffer = p_qwr_init->mem_buffer;
|
||||
p_qwr->callback = p_qwr_init->callback;
|
||||
p_qwr->nb_written_handles = 0;
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_ble_qwr_attr_register(nrf_ble_qwr_t * p_qwr, uint16_t attr_handle)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_qwr);
|
||||
VERIFY_MODULE_INITIALIZED();
|
||||
|
||||
if (p_qwr->nb_registered_attr == NRF_BLE_QWR_ATTR_LIST_SIZE)
|
||||
{
|
||||
return (NRF_ERROR_NO_MEM);
|
||||
}
|
||||
|
||||
if (attr_handle == BLE_GATT_HANDLE_INVALID)
|
||||
{
|
||||
return NRF_ERROR_INVALID_PARAM;
|
||||
}
|
||||
|
||||
p_qwr->attr_handles[p_qwr->nb_registered_attr] = attr_handle;
|
||||
p_qwr->nb_registered_attr++;
|
||||
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_ble_qwr_value_get(nrf_ble_qwr_t * p_qwr,
|
||||
uint16_t attr_handle,
|
||||
uint8_t * p_mem,
|
||||
uint16_t * p_len)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_qwr);
|
||||
VERIFY_PARAM_NOT_NULL(p_mem);
|
||||
VERIFY_PARAM_NOT_NULL(p_len);
|
||||
VERIFY_MODULE_INITIALIZED();
|
||||
|
||||
uint16_t i = 0;
|
||||
uint16_t handle = BLE_GATT_HANDLE_INVALID;
|
||||
uint16_t val_len = 0;
|
||||
uint16_t val_offset = 0;
|
||||
uint16_t cur_len = 0;
|
||||
|
||||
do
|
||||
{
|
||||
handle = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
|
||||
|
||||
if (handle == BLE_GATT_HANDLE_INVALID)
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
||||
i += sizeof(uint16_t);
|
||||
val_offset = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
|
||||
i += sizeof(uint16_t);
|
||||
val_len = uint16_decode(&(p_qwr->mem_buffer.p_mem[i]));
|
||||
i += sizeof(uint16_t);
|
||||
|
||||
if (handle == attr_handle)
|
||||
{
|
||||
cur_len = val_offset + val_len;
|
||||
if (cur_len <= *p_len)
|
||||
{
|
||||
memcpy((p_mem + val_offset), &(p_qwr->mem_buffer.p_mem[i]), val_len);
|
||||
}
|
||||
else
|
||||
{
|
||||
return NRF_ERROR_NO_MEM;
|
||||
}
|
||||
}
|
||||
|
||||
i += val_len;
|
||||
}
|
||||
while (i < p_qwr->mem_buffer.len);
|
||||
|
||||
*p_len = cur_len;
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
ret_code_t nrf_ble_qwr_conn_handle_assign(nrf_ble_qwr_t * p_qwr,
|
||||
uint16_t conn_handle)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL(p_qwr);
|
||||
VERIFY_MODULE_INITIALIZED();
|
||||
p_qwr->conn_handle = conn_handle;
|
||||
return NRF_SUCCESS;
|
||||
}
|
||||
|
||||
|
||||
/**@brief Handle a user memory request event.
|
||||
*
|
||||
* @param[in] p_qwr QWR structure.
|
||||
* @param[in] p_common_evt User_mem_request event to be handled.
|
||||
*/
|
||||
static void on_user_mem_request(nrf_ble_qwr_t * p_qwr,
|
||||
ble_common_evt_t const * p_common_evt)
|
||||
{
|
||||
if (p_common_evt->conn_handle == p_qwr->conn_handle)
|
||||
{
|
||||
uint32_t err_code = sd_ble_user_mem_reply(p_common_evt->conn_handle, &p_qwr->mem_buffer);
|
||||
if (err_code == NRF_SUCCESS)
|
||||
{
|
||||
p_qwr->is_user_mem_reply_pending = false;
|
||||
}
|
||||
else if (err_code == NRF_ERROR_BUSY)
|
||||
{
|
||||
p_qwr->is_user_mem_reply_pending = true;
|
||||
}
|
||||
else
|
||||
{
|
||||
p_qwr->error_handler(err_code);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**@brief Handle a prepare write event.
|
||||
*
|
||||
* @param[in] p_qwr QWR structure.
|
||||
* @param[in] p_evt_write WRITE event to be handled.
|
||||
*/
|
||||
static void on_prepare_write(nrf_ble_qwr_t * p_qwr,
|
||||
ble_gatts_evt_write_t const * p_evt_write)
|
||||
{
|
||||
uint32_t err_code;
|
||||
ble_gatts_rw_authorize_reply_params_t auth_reply;
|
||||
memset(&auth_reply, 0, sizeof(auth_reply));
|
||||
|
||||
auth_reply.params.write.gatt_status = NRF_BLE_QWR_REJ_REQUEST_ERR_CODE;
|
||||
auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
|
||||
|
||||
uint32_t i;
|
||||
|
||||
for (i = 0; i < p_qwr->nb_written_handles; i++)
|
||||
{
|
||||
if (p_qwr->written_attr_handles[i] == p_evt_write->handle)
|
||||
{
|
||||
auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (auth_reply.params.write.gatt_status != BLE_GATT_STATUS_SUCCESS)
|
||||
{
|
||||
for (i = 0; i < p_qwr->nb_registered_attr; i++)
|
||||
{
|
||||
if (p_qwr->attr_handles[i] == p_evt_write->handle)
|
||||
{
|
||||
auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
|
||||
p_qwr->written_attr_handles[p_qwr->nb_written_handles++] = p_evt_write->handle;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
// Cancel the current operation.
|
||||
p_qwr->nb_written_handles = 0;
|
||||
|
||||
// Report error to application.
|
||||
p_qwr->error_handler(err_code);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
/**@brief Handle an execute write event.
|
||||
*
|
||||
* @param[in] p_qwr QWR structure.
|
||||
* @param[in] p_evt_write EXEC WRITE event to be handled.
|
||||
*/
|
||||
static void on_execute_write(nrf_ble_qwr_t * p_qwr,
|
||||
ble_gatts_evt_write_t const * p_evt_write)
|
||||
{
|
||||
uint32_t err_code;
|
||||
ble_gatts_rw_authorize_reply_params_t auth_reply;
|
||||
memset(&auth_reply, 0, sizeof(auth_reply));
|
||||
|
||||
auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
|
||||
auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
|
||||
|
||||
if (p_qwr->nb_written_handles == 0)
|
||||
{
|
||||
auth_reply.params.write.gatt_status = NRF_BLE_QWR_REJ_REQUEST_ERR_CODE;
|
||||
err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
// Report error to application.
|
||||
p_qwr->error_handler(err_code);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
for (uint16_t i = 0; i < p_qwr->nb_written_handles; i++)
|
||||
{
|
||||
nrf_ble_qwr_evt_t evt;
|
||||
uint16_t ret_val;
|
||||
|
||||
evt.evt_type = NRF_BLE_QWR_EVT_AUTH_REQUEST;
|
||||
evt.attr_handle = p_qwr->written_attr_handles[i];
|
||||
ret_val = p_qwr->callback(p_qwr, &evt);
|
||||
if (ret_val != BLE_GATT_STATUS_SUCCESS)
|
||||
{
|
||||
auth_reply.params.write.gatt_status = ret_val;
|
||||
}
|
||||
}
|
||||
|
||||
err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
// Report error to application.
|
||||
p_qwr->error_handler(err_code);
|
||||
}
|
||||
|
||||
// If the execute has not been rejected by any of the registered applications, propagate execute write event to all written handles. */
|
||||
if (auth_reply.params.write.gatt_status == BLE_GATT_STATUS_SUCCESS)
|
||||
{
|
||||
for (uint16_t i = 0; i < p_qwr->nb_written_handles; i++)
|
||||
{
|
||||
nrf_ble_qwr_evt_t evt;
|
||||
evt.evt_type = NRF_BLE_QWR_EVT_EXECUTE_WRITE;
|
||||
evt.attr_handle = p_qwr->written_attr_handles[i];
|
||||
/*lint -e534 -save "Ignoring return value of function" */
|
||||
p_qwr->callback(p_qwr, &evt);
|
||||
/*lint -restore*/
|
||||
|
||||
auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
|
||||
}
|
||||
}
|
||||
p_qwr->nb_written_handles = 0;
|
||||
}
|
||||
|
||||
|
||||
/**@brief Handle a cancel write event.
|
||||
*
|
||||
* @param[in] p_qwr QWR structure.
|
||||
* @param[in] p_evt_write EXEC WRITE event to be handled.
|
||||
*/
|
||||
static void on_cancel_write(nrf_ble_qwr_t * p_qwr,
|
||||
ble_gatts_evt_write_t const * p_evt_write)
|
||||
{
|
||||
uint32_t err_code;
|
||||
ble_gatts_rw_authorize_reply_params_t auth_reply;
|
||||
memset(&auth_reply, 0, sizeof(auth_reply));
|
||||
|
||||
auth_reply.type = BLE_GATTS_AUTHORIZE_TYPE_WRITE;
|
||||
auth_reply.params.write.gatt_status = BLE_GATT_STATUS_SUCCESS;
|
||||
|
||||
err_code = sd_ble_gatts_rw_authorize_reply(p_qwr->conn_handle, &auth_reply);
|
||||
if (err_code != NRF_SUCCESS)
|
||||
{
|
||||
// Report error to application.
|
||||
p_qwr->error_handler(err_code);
|
||||
}
|
||||
p_qwr->nb_written_handles = 0;
|
||||
}
|
||||
|
||||
|
||||
/**@brief Handle a rw_authorize_request event.
|
||||
*
|
||||
* @param[in] p_qwr QWR structure.
|
||||
* @param[in] p_gatts_evt RW_authorize_request event to be handled.
|
||||
*/
|
||||
static void on_rw_authorize_request(nrf_ble_qwr_t * p_qwr,
|
||||
ble_gatts_evt_t const * p_gatts_evt)
|
||||
{
|
||||
if (p_gatts_evt->conn_handle != p_qwr->conn_handle)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
ble_gatts_evt_rw_authorize_request_t const * p_auth_req = &p_gatts_evt->params.authorize_request;
|
||||
if (p_auth_req->type != BLE_GATTS_AUTHORIZE_TYPE_WRITE)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
switch (p_auth_req->request.write.op)
|
||||
{
|
||||
case BLE_GATTS_OP_PREP_WRITE_REQ:
|
||||
on_prepare_write(p_qwr, &p_auth_req->request.write);
|
||||
break; // BLE_GATTS_OP_PREP_WRITE_REQ
|
||||
|
||||
case BLE_GATTS_OP_EXEC_WRITE_REQ_NOW:
|
||||
on_execute_write(p_qwr, &p_auth_req->request.write);
|
||||
break; // BLE_GATTS_OP_EXEC_WRITE_REQ_NOW
|
||||
|
||||
case BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL:
|
||||
on_cancel_write(p_qwr, &p_auth_req->request.write);
|
||||
break; // BLE_GATTS_OP_EXEC_WRITE_REQ_CANCEL
|
||||
|
||||
default:
|
||||
// No implementation needed.
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
void nrf_ble_qwr_on_ble_evt(nrf_ble_qwr_t * p_qwr,
|
||||
ble_evt_t * p_ble_evt)
|
||||
{
|
||||
VERIFY_PARAM_NOT_NULL_VOID(p_qwr);
|
||||
VERIFY_PARAM_NOT_NULL_VOID(p_ble_evt);
|
||||
VERIFY_MODULE_INITIALIZED_VOID();
|
||||
|
||||
if (p_qwr->is_user_mem_reply_pending)
|
||||
{
|
||||
on_user_mem_request(p_qwr, &p_ble_evt->evt.common_evt);
|
||||
}
|
||||
|
||||
switch (p_ble_evt->header.evt_id)
|
||||
{
|
||||
case BLE_EVT_USER_MEM_REQUEST:
|
||||
on_user_mem_request(p_qwr, &p_ble_evt->evt.common_evt);
|
||||
break; // BLE_EVT_USER_MEM_REQUEST
|
||||
|
||||
case BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST:
|
||||
on_rw_authorize_request(p_qwr, &p_ble_evt->evt.gatts_evt);
|
||||
break; // BLE_GATTS_EVT_RW_AUTHORIZE_REQUEST
|
||||
|
||||
case BLE_GAP_EVT_DISCONNECTED:
|
||||
if (p_ble_evt->evt.gap_evt.conn_handle == p_qwr->conn_handle)
|
||||
{
|
||||
p_qwr->conn_handle = BLE_CONN_HANDLE_INVALID;
|
||||
p_qwr->nb_written_handles = 0;
|
||||
}
|
||||
break; // BLE_GAP_EVT_DISCONNECTED
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
}
|
||||
#endif // NRF_MODULE_ENABLED(NRF_BLE_QWR)
|
||||
220
SDK/12.3.0_d7731ad/components/ble/nrf_ble_qwr/nrf_ble_qwr.h
Normal file
220
SDK/12.3.0_d7731ad/components/ble/nrf_ble_qwr/nrf_ble_qwr.h
Normal file
@@ -0,0 +1,220 @@
|
||||
/**
|
||||
* Copyright (c) 2016 - 2017, 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 nrf_ble_qwr Queued Writes module
|
||||
* @{
|
||||
* @ingroup ble_sdk_lib
|
||||
* @brief Module for handling Queued Write operations.
|
||||
*
|
||||
* @details This module handles prepare write, execute write, and cancel write
|
||||
* commands. It also manages memory requests related to these operations.
|
||||
*
|
||||
* @note The application must propagate BLE stack events to this module by calling
|
||||
* @ref nrf_ble_qwr_on_ble_evt().
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#ifndef NRF_BLE_QUEUED_WRITES_H__
|
||||
#define NRF_BLE_QUEUED_WRITES_H__
|
||||
|
||||
#include <stdint.h>
|
||||
#include "nordic_common.h"
|
||||
#include "sdk_common.h"
|
||||
#include "ble.h"
|
||||
#include "ble_srv_common.h"
|
||||
|
||||
#ifndef NRF_BLE_QWR_ATTR_LIST_SIZE
|
||||
#define NRF_BLE_QWR_ATTR_LIST_SIZE 10 //!< Maximum number of attribute handles that can be registered. This number must be adjusted according to the number of attributes for which Queued Writes will be enabled.
|
||||
#endif
|
||||
|
||||
#define NRF_BLE_QWR_REJ_REQUEST_ERR_CODE BLE_GATT_STATUS_ATTERR_APP_BEGIN + 0 //!< Error code used by the module to reject prepare write requests on non-registered attributes.
|
||||
|
||||
/**@brief Queued Writes module event types. */
|
||||
typedef enum
|
||||
{
|
||||
NRF_BLE_QWR_EVT_EXECUTE_WRITE, //!< Event that indicates that an execute write command was received for a registered handle and that the received data was actually written and is now ready.
|
||||
NRF_BLE_QWR_EVT_AUTH_REQUEST, //!< Event that indicates that an execute write command was received for a registered handle and that the write request must now be accepted or rejected.
|
||||
} nrf_ble_qwr_evt_type_t;
|
||||
|
||||
|
||||
/**@brief Queued Writes module events. */
|
||||
typedef struct
|
||||
{
|
||||
nrf_ble_qwr_evt_type_t evt_type; //!< Type of the event.
|
||||
uint16_t attr_handle; //!< Handle of the attribute to which the event relates.
|
||||
} nrf_ble_qwr_evt_t;
|
||||
|
||||
|
||||
// Forward declaration of the nrf_ble_qwr_t type.
|
||||
struct nrf_ble_qwr_t;
|
||||
|
||||
/**@brief Queued Writes module event handler type.
|
||||
*
|
||||
* If the provided event is of type @ref NRF_BLE_QWR_EVT_AUTH_REQUEST,
|
||||
* this function must accept or reject the execute write request by returning
|
||||
* one of the @ref BLE_GATT_STATUS_CODES.*/
|
||||
typedef uint16_t (* nrf_ble_qwr_evt_handler_t) (struct nrf_ble_qwr_t * p_qwr,
|
||||
nrf_ble_qwr_evt_t * p_evt);
|
||||
|
||||
|
||||
/**@brief Queued Writes structure.
|
||||
* @details This structure contains status information for the Queued Writes module. */
|
||||
typedef struct nrf_ble_qwr_t
|
||||
{
|
||||
uint8_t initialized; //!< Flag that indicates whether the module has been initialized.
|
||||
uint16_t attr_handles[NRF_BLE_QWR_ATTR_LIST_SIZE]; //!< List of handles for registered attributes, for which the module accepts and handles prepare write operations.
|
||||
uint8_t nb_registered_attr; //!< Number of registered attributes.
|
||||
uint16_t written_attr_handles[NRF_BLE_QWR_ATTR_LIST_SIZE]; //!< List of attribute handles that have been written to during the current prepare write or execute write operation.
|
||||
uint8_t nb_written_handles; //!< Number of attributes that have been written to during the current prepare write or execute write operation.
|
||||
ble_user_mem_block_t mem_buffer; //!< Memory buffer that is provided to the SoftDevice on an ON_USER_MEM_REQUEST event.
|
||||
ble_srv_error_handler_t error_handler; //!< Error handler.
|
||||
bool is_user_mem_reply_pending; //!< Flag that indicates whether a mem_reply is pending (because a previous attempt returned busy).
|
||||
uint16_t conn_handle; //!< Connection handle.
|
||||
nrf_ble_qwr_evt_handler_t callback; //!< Event handler function that is called for events concerning the handles of all registered attributes.
|
||||
} nrf_ble_qwr_t;
|
||||
|
||||
|
||||
/**@brief Queued Writes init structure.
|
||||
* @details This structure contains all information
|
||||
* that is needed to initialize the Queued Writes module. */
|
||||
typedef struct
|
||||
{
|
||||
ble_srv_error_handler_t error_handler; //!< Error handler.
|
||||
ble_user_mem_block_t mem_buffer; //!< Memory buffer that is provided to the SoftDevice on an ON_USER_MEM_REQUEST event.
|
||||
nrf_ble_qwr_evt_handler_t callback; //!< Event handler function that is called for events concerning the handles of all registered attributes.
|
||||
} nrf_ble_qwr_init_t;
|
||||
|
||||
|
||||
/**@brief Function for initializing the Queued Writes module.
|
||||
*
|
||||
* @details Call this function in the main entry of your application to
|
||||
* initialize the Queued Writes module. It must be called only once with a
|
||||
* given Queued Writes structure.
|
||||
*
|
||||
* @param[out] p_qwr Queued Writes structure. This structure must be
|
||||
* supplied by the application. It is initialized by this function
|
||||
* and is later used to identify the particular Queued Writes instance.
|
||||
* @param[in] p_qwr_init Initialization structure.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the Queued Writes module was initialized successfully.
|
||||
* @retval NRF_ERROR_NULL If any of the given pointers is NULL.
|
||||
* @retval NRF_ERROR_INVALID_STATE If the given context has already been initialized.
|
||||
*/
|
||||
ret_code_t nrf_ble_qwr_init(nrf_ble_qwr_t * p_qwr,
|
||||
nrf_ble_qwr_init_t const * p_qwr_init);
|
||||
|
||||
|
||||
/**@brief Function for registering an attribute with the Queued Writes module.
|
||||
*
|
||||
* @details Call this function for each attribute that you want to enable for
|
||||
* Queued Writes (thus a series of prepare write and execute write operations).
|
||||
*
|
||||
* @param[in] p_qwr Queued Writes structure.
|
||||
* @param[in] attr_handle Handle of the attribute to register.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the registration was successful.
|
||||
* @retval NRF_ERROR_NO_MEM If no more memory is available to add this registration.
|
||||
* @retval NRF_ERROR_NULL If any of the given pointers is NULL.
|
||||
* @retval NRF_ERROR_INVALID_STATE If the given context has not been initialized.
|
||||
*/
|
||||
ret_code_t nrf_ble_qwr_attr_register(nrf_ble_qwr_t * p_qwr, uint16_t attr_handle);
|
||||
|
||||
|
||||
/**@brief Function for handling BLE stack events.
|
||||
*
|
||||
* @details Handles all events from the BLE stack that are of interest to the Queued Writes module.
|
||||
*
|
||||
* @param[in] p_qwr Queued Writes structure.
|
||||
* @param[in] p_ble_evt Event received from the BLE stack.
|
||||
*/
|
||||
void nrf_ble_qwr_on_ble_evt(nrf_ble_qwr_t * p_qwr, ble_evt_t * p_ble_evt);
|
||||
|
||||
|
||||
/**@brief Function for retrieving the received data for a given attribute.
|
||||
*
|
||||
* @details Call this function after receiving an @ref NRF_BLE_QWR_EVT_AUTH_REQUEST
|
||||
* event to retrieve a linear copy of the data that was received for the given attribute.
|
||||
*
|
||||
* @param[in] p_qwr Queued Writes structure.
|
||||
* @param[in] attr_handle Handle of the attribute.
|
||||
* @param[out] p_mem Pointer to the application buffer where the received data will be copied.
|
||||
* @param[in,out] p_len Input: length of the input buffer. Output: length of the received data.
|
||||
*
|
||||
*
|
||||
* @retval NRF_SUCCESS If the data was retrieved and stored successfully.
|
||||
* @retval NRF_ERROR_NO_MEM If the provided buffer was smaller than the received data.
|
||||
* @retval NRF_ERROR_NULL If any of the given pointers is NULL.
|
||||
* @retval NRF_ERROR_INVALID_STATE If the given context has not been initialized.
|
||||
*/
|
||||
ret_code_t nrf_ble_qwr_value_get(nrf_ble_qwr_t * p_qwr,
|
||||
uint16_t attr_handle,
|
||||
uint8_t * p_mem,
|
||||
uint16_t * p_len);
|
||||
|
||||
|
||||
/**@brief Function for assigning a connection handle to a given instance of the Queued Writes module.
|
||||
*
|
||||
* @details Call this function when a link with a peer has been established to
|
||||
* associate this link to the instance of the module. This makes it
|
||||
* possible to handle several links and associate each link to a particular
|
||||
* instance of this module.
|
||||
*
|
||||
* @param[in] p_qwr Queued Writes structure.
|
||||
* @param[in] conn_handle Connection handle to be associated with the given Queued Writes instance.
|
||||
*
|
||||
* @retval NRF_SUCCESS If the assignment was successful.
|
||||
* @retval NRF_ERROR_NULL If any of the given pointers is NULL.
|
||||
* @retval NRF_ERROR_INVALID_STATE If the given context has not been initialized.
|
||||
*/
|
||||
ret_code_t nrf_ble_qwr_conn_handle_assign(nrf_ble_qwr_t * p_qwr,
|
||||
uint16_t conn_handle);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif // NRF_BLE_QUEUED_WRITES_H__
|
||||
|
||||
/** @} */
|
||||
Reference in New Issue
Block a user