Intel Quark SoC X1000 User manual

Order Number: 329687-007US
Intel®Quark™SoC X1000
Board Support Package (BSP)
Build and Software User Guide
Release: 1.0.1
16 June 2014

Contents
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
2 Order Number: 329687-007US
Contents
1About this document .........................................................................................4
Part 1 Building the BSP software .............................................................................................5
2Before you begin ..............................................................................................5
3Downloading software .......................................................................................7
4Building the EDKII firmware ...............................................................................8
4.1 Dependencies ........................................................................................8
4.2 Pre build setup.......................................................................................8
4.2.1 Performing pre build steps in a Linux/gcc build environment ............9
4.2.2 Performing pre build steps in a Windows build environment .............9
4.3 Building all the EDKII Firmware validated build configurations [Linux build
environment only] ................................................................................10
4.4 Building a single EDKII Firmware build configuration .................................11
4.5 EDKII firmware build standalone output files ............................................12
5Building the GRUB OS loader [Linux build environment only].................................13
6Creating a file system and building the kernel using Yocto
[Linux build environment only] .........................................................................15
6.1 Applying a custom patch to the Linux kernel using Yocto (optional) .............17
7Building the Linux* cross compile toolchain using Yocto [Linux build environment only]18
8Creating a flash image for the board [Linux build environment only].......................20
8.1 Using the SPI Flash Tools ......................................................................20
9Patching flash binary files using platform data file................................................22
10 Programming flash on the board using serial interface ..........................................24
10.1 Programming flash using UEFI shell ........................................................24
10.2 Programming flash using Linux* run-time system .....................................27
11 Programming flash on the board using DediProg..................................................28
12 Booting the board from SD card ........................................................................29
Part 2 Using the BSP Software..............................................................................................31
13 Capsule update...............................................................................................31
14 Capsule recovery ............................................................................................32
15 Signing files (secure SKU only) [Linux build environment only] ..............................33
16 Enabling the OpenOCD debugger ......................................................................35
Appendix A Related documents..........................................................................................36

Contents
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
Order Number: 329687-007US 3
Revision History .................................................................................................................37
Legal Disclaimers................................................................................................................38

About this document
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
4 Order Number: 329687-007US
1About this document
This document, the Intel®Quark™SoC X1000 Board Support Package (BSP) Build and
Software User Guide, is divided into two major sections:
Part 1 Building the BSP Software contains instructions for installing and
configuring the Intel®Quark™SoC X1000 Board Support Package sources.
Part 2 Using the BSP Software provides information on BSP software features
and functionality.
Use this document to create an image to boot on your Quark-based board, and to
learn more about BSP software features.
The intended audience for this document are hardware/software engineers with
experience in developing embedded applications.
This software release supports the following software and hardware:
Board Support Package Sources for Intel®Quark™ SoC X1000 v1.0.0
Intel®Galileo Customer Reference Board (CRB) (Fab D with blue PCB)
Kips Bay Customer Reference Board (CRB) (Fab C with green PCB)
Intel®Quark™ SoC X1000 Industrial/Energy Reference Design (Cross Hill)
Intel®Quark™ SoC X1000 Transportation Reference Design (Clanton Hill)

Before you begin
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
Order Number: 329687-007US 5
Part 1 Building the BSP software
This section contains the following topics:
Before you begin
Downloading software
Building the EDKII firmware
Building the GRUB OS loader [Linux build environment only]
Creating a file system and building the kernel using Yocto [Linux build environment only]
Building the Linux* cross compile toolchain using Yocto [Linux build environment only]
Creating a flash image for the board [Linux build environment only]
Patching flash binary files using platform data file
Programming flash on the board using serial interface
Programming flash on the board using DediProg
Booting the board from SD card
2Before you begin
Before you begin:
You need a host PC running either:
- Linux*; Intel recommends a 64-bit Linux system
- Microsoft* Windows* 7, x64
You need an internet connection to download third party sources.
The build process may require as much as 30 GB of free disk space.
To program the board you can use:
A serial interface using the UEFI shell or Linux* run-time (see Section 10)
A DediProg* SF100 SPI Flash Programmer (or equivalent) and the associated
flashing software (see Section 11)
An Intel®Galileo IDE (Galileo board only; see the Intel®Galileo Board Getting
Started Guide for details)
Note: Remove all previous versions of the software before installing the current version.
Individual components require very different environments (compiler options and
others). To avoid cross-pollution, the commands in each section below must
be run in a new command line window every time.

Before you begin
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
6 Order Number: 329687-007US
Note: If the commands fail or timeout, it may be due to your proxy settings. Contact your
network administrator. You may find answers here:
https://wiki.yoctoproject.org/wiki/Working_Behind_a_Network_Proxy
This release has been tested with Windows* 7, 64-bit and Debian* Linux* 7.0
(Wheezy), but will work with most other Linux distributions.
Linux builds have been validated on 64-bit Linux systems and may need additional
steps for operation on 32-bit systems.

Downloading software
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
Order Number: 329687-007US 7
3Downloading software
Download the BSP sources zip file from the following location:
https://downloadcenter.intel.com/Detail_Desc.aspx?DwnldID=23197
Note: If you are using an Intel®Quark™ Reference Design board, see your Intel
representative for the appropriate software download URL.
This release is comprised of:
Board Support Package (BSP) sources:
Board_Support_Package_Sources_for_Intel_Quark_v1.0.1.7z (2.6 MB)
For customers using the Clanton Hill FFRD, additional CAN software must be
downloaded from Intel Business Link (IBL). See your Intel representative for the URL.
The CAN package comprises:
•Fujitsu CAN Firmware:
CAN_Firmware_for_Intel_Quark_v1.0.1.zip (36 kB)
If building on a Debian host PC, use the Debian-provided meta package called build-
essential that installs a number of compiler tools and libraries. Install the meta
package and the other packages listed in the command below before continuing:
# sudo apt-get install build-essential gcc-multilib vim-common

Building the EDKII firmware
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
8 Order Number: 329687-007US
4Building the EDKII firmware
You need to build the open source EDKII firmware for the Intel®Quark™ SoC.
Additional details may be found here:
www.tianocore.sourceforge.net
http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=Getting_Started
_with_EDK_II
4.1 Dependencies
Linux* build environment dependencies:
Python 2.6 or 2.7 (Python 3.x not supported)
GCC and G++ (tested with GCC 4.3 and GCC 4.6)
subversion client
uuid-dev
iasl (https://www.acpica.org/downloads/linux)
Note: An ACPI5.0 compatible version is required.
Windows* build environment dependencies:
Python 2.6 or 2.7 (Python 3.x not supported)
Microsoft* Visual Studio* 2008 Professional.
The Intel®Quark™ SoC EDKII build is validated with the Win7 x64 /
VS2008x86 option shown in
http://sourceforge.net/apps/mediawiki/tianocore/index.php?title=Windows_syste
ms_ToolChain_Matrix
In addition, the quarkbuild.bat below enforces the x86 postfix onto the Visual
Studio* option for building under x64 Windows.
TortoiseSVN (1.4.2.8580 or later) installed with optional SVN command line tools.
iASL Windows binaries (https://www.acpica.org/downloads/binary-tools)
Note: An ACPI5.0 compatible version is required.
4.2 Pre build setup
The following steps are done once to prepare the EDKII workspace directory with the
required source code before commencing the actual firmware build.
1. Create the EDKII workspace directory and extract the contents of the Intel®
Quark™ SoC EDKII BSP into this directory. The file will have the name
Quark_EDKII_<version>.tar.gz. After the contents have been extracted the

Building the EDKII firmware
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
Order Number: 329687-007US 9
files quarkbuild.sh and quarkbuild.bat should be in the root of the created
workspace directory.
2. Fetch the upstream core EDKII packages using svn_setup.py and the SVN
command line tool.
3. Optionally, if OpenSSL is required by the build configuration in Section 4.3 or
Section 4.4 following, then perform the steps in the
CryptoPkg/Library/OpensslLib/Patch-HOWTO.txt file.
4.2.1 Performing pre build steps in a Linux/gcc build
environment
Open a new terminal session and enter the following commands:
# sudo apt-get install build-essential uuid-dev iasl subversion
# tar -xvf Quark_EDKII_*.tar.gz
# cd Quark_EDKII*
# ./svn_setup.py
# svn update
4.2.2 Performing pre build steps in a Windows build
environment
Use a preferred tool to extract the Quark_EDKII_*.tar.gz to a user created EDKII
Workspace directory and run the cmd.exe Windows command. Then, issue the
following commands:
>cd %USER_SELECTED_EDKII_WORKSPACE_DIR%
>.\svn_setup.py
>svn update
Note: The svn update command can take a few minutes to complete depending on the
speed of your internet connection.
Note: If these commands fail, it may be due to your proxy settings. Contact your network
administrator. You may find answers about proxy settings here:
https://wiki.yoctoproject.org/wiki/Working_Behind_a_Network_Proxy
Note: The examples above do not show the optional OpenSSL pre build step described in the
CryptoPkg/Library/OpensslLib/Patch-HOWTO.txt file.

Building the EDKII firmware
Intel®Quark™ SoC X1000
BSP Build and Software User Guide
10 Order Number: 329687-007US
4.3 Building all the EDKII Firmware validated build
configurations [Linux build environment only]
This section is only supported in Linux Build environments. The buildallconfigs.sh
file is used to build all the validated EDKII build configurations. Open a terminal
window and cd to the Quark_EDKII* directory created in Section 4.2.1 above.
The script has the following options:
buildallconfigs.sh [GCC43 | GCC44 | GCC45 | GCC46 | GCC47] [PlatformName]
GCC4x GCC flags used for this build. Set to the version of GCC
you have installed.
Note: Validated with GCC43; tested on GCC46.
[PlatformName] Name of the platform package you want to build.
Example usage:
Create a build for an Intel® Quark™ SoC platform based on GCC version 4.6:
./buildallconfigs.sh GCC46 QuarkPlatform
Note: Ensure the selected version of GCC matches the one installed on the system by
running the gcc --version command.
The build output can be found in the following directories:
Build/QuarkPlatform/<Config>/<Target>_<Tools>/FV/FlashModules/
Contains EDKII binary modules
Build/QuarkPlatform/<Config>/<Target>_<Tools>/FV/Applications/
Contains UEFI shell applications, including CapsuleApp.efi
Where:
<Config> = PLAIN | SECURE
<Target> = DEBUG | RELEASE
<Tools> = GCC43 | GCC44 | GCC45 | GCC46 | GCC47
In Section 8 you will run a script that creates a symbolic link to the directory where
the EDK binaries are placed.