WebUSB: iHex flashing whenever it fallsback to full flash.

Author: microbit-carlos

js/fs.js

@@ -45,14 +45,14 @@ var microbitFsWrapper = function() {
      * initial main.py
      */
     fsWrapper.setupFilesystem = function() {
-        var deferred1 = $.get('firmware.hex', function(fileStr) {
+        var deferred1 = $.get('micropython/microbit-micropython-v1.hex', function(fileStr) {
             fs1 = new microbitFs.MicropythonFsHex(fileStr, {
                 'maxFsSize': commonFsSize,
             });
         }).fail(function() {
             console.error('Could not load the MicroPython hex 1 file.');
         });
-        var deferred2 = $.get('firmware2.hex', function(fileStr) {
+        var deferred2 = $.get('micropython/microbit-micropython-v2.hex', function(fileStr) {
             fs2 = new microbitFs.MicropythonFsHex(fileStr, {
                 'maxFsSize': commonFsSize,
             });
@@ -89,7 +89,10 @@ var microbitFsWrapper = function() {
         }
     };
 
-    // TODO: doc this
+    /**
+     * @param {string} boardId String with the Board ID for the generation.
+     * @returns ArrayBuffer with the Intel Hex data for the given Board ID.
+     */
     fsWrapper.getIntelHexForBoardId = function(boardId) {
         if (boardId == '9900' || boardId == '9901') {
             var hexStr = fs1.getIntelHex();
@@ -98,6 +101,7 @@ var microbitFsWrapper = function() {
         } else {
             throw Error('Could not recognise the Board ID ' + boardId);
         }
+        // iHex is ASCII so we can do a 1-to-1 conversion from chars to bytes
         var hexBuffer = new Uint8Array(hexStr.length);
         for (var i=0, strLen=hexStr.length; i < strLen; i++) {
             hexBuffer[i] = hexStr.charCodeAt(i);

js/partial-flashing.js

@@ -551,6 +551,7 @@ let PartialFlashing = {
     // Write a single page of data to micro:bit ROM by writing it to micro:bit RAM and copying to ROM.
     // Drawn from https://github.com/microsoft/pxt-microbit/blob/dec5b8ce72d5c2b4b0b20aafefce7474a6f0c7b2/editor/extension.tsx#L385
     partialFlashPageAsync: function(dapwrapper, page, nextPage, i) {
+        // TODO: This short-circuits UICR, do we need to update this?
         if (page.targetAddr >= 0x10000000)
             return Promise.resolve();
 
@@ -598,7 +599,7 @@ let PartialFlashing = {
     // Flash the micro:bit's ROM with the provided image by only copying over the pages that differ.
     // Falls back to a full flash if partial flashing fails.
     // Drawn from https://github.com/microsoft/pxt-microbit/blob/dec5b8ce72d5c2b4b0b20aafefce7474a6f0c7b2/editor/extension.tsx#L335
-    partialFlashAsync: async function(dapwrapper, image, updateProgress) {
+    partialFlashAsync: async function(dapwrapper, flashBytes, hexBuffer, updateProgress) {
         let checksums;
         return this.getFlashChecksumsAsync(dapwrapper)
             .then(buf => {
@@ -607,15 +608,15 @@ let PartialFlashing = {
                 return dapwrapper.writeBlockAsync(this.loadAddr, this.flashPageBIN);
             })
             .then(async () => {
-                let aligned = PartialFlashingUtils.pageAlignBlocks(image, 0);
+                let aligned = PartialFlashingUtils.pageAlignBlocks(flashBytes, 0);
                 const totalPages = aligned.length;
                 PartialFlashingUtils.log("Total pages: " + totalPages);
                 aligned = PartialFlashingUtils.onlyChanged(aligned, checksums);
                 PartialFlashingUtils.log("Changed pages: " + aligned.length);
 
                 if (aligned.length > (totalPages / 2)) {
                     try {
-                        await this.fullFlashAsync(dapwrapper, image, updateProgress);
+                        await this.fullFlashAsync(dapwrapper, hexBuffer, updateProgress);
                     } catch(err) {
                         PartialFlashingUtils.log(err);
                         PartialFlashingUtils.log("Full flash failed, attempting partial flash.");
@@ -628,7 +629,7 @@ let PartialFlashing = {
                     } catch(err) {
                         PartialFlashingUtils.log(err);
                         PartialFlashingUtils.log("Partial flash failed, attempting full flash.");
-                        await this.fullFlashAsync(dapwrapper, image, updateProgress);
+                        await this.fullFlashAsync(dapwrapper, hexBuffer, updateProgress);
                     }
                 }
 
@@ -695,7 +696,7 @@ let PartialFlashing = {
 
     // Flash the micro:bit's ROM with the provided image, resetting the micro:bit first.
     // Drawn from https://github.com/microsoft/pxt-microbit/blob/dec5b8ce72d5c2b4b0b20aafefce7474a6f0c7b2/editor/extension.tsx#L439
-    flashAsync: async function(dapwrapper, image, updateProgress) {
+    flashAsync: async function(dapwrapper, flashBytes, hexBuffer, updateProgress) {
         try {
             let p = Promise.resolve()
                 .then(() => {
@@ -727,11 +728,11 @@ let PartialFlashing = {
                         "event-type": "info",
                         "message": "flash-failed" + "/" + "attempting-full-flash"
                     }}));
-                    return this.fullFlashAsync(dapwrapper, image, updateProgress);
+                    return this.fullFlashAsync(dapwrapper, hexBuffer, updateProgress);
                 } else {
                     // Start flashing
                     PartialFlashingUtils.log("Begin Flashing");
-                    return this.partialFlashAsync(dapwrapper, image, updateProgress);
+                    return this.partialFlashAsync(dapwrapper, flashBytes, hexBuffer, updateProgress);
                 }
             })
             .finally(() => {

firmware.hex micropython/microbit-micropython-v1.hexfirmware.hex renamed to micropython/microbit-micropython-v1.hex

@@ -1477,17 +1477,16 @@ function web_editor(config) {
                 //    throw new Error('One ore more of the modules used in this script are not available in this version of MicroPython.');
                 //}
 
-                // TODO: If the UICR is fixed in the future we can go back to only send the flash region without the whole hex data
-                var flashData = usePartialFlashing
-                    ? FS.getBytesForBoardId(window.dapwrapper.boardId)
-                    : FS.getIntelHexForBoardId(window.dapwrapper.boardId);
-
+                // Collect data to flash, partial flashing can use just the flash bytes,
+                // but full flashing needs the entire Intel Hex to include the UICR data
+                var flashBytes = FS.getBytesForBoardId(window.dapwrapper.boardId);
+                var hexBuffer = FS.getIntelHexForBoardId(window.dapwrapper.boardId);
                 // Begin flashing
                 $('#webusb-flashing-loader').hide();
                 $('#webusb-flashing-progress').val(0).css('display', 'inline-block');
                 return usePartialFlashing
-                    ? PartialFlashing.flashAsync(window.dapwrapper, flashData, updateProgress)
-                    : PartialFlashing.fullFlashAsync(window.dapwrapper, flashData, updateProgress);
+                    ? PartialFlashing.flashAsync(window.dapwrapper, flashBytes, hexBuffer, updateProgress)
+                    : PartialFlashing.fullFlashAsync(window.dapwrapper, hexBuffer, updateProgress);
             })
             .then(function() {
                 // Show tick