123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530 |
- /**
- * Copyright (c) 2012 - 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.
- *
- */
- /* Attention!
- * To maintain compliance with Nordic Semiconductor ASA's Bluetooth profile
- * qualification listings, this section of source code must not be modified.
- */
- #include "sdk_common.h"
- #if NRF_MODULE_ENABLED(BLE_ANS_C)
- #include "ble_ans_c.h"
- #include <string.h>
- #include <stdbool.h>
- #include "ble_err.h"
- #include "nrf_assert.h"
- #include "ble_db_discovery.h"
- #define NRF_LOG_MODULE_NAME ble_ans_c
- #include "nrf_log.h"
- NRF_LOG_MODULE_REGISTER();
- #define NOTIFICATION_DATA_LENGTH 2 /**< The mandatory length of the notification data. After the mandatory data, the optional message is located. */
- #define READ_DATA_LENGTH_MIN 1 /**< Minimum data length in a valid Alert Notification Read Response message. */
- #define WRITE_MESSAGE_LENGTH 2 /**< Length of the write message for CCCD and control point. */
- /**@brief Function for intercepting GATTC and @ref nrf_ble_gq errors.
- *
- * @param[in] nrf_error Error code.
- * @param[in] p_ctx Parameter from the event handler.
- * @param[in] conn_handle Connection handle.
- */
- static void gatt_error_handler(uint32_t nrf_error,
- void * p_ctx,
- uint16_t conn_handle)
- {
- ble_ans_c_t * p_ans = (ble_ans_c_t *)p_ctx;
- NRF_LOG_DEBUG("A GATT Client error has occurred on conn_handle: 0X%X", conn_handle);
- if (p_ans->error_handler != NULL)
- {
- p_ans->error_handler(nrf_error);
- }
- }
- /** @brief Function for copying a characteristic.
- */
- static void char_set(ble_gattc_char_t * p_dest_char, ble_gattc_char_t const * p_source_char)
- {
- memcpy(p_dest_char, p_source_char, sizeof(ble_gattc_char_t));
- }
- static void char_cccd_set(ble_gattc_desc_t * p_cccd, uint16_t cccd_handle)
- {
- p_cccd->handle = cccd_handle;
- }
- /** @brief Function for checking the presence of all the handles required by the client to use the server.
- */
- static bool is_valid_ans_srv_discovered(ble_ans_c_service_t const * p_srv)
- {
- if ((p_srv->alert_notif_ctrl_point.handle_value == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->suported_new_alert_cat.handle_value == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->suported_unread_alert_cat.handle_value == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->new_alert.handle_value == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->unread_alert_status.handle_value == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->new_alert_cccd.handle == BLE_GATT_HANDLE_INVALID) ||
- (p_srv->unread_alert_cccd.handle == BLE_GATT_HANDLE_INVALID)
- )
- {
- // At least one required characteristic is missing on the server side.
- return false;
- }
- return true;
- }
- void ble_ans_c_on_db_disc_evt(ble_ans_c_t * p_ans, ble_db_discovery_evt_t const * p_evt)
- {
- ble_ans_c_evt_t evt;
- memset(&evt, 0, sizeof(ble_ans_c_evt_t));
- evt.conn_handle = p_evt->conn_handle;
- // Check if the Alert Notification Service is discovered.
- if (p_evt->evt_type == BLE_DB_DISCOVERY_COMPLETE
- &&
- p_evt->params.discovered_db.srv_uuid.uuid == BLE_UUID_ALERT_NOTIFICATION_SERVICE
- &&
- p_evt->params.discovered_db.srv_uuid.type == BLE_UUID_TYPE_BLE)
- {
- // Find the characteristics inside the service.
- for (uint8_t i = 0; i < p_evt->params.discovered_db.char_count; i++)
- {
- ble_gatt_db_char_t const * p_char = &(p_evt->params.discovered_db.charateristics[i]);
- switch (p_char->characteristic.uuid.uuid)
- {
- case BLE_UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR:
- NRF_LOG_DEBUG("Found Ctrlpt \r\n\r");
- char_set(&evt.data.service.alert_notif_ctrl_point, &p_char->characteristic);
- break;
- case BLE_UUID_UNREAD_ALERT_CHAR:
- NRF_LOG_DEBUG("Found Unread Alert \r\n\r");
- char_set(&evt.data.service.unread_alert_status, &p_char->characteristic);
- char_cccd_set(&evt.data.service.unread_alert_cccd,
- p_char->cccd_handle);
- break;
- case BLE_UUID_NEW_ALERT_CHAR:
- NRF_LOG_DEBUG("Found New Alert \r\n\r");
- char_set(&evt.data.service.new_alert, &p_char->characteristic);
- char_cccd_set(&evt.data.service.new_alert_cccd,
- p_char->cccd_handle);
- break;
- case BLE_UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR:
- NRF_LOG_DEBUG("Found supported unread alert category \r\n\r");
- char_set(&evt.data.service.suported_unread_alert_cat, &p_char->characteristic);
- break;
- case BLE_UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR:
- NRF_LOG_DEBUG("Found supported new alert category \r\n\r");
- char_set(&evt.data.service.suported_new_alert_cat, &p_char->characteristic);
- break;
- default:
- // No implementation needed.
- break;
- }
- }
- if (is_valid_ans_srv_discovered(&evt.data.service))
- {
- evt.evt_type = BLE_ANS_C_EVT_DISCOVERY_COMPLETE;
- }
- }
- else if ((p_evt->evt_type == BLE_DB_DISCOVERY_SRV_NOT_FOUND) ||
- (p_evt->evt_type == BLE_DB_DISCOVERY_ERROR))
- {
- evt.evt_type = BLE_ANS_C_EVT_DISCOVERY_FAILED;
- }
- else
- {
- return;
- }
- p_ans->evt_handler(&evt);
- }
- /**@brief Function for receiving and validating notifications received from the central.
- */
- static void event_notify(ble_ans_c_t * p_ans, ble_evt_t const * p_ble_evt)
- {
- uint32_t message_length;
- ble_ans_c_evt_t event;
- ble_ans_alert_notification_t * p_alert = &event.data.alert;
- ble_gattc_evt_hvx_t const * p_notification = &p_ble_evt->evt.gattc_evt.params.hvx;
- // If the message is not valid, then ignore.
- event.evt_type = BLE_ANS_C_EVT_NOTIFICATION;
- if (p_notification->len < NOTIFICATION_DATA_LENGTH)
- {
- return;
- }
- message_length = p_notification->len - NOTIFICATION_DATA_LENGTH;
- if (p_notification->handle == p_ans->service.new_alert.handle_value)
- {
- BLE_UUID_COPY_INST(event.uuid, p_ans->service.new_alert.uuid);
- }
- else if (p_notification->handle == p_ans->service.unread_alert_status.handle_value)
- {
- BLE_UUID_COPY_INST(event.uuid, p_ans->service.unread_alert_status.uuid);
- }
- else
- {
- // Nothing to process.
- return;
- }
- p_alert->alert_category = p_notification->data[0];
- p_alert->alert_category_count = p_notification->data[1]; //lint !e415
- p_alert->alert_msg_length = (message_length > p_ans->message_buffer_size)
- ? p_ans->message_buffer_size
- : message_length;
- p_alert->p_alert_msg_buf = p_ans->p_message_buffer;
- memcpy(p_alert->p_alert_msg_buf,
- &p_notification->data[NOTIFICATION_DATA_LENGTH],
- p_alert->alert_msg_length); //lint !e416
- p_ans->evt_handler(&event);
- }
- /**@brief Function for validating and passing the response to the application,
- * when a read response is received.
- */
- static void event_read_rsp(ble_ans_c_t * p_ans, ble_evt_t const * p_ble_evt)
- {
- ble_ans_c_evt_t event;
- ble_gattc_evt_read_rsp_t const * p_response;
- p_response = &p_ble_evt->evt.gattc_evt.params.read_rsp;
- event.evt_type = BLE_ANS_C_EVT_READ_RESP;
- if (p_response->len < READ_DATA_LENGTH_MIN)
- {
- return;
- }
- if (p_response->handle == p_ans->service.suported_new_alert_cat.handle_value)
- {
- BLE_UUID_COPY_INST(event.uuid, p_ans->service.suported_new_alert_cat.uuid);
- }
- else if (p_response->handle == p_ans->service.suported_unread_alert_cat.handle_value)
- {
- BLE_UUID_COPY_INST(event.uuid, p_ans->service.suported_unread_alert_cat.uuid);
- }
- else
- {
- // If the response is not valid, then ignore.
- return;
- }
- event.data.settings = *(ble_ans_alert_settings_t *)(p_response->data);
- if (p_response->len == READ_DATA_LENGTH_MIN)
- {
- // These variables must default to 0, if they are not returned by central.
- event.data.settings.ans_high_prioritized_alert_support = 0;
- event.data.settings.ans_instant_message_support = 0;
- }
- p_ans->evt_handler(&event);
- }
- /**@brief Function for disconnecting and cleaning the current service.
- */
- static void event_disconnect(ble_ans_c_t * p_ans, ble_evt_t const * p_ble_evt)
- {
- if (p_ans->conn_handle == p_ble_evt->evt.gap_evt.conn_handle)
- {
- p_ans->conn_handle = BLE_CONN_HANDLE_INVALID;
- // Clearing all data for the service also sets all handle values to @ref BLE_GATT_HANDLE_INVALID
- memset(&p_ans->service, 0, sizeof(ble_ans_c_service_t));
- // If there was a valid instance of IAS on the peer, send an event to the
- // application, so that it can do any cleanup related to this module.
- ble_ans_c_evt_t evt;
- evt.evt_type = BLE_ANS_C_EVT_DISCONN_COMPLETE;
- p_ans->evt_handler(&evt);
- }
- }
- /**@brief Function for handling of BLE stack events. */
- void ble_ans_c_on_ble_evt(ble_evt_t const * p_ble_evt, void * p_context)
- {
- ble_ans_c_t * p_ans = (ble_ans_c_t *)p_context;
- switch (p_ble_evt->header.evt_id)
- {
- case BLE_GATTC_EVT_HVX:
- event_notify(p_ans, p_ble_evt);
- break;
- case BLE_GATTC_EVT_READ_RSP:
- event_read_rsp(p_ans, p_ble_evt);
- break;
- case BLE_GAP_EVT_DISCONNECTED:
- event_disconnect(p_ans, p_ble_evt);
- break;
- }
- }
- uint32_t ble_ans_c_init(ble_ans_c_t * p_ans, ble_ans_c_init_t const * p_ans_init)
- {
- VERIFY_PARAM_NOT_NULL(p_ans);
- VERIFY_PARAM_NOT_NULL(p_ans_init);
- VERIFY_PARAM_NOT_NULL(p_ans_init->evt_handler);
- VERIFY_PARAM_NOT_NULL(p_ans_init->p_gatt_queue);
- // Clear all handles.
- memset(p_ans, 0, sizeof(ble_ans_c_t));
- p_ans->conn_handle = BLE_CONN_HANDLE_INVALID;
- p_ans->evt_handler = p_ans_init->evt_handler;
- p_ans->error_handler = p_ans_init->error_handler;
- p_ans->message_buffer_size = p_ans_init->message_buffer_size;
- p_ans->p_message_buffer = p_ans_init->p_message_buffer;
- p_ans->p_gatt_queue = p_ans_init->p_gatt_queue;
- BLE_UUID_BLE_ASSIGN(p_ans->service.service.uuid, BLE_UUID_ALERT_NOTIFICATION_SERVICE);
- BLE_UUID_BLE_ASSIGN(p_ans->service.new_alert.uuid, BLE_UUID_NEW_ALERT_CHAR);
- BLE_UUID_BLE_ASSIGN(p_ans->service.alert_notif_ctrl_point.uuid,
- BLE_UUID_ALERT_NOTIFICATION_CONTROL_POINT_CHAR);
- BLE_UUID_BLE_ASSIGN(p_ans->service.unread_alert_status.uuid, BLE_UUID_UNREAD_ALERT_CHAR);
- BLE_UUID_BLE_ASSIGN(p_ans->service.suported_new_alert_cat.uuid,
- BLE_UUID_SUPPORTED_NEW_ALERT_CATEGORY_CHAR);
- BLE_UUID_BLE_ASSIGN(p_ans->service.suported_unread_alert_cat.uuid,
- BLE_UUID_SUPPORTED_UNREAD_ALERT_CATEGORY_CHAR);
- BLE_UUID_BLE_ASSIGN(p_ans->service.new_alert_cccd.uuid, BLE_UUID_DESCRIPTOR_CLIENT_CHAR_CONFIG);
- BLE_UUID_BLE_ASSIGN(p_ans->service.unread_alert_cccd.uuid,
- BLE_UUID_DESCRIPTOR_CLIENT_CHAR_CONFIG);
- return ble_db_discovery_evt_register(&p_ans->service.service.uuid);
- }
- /**@brief Function for creating a tx message for writing a CCCD.
- */
- static uint32_t cccd_configure(ble_ans_c_t const * const p_ans,
- uint16_t handle_cccd,
- bool notification_enable)
- {
- nrf_ble_gq_req_t cccd_req;
- uint16_t cccd_val = notification_enable ? BLE_GATT_HVX_NOTIFICATION : 0;
- uint8_t cccd[WRITE_MESSAGE_LENGTH];
- memset(&cccd_req, 0, sizeof(nrf_ble_gq_req_t));
- cccd[0] = LSB_16(cccd_val);
- cccd[1] = MSB_16(cccd_val);
- cccd_req.type = NRF_BLE_GQ_REQ_GATTC_WRITE;
- cccd_req.error_handler.cb = gatt_error_handler;
- cccd_req.error_handler.p_ctx = (ble_ans_c_t *)p_ans;
- cccd_req.params.gattc_write.handle = handle_cccd;
- cccd_req.params.gattc_write.len = WRITE_MESSAGE_LENGTH;
- cccd_req.params.gattc_write.p_value = cccd;
- cccd_req.params.gattc_write.offset = 0;
- cccd_req.params.gattc_write.write_op = BLE_GATT_OP_WRITE_REQ;
- return nrf_ble_gq_item_add(p_ans->p_gatt_queue, &cccd_req, p_ans->conn_handle);
- }
- uint32_t ble_ans_c_enable_notif_new_alert(ble_ans_c_t const * p_ans)
- {
- if (p_ans->conn_handle == BLE_CONN_HANDLE_INVALID)
- {
- return NRF_ERROR_INVALID_STATE;
- }
- else
- {
- return cccd_configure(p_ans,
- p_ans->service.new_alert_cccd.handle,
- true);
- }
- }
- uint32_t ble_ans_c_disable_notif_new_alert(ble_ans_c_t const * p_ans)
- {
- return cccd_configure(p_ans,
- p_ans->service.new_alert_cccd.handle,
- false);
- }
- uint32_t ble_ans_c_enable_notif_unread_alert(ble_ans_c_t const * p_ans)
- {
- if ( p_ans->conn_handle == BLE_CONN_HANDLE_INVALID)
- {
- return NRF_ERROR_INVALID_STATE;
- }
- return cccd_configure(p_ans,
- p_ans->service.unread_alert_cccd.handle,
- true);
- }
- uint32_t ble_ans_c_disable_notif_unread_alert(ble_ans_c_t const * p_ans)
- {
- return cccd_configure(p_ans,
- p_ans->service.unread_alert_cccd.handle,
- false);
- }
- uint32_t ble_ans_c_control_point_write(ble_ans_c_t const * p_ans,
- ble_ans_control_point_t const * p_control_point)
- {
- nrf_ble_gq_req_t gq_req;
- uint8_t write_data[WRITE_MESSAGE_LENGTH];
- write_data[0] = p_control_point->command;
- write_data[1] = p_control_point->category;
- memset(&gq_req, 0, sizeof(nrf_ble_gq_req_t));
- gq_req.type = NRF_BLE_GQ_REQ_GATTC_WRITE;
- gq_req.error_handler.cb = gatt_error_handler;
- gq_req.error_handler.p_ctx = (ble_ans_c_t *)p_ans;
- gq_req.params.gattc_write.handle = p_ans->service.alert_notif_ctrl_point.handle_value;
- gq_req.params.gattc_write.len = WRITE_MESSAGE_LENGTH;
- gq_req.params.gattc_write.p_value = write_data;
- gq_req.params.gattc_write.offset = 0;
- gq_req.params.gattc_write.write_op = BLE_GATT_OP_WRITE_REQ;
- return nrf_ble_gq_item_add(p_ans->p_gatt_queue, &gq_req, p_ans->conn_handle);
- }
- uint32_t ble_ans_c_new_alert_read(ble_ans_c_t const * p_ans)
- {
- nrf_ble_gq_req_t gq_req;
- memset(&gq_req, 0, sizeof(nrf_ble_gq_req_t));
- gq_req.type = NRF_BLE_GQ_REQ_GATTC_READ;
- gq_req.error_handler.cb = gatt_error_handler;
- gq_req.error_handler.p_ctx = (ble_ans_c_t *)p_ans;
- gq_req.params.gattc_read.handle = p_ans->service.suported_new_alert_cat.handle_value;
- gq_req.params.gattc_read.offset = 0;
- return nrf_ble_gq_item_add(p_ans->p_gatt_queue, &gq_req, p_ans->conn_handle);
- }
- uint32_t ble_ans_c_unread_alert_read(ble_ans_c_t const * p_ans)
- {
- nrf_ble_gq_req_t gq_req;
- memset(&gq_req, 0, sizeof(nrf_ble_gq_req_t));
- gq_req.type = NRF_BLE_GQ_REQ_GATTC_READ;
- gq_req.error_handler.cb = gatt_error_handler;
- gq_req.error_handler.p_ctx = (ble_ans_c_t *)p_ans;
- gq_req.params.gattc_read.handle = p_ans->service.suported_unread_alert_cat.handle_value;
- gq_req.params.gattc_read.offset = 0;
- return nrf_ble_gq_item_add(p_ans->p_gatt_queue, &gq_req, p_ans->conn_handle);
- }
- uint32_t ble_ans_c_new_alert_notify(ble_ans_c_t const * p_ans, ble_ans_category_id_t category_id)
- {
- ble_ans_control_point_t control_point;
- control_point.command = ANS_NOTIFY_NEW_INCOMING_ALERT_IMMEDIATELY;
- control_point.category = category_id;
- return ble_ans_c_control_point_write(p_ans, &control_point);
- }
- uint32_t ble_ans_c_unread_alert_notify(ble_ans_c_t const * p_ans, ble_ans_category_id_t category_id)
- {
- ble_ans_control_point_t control_point;
- control_point.command = ANS_NOTIFY_UNREAD_CATEGORY_STATUS_IMMEDIATELY;
- control_point.category = category_id;
- return ble_ans_c_control_point_write(p_ans, &control_point);
- }
- uint32_t ble_ans_c_handles_assign(ble_ans_c_t * p_ans,
- uint16_t conn_handle,
- ble_ans_c_service_t const * p_peer_handles)
- {
- VERIFY_PARAM_NOT_NULL(p_ans);
- if (!is_valid_ans_srv_discovered(p_peer_handles))
- {
- return NRF_ERROR_INVALID_PARAM;
- }
- p_ans->conn_handle = conn_handle;
- if (p_peer_handles != NULL)
- {
- // Copy the handles from the discovered characteristics to the provided client instance.
- char_set(&p_ans->service.alert_notif_ctrl_point, &p_peer_handles->alert_notif_ctrl_point);
- char_set(&p_ans->service.suported_new_alert_cat, &p_peer_handles->suported_new_alert_cat);
- char_set(&p_ans->service.suported_unread_alert_cat, &p_peer_handles->suported_unread_alert_cat);
- char_set(&p_ans->service.new_alert, &p_peer_handles->new_alert);
- char_cccd_set(&p_ans->service.new_alert_cccd, p_peer_handles->new_alert_cccd.handle);
- char_set(&p_ans->service.unread_alert_status, &p_peer_handles->unread_alert_status);
- char_cccd_set(&p_ans->service.unread_alert_cccd, p_peer_handles->unread_alert_cccd.handle);
- }
- return nrf_ble_gq_conn_handle_register(p_ans->p_gatt_queue, conn_handle);
- }
- #endif // NRF_MODULE_ENABLED(BLE_ANS_C)
|