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