[ndctl,v2,2/2] README.md: document CXL unit tests

Commit Message

Zhijian Li (Fujitsu) May 31, 2023, 2:24 a.m. UTC

It requires some CLX specific kconfigs and testing purpose module

Signed-off-by: Li Zhijian <[e-mail]>
---
V2: Add separate CXL unit test entry # Dave
---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

Patch

diff --git a/README.md b/README.md
index 7c7cf0dd065d..4874430a023b 100644
--- a/README.md
+++ b/README.md
@@ -82,6 +82,32 @@  loaded.  To build and install nfit_test.ko:
    sudo make modules_install
    ```
 
+1. CXL test
+
+   The unit tests will also run CXL test by default. In order to make the
+   CXL test work smoothly, we need to install the cxl_test.ko as well.
+
+   Obtain the CXL kernel source(optional).  For example,
+   `git clone -b pending git://git.kernel.org/pub/scm/linux/kernel/git/cxl/cxl.git`
+
+   Enable CXL specific kernel configurations
+   ```
+   CONFIG_CXL_BUS=m
+   CONFIG_CXL_PCI=m
+   CONFIG_CXL_ACPI=m
+   CONFIG_CXL_PMEM=m
+   CONFIG_CXL_MEM=m
+   CONFIG_CXL_PORT=m
+   CONFIG_CXL_REGION=y
+   CONFIG_CXL_REGION_INVALIDATION_TEST=y
+   CONFIG_DEV_DAX_CXL=m
+   ```
+   Install cxl_test.ko
+   ```
+   make M=tools/testing/cxl
+   sudo make M=tools/testing/cxl modules_install
+   sudo make modules_install
+   ```
 1. Now run `meson test -C build` in the ndctl source directory, or `ndctl test`,
    if ndctl was built with `-Dtest=enabled` as a configuration option to meson.