123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657 |
- /**
- * Copyright (c) 2015 - 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.
- *
- */
- #include "sdk_common.h"
- #if NRF_MODULE_ENABLED(PEER_MANAGER)
- #include "peer_data_storage.h"
- #include <stdint.h>
- #include <string.h>
- #include "sdk_errors.h"
- #include "peer_manager_types.h"
- #include "peer_manager_internal.h"
- #include "peer_id.h"
- #include "fds.h"
- #define NRF_LOG_MODULE_NAME peer_manager_pds
- #if PM_LOG_ENABLED
- #define NRF_LOG_LEVEL PM_LOG_LEVEL
- #define NRF_LOG_INFO_COLOR PM_LOG_INFO_COLOR
- #define NRF_LOG_DEBUG_COLOR PM_LOG_DEBUG_COLOR
- #else
- #define NRF_LOG_LEVEL 0
- #endif // PM_LOG_ENABLED
- #include "nrf_log.h"
- #include "nrf_log_ctrl.h"
- NRF_LOG_MODULE_REGISTER();
- // Macro for verifying that the peer id is within a valid range.
- #define VERIFY_PEER_ID_IN_RANGE(id) VERIFY_FALSE((id >= PM_PEER_ID_N_AVAILABLE_IDS), \
- NRF_ERROR_INVALID_PARAM)
- // Macro for verifying that the peer data id is withing a valid range.
- #define VERIFY_PEER_DATA_ID_IN_RANGE(id) VERIFY_TRUE(peer_data_id_is_valid(id), \
- NRF_ERROR_INVALID_PARAM)
- // The number of registered event handlers.
- #define PDS_EVENT_HANDLERS_CNT (sizeof(m_evt_handlers) / sizeof(m_evt_handlers[0]))
- // Peer Data Storage event handler in Peer Database.
- extern void pdb_pds_evt_handler(pm_evt_t *);
- // Peer Data Storage events' handlers.
- // The number of elements in this array is PDS_EVENT_HANDLERS_CNT.
- static pm_evt_handler_internal_t const m_evt_handlers[] =
- {
- pdb_pds_evt_handler,
- };
- static bool m_module_initialized = false;
- static volatile bool m_peer_delete_deferred = false;
- // A token used for Flash Data Storage searches.
- static fds_find_token_t m_fds_ftok;
- // Function for dispatching events to all registered event handlers.
- static void pds_evt_send(pm_evt_t * p_event)
- {
- p_event->conn_handle = BLE_CONN_HANDLE_INVALID;
- for (uint32_t i = 0; i < PDS_EVENT_HANDLERS_CNT; i++)
- {
- m_evt_handlers[i](p_event);
- }
- }
- // Function to convert peer IDs to file IDs.
- static uint16_t peer_id_to_file_id(pm_peer_id_t peer_id)
- {
- return (uint16_t)(peer_id + PEER_ID_TO_FILE_ID);
- }
- // Function to convert peer data id to type id.
- static pm_peer_id_t file_id_to_peer_id(uint16_t file_id)
- {
- return (pm_peer_id_t)(file_id + FILE_ID_TO_PEER_ID);
- }
- // Function to convert peer data IDs to record keys.
- static uint16_t peer_data_id_to_record_key(pm_peer_data_id_t peer_data_id)
- {
- return (uint16_t)(peer_data_id + DATA_ID_TO_RECORD_KEY);
- }
- // Function to convert record keys to peer data IDs.
- static pm_peer_data_id_t record_key_to_peer_data_id(uint16_t record_key)
- {
- return (pm_peer_data_id_t)(record_key + RECORD_KEY_TO_DATA_ID);
- }
- // Function for checking whether a file ID is relevant for the Peer Manager.
- static bool file_id_within_pm_range(uint16_t file_id)
- {
- return ((PDS_FIRST_RESERVED_FILE_ID <= file_id)
- && (file_id <= PDS_LAST_RESERVED_FILE_ID));
- }
- // Function for checking whether a record key is relevant for the Peer Manager.
- static bool record_key_within_pm_range(uint16_t record_key)
- {
- return ((PDS_FIRST_RESERVED_RECORD_KEY <= record_key)
- && (record_key <= PDS_LAST_RESERVED_RECORD_KEY));
- }
- static bool peer_data_id_is_valid(pm_peer_data_id_t data_id)
- {
- return ((data_id == PM_PEER_DATA_ID_BONDING) ||
- (data_id == PM_PEER_DATA_ID_SERVICE_CHANGED_PENDING) ||
- (data_id == PM_PEER_DATA_ID_GATT_LOCAL) ||
- (data_id == PM_PEER_DATA_ID_GATT_REMOTE) ||
- (data_id == PM_PEER_DATA_ID_PEER_RANK) ||
- (data_id == PM_PEER_DATA_ID_CENTRAL_ADDR_RES) ||
- (data_id == PM_PEER_DATA_ID_APPLICATION));
- }
- /**@brief Function for sending a PM_EVT_ERROR_UNEXPECTED event.
- *
- * @param[in] peer_id The peer the event pertains to.
- * @param[in] err_code The unexpected error that occurred.
- */
- static void send_unexpected_error(pm_peer_id_t peer_id, ret_code_t err_code)
- {
- pm_evt_t error_evt =
- {
- .evt_id = PM_EVT_ERROR_UNEXPECTED,
- .peer_id = peer_id,
- .params =
- {
- .error_unexpected =
- {
- .error = err_code,
- }
- }
- };
- pds_evt_send(&error_evt);
- }
- // Function for deleting all data beloning to a peer.
- // These operations will be sent to FDS one at a time.
- static void peer_data_delete_process()
- {
- ret_code_t ret;
- pm_peer_id_t peer_id;
- uint16_t file_id;
- fds_record_desc_t desc;
- fds_find_token_t ftok;
- m_peer_delete_deferred = false;
- memset(&ftok, 0x00, sizeof(fds_find_token_t));
- peer_id = peer_id_get_next_deleted(PM_PEER_ID_INVALID);
- while ( (peer_id != PM_PEER_ID_INVALID)
- && (fds_record_find_in_file(peer_id_to_file_id(peer_id), &desc, &ftok)
- == FDS_ERR_NOT_FOUND))
- {
- peer_id_free(peer_id);
- peer_id = peer_id_get_next_deleted(peer_id);
- }
- if (peer_id != PM_PEER_ID_INVALID)
- {
- file_id = peer_id_to_file_id(peer_id);
- ret = fds_file_delete(file_id);
- if (ret == FDS_ERR_NO_SPACE_IN_QUEUES)
- {
- m_peer_delete_deferred = true;
- }
- else if (ret != NRF_SUCCESS)
- {
- NRF_LOG_ERROR("Could not delete peer data. fds_file_delete() returned 0x%x for peer_id: %d",
- ret,
- peer_id);
- send_unexpected_error(peer_id, ret);
- }
- }
- }
- static ret_code_t peer_data_find(pm_peer_id_t peer_id,
- pm_peer_data_id_t data_id,
- fds_record_desc_t * const p_desc)
- {
- ret_code_t ret;
- fds_find_token_t ftok;
- NRF_PM_DEBUG_CHECK(peer_id < PM_PEER_ID_N_AVAILABLE_IDS);
- NRF_PM_DEBUG_CHECK(peer_data_id_is_valid(data_id));
- NRF_PM_DEBUG_CHECK(p_desc != NULL);
- memset(&ftok, 0x00, sizeof(fds_find_token_t));
- uint16_t file_id = peer_id_to_file_id(peer_id);
- uint16_t record_key = peer_data_id_to_record_key(data_id);
- ret = fds_record_find(file_id, record_key, p_desc, &ftok);
- if (ret != NRF_SUCCESS)
- {
- return NRF_ERROR_NOT_FOUND;
- }
- return NRF_SUCCESS;
- }
- static void peer_ids_load()
- {
- fds_record_desc_t record_desc;
- fds_flash_record_t record;
- fds_find_token_t ftok;
- memset(&ftok, 0x00, sizeof(fds_find_token_t));
- uint16_t const record_key = peer_data_id_to_record_key(PM_PEER_DATA_ID_BONDING);
- while (fds_record_find_by_key(record_key, &record_desc, &ftok) == NRF_SUCCESS)
- {
- pm_peer_id_t peer_id;
- // It is safe to ignore the return value since the descriptor was
- // just obtained and also 'record' is different from NULL.
- (void)fds_record_open(&record_desc, &record);
- peer_id = file_id_to_peer_id(record.p_header->file_id);
- (void)fds_record_close(&record_desc);
- (void)peer_id_allocate(peer_id);
- }
- }
- static void fds_evt_handler(fds_evt_t const * const p_fds_evt)
- {
- pm_evt_t pds_evt =
- {
- .peer_id = file_id_to_peer_id(p_fds_evt->write.file_id)
- };
- switch (p_fds_evt->id)
- {
- case FDS_EVT_WRITE:
- case FDS_EVT_UPDATE:
- case FDS_EVT_DEL_RECORD:
- if ( file_id_within_pm_range(p_fds_evt->write.file_id)
- || record_key_within_pm_range(p_fds_evt->write.record_key))
- {
- pds_evt.params.peer_data_update_succeeded.data_id
- = record_key_to_peer_data_id(p_fds_evt->write.record_key);
- pds_evt.params.peer_data_update_succeeded.action
- = (p_fds_evt->id == FDS_EVT_DEL_RECORD) ? PM_PEER_DATA_OP_DELETE
- : PM_PEER_DATA_OP_UPDATE;
- pds_evt.params.peer_data_update_succeeded.token = p_fds_evt->write.record_id;
- if (p_fds_evt->result == NRF_SUCCESS)
- {
- pds_evt.evt_id = PM_EVT_PEER_DATA_UPDATE_SUCCEEDED;
- pds_evt.params.peer_data_update_succeeded.flash_changed = true;
- }
- else
- {
- pds_evt.evt_id = PM_EVT_PEER_DATA_UPDATE_FAILED;
- pds_evt.params.peer_data_update_failed.error = p_fds_evt->result;
- }
- pds_evt_send(&pds_evt);
- }
- break;
- case FDS_EVT_DEL_FILE:
- if ( file_id_within_pm_range(p_fds_evt->del.file_id)
- && (p_fds_evt->del.record_key == FDS_RECORD_KEY_DIRTY))
- {
- if (p_fds_evt->result == NRF_SUCCESS)
- {
- pds_evt.evt_id = PM_EVT_PEER_DELETE_SUCCEEDED;
- peer_id_free(pds_evt.peer_id);
- }
- else
- {
- pds_evt.evt_id = PM_EVT_PEER_DELETE_FAILED;
- pds_evt.params.peer_delete_failed.error = p_fds_evt->result;
- }
- m_peer_delete_deferred = true; // Trigger remaining deletes.
- pds_evt_send(&pds_evt);
- }
- break;
- case FDS_EVT_GC:
- if (p_fds_evt->result == NRF_SUCCESS)
- {
- pds_evt.evt_id = PM_EVT_FLASH_GARBAGE_COLLECTED;
- }
- else
- {
- pds_evt.evt_id = PM_EVT_FLASH_GARBAGE_COLLECTION_FAILED;
- pds_evt.params.garbage_collection_failed.error = p_fds_evt->result;
- }
- pds_evt.peer_id = PM_PEER_ID_INVALID;
- pds_evt_send(&pds_evt);
- break;
- default:
- // No action.
- break;
- }
- if (m_peer_delete_deferred)
- {
- peer_data_delete_process();
- }
- }
- ret_code_t pds_init()
- {
- ret_code_t ret;
- // Check for re-initialization if debugging.
- NRF_PM_DEBUG_CHECK(!m_module_initialized);
- ret = fds_register(fds_evt_handler);
- if (ret != NRF_SUCCESS)
- {
- NRF_LOG_ERROR("Could not initialize flash storage. fds_register() returned 0x%x.", ret);
- return NRF_ERROR_INTERNAL;
- }
- ret = fds_init();
- if (ret != NRF_SUCCESS)
- {
- NRF_LOG_ERROR("Could not initialize flash storage. fds_init() returned 0x%x.", ret);
- return NRF_ERROR_STORAGE_FULL;
- }
- peer_id_init();
- peer_ids_load();
- m_module_initialized = true;
- return NRF_SUCCESS;
- }
- ret_code_t pds_peer_data_read(pm_peer_id_t peer_id,
- pm_peer_data_id_t data_id,
- pm_peer_data_t * const p_data,
- uint32_t const * const p_buf_len)
- {
- ret_code_t ret;
- fds_record_desc_t rec_desc;
- fds_flash_record_t rec_flash;
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- NRF_PM_DEBUG_CHECK(p_data != NULL);
- VERIFY_PEER_ID_IN_RANGE(peer_id);
- VERIFY_PEER_DATA_ID_IN_RANGE(data_id);
- ret = peer_data_find(peer_id, data_id, &rec_desc);
- if (ret != NRF_SUCCESS)
- {
- return NRF_ERROR_NOT_FOUND;
- }
- // Shouldn't fail, unless the record was deleted in the meanwhile or the CRC check has failed.
- ret = fds_record_open(&rec_desc, &rec_flash);
- if (ret != NRF_SUCCESS)
- {
- return NRF_ERROR_NOT_FOUND;
- }
- p_data->data_id = data_id;
- p_data->length_words = rec_flash.p_header->length_words;
- // If p_buf_len is NULL, provide a pointer to data in flash, otherwise,
- // check that the buffer is large enough and copy the data in flash into the buffer.
- if (p_buf_len == NULL)
- {
- // The cast is necessary because if no buffer is provided, we just copy the pointer,
- // but in that case it should be considered a pointer to const data by the caller,
- // since it is a pointer to data in flash.
- p_data->p_all_data = (void*)rec_flash.p_data;
- }
- else
- {
- uint32_t const data_len_bytes = (p_data->length_words * sizeof(uint32_t));
- uint32_t const copy_len_bytes = MIN((*p_buf_len), (p_data->length_words * sizeof(uint32_t)));
- memcpy(p_data->p_all_data, rec_flash.p_data, copy_len_bytes);
- if (copy_len_bytes < data_len_bytes)
- {
- return NRF_ERROR_DATA_SIZE;
- }
- }
- // Shouldn't fail unless the record was already closed, in which case it can be ignored.
- (void)fds_record_close(&rec_desc);
- return NRF_SUCCESS;
- }
- void pds_peer_data_iterate_prepare(void)
- {
- memset(&m_fds_ftok, 0x00, sizeof(fds_find_token_t));
- }
- bool pds_peer_data_iterate(pm_peer_data_id_t data_id,
- pm_peer_id_t * const p_peer_id,
- pm_peer_data_flash_t * const p_data)
- {
- ret_code_t ret;
- uint16_t rec_key;
- fds_record_desc_t rec_desc;
- fds_flash_record_t rec_flash;
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- NRF_PM_DEBUG_CHECK(p_peer_id != NULL);
- NRF_PM_DEBUG_CHECK(p_data != NULL);
- VERIFY_PEER_DATA_ID_IN_RANGE(data_id);
- rec_key = peer_data_id_to_record_key(data_id);
- if (fds_record_find_by_key(rec_key, &rec_desc, &m_fds_ftok) != NRF_SUCCESS)
- {
- return false;
- }
- ret = fds_record_open(&rec_desc, &rec_flash);
- if (ret != NRF_SUCCESS)
- {
- // It can only happen if the record was deleted after the call to fds_record_find_by_key(),
- // before we could open it, or if CRC support was enabled in Flash Data Storage at compile
- // time and the CRC check failed.
- return false;
- }
- p_data->data_id = data_id;
- p_data->length_words = rec_flash.p_header->length_words;
- p_data->p_all_data = rec_flash.p_data;
- *p_peer_id = file_id_to_peer_id(rec_flash.p_header->file_id);
- (void)fds_record_close(&rec_desc);
- return true;
- }
- ret_code_t pds_peer_data_store(pm_peer_id_t peer_id,
- pm_peer_data_const_t const * p_peer_data,
- pm_store_token_t * p_store_token)
- {
- ret_code_t ret;
- fds_record_t rec;
- fds_record_desc_t rec_desc;
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- NRF_PM_DEBUG_CHECK(p_peer_data != NULL);
- VERIFY_PEER_ID_IN_RANGE(peer_id);
- VERIFY_PEER_DATA_ID_IN_RANGE(p_peer_data->data_id);
- // Prepare the record to be stored in flash.
- rec.file_id = peer_id_to_file_id(peer_id);
- rec.key = peer_data_id_to_record_key(p_peer_data->data_id);
- rec.data.p_data = (void*)p_peer_data->p_all_data;
- rec.data.length_words = p_peer_data->length_words;
- ret = peer_data_find(peer_id, p_peer_data->data_id, &rec_desc);
- if (ret == NRF_ERROR_NOT_FOUND)
- {
- ret = fds_record_write(&rec_desc, &rec);
- }
- else // NRF_SUCCESS
- {
- // Update existing record.
- ret = fds_record_update(&rec_desc, &rec);
- }
- switch (ret)
- {
- case NRF_SUCCESS:
- if (p_store_token != NULL)
- {
- // Update the store token.
- (void)fds_record_id_from_desc(&rec_desc, (uint32_t*)p_store_token);
- }
- return NRF_SUCCESS;
- case FDS_ERR_BUSY:
- case FDS_ERR_NO_SPACE_IN_QUEUES:
- return NRF_ERROR_BUSY;
- case FDS_ERR_NO_SPACE_IN_FLASH:
- return NRF_ERROR_STORAGE_FULL;
- case FDS_ERR_UNALIGNED_ADDR:
- return NRF_ERROR_INVALID_ADDR;
- default:
- NRF_LOG_ERROR("Could not write data to flash. fds_record_{write|update}() returned 0x%x. "\
- "peer_id: %d",
- ret,
- peer_id);
- return NRF_ERROR_INTERNAL;
- }
- }
- ret_code_t pds_peer_data_delete(pm_peer_id_t peer_id, pm_peer_data_id_t data_id)
- {
- ret_code_t ret;
- fds_record_desc_t record_desc;
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- VERIFY_PEER_ID_IN_RANGE(peer_id);
- VERIFY_PEER_DATA_ID_IN_RANGE(data_id);
- ret = peer_data_find(peer_id, data_id, &record_desc);
- if (ret != NRF_SUCCESS)
- {
- return NRF_ERROR_NOT_FOUND;
- }
- ret = fds_record_delete(&record_desc);
- switch (ret)
- {
- case NRF_SUCCESS:
- return NRF_SUCCESS;
- case FDS_ERR_NO_SPACE_IN_QUEUES:
- return NRF_ERROR_BUSY;
- default:
- NRF_LOG_ERROR("Could not delete peer. fds_record_delete() returned 0x%x. peer_id: %d, "\
- "data_id: %d.",
- ret,
- peer_id,
- data_id);
- return NRF_ERROR_INTERNAL;
- }
- }
- pm_peer_id_t pds_peer_id_allocate(void)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_allocate(PM_PEER_ID_INVALID);
- }
- ret_code_t pds_peer_id_free(pm_peer_id_t peer_id)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- VERIFY_PEER_ID_IN_RANGE(peer_id);
- (void)peer_id_delete(peer_id);
- peer_data_delete_process();
- return NRF_SUCCESS;
- }
- bool pds_peer_id_is_allocated(pm_peer_id_t peer_id)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_is_allocated(peer_id);
- }
- bool pds_peer_id_is_deleted(pm_peer_id_t peer_id)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_is_deleted(peer_id);
- }
- pm_peer_id_t pds_next_peer_id_get(pm_peer_id_t prev_peer_id)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_get_next_used(prev_peer_id);
- }
- pm_peer_id_t pds_next_deleted_peer_id_get(pm_peer_id_t prev_peer_id)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_get_next_deleted(prev_peer_id);
- }
- uint32_t pds_peer_count_get(void)
- {
- NRF_PM_DEBUG_CHECK(m_module_initialized);
- return peer_id_n_ids();
- }
- #endif // NRF_MODULE_ENABLED(PEER_MANAGER)
|