2 * drivers/ata/sata_dwc_460ex.c
4 * Synopsys DesignWare Cores (DWC) SATA host driver
6 * Author: Mark Miesfeld <mmiesfeld@amcc.com>
8 * Ported from 2.6.19.2 to 2.6.25/26 by Stefan Roese <sr@denx.de>
9 * Copyright 2008 DENX Software Engineering
11 * Based on versions provided by AMCC and Synopsys which are:
12 * Copyright 2006 Applied Micro Circuits Corporation
13 * COPYRIGHT (C) 2005 SYNOPSYS, INC. ALL RIGHTS RESERVED
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2 of the License, or (at your
18 * option) any later version.
21 #ifdef CONFIG_SATA_DWC_DEBUG
25 #ifdef CONFIG_SATA_DWC_VDEBUG
30 #include <linux/kernel.h>
31 #include <linux/module.h>
32 #include <linux/device.h>
33 #include <linux/dmaengine.h>
34 #include <linux/of_address.h>
35 #include <linux/of_irq.h>
36 #include <linux/of_platform.h>
37 #include <linux/platform_device.h>
38 #include <linux/phy/phy.h>
39 #include <linux/libata.h>
40 #include <linux/slab.h>
44 #include <scsi/scsi_host.h>
45 #include <scsi/scsi_cmnd.h>
47 /* These two are defined in "libata.h" */
51 #define DRV_NAME "sata-dwc"
52 #define DRV_VERSION "1.3"
54 #define sata_dwc_writel(a, v) writel_relaxed(v, a)
55 #define sata_dwc_readl(a) readl_relaxed(a)
61 #define AHB_DMA_BRST_DFLT 64 /* 16 data items burst length */
64 SATA_DWC_MAX_PORTS = 1,
66 SATA_DWC_SCR_OFFSET = 0x24,
67 SATA_DWC_REG_OFFSET = 0x64,
70 /* DWC SATA Registers */
71 struct sata_dwc_regs {
72 u32 fptagr; /* 1st party DMA tag */
73 u32 fpbor; /* 1st party DMA buffer offset */
74 u32 fptcr; /* 1st party DMA Xfr count */
75 u32 dmacr; /* DMA Control */
76 u32 dbtsr; /* DMA Burst Transac size */
77 u32 intpr; /* Interrupt Pending */
78 u32 intmr; /* Interrupt Mask */
79 u32 errmr; /* Error Mask */
80 u32 llcr; /* Link Layer Control */
81 u32 phycr; /* PHY Control */
82 u32 physr; /* PHY Status */
83 u32 rxbistpd; /* Recvd BIST pattern def register */
84 u32 rxbistpd1; /* Recvd BIST data dword1 */
85 u32 rxbistpd2; /* Recvd BIST pattern data dword2 */
86 u32 txbistpd; /* Trans BIST pattern def register */
87 u32 txbistpd1; /* Trans BIST data dword1 */
88 u32 txbistpd2; /* Trans BIST data dword2 */
89 u32 bistcr; /* BIST Control Register */
90 u32 bistfctr; /* BIST FIS Count Register */
91 u32 bistsr; /* BIST Status Register */
92 u32 bistdecr; /* BIST Dword Error count register */
93 u32 res[15]; /* Reserved locations */
94 u32 testr; /* Test Register */
95 u32 versionr; /* Version Register */
96 u32 idr; /* ID Register */
97 u32 unimpl[192]; /* Unimplemented */
98 u32 dmadr[256]; /* FIFO Locations in DMA Mode */
102 SCR_SCONTROL_DET_ENABLE = 0x00000001,
103 SCR_SSTATUS_DET_PRESENT = 0x00000001,
104 SCR_SERROR_DIAG_X = 0x04000000,
105 /* DWC SATA Register Operations */
106 SATA_DWC_TXFIFO_DEPTH = 0x01FF,
107 SATA_DWC_RXFIFO_DEPTH = 0x01FF,
108 SATA_DWC_DMACR_TMOD_TXCHEN = 0x00000004,
109 SATA_DWC_DMACR_TXCHEN = (0x00000001 | SATA_DWC_DMACR_TMOD_TXCHEN),
110 SATA_DWC_DMACR_RXCHEN = (0x00000002 | SATA_DWC_DMACR_TMOD_TXCHEN),
111 SATA_DWC_DMACR_TXRXCH_CLEAR = SATA_DWC_DMACR_TMOD_TXCHEN,
112 SATA_DWC_INTPR_DMAT = 0x00000001,
113 SATA_DWC_INTPR_NEWFP = 0x00000002,
114 SATA_DWC_INTPR_PMABRT = 0x00000004,
115 SATA_DWC_INTPR_ERR = 0x00000008,
116 SATA_DWC_INTPR_NEWBIST = 0x00000010,
117 SATA_DWC_INTPR_IPF = 0x10000000,
118 SATA_DWC_INTMR_DMATM = 0x00000001,
119 SATA_DWC_INTMR_NEWFPM = 0x00000002,
120 SATA_DWC_INTMR_PMABRTM = 0x00000004,
121 SATA_DWC_INTMR_ERRM = 0x00000008,
122 SATA_DWC_INTMR_NEWBISTM = 0x00000010,
123 SATA_DWC_LLCR_SCRAMEN = 0x00000001,
124 SATA_DWC_LLCR_DESCRAMEN = 0x00000002,
125 SATA_DWC_LLCR_RPDEN = 0x00000004,
126 /* This is all error bits, zero's are reserved fields. */
127 SATA_DWC_SERROR_ERR_BITS = 0x0FFF0F03
130 #define SATA_DWC_SCR0_SPD_GET(v) (((v) >> 4) & 0x0000000F)
131 #define SATA_DWC_DMACR_TX_CLEAR(v) (((v) & ~SATA_DWC_DMACR_TXCHEN) |\
132 SATA_DWC_DMACR_TMOD_TXCHEN)
133 #define SATA_DWC_DMACR_RX_CLEAR(v) (((v) & ~SATA_DWC_DMACR_RXCHEN) |\
134 SATA_DWC_DMACR_TMOD_TXCHEN)
135 #define SATA_DWC_DBTSR_MWR(size) (((size)/4) & SATA_DWC_TXFIFO_DEPTH)
136 #define SATA_DWC_DBTSR_MRD(size) ((((size)/4) & SATA_DWC_RXFIFO_DEPTH)\
138 struct sata_dwc_device {
139 struct device *dev; /* generic device struct */
140 struct ata_probe_ent *pe; /* ptr to probe-ent */
141 struct ata_host *host;
142 struct sata_dwc_regs __iomem *sata_dwc_regs; /* DW SATA specific */
147 #ifdef CONFIG_SATA_DWC_OLD_DMA
148 struct dw_dma_chip *dma;
152 #define SATA_DWC_QCMD_MAX 32
154 struct sata_dwc_device_port {
155 struct sata_dwc_device *hsdev;
156 int cmd_issued[SATA_DWC_QCMD_MAX];
157 int dma_pending[SATA_DWC_QCMD_MAX];
160 struct dma_chan *chan;
161 struct dma_async_tx_descriptor *desc[SATA_DWC_QCMD_MAX];
162 u32 dma_interrupt_count;
166 * Commonly used DWC SATA driver macros
168 #define HSDEV_FROM_HOST(host) ((struct sata_dwc_device *)(host)->private_data)
169 #define HSDEV_FROM_AP(ap) ((struct sata_dwc_device *)(ap)->host->private_data)
170 #define HSDEVP_FROM_AP(ap) ((struct sata_dwc_device_port *)(ap)->private_data)
171 #define HSDEV_FROM_QC(qc) ((struct sata_dwc_device *)(qc)->ap->host->private_data)
172 #define HSDEV_FROM_HSDEVP(p) ((struct sata_dwc_device *)(p)->hsdev)
175 SATA_DWC_CMD_ISSUED_NOT = 0,
176 SATA_DWC_CMD_ISSUED_PEND = 1,
177 SATA_DWC_CMD_ISSUED_EXEC = 2,
178 SATA_DWC_CMD_ISSUED_NODATA = 3,
180 SATA_DWC_DMA_PENDING_NONE = 0,
181 SATA_DWC_DMA_PENDING_TX = 1,
182 SATA_DWC_DMA_PENDING_RX = 2,
188 static void sata_dwc_bmdma_start_by_tag(struct ata_queued_cmd *qc, u8 tag);
189 static int sata_dwc_qc_complete(struct ata_port *ap, struct ata_queued_cmd *qc,
191 static void sata_dwc_dma_xfer_complete(struct ata_port *ap, u32 check_status);
192 static void sata_dwc_port_stop(struct ata_port *ap);
193 static void sata_dwc_clear_dmacr(struct sata_dwc_device_port *hsdevp, u8 tag);
195 #ifdef CONFIG_SATA_DWC_OLD_DMA
197 #include <linux/platform_data/dma-dw.h>
198 #include <linux/dma/dw.h>
200 static struct dw_dma_slave sata_dwc_dma_dws = {
207 static bool sata_dwc_dma_filter(struct dma_chan *chan, void *param)
209 struct dw_dma_slave *dws = &sata_dwc_dma_dws;
211 if (dws->dma_dev != chan->device->dev)
218 static int sata_dwc_dma_get_channel_old(struct sata_dwc_device_port *hsdevp)
220 struct sata_dwc_device *hsdev = hsdevp->hsdev;
221 struct dw_dma_slave *dws = &sata_dwc_dma_dws;
224 dws->dma_dev = hsdev->dev;
227 dma_cap_set(DMA_SLAVE, mask);
229 /* Acquire DMA channel */
230 hsdevp->chan = dma_request_channel(mask, sata_dwc_dma_filter, hsdevp);
232 dev_err(hsdev->dev, "%s: dma channel unavailable\n",
240 static int sata_dwc_dma_init_old(struct platform_device *pdev,
241 struct sata_dwc_device *hsdev)
243 struct device_node *np = pdev->dev.of_node;
244 struct resource *res;
246 hsdev->dma = devm_kzalloc(&pdev->dev, sizeof(*hsdev->dma), GFP_KERNEL);
250 hsdev->dma->dev = &pdev->dev;
252 /* Get SATA DMA interrupt number */
253 hsdev->dma->irq = irq_of_parse_and_map(np, 1);
254 if (hsdev->dma->irq == NO_IRQ) {
255 dev_err(&pdev->dev, "no SATA DMA irq\n");
259 /* Get physical SATA DMA register base address */
260 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
261 hsdev->dma->regs = devm_ioremap_resource(&pdev->dev, res);
262 if (IS_ERR(hsdev->dma->regs))
263 return PTR_ERR(hsdev->dma->regs);
265 /* Initialize AHB DMAC */
266 return dw_dma_probe(hsdev->dma);
269 static void sata_dwc_dma_exit_old(struct sata_dwc_device *hsdev)
274 dw_dma_remove(hsdev->dma);
279 static const char *get_prot_descript(u8 protocol)
282 case ATA_PROT_NODATA:
283 return "ATA no data";
290 case ATA_PROT_NCQ_NODATA:
291 return "ATA NCQ no data";
292 case ATAPI_PROT_NODATA:
293 return "ATAPI no data";
303 static const char *get_dma_dir_descript(int dma_dir)
305 switch ((enum dma_data_direction)dma_dir) {
306 case DMA_BIDIRECTIONAL:
307 return "bidirectional";
310 case DMA_FROM_DEVICE:
311 return "from device";
317 static void sata_dwc_tf_dump(struct ata_port *ap, struct ata_taskfile *tf)
320 "taskfile cmd: 0x%02x protocol: %s flags: 0x%lx device: %x\n",
321 tf->command, get_prot_descript(tf->protocol), tf->flags,
324 "feature: 0x%02x nsect: 0x%x lbal: 0x%x lbam: 0x%x lbah: 0x%x\n",
325 tf->feature, tf->nsect, tf->lbal, tf->lbam, tf->lbah);
327 "hob_feature: 0x%02x hob_nsect: 0x%x hob_lbal: 0x%x hob_lbam: 0x%x hob_lbah: 0x%x\n",
328 tf->hob_feature, tf->hob_nsect, tf->hob_lbal, tf->hob_lbam,
332 static void dma_dwc_xfer_done(void *hsdev_instance)
335 struct sata_dwc_device *hsdev = hsdev_instance;
336 struct ata_host *host = (struct ata_host *)hsdev->host;
338 struct sata_dwc_device_port *hsdevp;
340 unsigned int port = 0;
342 spin_lock_irqsave(&host->lock, flags);
343 ap = host->ports[port];
344 hsdevp = HSDEVP_FROM_AP(ap);
345 tag = ap->link.active_tag;
348 * Each DMA command produces 2 interrupts. Only
349 * complete the command after both interrupts have been
350 * seen. (See sata_dwc_isr())
352 hsdevp->dma_interrupt_count++;
353 sata_dwc_clear_dmacr(hsdevp, tag);
355 if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_NONE) {
356 dev_err(ap->dev, "DMA not pending tag=0x%02x pending=%d\n",
357 tag, hsdevp->dma_pending[tag]);
360 if ((hsdevp->dma_interrupt_count % 2) == 0)
361 sata_dwc_dma_xfer_complete(ap, 1);
363 spin_unlock_irqrestore(&host->lock, flags);
366 static struct dma_async_tx_descriptor *dma_dwc_xfer_setup(struct ata_queued_cmd *qc)
368 struct ata_port *ap = qc->ap;
369 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
370 struct sata_dwc_device *hsdev = HSDEV_FROM_AP(ap);
371 struct dma_slave_config sconf;
372 struct dma_async_tx_descriptor *desc;
374 if (qc->dma_dir == DMA_DEV_TO_MEM) {
375 sconf.src_addr = hsdev->dmadr;
376 sconf.device_fc = false;
377 } else { /* DMA_MEM_TO_DEV */
378 sconf.dst_addr = hsdev->dmadr;
379 sconf.device_fc = false;
382 sconf.direction = qc->dma_dir;
383 sconf.src_maxburst = AHB_DMA_BRST_DFLT / 4; /* in items */
384 sconf.dst_maxburst = AHB_DMA_BRST_DFLT / 4; /* in items */
385 sconf.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
386 sconf.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES;
388 dmaengine_slave_config(hsdevp->chan, &sconf);
390 /* Convert SG list to linked list of items (LLIs) for AHB DMA */
391 desc = dmaengine_prep_slave_sg(hsdevp->chan, qc->sg, qc->n_elem,
393 DMA_PREP_INTERRUPT | DMA_CTRL_ACK);
398 desc->callback = dma_dwc_xfer_done;
399 desc->callback_param = hsdev;
401 dev_dbg(hsdev->dev, "%s sg: 0x%p, count: %d addr: %pa\n", __func__,
402 qc->sg, qc->n_elem, &hsdev->dmadr);
407 static int sata_dwc_scr_read(struct ata_link *link, unsigned int scr, u32 *val)
409 if (scr > SCR_NOTIFICATION) {
410 dev_err(link->ap->dev, "%s: Incorrect SCR offset 0x%02x\n",
415 *val = sata_dwc_readl(link->ap->ioaddr.scr_addr + (scr * 4));
416 dev_dbg(link->ap->dev, "%s: id=%d reg=%d val=0x%08x\n", __func__,
417 link->ap->print_id, scr, *val);
422 static int sata_dwc_scr_write(struct ata_link *link, unsigned int scr, u32 val)
424 dev_dbg(link->ap->dev, "%s: id=%d reg=%d val=0x%08x\n", __func__,
425 link->ap->print_id, scr, val);
426 if (scr > SCR_NOTIFICATION) {
427 dev_err(link->ap->dev, "%s: Incorrect SCR offset 0x%02x\n",
431 sata_dwc_writel(link->ap->ioaddr.scr_addr + (scr * 4), val);
436 static void clear_serror(struct ata_port *ap)
439 sata_dwc_scr_read(&ap->link, SCR_ERROR, &val);
440 sata_dwc_scr_write(&ap->link, SCR_ERROR, val);
443 static void clear_interrupt_bit(struct sata_dwc_device *hsdev, u32 bit)
445 sata_dwc_writel(&hsdev->sata_dwc_regs->intpr,
446 sata_dwc_readl(&hsdev->sata_dwc_regs->intpr));
449 static u32 qcmd_tag_to_mask(u8 tag)
451 return 0x00000001 << (tag & 0x1f);
455 static void sata_dwc_error_intr(struct ata_port *ap,
456 struct sata_dwc_device *hsdev, uint intpr)
458 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
459 struct ata_eh_info *ehi = &ap->link.eh_info;
460 unsigned int err_mask = 0, action = 0;
461 struct ata_queued_cmd *qc;
465 ata_ehi_clear_desc(ehi);
467 sata_dwc_scr_read(&ap->link, SCR_ERROR, &serror);
468 status = ap->ops->sff_check_status(ap);
470 tag = ap->link.active_tag;
473 "%s SCR_ERROR=0x%08x intpr=0x%08x status=0x%08x dma_intp=%d pending=%d issued=%d",
474 __func__, serror, intpr, status, hsdevp->dma_interrupt_count,
475 hsdevp->dma_pending[tag], hsdevp->cmd_issued[tag]);
477 /* Clear error register and interrupt bit */
479 clear_interrupt_bit(hsdev, SATA_DWC_INTPR_ERR);
481 /* This is the only error happening now. TODO check for exact error */
483 err_mask |= AC_ERR_HOST_BUS;
484 action |= ATA_EH_RESET;
486 /* Pass this on to EH */
487 ehi->serror |= serror;
488 ehi->action |= action;
490 qc = ata_qc_from_tag(ap, tag);
492 qc->err_mask |= err_mask;
494 ehi->err_mask |= err_mask;
500 * Function : sata_dwc_isr
501 * arguments : irq, void *dev_instance, struct pt_regs *regs
502 * Return value : irqreturn_t - status of IRQ
503 * This Interrupt handler called via port ops registered function.
504 * .irq_handler = sata_dwc_isr
506 static irqreturn_t sata_dwc_isr(int irq, void *dev_instance)
508 struct ata_host *host = (struct ata_host *)dev_instance;
509 struct sata_dwc_device *hsdev = HSDEV_FROM_HOST(host);
511 struct ata_queued_cmd *qc;
514 int handled, num_processed, port = 0;
515 uint intpr, sactive, sactive2, tag_mask;
516 struct sata_dwc_device_port *hsdevp;
517 hsdev->sactive_issued = 0;
519 spin_lock_irqsave(&host->lock, flags);
521 /* Read the interrupt register */
522 intpr = sata_dwc_readl(&hsdev->sata_dwc_regs->intpr);
524 ap = host->ports[port];
525 hsdevp = HSDEVP_FROM_AP(ap);
527 dev_dbg(ap->dev, "%s intpr=0x%08x active_tag=%d\n", __func__, intpr,
528 ap->link.active_tag);
530 /* Check for error interrupt */
531 if (intpr & SATA_DWC_INTPR_ERR) {
532 sata_dwc_error_intr(ap, hsdev, intpr);
537 /* Check for DMA SETUP FIS (FP DMA) interrupt */
538 if (intpr & SATA_DWC_INTPR_NEWFP) {
539 clear_interrupt_bit(hsdev, SATA_DWC_INTPR_NEWFP);
541 tag = (u8)(sata_dwc_readl(&hsdev->sata_dwc_regs->fptagr));
542 dev_dbg(ap->dev, "%s: NEWFP tag=%d\n", __func__, tag);
543 if (hsdevp->cmd_issued[tag] != SATA_DWC_CMD_ISSUED_PEND)
544 dev_warn(ap->dev, "CMD tag=%d not pending?\n", tag);
546 hsdev->sactive_issued |= qcmd_tag_to_mask(tag);
548 qc = ata_qc_from_tag(ap, tag);
550 * Start FP DMA for NCQ command. At this point the tag is the
551 * active tag. It is the tag that matches the command about to
554 qc->ap->link.active_tag = tag;
555 sata_dwc_bmdma_start_by_tag(qc, tag);
560 sata_dwc_scr_read(&ap->link, SCR_ACTIVE, &sactive);
561 tag_mask = (hsdev->sactive_issued | sactive) ^ sactive;
563 /* If no sactive issued and tag_mask is zero then this is not NCQ */
564 if (hsdev->sactive_issued == 0 && tag_mask == 0) {
565 if (ap->link.active_tag == ATA_TAG_POISON)
568 tag = ap->link.active_tag;
569 qc = ata_qc_from_tag(ap, tag);
571 /* DEV interrupt w/ no active qc? */
572 if (unlikely(!qc || (qc->tf.flags & ATA_TFLAG_POLLING))) {
574 "%s interrupt with no active qc qc=%p\n",
576 ap->ops->sff_check_status(ap);
580 status = ap->ops->sff_check_status(ap);
582 qc->ap->link.active_tag = tag;
583 hsdevp->cmd_issued[tag] = SATA_DWC_CMD_ISSUED_NOT;
585 if (status & ATA_ERR) {
586 dev_dbg(ap->dev, "interrupt ATA_ERR (0x%x)\n", status);
587 sata_dwc_qc_complete(ap, qc, 1);
592 dev_dbg(ap->dev, "%s non-NCQ cmd interrupt, protocol: %s\n",
593 __func__, get_prot_descript(qc->tf.protocol));
595 if (ata_is_dma(qc->tf.protocol)) {
597 * Each DMA transaction produces 2 interrupts. The DMAC
598 * transfer complete interrupt and the SATA controller
599 * operation done interrupt. The command should be
600 * completed only after both interrupts are seen.
602 hsdevp->dma_interrupt_count++;
603 if (hsdevp->dma_pending[tag] == \
604 SATA_DWC_DMA_PENDING_NONE) {
606 "%s: DMA not pending intpr=0x%08x status=0x%08x pending=%d\n",
607 __func__, intpr, status,
608 hsdevp->dma_pending[tag]);
611 if ((hsdevp->dma_interrupt_count % 2) == 0)
612 sata_dwc_dma_xfer_complete(ap, 1);
613 } else if (ata_is_pio(qc->tf.protocol)) {
614 ata_sff_hsm_move(ap, qc, status, 0);
618 if (unlikely(sata_dwc_qc_complete(ap, qc, 1)))
627 * This is a NCQ command. At this point we need to figure out for which
628 * tags we have gotten a completion interrupt. One interrupt may serve
629 * as completion for more than one operation when commands are queued
630 * (NCQ). We need to process each completed command.
633 /* process completed commands */
634 sata_dwc_scr_read(&ap->link, SCR_ACTIVE, &sactive);
635 tag_mask = (hsdev->sactive_issued | sactive) ^ sactive;
637 if (sactive != 0 || hsdev->sactive_issued > 1 || tag_mask > 1) {
639 "%s NCQ:sactive=0x%08x sactive_issued=0x%08x tag_mask=0x%08x\n",
640 __func__, sactive, hsdev->sactive_issued, tag_mask);
643 if ((tag_mask | hsdev->sactive_issued) != hsdev->sactive_issued) {
645 "Bad tag mask? sactive=0x%08x sactive_issued=0x%08x tag_mask=0x%08x\n",
646 sactive, hsdev->sactive_issued, tag_mask);
649 /* read just to clear ... not bad if currently still busy */
650 status = ap->ops->sff_check_status(ap);
651 dev_dbg(ap->dev, "%s ATA status register=0x%x\n", __func__, status);
657 while (!(tag_mask & 0x00000001)) {
662 tag_mask &= (~0x00000001);
663 qc = ata_qc_from_tag(ap, tag);
665 /* To be picked up by completion functions */
666 qc->ap->link.active_tag = tag;
667 hsdevp->cmd_issued[tag] = SATA_DWC_CMD_ISSUED_NOT;
669 /* Let libata/scsi layers handle error */
670 if (status & ATA_ERR) {
671 dev_dbg(ap->dev, "%s ATA_ERR (0x%x)\n", __func__,
673 sata_dwc_qc_complete(ap, qc, 1);
678 /* Process completed command */
679 dev_dbg(ap->dev, "%s NCQ command, protocol: %s\n", __func__,
680 get_prot_descript(qc->tf.protocol));
681 if (ata_is_dma(qc->tf.protocol)) {
682 hsdevp->dma_interrupt_count++;
683 if (hsdevp->dma_pending[tag] == \
684 SATA_DWC_DMA_PENDING_NONE)
685 dev_warn(ap->dev, "%s: DMA not pending?\n",
687 if ((hsdevp->dma_interrupt_count % 2) == 0)
688 sata_dwc_dma_xfer_complete(ap, 1);
690 if (unlikely(sata_dwc_qc_complete(ap, qc, 1)))
696 ap->stats.idle_irq++;
697 dev_warn(ap->dev, "STILL BUSY IRQ ata%d: irq trap\n",
699 } /* while tag_mask */
702 * Check to see if any commands completed while we were processing our
703 * initial set of completed commands (read status clears interrupts,
704 * so we might miss a completed command interrupt if one came in while
705 * we were processing --we read status as part of processing a completed
708 sata_dwc_scr_read(&ap->link, SCR_ACTIVE, &sactive2);
709 if (sactive2 != sactive) {
711 "More completed - sactive=0x%x sactive2=0x%x\n",
717 spin_unlock_irqrestore(&host->lock, flags);
718 return IRQ_RETVAL(handled);
721 static void sata_dwc_clear_dmacr(struct sata_dwc_device_port *hsdevp, u8 tag)
723 struct sata_dwc_device *hsdev = HSDEV_FROM_HSDEVP(hsdevp);
724 u32 dmacr = sata_dwc_readl(&hsdev->sata_dwc_regs->dmacr);
726 if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_RX) {
727 dmacr = SATA_DWC_DMACR_RX_CLEAR(dmacr);
728 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr, dmacr);
729 } else if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_TX) {
730 dmacr = SATA_DWC_DMACR_TX_CLEAR(dmacr);
731 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr, dmacr);
734 * This should not happen, it indicates the driver is out of
735 * sync. If it does happen, clear dmacr anyway.
738 "%s DMA protocol RX and TX DMA not pending tag=0x%02x pending=%d dmacr: 0x%08x\n",
739 __func__, tag, hsdevp->dma_pending[tag], dmacr);
740 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr,
741 SATA_DWC_DMACR_TXRXCH_CLEAR);
745 static void sata_dwc_dma_xfer_complete(struct ata_port *ap, u32 check_status)
747 struct ata_queued_cmd *qc;
748 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
749 struct sata_dwc_device *hsdev = HSDEV_FROM_AP(ap);
752 tag = ap->link.active_tag;
753 qc = ata_qc_from_tag(ap, tag);
755 dev_err(ap->dev, "failed to get qc");
762 "%s tag=%u cmd=0x%02x dma dir=%s proto=%s dmacr=0x%08x\n",
763 __func__, qc->tag, qc->tf.command,
764 get_dma_dir_descript(qc->dma_dir),
765 get_prot_descript(qc->tf.protocol),
766 sata_dwc_readl(&hsdev->sata_dwc_regs->dmacr));
770 if (ata_is_dma(qc->tf.protocol)) {
771 if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_NONE) {
773 "%s DMA protocol RX and TX DMA not pending dmacr: 0x%08x\n",
775 sata_dwc_readl(&hsdev->sata_dwc_regs->dmacr));
778 hsdevp->dma_pending[tag] = SATA_DWC_DMA_PENDING_NONE;
779 sata_dwc_qc_complete(ap, qc, check_status);
780 ap->link.active_tag = ATA_TAG_POISON;
782 sata_dwc_qc_complete(ap, qc, check_status);
786 static int sata_dwc_qc_complete(struct ata_port *ap, struct ata_queued_cmd *qc,
792 struct sata_dwc_device *hsdev = HSDEV_FROM_AP(ap);
793 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
794 hsdev->sactive_queued = 0;
795 dev_dbg(ap->dev, "%s checkstatus? %x\n", __func__, check_status);
797 if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_TX)
798 dev_err(ap->dev, "TX DMA PENDING\n");
799 else if (hsdevp->dma_pending[tag] == SATA_DWC_DMA_PENDING_RX)
800 dev_err(ap->dev, "RX DMA PENDING\n");
802 "QC complete cmd=0x%02x status=0x%02x ata%u: protocol=%d\n",
803 qc->tf.command, status, ap->print_id, qc->tf.protocol);
805 /* clear active bit */
806 mask = (~(qcmd_tag_to_mask(tag)));
807 hsdev->sactive_queued = hsdev->sactive_queued & mask;
808 hsdev->sactive_issued = hsdev->sactive_issued & mask;
813 static void sata_dwc_enable_interrupts(struct sata_dwc_device *hsdev)
815 /* Enable selective interrupts by setting the interrupt maskregister*/
816 sata_dwc_writel(&hsdev->sata_dwc_regs->intmr,
817 SATA_DWC_INTMR_ERRM |
818 SATA_DWC_INTMR_NEWFPM |
819 SATA_DWC_INTMR_PMABRTM |
820 SATA_DWC_INTMR_DMATM);
822 * Unmask the error bits that should trigger an error interrupt by
823 * setting the error mask register.
825 sata_dwc_writel(&hsdev->sata_dwc_regs->errmr, SATA_DWC_SERROR_ERR_BITS);
827 dev_dbg(hsdev->dev, "%s: INTMR = 0x%08x, ERRMR = 0x%08x\n",
828 __func__, sata_dwc_readl(&hsdev->sata_dwc_regs->intmr),
829 sata_dwc_readl(&hsdev->sata_dwc_regs->errmr));
832 static void sata_dwc_setup_port(struct ata_ioports *port, void __iomem *base)
834 port->cmd_addr = base + 0x00;
835 port->data_addr = base + 0x00;
837 port->error_addr = base + 0x04;
838 port->feature_addr = base + 0x04;
840 port->nsect_addr = base + 0x08;
842 port->lbal_addr = base + 0x0c;
843 port->lbam_addr = base + 0x10;
844 port->lbah_addr = base + 0x14;
846 port->device_addr = base + 0x18;
847 port->command_addr = base + 0x1c;
848 port->status_addr = base + 0x1c;
850 port->altstatus_addr = base + 0x20;
851 port->ctl_addr = base + 0x20;
854 static int sata_dwc_dma_get_channel(struct sata_dwc_device_port *hsdevp)
856 struct sata_dwc_device *hsdev = hsdevp->hsdev;
857 struct device *dev = hsdev->dev;
859 #ifdef CONFIG_SATA_DWC_OLD_DMA
860 if (!of_find_property(dev->of_node, "dmas", NULL))
861 return sata_dwc_dma_get_channel_old(hsdevp);
864 hsdevp->chan = dma_request_chan(dev, "sata-dma");
865 if (IS_ERR(hsdevp->chan)) {
866 dev_err(dev, "failed to allocate dma channel: %ld\n",
867 PTR_ERR(hsdevp->chan));
868 return PTR_ERR(hsdevp->chan);
875 * Function : sata_dwc_port_start
876 * arguments : struct ata_ioports *port
877 * Return value : returns 0 if success, error code otherwise
878 * This function allocates the scatter gather LLI table for AHB DMA
880 static int sata_dwc_port_start(struct ata_port *ap)
883 struct sata_dwc_device *hsdev;
884 struct sata_dwc_device_port *hsdevp = NULL;
888 hsdev = HSDEV_FROM_AP(ap);
890 dev_dbg(ap->dev, "%s: port_no=%d\n", __func__, ap->port_no);
892 hsdev->host = ap->host;
893 pdev = ap->host->dev;
895 dev_err(ap->dev, "%s: no ap->host->dev\n", __func__);
900 /* Allocate Port Struct */
901 hsdevp = kzalloc(sizeof(*hsdevp), GFP_KERNEL);
903 dev_err(ap->dev, "%s: kmalloc failed for hsdevp\n", __func__);
907 hsdevp->hsdev = hsdev;
909 err = sata_dwc_dma_get_channel(hsdevp);
913 err = phy_power_on(hsdev->phy);
917 for (i = 0; i < SATA_DWC_QCMD_MAX; i++)
918 hsdevp->cmd_issued[i] = SATA_DWC_CMD_ISSUED_NOT;
920 ap->bmdma_prd = NULL; /* set these so libata doesn't use them */
921 ap->bmdma_prd_dma = 0;
923 if (ap->port_no == 0) {
924 dev_dbg(ap->dev, "%s: clearing TXCHEN, RXCHEN in DMAC\n",
926 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr,
927 SATA_DWC_DMACR_TXRXCH_CLEAR);
929 dev_dbg(ap->dev, "%s: setting burst size in DBTSR\n",
931 sata_dwc_writel(&hsdev->sata_dwc_regs->dbtsr,
932 (SATA_DWC_DBTSR_MWR(AHB_DMA_BRST_DFLT) |
933 SATA_DWC_DBTSR_MRD(AHB_DMA_BRST_DFLT)));
936 /* Clear any error bits before libata starts issuing commands */
938 ap->private_data = hsdevp;
939 dev_dbg(ap->dev, "%s: done\n", __func__);
945 dev_dbg(ap->dev, "%s: fail. ap->id = %d\n", __func__, ap->print_id);
949 static void sata_dwc_port_stop(struct ata_port *ap)
951 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
952 struct sata_dwc_device *hsdev = HSDEV_FROM_AP(ap);
954 dev_dbg(ap->dev, "%s: ap->id = %d\n", __func__, ap->print_id);
956 dmaengine_terminate_sync(hsdevp->chan);
957 dma_release_channel(hsdevp->chan);
958 phy_power_off(hsdev->phy);
961 ap->private_data = NULL;
965 * Function : sata_dwc_exec_command_by_tag
966 * arguments : ata_port *ap, ata_taskfile *tf, u8 tag, u32 cmd_issued
967 * Return value : None
968 * This function keeps track of individual command tag ids and calls
969 * ata_exec_command in libata
971 static void sata_dwc_exec_command_by_tag(struct ata_port *ap,
972 struct ata_taskfile *tf,
973 u8 tag, u32 cmd_issued)
975 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
977 dev_dbg(ap->dev, "%s cmd(0x%02x): %s tag=%d\n", __func__, tf->command,
978 ata_get_cmd_descript(tf->command), tag);
980 hsdevp->cmd_issued[tag] = cmd_issued;
983 * Clear SError before executing a new command.
984 * sata_dwc_scr_write and read can not be used here. Clearing the PM
985 * managed SError register for the disk needs to be done before the
986 * task file is loaded.
989 ata_sff_exec_command(ap, tf);
992 static void sata_dwc_bmdma_setup_by_tag(struct ata_queued_cmd *qc, u8 tag)
994 sata_dwc_exec_command_by_tag(qc->ap, &qc->tf, tag,
995 SATA_DWC_CMD_ISSUED_PEND);
998 static void sata_dwc_bmdma_setup(struct ata_queued_cmd *qc)
1002 if (ata_is_ncq(qc->tf.protocol)) {
1003 dev_dbg(qc->ap->dev, "%s: ap->link.sactive=0x%08x tag=%d\n",
1004 __func__, qc->ap->link.sactive, tag);
1008 sata_dwc_bmdma_setup_by_tag(qc, tag);
1011 static void sata_dwc_bmdma_start_by_tag(struct ata_queued_cmd *qc, u8 tag)
1015 struct sata_dwc_device *hsdev = HSDEV_FROM_QC(qc);
1016 struct ata_port *ap = qc->ap;
1017 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
1018 struct dma_async_tx_descriptor *desc = hsdevp->desc[tag];
1019 int dir = qc->dma_dir;
1021 if (hsdevp->cmd_issued[tag] != SATA_DWC_CMD_ISSUED_NOT) {
1023 if (dir == DMA_TO_DEVICE)
1024 hsdevp->dma_pending[tag] = SATA_DWC_DMA_PENDING_TX;
1026 hsdevp->dma_pending[tag] = SATA_DWC_DMA_PENDING_RX;
1029 "%s: Command not pending cmd_issued=%d (tag=%d) DMA NOT started\n",
1030 __func__, hsdevp->cmd_issued[tag], tag);
1035 "%s qc=%p tag: %x cmd: 0x%02x dma_dir: %s start_dma? %x\n",
1036 __func__, qc, tag, qc->tf.command,
1037 get_dma_dir_descript(qc->dma_dir), start_dma);
1038 sata_dwc_tf_dump(ap, &qc->tf);
1041 sata_dwc_scr_read(&ap->link, SCR_ERROR, ®);
1042 if (reg & SATA_DWC_SERROR_ERR_BITS) {
1043 dev_err(ap->dev, "%s: ****** SError=0x%08x ******\n",
1047 if (dir == DMA_TO_DEVICE)
1048 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr,
1049 SATA_DWC_DMACR_TXCHEN);
1051 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr,
1052 SATA_DWC_DMACR_RXCHEN);
1054 /* Enable AHB DMA transfer on the specified channel */
1055 dmaengine_submit(desc);
1056 dma_async_issue_pending(hsdevp->chan);
1060 static void sata_dwc_bmdma_start(struct ata_queued_cmd *qc)
1064 if (ata_is_ncq(qc->tf.protocol)) {
1065 dev_dbg(qc->ap->dev, "%s: ap->link.sactive=0x%08x tag=%d\n",
1066 __func__, qc->ap->link.sactive, tag);
1070 dev_dbg(qc->ap->dev, "%s\n", __func__);
1071 sata_dwc_bmdma_start_by_tag(qc, tag);
1074 static unsigned int sata_dwc_qc_issue(struct ata_queued_cmd *qc)
1078 struct ata_port *ap = qc->ap;
1079 struct sata_dwc_device_port *hsdevp = HSDEVP_FROM_AP(ap);
1082 if (qc->tag > 0 || ap->link.sactive > 1)
1084 "%s ap id=%d cmd(0x%02x)=%s qc tag=%d prot=%s ap active_tag=0x%08x ap sactive=0x%08x\n",
1085 __func__, ap->print_id, qc->tf.command,
1086 ata_get_cmd_descript(qc->tf.command),
1087 qc->tag, get_prot_descript(qc->tf.protocol),
1088 ap->link.active_tag, ap->link.sactive);
1091 if (!ata_is_ncq(qc->tf.protocol))
1094 if (ata_is_dma(qc->tf.protocol)) {
1095 hsdevp->desc[tag] = dma_dwc_xfer_setup(qc);
1096 if (!hsdevp->desc[tag])
1097 return AC_ERR_SYSTEM;
1099 hsdevp->desc[tag] = NULL;
1102 if (ata_is_ncq(qc->tf.protocol)) {
1103 sata_dwc_scr_read(&ap->link, SCR_ACTIVE, &sactive);
1104 sactive |= (0x00000001 << tag);
1105 sata_dwc_scr_write(&ap->link, SCR_ACTIVE, sactive);
1107 dev_dbg(qc->ap->dev,
1108 "%s: tag=%d ap->link.sactive = 0x%08x sactive=0x%08x\n",
1109 __func__, tag, qc->ap->link.sactive, sactive);
1111 ap->ops->sff_tf_load(ap, &qc->tf);
1112 sata_dwc_exec_command_by_tag(ap, &qc->tf, tag,
1113 SATA_DWC_CMD_ISSUED_PEND);
1115 return ata_bmdma_qc_issue(qc);
1120 static void sata_dwc_error_handler(struct ata_port *ap)
1122 ata_sff_error_handler(ap);
1125 static int sata_dwc_hardreset(struct ata_link *link, unsigned int *class,
1126 unsigned long deadline)
1128 struct sata_dwc_device *hsdev = HSDEV_FROM_AP(link->ap);
1131 ret = sata_sff_hardreset(link, class, deadline);
1133 sata_dwc_enable_interrupts(hsdev);
1135 /* Reconfigure the DMA control register */
1136 sata_dwc_writel(&hsdev->sata_dwc_regs->dmacr,
1137 SATA_DWC_DMACR_TXRXCH_CLEAR);
1139 /* Reconfigure the DMA Burst Transaction Size register */
1140 sata_dwc_writel(&hsdev->sata_dwc_regs->dbtsr,
1141 SATA_DWC_DBTSR_MWR(AHB_DMA_BRST_DFLT) |
1142 SATA_DWC_DBTSR_MRD(AHB_DMA_BRST_DFLT));
1147 static void sata_dwc_dev_select(struct ata_port *ap, unsigned int device)
1149 /* SATA DWC is master only */
1153 * scsi mid-layer and libata interface structures
1155 static struct scsi_host_template sata_dwc_sht = {
1156 ATA_NCQ_SHT(DRV_NAME),
1158 * test-only: Currently this driver doesn't handle NCQ
1159 * correctly. We enable NCQ but set the queue depth to a
1160 * max of 1. This will get fixed in in a future release.
1162 .sg_tablesize = LIBATA_MAX_PRD,
1163 /* .can_queue = ATA_MAX_QUEUE, */
1165 * Make sure a LLI block is not created that will span 8K max FIS
1166 * boundary. If the block spans such a FIS boundary, there is a chance
1167 * that a DMA burst will cross that boundary -- this results in an
1168 * error in the host controller.
1170 .dma_boundary = 0x1fff /* ATA_DMA_BOUNDARY */,
1173 static struct ata_port_operations sata_dwc_ops = {
1174 .inherits = &ata_sff_port_ops,
1176 .error_handler = sata_dwc_error_handler,
1177 .hardreset = sata_dwc_hardreset,
1179 .qc_issue = sata_dwc_qc_issue,
1181 .scr_read = sata_dwc_scr_read,
1182 .scr_write = sata_dwc_scr_write,
1184 .port_start = sata_dwc_port_start,
1185 .port_stop = sata_dwc_port_stop,
1187 .sff_dev_select = sata_dwc_dev_select,
1189 .bmdma_setup = sata_dwc_bmdma_setup,
1190 .bmdma_start = sata_dwc_bmdma_start,
1193 static const struct ata_port_info sata_dwc_port_info[] = {
1195 .flags = ATA_FLAG_SATA | ATA_FLAG_NCQ,
1196 .pio_mask = ATA_PIO4,
1197 .udma_mask = ATA_UDMA6,
1198 .port_ops = &sata_dwc_ops,
1202 static int sata_dwc_probe(struct platform_device *ofdev)
1204 struct sata_dwc_device *hsdev;
1206 char *ver = (char *)&versionr;
1210 struct ata_host *host;
1211 struct ata_port_info pi = sata_dwc_port_info[0];
1212 const struct ata_port_info *ppi[] = { &pi, NULL };
1213 struct device_node *np = ofdev->dev.of_node;
1214 struct resource *res;
1216 /* Allocate DWC SATA device */
1217 host = ata_host_alloc_pinfo(&ofdev->dev, ppi, SATA_DWC_MAX_PORTS);
1218 hsdev = devm_kzalloc(&ofdev->dev, sizeof(*hsdev), GFP_KERNEL);
1219 if (!host || !hsdev)
1222 host->private_data = hsdev;
1224 /* Ioremap SATA registers */
1225 res = platform_get_resource(ofdev, IORESOURCE_MEM, 0);
1226 base = devm_ioremap_resource(&ofdev->dev, res);
1228 return PTR_ERR(base);
1229 dev_dbg(&ofdev->dev, "ioremap done for SATA register address\n");
1231 /* Synopsys DWC SATA specific Registers */
1232 hsdev->sata_dwc_regs = base + SATA_DWC_REG_OFFSET;
1233 hsdev->dmadr = res->start + SATA_DWC_REG_OFFSET + offsetof(struct sata_dwc_regs, dmadr);
1236 host->ports[0]->ioaddr.cmd_addr = base;
1237 host->ports[0]->ioaddr.scr_addr = base + SATA_DWC_SCR_OFFSET;
1238 sata_dwc_setup_port(&host->ports[0]->ioaddr, base);
1240 /* Read the ID and Version Registers */
1241 idr = sata_dwc_readl(&hsdev->sata_dwc_regs->idr);
1242 versionr = sata_dwc_readl(&hsdev->sata_dwc_regs->versionr);
1243 dev_notice(&ofdev->dev, "id %d, controller version %c.%c%c\n",
1244 idr, ver[0], ver[1], ver[2]);
1246 /* Save dev for later use in dev_xxx() routines */
1247 hsdev->dev = &ofdev->dev;
1249 /* Enable SATA Interrupts */
1250 sata_dwc_enable_interrupts(hsdev);
1252 /* Get SATA interrupt number */
1253 irq = irq_of_parse_and_map(np, 0);
1254 if (irq == NO_IRQ) {
1255 dev_err(&ofdev->dev, "no SATA DMA irq\n");
1260 #ifdef CONFIG_SATA_DWC_OLD_DMA
1261 if (!of_find_property(np, "dmas", NULL)) {
1262 err = sata_dwc_dma_init_old(ofdev, hsdev);
1268 hsdev->phy = devm_phy_optional_get(hsdev->dev, "sata-phy");
1269 if (IS_ERR(hsdev->phy)) {
1270 err = PTR_ERR(hsdev->phy);
1275 err = phy_init(hsdev->phy);
1280 * Now, register with libATA core, this will also initiate the
1281 * device discovery process, invoking our port_start() handler &
1282 * error_handler() to execute a dummy Softreset EH session
1284 err = ata_host_activate(host, irq, sata_dwc_isr, 0, &sata_dwc_sht);
1286 dev_err(&ofdev->dev, "failed to activate host");
1291 phy_exit(hsdev->phy);
1295 static int sata_dwc_remove(struct platform_device *ofdev)
1297 struct device *dev = &ofdev->dev;
1298 struct ata_host *host = dev_get_drvdata(dev);
1299 struct sata_dwc_device *hsdev = host->private_data;
1301 ata_host_detach(host);
1303 phy_exit(hsdev->phy);
1305 #ifdef CONFIG_SATA_DWC_OLD_DMA
1306 /* Free SATA DMA resources */
1307 sata_dwc_dma_exit_old(hsdev);
1310 dev_dbg(&ofdev->dev, "done\n");
1314 static const struct of_device_id sata_dwc_match[] = {
1315 { .compatible = "amcc,sata-460ex", },
1318 MODULE_DEVICE_TABLE(of, sata_dwc_match);
1320 static struct platform_driver sata_dwc_driver = {
1323 .of_match_table = sata_dwc_match,
1325 .probe = sata_dwc_probe,
1326 .remove = sata_dwc_remove,
1329 module_platform_driver(sata_dwc_driver);
1331 MODULE_LICENSE("GPL");
1332 MODULE_AUTHOR("Mark Miesfeld <mmiesfeld@amcc.com>");
1333 MODULE_DESCRIPTION("DesignWare Cores SATA controller low level driver");
1334 MODULE_VERSION(DRV_VERSION);