6b558195a76faf2aeee42a5250232a8183b730ac
[linux-3.10.git] / drivers / ata / sata_via.c
1 /*
2  *  sata_via.c - VIA Serial ATA controllers
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-2004 Red Hat, Inc.  All rights reserved.
9  *  Copyright 2003-2004 Jeff Garzik
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  *  Hardware documentation available under NDA.
31  *
32  *
33  *  To-do list:
34  *  - VT6421 PATA support
35  *
36  */
37
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/pci.h>
41 #include <linux/init.h>
42 #include <linux/blkdev.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <scsi/scsi_host.h>
46 #include <linux/libata.h>
47
48 #define DRV_NAME        "sata_via"
49 #define DRV_VERSION     "2.0"
50
51 enum board_ids_enum {
52         vt6420,
53         vt6421,
54 };
55
56 enum {
57         SATA_CHAN_ENAB          = 0x40, /* SATA channel enable */
58         SATA_INT_GATE           = 0x41, /* SATA interrupt gating */
59         SATA_NATIVE_MODE        = 0x42, /* Native mode enable */
60         SATA_PATA_SHARING       = 0x49, /* PATA/SATA sharing func ctrl */
61         PATA_UDMA_TIMING        = 0xB3, /* PATA timing for DMA/ cable detect */
62         PATA_PIO_TIMING         = 0xAB, /* PATA timing register */
63         
64         PORT0                   = (1 << 1),
65         PORT1                   = (1 << 0),
66         ALL_PORTS               = PORT0 | PORT1,
67         PATA_PORT               = 2,    /* PATA is port 2 */
68         N_PORTS                 = 3,
69
70         NATIVE_MODE_ALL         = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
71
72         SATA_EXT_PHY            = (1 << 6), /* 0==use PATA, 1==ext phy */
73         SATA_2DEV               = (1 << 5), /* SATA is master/slave */
74 };
75
76 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
77 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg);
78 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
79 static void svia_noop_freeze(struct ata_port *ap);
80 static void vt6420_error_handler(struct ata_port *ap);
81 static void vt6421_sata_error_handler(struct ata_port *ap);
82 static void vt6421_pata_error_handler(struct ata_port *ap);
83 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev);
84 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev);
85 static int vt6421_port_start(struct ata_port *ap);
86
87 static const struct pci_device_id svia_pci_tbl[] = {
88         { PCI_VDEVICE(VIA, 0x5337), vt6420 },
89         { PCI_VDEVICE(VIA, 0x0591), vt6420 },
90         { PCI_VDEVICE(VIA, 0x3149), vt6420 },
91         { PCI_VDEVICE(VIA, 0x3249), vt6421 },
92
93         { }     /* terminate list */
94 };
95
96 static struct pci_driver svia_pci_driver = {
97         .name                   = DRV_NAME,
98         .id_table               = svia_pci_tbl,
99         .probe                  = svia_init_one,
100         .remove                 = ata_pci_remove_one,
101 };
102
103 static struct scsi_host_template svia_sht = {
104         .module                 = THIS_MODULE,
105         .name                   = DRV_NAME,
106         .ioctl                  = ata_scsi_ioctl,
107         .queuecommand           = ata_scsi_queuecmd,
108         .can_queue              = ATA_DEF_QUEUE,
109         .this_id                = ATA_SHT_THIS_ID,
110         .sg_tablesize           = LIBATA_MAX_PRD,
111         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
112         .emulated               = ATA_SHT_EMULATED,
113         .use_clustering         = ATA_SHT_USE_CLUSTERING,
114         .proc_name              = DRV_NAME,
115         .dma_boundary           = ATA_DMA_BOUNDARY,
116         .slave_configure        = ata_scsi_slave_config,
117         .slave_destroy          = ata_scsi_slave_destroy,
118         .bios_param             = ata_std_bios_param,
119 };
120
121 static const struct ata_port_operations vt6420_sata_ops = {
122         .port_disable           = ata_port_disable,
123
124         .tf_load                = ata_tf_load,
125         .tf_read                = ata_tf_read,
126         .check_status           = ata_check_status,
127         .exec_command           = ata_exec_command,
128         .dev_select             = ata_std_dev_select,
129
130         .bmdma_setup            = ata_bmdma_setup,
131         .bmdma_start            = ata_bmdma_start,
132         .bmdma_stop             = ata_bmdma_stop,
133         .bmdma_status           = ata_bmdma_status,
134
135         .qc_prep                = ata_qc_prep,
136         .qc_issue               = ata_qc_issue_prot,
137         .data_xfer              = ata_data_xfer,
138
139         .freeze                 = svia_noop_freeze,
140         .thaw                   = ata_bmdma_thaw,
141         .error_handler          = vt6420_error_handler,
142         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
143
144         .irq_handler            = ata_interrupt,
145         .irq_clear              = ata_bmdma_irq_clear,
146
147         .port_start             = ata_port_start,
148 };
149
150 static const struct ata_port_operations vt6421_pata_ops = {
151         .port_disable           = ata_port_disable,
152         
153         .set_piomode            = vt6421_set_pio_mode,
154         .set_dmamode            = vt6421_set_dma_mode,
155
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
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
167         .qc_prep                = ata_qc_prep,
168         .qc_issue               = ata_qc_issue_prot,
169         .data_xfer              = ata_data_xfer,
170
171         .freeze                 = ata_bmdma_freeze,
172         .thaw                   = ata_bmdma_thaw,
173         .error_handler          = vt6421_pata_error_handler,
174         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
175
176         .irq_handler            = ata_interrupt,
177         .irq_clear              = ata_bmdma_irq_clear,
178
179         .port_start             = vt6421_port_start,
180 };
181
182 static const struct ata_port_operations vt6421_sata_ops = {
183         .port_disable           = ata_port_disable,
184         
185         .tf_load                = ata_tf_load,
186         .tf_read                = ata_tf_read,
187         .check_status           = ata_check_status,
188         .exec_command           = ata_exec_command,
189         .dev_select             = ata_std_dev_select,
190
191         .bmdma_setup            = ata_bmdma_setup,
192         .bmdma_start            = ata_bmdma_start,
193         .bmdma_stop             = ata_bmdma_stop,
194         .bmdma_status           = ata_bmdma_status,
195
196         .qc_prep                = ata_qc_prep,
197         .qc_issue               = ata_qc_issue_prot,
198         .data_xfer              = ata_data_xfer,
199
200         .freeze                 = ata_bmdma_freeze,
201         .thaw                   = ata_bmdma_thaw,
202         .error_handler          = vt6421_sata_error_handler,
203         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
204
205         .irq_handler            = ata_interrupt,
206         .irq_clear              = ata_bmdma_irq_clear,
207
208         .scr_read               = svia_scr_read,
209         .scr_write              = svia_scr_write,
210
211         .port_start             = vt6421_port_start,
212 };
213
214 static struct ata_port_info vt6420_port_info = {
215         .sht            = &svia_sht,
216         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
217         .pio_mask       = 0x1f,
218         .mwdma_mask     = 0x07,
219         .udma_mask      = 0x7f,
220         .port_ops       = &vt6420_sata_ops,
221 };
222
223 MODULE_AUTHOR("Jeff Garzik");
224 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
225 MODULE_LICENSE("GPL");
226 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
227 MODULE_VERSION(DRV_VERSION);
228
229 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
230 {
231         if (sc_reg > SCR_CONTROL)
232                 return 0xffffffffU;
233         return ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
234 }
235
236 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
237 {
238         if (sc_reg > SCR_CONTROL)
239                 return;
240         iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
241 }
242
243 static void svia_noop_freeze(struct ata_port *ap)
244 {
245         /* Some VIA controllers choke if ATA_NIEN is manipulated in
246          * certain way.  Leave it alone and just clear pending IRQ.
247          */
248         ata_chk_status(ap);
249         ata_bmdma_irq_clear(ap);
250 }
251
252 /**
253  *      vt6420_prereset - prereset for vt6420
254  *      @ap: target ATA port
255  *
256  *      SCR registers on vt6420 are pieces of shit and may hang the
257  *      whole machine completely if accessed with the wrong timing.
258  *      To avoid such catastrophe, vt6420 doesn't provide generic SCR
259  *      access operations, but uses SStatus and SControl only during
260  *      boot probing in controlled way.
261  *
262  *      As the old (pre EH update) probing code is proven to work, we
263  *      strictly follow the access pattern.
264  *
265  *      LOCKING:
266  *      Kernel thread context (may sleep)
267  *
268  *      RETURNS:
269  *      0 on success, -errno otherwise.
270  */
271 static int vt6420_prereset(struct ata_port *ap)
272 {
273         struct ata_eh_context *ehc = &ap->eh_context;
274         unsigned long timeout = jiffies + (HZ * 5);
275         u32 sstatus, scontrol;
276         int online;
277
278         /* don't do any SCR stuff if we're not loading */
279         if (!(ap->pflags & ATA_PFLAG_LOADING))
280                 goto skip_scr;
281
282         /* Resume phy.  This is the old resume sequence from
283          * __sata_phy_reset().
284          */
285         svia_scr_write(ap, SCR_CONTROL, 0x300);
286         svia_scr_read(ap, SCR_CONTROL); /* flush */
287
288         /* wait for phy to become ready, if necessary */
289         do {
290                 msleep(200);
291                 if ((svia_scr_read(ap, SCR_STATUS) & 0xf) != 1)
292                         break;
293         } while (time_before(jiffies, timeout));
294
295         /* open code sata_print_link_status() */
296         sstatus = svia_scr_read(ap, SCR_STATUS);
297         scontrol = svia_scr_read(ap, SCR_CONTROL);
298
299         online = (sstatus & 0xf) == 0x3;
300
301         ata_port_printk(ap, KERN_INFO,
302                         "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
303                         online ? "up" : "down", sstatus, scontrol);
304
305         /* SStatus is read one more time */
306         svia_scr_read(ap, SCR_STATUS);
307
308         if (!online) {
309                 /* tell EH to bail */
310                 ehc->i.action &= ~ATA_EH_RESET_MASK;
311                 return 0;
312         }
313
314  skip_scr:
315         /* wait for !BSY */
316         ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
317
318         return 0;
319 }
320
321 static void vt6420_error_handler(struct ata_port *ap)
322 {
323         return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
324                                   NULL, ata_std_postreset);
325 }
326
327 static int vt6421_pata_prereset(struct ata_port *ap)
328 {
329         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
330         u8 tmp;
331
332         pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
333         if (tmp & 0x10)
334                 ap->cbl = ATA_CBL_PATA40;
335         else
336                 ap->cbl = ATA_CBL_PATA80;
337         return 0;
338 }
339
340 static void vt6421_pata_error_handler(struct ata_port *ap)
341 {
342         return ata_bmdma_drive_eh(ap, vt6421_pata_prereset, ata_std_softreset,
343                                   NULL, ata_std_postreset);
344 }
345
346 static int vt6421_sata_prereset(struct ata_port *ap)
347 {
348         ap->cbl = ATA_CBL_SATA;
349         return 0;
350 }
351
352 static void vt6421_sata_error_handler(struct ata_port *ap)
353 {
354         return ata_bmdma_drive_eh(ap, vt6421_sata_prereset, ata_std_softreset,
355                                   NULL, ata_std_postreset);
356 }
357
358 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
359 {
360         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
361         static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
362         pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
363 }
364
365 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
366 {
367         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
368         static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
369         pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->pio_mode - XFER_UDMA_0]);
370 }
371
372 static int vt6421_port_start(struct ata_port *ap)
373 {
374         if (ap->port_no == PATA_PORT) {
375                 ap->ops = &vt6421_pata_ops;
376                 ap->mwdma_mask = 0;
377                 ap->flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST;
378         }
379         return ata_port_start(ap);
380 }
381
382 static const unsigned int svia_bar_sizes[] = {
383         8, 4, 8, 4, 16, 256
384 };
385
386 static const unsigned int vt6421_bar_sizes[] = {
387         16, 16, 16, 16, 32, 128
388 };
389
390 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
391 {
392         return addr + (port * 128);
393 }
394
395 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
396 {
397         return addr + (port * 64);
398 }
399
400 static void vt6421_init_addrs(struct ata_probe_ent *probe_ent,
401                               void __iomem * const *iomap, unsigned int port)
402 {
403         void __iomem *reg_addr = iomap[port];
404         void __iomem *bmdma_addr = iomap[4] + (port * 8);
405
406         probe_ent->port[port].cmd_addr = reg_addr;
407         probe_ent->port[port].altstatus_addr =
408         probe_ent->port[port].ctl_addr = (void __iomem *)
409                 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
410         probe_ent->port[port].bmdma_addr = bmdma_addr;
411         probe_ent->port[port].scr_addr = vt6421_scr_addr(iomap[5], port);
412
413         ata_std_ports(&probe_ent->port[port]);
414 }
415
416 static struct ata_probe_ent *vt6420_init_probe_ent(struct pci_dev *pdev)
417 {
418         struct ata_probe_ent *probe_ent;
419         struct ata_port_info *ppi[2];
420         void __iomem * const *iomap;
421
422         ppi[0] = ppi[1] = &vt6420_port_info;
423         probe_ent = ata_pci_init_native_mode(pdev, ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
424         if (!probe_ent)
425                 return NULL;
426
427         iomap = pcim_iomap_table(pdev);
428         probe_ent->port[0].scr_addr = svia_scr_addr(iomap[5], 0);
429         probe_ent->port[1].scr_addr = svia_scr_addr(iomap[5], 1);
430
431         return probe_ent;
432 }
433
434 static struct ata_probe_ent *vt6421_init_probe_ent(struct pci_dev *pdev)
435 {
436         struct ata_probe_ent *probe_ent;
437         unsigned int i;
438
439         probe_ent = devm_kzalloc(&pdev->dev, sizeof(*probe_ent), GFP_KERNEL);
440         if (!probe_ent)
441                 return NULL;
442
443         memset(probe_ent, 0, sizeof(*probe_ent));
444         probe_ent->dev = pci_dev_to_dev(pdev);
445         INIT_LIST_HEAD(&probe_ent->node);
446
447         probe_ent->sht          = &svia_sht;
448         probe_ent->port_flags   = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY;
449         probe_ent->port_ops     = &vt6421_sata_ops;
450         probe_ent->n_ports      = N_PORTS;
451         probe_ent->irq          = pdev->irq;
452         probe_ent->irq_flags    = IRQF_SHARED;
453         probe_ent->pio_mask     = 0x1f;
454         probe_ent->mwdma_mask   = 0x07;
455         probe_ent->udma_mask    = 0x7f;
456
457         for (i = 0; i < N_PORTS; i++)
458                 vt6421_init_addrs(probe_ent, pcim_iomap_table(pdev), i);
459
460         return probe_ent;
461 }
462
463 static void svia_configure(struct pci_dev *pdev)
464 {
465         u8 tmp8;
466
467         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
468         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
469                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
470
471         /* make sure SATA channels are enabled */
472         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
473         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
474                 dev_printk(KERN_DEBUG, &pdev->dev,
475                            "enabling SATA channels (0x%x)\n",
476                            (int) tmp8);
477                 tmp8 |= ALL_PORTS;
478                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
479         }
480
481         /* make sure interrupts for each channel sent to us */
482         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
483         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
484                 dev_printk(KERN_DEBUG, &pdev->dev,
485                            "enabling SATA channel interrupts (0x%x)\n",
486                            (int) tmp8);
487                 tmp8 |= ALL_PORTS;
488                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
489         }
490
491         /* make sure native mode is enabled */
492         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
493         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
494                 dev_printk(KERN_DEBUG, &pdev->dev,
495                            "enabling SATA channel native mode (0x%x)\n",
496                            (int) tmp8);
497                 tmp8 |= NATIVE_MODE_ALL;
498                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
499         }
500 }
501
502 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
503 {
504         static int printed_version;
505         unsigned int i;
506         int rc;
507         struct ata_probe_ent *probe_ent;
508         int board_id = (int) ent->driver_data;
509         const int *bar_sizes;
510         u8 tmp8;
511
512         if (!printed_version++)
513                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
514
515         rc = pcim_enable_device(pdev);
516         if (rc)
517                 return rc;
518
519         rc = pcim_iomap_regions(pdev, 0x1f, DRV_NAME);
520         if (rc) {
521                 pcim_pin_device(pdev);
522                 return rc;
523         }
524
525         if (board_id == vt6420) {
526                 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
527                 if (tmp8 & SATA_2DEV) {
528                         dev_printk(KERN_ERR, &pdev->dev,
529                                    "SATA master/slave not supported (0x%x)\n",
530                                    (int) tmp8);
531                         return -EIO;
532                 }
533
534                 bar_sizes = &svia_bar_sizes[0];
535         } else {
536                 bar_sizes = &vt6421_bar_sizes[0];
537         }
538
539         for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
540                 if ((pci_resource_start(pdev, i) == 0) ||
541                     (pci_resource_len(pdev, i) < bar_sizes[i])) {
542                         dev_printk(KERN_ERR, &pdev->dev,
543                                 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
544                                 i,
545                                 (unsigned long long)pci_resource_start(pdev, i),
546                                 (unsigned long long)pci_resource_len(pdev, i));
547                         return -ENODEV;
548                 }
549
550         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
551         if (rc)
552                 return rc;
553         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
554         if (rc)
555                 return rc;
556
557         if (board_id == vt6420)
558                 probe_ent = vt6420_init_probe_ent(pdev);
559         else
560                 probe_ent = vt6421_init_probe_ent(pdev);
561
562         if (!probe_ent) {
563                 dev_printk(KERN_ERR, &pdev->dev, "out of memory\n");
564                 return -ENOMEM;
565         }
566
567         svia_configure(pdev);
568
569         pci_set_master(pdev);
570
571         if (!ata_device_add(probe_ent))
572                 return -ENODEV;
573
574         devm_kfree(&pdev->dev, probe_ent);
575         return 0;
576 }
577
578 static int __init svia_init(void)
579 {
580         return pci_register_driver(&svia_pci_driver);
581 }
582
583 static void __exit svia_exit(void)
584 {
585         pci_unregister_driver(&svia_pci_driver);
586 }
587
588 module_init(svia_init);
589 module_exit(svia_exit);