2 * sata_promise.c - Promise SATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc.
10 * The contents of this file are subject to the Open
11 * Software License version 1.1 that can be found at
12 * http://www.opensource.org/licenses/osl-1.1.txt and is included herein
15 * Alternatively, the contents of this file may be used under the terms
16 * of the GNU General Public License version 2 (the "GPL") as distributed
17 * in the kernel source COPYING file, in which case the provisions of
18 * the GPL are applicable instead of the above. If you wish to allow
19 * the use of your version of this file only under the terms of the
20 * GPL and not to allow others to use your version of this file under
21 * the OSL, indicate your decision by deleting the provisions above and
22 * replace them with the notice and other provisions required by the GPL.
23 * If you do not delete the provisions above, a recipient may use your
24 * version of this file under either the OSL or the GPL.
28 #include <linux/kernel.h>
29 #include <linux/module.h>
30 #include <linux/pci.h>
31 #include <linux/init.h>
32 #include <linux/blkdev.h>
33 #include <linux/delay.h>
34 #include <linux/interrupt.h>
35 #include <linux/sched.h>
37 #include <scsi/scsi_host.h>
38 #include <linux/libata.h>
40 #include "sata_promise.h"
42 #define DRV_NAME "sata_promise"
43 #define DRV_VERSION "1.00"
47 PDC_PKT_SUBMIT
= 0x40, /* Command packet pointer addr */
48 PDC_INT_SEQMASK
= 0x40, /* Mask of asserted SEQ INTs */
49 PDC_TBG_MODE
= 0x41, /* TBG mode */
50 PDC_FLASH_CTL
= 0x44, /* Flash control register */
51 PDC_PCI_CTL
= 0x48, /* PCI control and status register */
52 PDC_GLOBAL_CTL
= 0x48, /* Global control/status (per port) */
53 PDC_CTLSTAT
= 0x60, /* IDE control and status (per port) */
54 PDC_SATA_PLUG_CSR
= 0x6C, /* SATA Plug control/status reg */
55 PDC_SLEW_CTL
= 0x470, /* slew rate control reg */
57 PDC_ERR_MASK
= (1<<19) | (1<<20) | (1<<21) | (1<<22) |
58 (1<<8) | (1<<9) | (1<<10),
60 board_2037x
= 0, /* FastTrak S150 TX2plus */
61 board_20319
= 1, /* FastTrak S150 TX4 */
63 PDC_HAS_PATA
= (1 << 1), /* PDC20375 has PATA */
65 PDC_RESET
= (1 << 11), /* HDMA reset */
69 struct pdc_port_priv
{
74 static u32
pdc_sata_scr_read (struct ata_port
*ap
, unsigned int sc_reg
);
75 static void pdc_sata_scr_write (struct ata_port
*ap
, unsigned int sc_reg
, u32 val
);
76 static int pdc_sata_init_one (struct pci_dev
*pdev
, const struct pci_device_id
*ent
);
77 static irqreturn_t
pdc_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
);
78 static void pdc_eng_timeout(struct ata_port
*ap
);
79 static int pdc_port_start(struct ata_port
*ap
);
80 static void pdc_port_stop(struct ata_port
*ap
);
81 static void pdc_phy_reset(struct ata_port
*ap
);
82 static void pdc_qc_prep(struct ata_queued_cmd
*qc
);
83 static void pdc_tf_load_mmio(struct ata_port
*ap
, struct ata_taskfile
*tf
);
84 static void pdc_exec_command_mmio(struct ata_port
*ap
, struct ata_taskfile
*tf
);
85 static void pdc_irq_clear(struct ata_port
*ap
);
86 static int pdc_qc_issue_prot(struct ata_queued_cmd
*qc
);
88 static Scsi_Host_Template pdc_sata_sht
= {
89 .module
= THIS_MODULE
,
91 .ioctl
= ata_scsi_ioctl
,
92 .queuecommand
= ata_scsi_queuecmd
,
93 .eh_strategy_handler
= ata_scsi_error
,
94 .can_queue
= ATA_DEF_QUEUE
,
95 .this_id
= ATA_SHT_THIS_ID
,
96 .sg_tablesize
= LIBATA_MAX_PRD
,
97 .max_sectors
= ATA_MAX_SECTORS
,
98 .cmd_per_lun
= ATA_SHT_CMD_PER_LUN
,
99 .emulated
= ATA_SHT_EMULATED
,
100 .use_clustering
= ATA_SHT_USE_CLUSTERING
,
101 .proc_name
= DRV_NAME
,
102 .dma_boundary
= ATA_DMA_BOUNDARY
,
103 .slave_configure
= ata_scsi_slave_config
,
104 .bios_param
= ata_std_bios_param
,
107 static struct ata_port_operations pdc_sata_ops
= {
108 .port_disable
= ata_port_disable
,
109 .tf_load
= pdc_tf_load_mmio
,
110 .tf_read
= ata_tf_read
,
111 .check_status
= ata_check_status
,
112 .exec_command
= pdc_exec_command_mmio
,
113 .dev_select
= ata_std_dev_select
,
114 .phy_reset
= pdc_phy_reset
,
115 .qc_prep
= pdc_qc_prep
,
116 .qc_issue
= pdc_qc_issue_prot
,
117 .eng_timeout
= pdc_eng_timeout
,
118 .irq_handler
= pdc_interrupt
,
119 .irq_clear
= pdc_irq_clear
,
120 .scr_read
= pdc_sata_scr_read
,
121 .scr_write
= pdc_sata_scr_write
,
122 .port_start
= pdc_port_start
,
123 .port_stop
= pdc_port_stop
,
126 static struct ata_port_info pdc_port_info
[] = {
129 .sht
= &pdc_sata_sht
,
130 .host_flags
= ATA_FLAG_SATA
| ATA_FLAG_NO_LEGACY
|
131 ATA_FLAG_SRST
| ATA_FLAG_MMIO
,
132 .pio_mask
= 0x1f, /* pio0-4 */
133 .mwdma_mask
= 0x07, /* mwdma0-2 */
134 .udma_mask
= 0x7f, /* udma0-6 ; FIXME */
135 .port_ops
= &pdc_sata_ops
,
140 .sht
= &pdc_sata_sht
,
141 .host_flags
= ATA_FLAG_SATA
| ATA_FLAG_NO_LEGACY
|
142 ATA_FLAG_SRST
| ATA_FLAG_MMIO
,
143 .pio_mask
= 0x1f, /* pio0-4 */
144 .mwdma_mask
= 0x07, /* mwdma0-2 */
145 .udma_mask
= 0x7f, /* udma0-6 ; FIXME */
146 .port_ops
= &pdc_sata_ops
,
150 static struct pci_device_id pdc_sata_pci_tbl
[] = {
151 { PCI_VENDOR_ID_PROMISE
, 0x3371, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
153 { PCI_VENDOR_ID_PROMISE
, 0x3373, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
155 { PCI_VENDOR_ID_PROMISE
, 0x3375, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
157 { PCI_VENDOR_ID_PROMISE
, 0x3376, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
159 { PCI_VENDOR_ID_PROMISE
, 0x3318, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
161 { PCI_VENDOR_ID_PROMISE
, 0x3319, PCI_ANY_ID
, PCI_ANY_ID
, 0, 0,
163 { } /* terminate list */
167 static struct pci_driver pdc_sata_pci_driver
= {
169 .id_table
= pdc_sata_pci_tbl
,
170 .probe
= pdc_sata_init_one
,
171 .remove
= ata_pci_remove_one
,
175 static int pdc_port_start(struct ata_port
*ap
)
177 struct pci_dev
*pdev
= ap
->host_set
->pdev
;
178 struct pdc_port_priv
*pp
;
181 rc
= ata_port_start(ap
);
185 pp
= kmalloc(sizeof(*pp
), GFP_KERNEL
);
190 memset(pp
, 0, sizeof(*pp
));
192 pp
->pkt
= pci_alloc_consistent(pdev
, 128, &pp
->pkt_dma
);
198 ap
->private_data
= pp
;
210 static void pdc_port_stop(struct ata_port
*ap
)
212 struct pci_dev
*pdev
= ap
->host_set
->pdev
;
213 struct pdc_port_priv
*pp
= ap
->private_data
;
215 ap
->private_data
= NULL
;
216 pci_free_consistent(pdev
, 128, pp
->pkt
, pp
->pkt_dma
);
222 static void pdc_reset_port(struct ata_port
*ap
)
224 void *mmio
= (void *) ap
->ioaddr
.cmd_addr
+ PDC_CTLSTAT
;
228 for (i
= 11; i
> 0; i
--) {
241 readl(mmio
); /* flush */
244 static void pdc_phy_reset(struct ata_port
*ap
)
250 static u32
pdc_sata_scr_read (struct ata_port
*ap
, unsigned int sc_reg
)
252 if (sc_reg
> SCR_CONTROL
)
254 return readl((void *) ap
->ioaddr
.scr_addr
+ (sc_reg
* 4));
258 static void pdc_sata_scr_write (struct ata_port
*ap
, unsigned int sc_reg
,
261 if (sc_reg
> SCR_CONTROL
)
263 writel(val
, (void *) ap
->ioaddr
.scr_addr
+ (sc_reg
* 4));
266 static void pdc_qc_prep(struct ata_queued_cmd
*qc
)
268 struct pdc_port_priv
*pp
= qc
->ap
->private_data
;
273 switch (qc
->tf
.protocol
) {
278 case ATA_PROT_NODATA
:
279 i
= pdc_pkt_header(&qc
->tf
, qc
->ap
->prd_dma
,
280 qc
->dev
->devno
, pp
->pkt
);
282 if (qc
->tf
.flags
& ATA_TFLAG_LBA48
)
283 i
= pdc_prep_lba48(&qc
->tf
, pp
->pkt
, i
);
285 i
= pdc_prep_lba28(&qc
->tf
, pp
->pkt
, i
);
287 pdc_pkt_footer(&qc
->tf
, pp
->pkt
, i
);
295 static void pdc_eng_timeout(struct ata_port
*ap
)
298 struct ata_queued_cmd
*qc
;
302 qc
= ata_qc_from_tag(ap
, ap
->active_tag
);
304 printk(KERN_ERR
"ata%u: BUG: timeout without command\n",
309 /* hack alert! We cannot use the supplied completion
310 * function from inside the ->eh_strategy_handler() thread.
311 * libata is the only user of ->eh_strategy_handler() in
312 * any kernel, so the default scsi_done() assumes it is
313 * not being called from the SCSI EH.
315 qc
->scsidone
= scsi_finish_command
;
317 switch (qc
->tf
.protocol
) {
319 case ATA_PROT_NODATA
:
320 printk(KERN_ERR
"ata%u: command timeout\n", ap
->id
);
321 ata_qc_complete(qc
, ata_wait_idle(ap
) | ATA_ERR
);
325 drv_stat
= ata_busy_wait(ap
, ATA_BUSY
| ATA_DRQ
, 1000);
327 printk(KERN_ERR
"ata%u: unknown timeout, cmd 0x%x stat 0x%x\n",
328 ap
->id
, qc
->tf
.command
, drv_stat
);
330 ata_qc_complete(qc
, drv_stat
);
338 static inline unsigned int pdc_host_intr( struct ata_port
*ap
,
339 struct ata_queued_cmd
*qc
)
342 unsigned int handled
= 0, have_err
= 0;
344 void *mmio
= (void *) ap
->ioaddr
.cmd_addr
+ PDC_GLOBAL_CTL
;
347 if (tmp
& PDC_ERR_MASK
) {
352 switch (qc
->tf
.protocol
) {
354 case ATA_PROT_NODATA
:
355 status
= ata_wait_idle(ap
);
358 ata_qc_complete(qc
, status
);
363 ap
->stats
.idle_irq
++;
370 static void pdc_irq_clear(struct ata_port
*ap
)
372 struct ata_host_set
*host_set
= ap
->host_set
;
373 void *mmio
= host_set
->mmio_base
;
375 readl(mmio
+ PDC_INT_SEQMASK
);
378 static irqreturn_t
pdc_interrupt (int irq
, void *dev_instance
, struct pt_regs
*regs
)
380 struct ata_host_set
*host_set
= dev_instance
;
384 unsigned int handled
= 0;
389 if (!host_set
|| !host_set
->mmio_base
) {
390 VPRINTK("QUICK EXIT\n");
394 mmio_base
= host_set
->mmio_base
;
396 /* reading should also clear interrupts */
397 mask
= readl(mmio_base
+ PDC_INT_SEQMASK
);
399 if (mask
== 0xffffffff) {
400 VPRINTK("QUICK EXIT 2\n");
403 mask
&= 0xffff; /* only 16 tags possible */
405 VPRINTK("QUICK EXIT 3\n");
409 spin_lock(&host_set
->lock
);
411 for (i
= 0; i
< host_set
->n_ports
; i
++) {
412 VPRINTK("port %u\n", i
);
413 ap
= host_set
->ports
[i
];
414 tmp
= mask
& (1 << (i
+ 1));
415 if (tmp
&& ap
&& (!(ap
->flags
& ATA_FLAG_PORT_DISABLED
))) {
416 struct ata_queued_cmd
*qc
;
418 qc
= ata_qc_from_tag(ap
, ap
->active_tag
);
419 if (qc
&& (!(qc
->tf
.ctl
& ATA_NIEN
)))
420 handled
+= pdc_host_intr(ap
, qc
);
424 spin_unlock(&host_set
->lock
);
428 return IRQ_RETVAL(handled
);
431 static inline void pdc_packet_start(struct ata_queued_cmd
*qc
)
433 struct ata_port
*ap
= qc
->ap
;
434 struct pdc_port_priv
*pp
= ap
->private_data
;
435 unsigned int port_no
= ap
->port_no
;
436 u8 seq
= (u8
) (port_no
+ 1);
438 VPRINTK("ENTER, ap %p\n", ap
);
440 writel(0x00000001, ap
->host_set
->mmio_base
+ (seq
* 4));
441 readl(ap
->host_set
->mmio_base
+ (seq
* 4)); /* flush */
444 wmb(); /* flush PRD, pkt writes */
445 writel(pp
->pkt_dma
, (void *) ap
->ioaddr
.cmd_addr
+ PDC_PKT_SUBMIT
);
446 readl((void *) ap
->ioaddr
.cmd_addr
+ PDC_PKT_SUBMIT
); /* flush */
449 static int pdc_qc_issue_prot(struct ata_queued_cmd
*qc
)
451 switch (qc
->tf
.protocol
) {
453 case ATA_PROT_NODATA
:
454 pdc_packet_start(qc
);
457 case ATA_PROT_ATAPI_DMA
:
465 return ata_qc_issue_prot(qc
);
468 static void pdc_tf_load_mmio(struct ata_port
*ap
, struct ata_taskfile
*tf
)
470 WARN_ON (tf
->protocol
== ATA_PROT_DMA
||
471 tf
->protocol
== ATA_PROT_NODATA
);
476 static void pdc_exec_command_mmio(struct ata_port
*ap
, struct ata_taskfile
*tf
)
478 WARN_ON (tf
->protocol
== ATA_PROT_DMA
||
479 tf
->protocol
== ATA_PROT_NODATA
);
480 ata_exec_command(ap
, tf
);
484 static void pdc_sata_setup_port(struct ata_ioports
*port
, unsigned long base
)
486 port
->cmd_addr
= base
;
487 port
->data_addr
= base
;
489 port
->error_addr
= base
+ 0x4;
490 port
->nsect_addr
= base
+ 0x8;
491 port
->lbal_addr
= base
+ 0xc;
492 port
->lbam_addr
= base
+ 0x10;
493 port
->lbah_addr
= base
+ 0x14;
494 port
->device_addr
= base
+ 0x18;
496 port
->status_addr
= base
+ 0x1c;
497 port
->altstatus_addr
=
498 port
->ctl_addr
= base
+ 0x38;
502 static void pdc_host_init(unsigned int chip_id
, struct ata_probe_ent
*pe
)
504 void *mmio
= pe
->mmio_base
;
508 * Except for the hotplug stuff, this is voodoo from the
509 * Promise driver. Label this entire section
510 * "TODO: figure out why we do this"
513 /* change FIFO_SHD to 8 dwords, enable BMR_BURST */
514 tmp
= readl(mmio
+ PDC_FLASH_CTL
);
515 tmp
|= 0x12000; /* bit 16 (fifo 8 dw) and 13 (bmr burst?) */
516 writel(tmp
, mmio
+ PDC_FLASH_CTL
);
518 /* clear plug/unplug flags for all ports */
519 tmp
= readl(mmio
+ PDC_SATA_PLUG_CSR
);
520 writel(tmp
| 0xff, mmio
+ PDC_SATA_PLUG_CSR
);
522 /* mask plug/unplug ints */
523 tmp
= readl(mmio
+ PDC_SATA_PLUG_CSR
);
524 writel(tmp
| 0xff0000, mmio
+ PDC_SATA_PLUG_CSR
);
526 /* reduce TBG clock to 133 Mhz. */
527 tmp
= readl(mmio
+ PDC_TBG_MODE
);
528 tmp
&= ~0x30000; /* clear bit 17, 16*/
529 tmp
|= 0x10000; /* set bit 17:16 = 0:1 */
530 writel(tmp
, mmio
+ PDC_TBG_MODE
);
532 readl(mmio
+ PDC_TBG_MODE
); /* flush */
535 /* adjust slew rate control register. */
536 tmp
= readl(mmio
+ PDC_SLEW_CTL
);
537 tmp
&= 0xFFFFF03F; /* clear bit 11 ~ 6 */
538 tmp
|= 0x00000900; /* set bit 11-9 = 100b , bit 8-6 = 100 */
539 writel(tmp
, mmio
+ PDC_SLEW_CTL
);
542 static int pdc_sata_init_one (struct pci_dev
*pdev
, const struct pci_device_id
*ent
)
544 static int printed_version
;
545 struct ata_probe_ent
*probe_ent
= NULL
;
548 unsigned int board_idx
= (unsigned int) ent
->driver_data
;
551 if (!printed_version
++)
552 printk(KERN_DEBUG DRV_NAME
" version " DRV_VERSION
"\n");
555 * If this driver happens to only be useful on Apple's K2, then
556 * we should check that here as it has a normal Serverworks ID
558 rc
= pci_enable_device(pdev
);
562 rc
= pci_request_regions(pdev
, DRV_NAME
);
566 rc
= pci_set_dma_mask(pdev
, ATA_DMA_MASK
);
568 goto err_out_regions
;
569 rc
= pci_set_consistent_dma_mask(pdev
, ATA_DMA_MASK
);
571 goto err_out_regions
;
573 probe_ent
= kmalloc(sizeof(*probe_ent
), GFP_KERNEL
);
574 if (probe_ent
== NULL
) {
576 goto err_out_regions
;
579 memset(probe_ent
, 0, sizeof(*probe_ent
));
580 probe_ent
->pdev
= pdev
;
581 INIT_LIST_HEAD(&probe_ent
->node
);
583 mmio_base
= ioremap(pci_resource_start(pdev
, 3),
584 pci_resource_len(pdev
, 3));
585 if (mmio_base
== NULL
) {
587 goto err_out_free_ent
;
589 base
= (unsigned long) mmio_base
;
591 probe_ent
->sht
= pdc_port_info
[board_idx
].sht
;
592 probe_ent
->host_flags
= pdc_port_info
[board_idx
].host_flags
;
593 probe_ent
->pio_mask
= pdc_port_info
[board_idx
].pio_mask
;
594 probe_ent
->mwdma_mask
= pdc_port_info
[board_idx
].mwdma_mask
;
595 probe_ent
->udma_mask
= pdc_port_info
[board_idx
].udma_mask
;
596 probe_ent
->port_ops
= pdc_port_info
[board_idx
].port_ops
;
598 probe_ent
->irq
= pdev
->irq
;
599 probe_ent
->irq_flags
= SA_SHIRQ
;
600 probe_ent
->mmio_base
= mmio_base
;
602 pdc_sata_setup_port(&probe_ent
->port
[0], base
+ 0x200);
603 pdc_sata_setup_port(&probe_ent
->port
[1], base
+ 0x280);
605 probe_ent
->port
[0].scr_addr
= base
+ 0x400;
606 probe_ent
->port
[1].scr_addr
= base
+ 0x500;
608 /* notice 4-port boards */
611 probe_ent
->n_ports
= 4;
613 pdc_sata_setup_port(&probe_ent
->port
[2], base
+ 0x300);
614 pdc_sata_setup_port(&probe_ent
->port
[3], base
+ 0x380);
616 probe_ent
->port
[2].scr_addr
= base
+ 0x600;
617 probe_ent
->port
[3].scr_addr
= base
+ 0x700;
620 probe_ent
->n_ports
= 2;
627 pci_set_master(pdev
);
629 /* initialize adapter */
630 pdc_host_init(board_idx
, probe_ent
);
632 /* FIXME: check ata_device_add return value */
633 ata_device_add(probe_ent
);
641 pci_release_regions(pdev
);
643 pci_disable_device(pdev
);
648 static int __init
pdc_sata_init(void)
650 return pci_module_init(&pdc_sata_pci_driver
);
654 static void __exit
pdc_sata_exit(void)
656 pci_unregister_driver(&pdc_sata_pci_driver
);
660 MODULE_AUTHOR("Jeff Garzik");
661 MODULE_DESCRIPTION("Promise SATA TX2/TX4 low-level driver");
662 MODULE_LICENSE("GPL");
663 MODULE_DEVICE_TABLE(pci
, pdc_sata_pci_tbl
);
665 module_init(pdc_sata_init
);
666 module_exit(pdc_sata_exit
);