2  * ata-serverworks.c    - Serverworks PATA for new ATA layer
 
   4  *                        Alan Cox <alan@redhat.com>
 
  10  * Copyright (C) 1998-2000 Michel Aubry
 
  11  * Copyright (C) 1998-2000 Andrzej Krzysztofowicz
 
  12  * Copyright (C) 1998-2000 Andre Hedrick <andre@linux-ide.org>
 
  13  * Portions copyright (c) 2001 Sun Microsystems
 
  16  * RCC/ServerWorks IDE driver for Linux
 
  18  *   OSB4: `Open South Bridge' IDE Interface (fn 1)
 
  19  *         supports UDMA mode 2 (33 MB/s)
 
  21  *   CSB5: `Champion South Bridge' IDE Interface (fn 1)
 
  22  *         all revisions support UDMA mode 4 (66 MB/s)
 
  23  *         revision A2.0 and up support UDMA mode 5 (100 MB/s)
 
  25  *         *** The CSB5 does not provide ANY register ***
 
  26  *         *** to detect 80-conductor cable presence. ***
 
  28  *   CSB6: `Champion South Bridge' IDE Interface (optional: third channel)
 
  31  *      Available under NDA only. Errata info very hard to get.
 
  34 #include <linux/kernel.h>
 
  35 #include <linux/module.h>
 
  36 #include <linux/pci.h>
 
  37 #include <linux/init.h>
 
  38 #include <linux/blkdev.h>
 
  39 #include <linux/delay.h>
 
  40 #include <scsi/scsi_host.h>
 
  41 #include <linux/libata.h>
 
  43 #define DRV_NAME "pata_serverworks"
 
  44 #define DRV_VERSION "0.3.9"
 
  46 #define SVWKS_CSB5_REVISION_NEW 0x92 /* min PCI_REVISION_ID for UDMA5 (A2.0) */
 
  47 #define SVWKS_CSB6_REVISION     0xa0 /* min PCI_REVISION_ID for UDMA4 (A1.0) */
 
  49 /* Seagate Barracuda ATA IV Family drives in UDMA mode 5
 
  50  * can overrun their FIFOs when used with the CSB5 */
 
  52 static const char *csb_bad_ata100[] = {
 
  61  *      dell_cable      -       Dell serverworks cable detection
 
  62  *      @ap: ATA port to do cable detect
 
  64  *      Dell hide the 40/80 pin select for their interfaces in the top two
 
  65  *      bits of the subsystem ID.
 
  68 static int dell_cable(struct ata_port *ap) {
 
  69         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
  71         if (pdev->subsystem_device & (1 << (ap->port_no + 14)))
 
  72                 return ATA_CBL_PATA80;
 
  73         return ATA_CBL_PATA40;
 
  77  *      sun_cable       -       Sun Cobalt 'Alpine' cable detection
 
  78  *      @ap: ATA port to do cable select
 
  80  *      Cobalt CSB5 IDE hides the 40/80pin in the top two bits of the
 
  81  *      subsystem ID the same as dell. We could use one function but we may
 
  82  *      need to extend the Dell one in future
 
  85 static int sun_cable(struct ata_port *ap) {
 
  86         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
  88         if (pdev->subsystem_device & (1 << (ap->port_no + 14)))
 
  89                 return ATA_CBL_PATA80;
 
  90         return ATA_CBL_PATA40;
 
  94  *      osb4_cable      -       OSB4 cable detect
 
  95  *      @ap: ATA port to check
 
  97  *      The OSB4 isn't UDMA66 capable so this is easy
 
 100 static int osb4_cable(struct ata_port *ap) {
 
 101         return ATA_CBL_PATA40;
 
 105  *      csb4_cable      -       CSB5/6 cable detect
 
 106  *      @ap: ATA port to check
 
 108  *      Serverworks default arrangement is to use the drive side detection
 
 112 static int csb_cable(struct ata_port *ap) {
 
 113         return ATA_CBL_PATA80;
 
 116 struct sv_cable_table {
 
 119         int (*cable_detect)(struct ata_port *ap);
 
 123  *      Note that we don't copy the old serverworks code because the old
 
 124  *      code contains obvious mistakes
 
 127 static struct sv_cable_table cable_detect[] = {
 
 128         { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_VENDOR_ID_DELL, dell_cable },
 
 129         { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE, PCI_VENDOR_ID_DELL, dell_cable },
 
 130         { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_VENDOR_ID_SUN,  sun_cable },
 
 131         { PCI_DEVICE_ID_SERVERWORKS_OSB4IDE, PCI_ANY_ID, osb4_cable },
 
 132         { PCI_DEVICE_ID_SERVERWORKS_CSB5IDE, PCI_ANY_ID, csb_cable },
 
 133         { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE, PCI_ANY_ID, csb_cable },
 
 134         { PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2, PCI_ANY_ID, csb_cable },
 
 135         { PCI_DEVICE_ID_SERVERWORKS_HT1000IDE, PCI_ANY_ID, csb_cable },
 
 140  *      serverworks_pre_reset           -       cable detection
 
 143  *      Perform cable detection according to the device and subvendor
 
 147 static int serverworks_pre_reset(struct ata_port *ap) {
 
 148         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 149         struct sv_cable_table *cb = cable_detect;
 
 152                 if (cb->device == pdev->device &&
 
 153                     (cb->subvendor == pdev->subsystem_vendor ||
 
 154                       cb->subvendor == PCI_ANY_ID)) {
 
 155                         ap->cbl = cb->cable_detect(ap);
 
 156                         return ata_std_prereset(ap);
 
 162         return -1;      /* kill compiler warning */
 
 165 static void serverworks_error_handler(struct ata_port *ap)
 
 167         return ata_bmdma_drive_eh(ap, serverworks_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
 
 171  *      serverworks_is_csb      -       Check for CSB or OSB
 
 172  *      @pdev: PCI device to check
 
 174  *      Returns true if the device being checked is known to be a CSB
 
 178 static u8 serverworks_is_csb(struct pci_dev *pdev)
 
 180         switch (pdev->device) {
 
 181                 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
 
 182                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
 
 183                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
 
 184                 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
 
 193  *      serverworks_osb4_filter -       mode selection filter
 
 197  *      Filter the offered modes for the device to apply controller
 
 198  *      specific rules. OSB4 requires no UDMA for disks due to a FIFO
 
 202 static unsigned long serverworks_osb4_filter(const struct ata_port *ap, struct ata_device *adev, unsigned long mask)
 
 204         if (adev->class == ATA_DEV_ATA)
 
 205                 mask &= ~ATA_MASK_UDMA;
 
 206         return ata_pci_default_filter(ap, adev, mask);
 
 211  *      serverworks_csb_filter  -       mode selection filter
 
 215  *      Check the blacklist and disable UDMA5 if matched
 
 218 static unsigned long serverworks_csb_filter(const struct ata_port *ap, struct ata_device *adev, unsigned long mask)
 
 225         if (adev->class != ATA_DEV_ATA)
 
 226                 return ata_pci_default_filter(ap, adev, mask);
 
 228         /* Actually do need to check */
 
 229         ata_id_string(adev->id, model_num, ATA_ID_PROD_OFS, sizeof(model_num));
 
 230         /* Precuationary - why not do this in the libata core ?? */
 
 232         len = strlen(model_num);
 
 233         while ((len > 0) && (model_num[len - 1] == ' ')) {
 
 238         for(i = 0; (p = csb_bad_ata100[i]) != NULL; i++) {
 
 239                 if (!strncmp(p, model_num, len))
 
 240                         mask &= ~(0x1F << ATA_SHIFT_UDMA);
 
 242         return ata_pci_default_filter(ap, adev, mask);
 
 247  *      serverworks_set_piomode -       set initial PIO mode data
 
 251  *      Program the OSB4/CSB5 timing registers for PIO. The PIO register
 
 252  *      load is done as a simple lookup.
 
 254 static void serverworks_set_piomode(struct ata_port *ap, struct ata_device *adev)
 
 256         static const u8 pio_mode[] = { 0x5d, 0x47, 0x34, 0x22, 0x20 };
 
 257         int offset = 1 + (2 * ap->port_no) - adev->devno;
 
 258         int devbits = (2 * ap->port_no + adev->devno) * 4;
 
 260         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 261         int pio = adev->pio_mode - XFER_PIO_0;
 
 263         pci_write_config_byte(pdev, 0x40 + offset, pio_mode[pio]);
 
 265         /* The OSB4 just requires the timing but the CSB series want the
 
 266            mode number as well */
 
 267         if (serverworks_is_csb(pdev)) {
 
 268                 pci_read_config_word(pdev, 0x4A, &csb5_pio);
 
 269                 csb5_pio &= ~(0x0F << devbits);
 
 270                 pci_write_config_byte(pdev, 0x4A, csb5_pio | (pio << devbits));
 
 275  *      serverworks_set_dmamode -       set initial DMA mode data
 
 279  *      Program the MWDMA/UDMA modes for the serverworks OSB4/CSB5
 
 280  *      chipset. The MWDMA mode values are pulled from a lookup table
 
 281  *      while the chipset uses mode number for UDMA.
 
 284 static void serverworks_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 
 286         static const u8 dma_mode[] = { 0x77, 0x21, 0x20 };
 
 287         int offset = 1 + 2 * ap->port_no - adev->devno;
 
 288         int devbits = (2 * ap->port_no + adev->devno);
 
 291         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 293         pci_read_config_byte(pdev, 0x54, &ultra_cfg);
 
 295         if (adev->dma_mode >= XFER_UDMA_0) {
 
 296                 pci_write_config_byte(pdev, 0x44 + offset,  0x20);
 
 298                 pci_read_config_byte(pdev, 0x56 + ap->port_no, &ultra);
 
 299                 ultra &= ~(0x0F << (ap->port_no * 4));
 
 300                 ultra |= (adev->dma_mode - XFER_UDMA_0)
 
 301                                         << (ap->port_no * 4);
 
 302                 pci_write_config_byte(pdev, 0x56 + ap->port_no, ultra);
 
 304                 ultra_cfg |=  (1 << devbits);
 
 306                 pci_write_config_byte(pdev, 0x44 + offset,
 
 307                         dma_mode[adev->dma_mode - XFER_MW_DMA_0]);
 
 308                 ultra_cfg &= ~(1 << devbits);
 
 310         pci_write_config_byte(pdev, 0x54, ultra_cfg);
 
 313 static struct scsi_host_template serverworks_sht = {
 
 314         .module                 = THIS_MODULE,
 
 316         .ioctl                  = ata_scsi_ioctl,
 
 317         .queuecommand           = ata_scsi_queuecmd,
 
 318         .can_queue              = ATA_DEF_QUEUE,
 
 319         .this_id                = ATA_SHT_THIS_ID,
 
 320         .sg_tablesize           = LIBATA_MAX_PRD,
 
 321         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 
 322         .emulated               = ATA_SHT_EMULATED,
 
 323         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 
 324         .proc_name              = DRV_NAME,
 
 325         .dma_boundary           = ATA_DMA_BOUNDARY,
 
 326         .slave_configure        = ata_scsi_slave_config,
 
 327         .slave_destroy          = ata_scsi_slave_destroy,
 
 328         .bios_param             = ata_std_bios_param,
 
 329         .resume                 = ata_scsi_device_resume,
 
 330         .suspend                = ata_scsi_device_suspend,
 
 333 static struct ata_port_operations serverworks_osb4_port_ops = {
 
 334         .port_disable   = ata_port_disable,
 
 335         .set_piomode    = serverworks_set_piomode,
 
 336         .set_dmamode    = serverworks_set_dmamode,
 
 337         .mode_filter    = serverworks_osb4_filter,
 
 339         .tf_load        = ata_tf_load,
 
 340         .tf_read        = ata_tf_read,
 
 341         .check_status   = ata_check_status,
 
 342         .exec_command   = ata_exec_command,
 
 343         .dev_select     = ata_std_dev_select,
 
 345         .freeze         = ata_bmdma_freeze,
 
 346         .thaw           = ata_bmdma_thaw,
 
 347         .error_handler  = serverworks_error_handler,
 
 348         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 
 350         .bmdma_setup    = ata_bmdma_setup,
 
 351         .bmdma_start    = ata_bmdma_start,
 
 352         .bmdma_stop     = ata_bmdma_stop,
 
 353         .bmdma_status   = ata_bmdma_status,
 
 355         .qc_prep        = ata_qc_prep,
 
 356         .qc_issue       = ata_qc_issue_prot,
 
 358         .data_xfer      = ata_pio_data_xfer,
 
 360         .irq_handler    = ata_interrupt,
 
 361         .irq_clear      = ata_bmdma_irq_clear,
 
 363         .port_start     = ata_port_start,
 
 364         .port_stop      = ata_port_stop,
 
 365         .host_stop      = ata_host_stop
 
 368 static struct ata_port_operations serverworks_csb_port_ops = {
 
 369         .port_disable   = ata_port_disable,
 
 370         .set_piomode    = serverworks_set_piomode,
 
 371         .set_dmamode    = serverworks_set_dmamode,
 
 372         .mode_filter    = serverworks_csb_filter,
 
 374         .tf_load        = ata_tf_load,
 
 375         .tf_read        = ata_tf_read,
 
 376         .check_status   = ata_check_status,
 
 377         .exec_command   = ata_exec_command,
 
 378         .dev_select     = ata_std_dev_select,
 
 380         .freeze         = ata_bmdma_freeze,
 
 381         .thaw           = ata_bmdma_thaw,
 
 382         .error_handler  = serverworks_error_handler,
 
 383         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 
 385         .bmdma_setup    = ata_bmdma_setup,
 
 386         .bmdma_start    = ata_bmdma_start,
 
 387         .bmdma_stop     = ata_bmdma_stop,
 
 388         .bmdma_status   = ata_bmdma_status,
 
 390         .qc_prep        = ata_qc_prep,
 
 391         .qc_issue       = ata_qc_issue_prot,
 
 393         .data_xfer      = ata_pio_data_xfer,
 
 395         .irq_handler    = ata_interrupt,
 
 396         .irq_clear      = ata_bmdma_irq_clear,
 
 398         .port_start     = ata_port_start,
 
 399         .port_stop      = ata_port_stop,
 
 400         .host_stop      = ata_host_stop
 
 403 static int serverworks_fixup_osb4(struct pci_dev *pdev)
 
 406         struct pci_dev *isa_dev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 407                   PCI_DEVICE_ID_SERVERWORKS_OSB4, NULL);
 
 409                 pci_read_config_dword(isa_dev, 0x64, ®);
 
 410                 reg &= ~0x00002000; /* disable 600ns interrupt mask */
 
 411                 if (!(reg & 0x00004000))
 
 412                         printk(KERN_DEBUG DRV_NAME ": UDMA not BIOS enabled.\n");
 
 413                 reg |=  0x00004000; /* enable UDMA/33 support */
 
 414                 pci_write_config_dword(isa_dev, 0x64, reg);
 
 415                 pci_dev_put(isa_dev);
 
 418         printk(KERN_WARNING "ata_serverworks: Unable to find bridge.\n");
 
 422 static int serverworks_fixup_csb(struct pci_dev *pdev)
 
 427         pci_read_config_byte(pdev, PCI_REVISION_ID, &rev);
 
 429         /* Third Channel Test */
 
 430         if (!(PCI_FUNC(pdev->devfn) & 1)) {
 
 431                 struct pci_dev * findev = NULL;
 
 433                 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 434                         PCI_DEVICE_ID_SERVERWORKS_CSB5, NULL);
 
 436                         pci_read_config_dword(findev, 0x4C, ®4c);
 
 437                         reg4c &= ~0x000007FF;
 
 440                         pci_write_config_dword(findev, 0x4C, reg4c);
 
 444                 struct pci_dev * findev = NULL;
 
 447                 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 448                                 PCI_DEVICE_ID_SERVERWORKS_CSB6, NULL);
 
 450                         pci_read_config_byte(findev, 0x41, ®41);
 
 452                         pci_write_config_byte(findev, 0x41, reg41);
 
 456         /* setup the UDMA Control register
 
 458          * 1. clear bit 6 to enable DMA
 
 459          * 2. enable DMA modes with bits 0-1
 
 463          *      11 : udma2/udma4/udma5
 
 465         pci_read_config_byte(pdev, 0x5A, &btr);
 
 467         if (!(PCI_FUNC(pdev->devfn) & 1))
 
 470                 btr |= (rev >= SVWKS_CSB5_REVISION_NEW) ? 0x3 : 0x2;
 
 471         pci_write_config_byte(pdev, 0x5A, btr);
 
 476 static void serverworks_fixup_ht1000(struct pci_dev *pdev)
 
 479         /* Setup HT1000 SouthBridge Controller - Single Channel Only */
 
 480         pci_read_config_byte(pdev, 0x5A, &btr);
 
 483         pci_write_config_byte(pdev, 0x5A, btr);
 
 487 static int serverworks_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 
 490         static struct ata_port_info info[4] = {
 
 492                         .sht = &serverworks_sht,
 
 493                         .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 497                         .port_ops = &serverworks_osb4_port_ops
 
 498                 }, { /* OSB4 no UDMA */
 
 499                         .sht = &serverworks_sht,
 
 500                         .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 504                         .port_ops = &serverworks_osb4_port_ops
 
 506                         .sht = &serverworks_sht,
 
 507                         .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 511                         .port_ops = &serverworks_csb_port_ops
 
 512                 }, { /* CSB5 - later revisions*/
 
 513                         .sht = &serverworks_sht,
 
 514                         .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 518                         .port_ops = &serverworks_csb_port_ops
 
 521         static struct ata_port_info *port_info[2];
 
 522         struct ata_port_info *devinfo = &info[id->driver_data];
 
 524         /* Force master latency timer to 64 PCI clocks */
 
 525         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
 
 527         /* OSB4 : South Bridge and IDE */
 
 528         if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_OSB4IDE) {
 
 529                 /* Select non UDMA capable OSB4 if we can't do fixups */
 
 530                 if ( serverworks_fixup_osb4(pdev) < 0)
 
 533         /* setup CSB5/CSB6 : South Bridge and IDE option RAID */
 
 534         else if ((pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE) ||
 
 535                  (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
 
 536                  (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)) {
 
 538                  /* If the returned btr is the newer revision then
 
 539                     select the right info block */
 
 540                  if (serverworks_fixup_csb(pdev) == 3)
 
 543                 /* Is this the 3rd channel CSB6 IDE ? */
 
 544                 if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)
 
 548         else if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_HT1000IDE)
 
 549                 serverworks_fixup_ht1000(pdev);
 
 551         if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE)
 
 552                 ata_pci_clear_simplex(pdev);
 
 554         port_info[0] = port_info[1] = devinfo;
 
 555         return ata_pci_init_one(pdev, port_info, ports);
 
 558 static int serverworks_reinit_one(struct pci_dev *pdev)
 
 560         /* Force master latency timer to 64 PCI clocks */
 
 561         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
 
 563         switch (pdev->device)
 
 565                 case PCI_DEVICE_ID_SERVERWORKS_OSB4IDE:
 
 566                         serverworks_fixup_osb4(pdev);
 
 568                 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
 
 569                         ata_pci_clear_simplex(pdev);
 
 571                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
 
 572                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
 
 573                         serverworks_fixup_csb(pdev);
 
 575                 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
 
 576                         serverworks_fixup_ht1000(pdev);
 
 579         return ata_pci_device_resume(pdev);
 
 582 static const struct pci_device_id serverworks[] = {
 
 583         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_OSB4IDE), 0},
 
 584         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB5IDE), 2},
 
 585         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE), 2},
 
 586         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2), 2},
 
 587         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_HT1000IDE), 2},
 
 592 static struct pci_driver serverworks_pci_driver = {
 
 594         .id_table       = serverworks,
 
 595         .probe          = serverworks_init_one,
 
 596         .remove         = ata_pci_remove_one,
 
 597         .suspend        = ata_pci_device_suspend,
 
 598         .resume         = serverworks_reinit_one,
 
 601 static int __init serverworks_init(void)
 
 603         return pci_register_driver(&serverworks_pci_driver);
 
 606 static void __exit serverworks_exit(void)
 
 608         pci_unregister_driver(&serverworks_pci_driver);
 
 611 MODULE_AUTHOR("Alan Cox");
 
 612 MODULE_DESCRIPTION("low-level driver for Serverworks OSB4/CSB5/CSB6");
 
 613 MODULE_LICENSE("GPL");
 
 614 MODULE_DEVICE_TABLE(pci, serverworks);
 
 615 MODULE_VERSION(DRV_VERSION);
 
 617 module_init(serverworks_init);
 
 618 module_exit(serverworks_exit);