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