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