2 * sata_qstor.c - Pacific Digital Corporation QStor SATA
4 * Maintained by: Mark Lord <mlord@pobox.com>
6 * Copyright 2005 Pacific Digital Corporation.
7 * (OSL/GPL code release authorized by Jalil Fadavi).
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2, or (at your option)
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; see the file COPYING. If not, write to
22 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25 * libata documentation is available via 'make {ps|pdf}docs',
26 * as Documentation/DocBook/libata.*
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/gfp.h>
33 #include <linux/pci.h>
34 #include <linux/blkdev.h>
35 #include <linux/delay.h>
36 #include <linux/interrupt.h>
37 #include <linux/device.h>
38 #include <scsi/scsi_host.h>
39 #include <linux/libata.h>
41 #define DRV_NAME "sata_qstor"
42 #define DRV_VERSION "0.09"
48 QS_MAX_PRD = LIBATA_MAX_PRD,
50 QS_CPB_BYTES = (1 << QS_CPB_ORDER),
51 QS_PRD_BYTES = QS_MAX_PRD * 16,
52 QS_PKT_BYTES = QS_CPB_BYTES + QS_PRD_BYTES,
54 /* global register offsets */
55 QS_HCF_CNFG3 = 0x0003, /* host configuration offset */
56 QS_HID_HPHY = 0x0004, /* host physical interface info */
57 QS_HCT_CTRL = 0x00e4, /* global interrupt mask offset */
58 QS_HST_SFF = 0x0100, /* host status fifo offset */
59 QS_HVS_SERD3 = 0x0393, /* PHY enable offset */
61 /* global control bits */
62 QS_HPHY_64BIT = (1 << 1), /* 64-bit bus detected */
63 QS_CNFG3_GSRST = 0x01, /* global chip reset */
64 QS_SERD3_PHY_ENA = 0xf0, /* PHY detection ENAble*/
66 /* per-channel register offsets */
67 QS_CCF_CPBA = 0x0710, /* chan CPB base address */
68 QS_CCF_CSEP = 0x0718, /* chan CPB separation factor */
69 QS_CFC_HUFT = 0x0800, /* host upstream fifo threshold */
70 QS_CFC_HDFT = 0x0804, /* host downstream fifo threshold */
71 QS_CFC_DUFT = 0x0808, /* dev upstream fifo threshold */
72 QS_CFC_DDFT = 0x080c, /* dev downstream fifo threshold */
73 QS_CCT_CTR0 = 0x0900, /* chan control-0 offset */
74 QS_CCT_CTR1 = 0x0901, /* chan control-1 offset */
75 QS_CCT_CFF = 0x0a00, /* chan command fifo offset */
77 /* channel control bits */
78 QS_CTR0_REG = (1 << 1), /* register mode (vs. pkt mode) */
79 QS_CTR0_CLER = (1 << 2), /* clear channel errors */
80 QS_CTR1_RDEV = (1 << 1), /* sata phy/comms reset */
81 QS_CTR1_RCHN = (1 << 4), /* reset channel logic */
82 QS_CCF_RUN_PKT = 0x107, /* RUN a new dma PKT */
84 /* pkt sub-field headers */
85 QS_HCB_HDR = 0x01, /* Host Control Block header */
86 QS_DCB_HDR = 0x02, /* Device Control Block header */
88 /* pkt HCB flag bits */
89 QS_HF_DIRO = (1 << 0), /* data DIRection Out */
90 QS_HF_DAT = (1 << 3), /* DATa pkt */
91 QS_HF_IEN = (1 << 4), /* Interrupt ENable */
92 QS_HF_VLD = (1 << 5), /* VaLiD pkt */
94 /* pkt DCB flag bits */
95 QS_DF_PORD = (1 << 2), /* Pio OR Dma */
96 QS_DF_ELBA = (1 << 3), /* Extended LBA (lba48) */
99 board_2068_idx = 0, /* QStor 4-port SATA/RAID */
103 QS_DMA_BOUNDARY = ~0UL
106 typedef enum { qs_state_mmio, qs_state_pkt } qs_state_t;
108 struct qs_port_priv {
114 static int qs_scr_read(struct ata_link *link, unsigned int sc_reg, u32 *val);
115 static int qs_scr_write(struct ata_link *link, unsigned int sc_reg, u32 val);
116 static int qs_ata_init_one(struct pci_dev *pdev, const struct pci_device_id *ent);
117 static int qs_port_start(struct ata_port *ap);
118 static void qs_host_stop(struct ata_host *host);
119 static enum ata_completion_errors qs_qc_prep(struct ata_queued_cmd *qc);
120 static unsigned int qs_qc_issue(struct ata_queued_cmd *qc);
121 static int qs_check_atapi_dma(struct ata_queued_cmd *qc);
122 static void qs_freeze(struct ata_port *ap);
123 static void qs_thaw(struct ata_port *ap);
124 static int qs_prereset(struct ata_link *link, unsigned long deadline);
125 static void qs_error_handler(struct ata_port *ap);
127 static struct scsi_host_template qs_ata_sht = {
128 ATA_BASE_SHT(DRV_NAME),
129 .sg_tablesize = QS_MAX_PRD,
130 .dma_boundary = QS_DMA_BOUNDARY,
133 static struct ata_port_operations qs_ata_ops = {
134 .inherits = &ata_sff_port_ops,
136 .check_atapi_dma = qs_check_atapi_dma,
137 .qc_prep = qs_qc_prep,
138 .qc_issue = qs_qc_issue,
142 .prereset = qs_prereset,
143 .softreset = ATA_OP_NULL,
144 .error_handler = qs_error_handler,
145 .lost_interrupt = ATA_OP_NULL,
147 .scr_read = qs_scr_read,
148 .scr_write = qs_scr_write,
150 .port_start = qs_port_start,
151 .host_stop = qs_host_stop,
154 static const struct ata_port_info qs_port_info[] = {
157 .flags = ATA_FLAG_SATA | ATA_FLAG_PIO_POLLING,
158 .pio_mask = ATA_PIO4_ONLY,
159 .udma_mask = ATA_UDMA6,
160 .port_ops = &qs_ata_ops,
164 static const struct pci_device_id qs_ata_pci_tbl[] = {
165 { PCI_VDEVICE(PDC, 0x2068), board_2068_idx },
167 { } /* terminate list */
170 static struct pci_driver qs_ata_pci_driver = {
172 .id_table = qs_ata_pci_tbl,
173 .probe = qs_ata_init_one,
174 .remove = ata_pci_remove_one,
177 static void __iomem *qs_mmio_base(struct ata_host *host)
179 return host->iomap[QS_MMIO_BAR];
182 static int qs_check_atapi_dma(struct ata_queued_cmd *qc)
184 return 1; /* ATAPI DMA not supported */
187 static inline void qs_enter_reg_mode(struct ata_port *ap)
189 u8 __iomem *chan = qs_mmio_base(ap->host) + (ap->port_no * 0x4000);
190 struct qs_port_priv *pp = ap->private_data;
192 pp->state = qs_state_mmio;
193 writeb(QS_CTR0_REG, chan + QS_CCT_CTR0);
194 readb(chan + QS_CCT_CTR0); /* flush */
197 static inline void qs_reset_channel_logic(struct ata_port *ap)
199 u8 __iomem *chan = qs_mmio_base(ap->host) + (ap->port_no * 0x4000);
201 writeb(QS_CTR1_RCHN, chan + QS_CCT_CTR1);
202 readb(chan + QS_CCT_CTR0); /* flush */
203 qs_enter_reg_mode(ap);
206 static void qs_freeze(struct ata_port *ap)
208 u8 __iomem *mmio_base = qs_mmio_base(ap->host);
210 writeb(0, mmio_base + QS_HCT_CTRL); /* disable host interrupts */
211 qs_enter_reg_mode(ap);
214 static void qs_thaw(struct ata_port *ap)
216 u8 __iomem *mmio_base = qs_mmio_base(ap->host);
218 qs_enter_reg_mode(ap);
219 writeb(1, mmio_base + QS_HCT_CTRL); /* enable host interrupts */
222 static int qs_prereset(struct ata_link *link, unsigned long deadline)
224 struct ata_port *ap = link->ap;
226 qs_reset_channel_logic(ap);
227 return ata_sff_prereset(link, deadline);
230 static int qs_scr_read(struct ata_link *link, unsigned int sc_reg, u32 *val)
232 if (sc_reg > SCR_CONTROL)
234 *val = readl(link->ap->ioaddr.scr_addr + (sc_reg * 8));
238 static void qs_error_handler(struct ata_port *ap)
240 qs_enter_reg_mode(ap);
241 ata_sff_error_handler(ap);
244 static int qs_scr_write(struct ata_link *link, unsigned int sc_reg, u32 val)
246 if (sc_reg > SCR_CONTROL)
248 writel(val, link->ap->ioaddr.scr_addr + (sc_reg * 8));
252 static unsigned int qs_fill_sg(struct ata_queued_cmd *qc)
254 struct scatterlist *sg;
255 struct ata_port *ap = qc->ap;
256 struct qs_port_priv *pp = ap->private_data;
257 u8 *prd = pp->pkt + QS_CPB_BYTES;
260 for_each_sg(qc->sg, sg, qc->n_elem, si) {
264 addr = sg_dma_address(sg);
265 *(__le64 *)prd = cpu_to_le64(addr);
268 len = sg_dma_len(sg);
269 *(__le32 *)prd = cpu_to_le32(len);
272 VPRINTK("PRD[%u] = (0x%llX, 0x%X)\n", si,
273 (unsigned long long)addr, len);
279 static enum ata_completion_errors qs_qc_prep(struct ata_queued_cmd *qc)
281 struct qs_port_priv *pp = qc->ap->private_data;
282 u8 dflags = QS_DF_PORD, *buf = pp->pkt;
283 u8 hflags = QS_HF_DAT | QS_HF_IEN | QS_HF_VLD;
289 qs_enter_reg_mode(qc->ap);
290 if (qc->tf.protocol != ATA_PROT_DMA)
293 nelem = qs_fill_sg(qc);
295 if ((qc->tf.flags & ATA_TFLAG_WRITE))
296 hflags |= QS_HF_DIRO;
297 if ((qc->tf.flags & ATA_TFLAG_LBA48))
298 dflags |= QS_DF_ELBA;
300 /* host control block (HCB) */
301 buf[ 0] = QS_HCB_HDR;
303 *(__le32 *)(&buf[ 4]) = cpu_to_le32(qc->nbytes);
304 *(__le32 *)(&buf[ 8]) = cpu_to_le32(nelem);
305 addr = ((u64)pp->pkt_dma) + QS_CPB_BYTES;
306 *(__le64 *)(&buf[16]) = cpu_to_le64(addr);
308 /* device control block (DCB) */
309 buf[24] = QS_DCB_HDR;
312 /* frame information structure (FIS) */
313 ata_tf_to_fis(&qc->tf, 0, 1, &buf[32]);
318 static inline void qs_packet_start(struct ata_queued_cmd *qc)
320 struct ata_port *ap = qc->ap;
321 u8 __iomem *chan = qs_mmio_base(ap->host) + (ap->port_no * 0x4000);
323 VPRINTK("ENTER, ap %p\n", ap);
325 writeb(QS_CTR0_CLER, chan + QS_CCT_CTR0);
326 wmb(); /* flush PRDs and pkt to memory */
327 writel(QS_CCF_RUN_PKT, chan + QS_CCT_CFF);
328 readl(chan + QS_CCT_CFF); /* flush */
331 static unsigned int qs_qc_issue(struct ata_queued_cmd *qc)
333 struct qs_port_priv *pp = qc->ap->private_data;
335 switch (qc->tf.protocol) {
337 pp->state = qs_state_pkt;
349 pp->state = qs_state_mmio;
350 return ata_sff_qc_issue(qc);
353 static void qs_do_or_die(struct ata_queued_cmd *qc, u8 status)
355 qc->err_mask |= ac_err_mask(status);
360 struct ata_port *ap = qc->ap;
361 struct ata_eh_info *ehi = &ap->link.eh_info;
363 ata_ehi_clear_desc(ehi);
364 ata_ehi_push_desc(ehi, "status 0x%02X", status);
366 if (qc->err_mask == AC_ERR_DEV)
373 static inline unsigned int qs_intr_pkt(struct ata_host *host)
375 unsigned int handled = 0;
377 u8 __iomem *mmio_base = qs_mmio_base(host);
380 u32 sff0 = readl(mmio_base + QS_HST_SFF);
381 u32 sff1 = readl(mmio_base + QS_HST_SFF + 4);
382 u8 sEVLD = (sff1 >> 30) & 0x01; /* valid flag */
383 sFFE = sff1 >> 31; /* empty flag */
386 u8 sDST = sff0 >> 16; /* dev status */
387 u8 sHST = sff1 & 0x3f; /* host status */
388 unsigned int port_no = (sff1 >> 8) & 0x03;
389 struct ata_port *ap = host->ports[port_no];
390 struct qs_port_priv *pp = ap->private_data;
391 struct ata_queued_cmd *qc;
393 DPRINTK("SFF=%08x%08x: sCHAN=%u sHST=%d sDST=%02x\n",
394 sff1, sff0, port_no, sHST, sDST);
396 if (!pp || pp->state != qs_state_pkt)
398 qc = ata_qc_from_tag(ap, ap->link.active_tag);
399 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
401 case 0: /* successful CPB */
402 case 3: /* device error */
403 qs_enter_reg_mode(qc->ap);
404 qs_do_or_die(qc, sDST);
415 static inline unsigned int qs_intr_mmio(struct ata_host *host)
417 unsigned int handled = 0, port_no;
419 for (port_no = 0; port_no < host->n_ports; ++port_no) {
420 struct ata_port *ap = host->ports[port_no];
421 struct qs_port_priv *pp = ap->private_data;
422 struct ata_queued_cmd *qc;
424 qc = ata_qc_from_tag(ap, ap->link.active_tag);
427 * The qstor hardware generates spurious
428 * interrupts from time to time when switching
429 * in and out of packet mode. There's no
430 * obvious way to know if we're here now due
431 * to that, so just ack the irq and pretend we
432 * knew it was ours.. (ugh). This does not
433 * affect packet mode.
435 ata_sff_check_status(ap);
440 if (!pp || pp->state != qs_state_mmio)
442 if (!(qc->tf.flags & ATA_TFLAG_POLLING))
443 handled |= ata_sff_port_intr(ap, qc);
448 static irqreturn_t qs_intr(int irq, void *dev_instance)
450 struct ata_host *host = dev_instance;
451 unsigned int handled = 0;
456 spin_lock_irqsave(&host->lock, flags);
457 handled = qs_intr_pkt(host) | qs_intr_mmio(host);
458 spin_unlock_irqrestore(&host->lock, flags);
462 return IRQ_RETVAL(handled);
465 static void qs_ata_setup_port(struct ata_ioports *port, void __iomem *base)
468 port->data_addr = base + 0x400;
470 port->feature_addr = base + 0x408; /* hob_feature = 0x409 */
471 port->nsect_addr = base + 0x410; /* hob_nsect = 0x411 */
472 port->lbal_addr = base + 0x418; /* hob_lbal = 0x419 */
473 port->lbam_addr = base + 0x420; /* hob_lbam = 0x421 */
474 port->lbah_addr = base + 0x428; /* hob_lbah = 0x429 */
475 port->device_addr = base + 0x430;
477 port->command_addr = base + 0x438;
478 port->altstatus_addr =
479 port->ctl_addr = base + 0x440;
480 port->scr_addr = base + 0xc00;
483 static int qs_port_start(struct ata_port *ap)
485 struct device *dev = ap->host->dev;
486 struct qs_port_priv *pp;
487 void __iomem *mmio_base = qs_mmio_base(ap->host);
488 void __iomem *chan = mmio_base + (ap->port_no * 0x4000);
491 pp = devm_kzalloc(dev, sizeof(*pp), GFP_KERNEL);
494 pp->pkt = dmam_alloc_coherent(dev, QS_PKT_BYTES, &pp->pkt_dma,
498 memset(pp->pkt, 0, QS_PKT_BYTES);
499 ap->private_data = pp;
501 qs_enter_reg_mode(ap);
502 addr = (u64)pp->pkt_dma;
503 writel((u32) addr, chan + QS_CCF_CPBA);
504 writel((u32)(addr >> 32), chan + QS_CCF_CPBA + 4);
508 static void qs_host_stop(struct ata_host *host)
510 void __iomem *mmio_base = qs_mmio_base(host);
512 writeb(0, mmio_base + QS_HCT_CTRL); /* disable host interrupts */
513 writeb(QS_CNFG3_GSRST, mmio_base + QS_HCF_CNFG3); /* global reset */
516 static void qs_host_init(struct ata_host *host, unsigned int chip_id)
518 void __iomem *mmio_base = host->iomap[QS_MMIO_BAR];
519 unsigned int port_no;
521 writeb(0, mmio_base + QS_HCT_CTRL); /* disable host interrupts */
522 writeb(QS_CNFG3_GSRST, mmio_base + QS_HCF_CNFG3); /* global reset */
524 /* reset each channel in turn */
525 for (port_no = 0; port_no < host->n_ports; ++port_no) {
526 u8 __iomem *chan = mmio_base + (port_no * 0x4000);
527 writeb(QS_CTR1_RDEV|QS_CTR1_RCHN, chan + QS_CCT_CTR1);
528 writeb(QS_CTR0_REG, chan + QS_CCT_CTR0);
529 readb(chan + QS_CCT_CTR0); /* flush */
531 writeb(QS_SERD3_PHY_ENA, mmio_base + QS_HVS_SERD3); /* enable phy */
533 for (port_no = 0; port_no < host->n_ports; ++port_no) {
534 u8 __iomem *chan = mmio_base + (port_no * 0x4000);
535 /* set FIFO depths to same settings as Windows driver */
536 writew(32, chan + QS_CFC_HUFT);
537 writew(32, chan + QS_CFC_HDFT);
538 writew(10, chan + QS_CFC_DUFT);
539 writew( 8, chan + QS_CFC_DDFT);
540 /* set CPB size in bytes, as a power of two */
541 writeb(QS_CPB_ORDER, chan + QS_CCF_CSEP);
543 writeb(1, mmio_base + QS_HCT_CTRL); /* enable host interrupts */
547 * The QStor understands 64-bit buses, and uses 64-bit fields
548 * for DMA pointers regardless of bus width. We just have to
549 * make sure our DMA masks are set appropriately for whatever
550 * bridge lies between us and the QStor, and then the DMA mapping
551 * code will ensure we only ever "see" appropriate buffer addresses.
552 * If we're 32-bit limited somewhere, then our 64-bit fields will
553 * just end up with zeros in the upper 32-bits, without any special
554 * logic required outside of this routine (below).
556 static int qs_set_dma_masks(struct pci_dev *pdev, void __iomem *mmio_base)
558 u32 bus_info = readl(mmio_base + QS_HID_HPHY);
559 int rc, have_64bit_bus = (bus_info & QS_HPHY_64BIT);
561 if (have_64bit_bus &&
562 !dma_set_mask(&pdev->dev, DMA_BIT_MASK(64))) {
563 rc = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(64));
565 rc = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
568 "64-bit DMA enable failed\n");
573 rc = dma_set_mask(&pdev->dev, DMA_BIT_MASK(32));
575 dev_err(&pdev->dev, "32-bit DMA enable failed\n");
578 rc = dma_set_coherent_mask(&pdev->dev, DMA_BIT_MASK(32));
581 "32-bit consistent DMA enable failed\n");
588 static int qs_ata_init_one(struct pci_dev *pdev,
589 const struct pci_device_id *ent)
591 unsigned int board_idx = (unsigned int) ent->driver_data;
592 const struct ata_port_info *ppi[] = { &qs_port_info[board_idx], NULL };
593 struct ata_host *host;
596 ata_print_version_once(&pdev->dev, DRV_VERSION);
599 host = ata_host_alloc_pinfo(&pdev->dev, ppi, QS_PORTS);
603 /* acquire resources and fill host */
604 rc = pcim_enable_device(pdev);
608 if ((pci_resource_flags(pdev, QS_MMIO_BAR) & IORESOURCE_MEM) == 0)
611 rc = pcim_iomap_regions(pdev, 1 << QS_MMIO_BAR, DRV_NAME);
614 host->iomap = pcim_iomap_table(pdev);
616 rc = qs_set_dma_masks(pdev, host->iomap[QS_MMIO_BAR]);
620 for (port_no = 0; port_no < host->n_ports; ++port_no) {
621 struct ata_port *ap = host->ports[port_no];
622 unsigned int offset = port_no * 0x4000;
623 void __iomem *chan = host->iomap[QS_MMIO_BAR] + offset;
625 qs_ata_setup_port(&ap->ioaddr, chan);
627 ata_port_pbar_desc(ap, QS_MMIO_BAR, -1, "mmio");
628 ata_port_pbar_desc(ap, QS_MMIO_BAR, offset, "port");
631 /* initialize adapter */
632 qs_host_init(host, board_idx);
634 pci_set_master(pdev);
635 return ata_host_activate(host, pdev->irq, qs_intr, IRQF_SHARED,
639 module_pci_driver(qs_ata_pci_driver);
641 MODULE_AUTHOR("Mark Lord");
642 MODULE_DESCRIPTION("Pacific Digital Corporation QStor SATA low-level driver");
643 MODULE_LICENSE("GPL");
644 MODULE_DEVICE_TABLE(pci, qs_ata_pci_tbl);
645 MODULE_VERSION(DRV_VERSION);