Merge branches 'sh/serial-rework' and 'sh/oprofile'
[linux-2.6] / 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  *
34  */
35
36 #include <linux/kernel.h>
37 #include <linux/module.h>
38 #include <linux/pci.h>
39 #include <linux/init.h>
40 #include <linux/blkdev.h>
41 #include <linux/delay.h>
42 #include <linux/device.h>
43 #include <scsi/scsi_host.h>
44 #include <linux/libata.h>
45
46 #define DRV_NAME        "sata_via"
47 #define DRV_VERSION     "2.3"
48
49 enum board_ids_enum {
50         vt6420,
51         vt6421,
52 };
53
54 enum {
55         SATA_CHAN_ENAB          = 0x40, /* SATA channel enable */
56         SATA_INT_GATE           = 0x41, /* SATA interrupt gating */
57         SATA_NATIVE_MODE        = 0x42, /* Native mode enable */
58         PATA_UDMA_TIMING        = 0xB3, /* PATA timing for DMA/ cable detect */
59         PATA_PIO_TIMING         = 0xAB, /* PATA timing register */
60
61         PORT0                   = (1 << 1),
62         PORT1                   = (1 << 0),
63         ALL_PORTS               = PORT0 | PORT1,
64
65         NATIVE_MODE_ALL         = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
66
67         SATA_EXT_PHY            = (1 << 6), /* 0==use PATA, 1==ext phy */
68 };
69
70 static int svia_init_one(struct pci_dev *pdev, const struct pci_device_id *ent);
71 static int svia_scr_read(struct ata_link *link, unsigned int sc_reg, u32 *val);
72 static int svia_scr_write(struct ata_link *link, unsigned int sc_reg, u32 val);
73 static void svia_tf_load(struct ata_port *ap, const struct ata_taskfile *tf);
74 static void svia_noop_freeze(struct ata_port *ap);
75 static int vt6420_prereset(struct ata_link *link, unsigned long deadline);
76 static int vt6421_pata_cable_detect(struct ata_port *ap);
77 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev);
78 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev);
79
80 static const struct pci_device_id svia_pci_tbl[] = {
81         { PCI_VDEVICE(VIA, 0x5337), vt6420 },
82         { PCI_VDEVICE(VIA, 0x0591), vt6420 },
83         { PCI_VDEVICE(VIA, 0x3149), vt6420 },
84         { PCI_VDEVICE(VIA, 0x3249), vt6421 },
85         { PCI_VDEVICE(VIA, 0x5287), vt6420 },
86         { PCI_VDEVICE(VIA, 0x5372), vt6420 },
87         { PCI_VDEVICE(VIA, 0x7372), vt6420 },
88
89         { }     /* terminate list */
90 };
91
92 static struct pci_driver svia_pci_driver = {
93         .name                   = DRV_NAME,
94         .id_table               = svia_pci_tbl,
95         .probe                  = svia_init_one,
96 #ifdef CONFIG_PM
97         .suspend                = ata_pci_device_suspend,
98         .resume                 = ata_pci_device_resume,
99 #endif
100         .remove                 = ata_pci_remove_one,
101 };
102
103 static struct scsi_host_template svia_sht = {
104         ATA_BMDMA_SHT(DRV_NAME),
105 };
106
107 static struct ata_port_operations svia_base_ops = {
108         .inherits               = &ata_bmdma_port_ops,
109         .sff_tf_load            = svia_tf_load,
110 };
111
112 static struct ata_port_operations vt6420_sata_ops = {
113         .inherits               = &svia_base_ops,
114         .freeze                 = svia_noop_freeze,
115         .prereset               = vt6420_prereset,
116 };
117
118 static struct ata_port_operations vt6421_pata_ops = {
119         .inherits               = &svia_base_ops,
120         .cable_detect           = vt6421_pata_cable_detect,
121         .set_piomode            = vt6421_set_pio_mode,
122         .set_dmamode            = vt6421_set_dma_mode,
123 };
124
125 static struct ata_port_operations vt6421_sata_ops = {
126         .inherits               = &svia_base_ops,
127         .scr_read               = svia_scr_read,
128         .scr_write              = svia_scr_write,
129 };
130
131 static const struct ata_port_info vt6420_port_info = {
132         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
133         .pio_mask       = 0x1f,
134         .mwdma_mask     = 0x07,
135         .udma_mask      = ATA_UDMA6,
136         .port_ops       = &vt6420_sata_ops,
137 };
138
139 static struct ata_port_info vt6421_sport_info = {
140         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
141         .pio_mask       = 0x1f,
142         .mwdma_mask     = 0x07,
143         .udma_mask      = ATA_UDMA6,
144         .port_ops       = &vt6421_sata_ops,
145 };
146
147 static struct ata_port_info vt6421_pport_info = {
148         .flags          = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY,
149         .pio_mask       = 0x1f,
150         .mwdma_mask     = 0,
151         .udma_mask      = ATA_UDMA6,
152         .port_ops       = &vt6421_pata_ops,
153 };
154
155 MODULE_AUTHOR("Jeff Garzik");
156 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
157 MODULE_LICENSE("GPL");
158 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
159 MODULE_VERSION(DRV_VERSION);
160
161 static int svia_scr_read(struct ata_link *link, unsigned int sc_reg, u32 *val)
162 {
163         if (sc_reg > SCR_CONTROL)
164                 return -EINVAL;
165         *val = ioread32(link->ap->ioaddr.scr_addr + (4 * sc_reg));
166         return 0;
167 }
168
169 static int svia_scr_write(struct ata_link *link, unsigned int sc_reg, u32 val)
170 {
171         if (sc_reg > SCR_CONTROL)
172                 return -EINVAL;
173         iowrite32(val, link->ap->ioaddr.scr_addr + (4 * sc_reg));
174         return 0;
175 }
176
177 /**
178  *      svia_tf_load - send taskfile registers to host controller
179  *      @ap: Port to which output is sent
180  *      @tf: ATA taskfile register set
181  *
182  *      Outputs ATA taskfile to standard ATA host controller.
183  *
184  *      This is to fix the internal bug of via chipsets, which will
185  *      reset the device register after changing the IEN bit on ctl
186  *      register.
187  */
188 static void svia_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
189 {
190         struct ata_taskfile ttf;
191
192         if (tf->ctl != ap->last_ctl)  {
193                 ttf = *tf;
194                 ttf.flags |= ATA_TFLAG_DEVICE;
195                 tf = &ttf;
196         }
197         ata_sff_tf_load(ap, tf);
198 }
199
200 static void svia_noop_freeze(struct ata_port *ap)
201 {
202         /* Some VIA controllers choke if ATA_NIEN is manipulated in
203          * certain way.  Leave it alone and just clear pending IRQ.
204          */
205         ap->ops->sff_check_status(ap);
206         ata_sff_irq_clear(ap);
207 }
208
209 /**
210  *      vt6420_prereset - prereset for vt6420
211  *      @link: target ATA link
212  *      @deadline: deadline jiffies for the operation
213  *
214  *      SCR registers on vt6420 are pieces of shit and may hang the
215  *      whole machine completely if accessed with the wrong timing.
216  *      To avoid such catastrophe, vt6420 doesn't provide generic SCR
217  *      access operations, but uses SStatus and SControl only during
218  *      boot probing in controlled way.
219  *
220  *      As the old (pre EH update) probing code is proven to work, we
221  *      strictly follow the access pattern.
222  *
223  *      LOCKING:
224  *      Kernel thread context (may sleep)
225  *
226  *      RETURNS:
227  *      0 on success, -errno otherwise.
228  */
229 static int vt6420_prereset(struct ata_link *link, unsigned long deadline)
230 {
231         struct ata_port *ap = link->ap;
232         struct ata_eh_context *ehc = &ap->link.eh_context;
233         unsigned long timeout = jiffies + (HZ * 5);
234         u32 sstatus, scontrol;
235         int online;
236
237         /* don't do any SCR stuff if we're not loading */
238         if (!(ap->pflags & ATA_PFLAG_LOADING))
239                 goto skip_scr;
240
241         /* Resume phy.  This is the old SATA resume sequence */
242         svia_scr_write(link, SCR_CONTROL, 0x300);
243         svia_scr_read(link, SCR_CONTROL, &scontrol); /* flush */
244
245         /* wait for phy to become ready, if necessary */
246         do {
247                 msleep(200);
248                 svia_scr_read(link, SCR_STATUS, &sstatus);
249                 if ((sstatus & 0xf) != 1)
250                         break;
251         } while (time_before(jiffies, timeout));
252
253         /* open code sata_print_link_status() */
254         svia_scr_read(link, SCR_STATUS, &sstatus);
255         svia_scr_read(link, SCR_CONTROL, &scontrol);
256
257         online = (sstatus & 0xf) == 0x3;
258
259         ata_port_printk(ap, KERN_INFO,
260                         "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
261                         online ? "up" : "down", sstatus, scontrol);
262
263         /* SStatus is read one more time */
264         svia_scr_read(link, SCR_STATUS, &sstatus);
265
266         if (!online) {
267                 /* tell EH to bail */
268                 ehc->i.action &= ~ATA_EH_RESET;
269                 return 0;
270         }
271
272  skip_scr:
273         /* wait for !BSY */
274         ata_sff_wait_ready(link, deadline);
275
276         return 0;
277 }
278
279 static int vt6421_pata_cable_detect(struct ata_port *ap)
280 {
281         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
282         u8 tmp;
283
284         pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
285         if (tmp & 0x10)
286                 return ATA_CBL_PATA40;
287         return ATA_CBL_PATA80;
288 }
289
290 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
291 {
292         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
293         static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
294         pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
295 }
296
297 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
298 {
299         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
300         static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
301         pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->dma_mode - XFER_UDMA_0]);
302 }
303
304 static const unsigned int svia_bar_sizes[] = {
305         8, 4, 8, 4, 16, 256
306 };
307
308 static const unsigned int vt6421_bar_sizes[] = {
309         16, 16, 16, 16, 32, 128
310 };
311
312 static void __iomem *svia_scr_addr(void __iomem *addr, unsigned int port)
313 {
314         return addr + (port * 128);
315 }
316
317 static void __iomem *vt6421_scr_addr(void __iomem *addr, unsigned int port)
318 {
319         return addr + (port * 64);
320 }
321
322 static void vt6421_init_addrs(struct ata_port *ap)
323 {
324         void __iomem * const * iomap = ap->host->iomap;
325         void __iomem *reg_addr = iomap[ap->port_no];
326         void __iomem *bmdma_addr = iomap[4] + (ap->port_no * 8);
327         struct ata_ioports *ioaddr = &ap->ioaddr;
328
329         ioaddr->cmd_addr = reg_addr;
330         ioaddr->altstatus_addr =
331         ioaddr->ctl_addr = (void __iomem *)
332                 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
333         ioaddr->bmdma_addr = bmdma_addr;
334         ioaddr->scr_addr = vt6421_scr_addr(iomap[5], ap->port_no);
335
336         ata_sff_std_ports(ioaddr);
337
338         ata_port_pbar_desc(ap, ap->port_no, -1, "port");
339         ata_port_pbar_desc(ap, 4, ap->port_no * 8, "bmdma");
340 }
341
342 static int vt6420_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
343 {
344         const struct ata_port_info *ppi[] = { &vt6420_port_info, NULL };
345         struct ata_host *host;
346         int rc;
347
348         rc = ata_pci_sff_prepare_host(pdev, ppi, &host);
349         if (rc)
350                 return rc;
351         *r_host = host;
352
353         rc = pcim_iomap_regions(pdev, 1 << 5, DRV_NAME);
354         if (rc) {
355                 dev_printk(KERN_ERR, &pdev->dev, "failed to iomap PCI BAR 5\n");
356                 return rc;
357         }
358
359         host->ports[0]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 0);
360         host->ports[1]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 1);
361
362         return 0;
363 }
364
365 static int vt6421_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
366 {
367         const struct ata_port_info *ppi[] =
368                 { &vt6421_sport_info, &vt6421_sport_info, &vt6421_pport_info };
369         struct ata_host *host;
370         int i, rc;
371
372         *r_host = host = ata_host_alloc_pinfo(&pdev->dev, ppi, ARRAY_SIZE(ppi));
373         if (!host) {
374                 dev_printk(KERN_ERR, &pdev->dev, "failed to allocate host\n");
375                 return -ENOMEM;
376         }
377
378         rc = pcim_iomap_regions(pdev, 0x3f, DRV_NAME);
379         if (rc) {
380                 dev_printk(KERN_ERR, &pdev->dev, "failed to request/iomap "
381                            "PCI BARs (errno=%d)\n", rc);
382                 return rc;
383         }
384         host->iomap = pcim_iomap_table(pdev);
385
386         for (i = 0; i < host->n_ports; i++)
387                 vt6421_init_addrs(host->ports[i]);
388
389         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
390         if (rc)
391                 return rc;
392         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
393         if (rc)
394                 return rc;
395
396         return 0;
397 }
398
399 static void svia_configure(struct pci_dev *pdev)
400 {
401         u8 tmp8;
402
403         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
404         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
405                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
406
407         /* make sure SATA channels are enabled */
408         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
409         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
410                 dev_printk(KERN_DEBUG, &pdev->dev,
411                            "enabling SATA channels (0x%x)\n",
412                            (int) tmp8);
413                 tmp8 |= ALL_PORTS;
414                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
415         }
416
417         /* make sure interrupts for each channel sent to us */
418         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
419         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
420                 dev_printk(KERN_DEBUG, &pdev->dev,
421                            "enabling SATA channel interrupts (0x%x)\n",
422                            (int) tmp8);
423                 tmp8 |= ALL_PORTS;
424                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
425         }
426
427         /* make sure native mode is enabled */
428         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
429         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
430                 dev_printk(KERN_DEBUG, &pdev->dev,
431                            "enabling SATA channel native mode (0x%x)\n",
432                            (int) tmp8);
433                 tmp8 |= NATIVE_MODE_ALL;
434                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
435         }
436 }
437
438 static int svia_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
439 {
440         static int printed_version;
441         unsigned int i;
442         int rc;
443         struct ata_host *host;
444         int board_id = (int) ent->driver_data;
445         const unsigned *bar_sizes;
446
447         if (!printed_version++)
448                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
449
450         rc = pcim_enable_device(pdev);
451         if (rc)
452                 return rc;
453
454         if (board_id == vt6420)
455                 bar_sizes = &svia_bar_sizes[0];
456         else
457                 bar_sizes = &vt6421_bar_sizes[0];
458
459         for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
460                 if ((pci_resource_start(pdev, i) == 0) ||
461                     (pci_resource_len(pdev, i) < bar_sizes[i])) {
462                         dev_printk(KERN_ERR, &pdev->dev,
463                                 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
464                                 i,
465                                 (unsigned long long)pci_resource_start(pdev, i),
466                                 (unsigned long long)pci_resource_len(pdev, i));
467                         return -ENODEV;
468                 }
469
470         if (board_id == vt6420)
471                 rc = vt6420_prepare_host(pdev, &host);
472         else
473                 rc = vt6421_prepare_host(pdev, &host);
474         if (rc)
475                 return rc;
476
477         svia_configure(pdev);
478
479         pci_set_master(pdev);
480         return ata_host_activate(host, pdev->irq, ata_sff_interrupt,
481                                  IRQF_SHARED, &svia_sht);
482 }
483
484 static int __init svia_init(void)
485 {
486         return pci_register_driver(&svia_pci_driver);
487 }
488
489 static void __exit svia_exit(void)
490 {
491         pci_unregister_driver(&svia_pci_driver);
492 }
493
494 module_init(svia_init);
495 module_exit(svia_exit);