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