2 * sata_via.c - VIA Serial ATA controllers
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
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)
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.
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.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available under NDA.
34 * - VT6421 PATA support
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>
49 #define DRV_NAME "sata_via"
50 #define DRV_VERSION "2.0"
58 SATA_CHAN_ENAB
= 0x40, /* SATA channel enable */
59 SATA_INT_GATE
= 0x41, /* SATA interrupt gating */
60 SATA_NATIVE_MODE
= 0x42, /* Native mode enable */
61 SATA_PATA_SHARING
= 0x49, /* PATA/SATA sharing func ctrl */
65 ALL_PORTS
= PORT0
| PORT1
,
68 NATIVE_MODE_ALL
= (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
70 SATA_EXT_PHY
= (1 << 6), /* 0==use PATA, 1==ext phy */
71 SATA_2DEV
= (1 << 5), /* SATA is master/slave */
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
);
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
},
86 { } /* terminate list */
89 static struct pci_driver svia_pci_driver
= {
91 .id_table
= svia_pci_tbl
,
92 .probe
= svia_init_one
,
93 .remove
= ata_pci_remove_one
,
96 static struct scsi_host_template svia_sht
= {
97 .module
= THIS_MODULE
,
99 .ioctl
= ata_scsi_ioctl
,
100 .queuecommand
= ata_scsi_queuecmd
,
101 .can_queue
= ATA_DEF_QUEUE
,
102 .this_id
= ATA_SHT_THIS_ID
,
103 .sg_tablesize
= LIBATA_MAX_PRD
,
104 .cmd_per_lun
= ATA_SHT_CMD_PER_LUN
,
105 .emulated
= ATA_SHT_EMULATED
,
106 .use_clustering
= ATA_SHT_USE_CLUSTERING
,
107 .proc_name
= DRV_NAME
,
108 .dma_boundary
= ATA_DMA_BOUNDARY
,
109 .slave_configure
= ata_scsi_slave_config
,
110 .slave_destroy
= ata_scsi_slave_destroy
,
111 .bios_param
= ata_std_bios_param
,
114 static const struct ata_port_operations vt6420_sata_ops
= {
115 .port_disable
= ata_port_disable
,
117 .tf_load
= ata_tf_load
,
118 .tf_read
= ata_tf_read
,
119 .check_status
= ata_check_status
,
120 .exec_command
= ata_exec_command
,
121 .dev_select
= ata_std_dev_select
,
123 .bmdma_setup
= ata_bmdma_setup
,
124 .bmdma_start
= ata_bmdma_start
,
125 .bmdma_stop
= ata_bmdma_stop
,
126 .bmdma_status
= ata_bmdma_status
,
128 .qc_prep
= ata_qc_prep
,
129 .qc_issue
= ata_qc_issue_prot
,
130 .data_xfer
= ata_pio_data_xfer
,
132 .freeze
= svia_noop_freeze
,
133 .thaw
= ata_bmdma_thaw
,
134 .error_handler
= vt6420_error_handler
,
135 .post_internal_cmd
= ata_bmdma_post_internal_cmd
,
137 .irq_handler
= ata_interrupt
,
138 .irq_clear
= ata_bmdma_irq_clear
,
140 .port_start
= ata_port_start
,
141 .port_stop
= ata_port_stop
,
142 .host_stop
= ata_host_stop
,
145 static const struct ata_port_operations vt6421_sata_ops
= {
146 .port_disable
= ata_port_disable
,
148 .tf_load
= ata_tf_load
,
149 .tf_read
= ata_tf_read
,
150 .check_status
= ata_check_status
,
151 .exec_command
= ata_exec_command
,
152 .dev_select
= ata_std_dev_select
,
154 .bmdma_setup
= ata_bmdma_setup
,
155 .bmdma_start
= ata_bmdma_start
,
156 .bmdma_stop
= ata_bmdma_stop
,
157 .bmdma_status
= ata_bmdma_status
,
159 .qc_prep
= ata_qc_prep
,
160 .qc_issue
= ata_qc_issue_prot
,
161 .data_xfer
= ata_pio_data_xfer
,
163 .freeze
= ata_bmdma_freeze
,
164 .thaw
= ata_bmdma_thaw
,
165 .error_handler
= ata_bmdma_error_handler
,
166 .post_internal_cmd
= ata_bmdma_post_internal_cmd
,
168 .irq_handler
= ata_interrupt
,
169 .irq_clear
= ata_bmdma_irq_clear
,
171 .scr_read
= svia_scr_read
,
172 .scr_write
= svia_scr_write
,
174 .port_start
= ata_port_start
,
175 .port_stop
= ata_port_stop
,
176 .host_stop
= ata_host_stop
,
179 static struct ata_port_info vt6420_port_info
= {
181 .flags
= ATA_FLAG_SATA
| ATA_FLAG_NO_LEGACY
,
185 .port_ops
= &vt6420_sata_ops
,
188 MODULE_AUTHOR("Jeff Garzik");
189 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
190 MODULE_LICENSE("GPL");
191 MODULE_DEVICE_TABLE(pci
, svia_pci_tbl
);
192 MODULE_VERSION(DRV_VERSION
);
194 static u32
svia_scr_read (struct ata_port
*ap
, unsigned int sc_reg
)
196 if (sc_reg
> SCR_CONTROL
)
198 return inl(ap
->ioaddr
.scr_addr
+ (4 * sc_reg
));
201 static void svia_scr_write (struct ata_port
*ap
, unsigned int sc_reg
, u32 val
)
203 if (sc_reg
> SCR_CONTROL
)
205 outl(val
, ap
->ioaddr
.scr_addr
+ (4 * sc_reg
));
208 static void svia_noop_freeze(struct ata_port
*ap
)
210 /* Some VIA controllers choke if ATA_NIEN is manipulated in
211 * certain way. Leave it alone and just clear pending IRQ.
214 ata_bmdma_irq_clear(ap
);
218 * vt6420_prereset - prereset for vt6420
219 * @ap: target ATA port
221 * SCR registers on vt6420 are pieces of shit and may hang the
222 * whole machine completely if accessed with the wrong timing.
223 * To avoid such catastrophe, vt6420 doesn't provide generic SCR
224 * access operations, but uses SStatus and SControl only during
225 * boot probing in controlled way.
227 * As the old (pre EH update) probing code is proven to work, we
228 * strictly follow the access pattern.
231 * Kernel thread context (may sleep)
234 * 0 on success, -errno otherwise.
236 static int vt6420_prereset(struct ata_port
*ap
)
238 struct ata_eh_context
*ehc
= &ap
->eh_context
;
239 unsigned long timeout
= jiffies
+ (HZ
* 5);
240 u32 sstatus
, scontrol
;
243 /* don't do any SCR stuff if we're not loading */
244 if (!(ap
->pflags
& ATA_PFLAG_LOADING
))
247 /* Resume phy. This is the old resume sequence from
248 * __sata_phy_reset().
250 svia_scr_write(ap
, SCR_CONTROL
, 0x300);
251 svia_scr_read(ap
, SCR_CONTROL
); /* flush */
253 /* wait for phy to become ready, if necessary */
256 if ((svia_scr_read(ap
, SCR_STATUS
) & 0xf) != 1)
258 } while (time_before(jiffies
, timeout
));
260 /* open code sata_print_link_status() */
261 sstatus
= svia_scr_read(ap
, SCR_STATUS
);
262 scontrol
= svia_scr_read(ap
, SCR_CONTROL
);
264 online
= (sstatus
& 0xf) == 0x3;
266 ata_port_printk(ap
, KERN_INFO
,
267 "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
268 online
? "up" : "down", sstatus
, scontrol
);
270 /* SStatus is read one more time */
271 svia_scr_read(ap
, SCR_STATUS
);
274 /* tell EH to bail */
275 ehc
->i
.action
&= ~ATA_EH_RESET_MASK
;
281 ata_busy_sleep(ap
, ATA_TMOUT_BOOT_QUICK
, ATA_TMOUT_BOOT
);
286 static void vt6420_error_handler(struct ata_port
*ap
)
288 return ata_bmdma_drive_eh(ap
, vt6420_prereset
, ata_std_softreset
,
289 NULL
, ata_std_postreset
);
292 static const unsigned int svia_bar_sizes
[] = {
296 static const unsigned int vt6421_bar_sizes
[] = {
297 16, 16, 16, 16, 32, 128
300 static unsigned long svia_scr_addr(unsigned long addr
, unsigned int port
)
302 return addr
+ (port
* 128);
305 static unsigned long vt6421_scr_addr(unsigned long addr
, unsigned int port
)
307 return addr
+ (port
* 64);
310 static void vt6421_init_addrs(struct ata_probe_ent
*probe_ent
,
311 struct pci_dev
*pdev
,
314 unsigned long reg_addr
= pci_resource_start(pdev
, port
);
315 unsigned long bmdma_addr
= pci_resource_start(pdev
, 4) + (port
* 8);
316 unsigned long scr_addr
;
318 probe_ent
->port
[port
].cmd_addr
= reg_addr
;
319 probe_ent
->port
[port
].altstatus_addr
=
320 probe_ent
->port
[port
].ctl_addr
= (reg_addr
+ 8) | ATA_PCI_CTL_OFS
;
321 probe_ent
->port
[port
].bmdma_addr
= bmdma_addr
;
323 scr_addr
= vt6421_scr_addr(pci_resource_start(pdev
, 5), port
);
324 probe_ent
->port
[port
].scr_addr
= scr_addr
;
326 ata_std_ports(&probe_ent
->port
[port
]);
329 static struct ata_probe_ent
*vt6420_init_probe_ent(struct pci_dev
*pdev
)
331 struct ata_probe_ent
*probe_ent
;
332 struct ata_port_info
*ppi
[2];
334 ppi
[0] = ppi
[1] = &vt6420_port_info
;
335 probe_ent
= ata_pci_init_native_mode(pdev
, ppi
, ATA_PORT_PRIMARY
| ATA_PORT_SECONDARY
);
339 probe_ent
->port
[0].scr_addr
=
340 svia_scr_addr(pci_resource_start(pdev
, 5), 0);
341 probe_ent
->port
[1].scr_addr
=
342 svia_scr_addr(pci_resource_start(pdev
, 5), 1);
347 static struct ata_probe_ent
*vt6421_init_probe_ent(struct pci_dev
*pdev
)
349 struct ata_probe_ent
*probe_ent
;
352 probe_ent
= kmalloc(sizeof(*probe_ent
), GFP_KERNEL
);
356 memset(probe_ent
, 0, sizeof(*probe_ent
));
357 probe_ent
->dev
= pci_dev_to_dev(pdev
);
358 INIT_LIST_HEAD(&probe_ent
->node
);
360 probe_ent
->sht
= &svia_sht
;
361 probe_ent
->port_flags
= ATA_FLAG_SATA
| ATA_FLAG_NO_LEGACY
;
362 probe_ent
->port_ops
= &vt6421_sata_ops
;
363 probe_ent
->n_ports
= N_PORTS
;
364 probe_ent
->irq
= pdev
->irq
;
365 probe_ent
->irq_flags
= IRQF_SHARED
;
366 probe_ent
->pio_mask
= 0x1f;
367 probe_ent
->mwdma_mask
= 0x07;
368 probe_ent
->udma_mask
= 0x7f;
370 for (i
= 0; i
< N_PORTS
; i
++)
371 vt6421_init_addrs(probe_ent
, pdev
, i
);
376 static void svia_configure(struct pci_dev
*pdev
)
380 pci_read_config_byte(pdev
, PCI_INTERRUPT_LINE
, &tmp8
);
381 dev_printk(KERN_INFO
, &pdev
->dev
, "routed to hard irq line %d\n",
382 (int) (tmp8
& 0xf0) == 0xf0 ? 0 : tmp8
& 0x0f);
384 /* make sure SATA channels are enabled */
385 pci_read_config_byte(pdev
, SATA_CHAN_ENAB
, &tmp8
);
386 if ((tmp8
& ALL_PORTS
) != ALL_PORTS
) {
387 dev_printk(KERN_DEBUG
, &pdev
->dev
,
388 "enabling SATA channels (0x%x)\n",
391 pci_write_config_byte(pdev
, SATA_CHAN_ENAB
, tmp8
);
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
) {
397 dev_printk(KERN_DEBUG
, &pdev
->dev
,
398 "enabling SATA channel interrupts (0x%x)\n",
401 pci_write_config_byte(pdev
, SATA_INT_GATE
, tmp8
);
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
) {
407 dev_printk(KERN_DEBUG
, &pdev
->dev
,
408 "enabling SATA channel native mode (0x%x)\n",
410 tmp8
|= NATIVE_MODE_ALL
;
411 pci_write_config_byte(pdev
, SATA_NATIVE_MODE
, tmp8
);
415 static int svia_init_one (struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
417 static int printed_version
;
420 struct ata_probe_ent
*probe_ent
;
421 int board_id
= (int) ent
->driver_data
;
422 const int *bar_sizes
;
423 int pci_dev_busy
= 0;
426 if (!printed_version
++)
427 dev_printk(KERN_DEBUG
, &pdev
->dev
, "version " DRV_VERSION
"\n");
429 rc
= pci_enable_device(pdev
);
433 rc
= pci_request_regions(pdev
, DRV_NAME
);
439 if (board_id
== vt6420
) {
440 pci_read_config_byte(pdev
, SATA_PATA_SHARING
, &tmp8
);
441 if (tmp8
& SATA_2DEV
) {
442 dev_printk(KERN_ERR
, &pdev
->dev
,
443 "SATA master/slave not supported (0x%x)\n",
446 goto err_out_regions
;
449 bar_sizes
= &svia_bar_sizes
[0];
451 bar_sizes
= &vt6421_bar_sizes
[0];
454 for (i
= 0; i
< ARRAY_SIZE(svia_bar_sizes
); i
++)
455 if ((pci_resource_start(pdev
, i
) == 0) ||
456 (pci_resource_len(pdev
, i
) < bar_sizes
[i
])) {
457 dev_printk(KERN_ERR
, &pdev
->dev
,
458 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
460 (unsigned long long)pci_resource_start(pdev
, i
),
461 (unsigned long long)pci_resource_len(pdev
, i
));
463 goto err_out_regions
;
466 rc
= pci_set_dma_mask(pdev
, ATA_DMA_MASK
);
468 goto err_out_regions
;
469 rc
= pci_set_consistent_dma_mask(pdev
, ATA_DMA_MASK
);
471 goto err_out_regions
;
473 if (board_id
== vt6420
)
474 probe_ent
= vt6420_init_probe_ent(pdev
);
476 probe_ent
= vt6421_init_probe_ent(pdev
);
479 dev_printk(KERN_ERR
, &pdev
->dev
, "out of memory\n");
481 goto err_out_regions
;
484 svia_configure(pdev
);
486 pci_set_master(pdev
);
488 /* FIXME: check ata_device_add return value */
489 ata_device_add(probe_ent
);
495 pci_release_regions(pdev
);
498 pci_disable_device(pdev
);
502 static int __init
svia_init(void)
504 return pci_register_driver(&svia_pci_driver
);
507 static void __exit
svia_exit(void)
509 pci_unregister_driver(&svia_pci_driver
);
512 module_init(svia_init
);
513 module_exit(svia_exit
);