[ndctl PATCH v11 6/7] cxl/list: add --media-errors option to cxl list

[alison . schofield]

From: Alison Schofield <alison.schofi...@intel.com>

The --media-errors option to 'cxl list' retrieves poison lists from
memory devices supporting the capability and displays the returned
media_error records in the cxl list json. This option can apply to
memdevs or regions.

Include media-errors in the -vvv verbose option.

Example usage in the Documentation/cxl/cxl-list.txt update.

Signed-off-by: Alison Schofield <alison.schofi...@intel.com>
---
 Documentation/cxl/cxl-list.txt | 62 +++++++++++++++++++++++++++++++++-
 cxl/filter.h                   |  3 ++
 cxl/list.c                     |  3 ++
 3 files changed, 67 insertions(+), 1 deletion(-)

diff --git a/Documentation/cxl/cxl-list.txt b/Documentation/cxl/cxl-list.txt
index 838de4086678..6d3ef92c29e8 100644
--- a/Documentation/cxl/cxl-list.txt
+++ b/Documentation/cxl/cxl-list.txt
@@ -415,6 +415,66 @@ OPTIONS
 --region::
        Specify CXL region device name(s), or device id(s), to filter the 
listing.
 
+-L::
+--media-errors::
+       Include media-error information. The poison list is retrieved from the
+       device(s) and media_error records are added to the listing. Apply this
+       option to memdevs and regions where devices support the poison list
+       capability. "offset:" is relative to the region resource when listing
+       by region and is the absolute device DPA when listing by memdev.
+       "source:" is one of: External, Internal, Injected, Vendor Specific,
+       or Unknown, as defined in CXL Specification v3.1 Table 8-140.
+
+----
+# cxl list -m mem9 --media-errors -u
+{
+  "memdev":"mem9",
+  "pmem_size":"1024.00 MiB (1073.74 MB)",
+  "pmem_qos_class":42,
+  "ram_size":"1024.00 MiB (1073.74 MB)",
+  "ram_qos_class":42,
+  "serial":"0x5",
+  "numa_node":1,
+  "host":"cxl_mem.5",
+  "media_errors":[
+    {
+      "offset":"0x40000000",
+      "length":64,
+      "source":"Injected"
+    }
+  ]
+}
+----
+In the above example, region mappings can be found using:
+"cxl list -p mem9 --decoders"
+----
+# cxl list -r region5 --media-errors -u
+{
+  "region":"region5",
+  "resource":"0xf110000000",
+  "size":"2.00 GiB (2.15 GB)",
+  "type":"pmem",
+  "interleave_ways":2,
+  "interleave_granularity":4096,
+  "decode_state":"commit",
+  "media_errors":[
+    {
+      "offset":"0x1000",
+      "length":64,
+      "source":"Injected"
+    },
+    {
+      "offset":"0x2000",
+      "length":64,
+      "source":"Injected"
+    }
+  ]
+}
+----
+In the above example, memdev mappings can be found using:
+"cxl list -r region5 --targets" and "cxl list -d <decoder_name>"
+
+
 -v::
 --verbose::
        Increase verbosity of the output. This can be specified
@@ -431,7 +491,7 @@ OPTIONS
          devices with --idle.
        - *-vvv*
          Everything *-vv* provides, plus enable
-         --health and --partition.
+         --health, --partition, --media-errors.
 
 --debug::
        If the cxl tool was built with debug enabled, turn on debug
diff --git a/cxl/filter.h b/cxl/filter.h
index 3f65990f835a..956a46e0c7a9 100644
--- a/cxl/filter.h
+++ b/cxl/filter.h
@@ -30,6 +30,7 @@ struct cxl_filter_params {
        bool fw;
        bool alert_config;
        bool dax;
+       bool media_errors;
        int verbose;
        struct log_ctx ctx;
 };
@@ -88,6 +89,8 @@ static inline unsigned long cxl_filter_to_flags(struct 
cxl_filter_params *param)
                flags |= UTIL_JSON_ALERT_CONFIG;
        if (param->dax)
                flags |= UTIL_JSON_DAX | UTIL_JSON_DAX_DEVS;
+       if (param->media_errors)
+               flags |= UTIL_JSON_MEDIA_ERRORS;
        return flags;
 }
 
diff --git a/cxl/list.c b/cxl/list.c
index 93ba51ef895c..0b25d78248d5 100644
--- a/cxl/list.c
+++ b/cxl/list.c
@@ -57,6 +57,8 @@ static const struct option options[] = {
                    "include memory device firmware information"),
        OPT_BOOLEAN('A', "alert-config", &param.alert_config,
                    "include alert configuration information"),
+       OPT_BOOLEAN('L', "media-errors", &param.media_errors,
+                   "include media-error information "),
        OPT_INCR('v', "verbose", &param.verbose, "increase output detail"),
 #ifdef ENABLE_DEBUG
        OPT_BOOLEAN(0, "debug", &debug, "debug list walk"),
@@ -121,6 +123,7 @@ int cmd_list(int argc, const char **argv, struct cxl_ctx 
*ctx)
                param.fw = true;
                param.alert_config = true;
                param.dax = true;
+               param.media_errors = true;
                /* fallthrough */
        case 2:
                param.idle = true;
-- 
2.37.3