Copyright (C) 2014, Intel Corporation. All rights reserved.

The release package contains one main license file placed in the main directory.
This license is specified for Production Validated release firmware.
There are two additional licenses for the "Sample Update Tool" and "Null Heci driver"
located in the tools' directories.

------------------------------------------------------------------------------
  Server Platform Services Release Kit ReadMe
------------------------------------------------------------------------------

##############################################################################
  Server Platform Services firmware
##############################################################################

SPS firmware is provided in two files:
SpsOperational.bin - fully featured ME firmware image
SpsRecovery.bin    - ME recovery boot loader image

##############################################################################
  Power Thermal Utility option ROM binary file (PTU\)
##############################################################################

Optional component, a binary library in the form of an option ROM
which can get executed during BIOS POST and supports the NM PTU feature.

##############################################################################
  Server Platform Services firmware configuration files (Config\)
##############################################################################

SPS firmware configuration is provided in the following files:
WBGMC_SiEn.xml - configuration for Silicon Enabling firmware (SiEn)
                 for Mayan City platform.
WBGMC_NM.xml   - configuration for Node Manager feature enabled (NM)
                 for Mayan City platform.
WBGIC_SiEn.xml - configuration for Silicon Enabling firmware (SiEn)
                 for Inca City platform.
WBGIC_NM.xml   - configuration for Node Manager feature enabled (NM)
                 for Inca City platform.
WBGYC_SiEn.xml - configuration for Silicon Enabling firmware (SiEn)
                 for Yakima City platform.
WBGYC_NM.xml   - configuration for Node Manager feature enabled (NM)
                 for Yakima City platform

All above XML files are single image configurations.
Configuration can be easily transformed to dual image with command line
parameter to spsFITC.exe or by enabling secondary partition in GUI.
See SPS FIT description below.

##############################################################################
  Null Heci Driver (Tools\NullHeciDriver\)
##############################################################################

Separate manual, licence provided.

##############################################################################
  Node Manager IPMI Tool Scripts (Scripts\IpmiNmScripts\)
##############################################################################

Example script files for IPMI Tool. Separate manual provided.

##############################################################################
  Compliance Tests IPMI Tool Scripts (Scripts\ComplianceTestsScripts\)
##############################################################################

Compliance Tests script files for IPMI Tool.

##############################################################################
  SPS Flash Image Tool (Tools\FlashImageTool\)
##############################################################################

Use this tool to assemble binary images that can be written to flash. To see
the full list of supported options use command:

Tools\FlashImageTool\spsFITC.exe /?

To build just ME region image with SPS firmware in single image configuration,
but without flash descriptor, BIOS and GbE regions use command:

Tools\FlashImageTool\spsFITC.exe /b /flashcount 0 Config\<platform-specific-xml>

Note that this image is not complete SPI flash image, but just ME region.

To build a complete SPI flash image with flash descriptor region and
SPS firmware in single-image configuration use command:

Tools\FlashImageTool\spsFITC.exe /b Config\<platform-specific-xml>

To build a complete SPI flash image with flash descriptor, BIOS, GbE and
SPS firmware in single-image configuration use command:

Tools\FlashImageTool\spsFITC.exe /b /bios <bios-file> /gbe <GbE-file> Config\<platform-specific-xml>

Note that the default flash size is 64 Mbits (8 MB). To build image for
128 Mbits part use option '/flashsize1 5'.

To force building dual image configuration use either a SPS FIT command line
option '/DualImage' or the change can be done and saved in XML by omitting
the option '/b' in the SPS FIT command line to allow opening GUI window and in
the GUI right-click on
Layout -> ME Region -> "OPR2" Partition
and select 'Enable' to enable this secondary code partition.
Note that if '/b' switch is not used, SPS FIT GUI will be presented and adjustments
to the default XML can be made and saved.
Note also that SPS FIT uses spsfitc.ini to set CurWorkDir, WorkingDir and SourceDir,
so SPS FIT batch file usage assumes appropriate working/source directories setting
(pushd/popd can be used).

To export files with SDR settings for BMC firmware use command:

Tools\FlashImageTool\spsFITC.exe Config\<platform-specific-xml> /sdr <files-dir>\<file-names-pattern>  

Note that <file-names-pattern> will be split into name and extension and then patched with 
" Discov" and " Std" between separated parts. The output files for the example command 
"/sdr .\sdr\sdr.sdr Config\<platform-specific-xml>" would be two files ".\sdr\sdr Discov.sdr" 
containing discovery SDR's and ".\sdr\sdr Std.sdr" containg standard SDR's. 

##############################################################################
  SPS Flash Programming Tool (Tools\FlashProgrammingTool\)
##############################################################################

Use this tool to program your complete SPI flash image to the flash part.
DOS, EFI, Windows 32-bit, and Windows 64-bit versions of the tool are provided in
directories:

Tools\FlashProgrammingTool\DOS
Tools\FlashProgrammingTool\EFI
Tools\FlashProgrammingTool\Windows
Tools\FlashProgrammingTool\Windows64

The DOS version is used in the following examples, but EFI and Windows versions
support analogous options.
To see the full list of supported options use command:

Tools\FlashProgrammingTool\DOS\spsFPT.exe -?

To dump the current contents of the flash part use command:

Tools\FlashProgrammingTool\DOS\spsFPT.exe -D <flash-image-file>

To program your new, complete flash image into the flash part use command:

Tools\FlashProgrammingTool\DOS\spsFPT.exe -F <flash-image-file>

To verify the current flash contents with a flash image file use command:

Tools\FlashProgrammingTool\DOS\spsFPT.exe -VERIFY <flash-image-file>

Note that you need to assert the Security Override Strap signal to
enable access to all regions on the flash.

##############################################################################
  ME SMBus Diagnostic Console (Tools\MeDiagnosticConsole\)
##############################################################################

This is ME Firmware diagnostic console application for MS Windows environment.
Refer SPS Integration Guide for instructions how to setup the hardware and
use the console application. Windows 32-bit and Windows 64-bit versions of the
tool are provided in directories:

Tools\MeDiagnosticConsole\Windows
Tools\MeDiagnosticConsole\Windows64

##############################################################################
  SPS Info (Tools\SpsInfo\)
##############################################################################

This tool provides basic information about ME firmware running in ME engine.
It gives the firmware version and enabled features. DOS, EFI, Linux 32-bit, Linux 64-bit,
Windows 32-bit and Windows 64-bit versions of the tool are provided in directories:

Tools\SpsInfo\DOS
Tools\SpsInfo\EFI
Tools\SpsInfo\Linux
Tools\SpsInfo\Linux64
Tools\SpsInfo\Windows
Tools\SpsInfo\Windows64

To see the full list of supported options use command:

Tools\spsInfo\DOS\spsInfo.exe -?

##############################################################################
  SPS Manuf (Tools\SpsManuf\)
##############################################################################

This tool provides basic set of tests for ME firmware running in ME engine.
DOS, EFI, Linux 32-bit, Linux 64-bit, Windows 32-bit and Windows 64-bit
versions of the tool are provided in directories:

Tools\SpsManuf\DOS
Tools\SpsManuf\EFI
Tools\SpsManuf\Linux
Tools\SpsManuf\Linux64
Tools\SpsManuf\Windows
Tools\SpsManuf\Windows64

To see the full list of supported options use command:

Tools\SpsManuf\DOS\SpsManuf.exe -?

##############################################################################
  Sample Update Tool (Tools\SampleUpdateTool\)
##############################################################################

This is source code of example implementation of ME firmware online update for
ME running NM or SiEn SKU in dual image configuration. Separate readme file
is provide with this tool.
