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