feat: add S3 initial read support

Author: antmak

include/esp-stub-lib/flash.h

@@ -48,6 +48,19 @@ void stub_lib_flash_deinit(const void *state);
 stub_lib_err_t stub_lib_flash_get_info(stub_lib_flash_info_t *info);
 
 void stub_lib_flash_info_print(const stub_lib_flash_info_t *info);
+
+/**
+ * @brief Read data from SPI flash into a buffer.
+ *
+ * @param addr Address to read from. Should be 4 bytes aligned.
+ * @param buffer Destination buffer
+ * @param size Number of bytes to read. Should be 4 bytes aligned.
+ *
+ * @return Result:
+ * - STUB_LIB_OK if success
+ * - STUB_LIB_ERR_FLASH_READ_UNALIGNED
+ * - STUB_LIB_ERR_FLASH_READ_ROM_ERR
+ */
 stub_lib_err_t stub_lib_flash_read_buff(uint32_t addr, void *buffer, uint32_t size);
 stub_lib_err_t stub_lib_flash_write_buff(uint32_t addr, const void *buffer, uint32_t size, int encrypt);
 stub_lib_err_t stub_lib_flash_erase_area(uint32_t addr, uint32_t size);

include/private/stub_lib_err.h

@@ -14,6 +14,8 @@
     X(STUB_LIB_FAIL,                                (STUB_LIB_ERR_END - 1),         "Generic esp-stub-lib failure") \
     \
     X(STUB_LIB_ERR_FLASH_INIT_UNKNOWN_FLASH_ID,     0x1000,                         "Unknown flash size, unknown flash id") \
+    X(STUB_LIB_ERR_FLASH_READ_UNALIGNED,            0x1001,                         "") \
+    X(STUB_LIB_ERR_FLASH_READ_ROM_ERR,              0x1002,                         "") \
 
 // Only numerical values, used in esp-stub-lib sources
 

src/flash.c

@@ -61,3 +61,8 @@ void stub_lib_flash_info_print(const stub_lib_flash_info_t *info)
               info->encrypted
              );
 }
+
+stub_lib_err_t stub_lib_flash_read_buff(uint32_t addr, void *buffer, uint32_t size)
+{
+    return stub_target_flash_read_buff(addr, buffer, size);
+}

src/target/common/include/private/rom_flash.h

@@ -18,6 +18,12 @@ typedef struct esp_rom_spiflash_chip {
     uint32_t status_mask;
 } esp_rom_spiflash_chip_t;
 
+typedef enum {
+    ESP_ROM_SPIFLASH_RESULT_OK,
+    ESP_ROM_SPIFLASH_RESULT_ERR,
+    ESP_ROM_SPIFLASH_RESULT_TIMEOUT
+} esp_rom_spiflash_result_t;
+
 /**
   * @brief SPI Flash init
   *
@@ -65,3 +71,23 @@ extern void esp_rom_spi_flash_update_id(void);
 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);
+
+/**
+  * @brief Read data from Flash
+  *
+  * @param src_addr Address to read from. Should be 4 bytes aligned.
+  * @param buffer Destination buffer
+  * @param size Number of bytes to read. Should be 4 bytes aligned.
+  *
+  * @return Result
+  * - ESP_ROM_SPIFLASH_RESULT_OK
+  * - ESP_ROM_SPIFLASH_RESULT_ERR
+  */
+esp_rom_spiflash_result_t esp_rom_spiflash_read(uint32_t src_addr, uint32_t *dest, int32_t len);
+
+/**
+ * @brief Check if Flash is OPI.
+ *
+ * @return true if eFuse indicates an OPI flash is attached.
+ */
+bool ets_efuse_flash_octal_mode(void);

src/target/common/include/private/rom_flash_config.h

@@ -14,7 +14,27 @@ typedef struct {
     uint8_t sig_matrix;
 } esp_rom_spiflash_legacy_data_t;
 
+typedef struct {
+    uint8_t pp_addr_bit_len;
+    uint8_t se_addr_bit_len;
+    uint8_t be_addr_bit_len;
+    uint8_t rd_addr_bit_len;
+    uint32_t read_sub_len;
+    uint32_t write_sub_len;
+    void* unlock;
+    void* erase_sector;
+    void* erase_block;
+    void* read;
+    void* write;
+    void* encrypt_write;
+    void* check_sus;
+    void* wren;
+    void* wait_idle;
+    void* erase_area;
+} esp_rom_spiflash_legacy_funcs_t;
+
 extern esp_rom_spiflash_legacy_data_t *rom_spiflash_legacy_data;
+extern esp_rom_spiflash_legacy_funcs_t *rom_spiflash_legacy_funcs;
 
 #define g_rom_flashchip (rom_spiflash_legacy_data->chip)
 #define g_rom_spiflash_dummy_len_plus (rom_spiflash_legacy_data->dummy_len_plus)

src/target/common/include/target/flash.h

@@ -8,6 +8,8 @@
 
 #include <stdint.h>
 
+#include <stub_lib_err.h>
+
 struct esp_rom_spiflash_chip;
 
 /**
@@ -49,3 +51,19 @@ void stub_target_flash_update_config(uint32_t flash_id, uint32_t flash_size);
  * - 0 if flash_id is unknown
  */
 uint32_t stub_target_flash_id_to_flash_size(uint32_t flash_id);
+
+/**
+ * @brief Read data.
+ *
+ * Check alignment, call a ROM function.
+ *
+ * @param addr Address to read from. Should be 4 bytes aligned.
+ * @param buffer Destination buffer
+ * @param size Number of bytes to read. Should be 4 bytes aligned.
+ *
+ * @return Result:
+ * - STUB_LIB_OK if success
+ * - STUB_LIB_ERR_FLASH_READ_UNALIGNED
+ * - STUB_LIB_ERR_FLASH_READ_ROM_ERR
+ */
+stub_lib_err_t stub_target_flash_read_buff(uint32_t addr, void *buffer, uint32_t size);

src/target/esp32/src/flash.c

@@ -34,3 +34,12 @@ uint32_t stub_target_flash_get_flash_id(void)
     // TODO: Implement
     return 0;
 }
+
+stub_lib_err_t stub_target_flash_read_buff(uint32_t addr, void *buffer, uint32_t size)
+{
+    (void)addr;
+    (void)buffer;
+    (void)size;
+    // TODO: Implement
+    return STUB_LIB_FAIL;
+}

src/target/esp32c2/src/flash.c

@@ -32,3 +32,12 @@ uint32_t stub_target_flash_get_flash_id(void)
     esp_rom_spi_flash_update_id();
     return stub_target_flash_get_config()->flash_id;
 }
+
+stub_lib_err_t stub_target_flash_read_buff(uint32_t addr, void *buffer, uint32_t size)
+{
+    (void)addr;
+    (void)buffer;
+    (void)size;
+    // TODO: Implement
+    return STUB_LIB_FAIL;
+}

src/target/esp32c3/src/flash.c

@@ -32,3 +32,12 @@ uint32_t stub_target_flash_get_flash_id(void)
     esp_rom_spi_flash_update_id();
     return stub_target_flash_get_config()->flash_id;
 }
+
+stub_lib_err_t stub_target_flash_read_buff(uint32_t addr, void *buffer, uint32_t size)
+{
+    (void)addr;
+    (void)buffer;
+    (void)size;
+    // TODO: Implement
+    return STUB_LIB_FAIL;
+}

src/target/esp32c5/src/flash.c

@@ -32,3 +32,12 @@ uint32_t stub_target_flash_get_flash_id(void)
     esp_rom_spi_flash_update_id();
     return stub_target_flash_get_config()->flash_id;
 }
+
+stub_lib_err_t stub_target_flash_read_buff(uint32_t addr, void *buffer, uint32_t size)
+{
+    (void)addr;
+    (void)buffer;
+    (void)size;
+    // TODO: Implement
+    return STUB_LIB_FAIL;
+}