View source for CM-X300: U-Boot: Disabled Module Recovery

== Overview ==

The CM-X300 firmware is required for hardware initialization, setup and operating system loading. The firmware resides in the beginning of the NAND flash (0x0 - 0x80000), therefore any write to this location, except for the update procedure, will corrupt the CM-X300 firmware.<br>
While updating the CM-X300 firmware, there is a possibility that the update will not perform as expected and CM-X300 firmware can become invalid. This will result in a disabled CM-X300.<br>
In such cases, CompuLab offers two solutions:
# [[CM-X300: U-Boot: Disabled Module Recovery#Sending disabled CM-X300 module to CompuLab|Send the disabled board to CompuLab for reprogramming]]
# [[CM-X300: U-Boot: Disabled Module Recovery#CM-X300 Recovery baseboard|Recover the CM-X300 disabled module with Recovery baseboard]]

== Sending disabled CM-X300 module to CompuLab ==

This option is recommended for one-time CM-X300 recovery.<br>
This option is not recommended for U-Boot developers, as sending boards to CompuLab takes time and impacts the development process.<br>
To continue with the RMA procedure, please consult [http://www.compulab.co.il/sales-and-support/rma.htm CompuLab website].

== CM-X300 Recovery baseboard ==

The CM-X300 Recovery baseboard is not fully functional baseboard for CM-X300. It is used '''only''' to recover the disabled CM-X300.<br>
It has the following items assembled:
* 9-pin serial port for U-Boot console
* Ethernet port
* 2 USB ports (lower port can be used only on modules with no W option)
* 3-pin power connector
* CAMI connectors (for CM-X300 placement)
* Write-protected NAND flash (storing the working copy of CM-X300 firmware and automatic update script)
* Reset button (SW1)
* Update button (SW3)

=== Getting started with the recovery process ===

Make sure you have the following items at hand:
* CM-X300 Recovery baseboard
* Serial cable
* PSU for the Recovery baseboard
* Ethernet cable - required for recovering via TFTP
* USB flash drive formatted with FAT filesystem - required for recovering from USB

Make the necessary preparations for the recovery procedure:
# Download the latest CM-X300 firmware from [http://compulab.co.il/products/computer-on-modules/cm-x300/#devres CompuLab website], unzip and place the file {{filename|cm-x300-firmware}} into a USB flash drive or TFTP server root directory.
# Make sure the CM-X300 Recovery baseboard is powered off
# Plug the disabled CM-X300 into the CAMI connectors
# Connect the serial cable to the CM-X300 Recovery baseboard
# Connect the second end of the serial cable to your host workstation
# On your host workstation:
## Start a terminal application on the appropriate COM port
## Configure the terminal application for: baud rate 38400, 1 stop bit, no parity, no flow control
# Proceed to [[CM-X300: U-Boot: Disabled Module Recovery#Recovering from USB flash drive|Recovering from USB flash drive]] or [[CM-X300: U-Boot: Disabled Module Recovery#Recovering via TFTP|Recovering via TFTP]]

=== Recovering from USB flash drive ===

Recovery procedure using USB is handled by an automatic script.<br>
To recover using USB, follow the instructions:
# Insert USB flash drive with {{filename|cm-x300-firmware}} into the '''upper''' USB port
# Press and hold the '''UPDATE''' button (SW3).
# While holding the '''UPDATE''' button, power on the Recovery baseboard.
# In your terminal application you should see the U-Boot start up messages, if you don't see any messages, turn off the Recovery baseboard and check your serial connection.
# When you see the "'''PLEASE, RELEASE THE UPDATE BUTTON!!!'''" message, release the '''UPDATE''' button. '''Note:''' if the '''UPDATE''' button is not released during 5 seconds the update will fail!
# Let the automatic script handle the update process.
# After the update process completed, you will see the message: "'''NAND update finished successfully! Your CM-X300 module should be usable now.'''"
# Make sure that the '''UPDATE''' button is released and reset the Recovery baseboard.
# U-Boot will start, and the Recovery process is now completed.

=== Recovering via TFTP ===

{{Note|This recovery method is available for CM-X300 with "E" option only.}}

To recover the disabled CM-X300 using TFTP, follow the instructions:
# Plug Ethernet cable into the Ethernet port
# Press and hold the '''UPDATE''' button (SW3).
# While holding the '''UPDATE''' button, power on the Recovery baseboard.
# In terminal application you should see the U-Boot start up messages, if you don't see any messages, turn off the Recovery baseboard and check all connectors.
# When you see the "'''Hit any key to stop autoboot:'''" message, press any key and stop the automatic USB update script. '''Note:''' if a key is not pressed during 3 seconds the update will fail!
# Release the '''UPDATE''' button.
# Set the MAC address:<pre>> setenv ethaddr "00:01:c0:05:f0:29"</pre>
# To use a DHCP server for the automatic IP address assignment, type:<pre>> dhcp</pre>
# To assign the IP address manually, type:<pre>> setenv ipaddr <CM-X300 IP address></pre>
# Set the IP address of your TFTP server:<pre>> setenv serverip <TFTP server IP address></pre>
# Download the CM-X300 firmware from TFTP server and update the NAND flash:<pre>> run tftp_read && run nand_update</pre>
# After the update process completed, make sure the '''UPDATE''' button is released and reset the Recovery board.
# U-Boot will start, and the Recovery process is now completed.

== See Also ==

* [[CM-X300: U-Boot: Firmware Update]]
* [[U-Boot quick reference]]
* [[U-Boot images]]
* [http://www.denx.de/wiki/U-Boot/Documentation U-Boot documentation]
* [[CM-X300: U-Boot: Firmware Development]]


[[Category:U-Boot]]
[[Category:CM-X300]]