https://github.com/calcite/espefuse-js

https://github.com/calcite/espefuse-js

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/calcite/espefuse-js
• Owner: calcite
• License: gpl-2.0
• Created: 2024-04-15T11:19:23.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-04-22T08:45:16.000Z (10 months ago)
• Last Synced: 2024-12-12T09:56:46.976Z (about 2 months ago)
• Language: TypeScript
• Size: 99.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Javascript implementation of espefuses

Complementary lib to [esptool-js](https://github.com/espressif/esptool-js).

**Only the esp32s3 variant is partially supported.**

No read/write file operation is implemented (burnKey input values, emulator output..).

---

`argparse` (parsing cmd line arguments) part of esptool is not implemented.

(Only burnEfuse operation is performing the ArgValue check - e.g. transform MAC address in string format to binary representation..)

---

#### usage

webpack example

```javascript

import { ESPLoader, LoaderOptions, Transport } from "esptool-js";

import { getEfuses, getEspEmulator } from "@alcz/espefuse-js";

// same as term in esptool-js

const espLoaderTerminal = {

   // xterm-js or any other output

   clean() {

      terminal.clear();

   },

   writeLine(data) {

      terminal.writeln(data);

   },

   write(data) {

      terminal.write(data);

   },

};

const main = async () => {

   // esptool

   const dev = await this.getDevice();

   const transp = new Transport(dev, true);

   const loaderOptions: LoaderOptions = {

            transport: transp,

            baudrate: 115200,

            terminal: espLoaderTerminal,

            enableTracing: false,

         };

   const espLoader = new ESPLoader(loaderOptions);

   // or use emulator

   // const espLoader = new (getEspEmulator())();

   // espefuses

   const efuseOptions = {

            esp: espLoader,

            skipConnect: false,

            debug: true,

            doNotConfirm: true,

            terminal: this.espLoaderTerminal

         };

   const [efuses, operations] = getEfuses(efuseOptions);

   await efuses.setup();

   // print efuses summary

   await operations.summary(espLoader, efuses, {format: "summary"});

}

main();

```

#### EspEfuses settings:

 - esp: esptool-js instance

 - skipConnect: `boolean = false` (assume esptool-js instance is connected if `true`)

 - debug: `boolean = false`

 - doNotConfirm: `boolean = false` (not-confirm burn op?)

 - terminal = `null`; same as in esptool-js

 - confirmFn = `null`; Confirmation function. Return `true` to confirm or raise Error to deny.

#### operations

List of implemented operations:

```

args used in all ops:

esp: ESPLoader insance

efuses: EspEfuses instance

```

---

 - **summary** `async function summary(esp: any, efuses: any, args: any): Promise`

    args: `{format: "summary"}` for human readable format

 - **burnBit** `async function burnBit(esp: any, efuses: any, args: any): Promise`

    ```

    args:

    block: blockName, - Efuse block to burn [string - BLOCK0,BLOCK1,BLOCK2,BLOCK3]

    bitNumber: bitNum - Bit number in the efuse block [0..BLK_LEN-1]

    ```

 - **burnEfuse** `async function burnEfuse(esp: any, efuses: any, args: any): Promise`

    ```

    args:

    nameValuePairs: [{[efuseName]: efuseValue}, ...]

    ```

 - **readEfuse** `async function readEfuse(esp: any, efuses: any, args: any)`

   ```

   args:

   efuses: list of efuse names to read [efuseName, ..]

   ```

   returns dict `{[efuseName]: value, ...}`

 - **writeProtectEfuse** `async function writeProtectEfuse(esp: any, efuses: any, args: any): Promise`

   ```

   args:

   efuseName: list of efuse names to write protect [efuseName, ...]

   ```

 - **burnKey** `async function burnKey(esp: any, efuses: any, args: any, digest: any = null): Promise`

   ```

   args:

   keypurpose: list of key purpose [TODO?: support "XTS_AES_256_KEY"]

   block: block name list

   keyfile: list of files to read block data from. (not supported, TODO?)

   forceWriteAlways: [boolean]

   noWriteProtect: [boolean]

   digest: list of data keys to burn

   ```

   If `keyfile` is not set, `digest` is used instead as source for data to burn.

   Number of items in `block`, `keypurpose`, and `keyfile` / `digest` must be the same.

Operations can be emulated for debugging purposes.

### License

This document and the attached source code are released as Free Software under GNU General Public License Version 2 or later. See the accompanying [LICENSE file](https://github.com/calcite/espefuse-js/blob/master/LICENSE) for a copy.