2008-03-13 11:22:14

by Ben Nizette

[permalink] [raw]
Subject: [PATCH v4] UIO: Implement a UIO interface for the SMX Cryptengine

This patch implements a UIO interface for the SMX Cryptengine.

The Cryptengine found on the Nias Digital SMX board is best suited
for a UIO interface. It is not wired in to the cryptographic API
as the engine handles it's own keys, algorithms, everything. All
that we know about is that if there's room in the buffer, you can
write data to it and when there's data ready, you read it out again.

There isn't necessarily even any direct correlation between data
going in and data coming out again, the engine may consume or
generate data all on its own.

This driver is for proprietary hardware but we're always told to
submit the drivers anyway; here you are. :-)

This is version 4 of this patch and addresses all issues raised by
Hans-Jürgen Koch and Paul Mundt in their reviews. Slightly altered
is Paul's suggestion to use DRV_NAME and DRV_VERSION as the UIO
version and name. While at the moment they are the same, there
is no reason for them to stay that way. Nevertheless we now at
least provide a MODULE_VERSION macro to keep modinfo happy.

Signed-off-by: Ben Nizette <[email protected]>
---
diff --git a/MAINTAINERS b/MAINTAINERS
index 2cdb591..480fd44 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3554,6 +3554,11 @@ M: [email protected]
L: [email protected]
S: Maintained

+SMX UIO Interface
+P: Ben Nizette
+M: [email protected]
+S: Maintained
+
SOFTMAC LAYER (IEEE 802.11)
P: Daniel Drake
M: [email protected]
diff --git a/drivers/uio/Kconfig b/drivers/uio/Kconfig
index b778ed7..f57b347 100644
--- a/drivers/uio/Kconfig
+++ b/drivers/uio/Kconfig
@@ -26,4 +26,16 @@ config UIO_CIF
To compile this driver as a module, choose M here: the module
will be called uio_cif.

+config UIO_SMX
+ tristate "SMX cryptengine UIO interface"
+ depends on UIO
+ default n
+ help
+ Userspace IO interface to the Cryptography engine found on the
+ Nias Digital SMX boards. These will be available from Q4 2008
+ from http://www.niasdigital.com. The userspace part of this
+ driver will be released under the GPL at the same time as the
+ hardware and will be able to be downloaded from the same site.
+
+ If you compile this as a module, it will be called uio_smx.
endmenu
diff --git a/drivers/uio/Makefile b/drivers/uio/Makefile
index 7fecfb4..18c4566 100644
--- a/drivers/uio/Makefile
+++ b/drivers/uio/Makefile
@@ -1,2 +1,3 @@
obj-$(CONFIG_UIO) += uio.o
obj-$(CONFIG_UIO_CIF) += uio_cif.o
+obj-$(CONFIG_UIO_SMX) += uio_smx.o
diff --git a/drivers/uio/uio_smx.c b/drivers/uio/uio_smx.c
new file mode 100644
index 0000000..44054a6
--- /dev/null
+++ b/drivers/uio/uio_smx.c
@@ -0,0 +1,140 @@
+/*
+ * UIO SMX Cryptengine driver.
+ *
+ * (C) 2008 Nias Digital P/L <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ */
+
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/uio_driver.h>
+#include <linux/io.h>
+
+#define DRV_NAME "smx-ce"
+#define DRV_VERSION "0.03"
+
+#define SMX_CSR 0x00000000
+#define SMX_EnD 0x00000001
+#define SMX_RUN 0x00000002
+#define SMX_DRDY 0x00000004
+#define SMX_ERR 0x00000008
+
+static irqreturn_t smx_handler(int irq, struct uio_info *dev_info)
+{
+ void __iomem *csr = dev_info->mem[0].internal_addr + SMX_CSR;
+
+ u32 status = ioread32(csr);
+
+ if (!(status & SMX_DRDY))
+ return IRQ_NONE;
+
+ /* Disable interrupt */
+ iowrite32(status & ~SMX_DRDY, csr);
+ return IRQ_HANDLED;
+}
+
+static int __devinit smx_ce_probe(struct platform_device *dev)
+{
+
+ int ret = -ENODEV;
+ struct uio_info *info;
+ struct resource *regs;
+
+ info = kzalloc(sizeof(struct uio_info), GFP_KERNEL);
+ if (!info)
+ return -ENOMEM;
+
+ regs = platform_get_resource(dev, IORESOURCE_MEM, 0);
+ if (!regs) {
+ dev_err(&dev->dev, "No memory resource specified\n");
+ goto out_free;
+ }
+
+ info->mem[0].addr = regs->start;
+ if (!info->mem[0].addr) {
+ dev_err(&dev->dev, "Invalid memory resource\n");
+ goto out_free;
+ }
+
+ info->mem[0].size = regs->end - regs->start + 1;
+ info->mem[0].internal_addr = ioremap(regs->start, info->mem[0].size);
+
+ if (!info->mem[0].internal_addr) {
+ dev_err(&dev->dev, "Can't remap memory address range\n");
+ goto out_free;
+ }
+
+ info->mem[0].memtype = UIO_MEM_PHYS;
+
+ info->name = "smx-ce";
+ info->version = "0.03";
+
+ info->irq = platform_get_irq(dev, 0);
+ if (info->irq < 0) {
+ ret = info->irq;
+ dev_err(&dev->dev, "No (or invalid) IRQ resource specified\n");
+ goto out_unmap;
+ }
+
+ info->irq_flags = IRQF_SHARED;
+ info->handler = smx_handler;
+
+ platform_set_drvdata(dev, info);
+
+ ret = uio_register_device(&dev->dev, info);
+
+ if (ret)
+ goto out_unmap;
+
+ return 0;
+
+out_unmap:
+ iounmap(info->mem[0].internal_addr);
+out_free:
+ kfree(info);
+
+ return ret;
+}
+
+static int __devexit smx_ce_remove(struct platform_device *dev)
+{
+ struct uio_info *info = platform_get_drvdata(dev);
+
+ uio_unregister_device(info);
+ platform_set_drvdata(dev, NULL);
+ iounmap(info->mem[0].internal_addr);
+
+ kfree(info);
+
+ return 0;
+}
+
+static struct platform_driver smx_ce_driver = {
+ .probe = smx_ce_probe,
+ .remove = __devexit_p(smx_ce_remove),
+ .driver = {
+ .name = DRV_NAME,
+ .owner = THIS_MODULE,
+ },
+};
+
+static int __init smx_ce_init_module(void)
+{
+ return platform_driver_register(&smx_ce_driver);
+}
+module_init(smx_ce_init_module);
+
+static void __exit smx_ce_exit_module(void)
+{
+ platform_driver_unregister(&smx_ce_driver);
+}
+module_exit(smx_ce_exit_module);
+
+MODULE_LICENSE("GPL v2");
+MODULE_VERSION(DRV_VERSION);
+MODULE_AUTHOR("Ben Nizette <[email protected]>");


2008-03-13 13:21:32

by Paul Mundt

[permalink] [raw]
Subject: Re: [PATCH v4] UIO: Implement a UIO interface for the SMX Cryptengine

On Thu, Mar 13, 2008 at 10:27:30PM +1100, Ben Nizette wrote:
> This patch implements a UIO interface for the SMX Cryptengine.
>
> The Cryptengine found on the Nias Digital SMX board is best suited
> for a UIO interface. It is not wired in to the cryptographic API
> as the engine handles it's own keys, algorithms, everything. All
> that we know about is that if there's room in the buffer, you can
> write data to it and when there's data ready, you read it out again.
>
> There isn't necessarily even any direct correlation between data
> going in and data coming out again, the engine may consume or
> generate data all on its own.
>
> This driver is for proprietary hardware but we're always told to
> submit the drivers anyway; here you are. :-)
>
> This is version 4 of this patch and addresses all issues raised by
> Hans-J??rgen Koch and Paul Mundt in their reviews. Slightly altered
> is Paul's suggestion to use DRV_NAME and DRV_VERSION as the UIO
> version and name. While at the moment they are the same, there
> is no reason for them to stay that way. Nevertheless we now at
> least provide a MODULE_VERSION macro to keep modinfo happy.
>
Looks good to me.

2008-03-13 14:34:08

by Hans J. Koch

[permalink] [raw]
Subject: Re: [PATCH v4] UIO: Implement a UIO interface for the SMX Cryptengine

Am Thu, 13 Mar 2008 22:27:30 +1100
schrieb Ben Nizette <[email protected]>:

Hi Ben,

> This patch implements a UIO interface for the SMX Cryptengine.

Thanks for fixing the issues mentioned. Looks alright to me now.

>
> The Cryptengine found on the Nias Digital SMX board is best suited
> for a UIO interface. It is not wired in to the cryptographic API
> as the engine handles it's own keys, algorithms, everything. All
> that we know about is that if there's room in the buffer, you can
> write data to it and when there's data ready, you read it out again.
>
> There isn't necessarily even any direct correlation between data
> going in and data coming out again, the engine may consume or
> generate data all on its own.
>
> This driver is for proprietary hardware but we're always told to
> submit the drivers anyway; here you are. :-)
>
> This is version 4 of this patch and addresses all issues raised by
> Hans-Jürgen Koch and Paul Mundt in their reviews. Slightly altered
> is Paul's suggestion to use DRV_NAME and DRV_VERSION as the UIO
> version and name. While at the moment they are the same, there
> is no reason for them to stay that way. Nevertheless we now at
> least provide a MODULE_VERSION macro to keep modinfo happy.
>
> Signed-off-by: Ben Nizette <[email protected]>

Signed-off-by: Hans J Koch <[email protected]>

> ---
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 2cdb591..480fd44 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3554,6 +3554,11 @@ M: [email protected]
> L: [email protected]
> S: Maintained
>
> +SMX UIO Interface
> +P: Ben Nizette
> +M: [email protected]
> +S: Maintained
> +
> SOFTMAC LAYER (IEEE 802.11)
> P: Daniel Drake
> M: [email protected]
> diff --git a/drivers/uio/Kconfig b/drivers/uio/Kconfig
> index b778ed7..f57b347 100644
> --- a/drivers/uio/Kconfig
> +++ b/drivers/uio/Kconfig
> @@ -26,4 +26,16 @@ config UIO_CIF
> To compile this driver as a module, choose M here: the module
> will be called uio_cif.
>
> +config UIO_SMX
> + tristate "SMX cryptengine UIO interface"
> + depends on UIO
> + default n
> + help
> + Userspace IO interface to the Cryptography engine found on the
> + Nias Digital SMX boards. These will be available from Q4 2008
> + from http://www.niasdigital.com. The userspace part of this
> + driver will be released under the GPL at the same time as the
> + hardware and will be able to be downloaded from the same site.
> +
> + If you compile this as a module, it will be called uio_smx.
> endmenu
> diff --git a/drivers/uio/Makefile b/drivers/uio/Makefile
> index 7fecfb4..18c4566 100644
> --- a/drivers/uio/Makefile
> +++ b/drivers/uio/Makefile
> @@ -1,2 +1,3 @@
> obj-$(CONFIG_UIO) += uio.o
> obj-$(CONFIG_UIO_CIF) += uio_cif.o
> +obj-$(CONFIG_UIO_SMX) += uio_smx.o
> diff --git a/drivers/uio/uio_smx.c b/drivers/uio/uio_smx.c
> new file mode 100644
> index 0000000..44054a6
> --- /dev/null
> +++ b/drivers/uio/uio_smx.c
> @@ -0,0 +1,140 @@
> +/*
> + * UIO SMX Cryptengine driver.
> + *
> + * (C) 2008 Nias Digital P/L <[email protected]>
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License version 2 as
> + * published by the Free Software Foundation.
> + *
> + */
> +
> +#include <linux/device.h>
> +#include <linux/module.h>
> +#include <linux/platform_device.h>
> +#include <linux/uio_driver.h>
> +#include <linux/io.h>
> +
> +#define DRV_NAME "smx-ce"
> +#define DRV_VERSION "0.03"
> +
> +#define SMX_CSR 0x00000000
> +#define SMX_EnD 0x00000001
> +#define SMX_RUN 0x00000002
> +#define SMX_DRDY 0x00000004
> +#define SMX_ERR 0x00000008
> +
> +static irqreturn_t smx_handler(int irq, struct uio_info *dev_info)
> +{
> + void __iomem *csr = dev_info->mem[0].internal_addr + SMX_CSR;
> +
> + u32 status = ioread32(csr);
> +
> + if (!(status & SMX_DRDY))
> + return IRQ_NONE;
> +
> + /* Disable interrupt */
> + iowrite32(status & ~SMX_DRDY, csr);
> + return IRQ_HANDLED;
> +}
> +
> +static int __devinit smx_ce_probe(struct platform_device *dev)
> +{
> +
> + int ret = -ENODEV;
> + struct uio_info *info;
> + struct resource *regs;
> +
> + info = kzalloc(sizeof(struct uio_info), GFP_KERNEL);
> + if (!info)
> + return -ENOMEM;
> +
> + regs = platform_get_resource(dev, IORESOURCE_MEM, 0);
> + if (!regs) {
> + dev_err(&dev->dev, "No memory resource specified\n");
> + goto out_free;
> + }
> +
> + info->mem[0].addr = regs->start;
> + if (!info->mem[0].addr) {
> + dev_err(&dev->dev, "Invalid memory resource\n");
> + goto out_free;
> + }
> +
> + info->mem[0].size = regs->end - regs->start + 1;
> + info->mem[0].internal_addr = ioremap(regs->start, info->mem[0].size);
> +
> + if (!info->mem[0].internal_addr) {
> + dev_err(&dev->dev, "Can't remap memory address range\n");
> + goto out_free;
> + }
> +
> + info->mem[0].memtype = UIO_MEM_PHYS;
> +
> + info->name = "smx-ce";
> + info->version = "0.03";
> +
> + info->irq = platform_get_irq(dev, 0);
> + if (info->irq < 0) {
> + ret = info->irq;
> + dev_err(&dev->dev, "No (or invalid) IRQ resource specified\n");
> + goto out_unmap;
> + }
> +
> + info->irq_flags = IRQF_SHARED;
> + info->handler = smx_handler;
> +
> + platform_set_drvdata(dev, info);
> +
> + ret = uio_register_device(&dev->dev, info);
> +
> + if (ret)
> + goto out_unmap;
> +
> + return 0;
> +
> +out_unmap:
> + iounmap(info->mem[0].internal_addr);
> +out_free:
> + kfree(info);
> +
> + return ret;
> +}
> +
> +static int __devexit smx_ce_remove(struct platform_device *dev)
> +{
> + struct uio_info *info = platform_get_drvdata(dev);
> +
> + uio_unregister_device(info);
> + platform_set_drvdata(dev, NULL);
> + iounmap(info->mem[0].internal_addr);
> +
> + kfree(info);
> +
> + return 0;
> +}
> +
> +static struct platform_driver smx_ce_driver = {
> + .probe = smx_ce_probe,
> + .remove = __devexit_p(smx_ce_remove),
> + .driver = {
> + .name = DRV_NAME,
> + .owner = THIS_MODULE,
> + },
> +};
> +
> +static int __init smx_ce_init_module(void)
> +{
> + return platform_driver_register(&smx_ce_driver);
> +}
> +module_init(smx_ce_init_module);
> +
> +static void __exit smx_ce_exit_module(void)
> +{
> + platform_driver_unregister(&smx_ce_driver);
> +}
> +module_exit(smx_ce_exit_module);
> +
> +MODULE_LICENSE("GPL v2");
> +MODULE_VERSION(DRV_VERSION);
> +MODULE_AUTHOR("Ben Nizette <[email protected]>");
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to [email protected]
> More majordomo info at http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at http://www.tux.org/lkml/

2008-03-13 20:56:34

by Greg KH

[permalink] [raw]
Subject: patch uio-implement-a-uio-interface-for-the-smx-cryptengine.patch added to gregkh-2.6 tree


This is a note to let you know that I've just added the patch titled

Subject: UIO: Implement a UIO interface for the SMX Cryptengine

to my gregkh-2.6 tree. Its filename is

uio-implement-a-uio-interface-for-the-smx-cryptengine.patch

This tree can be found at
http://www.kernel.org/pub/linux/kernel/people/gregkh/gregkh-2.6/patches/


>From [email protected] Thu Mar 13 13:40:45 2008
From: Ben Nizette <[email protected]>
Date: Thu, 13 Mar 2008 22:27:30 +1100
Subject: UIO: Implement a UIO interface for the SMX Cryptengine
To: Hans-J?rgen Koch <[email protected]>
Cc: Paul Mundt <[email protected]>, gregkh <[email protected]>, linux-kernel <[email protected]>
Message-ID: <[email protected]>

From: Ben Nizette <[email protected]>

This patch implements a UIO interface for the SMX Cryptengine.

The Cryptengine found on the Nias Digital SMX board is best suited
for a UIO interface. It is not wired in to the cryptographic API
as the engine handles it's own keys, algorithms, everything. All
that we know about is that if there's room in the buffer, you can
write data to it and when there's data ready, you read it out again.

There isn't necessarily even any direct correlation between data
going in and data coming out again, the engine may consume or
generate data all on its own.

This driver is for proprietary hardware but we're always told to
submit the drivers anyway; here you are. :-)

This is version 4 of this patch and addresses all issues raised by
Hans-Jürgen Koch and Paul Mundt in their reviews. Slightly altered
is Paul's suggestion to use DRV_NAME and DRV_VERSION as the UIO
version and name. While at the moment they are the same, there
is no reason for them to stay that way. Nevertheless we now at
least provide a MODULE_VERSION macro to keep modinfo happy.

Signed-off-by: Ben Nizette <[email protected]>
Acked-by: Paul Mundt <[email protected]>
Signed-off-by: Hans J Koch <[email protected]>
Signed-off-by: Greg Kroah-Hartman <[email protected]>

---
MAINTAINERS | 5 +
drivers/uio/Kconfig | 13 ++++
drivers/uio/Makefile | 1
drivers/uio/uio_smx.c | 140 ++++++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 159 insertions(+)

--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3583,6 +3583,11 @@ M: [email protected]
L: [email protected]
S: Maintained

+SMX UIO Interface
+P: Ben Nizette
+M: [email protected]
+S: Maintained
+
SOFTMAC LAYER (IEEE 802.11)
P: Daniel Drake
M: [email protected]
--- a/drivers/uio/Kconfig
+++ b/drivers/uio/Kconfig
@@ -26,4 +26,17 @@ config UIO_CIF
To compile this driver as a module, choose M here: the module
will be called uio_cif.

+config UIO_SMX
+ tristate "SMX cryptengine UIO interface"
+ depends on UIO
+ default n
+ help
+ Userspace IO interface to the Cryptography engine found on the
+ Nias Digital SMX boards. These will be available from Q4 2008
+ from http://www.niasdigital.com. The userspace part of this
+ driver will be released under the GPL at the same time as the
+ hardware and will be able to be downloaded from the same site.
+
+ If you compile this as a module, it will be called uio_smx.
+
endif
--- a/drivers/uio/Makefile
+++ b/drivers/uio/Makefile
@@ -1,2 +1,3 @@
obj-$(CONFIG_UIO) += uio.o
obj-$(CONFIG_UIO_CIF) += uio_cif.o
+obj-$(CONFIG_UIO_SMX) += uio_smx.o
--- /dev/null
+++ b/drivers/uio/uio_smx.c
@@ -0,0 +1,140 @@
+/*
+ * UIO SMX Cryptengine driver.
+ *
+ * (C) 2008 Nias Digital P/L <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ */
+
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/uio_driver.h>
+#include <linux/io.h>
+
+#define DRV_NAME "smx-ce"
+#define DRV_VERSION "0.03"
+
+#define SMX_CSR 0x00000000
+#define SMX_EnD 0x00000001
+#define SMX_RUN 0x00000002
+#define SMX_DRDY 0x00000004
+#define SMX_ERR 0x00000008
+
+static irqreturn_t smx_handler(int irq, struct uio_info *dev_info)
+{
+ void __iomem *csr = dev_info->mem[0].internal_addr + SMX_CSR;
+
+ u32 status = ioread32(csr);
+
+ if (!(status & SMX_DRDY))
+ return IRQ_NONE;
+
+ /* Disable interrupt */
+ iowrite32(status & ~SMX_DRDY, csr);
+ return IRQ_HANDLED;
+}
+
+static int __devinit smx_ce_probe(struct platform_device *dev)
+{
+
+ int ret = -ENODEV;
+ struct uio_info *info;
+ struct resource *regs;
+
+ info = kzalloc(sizeof(struct uio_info), GFP_KERNEL);
+ if (!info)
+ return -ENOMEM;
+
+ regs = platform_get_resource(dev, IORESOURCE_MEM, 0);
+ if (!regs) {
+ dev_err(&dev->dev, "No memory resource specified\n");
+ goto out_free;
+ }
+
+ info->mem[0].addr = regs->start;
+ if (!info->mem[0].addr) {
+ dev_err(&dev->dev, "Invalid memory resource\n");
+ goto out_free;
+ }
+
+ info->mem[0].size = regs->end - regs->start + 1;
+ info->mem[0].internal_addr = ioremap(regs->start, info->mem[0].size);
+
+ if (!info->mem[0].internal_addr) {
+ dev_err(&dev->dev, "Can't remap memory address range\n");
+ goto out_free;
+ }
+
+ info->mem[0].memtype = UIO_MEM_PHYS;
+
+ info->name = "smx-ce";
+ info->version = "0.03";
+
+ info->irq = platform_get_irq(dev, 0);
+ if (info->irq < 0) {
+ ret = info->irq;
+ dev_err(&dev->dev, "No (or invalid) IRQ resource specified\n");
+ goto out_unmap;
+ }
+
+ info->irq_flags = IRQF_SHARED;
+ info->handler = smx_handler;
+
+ platform_set_drvdata(dev, info);
+
+ ret = uio_register_device(&dev->dev, info);
+
+ if (ret)
+ goto out_unmap;
+
+ return 0;
+
+out_unmap:
+ iounmap(info->mem[0].internal_addr);
+out_free:
+ kfree(info);
+
+ return ret;
+}
+
+static int __devexit smx_ce_remove(struct platform_device *dev)
+{
+ struct uio_info *info = platform_get_drvdata(dev);
+
+ uio_unregister_device(info);
+ platform_set_drvdata(dev, NULL);
+ iounmap(info->mem[0].internal_addr);
+
+ kfree(info);
+
+ return 0;
+}
+
+static struct platform_driver smx_ce_driver = {
+ .probe = smx_ce_probe,
+ .remove = __devexit_p(smx_ce_remove),
+ .driver = {
+ .name = DRV_NAME,
+ .owner = THIS_MODULE,
+ },
+};
+
+static int __init smx_ce_init_module(void)
+{
+ return platform_driver_register(&smx_ce_driver);
+}
+module_init(smx_ce_init_module);
+
+static void __exit smx_ce_exit_module(void)
+{
+ platform_driver_unregister(&smx_ce_driver);
+}
+module_exit(smx_ce_exit_module);
+
+MODULE_LICENSE("GPL v2");
+MODULE_VERSION(DRV_VERSION);
+MODULE_AUTHOR("Ben Nizette <[email protected]>");


Patches currently in gregkh-2.6 which might be from [email protected] are

driver-core/uio-implement-a-uio-interface-for-the-smx-cryptengine.patch