xref: /openbmc/linux/drivers/scsi/aic7xxx/aic7xxx_osm_pci.c (revision 1da177e4c3f41524e886b7f1b8a0c1fc7321cac2)
1 /*
2  * Linux driver attachment glue for PCI based controllers.
3  *
4  * Copyright (c) 2000-2001 Adaptec Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14  *    substantially similar to the "NO WARRANTY" disclaimer below
15  *    ("Disclaimer") and any redistribution must be conditioned upon
16  *    including a substantially similar Disclaimer requirement for further
17  *    binary redistribution.
18  * 3. Neither the names of the above-listed copyright holders nor the names
19  *    of any contributors may be used to endorse or promote products derived
20  *    from this software without specific prior written permission.
21  *
22  * Alternatively, this software may be distributed under the terms of the
23  * GNU General Public License ("GPL") version 2 as published by the Free
24  * Software Foundation.
25  *
26  * NO WARRANTY
27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
36  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGES.
38  *
39  * $Id: //depot/aic7xxx/linux/drivers/scsi/aic7xxx/aic7xxx_osm_pci.c#47 $
40  */
41 
42 #include "aic7xxx_osm.h"
43 #include "aic7xxx_pci.h"
44 
45 static int	ahc_linux_pci_dev_probe(struct pci_dev *pdev,
46 					const struct pci_device_id *ent);
47 static int	ahc_linux_pci_reserve_io_region(struct ahc_softc *ahc,
48 						u_long *base);
49 static int	ahc_linux_pci_reserve_mem_region(struct ahc_softc *ahc,
50 						 u_long *bus_addr,
51 						 uint8_t __iomem **maddr);
52 static void	ahc_linux_pci_dev_remove(struct pci_dev *pdev);
53 
54 /* Define the macro locally since it's different for different class of chips.
55 */
56 #define ID(x)	ID_C(x, PCI_CLASS_STORAGE_SCSI)
57 
58 static struct pci_device_id ahc_linux_pci_id_table[] = {
59 	/* aic7850 based controllers */
60 	ID(ID_AHA_2902_04_10_15_20C_30C),
61 	/* aic7860 based controllers */
62 	ID(ID_AHA_2930CU),
63 	ID(ID_AHA_1480A & ID_DEV_VENDOR_MASK),
64 	ID(ID_AHA_2940AU_0 & ID_DEV_VENDOR_MASK),
65 	ID(ID_AHA_2940AU_CN & ID_DEV_VENDOR_MASK),
66 	ID(ID_AHA_2930C_VAR & ID_DEV_VENDOR_MASK),
67 	/* aic7870 based controllers */
68 	ID(ID_AHA_2940),
69 	ID(ID_AHA_3940),
70 	ID(ID_AHA_398X),
71 	ID(ID_AHA_2944),
72 	ID(ID_AHA_3944),
73 	ID(ID_AHA_4944),
74 	/* aic7880 based controllers */
75 	ID(ID_AHA_2940U & ID_DEV_VENDOR_MASK),
76 	ID(ID_AHA_3940U & ID_DEV_VENDOR_MASK),
77 	ID(ID_AHA_2944U & ID_DEV_VENDOR_MASK),
78 	ID(ID_AHA_3944U & ID_DEV_VENDOR_MASK),
79 	ID(ID_AHA_398XU & ID_DEV_VENDOR_MASK),
80 	ID(ID_AHA_4944U & ID_DEV_VENDOR_MASK),
81 	ID(ID_AHA_2930U & ID_DEV_VENDOR_MASK),
82 	ID(ID_AHA_2940U_PRO & ID_DEV_VENDOR_MASK),
83 	ID(ID_AHA_2940U_CN & ID_DEV_VENDOR_MASK),
84 	/* aic7890 based controllers */
85 	ID(ID_AHA_2930U2),
86 	ID(ID_AHA_2940U2B),
87 	ID(ID_AHA_2940U2_OEM),
88 	ID(ID_AHA_2940U2),
89 	ID(ID_AHA_2950U2B),
90 	ID16(ID_AIC7890_ARO & ID_AIC7895_ARO_MASK),
91 	ID(ID_AAA_131U2),
92 	/* aic7890 based controllers */
93 	ID(ID_AHA_29160),
94 	ID(ID_AHA_29160_CPQ),
95 	ID(ID_AHA_29160N),
96 	ID(ID_AHA_29160C),
97 	ID(ID_AHA_29160B),
98 	ID(ID_AHA_19160B),
99 	ID(ID_AIC7892_ARO),
100 	/* aic7892 based controllers */
101 	ID(ID_AHA_2940U_DUAL),
102 	ID(ID_AHA_3940AU),
103 	ID(ID_AHA_3944AU),
104 	ID(ID_AIC7895_ARO),
105 	ID(ID_AHA_3950U2B_0),
106 	ID(ID_AHA_3950U2B_1),
107 	ID(ID_AHA_3950U2D_0),
108 	ID(ID_AHA_3950U2D_1),
109 	ID(ID_AIC7896_ARO),
110 	/* aic7899 based controllers */
111 	ID(ID_AHA_3960D),
112 	ID(ID_AHA_3960D_CPQ),
113 	ID(ID_AIC7899_ARO),
114 	/* Generic chip probes for devices we don't know exactly. */
115 	ID(ID_AIC7850 & ID_DEV_VENDOR_MASK),
116 	ID(ID_AIC7855 & ID_DEV_VENDOR_MASK),
117 	ID(ID_AIC7859 & ID_DEV_VENDOR_MASK),
118 	ID(ID_AIC7860 & ID_DEV_VENDOR_MASK),
119 	ID(ID_AIC7870 & ID_DEV_VENDOR_MASK),
120 	ID(ID_AIC7880 & ID_DEV_VENDOR_MASK),
121  	ID16(ID_AIC7890 & ID_9005_GENERIC_MASK),
122  	ID16(ID_AIC7892 & ID_9005_GENERIC_MASK),
123 	ID(ID_AIC7895 & ID_DEV_VENDOR_MASK),
124 	ID16(ID_AIC7896 & ID_9005_GENERIC_MASK),
125 	ID16(ID_AIC7899 & ID_9005_GENERIC_MASK),
126 	ID(ID_AIC7810 & ID_DEV_VENDOR_MASK),
127 	ID(ID_AIC7815 & ID_DEV_VENDOR_MASK),
128 	{ 0 }
129 };
130 
131 MODULE_DEVICE_TABLE(pci, ahc_linux_pci_id_table);
132 
133 struct pci_driver aic7xxx_pci_driver = {
134 	.name		= "aic7xxx",
135 	.probe		= ahc_linux_pci_dev_probe,
136 	.remove		= ahc_linux_pci_dev_remove,
137 	.id_table	= ahc_linux_pci_id_table
138 };
139 
140 static void
141 ahc_linux_pci_dev_remove(struct pci_dev *pdev)
142 {
143 	struct ahc_softc *ahc;
144 	u_long l;
145 
146 	/*
147 	 * We should be able to just perform
148 	 * the free directly, but check our
149 	 * list for extra sanity.
150 	 */
151 	ahc_list_lock(&l);
152 	ahc = ahc_find_softc((struct ahc_softc *)pci_get_drvdata(pdev));
153 	if (ahc != NULL) {
154 		u_long s;
155 
156 		TAILQ_REMOVE(&ahc_tailq, ahc, links);
157 		ahc_list_unlock(&l);
158 		ahc_lock(ahc, &s);
159 		ahc_intr_enable(ahc, FALSE);
160 		ahc_unlock(ahc, &s);
161 		ahc_free(ahc);
162 	} else
163 		ahc_list_unlock(&l);
164 }
165 
166 static int
167 ahc_linux_pci_dev_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
168 {
169 	char		 buf[80];
170 	const uint64_t	 mask_39bit = 0x7FFFFFFFFFULL;
171 	struct		 ahc_softc *ahc;
172 	ahc_dev_softc_t	 pci;
173 	struct		 ahc_pci_identity *entry;
174 	char		*name;
175 	int		 error;
176 
177 	/*
178 	 * Some BIOSen report the same device multiple times.
179 	 */
180 	TAILQ_FOREACH(ahc, &ahc_tailq, links) {
181 		struct pci_dev *probed_pdev;
182 
183 		probed_pdev = ahc->dev_softc;
184 		if (probed_pdev->bus->number == pdev->bus->number
185 		 && probed_pdev->devfn == pdev->devfn)
186 			break;
187 	}
188 	if (ahc != NULL) {
189 		/* Skip duplicate. */
190 		return (-ENODEV);
191 	}
192 
193 	pci = pdev;
194 	entry = ahc_find_pci_device(pci);
195 	if (entry == NULL)
196 		return (-ENODEV);
197 
198 	/*
199 	 * Allocate a softc for this card and
200 	 * set it up for attachment by our
201 	 * common detect routine.
202 	 */
203 	sprintf(buf, "ahc_pci:%d:%d:%d",
204 		ahc_get_pci_bus(pci),
205 		ahc_get_pci_slot(pci),
206 		ahc_get_pci_function(pci));
207 	name = malloc(strlen(buf) + 1, M_DEVBUF, M_NOWAIT);
208 	if (name == NULL)
209 		return (-ENOMEM);
210 	strcpy(name, buf);
211 	ahc = ahc_alloc(NULL, name);
212 	if (ahc == NULL)
213 		return (-ENOMEM);
214 	if (pci_enable_device(pdev)) {
215 		ahc_free(ahc);
216 		return (-ENODEV);
217 	}
218 	pci_set_master(pdev);
219 
220 	if (sizeof(dma_addr_t) > 4
221 	 && ahc_linux_get_memsize() > 0x80000000
222 	 && pci_set_dma_mask(pdev, mask_39bit) == 0) {
223 		ahc->flags |= AHC_39BIT_ADDRESSING;
224 		ahc->platform_data->hw_dma_mask = mask_39bit;
225 	} else {
226 		if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
227 			printk(KERN_WARNING "aic7xxx: No suitable DMA available.\n");
228                 	return (-ENODEV);
229 		}
230 		ahc->platform_data->hw_dma_mask = DMA_32BIT_MASK;
231 	}
232 	ahc->dev_softc = pci;
233 	error = ahc_pci_config(ahc, entry);
234 	if (error != 0) {
235 		ahc_free(ahc);
236 		return (-error);
237 	}
238 	pci_set_drvdata(pdev, ahc);
239 	if (aic7xxx_detect_complete) {
240 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,5,0)
241 		ahc_linux_register_host(ahc, &aic7xxx_driver_template);
242 #else
243 		printf("aic7xxx: ignoring PCI device found after "
244 		       "initialization\n");
245 		return (-ENODEV);
246 #endif
247 	}
248 	return (0);
249 }
250 
251 int
252 ahc_linux_pci_init(void)
253 {
254 	/* Translate error or zero return into zero or one */
255 	return pci_module_init(&aic7xxx_pci_driver) ? 0 : 1;
256 }
257 
258 void
259 ahc_linux_pci_exit(void)
260 {
261 	pci_unregister_driver(&aic7xxx_pci_driver);
262 }
263 
264 static int
265 ahc_linux_pci_reserve_io_region(struct ahc_softc *ahc, u_long *base)
266 {
267 	if (aic7xxx_allow_memio == 0)
268 		return (ENOMEM);
269 
270 	*base = pci_resource_start(ahc->dev_softc, 0);
271 	if (*base == 0)
272 		return (ENOMEM);
273 	if (request_region(*base, 256, "aic7xxx") == 0)
274 		return (ENOMEM);
275 	return (0);
276 }
277 
278 static int
279 ahc_linux_pci_reserve_mem_region(struct ahc_softc *ahc,
280 				 u_long *bus_addr,
281 				 uint8_t __iomem **maddr)
282 {
283 	u_long	start;
284 	int	error;
285 
286 	error = 0;
287 	start = pci_resource_start(ahc->dev_softc, 1);
288 	if (start != 0) {
289 		*bus_addr = start;
290 		if (request_mem_region(start, 0x1000, "aic7xxx") == 0)
291 			error = ENOMEM;
292 		if (error == 0) {
293 			*maddr = ioremap_nocache(start, 256);
294 			if (*maddr == NULL) {
295 				error = ENOMEM;
296 				release_mem_region(start, 0x1000);
297 			}
298 		}
299 	} else
300 		error = ENOMEM;
301 	return (error);
302 }
303 
304 int
305 ahc_pci_map_registers(struct ahc_softc *ahc)
306 {
307 	uint32_t command;
308 	u_long	 base;
309 	uint8_t	__iomem *maddr;
310 	int	 error;
311 
312 	/*
313 	 * If its allowed, we prefer memory mapped access.
314 	 */
315 	command = ahc_pci_read_config(ahc->dev_softc, PCIR_COMMAND, 4);
316 	command &= ~(PCIM_CMD_PORTEN|PCIM_CMD_MEMEN);
317 	base = 0;
318 	maddr = NULL;
319 	error = ahc_linux_pci_reserve_mem_region(ahc, &base, &maddr);
320 	if (error == 0) {
321 		ahc->platform_data->mem_busaddr = base;
322 		ahc->tag = BUS_SPACE_MEMIO;
323 		ahc->bsh.maddr = maddr;
324 		ahc_pci_write_config(ahc->dev_softc, PCIR_COMMAND,
325 				     command | PCIM_CMD_MEMEN, 4);
326 
327 		/*
328 		 * Do a quick test to see if memory mapped
329 		 * I/O is functioning correctly.
330 		 */
331 		if (ahc_pci_test_register_access(ahc) != 0) {
332 
333 			printf("aic7xxx: PCI Device %d:%d:%d "
334 			       "failed memory mapped test.  Using PIO.\n",
335 			       ahc_get_pci_bus(ahc->dev_softc),
336 			       ahc_get_pci_slot(ahc->dev_softc),
337 			       ahc_get_pci_function(ahc->dev_softc));
338 			iounmap(maddr);
339 			release_mem_region(ahc->platform_data->mem_busaddr,
340 					   0x1000);
341 			ahc->bsh.maddr = NULL;
342 			maddr = NULL;
343 		} else
344 			command |= PCIM_CMD_MEMEN;
345 	} else {
346 		printf("aic7xxx: PCI%d:%d:%d MEM region 0x%lx "
347 		       "unavailable. Cannot memory map device.\n",
348 		       ahc_get_pci_bus(ahc->dev_softc),
349 		       ahc_get_pci_slot(ahc->dev_softc),
350 		       ahc_get_pci_function(ahc->dev_softc),
351 		       base);
352 	}
353 
354 	/*
355 	 * We always prefer memory mapped access.
356 	 */
357 	if (maddr == NULL) {
358 
359 		error = ahc_linux_pci_reserve_io_region(ahc, &base);
360 		if (error == 0) {
361 			ahc->tag = BUS_SPACE_PIO;
362 			ahc->bsh.ioport = base;
363 			command |= PCIM_CMD_PORTEN;
364 		} else {
365 			printf("aic7xxx: PCI%d:%d:%d IO region 0x%lx[0..255] "
366 			       "unavailable. Cannot map device.\n",
367 			       ahc_get_pci_bus(ahc->dev_softc),
368 			       ahc_get_pci_slot(ahc->dev_softc),
369 			       ahc_get_pci_function(ahc->dev_softc),
370 			       base);
371 		}
372 	}
373 	ahc_pci_write_config(ahc->dev_softc, PCIR_COMMAND, command, 4);
374 	return (error);
375 }
376 
377 int
378 ahc_pci_map_int(struct ahc_softc *ahc)
379 {
380 	int error;
381 
382 	error = request_irq(ahc->dev_softc->irq, ahc_linux_isr,
383 			    SA_SHIRQ, "aic7xxx", ahc);
384 	if (error == 0)
385 		ahc->platform_data->irq = ahc->dev_softc->irq;
386 
387 	return (-error);
388 }
389 
390