drivers/ide/pci/cs5530.c

   1 /*
   2  * Copyright (C) 2000                   Andre Hedrick <andre@linux-ide.org>
   3  * Copyright (C) 2000                   Mark Lord <mlord@pobox.com>
   4  * Copyright (C) 2007                   Bartlomiej Zolnierkiewicz
   5  *
   6  * May be copied or modified under the terms of the GNU General Public License
   7  *
   8  * Development of this chipset driver was funded
   9  * by the nice folks at National Semiconductor.
  10  *
  11  * Documentation:
  12  *      CS5530 documentation available from National Semiconductor.
  13  */
  14
  15 #include <linux/module.h>
  16 #include <linux/types.h>
  17 #include <linux/kernel.h>
  18 #include <linux/delay.h>
  19 #include <linux/timer.h>
  20 #include <linux/mm.h>
  21 #include <linux/ioport.h>
  22 #include <linux/blkdev.h>
  23 #include <linux/hdreg.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/pci.h>
  26 #include <linux/init.h>
  27 #include <linux/ide.h>
  28 #include <asm/io.h>
  29 #include <asm/irq.h>
  30
  31 /*
  32  * Here are the standard PIO mode 0-4 timings for each "format".
  33  * Format-0 uses fast data reg timings, with slower command reg timings.
  34  * Format-1 uses fast timings for all registers, but won't work with all drives.
  35  */
  36 static unsigned int cs5530_pio_timings[2][5] = {
  37         {0x00009172, 0x00012171, 0x00020080, 0x00032010, 0x00040010},
  38         {0xd1329172, 0x71212171, 0x30200080, 0x20102010, 0x00100010}
  39 };
  40
  41 /*
  42  * After chip reset, the PIO timings are set to 0x0000e132, which is not valid.
  43  */
  44 #define CS5530_BAD_PIO(timings) (((timings)&~0x80000000)==0x0000e132)
  45 #define CS5530_BASEREG(hwif)    (((hwif)->dma_base & ~0xf) + ((hwif)->channel ? 0x30 : 0x20))
  46
  47 /**
  48  *      cs5530_set_pio_mode     -       set host controller for PIO mode
  49  *      @drive: drive
  50  *      @pio: PIO mode number
  51  *
  52  *      Handles setting of PIO mode for the chipset.
  53  *
  54  *      The init_hwif_cs5530() routine guarantees that all drives
  55  *      will have valid default PIO timings set up before we get here.
  56  */
  57
  58 static void cs5530_set_pio_mode(ide_drive_t *drive, const u8 pio)
  59 {
  60         unsigned long basereg = CS5530_BASEREG(drive->hwif);
  61         unsigned int format = (inl(basereg + 4) >> 31) & 1;
  62
  63         outl(cs5530_pio_timings[format][pio], basereg + ((drive->dn & 1)<<3));
  64 }
  65
  66 /**
  67  *      cs5530_udma_filter      -       UDMA filter
  68  *      @drive: drive
  69  *
  70  *      cs5530_udma_filter() does UDMA mask filtering for the given drive
  71  *      taking into the consideration capabilities of the mate device.
  72  *
  73  *      The CS5530 specifies that two drives sharing a cable cannot mix
  74  *      UDMA/MDMA.  It has to be one or the other, for the pair, though
  75  *      different timings can still be chosen for each drive.  We could
  76  *      set the appropriate timing bits on the fly, but that might be
  77  *      a bit confusing.  So, for now we statically handle this requirement
  78  *      by looking at our mate drive to see what it is capable of, before
  79  *      choosing a mode for our own drive.
  80  *
  81  *      Note: This relies on the fact we never fail from UDMA to MWDMA2
  82  *      but instead drop to PIO.
  83  */
  84
  85 static u8 cs5530_udma_filter(ide_drive_t *drive)
  86 {
  87         ide_hwif_t *hwif = drive->hwif;
  88         ide_drive_t *mate = &hwif->drives[(drive->dn & 1) ^ 1];
  89         struct hd_driveid *mateid = mate->id;
  90         u8 mask = hwif->ultra_mask;
  91
  92         if (mate->present == 0)
  93                 goto out;
  94
  95         if ((mateid->capability & 1) && __ide_dma_bad_drive(mate) == 0) {
  96                 if ((mateid->field_valid & 4) && (mateid->dma_ultra & 7))
  97                         goto out;
  98                 if ((mateid->field_valid & 2) && (mateid->dma_mword & 7))
  99                         mask = 0;
 100         }
 101 out:
 102         return mask;
 103 }
 104
 105 static void cs5530_set_dma_mode(ide_drive_t *drive, const u8 mode)
 106 {
 107         unsigned long basereg;
 108         unsigned int reg, timings = 0;
 109
 110         switch (mode) {
 111                 case XFER_UDMA_0:       timings = 0x00921250; break;
 112                 case XFER_UDMA_1:       timings = 0x00911140; break;
 113                 case XFER_UDMA_2:       timings = 0x00911030; break;
 114                 case XFER_MW_DMA_0:     timings = 0x00077771; break;
 115                 case XFER_MW_DMA_1:     timings = 0x00012121; break;
 116                 case XFER_MW_DMA_2:     timings = 0x00002020; break;
 117         }
 118         basereg = CS5530_BASEREG(drive->hwif);
 119         reg = inl(basereg + 4);                 /* get drive0 config register */
 120         timings |= reg & 0x80000000;            /* preserve PIO format bit */
 121         if ((drive-> dn & 1) == 0) {            /* are we configuring drive0? */
 122                 outl(timings, basereg + 4);     /* write drive0 config register */
 123         } else {
 124                 if (timings & 0x00100000)
 125                         reg |=  0x00100000;     /* enable UDMA timings for both drives */
 126                 else
 127                         reg &= ~0x00100000;     /* disable UDMA timings for both drives */
 128                 outl(reg, basereg + 4);         /* write drive0 config register */
 129                 outl(timings, basereg + 12);    /* write drive1 config register */
 130         }
 131 }
 132
 133 /**
 134  *      init_chipset_5530       -       set up 5530 bridge
 135  *      @dev: PCI device
 136  *      @name: device name
 137  *
 138  *      Initialize the cs5530 bridge for reliable IDE DMA operation.
 139  */
 140
 141 static unsigned int __devinit init_chipset_cs5530 (struct pci_dev *dev, const char *name)
 142 {
 143         struct pci_dev *master_0 = NULL, *cs5530_0 = NULL;
 144
 145         if (pci_resource_start(dev, 4) == 0)
 146                 return -EFAULT;
 147
 148         dev = NULL;
 149         while ((dev = pci_get_device(PCI_VENDOR_ID_CYRIX, PCI_ANY_ID, dev)) != NULL) {
 150                 switch (dev->device) {
 151                         case PCI_DEVICE_ID_CYRIX_PCI_MASTER:
 152                                 master_0 = pci_dev_get(dev);
 153                                 break;
 154                         case PCI_DEVICE_ID_CYRIX_5530_LEGACY:
 155                                 cs5530_0 = pci_dev_get(dev);
 156                                 break;
 157                 }
 158         }
 159         if (!master_0) {
 160                 printk(KERN_ERR "%s: unable to locate PCI MASTER function\n", name);
 161                 goto out;
 162         }
 163         if (!cs5530_0) {
 164                 printk(KERN_ERR "%s: unable to locate CS5530 LEGACY function\n", name);
 165                 goto out;
 166         }
 167
 168         /*
 169          * Enable BusMaster and MemoryWriteAndInvalidate for the cs5530:
 170          * -->  OR 0x14 into 16-bit PCI COMMAND reg of function 0 of the cs5530
 171          */
 172
 173         pci_set_master(cs5530_0);
 174         pci_try_set_mwi(cs5530_0);
 175
 176         /*
 177          * Set PCI CacheLineSize to 16-bytes:
 178          * --> Write 0x04 into 8-bit PCI CACHELINESIZE reg of function 0 of the cs5530
 179          */
 180
 181         pci_write_config_byte(cs5530_0, PCI_CACHE_LINE_SIZE, 0x04);
 182
 183         /*
 184          * Disable trapping of UDMA register accesses (Win98 hack):
 185          * --> Write 0x5006 into 16-bit reg at offset 0xd0 of function 0 of the cs5530
 186          */
 187
 188         pci_write_config_word(cs5530_0, 0xd0, 0x5006);
 189
 190         /*
 191          * Bit-1 at 0x40 enables MemoryWriteAndInvalidate on internal X-bus:
 192          * The other settings are what is necessary to get the register
 193          * into a sane state for IDE DMA operation.
 194          */
 195
 196         pci_write_config_byte(master_0, 0x40, 0x1e);
 197
 198         /*
 199          * Set max PCI burst size (16-bytes seems to work best):
 200          *         16bytes: set bit-1 at 0x41 (reg value of 0x16)
 201          *      all others: clear bit-1 at 0x41, and do:
 202          *        128bytes: OR 0x00 at 0x41
 203          *        256bytes: OR 0x04 at 0x41
 204          *        512bytes: OR 0x08 at 0x41
 205          *       1024bytes: OR 0x0c at 0x41
 206          */
 207
 208         pci_write_config_byte(master_0, 0x41, 0x14);
 209
 210         /*
 211          * These settings are necessary to get the chip
 212          * into a sane state for IDE DMA operation.
 213          */
 214
 215         pci_write_config_byte(master_0, 0x42, 0x00);
 216         pci_write_config_byte(master_0, 0x43, 0xc1);
 217
 218 out:
 219         pci_dev_put(master_0);
 220         pci_dev_put(cs5530_0);
 221         return 0;
 222 }
 223
 224 /**
 225  *      init_hwif_cs5530        -       initialise an IDE channel
 226  *      @hwif: IDE to initialize
 227  *
 228  *      This gets invoked by the IDE driver once for each channel. It
 229  *      performs channel-specific pre-initialization before drive probing.
 230  */
 231
 232 static void __devinit init_hwif_cs5530 (ide_hwif_t *hwif)
 233 {
 234         unsigned long basereg;
 235         u32 d0_timings;
 236
 237         hwif->set_pio_mode = &cs5530_set_pio_mode;
 238         hwif->set_dma_mode = &cs5530_set_dma_mode;
 239
 240         basereg = CS5530_BASEREG(hwif);
 241         d0_timings = inl(basereg + 0);
 242         if (CS5530_BAD_PIO(d0_timings))
 243                 outl(cs5530_pio_timings[(d0_timings >> 31) & 1][0], basereg + 0);
 244         if (CS5530_BAD_PIO(inl(basereg + 8)))
 245                 outl(cs5530_pio_timings[(d0_timings >> 31) & 1][0], basereg + 8);
 246
 247         if (hwif->dma_base == 0)
 248                 return;
 249
 250         hwif->udma_filter = cs5530_udma_filter;
 251 }
 252
 253 static const struct ide_port_info cs5530_chipset __devinitdata = {
 254         .name           = "CS5530",
 255         .init_chipset   = init_chipset_cs5530,
 256         .init_hwif      = init_hwif_cs5530,
 257         .host_flags     = IDE_HFLAG_SERIALIZE |
 258                           IDE_HFLAG_POST_SET_MODE |
 259                           IDE_HFLAG_BOOTABLE,
 260         .pio_mask       = ATA_PIO4,
 261         .mwdma_mask     = ATA_MWDMA2,
 262         .udma_mask      = ATA_UDMA2,
 263 };
 264
 265 static int __devinit cs5530_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 266 {
 267         return ide_setup_pci_device(dev, &cs5530_chipset);
 268 }
 269
 270 static const struct pci_device_id cs5530_pci_tbl[] = {
 271         { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5530_IDE), 0 },
 272         { 0, },
 273 };
 274 MODULE_DEVICE_TABLE(pci, cs5530_pci_tbl);
 275
 276 static struct pci_driver driver = {
 277         .name           = "CS5530 IDE",
 278         .id_table       = cs5530_pci_tbl,
 279         .probe          = cs5530_init_one,
 280 };
 281
 282 static int __init cs5530_ide_init(void)
 283 {
 284         return ide_pci_register_driver(&driver);
 285 }
 286
 287 module_init(cs5530_ide_init);
 288
 289 MODULE_AUTHOR("Mark Lord");
 290 MODULE_DESCRIPTION("PCI driver module for Cyrix/NS 5530 IDE");
 291 MODULE_LICENSE("GPL");