Skip to content

Commit ae8726d

Browse files
ArduinoBotTaddyHC
andauthored
[PC-1479] Portenta X8: "How to flash your Portenta X8" Tutorial Update (#1507)
* Initial commit - X8 Image flashing tutorial update * Tutorial content update * Tutorial content update --------- Co-authored-by: TaddyHC <k.hochung@arduino.cc>
1 parent 799437d commit ae8726d

File tree

4 files changed

+22
-15
lines changed

4 files changed

+22
-15
lines changed

content/hardware/04.pro/boards/portenta-x8/tutorials/09.image-flashing/content.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@ In this tutorial, you will learn how to manually flash your Portenta X8 with the
2727
- [Arduino Portenta X8](https://store.arduino.cc/products/portenta-x8)
2828
- USB-C® cable (either USB-C® to USB-A or USB-C® to USB-C®)
2929
- Portenta Family Carrier (Optional):
30-
- [Portenta Breakout Board](https://store.arduino.cc/products/arduino-portenta-breakout)
30+
- [Arduino Portenta Breakout Board](https://store.arduino.cc/products/arduino-portenta-breakout)
3131
- [Arduino Portenta Max Carrier](https://store.arduino.cc/products/portenta-max-carrier)
32+
- [Arduino Portenta Hat Carrier](https://store.arduino.cc/products/portenta-hat-carrier)
3233

3334
## Instructions
3435

3536
### Arduino's Download Repository
3637

37-
Go to [Arduino Download repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz) and a compressed `.tar.gz` with latest version of all the required OS image files will be there to download.
38+
Go to [Arduino Download repository](https://downloads.arduino.cc/portentax8image/image-latest.tar.gz), and a compressed `.tar.gz` with the latest version of all the required OS image files will be there to download.
3839

3940
![lpm-manifest repository overview](assets/lpm-manifest-overview.png)
4041

@@ -49,7 +50,7 @@ Unzipped folder
4950
└── u-boot-portenta-x8.itb
5051
```
5152

52-
After verifying these files are available, you will need to decompress `mfgtool-files-portenta-x8.tar.gz` and `lmp-partner-arduino-image-portenta-x8.wic.gz`. Please make sure the `.wic` is in the unzipped folder in the main directory. The folder structure should share a similar following layout.
53+
After verifying these files are available, you will need to decompress `mfgtool-files-portenta-x8.tar.gz` and `lmp-partner-arduino-image-portenta-x8.wic.gz`. Please ensure the `.wic` is in the unzipped folder in the main directory. The folder structure should share a similar following layout.
5354

5455
```
5556
Unzipped folder
@@ -66,23 +67,29 @@ Unzipped folder
6667

6768
#### Flashing Mode with Carrier
6869

69-
Connect your Portenta X8 into your carrier of choice, either *Portenta Breakout* or *Portenta Max Carrier*, via High-Density connectors. After connecting the Portenta X8, you will need to set the `BOOT` DIP switches to the ON position. The `BOOT` switch configuration is important as it will put the board into Flashing mode.
70+
Connect your Portenta X8 to your carrier of choice, either *Portenta Breakout*, *Portenta Max Carrier*, or *Hat Carrier*, via High-Density connectors. After connecting the Portenta X8, you must set the `BOOT` or `BTSEL` DIP switches to the ON position. The `BOOT/BTSEL` switch configuration is crucial as it will put the board into Flashing mode.
7071

71-
On the Portenta Max Carrier, the DIP switches are identified by the label `BOOT SEL` and `BOOT` as shown in the figure:
72+
For the **Portenta Max Carrier**, set the `BOOT SEL` and `BOOT` DIP switches to the ON position as depicted in the figure:
7273

73-
![Max Carrier DIP switches](assets/max-carrier-dip-switches.png)
74+
![Portenta Max Carrier DIP switches](assets/max-carrier-dip-switches.png)
7475

75-
On the Portenta Breakout, the DIP switches are identified by the label `BT_SEL` and `BOOT` as shown in the figure:
76+
For the **Portenta Breakout**, the `BT_SEL` and `BOOT` DIP switches should be set to the ON position, as illustrated in the figure:
7677

77-
![Breakout DIP switches](assets/breakout-dip-switches.png)
78+
![Portenta Breakout DIP switches](assets/breakout-dip-switches.png)
7879

79-
You will need to connect one USB-C® end to the Portenta X8 and the other end (USB-C® or USB-A) to your computer. If the connection is established correctly, you will be able to see a newly connected device called `SE Blank M845S`.
80+
For the **Portenta Hat Carrier**, the `BTSEL` DIP switch must be set to the ON position, as depicted in the figure below:
81+
82+
![Portenta Hat Carrier DIP switches](assets/hatCarrier-dip-switches.png)
83+
84+
The `ETH CENTER TAP` DIP switch position does not affect the flashing mode state for the Portenta Hat Carrier.
85+
86+
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.
8087

8188
#### Flashing Mode without Carrier
8289

83-
***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 gets wrong during the procedure, you might not be able to recover the board. Proceed with caution.***
90+
***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.***
8491

85-
If *Portenta Breakout* or *Portenta Max Carrier* is not available to you, the Portenta X8 can be configured for programming mode using a few lines of command inside the Portenta X8's terminal via ADB. Please use the following commands in exact sequence while you are in the root environment with root permission.
92+
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.
8693

8794
```arduino
8895
echo 0 > /sys/block/mmcblk2boot0/force_ro
@@ -104,21 +111,21 @@ This sequence of commands will allow you to reset Portenta X8's bootloader secto
104111

105112
### Flashing the Portenta X8
106113

107-
To flash the Portenta X8, you need to begin by opening a terminal. Within the terminal, you need to change the directory to where `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:
114+
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:
108115

109116
```
110117
uuu full_image.uuu
111118
```
112119

113-
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 for 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. This should trigger the standing-by `uuu` task to run the flash process.
120+
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.
114121

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

117124
![uuu tool flashing success output](assets/uuu-flashing-success.png)
118125

119-
Once you have verified it has successfully flashed the Portenta X8, the `BOOT` DIP switches that have been configured to the ON position, now need to be set to the OFF position. Otherwise, you will always have the Portenta X8 in Flashing mode whenever it is attached to a carrier. Recycle the power for Portenta X8 by reconnecting the board to your computer and start using with the latest updates.
126+
Once you have verified it has successfully flashed the Portenta X8, the `BOOT` DIP switches configured to the ON position now need to be set to the OFF position. Otherwise, you will always have the Portenta X8 attached to a carrier in Flashing mode. Recycle the power for Portenta X8 by reconnecting the board to your computer. The board is now ready for use with the latest updates.
120127

121-
In case the Portenta X8 was flashed barebone, you will just need to recycle the power and should be ready with the latest OS image.
128+
If the Portenta X8 was flashed barebone, you will need to recycle the power and be ready with the latest OS image.
122129

123130
***After booting, you will need to wait 10 seconds until the Portenta X8 starts blinking Blue LED. The Blue LED indicates it was able to boot successfully.***
124131

0 commit comments

Comments
 (0)