change: rename Device ID to Flash ID for better semantic

Author: antmak

include/common/flash_impl_get_id_from_rom.h

@@ -14,7 +14,7 @@
 #include <target/soc_impl.h>
 
 /**
-  * @brief Sets the correct device_id in the flash config from SPI_MEM_FLASH_RDID in ROM code
+  * @brief Sets the correct flash_id in the flash config from SPI_MEM_FLASH_RDID in ROM code
   *
   */
 extern void esp_rom_spi_flash_update_id(void);
@@ -36,20 +36,20 @@ __attribute__((always_inline)) inline static
 uint32_t flash_impl_get_id_from_rom(void)
 {
     esp_rom_spi_flash_update_id();
-    return stub_target_rom_get_flash_config()->device_id;
+    return stub_target_rom_get_flash_config()->flash_id;
 }
 
 uint32_t stub_target_flash_get_flash_id(void)
 {
     // TODO: remove dev tracing
-    STUB_LOG_TRACEF("Uninit ROM's flash_id: 0x%x\n", stub_target_rom_get_flash_config()->device_id);
+    STUB_LOG_TRACEF("Uninit ROM's flash_id: 0x%x\n", stub_target_rom_get_flash_config()->flash_id);
 
     // TODO: it's just for development. remove this option then
     uint32_t rdid = flash_impl_get_id_from_rdid_reg();
     (void)rdid;
-    STUB_LOG_TRACEF("Device ID: 0x%x (from SPI RDID)\n", rdid);
+    STUB_LOG_TRACEF("Flash ID: 0x%x (from SPI RDID)\n", rdid);
 
     uint32_t id = flash_impl_get_id_from_rom();
-    STUB_LOG_TRACEF("Device ID: 0x%x (from ROM code)\n", stub_target_rom_get_flash_config()->device_id);
+    STUB_LOG_TRACEF("Flash ID: 0x%x (from ROM code)\n", stub_target_rom_get_flash_config()->flash_id);
     return id;
 }

include/common/target_rom.h

@@ -15,15 +15,15 @@
 #define STUB_FLASH_STATUS_MASK          0xFFFF
 
 typedef struct esp_rom_spiflash_chip {
-    uint32_t device_id;
+    uint32_t flash_id;
     uint32_t chip_size;    // chip size in bytes
     uint32_t block_size;
     uint32_t sector_size;
     uint32_t page_size;
     uint32_t status_mask;
 } esp_rom_spiflash_chip_t;
 
-extern int esp_rom_spiflash_config_param(uint32_t device_id, uint32_t chip_size,
+extern int esp_rom_spiflash_config_param(uint32_t flash_id, uint32_t chip_size,
                                          uint32_t block_size, uint32_t sector_size,
                                          uint32_t page_size, uint32_t status_mask);
 

src/esp32/src/target_flash.c

@@ -148,8 +148,8 @@ void stub_target_flash_init(void)
 uint32_t stub_target_flash_get_flash_id(void)
 {
     // TODO: remove dev tracing
-    STUB_LOG_TRACEF("Uninit g_rom_flashchip.device_id: 0x%x\n", g_rom_flashchip.device_id);
+    STUB_LOG_TRACEF("Uninit g_rom_flashchip.flash_id: 0x%x\n", g_rom_flashchip.flash_id);
     uint32_t id = get_id_from_rdid_cmd();
-    STUB_LOG_TRACEF("Device ID: 0x%x (from SPI RDID)\n", id);
+    STUB_LOG_TRACEF("Flash ID: 0x%x (from SPI RDID)\n", id);
     return id;
 }

src/flash.c

@@ -13,12 +13,12 @@
 #include <target/rom_impl.h> // corresponding implementation for common/target_rom.h
 #include <target/flash_impl.h> // corresponding implementation for common/target_flash.h
 
-static uint32_t device_id_to_flash_size(uint32_t device_id)
+static uint32_t flash_id_to_flash_size(uint32_t flash_id)
 {
     // TODO: remove dev tracing
-    STUB_LOG_TRACEF("device_id: 0x%x\n", device_id);
+    STUB_LOG_TRACEF("flash_id: 0x%x\n", flash_id);
 
-    const uint32_t id = device_id & 0xff;
+    const uint32_t id = flash_id & 0xff;
     switch (id) {
     case 0x12:  // 256 KB
     case 0x13:
@@ -36,7 +36,7 @@ static uint32_t device_id_to_flash_size(uint32_t device_id)
         return 32 * 1024 * 1024;
     }
 
-    STUB_LOGE("Unknown device_id! 0x%x", device_id);
+    STUB_LOGE("Unknown flash_id! 0x%x", flash_id);
     return 0;
 }
 
@@ -47,11 +47,11 @@ void stub_lib_flash_init(void **state)
     // TODO: check if we don't need the first initialization?
     // how we can check - only via EXTMEM_ICACHE_ENABLE?
     stub_target_flash_init();
-    // TODO: check if we should use "flash_id" instead of "device_id" (see the IDF's bootloader_flash and the esptool's legacy stub)
-    const uint32_t device_id = stub_target_flash_get_flash_id();
-    const uint32_t flash_size = device_id_to_flash_size(device_id);
+    // TODO: check if we should use "flash_id" instead of "flash_id" (see the IDF's bootloader_flash and the esptool's legacy stub)
+    const uint32_t flash_id = stub_target_flash_get_flash_id();
+    const uint32_t flash_size = flash_id_to_flash_size(flash_id);
     STUB_LOG_TRACEF("Flash size: %d MB\n", flash_size / (1024 * 1024));
-    stub_target_rom_update_flash_config(device_id, flash_size);
+    stub_target_rom_update_flash_config(flash_id, flash_size);
     STUB_LOG_TRACEF("config_param has been set\n");
 }
 
@@ -64,7 +64,7 @@ void stub_lib_flash_get_info(stub_lib_flash_info_t *info)
 {
     const esp_rom_spiflash_chip_t * chip = stub_target_rom_get_flash_config();
 
-    info->id = chip->device_id;
+    info->id = chip->flash_id;
     info->size = chip->chip_size;
     info->block_size = chip->block_size;
     info->sector_size = chip->sector_size;