From 474dea8b0cf5e735a16f6496b1af0637eccb061b Mon Sep 17 00:00:00 2001 From: Tim Gover Date: Sat, 30 Nov 2024 12:35:32 +0000 Subject: [PATCH 1/2] compute module: Add note about support / diagnostic tips. rpiboot is known to work well on Raspberry Pi and RPi OS because it is used for manufacturing test. Other platforms are best-effort or community maintained due to the huge variety of potential hardware/software interop possibilities. --- .../computers/compute-module/cm-emmc-flashing.adoc | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc index e57adb39d..5a737b076 100644 --- a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc @@ -13,10 +13,13 @@ The Compute Module has an on-board eMMC device connected to the primary SD card To flash the Compute Module eMMC, you need the following: -* Another computer, referred to in this guide as the *host device*. You can use Linux (we recommend Raspberry Pi OS or Ubuntu), Windows, or macOS. +* Another computer, referred to in this guide as the *host device*. You can use Linux (we recommend Raspberry Pi OS or Ubuntu), Windows 11, or macOS. * The Compute Module IO Board xref:compute-module.adoc#io-board-compatibility[that corresponds to your Compute Module model]. * A micro USB cable, or a USB-C cable for Compute Module models since CM5IO. +NOTE: If the Compute Module is not recognised then please remove any USB hubs between the *host device* and the Compute Module. +For more diagnostic tips see https://github.com/raspberrypi/usbboot?tab=readme-ov-file#troubleshooting + === Set up the IO Board To begin, physically set up your IO Board. This includes connecting the Compute Module and host device to the IO Board. @@ -52,6 +55,8 @@ To set up the Compute Module IO Board: Next, let's set up software on the host device. +The recommended host device is a Raspberry Pi 4 or newer running Raspberry Pi OS 64-bit. + [tabs%sync] ====== Linux:: @@ -89,10 +94,11 @@ $ sudo ./rpiboot Windows:: + -To set up software on a Windows host device: +To set up software on a Windows 11 host device: + . Download the https://github.com/raspberrypi/usbboot/raw/master/win32/rpiboot_setup.exe[Windows installer] or https://github.com/raspberrypi/usbboot[build `rpiboot` from source]. -. Double-click on the installer to run it. This installs the drivers and boot tool. +. Double-click on the installer to run it. This installs the drivers and boot tool. Do not close any driver installation windows which appear in the installation process. +. Reboot . Connect the IO Board to power. Windows should discover the hardware and configure the required drivers. . On CM4 and later devices, select **Raspberry Pi - Mass Storage Gadget - 64-bit** from the start menu. After a few seconds, the Compute Module eMMC or NVMe will appear as USB mass storage devices. This also provides a debug console as a serial port gadget. . On CM3 and older devices, select **rpiboot**. Double-click on `RPiBoot.exe` to run it. After a few seconds, the Compute Module eMMC should appear as a USB mass storage device. From 053b986df64e5b9ca955daee945a09bf61970b05 Mon Sep 17 00:00:00 2001 From: nate contino Date: Mon, 2 Dec 2024 09:10:12 +0000 Subject: [PATCH 2/2] Apply suggestions from code review --- .../computers/compute-module/cm-emmc-flashing.adoc | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc index 5a737b076..29490addf 100644 --- a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc @@ -17,8 +17,7 @@ To flash the Compute Module eMMC, you need the following: * The Compute Module IO Board xref:compute-module.adoc#io-board-compatibility[that corresponds to your Compute Module model]. * A micro USB cable, or a USB-C cable for Compute Module models since CM5IO. -NOTE: If the Compute Module is not recognised then please remove any USB hubs between the *host device* and the Compute Module. -For more diagnostic tips see https://github.com/raspberrypi/usbboot?tab=readme-ov-file#troubleshooting +TIP: In some cases, USB hubs can prevent the host device from recognising the Compute Module. If your host device does not recognise the Compute Module, try connecting the Compute Module directly to the host device. For more diagnostic tips, see https://github.com/raspberrypi/usbboot?tab=readme-ov-file#troubleshooting[the usbboot troubleshooting guide]. === Set up the IO Board @@ -55,7 +54,7 @@ To set up the Compute Module IO Board: Next, let's set up software on the host device. -The recommended host device is a Raspberry Pi 4 or newer running Raspberry Pi OS 64-bit. +TIP: For a host device, we recommend a Raspberry Pi 4 or newer running 64-bit Raspberry Pi OS. [tabs%sync] ====== @@ -97,7 +96,7 @@ Windows:: To set up software on a Windows 11 host device: + . Download the https://github.com/raspberrypi/usbboot/raw/master/win32/rpiboot_setup.exe[Windows installer] or https://github.com/raspberrypi/usbboot[build `rpiboot` from source]. -. Double-click on the installer to run it. This installs the drivers and boot tool. Do not close any driver installation windows which appear in the installation process. +. Double-click on the installer to run it. This installs the drivers and boot tool. Do not close any driver installation windows which appear during the installation process. . Reboot . Connect the IO Board to power. Windows should discover the hardware and configure the required drivers. . On CM4 and later devices, select **Raspberry Pi - Mass Storage Gadget - 64-bit** from the start menu. After a few seconds, the Compute Module eMMC or NVMe will appear as USB mass storage devices. This also provides a debug console as a serial port gadget.