From 27c4ff2cc99b2e0f103c52a0166be431abd46a36 Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Sun, 19 Sep 2021 12:54:55 -0400 Subject: [PATCH] clean up bootloader doc --- _includes/download/board.html | 104 ++++++++++++++++++---------------- 1 file changed, 54 insertions(+), 50 deletions(-) diff --git a/_includes/download/board.html b/_includes/download/board.html index dffa367c..5e6ea326 100644 --- a/_includes/download/board.html +++ b/_includes/download/board.html @@ -159,109 +159,112 @@ By the way, boolean operation precedence is right to left! (yeesh) {% assign bootloader_version = bootloaders[bootloader_board.family].version %} {% assign bootloader_id = bootloader_board.bootloader_id %} {% if bootloader_version and bootloader_id and bootloader_board %} + +{% if bootloader_board.family == 'esp32s2' %}
-

Install/Repair UF2 Bootloader

+

Install, Repair, or Update UF2 Bootloader

Latest version: {{ bootloader_version }}

- The bootloader allows you to load CircuitPython, Makecode, and Arduino programs. + The UF2 bootloader allows you to load CircuitPython, MakeCode, and Arduino programs. The bootloader is not CircuitPython. -

- -{% if bootloader_board.family == 'esp32s2' %} -

- It is not necessary to reinstall the bootloader unless a BOOT drive is not visible when in UF2 bootloader mode (FTHRS2BOOT, MAGTAGBOOT, HOUSEBOOT, etc.), in which case the UF2 bootloader may need to be repaired. + If a UF2 bootloader is installed, you can check its version by looking in + the INFO_UF2.TXT file when the BOOT drive is visible + (FTHRS2BOOT, MAGTAGBOOT, HOUSEBOOT, etc.)

- If a UF2 bootloader has never been installed on the board, or the UF2 bootloader was removed by erasing or overwriting the flash, the UF2 bootloader should be installed in order to flash .uf2 files onto the board. + It is not necessary to reinstall a UF2 bootloader you unless a BOOT drive is not visible + when in UF2 bootloader mode, or you know of a problem with your current UF2 bootloader. +

+

+ If a UF2 bootloader has never been installed on the board, or the UF2 bootloader was removed by erasing or overwriting the flash, the UF2 bootloader must be installed in order to flash .uf2 files onto the board. .bin files can be uploaded without a UF2 bootloader, using the + Adafruit WebSerial ESPTool + or esptool.py.

-

Important: - this will erase previously flashed firmware & sketches from the board, but needs to be perfomed only once. +

+ Note: update.uf2 files are not currently working on ESP32-S2 boards. +

+ +

Important: + this will erase previously flashed firmware and sketches from the board, + but needs to be perfomed only once.

    -
  • Unzip to find the file combined.bin.
    • +
  • Unzip to find the file combined.bin.
  • Place board in bootloader mode:
    • Plug board into a USB port on your computer using a data/sync cable. Make sure it is the only board plugged in, and that a charge-only cable is not being used.
      • -
    • Press and hold down the BOOT or 0 button.
      • -
    • Press and release the RESET or RST button.
      • -
    • Release the BOOT button.
      • +
    • Press and hold down the BOOT or 0 button.
      • +
    • Press and release the RESET or RST button.
      • +
    • Release the BOOT button.
    • -
  • Upload combined.bin (Google Chrome 89 or newer): +
  • Upload combined.bin (Google Chrome 89 or newer):
    • Open Adafruit WebSerial ESPTool in a new window/tab.
      • -
    • Select 460800 Baud from the pull-down menu (top-right).
      • -
    • Click Connect (top-right).
      • +
    • Select 460800 Baud from the pull-down menu (top-right).
      • +
    • Click Connect (top-right).
    • Select the COM or Serial port from the pop-up window.
      • -
    • After successful connection, click Erase.
      • -
    • After successful erase, click any Choose a file..., then locate and select the combined.bin file unzipped earlier.
      • -
    • After successfully choosing combined.bin, click Program.
      • -
    • After the TinyUF2 firmware update is complete, press the RESET button on the board. A new drive BOARDBOOT (where BOARD is an abbreviation of your board's name) should be visible in your file browser.
      • +
    • After successful connection, click Erase.
      • +
    • After successful erase, click any Choose a file..., then locate and select the combined.bin file unzipped earlier.
      • +
    • After successfully choosing combined.bin, click Program.
      • +
    • After the TinyUF2 firmware update is complete, press the RESET button on the board. + A new drive BOOT should be visible in your file browser.

- After you update, check INFO_UF2.TXT to verify that the bootloader version has been updated. - Then you will need to load or reload CircuitPython using the .uf2 file. + After you update, check INFO_UF2.TXT to verify that the bootloader version has been updated. + Then you will need to load or reload CircuitPython using the .uf2 file.

DOWNLOAD BOOTLOADER ZIP -
-{% endif %} +
- +{% else %}

Update UF2 Bootloader

Latest version: {{ bootloader_version }}

- The bootloader allows you to load CircuitPython, Makecode, and Arduino programs. + The bootloader allows you to load CircuitPython, MakeCode, and Arduino programs. The bootloader is not CircuitPython. You can check the current version of your bootloader by looking in - the INFO_UF2.TXT file when the BOOT drive is visible (FEATHERBOOT, CPLAYBOOT, etc.). + the INFO_UF2.TXT file when the BOOT drive is visible (FEATHERBOOT, CPLAYBOOT, etc.).

- -{% if bootloader_board.family == 'esp32s2' %}

- update.uf2 files are not currently working on ESP32-S2 boards. + It is not necessary to update your bootloader if it is working fine. + Read the release notes on GitHub to see what has been changed. + In general, we recommend you not update the bootloader unless you know there is a problem with it + or a support person has asked you to try updating it.

-
    -
  • Save the contents of CIRCUITPY, just in case.
    • -
  • Follow instructions in the Install/Repair UF2 Bootloader section above.
    • -
  • Check INFO_UF2.TXT to verify that the bootloader version has been updated.
    • -
  • Reload CircuitPython.
    • -
-{% endif %} -{% if bootloader_board.family == 'nrf52840' %} + {% if bootloader_board.family == 'nrf52840' %}

Updating the bootloader on nRF52840 boards is an involved process right now. Follow the instructions in this README. - It is not necessary to update on each release if your bootloader is working fine. - Read the release notes on GitHub to see what has been changed.

- After you update, check INFO_UF2.TXT to verify that the bootloader version has been updated. + After you update, check INFO_UF2.TXT to verify that the bootloader version has been updated. Then you will need to reload CircuitPython.

BROWSE ON GITHUB
-{% endif %} + {% endif %} -{% if bootloader_board.family == 'atmel-samd' %} + {% if bootloader_board.family == 'atmel-samd' %}

- To update, first save the contents of CIRCUITPY, just in case. - Then double-click the reset button to show the BOOT drive. - Drag the update-bootloader .uf2 file to the BOOT drive. - Wait a few tens of seconds for the bootloader to update; the BOOT drive will reappear. - Check INFO_UF2.TXT to verify that the bootloader version has been updated. + To update, first save the contents of CIRCUITPY, just in case. + Then double-click the reset button to show the BOOT drive. + Drag the update-bootloader .uf2 file to the BOOT drive. + Wait a few tens of seconds for the bootloader to update; the BOOT drive will reappear. + After you update, check INFO_UF2.TXT to verify that the bootloader version has been updated. Then you will need to reload CircuitPython.

@@ -270,6 +273,7 @@ By the way, boolean operation precedence is right to left! (yeesh)

BROWSE ON GITHUB
-{% endif %} + {% endif %}
{% endif %} +{% endif %}