2 * drivers/ata/sata_fsl.c
4 * Freescale 3.0Gbps SATA device driver
6 * Author: Ashish Kalra <ashish.kalra@freescale.com>
7 * Li Yang <leoli@freescale.com>
9 * Copyright (c) 2006-2007 Freescale Semiconductor, Inc.
11 * This program is free software; you can redistribute it and/or modify it
12 * under the terms of the GNU General Public License as published by the
13 * Free Software Foundation; either version 2 of the License, or (at your
14 * option) any later version.
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/platform_device.h>
22 #include <scsi/scsi_host.h>
23 #include <scsi/scsi_cmnd.h>
24 #include <linux/libata.h>
26 #include <linux/of_platform.h>
28 /* Controller information */
30 SATA_FSL_QUEUE_DEPTH = 16,
31 SATA_FSL_MAX_PRD = 63,
32 SATA_FSL_MAX_PRD_USABLE = SATA_FSL_MAX_PRD - 1,
33 SATA_FSL_MAX_PRD_DIRECT = 16, /* Direct PRDT entries */
35 SATA_FSL_HOST_FLAGS = (ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
36 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA |
37 ATA_FLAG_PMP | ATA_FLAG_NCQ),
39 SATA_FSL_MAX_CMDS = SATA_FSL_QUEUE_DEPTH,
40 SATA_FSL_CMD_HDR_SIZE = 16, /* 4 DWORDS */
41 SATA_FSL_CMD_SLOT_SIZE = (SATA_FSL_MAX_CMDS * SATA_FSL_CMD_HDR_SIZE),
44 * SATA-FSL host controller supports a max. of (15+1) direct PRDEs, and
45 * chained indirect PRDEs upto a max count of 63.
46 * We are allocating an array of 63 PRDEs contigiously, but PRDE#15 will
47 * be setup as an indirect descriptor, pointing to it's next
48 * (contigious) PRDE. Though chained indirect PRDE arrays are
49 * supported,it will be more efficient to use a direct PRDT and
50 * a single chain/link to indirect PRDE array/PRDT.
53 SATA_FSL_CMD_DESC_CFIS_SZ = 32,
54 SATA_FSL_CMD_DESC_SFIS_SZ = 32,
55 SATA_FSL_CMD_DESC_ACMD_SZ = 16,
56 SATA_FSL_CMD_DESC_RSRVD = 16,
58 SATA_FSL_CMD_DESC_SIZE = (SATA_FSL_CMD_DESC_CFIS_SZ +
59 SATA_FSL_CMD_DESC_SFIS_SZ +
60 SATA_FSL_CMD_DESC_ACMD_SZ +
61 SATA_FSL_CMD_DESC_RSRVD +
62 SATA_FSL_MAX_PRD * 16),
64 SATA_FSL_CMD_DESC_OFFSET_TO_PRDT =
65 (SATA_FSL_CMD_DESC_CFIS_SZ +
66 SATA_FSL_CMD_DESC_SFIS_SZ +
67 SATA_FSL_CMD_DESC_ACMD_SZ +
68 SATA_FSL_CMD_DESC_RSRVD),
70 SATA_FSL_CMD_DESC_AR_SZ = (SATA_FSL_CMD_DESC_SIZE * SATA_FSL_MAX_CMDS),
71 SATA_FSL_PORT_PRIV_DMA_SZ = (SATA_FSL_CMD_SLOT_SIZE +
72 SATA_FSL_CMD_DESC_AR_SZ),
75 * MPC8315 has two SATA controllers, SATA1 & SATA2
76 * (one port per controller)
77 * MPC837x has 2/4 controllers, one port per controller
80 SATA_FSL_MAX_PORTS = 1,
82 SATA_FSL_IRQ_FLAG = IRQF_SHARED,
86 * Host Controller command register set - per port
102 * Host Status Register (HStatus) bitdefs
105 GOING_OFFLINE = (1 << 30),
106 BIST_ERR = (1 << 29),
108 FATAL_ERR_HC_MASTER_ERR = (1 << 18),
109 FATAL_ERR_PARITY_ERR_TX = (1 << 17),
110 FATAL_ERR_PARITY_ERR_RX = (1 << 16),
111 FATAL_ERR_DATA_UNDERRUN = (1 << 13),
112 FATAL_ERR_DATA_OVERRUN = (1 << 12),
113 FATAL_ERR_CRC_ERR_TX = (1 << 11),
114 FATAL_ERR_CRC_ERR_RX = (1 << 10),
115 FATAL_ERR_FIFO_OVRFL_TX = (1 << 9),
116 FATAL_ERR_FIFO_OVRFL_RX = (1 << 8),
118 FATAL_ERROR_DECODE = FATAL_ERR_HC_MASTER_ERR |
119 FATAL_ERR_PARITY_ERR_TX |
120 FATAL_ERR_PARITY_ERR_RX |
121 FATAL_ERR_DATA_UNDERRUN |
122 FATAL_ERR_DATA_OVERRUN |
123 FATAL_ERR_CRC_ERR_TX |
124 FATAL_ERR_CRC_ERR_RX |
125 FATAL_ERR_FIFO_OVRFL_TX | FATAL_ERR_FIFO_OVRFL_RX,
127 INT_ON_FATAL_ERR = (1 << 5),
128 INT_ON_PHYRDY_CHG = (1 << 4),
130 INT_ON_SIGNATURE_UPDATE = (1 << 3),
131 INT_ON_SNOTIFY_UPDATE = (1 << 2),
132 INT_ON_SINGL_DEVICE_ERR = (1 << 1),
133 INT_ON_CMD_COMPLETE = 1,
135 INT_ON_ERROR = INT_ON_FATAL_ERR |
136 INT_ON_PHYRDY_CHG | INT_ON_SINGL_DEVICE_ERR,
139 * Host Control Register (HControl) bitdefs
141 HCONTROL_ONLINE_PHY_RST = (1 << 31),
142 HCONTROL_FORCE_OFFLINE = (1 << 30),
143 HCONTROL_PARITY_PROT_MOD = (1 << 14),
144 HCONTROL_DPATH_PARITY = (1 << 12),
145 HCONTROL_SNOOP_ENABLE = (1 << 10),
146 HCONTROL_PMP_ATTACHED = (1 << 9),
147 HCONTROL_COPYOUT_STATFIS = (1 << 8),
148 IE_ON_FATAL_ERR = (1 << 5),
149 IE_ON_PHYRDY_CHG = (1 << 4),
150 IE_ON_SIGNATURE_UPDATE = (1 << 3),
151 IE_ON_SNOTIFY_UPDATE = (1 << 2),
152 IE_ON_SINGL_DEVICE_ERR = (1 << 1),
153 IE_ON_CMD_COMPLETE = 1,
155 DEFAULT_PORT_IRQ_ENABLE_MASK = IE_ON_FATAL_ERR | IE_ON_PHYRDY_CHG |
156 IE_ON_SIGNATURE_UPDATE |
157 IE_ON_SINGL_DEVICE_ERR | IE_ON_CMD_COMPLETE,
159 EXT_INDIRECT_SEG_PRD_FLAG = (1 << 31),
160 DATA_SNOOP_ENABLE = (1 << 22),
164 * SATA Superset Registers
174 * Control Status Register Set
188 /* PHY (link-layer) configuration control */
190 PHY_BIST_ENABLE = 0x01,
194 * Command Header Table entry, i.e, command slot
195 * 4 Dwords per command slot, command header size == 64 Dwords.
197 struct cmdhdr_tbl_entry {
205 * Description information bitdefs
208 VENDOR_SPECIFIC_BIST = (1 << 10),
209 CMD_DESC_SNOOP_ENABLE = (1 << 9),
210 FPDMA_QUEUED_CMD = (1 << 8),
213 ATAPI_CMD = (1 << 5),
219 struct command_desc {
224 u32 prdt[SATA_FSL_MAX_PRD_DIRECT * 4];
225 u32 prdt_indirect[(SATA_FSL_MAX_PRD - SATA_FSL_MAX_PRD_DIRECT) * 4];
229 * Physical region table descriptor(PRD)
239 * ata_port private data
240 * This is our per-port instance data.
242 struct sata_fsl_port_priv {
243 struct cmdhdr_tbl_entry *cmdslot;
244 dma_addr_t cmdslot_paddr;
245 struct command_desc *cmdentry;
246 dma_addr_t cmdentry_paddr;
250 * ata_port->host_set private data
252 struct sata_fsl_host_priv {
253 void __iomem *hcr_base;
254 void __iomem *ssr_base;
255 void __iomem *csr_base;
259 static inline unsigned int sata_fsl_tag(unsigned int tag,
260 void __iomem *hcr_base)
262 /* We let libATA core do actual (queue) tag allocation */
264 /* all non NCQ/queued commands should have tag#0 */
265 if (ata_tag_internal(tag)) {
266 DPRINTK("mapping internal cmds to tag#0\n");
270 if (unlikely(tag >= SATA_FSL_QUEUE_DEPTH)) {
271 DPRINTK("tag %d invalid : out of range\n", tag);
275 if (unlikely((ioread32(hcr_base + CQ)) & (1 << tag))) {
276 DPRINTK("tag %d invalid : in use!!\n", tag);
283 static void sata_fsl_setup_cmd_hdr_entry(struct sata_fsl_port_priv *pp,
284 unsigned int tag, u32 desc_info,
285 u32 data_xfer_len, u8 num_prde,
288 dma_addr_t cmd_descriptor_address;
290 cmd_descriptor_address = pp->cmdentry_paddr +
291 tag * SATA_FSL_CMD_DESC_SIZE;
293 /* NOTE: both data_xfer_len & fis_len are Dword counts */
295 pp->cmdslot[tag].cda = cpu_to_le32(cmd_descriptor_address);
296 pp->cmdslot[tag].prde_fis_len =
297 cpu_to_le32((num_prde << 16) | (fis_len << 2));
298 pp->cmdslot[tag].ttl = cpu_to_le32(data_xfer_len & ~0x03);
299 pp->cmdslot[tag].desc_info = cpu_to_le32(desc_info | (tag & 0x1F));
301 VPRINTK("cda=0x%x, prde_fis_len=0x%x, ttl=0x%x, di=0x%x\n",
302 pp->cmdslot[tag].cda,
303 pp->cmdslot[tag].prde_fis_len,
304 pp->cmdslot[tag].ttl, pp->cmdslot[tag].desc_info);
308 static unsigned int sata_fsl_fill_sg(struct ata_queued_cmd *qc, void *cmd_desc,
309 u32 *ttl, dma_addr_t cmd_desc_paddr)
311 struct scatterlist *sg;
312 unsigned int num_prde = 0;
316 * NOTE : direct & indirect prdt's are contigiously allocated
318 struct prde *prd = (struct prde *)&((struct command_desc *)
321 struct prde *prd_ptr_to_indirect_ext = NULL;
322 unsigned indirect_ext_segment_sz = 0;
323 dma_addr_t indirect_ext_segment_paddr;
326 VPRINTK("SATA FSL : cd = 0x%p, prd = 0x%p\n", cmd_desc, prd);
328 indirect_ext_segment_paddr = cmd_desc_paddr +
329 SATA_FSL_CMD_DESC_OFFSET_TO_PRDT + SATA_FSL_MAX_PRD_DIRECT * 16;
331 for_each_sg(qc->sg, sg, qc->n_elem, si) {
332 dma_addr_t sg_addr = sg_dma_address(sg);
333 u32 sg_len = sg_dma_len(sg);
335 VPRINTK("SATA FSL : fill_sg, sg_addr = 0x%x, sg_len = %d\n",
338 /* warn if each s/g element is not dword aligned */
340 ata_port_printk(qc->ap, KERN_ERR,
341 "s/g addr unaligned : 0x%x\n", sg_addr);
343 ata_port_printk(qc->ap, KERN_ERR,
344 "s/g len unaligned : 0x%x\n", sg_len);
346 if (num_prde == (SATA_FSL_MAX_PRD_DIRECT - 1) &&
347 sg_next(sg) != NULL) {
348 VPRINTK("setting indirect prde\n");
349 prd_ptr_to_indirect_ext = prd;
350 prd->dba = cpu_to_le32(indirect_ext_segment_paddr);
351 indirect_ext_segment_sz = 0;
356 ttl_dwords += sg_len;
357 prd->dba = cpu_to_le32(sg_addr);
359 cpu_to_le32(DATA_SNOOP_ENABLE | (sg_len & ~0x03));
361 VPRINTK("sg_fill, ttl=%d, dba=0x%x, ddc=0x%x\n",
362 ttl_dwords, prd->dba, prd->ddc_and_ext);
366 if (prd_ptr_to_indirect_ext)
367 indirect_ext_segment_sz += sg_len;
370 if (prd_ptr_to_indirect_ext) {
371 /* set indirect extension flag along with indirect ext. size */
372 prd_ptr_to_indirect_ext->ddc_and_ext =
373 cpu_to_le32((EXT_INDIRECT_SEG_PRD_FLAG |
375 (indirect_ext_segment_sz & ~0x03)));
382 static void sata_fsl_qc_prep(struct ata_queued_cmd *qc)
384 struct ata_port *ap = qc->ap;
385 struct sata_fsl_port_priv *pp = ap->private_data;
386 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
387 void __iomem *hcr_base = host_priv->hcr_base;
388 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
389 struct command_desc *cd;
390 u32 desc_info = CMD_DESC_SNOOP_ENABLE;
395 cd = (struct command_desc *)pp->cmdentry + tag;
396 cd_paddr = pp->cmdentry_paddr + tag * SATA_FSL_CMD_DESC_SIZE;
398 ata_tf_to_fis(&qc->tf, qc->dev->link->pmp, 1, (u8 *) &cd->cfis);
400 VPRINTK("Dumping cfis : 0x%x, 0x%x, 0x%x\n",
401 cd->cfis[0], cd->cfis[1], cd->cfis[2]);
403 if (qc->tf.protocol == ATA_PROT_NCQ) {
404 VPRINTK("FPDMA xfer,Sctor cnt[0:7],[8:15] = %d,%d\n",
405 cd->cfis[3], cd->cfis[11]);
408 /* setup "ACMD - atapi command" in cmd. desc. if this is ATAPI cmd */
409 if (ata_is_atapi(qc->tf.protocol)) {
410 desc_info |= ATAPI_CMD;
411 memset((void *)&cd->acmd, 0, 32);
412 memcpy((void *)&cd->acmd, qc->cdb, qc->dev->cdb_len);
415 if (qc->flags & ATA_QCFLAG_DMAMAP)
416 num_prde = sata_fsl_fill_sg(qc, (void *)cd,
417 &ttl_dwords, cd_paddr);
419 if (qc->tf.protocol == ATA_PROT_NCQ)
420 desc_info |= FPDMA_QUEUED_CMD;
422 sata_fsl_setup_cmd_hdr_entry(pp, tag, desc_info, ttl_dwords,
425 VPRINTK("SATA FSL : xx_qc_prep, di = 0x%x, ttl = %d, num_prde = %d\n",
426 desc_info, ttl_dwords, num_prde);
429 static unsigned int sata_fsl_qc_issue(struct ata_queued_cmd *qc)
431 struct ata_port *ap = qc->ap;
432 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
433 void __iomem *hcr_base = host_priv->hcr_base;
434 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
436 VPRINTK("xx_qc_issue called,CQ=0x%x,CA=0x%x,CE=0x%x,CC=0x%x\n",
437 ioread32(CQ + hcr_base),
438 ioread32(CA + hcr_base),
439 ioread32(CE + hcr_base), ioread32(CC + hcr_base));
441 iowrite32(qc->dev->link->pmp, CQPMP + hcr_base);
443 /* Simply queue command to the controller/device */
444 iowrite32(1 << tag, CQ + hcr_base);
446 VPRINTK("xx_qc_issue called, tag=%d, CQ=0x%x, CA=0x%x\n",
447 tag, ioread32(CQ + hcr_base), ioread32(CA + hcr_base));
449 VPRINTK("CE=0x%x, DE=0x%x, CC=0x%x, CmdStat = 0x%x\n",
450 ioread32(CE + hcr_base),
451 ioread32(DE + hcr_base),
452 ioread32(CC + hcr_base),
453 ioread32(COMMANDSTAT + host_priv->csr_base));
458 static bool sata_fsl_qc_fill_rtf(struct ata_queued_cmd *qc)
460 struct sata_fsl_port_priv *pp = qc->ap->private_data;
461 struct sata_fsl_host_priv *host_priv = qc->ap->host->private_data;
462 void __iomem *hcr_base = host_priv->hcr_base;
463 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
464 struct command_desc *cd;
466 cd = pp->cmdentry + tag;
468 ata_tf_from_fis(cd->sfis, &qc->result_tf);
472 static int sata_fsl_scr_write(struct ata_link *link,
473 unsigned int sc_reg_in, u32 val)
475 struct sata_fsl_host_priv *host_priv = link->ap->host->private_data;
476 void __iomem *ssr_base = host_priv->ssr_base;
490 VPRINTK("xx_scr_write, reg_in = %d\n", sc_reg);
492 iowrite32(val, ssr_base + (sc_reg * 4));
496 static int sata_fsl_scr_read(struct ata_link *link,
497 unsigned int sc_reg_in, u32 *val)
499 struct sata_fsl_host_priv *host_priv = link->ap->host->private_data;
500 void __iomem *ssr_base = host_priv->ssr_base;
514 VPRINTK("xx_scr_read, reg_in = %d\n", sc_reg);
516 *val = ioread32(ssr_base + (sc_reg * 4));
520 static void sata_fsl_freeze(struct ata_port *ap)
522 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
523 void __iomem *hcr_base = host_priv->hcr_base;
526 VPRINTK("xx_freeze, CQ=0x%x, CA=0x%x, CE=0x%x, DE=0x%x\n",
527 ioread32(CQ + hcr_base),
528 ioread32(CA + hcr_base),
529 ioread32(CE + hcr_base), ioread32(DE + hcr_base));
530 VPRINTK("CmdStat = 0x%x\n",
531 ioread32(host_priv->csr_base + COMMANDSTAT));
533 /* disable interrupts on the controller/port */
534 temp = ioread32(hcr_base + HCONTROL);
535 iowrite32((temp & ~0x3F), hcr_base + HCONTROL);
537 VPRINTK("in xx_freeze : HControl = 0x%x, HStatus = 0x%x\n",
538 ioread32(hcr_base + HCONTROL), ioread32(hcr_base + HSTATUS));
541 static void sata_fsl_thaw(struct ata_port *ap)
543 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
544 void __iomem *hcr_base = host_priv->hcr_base;
547 /* ack. any pending IRQs for this controller/port */
548 temp = ioread32(hcr_base + HSTATUS);
550 VPRINTK("xx_thaw, pending IRQs = 0x%x\n", (temp & 0x3F));
553 iowrite32((temp & 0x3F), hcr_base + HSTATUS);
555 /* enable interrupts on the controller/port */
556 temp = ioread32(hcr_base + HCONTROL);
557 iowrite32((temp | DEFAULT_PORT_IRQ_ENABLE_MASK), hcr_base + HCONTROL);
559 VPRINTK("xx_thaw : HControl = 0x%x, HStatus = 0x%x\n",
560 ioread32(hcr_base + HCONTROL), ioread32(hcr_base + HSTATUS));
563 static void sata_fsl_pmp_attach(struct ata_port *ap)
565 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
566 void __iomem *hcr_base = host_priv->hcr_base;
569 temp = ioread32(hcr_base + HCONTROL);
570 iowrite32((temp | HCONTROL_PMP_ATTACHED), hcr_base + HCONTROL);
573 static void sata_fsl_pmp_detach(struct ata_port *ap)
575 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
576 void __iomem *hcr_base = host_priv->hcr_base;
579 temp = ioread32(hcr_base + HCONTROL);
580 temp &= ~HCONTROL_PMP_ATTACHED;
581 iowrite32(temp, hcr_base + HCONTROL);
583 /* enable interrupts on the controller/port */
584 temp = ioread32(hcr_base + HCONTROL);
585 iowrite32((temp | DEFAULT_PORT_IRQ_ENABLE_MASK), hcr_base + HCONTROL);
589 static int sata_fsl_port_start(struct ata_port *ap)
591 struct device *dev = ap->host->dev;
592 struct sata_fsl_port_priv *pp;
595 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
596 void __iomem *hcr_base = host_priv->hcr_base;
599 pp = kzalloc(sizeof(*pp), GFP_KERNEL);
603 mem = dma_alloc_coherent(dev, SATA_FSL_PORT_PRIV_DMA_SZ, &mem_dma,
609 memset(mem, 0, SATA_FSL_PORT_PRIV_DMA_SZ);
612 pp->cmdslot_paddr = mem_dma;
614 mem += SATA_FSL_CMD_SLOT_SIZE;
615 mem_dma += SATA_FSL_CMD_SLOT_SIZE;
618 pp->cmdentry_paddr = mem_dma;
620 ap->private_data = pp;
622 VPRINTK("CHBA = 0x%x, cmdentry_phys = 0x%x\n",
623 pp->cmdslot_paddr, pp->cmdentry_paddr);
625 /* Now, update the CHBA register in host controller cmd register set */
626 iowrite32(pp->cmdslot_paddr & 0xffffffff, hcr_base + CHBA);
629 * Now, we can bring the controller on-line & also initiate
630 * the COMINIT sequence, we simply return here and the boot-probing
631 * & device discovery process is re-initiated by libATA using a
632 * Softreset EH (dummy) session. Hence, boot probing and device
633 * discovey will be part of sata_fsl_softreset() callback.
636 temp = ioread32(hcr_base + HCONTROL);
637 iowrite32((temp | HCONTROL_ONLINE_PHY_RST), hcr_base + HCONTROL);
639 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
640 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
641 VPRINTK("CHBA = 0x%x\n", ioread32(hcr_base + CHBA));
643 #ifdef CONFIG_MPC8315_DS
645 * Workaround for 8315DS board 3gbps link-up issue,
646 * currently limit SATA port to GEN1 speed
648 sata_fsl_scr_read(&ap->link, SCR_CONTROL, &temp);
651 sata_fsl_scr_write(&ap->link, SCR_CONTROL, temp);
653 sata_fsl_scr_read(&ap->link, SCR_CONTROL, &temp);
654 dev_printk(KERN_WARNING, dev, "scr_control, speed limited to %x\n",
661 static void sata_fsl_port_stop(struct ata_port *ap)
663 struct device *dev = ap->host->dev;
664 struct sata_fsl_port_priv *pp = ap->private_data;
665 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
666 void __iomem *hcr_base = host_priv->hcr_base;
670 * Force host controller to go off-line, aborting current operations
672 temp = ioread32(hcr_base + HCONTROL);
673 temp &= ~HCONTROL_ONLINE_PHY_RST;
674 temp |= HCONTROL_FORCE_OFFLINE;
675 iowrite32(temp, hcr_base + HCONTROL);
677 /* Poll for controller to go offline - should happen immediately */
678 ata_wait_register(hcr_base + HSTATUS, ONLINE, ONLINE, 1, 1);
680 ap->private_data = NULL;
681 dma_free_coherent(dev, SATA_FSL_PORT_PRIV_DMA_SZ,
682 pp->cmdslot, pp->cmdslot_paddr);
687 static unsigned int sata_fsl_dev_classify(struct ata_port *ap)
689 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
690 void __iomem *hcr_base = host_priv->hcr_base;
691 struct ata_taskfile tf;
694 temp = ioread32(hcr_base + SIGNATURE);
696 VPRINTK("raw sig = 0x%x\n", temp);
697 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
698 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
700 tf.lbah = (temp >> 24) & 0xff;
701 tf.lbam = (temp >> 16) & 0xff;
702 tf.lbal = (temp >> 8) & 0xff;
703 tf.nsect = temp & 0xff;
705 return ata_dev_classify(&tf);
708 static int sata_fsl_prereset(struct ata_link *link, unsigned long deadline)
710 /* FIXME: Never skip softreset, sata_fsl_softreset() is
711 * combination of soft and hard resets. sata_fsl_softreset()
712 * needs to be splitted into soft and hard resets.
717 static int sata_fsl_softreset(struct ata_link *link, unsigned int *class,
718 unsigned long deadline)
720 struct ata_port *ap = link->ap;
721 struct sata_fsl_port_priv *pp = ap->private_data;
722 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
723 void __iomem *hcr_base = host_priv->hcr_base;
724 int pmp = sata_srst_pmp(link);
726 struct ata_taskfile tf;
730 unsigned long start_jiffies;
732 DPRINTK("in xx_softreset\n");
734 if (pmp != SATA_PMP_CTRL_PORT)
739 * Force host controller to go off-line, aborting current operations
741 temp = ioread32(hcr_base + HCONTROL);
742 temp &= ~HCONTROL_ONLINE_PHY_RST;
743 iowrite32(temp, hcr_base + HCONTROL);
745 /* Poll for controller to go offline */
746 temp = ata_wait_register(hcr_base + HSTATUS, ONLINE, ONLINE, 1, 500);
749 ata_port_printk(ap, KERN_ERR,
750 "Softreset failed, not off-lined %d\n", i);
753 * Try to offline controller atleast twice
759 goto try_offline_again;
762 DPRINTK("softreset, controller off-lined\n");
763 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
764 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
767 * PHY reset should remain asserted for atleast 1ms
772 * Now, bring the host controller online again, this can take time
773 * as PHY reset and communication establishment, 1st D2H FIS and
774 * device signature update is done, on safe side assume 500ms
775 * NOTE : Host online status may be indicated immediately!!
778 temp = ioread32(hcr_base + HCONTROL);
779 temp |= (HCONTROL_ONLINE_PHY_RST | HCONTROL_SNOOP_ENABLE);
780 temp |= HCONTROL_PMP_ATTACHED;
781 iowrite32(temp, hcr_base + HCONTROL);
783 temp = ata_wait_register(hcr_base + HSTATUS, ONLINE, 0, 1, 500);
785 if (!(temp & ONLINE)) {
786 ata_port_printk(ap, KERN_ERR,
787 "Softreset failed, not on-lined\n");
791 DPRINTK("softreset, controller off-lined & on-lined\n");
792 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
793 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
796 * First, wait for the PHYRDY change to occur before waiting for
797 * the signature, and also verify if SStatus indicates device
801 temp = ata_wait_register(hcr_base + HSTATUS, 0xFF, 0, 1, 500);
802 if ((!(temp & 0x10)) || ata_link_offline(link)) {
803 ata_port_printk(ap, KERN_WARNING,
804 "No Device OR PHYRDY change,Hstatus = 0x%x\n",
805 ioread32(hcr_base + HSTATUS));
806 *class = ATA_DEV_NONE;
811 * Wait for the first D2H from device,i.e,signature update notification
813 start_jiffies = jiffies;
814 temp = ata_wait_register(hcr_base + HSTATUS, 0xFF, 0x10,
815 500, jiffies_to_msecs(deadline - start_jiffies));
817 if ((temp & 0xFF) != 0x18) {
818 ata_port_printk(ap, KERN_WARNING, "No Signature Update\n");
819 *class = ATA_DEV_NONE;
822 ata_port_printk(ap, KERN_INFO,
823 "Signature Update detected @ %d msecs\n",
824 jiffies_to_msecs(jiffies - start_jiffies));
828 * Send a device reset (SRST) explicitly on command slot #0
829 * Check : will the command queue (reg) be cleared during offlining ??
830 * Also we will be online only if Phy commn. has been established
831 * and device presence has been detected, therefore if we have
832 * reached here, we can send a command to the target device
836 DPRINTK("Sending SRST/device reset\n");
838 ata_tf_init(link->device, &tf);
839 cfis = (u8 *) &pp->cmdentry->cfis;
841 /* device reset/SRST is a control register update FIS, uses tag0 */
842 sata_fsl_setup_cmd_hdr_entry(pp, 0,
843 SRST_CMD | CMD_DESC_SNOOP_ENABLE, 0, 0, 5);
845 tf.ctl |= ATA_SRST; /* setup SRST bit in taskfile control reg */
846 ata_tf_to_fis(&tf, pmp, 0, cfis);
848 DPRINTK("Dumping cfis : 0x%x, 0x%x, 0x%x, 0x%x\n",
849 cfis[0], cfis[1], cfis[2], cfis[3]);
852 * Queue SRST command to the controller/device, ensure that no
853 * other commands are active on the controller/device
856 DPRINTK("@Softreset, CQ = 0x%x, CA = 0x%x, CC = 0x%x\n",
857 ioread32(CQ + hcr_base),
858 ioread32(CA + hcr_base), ioread32(CC + hcr_base));
860 iowrite32(0xFFFF, CC + hcr_base);
861 iowrite32(1, CQ + hcr_base);
863 temp = ata_wait_register(CQ + hcr_base, 0x1, 0x1, 1, 5000);
865 ata_port_printk(ap, KERN_WARNING, "ATA_SRST issue failed\n");
867 DPRINTK("Softreset@5000,CQ=0x%x,CA=0x%x,CC=0x%x\n",
868 ioread32(CQ + hcr_base),
869 ioread32(CA + hcr_base), ioread32(CC + hcr_base));
871 sata_fsl_scr_read(&ap->link, SCR_ERROR, &Serror);
873 DPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
874 DPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
875 DPRINTK("Serror = 0x%x\n", Serror);
882 * SATA device enters reset state after receving a Control register
883 * FIS with SRST bit asserted and it awaits another H2D Control reg.
884 * FIS with SRST bit cleared, then the device does internal diags &
885 * initialization, followed by indicating it's initialization status
886 * using ATA signature D2H register FIS to the host controller.
889 sata_fsl_setup_cmd_hdr_entry(pp, 0, CMD_DESC_SNOOP_ENABLE, 0, 0, 5);
891 tf.ctl &= ~ATA_SRST; /* 2nd H2D Ctl. register FIS */
892 ata_tf_to_fis(&tf, pmp, 0, cfis);
894 if (pmp != SATA_PMP_CTRL_PORT)
895 iowrite32(pmp, CQPMP + hcr_base);
896 iowrite32(1, CQ + hcr_base);
897 msleep(150); /* ?? */
900 * The above command would have signalled an interrupt on command
901 * complete, which needs special handling, by clearing the Nth
902 * command bit of the CCreg
904 iowrite32(0x01, CC + hcr_base); /* We know it will be cmd#0 always */
906 DPRINTK("SATA FSL : Now checking device signature\n");
908 *class = ATA_DEV_NONE;
910 /* Verify if SStatus indicates device presence */
911 if (ata_link_online(link)) {
913 * if we are here, device presence has been detected,
914 * 1st D2H FIS would have been received, but sfis in
915 * command desc. is not updated, but signature register
916 * would have been updated
919 *class = sata_fsl_dev_classify(ap);
921 DPRINTK("class = %d\n", *class);
922 VPRINTK("ccreg = 0x%x\n", ioread32(hcr_base + CC));
923 VPRINTK("cereg = 0x%x\n", ioread32(hcr_base + CE));
933 static void sata_fsl_error_handler(struct ata_port *ap)
936 DPRINTK("in xx_error_handler\n");
937 sata_pmp_error_handler(ap);
941 static void sata_fsl_post_internal_cmd(struct ata_queued_cmd *qc)
943 if (qc->flags & ATA_QCFLAG_FAILED)
944 qc->err_mask |= AC_ERR_OTHER;
947 /* make DMA engine forget about the failed command */
952 static void sata_fsl_error_intr(struct ata_port *ap)
954 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
955 void __iomem *hcr_base = host_priv->hcr_base;
956 u32 hstatus, dereg=0, cereg = 0, SError = 0;
957 unsigned int err_mask = 0, action = 0;
958 int freeze = 0, abort=0;
959 struct ata_link *link = NULL;
960 struct ata_queued_cmd *qc = NULL;
961 struct ata_eh_info *ehi;
963 hstatus = ioread32(hcr_base + HSTATUS);
964 cereg = ioread32(hcr_base + CE);
966 /* first, analyze and record host port events */
968 ehi = &link->eh_info;
969 ata_ehi_clear_desc(ehi);
972 * Handle & Clear SError
975 sata_fsl_scr_read(&ap->link, SCR_ERROR, &SError);
976 if (unlikely(SError & 0xFFFF0000)) {
977 sata_fsl_scr_write(&ap->link, SCR_ERROR, SError);
980 DPRINTK("error_intr,hStat=0x%x,CE=0x%x,DE =0x%x,SErr=0x%x\n",
981 hstatus, cereg, ioread32(hcr_base + DE), SError);
983 /* handle fatal errors */
984 if (hstatus & FATAL_ERROR_DECODE) {
985 ehi->err_mask |= AC_ERR_ATA_BUS;
986 ehi->action |= ATA_EH_SOFTRESET;
989 * Ignore serror in case of fatal errors as we always want
990 * to do a soft-reset of the FSL SATA controller. Analyzing
991 * serror may cause libata to schedule a hard-reset action,
992 * and hard-reset currently does not do controller
993 * offline/online, causing command timeouts and leads to an
994 * un-recoverable state, hence make libATA ignore
995 * autopsy in case of fatal errors.
998 ehi->flags |= ATA_EHI_NO_AUTOPSY;
1003 /* Handle PHYRDY change notification */
1004 if (hstatus & INT_ON_PHYRDY_CHG) {
1005 DPRINTK("SATA FSL: PHYRDY change indication\n");
1007 /* Setup a soft-reset EH action */
1008 ata_ehi_hotplugged(ehi);
1009 ata_ehi_push_desc(ehi, "%s", "PHY RDY changed");
1013 /* handle single device errors */
1016 * clear the command error, also clears queue to the device
1017 * in error, and we can (re)issue commands to this device.
1018 * When a device is in error all commands queued into the
1019 * host controller and at the device are considered aborted
1020 * and the queue for that device is stopped. Now, after
1021 * clearing the device error, we can issue commands to the
1022 * device to interrogate it to find the source of the error.
1026 DPRINTK("single device error, CE=0x%x, DE=0x%x\n",
1027 ioread32(hcr_base + CE), ioread32(hcr_base + DE));
1029 /* find out the offending link and qc */
1030 if (ap->nr_pmp_links) {
1031 dereg = ioread32(hcr_base + DE);
1032 iowrite32(dereg, hcr_base + DE);
1033 iowrite32(cereg, hcr_base + CE);
1035 if (dereg < ap->nr_pmp_links) {
1036 link = &ap->pmp_link[dereg];
1037 ehi = &link->eh_info;
1038 qc = ata_qc_from_tag(ap, link->active_tag);
1040 * We should consider this as non fatal error,
1041 * and TF must be updated as done below.
1044 err_mask |= AC_ERR_DEV;
1047 err_mask |= AC_ERR_HSM;
1048 action |= ATA_EH_HARDRESET;
1052 dereg = ioread32(hcr_base + DE);
1053 iowrite32(dereg, hcr_base + DE);
1054 iowrite32(cereg, hcr_base + CE);
1056 qc = ata_qc_from_tag(ap, link->active_tag);
1058 * We should consider this as non fatal error,
1059 * and TF must be updated as done below.
1061 err_mask |= AC_ERR_DEV;
1065 /* record error info */
1067 qc->err_mask |= err_mask;
1069 ehi->err_mask |= err_mask;
1071 ehi->action |= action;
1073 /* freeze or abort */
1075 ata_port_freeze(ap);
1078 ata_link_abort(qc->dev->link);
1084 static void sata_fsl_host_intr(struct ata_port *ap)
1086 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
1087 void __iomem *hcr_base = host_priv->hcr_base;
1088 u32 hstatus, qc_active = 0;
1089 struct ata_queued_cmd *qc;
1092 hstatus = ioread32(hcr_base + HSTATUS);
1094 sata_fsl_scr_read(&ap->link, SCR_ERROR, &SError);
1096 if (unlikely(SError & 0xFFFF0000)) {
1097 DPRINTK("serror @host_intr : 0x%x\n", SError);
1098 sata_fsl_error_intr(ap);
1102 if (unlikely(hstatus & INT_ON_ERROR)) {
1103 DPRINTK("error interrupt!!\n");
1104 sata_fsl_error_intr(ap);
1108 /* Read command completed register */
1109 qc_active = ioread32(hcr_base + CC);
1111 VPRINTK("Status of all queues :\n");
1112 VPRINTK("qc_active/CC = 0x%x, CA = 0x%x, CE=0x%x,CQ=0x%x,apqa=0x%x\n",
1114 ioread32(hcr_base + CA),
1115 ioread32(hcr_base + CE),
1116 ioread32(hcr_base + CQ),
1119 if (qc_active & ap->qc_active) {
1121 /* clear CC bit, this will also complete the interrupt */
1122 iowrite32(qc_active, hcr_base + CC);
1124 DPRINTK("Status of all queues :\n");
1125 DPRINTK("qc_active/CC = 0x%x, CA = 0x%x, CE=0x%x\n",
1126 qc_active, ioread32(hcr_base + CA),
1127 ioread32(hcr_base + CE));
1129 for (i = 0; i < SATA_FSL_QUEUE_DEPTH; i++) {
1130 if (qc_active & (1 << i)) {
1131 qc = ata_qc_from_tag(ap, i);
1133 ata_qc_complete(qc);
1136 ("completing ncq cmd,tag=%d,CC=0x%x,CA=0x%x\n",
1137 i, ioread32(hcr_base + CC),
1138 ioread32(hcr_base + CA));
1143 } else if ((ap->qc_active & (1 << ATA_TAG_INTERNAL))) {
1144 iowrite32(1, hcr_base + CC);
1145 qc = ata_qc_from_tag(ap, ATA_TAG_INTERNAL);
1147 DPRINTK("completing non-ncq cmd, CC=0x%x\n",
1148 ioread32(hcr_base + CC));
1151 ata_qc_complete(qc);
1154 /* Spurious Interrupt!! */
1155 DPRINTK("spurious interrupt!!, CC = 0x%x\n",
1156 ioread32(hcr_base + CC));
1157 iowrite32(qc_active, hcr_base + CC);
1162 static irqreturn_t sata_fsl_interrupt(int irq, void *dev_instance)
1164 struct ata_host *host = dev_instance;
1165 struct sata_fsl_host_priv *host_priv = host->private_data;
1166 void __iomem *hcr_base = host_priv->hcr_base;
1167 u32 interrupt_enables;
1168 unsigned handled = 0;
1169 struct ata_port *ap;
1171 /* ack. any pending IRQs for this controller/port */
1172 interrupt_enables = ioread32(hcr_base + HSTATUS);
1173 interrupt_enables &= 0x3F;
1175 DPRINTK("interrupt status 0x%x\n", interrupt_enables);
1177 if (!interrupt_enables)
1180 spin_lock(&host->lock);
1182 /* Assuming one port per host controller */
1184 ap = host->ports[0];
1186 sata_fsl_host_intr(ap);
1188 dev_printk(KERN_WARNING, host->dev,
1189 "interrupt on disabled port 0\n");
1192 iowrite32(interrupt_enables, hcr_base + HSTATUS);
1195 spin_unlock(&host->lock);
1197 return IRQ_RETVAL(handled);
1201 * Multiple ports are represented by multiple SATA controllers with
1202 * one port per controller
1204 static int sata_fsl_init_controller(struct ata_host *host)
1206 struct sata_fsl_host_priv *host_priv = host->private_data;
1207 void __iomem *hcr_base = host_priv->hcr_base;
1211 * NOTE : We cannot bring the controller online before setting
1212 * the CHBA, hence main controller initialization is done as
1213 * part of the port_start() callback
1216 /* ack. any pending IRQs for this controller/port */
1217 temp = ioread32(hcr_base + HSTATUS);
1219 iowrite32((temp & 0x3F), hcr_base + HSTATUS);
1221 /* Keep interrupts disabled on the controller */
1222 temp = ioread32(hcr_base + HCONTROL);
1223 iowrite32((temp & ~0x3F), hcr_base + HCONTROL);
1225 /* Disable interrupt coalescing control(icc), for the moment */
1226 DPRINTK("icc = 0x%x\n", ioread32(hcr_base + ICC));
1227 iowrite32(0x01000000, hcr_base + ICC);
1229 /* clear error registers, SError is cleared by libATA */
1230 iowrite32(0x00000FFFF, hcr_base + CE);
1231 iowrite32(0x00000FFFF, hcr_base + DE);
1234 * host controller will be brought on-line, during xx_port_start()
1235 * callback, that should also initiate the OOB, COMINIT sequence
1238 DPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
1239 DPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
1245 * scsi mid-layer and libata interface structures
1247 static struct scsi_host_template sata_fsl_sht = {
1248 ATA_NCQ_SHT("sata_fsl"),
1249 .can_queue = SATA_FSL_QUEUE_DEPTH,
1250 .sg_tablesize = SATA_FSL_MAX_PRD_USABLE,
1251 .dma_boundary = ATA_DMA_BOUNDARY,
1254 static struct ata_port_operations sata_fsl_ops = {
1255 .inherits = &sata_pmp_port_ops,
1257 .qc_prep = sata_fsl_qc_prep,
1258 .qc_issue = sata_fsl_qc_issue,
1259 .qc_fill_rtf = sata_fsl_qc_fill_rtf,
1261 .scr_read = sata_fsl_scr_read,
1262 .scr_write = sata_fsl_scr_write,
1264 .freeze = sata_fsl_freeze,
1265 .thaw = sata_fsl_thaw,
1266 .prereset = sata_fsl_prereset,
1267 .softreset = sata_fsl_softreset,
1268 .pmp_softreset = sata_fsl_softreset,
1269 .error_handler = sata_fsl_error_handler,
1270 .post_internal_cmd = sata_fsl_post_internal_cmd,
1272 .port_start = sata_fsl_port_start,
1273 .port_stop = sata_fsl_port_stop,
1275 .pmp_attach = sata_fsl_pmp_attach,
1276 .pmp_detach = sata_fsl_pmp_detach,
1279 static const struct ata_port_info sata_fsl_port_info[] = {
1281 .flags = SATA_FSL_HOST_FLAGS,
1282 .pio_mask = ATA_PIO4,
1283 .udma_mask = ATA_UDMA6,
1284 .port_ops = &sata_fsl_ops,
1288 static int sata_fsl_probe(struct of_device *ofdev,
1289 const struct of_device_id *match)
1291 int retval = -ENXIO;
1292 void __iomem *hcr_base = NULL;
1293 void __iomem *ssr_base = NULL;
1294 void __iomem *csr_base = NULL;
1295 struct sata_fsl_host_priv *host_priv = NULL;
1297 struct ata_host *host;
1299 struct ata_port_info pi = sata_fsl_port_info[0];
1300 const struct ata_port_info *ppi[] = { &pi, NULL };
1302 dev_printk(KERN_INFO, &ofdev->dev,
1303 "Sata FSL Platform/CSB Driver init\n");
1305 hcr_base = of_iomap(ofdev->node, 0);
1307 goto error_exit_with_cleanup;
1309 ssr_base = hcr_base + 0x100;
1310 csr_base = hcr_base + 0x140;
1312 DPRINTK("@reset i/o = 0x%x\n", ioread32(csr_base + TRANSCFG));
1313 DPRINTK("sizeof(cmd_desc) = %d\n", sizeof(struct command_desc));
1314 DPRINTK("sizeof(#define cmd_desc) = %d\n", SATA_FSL_CMD_DESC_SIZE);
1316 host_priv = kzalloc(sizeof(struct sata_fsl_host_priv), GFP_KERNEL);
1318 goto error_exit_with_cleanup;
1320 host_priv->hcr_base = hcr_base;
1321 host_priv->ssr_base = ssr_base;
1322 host_priv->csr_base = csr_base;
1324 irq = irq_of_parse_and_map(ofdev->node, 0);
1326 dev_printk(KERN_ERR, &ofdev->dev, "invalid irq from platform\n");
1327 goto error_exit_with_cleanup;
1329 host_priv->irq = irq;
1331 /* allocate host structure */
1332 host = ata_host_alloc_pinfo(&ofdev->dev, ppi, SATA_FSL_MAX_PORTS);
1334 /* host->iomap is not used currently */
1335 host->private_data = host_priv;
1337 /* initialize host controller */
1338 sata_fsl_init_controller(host);
1341 * Now, register with libATA core, this will also initiate the
1342 * device discovery process, invoking our port_start() handler &
1343 * error_handler() to execute a dummy Softreset EH session
1345 ata_host_activate(host, irq, sata_fsl_interrupt, SATA_FSL_IRQ_FLAG,
1348 dev_set_drvdata(&ofdev->dev, host);
1352 error_exit_with_cleanup:
1362 static int sata_fsl_remove(struct of_device *ofdev)
1364 struct ata_host *host = dev_get_drvdata(&ofdev->dev);
1365 struct sata_fsl_host_priv *host_priv = host->private_data;
1367 ata_host_detach(host);
1369 dev_set_drvdata(&ofdev->dev, NULL);
1371 irq_dispose_mapping(host_priv->irq);
1372 iounmap(host_priv->hcr_base);
1378 static struct of_device_id fsl_sata_match[] = {
1380 .compatible = "fsl,pq-sata",
1385 MODULE_DEVICE_TABLE(of, fsl_sata_match);
1387 static struct of_platform_driver fsl_sata_driver = {
1389 .match_table = fsl_sata_match,
1390 .probe = sata_fsl_probe,
1391 .remove = sata_fsl_remove,
1394 static int __init sata_fsl_init(void)
1396 of_register_platform_driver(&fsl_sata_driver);
1400 static void __exit sata_fsl_exit(void)
1402 of_unregister_platform_driver(&fsl_sata_driver);
1405 MODULE_LICENSE("GPL");
1406 MODULE_AUTHOR("Ashish Kalra, Freescale Semiconductor");
1407 MODULE_DESCRIPTION("Freescale 3.0Gbps SATA controller low level driver");
1408 MODULE_VERSION("1.10");
1410 module_init(sata_fsl_init);
1411 module_exit(sata_fsl_exit);