node-ch347 0.0.1

package/dist/flash.d.ts

@@ -0,0 +1,134 @@
+/**
+ * CH347 SPI Flash Programmer
+ *
+ * Supports common SPI flash chips (W25Qxx, GD25Qxx, MX25Lxx, etc.)
+ */
+import { CH347SPI } from './spi';
+import { FlashInfo, FlashProgressCallback } from './types';
+export declare class CH347Flash {
+    private spi;
+    private flashInfo;
+    constructor(spi: CH347SPI);
+    /**
+     * Read JEDEC ID from flash chip
+     */
+    readJedecId(): Promise<FlashInfo>;
+    /**
+     * Read SFDP (Serial Flash Discoverable Parameters) data
+     * @param address 24-bit address in SFDP space
+     * @param length Number of bytes to read
+     */
+    readSFDP(address: number, length: number): Promise<Buffer>;
+    /**
+     * Estimate erase timeout based on block size
+     */
+    private estimateEraseTimeout;
+    /**
+     * Read and parse SFDP Basic Flash Parameter Table
+     * Populates flashInfo with discovered erase types and page size
+     */
+    private readSFDPBasicParams;
+    /**
+     * Read status register
+     */
+    readStatus(): Promise<number>;
+    /**
+     * Wait for flash to be ready (WIP bit cleared)
+     */
+    waitReady(timeoutMs?: number): Promise<void>;
+    /**
+     * Enable write operations
+     */
+    writeEnable(): Promise<void>;
+    /**
+     * Disable write operations
+     */
+    writeDisable(): Promise<void>;
+    /**
+     * Read data from flash
+     */
+    read(address: number, length: number, onProgress?: FlashProgressCallback): Promise<Buffer>;
+    /**
+     * Write a single page (up to 256 bytes)
+     */
+    private writePage;
+    /**
+     * Write data to flash (handles page boundaries)
+     */
+    write(address: number, data: Buffer, onProgress?: FlashProgressCallback): Promise<void>;
+    /**
+     * Erase a 4KB sector
+     */
+    eraseSector(address: number): Promise<void>;
+    /**
+     * Erase a 32KB block
+     */
+    eraseBlock32K(address: number): Promise<void>;
+    /**
+     * Erase a 64KB block
+     */
+    eraseBlock64K(address: number): Promise<void>;
+    /**
+     * Erase entire chip
+     */
+    eraseChip(onProgress?: FlashProgressCallback): Promise<void>;
+    /**
+     * Erase using a specific erase type (from SFDP discovery)
+     */
+    private eraseWithType;
+    /**
+     * Get default erase types (fallback when SFDP not available)
+     */
+    private getDefaultEraseTypes;
+    /**
+     * Erase range (uses optimal erase commands from SFDP or defaults)
+     */
+    eraseRange(address: number, length: number, onProgress?: FlashProgressCallback): Promise<void>;
+    /**
+     * Verify data matches flash contents
+     */
+    verify(address: number, data: Buffer, onProgress?: FlashProgressCallback): Promise<boolean>;
+    /**
+     * Check if a sector needs to be erased to write new data
+     * Flash can only program 1→0, so we need to erase if any bit needs to go 0→1
+     */
+    private sectorNeedsErase;
+    /**
+     * Check if a sector has any changes
+     */
+    private sectorHasChanges;
+    /**
+     * Program flash (smart erase + write + verify)
+     * Only erases and writes sectors that have actual changes
+     */
+    program(address: number, data: Buffer, options?: {
+        erase?: boolean;
+        verify?: boolean;
+        onProgress?: FlashProgressCallback;
+    }): Promise<boolean>;
+    /**
+     * Program flash from a binary file
+     * @param filePath Path to the binary file to write
+     * @param address Starting address in flash (default: 0, requires file size to match flash size)
+     * @param options Programming options (erase, verify, progress callback)
+     */
+    programFile(filePath: string, address?: number, options?: {
+        erase?: boolean;
+        verify?: boolean;
+        onProgress?: FlashProgressCallback;
+    }): Promise<boolean>;
+    /**
+     * Read flash contents and save to a binary file
+     * @param filePath Path to save the binary file
+     * @param address Starting address in flash (default: 0)
+     * @param length Number of bytes to read (if not specified, reads entire flash based on JEDEC ID)
+     * @param onProgress Progress callback
+     */
+    readToFile(filePath: string, address?: number, length?: number, onProgress?: FlashProgressCallback): Promise<void>;
+    /**
+     * Get flash info (call readJedecId first)
+     */
+    getFlashInfo(): FlashInfo | null;
+    private delay;
+}
+//# sourceMappingURL=flash.d.ts.map