Merge pull request #167 from arduino/marqdevx/portenta-X8/flashing-tutorial

Portenta X8: Flashing tutorial[PC-892]

Author: marqdevx

content/hardware/04.pro/boards/portenta-x8/tutorials/image-flashing/assets/foundries-factories-target-runs.png

@@ -0,0 +1,99 @@
+---
+beta: true
+title: 'How To Flash Your Portenta X8'
+description: 'This tutorial teaches you how to flash your Portenta X8 through USB'
+difficulty: intermediate
+tags:
+  - Embedded Linux
+  - Flashing
+  - Foundries.io
+author: 'Pablo Marquínez'
+hardware:
+  - hardware/04.pro/boards/portenta-x8
+---
+
+## Overview
+
+In this tutorial you will see how to manually flash your Portenta X8 with the image that is provided by Foundries.io through USB using the Terminal.
+
+## Goals
+
+- Get the required files
+- Set up the correct structure of the files
+- Set up the board
+- Flash the device
+
+### Required Hardware and Software
+
+- USB-C to USB-A or USB-C to USB-C
+- Portenta X8
+- Portenta Breakout Board <!-- or Portenta Max Carrier-->
+- Arduino Create account
+- Arduino Create Pro subscription
+- Foundries.io account (linked with the Pro plan)
+- FoundriesFactory® ([Check the Getting Started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box))
+- 1 Device already attached to your factory ([Check the Getting Started tutorial](https://docs.arduino.cc/tutorials/portenta-x8/out-of-the-box))
+    
+## Instructions
+
+### Get the Required Files
+
+Required files following this structure:
+
+```
+Root folder
+├── imx-boot
+├── imx-boot-portenta-x8
+├── lmp-partner-arduino-image-portenta-x8.wic.gz **(Unzipped)**
+├── mfgtool-files-portenta-x8.tar **(Unzipped)**
+├── sit-portenta-x8.bin
+└── u-boot-portenta-x8.itb
+```
+
+To get those files open your FoundriesFactory®.
+
+![Foundries.io factories dashboard](assets/foundries-factories.png)
+
+Switch to the targets tab.
+
+![Foundries.io factory targets tab](assets/foundries-factories-targets.png)
+
+Click on the platform-master version.
+
+![Foundries.io tag dashboard](assets/foundries-factories-targets-dashboard.png)
+
+On the "Runs" section open those collapsed labels, and download the files listed above by clicking on their text (like a normal link).
+
+![Foundries.io target runs section](assets/foundries-factories-target-runs.png)
+
+After downloading them, make sure you put them in a folder following the structure shown.
+
+### Set the Portenta X8 to Flashing Mode
+
+Plug your Porenta X8 into your carrier (Portenta Breakout carrier <!-- or Portenta Max Carrier-->).
+
+Switch both DIP switches to the ON position.
+
+Plug the USB-C end into the Portenta X8 and the other end (USB-C or USB-A) to your computer.
+
+You will see a new device connected called `SE Blank M845S`.
+
+### Flash the Device
+
+Open a terminal and change the directory (`cd`) to your root folder as shown in the beginning.
+
+Use the `uuu full_image.uuu` command.
+
+Wait until it gets flashed.
+
+![uuu tool flashing success output](assets/uuu-flashing-success.png)
+
+Switch back the DIP switches to OFF position.
+
+Unplug and then plug in the Portenta X8 to your computer.
+
+***After flashing you will need to wait 10 secs, until the Portenta X8 blue LED starts blinking, this means the boot was successful***
+
+## Troubleshooting
+
+- If you get an error while its flashing, make sure your USB is correctly plugged in. Re-plug your board and try to flash again, you may need few tries before the flashing is successful.