61d2d920a5cd494d9d70929cd7edfe0e76b7465c
[linux-2.6.git] / drivers / ide / piix.c
1 /*
2  *  Copyright (C) 1998-1999 Andrzej Krzysztofowicz, Author and Maintainer
3  *  Copyright (C) 1998-2000 Andre Hedrick <andre@linux-ide.org>
4  *  Copyright (C) 2003 Red Hat
5  *  Copyright (C) 2006-2007 MontaVista Software, Inc. <source@mvista.com>
6  *
7  *  May be copied or modified under the terms of the GNU General Public License
8  *
9  * Documentation:
10  *
11  *      Publically available from Intel web site. Errata documentation
12  * is also publically available. As an aide to anyone hacking on this
13  * driver the list of errata that are relevant is below.going back to
14  * PIIX4. Older device documentation is now a bit tricky to find.
15  *
16  * Errata of note:
17  *
18  * Unfixable
19  *      PIIX4    errata #9      - Only on ultra obscure hw
20  *      ICH3     errata #13     - Not observed to affect real hw
21  *                                by Intel
22  *
23  * Things we must deal with
24  *      PIIX4   errata #10      - BM IDE hang with non UDMA
25  *                                (must stop/start dma to recover)
26  *      440MX   errata #15      - As PIIX4 errata #10
27  *      PIIX4   errata #15      - Must not read control registers
28  *                                during a PIO transfer
29  *      440MX   errata #13      - As PIIX4 errata #15
30  *      ICH2    errata #21      - DMA mode 0 doesn't work right
31  *      ICH0/1  errata #55      - As ICH2 errata #21
32  *      ICH2    spec c #9       - Extra operations needed to handle
33  *                                drive hotswap [NOT YET SUPPORTED]
34  *      ICH2    spec c #20      - IDE PRD must not cross a 64K boundary
35  *                                and must be dword aligned
36  *      ICH2    spec c #24      - UDMA mode 4,5 t85/86 should be 6ns not 3.3
37  *
38  * Should have been BIOS fixed:
39  *      450NX:  errata #19      - DMA hangs on old 450NX
40  *      450NX:  errata #20      - DMA hangs on old 450NX
41  *      450NX:  errata #25      - Corruption with DMA on old 450NX
42  *      ICH3    errata #15      - IDE deadlock under high load
43  *                                (BIOS must set dev 31 fn 0 bit 23)
44  *      ICH3    errata #18      - Don't use native mode
45  */
46
47 #include <linux/types.h>
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/pci.h>
51 #include <linux/ide.h>
52 #include <linux/init.h>
53
54 #include <asm/io.h>
55
56 #define DRV_NAME "piix"
57
58 static int no_piix_dma;
59
60 /**
61  *      piix_set_pio_mode       -       set host controller for PIO mode
62  *      @drive: drive
63  *      @pio: PIO mode number
64  *
65  *      Set the interface PIO mode based upon the settings done by AMI BIOS.
66  */
67
68 static void piix_set_pio_mode(ide_drive_t *drive, const u8 pio)
69 {
70         ide_hwif_t *hwif        = HWIF(drive);
71         struct pci_dev *dev     = to_pci_dev(hwif->dev);
72         int is_slave            = drive->dn & 1;
73         int master_port         = hwif->channel ? 0x42 : 0x40;
74         int slave_port          = 0x44;
75         unsigned long flags;
76         u16 master_data;
77         u8 slave_data;
78         static DEFINE_SPINLOCK(tune_lock);
79         int control = 0;
80
81                                      /* ISP  RTC */
82         static const u8 timings[][2]= {
83                                         { 0, 0 },
84                                         { 0, 0 },
85                                         { 1, 0 },
86                                         { 2, 1 },
87                                         { 2, 3 }, };
88
89         /*
90          * Master vs slave is synchronized above us but the slave register is
91          * shared by the two hwifs so the corner case of two slave timeouts in
92          * parallel must be locked.
93          */
94         spin_lock_irqsave(&tune_lock, flags);
95         pci_read_config_word(dev, master_port, &master_data);
96
97         if (pio > 1)
98                 control |= 1;   /* Programmable timing on */
99         if (drive->media == ide_disk)
100                 control |= 4;   /* Prefetch, post write */
101         if (pio > 2)
102                 control |= 2;   /* IORDY */
103         if (is_slave) {
104                 master_data |=  0x4000;
105                 master_data &= ~0x0070;
106                 if (pio > 1) {
107                         /* Set PPE, IE and TIME */
108                         master_data |= control << 4;
109                 }
110                 pci_read_config_byte(dev, slave_port, &slave_data);
111                 slave_data &= hwif->channel ? 0x0f : 0xf0;
112                 slave_data |= ((timings[pio][0] << 2) | timings[pio][1]) <<
113                                (hwif->channel ? 4 : 0);
114         } else {
115                 master_data &= ~0x3307;
116                 if (pio > 1) {
117                         /* enable PPE, IE and TIME */
118                         master_data |= control;
119                 }
120                 master_data |= (timings[pio][0] << 12) | (timings[pio][1] << 8);
121         }
122         pci_write_config_word(dev, master_port, master_data);
123         if (is_slave)
124                 pci_write_config_byte(dev, slave_port, slave_data);
125         spin_unlock_irqrestore(&tune_lock, flags);
126 }
127
128 /**
129  *      piix_set_dma_mode       -       set host controller for DMA mode
130  *      @drive: drive
131  *      @speed: DMA mode
132  *
133  *      Set a PIIX host controller to the desired DMA mode.  This involves
134  *      programming the right timing data into the PCI configuration space.
135  */
136
137 static void piix_set_dma_mode(ide_drive_t *drive, const u8 speed)
138 {
139         ide_hwif_t *hwif        = HWIF(drive);
140         struct pci_dev *dev     = to_pci_dev(hwif->dev);
141         u8 maslave              = hwif->channel ? 0x42 : 0x40;
142         int a_speed             = 3 << (drive->dn * 4);
143         int u_flag              = 1 << drive->dn;
144         int v_flag              = 0x01 << drive->dn;
145         int w_flag              = 0x10 << drive->dn;
146         int u_speed             = 0;
147         int                     sitre;
148         u16                     reg4042, reg4a;
149         u8                      reg48, reg54, reg55;
150
151         pci_read_config_word(dev, maslave, &reg4042);
152         sitre = (reg4042 & 0x4000) ? 1 : 0;
153         pci_read_config_byte(dev, 0x48, &reg48);
154         pci_read_config_word(dev, 0x4a, &reg4a);
155         pci_read_config_byte(dev, 0x54, &reg54);
156         pci_read_config_byte(dev, 0x55, &reg55);
157
158         if (speed >= XFER_UDMA_0) {
159                 u8 udma = speed - XFER_UDMA_0;
160
161                 u_speed = min_t(u8, 2 - (udma & 1), udma) << (drive->dn * 4);
162
163                 if (!(reg48 & u_flag))
164                         pci_write_config_byte(dev, 0x48, reg48 | u_flag);
165                 if (speed == XFER_UDMA_5) {
166                         pci_write_config_byte(dev, 0x55, (u8) reg55|w_flag);
167                 } else {
168                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
169                 }
170                 if ((reg4a & a_speed) != u_speed)
171                         pci_write_config_word(dev, 0x4a, (reg4a & ~a_speed) | u_speed);
172                 if (speed > XFER_UDMA_2) {
173                         if (!(reg54 & v_flag))
174                                 pci_write_config_byte(dev, 0x54, reg54 | v_flag);
175                 } else
176                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
177         } else {
178                 const u8 mwdma_to_pio[] = { 0, 3, 4 };
179                 u8 pio;
180
181                 if (reg48 & u_flag)
182                         pci_write_config_byte(dev, 0x48, reg48 & ~u_flag);
183                 if (reg4a & a_speed)
184                         pci_write_config_word(dev, 0x4a, reg4a & ~a_speed);
185                 if (reg54 & v_flag)
186                         pci_write_config_byte(dev, 0x54, reg54 & ~v_flag);
187                 if (reg55 & w_flag)
188                         pci_write_config_byte(dev, 0x55, (u8) reg55 & ~w_flag);
189
190                 if (speed >= XFER_MW_DMA_0)
191                         pio = mwdma_to_pio[speed - XFER_MW_DMA_0];
192                 else
193                         pio = 2; /* only SWDMA2 is allowed */
194
195                 piix_set_pio_mode(drive, pio);
196         }
197 }
198
199 /**
200  *      init_chipset_ich        -       set up the ICH chipset
201  *      @dev: PCI device to set up
202  *
203  *      Initialize the PCI device as required.  For the ICH this turns
204  *      out to be nice and simple.
205  */
206
207 static unsigned int init_chipset_ich(struct pci_dev *dev)
208 {
209         u32 extra = 0;
210
211         pci_read_config_dword(dev, 0x54, &extra);
212         pci_write_config_dword(dev, 0x54, extra | 0x400);
213
214         return 0;
215 }
216
217 /**
218  *      ich_clear_irq   -       clear BMDMA status
219  *      @drive: IDE drive
220  *
221  *      ICHx contollers set DMA INTR no matter DMA or PIO.
222  *      BMDMA status might need to be cleared even for
223  *      PIO interrupts to prevent spurious/lost IRQ.
224  */
225 static void ich_clear_irq(ide_drive_t *drive)
226 {
227         ide_hwif_t *hwif = HWIF(drive);
228         u8 dma_stat;
229
230         /*
231          * ide_dma_end() needs BMDMA status for error checking.
232          * So, skip clearing BMDMA status here and leave it
233          * to ide_dma_end() if this is DMA interrupt.
234          */
235         if (drive->waiting_for_dma || hwif->dma_base == 0)
236                 return;
237
238         /* clear the INTR & ERROR bits */
239         dma_stat = inb(hwif->dma_base + ATA_DMA_STATUS);
240         /* Should we force the bit as well ? */
241         outb(dma_stat, hwif->dma_base + ATA_DMA_STATUS);
242 }
243
244 struct ich_laptop {
245         u16 device;
246         u16 subvendor;
247         u16 subdevice;
248 };
249
250 /*
251  *      List of laptops that use short cables rather than 80 wire
252  */
253
254 static const struct ich_laptop ich_laptop[] = {
255         /* devid, subvendor, subdev */
256         { 0x27DF, 0x1025, 0x0102 },     /* ICH7 on Acer 5602aWLMi */
257         { 0x27DF, 0x0005, 0x0280 },     /* ICH7 on Acer 5602WLMi */
258         { 0x27DF, 0x1025, 0x0110 },     /* ICH7 on Acer 3682WLMi */
259         { 0x27DF, 0x1043, 0x1267 },     /* ICH7 on Asus W5F */
260         { 0x27DF, 0x103C, 0x30A1 },     /* ICH7 on HP Compaq nc2400 */
261         { 0x27DF, 0x1071, 0xD221 },     /* ICH7 on Hercules EC-900 */
262         { 0x24CA, 0x1025, 0x0061 },     /* ICH4 on Acer Aspire 2023WLMi */
263         { 0x2653, 0x1043, 0x82D8 },     /* ICH6M on Asus Eee 701 */
264         /* end marker */
265         { 0, }
266 };
267
268 static u8 piix_cable_detect(ide_hwif_t *hwif)
269 {
270         struct pci_dev *pdev = to_pci_dev(hwif->dev);
271         const struct ich_laptop *lap = &ich_laptop[0];
272         u8 reg54h = 0, mask = hwif->channel ? 0xc0 : 0x30;
273
274         /* check for specials */
275         while (lap->device) {
276                 if (lap->device == pdev->device &&
277                     lap->subvendor == pdev->subsystem_vendor &&
278                     lap->subdevice == pdev->subsystem_device) {
279                         return ATA_CBL_PATA40_SHORT;
280                 }
281                 lap++;
282         }
283
284         pci_read_config_byte(pdev, 0x54, &reg54h);
285
286         return (reg54h & mask) ? ATA_CBL_PATA80 : ATA_CBL_PATA40;
287 }
288
289 /**
290  *      init_hwif_piix          -       fill in the hwif for the PIIX
291  *      @hwif: IDE interface
292  *
293  *      Set up the ide_hwif_t for the PIIX interface according to the
294  *      capabilities of the hardware.
295  */
296
297 static void __devinit init_hwif_piix(ide_hwif_t *hwif)
298 {
299         if (!hwif->dma_base)
300                 return;
301
302         if (no_piix_dma)
303                 hwif->ultra_mask = hwif->mwdma_mask = hwif->swdma_mask = 0;
304 }
305
306 static const struct ide_port_ops piix_port_ops = {
307         .set_pio_mode           = piix_set_pio_mode,
308         .set_dma_mode           = piix_set_dma_mode,
309         .cable_detect           = piix_cable_detect,
310 };
311
312 static const struct ide_port_ops ich_port_ops = {
313         .set_pio_mode           = piix_set_pio_mode,
314         .set_dma_mode           = piix_set_dma_mode,
315         .clear_irq              = ich_clear_irq,
316         .cable_detect           = piix_cable_detect,
317 };
318
319 #ifndef CONFIG_IA64
320  #define IDE_HFLAGS_PIIX IDE_HFLAG_LEGACY_IRQS
321 #else
322  #define IDE_HFLAGS_PIIX 0
323 #endif
324
325 #define DECLARE_PIIX_DEV(udma) \
326         {                                               \
327                 .name           = DRV_NAME,             \
328                 .init_hwif      = init_hwif_piix,       \
329                 .enablebits     = {{0x41,0x80,0x80}, {0x43,0x80,0x80}}, \
330                 .port_ops       = &piix_port_ops,       \
331                 .host_flags     = IDE_HFLAGS_PIIX,      \
332                 .pio_mask       = ATA_PIO4,             \
333                 .swdma_mask     = ATA_SWDMA2_ONLY,      \
334                 .mwdma_mask     = ATA_MWDMA12_ONLY,     \
335                 .udma_mask      = udma,                 \
336         }
337
338 #define DECLARE_ICH_DEV(udma) \
339         { \
340                 .name           = DRV_NAME, \
341                 .init_chipset   = init_chipset_ich, \
342                 .init_hwif      = init_hwif_piix, \
343                 .enablebits     = {{0x41,0x80,0x80}, {0x43,0x80,0x80}}, \
344                 .port_ops       = &ich_port_ops, \
345                 .host_flags     = IDE_HFLAGS_PIIX, \
346                 .pio_mask       = ATA_PIO4, \
347                 .swdma_mask     = ATA_SWDMA2_ONLY, \
348                 .mwdma_mask     = ATA_MWDMA12_ONLY, \
349                 .udma_mask      = udma, \
350         }
351
352 static const struct ide_port_info piix_pci_info[] __devinitdata = {
353         /* 0: MPIIX */
354         {       /*
355                  * MPIIX actually has only a single IDE channel mapped to
356                  * the primary or secondary ports depending on the value
357                  * of the bit 14 of the IDETIM register at offset 0x6c
358                  */
359                 .name           = DRV_NAME,
360                 .enablebits     = {{0x6d,0xc0,0x80}, {0x6d,0xc0,0xc0}},
361                 .host_flags     = IDE_HFLAG_ISA_PORTS | IDE_HFLAG_NO_DMA |
362                                   IDE_HFLAGS_PIIX,
363                 .pio_mask       = ATA_PIO4,
364                 /* This is a painful system best to let it self tune for now */
365         },
366         /* 1: PIIXa/PIIXb/PIIX3 */
367         DECLARE_PIIX_DEV(0x00), /* no udma */
368         /* 2: PIIX4 */
369         DECLARE_PIIX_DEV(ATA_UDMA2),
370         /* 3: ICH0 */
371         DECLARE_ICH_DEV(ATA_UDMA2),
372         /* 4: ICH */
373         DECLARE_ICH_DEV(ATA_UDMA4),
374         /* 5: PIIX4 */
375         DECLARE_PIIX_DEV(ATA_UDMA4),
376         /* 6: ICH[2-7]/ICH[2-3]M/C-ICH/ICH5-SATA/ESB2/ICH8M */
377         DECLARE_ICH_DEV(ATA_UDMA5),
378 };
379
380 /**
381  *      piix_init_one   -       called when a PIIX is found
382  *      @dev: the piix device
383  *      @id: the matching pci id
384  *
385  *      Called when the PCI registration layer (or the IDE initialization)
386  *      finds a device matching our IDE device tables.
387  */
388  
389 static int __devinit piix_init_one(struct pci_dev *dev, const struct pci_device_id *id)
390 {
391         return ide_pci_init_one(dev, &piix_pci_info[id->driver_data], NULL);
392 }
393
394 /**
395  *      piix_check_450nx        -       Check for problem 450NX setup
396  *      
397  *      Check for the present of 450NX errata #19 and errata #25. If
398  *      they are found, disable use of DMA IDE
399  */
400
401 static void __devinit piix_check_450nx(void)
402 {
403         struct pci_dev *pdev = NULL;
404         u16 cfg;
405         while((pdev=pci_get_device(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82454NX, pdev))!=NULL)
406         {
407                 /* Look for 450NX PXB. Check for problem configurations
408                    A PCI quirk checks bit 6 already */
409                 pci_read_config_word(pdev, 0x41, &cfg);
410                 /* Only on the original revision: IDE DMA can hang */
411                 if (pdev->revision == 0x00)
412                         no_piix_dma = 1;
413                 /* On all revisions below 5 PXB bus lock must be disabled for IDE */
414                 else if (cfg & (1<<14) && pdev->revision < 5)
415                         no_piix_dma = 2;
416         }
417         if(no_piix_dma)
418                 printk(KERN_WARNING DRV_NAME ": 450NX errata present, disabling IDE DMA.\n");
419         if(no_piix_dma == 2)
420                 printk(KERN_WARNING DRV_NAME ": A BIOS update may resolve this.\n");
421 }               
422
423 static const struct pci_device_id piix_pci_tbl[] = {
424         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371FB_0),  1 },
425         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371FB_1),  1 },
426         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371MX),    0 },
427         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371SB_1),  1 },
428         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82371AB),    2 },
429         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801AB_1),  3 },
430         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82443MX_1),  2 },
431         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801AA_1),  4 },
432         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82372FB_1),  5 },
433         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82451NX),    2 },
434         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801BA_9),  6 },
435         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801BA_8),  6 },
436         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801CA_10), 6 },
437         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801CA_11), 6 },
438         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_11), 6 },
439         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801EB_11), 6 },
440         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801E_11),  6 },
441         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_10), 6 },
442 #ifdef CONFIG_BLK_DEV_IDE_SATA
443         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801EB_1),  6 },
444 #endif
445         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ESB_2),      6 },
446         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH6_19),    6 },
447         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH7_21),    6 },
448         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_82801DB_1),  6 },
449         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ESB2_18),    6 },
450         { PCI_VDEVICE(INTEL, PCI_DEVICE_ID_INTEL_ICH8_6),     6 },
451         { 0, },
452 };
453 MODULE_DEVICE_TABLE(pci, piix_pci_tbl);
454
455 static struct pci_driver piix_pci_driver = {
456         .name           = "PIIX_IDE",
457         .id_table       = piix_pci_tbl,
458         .probe          = piix_init_one,
459         .remove         = ide_pci_remove,
460         .suspend        = ide_pci_suspend,
461         .resume         = ide_pci_resume,
462 };
463
464 static int __init piix_ide_init(void)
465 {
466         piix_check_450nx();
467         return ide_pci_register_driver(&piix_pci_driver);
468 }
469
470 static void __exit piix_ide_exit(void)
471 {
472         pci_unregister_driver(&piix_pci_driver);
473 }
474
475 module_init(piix_ide_init);
476 module_exit(piix_ide_exit);
477
478 MODULE_AUTHOR("Andre Hedrick, Andrzej Krzysztofowicz");
479 MODULE_DESCRIPTION("PCI driver module for Intel PIIX IDE");
480 MODULE_LICENSE("GPL");