@aepyornis/fastboot.ts 0.0.1

package/src/flasher.ts

@@ -0,0 +1,174 @@
+import {
+  ZipReader,
+  BlobReader,
+  BlobWriter,
+  TextWriter,
+  Entry,
+} from "@zip.js/zip.js"
+import type { FastbootClient } from "./client"
+
+type CommandName =
+  | "update"
+  | "flashall"
+  | "flash"
+  | "flashing"
+  | "erase"
+  | "format"
+  | "getvar"
+  | "set_active"
+  | "boot"
+  | "devices"
+  | "continue"
+  | "reboot"
+  | "reboot-bootloader"
+  | "help"
+
+type Instruction = {
+  command: CommandName
+  args: string[]
+  options: object
+}
+
+function getEntry(entries: Entry[], filename: string): Entry {
+  const entry = entries.find(
+    (e) => e.filename.split(/[\\/]/).pop() === filename,
+  )
+  if (entry) {
+    return entry
+  } else {
+    throw new Error(`${filename} not found in zip`)
+  }
+}
+
+function parseInstruction(text: string): Instruction {
+  if (text.slice(0, 8) === "fastboot") {
+    text = text.slice(8).trim()
+  }
+
+  let command: CommandName
+  const args = []
+  const options = {}
+
+  const words = text.split(" ").map((x) => x.trim())
+
+  for (const word of words) {
+    if (word[0] === "-") {
+      if (word === "-w" || word === "--wipe") {
+        options.wipe = true
+      } else if (word === "--set-active=other") {
+        options.setActive = "other"
+      } else if (word === '--slot-other') {
+	options.slot = 'other'
+      } else if (word.slice(0, 6) === "--slot") {
+        const slot = word.split("=")[1]
+        if (!["current", "other", "a", "b"].includes(slot)) {
+          throw new Error(`unknown slot: ${slot}`)
+        }
+        options.slot = slot
+      } else if (word === "--skip-reboot") {
+        options.skipReboot = true
+      } else if (word === "--apply-vbmeta") {
+        options.applyVbmeta = true
+      } else {
+        console.warn(`Unknown option: ${word}`)
+      }
+    } else {
+      if (command) {
+        args.push(word)
+      } else {
+        command = word
+      }
+    }
+  }
+  return { command, args, options }
+}
+
+function parseInstructions(text: string): Instruction[] {
+  return text
+    .split("\n")
+    .map((x) => x.trim())
+    .filter((x) => x !== "")
+    .filter((x) => x[0] !== "#")
+    .map(parseInstruction)
+}
+
+export class FastbootFlasher {
+  client: FastbootClient
+  reader: ZipReader
+
+  constructor(client: FastbootClient, blob: Blob) {
+    this.client = client
+    this.reader = new ZipReader(new BlobReader(blob))
+  }
+
+  async run(instructions: text) {
+    const entries: Entry[] = await this.reader.getEntries() // io with factory.zip
+    const commands: Instruction[] = parseInstructions(instructions)
+    console.log(commands)
+
+    for (const command of commands) {
+      this.client.logger.log(`‣ ${JSON.stringify(command)}`)
+      if (command.command === "flash") {
+        const partition = command.args[0]
+        const filename = command.args[1]
+        const slot = command.options.slot || "current"
+        const entry = getEntry(entries, filename)
+        const blob = await entry.getData(
+          new BlobWriter("application/octet-stream"),
+        )
+
+        await this.client.doFlash(
+          partition,
+          blob,
+          slot,
+          Boolean(command.options.applyVbmeta),
+        )
+      } else if (command.command === "reboot-bootloader") {
+        if (command.options.setActive === "other") {
+          await this.client.setActiveOtherSlot()
+        }
+        await this.client.rebootBootloader()
+      } else if (command.command === "update") {
+        const nestedZipEntry = getEntry(entries, command.args[0])
+        const zipBlob = await nestedZipEntry.getData(
+          new BlobWriter("application/zip"),
+        )
+        const zipReader = new ZipReader(new BlobReader(zipBlob))
+        const nestedEntries = await zipReader.getEntries()
+        const fastbootInfoFile = nestedEntries.find(
+          (e) => e.filename === "fastboot-info.txt",
+        )
+        const fastbootInfoText = await fastbootInfoFile.getData(
+          new TextWriter(),
+        )
+
+        this.client.logger.log(`fastboot-info.txt: ${fastbootInfoText}`)
+
+        // fastboot -w update image-lynx-bp1a.250305.019.zip
+        await this.client.fastbootInfo(
+          nestedEntries,
+          fastbootInfoText,
+          Boolean(command.options.wipe),
+        )
+      } else if (command.command === "flashing") {
+        if (command.args[0] === "lock") {
+          await this.client.lock()
+        } else if (command.args[0] === "unlock") {
+          await this.client.unlock()
+        } else {
+          throw new Error(`Unknown command`)
+        }
+      } else if (command.command === "getvar") {
+        const clientVar = await this.client.getVar(command.args[0])
+        this.client.logger(`getVar(${command.args[0]}) => ${clientVar}`)
+      } else if (command.command === "erase") {
+        await this.client.erase(command.args[0])
+      } else if (command.command === "sleep") {
+        const ms = command.args[0] ? parseInt(command.args[0]) * 1000 : 5000
+        await new Promise((resolve) => setTimeout(resolve, ms))
+      } else {
+        throw new Error(`Fastboot command ${command.command} not implemented`)
+      }
+    }
+  }
+}

package/src/images.ts

@@ -0,0 +1,218 @@
+export const IMAGES = [
+  {
+    nickname: "boot",
+    img_name: "boot.img",
+    sig_name: "boot.sig",
+    part_name: "boot",
+    optional: false,
+    type: "BootCritical",
+  },
+  {
+    nickname: "bootloader",
+    img_name: "bootloader.img",
+    sig_name: "",
+    part_name: "bootloader",
+    optional: true,
+    type: "Extra",
+  },
+  {
+    nickname: "init_boot",
+    img_name: "init_boot.img",
+    sig_name: "init_boot.sig",
+    part_name: "init_boot",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "",
+    img_name: "boot_other.img",
+    sig_name: "boot.sig",
+    part_name: "boot",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "cache",
+    img_name: "cache.img",
+    sig_name: "cache.sig",
+    part_name: "cache",
+    optional: true,
+    type: "Extra",
+  },
+  {
+    nickname: "dtbo",
+    img_name: "dtbo.img",
+    sig_name: "dtbo.sig",
+    part_name: "dtbo",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "dts",
+    img_name: "dt.img",
+    sig_name: "dt.sig",
+    part_name: "dts",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "odm",
+    img_name: "odm.img",
+    sig_name: "odm.sig",
+    part_name: "odm",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "odm_dlkm",
+    img_name: "odm_dlkm.img",
+    sig_name: "odm_dlkm.sig",
+    part_name: "odm_dlkm",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "product",
+    img_name: "product.img",
+    sig_name: "product.sig",
+    part_name: "product",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "pvmfw",
+    img_name: "pvmfw.img",
+    sig_name: "pvmfw.sig",
+    part_name: "pvmfw",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "radio",
+    img_name: "radio.img",
+    sig_name: "",
+    part_name: "radio",
+    optional: true,
+    type: "Extra",
+  },
+  {
+    nickname: "recovery",
+    img_name: "recovery.img",
+    sig_name: "recovery.sig",
+    part_name: "recovery",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "super",
+    img_name: "super.img",
+    sig_name: "super.sig",
+    part_name: "super",
+    optional: true,
+    type: "Extra",
+  },
+  {
+    nickname: "system",
+    img_name: "system.img",
+    sig_name: "system.sig",
+    part_name: "system",
+    optional: false,
+    type: "Normal",
+  },
+  {
+    nickname: "system_dlkm",
+    img_name: "system_dlkm.img",
+    sig_name: "system_dlkm.sig",
+    part_name: "system_dlkm",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "system_ext",
+    img_name: "system_ext.img",
+    sig_name: "system_ext.sig",
+    part_name: "system_ext",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "",
+    img_name: "system_other.img",
+    sig_name: "system.sig",
+    part_name: "system",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "userdata",
+    img_name: "userdata.img",
+    sig_name: "userdata.sig",
+    part_name: "userdata",
+    optional: true,
+    type: "Extra",
+  },
+  {
+    nickname: "vbmeta",
+    img_name: "vbmeta.img",
+    sig_name: "vbmeta.sig",
+    part_name: "vbmeta",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "vbmeta_system",
+    img_name: "vbmeta_system.img",
+    sig_name: "vbmeta_system.sig",
+    part_name: "vbmeta_system",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "vbmeta_vendor",
+    img_name: "vbmeta_vendor.img",
+    sig_name: "vbmeta_vendor.sig",
+    part_name: "vbmeta_vendor",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "vendor",
+    img_name: "vendor.img",
+    sig_name: "vendor.sig",
+    part_name: "vendor",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "vendor_boot",
+    img_name: "vendor_boot.img",
+    sig_name: "vendor_boot.sig",
+    part_name: "vendor_boot",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "vendor_dlkm",
+    img_name: "vendor_dlkm.img",
+    sig_name: "vendor_dlkm.sig",
+    part_name: "vendor_dlkm",
+    optional: true,
+    type: "Normal",
+  },
+  {
+    nickname: "vendor_kernel_boot",
+    img_name: "vendor_kernel_boot.img",
+    sig_name: "vendor_kernel_boot.sig",
+    part_name: "vendor_kernel_boot",
+    optional: true,
+    type: "BootCritical",
+  },
+  {
+    nickname: "",
+    img_name: "vendor_other.img",
+    sig_name: "vendor.sig",
+    part_name: "vendor",
+    optional: true,
+    type: "Normal",
+  },
+]

package/src/index.ts

@@ -0,0 +1,3 @@
+export { FastbootDevice } from "./device"
+export { FastbootClient } from "./client"
+export { FastbootFlasher } from "./flasher"