crypto: nx - add NX-842 platform frontend driver
authorDan Streetman <ddstreet@ieee.org>
Thu, 7 May 2015 17:49:17 +0000 (13:49 -0400)
committerHerbert Xu <herbert@gondor.apana.org.au>
Mon, 11 May 2015 07:06:46 +0000 (15:06 +0800)
Add NX-842 frontend that allows using either the pSeries platform or
PowerNV platform driver (to be added by later patch) for the NX-842
hardware.  Update the MAINTAINERS file to include the new filenames.
Update Kconfig files to clarify titles and descriptions, and correct
dependencies.

Signed-off-by: Dan Streetman <ddstreet@ieee.org>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
MAINTAINERS
drivers/crypto/Kconfig
drivers/crypto/nx/Kconfig
drivers/crypto/nx/Makefile
drivers/crypto/nx/nx-842-pseries.c
drivers/crypto/nx/nx-842.c [new file with mode: 0644]
drivers/crypto/nx/nx-842.h [new file with mode: 0644]
include/linux/nx842.h

index a13b4b10ff460f49de8a6e3f9e65bd09413df8ab..912c9d9f741c5f95b3a20ea7a2278e7b55c6c5ea 100644 (file)
@@ -4861,7 +4861,7 @@ F:        drivers/crypto/nx/
 IBM Power 842 compression accelerator
 M:     Dan Streetman <ddstreet@us.ibm.com>
 S:     Supported
-F:     drivers/crypto/nx/nx-842.c
+F:     drivers/crypto/nx/nx-842*
 F:     include/linux/nx842.h
 F:     include/linux/sw842.h
 F:     crypto/842.c
index 8a76a012be614c36b5436ab6d3414dc06a9ff35c..0889e496d8863f43faa020851c0d20354db53625 100644 (file)
@@ -330,11 +330,13 @@ config CRYPTO_DEV_S5P
          algorithms execution.
 
 config CRYPTO_DEV_NX
-       bool "Support for IBM Power7+ in-Nest cryptographic acceleration"
-       depends on PPC64 && IBMVIO && !CPU_LITTLE_ENDIAN
-       default n
+       bool "Support for IBM PowerPC Nest (NX) cryptographic acceleration"
+       depends on PPC64
        help
-         Support for Power7+ in-Nest cryptographic acceleration.
+         This enables support for the NX hardware cryptographic accelerator
+         coprocessor that is in IBM PowerPC P7+ or later processors.  This
+         does not actually enable any drivers, it only allows you to select
+         which acceleration type (encryption and/or compression) to enable.
 
 if CRYPTO_DEV_NX
        source "drivers/crypto/nx/Kconfig"
index f82616621ae13e868210e34f1b26b83584848f8b..34013f7d46c86dc84afb63977a8fd5391a046226 100644 (file)
@@ -1,7 +1,9 @@
+
 config CRYPTO_DEV_NX_ENCRYPT
-       tristate "Encryption acceleration support"
-       depends on PPC64 && IBMVIO
+       tristate "Encryption acceleration support on pSeries platform"
+       depends on PPC_PSERIES && IBMVIO && !CPU_LITTLE_ENDIAN
        default y
+       select CRYPTO_ALGAPI
        select CRYPTO_AES
        select CRYPTO_CBC
        select CRYPTO_ECB
@@ -12,15 +14,30 @@ config CRYPTO_DEV_NX_ENCRYPT
        select CRYPTO_SHA256
        select CRYPTO_SHA512
        help
-         Support for Power7+ in-Nest encryption acceleration. This
-         module supports acceleration for AES and SHA2 algorithms. If you
-         choose 'M' here, this module will be called nx_crypto.
+         Support for PowerPC Nest (NX) encryption acceleration. This
+         module supports acceleration for AES and SHA2 algorithms on
+         the pSeries platform.  If you choose 'M' here, this module
+         will be called nx_crypto.
 
 config CRYPTO_DEV_NX_COMPRESS
        tristate "Compression acceleration support"
-       depends on PPC64 && IBMVIO
        default y
        help
-         Support for Power7+ in-Nest compression acceleration. This
-         module supports acceleration for AES and SHA2 algorithms. If you
-         choose 'M' here, this module will be called nx_compress.
+         Support for PowerPC Nest (NX) compression acceleration. This
+         module supports acceleration for compressing memory with the 842
+         algorithm.  One of the platform drivers must be selected also.
+         If you choose 'M' here, this module will be called nx_compress.
+
+if CRYPTO_DEV_NX_COMPRESS
+
+config CRYPTO_DEV_NX_COMPRESS_PSERIES
+       tristate "Compression acceleration support on pSeries platform"
+       depends on PPC_PSERIES && IBMVIO && !CPU_LITTLE_ENDIAN
+       default y
+       help
+         Support for PowerPC Nest (NX) compression acceleration. This
+         module supports acceleration for compressing memory with the 842
+         algorithm.  This supports NX hardware on the pSeries platform.
+         If you choose 'M' here, this module will be called nx_compress_pseries.
+
+endif
index 8669ffa8dc5ce8f32bb434ab089aa4c66b4ccfcc..5d9f4bc152091c636747c3dfa3db4300e072dc7d 100644 (file)
@@ -11,4 +11,6 @@ nx-crypto-objs := nx.o \
                  nx-sha512.o
 
 obj-$(CONFIG_CRYPTO_DEV_NX_COMPRESS) += nx-compress.o
-nx-compress-objs := nx-842-pseries.o
+obj-$(CONFIG_CRYPTO_DEV_NX_COMPRESS_PSERIES) += nx-compress-pseries.o
+nx-compress-objs := nx-842.o
+nx-compress-pseries-objs := nx-842-pseries.o
index 887196e9b50c08250ee57fac412c14b1b8be0142..9b83c9e7fd73cb2205dbd30c581812abc4870ee6 100644 (file)
  *          Seth Jennings <sjenning@linux.vnet.ibm.com>
  */
 
-#include <linux/kernel.h>
-#include <linux/module.h>
-#include <linux/nx842.h>
-#include <linux/of.h>
-#include <linux/slab.h>
-
 #include <asm/page.h>
 #include <asm/vio.h>
 
+#include "nx-842.h"
 #include "nx_csbcpb.h" /* struct nx_csbcpb */
 
-#define MODULE_NAME "nx-compress"
+#define MODULE_NAME NX842_PSERIES_MODULE_NAME
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Robert Jennings <rcj@linux.vnet.ibm.com>");
 MODULE_DESCRIPTION("842 H/W Compression driver for IBM Power processors");
@@ -236,18 +231,6 @@ struct nx842_workmem {
        };
 };
 
-int nx842_get_workmem_size(void)
-{
-       return sizeof(struct nx842_workmem) + NX842_HW_PAGE_SIZE;
-}
-EXPORT_SYMBOL_GPL(nx842_get_workmem_size);
-
-int nx842_get_workmem_size_aligned(void)
-{
-       return sizeof(struct nx842_workmem);
-}
-EXPORT_SYMBOL_GPL(nx842_get_workmem_size_aligned);
-
 static int nx842_validate_result(struct device *dev,
        struct cop_status_block *csb)
 {
@@ -300,7 +283,7 @@ static int nx842_validate_result(struct device *dev,
 }
 
 /**
- * nx842_compress - Compress data using the 842 algorithm
+ * nx842_pseries_compress - Compress data using the 842 algorithm
  *
  * Compression provide by the NX842 coprocessor on IBM Power systems.
  * The input buffer is compressed and the result is stored in the
@@ -315,7 +298,7 @@ static int nx842_validate_result(struct device *dev,
  * @out: Pointer to output buffer
  * @outlen: Length of output buffer
  * @wrkmem: ptr to buffer for working memory, size determined by
- *          nx842_get_workmem_size()
+ *          NX842_MEM_COMPRESS
  *
  * Returns:
  *   0         Success, output of length @outlen stored in the buffer at @out
@@ -325,8 +308,9 @@ static int nx842_validate_result(struct device *dev,
  *   -EIO      Internal error
  *   -ENODEV   Hardware unavailable
  */
-int nx842_compress(const unsigned char *in, unsigned int inlen,
-                      unsigned char *out, unsigned int *outlen, void *wmem)
+static int nx842_pseries_compress(const unsigned char *in, unsigned int inlen,
+                                 unsigned char *out, unsigned int *outlen,
+                                 void *wmem)
 {
        struct nx842_header *hdr;
        struct nx842_devdata *local_devdata;
@@ -493,13 +477,12 @@ unlock:
        rcu_read_unlock();
        return ret;
 }
-EXPORT_SYMBOL_GPL(nx842_compress);
 
 static int sw842_decompress(const unsigned char *, int, unsigned char *, int *,
                        const void *);
 
 /**
- * nx842_decompress - Decompress data using the 842 algorithm
+ * nx842_pseries_decompress - Decompress data using the 842 algorithm
  *
  * Decompression provide by the NX842 coprocessor on IBM Power systems.
  * The input buffer is decompressed and the result is stored in the
@@ -515,7 +498,7 @@ static int sw842_decompress(const unsigned char *, int, unsigned char *, int *,
  * @out: Pointer to output buffer, must be page aligned
  * @outlen: Length of output buffer, must be PAGE_SIZE
  * @wrkmem: ptr to buffer for working memory, size determined by
- *          nx842_get_workmem_size()
+ *          NX842_MEM_COMPRESS
  *
  * Returns:
  *   0         Success, output of length @outlen stored in the buffer at @out
@@ -525,8 +508,9 @@ static int sw842_decompress(const unsigned char *, int, unsigned char *, int *,
  *   -EINVAL   Bad input data encountered when attempting decompress
  *   -EIO      Internal error
  */
-int nx842_decompress(const unsigned char *in, unsigned int inlen,
-                        unsigned char *out, unsigned int *outlen, void *wmem)
+static int nx842_pseries_decompress(const unsigned char *in, unsigned int inlen,
+                                   unsigned char *out, unsigned int *outlen,
+                                   void *wmem)
 {
        struct nx842_header *hdr;
        struct nx842_devdata *local_devdata;
@@ -694,7 +678,6 @@ unlock:
        rcu_read_unlock();
        return ret;
 }
-EXPORT_SYMBOL_GPL(nx842_decompress);
 
 /**
  * nx842_OF_set_defaults -- Set default (disabled) values for devdata
@@ -1130,6 +1113,12 @@ static struct attribute_group nx842_attribute_group = {
        .attrs = nx842_sysfs_entries,
 };
 
+static struct nx842_driver nx842_pseries_driver = {
+       .owner =        THIS_MODULE,
+       .compress =     nx842_pseries_compress,
+       .decompress =   nx842_pseries_decompress,
+};
+
 static int __init nx842_probe(struct vio_dev *viodev,
                                  const struct vio_device_id *id)
 {
@@ -1192,6 +1181,8 @@ static int __init nx842_probe(struct vio_dev *viodev,
                goto error;
        }
 
+       nx842_register_driver(&nx842_pseries_driver);
+
        return 0;
 
 error_unlock:
@@ -1222,11 +1213,14 @@ static int __exit nx842_remove(struct vio_dev *viodev)
        if (old_devdata)
                kfree(old_devdata->counters);
        kfree(old_devdata);
+
+       nx842_unregister_driver(&nx842_pseries_driver);
+
        return 0;
 }
 
 static struct vio_device_id nx842_driver_ids[] = {
-       {"ibm,compression-v1", "ibm,compression"},
+       {NX842_PSERIES_COMPAT_NAME "-v1", NX842_PSERIES_COMPAT_NAME},
        {"", ""},
 };
 
@@ -1243,6 +1237,8 @@ static int __init nx842_init(void)
        struct nx842_devdata *new_devdata;
        pr_info("Registering IBM Power 842 compression driver\n");
 
+       BUILD_BUG_ON(sizeof(struct nx842_workmem) > NX842_MEM_COMPRESS);
+
        RCU_INIT_POINTER(devdata, NULL);
        new_devdata = kzalloc(sizeof(*new_devdata), GFP_KERNEL);
        if (!new_devdata) {
@@ -1272,6 +1268,7 @@ static void __exit nx842_exit(void)
        if (old_devdata)
                dev_set_drvdata(old_devdata->dev, NULL);
        kfree(old_devdata);
+       nx842_unregister_driver(&nx842_pseries_driver);
        vio_unregister_driver(&nx842_driver);
 }
 
diff --git a/drivers/crypto/nx/nx-842.c b/drivers/crypto/nx/nx-842.c
new file mode 100644 (file)
index 0000000..f1f378e
--- /dev/null
@@ -0,0 +1,144 @@
+/*
+ * Driver frontend for IBM Power 842 compression accelerator
+ *
+ * Copyright (C) 2015 Dan Streetman, IBM Corp
+ *
+ * Designer of the Power data compression engine:
+ *   Bulent Abali <abali@us.ibm.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
+
+#include "nx-842.h"
+
+#define MODULE_NAME "nx-compress"
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Dan Streetman <ddstreet@ieee.org>");
+MODULE_DESCRIPTION("842 H/W Compression driver for IBM Power processors");
+
+/* Only one driver is expected, based on the HW platform */
+static struct nx842_driver *nx842_driver;
+static DEFINE_SPINLOCK(nx842_driver_lock); /* protects driver pointers */
+
+void nx842_register_driver(struct nx842_driver *driver)
+{
+       spin_lock(&nx842_driver_lock);
+
+       if (nx842_driver) {
+               pr_err("can't register driver %s, already using driver %s\n",
+                      driver->owner->name, nx842_driver->owner->name);
+       } else {
+               pr_info("registering driver %s\n", driver->owner->name);
+               nx842_driver = driver;
+       }
+
+       spin_unlock(&nx842_driver_lock);
+}
+EXPORT_SYMBOL_GPL(nx842_register_driver);
+
+void nx842_unregister_driver(struct nx842_driver *driver)
+{
+       spin_lock(&nx842_driver_lock);
+
+       if (nx842_driver == driver) {
+               pr_info("unregistering driver %s\n", driver->owner->name);
+               nx842_driver = NULL;
+       } else if (nx842_driver) {
+               pr_err("can't unregister driver %s, using driver %s\n",
+                      driver->owner->name, nx842_driver->owner->name);
+       } else {
+               pr_err("can't unregister driver %s, no driver in use\n",
+                      driver->owner->name);
+       }
+
+       spin_unlock(&nx842_driver_lock);
+}
+EXPORT_SYMBOL_GPL(nx842_unregister_driver);
+
+static struct nx842_driver *get_driver(void)
+{
+       struct nx842_driver *driver = NULL;
+
+       spin_lock(&nx842_driver_lock);
+
+       driver = nx842_driver;
+
+       if (driver && !try_module_get(driver->owner))
+               driver = NULL;
+
+       spin_unlock(&nx842_driver_lock);
+
+       return driver;
+}
+
+static void put_driver(struct nx842_driver *driver)
+{
+       module_put(driver->owner);
+}
+
+int nx842_compress(const unsigned char *in, unsigned int in_len,
+                  unsigned char *out, unsigned int *out_len,
+                  void *wrkmem)
+{
+       struct nx842_driver *driver = get_driver();
+       int ret;
+
+       if (!driver)
+               return -ENODEV;
+
+       ret = driver->compress(in, in_len, out, out_len, wrkmem);
+
+       put_driver(driver);
+
+       return ret;
+}
+EXPORT_SYMBOL_GPL(nx842_compress);
+
+int nx842_decompress(const unsigned char *in, unsigned int in_len,
+                    unsigned char *out, unsigned int *out_len,
+                    void *wrkmem)
+{
+       struct nx842_driver *driver = get_driver();
+       int ret;
+
+       if (!driver)
+               return -ENODEV;
+
+       ret = driver->decompress(in, in_len, out, out_len, wrkmem);
+
+       put_driver(driver);
+
+       return ret;
+}
+EXPORT_SYMBOL_GPL(nx842_decompress);
+
+static __init int nx842_init(void)
+{
+       pr_info("loading\n");
+
+       if (of_find_compatible_node(NULL, NULL, NX842_PSERIES_COMPAT_NAME))
+               request_module_nowait(NX842_PSERIES_MODULE_NAME);
+       else
+               pr_err("no nx842 driver found.\n");
+
+       pr_info("loaded\n");
+
+       return 0;
+}
+module_init(nx842_init);
+
+static void __exit nx842_exit(void)
+{
+       pr_info("NX842 unloaded\n");
+}
+module_exit(nx842_exit);
diff --git a/drivers/crypto/nx/nx-842.h b/drivers/crypto/nx/nx-842.h
new file mode 100644 (file)
index 0000000..2a5d4e1
--- /dev/null
@@ -0,0 +1,32 @@
+
+#ifndef __NX_842_H__
+#define __NX_842_H__
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/nx842.h>
+#include <linux/of.h>
+#include <linux/slab.h>
+#include <linux/io.h>
+
+struct nx842_driver {
+       struct module *owner;
+
+       int (*compress)(const unsigned char *in, unsigned int in_len,
+                       unsigned char *out, unsigned int *out_len,
+                       void *wrkmem);
+       int (*decompress)(const unsigned char *in, unsigned int in_len,
+                         unsigned char *out, unsigned int *out_len,
+                         void *wrkmem);
+};
+
+void nx842_register_driver(struct nx842_driver *driver);
+void nx842_unregister_driver(struct nx842_driver *driver);
+
+
+/* To allow the main nx-compress module to load platform module */
+#define NX842_PSERIES_MODULE_NAME      "nx-compress-pseries"
+#define NX842_PSERIES_COMPAT_NAME      "ibm,compression"
+
+
+#endif /* __NX_842_H__ */
index a4d324c6406a5144e11170a1e0eaecec06ae85c8..d919c22b7fd63510112aecec7bdacb33797583c7 100644 (file)
@@ -1,11 +1,13 @@
 #ifndef __NX842_H__
 #define __NX842_H__
 
-int nx842_get_workmem_size(void);
-int nx842_get_workmem_size_aligned(void);
+#define __NX842_PSERIES_MEM_COMPRESS   ((PAGE_SIZE * 2) + 10240)
+
+#define NX842_MEM_COMPRESS     __NX842_PSERIES_MEM_COMPRESS
+
 int nx842_compress(const unsigned char *in, unsigned int in_len,
-               unsigned char *out, unsigned int *out_len, void *wrkmem);
+                  unsigned char *out, unsigned int *out_len, void *wrkmem);
 int nx842_decompress(const unsigned char *in, unsigned int in_len,
-               unsigned char *out, unsigned int *out_len, void *wrkmem);
+                    unsigned char *out, unsigned int *out_len, void *wrkmem);
 
 #endif