Merge pull request #24 from dayeol/dev

Make Keystone driver loadable module

.gitmodules

@@ -6,7 +6,7 @@
 	url = https://github.com/keystone-enclave/busybear-linux
 [submodule "riscv-linux"]
 	path = riscv-linux
-	url = https://github.com/keystone-enclave/riscv-linux
+	url = https://github.com/riscv/riscv-linux
 [submodule "riscv-pk"]
 	path = riscv-pk
 	url = https://github.com/keystone-enclave/riscv-pk
@@ -16,3 +16,6 @@
 [submodule "sdk"]
 	path = sdk
 	url = https://github.com/keystone-enclave/keystone-sdk
+[submodule "linux-keystone-driver"]
+	path = linux-keystone-driver
+	url = https://github.com/keystone-enclave/linux-keystone-driver

docs/source/Getting-Started/Guide-to-Components.rst

@@ -29,13 +29,22 @@ riscv-gnu-toolchain
 Unmodified toolchain for building riscv targets. Required to build all
 other components.
 
+linux-keystone-driver
+---------------------
+
+Link: `<https://github.com/keystone-enclave/linux-keystone-driver>`_
+
+A loadable module for Keystone Enclave.
+Works in kernels >= 4.17
+
+
 riscv-linux
 -----------
 
-Link: `<https://github.com/keystone-enclave/riscv-linux>`_
+Link: `<https://github.com/riscv/riscv-linux>`_
 
-Linux kernel with riscv patches, updated to mainline semi-regularly.
-Only Keystone modification is the Keystone driver, in arch/riscv/drivers/.
+Linux kernel with riscv patches.
+We use 4.15 with patches for the loadable module support.
 
 riscv-pk
 --------

docs/source/Getting-Started/Running-Keystone-with-QEMU.rst

@@ -90,7 +90,7 @@ You should apply patches before building the QEMU.
   make
   cd ..
 
-Build Linux Kernel with Built-in Keystone Driver
+Build Linux Kernel
 ################################################
 
 ::
@@ -128,8 +128,19 @@ Build Root-of-Trust Boot ROM
   make
   cd ..
 
+Build Keystone Driver
+##############################
+
+::
+
+  cd linux-keystone-driver
+  make
+  make copy
+  cd ..
+
 Build Keystone SDK
 #############################
+
 Keystone SDK includes sample enclave programs and some useful libraries. To run sample programs, you should compile SDK library and apps, and copy all of them into the disk image. Following commands will compile the sdk, and copy sample binaries into the ``busybear.bin`` disk image.
 
 ::
@@ -157,6 +168,15 @@ Login as ``root`` with the password ``busybear``.
 
 You can exit QEMU by ``ctrl-a``+``x``
 
+Insert Keystone Driver
+-------------------------------------
+
+Insert the keystone driver.
+
+::
+
+    insmod keystone-driver.ko
+
 Run Tests
 ---------------------------------------