sys/dev/mfi/mfi_pci.c

   1 /*-
   2  * Copyright (c) 2006 IronPort Systems
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26 /*-
  27  * Copyright (c) 2007 LSI Corp.
  28  * Copyright (c) 2007 Rajesh Prabhakaran.
  29  * All rights reserved.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  */
  52
  53 #include <sys/cdefs.h>
  54 __FBSDID("$FreeBSD$");
  55
  56 /* PCI/PCI-X/PCIe bus interface for the LSI MegaSAS controllers */
  57
  58 #include "opt_mfi.h"
  59
  60 #include <sys/param.h>
  61 #include <sys/systm.h>
  62 #include <sys/kernel.h>
  63 #include <sys/selinfo.h>
  64 #include <sys/module.h>
  65 #include <sys/bus.h>
  66 #include <sys/conf.h>
  67 #include <sys/bio.h>
  68 #include <sys/malloc.h>
  69 #include <sys/sysctl.h>
  70 #include <sys/uio.h>
  71
  72 #include <machine/bus.h>
  73 #include <machine/resource.h>
  74 #include <sys/rman.h>
  75
  76 #include <dev/pci/pcireg.h>
  77 #include <dev/pci/pcivar.h>
  78
  79 #include <dev/mfi/mfireg.h>
  80 #include <dev/mfi/mfi_ioctl.h>
  81 #include <dev/mfi/mfivar.h>
  82
  83 static int      mfi_pci_probe(device_t);
  84 static int      mfi_pci_attach(device_t);
  85 static int      mfi_pci_detach(device_t);
  86 static int      mfi_pci_suspend(device_t);
  87 static int      mfi_pci_resume(device_t);
  88 static void     mfi_pci_free(struct mfi_softc *);
  89
  90 static device_method_t mfi_methods[] = {
  91         DEVMETHOD(device_probe,         mfi_pci_probe),
  92         DEVMETHOD(device_attach,        mfi_pci_attach),
  93         DEVMETHOD(device_detach,        mfi_pci_detach),
  94         DEVMETHOD(device_suspend,       mfi_pci_suspend),
  95         DEVMETHOD(device_resume,        mfi_pci_resume),
  96
  97         DEVMETHOD_END
  98 };
  99
 100 static driver_t mfi_pci_driver = {
 101         "mfi",
 102         mfi_methods,
 103         sizeof(struct mfi_softc)
 104 };
 105
 106 static devclass_t       mfi_devclass;
 107 DRIVER_MODULE(mfi, pci, mfi_pci_driver, mfi_devclass, 0, 0);
 108 MODULE_VERSION(mfi, 1);
 109
 110 static int      mfi_msi = 1;
 111 TUNABLE_INT("hw.mfi.msi", &mfi_msi);
 112 SYSCTL_INT(_hw_mfi, OID_AUTO, msi, CTLFLAG_RDTUN, &mfi_msi, 0,
 113     "Enable use of MSI interrupts");
 114
 115 struct mfi_ident {
 116         uint16_t        vendor;
 117         uint16_t        device;
 118         uint16_t        subvendor;
 119         uint16_t        subdevice;
 120         int             flags;
 121         const char      *desc;
 122 } mfi_identifiers[] = {
 123         {0x1000, 0x005b, 0x1028, 0x1f2d, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H810 Adapter"},
 124         {0x1000, 0x005b, 0x1028, 0x1f30, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Embedded"},
 125         {0x1000, 0x005b, 0x1028, 0x1f31, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Adapter"},
 126         {0x1000, 0x005b, 0x1028, 0x1f33, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (blades)"},
 127         {0x1000, 0x005b, 0x1028, 0x1f34, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710P Mini (monolithics)"},
 128         {0x1000, 0x005b, 0x1028, 0x1f35, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Adapter"},
 129         {0x1000, 0x005b, 0x1028, 0x1f37, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (blades)"},
 130         {0x1000, 0x005b, 0x1028, 0x1f38, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Dell PERC H710 Mini (monolithics)"},
 131         {0x1000, 0x005b, 0x8086, 0x9265, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25DB080"},
 132         {0x1000, 0x005b, 0x8086, 0x9285, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "Intel (R) RAID Controller RS25NB008"},
 133         {0x1000, 0x005b, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT, "ThunderBolt"},
 134         {0x1000, 0x005d, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT| MFI_FLAGS_INVADER, "Invader"},
 135         {0x1000, 0x005f, 0xffff, 0xffff, MFI_FLAGS_SKINNY| MFI_FLAGS_TBOLT| MFI_FLAGS_FURY, "Fury"},
 136         {0x1000, 0x0060, 0x1028, 0xffff, MFI_FLAGS_1078,  "Dell PERC 6"},
 137         {0x1000, 0x0060, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
 138         {0x1000, 0x0071, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
 139         {0x1000, 0x0073, 0xffff, 0xffff, MFI_FLAGS_SKINNY, "Drake Skinny"},
 140         {0x1000, 0x0078, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
 141         {0x1000, 0x0079, 0x1028, 0x1f15, MFI_FLAGS_GEN2,  "Dell PERC H800 Adapter"},
 142         {0x1000, 0x0079, 0x1028, 0x1f16, MFI_FLAGS_GEN2,  "Dell PERC H700 Adapter"},
 143         {0x1000, 0x0079, 0x1028, 0x1f17, MFI_FLAGS_GEN2,  "Dell PERC H700 Integrated"},
 144         {0x1000, 0x0079, 0x1028, 0x1f18, MFI_FLAGS_GEN2,  "Dell PERC H700 Modular"},
 145         {0x1000, 0x0079, 0x1028, 0x1f19, MFI_FLAGS_GEN2,  "Dell PERC H700"},
 146         {0x1000, 0x0079, 0x1028, 0x1f1a, MFI_FLAGS_GEN2,  "Dell PERC H800 Proto Adapter"},
 147         {0x1000, 0x0079, 0x1028, 0x1f1b, MFI_FLAGS_GEN2,  "Dell PERC H800"},
 148         {0x1000, 0x0079, 0x1028, 0xffff, MFI_FLAGS_GEN2,  "Dell PERC Gen2"},
 149         {0x1000, 0x0079, 0xffff, 0xffff, MFI_FLAGS_GEN2,  "LSI MegaSAS Gen2"},
 150         {0x1000, 0x007c, 0xffff, 0xffff, MFI_FLAGS_1078,  "LSI MegaSAS 1078"},
 151         {0x1000, 0x0411, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Brocton IOP */
 152         {0x1000, 0x0413, 0xffff, 0xffff, MFI_FLAGS_1064R, "LSI MegaSAS 1064R"}, /* Verde ZCR */
 153         {0x1028, 0x0015, 0xffff, 0xffff, MFI_FLAGS_1064R, "Dell PERC 5/i"},
 154         {0, 0, 0, 0, 0, NULL}
 155 };
 156
 157 static struct mfi_ident *
 158 mfi_find_ident(device_t dev)
 159 {
 160         struct mfi_ident *m;
 161
 162         for (m = mfi_identifiers; m->vendor != 0; m++) {
 163                 if ((m->vendor == pci_get_vendor(dev)) &&
 164                     (m->device == pci_get_device(dev)) &&
 165                     ((m->subvendor == pci_get_subvendor(dev)) ||
 166                     (m->subvendor == 0xffff)) &&
 167                     ((m->subdevice == pci_get_subdevice(dev)) ||
 168                     (m->subdevice == 0xffff)))
 169                         return (m);
 170         }
 171
 172         return (NULL);
 173 }
 174
 175 static int
 176 mfi_pci_probe(device_t dev)
 177 {
 178         struct mfi_ident *id;
 179
 180         if ((id = mfi_find_ident(dev)) != NULL) {
 181                 device_set_desc(dev, id->desc);
 182                 return (BUS_PROBE_DEFAULT);
 183         }
 184         return (ENXIO);
 185 }
 186
 187 static int
 188 mfi_pci_attach(device_t dev)
 189 {
 190         struct mfi_softc *sc;
 191         struct mfi_ident *m;
 192         int count, error;
 193
 194         sc = device_get_softc(dev);
 195         bzero(sc, sizeof(*sc));
 196         sc->mfi_dev = dev;
 197         m = mfi_find_ident(dev);
 198         sc->mfi_flags = m->flags;
 199
 200         /* Ensure busmastering is enabled */
 201         pci_enable_busmaster(dev);
 202
 203         /* Allocate PCI registers */
 204         if ((sc->mfi_flags & MFI_FLAGS_1064R) ||
 205             (sc->mfi_flags & MFI_FLAGS_1078)) {
 206                 /* 1068/1078: Memory mapped BAR is at offset 0x10 */
 207                 sc->mfi_regs_rid = PCIR_BAR(0);
 208         }
 209         else if ((sc->mfi_flags & MFI_FLAGS_GEN2) ||
 210                  (sc->mfi_flags & MFI_FLAGS_SKINNY) ||
 211                 (sc->mfi_flags & MFI_FLAGS_TBOLT)) {
 212                 /* Gen2/Skinny: Memory mapped BAR is at offset 0x14 */
 213                 sc->mfi_regs_rid = PCIR_BAR(1);
 214         }
 215         if ((sc->mfi_regs_resource = bus_alloc_resource_any(sc->mfi_dev,
 216             SYS_RES_MEMORY, &sc->mfi_regs_rid, RF_ACTIVE)) == NULL) {
 217                 device_printf(dev, "Cannot allocate PCI registers\n");
 218                 return (ENXIO);
 219         }
 220         sc->mfi_btag = rman_get_bustag(sc->mfi_regs_resource);
 221         sc->mfi_bhandle = rman_get_bushandle(sc->mfi_regs_resource);
 222
 223         error = ENOMEM;
 224
 225         /* Allocate parent DMA tag */
 226         if (bus_dma_tag_create( bus_get_dma_tag(dev),   /* PCI parent */
 227                                 1, 0,                   /* algnmnt, boundary */
 228                                 BUS_SPACE_MAXADDR,      /* lowaddr */
 229                                 BUS_SPACE_MAXADDR,      /* highaddr */
 230                                 NULL, NULL,             /* filter, filterarg */
 231                                 BUS_SPACE_MAXSIZE_32BIT,/* maxsize */
 232                                 BUS_SPACE_UNRESTRICTED, /* nsegments */
 233                                 BUS_SPACE_MAXSIZE_32BIT,/* maxsegsize */
 234                                 0,                      /* flags */
 235                                 NULL, NULL,             /* lockfunc, lockarg */
 236                                 &sc->mfi_parent_dmat)) {
 237                 device_printf(dev, "Cannot allocate parent DMA tag\n");
 238                 goto out;
 239         }
 240
 241         /* Allocate IRQ resource. */
 242         sc->mfi_irq_rid = 0;
 243         count = 1;
 244         if (mfi_msi && pci_alloc_msi(sc->mfi_dev, &count) == 0) {
 245                 device_printf(sc->mfi_dev, "Using MSI\n");
 246                 sc->mfi_irq_rid = 1;
 247         }
 248         if ((sc->mfi_irq = bus_alloc_resource_any(sc->mfi_dev, SYS_RES_IRQ,
 249             &sc->mfi_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
 250                 device_printf(sc->mfi_dev, "Cannot allocate interrupt\n");
 251                 error = EINVAL;
 252                 goto out;
 253         }
 254
 255         error = mfi_attach(sc);
 256 out:
 257         if (error) {
 258                 mfi_free(sc);
 259                 mfi_pci_free(sc);
 260         }
 261
 262         return (error);
 263 }
 264
 265 static int
 266 mfi_pci_detach(device_t dev)
 267 {
 268         struct mfi_softc *sc;
 269         int error, devcount, i;
 270         device_t *devlist;
 271
 272         sc = device_get_softc(dev);
 273
 274         sx_xlock(&sc->mfi_config_lock);
 275         mtx_lock(&sc->mfi_io_lock);
 276         if ((sc->mfi_flags & MFI_FLAGS_OPEN) != 0) {
 277                 mtx_unlock(&sc->mfi_io_lock);
 278                 sx_xunlock(&sc->mfi_config_lock);
 279                 return (EBUSY);
 280         }
 281         sc->mfi_detaching = 1;
 282         mtx_unlock(&sc->mfi_io_lock);
 283
 284         if ((error = device_get_children(sc->mfi_dev, &devlist, &devcount)) != 0) {
 285                 sx_xunlock(&sc->mfi_config_lock);
 286                 return error;
 287         }
 288         for (i = 0; i < devcount; i++)
 289                 device_delete_child(sc->mfi_dev, devlist[i]);
 290         free(devlist, M_TEMP);
 291         sx_xunlock(&sc->mfi_config_lock);
 292
 293         EVENTHANDLER_DEREGISTER(shutdown_final, sc->mfi_eh);
 294
 295         mfi_shutdown(sc);
 296         mfi_free(sc);
 297         mfi_pci_free(sc);
 298         return (0);
 299 }
 300
 301 static void
 302 mfi_pci_free(struct mfi_softc *sc)
 303 {
 304
 305         if (sc->mfi_regs_resource != NULL) {
 306                 bus_release_resource(sc->mfi_dev, SYS_RES_MEMORY,
 307                     sc->mfi_regs_rid, sc->mfi_regs_resource);
 308         }
 309         if (sc->mfi_irq_rid != 0)
 310                 pci_release_msi(sc->mfi_dev);
 311
 312         return;
 313 }
 314
 315 static int
 316 mfi_pci_suspend(device_t dev)
 317 {
 318
 319         return (EINVAL);
 320 }
 321
 322 static int
 323 mfi_pci_resume(device_t dev)
 324 {
 325
 326         return (EINVAL);
 327 }