4 files changed, 179 insertions, 17 deletions

diff --git a/drivers/acpi/nfit.c b/drivers/acpi/nfit.c
index 1b98e9dc6138..b85a46873228 100644
--- a/drivers/acpi/nfit.c
+++ b/drivers/acpi/nfit.c
@@ -171,33 +171,46 @@ static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,
                 unsigned int buf_len, int *cmd_rc)
 {
         struct acpi_nfit_desc *acpi_desc = to_acpi_nfit_desc(nd_desc);
-        const struct nd_cmd_desc *desc = NULL;
         union acpi_object in_obj, in_buf, *out_obj;
+        const struct nd_cmd_desc *desc = NULL;
         struct device *dev = acpi_desc->dev;
+        struct nd_cmd_pkg *call_pkg = NULL;
         const char *cmd_name, *dimm_name;
-        unsigned long cmd_mask;
+        unsigned long cmd_mask, dsm_mask;
         acpi_handle handle;
+        unsigned int func;
         const u8 *uuid;
         u32 offset;
         int rc, i;
 
+        func = cmd;
+        if (cmd == ND_CMD_CALL) {
+                call_pkg = buf;
+                func = call_pkg->nd_command;
+        }
+
         if (nvdimm) {
                 struct nfit_mem *nfit_mem = nvdimm_provider_data(nvdimm);
                 struct acpi_device *adev = nfit_mem->adev;
 
                 if (!adev)
                         return -ENOTTY;
+                if (call_pkg && nfit_mem->family != call_pkg->nd_family)
+                        return -ENOTTY;
+
                 dimm_name = nvdimm_name(nvdimm);
                 cmd_name = nvdimm_cmd_name(cmd);
                 cmd_mask = nvdimm_cmd_mask(nvdimm);
+                dsm_mask = nfit_mem->dsm_mask;
                 desc = nd_cmd_dimm_desc(cmd);
-                uuid = to_nfit_uuid(NFIT_DEV_DIMM);
+                uuid = to_nfit_uuid(nfit_mem->family);
                 handle = adev->handle;
         } else {
                 struct acpi_device *adev = to_acpi_dev(acpi_desc);
 
                 cmd_name = nvdimm_bus_cmd_name(cmd);
                 cmd_mask = nd_desc->cmd_mask;
+                dsm_mask = cmd_mask;
                 desc = nd_cmd_bus_desc(cmd);
                 uuid = to_nfit_uuid(NFIT_DEV_BUS);
                 handle = adev->handle;
@@ -207,7 +220,7 @@ static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,
         if (!desc || (cmd && (desc->out_num + desc->in_num == 0)))
                 return -ENOTTY;
 
-        if (!test_bit(cmd, &cmd_mask))
+        if (!test_bit(cmd, &cmd_mask) || !test_bit(func, &dsm_mask))
                 return -ENOTTY;
 
         in_obj.type = ACPI_TYPE_PACKAGE;
@@ -222,21 +235,44 @@ static int acpi_nfit_ctl(struct nvdimm_bus_descriptor *nd_desc,
                 in_buf.buffer.length += nd_cmd_in_size(nvdimm, cmd, desc,
                                 i, buf);
 
+        if (call_pkg) {
+                /* skip over package wrapper */
+                in_buf.buffer.pointer = (void *) &call_pkg->nd_payload;
+                in_buf.buffer.length = call_pkg->nd_size_in;
+        }
+
         if (IS_ENABLED(CONFIG_ACPI_NFIT_DEBUG)) {
-                dev_dbg(dev, "%s:%s cmd: %s input length: %d\n", __func__,
-                                dimm_name, cmd_name, in_buf.buffer.length);
-                print_hex_dump_debug(cmd_name, DUMP_PREFIX_OFFSET, 4,
-                                4, in_buf.buffer.pointer, min_t(u32, 128,
-                                        in_buf.buffer.length), true);
+                dev_dbg(dev, "%s:%s cmd: %d: func: %d input length: %d\n",
+                                __func__, dimm_name, cmd, func,
+                                in_buf.buffer.length);
+                print_hex_dump_debug("nvdimm in  ", DUMP_PREFIX_OFFSET, 4, 4,
+                        in_buf.buffer.pointer,
+                        min_t(u32, 256, in_buf.buffer.length), true);
         }
 
-        out_obj = acpi_evaluate_dsm(handle, uuid, 1, cmd, &in_obj);
+        out_obj = acpi_evaluate_dsm(handle, uuid, 1, func, &in_obj);
         if (!out_obj) {
                 dev_dbg(dev, "%s:%s _DSM failed cmd: %s\n", __func__, dimm_name,
                                 cmd_name);
                 return -EINVAL;
         }
 
+        if (call_pkg) {
+                call_pkg->nd_fw_size = out_obj->buffer.length;
+                memcpy(call_pkg->nd_payload + call_pkg->nd_size_in,
+                        out_obj->buffer.pointer,
+                        min(call_pkg->nd_fw_size, call_pkg->nd_size_out));
+
+                ACPI_FREE(out_obj);
+                /*
+                 * Need to support FW function w/o known size in advance.
+                 * Caller can determine required size based upon nd_fw_size.
+                 * If we return an error (like elsewhere) then caller wouldn't
+                 * be able to rely upon data returned to make calculation.
+                 */
+                return 0;
+        }
+
         if (out_obj->package.type != ACPI_TYPE_BUFFER) {
                 dev_dbg(dev, "%s:%s unexpected output object type cmd: %s type: %d\n",
                                 __func__, dimm_name, cmd_name, out_obj->type);
@@ -923,11 +959,13 @@ static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
 {
         struct acpi_device *adev, *adev_dimm;
         struct device *dev = acpi_desc->dev;
-        const u8 *uuid = to_nfit_uuid(NFIT_DEV_DIMM);
+        unsigned long dsm_mask;
+        const u8 *uuid;
         int i;
 
         /* nfit test assumes 1:1 relationship between commands and dsms */
         nfit_mem->dsm_mask = acpi_desc->dimm_cmd_force_en;
+        nfit_mem->family = NVDIMM_FAMILY_INTEL;
         adev = to_acpi_dev(acpi_desc);
         if (!adev)
                 return 0;
@@ -940,7 +978,31 @@ static int acpi_nfit_add_dimm(struct acpi_nfit_desc *acpi_desc,
                 return force_enable_dimms ? 0 : -ENODEV;
         }
 
-        for (i = ND_CMD_SMART; i <= ND_CMD_VENDOR; i++)
+        /*
+         * Until standardization materializes we need to consider up to 3
+         * different command sets.  Note, that checking for function0 (bit0)
+         * tells us if any commands are reachable through this uuid.
+         */
+        for (i = NVDIMM_FAMILY_INTEL; i <= NVDIMM_FAMILY_HPE2; i++)
+                if (acpi_check_dsm(adev_dimm->handle, to_nfit_uuid(i), 1, 1))
+                        break;
+
+        /* limit the supported commands to those that are publicly documented */
+        nfit_mem->family = i;
+        if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
+                dsm_mask = 0x3fe;
+        else if (nfit_mem->family == NVDIMM_FAMILY_HPE1)
+                dsm_mask = 0x1c3c76;
+        else if (nfit_mem->family == NVDIMM_FAMILY_HPE2)
+                dsm_mask = 0x1fe;
+        else {
+                dev_err(dev, "unknown dimm command family\n");
+                nfit_mem->family = -1;
+                return force_enable_dimms ? 0 : -ENODEV;
+        }
+
+        uuid = to_nfit_uuid(nfit_mem->family);
+        for_each_set_bit(i, &dsm_mask, BITS_PER_LONG)
                 if (acpi_check_dsm(adev_dimm->handle, uuid, 1, 1ULL << i))
                         set_bit(i, &nfit_mem->dsm_mask);
 
@@ -953,8 +1015,8 @@ static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
         int dimm_count = 0;
 
         list_for_each_entry(nfit_mem, &acpi_desc->dimms, list) {
+                unsigned long flags = 0, cmd_mask;
                 struct nvdimm *nvdimm;
-                unsigned long flags = 0;
                 u32 device_handle;
                 u16 mem_flags;
                 int rc;
@@ -978,12 +1040,17 @@ static int acpi_nfit_register_dimms(struct acpi_nfit_desc *acpi_desc)
                         continue;
 
                 /*
-                 * For now there is 1:1 relationship between cmd_mask and
-                 * dsm_mask.
+                 * TODO: provide translation for non-NVDIMM_FAMILY_INTEL
+                 * devices (i.e. from nd_cmd to acpi_dsm) to standardize the
+                 * userspace interface.
                  */
+                cmd_mask = 1UL << ND_CMD_CALL;
+                if (nfit_mem->family == NVDIMM_FAMILY_INTEL)
+                        cmd_mask |= nfit_mem->dsm_mask;
+
                 nvdimm = nvdimm_create(acpi_desc->nvdimm_bus, nfit_mem,
                                 acpi_nfit_dimm_attribute_groups,
-                                flags, nfit_mem->dsm_mask);
+                                flags, cmd_mask);
                 if (!nvdimm)
                         return -ENOMEM;
 
@@ -2468,6 +2535,8 @@ static __init int nfit_init(void)
         acpi_str_to_uuid(UUID_PERSISTENT_VIRTUAL_CD, nfit_uuid[NFIT_SPA_PCD]);
         acpi_str_to_uuid(UUID_NFIT_BUS, nfit_uuid[NFIT_DEV_BUS]);
         acpi_str_to_uuid(UUID_NFIT_DIMM, nfit_uuid[NFIT_DEV_DIMM]);
+        acpi_str_to_uuid(UUID_NFIT_DIMM_N_HPE1, nfit_uuid[NFIT_DEV_DIMM_N_HPE1]);
+        acpi_str_to_uuid(UUID_NFIT_DIMM_N_HPE2, nfit_uuid[NFIT_DEV_DIMM_N_HPE2]);
 
         nfit_wq = create_singlethread_workqueue("nfit");
         if (!nfit_wq)
diff --git a/drivers/acpi/nfit.h b/drivers/acpi/nfit.h
index 332ee6f01662..f82fda55b6de 100644
--- a/drivers/acpi/nfit.h
+++ b/drivers/acpi/nfit.h
@@ -21,13 +21,25 @@
 #include <linux/acpi.h>
 #include <acpi/acuuid.h>
 
+/* ACPI 6.1 */
 #define UUID_NFIT_BUS "2f10e7a4-9e91-11e4-89d3-123b93f75cba"
+
+/* http://pmem.io/documents/NVDIMM_DSM_Interface_Example.pdf */
 #define UUID_NFIT_DIMM "4309ac30-0d11-11e4-9191-0800200c9a66"
+
+/* https://github.com/HewlettPackard/hpe-nvm/blob/master/Documentation/ */
+#define UUID_NFIT_DIMM_N_HPE1 "9002c334-acf3-4c0e-9642-a235f0d53bc6"
+#define UUID_NFIT_DIMM_N_HPE2 "5008664b-b758-41a0-a03c-27c2f2d04f7e"
+
 #define ACPI_NFIT_MEM_FAILED_MASK (ACPI_NFIT_MEM_SAVE_FAILED \
                 | ACPI_NFIT_MEM_RESTORE_FAILED | ACPI_NFIT_MEM_FLUSH_FAILED \
                 | ACPI_NFIT_MEM_NOT_ARMED)
 
 enum nfit_uuids {
+        /* for simplicity alias the uuid index with the family id */
+        NFIT_DEV_DIMM = NVDIMM_FAMILY_INTEL,
+        NFIT_DEV_DIMM_N_HPE1 = NVDIMM_FAMILY_HPE1,
+        NFIT_DEV_DIMM_N_HPE2 = NVDIMM_FAMILY_HPE2,
         NFIT_SPA_VOLATILE,
         NFIT_SPA_PM,
         NFIT_SPA_DCR,
@@ -37,7 +49,6 @@ enum nfit_uuids {
         NFIT_SPA_PDISK,
         NFIT_SPA_PCD,
         NFIT_DEV_BUS,
-        NFIT_DEV_DIMM,
         NFIT_UUID_MAX,
 };
 
@@ -110,6 +121,7 @@ struct nfit_mem {
         struct list_head list;
         struct acpi_device *adev;
         unsigned long dsm_mask;
+        int family;
 };
 
 struct acpi_nfit_desc {
diff --git a/drivers/nvdimm/bus.c b/drivers/nvdimm/bus.c
index cb2042a12b76..395a9fbbc69d 100644
--- a/drivers/nvdimm/bus.c
+++ b/drivers/nvdimm/bus.c
@@ -439,6 +439,12 @@ static const struct nd_cmd_desc __nd_cmd_dimm_descs[] = {
                 .out_num = 3,
                 .out_sizes = { 4, 4, UINT_MAX, },
         },
+        [ND_CMD_CALL] = {
+                .in_num = 2,
+                .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
+                .out_num = 1,
+                .out_sizes = { UINT_MAX, },
+        },
 };
 
 const struct nd_cmd_desc *nd_cmd_dimm_desc(int cmd)
@@ -473,6 +479,12 @@ static const struct nd_cmd_desc __nd_cmd_bus_descs[] = {
                 .out_num = 3,
                 .out_sizes = { 4, 4, 8, },
         },
+        [ND_CMD_CALL] = {
+                .in_num = 2,
+                .in_sizes = { sizeof(struct nd_cmd_pkg), UINT_MAX, },
+                .out_num = 1,
+                .out_sizes = { UINT_MAX, },
+        },
 };
 
 const struct nd_cmd_desc *nd_cmd_bus_desc(int cmd)
@@ -500,6 +512,10 @@ u32 nd_cmd_in_size(struct nvdimm *nvdimm, int cmd,
                 struct nd_cmd_vendor_hdr *hdr = buf;
 
                 return hdr->in_length;
+        } else if (cmd == ND_CMD_CALL) {
+                struct nd_cmd_pkg *pkg = buf;
+
+                return pkg->nd_size_in;
         }
 
         return UINT_MAX;
@@ -522,6 +538,12 @@ u32 nd_cmd_out_size(struct nvdimm *nvdimm, int cmd,
                 return out_field[1];
         else if (!nvdimm && cmd == ND_CMD_ARS_STATUS && idx == 2)
                 return out_field[1] - 8;
+        else if (cmd == ND_CMD_CALL) {
+                struct nd_cmd_pkg *pkg = (struct nd_cmd_pkg *) in_field;
+
+                return pkg->nd_size_out;
+        }
+
 
         return UINT_MAX;
 }
@@ -588,6 +610,7 @@ static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
         unsigned int cmd = _IOC_NR(ioctl_cmd);
         void __user *p = (void __user *) arg;
         struct device *dev = &nvdimm_bus->dev;
+        struct nd_cmd_pkg pkg;
         const char *cmd_name, *dimm_name;
         unsigned long cmd_mask;
         void *buf;
@@ -605,6 +628,11 @@ static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
                 dimm_name = "bus";
         }
 
+        if (cmd == ND_CMD_CALL) {
+                if (copy_from_user(&pkg, p, sizeof(pkg)))
+                        return -EFAULT;
+        }
+
         if (!desc || (desc->out_num + desc->in_num == 0) ||
                         !test_bit(cmd, &cmd_mask))
                 return -ENOTTY;
@@ -616,6 +644,7 @@ static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
                 case ND_CMD_SET_CONFIG_DATA:
                 case ND_CMD_ARS_START:
                 case ND_CMD_CLEAR_ERROR:
+                case ND_CMD_CALL:
                         dev_dbg(&nvdimm_bus->dev, "'%s' command while read-only.\n",
                                         nvdimm ? nvdimm_cmd_name(cmd)
                                         : nvdimm_bus_cmd_name(cmd));
@@ -643,6 +672,16 @@ static int __nd_ioctl(struct nvdimm_bus *nvdimm_bus, struct nvdimm *nvdimm,
                 in_len += in_size;
         }
 
+        if (cmd == ND_CMD_CALL) {
+                dev_dbg(dev, "%s:%s, idx: %llu, in: %zu, out: %zu, len %zu\n",
+                                __func__, dimm_name, pkg.nd_command,
+                                in_len, out_len, buf_len);
+
+                for (i = 0; i < ARRAY_SIZE(pkg.nd_reserved2); i++)
+                        if (pkg.nd_reserved2[i])
+                                return -EINVAL;
+        }
+
         /* process an output envelope */
         for (i = 0; i < desc->out_num; i++) {
                 u32 out_size = nd_cmd_out_size(nvdimm, cmd, desc, i,
diff --git a/include/uapi/linux/ndctl.h b/include/uapi/linux/ndctl.h
index 7cc28ab05b87..45daa0be5ff9 100644
--- a/include/uapi/linux/ndctl.h
+++ b/include/uapi/linux/ndctl.h
@@ -125,6 +125,7 @@ enum {
         ND_CMD_VENDOR_EFFECT_LOG_SIZE = 7,
         ND_CMD_VENDOR_EFFECT_LOG = 8,
         ND_CMD_VENDOR = 9,
+        ND_CMD_CALL = 10,
 };
 
 enum {
@@ -158,6 +159,7 @@ static inline const char *nvdimm_cmd_name(unsigned cmd)
                 [ND_CMD_VENDOR_EFFECT_LOG_SIZE] = "effect_size",
                 [ND_CMD_VENDOR_EFFECT_LOG] = "effect_log",
                 [ND_CMD_VENDOR] = "vendor",
+                [ND_CMD_CALL] = "cmd_call",
         };
 
         if (cmd < ARRAY_SIZE(names) && names[cmd])
@@ -224,4 +226,44 @@ enum ars_masks {
         ARS_STATUS_MASK = 0x0000FFFF,
         ARS_EXT_STATUS_SHIFT = 16,
 };
+
+/*
+ * struct nd_cmd_pkg
+ *
+ * is a wrapper to a quasi pass thru interface for invoking firmware
+ * associated with nvdimms.
+ *
+ * INPUT PARAMETERS
+ *
+ * nd_family corresponds to the firmware (e.g. DSM) interface.
+ *
+ * nd_command are the function index advertised by the firmware.
+ *
+ * nd_size_in is the size of the input parameters being passed to firmware
+ *
+ * OUTPUT PARAMETERS
+ *
+ * nd_fw_size is the size of the data firmware wants to return for
+ * the call.  If nd_fw_size is greater than size of nd_size_out, only
+ * the first nd_size_out bytes are returned.
+ */
+
+struct nd_cmd_pkg {
+        __u64   nd_family;              /* family of commands */
+        __u64   nd_command;
+        __u32   nd_size_in;             /* INPUT: size of input args */
+        __u32   nd_size_out;            /* INPUT: size of payload */
+        __u32   nd_reserved2[9];        /* reserved must be zero */
+        __u32   nd_fw_size;             /* OUTPUT: size fw wants to return */
+        unsigned char nd_payload[];     /* Contents of call      */
+};
+
+/* These NVDIMM families represent pre-standardization command sets */
+#define NVDIMM_FAMILY_INTEL 0
+#define NVDIMM_FAMILY_HPE1 1
+#define NVDIMM_FAMILY_HPE2 2
+
+#define ND_IOCTL_CALL                   _IOWR(ND_IOCTL, ND_CMD_CALL,\
+                                        struct nd_cmd_pkg)
+
 #endif /* __NDCTL_H__ */