Merge branch 'for-jeff' of git://htj.dyndns.org/libata-tj into tejun-merge
[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     "1.0"
50
51 enum {
52         /*
53          * host flags
54          */
55         SIL_FLAG_RERR_ON_DMA_ACT = (1 << 29),
56         SIL_FLAG_MOD15WRITE     = (1 << 30),
57         SIL_DFL_HOST_FLAGS      = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
58                                   ATA_FLAG_MMIO,
59
60         /*
61          * Controller IDs
62          */
63         sil_3112                = 0,
64         sil_3512                = 1,
65         sil_3114                = 2,
66
67         /*
68          * Register offsets
69          */
70         SIL_SYSCFG              = 0x48,
71
72         /*
73          * Register bits
74          */
75         /* SYSCFG */
76         SIL_MASK_IDE0_INT       = (1 << 22),
77         SIL_MASK_IDE1_INT       = (1 << 23),
78         SIL_MASK_IDE2_INT       = (1 << 24),
79         SIL_MASK_IDE3_INT       = (1 << 25),
80         SIL_MASK_2PORT          = SIL_MASK_IDE0_INT | SIL_MASK_IDE1_INT,
81         SIL_MASK_4PORT          = SIL_MASK_2PORT |
82                                   SIL_MASK_IDE2_INT | SIL_MASK_IDE3_INT,
83
84         /* BMDMA/BMDMA2 */
85         SIL_INTR_STEERING       = (1 << 1),
86
87         /*
88          * Others
89          */
90         SIL_QUIRK_MOD15WRITE    = (1 << 0),
91         SIL_QUIRK_UDMA5MAX      = (1 << 1),
92 };
93
94 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
95 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev);
96 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg);
97 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
98 static void sil_post_set_mode (struct ata_port *ap);
99 static void sil_freeze(struct ata_port *ap);
100 static void sil_thaw(struct ata_port *ap);
101
102
103 static const struct pci_device_id sil_pci_tbl[] = {
104         { 0x1095, 0x3112, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
105         { 0x1095, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
106         { 0x1095, 0x3512, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3512 },
107         { 0x1095, 0x3114, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3114 },
108         { 0x1002, 0x436e, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
109         { 0x1002, 0x4379, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
110         { 0x1002, 0x437a, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
111         { }     /* terminate list */
112 };
113
114
115 /* TODO firmware versions should be added - eric */
116 static const struct sil_drivelist {
117         const char * product;
118         unsigned int quirk;
119 } sil_blacklist [] = {
120         { "ST320012AS",         SIL_QUIRK_MOD15WRITE },
121         { "ST330013AS",         SIL_QUIRK_MOD15WRITE },
122         { "ST340017AS",         SIL_QUIRK_MOD15WRITE },
123         { "ST360015AS",         SIL_QUIRK_MOD15WRITE },
124         { "ST380013AS",         SIL_QUIRK_MOD15WRITE },
125         { "ST380023AS",         SIL_QUIRK_MOD15WRITE },
126         { "ST3120023AS",        SIL_QUIRK_MOD15WRITE },
127         { "ST3160023AS",        SIL_QUIRK_MOD15WRITE },
128         { "ST3120026AS",        SIL_QUIRK_MOD15WRITE },
129         { "ST3200822AS",        SIL_QUIRK_MOD15WRITE },
130         { "ST340014ASL",        SIL_QUIRK_MOD15WRITE },
131         { "ST360014ASL",        SIL_QUIRK_MOD15WRITE },
132         { "ST380011ASL",        SIL_QUIRK_MOD15WRITE },
133         { "ST3120022ASL",       SIL_QUIRK_MOD15WRITE },
134         { "ST3160021ASL",       SIL_QUIRK_MOD15WRITE },
135         { "Maxtor 4D060H3",     SIL_QUIRK_UDMA5MAX },
136         { }
137 };
138
139 static struct pci_driver sil_pci_driver = {
140         .name                   = DRV_NAME,
141         .id_table               = sil_pci_tbl,
142         .probe                  = sil_init_one,
143         .remove                 = ata_pci_remove_one,
144 };
145
146 static struct scsi_host_template sil_sht = {
147         .module                 = THIS_MODULE,
148         .name                   = DRV_NAME,
149         .ioctl                  = ata_scsi_ioctl,
150         .queuecommand           = ata_scsi_queuecmd,
151         .can_queue              = ATA_DEF_QUEUE,
152         .this_id                = ATA_SHT_THIS_ID,
153         .sg_tablesize           = LIBATA_MAX_PRD,
154         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
155         .emulated               = ATA_SHT_EMULATED,
156         .use_clustering         = ATA_SHT_USE_CLUSTERING,
157         .proc_name              = DRV_NAME,
158         .dma_boundary           = ATA_DMA_BOUNDARY,
159         .slave_configure        = ata_scsi_slave_config,
160         .bios_param             = ata_std_bios_param,
161 };
162
163 static const struct ata_port_operations sil_ops = {
164         .port_disable           = ata_port_disable,
165         .dev_config             = sil_dev_config,
166         .tf_load                = ata_tf_load,
167         .tf_read                = ata_tf_read,
168         .check_status           = ata_check_status,
169         .exec_command           = ata_exec_command,
170         .dev_select             = ata_std_dev_select,
171         .probe_reset            = ata_std_probe_reset,
172         .post_set_mode          = sil_post_set_mode,
173         .bmdma_setup            = ata_bmdma_setup,
174         .bmdma_start            = ata_bmdma_start,
175         .bmdma_stop             = ata_bmdma_stop,
176         .bmdma_status           = ata_bmdma_status,
177         .qc_prep                = ata_qc_prep,
178         .qc_issue               = ata_qc_issue_prot,
179         .freeze                 = sil_freeze,
180         .thaw                   = sil_thaw,
181         .error_handler          = ata_bmdma_error_handler,
182         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
183         .irq_handler            = ata_interrupt,
184         .irq_clear              = ata_bmdma_irq_clear,
185         .scr_read               = sil_scr_read,
186         .scr_write              = sil_scr_write,
187         .port_start             = ata_port_start,
188         .port_stop              = ata_port_stop,
189         .host_stop              = ata_pci_host_stop,
190 };
191
192 static const struct ata_port_info sil_port_info[] = {
193         /* sil_3112 */
194         {
195                 .sht            = &sil_sht,
196                 .host_flags     = SIL_DFL_HOST_FLAGS | SIL_FLAG_MOD15WRITE,
197                 .pio_mask       = 0x1f,                 /* pio0-4 */
198                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
199                 .udma_mask      = 0x3f,                 /* udma0-5 */
200                 .port_ops       = &sil_ops,
201         },
202         /* sil_3512 */
203         {
204                 .sht            = &sil_sht,
205                 .host_flags     = SIL_DFL_HOST_FLAGS | SIL_FLAG_RERR_ON_DMA_ACT,
206                 .pio_mask       = 0x1f,                 /* pio0-4 */
207                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
208                 .udma_mask      = 0x3f,                 /* udma0-5 */
209                 .port_ops       = &sil_ops,
210         },
211         /* sil_3114 */
212         {
213                 .sht            = &sil_sht,
214                 .host_flags     = SIL_DFL_HOST_FLAGS | SIL_FLAG_RERR_ON_DMA_ACT,
215                 .pio_mask       = 0x1f,                 /* pio0-4 */
216                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
217                 .udma_mask      = 0x3f,                 /* udma0-5 */
218                 .port_ops       = &sil_ops,
219         },
220 };
221
222 /* per-port register offsets */
223 /* TODO: we can probably calculate rather than use a table */
224 static const struct {
225         unsigned long tf;       /* ATA taskfile register block */
226         unsigned long ctl;      /* ATA control/altstatus register block */
227         unsigned long bmdma;    /* DMA register block */
228         unsigned long fifo_cfg; /* FIFO Valid Byte Count and Control */
229         unsigned long scr;      /* SATA control register block */
230         unsigned long sien;     /* SATA Interrupt Enable register */
231         unsigned long xfer_mode;/* data transfer mode register */
232         unsigned long sfis_cfg; /* SATA FIS reception config register */
233 } sil_port[] = {
234         /* port 0 ... */
235         { 0x80, 0x8A, 0x00, 0x40, 0x100, 0x148, 0xb4, 0x14c },
236         { 0xC0, 0xCA, 0x08, 0x44, 0x180, 0x1c8, 0xf4, 0x1cc },
237         { 0x280, 0x28A, 0x200, 0x240, 0x300, 0x348, 0x2b4, 0x34c },
238         { 0x2C0, 0x2CA, 0x208, 0x244, 0x380, 0x3c8, 0x2f4, 0x3cc },
239         /* ... port 3 */
240 };
241
242 MODULE_AUTHOR("Jeff Garzik");
243 MODULE_DESCRIPTION("low-level driver for Silicon Image SATA controller");
244 MODULE_LICENSE("GPL");
245 MODULE_DEVICE_TABLE(pci, sil_pci_tbl);
246 MODULE_VERSION(DRV_VERSION);
247
248 static int slow_down = 0;
249 module_param(slow_down, int, 0444);
250 MODULE_PARM_DESC(slow_down, "Sledgehammer used to work around random problems, by limiting commands to 15 sectors (0=off, 1=on)");
251
252
253 static unsigned char sil_get_device_cache_line(struct pci_dev *pdev)
254 {
255         u8 cache_line = 0;
256         pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &cache_line);
257         return cache_line;
258 }
259
260 static void sil_post_set_mode (struct ata_port *ap)
261 {
262         struct ata_host_set *host_set = ap->host_set;
263         struct ata_device *dev;
264         void __iomem *addr =
265                 host_set->mmio_base + sil_port[ap->port_no].xfer_mode;
266         u32 tmp, dev_mode[2];
267         unsigned int i;
268
269         for (i = 0; i < 2; i++) {
270                 dev = &ap->device[i];
271                 if (!ata_dev_enabled(dev))
272                         dev_mode[i] = 0;        /* PIO0/1/2 */
273                 else if (dev->flags & ATA_DFLAG_PIO)
274                         dev_mode[i] = 1;        /* PIO3/4 */
275                 else
276                         dev_mode[i] = 3;        /* UDMA */
277                 /* value 2 indicates MDMA */
278         }
279
280         tmp = readl(addr);
281         tmp &= ~((1<<5) | (1<<4) | (1<<1) | (1<<0));
282         tmp |= dev_mode[0];
283         tmp |= (dev_mode[1] << 4);
284         writel(tmp, addr);
285         readl(addr);    /* flush */
286 }
287
288 static inline unsigned long sil_scr_addr(struct ata_port *ap, unsigned int sc_reg)
289 {
290         unsigned long offset = ap->ioaddr.scr_addr;
291
292         switch (sc_reg) {
293         case SCR_STATUS:
294                 return offset + 4;
295         case SCR_ERROR:
296                 return offset + 8;
297         case SCR_CONTROL:
298                 return offset;
299         default:
300                 /* do nothing */
301                 break;
302         }
303
304         return 0;
305 }
306
307 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg)
308 {
309         void __iomem *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
310         if (mmio)
311                 return readl(mmio);
312         return 0xffffffffU;
313 }
314
315 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
316 {
317         void *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
318         if (mmio)
319                 writel(val, mmio);
320 }
321
322 static void sil_freeze(struct ata_port *ap)
323 {
324         void __iomem *mmio_base = ap->host_set->mmio_base;
325         u32 tmp;
326
327         /* plug IRQ */
328         tmp = readl(mmio_base + SIL_SYSCFG);
329         tmp |= SIL_MASK_IDE0_INT << ap->port_no;
330         writel(tmp, mmio_base + SIL_SYSCFG);
331         readl(mmio_base + SIL_SYSCFG);  /* flush */
332 }
333
334 static void sil_thaw(struct ata_port *ap)
335 {
336         void __iomem *mmio_base = ap->host_set->mmio_base;
337         u32 tmp;
338
339         /* clear IRQ */
340         ata_chk_status(ap);
341         ata_bmdma_irq_clear(ap);
342
343         /* turn on IRQ */
344         tmp = readl(mmio_base + SIL_SYSCFG);
345         tmp &= ~(SIL_MASK_IDE0_INT << ap->port_no);
346         writel(tmp, mmio_base + SIL_SYSCFG);
347 }
348
349 /**
350  *      sil_dev_config - Apply device/host-specific errata fixups
351  *      @ap: Port containing device to be examined
352  *      @dev: Device to be examined
353  *
354  *      After the IDENTIFY [PACKET] DEVICE step is complete, and a
355  *      device is known to be present, this function is called.
356  *      We apply two errata fixups which are specific to Silicon Image,
357  *      a Seagate and a Maxtor fixup.
358  *
359  *      For certain Seagate devices, we must limit the maximum sectors
360  *      to under 8K.
361  *
362  *      For certain Maxtor devices, we must not program the drive
363  *      beyond udma5.
364  *
365  *      Both fixups are unfairly pessimistic.  As soon as I get more
366  *      information on these errata, I will create a more exhaustive
367  *      list, and apply the fixups to only the specific
368  *      devices/hosts/firmwares that need it.
369  *
370  *      20040111 - Seagate drives affected by the Mod15Write bug are blacklisted
371  *      The Maxtor quirk is in the blacklist, but I'm keeping the original
372  *      pessimistic fix for the following reasons...
373  *      - There seems to be less info on it, only one device gleaned off the
374  *      Windows driver, maybe only one is affected.  More info would be greatly
375  *      appreciated.
376  *      - But then again UDMA5 is hardly anything to complain about
377  */
378 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev)
379 {
380         unsigned int n, quirks = 0;
381         unsigned char model_num[41];
382
383         ata_id_c_string(dev->id, model_num, ATA_ID_PROD_OFS, sizeof(model_num));
384
385         for (n = 0; sil_blacklist[n].product; n++)
386                 if (!strcmp(sil_blacklist[n].product, model_num)) {
387                         quirks = sil_blacklist[n].quirk;
388                         break;
389                 }
390
391         /* limit requests to 15 sectors */
392         if (slow_down ||
393             ((ap->flags & SIL_FLAG_MOD15WRITE) &&
394              (quirks & SIL_QUIRK_MOD15WRITE))) {
395                 ata_dev_printk(dev, KERN_INFO, "applying Seagate errata fix "
396                                "(mod15write workaround)\n");
397                 dev->max_sectors = 15;
398                 return;
399         }
400
401         /* limit to udma5 */
402         if (quirks & SIL_QUIRK_UDMA5MAX) {
403                 ata_dev_printk(dev, KERN_INFO,
404                                "applying Maxtor errata fix %s\n", model_num);
405                 dev->udma_mask &= ATA_UDMA5;
406                 return;
407         }
408 }
409
410 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
411 {
412         static int printed_version;
413         struct ata_probe_ent *probe_ent = NULL;
414         unsigned long base;
415         void __iomem *mmio_base;
416         int rc;
417         unsigned int i;
418         int pci_dev_busy = 0;
419         u32 tmp;
420         u8 cls;
421
422         if (!printed_version++)
423                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
424
425         rc = pci_enable_device(pdev);
426         if (rc)
427                 return rc;
428
429         rc = pci_request_regions(pdev, DRV_NAME);
430         if (rc) {
431                 pci_dev_busy = 1;
432                 goto err_out;
433         }
434
435         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
436         if (rc)
437                 goto err_out_regions;
438         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
439         if (rc)
440                 goto err_out_regions;
441
442         probe_ent = kzalloc(sizeof(*probe_ent), GFP_KERNEL);
443         if (probe_ent == NULL) {
444                 rc = -ENOMEM;
445                 goto err_out_regions;
446         }
447
448         INIT_LIST_HEAD(&probe_ent->node);
449         probe_ent->dev = pci_dev_to_dev(pdev);
450         probe_ent->port_ops = sil_port_info[ent->driver_data].port_ops;
451         probe_ent->sht = sil_port_info[ent->driver_data].sht;
452         probe_ent->n_ports = (ent->driver_data == sil_3114) ? 4 : 2;
453         probe_ent->pio_mask = sil_port_info[ent->driver_data].pio_mask;
454         probe_ent->mwdma_mask = sil_port_info[ent->driver_data].mwdma_mask;
455         probe_ent->udma_mask = sil_port_info[ent->driver_data].udma_mask;
456         probe_ent->irq = pdev->irq;
457         probe_ent->irq_flags = SA_SHIRQ;
458         probe_ent->host_flags = sil_port_info[ent->driver_data].host_flags;
459
460         mmio_base = pci_iomap(pdev, 5, 0);
461         if (mmio_base == NULL) {
462                 rc = -ENOMEM;
463                 goto err_out_free_ent;
464         }
465
466         probe_ent->mmio_base = mmio_base;
467
468         base = (unsigned long) mmio_base;
469
470         for (i = 0; i < probe_ent->n_ports; i++) {
471                 probe_ent->port[i].cmd_addr = base + sil_port[i].tf;
472                 probe_ent->port[i].altstatus_addr =
473                 probe_ent->port[i].ctl_addr = base + sil_port[i].ctl;
474                 probe_ent->port[i].bmdma_addr = base + sil_port[i].bmdma;
475                 probe_ent->port[i].scr_addr = base + sil_port[i].scr;
476                 ata_std_ports(&probe_ent->port[i]);
477         }
478
479         /* Initialize FIFO PCI bus arbitration */
480         cls = sil_get_device_cache_line(pdev);
481         if (cls) {
482                 cls >>= 3;
483                 cls++;  /* cls = (line_size/8)+1 */
484                 for (i = 0; i < probe_ent->n_ports; i++)
485                         writew(cls << 8 | cls,
486                                mmio_base + sil_port[i].fifo_cfg);
487         } else
488                 dev_printk(KERN_WARNING, &pdev->dev,
489                            "cache line size not set.  Driver may not function\n");
490
491         /* Apply R_ERR on DMA activate FIS errata workaround */
492         if (probe_ent->host_flags & SIL_FLAG_RERR_ON_DMA_ACT) {
493                 int cnt;
494
495                 for (i = 0, cnt = 0; i < probe_ent->n_ports; i++) {
496                         tmp = readl(mmio_base + sil_port[i].sfis_cfg);
497                         if ((tmp & 0x3) != 0x01)
498                                 continue;
499                         if (!cnt)
500                                 dev_printk(KERN_INFO, &pdev->dev,
501                                            "Applying R_ERR on DMA activate "
502                                            "FIS errata fix\n");
503                         writel(tmp & ~0x3, mmio_base + sil_port[i].sfis_cfg);
504                         cnt++;
505                 }
506         }
507
508         if (ent->driver_data == sil_3114) {
509                 /* flip the magic "make 4 ports work" bit */
510                 tmp = readl(mmio_base + sil_port[2].bmdma);
511                 if ((tmp & SIL_INTR_STEERING) == 0)
512                         writel(tmp | SIL_INTR_STEERING,
513                                mmio_base + sil_port[2].bmdma);
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);