2 * ahci.c - AHCI SATA support
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2004-2005 Red Hat, Inc.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2, or (at your option)
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; see the file COPYING. If not, write to
23 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 * libata documentation is available via 'make {ps|pdf}docs',
27 * as Documentation/DocBook/libata.*
29 * AHCI hardware documentation:
30 * http://www.intel.com/technology/serialata/pdf/rev1_0.pdf
31 * http://www.intel.com/technology/serialata/pdf/rev1_1.pdf
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/pci.h>
38 #include <linux/init.h>
39 #include <linux/blkdev.h>
40 #include <linux/delay.h>
41 #include <linux/interrupt.h>
42 #include <linux/sched.h>
43 #include <linux/dma-mapping.h>
44 #include <linux/device.h>
45 #include <scsi/scsi_host.h>
46 #include <scsi/scsi_cmnd.h>
47 #include <linux/libata.h>
50 #define DRV_NAME "ahci"
51 #define DRV_VERSION "1.3"
56 AHCI_MAX_SG = 168, /* hardware max is 64K */
57 AHCI_DMA_BOUNDARY = 0xffffffff,
58 AHCI_USE_CLUSTERING = 0,
61 AHCI_CMD_SLOT_SZ = 32 * AHCI_CMD_SZ,
63 AHCI_CMD_TBL_CDB = 0x40,
64 AHCI_CMD_TBL_HDR_SZ = 0x80,
65 AHCI_CMD_TBL_SZ = AHCI_CMD_TBL_HDR_SZ + (AHCI_MAX_SG * 16),
66 AHCI_CMD_TBL_AR_SZ = AHCI_CMD_TBL_SZ * AHCI_MAX_CMDS,
67 AHCI_PORT_PRIV_DMA_SZ = AHCI_CMD_SLOT_SZ + AHCI_CMD_TBL_AR_SZ +
69 AHCI_IRQ_ON_SG = (1 << 31),
70 AHCI_CMD_ATAPI = (1 << 5),
71 AHCI_CMD_WRITE = (1 << 6),
72 AHCI_CMD_PREFETCH = (1 << 7),
73 AHCI_CMD_RESET = (1 << 8),
74 AHCI_CMD_CLR_BUSY = (1 << 10),
76 RX_FIS_D2H_REG = 0x40, /* offset of D2H Register FIS data */
77 RX_FIS_UNK = 0x60, /* offset of Unknown FIS data */
80 board_ahci_vt8251 = 1,
82 /* global controller registers */
83 HOST_CAP = 0x00, /* host capabilities */
84 HOST_CTL = 0x04, /* global host control */
85 HOST_IRQ_STAT = 0x08, /* interrupt status */
86 HOST_PORTS_IMPL = 0x0c, /* bitmap of implemented ports */
87 HOST_VERSION = 0x10, /* AHCI spec. version compliancy */
90 HOST_RESET = (1 << 0), /* reset controller; self-clear */
91 HOST_IRQ_EN = (1 << 1), /* global IRQ enable */
92 HOST_AHCI_EN = (1 << 31), /* AHCI enabled */
95 HOST_CAP_CLO = (1 << 24), /* Command List Override support */
96 HOST_CAP_64 = (1 << 31), /* PCI DAC (64-bit DMA) support */
98 /* registers for each SATA port */
99 PORT_LST_ADDR = 0x00, /* command list DMA addr */
100 PORT_LST_ADDR_HI = 0x04, /* command list DMA addr hi */
101 PORT_FIS_ADDR = 0x08, /* FIS rx buf addr */
102 PORT_FIS_ADDR_HI = 0x0c, /* FIS rx buf addr hi */
103 PORT_IRQ_STAT = 0x10, /* interrupt status */
104 PORT_IRQ_MASK = 0x14, /* interrupt enable/disable mask */
105 PORT_CMD = 0x18, /* port command */
106 PORT_TFDATA = 0x20, /* taskfile data */
107 PORT_SIG = 0x24, /* device TF signature */
108 PORT_CMD_ISSUE = 0x38, /* command issue */
109 PORT_SCR = 0x28, /* SATA phy register block */
110 PORT_SCR_STAT = 0x28, /* SATA phy register: SStatus */
111 PORT_SCR_CTL = 0x2c, /* SATA phy register: SControl */
112 PORT_SCR_ERR = 0x30, /* SATA phy register: SError */
113 PORT_SCR_ACT = 0x34, /* SATA phy register: SActive */
115 /* PORT_IRQ_{STAT,MASK} bits */
116 PORT_IRQ_COLD_PRES = (1 << 31), /* cold presence detect */
117 PORT_IRQ_TF_ERR = (1 << 30), /* task file error */
118 PORT_IRQ_HBUS_ERR = (1 << 29), /* host bus fatal error */
119 PORT_IRQ_HBUS_DATA_ERR = (1 << 28), /* host bus data error */
120 PORT_IRQ_IF_ERR = (1 << 27), /* interface fatal error */
121 PORT_IRQ_IF_NONFATAL = (1 << 26), /* interface non-fatal error */
122 PORT_IRQ_OVERFLOW = (1 << 24), /* xfer exhausted available S/G */
123 PORT_IRQ_BAD_PMP = (1 << 23), /* incorrect port multiplier */
125 PORT_IRQ_PHYRDY = (1 << 22), /* PhyRdy changed */
126 PORT_IRQ_DEV_ILCK = (1 << 7), /* device interlock */
127 PORT_IRQ_CONNECT = (1 << 6), /* port connect change status */
128 PORT_IRQ_SG_DONE = (1 << 5), /* descriptor processed */
129 PORT_IRQ_UNK_FIS = (1 << 4), /* unknown FIS rx'd */
130 PORT_IRQ_SDB_FIS = (1 << 3), /* Set Device Bits FIS rx'd */
131 PORT_IRQ_DMAS_FIS = (1 << 2), /* DMA Setup FIS rx'd */
132 PORT_IRQ_PIOS_FIS = (1 << 1), /* PIO Setup FIS rx'd */
133 PORT_IRQ_D2H_REG_FIS = (1 << 0), /* D2H Register FIS rx'd */
135 PORT_IRQ_FREEZE = PORT_IRQ_HBUS_ERR |
139 PORT_IRQ_ERROR = PORT_IRQ_FREEZE |
141 PORT_IRQ_HBUS_DATA_ERR,
142 DEF_PORT_IRQ = PORT_IRQ_ERROR | PORT_IRQ_SG_DONE |
143 PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS |
144 PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS,
147 PORT_CMD_ATAPI = (1 << 24), /* Device is ATAPI */
148 PORT_CMD_LIST_ON = (1 << 15), /* cmd list DMA engine running */
149 PORT_CMD_FIS_ON = (1 << 14), /* FIS DMA engine running */
150 PORT_CMD_FIS_RX = (1 << 4), /* Enable FIS receive DMA engine */
151 PORT_CMD_CLO = (1 << 3), /* Command list override */
152 PORT_CMD_POWER_ON = (1 << 2), /* Power up device */
153 PORT_CMD_SPIN_UP = (1 << 1), /* Spin up device */
154 PORT_CMD_START = (1 << 0), /* Enable port DMA engine */
156 PORT_CMD_ICC_ACTIVE = (0x1 << 28), /* Put i/f in active state */
157 PORT_CMD_ICC_PARTIAL = (0x2 << 28), /* Put i/f in partial state */
158 PORT_CMD_ICC_SLUMBER = (0x6 << 28), /* Put i/f in slumber state */
160 /* hpriv->flags bits */
161 AHCI_FLAG_MSI = (1 << 0),
164 AHCI_FLAG_RESET_NEEDS_CLO = (1 << 24),
167 struct ahci_cmd_hdr {
182 struct ahci_host_priv {
184 u32 cap; /* cache of HOST_CAP register */
185 u32 port_map; /* cache of HOST_PORTS_IMPL reg */
188 struct ahci_port_priv {
189 struct ahci_cmd_hdr *cmd_slot;
190 dma_addr_t cmd_slot_dma;
192 dma_addr_t cmd_tbl_dma;
193 struct ahci_sg *cmd_tbl_sg;
195 dma_addr_t rx_fis_dma;
198 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg);
199 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
200 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
201 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc);
202 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
203 static int ahci_probe_reset(struct ata_port *ap, unsigned int *classes);
204 static void ahci_irq_clear(struct ata_port *ap);
205 static int ahci_port_start(struct ata_port *ap);
206 static void ahci_port_stop(struct ata_port *ap);
207 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
208 static void ahci_qc_prep(struct ata_queued_cmd *qc);
209 static u8 ahci_check_status(struct ata_port *ap);
210 static void ahci_freeze(struct ata_port *ap);
211 static void ahci_thaw(struct ata_port *ap);
212 static void ahci_error_handler(struct ata_port *ap);
213 static void ahci_post_internal_cmd(struct ata_queued_cmd *qc);
214 static void ahci_remove_one (struct pci_dev *pdev);
216 static struct scsi_host_template ahci_sht = {
217 .module = THIS_MODULE,
219 .ioctl = ata_scsi_ioctl,
220 .queuecommand = ata_scsi_queuecmd,
221 .can_queue = ATA_DEF_QUEUE,
222 .this_id = ATA_SHT_THIS_ID,
223 .sg_tablesize = AHCI_MAX_SG,
224 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
225 .emulated = ATA_SHT_EMULATED,
226 .use_clustering = AHCI_USE_CLUSTERING,
227 .proc_name = DRV_NAME,
228 .dma_boundary = AHCI_DMA_BOUNDARY,
229 .slave_configure = ata_scsi_slave_config,
230 .bios_param = ata_std_bios_param,
233 static const struct ata_port_operations ahci_ops = {
234 .port_disable = ata_port_disable,
236 .check_status = ahci_check_status,
237 .check_altstatus = ahci_check_status,
238 .dev_select = ata_noop_dev_select,
240 .tf_read = ahci_tf_read,
242 .probe_reset = ahci_probe_reset,
244 .qc_prep = ahci_qc_prep,
245 .qc_issue = ahci_qc_issue,
247 .irq_handler = ahci_interrupt,
248 .irq_clear = ahci_irq_clear,
250 .scr_read = ahci_scr_read,
251 .scr_write = ahci_scr_write,
253 .freeze = ahci_freeze,
256 .error_handler = ahci_error_handler,
257 .post_internal_cmd = ahci_post_internal_cmd,
259 .port_start = ahci_port_start,
260 .port_stop = ahci_port_stop,
263 static const struct ata_port_info ahci_port_info[] = {
267 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
268 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA,
269 .pio_mask = 0x1f, /* pio0-4 */
270 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
271 .port_ops = &ahci_ops,
273 /* board_ahci_vt8251 */
276 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
277 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA |
278 AHCI_FLAG_RESET_NEEDS_CLO,
279 .pio_mask = 0x1f, /* pio0-4 */
280 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
281 .port_ops = &ahci_ops,
285 static const struct pci_device_id ahci_pci_tbl[] = {
286 { PCI_VENDOR_ID_INTEL, 0x2652, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
287 board_ahci }, /* ICH6 */
288 { PCI_VENDOR_ID_INTEL, 0x2653, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
289 board_ahci }, /* ICH6M */
290 { PCI_VENDOR_ID_INTEL, 0x27c1, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
291 board_ahci }, /* ICH7 */
292 { PCI_VENDOR_ID_INTEL, 0x27c5, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
293 board_ahci }, /* ICH7M */
294 { PCI_VENDOR_ID_INTEL, 0x27c3, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
295 board_ahci }, /* ICH7R */
296 { PCI_VENDOR_ID_AL, 0x5288, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
297 board_ahci }, /* ULi M5288 */
298 { PCI_VENDOR_ID_INTEL, 0x2681, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
299 board_ahci }, /* ESB2 */
300 { PCI_VENDOR_ID_INTEL, 0x2682, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
301 board_ahci }, /* ESB2 */
302 { PCI_VENDOR_ID_INTEL, 0x2683, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
303 board_ahci }, /* ESB2 */
304 { PCI_VENDOR_ID_INTEL, 0x27c6, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
305 board_ahci }, /* ICH7-M DH */
306 { PCI_VENDOR_ID_INTEL, 0x2821, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
307 board_ahci }, /* ICH8 */
308 { PCI_VENDOR_ID_INTEL, 0x2822, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
309 board_ahci }, /* ICH8 */
310 { PCI_VENDOR_ID_INTEL, 0x2824, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
311 board_ahci }, /* ICH8 */
312 { PCI_VENDOR_ID_INTEL, 0x2829, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
313 board_ahci }, /* ICH8M */
314 { PCI_VENDOR_ID_INTEL, 0x282a, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
315 board_ahci }, /* ICH8M */
316 { 0x197b, 0x2360, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
317 board_ahci }, /* JMicron JMB360 */
318 { 0x197b, 0x2363, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
319 board_ahci }, /* JMicron JMB363 */
320 { PCI_VENDOR_ID_ATI, 0x4380, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
321 board_ahci }, /* ATI SB600 non-raid */
322 { PCI_VENDOR_ID_ATI, 0x4381, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
323 board_ahci }, /* ATI SB600 raid */
324 { PCI_VENDOR_ID_VIA, 0x3349, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
325 board_ahci_vt8251 }, /* VIA VT8251 */
326 { } /* terminate list */
330 static struct pci_driver ahci_pci_driver = {
332 .id_table = ahci_pci_tbl,
333 .probe = ahci_init_one,
334 .remove = ahci_remove_one,
338 static inline unsigned long ahci_port_base_ul (unsigned long base, unsigned int port)
340 return base + 0x100 + (port * 0x80);
343 static inline void __iomem *ahci_port_base (void __iomem *base, unsigned int port)
345 return (void __iomem *) ahci_port_base_ul((unsigned long)base, port);
348 static int ahci_port_start(struct ata_port *ap)
350 struct device *dev = ap->host_set->dev;
351 struct ahci_host_priv *hpriv = ap->host_set->private_data;
352 struct ahci_port_priv *pp;
353 void __iomem *mmio = ap->host_set->mmio_base;
354 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
359 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
362 memset(pp, 0, sizeof(*pp));
364 rc = ata_pad_alloc(ap, dev);
370 mem = dma_alloc_coherent(dev, AHCI_PORT_PRIV_DMA_SZ, &mem_dma, GFP_KERNEL);
372 ata_pad_free(ap, dev);
376 memset(mem, 0, AHCI_PORT_PRIV_DMA_SZ);
379 * First item in chunk of DMA memory: 32-slot command table,
380 * 32 bytes each in size
383 pp->cmd_slot_dma = mem_dma;
385 mem += AHCI_CMD_SLOT_SZ;
386 mem_dma += AHCI_CMD_SLOT_SZ;
389 * Second item: Received-FIS area
392 pp->rx_fis_dma = mem_dma;
394 mem += AHCI_RX_FIS_SZ;
395 mem_dma += AHCI_RX_FIS_SZ;
398 * Third item: data area for storing a single command
399 * and its scatter-gather table
402 pp->cmd_tbl_dma = mem_dma;
404 pp->cmd_tbl_sg = mem + AHCI_CMD_TBL_HDR_SZ;
406 ap->private_data = pp;
408 if (hpriv->cap & HOST_CAP_64)
409 writel((pp->cmd_slot_dma >> 16) >> 16, port_mmio + PORT_LST_ADDR_HI);
410 writel(pp->cmd_slot_dma & 0xffffffff, port_mmio + PORT_LST_ADDR);
411 readl(port_mmio + PORT_LST_ADDR); /* flush */
413 if (hpriv->cap & HOST_CAP_64)
414 writel((pp->rx_fis_dma >> 16) >> 16, port_mmio + PORT_FIS_ADDR_HI);
415 writel(pp->rx_fis_dma & 0xffffffff, port_mmio + PORT_FIS_ADDR);
416 readl(port_mmio + PORT_FIS_ADDR); /* flush */
418 writel(PORT_CMD_ICC_ACTIVE | PORT_CMD_FIS_RX |
419 PORT_CMD_POWER_ON | PORT_CMD_SPIN_UP |
420 PORT_CMD_START, port_mmio + PORT_CMD);
421 readl(port_mmio + PORT_CMD); /* flush */
427 static void ahci_port_stop(struct ata_port *ap)
429 struct device *dev = ap->host_set->dev;
430 struct ahci_port_priv *pp = ap->private_data;
431 void __iomem *mmio = ap->host_set->mmio_base;
432 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
435 tmp = readl(port_mmio + PORT_CMD);
436 tmp &= ~(PORT_CMD_START | PORT_CMD_FIS_RX);
437 writel(tmp, port_mmio + PORT_CMD);
438 readl(port_mmio + PORT_CMD); /* flush */
440 /* spec says 500 msecs for each PORT_CMD_{START,FIS_RX} bit, so
441 * this is slightly incorrect.
445 ap->private_data = NULL;
446 dma_free_coherent(dev, AHCI_PORT_PRIV_DMA_SZ,
447 pp->cmd_slot, pp->cmd_slot_dma);
448 ata_pad_free(ap, dev);
452 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg_in)
457 case SCR_STATUS: sc_reg = 0; break;
458 case SCR_CONTROL: sc_reg = 1; break;
459 case SCR_ERROR: sc_reg = 2; break;
460 case SCR_ACTIVE: sc_reg = 3; break;
465 return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
469 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg_in,
475 case SCR_STATUS: sc_reg = 0; break;
476 case SCR_CONTROL: sc_reg = 1; break;
477 case SCR_ERROR: sc_reg = 2; break;
478 case SCR_ACTIVE: sc_reg = 3; break;
483 writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
486 static int ahci_stop_engine(struct ata_port *ap)
488 void __iomem *mmio = ap->host_set->mmio_base;
489 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
493 tmp = readl(port_mmio + PORT_CMD);
494 tmp &= ~PORT_CMD_START;
495 writel(tmp, port_mmio + PORT_CMD);
497 /* wait for engine to stop. TODO: this could be
498 * as long as 500 msec
502 tmp = readl(port_mmio + PORT_CMD);
503 if ((tmp & PORT_CMD_LIST_ON) == 0)
511 static void ahci_start_engine(struct ata_port *ap)
513 void __iomem *mmio = ap->host_set->mmio_base;
514 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
517 tmp = readl(port_mmio + PORT_CMD);
518 tmp |= PORT_CMD_START;
519 writel(tmp, port_mmio + PORT_CMD);
520 readl(port_mmio + PORT_CMD); /* flush */
523 static unsigned int ahci_dev_classify(struct ata_port *ap)
525 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
526 struct ata_taskfile tf;
529 tmp = readl(port_mmio + PORT_SIG);
530 tf.lbah = (tmp >> 24) & 0xff;
531 tf.lbam = (tmp >> 16) & 0xff;
532 tf.lbal = (tmp >> 8) & 0xff;
533 tf.nsect = (tmp) & 0xff;
535 return ata_dev_classify(&tf);
538 static void ahci_fill_cmd_slot(struct ahci_port_priv *pp, u32 opts)
540 pp->cmd_slot[0].opts = cpu_to_le32(opts);
541 pp->cmd_slot[0].status = 0;
542 pp->cmd_slot[0].tbl_addr = cpu_to_le32(pp->cmd_tbl_dma & 0xffffffff);
543 pp->cmd_slot[0].tbl_addr_hi = cpu_to_le32((pp->cmd_tbl_dma >> 16) >> 16);
546 static int ahci_clo(struct ata_port *ap)
548 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
549 struct ahci_host_priv *hpriv = ap->host_set->private_data;
552 if (!(hpriv->cap & HOST_CAP_CLO))
555 tmp = readl(port_mmio + PORT_CMD);
557 writel(tmp, port_mmio + PORT_CMD);
559 tmp = ata_wait_register(port_mmio + PORT_CMD,
560 PORT_CMD_CLO, PORT_CMD_CLO, 1, 500);
561 if (tmp & PORT_CMD_CLO)
567 static int ahci_softreset(struct ata_port *ap, unsigned int *class)
569 struct ahci_port_priv *pp = ap->private_data;
570 void __iomem *mmio = ap->host_set->mmio_base;
571 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
572 const u32 cmd_fis_len = 5; /* five dwords */
573 const char *reason = NULL;
574 struct ata_taskfile tf;
581 if (ata_port_offline(ap)) {
582 DPRINTK("PHY reports no device\n");
583 *class = ATA_DEV_NONE;
587 /* prepare for SRST (AHCI-1.1 10.4.1) */
588 rc = ahci_stop_engine(ap);
590 reason = "failed to stop engine";
594 /* check BUSY/DRQ, perform Command List Override if necessary */
595 ahci_tf_read(ap, &tf);
596 if (tf.command & (ATA_BUSY | ATA_DRQ)) {
599 if (rc == -EOPNOTSUPP) {
600 reason = "port busy but CLO unavailable";
603 reason = "port busy but CLO failed";
609 ahci_start_engine(ap);
611 ata_tf_init(ap->device, &tf);
614 /* issue the first D2H Register FIS */
615 ahci_fill_cmd_slot(pp, cmd_fis_len | AHCI_CMD_RESET | AHCI_CMD_CLR_BUSY);
618 ata_tf_to_fis(&tf, fis, 0);
619 fis[1] &= ~(1 << 7); /* turn off Command FIS bit */
621 writel(1, port_mmio + PORT_CMD_ISSUE);
623 tmp = ata_wait_register(port_mmio + PORT_CMD_ISSUE, 0x1, 0x1, 1, 500);
626 reason = "1st FIS failed";
630 /* spec says at least 5us, but be generous and sleep for 1ms */
633 /* issue the second D2H Register FIS */
634 ahci_fill_cmd_slot(pp, cmd_fis_len);
637 ata_tf_to_fis(&tf, fis, 0);
638 fis[1] &= ~(1 << 7); /* turn off Command FIS bit */
640 writel(1, port_mmio + PORT_CMD_ISSUE);
641 readl(port_mmio + PORT_CMD_ISSUE); /* flush */
643 /* spec mandates ">= 2ms" before checking status.
644 * We wait 150ms, because that was the magic delay used for
645 * ATAPI devices in Hale Landis's ATADRVR, for the period of time
646 * between when the ATA command register is written, and then
647 * status is checked. Because waiting for "a while" before
648 * checking status is fine, post SRST, we perform this magic
649 * delay here as well.
653 *class = ATA_DEV_NONE;
654 if (ata_port_online(ap)) {
655 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
657 reason = "device not ready";
660 *class = ahci_dev_classify(ap);
663 DPRINTK("EXIT, class=%u\n", *class);
667 ahci_start_engine(ap);
669 ata_port_printk(ap, KERN_ERR, "softreset failed (%s)\n", reason);
673 static int ahci_hardreset(struct ata_port *ap, unsigned int *class)
679 ahci_stop_engine(ap);
680 rc = sata_std_hardreset(ap, class);
681 ahci_start_engine(ap);
683 if (rc == 0 && ata_port_online(ap))
684 *class = ahci_dev_classify(ap);
685 if (*class == ATA_DEV_UNKNOWN)
686 *class = ATA_DEV_NONE;
688 DPRINTK("EXIT, rc=%d, class=%u\n", rc, *class);
692 static void ahci_postreset(struct ata_port *ap, unsigned int *class)
694 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
697 ata_std_postreset(ap, class);
699 /* Make sure port's ATAPI bit is set appropriately */
700 new_tmp = tmp = readl(port_mmio + PORT_CMD);
701 if (*class == ATA_DEV_ATAPI)
702 new_tmp |= PORT_CMD_ATAPI;
704 new_tmp &= ~PORT_CMD_ATAPI;
705 if (new_tmp != tmp) {
706 writel(new_tmp, port_mmio + PORT_CMD);
707 readl(port_mmio + PORT_CMD); /* flush */
711 static int ahci_probe_reset(struct ata_port *ap, unsigned int *classes)
713 if ((ap->flags & AHCI_FLAG_RESET_NEEDS_CLO) &&
714 (ata_busy_wait(ap, ATA_BUSY, 1000) & ATA_BUSY)) {
715 /* ATA_BUSY hasn't cleared, so send a CLO */
719 return ata_drive_probe_reset(ap, ata_std_probeinit,
720 ahci_softreset, ahci_hardreset,
721 ahci_postreset, classes);
724 static u8 ahci_check_status(struct ata_port *ap)
726 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr;
728 return readl(mmio + PORT_TFDATA) & 0xFF;
731 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
733 struct ahci_port_priv *pp = ap->private_data;
734 u8 *d2h_fis = pp->rx_fis + RX_FIS_D2H_REG;
736 ata_tf_from_fis(d2h_fis, tf);
739 static unsigned int ahci_fill_sg(struct ata_queued_cmd *qc)
741 struct ahci_port_priv *pp = qc->ap->private_data;
742 struct scatterlist *sg;
743 struct ahci_sg *ahci_sg;
744 unsigned int n_sg = 0;
749 * Next, the S/G list.
751 ahci_sg = pp->cmd_tbl_sg;
752 ata_for_each_sg(sg, qc) {
753 dma_addr_t addr = sg_dma_address(sg);
754 u32 sg_len = sg_dma_len(sg);
756 ahci_sg->addr = cpu_to_le32(addr & 0xffffffff);
757 ahci_sg->addr_hi = cpu_to_le32((addr >> 16) >> 16);
758 ahci_sg->flags_size = cpu_to_le32(sg_len - 1);
767 static void ahci_qc_prep(struct ata_queued_cmd *qc)
769 struct ata_port *ap = qc->ap;
770 struct ahci_port_priv *pp = ap->private_data;
771 int is_atapi = is_atapi_taskfile(&qc->tf);
773 const u32 cmd_fis_len = 5; /* five dwords */
777 * Fill in command table information. First, the header,
778 * a SATA Register - Host to Device command FIS.
780 ata_tf_to_fis(&qc->tf, pp->cmd_tbl, 0);
782 memset(pp->cmd_tbl + AHCI_CMD_TBL_CDB, 0, 32);
783 memcpy(pp->cmd_tbl + AHCI_CMD_TBL_CDB, qc->cdb,
788 if (qc->flags & ATA_QCFLAG_DMAMAP)
789 n_elem = ahci_fill_sg(qc);
792 * Fill in command slot information.
794 opts = cmd_fis_len | n_elem << 16;
795 if (qc->tf.flags & ATA_TFLAG_WRITE)
796 opts |= AHCI_CMD_WRITE;
798 opts |= AHCI_CMD_ATAPI | AHCI_CMD_PREFETCH;
800 ahci_fill_cmd_slot(pp, opts);
803 static void ahci_error_intr(struct ata_port *ap, u32 irq_stat)
805 struct ahci_port_priv *pp = ap->private_data;
806 struct ata_eh_info *ehi = &ap->eh_info;
807 unsigned int err_mask = 0, action = 0;
808 struct ata_queued_cmd *qc;
811 ata_ehi_clear_desc(ehi);
813 /* AHCI needs SError cleared; otherwise, it might lock up */
814 serror = ahci_scr_read(ap, SCR_ERROR);
815 ahci_scr_write(ap, SCR_ERROR, serror);
817 /* analyze @irq_stat */
818 ata_ehi_push_desc(ehi, "irq_stat 0x%08x", irq_stat);
820 if (irq_stat & PORT_IRQ_TF_ERR)
821 err_mask |= AC_ERR_DEV;
823 if (irq_stat & (PORT_IRQ_HBUS_ERR | PORT_IRQ_HBUS_DATA_ERR)) {
824 err_mask |= AC_ERR_HOST_BUS;
825 action |= ATA_EH_SOFTRESET;
828 if (irq_stat & PORT_IRQ_IF_ERR) {
829 err_mask |= AC_ERR_ATA_BUS;
830 action |= ATA_EH_SOFTRESET;
831 ata_ehi_push_desc(ehi, ", interface fatal error");
834 if (irq_stat & (PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)) {
835 err_mask |= AC_ERR_ATA_BUS;
836 action |= ATA_EH_SOFTRESET;
837 ata_ehi_push_desc(ehi, ", %s", irq_stat & PORT_IRQ_CONNECT ?
838 "connection status changed" : "PHY RDY changed");
841 if (irq_stat & PORT_IRQ_UNK_FIS) {
842 u32 *unk = (u32 *)(pp->rx_fis + RX_FIS_UNK);
844 err_mask |= AC_ERR_HSM;
845 action |= ATA_EH_SOFTRESET;
846 ata_ehi_push_desc(ehi, ", unknown FIS %08x %08x %08x %08x",
847 unk[0], unk[1], unk[2], unk[3]);
850 /* okay, let's hand over to EH */
851 ehi->serror |= serror;
852 ehi->action |= action;
854 qc = ata_qc_from_tag(ap, ap->active_tag);
856 qc->err_mask |= err_mask;
858 ehi->err_mask |= err_mask;
860 if (irq_stat & PORT_IRQ_FREEZE)
866 static void ahci_host_intr(struct ata_port *ap)
868 void __iomem *mmio = ap->host_set->mmio_base;
869 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
870 struct ata_queued_cmd *qc;
873 status = readl(port_mmio + PORT_IRQ_STAT);
874 writel(status, port_mmio + PORT_IRQ_STAT);
876 if (unlikely(status & PORT_IRQ_ERROR)) {
877 ahci_error_intr(ap, status);
881 if ((qc = ata_qc_from_tag(ap, ap->active_tag))) {
882 ci = readl(port_mmio + PORT_CMD_ISSUE);
883 if ((ci & 0x1) == 0) {
889 /* hmmm... a spurious interupt */
891 /* ignore interim PIO setup fis interrupts */
892 if (ata_tag_valid(ap->active_tag)) {
893 struct ata_queued_cmd *qc =
894 ata_qc_from_tag(ap, ap->active_tag);
896 if (qc && qc->tf.protocol == ATA_PROT_PIO &&
897 (status & PORT_IRQ_PIOS_FIS))
902 ata_port_printk(ap, KERN_INFO, "spurious interrupt "
903 "(irq_stat 0x%x active_tag %d)\n",
904 status, ap->active_tag);
907 static void ahci_irq_clear(struct ata_port *ap)
912 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
914 struct ata_host_set *host_set = dev_instance;
915 struct ahci_host_priv *hpriv;
916 unsigned int i, handled = 0;
918 u32 irq_stat, irq_ack = 0;
922 hpriv = host_set->private_data;
923 mmio = host_set->mmio_base;
925 /* sigh. 0xffffffff is a valid return from h/w */
926 irq_stat = readl(mmio + HOST_IRQ_STAT);
927 irq_stat &= hpriv->port_map;
931 spin_lock(&host_set->lock);
933 for (i = 0; i < host_set->n_ports; i++) {
936 if (!(irq_stat & (1 << i)))
939 ap = host_set->ports[i];
942 VPRINTK("port %u\n", i);
944 VPRINTK("port %u (no irq)\n", i);
946 dev_printk(KERN_WARNING, host_set->dev,
947 "interrupt on disabled port %u\n", i);
954 writel(irq_ack, mmio + HOST_IRQ_STAT);
958 spin_unlock(&host_set->lock);
962 return IRQ_RETVAL(handled);
965 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc)
967 struct ata_port *ap = qc->ap;
968 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
970 writel(1, port_mmio + PORT_CMD_ISSUE);
971 readl(port_mmio + PORT_CMD_ISSUE); /* flush */
976 static void ahci_freeze(struct ata_port *ap)
978 void __iomem *mmio = ap->host_set->mmio_base;
979 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
982 writel(0, port_mmio + PORT_IRQ_MASK);
985 static void ahci_thaw(struct ata_port *ap)
987 void __iomem *mmio = ap->host_set->mmio_base;
988 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
992 tmp = readl(port_mmio + PORT_IRQ_STAT);
993 writel(tmp, port_mmio + PORT_IRQ_STAT);
994 writel(1 << ap->id, mmio + HOST_IRQ_STAT);
996 /* turn IRQ back on */
997 writel(DEF_PORT_IRQ, port_mmio + PORT_IRQ_MASK);
1000 static void ahci_error_handler(struct ata_port *ap)
1002 if (!(ap->flags & ATA_FLAG_FROZEN)) {
1003 /* restart engine */
1004 ahci_stop_engine(ap);
1005 ahci_start_engine(ap);
1008 /* perform recovery */
1009 ata_do_eh(ap, ahci_softreset, ahci_hardreset, ahci_postreset);
1012 static void ahci_post_internal_cmd(struct ata_queued_cmd *qc)
1014 struct ata_port *ap = qc->ap;
1016 if (qc->flags & ATA_QCFLAG_FAILED)
1017 qc->err_mask |= AC_ERR_OTHER;
1020 /* make DMA engine forget about the failed command */
1021 ahci_stop_engine(ap);
1022 ahci_start_engine(ap);
1026 static void ahci_setup_port(struct ata_ioports *port, unsigned long base,
1027 unsigned int port_idx)
1029 VPRINTK("ENTER, base==0x%lx, port_idx %u\n", base, port_idx);
1030 base = ahci_port_base_ul(base, port_idx);
1031 VPRINTK("base now==0x%lx\n", base);
1033 port->cmd_addr = base;
1034 port->scr_addr = base + PORT_SCR;
1039 static int ahci_host_init(struct ata_probe_ent *probe_ent)
1041 struct ahci_host_priv *hpriv = probe_ent->private_data;
1042 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
1043 void __iomem *mmio = probe_ent->mmio_base;
1045 unsigned int i, j, using_dac;
1047 void __iomem *port_mmio;
1049 cap_save = readl(mmio + HOST_CAP);
1050 cap_save &= ( (1<<28) | (1<<17) );
1051 cap_save |= (1 << 27);
1053 /* global controller reset */
1054 tmp = readl(mmio + HOST_CTL);
1055 if ((tmp & HOST_RESET) == 0) {
1056 writel(tmp | HOST_RESET, mmio + HOST_CTL);
1057 readl(mmio + HOST_CTL); /* flush */
1060 /* reset must complete within 1 second, or
1061 * the hardware should be considered fried.
1065 tmp = readl(mmio + HOST_CTL);
1066 if (tmp & HOST_RESET) {
1067 dev_printk(KERN_ERR, &pdev->dev,
1068 "controller reset failed (0x%x)\n", tmp);
1072 writel(HOST_AHCI_EN, mmio + HOST_CTL);
1073 (void) readl(mmio + HOST_CTL); /* flush */
1074 writel(cap_save, mmio + HOST_CAP);
1075 writel(0xf, mmio + HOST_PORTS_IMPL);
1076 (void) readl(mmio + HOST_PORTS_IMPL); /* flush */
1078 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
1081 pci_read_config_word(pdev, 0x92, &tmp16);
1083 pci_write_config_word(pdev, 0x92, tmp16);
1086 hpriv->cap = readl(mmio + HOST_CAP);
1087 hpriv->port_map = readl(mmio + HOST_PORTS_IMPL);
1088 probe_ent->n_ports = (hpriv->cap & 0x1f) + 1;
1090 VPRINTK("cap 0x%x port_map 0x%x n_ports %d\n",
1091 hpriv->cap, hpriv->port_map, probe_ent->n_ports);
1093 using_dac = hpriv->cap & HOST_CAP_64;
1095 !pci_set_dma_mask(pdev, DMA_64BIT_MASK)) {
1096 rc = pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK);
1098 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
1100 dev_printk(KERN_ERR, &pdev->dev,
1101 "64-bit DMA enable failed\n");
1106 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
1108 dev_printk(KERN_ERR, &pdev->dev,
1109 "32-bit DMA enable failed\n");
1112 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
1114 dev_printk(KERN_ERR, &pdev->dev,
1115 "32-bit consistent DMA enable failed\n");
1120 for (i = 0; i < probe_ent->n_ports; i++) {
1121 #if 0 /* BIOSen initialize this incorrectly */
1122 if (!(hpriv->port_map & (1 << i)))
1126 port_mmio = ahci_port_base(mmio, i);
1127 VPRINTK("mmio %p port_mmio %p\n", mmio, port_mmio);
1129 ahci_setup_port(&probe_ent->port[i],
1130 (unsigned long) mmio, i);
1132 /* make sure port is not active */
1133 tmp = readl(port_mmio + PORT_CMD);
1134 VPRINTK("PORT_CMD 0x%x\n", tmp);
1135 if (tmp & (PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
1136 PORT_CMD_FIS_RX | PORT_CMD_START)) {
1137 tmp &= ~(PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
1138 PORT_CMD_FIS_RX | PORT_CMD_START);
1139 writel(tmp, port_mmio + PORT_CMD);
1140 readl(port_mmio + PORT_CMD); /* flush */
1142 /* spec says 500 msecs for each bit, so
1143 * this is slightly incorrect.
1148 writel(PORT_CMD_SPIN_UP, port_mmio + PORT_CMD);
1153 tmp = readl(port_mmio + PORT_SCR_STAT);
1154 if ((tmp & 0xf) == 0x3)
1159 tmp = readl(port_mmio + PORT_SCR_ERR);
1160 VPRINTK("PORT_SCR_ERR 0x%x\n", tmp);
1161 writel(tmp, port_mmio + PORT_SCR_ERR);
1163 /* ack any pending irq events for this port */
1164 tmp = readl(port_mmio + PORT_IRQ_STAT);
1165 VPRINTK("PORT_IRQ_STAT 0x%x\n", tmp);
1167 writel(tmp, port_mmio + PORT_IRQ_STAT);
1169 writel(1 << i, mmio + HOST_IRQ_STAT);
1172 tmp = readl(mmio + HOST_CTL);
1173 VPRINTK("HOST_CTL 0x%x\n", tmp);
1174 writel(tmp | HOST_IRQ_EN, mmio + HOST_CTL);
1175 tmp = readl(mmio + HOST_CTL);
1176 VPRINTK("HOST_CTL 0x%x\n", tmp);
1178 pci_set_master(pdev);
1183 static void ahci_print_info(struct ata_probe_ent *probe_ent)
1185 struct ahci_host_priv *hpriv = probe_ent->private_data;
1186 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
1187 void __iomem *mmio = probe_ent->mmio_base;
1188 u32 vers, cap, impl, speed;
1189 const char *speed_s;
1193 vers = readl(mmio + HOST_VERSION);
1195 impl = hpriv->port_map;
1197 speed = (cap >> 20) & 0xf;
1200 else if (speed == 2)
1205 pci_read_config_word(pdev, 0x0a, &cc);
1208 else if (cc == 0x0106)
1210 else if (cc == 0x0104)
1215 dev_printk(KERN_INFO, &pdev->dev,
1216 "AHCI %02x%02x.%02x%02x "
1217 "%u slots %u ports %s Gbps 0x%x impl %s mode\n"
1220 (vers >> 24) & 0xff,
1221 (vers >> 16) & 0xff,
1225 ((cap >> 8) & 0x1f) + 1,
1231 dev_printk(KERN_INFO, &pdev->dev,
1237 cap & (1 << 31) ? "64bit " : "",
1238 cap & (1 << 30) ? "ncq " : "",
1239 cap & (1 << 28) ? "ilck " : "",
1240 cap & (1 << 27) ? "stag " : "",
1241 cap & (1 << 26) ? "pm " : "",
1242 cap & (1 << 25) ? "led " : "",
1244 cap & (1 << 24) ? "clo " : "",
1245 cap & (1 << 19) ? "nz " : "",
1246 cap & (1 << 18) ? "only " : "",
1247 cap & (1 << 17) ? "pmp " : "",
1248 cap & (1 << 15) ? "pio " : "",
1249 cap & (1 << 14) ? "slum " : "",
1250 cap & (1 << 13) ? "part " : ""
1254 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
1256 static int printed_version;
1257 struct ata_probe_ent *probe_ent = NULL;
1258 struct ahci_host_priv *hpriv;
1260 void __iomem *mmio_base;
1261 unsigned int board_idx = (unsigned int) ent->driver_data;
1262 int have_msi, pci_dev_busy = 0;
1267 if (!printed_version++)
1268 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
1270 rc = pci_enable_device(pdev);
1274 rc = pci_request_regions(pdev, DRV_NAME);
1280 if (pci_enable_msi(pdev) == 0)
1287 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
1288 if (probe_ent == NULL) {
1293 memset(probe_ent, 0, sizeof(*probe_ent));
1294 probe_ent->dev = pci_dev_to_dev(pdev);
1295 INIT_LIST_HEAD(&probe_ent->node);
1297 mmio_base = pci_iomap(pdev, AHCI_PCI_BAR, 0);
1298 if (mmio_base == NULL) {
1300 goto err_out_free_ent;
1302 base = (unsigned long) mmio_base;
1304 hpriv = kmalloc(sizeof(*hpriv), GFP_KERNEL);
1307 goto err_out_iounmap;
1309 memset(hpriv, 0, sizeof(*hpriv));
1311 probe_ent->sht = ahci_port_info[board_idx].sht;
1312 probe_ent->host_flags = ahci_port_info[board_idx].host_flags;
1313 probe_ent->pio_mask = ahci_port_info[board_idx].pio_mask;
1314 probe_ent->udma_mask = ahci_port_info[board_idx].udma_mask;
1315 probe_ent->port_ops = ahci_port_info[board_idx].port_ops;
1317 probe_ent->irq = pdev->irq;
1318 probe_ent->irq_flags = SA_SHIRQ;
1319 probe_ent->mmio_base = mmio_base;
1320 probe_ent->private_data = hpriv;
1323 hpriv->flags |= AHCI_FLAG_MSI;
1325 /* JMicron-specific fixup: make sure we're in AHCI mode */
1326 if (pdev->vendor == 0x197b)
1327 pci_write_config_byte(pdev, 0x41, 0xa1);
1329 /* initialize adapter */
1330 rc = ahci_host_init(probe_ent);
1334 ahci_print_info(probe_ent);
1336 /* FIXME: check ata_device_add return value */
1337 ata_device_add(probe_ent);
1345 pci_iounmap(pdev, mmio_base);
1350 pci_disable_msi(pdev);
1353 pci_release_regions(pdev);
1356 pci_disable_device(pdev);
1360 static void ahci_remove_one (struct pci_dev *pdev)
1362 struct device *dev = pci_dev_to_dev(pdev);
1363 struct ata_host_set *host_set = dev_get_drvdata(dev);
1364 struct ahci_host_priv *hpriv = host_set->private_data;
1365 struct ata_port *ap;
1369 for (i = 0; i < host_set->n_ports; i++) {
1370 ap = host_set->ports[i];
1372 scsi_remove_host(ap->host);
1375 have_msi = hpriv->flags & AHCI_FLAG_MSI;
1376 free_irq(host_set->irq, host_set);
1378 for (i = 0; i < host_set->n_ports; i++) {
1379 ap = host_set->ports[i];
1381 ata_scsi_release(ap->host);
1382 scsi_host_put(ap->host);
1386 pci_iounmap(pdev, host_set->mmio_base);
1390 pci_disable_msi(pdev);
1393 pci_release_regions(pdev);
1394 pci_disable_device(pdev);
1395 dev_set_drvdata(dev, NULL);
1398 static int __init ahci_init(void)
1400 return pci_module_init(&ahci_pci_driver);
1403 static void __exit ahci_exit(void)
1405 pci_unregister_driver(&ahci_pci_driver);
1409 MODULE_AUTHOR("Jeff Garzik");
1410 MODULE_DESCRIPTION("AHCI SATA low-level driver");
1411 MODULE_LICENSE("GPL");
1412 MODULE_DEVICE_TABLE(pci, ahci_pci_tbl);
1413 MODULE_VERSION(DRV_VERSION);
1415 module_init(ahci_init);
1416 module_exit(ahci_exit);