Add Wiwynn OCP Delta Lake Open System Firmware

Signed-off-by: Johnny Lin <[email protected]>

Author: johnnylinwiwynn

Wiwynn/deltalake/LICENSE

@@ -0,0 +1,24 @@
+This software and associated documentation files (the "Software") are contributed to the
+Open Compute Project and are subject to the license terms of the Open Compute Project
+(OCP) Software Contributor License Agreement listed at the following address:
+https://www.opencompute.org/documents/software-contributor-license-agreement.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+The Software incorporates third-party software listed below. The provisions contained in each
+such license apply only to the respective third-party software.
+
+1.      coreboot (https://github.com/coreboot/coreboot/blob/master/COPYING)
+2.      Linux Kernel (https://github.com/torvalds/linux/blob/master/COPYING)
+3.      u-root (https://github.com/u-root/u-root/blob/master/LICENSE)
+4.      Intel FSP (https://github.com/intel/FSP/blob/master/FSP_License.pdf)
+5.      Intel PCH Ignition Firmware and Flash descriptor for Delta Lake
+        (https://github.com/tianocore/edk2-non-osi/blob/master/Platform/Intel/WhitleyOpenBoardBinPkg/Ifwi/DeltaLake/License.txt)
+6.      Intel microcode (https://github.com/tianocore/edk2-non-osi/blob/master/Silicon/Intel/WhitleySiliconBinPkg/CpxMicrocode/IntelMicrocodeLicense.txt)
+7.      Go (https://github.com/golang/go/blob/master/LICENSE)
+8.      osf-builder (https://github.com/facebookincubator/osf-builder/blob/main/LICENSE)

Wiwynn/deltalake/README.md

@@ -0,0 +1,47 @@
+# OCP Delta Lake Open System Firmware
+
+The open system firmware contribution to OCP Delta Lake is hosted in this directory. OCP Delta Lake is a single socket server design based on the 3rd Gen Intel Xeon
+Scalable processors, which is referred to as [Delta Lake 1S Server](https://www.opencompute.org/documents/delta-lake-1s-server-design-specification-1v05-pdf). OCP Delta Lake server is a component of multi-node server system [Yosemite-V3](https://www.opencompute.org/documents/ocp-yosemite-v3-platform-design-specification-1v16-pdf).
+The open system firmware solution developed for Delta Lake is based on [coreboot](https://coreboot.org/)/[LinuxBoot](https://www.linuxboot.org/) stack. The support status and information of coreboot/LinuxBoot for OCP Delta Lake can be found [here](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md). Please note that the support status described in the link was developed and validated against an engineering Intel FSP which is not public, but it shouldn't be a huge gap to work on the current upstream coreboot to reach the same status with the public Intel FSP. If you need professional service for this effort or other features development, please see [Maintainers and Professional Support](#Maintainers-and-Professional-Support). The files in this directory can help you download all the public source code and binary files, and build the final system firmware image that can pass [OCP OSF checklist](https://www.opencompute.org/wiki/Open_System_Firmware/Checklist). In the patch file in src directory, config-deltalake.json configures all the open source upstream repositories and commit hashes, including the toolchain that will be downloaded and built. For more detail about the fetching and building process please see [How To Build](#How-To-Build).
+
+## Build Pre-requisites
+
+ * Linux OS
+ * GNU Make
+ * python
+
+## How To Build
+
+    cd Wiwynn/deltalake && ./download_and_build.sh
+
+The download_and_build.sh shell script will clone the necessary repositories and trigger the build process. The [osf-builder](https://github.com/facebookincubator/osf-builder) describes more detail about the fetching and building process for coreboot and LinuxBoot. A built firmware image following the build steps is placed under bin/osf-deltalake.rom.
+
+## Documentation
+
+The [document](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md) provides the support status that has been developed and validated against an enginnering Intel FSP, Server Platform Services, microcode and ACM binaries that are not public but can be obainted under Intel NDA. [Features of firmware](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md#working-features), [how to flash](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md#flashing-coreboot) and [firmware configurations](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md#firmware-configurations) are described in the document.
+ * Validation scope: The uploaded image can pass and is compliant to OCP OSF checklist (v1.1) section 6 Test regime, please see the test results for detail. The test report is placed under Wiwynn/deltalake/Wiwynn_OSF_Cooperlake_QE_OCP_Checklist_V1.0_BIOS_v1.0.0_20210908.pdf.
+ * Readiness: Pre-production. The OSF is good enough for pre-production entrance on the corresponding OCP platform as-is.
+
+## Tool For User Modification
+
+* Firmware upgrade: same as described in [how to flash](https://github.com/coreboot/coreboot/blob/master/Documentation/mainboard/ocp/deltalake.md#flashing-coreboot).
+* Firmware configuration: in LinuxBoot u-root shell, we use [vpdbootmanager](https://github.com/u-root/u-root/tree/master/tools/vpdbootmanager) to get, set, add and delete firmware configurable variables. Please note that the tool may be renamed to 'vpdmgr' in the future. The tool would execute [vpd](https://chromium.googlesource.com/chromiumos/platform/vpd/+/master/README.md) and [flashrom](https://flashrom.org/Flashrom) for flash write operation. For read operation it reads via Linux /sys/firmware/vpd interface provided by selecting Linux kernel CONFIG_GOOGLE_VPD.
+    - vpdbootmanager get [variable name]
+    - vpdbootmanager set [variable name]
+    - vpdbootmanager delete [variable name]
+
+## How To Buy OCP Delta Lake
+
+In the near future Yosemite-V3 can be found in [Open Compute Project Marketplace](https://www.opencompute.org/solutions), if you are interested please contact [Wiwynn](https://www.wiwynn.com/contact-wiwynn/).
+
+## Potential Gaps To Use OCP Delta Lake OSF in Production
+ * Intel CBnT. CBnT 0T support is in coreboot, but overall solution requires Intel ACM binaries which are available under Intel agreement. 
+ * Run time management engine. The OCP OSF Delta Lake code base includes Intel PCH Ignition binary instead of Server Platform Services (SPS) binary, this means there is no run time service from management engine. Intel SPS binary is available under Intel agreement. 
+ * Hardware error handling. coreboot patches related to hardware error injection/handling are not present in the public OCP OSF Delta Lake codebase as they involve Intel IPs. Those patches can not be posted in public.
+ * GRUB BootLoaderSpec-style configuration (BLSCFG). The current [localboot](https://github.com/u-root/u-root/tree/master/pkg/boot/localboot) u-root package does not support BLSCFG, you need to make sure your GRUB doesn't enable it. On CentOS 8, you can disable it by modifying /etc/default/grub and set GRUB_ENABLE_BLSCFG=false, and then update the grub configuration by running 'grub2-mkconfig -o /boot/efi/EFI/centos/grub.cfg'. There are other u-root packages that support BLSCFG and we are planning to switch to other better maintained package in the near future.
+
+Nevertheless, the above features can be enabled. Please see [Maintainers and Professional Support](#Maintainers-and-Professional-Support).
+
+## Maintainers and Professional Support
+
+For more advanced server features such as Intel CBnT, RAS features for hardware error handling, feature customization and more, those may require Intel NDA information and professional support, please contact [9elements Cyber Security](https://9esec.io/contact) and work with Intel to obain the necessary NDA information.

Wiwynn/deltalake/Wiwynn_OSF_Cooperlake_QE_OCP_Checklist_V1.0_BIOS_v1.0.0_20210908.pdf

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+scriptdir="$(realpath "$(dirname "$0")")"
+osf_builder_hash="4f7836a3a8d1181fdc3444bfc1ea72b56de3e625"
+fsp_hash="0e18518131e7ecfeeb4afeab306121ca554c5054"
+edk2_non_osi_hash="eba85cf5d882340b2ce0f845facc31dde0c3dbcb"
+
+patches="${scriptdir}/src/*.patch"
+
+apply_patches()
+{
+  for p in $patches
+  do
+    if [ -f "$p" ]
+    then
+      patch -p1 < "$p"
+    fi
+  done
+}
+
+download_intel_blobs()
+{
+  cd bin
+  git clone https://github.com/tianocore/edk2-non-osi.git
+  cd edk2-non-osi
+  git checkout $edk2_non_osi_hash
+  cd ..
+  git clone https://github.com/intel/FSP.git
+  cd FSP
+  git checkout $fsp_hash
+  mkdir CPX-FSP-split
+  python Tools/SplitFspBin.py split -f CedarIslandFspBinPkg/Fsp.fd -o CPX-FSP-split
+  cd $scriptdir
+}
+
+# Download Intel FSP and microcode binaries under bin
+download_intel_blobs
+# Download osf-builder under src
+cd src
+git clone https://github.com/facebookincubator/osf-builder.git
+cd osf-builder
+git checkout $osf_builder_hash
+# Apply patches that add Delta Lake files to osf-builder
+apply_patches
+cp ${scriptdir}/bin/FSP/CPX-FSP-split/Fsp_M.fd projects/deltalake/blobs/Server_M.fd
+cp ${scriptdir}/bin/FSP/CPX-FSP-split/Fsp_S.fd projects/deltalake/blobs/Server_S.fd
+cp ${scriptdir}/bin/FSP/CPX-FSP-split/Fsp_T.fd projects/deltalake/blobs/Server_T.fd
+cp ${scriptdir}/bin/edk2-non-osi/Silicon/Intel/WhitleySiliconBinPkg/CpxMicrocode/mBF5065B_07002302.mcb projects/deltalake/blobs/microcode.mcb
+cp ${scriptdir}/bin/edk2-non-osi/Platform/Intel/WhitleyOpenBoardBinPkg/Ifwi/DeltaLake/FlashDescriptor.bin projects/deltalake/blobs/flashregion_0_flashdescriptor.bin
+cp ${scriptdir}/bin/edk2-non-osi/Platform/Intel/WhitleyOpenBoardBinPkg/Ifwi/DeltaLake/Me.bin projects/deltalake/blobs/flashregion_2_intel_me.bin
+# Run osf-builder to fetch the rest of the codes and start building
+cd projects/deltalake
+make