From 6f06384f1d1023d7a751f2aba76a05b3e65fbecd Mon Sep 17 00:00:00 2001 From: Angie Chinchilla Date: Thu, 9 Nov 2017 14:53:49 -0500 Subject: [PATCH] Update README for SGX 2.0. Signed-off-by: Angie Chinchilla --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index a8b2b04..faa7cb6 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,13 @@ The Linux SGX software stack is comprised of the Intel(R) SGX driver, the Intel( The [linux-sgx-driver](https://github.com/01org/linux-sgx-driver) project hosts the out-of-tree driver for the Linux Intel(R) SGX software stack, which will be used until the driver upstreaming process is complete. +Within the linux-sgx-driver project, two versions of the out-of-tree driver are provided. Both versions are compatible with the linux-sgx PSW and SDK: +- SGX 2.0 Linux Driver (sgx2) + * The sgx2 branch of the linux-sgx-driver project contains the SGX 2.0 Linux Driver. This driver has additional support for SGX 2.0-based features available in upcoming CPUs. This driver has the same behavior as the SGX Linux Driver (master) on CPUs without SGX 2.0 support. +- SGX Linux Driver (master) + * The master branch of the linux-sgx-driver project tracks the proposed upstream version of the SGX driver and does not yet support SGX 2.0-based features. + + License ------- See License.txt for details. @@ -20,6 +27,8 @@ Contributing Starting from 05/2017, we are importing the sgx driver code from the in-kernel sgx repository located at git-hub: https://github.com/jsakkine-intel/linux-sgx.git. Any contribution should be done there. Future versions of the sgx driver code will be imported later on. The motivation behind this decision is to maintain a single source code of the sgx linux driver. An additional directory inker2ext/ has been created, it contains a script and a patch file that can be used in order to separately generate the code base of the sgx external module; it can be used in case someone wants the newest sgx driver as an external module and does not want to wait for next update. +The sgx2 branch hosts an initial implementation supporting SGX 2.0. This patch is maintained in inker2ext/sgx2.patch in the 2.0 branch and will be periodically rebased to take updates from the linux-sgx-driver:master branch. Contributions for this patch should be managed directly through the linux-sgx-driver project on Github. + Documentation ------------- - [Intel(R) SGX for Linux\* OS](https://01.org/intel-softwareguard-extensions) project home page on [01.org](http://01.org) @@ -39,6 +48,8 @@ Build and Install the Intel(R) SGX Driver - Configure the system with the **SGX hardware enabled** option. ### Build the Intel(R) SGX Driver +**Note:** To use the SGX 2.0 driver, checkout or download the sgx2 branch and then follow the build instructions. + To build Intel(R) SGX driver, change the directory to the driver path and enter the following command: ``` $ make