Merge branch 'refactor/nvs_header_cleanup' into 'master'

Cleanup of NVS copyright notices, header pragma once and NVS related constants

See merge request espressif/esp-idf!42353

Author: rrtandler

components/nvs_flash/host_test/nvs_host_test/main/test_fixtures.hpp

@@ -29,7 +29,7 @@ class PartitionEmulationFixture {
         esp_partition.erase_size = ESP_PARTITION_EMULATED_SECTOR_SIZE;
         esp_partition.type = ESP_PARTITION_TYPE_DATA;
         esp_partition.subtype = ESP_PARTITION_SUBTYPE_DATA_NVS;
-        strncpy(esp_partition.label, partition_name, PART_NAME_MAX_SIZE);
+        strncpy(esp_partition.label, partition_name, NVS_PART_NAME_MAX_SIZE);
         p_part = new (std::nothrow) nvs::NVSPartition(&esp_partition);
         REQUIRE(p_part != nullptr);
     }
@@ -186,7 +186,7 @@ class PartitionEmulationFixture2 : public PartitionEmulationFixture {
         esp_partition2.erase_size = ESP_PARTITION_EMULATED_SECTOR_SIZE;
         esp_partition2.type = ESP_PARTITION_TYPE_DATA;
         esp_partition2.subtype = ESP_PARTITION_SUBTYPE_DATA_NVS;
-        strncpy(esp_partition2.label, partition_name2, PART_NAME_MAX_SIZE);
+        strncpy(esp_partition2.label, partition_name2, NVS_PART_NAME_MAX_SIZE);
         p_part2 = new (std::nothrow) nvs::NVSPartition(&esp_partition2);
         REQUIRE(p_part2 != nullptr);
     }

components/nvs_flash/include/nvs.h

@@ -1,10 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#ifndef ESP_NVS_H
-#define ESP_NVS_H
+#pragma once
 
 #include <stdint.h>
 #include <stddef.h>
@@ -802,5 +801,3 @@ void nvs_release_iterator(nvs_iterator_t iterator);
 #ifdef __cplusplus
 } // extern "C"
 #endif
-
-#endif //ESP_NVS_H

components/nvs_flash/include/nvs_flash.h

@@ -3,8 +3,7 @@
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#ifndef nvs_flash_h
-#define nvs_flash_h
+#pragma once
 
 #ifdef __cplusplus
 extern "C" {
@@ -325,6 +324,3 @@ esp_err_t nvs_flash_read_security_cfg_v2(nvs_sec_scheme_t *scheme_cfg, nvs_sec_c
 #ifdef __cplusplus
 }
 #endif
-
-
-#endif /* nvs_flash_h */

components/nvs_flash/include/nvs_handle.hpp

@@ -1,5 +1,9 @@
-#ifndef NVS_HANDLE_HPP_
-#define NVS_HANDLE_HPP_
+/*
+ * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
 
 #include <string>
 #include <memory>
@@ -307,5 +311,3 @@ esp_err_t NVSHandle::get_item(const char *key, T &value) {
 }
 
 } // nvs
-
-#endif // NVS_HANDLE_HPP_

components/nvs_flash/private_include/nvs_constants.h

@@ -1,12 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#ifndef NVS_CONSTANTS_H
-#define NVS_CONSTANTS_H
-
-#include "spi_flash_mmap.h" // for SPI_FLASH_SEC_SIZE
+#pragma once
 
 // constants for the NVS to be used in the regular as well as bootloader implementations
 
@@ -18,7 +15,7 @@
 #define NVS_CONST_ESB_WRITTEN 0x1
 #define NVS_CONST_ESB_ERASED 0x2
 
-#define NVS_CONST_PAGE_SIZE SPI_FLASH_SEC_SIZE
+#define NVS_CONST_PAGE_SIZE 4096    // Page size is by design assumed to be 4096 bytes
 
 #define NVS_CONST_ENTRY_SIZE 32
 #define NVS_CONST_ENTRY_COUNT 126
@@ -32,6 +29,8 @@
 
 #define NVS_CONST_NVS_VERSION 0xfe // Decrement to upgrade
 
+#define NVS_ENCRYPT_BLOCK_SIZE 16       // Size of the encryption block in bytes
+
 // Page States
 // All bits set, default state after flash erase. Page has not been initialized yet.
 #define NVS_CONST_PAGE_STATE_UNINITIALIZED 0xffffffff
@@ -64,5 +63,3 @@
 #define NVS_CONST_PAGE_HEADER_OFFSET 0
 #define NVS_CONST_PAGE_ENTRY_TABLE_OFFSET (NVS_CONST_PAGE_HEADER_OFFSET + 32)
 #define NVS_CONST_PAGE_ENTRY_DATA_OFFSET (NVS_CONST_PAGE_ENTRY_TABLE_OFFSET + 32)
-
-#endif

components/nvs_flash/private_include/nvs_internal.h

@@ -1,10 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#ifndef NVS_INTERNAL_H
-#define NVS_INTERNAL_H
+#pragma once
 
 #if CONFIG_NVS_ASSERT_ERROR_CHECK
 #define NVS_ASSERT_OR_RETURN(condition, retcode) assert(condition);
@@ -14,5 +13,3 @@
         return retcode;                          \
     }
 #endif // CONFIG_NVS_ASSERT_ERROR_CHECK
-
-#endif // NVS_INTERNAL_H

components/nvs_flash/src/compressed_enum_table.hpp

@@ -1,11 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-
-#ifndef compressed_enum_table_h
-#define compressed_enum_table_h
+#pragma once
 
 #include <cstdint>
 #include <cassert>
@@ -71,5 +69,3 @@ class CompressedEnumTable
     static const uint32_t VALUE_MASK = (1 << Nbits) - 1;
     uint32_t mData[WORD_COUNT];
 };
-
-#endif /* compressed_enum_table_h */

components/nvs_flash/src/intrusive_list.h

@@ -1,10 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
-#ifndef intrusive_list_h
-#define intrusive_list_h
+#pragma once
 
 #include <cassert>
 #include <unordered_map>
@@ -251,6 +250,3 @@ class intrusive_list
     T* mLast = nullptr;
     size_t mSize = 0;
 };
-
-
-#endif /* intrusive_list_h */

components/nvs_flash/src/nvs_encrypted_partition.cpp

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2019-2022 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */

components/nvs_flash/src/nvs_encrypted_partition.hpp

@@ -1,22 +1,12 @@
-// Copyright 2019 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.
-
-#ifndef NVS_ENCRYPTED_PARTITION_HPP_
-#define NVS_ENCRYPTED_PARTITION_HPP_
-
-#include "mbedtls/aes.h"
-#include "nvs_flash.h"
+/*
+ * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+#pragma once
+
+#include "mbedtls/aes.h"        // For mbedtls_aes_xts_context
+#include "nvs_flash.h"          // For nvs_sec_cfg_t
 #include "nvs_partition.hpp"
 
 namespace nvs {
@@ -39,5 +29,3 @@ class NVSEncryptedPartition : public NVSPartition {
 };
 
 } // nvs
-
-#endif // NVS_ENCRYPTED_PARTITION_HPP_