drivers/ata/pata_sl82c105.c

   1 /*
   2  * pata_sl82c105.c      - SL82C105 PATA for new ATA layer
   3  *                        (C) 2005 Red Hat Inc
   4  *                        Alan Cox <alan@redhat.com>
   5  *
   6  * Based in part on linux/drivers/ide/pci/sl82c105.c
   7  *              SL82C105/Winbond 553 IDE driver
   8  *
   9  * and in part on the documentation and errata sheet
  10  *
  11  *
  12  * Note: The controller like many controllers has shared timings for
  13  * PIO and DMA. We thus flip to the DMA timings in dma_start and flip back
  14  * in the dma_stop function. Thus we actually don't need a set_dmamode
  15  * method as the PIO method is always called and will set the right PIO
  16  * timing parameters.
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/pci.h>
  22 #include <linux/init.h>
  23 #include <linux/blkdev.h>
  24 #include <linux/delay.h>
  25 #include <scsi/scsi_host.h>
  26 #include <linux/libata.h>
  27
  28 #define DRV_NAME "pata_sl82c105"
  29 #define DRV_VERSION "0.3.0"
  30
  31 enum {
  32         /*
  33          * SL82C105 PCI config register 0x40 bits.
  34          */
  35         CTRL_IDE_IRQB   =       (1 << 30),
  36         CTRL_IDE_IRQA   =       (1 << 28),
  37         CTRL_LEGIRQ     =       (1 << 11),
  38         CTRL_P1F16      =       (1 << 5),
  39         CTRL_P1EN       =       (1 << 4),
  40         CTRL_P0F16      =       (1 << 1),
  41         CTRL_P0EN       =       (1 << 0)
  42 };
  43
  44 /**
  45  *      sl82c105_pre_reset              -       probe begin
  46  *      @ap: ATA port
  47  *
  48  *      Set up cable type and use generic probe init
  49  */
  50
  51 static int sl82c105_pre_reset(struct ata_port *ap)
  52 {
  53         static const struct pci_bits sl82c105_enable_bits[] = {
  54                 { 0x40, 1, 0x01, 0x01 },
  55                 { 0x40, 1, 0x10, 0x10 }
  56         };
  57         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
  58
  59         if (ap->port_no && !pci_test_config_bits(pdev, &sl82c105_enable_bits[ap->port_no]))
  60                 return -ENOENT;
  61         return ata_std_prereset(ap);
  62 }
  63
  64
  65 static void sl82c105_error_handler(struct ata_port *ap)
  66 {
  67         ata_bmdma_drive_eh(ap, sl82c105_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
  68 }
  69
  70
  71 /**
  72  *      sl82c105_configure_piomode      -       set chip PIO timing
  73  *      @ap: ATA interface
  74  *      @adev: ATA device
  75  *      @pio: PIO mode
  76  *
  77  *      Called to do the PIO mode setup. Our timing registers are shared
  78  *      so a configure_dmamode call will undo any work we do here and vice
  79  *      versa
  80  */
  81
  82 static void sl82c105_configure_piomode(struct ata_port *ap, struct ata_device *adev, int pio)
  83 {
  84         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
  85         static u16 pio_timing[5] = {
  86                 0x50D, 0x407, 0x304, 0x242, 0x240
  87         };
  88         u16 dummy;
  89         int timing = 0x44 + (8 * ap->port_no) + (4 * adev->devno);
  90
  91         pci_write_config_word(pdev, timing, pio_timing[pio]);
  92         /* Can we lose this oddity of the old driver */
  93         pci_read_config_word(pdev, timing, &dummy);
  94 }
  95
  96 /**
  97  *      sl82c105_set_piomode    -       set initial PIO mode data
  98  *      @ap: ATA interface
  99  *      @adev: ATA device
 100  *
 101  *      Called to do the PIO mode setup. Our timing registers are shared
 102  *      but we want to set the PIO timing by default.
 103  */
 104
 105 static void sl82c105_set_piomode(struct ata_port *ap, struct ata_device *adev)
 106 {
 107         sl82c105_configure_piomode(ap, adev, adev->pio_mode - XFER_PIO_0);
 108 }
 109
 110 /**
 111  *      sl82c105_configure_dmamode      -       set DMA mode in chip
 112  *      @ap: ATA interface
 113  *      @adev: ATA device
 114  *
 115  *      Load DMA cycle times into the chip ready for a DMA transfer
 116  *      to occur.
 117  */
 118
 119 static void sl82c105_configure_dmamode(struct ata_port *ap, struct ata_device *adev)
 120 {
 121         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 122         static u16 dma_timing[3] = {
 123                 0x707, 0x201, 0x200
 124         };
 125         u16 dummy;
 126         int timing = 0x44 + (8 * ap->port_no) + (4 * adev->devno);
 127         int dma = adev->dma_mode - XFER_MW_DMA_0;
 128
 129         pci_write_config_word(pdev, timing, dma_timing[dma]);
 130         /* Can we lose this oddity of the old driver */
 131         pci_read_config_word(pdev, timing, &dummy);
 132 }
 133
 134 /**
 135  *      sl82c105_reset_engine   -       Reset the DMA engine
 136  *      @ap: ATA interface
 137  *
 138  *      The sl82c105 has some serious problems with the DMA engine
 139  *      when transfers don't run as expected or ATAPI is used. The
 140  *      recommended fix is to reset the engine each use using a chip
 141  *      test register.
 142  */
 143
 144 static void sl82c105_reset_engine(struct ata_port *ap)
 145 {
 146         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 147         u16 val;
 148
 149         pci_read_config_word(pdev, 0x7E, &val);
 150         pci_write_config_word(pdev, 0x7E, val | 4);
 151         pci_write_config_word(pdev, 0x7E, val & ~4);
 152 }
 153
 154 /**
 155  *      sl82c105_bmdma_start            -       DMA engine begin
 156  *      @qc: ATA command
 157  *
 158  *      Reset the DMA engine each use as recommended by the errata
 159  *      document.
 160  *
 161  *      FIXME: if we switch clock at BMDMA start/end we might get better
 162  *      PIO performance on DMA capable devices.
 163  */
 164
 165 static void sl82c105_bmdma_start(struct ata_queued_cmd *qc)
 166 {
 167         struct ata_port *ap = qc->ap;
 168
 169         udelay(100);
 170         sl82c105_reset_engine(ap);
 171         udelay(100);
 172
 173         /* Set the clocks for DMA */
 174         sl82c105_configure_dmamode(ap, qc->dev);
 175         /* Activate DMA */
 176         ata_bmdma_start(qc);
 177 }
 178
 179 /**
 180  *      sl82c105_bmdma_end              -       DMA engine stop
 181  *      @qc: ATA command
 182  *
 183  *      Reset the DMA engine each use as recommended by the errata
 184  *      document.
 185  *
 186  *      This function is also called to turn off DMA when a timeout occurs
 187  *      during DMA operation. In both cases we need to reset the engine,
 188  *      so no actual eng_timeout handler is required.
 189  *
 190  *      We assume bmdma_stop is always called if bmdma_start as called. If
 191  *      not then we may need to wrap qc_issue.
 192  */
 193
 194 static void sl82c105_bmdma_stop(struct ata_queued_cmd *qc)
 195 {
 196         struct ata_port *ap = qc->ap;
 197
 198         ata_bmdma_stop(qc);
 199         sl82c105_reset_engine(ap);
 200         udelay(100);
 201
 202         /* This will redo the initial setup of the DMA device to matching
 203            PIO timings */
 204         sl82c105_set_piomode(ap, qc->dev);
 205 }
 206
 207 static struct scsi_host_template sl82c105_sht = {
 208         .module                 = THIS_MODULE,
 209         .name                   = DRV_NAME,
 210         .ioctl                  = ata_scsi_ioctl,
 211         .queuecommand           = ata_scsi_queuecmd,
 212         .can_queue              = ATA_DEF_QUEUE,
 213         .this_id                = ATA_SHT_THIS_ID,
 214         .sg_tablesize           = LIBATA_MAX_PRD,
 215         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 216         .emulated               = ATA_SHT_EMULATED,
 217         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 218         .proc_name              = DRV_NAME,
 219         .dma_boundary           = ATA_DMA_BOUNDARY,
 220         .slave_configure        = ata_scsi_slave_config,
 221         .slave_destroy          = ata_scsi_slave_destroy,
 222         .bios_param             = ata_std_bios_param,
 223 };
 224
 225 static struct ata_port_operations sl82c105_port_ops = {
 226         .port_disable   = ata_port_disable,
 227         .set_piomode    = sl82c105_set_piomode,
 228         .mode_filter    = ata_pci_default_filter,
 229
 230         .tf_load        = ata_tf_load,
 231         .tf_read        = ata_tf_read,
 232         .check_status   = ata_check_status,
 233         .exec_command   = ata_exec_command,
 234         .dev_select     = ata_std_dev_select,
 235
 236         .freeze         = ata_bmdma_freeze,
 237         .thaw           = ata_bmdma_thaw,
 238         .error_handler  = sl82c105_error_handler,
 239         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 240         .cable_detect   = ata_cable_40wire,
 241
 242         .bmdma_setup    = ata_bmdma_setup,
 243         .bmdma_start    = sl82c105_bmdma_start,
 244         .bmdma_stop     = sl82c105_bmdma_stop,
 245         .bmdma_status   = ata_bmdma_status,
 246
 247         .qc_prep        = ata_qc_prep,
 248         .qc_issue       = ata_qc_issue_prot,
 249
 250         .data_xfer      = ata_data_xfer,
 251
 252         .irq_handler    = ata_interrupt,
 253         .irq_clear      = ata_bmdma_irq_clear,
 254         .irq_on         = ata_irq_on,
 255         .irq_ack        = ata_irq_ack,
 256
 257         .port_start     = ata_port_start,
 258 };
 259
 260 /**
 261  *      sl82c105_bridge_revision        -       find bridge version
 262  *      @pdev: PCI device for the ATA function
 263  *
 264  *      Locates the PCI bridge associated with the ATA function and
 265  *      providing it is a Winbond 553 reports the revision. If it cannot
 266  *      find a revision or the right device it returns -1
 267  */
 268
 269 static int sl82c105_bridge_revision(struct pci_dev *pdev)
 270 {
 271         struct pci_dev *bridge;
 272         u8 rev;
 273
 274         /*
 275          * The bridge should be part of the same device, but function 0.
 276          */
 277         bridge = pci_get_slot(pdev->bus,
 278                                PCI_DEVFN(PCI_SLOT(pdev->devfn), 0));
 279         if (!bridge)
 280                 return -1;
 281
 282         /*
 283          * Make sure it is a Winbond 553 and is an ISA bridge.
 284          */
 285         if (bridge->vendor != PCI_VENDOR_ID_WINBOND ||
 286             bridge->device != PCI_DEVICE_ID_WINBOND_83C553 ||
 287             bridge->class >> 8 != PCI_CLASS_BRIDGE_ISA) {
 288                 pci_dev_put(bridge);
 289                 return -1;
 290         }
 291         /*
 292          * We need to find function 0's revision, not function 1
 293          */
 294         pci_read_config_byte(bridge, PCI_REVISION_ID, &rev);
 295
 296         pci_dev_put(bridge);
 297         return rev;
 298 }
 299
 300
 301 static int sl82c105_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 302 {
 303         static struct ata_port_info info_dma = {
 304                 .sht = &sl82c105_sht,
 305                 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 306                 .pio_mask = 0x1f,
 307                 .mwdma_mask = 0x07,
 308                 .port_ops = &sl82c105_port_ops
 309         };
 310         static struct ata_port_info info_early = {
 311                 .sht = &sl82c105_sht,
 312                 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 313                 .pio_mask = 0x1f,
 314                 .port_ops = &sl82c105_port_ops
 315         };
 316         static struct ata_port_info *port_info[2] = { &info_early, &info_early };
 317         u32 val;
 318         int rev;
 319
 320         rev = sl82c105_bridge_revision(dev);
 321
 322         if (rev == -1)
 323                 dev_printk(KERN_WARNING, &dev->dev, "pata_sl82c105: Unable to find bridge, disabling DMA.\n");
 324         else if (rev <= 5)
 325                 dev_printk(KERN_WARNING, &dev->dev, "pata_sl82c105: Early bridge revision, no DMA available.\n");
 326         else {
 327                 port_info[0] = &info_dma;
 328                 port_info[1] = &info_dma;
 329         }
 330
 331         pci_read_config_dword(dev, 0x40, &val);
 332         val |= CTRL_P0EN | CTRL_P0F16 | CTRL_P1F16;
 333         pci_write_config_dword(dev, 0x40, val);
 334
 335
 336         return ata_pci_init_one(dev, port_info, 1); /* For now */
 337 }
 338
 339 static const struct pci_device_id sl82c105[] = {
 340         { PCI_VDEVICE(WINBOND, PCI_DEVICE_ID_WINBOND_82C105), },
 341
 342         { },
 343 };
 344
 345 static struct pci_driver sl82c105_pci_driver = {
 346         .name           = DRV_NAME,
 347         .id_table       = sl82c105,
 348         .probe          = sl82c105_init_one,
 349         .remove         = ata_pci_remove_one
 350 };
 351
 352 static int __init sl82c105_init(void)
 353 {
 354         return pci_register_driver(&sl82c105_pci_driver);
 355 }
 356
 357 static void __exit sl82c105_exit(void)
 358 {
 359         pci_unregister_driver(&sl82c105_pci_driver);
 360 }
 361
 362 MODULE_AUTHOR("Alan Cox");
 363 MODULE_DESCRIPTION("low-level driver for Sl82c105");
 364 MODULE_LICENSE("GPL");
 365 MODULE_DEVICE_TABLE(pci, sl82c105);
 366 MODULE_VERSION(DRV_VERSION);
 367
 368 module_init(sl82c105_init);
 369 module_exit(sl82c105_exit);