// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #include "nvs.hpp" #include "nvs_flash.h" #include "nvs_storage.hpp" #include "intrusive_list.h" #include "nvs_platform.hpp" #include "esp_partition.h" #include "sdkconfig.h" #ifdef CONFIG_NVS_ENCRYPTION #include "nvs_encr.hpp" #endif #ifdef ESP_PLATFORM #include // Uncomment this line to force output from this module // #define LOG_LOCAL_LEVEL ESP_LOG_DEBUG #include "esp_log.h" static const char* TAG = "nvs"; #else #include "crc.h" #define ESP_LOGD(...) #endif extern "C" void nvs_dump(const char *partName); extern "C" esp_err_t nvs_flash_init_custom(const char *partName, uint32_t baseSector, uint32_t sectorCount); #ifdef CONFIG_NVS_ENCRYPTION extern "C" esp_err_t nvs_flash_secure_init_custom(const char *partName, uint32_t baseSector, uint32_t sectorCount, nvs_sec_cfg_t* cfg); #endif class HandleEntry : public intrusive_list_node { static uint32_t s_nvs_next_handle; public: HandleEntry() {} HandleEntry(bool readOnly, uint8_t nsIndex, nvs::Storage* StoragePtr) : mHandle(++s_nvs_next_handle), // Begin the handle value with 1 mReadOnly(readOnly), mNsIndex(nsIndex), mStoragePtr(StoragePtr) { } nvs_handle mHandle; uint8_t mReadOnly; uint8_t mNsIndex; nvs::Storage* mStoragePtr; }; #ifdef ESP_PLATFORM SemaphoreHandle_t nvs::Lock::mSemaphore = NULL; #endif using namespace std; using namespace nvs; static intrusive_list s_nvs_handles; uint32_t HandleEntry::s_nvs_next_handle; static intrusive_list s_nvs_storage_list; static nvs::Storage* lookup_storage_from_name(const char *name) { auto it = find_if(begin(s_nvs_storage_list), end(s_nvs_storage_list), [=](Storage& e) -> bool { return (strcmp(e.getPartName(), name) == 0); }); if (it == end(s_nvs_storage_list)) { return NULL; } return it; } extern "C" void nvs_dump(const char *partName) { Lock lock; nvs::Storage* pStorage; pStorage = lookup_storage_from_name(partName); if (pStorage == NULL) { return; } pStorage->debugDump(); return; } extern "C" esp_err_t nvs_flash_init_custom(const char *partName, uint32_t baseSector, uint32_t sectorCount) { ESP_LOGD(TAG, "nvs_flash_init_custom partition=%s start=%d count=%d", partName, baseSector, sectorCount); nvs::Storage* new_storage = NULL; nvs::Storage* storage = lookup_storage_from_name(partName); if (storage == NULL) { new_storage = new nvs::Storage((const char *)partName); storage = new_storage; } esp_err_t err = storage->init(baseSector, sectorCount); if (new_storage != NULL) { if (err == ESP_OK) { s_nvs_storage_list.push_back(new_storage); } else { delete new_storage; } } return err; } #ifdef CONFIG_NVS_ENCRYPTION extern "C" esp_err_t nvs_flash_secure_init_custom(const char *partName, uint32_t baseSector, uint32_t sectorCount, nvs_sec_cfg_t* cfg) { ESP_LOGD(TAG, "nvs_flash_secure_init_custom partition=%s start=%d count=%d", partName, baseSector, sectorCount); if(cfg) { auto encrMgr = EncrMgr::getInstance(); auto err = encrMgr->setSecurityContext(baseSector, sectorCount, cfg); if(err != ESP_OK) { return err; } } return nvs_flash_init_custom(partName, baseSector, sectorCount); } #endif #ifdef ESP_PLATFORM extern "C" esp_err_t nvs_flash_init_partition(const char *part_name) { Lock::init(); Lock lock; nvs::Storage* mStorage; mStorage = lookup_storage_from_name(part_name); if (mStorage) { return ESP_OK; } const esp_partition_t* partition = esp_partition_find_first( ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, part_name); if (partition == NULL) { return ESP_ERR_NOT_FOUND; } return nvs_flash_init_custom(part_name, partition->address / SPI_FLASH_SEC_SIZE, partition->size / SPI_FLASH_SEC_SIZE); } extern "C" esp_err_t nvs_flash_init(void) { return nvs_flash_init_partition(NVS_DEFAULT_PART_NAME); } #ifdef CONFIG_NVS_ENCRYPTION extern "C" esp_err_t nvs_flash_secure_init_partition(const char *part_name, nvs_sec_cfg_t* cfg) { Lock::init(); Lock lock; nvs::Storage* mStorage; mStorage = lookup_storage_from_name(part_name); if (mStorage) { return ESP_OK; } const esp_partition_t* partition = esp_partition_find_first( ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, part_name); if (partition == NULL) { return ESP_ERR_NOT_FOUND; } return nvs_flash_secure_init_custom(part_name, partition->address / SPI_FLASH_SEC_SIZE, partition->size / SPI_FLASH_SEC_SIZE, cfg); } extern "C" esp_err_t nvs_flash_secure_init(nvs_sec_cfg_t* cfg) { return nvs_flash_secure_init_partition(NVS_DEFAULT_PART_NAME, cfg); } #endif extern "C" esp_err_t nvs_flash_erase_partition(const char *part_name) { const esp_partition_t* partition = esp_partition_find_first( ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_NVS, part_name); if (partition == NULL) { return ESP_ERR_NOT_FOUND; } return esp_partition_erase_range(partition, 0, partition->size); } extern "C" esp_err_t nvs_flash_erase() { return nvs_flash_erase_partition(NVS_DEFAULT_PART_NAME); } #endif // ESP_PLATFORM extern "C" esp_err_t nvs_flash_deinit_partition(const char* partition_name) { Lock::init(); Lock lock; nvs::Storage* storage = lookup_storage_from_name(partition_name); if (!storage) { return ESP_ERR_NVS_NOT_INITIALIZED; } #ifdef CONFIG_NVS_ENCRYPTION if(EncrMgr::isEncrActive()) { auto encrMgr = EncrMgr::getInstance(); encrMgr->removeSecurityContext(storage->getBaseSector()); } #endif /* Clean up handles related to the storage being deinitialized */ auto it = s_nvs_handles.begin(); auto next = it; while(it != s_nvs_handles.end()) { next++; if (it->mStoragePtr == storage) { ESP_LOGD(TAG, "Deleting handle %d (ns=%d) related to partition \"%s\" (missing call to nvs_close?)", it->mHandle, it->mNsIndex, partition_name); s_nvs_handles.erase(it); delete static_cast(it); } it = next; } /* Finally delete the storage itself */ s_nvs_storage_list.erase(storage); delete storage; return ESP_OK; } extern "C" esp_err_t nvs_flash_deinit(void) { return nvs_flash_deinit_partition(NVS_DEFAULT_PART_NAME); } static esp_err_t nvs_find_ns_handle(nvs_handle handle, HandleEntry& entry) { auto it = find_if(begin(s_nvs_handles), end(s_nvs_handles), [=](HandleEntry& e) -> bool { return e.mHandle == handle; }); if (it == end(s_nvs_handles)) { return ESP_ERR_NVS_INVALID_HANDLE; } entry = *it; return ESP_OK; } extern "C" esp_err_t nvs_open_from_partition(const char *part_name, const char* name, nvs_open_mode open_mode, nvs_handle *out_handle) { Lock lock; ESP_LOGD(TAG, "%s %s %d", __func__, name, open_mode); uint8_t nsIndex; nvs::Storage* sHandle; sHandle = lookup_storage_from_name(part_name); if (sHandle == NULL) { return ESP_ERR_NVS_PART_NOT_FOUND; } esp_err_t err = sHandle->createOrOpenNamespace(name, open_mode == NVS_READWRITE, nsIndex); if (err != ESP_OK) { return err; } HandleEntry *handle_entry = new HandleEntry(open_mode==NVS_READONLY, nsIndex, sHandle); s_nvs_handles.push_back(handle_entry); *out_handle = handle_entry->mHandle; return ESP_OK; } extern "C" esp_err_t nvs_open(const char* name, nvs_open_mode open_mode, nvs_handle *out_handle) { if (s_nvs_storage_list.size() == 0) { return ESP_ERR_NVS_NOT_INITIALIZED; } return nvs_open_from_partition(NVS_DEFAULT_PART_NAME, name, open_mode, out_handle); } extern "C" void nvs_close(nvs_handle handle) { Lock lock; ESP_LOGD(TAG, "%s %d", __func__, handle); auto it = find_if(begin(s_nvs_handles), end(s_nvs_handles), [=](HandleEntry& e) -> bool { return e.mHandle == handle; }); if (it == end(s_nvs_handles)) { return; } s_nvs_handles.erase(it); delete static_cast(it); } extern "C" esp_err_t nvs_erase_key(nvs_handle handle, const char* key) { Lock lock; ESP_LOGD(TAG, "%s %s\r\n", __func__, key); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } if (entry.mReadOnly) { return ESP_ERR_NVS_READ_ONLY; } return entry.mStoragePtr->eraseItem(entry.mNsIndex, key); } extern "C" esp_err_t nvs_erase_all(nvs_handle handle) { Lock lock; ESP_LOGD(TAG, "%s\r\n", __func__); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } if (entry.mReadOnly) { return ESP_ERR_NVS_READ_ONLY; } return entry.mStoragePtr->eraseNamespace(entry.mNsIndex); } template static esp_err_t nvs_set(nvs_handle handle, const char* key, T value) { Lock lock; ESP_LOGD(TAG, "%s %s %d %d", __func__, key, sizeof(T), (uint32_t) value); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } if (entry.mReadOnly) { return ESP_ERR_NVS_READ_ONLY; } return entry.mStoragePtr->writeItem(entry.mNsIndex, key, value); } extern "C" esp_err_t nvs_set_i8 (nvs_handle handle, const char* key, int8_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_u8 (nvs_handle handle, const char* key, uint8_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_i16 (nvs_handle handle, const char* key, int16_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_u16 (nvs_handle handle, const char* key, uint16_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_i32 (nvs_handle handle, const char* key, int32_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_u32 (nvs_handle handle, const char* key, uint32_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_i64 (nvs_handle handle, const char* key, int64_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_set_u64 (nvs_handle handle, const char* key, uint64_t value) { return nvs_set(handle, key, value); } extern "C" esp_err_t nvs_commit(nvs_handle handle) { Lock lock; // no-op for now, to be used when intermediate cache is added HandleEntry entry; return nvs_find_ns_handle(handle, entry); } extern "C" esp_err_t nvs_set_str(nvs_handle handle, const char* key, const char* value) { Lock lock; ESP_LOGD(TAG, "%s %s %s", __func__, key, value); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } return entry.mStoragePtr->writeItem(entry.mNsIndex, nvs::ItemType::SZ, key, value, strlen(value) + 1); } extern "C" esp_err_t nvs_set_blob(nvs_handle handle, const char* key, const void* value, size_t length) { Lock lock; ESP_LOGD(TAG, "%s %s %d", __func__, key, length); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } return entry.mStoragePtr->writeItem(entry.mNsIndex, nvs::ItemType::BLOB, key, value, length); } template static esp_err_t nvs_get(nvs_handle handle, const char* key, T* out_value) { Lock lock; ESP_LOGD(TAG, "%s %s %d", __func__, key, sizeof(T)); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } return entry.mStoragePtr->readItem(entry.mNsIndex, key, *out_value); } extern "C" esp_err_t nvs_get_i8 (nvs_handle handle, const char* key, int8_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_u8 (nvs_handle handle, const char* key, uint8_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_i16 (nvs_handle handle, const char* key, int16_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_u16 (nvs_handle handle, const char* key, uint16_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_i32 (nvs_handle handle, const char* key, int32_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_u32 (nvs_handle handle, const char* key, uint32_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_i64 (nvs_handle handle, const char* key, int64_t* out_value) { return nvs_get(handle, key, out_value); } extern "C" esp_err_t nvs_get_u64 (nvs_handle handle, const char* key, uint64_t* out_value) { return nvs_get(handle, key, out_value); } static esp_err_t nvs_get_str_or_blob(nvs_handle handle, nvs::ItemType type, const char* key, void* out_value, size_t* length) { Lock lock; ESP_LOGD(TAG, "%s %s", __func__, key); HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } size_t dataSize; err = entry.mStoragePtr->getItemDataSize(entry.mNsIndex, type, key, dataSize); if (err != ESP_OK) { return err; } if (length == nullptr) { return ESP_ERR_NVS_INVALID_LENGTH; } else if (out_value == nullptr) { *length = dataSize; return ESP_OK; } else if (*length < dataSize) { *length = dataSize; return ESP_ERR_NVS_INVALID_LENGTH; } *length = dataSize; return entry.mStoragePtr->readItem(entry.mNsIndex, type, key, out_value, dataSize); } extern "C" esp_err_t nvs_get_str(nvs_handle handle, const char* key, char* out_value, size_t* length) { return nvs_get_str_or_blob(handle, nvs::ItemType::SZ, key, out_value, length); } extern "C" esp_err_t nvs_get_blob(nvs_handle handle, const char* key, void* out_value, size_t* length) { return nvs_get_str_or_blob(handle, nvs::ItemType::BLOB, key, out_value, length); } extern "C" esp_err_t nvs_get_stats(const char* part_name, nvs_stats_t* nvs_stats) { Lock lock; nvs::Storage* pStorage; if (nvs_stats == NULL) { return ESP_ERR_INVALID_ARG; } nvs_stats->used_entries = 0; nvs_stats->free_entries = 0; nvs_stats->total_entries = 0; nvs_stats->namespace_count = 0; pStorage = lookup_storage_from_name((part_name == NULL) ? NVS_DEFAULT_PART_NAME : part_name); if (pStorage == NULL) { return ESP_ERR_NVS_NOT_INITIALIZED; } if(!pStorage->isValid()){ return ESP_ERR_NVS_INVALID_STATE; } return pStorage->fillStats(*nvs_stats); } extern "C" esp_err_t nvs_get_used_entry_count(nvs_handle handle, size_t* used_entries) { Lock lock; if(used_entries == NULL){ return ESP_ERR_INVALID_ARG; } *used_entries = 0; HandleEntry entry; auto err = nvs_find_ns_handle(handle, entry); if (err != ESP_OK) { return err; } size_t used_entry_count; err = entry.mStoragePtr->calcEntriesInNamespace(entry.mNsIndex, used_entry_count); if(err == ESP_OK){ *used_entries = used_entry_count; } return err; } #if (defined CONFIG_NVS_ENCRYPTION) && (defined ESP_PLATFORM) extern "C" esp_err_t nvs_flash_generate_keys(const esp_partition_t* partition, nvs_sec_cfg_t* cfg) { auto err = esp_partition_erase_range(partition, 0, partition->size); if(err != ESP_OK) { return err; } for(uint8_t cnt = 0; cnt < NVS_KEY_SIZE; cnt++) { cfg->eky[cnt] = 0xff; cfg->tky[cnt] = 0xee; } err = spi_flash_write(partition->address, cfg->eky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = spi_flash_write(partition->address + NVS_KEY_SIZE, cfg->tky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = esp_partition_read(partition, 0, cfg->eky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = esp_partition_read(partition, NVS_KEY_SIZE, cfg->tky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } uint32_t crc_calc = crc32_le(0xffffffff, cfg->eky, NVS_KEY_SIZE); crc_calc = crc32_le(crc_calc, cfg->tky, NVS_KEY_SIZE); uint8_t crc_wr[16]; memset(crc_wr, 0xff, sizeof(crc_wr)); memcpy(crc_wr, &crc_calc, 4); err = esp_partition_write(partition, 2 * NVS_KEY_SIZE, crc_wr, sizeof(crc_wr)); if(err != ESP_OK) { return err; } return ESP_OK; } extern "C" esp_err_t nvs_flash_read_security_cfg(const esp_partition_t* partition, nvs_sec_cfg_t* cfg) { uint8_t eky_raw[NVS_KEY_SIZE], tky_raw[NVS_KEY_SIZE]; uint32_t crc_raw, crc_read, crc_calc; auto err = spi_flash_read(partition->address, eky_raw, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = spi_flash_read(partition->address + NVS_KEY_SIZE, tky_raw, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = spi_flash_read(partition->address + 2 * NVS_KEY_SIZE, &crc_raw, 4); if(err != ESP_OK) { return err; } uint8_t cnt = 0; while(cnt < NVS_KEY_SIZE && eky_raw[cnt] == 0xff && tky_raw[cnt] == 0xff) cnt++; if(cnt == NVS_KEY_SIZE && crc_raw == 0xffffffff) { /* This is an uninitialized key partition*/ return ESP_ERR_NVS_KEYS_NOT_INITIALIZED; } err = esp_partition_read(partition, 0, cfg->eky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = esp_partition_read(partition, NVS_KEY_SIZE, cfg->tky, NVS_KEY_SIZE); if(err != ESP_OK) { return err; } err = esp_partition_read(partition, 2 * NVS_KEY_SIZE, &crc_read, 4); if(err != ESP_OK) { return err; } crc_calc = crc32_le(0xffffffff, cfg->eky, NVS_KEY_SIZE); crc_calc = crc32_le(crc_calc, cfg->tky, NVS_KEY_SIZE); if(crc_calc != crc_read) { return ESP_ERR_NVS_CORRUPT_KEY_PART; } return ESP_OK; } #endif