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