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