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