Skip to content

Commit

Permalink
Documentation content update (Flashing details)
Browse files Browse the repository at this point in the history
  • Loading branch information
TaddyHC committed Oct 16, 2024
1 parent b12d8f1 commit 1b109ea
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -148,9 +148,7 @@ As shown in the image above, the OS release of this Portenta X8 corresponds to `

### Update For OS Release V.399

If your Portenta X8 is flashed with the OS release V.399 and you have a carrier compatible with Portenta X8 (like Portenta Breakout). In that case, we recommend you update it to the latest image release by following [this tutorial](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing#flashing-mode-with-carrier).

Otherwise, you can also open a new Command Line window and connect to your Portenta X8, as explained [here](#working-with-linux). At this point, verify that your Portenta X8 is connected to the Internet and type the following commands:
Open a new Command Line window and connect to your Portenta X8, as explained [here](#working-with-linux). At this point, verify that your Portenta X8 is connected to the Internet and type the following commands:

```bash
wget https://downloads.arduino.cc/portentax8image/399-install-update
Expand Down Expand Up @@ -182,7 +180,9 @@ These commands will make your V.399 compatible with the [aklite-offline](https:/

Arduino provides this tool for free for any Portenta X8 user to enable offline secure updates to all devices, even if those devices are not connected to any FoundriesFactory.

After the update process is finalized, your Portenta X8 will start running the latest OS release immediately.
After the update process has finished, your Portenta X8 will start running the latest OS release immediately.

***If your Portenta X8 has the _OS release V.399_ and you have a carrier compatible with Portenta X8 (like Portenta Breakout). In that case, we recommend you update it to the latest image release by going to [flashing with `uuu tool`](#update-using-uuu-tool) section and follow the instructions found within the dedicated tutorial here: [__How To Flash Your Portenta X8__](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing).***

### Update Through Out-Of-The-Box Experience

Expand Down Expand Up @@ -238,6 +238,8 @@ More information about Waves can be found in the official Foundries documentatio

An alternative method to update the Portenta X8 with the latest OS image is to use the `uuu` tool (or `uuu_mac` for macOS). This approach is particularly useful for users who have built a custom image or prefer a manual update process. The image files can be downloaded from the [Arduino repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz) and extracted into a specific directory.

You can find more details in the dedicated tutorial here: [**How To Flash Your Portenta X8**](https://docs.arduino.cc/tutorials/portenta-x8/image-flashing).

Depending on the carrier being used (e.g., Max Carrier, Breakout, Hat, or Mid Carrier), DIP switch settings must be adjusted to enter programming mode or specific commands can be executed via ADB for a barebone setup. Once the board is in programming mode, you can navigate to the extracted image files and run the `uuu full_image.uuu` command to begin the flashing process.

If not using a carrier, ensure the tool is running before cycling the power on the Portenta X8. Upon successful completion, reset the DIP switches or recycle the power to confirm the update.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,12 @@ In this tutorial, you will learn how to manually flash your Portenta X8 with the
### Required Hardware and Software

- [Arduino Portenta X8](https://store.arduino.cc/products/portenta-x8)
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
- [USB-C® cable (USB-C® to USB-A cable)](https://store.arduino.cc/products/usb-cable2in1-type-c)
- Portenta Family Carrier (Optional):
- [Arduino Portenta Breakout Board](https://store.arduino.cc/products/arduino-portenta-breakout)
- [Arduino Portenta Max Carrier](https://store.arduino.cc/products/portenta-max-carrier)
- [Arduino Portenta Hat Carrier](https://store.arduino.cc/products/portenta-hat-carrier)
- [Arduino Portenta Mid Carrier](https://store.arduino.cc/products/portenta-mid-carrier)

## Instructions

Expand Down Expand Up @@ -91,13 +92,15 @@ For the **Portenta Mid Carrier**, the `BOOT SEL` DIP switch should be set to the

![Portenta Mid Carrier DIP switches](assets/midCarrier-dip-switches.png)

You must connect one USB-C® end to the Portenta X8 and the other (USB-C® or USB-A) to your computer. With this, the Portenta X8 is ready to begin the flashing process.
**You must connect one USB-C® end to the Portenta X8 and the other (USB-C® or USB-A) to your computer.** With this, the Portenta X8 is ready to begin the flashing process.

#### Flashing Mode without Carrier

***It is recommended to flash the board with the carrier. If it is not possible, we provide an alternative procedure for advanced users only implying the full flash memory erasing. If something goes wrong during the procedure, you might not be able to recover the board. Proceed with caution.***
***It is recommended to flash the board with the carrier. If it is not possible, we provide an alternative procedure for advanced users only implying the full flash memory erasing. If something goes wrong during the procedure, you might not be able to recover the board. __Proceed with caution__.***

If *Portenta Breakout* or *Portenta Max Carrier* is unavailable, the Portenta X8 can be configured for programming mode using a few command lines inside the Portenta X8's terminal via ADB. Please use the following commands in exact sequence while in the root environment with root permission.
If **compatible Carrier platform** is unavailable, the Portenta X8 can be configured for **programming mode** using a few command lines inside the Portenta X8's terminal via ADB.

**Please use the following commands in exact sequence while in the root environment with root permission.**

```bash
echo 0 > /sys/block/mmcblk2boot0/force_ro
Expand All @@ -119,13 +122,23 @@ This sequence of commands will allow you to reset Portenta X8's bootloader secto

### Flashing the Portenta X8

To flash the Portenta X8, you need to begin by opening a terminal. Within the terminal, you need to change the directory to where the `mfgtool-files-portenta-x8` file is located using the `cd` command. Once it is inside the directory where the previous file is included, the following command is used:
To flash the Portenta X8, you need to begin by opening a terminal. Within the terminal, you need to change the directory to where the **`mfgtool-files-portenta-x8`** files are found using the `cd` command.

Once it is inside the directory where the previous file is included, the following command is used:

```bash
uuu full_image.uuu
```

If you have followed the __Flashing Mode without Carrier__ method to flash an OS or a custom image, the `uuu` command should be active and seeking the board. While the process is active, please unplug and reconnect the USB-C® cable powering the Portenta X8 to allow entering the programming mode of the boot sequence. It should trigger the standing-by `uuu` task to run the flash process.
If the command is not recognized, use this command with the additional prefixes:

```bash
.\uuu .\full_image.uuu
```

If you have followed the [**Flashing Mode without Carrier** method](#flashing-mode-without-carrier) to flash a factory or custom image, the `uuu` command should be active and waiting to connect with the board.

While the process is active, please unplug and reconnect the USB-C® cable powering the Portenta X8 to allow entering the programming mode of the boot sequence. It should trigger the standing-by `uuu` task to run the flash process.

When the flashing operation is finished, you should see a similar result as the following figure:

Expand Down

0 comments on commit 1b109ea

Please sign in to comment.