2  * pata_sil680.c        - SIL680 PATA for new ATA layer
 
   4  *                        Alan Cox <alan@redhat.com>
 
   8  * linux/drivers/ide/pci/siimage.c              Version 1.07    Nov 30, 2003
 
  10  * Copyright (C) 2001-2002      Andre Hedrick <andre@linux-ide.org>
 
  11  * Copyright (C) 2003           Red Hat <alan@redhat.com>
 
  13  *  May be copied or modified under the terms of the GNU General Public License
 
  15  *  Documentation publically available.
 
  17  *      If you have strange problems with nVidia chipset systems please
 
  18  *      see the SI support documentation and update your system BIOS
 
  22  *      If we know all our devices are LBA28 (or LBA28 sized)  we could use
 
  23  *      the command fifo mode.
 
  26 #include <linux/kernel.h>
 
  27 #include <linux/module.h>
 
  28 #include <linux/pci.h>
 
  29 #include <linux/init.h>
 
  30 #include <linux/blkdev.h>
 
  31 #include <linux/delay.h>
 
  32 #include <scsi/scsi_host.h>
 
  33 #include <linux/libata.h>
 
  35 #define DRV_NAME "pata_sil680"
 
  36 #define DRV_VERSION "0.4.6"
 
  39  *      sil680_selreg           -       return register base
 
  43  *      Turn a config register offset into the right address in either
 
  44  *      PCI space or MMIO space to access the control register in question
 
  45  *      Thankfully this is a configuration operation so isnt performance
 
  49 static unsigned long sil680_selreg(struct ata_port *ap, int r)
 
  51         unsigned long base = 0xA0 + r;
 
  52         base += (ap->port_no << 4);
 
  57  *      sil680_seldev           -       return register base
 
  61  *      Turn a config register offset into the right address in either
 
  62  *      PCI space or MMIO space to access the control register in question
 
  63  *      including accounting for the unit shift.
 
  66 static unsigned long sil680_seldev(struct ata_port *ap, struct ata_device *adev, int r)
 
  68         unsigned long base = 0xA0 + r;
 
  69         base += (ap->port_no << 4);
 
  70         base |= adev->devno ? 2 : 0;
 
  76  *      sil680_cable_detect     -       cable detection
 
  79  *      Perform cable detection. The SIL680 stores this in PCI config
 
  83 static int sil680_cable_detect(struct ata_port *ap) {
 
  84         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
  85         unsigned long addr = sil680_selreg(ap, 0);
 
  87         pci_read_config_byte(pdev, addr, &ata66);
 
  89                 return ATA_CBL_PATA80;
 
  91                 return ATA_CBL_PATA40;
 
  95  *      sil680_bus_reset        -       reset the SIL680 bus
 
  96  *      @ap: ATA port to reset
 
  97  *      @deadline: deadline jiffies for the operation
 
  99  *      Perform the SIL680 housekeeping when doing an ATA bus reset
 
 102 static int sil680_bus_reset(struct ata_port *ap,unsigned int *classes,
 
 103                             unsigned long deadline)
 
 105         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 106         unsigned long addr = sil680_selreg(ap, 0);
 
 109         pci_read_config_byte(pdev, addr, &reset);
 
 110         pci_write_config_byte(pdev, addr, reset | 0x03);
 
 112         pci_write_config_byte(pdev, addr, reset);
 
 113         return ata_std_softreset(ap, classes, deadline);
 
 116 static void sil680_error_handler(struct ata_port *ap)
 
 118         ata_bmdma_drive_eh(ap, ata_std_prereset, sil680_bus_reset, NULL, ata_std_postreset);
 
 122  *      sil680_set_piomode      -       set initial PIO mode data
 
 126  *      Program the SIL680 registers for PIO mode. Note that the task speed
 
 127  *      registers are shared between the devices so we must pick the lowest
 
 128  *      mode for command work.
 
 131 static void sil680_set_piomode(struct ata_port *ap, struct ata_device *adev)
 
 133         static u16 speed_p[5] = { 0x328A, 0x2283, 0x1104, 0x10C3, 0x10C1 };
 
 134         static u16 speed_t[5] = { 0x328A, 0x2283, 0x1281, 0x10C3, 0x10C1 };
 
 136         unsigned long tfaddr = sil680_selreg(ap, 0x02);
 
 137         unsigned long addr = sil680_seldev(ap, adev, 0x04);
 
 138         unsigned long addr_mask = 0x80 + 4 * ap->port_no;
 
 139         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 140         int pio = adev->pio_mode - XFER_PIO_0;
 
 141         int lowest_pio = pio;
 
 142         int port_shift = 4 * adev->devno;
 
 146         struct ata_device *pair = ata_dev_pair(adev);
 
 148         if (pair != NULL && adev->pio_mode > pair->pio_mode)
 
 149                 lowest_pio = pair->pio_mode - XFER_PIO_0;
 
 151         pci_write_config_word(pdev, addr, speed_p[pio]);
 
 152         pci_write_config_word(pdev, tfaddr, speed_t[lowest_pio]);
 
 154         pci_read_config_word(pdev, tfaddr-2, ®);
 
 155         pci_read_config_byte(pdev, addr_mask, &mode);
 
 157         reg &= ~0x0200;                 /* Clear IORDY */
 
 158         mode &= ~(3 << port_shift);     /* Clear IORDY and DMA bits */
 
 160         if (ata_pio_need_iordy(adev)) {
 
 161                 reg |= 0x0200;          /* Enable IORDY */
 
 162                 mode |= 1 << port_shift;
 
 164         pci_write_config_word(pdev, tfaddr-2, reg);
 
 165         pci_write_config_byte(pdev, addr_mask, mode);
 
 169  *      sil680_set_dmamode      -       set initial DMA mode data
 
 173  *      Program the MWDMA/UDMA modes for the sil680 k
 
 174  *      chipset. The MWDMA mode values are pulled from a lookup table
 
 175  *      while the chipset uses mode number for UDMA.
 
 178 static void sil680_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 
 180         static u8 ultra_table[2][7] = {
 
 181                 { 0x0C, 0x07, 0x05, 0x04, 0x02, 0x01, 0xFF },   /* 100MHz */
 
 182                 { 0x0F, 0x0B, 0x07, 0x05, 0x03, 0x02, 0x01 },   /* 133Mhz */
 
 184         static u16 dma_table[3] = { 0x2208, 0x10C2, 0x10C1 };
 
 186         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 187         unsigned long ma = sil680_seldev(ap, adev, 0x08);
 
 188         unsigned long ua = sil680_seldev(ap, adev, 0x0C);
 
 189         unsigned long addr_mask = 0x80 + 4 * ap->port_no;
 
 190         int port_shift = adev->devno * 4;
 
 194         pci_read_config_byte(pdev, 0x8A, &scsc);
 
 195         pci_read_config_byte(pdev, addr_mask, &mode);
 
 196         pci_read_config_word(pdev, ma, &multi);
 
 197         pci_read_config_word(pdev, ua, &ultra);
 
 199         /* Mask timing bits */
 
 201         mode &= ~(0x03 << port_shift);
 
 204         scsc = (scsc & 0x30) ? 1: 0;
 
 206         if (adev->dma_mode >= XFER_UDMA_0) {
 
 208                 ultra |= ultra_table[scsc][adev->dma_mode - XFER_UDMA_0];
 
 209                 mode |= (0x03 << port_shift);
 
 211                 multi = dma_table[adev->dma_mode - XFER_MW_DMA_0];
 
 212                 mode |= (0x02 << port_shift);
 
 214         pci_write_config_byte(pdev, addr_mask, mode);
 
 215         pci_write_config_word(pdev, ma, multi);
 
 216         pci_write_config_word(pdev, ua, ultra);
 
 219 static struct scsi_host_template sil680_sht = {
 
 220         .module                 = THIS_MODULE,
 
 222         .ioctl                  = ata_scsi_ioctl,
 
 223         .queuecommand           = ata_scsi_queuecmd,
 
 224         .can_queue              = ATA_DEF_QUEUE,
 
 225         .this_id                = ATA_SHT_THIS_ID,
 
 226         .sg_tablesize           = LIBATA_MAX_PRD,
 
 227         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 
 228         .emulated               = ATA_SHT_EMULATED,
 
 229         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 
 230         .proc_name              = DRV_NAME,
 
 231         .dma_boundary           = ATA_DMA_BOUNDARY,
 
 232         .slave_configure        = ata_scsi_slave_config,
 
 233         .slave_destroy          = ata_scsi_slave_destroy,
 
 234         .bios_param             = ata_std_bios_param,
 
 237 static struct ata_port_operations sil680_port_ops = {
 
 238         .port_disable   = ata_port_disable,
 
 239         .set_piomode    = sil680_set_piomode,
 
 240         .set_dmamode    = sil680_set_dmamode,
 
 241         .mode_filter    = ata_pci_default_filter,
 
 242         .tf_load        = ata_tf_load,
 
 243         .tf_read        = ata_tf_read,
 
 244         .check_status   = ata_check_status,
 
 245         .exec_command   = ata_exec_command,
 
 246         .dev_select     = ata_std_dev_select,
 
 248         .freeze         = ata_bmdma_freeze,
 
 249         .thaw           = ata_bmdma_thaw,
 
 250         .error_handler  = sil680_error_handler,
 
 251         .post_internal_cmd = ata_bmdma_post_internal_cmd,
 
 252         .cable_detect   = sil680_cable_detect,
 
 254         .bmdma_setup    = ata_bmdma_setup,
 
 255         .bmdma_start    = ata_bmdma_start,
 
 256         .bmdma_stop     = ata_bmdma_stop,
 
 257         .bmdma_status   = ata_bmdma_status,
 
 259         .qc_prep        = ata_qc_prep,
 
 260         .qc_issue       = ata_qc_issue_prot,
 
 262         .data_xfer      = ata_data_xfer,
 
 264         .irq_handler    = ata_interrupt,
 
 265         .irq_clear      = ata_bmdma_irq_clear,
 
 266         .irq_on         = ata_irq_on,
 
 267         .irq_ack        = ata_irq_ack,
 
 269         .port_start     = ata_port_start,
 
 273  *      sil680_init_chip                -       chip setup
 
 276  *      Perform all the chip setup which must be done both when the device
 
 277  *      is powered up on boot and when we resume in case we resumed from RAM.
 
 278  *      Returns the final clock settings.
 
 281 static u8 sil680_init_chip(struct pci_dev *pdev)
 
 286         pci_read_config_dword(pdev, PCI_CLASS_REVISION, &class_rev);
 
 288         /* FIXME: double check */
 
 289         pci_write_config_byte(pdev, PCI_CACHE_LINE_SIZE, (class_rev) ? 1 : 255);
 
 291         pci_write_config_byte(pdev, 0x80, 0x00);
 
 292         pci_write_config_byte(pdev, 0x84, 0x00);
 
 294         pci_read_config_byte(pdev, 0x8A, &tmpbyte);
 
 296         printk(KERN_INFO "sil680: BA5_EN = %d clock = %02X\n",
 
 297                         tmpbyte & 1, tmpbyte & 0x30);
 
 299         switch(tmpbyte & 0x30) {
 
 301                         /* 133 clock attempt to force it on */
 
 302                         pci_write_config_byte(pdev, 0x8A, tmpbyte|0x10);
 
 305                         /* if clocking is disabled */
 
 306                         /* 133 clock attempt to force it on */
 
 307                         pci_write_config_byte(pdev, 0x8A, tmpbyte & ~0x20);
 
 313                         /* BIOS set PCI x2 clocking */
 
 317         pci_read_config_byte(pdev,   0x8A, &tmpbyte);
 
 318         printk(KERN_INFO "sil680: BA5_EN = %d clock = %02X\n",
 
 319                         tmpbyte & 1, tmpbyte & 0x30);
 
 321         pci_write_config_byte(pdev,  0xA1, 0x72);
 
 322         pci_write_config_word(pdev,  0xA2, 0x328A);
 
 323         pci_write_config_dword(pdev, 0xA4, 0x62DD62DD);
 
 324         pci_write_config_dword(pdev, 0xA8, 0x43924392);
 
 325         pci_write_config_dword(pdev, 0xAC, 0x40094009);
 
 326         pci_write_config_byte(pdev,  0xB1, 0x72);
 
 327         pci_write_config_word(pdev,  0xB2, 0x328A);
 
 328         pci_write_config_dword(pdev, 0xB4, 0x62DD62DD);
 
 329         pci_write_config_dword(pdev, 0xB8, 0x43924392);
 
 330         pci_write_config_dword(pdev, 0xBC, 0x40094009);
 
 332         switch(tmpbyte & 0x30) {
 
 333                 case 0x00: printk(KERN_INFO "sil680: 100MHz clock.\n");break;
 
 334                 case 0x10: printk(KERN_INFO "sil680: 133MHz clock.\n");break;
 
 335                 case 0x20: printk(KERN_INFO "sil680: Using PCI clock.\n");break;
 
 336                 /* This last case is _NOT_ ok */
 
 337                 case 0x30: printk(KERN_ERR "sil680: Clock disabled ?\n");
 
 339         return tmpbyte & 0x30;
 
 342 static int sil680_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 
 344         static const struct ata_port_info info = {
 
 346                 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 350                 .port_ops = &sil680_port_ops
 
 352         static const struct ata_port_info info_slow = {
 
 354                 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
 
 358                 .port_ops = &sil680_port_ops
 
 360         const struct ata_port_info *ppi[] = { &info, NULL };
 
 361         static int printed_version;
 
 363         if (!printed_version++)
 
 364                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 
 366         switch(sil680_init_chip(pdev))
 
 374         return ata_pci_init_one(pdev, ppi);
 
 378 static int sil680_reinit_one(struct pci_dev *pdev)
 
 380         sil680_init_chip(pdev);
 
 381         return ata_pci_device_resume(pdev);
 
 385 static const struct pci_device_id sil680[] = {
 
 386         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_SII_680), },
 
 391 static struct pci_driver sil680_pci_driver = {
 
 394         .probe          = sil680_init_one,
 
 395         .remove         = ata_pci_remove_one,
 
 397         .suspend        = ata_pci_device_suspend,
 
 398         .resume         = sil680_reinit_one,
 
 402 static int __init sil680_init(void)
 
 404         return pci_register_driver(&sil680_pci_driver);
 
 407 static void __exit sil680_exit(void)
 
 409         pci_unregister_driver(&sil680_pci_driver);
 
 412 MODULE_AUTHOR("Alan Cox");
 
 413 MODULE_DESCRIPTION("low-level driver for SI680 PATA");
 
 414 MODULE_LICENSE("GPL");
 
 415 MODULE_DEVICE_TABLE(pci, sil680);
 
 416 MODULE_VERSION(DRV_VERSION);
 
 418 module_init(sil680_init);
 
 419 module_exit(sil680_exit);