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 |
38 SATA_FSL_HOST_LFLAGS = ATA_LFLAG_SKIP_D2H_BSY,
40 SATA_FSL_MAX_CMDS = SATA_FSL_QUEUE_DEPTH,
41 SATA_FSL_CMD_HDR_SIZE = 16, /* 4 DWORDS */
42 SATA_FSL_CMD_SLOT_SIZE = (SATA_FSL_MAX_CMDS * SATA_FSL_CMD_HDR_SIZE),
45 * SATA-FSL host controller supports a max. of (15+1) direct PRDEs, and
46 * chained indirect PRDEs upto a max count of 63.
47 * We are allocating an array of 63 PRDEs contigiously, but PRDE#15 will
48 * be setup as an indirect descriptor, pointing to it's next
49 * (contigious) PRDE. Though chained indirect PRDE arrays are
50 * supported,it will be more efficient to use a direct PRDT and
51 * a single chain/link to indirect PRDE array/PRDT.
54 SATA_FSL_CMD_DESC_CFIS_SZ = 32,
55 SATA_FSL_CMD_DESC_SFIS_SZ = 32,
56 SATA_FSL_CMD_DESC_ACMD_SZ = 16,
57 SATA_FSL_CMD_DESC_RSRVD = 16,
59 SATA_FSL_CMD_DESC_SIZE = (SATA_FSL_CMD_DESC_CFIS_SZ +
60 SATA_FSL_CMD_DESC_SFIS_SZ +
61 SATA_FSL_CMD_DESC_ACMD_SZ +
62 SATA_FSL_CMD_DESC_RSRVD +
63 SATA_FSL_MAX_PRD * 16),
65 SATA_FSL_CMD_DESC_OFFSET_TO_PRDT =
66 (SATA_FSL_CMD_DESC_CFIS_SZ +
67 SATA_FSL_CMD_DESC_SFIS_SZ +
68 SATA_FSL_CMD_DESC_ACMD_SZ +
69 SATA_FSL_CMD_DESC_RSRVD),
71 SATA_FSL_CMD_DESC_AR_SZ = (SATA_FSL_CMD_DESC_SIZE * SATA_FSL_MAX_CMDS),
72 SATA_FSL_PORT_PRIV_DMA_SZ = (SATA_FSL_CMD_SLOT_SIZE +
73 SATA_FSL_CMD_DESC_AR_SZ),
76 * MPC8315 has two SATA controllers, SATA1 & SATA2
77 * (one port per controller)
78 * MPC837x has 2/4 controllers, one port per controller
81 SATA_FSL_MAX_PORTS = 1,
83 SATA_FSL_IRQ_FLAG = IRQF_SHARED,
87 * Host Controller command register set - per port
103 * Host Status Register (HStatus) bitdefs
106 GOING_OFFLINE = (1 << 30),
107 BIST_ERR = (1 << 29),
109 FATAL_ERR_HC_MASTER_ERR = (1 << 18),
110 FATAL_ERR_PARITY_ERR_TX = (1 << 17),
111 FATAL_ERR_PARITY_ERR_RX = (1 << 16),
112 FATAL_ERR_DATA_UNDERRUN = (1 << 13),
113 FATAL_ERR_DATA_OVERRUN = (1 << 12),
114 FATAL_ERR_CRC_ERR_TX = (1 << 11),
115 FATAL_ERR_CRC_ERR_RX = (1 << 10),
116 FATAL_ERR_FIFO_OVRFL_TX = (1 << 9),
117 FATAL_ERR_FIFO_OVRFL_RX = (1 << 8),
119 FATAL_ERROR_DECODE = FATAL_ERR_HC_MASTER_ERR |
120 FATAL_ERR_PARITY_ERR_TX |
121 FATAL_ERR_PARITY_ERR_RX |
122 FATAL_ERR_DATA_UNDERRUN |
123 FATAL_ERR_DATA_OVERRUN |
124 FATAL_ERR_CRC_ERR_TX |
125 FATAL_ERR_CRC_ERR_RX |
126 FATAL_ERR_FIFO_OVRFL_TX | FATAL_ERR_FIFO_OVRFL_RX,
128 INT_ON_FATAL_ERR = (1 << 5),
129 INT_ON_PHYRDY_CHG = (1 << 4),
131 INT_ON_SIGNATURE_UPDATE = (1 << 3),
132 INT_ON_SNOTIFY_UPDATE = (1 << 2),
133 INT_ON_SINGL_DEVICE_ERR = (1 << 1),
134 INT_ON_CMD_COMPLETE = 1,
136 INT_ON_ERROR = INT_ON_FATAL_ERR |
137 INT_ON_PHYRDY_CHG | INT_ON_SINGL_DEVICE_ERR,
140 * Host Control Register (HControl) bitdefs
142 HCONTROL_ONLINE_PHY_RST = (1 << 31),
143 HCONTROL_FORCE_OFFLINE = (1 << 30),
144 HCONTROL_PARITY_PROT_MOD = (1 << 14),
145 HCONTROL_DPATH_PARITY = (1 << 12),
146 HCONTROL_SNOOP_ENABLE = (1 << 10),
147 HCONTROL_PMP_ATTACHED = (1 << 9),
148 HCONTROL_COPYOUT_STATFIS = (1 << 8),
149 IE_ON_FATAL_ERR = (1 << 5),
150 IE_ON_PHYRDY_CHG = (1 << 4),
151 IE_ON_SIGNATURE_UPDATE = (1 << 3),
152 IE_ON_SNOTIFY_UPDATE = (1 << 2),
153 IE_ON_SINGL_DEVICE_ERR = (1 << 1),
154 IE_ON_CMD_COMPLETE = 1,
156 DEFAULT_PORT_IRQ_ENABLE_MASK = IE_ON_FATAL_ERR | IE_ON_PHYRDY_CHG |
157 IE_ON_SIGNATURE_UPDATE |
158 IE_ON_SINGL_DEVICE_ERR | IE_ON_CMD_COMPLETE,
160 EXT_INDIRECT_SEG_PRD_FLAG = (1 << 31),
161 DATA_SNOOP_ENABLE = (1 << 22),
165 * SATA Superset Registers
175 * Control Status Register Set
189 /* PHY (link-layer) configuration control */
191 PHY_BIST_ENABLE = 0x01,
195 * Command Header Table entry, i.e, command slot
196 * 4 Dwords per command slot, command header size == 64 Dwords.
198 struct cmdhdr_tbl_entry {
206 * Description information bitdefs
209 VENDOR_SPECIFIC_BIST = (1 << 10),
210 CMD_DESC_SNOOP_ENABLE = (1 << 9),
211 FPDMA_QUEUED_CMD = (1 << 8),
214 ATAPI_CMD = (1 << 5),
220 struct command_desc {
225 u32 prdt[SATA_FSL_MAX_PRD_DIRECT * 4];
226 u32 prdt_indirect[(SATA_FSL_MAX_PRD - SATA_FSL_MAX_PRD_DIRECT) * 4];
230 * Physical region table descriptor(PRD)
240 * ata_port private data
241 * This is our per-port instance data.
243 struct sata_fsl_port_priv {
244 struct cmdhdr_tbl_entry *cmdslot;
245 dma_addr_t cmdslot_paddr;
246 struct command_desc *cmdentry;
247 dma_addr_t cmdentry_paddr;
250 * SATA FSL controller has a Status FIS which should contain the
251 * received D2H FIS & taskfile registers. This SFIS is present in
252 * the command descriptor, and to have a ready reference to it,
253 * we are caching it here, quite similar to what is done in H/W on
254 * AHCI compliant devices by copying taskfile fields to a 32-bit
258 struct ata_taskfile tf;
262 * ata_port->host_set private data
264 struct sata_fsl_host_priv {
265 void __iomem *hcr_base;
266 void __iomem *ssr_base;
267 void __iomem *csr_base;
271 static inline unsigned int sata_fsl_tag(unsigned int tag,
272 void __iomem *hcr_base)
274 /* We let libATA core do actual (queue) tag allocation */
276 /* all non NCQ/queued commands should have tag#0 */
277 if (ata_tag_internal(tag)) {
278 DPRINTK("mapping internal cmds to tag#0\n");
282 if (unlikely(tag >= SATA_FSL_QUEUE_DEPTH)) {
283 DPRINTK("tag %d invalid : out of range\n", tag);
287 if (unlikely((ioread32(hcr_base + CQ)) & (1 << tag))) {
288 DPRINTK("tag %d invalid : in use!!\n", tag);
295 static void sata_fsl_setup_cmd_hdr_entry(struct sata_fsl_port_priv *pp,
296 unsigned int tag, u32 desc_info,
297 u32 data_xfer_len, u8 num_prde,
300 dma_addr_t cmd_descriptor_address;
302 cmd_descriptor_address = pp->cmdentry_paddr +
303 tag * SATA_FSL_CMD_DESC_SIZE;
305 /* NOTE: both data_xfer_len & fis_len are Dword counts */
307 pp->cmdslot[tag].cda = cpu_to_le32(cmd_descriptor_address);
308 pp->cmdslot[tag].prde_fis_len =
309 cpu_to_le32((num_prde << 16) | (fis_len << 2));
310 pp->cmdslot[tag].ttl = cpu_to_le32(data_xfer_len & ~0x03);
311 pp->cmdslot[tag].desc_info = cpu_to_le32(desc_info | (tag & 0x1F));
313 VPRINTK("cda=0x%x, prde_fis_len=0x%x, ttl=0x%x, di=0x%x\n",
314 pp->cmdslot[tag].cda,
315 pp->cmdslot[tag].prde_fis_len,
316 pp->cmdslot[tag].ttl, pp->cmdslot[tag].desc_info);
320 static unsigned int sata_fsl_fill_sg(struct ata_queued_cmd *qc, void *cmd_desc,
321 u32 *ttl, dma_addr_t cmd_desc_paddr)
323 struct scatterlist *sg;
324 unsigned int num_prde = 0;
328 * NOTE : direct & indirect prdt's are contigiously allocated
330 struct prde *prd = (struct prde *)&((struct command_desc *)
333 struct prde *prd_ptr_to_indirect_ext = NULL;
334 unsigned indirect_ext_segment_sz = 0;
335 dma_addr_t indirect_ext_segment_paddr;
338 VPRINTK("SATA FSL : cd = 0x%x, prd = 0x%x\n", cmd_desc, prd);
340 indirect_ext_segment_paddr = cmd_desc_paddr +
341 SATA_FSL_CMD_DESC_OFFSET_TO_PRDT + SATA_FSL_MAX_PRD_DIRECT * 16;
343 for_each_sg(qc->sg, sg, qc->n_elem, si) {
344 dma_addr_t sg_addr = sg_dma_address(sg);
345 u32 sg_len = sg_dma_len(sg);
347 VPRINTK("SATA FSL : fill_sg, sg_addr = 0x%x, sg_len = %d\n",
350 /* warn if each s/g element is not dword aligned */
352 ata_port_printk(qc->ap, KERN_ERR,
353 "s/g addr unaligned : 0x%x\n", sg_addr);
355 ata_port_printk(qc->ap, KERN_ERR,
356 "s/g len unaligned : 0x%x\n", sg_len);
358 if (num_prde == (SATA_FSL_MAX_PRD_DIRECT - 1) &&
359 sg_next(sg) != NULL) {
360 VPRINTK("setting indirect prde\n");
361 prd_ptr_to_indirect_ext = prd;
362 prd->dba = cpu_to_le32(indirect_ext_segment_paddr);
363 indirect_ext_segment_sz = 0;
368 ttl_dwords += sg_len;
369 prd->dba = cpu_to_le32(sg_addr);
371 cpu_to_le32(DATA_SNOOP_ENABLE | (sg_len & ~0x03));
373 VPRINTK("sg_fill, ttl=%d, dba=0x%x, ddc=0x%x\n",
374 ttl_dwords, prd->dba, prd->ddc_and_ext);
378 if (prd_ptr_to_indirect_ext)
379 indirect_ext_segment_sz += sg_len;
382 if (prd_ptr_to_indirect_ext) {
383 /* set indirect extension flag along with indirect ext. size */
384 prd_ptr_to_indirect_ext->ddc_and_ext =
385 cpu_to_le32((EXT_INDIRECT_SEG_PRD_FLAG |
387 (indirect_ext_segment_sz & ~0x03)));
394 static void sata_fsl_qc_prep(struct ata_queued_cmd *qc)
396 struct ata_port *ap = qc->ap;
397 struct sata_fsl_port_priv *pp = ap->private_data;
398 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
399 void __iomem *hcr_base = host_priv->hcr_base;
400 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
401 struct command_desc *cd;
402 u32 desc_info = CMD_DESC_SNOOP_ENABLE;
407 cd = (struct command_desc *)pp->cmdentry + tag;
408 cd_paddr = pp->cmdentry_paddr + tag * SATA_FSL_CMD_DESC_SIZE;
410 ata_tf_to_fis(&qc->tf, 0, 1, (u8 *) &cd->cfis);
412 VPRINTK("Dumping cfis : 0x%x, 0x%x, 0x%x\n",
413 cd->cfis[0], cd->cfis[1], cd->cfis[2]);
415 if (qc->tf.protocol == ATA_PROT_NCQ) {
416 VPRINTK("FPDMA xfer,Sctor cnt[0:7],[8:15] = %d,%d\n",
417 cd->cfis[3], cd->cfis[11]);
420 /* setup "ACMD - atapi command" in cmd. desc. if this is ATAPI cmd */
421 if (ata_is_atapi(qc->tf.protocol)) {
422 desc_info |= ATAPI_CMD;
423 memset((void *)&cd->acmd, 0, 32);
424 memcpy((void *)&cd->acmd, qc->cdb, qc->dev->cdb_len);
427 if (qc->flags & ATA_QCFLAG_DMAMAP)
428 num_prde = sata_fsl_fill_sg(qc, (void *)cd,
429 &ttl_dwords, cd_paddr);
431 if (qc->tf.protocol == ATA_PROT_NCQ)
432 desc_info |= FPDMA_QUEUED_CMD;
434 sata_fsl_setup_cmd_hdr_entry(pp, tag, desc_info, ttl_dwords,
437 VPRINTK("SATA FSL : xx_qc_prep, di = 0x%x, ttl = %d, num_prde = %d\n",
438 desc_info, ttl_dwords, num_prde);
441 static unsigned int sata_fsl_qc_issue(struct ata_queued_cmd *qc)
443 struct ata_port *ap = qc->ap;
444 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
445 void __iomem *hcr_base = host_priv->hcr_base;
446 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
448 VPRINTK("xx_qc_issue called,CQ=0x%x,CA=0x%x,CE=0x%x,CC=0x%x\n",
449 ioread32(CQ + hcr_base),
450 ioread32(CA + hcr_base),
451 ioread32(CE + hcr_base), ioread32(CC + hcr_base));
453 /* Simply queue command to the controller/device */
454 iowrite32(1 << tag, CQ + hcr_base);
456 VPRINTK("xx_qc_issue called, tag=%d, CQ=0x%x, CA=0x%x\n",
457 tag, ioread32(CQ + hcr_base), ioread32(CA + hcr_base));
459 VPRINTK("CE=0x%x, DE=0x%x, CC=0x%x, CmdStat = 0x%x\n",
460 ioread32(CE + hcr_base),
461 ioread32(DE + hcr_base),
462 ioread32(CC + hcr_base), ioread32(COMMANDSTAT + csr_base));
467 static int sata_fsl_scr_write(struct ata_port *ap, unsigned int sc_reg_in,
470 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
471 void __iomem *ssr_base = host_priv->ssr_base;
485 VPRINTK("xx_scr_write, reg_in = %d\n", sc_reg);
487 iowrite32(val, ssr_base + (sc_reg * 4));
491 static int sata_fsl_scr_read(struct ata_port *ap, unsigned int sc_reg_in,
494 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
495 void __iomem *ssr_base = host_priv->ssr_base;
509 VPRINTK("xx_scr_read, reg_in = %d\n", sc_reg);
511 *val = ioread32(ssr_base + (sc_reg * 4));
515 static void sata_fsl_freeze(struct ata_port *ap)
517 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
518 void __iomem *hcr_base = host_priv->hcr_base;
521 VPRINTK("xx_freeze, CQ=0x%x, CA=0x%x, CE=0x%x, DE=0x%x\n",
522 ioread32(CQ + hcr_base),
523 ioread32(CA + hcr_base),
524 ioread32(CE + hcr_base), ioread32(DE + hcr_base));
525 VPRINTK("CmdStat = 0x%x\n", ioread32(csr_base + COMMANDSTAT));
527 /* disable interrupts on the controller/port */
528 temp = ioread32(hcr_base + HCONTROL);
529 iowrite32((temp & ~0x3F), hcr_base + HCONTROL);
531 VPRINTK("in xx_freeze : HControl = 0x%x, HStatus = 0x%x\n",
532 ioread32(hcr_base + HCONTROL), ioread32(hcr_base + HSTATUS));
535 static void sata_fsl_thaw(struct ata_port *ap)
537 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
538 void __iomem *hcr_base = host_priv->hcr_base;
541 /* ack. any pending IRQs for this controller/port */
542 temp = ioread32(hcr_base + HSTATUS);
544 VPRINTK("xx_thaw, pending IRQs = 0x%x\n", (temp & 0x3F));
547 iowrite32((temp & 0x3F), hcr_base + HSTATUS);
549 /* enable interrupts on the controller/port */
550 temp = ioread32(hcr_base + HCONTROL);
551 iowrite32((temp | DEFAULT_PORT_IRQ_ENABLE_MASK), hcr_base + HCONTROL);
553 VPRINTK("xx_thaw : HControl = 0x%x, HStatus = 0x%x\n",
554 ioread32(hcr_base + HCONTROL), ioread32(hcr_base + HSTATUS));
558 * NOTE : 1st D2H FIS from device does not update sfis in command descriptor.
560 static inline void sata_fsl_cache_taskfile_from_d2h_fis(struct ata_queued_cmd
564 struct sata_fsl_port_priv *pp = ap->private_data;
565 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
566 void __iomem *hcr_base = host_priv->hcr_base;
567 unsigned int tag = sata_fsl_tag(qc->tag, hcr_base);
568 struct command_desc *cd;
570 cd = pp->cmdentry + tag;
572 ata_tf_from_fis(cd->sfis, &pp->tf);
575 static u8 sata_fsl_check_status(struct ata_port *ap)
577 struct sata_fsl_port_priv *pp = ap->private_data;
579 return pp->tf.command;
582 static void sata_fsl_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
584 struct sata_fsl_port_priv *pp = ap->private_data;
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;
596 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
597 void __iomem *hcr_base = host_priv->hcr_base;
600 pp = kzalloc(sizeof(*pp), GFP_KERNEL);
604 mem = dma_alloc_coherent(dev, SATA_FSL_PORT_PRIV_DMA_SZ, &mem_dma,
610 memset(mem, 0, SATA_FSL_PORT_PRIV_DMA_SZ);
613 pp->cmdslot_paddr = mem_dma;
615 mem += SATA_FSL_CMD_SLOT_SIZE;
616 mem_dma += SATA_FSL_CMD_SLOT_SIZE;
619 pp->cmdentry_paddr = mem_dma;
621 ap->private_data = pp;
623 VPRINTK("CHBA = 0x%x, cmdentry_phys = 0x%x\n",
624 pp->cmdslot_paddr, pp->cmdentry_paddr);
626 /* Now, update the CHBA register in host controller cmd register set */
627 iowrite32(pp->cmdslot_paddr & 0xffffffff, hcr_base + CHBA);
630 * Now, we can bring the controller on-line & also initiate
631 * the COMINIT sequence, we simply return here and the boot-probing
632 * & device discovery process is re-initiated by libATA using a
633 * Softreset EH (dummy) session. Hence, boot probing and device
634 * discovey will be part of sata_fsl_softreset() callback.
637 temp = ioread32(hcr_base + HCONTROL);
638 iowrite32((temp | HCONTROL_ONLINE_PHY_RST), hcr_base + HCONTROL);
640 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
641 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
642 VPRINTK("CHBA = 0x%x\n", ioread32(hcr_base + CHBA));
644 #ifdef CONFIG_MPC8315_DS
646 * Workaround for 8315DS board 3gbps link-up issue,
647 * currently limit SATA port to GEN1 speed
649 sata_fsl_scr_read(ap, SCR_CONTROL, &temp);
652 sata_fsl_scr_write(ap, SCR_CONTROL, temp);
654 sata_fsl_scr_read(ap, SCR_CONTROL, &temp);
655 dev_printk(KERN_WARNING, dev, "scr_control, speed limited to %x\n",
662 static void sata_fsl_port_stop(struct ata_port *ap)
664 struct device *dev = ap->host->dev;
665 struct sata_fsl_port_priv *pp = ap->private_data;
666 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
667 void __iomem *hcr_base = host_priv->hcr_base;
671 * Force host controller to go off-line, aborting current operations
673 temp = ioread32(hcr_base + HCONTROL);
674 temp &= ~HCONTROL_ONLINE_PHY_RST;
675 temp |= HCONTROL_FORCE_OFFLINE;
676 iowrite32(temp, hcr_base + HCONTROL);
678 /* Poll for controller to go offline - should happen immediately */
679 ata_wait_register(hcr_base + HSTATUS, ONLINE, ONLINE, 1, 1);
681 ap->private_data = NULL;
682 dma_free_coherent(dev, SATA_FSL_PORT_PRIV_DMA_SZ,
683 pp->cmdslot, pp->cmdslot_paddr);
688 static unsigned int sata_fsl_dev_classify(struct ata_port *ap)
690 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
691 void __iomem *hcr_base = host_priv->hcr_base;
692 struct ata_taskfile tf;
695 temp = ioread32(hcr_base + SIGNATURE);
697 VPRINTK("raw sig = 0x%x\n", temp);
698 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
699 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
701 tf.lbah = (temp >> 24) & 0xff;
702 tf.lbam = (temp >> 16) & 0xff;
703 tf.lbal = (temp >> 8) & 0xff;
704 tf.nsect = temp & 0xff;
706 return ata_dev_classify(&tf);
709 static int sata_fsl_softreset(struct ata_link *link, unsigned int *class,
710 unsigned long deadline)
712 struct ata_port *ap = link->ap;
713 struct sata_fsl_port_priv *pp = ap->private_data;
714 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
715 void __iomem *hcr_base = host_priv->hcr_base;
717 struct ata_taskfile tf;
721 unsigned long start_jiffies;
723 DPRINTK("in xx_softreset\n");
727 * Force host controller to go off-line, aborting current operations
729 temp = ioread32(hcr_base + HCONTROL);
730 temp &= ~HCONTROL_ONLINE_PHY_RST;
731 iowrite32(temp, hcr_base + HCONTROL);
733 /* Poll for controller to go offline */
734 temp = ata_wait_register(hcr_base + HSTATUS, ONLINE, ONLINE, 1, 500);
737 ata_port_printk(ap, KERN_ERR,
738 "Softreset failed, not off-lined %d\n", i);
741 * Try to offline controller atleast twice
747 goto try_offline_again;
750 DPRINTK("softreset, controller off-lined\n");
751 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
752 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
755 * PHY reset should remain asserted for atleast 1ms
760 * Now, bring the host controller online again, this can take time
761 * as PHY reset and communication establishment, 1st D2H FIS and
762 * device signature update is done, on safe side assume 500ms
763 * NOTE : Host online status may be indicated immediately!!
766 temp = ioread32(hcr_base + HCONTROL);
767 temp |= (HCONTROL_ONLINE_PHY_RST | HCONTROL_SNOOP_ENABLE);
768 iowrite32(temp, hcr_base + HCONTROL);
770 temp = ata_wait_register(hcr_base + HSTATUS, ONLINE, 0, 1, 500);
772 if (!(temp & ONLINE)) {
773 ata_port_printk(ap, KERN_ERR,
774 "Softreset failed, not on-lined\n");
778 DPRINTK("softreset, controller off-lined & on-lined\n");
779 VPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
780 VPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
783 * First, wait for the PHYRDY change to occur before waiting for
784 * the signature, and also verify if SStatus indicates device
788 temp = ata_wait_register(hcr_base + HSTATUS, 0xFF, 0, 1, 500);
789 if ((!(temp & 0x10)) || ata_link_offline(link)) {
790 ata_port_printk(ap, KERN_WARNING,
791 "No Device OR PHYRDY change,Hstatus = 0x%x\n",
792 ioread32(hcr_base + HSTATUS));
797 * Wait for the first D2H from device,i.e,signature update notification
799 start_jiffies = jiffies;
800 temp = ata_wait_register(hcr_base + HSTATUS, 0xFF, 0x10,
801 500, jiffies_to_msecs(deadline - start_jiffies));
803 if ((temp & 0xFF) != 0x18) {
804 ata_port_printk(ap, KERN_WARNING, "No Signature Update\n");
807 ata_port_printk(ap, KERN_INFO,
808 "Signature Update detected @ %d msecs\n",
809 jiffies_to_msecs(jiffies - start_jiffies));
813 * Send a device reset (SRST) explicitly on command slot #0
814 * Check : will the command queue (reg) be cleared during offlining ??
815 * Also we will be online only if Phy commn. has been established
816 * and device presence has been detected, therefore if we have
817 * reached here, we can send a command to the target device
820 DPRINTK("Sending SRST/device reset\n");
822 ata_tf_init(link->device, &tf);
823 cfis = (u8 *) &pp->cmdentry->cfis;
825 /* device reset/SRST is a control register update FIS, uses tag0 */
826 sata_fsl_setup_cmd_hdr_entry(pp, 0,
827 SRST_CMD | CMD_DESC_SNOOP_ENABLE, 0, 0, 5);
829 tf.ctl |= ATA_SRST; /* setup SRST bit in taskfile control reg */
830 ata_tf_to_fis(&tf, 0, 0, cfis);
832 DPRINTK("Dumping cfis : 0x%x, 0x%x, 0x%x, 0x%x\n",
833 cfis[0], cfis[1], cfis[2], cfis[3]);
836 * Queue SRST command to the controller/device, ensure that no
837 * other commands are active on the controller/device
840 DPRINTK("@Softreset, CQ = 0x%x, CA = 0x%x, CC = 0x%x\n",
841 ioread32(CQ + hcr_base),
842 ioread32(CA + hcr_base), ioread32(CC + hcr_base));
844 iowrite32(0xFFFF, CC + hcr_base);
845 iowrite32(1, CQ + hcr_base);
847 temp = ata_wait_register(CQ + hcr_base, 0x1, 0x1, 1, 5000);
849 ata_port_printk(ap, KERN_WARNING, "ATA_SRST issue failed\n");
851 DPRINTK("Softreset@5000,CQ=0x%x,CA=0x%x,CC=0x%x\n",
852 ioread32(CQ + hcr_base),
853 ioread32(CA + hcr_base), ioread32(CC + hcr_base));
855 sata_fsl_scr_read(ap, SCR_ERROR, &Serror);
857 DPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
858 DPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
859 DPRINTK("Serror = 0x%x\n", Serror);
866 * SATA device enters reset state after receving a Control register
867 * FIS with SRST bit asserted and it awaits another H2D Control reg.
868 * FIS with SRST bit cleared, then the device does internal diags &
869 * initialization, followed by indicating it's initialization status
870 * using ATA signature D2H register FIS to the host controller.
873 sata_fsl_setup_cmd_hdr_entry(pp, 0, CMD_DESC_SNOOP_ENABLE, 0, 0, 5);
875 tf.ctl &= ~ATA_SRST; /* 2nd H2D Ctl. register FIS */
876 ata_tf_to_fis(&tf, 0, 0, cfis);
878 iowrite32(1, CQ + hcr_base);
879 msleep(150); /* ?? */
882 * The above command would have signalled an interrupt on command
883 * complete, which needs special handling, by clearing the Nth
884 * command bit of the CCreg
886 iowrite32(0x01, CC + hcr_base); /* We know it will be cmd#0 always */
888 DPRINTK("SATA FSL : Now checking device signature\n");
890 *class = ATA_DEV_NONE;
892 /* Verify if SStatus indicates device presence */
893 if (ata_link_online(link)) {
895 * if we are here, device presence has been detected,
896 * 1st D2H FIS would have been received, but sfis in
897 * command desc. is not updated, but signature register
898 * would have been updated
901 *class = sata_fsl_dev_classify(ap);
903 DPRINTK("class = %d\n", *class);
904 VPRINTK("ccreg = 0x%x\n", ioread32(hcr_base + CC));
905 VPRINTK("cereg = 0x%x\n", ioread32(hcr_base + CE));
914 static void sata_fsl_error_handler(struct ata_port *ap)
917 DPRINTK("in xx_error_handler\n");
919 /* perform recovery */
920 ata_do_eh(ap, ata_std_prereset, sata_fsl_softreset, sata_std_hardreset,
924 static void sata_fsl_post_internal_cmd(struct ata_queued_cmd *qc)
926 if (qc->flags & ATA_QCFLAG_FAILED)
927 qc->err_mask |= AC_ERR_OTHER;
930 /* make DMA engine forget about the failed command */
935 static void sata_fsl_irq_clear(struct ata_port *ap)
940 static void sata_fsl_error_intr(struct ata_port *ap)
942 struct ata_link *link = &ap->link;
943 struct ata_eh_info *ehi = &link->eh_info;
944 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
945 void __iomem *hcr_base = host_priv->hcr_base;
946 u32 hstatus, dereg, cereg = 0, SError = 0;
947 unsigned int err_mask = 0, action = 0;
948 struct ata_queued_cmd *qc;
951 hstatus = ioread32(hcr_base + HSTATUS);
952 cereg = ioread32(hcr_base + CE);
954 ata_ehi_clear_desc(ehi);
957 * Handle & Clear SError
960 sata_fsl_scr_read(ap, SCR_ERROR, &SError);
961 if (unlikely(SError & 0xFFFF0000)) {
962 sata_fsl_scr_write(ap, SCR_ERROR, SError);
963 err_mask |= AC_ERR_ATA_BUS;
966 DPRINTK("error_intr,hStat=0x%x,CE=0x%x,DE =0x%x,SErr=0x%x\n",
967 hstatus, cereg, ioread32(hcr_base + DE), SError);
969 /* handle single device errors */
972 * clear the command error, also clears queue to the device
973 * in error, and we can (re)issue commands to this device.
974 * When a device is in error all commands queued into the
975 * host controller and at the device are considered aborted
976 * and the queue for that device is stopped. Now, after
977 * clearing the device error, we can issue commands to the
978 * device to interrogate it to find the source of the error.
980 dereg = ioread32(hcr_base + DE);
981 iowrite32(dereg, hcr_base + DE);
982 iowrite32(cereg, hcr_base + CE);
984 DPRINTK("single device error, CE=0x%x, DE=0x%x\n",
985 ioread32(hcr_base + CE), ioread32(hcr_base + DE));
987 * We should consider this as non fatal error, and TF must
988 * be updated as done below.
991 err_mask |= AC_ERR_DEV;
994 /* handle fatal errors */
995 if (hstatus & FATAL_ERROR_DECODE) {
996 err_mask |= AC_ERR_ATA_BUS;
997 action |= ATA_EH_SOFTRESET;
998 /* how will fatal error interrupts be completed ?? */
1002 /* Handle PHYRDY change notification */
1003 if (hstatus & INT_ON_PHYRDY_CHG) {
1004 DPRINTK("SATA FSL: PHYRDY change indication\n");
1006 /* Setup a soft-reset EH action */
1007 ata_ehi_hotplugged(ehi);
1011 /* record error info */
1012 qc = ata_qc_from_tag(ap, link->active_tag);
1015 sata_fsl_cache_taskfile_from_d2h_fis(qc, qc->ap);
1016 qc->err_mask |= err_mask;
1018 ehi->err_mask |= err_mask;
1020 ehi->action |= action;
1021 ehi->serror |= SError;
1023 /* freeze or abort */
1025 ata_port_freeze(ap);
1030 static void sata_fsl_qc_complete(struct ata_queued_cmd *qc)
1032 if (qc->flags & ATA_QCFLAG_RESULT_TF) {
1033 DPRINTK("xx_qc_complete called\n");
1034 sata_fsl_cache_taskfile_from_d2h_fis(qc, qc->ap);
1038 static void sata_fsl_host_intr(struct ata_port *ap)
1040 struct ata_link *link = &ap->link;
1041 struct sata_fsl_host_priv *host_priv = ap->host->private_data;
1042 void __iomem *hcr_base = host_priv->hcr_base;
1043 u32 hstatus, qc_active = 0;
1044 struct ata_queued_cmd *qc;
1047 hstatus = ioread32(hcr_base + HSTATUS);
1049 sata_fsl_scr_read(ap, SCR_ERROR, &SError);
1051 if (unlikely(SError & 0xFFFF0000)) {
1052 DPRINTK("serror @host_intr : 0x%x\n", SError);
1053 sata_fsl_error_intr(ap);
1057 if (unlikely(hstatus & INT_ON_ERROR)) {
1058 DPRINTK("error interrupt!!\n");
1059 sata_fsl_error_intr(ap);
1063 if (link->sactive) { /* only true for NCQ commands */
1065 /* Read command completed register */
1066 qc_active = ioread32(hcr_base + CC);
1067 /* clear CC bit, this will also complete the interrupt */
1068 iowrite32(qc_active, hcr_base + CC);
1070 DPRINTK("Status of all queues :\n");
1071 DPRINTK("qc_active/CC = 0x%x, CA = 0x%x, CE=0x%x\n",
1072 qc_active, ioread32(hcr_base + CA),
1073 ioread32(hcr_base + CE));
1075 for (i = 0; i < SATA_FSL_QUEUE_DEPTH; i++) {
1076 if (qc_active & (1 << i)) {
1077 qc = ata_qc_from_tag(ap, i);
1079 sata_fsl_qc_complete(qc);
1080 ata_qc_complete(qc);
1083 ("completing ncq cmd,tag=%d,CC=0x%x,CA=0x%x\n",
1084 i, ioread32(hcr_base + CC),
1085 ioread32(hcr_base + CA));
1090 } else if (ap->qc_active) {
1091 iowrite32(1, hcr_base + CC);
1092 qc = ata_qc_from_tag(ap, link->active_tag);
1094 DPRINTK("completing non-ncq cmd, tag=%d,CC=0x%x\n",
1095 link->active_tag, ioread32(hcr_base + CC));
1098 sata_fsl_qc_complete(qc);
1099 ata_qc_complete(qc);
1102 /* Spurious Interrupt!! */
1103 DPRINTK("spurious interrupt!!, CC = 0x%x\n",
1104 ioread32(hcr_base + CC));
1109 static irqreturn_t sata_fsl_interrupt(int irq, void *dev_instance)
1111 struct ata_host *host = dev_instance;
1112 struct sata_fsl_host_priv *host_priv = host->private_data;
1113 void __iomem *hcr_base = host_priv->hcr_base;
1114 u32 interrupt_enables;
1115 unsigned handled = 0;
1116 struct ata_port *ap;
1118 /* ack. any pending IRQs for this controller/port */
1119 interrupt_enables = ioread32(hcr_base + HSTATUS);
1120 interrupt_enables &= 0x3F;
1122 DPRINTK("interrupt status 0x%x\n", interrupt_enables);
1124 if (!interrupt_enables)
1127 spin_lock(&host->lock);
1129 /* Assuming one port per host controller */
1131 ap = host->ports[0];
1133 sata_fsl_host_intr(ap);
1135 dev_printk(KERN_WARNING, host->dev,
1136 "interrupt on disabled port 0\n");
1139 iowrite32(interrupt_enables, hcr_base + HSTATUS);
1142 spin_unlock(&host->lock);
1144 return IRQ_RETVAL(handled);
1148 * Multiple ports are represented by multiple SATA controllers with
1149 * one port per controller
1151 static int sata_fsl_init_controller(struct ata_host *host)
1153 struct sata_fsl_host_priv *host_priv = host->private_data;
1154 void __iomem *hcr_base = host_priv->hcr_base;
1158 * NOTE : We cannot bring the controller online before setting
1159 * the CHBA, hence main controller initialization is done as
1160 * part of the port_start() callback
1163 /* ack. any pending IRQs for this controller/port */
1164 temp = ioread32(hcr_base + HSTATUS);
1166 iowrite32((temp & 0x3F), hcr_base + HSTATUS);
1168 /* Keep interrupts disabled on the controller */
1169 temp = ioread32(hcr_base + HCONTROL);
1170 iowrite32((temp & ~0x3F), hcr_base + HCONTROL);
1172 /* Disable interrupt coalescing control(icc), for the moment */
1173 DPRINTK("icc = 0x%x\n", ioread32(hcr_base + ICC));
1174 iowrite32(0x01000000, hcr_base + ICC);
1176 /* clear error registers, SError is cleared by libATA */
1177 iowrite32(0x00000FFFF, hcr_base + CE);
1178 iowrite32(0x00000FFFF, hcr_base + DE);
1180 /* initially assuming no Port multiplier, set CQPMP to 0 */
1181 iowrite32(0x0, hcr_base + CQPMP);
1184 * host controller will be brought on-line, during xx_port_start()
1185 * callback, that should also initiate the OOB, COMINIT sequence
1188 DPRINTK("HStatus = 0x%x\n", ioread32(hcr_base + HSTATUS));
1189 DPRINTK("HControl = 0x%x\n", ioread32(hcr_base + HCONTROL));
1195 * scsi mid-layer and libata interface structures
1197 static struct scsi_host_template sata_fsl_sht = {
1198 .module = THIS_MODULE,
1200 .ioctl = ata_scsi_ioctl,
1201 .queuecommand = ata_scsi_queuecmd,
1202 .change_queue_depth = ata_scsi_change_queue_depth,
1203 .can_queue = SATA_FSL_QUEUE_DEPTH,
1204 .this_id = ATA_SHT_THIS_ID,
1205 .sg_tablesize = SATA_FSL_MAX_PRD_USABLE,
1206 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
1207 .emulated = ATA_SHT_EMULATED,
1208 .use_clustering = ATA_SHT_USE_CLUSTERING,
1209 .proc_name = "sata_fsl",
1210 .dma_boundary = ATA_DMA_BOUNDARY,
1211 .slave_configure = ata_scsi_slave_config,
1212 .slave_destroy = ata_scsi_slave_destroy,
1213 .bios_param = ata_std_bios_param,
1216 static const struct ata_port_operations sata_fsl_ops = {
1217 .check_status = sata_fsl_check_status,
1218 .check_altstatus = sata_fsl_check_status,
1219 .dev_select = ata_noop_dev_select,
1221 .tf_read = sata_fsl_tf_read,
1223 .qc_prep = sata_fsl_qc_prep,
1224 .qc_issue = sata_fsl_qc_issue,
1225 .irq_clear = sata_fsl_irq_clear,
1227 .scr_read = sata_fsl_scr_read,
1228 .scr_write = sata_fsl_scr_write,
1230 .freeze = sata_fsl_freeze,
1231 .thaw = sata_fsl_thaw,
1232 .error_handler = sata_fsl_error_handler,
1233 .post_internal_cmd = sata_fsl_post_internal_cmd,
1235 .port_start = sata_fsl_port_start,
1236 .port_stop = sata_fsl_port_stop,
1239 static const struct ata_port_info sata_fsl_port_info[] = {
1241 .flags = SATA_FSL_HOST_FLAGS,
1242 .link_flags = SATA_FSL_HOST_LFLAGS,
1243 .pio_mask = 0x1f, /* pio 0-4 */
1244 .udma_mask = 0x7f, /* udma 0-6 */
1245 .port_ops = &sata_fsl_ops,
1249 static int sata_fsl_probe(struct of_device *ofdev,
1250 const struct of_device_id *match)
1253 void __iomem *hcr_base = NULL;
1254 void __iomem *ssr_base = NULL;
1255 void __iomem *csr_base = NULL;
1256 struct sata_fsl_host_priv *host_priv = NULL;
1259 struct ata_host *host;
1261 struct ata_port_info pi = sata_fsl_port_info[0];
1262 const struct ata_port_info *ppi[] = { &pi, NULL };
1264 dev_printk(KERN_INFO, &ofdev->dev,
1265 "Sata FSL Platform/CSB Driver init\n");
1267 r = kmalloc(sizeof(struct resource), GFP_KERNEL);
1269 hcr_base = of_iomap(ofdev->node, 0);
1271 goto error_exit_with_cleanup;
1273 ssr_base = hcr_base + 0x100;
1274 csr_base = hcr_base + 0x140;
1276 DPRINTK("@reset i/o = 0x%x\n", ioread32(csr_base + TRANSCFG));
1277 DPRINTK("sizeof(cmd_desc) = %d\n", sizeof(struct command_desc));
1278 DPRINTK("sizeof(#define cmd_desc) = %d\n", SATA_FSL_CMD_DESC_SIZE);
1280 host_priv = kzalloc(sizeof(struct sata_fsl_host_priv), GFP_KERNEL);
1282 goto error_exit_with_cleanup;
1284 host_priv->hcr_base = hcr_base;
1285 host_priv->ssr_base = ssr_base;
1286 host_priv->csr_base = csr_base;
1288 irq = irq_of_parse_and_map(ofdev->node, 0);
1290 dev_printk(KERN_ERR, &ofdev->dev, "invalid irq from platform\n");
1291 goto error_exit_with_cleanup;
1293 host_priv->irq = irq;
1295 /* allocate host structure */
1296 host = ata_host_alloc_pinfo(&ofdev->dev, ppi, SATA_FSL_MAX_PORTS);
1298 /* host->iomap is not used currently */
1299 host->private_data = host_priv;
1303 host->ports[0]->ioaddr.cmd_addr = host_priv->hcr_base;
1304 host->ports[0]->ioaddr.scr_addr = host_priv->ssr_base;
1306 /* initialize host controller */
1307 sata_fsl_init_controller(host);
1310 * Now, register with libATA core, this will also initiate the
1311 * device discovery process, invoking our port_start() handler &
1312 * error_handler() to execute a dummy Softreset EH session
1314 ata_host_activate(host, irq, sata_fsl_interrupt, SATA_FSL_IRQ_FLAG,
1317 dev_set_drvdata(&ofdev->dev, host);
1321 error_exit_with_cleanup:
1331 static int sata_fsl_remove(struct of_device *ofdev)
1333 struct ata_host *host = dev_get_drvdata(&ofdev->dev);
1334 struct sata_fsl_host_priv *host_priv = host->private_data;
1336 ata_host_detach(host);
1338 dev_set_drvdata(&ofdev->dev, NULL);
1340 irq_dispose_mapping(host_priv->irq);
1341 iounmap(host_priv->hcr_base);
1347 static struct of_device_id fsl_sata_match[] = {
1349 .compatible = "fsl,mpc8315-sata",
1352 .compatible = "fsl,mpc8379-sata",
1357 MODULE_DEVICE_TABLE(of, fsl_sata_match);
1359 static struct of_platform_driver fsl_sata_driver = {
1361 .match_table = fsl_sata_match,
1362 .probe = sata_fsl_probe,
1363 .remove = sata_fsl_remove,
1366 static int __init sata_fsl_init(void)
1368 of_register_platform_driver(&fsl_sata_driver);
1372 static void __exit sata_fsl_exit(void)
1374 of_unregister_platform_driver(&fsl_sata_driver);
1377 MODULE_LICENSE("GPL");
1378 MODULE_AUTHOR("Ashish Kalra, Freescale Semiconductor");
1379 MODULE_DESCRIPTION("Freescale 3.0Gbps SATA controller low level driver");
1380 MODULE_VERSION("1.10");
1382 module_init(sata_fsl_init);
1383 module_exit(sata_fsl_exit);