2 * Driver for Hifn HIPP-I/II chipset
3 * Copyright (c) 2006 Michael Richardson <mcr@xelerance.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 * Effort sponsored by Hifn Inc.
33 * Driver for various Hifn encryption processors.
35 #ifndef AUTOCONF_INCLUDED
36 #include <linux/config.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/list.h>
41 #include <linux/slab.h>
42 #include <linux/wait.h>
43 #include <linux/sched.h>
44 #include <linux/pci.h>
45 #include <linux/delay.h>
46 #include <linux/interrupt.h>
47 #include <linux/spinlock.h>
48 #include <linux/random.h>
49 #include <linux/version.h>
50 #include <linux/skbuff.h>
51 #include <linux/uio.h>
52 #include <linux/sysfs.h>
53 #include <linux/miscdevice.h>
56 #include <cryptodev.h>
58 #include "hifnHIPPreg.h"
59 #include "hifnHIPPvar.h"
62 #define DPRINTF(a...) if (hipp_debug) { \
64 device_get_nameunit(sc->sc_dev) : "hifn"); \
71 typedef int bus_size_t;
74 pci_get_revid(struct pci_dev *dev)
77 pci_read_config_byte(dev, PCI_REVISION_ID, &rid);
81 #define debug hipp_debug
83 module_param(hipp_debug, int, 0644);
84 MODULE_PARM_DESC(hipp_debug, "Enable debug");
86 int hipp_maxbatch = 1;
87 module_param(hipp_maxbatch, int, 0644);
88 MODULE_PARM_DESC(hipp_maxbatch, "max ops to batch w/o interrupt");
90 static int hipp_probe(struct pci_dev *dev, const struct pci_device_id *ent);
91 static void hipp_remove(struct pci_dev *dev);
92 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,19)
93 static irqreturn_t hipp_intr(int irq, void *arg);
95 static irqreturn_t hipp_intr(int irq, void *arg, struct pt_regs *regs);
98 static int hipp_num_chips = 0;
99 static struct hipp_softc *hipp_chip_idx[HIPP_MAX_CHIPS];
101 static int hipp_newsession(device_t, u_int32_t *, struct cryptoini *);
102 static int hipp_freesession(device_t, u_int64_t);
103 static int hipp_process(device_t, struct cryptop *, int);
105 static device_method_t hipp_methods = {
106 /* crypto device methods */
107 DEVMETHOD(cryptodev_newsession, hipp_newsession),
108 DEVMETHOD(cryptodev_freesession,hipp_freesession),
109 DEVMETHOD(cryptodev_process, hipp_process),
112 static __inline u_int32_t
113 READ_REG(struct hipp_softc *sc, unsigned int barno, bus_size_t reg)
115 u_int32_t v = readl(sc->sc_bar[barno] + reg);
116 //sc->sc_bar0_lastreg = (bus_size_t) -1;
120 WRITE_REG(struct hipp_softc *sc, unsigned int barno, bus_size_t reg, u_int32_t val)
122 writel(val, sc->sc_bar[barno] + reg);
125 #define READ_REG_0(sc, reg) READ_REG(sc, 0, reg)
126 #define WRITE_REG_0(sc, reg, val) WRITE_REG(sc,0, reg, val)
127 #define READ_REG_1(sc, reg) READ_REG(sc, 1, reg)
128 #define WRITE_REG_1(sc, reg, val) WRITE_REG(sc,1, reg, val)
131 hipp_newsession(device_t dev, u_int32_t *sidp, struct cryptoini *cri)
137 hipp_freesession(device_t dev, u_int64_t tid)
143 hipp_process(device_t dev, struct cryptop *crp, int hint)
149 hipp_partname(struct hipp_softc *sc, char buf[128], size_t blen)
153 switch (pci_get_vendor(sc->sc_pcidev)) {
154 case PCI_VENDOR_HIFN:
155 switch (pci_get_device(sc->sc_pcidev)) {
156 case PCI_PRODUCT_HIFN_7855: n = "Hifn 7855";
157 case PCI_PRODUCT_HIFN_8155: n = "Hifn 8155";
158 case PCI_PRODUCT_HIFN_6500: n = "Hifn 6500";
163 snprintf(buf, blen, "VID=%02x,PID=%02x",
164 pci_get_vendor(sc->sc_pcidev),
165 pci_get_device(sc->sc_pcidev));
168 strncat(buf, n, blen);
173 struct hipp_fs_entry {
174 struct attribute attr;
180 cryptoid_show(struct device *dev,
181 struct device_attribute *attr,
184 struct hipp_softc *sc;
186 sc = pci_get_drvdata(to_pci_dev (dev));
187 return sprintf (buf, "%d\n", sc->sc_cid);
190 struct device_attribute hipp_dev_cryptoid = __ATTR_RO(cryptoid);
193 * Attach an interface that successfully probed.
196 hipp_probe(struct pci_dev *dev, const struct pci_device_id *ent)
198 struct hipp_softc *sc = NULL;
206 DPRINTF("%s()\n", __FUNCTION__);
208 if (pci_enable_device(dev) < 0)
211 #ifdef CONFIG_HAVE_PCI_SET_MWI
212 if (pci_set_mwi(dev))
217 printk("hifn: found device with no IRQ assigned. check BIOS settings!");
218 pci_disable_device(dev);
222 sc = (struct hipp_softc *) kmalloc(sizeof(*sc), GFP_KERNEL);
225 memset(sc, 0, sizeof(*sc));
227 softc_device_init(sc, "hifn-hipp", hipp_num_chips, hipp_methods);
232 sc->sc_num = hipp_num_chips++;
234 if (sc->sc_num < HIPP_MAX_CHIPS)
235 hipp_chip_idx[sc->sc_num] = sc;
237 pci_set_drvdata(sc->sc_pcidev, sc);
239 spin_lock_init(&sc->sc_mtx);
242 * Setup PCI resources.
243 * The READ_REG_0, WRITE_REG_0, READ_REG_1,
244 * and WRITE_REG_1 macros throughout the driver are used
245 * to permit better debugging.
248 unsigned long mem_start, mem_len;
249 mem_start = pci_resource_start(sc->sc_pcidev, i);
250 mem_len = pci_resource_len(sc->sc_pcidev, i);
251 sc->sc_barphy[i] = (caddr_t)mem_start;
252 sc->sc_bar[i] = (ocf_iomem_t) ioremap(mem_start, mem_len);
253 if (!sc->sc_bar[i]) {
254 device_printf(sc->sc_dev, "cannot map bar%d register space\n", i);
259 //hipp_reset_board(sc, 0);
260 pci_set_master(sc->sc_pcidev);
263 * Arrange the interrupt line.
265 rc = request_irq(dev->irq, hipp_intr, IRQF_SHARED, "hifn", sc);
267 device_printf(sc->sc_dev, "could not map interrupt: %d\n", rc);
270 sc->sc_irq = dev->irq;
272 rev = READ_REG_1(sc, HIPP_1_REVID) & 0xffff;
276 device_printf(sc->sc_dev, "%s, rev %u",
277 hipp_partname(sc, b, sizeof(b)), rev);
281 if (sc->sc_flags & HIFN_IS_7956)
282 printf(", pll=0x%x<%s clk, %ux mult>",
284 sc->sc_pllconfig & HIFN_PLL_REF_SEL ? "ext" : "pci",
285 2 + 2*((sc->sc_pllconfig & HIFN_PLL_ND) >> 11));
289 sc->sc_cid = crypto_get_driverid(softc_get_device(sc),CRYPTOCAP_F_HARDWARE);
290 if (sc->sc_cid < 0) {
291 device_printf(sc->sc_dev, "could not get crypto driver id\n");
295 #if 0 /* cannot work with a non-GPL module */
296 /* make a sysfs entry to let the world know what entry we got */
297 sysfs_create_file(&sc->sc_pcidev->dev.kobj, &hipp_dev_cryptoid.attr);
301 init_timer(&sc->sc_tickto);
302 sc->sc_tickto.function = hifn_tick;
303 sc->sc_tickto.data = (unsigned long) sc->sc_num;
304 mod_timer(&sc->sc_tickto, jiffies + HZ);
307 #if 0 /* no code here yet ?? */
308 crypto_register(sc->sc_cid, CRYPTO_3DES_CBC, 0, 0);
315 crypto_unregister_all(sc->sc_cid);
316 if (sc->sc_irq != -1)
317 free_irq(sc->sc_irq, sc);
321 /* Turn off DMA polling */
322 WRITE_REG_1(sc, HIFN_1_DMA_CNFG, HIFN_DMACNFG_MSTRESET |
323 HIFN_DMACNFG_DMARESET | HIFN_DMACNFG_MODE);
325 pci_free_consistent(sc->sc_pcidev,
327 sc->sc_dma, sc->sc_dma_physaddr);
335 * Detach an interface that successfully probed.
338 hipp_remove(struct pci_dev *dev)
340 struct hipp_softc *sc = pci_get_drvdata(dev);
341 unsigned long l_flags;
343 DPRINTF("%s()\n", __FUNCTION__);
345 /* disable interrupts */
349 WRITE_REG_1(sc, HIFN_1_DMA_IER, 0);
352 /*XXX other resources */
353 del_timer_sync(&sc->sc_tickto);
355 /* Turn off DMA polling */
356 WRITE_REG_1(sc, HIFN_1_DMA_CNFG, HIFN_DMACNFG_MSTRESET |
357 HIFN_DMACNFG_DMARESET | HIFN_DMACNFG_MODE);
360 crypto_unregister_all(sc->sc_cid);
362 free_irq(sc->sc_irq, sc);
365 pci_free_consistent(sc->sc_pcidev, sizeof(*sc->sc_dma),
366 sc->sc_dma, sc->sc_dma_physaddr);
370 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,19)
371 static irqreturn_t hipp_intr(int irq, void *arg)
373 static irqreturn_t hipp_intr(int irq, void *arg, struct pt_regs *regs)
376 struct hipp_softc *sc = arg;
378 sc = sc; /* shut up compiler */
383 static struct pci_device_id hipp_pci_tbl[] = {
384 { PCI_VENDOR_HIFN, PCI_PRODUCT_HIFN_7855,
385 PCI_ANY_ID, PCI_ANY_ID, 0, 0, },
386 { PCI_VENDOR_HIFN, PCI_PRODUCT_HIFN_8155,
387 PCI_ANY_ID, PCI_ANY_ID, 0, 0, },
390 MODULE_DEVICE_TABLE(pci, hipp_pci_tbl);
392 static struct pci_driver hipp_driver = {
394 .id_table = hipp_pci_tbl,
396 .remove = hipp_remove,
397 /* add PM stuff here one day */
400 static int __init hipp_init (void)
402 struct hipp_softc *sc = NULL;
405 DPRINTF("%s(%p)\n", __FUNCTION__, hipp_init);
407 rc = pci_register_driver(&hipp_driver);
408 pci_register_driver_compat(&hipp_driver, rc);
413 static void __exit hipp_exit (void)
415 pci_unregister_driver(&hipp_driver);
418 module_init(hipp_init);
419 module_exit(hipp_exit);
421 MODULE_LICENSE("BSD");
422 MODULE_AUTHOR("Michael Richardson <mcr@xelerance.com>");
423 MODULE_DESCRIPTION("OCF driver for hifn HIPP-I/II PCI crypto devices");