meta-intel/meta-romley/README

This README file contains information on building the meta-romley
BSP layer, and booting the images contained in the /binary directory.
Please see the corresponding sections below for details.

The romley platform consists of two versions:
1. romley - Sandy Bridge
2. romley - Ivy Bridge

The romley - Sandy Bridge platform consists of the Intel Xeon E5-2600
and E5-2400 Series processors, plus the Intel C604/C602-J chipset
(Sandy Bridge-EP/EN + Patsburg).

The romley - Ivy Bridge platform consists of the Intel Xeon E5-2600
and E5-2400 v2 Series processors with the Intel C604/C602-J chipset
(Ivy Bridge-EP/EN + Patsburg).

This BSP assumes Matrox graphics is being used.

Further information about the platforms supported by this BSP can be
found here:

  http://www.intel.com/p/en_US/embedded/hwsw/hardware/xeon-e5-c604/overview

Information on all Intel® embedded platforms can be found here:

  http://www.intel.com/p/en_US/embedded/hwsw/hardware


Yocto Project Compatible
========================

This BSP is compatible with the Yocto Project as per the requirements
listed here:

  https://www.yoctoproject.org/webform/yocto-project-compatible-registration


Dependencies
============

This layer depends on:

  URI: git://git.openembedded.org/bitbake
  branch: master

  URI: git://git.openembedded.org/openembedded-core
  layers: meta
  branch: master

  URI: git://git.yoctoproject.org/meta-intel
  layers: intel
  branch: master


Patches
=======

Please submit any patches against this BSP to the meta-intel mailing
list (meta-intel@yoctoproject.org) and cc: the maintainer:

Maintainer: Chan Wei Sern <wei.sern.chan@intel.com>

Please see the meta-intel/MAINTAINERS file for more details.


Table of Contents
=================

  I. Building the meta-romley BSP layer
 II. Booting the images in /binary
III. Device Notes
    a. Boot Loader
    b. I/O drivers
IV. Enabling Intel DPDK Technology

I. Building the meta-romley BSP layer
=======================================

In order to build an image with BSP support for a given release, you
need to download the corresponding BSP tarball from the 'Board Support
Package (BSP) Downloads' page of the Yocto Project website.

Having done that, and assuming you extracted the BSP tarball contents
at the top-level of your yocto build tree, you can build a romley
image by adding the location of the meta-romley layer to
bblayers.conf, along with the meta-intel layer itself (to access
common metadata shared between BSPs) e.g.:

  yocto/meta-intel \
  yocto/meta-intel/meta-romley \

To enable the romley Sandy Bridge layer, add the romley MACHINE to local.conf:

  MACHINE ?= "romley"

To enable the romley Ivy Bridge layer, add the romley-ivb MACHINE to local.conf:

  MACHINE ?= "romley-ivb"

You should then be able to build a romley image as such:

  $ source oe-init-build-env
  $ bitbake core-image-sato

At the end of a successful build, you should have a live image that
you can boot from a USB flash drive (see instructions on how to do
that below, in the section 'Booting the images from /binary').

As an alternative to downloading the BSP tarball, you can also work
directly from the meta-intel git repository.  For each BSP in the
'meta-intel' repository, there are multiple branches, one
corresponding to each major release starting with 'laverne' (0.90), in
addition to the latest code which tracks the current master (note that
not all BSPs are present in every release).  Instead of extracting a
BSP tarball at the top level of your yocto build tree, you can
equivalently check out the appropriate branch from the meta-intel
repository at the same location.


II. Booting the images in /binary
=================================

This BSP contains bootable live images, which can be used to directly
boot Yocto off of a USB flash drive.

Under Linux, insert a USB flash drive.  Assuming the USB flash drive
takes device /dev/sdf, use dd to copy the live image to it.  For
example:

# dd if=core-image-sato-romley.hddimg of=/dev/sdf
# sync
# eject /dev/sdf

This should give you a bootable USB flash device.  Insert the device
into a bootable USB socket on the target, and power on.  This should
result in a system booted to the Sato graphical desktop.

If you want a terminal, use the arrows at the top of the UI to move to
different pages of available applications, one of which is named
'Terminal'.  Clicking that should give you a root terminal.

If you want to ssh into the system, you can use the root terminal to
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 you're using Rose City and does not have ME firmware and struggling with
rebooting the machine. This is because broken ME firmware can contribute to long wait of
reboot. We have to changing the kernel command line to blacklist MEI driver to be loaded:

1. Open your syslinux in VI editor eg:
    # vi /media/sda/syslinux.cfg

2. Look for the line that has kernel command line which has certain similiarity
   as below:

   "APPEND initrd=/initrd LABEL=boot root=/dev/ram0 ....."

   or

   "APPEND initrd=/initrd LABEL=install root=/dev/ram0 ...."

3. Add "mei_me.blacklist=yes"at the end of that line and it will be like below:
   "APPEND inird=/initRD LABEL=boot root=/dev/ram0 .... mei_me.blacklist=yes"

4. Save this syslinux.cfg

5. Boot up the Romley with this new changed.


III. Device Notes
=================

a. Boot Loader
--------------
- Support BIOS version at RoseCity board :RMLCRB.86J.R0.45.D018

b. I/O drivers
--------------
-Support Matrox graphic card.
-Support SATA, USB Host v2.0
-Supported I/O devices (APIC, RTC, SPI, UART, I2C, LPS, SMBus i801,
 WDT, and HPET)

IV. Enabling Intel DPDK Technology
===================================

There are recipes available for the 'Intel Data Plane Development Kit
Technology components for use with this BSP.  Please contact your
Intel Field Sales Representative or visit Intel Embedded Design
Center (www.intel.com/p/en_US/embedded/designcenter) for instructions on how
to locate and use these recipes.
----

If you find you're getting corrupt images on the USB (it doesn't show
the syslinux boot: prompt, or the boot: prompt contains strange
characters), try doing this first:

# dd if=/dev/zero of=/dev/sdf bs=1M count=512