Add firmware updater scripts from the firmware repo and the dependent blhost binaries.

packages/usb/package-lock.json

@@ -1,11 +1,14 @@
 {
-	"requires": true,
+	"name": "agent-usb",
+	"version": "1.0.0",
 	"lockfileVersion": 1,
+	"requires": true,
 	"dependencies": {
 		"@types/node": {
 			"version": "8.0.28",
 			"resolved": "https://registry.npmjs.org/@types/node/-/node-8.0.28.tgz",
-			"integrity": "sha512-HupkFXEv3O3KSzcr3Ylfajg0kaerBg1DyaZzRBBQfrU3NN1mTBRE7sCveqHwXLS5Yrjvww8qFzkzYQQakG9FuQ=="
+			"integrity": "sha512-HupkFXEv3O3KSzcr3Ylfajg0kaerBg1DyaZzRBBQfrU3NN1mTBRE7sCveqHwXLS5Yrjvww8qFzkzYQQakG9FuQ==",
+			"dev": true
 		},
 		"ansi-regex": {
 			"version": "2.1.1",
@@ -34,6 +37,11 @@
 				"readable-stream": "2.3.3"
 			}
 		},
+		"balanced-match": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
+			"integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c="
+		},
 		"bindings": {
 			"version": "1.3.0",
 			"resolved": "https://registry.npmjs.org/bindings/-/bindings-1.3.0.tgz",
@@ -47,6 +55,15 @@
 				"readable-stream": "2.3.3"
 			}
 		},
+		"brace-expansion": {
+			"version": "1.1.8",
+			"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.8.tgz",
+			"integrity": "sha1-wHshHHyVLsH479Uad+8NHTmQopI=",
+			"requires": {
+				"balanced-match": "1.0.0",
+				"concat-map": "0.0.1"
+			}
+		},
 		"chalk": {
 			"version": "2.1.0",
 			"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.1.0.tgz",
@@ -85,6 +102,11 @@
 			"resolved": "https://registry.npmjs.org/commander/-/commander-2.11.0.tgz",
 			"integrity": "sha512-b0553uYA5YAEGgyYIGYROzKQ7X5RAqedkfjiZxwi0kL1g3bOaBNNZfYkzt/CL0umgD5wc9Jec2FbB98CjkMRvQ=="
 		},
+		"concat-map": {
+			"version": "0.0.1",
+			"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
+			"integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s="
+		},
 		"console-control-strings": {
 			"version": "1.1.0",
 			"resolved": "https://registry.npmjs.org/console-control-strings/-/console-control-strings-1.1.0.tgz",
@@ -123,6 +145,11 @@
 			"resolved": "https://registry.npmjs.org/expand-template/-/expand-template-1.1.0.tgz",
 			"integrity": "sha512-kkjwkMqj0h4w/sb32ERCDxCQkREMCAgS39DscDnSwDsbxnwwM1BTZySdC3Bn1lhY7vL08n9GoO/fVTynjDgRyQ=="
 		},
+		"fs.realpath": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
+			"integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8="
+		},
 		"gauge": {
 			"version": "2.7.4",
 			"resolved": "https://registry.npmjs.org/gauge/-/gauge-2.7.4.tgz",
@@ -143,6 +170,19 @@
 			"resolved": "https://registry.npmjs.org/github-from-package/-/github-from-package-0.0.0.tgz",
 			"integrity": "sha1-l/tdlr/eiXMxPyDoKI75oWf6ZM4="
 		},
+		"glob": {
+			"version": "7.1.2",
+			"resolved": "https://registry.npmjs.org/glob/-/glob-7.1.2.tgz",
+			"integrity": "sha512-MJTUg1kjuLeQCJ+ccE4Vpa6kKVXkPYJ2mOCQyUuKLcLQsdrMCpBPUi8qVE6+YuaJkozeA9NusTAw3hLr8Xe5EQ==",
+			"requires": {
+				"fs.realpath": "1.0.0",
+				"inflight": "1.0.6",
+				"inherits": "2.0.3",
+				"minimatch": "3.0.4",
+				"once": "1.4.0",
+				"path-is-absolute": "1.0.1"
+			}
+		},
 		"has-flag": {
 			"version": "2.0.0",
 			"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-2.0.0.tgz",
@@ -153,6 +193,15 @@
 			"resolved": "https://registry.npmjs.org/has-unicode/-/has-unicode-2.0.1.tgz",
 			"integrity": "sha1-4Ob+aijPUROIVeCG0Wkedx3iqLk="
 		},
+		"inflight": {
+			"version": "1.0.6",
+			"resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz",
+			"integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=",
+			"requires": {
+				"once": "1.4.0",
+				"wrappy": "1.0.2"
+			}
+		},
 		"inherits": {
 			"version": "2.0.3",
 			"resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.3.tgz",
@@ -163,6 +212,11 @@
 			"resolved": "https://registry.npmjs.org/ini/-/ini-1.3.4.tgz",
 			"integrity": "sha1-BTfLedr1m1mhpRff9wbIbsA5Fi4="
 		},
+		"interpret": {
+			"version": "1.0.4",
+			"resolved": "https://registry.npmjs.org/interpret/-/interpret-1.0.4.tgz",
+			"integrity": "sha1-ggzdWIuGj/sZGoCVBtbJyPISsbA="
+		},
 		"is-fullwidth-code-point": {
 			"version": "1.0.0",
 			"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz",
@@ -176,6 +230,14 @@
 			"resolved": "https://registry.npmjs.org/isarray/-/isarray-1.0.0.tgz",
 			"integrity": "sha1-u5NdSFgsuhaMBoNJV6VKPgcSTxE="
 		},
+		"minimatch": {
+			"version": "3.0.4",
+			"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz",
+			"integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==",
+			"requires": {
+				"brace-expansion": "1.1.8"
+			}
+		},
 		"minimist": {
 			"version": "1.2.0",
 			"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz",
@@ -255,6 +317,16 @@
 			"resolved": "https://registry.npmjs.org/os-homedir/-/os-homedir-1.0.2.tgz",
 			"integrity": "sha1-/7xJiDNuDoM94MFox+8VISGqf7M="
 		},
+		"path-is-absolute": {
+			"version": "1.0.1",
+			"resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz",
+			"integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18="
+		},
+		"path-parse": {
+			"version": "1.0.5",
+			"resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.5.tgz",
+			"integrity": "sha1-PBrfhx6pzWyUMbbqK9dKD/BVxME="
+		},
 		"prebuild-install": {
 			"version": "2.3.0",
 			"resolved": "https://registry.npmjs.org/prebuild-install/-/prebuild-install-2.3.0.tgz",
@@ -315,6 +387,22 @@
 				"util-deprecate": "1.0.2"
 			}
 		},
+		"rechoir": {
+			"version": "0.6.2",
+			"resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
+			"integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
+			"requires": {
+				"resolve": "1.5.0"
+			}
+		},
+		"resolve": {
+			"version": "1.5.0",
+			"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.5.0.tgz",
+			"integrity": "sha512-hgoSGrc3pjzAPHNBg+KnFcK2HwlHTs/YrAGUr6qgTVUZmXv1UEXXl0bZNBKMA9fud6lRYFdPGz0xXxycPzmmiw==",
+			"requires": {
+				"path-parse": "1.0.5"
+			}
+		},
 		"safe-buffer": {
 			"version": "5.1.1",
 			"resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.1.tgz",
@@ -325,6 +413,16 @@
 			"resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz",
 			"integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc="
 		},
+		"shelljs": {
+			"version": "0.7.8",
+			"resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.7.8.tgz",
+			"integrity": "sha1-3svPh0sNHl+3LhSxZKloMEjprLM=",
+			"requires": {
+				"glob": "7.1.2",
+				"interpret": "1.0.4",
+				"rechoir": "0.6.2"
+			}
+		},
 		"signal-exit": {
 			"version": "3.0.2",
 			"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.2.tgz",
@@ -340,14 +438,6 @@
 				"xtend": "4.0.1"
 			}
 		},
-		"string_decoder": {
-			"version": "1.0.3",
-			"resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
-			"integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
-			"requires": {
-				"safe-buffer": "5.1.1"
-			}
-		},
 		"string-width": {
 			"version": "1.0.2",
 			"resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz",
@@ -358,6 +448,14 @@
 				"strip-ansi": "3.0.1"
 			}
 		},
+		"string_decoder": {
+			"version": "1.0.3",
+			"resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.0.3.tgz",
+			"integrity": "sha512-4AH6Z5fzNNBcH+6XDMfA/BTt87skxqJlO0lAh3Dker5zThcAxG6mKz+iGu308UKoPPQ8Dcqx/4JhujzltRa+hQ==",
+			"requires": {
+				"safe-buffer": "5.1.1"
+			}
+		},
 		"strip-ansi": {
 			"version": "3.0.1",
 			"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-3.0.1.tgz",

packages/usb/package.json

@@ -13,6 +13,7 @@
     "chalk": "2.1.0",
     "commander": "^2.11.0",
     "node-hid": "0.5.7",
+    "shelljs": "^0.7.8",
     "uhk-common": "1.0.0",
     "uhk-usb": "1.0.0"
   }

packages/usb/shared.js

@@ -0,0 +1,64 @@
+require('shelljs/global');
+
+function checkFirmwareImage(imagePath, extension) {
+    if (!imagePath) {
+        echo('No firmware image specified');
+        exit(1);
+    }
+
+    if (!imagePath.endsWith(extension)) {
+        echo(`Firmware image extension is not ${extension}`);
+        exit(1);
+    }
+
+    if (!test('-f', imagePath)) {
+        echo('Firmware image does not exist');
+        exit(1);
+    }
+}
+
+function getBlhostCmd(pid) {
+    let blhostPath;
+    switch (process.platform) {
+        case 'linux':
+            blhostPath = 'linux/amd64/blhost';
+            break;
+        case 'darwin':
+            blhostPath = 'mac/blhost';
+            break;
+        case 'win32':
+            blhostPath = 'win/blhost.exe';
+            break;
+        default:
+            echo('Your operating system is not supported');
+            exit(1);
+            break;
+    }
+
+    return `${__dirname}/blhost/${blhostPath} --usb 0x1d50,${pid}`;
+}
+
+function execRetry(command) {
+    let firstRun = true;
+    let remainingRetries = 3;
+    let code;
+    do {
+        if (!firstRun) {
+            console.log(`Retrying ${command}`)
+        }
+        config.fatal = !remainingRetries;
+        code = exec(command).code;
+        config.fatal = true;
+        firstRun = false;
+    } while(code && --remainingRetries);
+}
+
+const exp = {
+    checkFirmwareImage,
+    getBlhostCmd,
+    execRetry,
+}
+
+Object.keys(exp).forEach(function (cmd) {
+  global[cmd] = exp[cmd];
+});

packages/usb/update-master-firmware.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+const program = require('commander');
+require('shelljs/global');
+require('./shared')
+
+const extension = '.hex';
+config.fatal = true;
+
+program
+    .usage(`update-master-firmware <firmware-image${extension}>`)
+    .parse(process.argv)
+
+const firmwareImage = program.args[0];
+const usbDir = `${__dirname}`;
+const blhost = getBlhostCmd(0x6120);
+
+checkFirmwareImage(firmwareImage, extension);
+
+config.verbose = true;
+exec(`${usbDir}/reenumerate.js bootloader`);
+exec(`${blhost} flash-security-disable 0403020108070605`);
+exec(`${blhost} flash-erase-region 0xc000 475136`);
+exec(`${blhost} flash-image ${firmwareImage}`);
+exec(`${blhost} reset`);
+config.verbose = false;
+
+echo('Firmware updated successfully');

packages/usb/update-slave-firmware.js

@@ -0,0 +1,32 @@
+#!/usr/bin/env node
+const program = require('commander');
+require('shelljs/global');
+require('./shared')
+
+const extension = '.bin';
+config.fatal = true;
+
+program
+    .usage(`update-slave-firmware <firmware-image${extension}>`)
+    .parse(process.argv)
+
+const firmwareImage = program.args[0];
+const usbDir = `${__dirname}`;
+const blhostUsb = getBlhostCmd(0x6121);
+const blhostBuspal = `${blhostUsb} --buspal i2c,0x10,100k`;
+
+checkFirmwareImage(firmwareImage, extension);
+
+config.verbose = true;
+exec(`${usbDir}/send-kboot-command-to-slave.js ping 0x10`);
+exec(`${usbDir}/jump-to-slave-bootloader.js`);
+exec(`${usbDir}/reenumerate.js buspal`);
+execRetry(`${blhostBuspal} get-property 1`);
+exec(`${blhostBuspal} flash-erase-all-unsecure`);
+exec(`${blhostBuspal} write-memory 0x0 ${firmwareImage}`);
+exec(`${blhostUsb} reset`);
+exec(`${usbDir}/reenumerate.js normalKeyboard`);
+execRetry(`${usbDir}/send-kboot-command-to-slave.js reset 0x10`);
+config.verbose = false;
+
+echo('Firmware updated successfully');