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