Merge branch 'master'
[linux-2.6] / drivers / scsi / sata_sil.c
1 /*
2  *  sata_sil.c - Silicon Image 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-2005 Red Hat, Inc.
9  *  Copyright 2003 Benjamin Herrenschmidt
10  *
11  *
12  *  This program is free software; you can redistribute it and/or modify
13  *  it under the terms of the GNU General Public License as published by
14  *  the Free Software Foundation; either version 2, or (at your option)
15  *  any later version.
16  *
17  *  This program is distributed in the hope that it will be useful,
18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  *  GNU General Public License for more details.
21  *
22  *  You should have received a copy of the GNU General Public License
23  *  along with this program; see the file COPYING.  If not, write to
24  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25  *
26  *
27  *  libata documentation is available via 'make {ps|pdf}docs',
28  *  as Documentation/DocBook/libata.*
29  *
30  *  Documentation for SiI 3112:
31  *  http://gkernel.sourceforge.net/specs/sii/3112A_SiI-DS-0095-B2.pdf.bz2
32  *
33  *  Other errata and documentation available under NDA.
34  *
35  */
36
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/pci.h>
40 #include <linux/init.h>
41 #include <linux/blkdev.h>
42 #include <linux/delay.h>
43 #include <linux/interrupt.h>
44 #include <linux/device.h>
45 #include <scsi/scsi_host.h>
46 #include <linux/libata.h>
47
48 #define DRV_NAME        "sata_sil"
49 #define DRV_VERSION     "0.9"
50
51 enum {
52         SIL_FLAG_RERR_ON_DMA_ACT = (1 << 29),
53         SIL_FLAG_MOD15WRITE     = (1 << 30),
54
55         sil_3112                = 0,
56         sil_3112_m15w           = 1,
57         sil_3512                = 2,
58         sil_3114                = 3,
59
60         SIL_FIFO_R0             = 0x40,
61         SIL_FIFO_W0             = 0x41,
62         SIL_FIFO_R1             = 0x44,
63         SIL_FIFO_W1             = 0x45,
64         SIL_FIFO_R2             = 0x240,
65         SIL_FIFO_W2             = 0x241,
66         SIL_FIFO_R3             = 0x244,
67         SIL_FIFO_W3             = 0x245,
68
69         SIL_SYSCFG              = 0x48,
70         SIL_MASK_IDE0_INT       = (1 << 22),
71         SIL_MASK_IDE1_INT       = (1 << 23),
72         SIL_MASK_IDE2_INT       = (1 << 24),
73         SIL_MASK_IDE3_INT       = (1 << 25),
74         SIL_MASK_2PORT          = SIL_MASK_IDE0_INT | SIL_MASK_IDE1_INT,
75         SIL_MASK_4PORT          = SIL_MASK_2PORT |
76                                   SIL_MASK_IDE2_INT | SIL_MASK_IDE3_INT,
77
78         SIL_IDE2_BMDMA          = 0x200,
79
80         SIL_INTR_STEERING       = (1 << 1),
81         SIL_QUIRK_MOD15WRITE    = (1 << 0),
82         SIL_QUIRK_UDMA5MAX      = (1 << 1),
83 };
84
85 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
86 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev);
87 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg);
88 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
89 static void sil_post_set_mode (struct ata_port *ap);
90
91
92 static const struct pci_device_id sil_pci_tbl[] = {
93         { 0x1095, 0x3112, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
94         { 0x1095, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
95         { 0x1095, 0x3512, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3512 },
96         { 0x1095, 0x3114, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3114 },
97         { 0x1002, 0x436e, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
98         { 0x1002, 0x4379, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
99         { 0x1002, 0x437a, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
100         { }     /* terminate list */
101 };
102
103
104 /* TODO firmware versions should be added - eric */
105 static const struct sil_drivelist {
106         const char * product;
107         unsigned int quirk;
108 } sil_blacklist [] = {
109         { "ST320012AS",         SIL_QUIRK_MOD15WRITE },
110         { "ST330013AS",         SIL_QUIRK_MOD15WRITE },
111         { "ST340017AS",         SIL_QUIRK_MOD15WRITE },
112         { "ST360015AS",         SIL_QUIRK_MOD15WRITE },
113         { "ST380013AS",         SIL_QUIRK_MOD15WRITE },
114         { "ST380023AS",         SIL_QUIRK_MOD15WRITE },
115         { "ST3120023AS",        SIL_QUIRK_MOD15WRITE },
116         { "ST3160023AS",        SIL_QUIRK_MOD15WRITE },
117         { "ST3120026AS",        SIL_QUIRK_MOD15WRITE },
118         { "ST3200822AS",        SIL_QUIRK_MOD15WRITE },
119         { "ST340014ASL",        SIL_QUIRK_MOD15WRITE },
120         { "ST360014ASL",        SIL_QUIRK_MOD15WRITE },
121         { "ST380011ASL",        SIL_QUIRK_MOD15WRITE },
122         { "ST3120022ASL",       SIL_QUIRK_MOD15WRITE },
123         { "ST3160021ASL",       SIL_QUIRK_MOD15WRITE },
124         { "Maxtor 4D060H3",     SIL_QUIRK_UDMA5MAX },
125         { }
126 };
127
128 static struct pci_driver sil_pci_driver = {
129         .name                   = DRV_NAME,
130         .id_table               = sil_pci_tbl,
131         .probe                  = sil_init_one,
132         .remove                 = ata_pci_remove_one,
133 };
134
135 static struct scsi_host_template sil_sht = {
136         .module                 = THIS_MODULE,
137         .name                   = DRV_NAME,
138         .ioctl                  = ata_scsi_ioctl,
139         .queuecommand           = ata_scsi_queuecmd,
140         .eh_timed_out           = ata_scsi_timed_out,
141         .eh_strategy_handler    = ata_scsi_error,
142         .can_queue              = ATA_DEF_QUEUE,
143         .this_id                = ATA_SHT_THIS_ID,
144         .sg_tablesize           = LIBATA_MAX_PRD,
145         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
146         .emulated               = ATA_SHT_EMULATED,
147         .use_clustering         = ATA_SHT_USE_CLUSTERING,
148         .proc_name              = DRV_NAME,
149         .dma_boundary           = ATA_DMA_BOUNDARY,
150         .slave_configure        = ata_scsi_slave_config,
151         .bios_param             = ata_std_bios_param,
152 };
153
154 static const struct ata_port_operations sil_ops = {
155         .port_disable           = ata_port_disable,
156         .dev_config             = sil_dev_config,
157         .tf_load                = ata_tf_load,
158         .tf_read                = ata_tf_read,
159         .check_status           = ata_check_status,
160         .exec_command           = ata_exec_command,
161         .dev_select             = ata_std_dev_select,
162         .probe_reset            = ata_std_probe_reset,
163         .post_set_mode          = sil_post_set_mode,
164         .bmdma_setup            = ata_bmdma_setup,
165         .bmdma_start            = ata_bmdma_start,
166         .bmdma_stop             = ata_bmdma_stop,
167         .bmdma_status           = ata_bmdma_status,
168         .qc_prep                = ata_qc_prep,
169         .qc_issue               = ata_qc_issue_prot,
170         .eng_timeout            = ata_eng_timeout,
171         .irq_handler            = ata_interrupt,
172         .irq_clear              = ata_bmdma_irq_clear,
173         .scr_read               = sil_scr_read,
174         .scr_write              = sil_scr_write,
175         .port_start             = ata_port_start,
176         .port_stop              = ata_port_stop,
177         .host_stop              = ata_pci_host_stop,
178 };
179
180 static const struct ata_port_info sil_port_info[] = {
181         /* sil_3112 */
182         {
183                 .sht            = &sil_sht,
184                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
185                                   ATA_FLAG_MMIO,
186                 .pio_mask       = 0x1f,                 /* pio0-4 */
187                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
188                 .udma_mask      = 0x3f,                 /* udma0-5 */
189                 .port_ops       = &sil_ops,
190         },
191         /* sil_3112_15w - keep it sync'd w/ sil_3112 */
192         {
193                 .sht            = &sil_sht,
194                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
195                                   ATA_FLAG_MMIO | SIL_FLAG_MOD15WRITE,
196                 .pio_mask       = 0x1f,                 /* pio0-4 */
197                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
198                 .udma_mask      = 0x3f,                 /* udma0-5 */
199                 .port_ops       = &sil_ops,
200         },
201         /* sil_3512 */
202         {
203                 .sht            = &sil_sht,
204                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
205                                   ATA_FLAG_SRST | ATA_FLAG_MMIO |
206                                   SIL_FLAG_RERR_ON_DMA_ACT,
207                 .pio_mask       = 0x1f,                 /* pio0-4 */
208                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
209                 .udma_mask      = 0x3f,                 /* udma0-5 */
210                 .port_ops       = &sil_ops,
211         },
212         /* sil_3114 */
213         {
214                 .sht            = &sil_sht,
215                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
216                                   ATA_FLAG_MMIO |
217                                   SIL_FLAG_RERR_ON_DMA_ACT,
218                 .pio_mask       = 0x1f,                 /* pio0-4 */
219                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
220                 .udma_mask      = 0x3f,                 /* udma0-5 */
221                 .port_ops       = &sil_ops,
222         },
223 };
224
225 /* per-port register offsets */
226 /* TODO: we can probably calculate rather than use a table */
227 static const struct {
228         unsigned long tf;       /* ATA taskfile register block */
229         unsigned long ctl;      /* ATA control/altstatus register block */
230         unsigned long bmdma;    /* DMA register block */
231         unsigned long scr;      /* SATA control register block */
232         unsigned long sien;     /* SATA Interrupt Enable register */
233         unsigned long xfer_mode;/* data transfer mode register */
234         unsigned long sfis_cfg; /* SATA FIS reception config register */
235 } sil_port[] = {
236         /* port 0 ... */
237         { 0x80, 0x8A, 0x00, 0x100, 0x148, 0xb4, 0x14c },
238         { 0xC0, 0xCA, 0x08, 0x180, 0x1c8, 0xf4, 0x1cc },
239         { 0x280, 0x28A, 0x200, 0x300, 0x348, 0x2b4, 0x34c },
240         { 0x2C0, 0x2CA, 0x208, 0x380, 0x3c8, 0x2f4, 0x3cc },
241         /* ... port 3 */
242 };
243
244 MODULE_AUTHOR("Jeff Garzik");
245 MODULE_DESCRIPTION("low-level driver for Silicon Image SATA controller");
246 MODULE_LICENSE("GPL");
247 MODULE_DEVICE_TABLE(pci, sil_pci_tbl);
248 MODULE_VERSION(DRV_VERSION);
249
250 static int slow_down = 0;
251 module_param(slow_down, int, 0444);
252 MODULE_PARM_DESC(slow_down, "Sledgehammer used to work around random problems, by limiting commands to 15 sectors (0=off, 1=on)");
253
254
255 static unsigned char sil_get_device_cache_line(struct pci_dev *pdev)
256 {
257         u8 cache_line = 0;
258         pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &cache_line);
259         return cache_line;
260 }
261
262 static void sil_post_set_mode (struct ata_port *ap)
263 {
264         struct ata_host_set *host_set = ap->host_set;
265         struct ata_device *dev;
266         void __iomem *addr =
267                 host_set->mmio_base + sil_port[ap->port_no].xfer_mode;
268         u32 tmp, dev_mode[2];
269         unsigned int i;
270
271         for (i = 0; i < 2; i++) {
272                 dev = &ap->device[i];
273                 if (!ata_dev_present(dev))
274                         dev_mode[i] = 0;        /* PIO0/1/2 */
275                 else if (dev->flags & ATA_DFLAG_PIO)
276                         dev_mode[i] = 1;        /* PIO3/4 */
277                 else
278                         dev_mode[i] = 3;        /* UDMA */
279                 /* value 2 indicates MDMA */
280         }
281
282         tmp = readl(addr);
283         tmp &= ~((1<<5) | (1<<4) | (1<<1) | (1<<0));
284         tmp |= dev_mode[0];
285         tmp |= (dev_mode[1] << 4);
286         writel(tmp, addr);
287         readl(addr);    /* flush */
288 }
289
290 static inline unsigned long sil_scr_addr(struct ata_port *ap, unsigned int sc_reg)
291 {
292         unsigned long offset = ap->ioaddr.scr_addr;
293
294         switch (sc_reg) {
295         case SCR_STATUS:
296                 return offset + 4;
297         case SCR_ERROR:
298                 return offset + 8;
299         case SCR_CONTROL:
300                 return offset;
301         default:
302                 /* do nothing */
303                 break;
304         }
305
306         return 0;
307 }
308
309 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg)
310 {
311         void __iomem *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
312         if (mmio)
313                 return readl(mmio);
314         return 0xffffffffU;
315 }
316
317 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
318 {
319         void *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
320         if (mmio)
321                 writel(val, mmio);
322 }
323
324 /**
325  *      sil_dev_config - Apply device/host-specific errata fixups
326  *      @ap: Port containing device to be examined
327  *      @dev: Device to be examined
328  *
329  *      After the IDENTIFY [PACKET] DEVICE step is complete, and a
330  *      device is known to be present, this function is called.
331  *      We apply two errata fixups which are specific to Silicon Image,
332  *      a Seagate and a Maxtor fixup.
333  *
334  *      For certain Seagate devices, we must limit the maximum sectors
335  *      to under 8K.
336  *
337  *      For certain Maxtor devices, we must not program the drive
338  *      beyond udma5.
339  *
340  *      Both fixups are unfairly pessimistic.  As soon as I get more
341  *      information on these errata, I will create a more exhaustive
342  *      list, and apply the fixups to only the specific
343  *      devices/hosts/firmwares that need it.
344  *
345  *      20040111 - Seagate drives affected by the Mod15Write bug are blacklisted
346  *      The Maxtor quirk is in the blacklist, but I'm keeping the original
347  *      pessimistic fix for the following reasons...
348  *      - There seems to be less info on it, only one device gleaned off the
349  *      Windows driver, maybe only one is affected.  More info would be greatly
350  *      appreciated.
351  *      - But then again UDMA5 is hardly anything to complain about
352  */
353 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev)
354 {
355         unsigned int n, quirks = 0;
356         unsigned char model_num[41];
357
358         ata_id_c_string(dev->id, model_num, ATA_ID_PROD_OFS, sizeof(model_num));
359
360         for (n = 0; sil_blacklist[n].product; n++)
361                 if (!strcmp(sil_blacklist[n].product, model_num)) {
362                         quirks = sil_blacklist[n].quirk;
363                         break;
364                 }
365
366         /* limit requests to 15 sectors */
367         if (slow_down ||
368             ((ap->flags & SIL_FLAG_MOD15WRITE) &&
369              (quirks & SIL_QUIRK_MOD15WRITE))) {
370                 printk(KERN_INFO "ata%u(%u): applying Seagate errata fix (mod15write workaround)\n",
371                        ap->id, dev->devno);
372                 dev->max_sectors = 15;
373                 return;
374         }
375
376         /* limit to udma5 */
377         if (quirks & SIL_QUIRK_UDMA5MAX) {
378                 printk(KERN_INFO "ata%u(%u): applying Maxtor errata fix %s\n",
379                        ap->id, dev->devno, model_num);
380                 ap->udma_mask &= ATA_UDMA5;
381                 return;
382         }
383 }
384
385 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
386 {
387         static int printed_version;
388         struct ata_probe_ent *probe_ent = NULL;
389         unsigned long base;
390         void __iomem *mmio_base;
391         int rc;
392         unsigned int i;
393         int pci_dev_busy = 0;
394         u32 tmp, irq_mask;
395         u8 cls;
396
397         if (!printed_version++)
398                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
399
400         /*
401          * If this driver happens to only be useful on Apple's K2, then
402          * we should check that here as it has a normal Serverworks ID
403          */
404         rc = pci_enable_device(pdev);
405         if (rc)
406                 return rc;
407
408         rc = pci_request_regions(pdev, DRV_NAME);
409         if (rc) {
410                 pci_dev_busy = 1;
411                 goto err_out;
412         }
413
414         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
415         if (rc)
416                 goto err_out_regions;
417         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
418         if (rc)
419                 goto err_out_regions;
420
421         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
422         if (probe_ent == NULL) {
423                 rc = -ENOMEM;
424                 goto err_out_regions;
425         }
426
427         memset(probe_ent, 0, sizeof(*probe_ent));
428         INIT_LIST_HEAD(&probe_ent->node);
429         probe_ent->dev = pci_dev_to_dev(pdev);
430         probe_ent->port_ops = sil_port_info[ent->driver_data].port_ops;
431         probe_ent->sht = sil_port_info[ent->driver_data].sht;
432         probe_ent->n_ports = (ent->driver_data == sil_3114) ? 4 : 2;
433         probe_ent->pio_mask = sil_port_info[ent->driver_data].pio_mask;
434         probe_ent->mwdma_mask = sil_port_info[ent->driver_data].mwdma_mask;
435         probe_ent->udma_mask = sil_port_info[ent->driver_data].udma_mask;
436         probe_ent->irq = pdev->irq;
437         probe_ent->irq_flags = SA_SHIRQ;
438         probe_ent->host_flags = sil_port_info[ent->driver_data].host_flags;
439
440         mmio_base = pci_iomap(pdev, 5, 0);
441         if (mmio_base == NULL) {
442                 rc = -ENOMEM;
443                 goto err_out_free_ent;
444         }
445
446         probe_ent->mmio_base = mmio_base;
447
448         base = (unsigned long) mmio_base;
449
450         for (i = 0; i < probe_ent->n_ports; i++) {
451                 probe_ent->port[i].cmd_addr = base + sil_port[i].tf;
452                 probe_ent->port[i].altstatus_addr =
453                 probe_ent->port[i].ctl_addr = base + sil_port[i].ctl;
454                 probe_ent->port[i].bmdma_addr = base + sil_port[i].bmdma;
455                 probe_ent->port[i].scr_addr = base + sil_port[i].scr;
456                 ata_std_ports(&probe_ent->port[i]);
457         }
458
459         /* Initialize FIFO PCI bus arbitration */
460         cls = sil_get_device_cache_line(pdev);
461         if (cls) {
462                 cls >>= 3;
463                 cls++;  /* cls = (line_size/8)+1 */
464                 writeb(cls, mmio_base + SIL_FIFO_R0);
465                 writeb(cls, mmio_base + SIL_FIFO_W0);
466                 writeb(cls, mmio_base + SIL_FIFO_R1);
467                 writeb(cls, mmio_base + SIL_FIFO_W1);
468                 if (ent->driver_data == sil_3114) {
469                         writeb(cls, mmio_base + SIL_FIFO_R2);
470                         writeb(cls, mmio_base + SIL_FIFO_W2);
471                         writeb(cls, mmio_base + SIL_FIFO_R3);
472                         writeb(cls, mmio_base + SIL_FIFO_W3);
473                 }
474         } else
475                 dev_printk(KERN_WARNING, &pdev->dev,
476                          "cache line size not set.  Driver may not function\n");
477
478         /* Apply R_ERR on DMA activate FIS errata workaround */
479         if (probe_ent->host_flags & SIL_FLAG_RERR_ON_DMA_ACT) {
480                 int cnt;
481
482                 for (i = 0, cnt = 0; i < probe_ent->n_ports; i++) {
483                         tmp = readl(mmio_base + sil_port[i].sfis_cfg);
484                         if ((tmp & 0x3) != 0x01)
485                                 continue;
486                         if (!cnt)
487                                 dev_printk(KERN_INFO, &pdev->dev,
488                                            "Applying R_ERR on DMA activate "
489                                            "FIS errata fix\n");
490                         writel(tmp & ~0x3, mmio_base + sil_port[i].sfis_cfg);
491                         cnt++;
492                 }
493         }
494
495         if (ent->driver_data == sil_3114) {
496                 irq_mask = SIL_MASK_4PORT;
497
498                 /* flip the magic "make 4 ports work" bit */
499                 tmp = readl(mmio_base + SIL_IDE2_BMDMA);
500                 if ((tmp & SIL_INTR_STEERING) == 0)
501                         writel(tmp | SIL_INTR_STEERING,
502                                mmio_base + SIL_IDE2_BMDMA);
503
504         } else {
505                 irq_mask = SIL_MASK_2PORT;
506         }
507
508         /* make sure IDE0/1/2/3 interrupts are not masked */
509         tmp = readl(mmio_base + SIL_SYSCFG);
510         if (tmp & irq_mask) {
511                 tmp &= ~irq_mask;
512                 writel(tmp, mmio_base + SIL_SYSCFG);
513                 readl(mmio_base + SIL_SYSCFG);  /* flush */
514         }
515
516         /* mask all SATA phy-related interrupts */
517         /* TODO: unmask bit 6 (SError N bit) for hotplug */
518         for (i = 0; i < probe_ent->n_ports; i++)
519                 writel(0, mmio_base + sil_port[i].sien);
520
521         pci_set_master(pdev);
522
523         /* FIXME: check ata_device_add return value */
524         ata_device_add(probe_ent);
525         kfree(probe_ent);
526
527         return 0;
528
529 err_out_free_ent:
530         kfree(probe_ent);
531 err_out_regions:
532         pci_release_regions(pdev);
533 err_out:
534         if (!pci_dev_busy)
535                 pci_disable_device(pdev);
536         return rc;
537 }
538
539 static int __init sil_init(void)
540 {
541         return pci_module_init(&sil_pci_driver);
542 }
543
544 static void __exit sil_exit(void)
545 {
546         pci_unregister_driver(&sil_pci_driver);
547 }
548
549
550 module_init(sil_init);
551 module_exit(sil_exit);