/* * Copyright (c) 2015 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 or object form under this license must not be reverse * engineered, decompiled, modified and/or disassembled. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 "gatts_cache_manager.h" #include <string.h> #include "nrf_ble_gap.h" #include "ble_conn_state.h" #include "peer_manager_types.h" #include "peer_manager_internal.h" #include "peer_database.h" #include "id_manager.h" #include "sdk_common.h" #define SYS_ATTR_SYS (BLE_GATTS_SYS_ATTR_FLAG_SYS_SRVCS) /**< Shorthand define for the flag for system attributes. */ #define SYS_ATTR_USR (BLE_GATTS_SYS_ATTR_FLAG_USR_SRVCS) /**< Shorthand define for the flag for user attributes. */ #define SYS_ATTR_BOTH (SYS_ATTR_SYS | SYS_ATTR_USR) /**< Shorthand define for the combined flags for system and user attributes. */ /**@brief Structure containing the module variable(s) of the GSCM module. */ typedef struct { gscm_evt_handler_t evt_handler; /**< The event handler to use for outbound GSCM events. */ pm_peer_id_t current_sc_store_peer_id; } gscm_t; static gscm_t m_gscm = { .current_sc_store_peer_id = PM_PEER_ID_INVALID, }; /**< Instantiation of module variable(s). */ #define MODULE_INITIALIZED (m_gscm.evt_handler != NULL) #include "sdk_macros.h" /**@brief Function for resetting the module variable(s) of the GSCM module. * * @param[out] p_gscm The instance to reset. */ static void internal_state_reset(gscm_t * p_gscm) { memset(p_gscm, 0, sizeof(gscm_t)); p_gscm->current_sc_store_peer_id = PM_PEER_ID_INVALID; } //lint -save -e550 /**@brief Function for storing service_changed_pending = true to flash for all peers, in sequence. * * This function aborts if it gets @ref NRF_ERROR_BUSY when trying to store. A subsequent call will * continue where the last call was aborted. */ static void service_changed_pending_set(void) { VERIFY_MODULE_INITIALIZED_VOID(); static const bool service_changed_pending = true; ret_code_t err_code; //lint -save -e65 -e64 pm_peer_data_const_t peer_data = { .data_id = PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING, .length_words = PM_SC_STATE_N_WORDS(), .p_service_changed_pending = &service_changed_pending, }; //lint -restore err_code = pdb_raw_store(m_gscm.current_sc_store_peer_id, &peer_data, NULL); while((m_gscm.current_sc_store_peer_id != PM_PEER_ID_INVALID) && (err_code != NRF_ERROR_BUSY)) { m_gscm.current_sc_store_peer_id = pdb_next_peer_id_get(m_gscm.current_sc_store_peer_id); err_code = pdb_raw_store(m_gscm.current_sc_store_peer_id, &peer_data, NULL); } } //lint -restore /**@brief Event handler for events from the peer_database module. * * @param[in] p_event The event that has happend with peer id and flags. */ static void pdb_evt_handler(pdb_evt_t const * p_event) { if (p_event->evt_id == PDB_EVT_RAW_STORED) { if (p_event->data_id == PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING) { ret_code_t err_code; pm_peer_data_flash_t peer_data; err_code = pdb_read_buf_get(p_event->peer_id, PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING, &peer_data, NULL); if (err_code == NRF_SUCCESS) { gscm_evt_t gscm_evt; gscm_evt.evt_id = GSCM_EVT_SC_STATE_STORED; gscm_evt.peer_id = p_event->peer_id; gscm_evt.params.sc_state_stored.state = &peer_data.p_service_changed_pending; m_gscm.evt_handler(&gscm_evt); } } } if (m_gscm.current_sc_store_peer_id != PM_PEER_ID_INVALID) { service_changed_pending_set(); } } ret_code_t gscm_init(gscm_evt_handler_t evt_handler) { ret_code_t err_code; if (evt_handler == NULL) { err_code = NRF_ERROR_NULL; } else { err_code = pdb_register(pdb_evt_handler); if (err_code == NRF_SUCCESS) { internal_state_reset(&m_gscm); m_gscm.evt_handler = evt_handler; } } return err_code; } ret_code_t gscm_local_db_cache_update(uint16_t conn_handle) { VERIFY_MODULE_INITIALIZED(); pm_peer_id_t peer_id = im_peer_id_get_by_conn_handle(conn_handle); ret_code_t err_code; if (peer_id == PM_PEER_ID_INVALID) { return BLE_ERROR_INVALID_CONN_HANDLE; } else { pm_peer_data_t peer_data; uint16_t n_bufs = 1; bool retry_with_bigger_buffer = false; do { retry_with_bigger_buffer = false; err_code = pdb_write_buf_get(peer_id, PM_PEER_DATA_ID_GATT_LOCAL, n_bufs++, &peer_data); if (err_code == NRF_SUCCESS) { pm_peer_data_local_gatt_db_t * p_local_gatt_db = peer_data.p_local_gatt_db; p_local_gatt_db->flags = SYS_ATTR_BOTH; err_code = sd_ble_gatts_sys_attr_get(conn_handle, &p_local_gatt_db->data[0], &p_local_gatt_db->len, p_local_gatt_db->flags); if (err_code == NRF_SUCCESS) { err_code = pdb_write_buf_store(peer_id, PM_PEER_DATA_ID_GATT_LOCAL); } else { if (err_code == NRF_ERROR_DATA_SIZE) { // The sys attributes are bigger than the requested write buffer. retry_with_bigger_buffer = true; } else if (err_code == NRF_ERROR_NOT_FOUND) { // There are no sys attributes in the GATT db, so nothing needs to be stored. err_code = NRF_SUCCESS; } ret_code_t err_code_release = pdb_write_buf_release(peer_id, PM_PEER_DATA_ID_GATT_LOCAL); if (err_code_release != NRF_SUCCESS) { err_code = NRF_ERROR_INTERNAL; } } } else if (err_code == NRF_ERROR_INVALID_PARAM) { // The sys attributes are bigger than the entire write buffer. err_code = NRF_ERROR_DATA_SIZE; } } while (retry_with_bigger_buffer); } return err_code; } ret_code_t gscm_local_db_cache_apply(uint16_t conn_handle) { VERIFY_MODULE_INITIALIZED(); pm_peer_id_t peer_id = im_peer_id_get_by_conn_handle(conn_handle); ret_code_t err_code; pm_peer_data_flash_t peer_data; uint8_t const * p_sys_attr_data = NULL; uint16_t sys_attr_len = 0; uint32_t sys_attr_flags = (SYS_ATTR_BOTH); bool all_attributes_applied = true; if (peer_id != PM_PEER_ID_INVALID) { err_code = pdb_read_buf_get(peer_id, PM_PEER_DATA_ID_GATT_LOCAL, &peer_data, NULL); if (err_code == NRF_SUCCESS) { pm_peer_data_local_gatt_db_t const * p_local_gatt_db; p_local_gatt_db = peer_data.p_local_gatt_db; p_sys_attr_data = p_local_gatt_db->data; sys_attr_len = p_local_gatt_db->len; sys_attr_flags = p_local_gatt_db->flags; } } do { err_code = sd_ble_gatts_sys_attr_set(conn_handle, p_sys_attr_data, sys_attr_len, sys_attr_flags); if (err_code == NRF_ERROR_NO_MEM) { err_code = NRF_ERROR_BUSY; } else if (err_code == NRF_ERROR_INVALID_STATE) { err_code = NRF_SUCCESS; } else if (err_code == NRF_ERROR_INVALID_DATA) { all_attributes_applied = false; if (sys_attr_flags & SYS_ATTR_USR) { // Try setting only system attributes. sys_attr_flags = SYS_ATTR_SYS; } else if (p_sys_attr_data || sys_attr_len) { // Try reporting that none exist. p_sys_attr_data = NULL; sys_attr_len = 0; sys_attr_flags = SYS_ATTR_BOTH; } else { err_code = NRF_ERROR_INTERNAL; } } } while (err_code == NRF_ERROR_INVALID_DATA); if (!all_attributes_applied) { err_code = NRF_ERROR_INVALID_DATA; } return err_code; } ret_code_t gscm_local_db_cache_set(pm_peer_id_t peer_id, pm_peer_data_local_gatt_db_t * p_local_db) { VERIFY_MODULE_INITIALIZED(); pm_peer_data_const_t peer_data; memset(&peer_data, 0, sizeof(pm_peer_data_const_t)); peer_data.data_id = PM_PEER_DATA_ID_GATT_LOCAL; peer_data.p_local_gatt_db = p_local_db; return pdb_raw_store(peer_id, &peer_data, NULL); } ret_code_t gscm_local_db_cache_get(pm_peer_id_t peer_id, pm_peer_data_local_gatt_db_t * p_local_db) { VERIFY_MODULE_INITIALIZED(); pm_peer_data_t peer_data; memset(&peer_data, 0, sizeof(pm_peer_data_t)); peer_data.p_local_gatt_db = p_local_db; return pdb_raw_read(peer_id, PM_PEER_DATA_ID_GATT_LOCAL, &peer_data); } void gscm_local_database_has_changed(void) { VERIFY_MODULE_INITIALIZED_VOID(); m_gscm.current_sc_store_peer_id = pdb_next_peer_id_get(PM_PEER_ID_INVALID); service_changed_pending_set(); } bool gscm_service_changed_ind_needed(uint16_t conn_handle) { ret_code_t err_code; pm_peer_data_flash_t peer_data; pm_peer_id_t peer_id = im_peer_id_get_by_conn_handle(conn_handle); err_code = pdb_read_buf_get(peer_id, PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING, &peer_data, NULL); if (err_code != NRF_SUCCESS) { return false; } return &peer_data.p_service_changed_pending; } ret_code_t gscm_service_changed_ind_send(uint16_t conn_handle) { static uint16_t start_handle = 0x0000; const uint16_t end_handle = 0xFFFF; ret_code_t err_code; do { err_code = sd_ble_gatts_service_changed(conn_handle, start_handle, end_handle); if (err_code == BLE_ERROR_INVALID_ATTR_HANDLE) { start_handle += 1; } } while (err_code == BLE_ERROR_INVALID_ATTR_HANDLE); return err_code; } void gscm_db_change_notification_done(pm_peer_id_t peer_id) { VERIFY_MODULE_INITIALIZED_VOID(); static const bool service_changed_pending = false; //lint -save -e65 -e64 pm_peer_data_const_t peer_data = { .data_id = PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING, .length_words = PM_SC_STATE_N_WORDS(), .p_service_changed_pending = &service_changed_pending, }; //lint -restore // Don't need to check return code, because all error conditions can be ignored. //lint -save -e550 (void) pdb_raw_store(peer_id, &peer_data, NULL); //lint -restore }