CM-FX6: U-Boot: Display and console - Revision history

Nikita: /* splashsource */

2015-09-02T11:29:55Z

‎splashsource

Nikita: /* Flashing the splash image into the SPI flash */

2015-05-10T11:17:02Z

‎Flashing the splash image into the SPI flash

Nikita at 17:09, 10 February 2015

2015-02-10T17:09:31Z

Nikita at 13:23, 19 January 2015

2015-01-19T13:23:20Z

New page

== Display support ==
CM-FX6 U-Boot supports displays that are connected via HDMI interface, and a resolution of 1024x768.

=== Enable display ===
* To enable display, set the {{parameter|displaytype}} environment variable to one of the supported display presets:
<pre>
> setenv displaytype <preset>
> saveenv
</pre>
* The supported values of {{parameter|displaytype}} are: HDMI.
* For backwards compatibility, the {{parameter|displaytype}} variable can be substituted with the {{parameter|panel}} variable. If both variables are defined, {{parameter|displaytype}} takes precedence.

== Console support ==
CM-FX6 U-Boot can send console output to the following devices: serial, HDMI display.
CM-FX6 U-Boot can accept console input from the following devices: serial, USB keyboard.

By default, U-Boot only performs console I/O over serial. If display is enabled (see [[#Enable display | Enable display]]), only the Compulab logo and the U-Boot header are displayed (no console output).
This behavior can be overridden in various ways:

=== Console input: enabling USB keyboard ===

* Connect USB keyboard to a USB port.
* Start USB subsystem to detect the USB keyboard:
<pre>
> usb start
</pre>
* Add USB keyboard as console input device:
<pre>
> setenv stdin serial,usbkbd
> saveenv
</pre>
* To make U-Boot detect the keyboard automatically at boot, run the following commands:
<pre>
> setenv preboot "usb start"
> saveenv
</pre>

=== Console output: enabling framebuffer console ===

To output console to the display screen, run the following commands:
<pre>
> setenv stdout serial,vga
> setenv stderr serial,vga
> saveenv
</pre>

Enabling framebuffer console will display the console output below the Compulab logo if no splash screen is setup, and will overwrite the splash screen otherwise.

== Splash screen ==

The following setup is required to enable splash screen display:
* Connect a display to the SB-FX6 as described in [http://compulab.co.il/products/computer-on-modules/cm-fx6/#devres SB-FX6 reference manual]
* [[#Flashing the splash screen image into the SPI flash|Store a splash screen image in the CM-FX6 SPI flash]]
* [[#Setting up the environment|Setup U-Boot environment]]

=== Splash screen image ===

U-Boot for CM-FX6 supports uncompressed 8-bit BMP splash screen images.
An example of such an image can be found in the U-Boot for CM-FX6 package ([[#See also|here]]) under {{parameter|utilities-->splash_images}} folder.
The splash screen image can be stored in the CM-FX6 SPI flash at offset {{parameter|0x100000}}.
U-Boot will automatically relocate the splash screen image from its storage into the MX6 display frame buffer.<br>

==== Flashing the splash screen image into the SPI flash ====

To write the splash screen image into the SPI flash use the following command sequence:
* Download the image to the CM-FX6 RAM:
<pre>
> tftp 10800000 <bmp file name>
</pre>
* Or read the image from MMC/SD card:
<pre>
> mmc dev 2
> mmc rescan
> load mmc 2 10800000 <bmp file name>
</pre>
* Detect SPI flash
<pre>
> sf probe
</pre>
* Erase the SPI flash at offset 0x100000:
<pre>
> sf erase 100000 <bmp size>
</pre>
* Write the splash screen image into the SPI flash:
<pre>
> sf write 10800000 100000 <bmp size>
</pre>
Now the splash screen is in the SPI flash.

==== Setting up the environment ====
===== splashsource =====

* Set the {{parameter|splashsource}} variable to one of the supported storage devices for splash image (optional). For example, the following selects SPI flash as the storage device:
<pre>
> setenv splashsource sf
> saveenv
</pre>
* If {{parameter|splashsource}} is not defined, U-Boot will default to loading splash screen from SPI flash.
* The supported values for {{parameter|splashsource}} are: sf.

===== splashimage =====
* Set the {{parameter|splashimage}} variable to the address to which you wish U-Boot to load the splash image from its storage. For example:
<pre>
> setenv splashimage 10800000
> saveenv
</pre>

== See also ==
* [http://compulab.co.il/products/computer-on-modules/cm-fx6/#devres CM-FX6 U-Boot package]
* [[U-Boot quick reference]]
* [http://www.denx.de/wiki/U-Boot/Documentation U-Boot documentation]

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

@@ Line 103: / Line 103: @@
 </pre>
 Now the splash screen is in the SPI flash.
 === Setting up the environment ===
@@ Line 113: / Line 117: @@
 </pre>
 * If {{parameter|splashsource}} is not defined, U-Boot will default to loading splash screen from SPI flash.
-* Currently the only supported value for {{parameter|splashsource}} is: sf.
+* The supported values for {{parameter|splashsource}} are
 ==== splashimage ====

@@ Line 96: / Line 96: @@
 * Erase the SPI flash at offset 0x100000:
 <pre>
-# sf erase 100000 <bmp size>
+# sf erase 100000 100000
 </pre>
 * Write the in-memory splash screen image into the SPI flash:
 <pre>
-# sf write 10800000 100000 <bmp size>
+# sf write 10800000 100000 100000
 </pre>
 Now the splash screen is in the SPI flash.

@@ Line 5: / Line 5: @@
 * To enable display, set the {{parameter|displaytype}} environment variable to one of the supported display presets:
 <pre>
-> setenv displaytype &lt;preset&gt;
+# setenv displaytype <preset>
-> saveenv
+# saveenv
 </pre>
 * The supported values of {{parameter|displaytype}} are: HDMI.
@@ Line 12: / Line 12: @@
 == Console support ==
-CM-FX6 U-Boot can send console output to the following devices: serial, HDMI display.
+CM-FX6 U-Boot can send console output to the serial port and HDMI display.
-CM-FX6 U-Boot can accept console input from the following devices: serial, USB keyboard.
+CM-FX6 U-Boot can accept console input from the serial port and USB keyboard.
 By default, U-Boot only performs console I/O over serial. If display is enabled (see [[#Enable display | Enable display]]), only the Compulab logo and the U-Boot header are displayed (no console output).
-This behavior can be overridden in various ways:
+This behaviour can be modified in various ways:
 === Console input: enabling USB keyboard ===
@@ Line 23: / Line 23: @@
 * Start USB subsystem to detect the USB keyboard:
 <pre>
-> usb start
+# usb start
 </pre>
 * Add USB keyboard as console input device:
 <pre>
-> setenv stdin serial,usbkbd
+# setenv stdin serial,usbkbd
-> saveenv
+# saveenv
 </pre>
 * To make U-Boot detect the keyboard automatically at boot, run the following commands:
 <pre>
-> setenv preboot "usb start"
+# setenv preboot "usb start"
-> saveenv
+# saveenv
 </pre>
@@ Line 40: / Line 40: @@
 To output console to the display screen, run the following commands:
 <pre>
-> setenv stdout serial,vga
+# setenv stdout serial,vga
-> setenv stderr serial,vga
+# setenv stderr serial,vga
-> saveenv
+# saveenv
 </pre>
@@ Line 48: / Line 48: @@
 == Splash screen ==
 U-Boot for CM-FX6 supports uncompressed 8-bit BMP splash screen images.
@@ Line 61: / Line 54: @@
 U-Boot will automatically relocate the splash screen image from its storage into the MX6 display frame buffer.<br>
-==== Flashing the splash screen image into the SPI flash ====
+The following setup is required to enable splash screen display:
-To write the splash screen image into the SPI flash use the following command sequence:
+Splash image can be read into memory from a variety of sources:
-* Download the image to the CM-FX6 RAM:
+* Network download:
 <pre>
-> tftp 10800000 <bmp file name>
+# mmc dev 2
 </pre>
-* Or read the image from MMC/SD card:
+* USB storage:
 <pre>
-> mmc dev 2
+# usb start
-> mmc rescan
+# load usb <device number> 10800000 <bmp file name>
 </pre>
 * Detect SPI flash
 <pre>
-> sf probe
+# sf probe
 </pre>
 * Erase the SPI flash at offset 0x100000:
 <pre>
-> sf erase 100000 <bmp size>
+# sf erase 100000 <bmp size>
 </pre>
-* Write the splash screen image into the SPI flash:
+* Write the in-memory splash screen image into the SPI flash:
 <pre>
-> sf write 10800000 100000 <bmp size>
+# sf write 10800000 100000 <bmp size>
 </pre>
 Now the splash screen is in the SPI flash.
-==== Setting up the environment ====
+=== Setting up the environment ===
-===== splashsource =====
+==== splashsource ====
 * Set the {{parameter|splashsource}} variable to one of the supported storage devices for splash image (optional). For example, the following selects SPI flash as the storage device:
 <pre>
-> setenv splashsource sf
+# setenv splashsource sf
-> saveenv
+# saveenv
 </pre>
 * If {{parameter|splashsource}} is not defined, U-Boot will default to loading splash screen from SPI flash.
-* The supported values for {{parameter|splashsource}} are: sf.
+* Currently the only supported value for {{parameter|splashsource}} is: sf.
-===== splashimage =====
+==== splashimage ====
-* Set the {{parameter|splashimage}} variable to the address to which you wish U-Boot to load the splash image from its storage. For example:
+* Set the {{parameter|splashimage}} variable to the address where you wish U-Boot to load the splash image from the storage. For example:
 <pre>
-> setenv splashimage 10800000
+# setenv splashimage 10800000
-> saveenv
+# saveenv
 </pre>