From 26800ed71e287f51666874e83b5dae782cc11e52 Mon Sep 17 00:00:00 2001 From: Ivan Grokhotkov Date: Sat, 27 Jul 2019 10:27:38 +0200 Subject: [PATCH] global: update note in the partition tables The build system automatically determines offsets of partitions from the partition table, so no manual changes are needed. Instead, add a note that partition offsets may need to be updated when increasing the bootloader size. --- components/fatfs/test_fatfs_host/partition_table.csv | 2 +- components/partition_table/partitions_singleapp.csv | 2 +- components/partition_table/partitions_singleapp_coredump.csv | 2 +- components/partition_table/partitions_two_ota.csv | 2 +- components/partition_table/partitions_two_ota_coredump.csv | 2 +- components/spiffs/test_spiffs_host/partition_table.csv | 2 +- components/wear_levelling/test_wl_host/partition_table.csv | 2 +- docs/en/api-guides/bootloader.rst | 2 +- docs/en/api-guides/core_dump.rst | 2 +- .../bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/partitions.csv | 2 +- examples/build_system/cmake/import_lib/partitions_example.csv | 2 +- examples/ethernet/iperf/partitions_example.csv | 2 +- examples/peripherals/i2c/i2c_tools/partitions_example.csv | 2 +- examples/peripherals/i2s_adc_dac/partitions_adc_dac_example.csv | 2 +- .../protocols/http_server/file_serving/partitions_example.csv | 2 +- .../protocols/http_server/restful_server/partitions_example.csv | 2 +- examples/provisioning/ble_prov/partitions.csv | 2 +- examples/provisioning/manager/partitions.csv | 2 +- examples/storage/partition_api/partition_find/README.md | 2 +- .../storage/partition_api/partition_find/partitions_example.csv | 2 +- .../storage/partition_api/partition_mmap/partitions_example.csv | 2 +- .../storage/partition_api/partition_ops/partitions_example.csv | 2 +- examples/storage/parttool/partitions_example.csv | 2 +- examples/storage/spiffs/partitions_example.csv | 2 +- examples/storage/spiffsgen/partitions_example.csv | 2 +- examples/storage/wear_levelling/partitions_example.csv | 2 +- examples/system/console/partitions_example.csv | 2 +- examples/wifi/simple_sniffer/partitions_example.csv | 2 +- tools/unit-test-app/partition_table_unit_test_app.csv | 2 +- 29 files changed, 29 insertions(+), 29 deletions(-) diff --git a/components/fatfs/test_fatfs_host/partition_table.csv b/components/fatfs/test_fatfs_host/partition_table.csv index cb7fccd87b..9b4dbd1ba5 100644 --- a/components/fatfs/test_fatfs_host/partition_table.csv +++ b/components/fatfs/test_fatfs_host/partition_table.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/components/partition_table/partitions_singleapp.csv b/components/partition_table/partitions_singleapp.csv index 22cf97bacb..5156e827b4 100644 --- a/components/partition_table/partitions_singleapp.csv +++ b/components/partition_table/partitions_singleapp.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, , 0x6000, phy_init, data, phy, , 0x1000, factory, app, factory, , 1M, diff --git a/components/partition_table/partitions_singleapp_coredump.csv b/components/partition_table/partitions_singleapp_coredump.csv index 8bcf89c20f..bbb55e2b47 100644 --- a/components/partition_table/partitions_singleapp_coredump.csv +++ b/components/partition_table/partitions_singleapp_coredump.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, , 0x6000 phy_init, data, phy, , 0x1000 factory, app, factory, , 1M diff --git a/components/partition_table/partitions_two_ota.csv b/components/partition_table/partitions_two_ota.csv index 0a325b2f5a..7aee909cd1 100644 --- a/components/partition_table/partitions_two_ota.csv +++ b/components/partition_table/partitions_two_ota.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, , 0x4000, otadata, data, ota, , 0x2000, phy_init, data, phy, , 0x1000, diff --git a/components/partition_table/partitions_two_ota_coredump.csv b/components/partition_table/partitions_two_ota_coredump.csv index 3a2143690b..2e1af0eca6 100644 --- a/components/partition_table/partitions_two_ota_coredump.csv +++ b/components/partition_table/partitions_two_ota_coredump.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, , 0x4000 otadata, data, ota, , 0x2000 phy_init, data, phy, , 0x1000 diff --git a/components/spiffs/test_spiffs_host/partition_table.csv b/components/spiffs/test_spiffs_host/partition_table.csv index d02771b51b..3c2903a70d 100644 --- a/components/spiffs/test_spiffs_host/partition_table.csv +++ b/components/spiffs/test_spiffs_host/partition_table.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/components/wear_levelling/test_wl_host/partition_table.csv b/components/wear_levelling/test_wl_host/partition_table.csv index af5bc831eb..f6383e46d4 100644 --- a/components/wear_levelling/test_wl_host/partition_table.csv +++ b/components/wear_levelling/test_wl_host/partition_table.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/docs/en/api-guides/bootloader.rst b/docs/en/api-guides/bootloader.rst index aea98d6c91..2671b353fc 100644 --- a/docs/en/api-guides/bootloader.rst +++ b/docs/en/api-guides/bootloader.rst @@ -33,7 +33,7 @@ Partitions of type "app" cannot be specified here. Partition table.:: # Name, Type, SubType, Offset, Size, Flags - # Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild + # Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x4000 otadata, data, ota, 0xd000, 0x2000 phy_init, data, phy, 0xf000, 0x1000 diff --git a/docs/en/api-guides/core_dump.rst b/docs/en/api-guides/core_dump.rst index c590efeea7..f96d4e2cb0 100644 --- a/docs/en/api-guides/core_dump.rst +++ b/docs/en/api-guides/core_dump.rst @@ -37,7 +37,7 @@ allocates necessary space on flash, But if user wants to use its own layout file as it is shown below:: # Name, Type, SubType, Offset, Size - # Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild + # Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000 phy_init, data, phy, 0xf000, 0x1000 factory, app, factory, 0x10000, 1M diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/partitions.csv b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/partitions.csv index 96141670f3..24200e5b33 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/partitions.csv +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/partitions.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 16k otadata, data, ota, 0xd000, 8k phy_init, data, phy, 0xf000, 4k diff --git a/examples/build_system/cmake/import_lib/partitions_example.csv b/examples/build_system/cmake/import_lib/partitions_example.csv index 3e9543311e..3337f31642 100644 --- a/examples/build_system/cmake/import_lib/partitions_example.csv +++ b/examples/build_system/cmake/import_lib/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/ethernet/iperf/partitions_example.csv b/examples/ethernet/iperf/partitions_example.csv index 7e28b5668c..ac18e080c8 100644 --- a/examples/ethernet/iperf/partitions_example.csv +++ b/examples/ethernet/iperf/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/peripherals/i2c/i2c_tools/partitions_example.csv b/examples/peripherals/i2c/i2c_tools/partitions_example.csv index 7e28b5668c..ac18e080c8 100644 --- a/examples/peripherals/i2c/i2c_tools/partitions_example.csv +++ b/examples/peripherals/i2c/i2c_tools/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/peripherals/i2s_adc_dac/partitions_adc_dac_example.csv b/examples/peripherals/i2s_adc_dac/partitions_adc_dac_example.csv index c9a081314e..85bc43e33c 100644 --- a/examples/peripherals/i2s_adc_dac/partitions_adc_dac_example.csv +++ b/examples/peripherals/i2s_adc_dac/partitions_adc_dac_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/protocols/http_server/file_serving/partitions_example.csv b/examples/protocols/http_server/file_serving/partitions_example.csv index 6d9ee2e745..0eebc192ae 100644 --- a/examples/protocols/http_server/file_serving/partitions_example.csv +++ b/examples/protocols/http_server/file_serving/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/protocols/http_server/restful_server/partitions_example.csv b/examples/protocols/http_server/restful_server/partitions_example.csv index ca4898e596..a5b16e199b 100644 --- a/examples/protocols/http_server/restful_server/partitions_example.csv +++ b/examples/protocols/http_server/restful_server/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/provisioning/ble_prov/partitions.csv b/examples/provisioning/ble_prov/partitions.csv index e382463f94..d01414b8a9 100644 --- a/examples/provisioning/ble_prov/partitions.csv +++ b/examples/provisioning/ble_prov/partitions.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1200000, diff --git a/examples/provisioning/manager/partitions.csv b/examples/provisioning/manager/partitions.csv index e382463f94..d01414b8a9 100644 --- a/examples/provisioning/manager/partitions.csv +++ b/examples/provisioning/manager/partitions.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1200000, diff --git a/examples/storage/partition_api/partition_find/README.md b/examples/storage/partition_api/partition_find/README.md index 03b71cbc5c..a05152850e 100644 --- a/examples/storage/partition_api/partition_find/README.md +++ b/examples/storage/partition_api/partition_find/README.md @@ -20,7 +20,7 @@ The iterator is obtained using `esp_partition_find` and is released after its us I (310) example: Printing partition table csv file contents for reference... # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/partition_api/partition_find/partitions_example.csv b/examples/storage/partition_api/partition_find/partitions_example.csv index a0ff092cc1..f3c3b68e56 100644 --- a/examples/storage/partition_api/partition_find/partitions_example.csv +++ b/examples/storage/partition_api/partition_find/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/partition_api/partition_mmap/partitions_example.csv b/examples/storage/partition_api/partition_mmap/partitions_example.csv index 52a5fce840..a70efe6a75 100644 --- a/examples/storage/partition_api/partition_mmap/partitions_example.csv +++ b/examples/storage/partition_api/partition_mmap/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/partition_api/partition_ops/partitions_example.csv b/examples/storage/partition_api/partition_ops/partitions_example.csv index 52a5fce840..a70efe6a75 100644 --- a/examples/storage/partition_api/partition_ops/partitions_example.csv +++ b/examples/storage/partition_api/partition_ops/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/parttool/partitions_example.csv b/examples/storage/parttool/partitions_example.csv index f76d1ca37a..f49ae3c602 100644 --- a/examples/storage/parttool/partitions_example.csv +++ b/examples/storage/parttool/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/spiffs/partitions_example.csv b/examples/storage/spiffs/partitions_example.csv index 6d9ee2e745..0eebc192ae 100644 --- a/examples/storage/spiffs/partitions_example.csv +++ b/examples/storage/spiffs/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/spiffsgen/partitions_example.csv b/examples/storage/spiffsgen/partitions_example.csv index 6d9ee2e745..0eebc192ae 100644 --- a/examples/storage/spiffsgen/partitions_example.csv +++ b/examples/storage/spiffsgen/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/storage/wear_levelling/partitions_example.csv b/examples/storage/wear_levelling/partitions_example.csv index 7e28b5668c..ac18e080c8 100644 --- a/examples/storage/wear_levelling/partitions_example.csv +++ b/examples/storage/wear_levelling/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/system/console/partitions_example.csv b/examples/system/console/partitions_example.csv index 7e28b5668c..ac18e080c8 100644 --- a/examples/system/console/partitions_example.csv +++ b/examples/system/console/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/examples/wifi/simple_sniffer/partitions_example.csv b/examples/wifi/simple_sniffer/partitions_example.csv index 7e28b5668c..ac18e080c8 100644 --- a/examples/wifi/simple_sniffer/partitions_example.csv +++ b/examples/wifi/simple_sniffer/partitions_example.csv @@ -1,5 +1,5 @@ # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x6000, phy_init, data, phy, 0xf000, 0x1000, factory, app, factory, 0x10000, 1M, diff --git a/tools/unit-test-app/partition_table_unit_test_app.csv b/tools/unit-test-app/partition_table_unit_test_app.csv index f4bd924310..948f00c5c1 100644 --- a/tools/unit-test-app/partition_table_unit_test_app.csv +++ b/tools/unit-test-app/partition_table_unit_test_app.csv @@ -1,7 +1,7 @@ # Special partition table for unit test app # # Name, Type, SubType, Offset, Size, Flags -# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild +# Note: if you have increased the bootloader size, make sure to update the offsets to avoid overlap nvs, data, nvs, 0x9000, 0x4000 otadata, data, ota, 0xd000, 0x2000 phy_init, data, phy, 0xf000, 0x1000