/Aptio-OpenEdition

TianoCore/EDKII for UEFI implementation

Primary LanguageCBSD 2-Clause "Simplified" LicenseBSD-2-Clause

** Aptio OpenEdition for TiogaPass **

The Minimum Platform is a software architecture that guides uniform delivery of Intel platforms enabling firmware solutions for basic boot functionality with extensibility built-in. This project incorporates support for the OCP derived Tioga Pass platform.

Package maintainers are listed in Maintainers.txt.

Overview

The key elements of the architecture are organized into a staged boot approach where each stage has requirements and functionality for specific use cases. The generic control flow through the boot process is implemented in the MinPlatformPkg. The generic nature of the tasks performed in MinPlatformPkg lends to reuse across all Intel platforms with no source modification. Details for any particular board are made accessible to the MinPlatformPkg through a well-defined statically linked board API. A complete platform solution then consists of the MinPlatformPkg and a compatible board package.

Board Naming Convention

The board packages supported by Intel follow the naming convention <xxx>OpenBoardPkg where xxx refers to the encompassing platform name for a particular platform generation. For example, the KabylakeOpenBoardPkg contains the board code for Intel Kaby Lake reference systems. Intel uses the moniker "OpenBoardPkg" to indicate that this package is the open source board code. A closed source counterpart may exist which simply uses "BoardPkg". Both directly use the MinPlatformPkg from edk2-platforms.

Stage Selection

Stage selection is controlled via the PCD gMinPlatformPkgTokenSpaceGuid.PcdBootStage in MinPlatformPkg.dec. The stage should be configured in the board package DSC file to the appropriate value. For example, a board may disable all advanced features by setting this value to 4 instead of 6. This may be used to improve boot time for a particular use case. Decrementing the stage can also be used for debug since only the actions required for that stage objective should be executed. As an example, ACPI initialization is not required for a Stage 3 boot.

The stages are defined as follows:

Stage Functional Objective Example Capabilities
I Minimal Debug Serial port output, source debug enabled, hardware debugger enabled
II Memory Functional Basic hardware initialization necessary to reach memory initialization, permanent memory available
III Boot to UI Simple console input and output to a UI, UEFI shell
IV Boot to OS Boot an operating system with the minimally required features
V Security Enable UEFI Secure Boot, TCG measured boot, DMA protections
VI Advanced Feature Enable Firmware update, power management, non-essential I/O

Minimum Platform Firmware Solution Stack

A UEFI firmware implementation using MinPlatformPkg is constructed using the following pieces.
EDK II
Intel(r) FSP
Minimum Platform (MinPlatformPkg)
Board Support (<xxx>OpenBoardPkg)

Board Support

  • The PurleyOpenBoardPkg contains board implementations for Purley systems.

Board Package Organization

The board package follows the standard EDK II package structure with the following additional elements and guidelines:

  • Only code usable across more than one board at the root level.* Board-specific code in a directory. The directory name should match that of the board supported.
  • Features not essential to achieve stage 5 or earlier boots are maintained in a Features folder at the appropriate level in the package hierarchy.

Shared resources in the package root directory can include interfaces described in header files, library instances, firmware modules, binaries, etc. The UEFI firmware implementation is built using the process described below from the board-specific directory.

A board package must implement the board APIs defined in the MinPlatformPkg even if a "NULL" implementation is used to return back to the minimum platform caller.

Windows Build Instructions

Pre-requisites

Download the required components

git clone https://github.com/opencomputeproject/Aptio-OE.git

Build

Building with the batch scripts

For PurleyOpenBoardPkg

  1. Open command window, go to the workspace directory, e.g. c:\Purley.
  2. Type "cd edk2-platforms\Platform\Intel\PurleyOpenBoardPkg\BoardTiogaPass".
  3. Type "GitEdk2MinTiogaPass.bat" to setup GIT environment.
  4. Type "bld" to build Purley Tioga Pass board UEFI firmware image, "bld release" for release build, "bld clean" to remove intermediate files.
  5. Final BIOS image will be Build\PurleyOpenBoardPkg\BoardTiagoPass\DEBUG_VS2015x86\FV\PLATFORM.fd or Build\PurleyOpenBoardPkg\BoardTiagoPass\RELEASE_VS2015x86\FV\PLATFORM.fd, depending on bld batch script input.
  6. This BIOS image needs to be merged with SPS FW.

The validated version of iasl compiler that can build MinPurley is 20180629. Older versions may generate ACPI build errors.

Users with access to the Intel proprietary FITC tool and ME ingredients can build full images for flash (BIOS + ME + DESC).

Users can also flash the UEFI firmware image to the highest area of the flash region directly.

Binary and Reference Code Details

Validation Details

  • All firmware projects can only build on Windows with the validated configuration below.

PurleyOpenBoardPkg

  • This firmware project has only been tested on the Tioga Pass hardware.
  • This firmware project build has only been tested using the Microsoft Visual Studio 2015 build tools.
  • Booted to UEFI shell.
  • Installed and booted to UEFI Windows 2016 on M.2 NVME slot.
  • Installed and booted to UEFI Windows 2019 on M.2 NVME slot and with SATA HDD.
  • Installed and booted to UEFI RHEL 7.3 on SATA HDD.
  • Installed and booted to Ubuntu 18.04 on M.2 NVME slot.
  • Verified Mellanox card detection during POST and OS.

Planned Activities

  • Sync with latest EDKII platforms master
  • Publish PurleyOpenBoardPkg to TianoCore github
  • Add Linux boot support

Additional Support and Customizations

  • To get dedicated support or additional features or customizations for Aptio OpenEdition, feel free to email sales@ami.com