]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - drivers/ata/sata_via.c
libata: clean up SFF init mess
[mirror_ubuntu-bionic-kernel.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
68 NATIVE_MODE_ALL = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
69
70 SATA_EXT_PHY = (1 << 6), /* 0==use PATA, 1==ext phy */
71 SATA_2DEV = (1 << 5), /* SATA is master/slave */
72 };
73
74 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
75 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg);
76 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
77 static void svia_noop_freeze(struct ata_port *ap);
78 static void vt6420_error_handler(struct ata_port *ap);
79 static int vt6421_pata_cable_detect(struct ata_port *ap);
80 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev);
81 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev);
82
83 static const struct pci_device_id svia_pci_tbl[] = {
84 { PCI_VDEVICE(VIA, 0x5337), vt6420 },
85 { PCI_VDEVICE(VIA, 0x0591), vt6420 },
86 { PCI_VDEVICE(VIA, 0x3149), vt6420 },
87 { PCI_VDEVICE(VIA, 0x3249), vt6421 },
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 .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 #ifdef CONFIG_PM
120 .suspend = ata_scsi_device_suspend,
121 .resume = ata_scsi_device_resume,
122 #endif
123 };
124
125 static const struct ata_port_operations vt6420_sata_ops = {
126 .port_disable = ata_port_disable,
127
128 .tf_load = ata_tf_load,
129 .tf_read = ata_tf_read,
130 .check_status = ata_check_status,
131 .exec_command = ata_exec_command,
132 .dev_select = ata_std_dev_select,
133
134 .bmdma_setup = ata_bmdma_setup,
135 .bmdma_start = ata_bmdma_start,
136 .bmdma_stop = ata_bmdma_stop,
137 .bmdma_status = ata_bmdma_status,
138
139 .qc_prep = ata_qc_prep,
140 .qc_issue = ata_qc_issue_prot,
141 .data_xfer = ata_data_xfer,
142
143 .freeze = svia_noop_freeze,
144 .thaw = ata_bmdma_thaw,
145 .error_handler = vt6420_error_handler,
146 .post_internal_cmd = ata_bmdma_post_internal_cmd,
147
148 .irq_clear = ata_bmdma_irq_clear,
149 .irq_on = ata_irq_on,
150 .irq_ack = ata_irq_ack,
151
152 .port_start = ata_port_start,
153 };
154
155 static const struct ata_port_operations vt6421_pata_ops = {
156 .port_disable = ata_port_disable,
157
158 .set_piomode = vt6421_set_pio_mode,
159 .set_dmamode = vt6421_set_dma_mode,
160
161 .tf_load = ata_tf_load,
162 .tf_read = ata_tf_read,
163 .check_status = ata_check_status,
164 .exec_command = ata_exec_command,
165 .dev_select = ata_std_dev_select,
166
167 .bmdma_setup = ata_bmdma_setup,
168 .bmdma_start = ata_bmdma_start,
169 .bmdma_stop = ata_bmdma_stop,
170 .bmdma_status = ata_bmdma_status,
171
172 .qc_prep = ata_qc_prep,
173 .qc_issue = ata_qc_issue_prot,
174 .data_xfer = ata_data_xfer,
175
176 .freeze = ata_bmdma_freeze,
177 .thaw = ata_bmdma_thaw,
178 .error_handler = ata_bmdma_error_handler,
179 .post_internal_cmd = ata_bmdma_post_internal_cmd,
180 .cable_detect = vt6421_pata_cable_detect,
181
182 .irq_clear = ata_bmdma_irq_clear,
183 .irq_on = ata_irq_on,
184 .irq_ack = ata_irq_ack,
185
186 .port_start = ata_port_start,
187 };
188
189 static const struct ata_port_operations vt6421_sata_ops = {
190 .port_disable = ata_port_disable,
191
192 .tf_load = ata_tf_load,
193 .tf_read = ata_tf_read,
194 .check_status = ata_check_status,
195 .exec_command = ata_exec_command,
196 .dev_select = ata_std_dev_select,
197
198 .bmdma_setup = ata_bmdma_setup,
199 .bmdma_start = ata_bmdma_start,
200 .bmdma_stop = ata_bmdma_stop,
201 .bmdma_status = ata_bmdma_status,
202
203 .qc_prep = ata_qc_prep,
204 .qc_issue = ata_qc_issue_prot,
205 .data_xfer = ata_data_xfer,
206
207 .freeze = ata_bmdma_freeze,
208 .thaw = ata_bmdma_thaw,
209 .error_handler = ata_bmdma_error_handler,
210 .post_internal_cmd = ata_bmdma_post_internal_cmd,
211 .cable_detect = ata_cable_sata,
212
213 .irq_clear = ata_bmdma_irq_clear,
214 .irq_on = ata_irq_on,
215 .irq_ack = ata_irq_ack,
216
217 .scr_read = svia_scr_read,
218 .scr_write = svia_scr_write,
219
220 .port_start = ata_port_start,
221 };
222
223 static const struct ata_port_info vt6420_port_info = {
224 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
225 .pio_mask = 0x1f,
226 .mwdma_mask = 0x07,
227 .udma_mask = 0x7f,
228 .port_ops = &vt6420_sata_ops,
229 };
230
231 static struct ata_port_info vt6421_sport_info = {
232 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
233 .pio_mask = 0x1f,
234 .mwdma_mask = 0x07,
235 .udma_mask = 0x7f,
236 .port_ops = &vt6421_sata_ops,
237 };
238
239 static struct ata_port_info vt6421_pport_info = {
240 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY,
241 .pio_mask = 0x1f,
242 .mwdma_mask = 0,
243 .udma_mask = 0x7f,
244 .port_ops = &vt6421_pata_ops,
245 };
246
247 MODULE_AUTHOR("Jeff Garzik");
248 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
249 MODULE_LICENSE("GPL");
250 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
251 MODULE_VERSION(DRV_VERSION);
252
253 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
254 {
255 if (sc_reg > SCR_CONTROL)
256 return 0xffffffffU;
257 return ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
258 }
259
260 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
261 {
262 if (sc_reg > SCR_CONTROL)
263 return;
264 iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
265 }
266
267 static void svia_noop_freeze(struct ata_port *ap)
268 {
269 /* Some VIA controllers choke if ATA_NIEN is manipulated in
270 * certain way. Leave it alone and just clear pending IRQ.
271 */
272 ata_chk_status(ap);
273 ata_bmdma_irq_clear(ap);
274 }
275
276 /**
277 * vt6420_prereset - prereset for vt6420
278 * @ap: target ATA port
279 * @deadline: deadline jiffies for the operation
280 *
281 * SCR registers on vt6420 are pieces of shit and may hang the
282 * whole machine completely if accessed with the wrong timing.
283 * To avoid such catastrophe, vt6420 doesn't provide generic SCR
284 * access operations, but uses SStatus and SControl only during
285 * boot probing in controlled way.
286 *
287 * As the old (pre EH update) probing code is proven to work, we
288 * strictly follow the access pattern.
289 *
290 * LOCKING:
291 * Kernel thread context (may sleep)
292 *
293 * RETURNS:
294 * 0 on success, -errno otherwise.
295 */
296 static int vt6420_prereset(struct ata_port *ap, unsigned long deadline)
297 {
298 struct ata_eh_context *ehc = &ap->eh_context;
299 unsigned long timeout = jiffies + (HZ * 5);
300 u32 sstatus, scontrol;
301 int online;
302
303 /* don't do any SCR stuff if we're not loading */
304 if (!(ap->pflags & ATA_PFLAG_LOADING))
305 goto skip_scr;
306
307 /* Resume phy. This is the old resume sequence from
308 * __sata_phy_reset().
309 */
310 svia_scr_write(ap, SCR_CONTROL, 0x300);
311 svia_scr_read(ap, SCR_CONTROL); /* flush */
312
313 /* wait for phy to become ready, if necessary */
314 do {
315 msleep(200);
316 if ((svia_scr_read(ap, SCR_STATUS) & 0xf) != 1)
317 break;
318 } while (time_before(jiffies, timeout));
319
320 /* open code sata_print_link_status() */
321 sstatus = svia_scr_read(ap, SCR_STATUS);
322 scontrol = svia_scr_read(ap, SCR_CONTROL);
323
324 online = (sstatus & 0xf) == 0x3;
325
326 ata_port_printk(ap, KERN_INFO,
327 "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
328 online ? "up" : "down", sstatus, scontrol);
329
330 /* SStatus is read one more time */
331 svia_scr_read(ap, SCR_STATUS);
332
333 if (!online) {
334 /* tell EH to bail */
335 ehc->i.action &= ~ATA_EH_RESET_MASK;
336 return 0;
337 }
338
339 skip_scr:
340 /* wait for !BSY */
341 ata_wait_ready(ap, deadline);
342
343 return 0;
344 }
345
346 static void vt6420_error_handler(struct ata_port *ap)
347 {
348 return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
349 NULL, ata_std_postreset);
350 }
351
352 static int vt6421_pata_cable_detect(struct ata_port *ap)
353 {
354 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
355 u8 tmp;
356
357 pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
358 if (tmp & 0x10)
359 return ATA_CBL_PATA40;
360 return ATA_CBL_PATA80;
361 }
362
363 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
364 {
365 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
366 static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
367 pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
368 }
369
370 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
371 {
372 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
373 static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
374 pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->pio_mode - XFER_UDMA_0]);
375 }
376
377 static const unsigned int svia_bar_sizes[] = {
378 8, 4, 8, 4, 16, 256
379 };
380
381 static const unsigned int vt6421_bar_sizes[] = {
382 16, 16, 16, 16, 32, 128
383 };
384
385 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
386 {
387 return addr + (port * 128);
388 }
389
390 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
391 {
392 return addr + (port * 64);
393 }
394
395 static void vt6421_init_addrs(struct ata_port *ap)
396 {
397 void __iomem * const * iomap = ap->host->iomap;
398 void __iomem *reg_addr = iomap[ap->port_no];
399 void __iomem *bmdma_addr = iomap[4] + (ap->port_no * 8);
400 struct ata_ioports *ioaddr = &ap->ioaddr;
401
402 ioaddr->cmd_addr = reg_addr;
403 ioaddr->altstatus_addr =
404 ioaddr->ctl_addr = (void __iomem *)
405 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
406 ioaddr->bmdma_addr = bmdma_addr;
407 ioaddr->scr_addr = vt6421_scr_addr(iomap[5], ap->port_no);
408
409 ata_std_ports(ioaddr);
410 }
411
412 static int vt6420_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
413 {
414 const struct ata_port_info *ppi[] = { &vt6420_port_info, NULL };
415 struct ata_host *host;
416 int rc;
417
418 rc = ata_pci_prepare_native_host(pdev, ppi, &host);
419 if (rc)
420 return rc;
421 *r_host = host;
422
423 rc = pcim_iomap_regions(pdev, 1 << 5, DRV_NAME);
424 if (rc) {
425 dev_printk(KERN_ERR, &pdev->dev, "failed to iomap PCI BAR 5\n");
426 return rc;
427 }
428
429 host->ports[0]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 0);
430 host->ports[1]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 1);
431
432 return 0;
433 }
434
435 static int vt6421_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
436 {
437 const struct ata_port_info *ppi[] =
438 { &vt6421_sport_info, &vt6421_sport_info, &vt6421_pport_info };
439 struct ata_host *host;
440 int i, rc;
441
442 *r_host = host = ata_host_alloc_pinfo(&pdev->dev, ppi, ARRAY_SIZE(ppi));
443 if (!host) {
444 dev_printk(KERN_ERR, &pdev->dev, "failed to allocate host\n");
445 return -ENOMEM;
446 }
447
448 rc = pcim_iomap_regions(pdev, 0x1f, DRV_NAME);
449 if (rc) {
450 dev_printk(KERN_ERR, &pdev->dev, "failed to request/iomap "
451 "PCI BARs (errno=%d)\n", rc);
452 return rc;
453 }
454 host->iomap = pcim_iomap_table(pdev);
455
456 for (i = 0; i < host->n_ports; i++)
457 vt6421_init_addrs(host->ports[i]);
458
459 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
460 if (rc)
461 return rc;
462 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
463 if (rc)
464 return rc;
465
466 return 0;
467 }
468
469 static void svia_configure(struct pci_dev *pdev)
470 {
471 u8 tmp8;
472
473 pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
474 dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
475 (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
476
477 /* make sure SATA channels are enabled */
478 pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
479 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
480 dev_printk(KERN_DEBUG, &pdev->dev,
481 "enabling SATA channels (0x%x)\n",
482 (int) tmp8);
483 tmp8 |= ALL_PORTS;
484 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
485 }
486
487 /* make sure interrupts for each channel sent to us */
488 pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
489 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
490 dev_printk(KERN_DEBUG, &pdev->dev,
491 "enabling SATA channel interrupts (0x%x)\n",
492 (int) tmp8);
493 tmp8 |= ALL_PORTS;
494 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
495 }
496
497 /* make sure native mode is enabled */
498 pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
499 if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
500 dev_printk(KERN_DEBUG, &pdev->dev,
501 "enabling SATA channel native mode (0x%x)\n",
502 (int) tmp8);
503 tmp8 |= NATIVE_MODE_ALL;
504 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
505 }
506 }
507
508 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
509 {
510 static int printed_version;
511 unsigned int i;
512 int rc;
513 struct ata_host *host;
514 int board_id = (int) ent->driver_data;
515 const int *bar_sizes;
516 u8 tmp8;
517
518 if (!printed_version++)
519 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
520
521 rc = pcim_enable_device(pdev);
522 if (rc)
523 return rc;
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 if (board_id == vt6420)
551 rc = vt6420_prepare_host(pdev, &host);
552 else
553 rc = vt6421_prepare_host(pdev, &host);
554 if (rc)
555 return rc;
556
557 svia_configure(pdev);
558
559 pci_set_master(pdev);
560 return ata_host_activate(host, pdev->irq, ata_interrupt, IRQF_SHARED,
561 &svia_sht);
562 }
563
564 static int __init svia_init(void)
565 {
566 return pci_register_driver(&svia_pci_driver);
567 }
568
569 static void __exit svia_exit(void)
570 {
571 pci_unregister_driver(&svia_pci_driver);
572 }
573
574 module_init(svia_init);
575 module_exit(svia_exit);