2  * pata_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.4.3"
 
  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  *      csb_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_PATA_UNK;
 
 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_cable_detect        -       cable detection
 
 142  *      @deadline: deadline jiffies for the operation
 
 144  *      Perform cable detection according to the device and subvendor
 
 148 static int serverworks_cable_detect(struct ata_port *ap)
 
 150         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 151         struct sv_cable_table *cb = cable_detect;
 
 154                 if (cb->device == pdev->device &&
 
 155                     (cb->subvendor == pdev->subsystem_vendor ||
 
 156                       cb->subvendor == PCI_ANY_ID)) {
 
 157                         return cb->cable_detect(ap);
 
 163         return -1;      /* kill compiler warning */
 
 167  *      serverworks_is_csb      -       Check for CSB or OSB
 
 168  *      @pdev: PCI device to check
 
 170  *      Returns true if the device being checked is known to be a CSB
 
 174 static u8 serverworks_is_csb(struct pci_dev *pdev)
 
 176         switch (pdev->device) {
 
 177                 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
 
 178                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
 
 179                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
 
 180                 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
 
 189  *      serverworks_osb4_filter -       mode selection filter
 
 191  *      @mask: Mask of proposed modes
 
 193  *      Filter the offered modes for the device to apply controller
 
 194  *      specific rules. OSB4 requires no UDMA for disks due to a FIFO
 
 198 static unsigned long serverworks_osb4_filter(struct ata_device *adev, unsigned long mask)
 
 200         if (adev->class == ATA_DEV_ATA)
 
 201                 mask &= ~ATA_MASK_UDMA;
 
 202         return ata_pci_default_filter(adev, mask);
 
 207  *      serverworks_csb_filter  -       mode selection filter
 
 209  *      @mask: Mask of proposed modes
 
 211  *      Check the blacklist and disable UDMA5 if matched
 
 214 static unsigned long serverworks_csb_filter(struct ata_device *adev, unsigned long mask)
 
 217         char model_num[ATA_ID_PROD_LEN + 1];
 
 221         if (adev->class != ATA_DEV_ATA)
 
 222                 return ata_pci_default_filter(adev, mask);
 
 224         /* Actually do need to check */
 
 225         ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
 
 227         for (i = 0; (p = csb_bad_ata100[i]) != NULL; i++) {
 
 228                 if (!strcmp(p, model_num))
 
 229                         mask &= ~(0x1F << ATA_SHIFT_UDMA);
 
 231         return ata_pci_default_filter(adev, mask);
 
 235  *      serverworks_set_piomode -       set initial PIO mode data
 
 239  *      Program the OSB4/CSB5 timing registers for PIO. The PIO register
 
 240  *      load is done as a simple lookup.
 
 242 static void serverworks_set_piomode(struct ata_port *ap, struct ata_device *adev)
 
 244         static const u8 pio_mode[] = { 0x5d, 0x47, 0x34, 0x22, 0x20 };
 
 245         int offset = 1 + 2 * ap->port_no - adev->devno;
 
 246         int devbits = (2 * ap->port_no + adev->devno) * 4;
 
 248         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 249         int pio = adev->pio_mode - XFER_PIO_0;
 
 251         pci_write_config_byte(pdev, 0x40 + offset, pio_mode[pio]);
 
 253         /* The OSB4 just requires the timing but the CSB series want the
 
 254            mode number as well */
 
 255         if (serverworks_is_csb(pdev)) {
 
 256                 pci_read_config_word(pdev, 0x4A, &csb5_pio);
 
 257                 csb5_pio &= ~(0x0F << devbits);
 
 258                 pci_write_config_byte(pdev, 0x4A, csb5_pio | (pio << devbits));
 
 263  *      serverworks_set_dmamode -       set initial DMA mode data
 
 267  *      Program the MWDMA/UDMA modes for the serverworks OSB4/CSB5
 
 268  *      chipset. The MWDMA mode values are pulled from a lookup table
 
 269  *      while the chipset uses mode number for UDMA.
 
 272 static void serverworks_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 
 274         static const u8 dma_mode[] = { 0x77, 0x21, 0x20 };
 
 275         int offset = 1 + 2 * ap->port_no - adev->devno;
 
 276         int devbits = 2 * ap->port_no + adev->devno;
 
 279         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 281         pci_read_config_byte(pdev, 0x54, &ultra_cfg);
 
 282         pci_read_config_byte(pdev, 0x56 + ap->port_no, &ultra);
 
 283         ultra &= ~(0x0F << (adev->devno * 4));
 
 285         if (adev->dma_mode >= XFER_UDMA_0) {
 
 286                 pci_write_config_byte(pdev, 0x44 + offset,  0x20);
 
 288                 ultra |= (adev->dma_mode - XFER_UDMA_0)
 
 289                                         << (adev->devno * 4);
 
 290                 ultra_cfg |=  (1 << devbits);
 
 292                 pci_write_config_byte(pdev, 0x44 + offset,
 
 293                         dma_mode[adev->dma_mode - XFER_MW_DMA_0]);
 
 294                 ultra_cfg &= ~(1 << devbits);
 
 296         pci_write_config_byte(pdev, 0x56 + ap->port_no, ultra);
 
 297         pci_write_config_byte(pdev, 0x54, ultra_cfg);
 
 300 static struct scsi_host_template serverworks_sht = {
 
 301         .module                 = THIS_MODULE,
 
 303         .ioctl                  = ata_scsi_ioctl,
 
 304         .queuecommand           = ata_scsi_queuecmd,
 
 305         .can_queue              = ATA_DEF_QUEUE,
 
 306         .this_id                = ATA_SHT_THIS_ID,
 
 307         .sg_tablesize           = LIBATA_MAX_PRD,
 
 308         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 
 309         .emulated               = ATA_SHT_EMULATED,
 
 310         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 
 311         .proc_name              = DRV_NAME,
 
 312         .dma_boundary           = ATA_DMA_BOUNDARY,
 
 313         .slave_configure        = ata_scsi_slave_config,
 
 314         .slave_destroy          = ata_scsi_slave_destroy,
 
 315         .bios_param             = ata_std_bios_param,
 
 318 static struct ata_port_operations serverworks_osb4_port_ops = {
 
 319         .set_piomode    = serverworks_set_piomode,
 
 320         .set_dmamode    = serverworks_set_dmamode,
 
 321         .mode_filter    = serverworks_osb4_filter,
 
 323         .tf_load        = ata_tf_load,
 
 324         .tf_read        = ata_tf_read,
 
 325         .check_status   = ata_check_status,
 
 326         .exec_command   = ata_exec_command,
 
 327         .dev_select     = ata_std_dev_select,
 
 329         .freeze         = ata_bmdma_freeze,
 
 330         .thaw           = ata_bmdma_thaw,
 
 331         .error_handler  = ata_bmdma_error_handler,
 
 332         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 
 333         .cable_detect   = serverworks_cable_detect,
 
 335         .bmdma_setup    = ata_bmdma_setup,
 
 336         .bmdma_start    = ata_bmdma_start,
 
 337         .bmdma_stop     = ata_bmdma_stop,
 
 338         .bmdma_status   = ata_bmdma_status,
 
 340         .qc_prep        = ata_qc_prep,
 
 341         .qc_issue       = ata_qc_issue_prot,
 
 343         .data_xfer      = ata_data_xfer,
 
 345         .irq_handler    = ata_interrupt,
 
 346         .irq_clear      = ata_bmdma_irq_clear,
 
 347         .irq_on         = ata_irq_on,
 
 349         .port_start     = ata_sff_port_start,
 
 352 static struct ata_port_operations serverworks_csb_port_ops = {
 
 353         .set_piomode    = serverworks_set_piomode,
 
 354         .set_dmamode    = serverworks_set_dmamode,
 
 355         .mode_filter    = serverworks_csb_filter,
 
 357         .tf_load        = ata_tf_load,
 
 358         .tf_read        = ata_tf_read,
 
 359         .check_status   = ata_check_status,
 
 360         .exec_command   = ata_exec_command,
 
 361         .dev_select     = ata_std_dev_select,
 
 363         .freeze         = ata_bmdma_freeze,
 
 364         .thaw           = ata_bmdma_thaw,
 
 365         .error_handler  = ata_bmdma_error_handler,
 
 366         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 
 367         .cable_detect   = serverworks_cable_detect,
 
 369         .bmdma_setup    = ata_bmdma_setup,
 
 370         .bmdma_start    = ata_bmdma_start,
 
 371         .bmdma_stop     = ata_bmdma_stop,
 
 372         .bmdma_status   = ata_bmdma_status,
 
 374         .qc_prep        = ata_qc_prep,
 
 375         .qc_issue       = ata_qc_issue_prot,
 
 377         .data_xfer      = ata_data_xfer,
 
 379         .irq_handler    = ata_interrupt,
 
 380         .irq_clear      = ata_bmdma_irq_clear,
 
 381         .irq_on         = ata_irq_on,
 
 383         .port_start     = ata_sff_port_start,
 
 386 static int serverworks_fixup_osb4(struct pci_dev *pdev)
 
 389         struct pci_dev *isa_dev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 390                   PCI_DEVICE_ID_SERVERWORKS_OSB4, NULL);
 
 392                 pci_read_config_dword(isa_dev, 0x64, ®);
 
 393                 reg &= ~0x00002000; /* disable 600ns interrupt mask */
 
 394                 if (!(reg & 0x00004000))
 
 395                         printk(KERN_DEBUG DRV_NAME ": UDMA not BIOS enabled.\n");
 
 396                 reg |=  0x00004000; /* enable UDMA/33 support */
 
 397                 pci_write_config_dword(isa_dev, 0x64, reg);
 
 398                 pci_dev_put(isa_dev);
 
 401         printk(KERN_WARNING "ata_serverworks: Unable to find bridge.\n");
 
 405 static int serverworks_fixup_csb(struct pci_dev *pdev)
 
 409         /* Third Channel Test */
 
 410         if (!(PCI_FUNC(pdev->devfn) & 1)) {
 
 411                 struct pci_dev * findev = NULL;
 
 413                 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 414                         PCI_DEVICE_ID_SERVERWORKS_CSB5, NULL);
 
 416                         pci_read_config_dword(findev, 0x4C, ®4c);
 
 417                         reg4c &= ~0x000007FF;
 
 420                         pci_write_config_dword(findev, 0x4C, reg4c);
 
 424                 struct pci_dev * findev = NULL;
 
 427                 findev = pci_get_device(PCI_VENDOR_ID_SERVERWORKS,
 
 428                                 PCI_DEVICE_ID_SERVERWORKS_CSB6, NULL);
 
 430                         pci_read_config_byte(findev, 0x41, ®41);
 
 432                         pci_write_config_byte(findev, 0x41, reg41);
 
 436         /* setup the UDMA Control register
 
 438          * 1. clear bit 6 to enable DMA
 
 439          * 2. enable DMA modes with bits 0-1
 
 443          *      11 : udma2/udma4/udma5
 
 445         pci_read_config_byte(pdev, 0x5A, &btr);
 
 447         if (!(PCI_FUNC(pdev->devfn) & 1))
 
 450                 btr |= (pdev->revision >= SVWKS_CSB5_REVISION_NEW) ? 0x3 : 0x2;
 
 451         pci_write_config_byte(pdev, 0x5A, btr);
 
 456 static void serverworks_fixup_ht1000(struct pci_dev *pdev)
 
 459         /* Setup HT1000 SouthBridge Controller - Single Channel Only */
 
 460         pci_read_config_byte(pdev, 0x5A, &btr);
 
 463         pci_write_config_byte(pdev, 0x5A, btr);
 
 467 static int serverworks_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 
 469         static const struct ata_port_info info[4] = {
 
 471                         .sht = &serverworks_sht,
 
 472                         .flags = ATA_FLAG_SLAVE_POSS,
 
 476                         .port_ops = &serverworks_osb4_port_ops
 
 477                 }, { /* OSB4 no UDMA */
 
 478                         .sht = &serverworks_sht,
 
 479                         .flags = ATA_FLAG_SLAVE_POSS,
 
 483                         .port_ops = &serverworks_osb4_port_ops
 
 485                         .sht = &serverworks_sht,
 
 486                         .flags = ATA_FLAG_SLAVE_POSS,
 
 489                         .udma_mask = ATA_UDMA4,
 
 490                         .port_ops = &serverworks_csb_port_ops
 
 491                 }, { /* CSB5 - later revisions*/
 
 492                         .sht = &serverworks_sht,
 
 493                         .flags = ATA_FLAG_SLAVE_POSS,
 
 496                         .udma_mask = ATA_UDMA5,
 
 497                         .port_ops = &serverworks_csb_port_ops
 
 500         const struct ata_port_info *ppi[] = { &info[id->driver_data], NULL };
 
 502         /* Force master latency timer to 64 PCI clocks */
 
 503         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
 
 505         /* OSB4 : South Bridge and IDE */
 
 506         if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_OSB4IDE) {
 
 507                 /* Select non UDMA capable OSB4 if we can't do fixups */
 
 508                 if ( serverworks_fixup_osb4(pdev) < 0)
 
 511         /* setup CSB5/CSB6 : South Bridge and IDE option RAID */
 
 512         else if ((pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE) ||
 
 513                  (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE) ||
 
 514                  (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)) {
 
 516                  /* If the returned btr is the newer revision then
 
 517                     select the right info block */
 
 518                  if (serverworks_fixup_csb(pdev) == 3)
 
 521                 /* Is this the 3rd channel CSB6 IDE ? */
 
 522                 if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2)
 
 523                         ppi[1] = &ata_dummy_port_info;
 
 526         else if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_HT1000IDE)
 
 527                 serverworks_fixup_ht1000(pdev);
 
 529         if (pdev->device == PCI_DEVICE_ID_SERVERWORKS_CSB5IDE)
 
 530                 ata_pci_clear_simplex(pdev);
 
 532         return ata_pci_init_one(pdev, ppi);
 
 536 static int serverworks_reinit_one(struct pci_dev *pdev)
 
 538         /* Force master latency timer to 64 PCI clocks */
 
 539         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 0x40);
 
 541         switch (pdev->device)
 
 543                 case PCI_DEVICE_ID_SERVERWORKS_OSB4IDE:
 
 544                         serverworks_fixup_osb4(pdev);
 
 546                 case PCI_DEVICE_ID_SERVERWORKS_CSB5IDE:
 
 547                         ata_pci_clear_simplex(pdev);
 
 549                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE:
 
 550                 case PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2:
 
 551                         serverworks_fixup_csb(pdev);
 
 553                 case PCI_DEVICE_ID_SERVERWORKS_HT1000IDE:
 
 554                         serverworks_fixup_ht1000(pdev);
 
 557         return ata_pci_device_resume(pdev);
 
 561 static const struct pci_device_id serverworks[] = {
 
 562         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_OSB4IDE), 0},
 
 563         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB5IDE), 2},
 
 564         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE), 2},
 
 565         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_CSB6IDE2), 2},
 
 566         { PCI_VDEVICE(SERVERWORKS, PCI_DEVICE_ID_SERVERWORKS_HT1000IDE), 2},
 
 571 static struct pci_driver serverworks_pci_driver = {
 
 573         .id_table       = serverworks,
 
 574         .probe          = serverworks_init_one,
 
 575         .remove         = ata_pci_remove_one,
 
 577         .suspend        = ata_pci_device_suspend,
 
 578         .resume         = serverworks_reinit_one,
 
 582 static int __init serverworks_init(void)
 
 584         return pci_register_driver(&serverworks_pci_driver);
 
 587 static void __exit serverworks_exit(void)
 
 589         pci_unregister_driver(&serverworks_pci_driver);
 
 592 MODULE_AUTHOR("Alan Cox");
 
 593 MODULE_DESCRIPTION("low-level driver for Serverworks OSB4/CSB5/CSB6");
 
 594 MODULE_LICENSE("GPL");
 
 595 MODULE_DEVICE_TABLE(pci, serverworks);
 
 596 MODULE_VERSION(DRV_VERSION);
 
 598 module_init(serverworks_init);
 
 599 module_exit(serverworks_exit);