Update kvm-unit-tests README
Change-Id: I2500d757d89a9747297a1ffe6ac51e309a7e479c
diff --git a/aarch64-unit-tests/README b/aarch64-unit-tests/README
deleted file mode 100644
index fbd72bf..0000000
--- a/aarch64-unit-tests/README
+++ /dev/null
@@ -1,58 +0,0 @@
-# AArch64 KVM Unit Test Driver
-
-This directory contains the driver script for the AArch64 unit tests. These
-scripts run the kvm-unit-tests inside an AArch64 emulator (qemu-system-aarch64).
-This to enable testing KVM with virtual machines that are running natively on
-the underlying system, as opposed to emulated VMs. We need this to be able to
-test Protected KVM, which would be running VMs on the same architecture as the
-host/hypervisor (i.e., AAarch64).
-
-
-## Requirements:
-
-- A Linux kernel image cross-compiled for AArch64. See ANDROID-KVM_DIR/linux
-
-An example on how to build one, in the linux source:
-cd ANDROID-KVM_DIR/linux
-make ARCH=arm64 CROSS_COMPILE="aarch64-linux-gnu-" -j`nproc` defconfig
-make ARCH=arm64 CROSS_COMPILE="aarch64-linux-gnu-" -j`nproc`
-
-The image will be built at:
-ANDROID-KVM_DIR/linux/arch/arm64/boot/Image
-
-
-- KVM unit tests built as standalone. See ANDROID-KVM_DIR/kvm-unit-tests
-
-To build these standalone tests, in the kvm-unit-tests source directory:
-
-cd ANDROID-KVM_DIR/kvm-unit-tests
-./configure --arch=arm64 --cross-prefix="aarch64-linux-gnu-"
-make -j`nproc` standalone
-
-The standalone tests will be built at:
-ANDROID-KVM_DIR/kvm-unit-tests/tests
-
-
-- A root file system image to boot. An image will be uploaded to
-ANDROID-KVM_DIR/prebuilts. In the meantime, you can generate such an image
-using Buildroot. See ANDROID-KVM_DIR/buildroot.
-
-cd ANDROID-KVM_DIR/buildroot
-make qemu_aarch64_virt_kvmunittests_defconfig
-make clean all
-
-The generated image will be at:
-ANDROID-KVM_DIR/buildroot/output/images/rootfs.ext4
-
-
-- QEMU with aarch64-softmmu, v5.0.0 or later
-
-Buildroot creates one in the buildprocess. It's available at
-ANDROID-KVM_DIR/buildroot/output/host/bin/qemu-system-aarch64
-
-## Running the tests
-
-Assuming you are using the binaries, tests, and images from above, you can run
-the tests as follows:
-
-./run_tests.sh -j `nproc` -t ANDROID-KVM_DIR/kvm-unit-tests/tests -l ANDROID-KVM_DIR/linux/arch/arm64/boot/Image -r ANDROID-KVM_DIR/buildroot/output/images/rootfs.ext4 -e ANDROID-KVM_DIR/buildroot/output/host/bin/qemu-system-aarch64
diff --git a/kvm-unit-tests/README b/kvm-unit-tests/README
new file mode 100644
index 0000000..780952c
--- /dev/null
+++ b/kvm-unit-tests/README
@@ -0,0 +1,69 @@
+# KVM Unit Test Driver
+
+This directory contains the driver script for kvm-unit-tests. Tests run
+inside QEMU that emulates the native architecture.
+
+## Requirements:
+
+- A Linux kernel image cross-compiled for AArch64. See ANDROID-KVM_DIR/linux
+
+Build using default rules:
+ $ make linux
+
+Example of custom building:
+ $ cd ANDROID-KVM_DIR/linux
+ $ make ARCH=arm64 CROSS_COMPILE="aarch64-linux-gnu-" -j`nproc` defconfig
+ $ make ARCH=arm64 CROSS_COMPILE="aarch64-linux-gnu-" -j`nproc`
+ $ # image is now in ANDROID-KVM_DIR/linux/arch/arm64/boot/Image.gz
+
+
+- KVM unit tests built as standalone. See ANDROID-KVM_DIR/kvm-unit-tests
+
+Build using default rules:
+ $ make kvm-unit-tests
+
+Example of custom building:
+ $ cd ANDROID-KVM_DIR/kvm-unit-tests
+ $ ./configure --arch=arm64 --cross-prefix="aarch64-linux-gnu-"
+ $ make -j`nproc` standalone
+ $ # test binaries are now in ANDROID-KVM_DIR/kvm-unit-tests/tests
+
+
+- A root file system image to boot.
+
+A prebuilt image is in ANDROID-KVM_DIR/prebuilts.
+
+Rebuild using default rules:
+ $ make update-prebuilts
+
+Example of custom building:
+ $ cd ANDROID-KVM_DIR/buildroot
+ $ make qemu_aarch64_virt_kvmunittests_defconfig
+ $ make clean all
+ $ # image is now in ANDROID-KVM_DIR/buildroot/output/images/rootfs.ext4
+
+
+- QEMU with aarch64-softmmu, v5.0.0 or later
+
+A prebuilt binary is in ANDROID-KVM_DIR/prebuilts.
+
+Buildroot creates one in the buildprocess. It's available at
+ANDROID-KVM_DIR/buildroot/output/host/bin/qemu-system-aarch64
+
+## Running the tests
+
+To run all tests:
+ $ make test -j`nproc`
+
+To list all test targets:
+ $ make test-list
+
+To run one test, e.g. PSCI under nVHE:
+ $ make test-kut-nvhe-psci
+
+To run the same test with GDB server:
+ $ make test-kut-nvhe-psci-gdb
+
+Alternatively, a test can be invoked using run_test.sh:
+ $ ./build/kvm-unit-tests/run_test.sh psci
+Note that this will not rebuild dependencies but starts quicker.
