drivers/scsi/sata_promise.c

   1 /*
   2  *  sata_promise.c - Promise SATA
   3  *
   4  *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
   5  *                  Please ALWAYS copy linux-ide@vger.kernel.org
   6  *                  on emails.
   7  *
   8  *  Copyright 2003-2004 Red Hat, Inc.
   9  *
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2, or (at your option)
  14  *  any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; see the file COPYING.  If not, write to
  23  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *
  25  *
  26  *  libata documentation is available via 'make {ps|pdf}docs',
  27  *  as Documentation/DocBook/libata.*
  28  *
  29  *  Hardware information only available under NDA.
  30  *
  31  */
  32
  33 #include <linux/kernel.h>
  34 #include <linux/module.h>
  35 #include <linux/pci.h>
  36 #include <linux/init.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/delay.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/sched.h>
  41 #include "scsi.h"
  42 #include <scsi/scsi_host.h>
  43 #include <linux/libata.h>
  44 #include <asm/io.h>
  45 #include "sata_promise.h"
  46
  47 #define DRV_NAME        "sata_promise"
  48 #define DRV_VERSION     "1.02"
  49
  50
  51 enum {
  52         PDC_PKT_SUBMIT          = 0x40, /* Command packet pointer addr */
  53         PDC_INT_SEQMASK         = 0x40, /* Mask of asserted SEQ INTs */
  54         PDC_TBG_MODE            = 0x41, /* TBG mode */
  55         PDC_FLASH_CTL           = 0x44, /* Flash control register */
  56         PDC_PCI_CTL             = 0x48, /* PCI control and status register */
  57         PDC_GLOBAL_CTL          = 0x48, /* Global control/status (per port) */
  58         PDC_CTLSTAT             = 0x60, /* IDE control and status (per port) */
  59         PDC_SATA_PLUG_CSR       = 0x6C, /* SATA Plug control/status reg */
  60         PDC_SLEW_CTL            = 0x470, /* slew rate control reg */
  61
  62         PDC_ERR_MASK            = (1<<19) | (1<<20) | (1<<21) | (1<<22) |
  63                                   (1<<8) | (1<<9) | (1<<10),
  64
  65         board_2037x             = 0,    /* FastTrak S150 TX2plus */
  66         board_20319             = 1,    /* FastTrak S150 TX4 */
  67         board_20619             = 2,    /* FastTrak TX4000 */
  68
  69         PDC_HAS_PATA            = (1 << 1), /* PDC20375 has PATA */
  70
  71         PDC_RESET               = (1 << 11), /* HDMA reset */
  72 };
  73
  74
  75 struct pdc_port_priv {
  76         u8                      *pkt;
  77         dma_addr_t              pkt_dma;
  78 };
  79
  80 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg);
  81 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
  82 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
  83 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
  84 static void pdc_eng_timeout(struct ata_port *ap);
  85 static int pdc_port_start(struct ata_port *ap);
  86 static void pdc_port_stop(struct ata_port *ap);
  87 static void pdc_pata_phy_reset(struct ata_port *ap);
  88 static void pdc_sata_phy_reset(struct ata_port *ap);
  89 static void pdc_qc_prep(struct ata_queued_cmd *qc);
  90 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
  91 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
  92 static void pdc_irq_clear(struct ata_port *ap);
  93 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc);
  94
  95
  96 static Scsi_Host_Template pdc_ata_sht = {
  97         .module                 = THIS_MODULE,
  98         .name                   = DRV_NAME,
  99         .ioctl                  = ata_scsi_ioctl,
 100         .queuecommand           = ata_scsi_queuecmd,
 101         .eh_strategy_handler    = ata_scsi_error,
 102         .can_queue              = ATA_DEF_QUEUE,
 103         .this_id                = ATA_SHT_THIS_ID,
 104         .sg_tablesize           = LIBATA_MAX_PRD,
 105         .max_sectors            = ATA_MAX_SECTORS,
 106         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 107         .emulated               = ATA_SHT_EMULATED,
 108         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 109         .proc_name              = DRV_NAME,
 110         .dma_boundary           = ATA_DMA_BOUNDARY,
 111         .slave_configure        = ata_scsi_slave_config,
 112         .bios_param             = ata_std_bios_param,
 113         .ordered_flush          = 1,
 114 };
 115
 116 static const struct ata_port_operations pdc_sata_ops = {
 117         .port_disable           = ata_port_disable,
 118         .tf_load                = pdc_tf_load_mmio,
 119         .tf_read                = ata_tf_read,
 120         .check_status           = ata_check_status,
 121         .exec_command           = pdc_exec_command_mmio,
 122         .dev_select             = ata_std_dev_select,
 123
 124         .phy_reset              = pdc_sata_phy_reset,
 125
 126         .qc_prep                = pdc_qc_prep,
 127         .qc_issue               = pdc_qc_issue_prot,
 128         .eng_timeout            = pdc_eng_timeout,
 129         .irq_handler            = pdc_interrupt,
 130         .irq_clear              = pdc_irq_clear,
 131
 132         .scr_read               = pdc_sata_scr_read,
 133         .scr_write              = pdc_sata_scr_write,
 134         .port_start             = pdc_port_start,
 135         .port_stop              = pdc_port_stop,
 136         .host_stop              = ata_pci_host_stop,
 137 };
 138
 139 static const struct ata_port_operations pdc_pata_ops = {
 140         .port_disable           = ata_port_disable,
 141         .tf_load                = pdc_tf_load_mmio,
 142         .tf_read                = ata_tf_read,
 143         .check_status           = ata_check_status,
 144         .exec_command           = pdc_exec_command_mmio,
 145         .dev_select             = ata_std_dev_select,
 146
 147         .phy_reset              = pdc_pata_phy_reset,
 148
 149         .qc_prep                = pdc_qc_prep,
 150         .qc_issue               = pdc_qc_issue_prot,
 151         .eng_timeout            = pdc_eng_timeout,
 152         .irq_handler            = pdc_interrupt,
 153         .irq_clear              = pdc_irq_clear,
 154
 155         .port_start             = pdc_port_start,
 156         .port_stop              = pdc_port_stop,
 157         .host_stop              = ata_pci_host_stop,
 158 };
 159
 160 static struct ata_port_info pdc_port_info[] = {
 161         /* board_2037x */
 162         {
 163                 .sht            = &pdc_ata_sht,
 164                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
 165                                   ATA_FLAG_SRST | ATA_FLAG_MMIO |
 166                                   ATA_FLAG_PIO_POLLING,
 167                 .pio_mask       = 0x1f, /* pio0-4 */
 168                 .mwdma_mask     = 0x07, /* mwdma0-2 */
 169                 .udma_mask      = 0x7f, /* udma0-6 ; FIXME */
 170                 .port_ops       = &pdc_sata_ops,
 171         },
 172
 173         /* board_20319 */
 174         {
 175                 .sht            = &pdc_ata_sht,
 176                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
 177                                   ATA_FLAG_SRST | ATA_FLAG_MMIO |
 178                                   ATA_FLAG_PIO_POLLING,
 179                 .pio_mask       = 0x1f, /* pio0-4 */
 180                 .mwdma_mask     = 0x07, /* mwdma0-2 */
 181                 .udma_mask      = 0x7f, /* udma0-6 ; FIXME */
 182                 .port_ops       = &pdc_sata_ops,
 183         },
 184
 185         /* board_20619 */
 186         {
 187                 .sht            = &pdc_ata_sht,
 188                 .host_flags     = ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST |
 189                                   ATA_FLAG_MMIO | ATA_FLAG_SLAVE_POSS |
 190                                   ATA_FLAG_PIO_POLLING,
 191                 .pio_mask       = 0x1f, /* pio0-4 */
 192                 .mwdma_mask     = 0x07, /* mwdma0-2 */
 193                 .udma_mask      = 0x7f, /* udma0-6 ; FIXME */
 194                 .port_ops       = &pdc_pata_ops,
 195         },
 196 };
 197
 198 static struct pci_device_id pdc_ata_pci_tbl[] = {
 199         { PCI_VENDOR_ID_PROMISE, 0x3371, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 200           board_2037x },
 201         { PCI_VENDOR_ID_PROMISE, 0x3571, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 202           board_2037x },
 203         { PCI_VENDOR_ID_PROMISE, 0x3373, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 204           board_2037x },
 205         { PCI_VENDOR_ID_PROMISE, 0x3375, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 206           board_2037x },
 207         { PCI_VENDOR_ID_PROMISE, 0x3376, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 208           board_2037x },
 209         { PCI_VENDOR_ID_PROMISE, 0x3574, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 210           board_2037x },
 211         { PCI_VENDOR_ID_PROMISE, 0x3d75, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 212           board_2037x },
 213
 214         { PCI_VENDOR_ID_PROMISE, 0x3318, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 215           board_20319 },
 216         { PCI_VENDOR_ID_PROMISE, 0x3319, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 217           board_20319 },
 218         { PCI_VENDOR_ID_PROMISE, 0x3519, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 219           board_20319 },
 220         { PCI_VENDOR_ID_PROMISE, 0x3d17, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 221           board_20319 },
 222         { PCI_VENDOR_ID_PROMISE, 0x3d18, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 223           board_20319 },
 224
 225         { PCI_VENDOR_ID_PROMISE, 0x6629, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
 226           board_20619 },
 227
 228         { }     /* terminate list */
 229 };
 230
 231
 232 static struct pci_driver pdc_ata_pci_driver = {
 233         .name                   = DRV_NAME,
 234         .id_table               = pdc_ata_pci_tbl,
 235         .probe                  = pdc_ata_init_one,
 236         .remove                 = ata_pci_remove_one,
 237 };
 238
 239
 240 static int pdc_port_start(struct ata_port *ap)
 241 {
 242         struct device *dev = ap->host_set->dev;
 243         struct pdc_port_priv *pp;
 244         int rc;
 245
 246         rc = ata_port_start(ap);
 247         if (rc)
 248                 return rc;
 249
 250         pp = kmalloc(sizeof(*pp), GFP_KERNEL);
 251         if (!pp) {
 252                 rc = -ENOMEM;
 253                 goto err_out;
 254         }
 255         memset(pp, 0, sizeof(*pp));
 256
 257         pp->pkt = dma_alloc_coherent(dev, 128, &pp->pkt_dma, GFP_KERNEL);
 258         if (!pp->pkt) {
 259                 rc = -ENOMEM;
 260                 goto err_out_kfree;
 261         }
 262
 263         ap->private_data = pp;
 264
 265         return 0;
 266
 267 err_out_kfree:
 268         kfree(pp);
 269 err_out:
 270         ata_port_stop(ap);
 271         return rc;
 272 }
 273
 274
 275 static void pdc_port_stop(struct ata_port *ap)
 276 {
 277         struct device *dev = ap->host_set->dev;
 278         struct pdc_port_priv *pp = ap->private_data;
 279
 280         ap->private_data = NULL;
 281         dma_free_coherent(dev, 128, pp->pkt, pp->pkt_dma);
 282         kfree(pp);
 283         ata_port_stop(ap);
 284 }
 285
 286
 287 static void pdc_reset_port(struct ata_port *ap)
 288 {
 289         void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_CTLSTAT;
 290         unsigned int i;
 291         u32 tmp;
 292
 293         for (i = 11; i > 0; i--) {
 294                 tmp = readl(mmio);
 295                 if (tmp & PDC_RESET)
 296                         break;
 297
 298                 udelay(100);
 299
 300                 tmp |= PDC_RESET;
 301                 writel(tmp, mmio);
 302         }
 303
 304         tmp &= ~PDC_RESET;
 305         writel(tmp, mmio);
 306         readl(mmio);    /* flush */
 307 }
 308
 309 static void pdc_sata_phy_reset(struct ata_port *ap)
 310 {
 311         pdc_reset_port(ap);
 312         sata_phy_reset(ap);
 313 }
 314
 315 static void pdc_pata_phy_reset(struct ata_port *ap)
 316 {
 317         /* FIXME: add cable detect.  Don't assume 40-pin cable */
 318         ap->cbl = ATA_CBL_PATA40;
 319         ap->udma_mask &= ATA_UDMA_MASK_40C;
 320
 321         pdc_reset_port(ap);
 322         ata_port_probe(ap);
 323         ata_bus_reset(ap);
 324 }
 325
 326 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
 327 {
 328         if (sc_reg > SCR_CONTROL)
 329                 return 0xffffffffU;
 330         return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
 331 }
 332
 333
 334 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
 335                                u32 val)
 336 {
 337         if (sc_reg > SCR_CONTROL)
 338                 return;
 339         writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
 340 }
 341
 342 static void pdc_qc_prep(struct ata_queued_cmd *qc)
 343 {
 344         struct pdc_port_priv *pp = qc->ap->private_data;
 345         unsigned int i;
 346
 347         VPRINTK("ENTER\n");
 348
 349         switch (qc->tf.protocol) {
 350         case ATA_PROT_DMA:
 351                 ata_qc_prep(qc);
 352                 /* fall through */
 353
 354         case ATA_PROT_NODATA:
 355                 i = pdc_pkt_header(&qc->tf, qc->ap->prd_dma,
 356                                    qc->dev->devno, pp->pkt);
 357
 358                 if (qc->tf.flags & ATA_TFLAG_LBA48)
 359                         i = pdc_prep_lba48(&qc->tf, pp->pkt, i);
 360                 else
 361                         i = pdc_prep_lba28(&qc->tf, pp->pkt, i);
 362
 363                 pdc_pkt_footer(&qc->tf, pp->pkt, i);
 364                 break;
 365
 366         default:
 367                 break;
 368         }
 369 }
 370
 371 static void pdc_eng_timeout(struct ata_port *ap)
 372 {
 373         struct ata_host_set *host_set = ap->host_set;
 374         u8 drv_stat;
 375         struct ata_queued_cmd *qc;
 376         unsigned long flags;
 377
 378         DPRINTK("ENTER\n");
 379
 380         spin_lock_irqsave(&host_set->lock, flags);
 381
 382         qc = ata_qc_from_tag(ap, ap->active_tag);
 383         if (!qc) {
 384                 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
 385                        ap->id);
 386                 goto out;
 387         }
 388
 389         /* hack alert!  We cannot use the supplied completion
 390          * function from inside the ->eh_strategy_handler() thread.
 391          * libata is the only user of ->eh_strategy_handler() in
 392          * any kernel, so the default scsi_done() assumes it is
 393          * not being called from the SCSI EH.
 394          */
 395         qc->scsidone = scsi_finish_command;
 396
 397         switch (qc->tf.protocol) {
 398         case ATA_PROT_DMA:
 399         case ATA_PROT_NODATA:
 400                 printk(KERN_ERR "ata%u: command timeout\n", ap->id);
 401                 ata_qc_complete(qc, ata_wait_idle(ap) | ATA_ERR);
 402                 break;
 403
 404         default:
 405                 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
 406
 407                 printk(KERN_ERR "ata%u: unknown timeout, cmd 0x%x stat 0x%x\n",
 408                        ap->id, qc->tf.command, drv_stat);
 409
 410                 ata_qc_complete(qc, drv_stat);
 411                 break;
 412         }
 413
 414 out:
 415         spin_unlock_irqrestore(&host_set->lock, flags);
 416         DPRINTK("EXIT\n");
 417 }
 418
 419 static inline unsigned int pdc_host_intr( struct ata_port *ap,
 420                                           struct ata_queued_cmd *qc)
 421 {
 422         u8 status;
 423         unsigned int handled = 0, have_err = 0;
 424         u32 tmp;
 425         void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_GLOBAL_CTL;
 426
 427         tmp = readl(mmio);
 428         if (tmp & PDC_ERR_MASK) {
 429                 have_err = 1;
 430                 pdc_reset_port(ap);
 431         }
 432
 433         switch (qc->tf.protocol) {
 434         case ATA_PROT_DMA:
 435         case ATA_PROT_NODATA:
 436                 status = ata_wait_idle(ap);
 437                 if (have_err)
 438                         status |= ATA_ERR;
 439                 ata_qc_complete(qc, status);
 440                 handled = 1;
 441                 break;
 442
 443         default:
 444                 ap->stats.idle_irq++;
 445                 break;
 446         }
 447
 448         return handled;
 449 }
 450
 451 static void pdc_irq_clear(struct ata_port *ap)
 452 {
 453         struct ata_host_set *host_set = ap->host_set;
 454         void __iomem *mmio = host_set->mmio_base;
 455
 456         readl(mmio + PDC_INT_SEQMASK);
 457 }
 458
 459 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
 460 {
 461         struct ata_host_set *host_set = dev_instance;
 462         struct ata_port *ap;
 463         u32 mask = 0;
 464         unsigned int i, tmp;
 465         unsigned int handled = 0;
 466         void __iomem *mmio_base;
 467
 468         VPRINTK("ENTER\n");
 469
 470         if (!host_set || !host_set->mmio_base) {
 471                 VPRINTK("QUICK EXIT\n");
 472                 return IRQ_NONE;
 473         }
 474
 475         mmio_base = host_set->mmio_base;
 476
 477         /* reading should also clear interrupts */
 478         mask = readl(mmio_base + PDC_INT_SEQMASK);
 479
 480         if (mask == 0xffffffff) {
 481                 VPRINTK("QUICK EXIT 2\n");
 482                 return IRQ_NONE;
 483         }
 484         mask &= 0xffff;         /* only 16 tags possible */
 485         if (!mask) {
 486                 VPRINTK("QUICK EXIT 3\n");
 487                 return IRQ_NONE;
 488         }
 489
 490         spin_lock(&host_set->lock);
 491
 492         writel(mask, mmio_base + PDC_INT_SEQMASK);
 493
 494         for (i = 0; i < host_set->n_ports; i++) {
 495                 VPRINTK("port %u\n", i);
 496                 ap = host_set->ports[i];
 497                 tmp = mask & (1 << (i + 1));
 498                 if (tmp && ap &&
 499                     !(ap->flags & ATA_FLAG_PORT_DISABLED)) {
 500                         struct ata_queued_cmd *qc;
 501
 502                         qc = ata_qc_from_tag(ap, ap->active_tag);
 503                         if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING)))
 504                                 handled += pdc_host_intr(ap, qc);
 505                 }
 506         }
 507
 508         spin_unlock(&host_set->lock);
 509
 510         VPRINTK("EXIT\n");
 511
 512         return IRQ_RETVAL(handled);
 513 }
 514
 515 static inline void pdc_packet_start(struct ata_queued_cmd *qc)
 516 {
 517         struct ata_port *ap = qc->ap;
 518         struct pdc_port_priv *pp = ap->private_data;
 519         unsigned int port_no = ap->port_no;
 520         u8 seq = (u8) (port_no + 1);
 521
 522         VPRINTK("ENTER, ap %p\n", ap);
 523
 524         writel(0x00000001, ap->host_set->mmio_base + (seq * 4));
 525         readl(ap->host_set->mmio_base + (seq * 4));     /* flush */
 526
 527         pp->pkt[2] = seq;
 528         wmb();                  /* flush PRD, pkt writes */
 529         writel(pp->pkt_dma, (void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT);
 530         readl((void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT); /* flush */
 531 }
 532
 533 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc)
 534 {
 535         switch (qc->tf.protocol) {
 536         case ATA_PROT_DMA:
 537         case ATA_PROT_NODATA:
 538                 pdc_packet_start(qc);
 539                 return 0;
 540
 541         case ATA_PROT_ATAPI_DMA:
 542                 BUG();
 543                 break;
 544
 545         default:
 546                 break;
 547         }
 548
 549         return ata_qc_issue_prot(qc);
 550 }
 551
 552 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
 553 {
 554         WARN_ON (tf->protocol == ATA_PROT_DMA ||
 555                  tf->protocol == ATA_PROT_NODATA);
 556         ata_tf_load(ap, tf);
 557 }
 558
 559
 560 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
 561 {
 562         WARN_ON (tf->protocol == ATA_PROT_DMA ||
 563                  tf->protocol == ATA_PROT_NODATA);
 564         ata_exec_command(ap, tf);
 565 }
 566
 567
 568 static void pdc_ata_setup_port(struct ata_ioports *port, unsigned long base)
 569 {
 570         port->cmd_addr          = base;
 571         port->data_addr         = base;
 572         port->feature_addr      =
 573         port->error_addr        = base + 0x4;
 574         port->nsect_addr        = base + 0x8;
 575         port->lbal_addr         = base + 0xc;
 576         port->lbam_addr         = base + 0x10;
 577         port->lbah_addr         = base + 0x14;
 578         port->device_addr       = base + 0x18;
 579         port->command_addr      =
 580         port->status_addr       = base + 0x1c;
 581         port->altstatus_addr    =
 582         port->ctl_addr          = base + 0x38;
 583 }
 584
 585
 586 static void pdc_host_init(unsigned int chip_id, struct ata_probe_ent *pe)
 587 {
 588         void __iomem *mmio = pe->mmio_base;
 589         u32 tmp;
 590
 591         /*
 592          * Except for the hotplug stuff, this is voodoo from the
 593          * Promise driver.  Label this entire section
 594          * "TODO: figure out why we do this"
 595          */
 596
 597         /* change FIFO_SHD to 8 dwords, enable BMR_BURST */
 598         tmp = readl(mmio + PDC_FLASH_CTL);
 599         tmp |= 0x12000; /* bit 16 (fifo 8 dw) and 13 (bmr burst?) */
 600         writel(tmp, mmio + PDC_FLASH_CTL);
 601
 602         /* clear plug/unplug flags for all ports */
 603         tmp = readl(mmio + PDC_SATA_PLUG_CSR);
 604         writel(tmp | 0xff, mmio + PDC_SATA_PLUG_CSR);
 605
 606         /* mask plug/unplug ints */
 607         tmp = readl(mmio + PDC_SATA_PLUG_CSR);
 608         writel(tmp | 0xff0000, mmio + PDC_SATA_PLUG_CSR);
 609
 610         /* reduce TBG clock to 133 Mhz. */
 611         tmp = readl(mmio + PDC_TBG_MODE);
 612         tmp &= ~0x30000; /* clear bit 17, 16*/
 613         tmp |= 0x10000;  /* set bit 17:16 = 0:1 */
 614         writel(tmp, mmio + PDC_TBG_MODE);
 615
 616         readl(mmio + PDC_TBG_MODE);     /* flush */
 617         msleep(10);
 618
 619         /* adjust slew rate control register. */
 620         tmp = readl(mmio + PDC_SLEW_CTL);
 621         tmp &= 0xFFFFF03F; /* clear bit 11 ~ 6 */
 622         tmp  |= 0x00000900; /* set bit 11-9 = 100b , bit 8-6 = 100 */
 623         writel(tmp, mmio + PDC_SLEW_CTL);
 624 }
 625
 626 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 627 {
 628         static int printed_version;
 629         struct ata_probe_ent *probe_ent = NULL;
 630         unsigned long base;
 631         void __iomem *mmio_base;
 632         unsigned int board_idx = (unsigned int) ent->driver_data;
 633         int pci_dev_busy = 0;
 634         int rc;
 635
 636         if (!printed_version++)
 637                 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
 638
 639         /*
 640          * If this driver happens to only be useful on Apple's K2, then
 641          * we should check that here as it has a normal Serverworks ID
 642          */
 643         rc = pci_enable_device(pdev);
 644         if (rc)
 645                 return rc;
 646
 647         rc = pci_request_regions(pdev, DRV_NAME);
 648         if (rc) {
 649                 pci_dev_busy = 1;
 650                 goto err_out;
 651         }
 652
 653         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 654         if (rc)
 655                 goto err_out_regions;
 656         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 657         if (rc)
 658                 goto err_out_regions;
 659
 660         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
 661         if (probe_ent == NULL) {
 662                 rc = -ENOMEM;
 663                 goto err_out_regions;
 664         }
 665
 666         memset(probe_ent, 0, sizeof(*probe_ent));
 667         probe_ent->dev = pci_dev_to_dev(pdev);
 668         INIT_LIST_HEAD(&probe_ent->node);
 669
 670         mmio_base = pci_iomap(pdev, 3, 0);
 671         if (mmio_base == NULL) {
 672                 rc = -ENOMEM;
 673                 goto err_out_free_ent;
 674         }
 675         base = (unsigned long) mmio_base;
 676
 677         probe_ent->sht          = pdc_port_info[board_idx].sht;
 678         probe_ent->host_flags   = pdc_port_info[board_idx].host_flags;
 679         probe_ent->pio_mask     = pdc_port_info[board_idx].pio_mask;
 680         probe_ent->mwdma_mask   = pdc_port_info[board_idx].mwdma_mask;
 681         probe_ent->udma_mask    = pdc_port_info[board_idx].udma_mask;
 682         probe_ent->port_ops     = pdc_port_info[board_idx].port_ops;
 683
 684         probe_ent->irq = pdev->irq;
 685         probe_ent->irq_flags = SA_SHIRQ;
 686         probe_ent->mmio_base = mmio_base;
 687
 688         pdc_ata_setup_port(&probe_ent->port[0], base + 0x200);
 689         pdc_ata_setup_port(&probe_ent->port[1], base + 0x280);
 690
 691         probe_ent->port[0].scr_addr = base + 0x400;
 692         probe_ent->port[1].scr_addr = base + 0x500;
 693
 694         /* notice 4-port boards */
 695         switch (board_idx) {
 696         case board_20319:
 697                 probe_ent->n_ports = 4;
 698
 699                 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
 700                 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
 701
 702                 probe_ent->port[2].scr_addr = base + 0x600;
 703                 probe_ent->port[3].scr_addr = base + 0x700;
 704                 break;
 705         case board_2037x:
 706                 probe_ent->n_ports = 2;
 707                 break;
 708         case board_20619:
 709                 probe_ent->n_ports = 4;
 710
 711                 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
 712                 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
 713
 714                 probe_ent->port[2].scr_addr = base + 0x600;
 715                 probe_ent->port[3].scr_addr = base + 0x700;
 716                 break;
 717         default:
 718                 BUG();
 719                 break;
 720         }
 721
 722         pci_set_master(pdev);
 723
 724         /* initialize adapter */
 725         pdc_host_init(board_idx, probe_ent);
 726
 727         /* FIXME: check ata_device_add return value */
 728         ata_device_add(probe_ent);
 729         kfree(probe_ent);
 730
 731         return 0;
 732
 733 err_out_free_ent:
 734         kfree(probe_ent);
 735 err_out_regions:
 736         pci_release_regions(pdev);
 737 err_out:
 738         if (!pci_dev_busy)
 739                 pci_disable_device(pdev);
 740         return rc;
 741 }
 742
 743
 744 static int __init pdc_ata_init(void)
 745 {
 746         return pci_module_init(&pdc_ata_pci_driver);
 747 }
 748
 749
 750 static void __exit pdc_ata_exit(void)
 751 {
 752         pci_unregister_driver(&pdc_ata_pci_driver);
 753 }
 754
 755
 756 MODULE_AUTHOR("Jeff Garzik");
 757 MODULE_DESCRIPTION("Promise ATA TX2/TX4/TX4000 low-level driver");
 758 MODULE_LICENSE("GPL");
 759 MODULE_DEVICE_TABLE(pci, pdc_ata_pci_tbl);
 760 MODULE_VERSION(DRV_VERSION);
 761
 762 module_init(pdc_ata_init);
 763 module_exit(pdc_ata_exit);