Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/ieee1394...
[linux-2.6] / drivers / ide / setup-pci.c
1 /*
2  *  Copyright (C) 1998-2000  Andre Hedrick <andre@linux-ide.org>
3  *  Copyright (C) 1995-1998  Mark Lord
4  *  Copyright (C)      2007  Bartlomiej Zolnierkiewicz
5  *
6  *  May be copied or modified under the terms of the GNU General Public License
7  */
8
9 #include <linux/module.h>
10 #include <linux/types.h>
11 #include <linux/kernel.h>
12 #include <linux/pci.h>
13 #include <linux/init.h>
14 #include <linux/timer.h>
15 #include <linux/mm.h>
16 #include <linux/interrupt.h>
17 #include <linux/ide.h>
18 #include <linux/dma-mapping.h>
19
20 #include <asm/io.h>
21 #include <asm/irq.h>
22
23 /**
24  *      ide_setup_pci_baseregs  -       place a PCI IDE controller native
25  *      @dev: PCI device of interface to switch native
26  *      @name: Name of interface
27  *
28  *      We attempt to place the PCI interface into PCI native mode. If
29  *      we succeed the BARs are ok and the controller is in PCI mode.
30  *      Returns 0 on success or an errno code.
31  *
32  *      FIXME: if we program the interface and then fail to set the BARS
33  *      we don't switch it back to legacy mode. Do we actually care ??
34  */
35
36 static int ide_setup_pci_baseregs(struct pci_dev *dev, const char *name)
37 {
38         u8 progif = 0;
39
40         /*
41          * Place both IDE interfaces into PCI "native" mode:
42          */
43         if (pci_read_config_byte(dev, PCI_CLASS_PROG, &progif) ||
44                          (progif & 5) != 5) {
45                 if ((progif & 0xa) != 0xa) {
46                         printk(KERN_INFO "%s: device not capable of full "
47                                 "native PCI mode\n", name);
48                         return -EOPNOTSUPP;
49                 }
50                 printk("%s: placing both ports into native PCI mode\n", name);
51                 (void) pci_write_config_byte(dev, PCI_CLASS_PROG, progif|5);
52                 if (pci_read_config_byte(dev, PCI_CLASS_PROG, &progif) ||
53                     (progif & 5) != 5) {
54                         printk(KERN_ERR "%s: rewrite of PROGIF failed, wanted "
55                                 "0x%04x, got 0x%04x\n",
56                                 name, progif|5, progif);
57                         return -EOPNOTSUPP;
58                 }
59         }
60         return 0;
61 }
62
63 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
64 static void ide_pci_clear_simplex(unsigned long dma_base, const char *name)
65 {
66         u8 dma_stat = inb(dma_base + 2);
67
68         outb(dma_stat & 0x60, dma_base + 2);
69         dma_stat = inb(dma_base + 2);
70         if (dma_stat & 0x80)
71                 printk(KERN_INFO "%s: simplex device: DMA forced\n", name);
72 }
73
74 /**
75  *      ide_pci_dma_base        -       setup BMIBA
76  *      @hwif: IDE interface
77  *      @d: IDE port info
78  *
79  *      Fetch the DMA Bus-Master-I/O-Base-Address (BMIBA) from PCI space.
80  *      Where a device has a partner that is already in DMA mode we check
81  *      and enforce IDE simplex rules.
82  */
83
84 unsigned long ide_pci_dma_base(ide_hwif_t *hwif, const struct ide_port_info *d)
85 {
86         struct pci_dev *dev = to_pci_dev(hwif->dev);
87         unsigned long dma_base = 0;
88         u8 dma_stat = 0;
89
90         if (hwif->host_flags & IDE_HFLAG_MMIO)
91                 return hwif->dma_base;
92
93         if (hwif->mate && hwif->mate->dma_base) {
94                 dma_base = hwif->mate->dma_base - (hwif->channel ? 0 : 8);
95         } else {
96                 u8 baridx = (d->host_flags & IDE_HFLAG_CS5520) ? 2 : 4;
97
98                 dma_base = pci_resource_start(dev, baridx);
99
100                 if (dma_base == 0) {
101                         printk(KERN_ERR "%s: DMA base is invalid\n", d->name);
102                         return 0;
103                 }
104         }
105
106         if (hwif->channel)
107                 dma_base += 8;
108
109         if (d->host_flags & IDE_HFLAG_CS5520)
110                 goto out;
111
112         if (d->host_flags & IDE_HFLAG_CLEAR_SIMPLEX) {
113                 ide_pci_clear_simplex(dma_base, d->name);
114                 goto out;
115         }
116
117         /*
118          * If the device claims "simplex" DMA, this means that only one of
119          * the two interfaces can be trusted with DMA at any point in time
120          * (so we should enable DMA only on one of the two interfaces).
121          *
122          * FIXME: At this point we haven't probed the drives so we can't make
123          * the appropriate decision.  Really we should defer this problem until
124          * we tune the drive then try to grab DMA ownership if we want to be
125          * the DMA end.  This has to be become dynamic to handle hot-plug.
126          */
127         dma_stat = hwif->INB(dma_base + 2);
128         if ((dma_stat & 0x80) && hwif->mate && hwif->mate->dma_base) {
129                 printk(KERN_INFO "%s: simplex device: DMA disabled\n", d->name);
130                 dma_base = 0;
131         }
132 out:
133         return dma_base;
134 }
135 EXPORT_SYMBOL_GPL(ide_pci_dma_base);
136
137 /*
138  * Set up BM-DMA capability (PnP BIOS should have done this)
139  */
140 int ide_pci_set_master(struct pci_dev *dev, const char *name)
141 {
142         u16 pcicmd;
143
144         pci_read_config_word(dev, PCI_COMMAND, &pcicmd);
145
146         if ((pcicmd & PCI_COMMAND_MASTER) == 0) {
147                 pci_set_master(dev);
148
149                 if (pci_read_config_word(dev, PCI_COMMAND, &pcicmd) ||
150                     (pcicmd & PCI_COMMAND_MASTER) == 0) {
151                         printk(KERN_ERR "%s: error updating PCICMD on %s\n",
152                                         name, pci_name(dev));
153                         return -EIO;
154                 }
155         }
156
157         return 0;
158 }
159 EXPORT_SYMBOL_GPL(ide_pci_set_master);
160 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
161
162 void ide_setup_pci_noise(struct pci_dev *dev, const struct ide_port_info *d)
163 {
164         printk(KERN_INFO "%s: IDE controller (0x%04x:0x%04x rev 0x%02x) at "
165                          " PCI slot %s\n", d->name, dev->vendor, dev->device,
166                          dev->revision, pci_name(dev));
167 }
168 EXPORT_SYMBOL_GPL(ide_setup_pci_noise);
169
170
171 /**
172  *      ide_pci_enable  -       do PCI enables
173  *      @dev: PCI device
174  *      @d: IDE port info
175  *
176  *      Enable the IDE PCI device. We attempt to enable the device in full
177  *      but if that fails then we only need IO space. The PCI code should
178  *      have setup the proper resources for us already for controllers in
179  *      legacy mode.
180  *
181  *      Returns zero on success or an error code
182  */
183
184 static int ide_pci_enable(struct pci_dev *dev, const struct ide_port_info *d)
185 {
186         int ret, bars;
187
188         if (pci_enable_device(dev)) {
189                 ret = pci_enable_device_io(dev);
190                 if (ret < 0) {
191                         printk(KERN_WARNING "%s: (ide_setup_pci_device:) "
192                                 "Could not enable device.\n", d->name);
193                         goto out;
194                 }
195                 printk(KERN_WARNING "%s: BIOS configuration fixed.\n", d->name);
196         }
197
198         /*
199          * assume all devices can do 32-bit DMA for now, we can add
200          * a DMA mask field to the struct ide_port_info if we need it
201          * (or let lower level driver set the DMA mask)
202          */
203         ret = pci_set_dma_mask(dev, DMA_32BIT_MASK);
204         if (ret < 0) {
205                 printk(KERN_ERR "%s: can't set dma mask\n", d->name);
206                 goto out;
207         }
208
209         if (d->host_flags & IDE_HFLAG_SINGLE)
210                 bars = (1 << 2) - 1;
211         else
212                 bars = (1 << 4) - 1;
213
214         if ((d->host_flags & IDE_HFLAG_NO_DMA) == 0) {
215                 if (d->host_flags & IDE_HFLAG_CS5520)
216                         bars |= (1 << 2);
217                 else
218                         bars |= (1 << 4);
219         }
220
221         ret = pci_request_selected_regions(dev, bars, d->name);
222         if (ret < 0)
223                 printk(KERN_ERR "%s: can't reserve resources\n", d->name);
224 out:
225         return ret;
226 }
227
228 /**
229  *      ide_pci_configure       -       configure an unconfigured device
230  *      @dev: PCI device
231  *      @d: IDE port info
232  *
233  *      Enable and configure the PCI device we have been passed.
234  *      Returns zero on success or an error code.
235  */
236
237 static int ide_pci_configure(struct pci_dev *dev, const struct ide_port_info *d)
238 {
239         u16 pcicmd = 0;
240         /*
241          * PnP BIOS was *supposed* to have setup this device, but we
242          * can do it ourselves, so long as the BIOS has assigned an IRQ
243          * (or possibly the device is using a "legacy header" for IRQs).
244          * Maybe the user deliberately *disabled* the device,
245          * but we'll eventually ignore it again if no drives respond.
246          */
247         if (ide_setup_pci_baseregs(dev, d->name) ||
248             pci_write_config_word(dev, PCI_COMMAND, pcicmd | PCI_COMMAND_IO)) {
249                 printk(KERN_INFO "%s: device disabled (BIOS)\n", d->name);
250                 return -ENODEV;
251         }
252         if (pci_read_config_word(dev, PCI_COMMAND, &pcicmd)) {
253                 printk(KERN_ERR "%s: error accessing PCI regs\n", d->name);
254                 return -EIO;
255         }
256         if (!(pcicmd & PCI_COMMAND_IO)) {
257                 printk(KERN_ERR "%s: unable to enable IDE controller\n", d->name);
258                 return -ENXIO;
259         }
260         return 0;
261 }
262
263 /**
264  *      ide_pci_check_iomem     -       check a register is I/O
265  *      @dev: PCI device
266  *      @d: IDE port info
267  *      @bar: BAR number
268  *
269  *      Checks if a BAR is configured and points to MMIO space. If so,
270  *      return an error code. Otherwise return 0
271  */
272
273 static int ide_pci_check_iomem(struct pci_dev *dev, const struct ide_port_info *d,
274                                int bar)
275 {
276         ulong flags = pci_resource_flags(dev, bar);
277
278         /* Unconfigured ? */
279         if (!flags || pci_resource_len(dev, bar) == 0)
280                 return 0;
281
282         /* I/O space */
283         if (flags & IORESOURCE_IO)
284                 return 0;
285
286         /* Bad */
287         return -EINVAL;
288 }
289
290 /**
291  *      ide_hwif_configure      -       configure an IDE interface
292  *      @dev: PCI device holding interface
293  *      @d: IDE port info
294  *      @port: port number
295  *      @irq: PCI IRQ
296  *
297  *      Perform the initial set up for the hardware interface structure. This
298  *      is done per interface port rather than per PCI device. There may be
299  *      more than one port per device.
300  *
301  *      Returns the new hardware interface structure, or NULL on a failure
302  */
303
304 static ide_hwif_t *ide_hwif_configure(struct pci_dev *dev,
305                                       const struct ide_port_info *d,
306                                       unsigned int port, int irq)
307 {
308         unsigned long ctl = 0, base = 0;
309         ide_hwif_t *hwif;
310         struct hw_regs_s hw;
311
312         if ((d->host_flags & IDE_HFLAG_ISA_PORTS) == 0) {
313                 if (ide_pci_check_iomem(dev, d, 2 * port) ||
314                     ide_pci_check_iomem(dev, d, 2 * port + 1)) {
315                         printk(KERN_ERR "%s: I/O baseregs (BIOS) are reported "
316                                         "as MEM for port %d!\n", d->name, port);
317                         return NULL;
318                 }
319
320                 ctl  = pci_resource_start(dev, 2*port+1);
321                 base = pci_resource_start(dev, 2*port);
322                 if ((ctl && !base) || (base && !ctl)) {
323                         printk(KERN_ERR "%s: inconsistent baseregs (BIOS) "
324                                 "for port %d, skipping\n", d->name, port);
325                         return NULL;
326                 }
327         }
328         if (!ctl) {
329                 /* Use default values */
330                 ctl = port ? 0x374 : 0x3f4;
331                 base = port ? 0x170 : 0x1f0;
332         }
333
334         hwif = ide_find_port_slot(d);
335         if (hwif == NULL) {
336                 printk(KERN_ERR "%s: too many IDE interfaces, no room in "
337                                 "table\n", d->name);
338                 return NULL;
339         }
340
341         memset(&hw, 0, sizeof(hw));
342         hw.irq = irq;
343         hw.dev = &dev->dev;
344         hw.chipset = d->chipset ? d->chipset : ide_pci;
345         ide_std_init_ports(&hw, base, ctl | 2);
346
347         ide_init_port_hw(hwif, &hw);
348
349         hwif->dev = &dev->dev;
350
351         return hwif;
352 }
353
354 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
355 /**
356  *      ide_hwif_setup_dma      -       configure DMA interface
357  *      @hwif: IDE interface
358  *      @d: IDE port info
359  *
360  *      Set up the DMA base for the interface. Enable the master bits as
361  *      necessary and attempt to bring the device DMA into a ready to use
362  *      state
363  */
364
365 int ide_hwif_setup_dma(ide_hwif_t *hwif, const struct ide_port_info *d)
366 {
367         struct pci_dev *dev = to_pci_dev(hwif->dev);
368
369         if ((d->host_flags & IDE_HFLAG_NO_AUTODMA) == 0 ||
370             ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE &&
371              (dev->class & 0x80))) {
372                 unsigned long base = ide_pci_dma_base(hwif, d);
373
374                 if (base == 0 || ide_pci_set_master(dev, d->name) < 0)
375                         return -1;
376
377                 if (hwif->host_flags & IDE_HFLAG_MMIO)
378                         printk(KERN_INFO "    %s: MMIO-DMA\n", hwif->name);
379                 else
380                         printk(KERN_INFO "    %s: BM-DMA at 0x%04lx-0x%04lx\n",
381                                          hwif->name, base, base + 7);
382
383                 hwif->extra_base = base + (hwif->channel ? 8 : 16);
384
385                 if (ide_allocate_dma_engine(hwif))
386                         return -1;
387
388                 ide_setup_dma(hwif, base);
389         }
390
391         return 0;
392 }
393 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
394
395 /**
396  *      ide_setup_pci_controller        -       set up IDE PCI
397  *      @dev: PCI device
398  *      @d: IDE port info
399  *      @noisy: verbose flag
400  *      @config: returned as 1 if we configured the hardware
401  *
402  *      Set up the PCI and controller side of the IDE interface. This brings
403  *      up the PCI side of the device, checks that the device is enabled
404  *      and enables it if need be
405  */
406
407 static int ide_setup_pci_controller(struct pci_dev *dev, const struct ide_port_info *d, int noisy, int *config)
408 {
409         int ret;
410         u16 pcicmd;
411
412         if (noisy)
413                 ide_setup_pci_noise(dev, d);
414
415         ret = ide_pci_enable(dev, d);
416         if (ret < 0)
417                 goto out;
418
419         ret = pci_read_config_word(dev, PCI_COMMAND, &pcicmd);
420         if (ret < 0) {
421                 printk(KERN_ERR "%s: error accessing PCI regs\n", d->name);
422                 goto out;
423         }
424         if (!(pcicmd & PCI_COMMAND_IO)) {       /* is device disabled? */
425                 ret = ide_pci_configure(dev, d);
426                 if (ret < 0)
427                         goto out;
428                 *config = 1;
429                 printk(KERN_INFO "%s: device enabled (Linux)\n", d->name);
430         }
431
432 out:
433         return ret;
434 }
435
436 /**
437  *      ide_pci_setup_ports     -       configure ports/devices on PCI IDE
438  *      @dev: PCI device
439  *      @d: IDE port info
440  *      @pciirq: IRQ line
441  *      @idx: ATA index table to update
442  *
443  *      Scan the interfaces attached to this device and do any
444  *      necessary per port setup. Attach the devices and ask the
445  *      generic DMA layer to do its work for us.
446  *
447  *      Normally called automaticall from do_ide_pci_setup_device,
448  *      but is also used directly as a helper function by some controllers
449  *      where the chipset setup is not the default PCI IDE one.
450  */
451
452 void ide_pci_setup_ports(struct pci_dev *dev, const struct ide_port_info *d, int pciirq, u8 *idx)
453 {
454         int channels = (d->host_flags & IDE_HFLAG_SINGLE) ? 1 : 2, port;
455         ide_hwif_t *hwif;
456         u8 tmp;
457
458         /*
459          * Set up the IDE ports
460          */
461
462         for (port = 0; port < channels; ++port) {
463                 const ide_pci_enablebit_t *e = &(d->enablebits[port]);
464
465                 if (e->reg && (pci_read_config_byte(dev, e->reg, &tmp) ||
466                     (tmp & e->mask) != e->val)) {
467                         printk(KERN_INFO "%s: IDE port disabled\n", d->name);
468                         continue;       /* port not enabled */
469                 }
470
471                 hwif = ide_hwif_configure(dev, d, port, pciirq);
472                 if (hwif == NULL)
473                         continue;
474
475                 *(idx + port) = hwif->index;
476         }
477 }
478 EXPORT_SYMBOL_GPL(ide_pci_setup_ports);
479
480 /*
481  * ide_setup_pci_device() looks at the primary/secondary interfaces
482  * on a PCI IDE device and, if they are enabled, prepares the IDE driver
483  * for use with them.  This generic code works for most PCI chipsets.
484  *
485  * One thing that is not standardized is the location of the
486  * primary/secondary interface "enable/disable" bits.  For chipsets that
487  * we "know" about, this information is in the struct ide_port_info;
488  * for all other chipsets, we just assume both interfaces are enabled.
489  */
490 static int do_ide_setup_pci_device(struct pci_dev *dev,
491                                    const struct ide_port_info *d,
492                                    u8 *idx, u8 noisy)
493 {
494         int tried_config = 0;
495         int pciirq, ret;
496
497         ret = ide_setup_pci_controller(dev, d, noisy, &tried_config);
498         if (ret < 0)
499                 goto out;
500
501         /*
502          * Can we trust the reported IRQ?
503          */
504         pciirq = dev->irq;
505
506         /* Is it an "IDE storage" device in non-PCI mode? */
507         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5) {
508                 if (noisy)
509                         printk(KERN_INFO "%s: not 100%% native mode: "
510                                 "will probe irqs later\n", d->name);
511                 /*
512                  * This allows offboard ide-pci cards the enable a BIOS,
513                  * verify interrupt settings of split-mirror pci-config
514                  * space, place chipset into init-mode, and/or preserve
515                  * an interrupt if the card is not native ide support.
516                  */
517                 ret = d->init_chipset ? d->init_chipset(dev, d->name) : 0;
518                 if (ret < 0)
519                         goto out;
520                 pciirq = ret;
521         } else if (tried_config) {
522                 if (noisy)
523                         printk(KERN_INFO "%s: will probe irqs later\n", d->name);
524                 pciirq = 0;
525         } else if (!pciirq) {
526                 if (noisy)
527                         printk(KERN_WARNING "%s: bad irq (%d): will probe later\n",
528                                 d->name, pciirq);
529                 pciirq = 0;
530         } else {
531                 if (d->init_chipset) {
532                         ret = d->init_chipset(dev, d->name);
533                         if (ret < 0)
534                                 goto out;
535                 }
536                 if (noisy)
537                         printk(KERN_INFO "%s: 100%% native mode on irq %d\n",
538                                 d->name, pciirq);
539         }
540
541         /* FIXME: silent failure can happen */
542
543         ide_pci_setup_ports(dev, d, pciirq, idx);
544 out:
545         return ret;
546 }
547
548 int ide_setup_pci_device(struct pci_dev *dev, const struct ide_port_info *d)
549 {
550         u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
551         int ret;
552
553         ret = do_ide_setup_pci_device(dev, d, &idx[0], 1);
554
555         if (ret >= 0)
556                 ide_device_add(idx, d);
557
558         return ret;
559 }
560 EXPORT_SYMBOL_GPL(ide_setup_pci_device);
561
562 int ide_setup_pci_devices(struct pci_dev *dev1, struct pci_dev *dev2,
563                           const struct ide_port_info *d)
564 {
565         struct pci_dev *pdev[] = { dev1, dev2 };
566         int ret, i;
567         u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
568
569         for (i = 0; i < 2; i++) {
570                 ret = do_ide_setup_pci_device(pdev[i], d, &idx[i*2], !i);
571                 /*
572                  * FIXME: Mom, mom, they stole me the helper function to undo
573                  * do_ide_setup_pci_device() on the first device!
574                  */
575                 if (ret < 0)
576                         goto out;
577         }
578
579         ide_device_add(idx, d);
580 out:
581         return ret;
582 }
583 EXPORT_SYMBOL_GPL(ide_setup_pci_devices);