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