tests: Add READMEs to the testing directory

This change adds READMEs to each directory within tests/gem5,
with a short description of the test, as well as how to run it.

Change-Id: I574ebcdc837848b52f21e8c0f8856ff09463284b

tests/gem5/arm_boot_tests/README.md

@@ -0,0 +1,9 @@
+# Arm Boot Tests
+
+These tests run a series of Linux boots on the ARMBoard.
+It varies the CPU type, number of CPUs, and memory used for each run.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/arm_boot_tests --length=[length]
+```

tests/gem5/asmtest/README.md

@@ -0,0 +1,9 @@
+# ASM Test
+
+These tests run a set of RISCV binaries on a bare bones syscall execution.
+In addition, these test run these binaries against different CPU types.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/asmtest --length=[length]
+```

tests/gem5/cpu_tests/README.md

@@ -0,0 +1,8 @@
+# CPU Tests
+
+These tests run the Bubblesort and FloatMM workloads against the different CPU models.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/cpu_tests --length=[length]
+```

tests/gem5/dram_lowp/README.md

@@ -0,0 +1,8 @@
+# DRAM LowP
+
+These tests run the `configs/dram` scripts that trigger low power state transitions in the DRAM controller.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/dram_lowp --length=[length]
+```

tests/gem5/fs/linux/arm/README.md

@@ -0,0 +1,8 @@
+# FS
+
+This is a set of full system ARM tests.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/fs/linux/arm --length=[length]
+```

tests/gem5/gem5_library_example_tests/README.md

@@ -0,0 +1,8 @@
+# gem5 Library Example Tests
+
+This set of tests checks the examples in `configs/example/gem5_library`, and makes sure they run to completion.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/gem5-resources --length=very-long
+```

tests/gem5/gem5_resources/README.md

@@ -0,0 +1,8 @@
+# gem5 Resources
+
+This test makes sure that resources you download within gem5 work properly, and the downloaded resource matches the input given.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/gem5_resources --length=very-long
+```

tests/gem5/gpu/README.md

@@ -0,0 +1,8 @@
+# GPU
+
+These tests do random checks to the Ruby GPU protocol within gem5.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/gem5-resources --length=very-long
+```

tests/gem5/insttest_se/README.md

@@ -0,0 +1,8 @@
+# Inst Test SE
+
+These test the insttest binary running on the SPARC ISA, checking against different CPU models.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/insttest_se --length=[length]
+```

tests/gem5/kvm_fork_tests/README.md

@@ -0,0 +1,8 @@
+# KVM Fork Tests
+
+These tests check that gem5 can fork with the KVM cpu, then switch to a different CPU.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/kvm_fork_tests --length=[length]
+```

tests/gem5/kvm_switch_tests/README.md

@@ -0,0 +1,8 @@
+# KVM Switch Tests
+
+These tests ensure that gem5 can switch processors during simulation.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/kvm_switch_tests --length=[length]
+```

tests/gem5/learning_gem5/README.md

@@ -0,0 +1,9 @@
+# Learning gem5
+
+This set of tests ensures that the example scripts for the gem5 tutorial run properly.
+
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/learning_gem5 --length=[length]
+```

tests/gem5/m5_util/README.md

@@ -0,0 +1,8 @@
+# m5 Util
+
+These test the util m5 exit assembly instruction.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/m5_util --length=[length]
+```

tests/gem5/m5threads_test_atomic/README.md

@@ -0,0 +1,8 @@
+# m5 Threads Test Atomic
+
+These are m5threads atomic tests that run against different CPU types.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/m5threads_test_atomic --length=[length]
+```

tests/gem5/memory/README.md

@@ -0,0 +1,9 @@
+# Memory
+
+These run a set of tests on memory within gem5.
+
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/memory --length=[length]
+```

tests/gem5/multi_isa/README.md

@@ -0,0 +1,9 @@
+# Multi ISA
+
+These tests check that all our ISAs are both currrently supported within gem5, as well as checking that get_runtime_isa() works as expected.
+
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/multi_isa --length=[length]
+```

tests/gem5/parsec_benchmarks/README.md

@@ -0,0 +1,9 @@
+# Parsec Benchmarks
+
+These tests run through a subset of the parsec benchmarks within gem5.
+
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/parsec_benchmarks --length=[length]
+```

tests/gem5/riscv_boot_tests/README.md

@@ -0,0 +1,9 @@
+# RISCV Boot Tests
+
+These tests run a series of Linux boots on the RISCVBoard.
+It varies the CPU type, number of CPUs, and memory used for each run.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/riscv_boot_tests --length=[length]
+```

tests/gem5/se_mode/hello_se/README.md

@@ -0,0 +1,8 @@
+# SE Mode
+
+These tests use the SimpleBoard to test simple binaries in SE mode, both with single and multi cores.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/se_mode/hello_se --length=[length]
+```

tests/gem5/stats/README.md

@@ -0,0 +1,8 @@
+# Stats
+
+This test runs an SE simulation with the hdf5 stats and checks that the simulation succeeds and the stats file exists.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/stats --length=[length]
+```

tests/gem5/stdlib/README.md

@@ -0,0 +1,8 @@
+# Standard Library
+
+These tests check that the BaseCPUProcessor and the gem5.utils.requires function work as intended.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/stdlib --length=[length]
+```

tests/gem5/to_tick/README.md

@@ -0,0 +1,8 @@
+# To Tick
+
+These tests check that setting the max tick in various ways behaves as expected, as well as that event scheduling at a certain tick works.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/to_tick --length=[length]
+```

tests/gem5/traffic_gen/README.md

@@ -0,0 +1,9 @@
+# Traffic Generator
+
+This tests the gem5 memory components with a simple traffic generator.
+It also checks the correctness of the statistics outputted by gem5.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/traffic_gen --length=[length]
+```

tests/gem5/x86_boot_tests/README.md

@@ -0,0 +1,9 @@
+# X86 Boot Tests
+
+These tests run a series of Linux boots on the X86Board.
+It varies the CPU type, number of CPUs, and memory used for each run.
+To run these tests by themselves, you can run the following command in the tests directory:
+
+```bash
+./main.py run gem5/x86_boot_tests --length=[length]
+```