fri2: Update README

o Technical writing feedback from Scott Rifenbark
o Updated and refactored device notes, including
  a new section on BIOS and firmware
o Added dim secondary HDMI port to known issues

Signed-off-by: Darren Hart <dvhart@linux.intel.com>
CC: Scott Rifenbark <scott.m.rifenbark@intel.com>

1 files changed, 85 insertions, 45 deletions

diff --git a/meta-fri2/README b/meta-fri2/README
index 2208392f..a93e76fb 100644
--- a/meta-fri2/README
+++ b/meta-fri2/README
@@ -1,5 +1,5 @@
 This README file contains information on building the meta-fri2 BSP
-layer, and booting the images contained in the /binary directory.
+layer and booting the images contained in the /binary directory.
 Please see the corresponding sections below for details.
 
 The Fish River Island II BSP supports the Kontron M2M Smart Services
@@ -50,20 +50,23 @@ Table of Contents
   I. Building the meta-fri2 BSP layer
  II. Booting the images in /binary
 III. Device Notes
-     a. Serial Port
-     b. HDMI
-     c. Power Reset
-     d. Accelerometer
-     e. GPIO
-     f. MMC
-     g. 802.11
-     h. 802.15.4
-     i. Audio
-     j. Optional devices
+     a. BIOS and Firmware
+     b. Serial Port
+     c. HDMI
+     d. Power Reset
+     e. Accelerometer
+     f. GPIO
+     g. MMC
+     h. 802.11
+     i. 802.15.4
+     j. Audio
+     k. Optional Devices
  IV. Known Issues
      a. EFI boot fails
      b. Client USB is disabled
      c. Audio over secondary HDMI port only
+     d. Secondary HDMI port is dim under X
+  V. Additional Resources
 
 
 I. Building the meta-fri2 BSP layer
@@ -99,7 +102,7 @@ in your local.conf.  For example:
 
   LICENSE_FLAGS_WHITELIST = "license_emgd-driver-bin_1.10"
 
-If you want to enable the layer that does not support EMGD graphics
+If you want to enable the layer that does not support EMGD graphics,
 add the following to the local.conf file:
 
   MACHINE ?= "fri2-noemgd"
@@ -151,6 +154,11 @@ ifconfig the IP address and use that to ssh in.  The root password is
 empty, so to log in type 'root' for the user name and hit 'Enter' at
 the Password prompt: and you should be in.
 
+If instead of a live image, you would like to prepare an EFI bootable
+partitioned image, use the mkefidisk.sh script provided in the scripts
+directory of this BSP. Future versions of the images have an EFI
+installer integrated into the live image.
+
 ----
 
 If you find you're getting corrupt images on the USB (it doesn't show
@@ -162,10 +170,26 @@ characters), try doing this first:
 
 III. Device Notes
 ================================
-a. Serial Port
+a. BIOS and Firmware
+
+Units provided from the Yocto Project Fish River Island 2 Giveaway
+Program are preconfigured with the Intel provided Fast Boot firmware.
+This firmware will search the available devices (USB, SD, and mSATA) for
+a valid EFI payload at "EFI\BOOT\BOOTIA32.EFI". If it fails to find one,
+it will launch the EFI shell and optionally execute a "startup.nsh"
+script if it finds the script on the available storage devices. It
+searches the devices in the following order: USB, SD, mSATA.
+
+Units acquired via other channels may have the Kontron supplied APTIO
+(AMI) BIOS. This is a PCBIOS and EFI firmware with a traditional BIOS
+configuration menu which can be used to define a variety of boot
+configurations.
+
+
+b. Serial Port
 --------------
 The FRI2 has an optional serial daughter card providing a serial
-console via the micro-USB port on the top of the device adjascent the
+console via the micro-USB port on the top of the device adjacent the
 SIM card slot.
 
 The UART from the EG20T is connected to a TI UART-to-USB device
@@ -181,9 +205,9 @@ When you power on your FRI2, your host will discover a serial device
 and name it /dev/ttyUSB0 (or similar). You can communicate with this
 device at 115200 8N1 using your preferred terminal emulator.
 
-In order to redirect the BIOS console to the serial port, you may need
-to set up console redirection in the BIOS menu. The serial port is
-referred to as COM2 in the BIOS.
+If using the Intel provided Fast Boot firmware, no additional
+configuration is required. If using the APTIO (AMI) BIOS, use the
+following settings to configure console redirection in the BIOS menu:
 
   Advanced
     Serial Port Console Redirection
@@ -200,50 +224,46 @@ referred to as COM2 in the BIOS.
         Resolution 100x31     [Disabled]
         Legacy OS Redirection [80x24]
 
-Note that the UART clock is configured at 48MHz in the firmware. This
-will cause problems with software assuming a typical 1.8 MHz clock.
-The Linux kernel pch-uart driver is aware of the clock, but Syslinux,
-for example, is not. For software expecting a typical clock, directing
-them to use a BAUD of 3318 (rather than 115200) can work around the
-problem.
 
-b. HDMI
+c. HDMI
 -------
-The FRI2 has two micro HDMI ports. The one closest to the 1/8" audio
-jacks is the primary display.
+The FRI2 has two micro HDMI ports. For the Intel provided Fast Boot
+firmware, the one closest to the bottom of the device is the primary
+display. For the APTIO (AMI) BIOS, the jack nearest the 1/8" audio jacks
+is the primary display.
 
-c. Power Reset
+d. Power Reset
 --------------
 The recessed button adjacent the LEDs on the top of the device is a
 power reset button.
 
-d. Accelerometer
+e. Accelerometer
 ----------------
 The LIS331DLH accelerometer is connected to the I2C bus on the CPLD on
 the compute module. The driver for this chip is under active
 development and will be included in the BSP once completed.
 
-e. GPIO
+f. GPIO
 -------
 The FRI2 has two I2C PCA555x GPIO devices used for internal control
 signals. These have not been exposed in the current release of the
 BSP, but may be in the future. Regardless, these do would not provide
 general purpose IO with which to read or drive additional signals.
 
-f. MMC
+g. MMC
 ------
 The FRI2 provides two microSD card MMC devices. One is located
 adjacent the 1/8" audio jacks, another is located on the board inside
 the chassis. These devices can be used to boot the device, or as
 secondary storage.
 
-g. 802.11
+h. 802.11
 ---------
 The Intel Corporation Centrino Advanced-N 6205 that ships with the
 FRI2 is supported. You can use connman-gnome to configures the
 interface.
 
-h. 802.15.4
+i. 802.15.4
 -----------
 The TI CC2531 802.15.4 radio is a USB ACM modem. The MAC is enabled by
 issuing the following command:
@@ -256,11 +276,11 @@ the 802.15.4 device may appear as /dev/ttyACM3 instead.
 
 No further testing or integration has been done.
 
-i. Audio
+j. Audio
 --------------------
 The FRI2 has an 1/8" analog output (nearest the antennae), a line-in
 input below that, as well as SPDIF over HDMI. These can be tested
-using the alsa-utils package. aplay -l will list both playback
+using the alsa-utils package. The aplay -l command will list both playback
 devices:
 
 # aplay -l
@@ -281,7 +301,7 @@ Over HDMI:
 # aplay -D plughw:0,3 sample.wav
 
 
-j. Optional Devices
+k. Optional Devices
 -------------------
 The FRI2 has two mini-PCIe slots internally. The device ships with a
 half-length wireless card installed. This can be replaced with a
@@ -290,27 +310,47 @@ cellular cards or mSATA SSDs.
 
 The Ericsson F5521gw 3G modem has been verifed with the FRI2 images.
 Note that the connman-gnome UI does not allow for configuring the
-cellular interface. The ofono-tests package can be used to configure
-the modem and bring up an interface.
+cellular interface. The ofono-tests package can be used to configure the
+modem and bring up an interface.
 
 
 IV. Known Issues
 ----------------
 a. EFI
 ------
-The FRI2 firmware can boot to an EFI shell. It does not yet boot the
-EFI payload provided on the FRI2 live image. This is a known issue
-under investigation.
+The APTIO (AMI) BIOS does not yet boot the EFI payload provided on the
+FRI2 live image. This is a known issue under investigation. If using
+this firmware, boot using PCBIOS mode, rather than EFI.  The Intel
+provided Fast Boot firmware will boot the EFI payload.
 
 b. Client USB is disabled
 -------------------------
-The micro-USB port adjacent the primary HDMI port is intended for
-Client USB functionality, but is not supported on current revisions of
-the device.
+The micro-USB port adjacent the primary HDMI port is intended for Client
+USB functionality, but is not supported on current revisions of the
+device.
 
 c. Audio over secondary HDMI port only
 --------------------------------------
 While audio over HDMI has been shown to work, it seems to only work over
 the secondary (bottom-most) HDMI port. There does not appear to be a
-deterministic way of getting the device to output the signal (video and audio)
-over the secondary port.
+deterministic way of getting the device to output the signal (video and
+audio) over the secondary port.
+
+d. Secondary HDMI port is dim under X
+-------------------------------------
+The EMGD driver appears to display a dim image on the secondary
+(bottom-most) HDMI port. With the Intel provided Fast Boot firmware, the
+EFI shell and payload (including the Linux kernel messages and tty) are
+only displayed over the secondary HDMI port. For scenarios requiring a
+graphical display, the workaround is to connect the display to the
+primary HDMI port and boot unattended, or using the serial port if
+manual interaction is required. A software fix including an upgraded
+EMGD driver is planned for the 1.3 version of the BSP.
+
+
+V. Additional Resources
+-----------------------
+In addition to this README, please see the following wiki page for tips
+on using the FRI2 with the Yocto Project:
+
+https://wiki.yoctoproject.org/wiki/BSPs/FRI2