Ktool is the enhanced version of Kendryte kflash.py utility.

It is compatible with kflash.py but introduces many new features and enhancement.

Full sources of the enhanced 2nd stage ISP are available in this repository's src/isp directory.
More information about 2nd stage ISP and build instructions are available in the build directory.

• On start, K210 board is reset into bootloader ISP mode (running from K210 ROM) by holding the K210 IO16 low and asserting the reset pin.
• After reset, if IO16 is low, K210 executes the 1st stage ISP from ROM.
  1st stage ISP is only capable of loading K210 program to the requested SRAM address and execute it.
• After the communication with the 1st stage ISP is established, ktool.py uploads the 2nd stage ISP to the K210 SRAM (at address 0x805E0000) and executes it.
• All further communication is performed via 2nd stage ISP

• Compatible with standard kflash.py, the same command line options are supported (but more are added)
• Uses highly optimized 2nd stage ISP binary which loads in less than a second and supports many new features
• Write firmware or data to any SPI Flash address
• Write firmware/data using also 4K chunks and 4K alignment
  (kflash.py always writes 64K chunks and the firmware address must be 64KB aligned)
• Read Flash content to file is supported
• Erase the SPI Flash chip
• Reports SPI Flash chip manufacturer's JEDEC ID, 64-bit unique serial number and size
• Optionally swap endianess on data write (useful when writing some kind of data, for example file system images)
• Load the firmware to K210 SRAM end execute it.
  Loading is done by the 2nd stage ISP and can be performed at any baudrate supported by the board.
  It is now possible to load and start large firmwares at high speed...
  (kflash.py supports this function, but loading to SRAM is done at 115200 baud, making it impractical for larger firmwares)

kfpgk package is a ZIP archive containing several firmware or data binary files and a json file describing its content.
It is convenient to use it when multiple files must be flashed at different Flash addresses and with different options.

ktool.py can proces this file, unpack the content and perform the necessary operations.

The package must contain the JSON file named flash-list.json which describes which files are to be flashed and how.

The following objects must be present to describe each file under files object:

{
    "version": "0.1.0",
    "files": [
        {
            "address": 0,
            "bin": "MicroPython.bin",
            "sha256Prefix": true,
            "swap": false
        },
        {
            "address": 5242880,
            "bin": "MicroPython_lfs.img",
            "sha256Prefix": false,
            "swap": true
        }
    ]
}

{
    "version": "0.1.1",
    "files": [
        {
            "address": 0,
            "bin": "bootloader_lo.bin",
            "sha256Prefix": true
        },
        {
            "address": 4096,
            "bin": "bootloader_hi.bin",
            "sha256Prefix": true
        },
        {
            "address": 16384,
            "bin": "config.bin",
            "sha256Prefix": false
        },
        {
            "address": 20480,
            "bin": "config.bin",
            "sha256Prefix": false
        }
    ]
}