sys/dev/aacraid/aacraid_pci.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2000 Michael Smith
   5  * Copyright (c) 2001 Scott Long
   6  * Copyright (c) 2000 BSDi
   7  * Copyright (c) 2001-2010 Adaptec, Inc.
   8  * Copyright (c) 2010-2012 PMC-Sierra, Inc.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 #include <sys/cdefs.h>
  34 __FBSDID("$FreeBSD$");
  35
  36 /*
  37  * PCI bus interface and resource allocation.
  38  */
  39
  40 #include "opt_aacraid.h"
  41
  42 #include <sys/param.h>
  43 #include <sys/systm.h>
  44 #include <sys/kernel.h>
  45 #include <sys/module.h>
  46
  47 #include <sys/bio.h>
  48 #include <sys/bus.h>
  49 #include <sys/conf.h>
  50 #include <sys/disk.h>
  51
  52 #include <machine/bus.h>
  53 #include <machine/resource.h>
  54 #include <sys/rman.h>
  55
  56 #include <dev/pci/pcireg.h>
  57 #include <dev/pci/pcivar.h>
  58
  59 #include <dev/aacraid/aacraid_reg.h>
  60 #include <sys/aac_ioctl.h>
  61 #include <dev/aacraid/aacraid_debug.h>
  62 #include <dev/aacraid/aacraid_var.h>
  63
  64 static int      aacraid_pci_probe(device_t dev);
  65 static int      aacraid_pci_attach(device_t dev);
  66
  67 static device_method_t aacraid_methods[] = {
  68         /* Device interface */
  69         DEVMETHOD(device_probe,         aacraid_pci_probe),
  70         DEVMETHOD(device_attach,        aacraid_pci_attach),
  71         DEVMETHOD(device_detach,        aacraid_detach),
  72         DEVMETHOD(device_suspend,       aacraid_suspend),
  73         DEVMETHOD(device_resume,        aacraid_resume),
  74
  75         DEVMETHOD(bus_print_child,      bus_generic_print_child),
  76         DEVMETHOD(bus_driver_added,     bus_generic_driver_added),
  77         { 0, 0 }
  78 };
  79
  80 static driver_t aacraid_pci_driver = {
  81         "aacraid",
  82         aacraid_methods,
  83         sizeof(struct aac_softc)
  84 };
  85
  86 static devclass_t       aacraid_devclass;
  87
  88 DRIVER_MODULE(aacraid, pci, aacraid_pci_driver, aacraid_devclass, 0, 0);
  89 MODULE_DEPEND(aacraid, pci, 1, 1, 1);
  90
  91 struct aac_ident
  92 {
  93         u_int16_t               vendor;
  94         u_int16_t               device;
  95         u_int16_t               subvendor;
  96         u_int16_t               subdevice;
  97         int                     hwif;
  98         int                     quirks;
  99         char                    *desc;
 100 } aacraid_family_identifiers[] = {
 101         {0x9005, 0x028b, 0, 0, AAC_HWIF_SRC, 0,
 102          "Adaptec RAID Controller"},
 103         {0x9005, 0x028c, 0, 0, AAC_HWIF_SRCV, 0,
 104          "Adaptec RAID Controller"},
 105         {0x9005, 0x028d, 0, 0, AAC_HWIF_SRCV, 0,
 106          "Adaptec RAID Controller"},
 107         {0, 0, 0, 0, 0, 0, 0}
 108 };
 109
 110 static struct aac_ident *
 111 aac_find_ident(device_t dev)
 112 {
 113         struct aac_ident *m;
 114         u_int16_t vendid, devid;
 115
 116         vendid = pci_get_vendor(dev);
 117         devid = pci_get_device(dev);
 118
 119         for (m = aacraid_family_identifiers; m->vendor != 0; m++) {
 120                 if ((m->vendor == vendid) && (m->device == devid))
 121                         return (m);
 122         }
 123
 124         return (NULL);
 125 }
 126
 127 /*
 128  * Determine whether this is one of our supported adapters.
 129  */
 130 static int
 131 aacraid_pci_probe(device_t dev)
 132 {
 133         struct aac_ident *id;
 134
 135         fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
 136
 137         if ((id = aac_find_ident(dev)) != NULL) {
 138                 device_set_desc(dev, id->desc);
 139                 return(BUS_PROBE_DEFAULT);
 140         }
 141         return(ENXIO);
 142 }
 143
 144 /*
 145  * Allocate resources for our device, set up the bus interface.
 146  */
 147 static int
 148 aacraid_pci_attach(device_t dev)
 149 {
 150         struct aac_softc *sc;
 151         struct aac_ident *id;
 152         int error;
 153         u_int32_t command;
 154
 155         fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
 156
 157         /*
 158          * Initialise softc.
 159          */
 160         sc = device_get_softc(dev);
 161         bzero(sc, sizeof(*sc));
 162         sc->aac_dev = dev;
 163
 164         /* assume failure is 'not configured' */
 165         error = ENXIO;
 166
 167         /*
 168          * Verify that the adapter is correctly set up in PCI space.
 169          */
 170         pci_enable_busmaster(dev);
 171         command = pci_read_config(sc->aac_dev, PCIR_COMMAND, 2);
 172         if (!(command & PCIM_CMD_BUSMASTEREN)) {
 173                 device_printf(sc->aac_dev, "can't enable bus-master feature\n");
 174                 goto out;
 175         }
 176
 177         /*
 178          * Detect the hardware interface version, set up the bus interface
 179          * indirection.
 180          */
 181         id = aac_find_ident(dev);
 182         sc->aac_hwif = id->hwif;
 183         switch(sc->aac_hwif) {
 184         case AAC_HWIF_SRC:
 185                 fwprintf(sc, HBA_FLAGS_DBG_INIT_B, "set hardware up for PMC SRC");
 186                 sc->aac_if = aacraid_src_interface;
 187                 break;
 188         case AAC_HWIF_SRCV:
 189                 fwprintf(sc, HBA_FLAGS_DBG_INIT_B, "set hardware up for PMC SRCv");
 190                 sc->aac_if = aacraid_srcv_interface;
 191                 break;
 192         default:
 193                 sc->aac_hwif = AAC_HWIF_UNKNOWN;
 194                 device_printf(sc->aac_dev, "unknown hardware type\n");
 195                 error = ENXIO;
 196                 goto out;
 197         }
 198
 199         /* assume failure is 'out of memory' */
 200         error = ENOMEM;
 201
 202         /*
 203          * Allocate the PCI register window.
 204          */
 205         sc->aac_regs_rid0 = PCIR_BAR(0);
 206         if ((sc->aac_regs_res0 = bus_alloc_resource_any(sc->aac_dev,
 207             SYS_RES_MEMORY, &sc->aac_regs_rid0, RF_ACTIVE)) == NULL) {
 208                 device_printf(sc->aac_dev,
 209                     "couldn't allocate register window 0\n");
 210                 goto out;
 211         }
 212         sc->aac_btag0 = rman_get_bustag(sc->aac_regs_res0);
 213         sc->aac_bhandle0 = rman_get_bushandle(sc->aac_regs_res0);
 214
 215         sc->aac_regs_rid1 = PCIR_BAR(2);
 216         if ((sc->aac_regs_res1 = bus_alloc_resource_any(sc->aac_dev,
 217             SYS_RES_MEMORY, &sc->aac_regs_rid1, RF_ACTIVE)) == NULL) {
 218                 device_printf(sc->aac_dev,
 219                     "couldn't allocate register window 1\n");
 220                 goto out;
 221         }
 222         sc->aac_btag1 = rman_get_bustag(sc->aac_regs_res1);
 223         sc->aac_bhandle1 = rman_get_bushandle(sc->aac_regs_res1);
 224
 225         /*
 226          * Allocate the parent bus DMA tag appropriate for our PCI interface.
 227          *
 228          * Note that some of these controllers are 64-bit capable.
 229          */
 230         if (bus_dma_tag_create(bus_get_dma_tag(dev),    /* parent */
 231                                PAGE_SIZE, 0,            /* algnmnt, boundary */
 232                                BUS_SPACE_MAXADDR,       /* lowaddr */
 233                                BUS_SPACE_MAXADDR,       /* highaddr */
 234                                NULL, NULL,              /* filter, filterarg */
 235                                BUS_SPACE_MAXSIZE_32BIT, /* maxsize */
 236                                BUS_SPACE_UNRESTRICTED,  /* nsegments */
 237                                BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */
 238                                0,                       /* flags */
 239                                NULL, NULL,              /* No locking needed */
 240                                &sc->aac_parent_dmat)) {
 241                 device_printf(sc->aac_dev, "can't allocate parent DMA tag\n");
 242                 goto out;
 243         }
 244
 245         /* Set up quirks */
 246         sc->flags = id->quirks;
 247
 248         /*
 249          * Do bus-independent initialisation.
 250          */
 251         error = aacraid_attach(sc);
 252
 253 out:
 254         if (error)
 255                 aacraid_free(sc);
 256         return(error);
 257 }