IDE: Coding Style fixes to drivers/ide/legacy/hd.c
[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_get_or_set_dma_base         -       setup BMIBA
76  *      @d: IDE port info
77  *      @hwif: IDE interface
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 static unsigned long ide_get_or_set_dma_base(const struct ide_port_info *d, ide_hwif_t *hwif)
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->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 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
136
137 void ide_setup_pci_noise(struct pci_dev *dev, const struct ide_port_info *d)
138 {
139         printk(KERN_INFO "%s: IDE controller (0x%04x:0x%04x rev 0x%02x) at "
140                          " PCI slot %s\n", d->name, dev->vendor, dev->device,
141                          dev->revision, pci_name(dev));
142 }
143 EXPORT_SYMBOL_GPL(ide_setup_pci_noise);
144
145
146 /**
147  *      ide_pci_enable  -       do PCI enables
148  *      @dev: PCI device
149  *      @d: IDE port info
150  *
151  *      Enable the IDE PCI device. We attempt to enable the device in full
152  *      but if that fails then we only need IO space. The PCI code should
153  *      have setup the proper resources for us already for controllers in
154  *      legacy mode.
155  *
156  *      Returns zero on success or an error code
157  */
158
159 static int ide_pci_enable(struct pci_dev *dev, const struct ide_port_info *d)
160 {
161         int ret;
162
163         if (pci_enable_device(dev)) {
164                 ret = pci_enable_device_io(dev);
165                 if (ret < 0) {
166                         printk(KERN_WARNING "%s: (ide_setup_pci_device:) "
167                                 "Could not enable device.\n", d->name);
168                         goto out;
169                 }
170                 printk(KERN_WARNING "%s: BIOS configuration fixed.\n", d->name);
171         }
172
173         /*
174          * assume all devices can do 32-bit DMA for now, we can add
175          * a DMA mask field to the struct ide_port_info if we need it
176          * (or let lower level driver set the DMA mask)
177          */
178         ret = pci_set_dma_mask(dev, DMA_32BIT_MASK);
179         if (ret < 0) {
180                 printk(KERN_ERR "%s: can't set dma mask\n", d->name);
181                 goto out;
182         }
183
184         /* FIXME: Temporary - until we put in the hotplug interface logic
185            Check that the bits we want are not in use by someone else. */
186         ret = pci_request_region(dev, 4, "ide_tmp");
187         if (ret < 0)
188                 goto out;
189
190         pci_release_region(dev, 4);
191 out:
192         return ret;
193 }
194
195 /**
196  *      ide_pci_configure       -       configure an unconfigured device
197  *      @dev: PCI device
198  *      @d: IDE port info
199  *
200  *      Enable and configure the PCI device we have been passed.
201  *      Returns zero on success or an error code.
202  */
203
204 static int ide_pci_configure(struct pci_dev *dev, const struct ide_port_info *d)
205 {
206         u16 pcicmd = 0;
207         /*
208          * PnP BIOS was *supposed* to have setup this device, but we
209          * can do it ourselves, so long as the BIOS has assigned an IRQ
210          * (or possibly the device is using a "legacy header" for IRQs).
211          * Maybe the user deliberately *disabled* the device,
212          * but we'll eventually ignore it again if no drives respond.
213          */
214         if (ide_setup_pci_baseregs(dev, d->name) ||
215             pci_write_config_word(dev, PCI_COMMAND, pcicmd | PCI_COMMAND_IO)) {
216                 printk(KERN_INFO "%s: device disabled (BIOS)\n", d->name);
217                 return -ENODEV;
218         }
219         if (pci_read_config_word(dev, PCI_COMMAND, &pcicmd)) {
220                 printk(KERN_ERR "%s: error accessing PCI regs\n", d->name);
221                 return -EIO;
222         }
223         if (!(pcicmd & PCI_COMMAND_IO)) {
224                 printk(KERN_ERR "%s: unable to enable IDE controller\n", d->name);
225                 return -ENXIO;
226         }
227         return 0;
228 }
229
230 /**
231  *      ide_pci_check_iomem     -       check a register is I/O
232  *      @dev: PCI device
233  *      @d: IDE port info
234  *      @bar: BAR number
235  *
236  *      Checks if a BAR is configured and points to MMIO space. If so,
237  *      return an error code. Otherwise return 0
238  */
239
240 static int ide_pci_check_iomem(struct pci_dev *dev, const struct ide_port_info *d,
241                                int bar)
242 {
243         ulong flags = pci_resource_flags(dev, bar);
244
245         /* Unconfigured ? */
246         if (!flags || pci_resource_len(dev, bar) == 0)
247                 return 0;
248
249         /* I/O space */
250         if (flags & IORESOURCE_IO)
251                 return 0;
252
253         /* Bad */
254         return -EINVAL;
255 }
256
257 /**
258  *      ide_hwif_configure      -       configure an IDE interface
259  *      @dev: PCI device holding interface
260  *      @d: IDE port info
261  *      @port: port number
262  *      @irq: PCI IRQ
263  *
264  *      Perform the initial set up for the hardware interface structure. This
265  *      is done per interface port rather than per PCI device. There may be
266  *      more than one port per device.
267  *
268  *      Returns the new hardware interface structure, or NULL on a failure
269  */
270
271 static ide_hwif_t *ide_hwif_configure(struct pci_dev *dev,
272                                       const struct ide_port_info *d,
273                                       unsigned int port, int irq)
274 {
275         unsigned long ctl = 0, base = 0;
276         ide_hwif_t *hwif;
277         struct hw_regs_s hw;
278
279         if ((d->host_flags & IDE_HFLAG_ISA_PORTS) == 0) {
280                 if (ide_pci_check_iomem(dev, d, 2 * port) ||
281                     ide_pci_check_iomem(dev, d, 2 * port + 1)) {
282                         printk(KERN_ERR "%s: I/O baseregs (BIOS) are reported "
283                                         "as MEM for port %d!\n", d->name, port);
284                         return NULL;
285                 }
286
287                 ctl  = pci_resource_start(dev, 2*port+1);
288                 base = pci_resource_start(dev, 2*port);
289                 if ((ctl && !base) || (base && !ctl)) {
290                         printk(KERN_ERR "%s: inconsistent baseregs (BIOS) "
291                                 "for port %d, skipping\n", d->name, port);
292                         return NULL;
293                 }
294         }
295         if (!ctl) {
296                 /* Use default values */
297                 ctl = port ? 0x374 : 0x3f4;
298                 base = port ? 0x170 : 0x1f0;
299         }
300
301         hwif = ide_find_port_slot(d);
302         if (hwif == NULL) {
303                 printk(KERN_ERR "%s: too many IDE interfaces, no room in "
304                                 "table\n", d->name);
305                 return NULL;
306         }
307
308         memset(&hw, 0, sizeof(hw));
309         hw.irq = irq;
310         hw.dev = &dev->dev;
311         hw.chipset = d->chipset ? d->chipset : ide_pci;
312         ide_std_init_ports(&hw, base, ctl | 2);
313
314         ide_init_port_hw(hwif, &hw);
315
316         hwif->dev = &dev->dev;
317         hwif->cds = d;
318
319         return hwif;
320 }
321
322 #ifdef CONFIG_BLK_DEV_IDEDMA_PCI
323 /**
324  *      ide_hwif_setup_dma      -       configure DMA interface
325  *      @hwif: IDE interface
326  *      @d: IDE port info
327  *
328  *      Set up the DMA base for the interface. Enable the master bits as
329  *      necessary and attempt to bring the device DMA into a ready to use
330  *      state
331  */
332
333 void ide_hwif_setup_dma(ide_hwif_t *hwif, const struct ide_port_info *d)
334 {
335         struct pci_dev *dev = to_pci_dev(hwif->dev);
336         u16 pcicmd;
337
338         pci_read_config_word(dev, PCI_COMMAND, &pcicmd);
339
340         if ((d->host_flags & IDE_HFLAG_NO_AUTODMA) == 0 ||
341             ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE &&
342              (dev->class & 0x80))) {
343                 unsigned long dma_base = ide_get_or_set_dma_base(d, hwif);
344                 if (dma_base && !(pcicmd & PCI_COMMAND_MASTER)) {
345                         /*
346                          * Set up BM-DMA capability
347                          * (PnP BIOS should have done this)
348                          */
349                         pci_set_master(dev);
350                         if (pci_read_config_word(dev, PCI_COMMAND, &pcicmd) || !(pcicmd & PCI_COMMAND_MASTER)) {
351                                 printk(KERN_ERR "%s: %s error updating PCICMD\n",
352                                         hwif->name, d->name);
353                                 dma_base = 0;
354                         }
355                 }
356                 if (dma_base) {
357                         if (d->init_dma) {
358                                 d->init_dma(hwif, dma_base);
359                         } else {
360                                 ide_setup_dma(hwif, dma_base);
361                         }
362                 } else {
363                         printk(KERN_INFO "%s: %s Bus-Master DMA disabled "
364                                 "(BIOS)\n", hwif->name, d->name);
365                 }
366         }
367 }
368 #endif /* CONFIG_BLK_DEV_IDEDMA_PCI */
369
370 /**
371  *      ide_setup_pci_controller        -       set up IDE PCI
372  *      @dev: PCI device
373  *      @d: IDE port info
374  *      @noisy: verbose flag
375  *      @config: returned as 1 if we configured the hardware
376  *
377  *      Set up the PCI and controller side of the IDE interface. This brings
378  *      up the PCI side of the device, checks that the device is enabled
379  *      and enables it if need be
380  */
381
382 static int ide_setup_pci_controller(struct pci_dev *dev, const struct ide_port_info *d, int noisy, int *config)
383 {
384         int ret;
385         u16 pcicmd;
386
387         if (noisy)
388                 ide_setup_pci_noise(dev, d);
389
390         ret = ide_pci_enable(dev, d);
391         if (ret < 0)
392                 goto out;
393
394         ret = pci_read_config_word(dev, PCI_COMMAND, &pcicmd);
395         if (ret < 0) {
396                 printk(KERN_ERR "%s: error accessing PCI regs\n", d->name);
397                 goto out;
398         }
399         if (!(pcicmd & PCI_COMMAND_IO)) {       /* is device disabled? */
400                 ret = ide_pci_configure(dev, d);
401                 if (ret < 0)
402                         goto out;
403                 *config = 1;
404                 printk(KERN_INFO "%s: device enabled (Linux)\n", d->name);
405         }
406
407 out:
408         return ret;
409 }
410
411 /**
412  *      ide_pci_setup_ports     -       configure ports/devices on PCI IDE
413  *      @dev: PCI device
414  *      @d: IDE port info
415  *      @pciirq: IRQ line
416  *      @idx: ATA index table to update
417  *
418  *      Scan the interfaces attached to this device and do any
419  *      necessary per port setup. Attach the devices and ask the
420  *      generic DMA layer to do its work for us.
421  *
422  *      Normally called automaticall from do_ide_pci_setup_device,
423  *      but is also used directly as a helper function by some controllers
424  *      where the chipset setup is not the default PCI IDE one.
425  */
426
427 void ide_pci_setup_ports(struct pci_dev *dev, const struct ide_port_info *d, int pciirq, u8 *idx)
428 {
429         int channels = (d->host_flags & IDE_HFLAG_SINGLE) ? 1 : 2, port;
430         ide_hwif_t *hwif;
431         u8 tmp;
432
433         /*
434          * Set up the IDE ports
435          */
436
437         for (port = 0; port < channels; ++port) {
438                 const ide_pci_enablebit_t *e = &(d->enablebits[port]);
439
440                 if (e->reg && (pci_read_config_byte(dev, e->reg, &tmp) ||
441                     (tmp & e->mask) != e->val)) {
442                         printk(KERN_INFO "%s: IDE port disabled\n", d->name);
443                         continue;       /* port not enabled */
444                 }
445
446                 hwif = ide_hwif_configure(dev, d, port, pciirq);
447                 if (hwif == NULL)
448                         continue;
449
450                 *(idx + port) = hwif->index;
451         }
452 }
453 EXPORT_SYMBOL_GPL(ide_pci_setup_ports);
454
455 /*
456  * ide_setup_pci_device() looks at the primary/secondary interfaces
457  * on a PCI IDE device and, if they are enabled, prepares the IDE driver
458  * for use with them.  This generic code works for most PCI chipsets.
459  *
460  * One thing that is not standardized is the location of the
461  * primary/secondary interface "enable/disable" bits.  For chipsets that
462  * we "know" about, this information is in the struct ide_port_info;
463  * for all other chipsets, we just assume both interfaces are enabled.
464  */
465 static int do_ide_setup_pci_device(struct pci_dev *dev,
466                                    const struct ide_port_info *d,
467                                    u8 *idx, u8 noisy)
468 {
469         int tried_config = 0;
470         int pciirq, ret;
471
472         ret = ide_setup_pci_controller(dev, d, noisy, &tried_config);
473         if (ret < 0)
474                 goto out;
475
476         /*
477          * Can we trust the reported IRQ?
478          */
479         pciirq = dev->irq;
480
481         /* Is it an "IDE storage" device in non-PCI mode? */
482         if ((dev->class >> 8) == PCI_CLASS_STORAGE_IDE && (dev->class & 5) != 5) {
483                 if (noisy)
484                         printk(KERN_INFO "%s: not 100%% native mode: "
485                                 "will probe irqs later\n", d->name);
486                 /*
487                  * This allows offboard ide-pci cards the enable a BIOS,
488                  * verify interrupt settings of split-mirror pci-config
489                  * space, place chipset into init-mode, and/or preserve
490                  * an interrupt if the card is not native ide support.
491                  */
492                 ret = d->init_chipset ? d->init_chipset(dev, d->name) : 0;
493                 if (ret < 0)
494                         goto out;
495                 pciirq = ret;
496         } else if (tried_config) {
497                 if (noisy)
498                         printk(KERN_INFO "%s: will probe irqs later\n", d->name);
499                 pciirq = 0;
500         } else if (!pciirq) {
501                 if (noisy)
502                         printk(KERN_WARNING "%s: bad irq (%d): will probe later\n",
503                                 d->name, pciirq);
504                 pciirq = 0;
505         } else {
506                 if (d->init_chipset) {
507                         ret = d->init_chipset(dev, d->name);
508                         if (ret < 0)
509                                 goto out;
510                 }
511                 if (noisy)
512                         printk(KERN_INFO "%s: 100%% native mode on irq %d\n",
513                                 d->name, pciirq);
514         }
515
516         /* FIXME: silent failure can happen */
517
518         ide_pci_setup_ports(dev, d, pciirq, idx);
519 out:
520         return ret;
521 }
522
523 int ide_setup_pci_device(struct pci_dev *dev, const struct ide_port_info *d)
524 {
525         u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
526         int ret;
527
528         ret = do_ide_setup_pci_device(dev, d, &idx[0], 1);
529
530         if (ret >= 0)
531                 ide_device_add(idx, d);
532
533         return ret;
534 }
535 EXPORT_SYMBOL_GPL(ide_setup_pci_device);
536
537 int ide_setup_pci_devices(struct pci_dev *dev1, struct pci_dev *dev2,
538                           const struct ide_port_info *d)
539 {
540         struct pci_dev *pdev[] = { dev1, dev2 };
541         int ret, i;
542         u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
543
544         for (i = 0; i < 2; i++) {
545                 ret = do_ide_setup_pci_device(pdev[i], d, &idx[i*2], !i);
546                 /*
547                  * FIXME: Mom, mom, they stole me the helper function to undo
548                  * do_ide_setup_pci_device() on the first device!
549                  */
550                 if (ret < 0)
551                         goto out;
552         }
553
554         ide_device_add(idx, d);
555 out:
556         return ret;
557 }
558 EXPORT_SYMBOL_GPL(ide_setup_pci_devices);