add detect chip with get security info

Author: brianignacio5

src/esploader.ts

@@ -9,8 +9,16 @@ import { IEspLoaderTerminal } from "./types/loaderTerminal.js";
 import { LoaderOptions } from "./types/loaderOptions.js";
 import { FlashOptions } from "./types/flashOptions.js";
 import { After, Before } from "./types/resetModes.js";
+import { ROM_LIST } from "./targets/index.js";
 
-type FlashReadCallback = ((packet: Uint8Array, progress: number, totalSize: number) => void) | null;
+/**
+ * Callback function type for handling packets received during flash memory read operations.
+ * @callback FlashReadCallback
+ * @param {Uint8Array} packet - The data packet received from the flash memory.
+ * @param {number} progress - The current progress of the read operation in bytes.
+ * @param {number} totalSize - The total size of the data to be read in bytes.
+ */
+export type FlashReadCallback = ((packet: Uint8Array, progress: number, totalSize: number) => void) | null;
 
 /**
  * Return the chip ROM based on the given magic number
@@ -96,6 +104,8 @@ export class ESPLoader {
   ESP_FLASH_DEFL_END = 0x12;
   ESP_SPI_FLASH_MD5 = 0x13;
 
+  ESP_GET_SECURITY_INFO = 0x14;
+
   // Only Stub supported commands
   ESP_ERASE_FLASH = 0xd0;
   ESP_ERASE_REGION = 0xd1;
@@ -389,8 +399,9 @@ export class ESPLoader {
         if (op == null || opRet == op) {
           return [val, data];
         } else if (data[0] != 0 && data[1] == this.ROM_INVALID_RECV_MSG) {
-          await this.flushInput();
-          throw new ESPError("unsupported command error");
+          this.debug("read_packet unsupported command error " + op);
+          // await this.flushInput();
+          throw new ESPError("unsupported command error " + op);
         }
       }
     }
@@ -629,7 +640,7 @@ export class ESPLoader {
     this.debug("Connect attempt successful.");
     this.info("\n\r", false);
 
-    if (detecting) {
+    if (!detecting) {
       const chipMagicValue = (await this.readReg(this.CHIP_DETECT_MAGIC_REG_ADDR)) >>> 0;
       this.debug("Chip Magic " + chipMagicValue.toString(16));
       const chip = await magic2Chip(chipMagicValue);
@@ -641,17 +652,49 @@ export class ESPLoader {
     }
   }
 
+  /**
+   * Get the CHIP ID with ESP_GET_SECURITY_INFO check command.
+   * @returns {number} Chip ID number
+   */
+  async getChipId(): Promise<number | undefined> {
+    const response = await this.checkCommand("get security info", this.ESP_GET_SECURITY_INFO, new Uint8Array(0));
+
+    this.debug("get_chip_id " + response.toString(16));
+
+    if (response instanceof Uint8Array && response.length > 16) {
+      const chipId = response[12] | (response[13] << 8) | (response[14] << 16) | (response[15] << 24);
+      return chipId;
+    }
+    return;
+  }
+
   /**
    * Connect and detect the existing chip.
    * @param {string} mode Reset mode to use for connection.
+   * @param {number} attempts - Number of connection attempts
    */
-  async detectChip(mode: Before = "default_reset") {
+  async detectChip(mode: Before = "default_reset", attempts = 7) {
     await this.connect(mode);
-    this.info("Detecting chip type... ", false);
+    try {
+      this.info("Detecting chip type... ");
+      const chipID = await this.getChipId();
+      const filteredROMList = ROM_LIST.filter(
+        (n) => n.CHIP_NAME !== "ESP8266" && n.CHIP_NAME !== "ESP32" && n.CHIP_NAME !== "ESP32-S2",
+      );
+      for (const cls of filteredROMList) {
+        if (chipID === cls.IMAGE_CHIP_ID) {
+          this.chip = cls;
+          break;
+        }
+      }
+    } catch (error) {
+      await this.transport.disconnect();
+      await this.connect(mode, attempts, false);
+    }
     if (this.chip != null) {
       this.info(this.chip.CHIP_NAME);
     } else {
-      this.info("unknown!");
+      this.info("unknown chip! detectchip has failed.");
     }
   }
 
@@ -1091,6 +1134,16 @@ export class ESPLoader {
     return strmd5;
   }
 
+  /**
+   * Read data from flash memory of the chip.
+   * This function reads a specified amount of data from the flash memory starting at a given address.
+   * It sends a read command to the chip and processes the response packets until the requested size is read.
+   * @param {number} addr - The starting address in flash memory to read from.
+   * @param {number} size - The number of bytes to read from flash memory.
+   * @param {FlashReadCallback} onPacketReceived - Optional callback function to handle each received packet.
+   * @returns {Promise<Uint8Array>} A promise that resolves to the data read from flash memory as a Uint8Array.
+   * @throws {ESPError} If the read operation fails or an unexpected response is received.
+   */
   async readFlash(addr: number, size: number, onPacketReceived: FlashReadCallback = null) {
     let pkt = this._appendArray(this._intToByteArray(addr), this._intToByteArray(size));
     pkt = this._appendArray(pkt, this._intToByteArray(0x1000));

src/index.ts

@@ -1,11 +1,12 @@
-export { ESPLoader } from "./esploader.js";
+export { ESPLoader, FlashReadCallback } from "./esploader.js";
 export {
   ClassicReset,
   CustomReset,
   HardReset,
   UsbJtagSerialReset,
   validateCustomResetStringSequence,
   ResetConstructors,
+  ResetStrategy,
 } from "./reset.js";
 export { ROM } from "./targets/rom.js";
 export { Transport, SerialOptions } from "./webserial.js";

src/targets/esp8266.ts

@@ -33,6 +33,7 @@ export class ESP8266ROM extends ROM {
   public SPI_USR2_OFFS = 0x24;
   public SPI_MOSI_DLEN_OFFS = 0; // not in esp8266
   public SPI_MISO_DLEN_OFFS = 0; // not in esp8266
+  public IMAGE_CHIP_ID = 9999; // not in esp8266
   public SPI_W0_OFFS = 0x40;
 
   public async readEfuse(loader: ESPLoader, offset: number): Promise<number> {

src/targets/index.ts

@@ -0,0 +1,28 @@
+import { ESP32ROM } from "./esp32";
+import { ESP32C2ROM } from "./esp32c2";
+import { ESP32C3ROM } from "./esp32c3";
+import { ESP32C5ROM } from "./esp32c5";
+import { ESP32C6ROM } from "./esp32c6";
+import { ESP32C61ROM } from "./esp32c61";
+import { ESP32H2ROM } from "./esp32h2";
+import { ESP32P4ROM } from "./esp32p4";
+import { ESP32S2ROM } from "./esp32s2";
+import { ESP32S3ROM } from "./esp32s3";
+import { ESP8266ROM } from "./esp8266";
+
+export const CHIP_DEFS = {
+  esp8266: new ESP8266ROM(),
+  esp32: new ESP32ROM(),
+  esp32s2: new ESP32S2ROM(),
+  esp32s3: new ESP32S3ROM(),
+  esp32c3: new ESP32C3ROM(),
+  esp32c2: new ESP32C2ROM(),
+  esp32c6: new ESP32C6ROM(),
+  esp32c61: new ESP32C61ROM(),
+  esp32c5: new ESP32C5ROM(),
+  esp32h2: new ESP32H2ROM(),
+  esp32p4: new ESP32P4ROM(),
+};
+
+export const CHIP_LIST = Object.keys(CHIP_DEFS) as Array<keyof typeof CHIP_DEFS>;
+export const ROM_LIST = Object.values(CHIP_DEFS);

src/targets/rom.ts

@@ -83,7 +83,7 @@ export abstract class ROM {
   // abstract EFUSE_RD_REG_BASE: number; //esp32
 
   abstract FLASH_WRITE_SIZE: number;
-  // abstract IMAGE_CHIP_ID: number; // not in esp8266
+  abstract IMAGE_CHIP_ID: number; // not in esp8266
   abstract SPI_MOSI_DLEN_OFFS: number; // not in esp8266
   abstract SPI_MISO_DLEN_OFFS: number; // not in esp8266
   abstract SPI_REG_BASE: number;

src/webserial.ts

@@ -244,7 +244,7 @@ class Transport {
   }
 
   async flushInput() {
-    if (this.reader && !(await this.reader.closed)) {
+    if (this.reader) {
       await this.reader.cancel();
       this.reader.releaseLock();
       this.reader = this.device.readable?.getReader();