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,
59 AHCI_CMD_SLOT_SZ = 32 * 32,
61 AHCI_CMD_TBL_HDR = 0x80,
62 AHCI_CMD_TBL_CDB = 0x40,
63 AHCI_CMD_TBL_SZ = AHCI_CMD_TBL_HDR + (AHCI_MAX_SG * 16),
64 AHCI_PORT_PRIV_DMA_SZ = AHCI_CMD_SLOT_SZ + AHCI_CMD_TBL_SZ +
66 AHCI_IRQ_ON_SG = (1 << 31),
67 AHCI_CMD_ATAPI = (1 << 5),
68 AHCI_CMD_WRITE = (1 << 6),
69 AHCI_CMD_PREFETCH = (1 << 7),
70 AHCI_CMD_RESET = (1 << 8),
71 AHCI_CMD_CLR_BUSY = (1 << 10),
73 RX_FIS_D2H_REG = 0x40, /* offset of D2H Register FIS data */
74 RX_FIS_UNK = 0x60, /* offset of Unknown FIS data */
77 board_ahci_vt8251 = 1,
79 /* global controller registers */
80 HOST_CAP = 0x00, /* host capabilities */
81 HOST_CTL = 0x04, /* global host control */
82 HOST_IRQ_STAT = 0x08, /* interrupt status */
83 HOST_PORTS_IMPL = 0x0c, /* bitmap of implemented ports */
84 HOST_VERSION = 0x10, /* AHCI spec. version compliancy */
87 HOST_RESET = (1 << 0), /* reset controller; self-clear */
88 HOST_IRQ_EN = (1 << 1), /* global IRQ enable */
89 HOST_AHCI_EN = (1 << 31), /* AHCI enabled */
92 HOST_CAP_64 = (1 << 31), /* PCI DAC (64-bit DMA) support */
93 HOST_CAP_CLO = (1 << 24), /* Command List Override support */
95 /* registers for each SATA port */
96 PORT_LST_ADDR = 0x00, /* command list DMA addr */
97 PORT_LST_ADDR_HI = 0x04, /* command list DMA addr hi */
98 PORT_FIS_ADDR = 0x08, /* FIS rx buf addr */
99 PORT_FIS_ADDR_HI = 0x0c, /* FIS rx buf addr hi */
100 PORT_IRQ_STAT = 0x10, /* interrupt status */
101 PORT_IRQ_MASK = 0x14, /* interrupt enable/disable mask */
102 PORT_CMD = 0x18, /* port command */
103 PORT_TFDATA = 0x20, /* taskfile data */
104 PORT_SIG = 0x24, /* device TF signature */
105 PORT_CMD_ISSUE = 0x38, /* command issue */
106 PORT_SCR = 0x28, /* SATA phy register block */
107 PORT_SCR_STAT = 0x28, /* SATA phy register: SStatus */
108 PORT_SCR_CTL = 0x2c, /* SATA phy register: SControl */
109 PORT_SCR_ERR = 0x30, /* SATA phy register: SError */
110 PORT_SCR_ACT = 0x34, /* SATA phy register: SActive */
112 /* PORT_IRQ_{STAT,MASK} bits */
113 PORT_IRQ_COLD_PRES = (1 << 31), /* cold presence detect */
114 PORT_IRQ_TF_ERR = (1 << 30), /* task file error */
115 PORT_IRQ_HBUS_ERR = (1 << 29), /* host bus fatal error */
116 PORT_IRQ_HBUS_DATA_ERR = (1 << 28), /* host bus data error */
117 PORT_IRQ_IF_ERR = (1 << 27), /* interface fatal error */
118 PORT_IRQ_IF_NONFATAL = (1 << 26), /* interface non-fatal error */
119 PORT_IRQ_OVERFLOW = (1 << 24), /* xfer exhausted available S/G */
120 PORT_IRQ_BAD_PMP = (1 << 23), /* incorrect port multiplier */
122 PORT_IRQ_PHYRDY = (1 << 22), /* PhyRdy changed */
123 PORT_IRQ_DEV_ILCK = (1 << 7), /* device interlock */
124 PORT_IRQ_CONNECT = (1 << 6), /* port connect change status */
125 PORT_IRQ_SG_DONE = (1 << 5), /* descriptor processed */
126 PORT_IRQ_UNK_FIS = (1 << 4), /* unknown FIS rx'd */
127 PORT_IRQ_SDB_FIS = (1 << 3), /* Set Device Bits FIS rx'd */
128 PORT_IRQ_DMAS_FIS = (1 << 2), /* DMA Setup FIS rx'd */
129 PORT_IRQ_PIOS_FIS = (1 << 1), /* PIO Setup FIS rx'd */
130 PORT_IRQ_D2H_REG_FIS = (1 << 0), /* D2H Register FIS rx'd */
132 PORT_IRQ_FREEZE = PORT_IRQ_HBUS_ERR |
136 PORT_IRQ_ERROR = PORT_IRQ_FREEZE |
138 PORT_IRQ_HBUS_DATA_ERR,
139 DEF_PORT_IRQ = PORT_IRQ_ERROR | PORT_IRQ_SG_DONE |
140 PORT_IRQ_SDB_FIS | PORT_IRQ_DMAS_FIS |
141 PORT_IRQ_PIOS_FIS | PORT_IRQ_D2H_REG_FIS,
144 PORT_CMD_ATAPI = (1 << 24), /* Device is ATAPI */
145 PORT_CMD_LIST_ON = (1 << 15), /* cmd list DMA engine running */
146 PORT_CMD_FIS_ON = (1 << 14), /* FIS DMA engine running */
147 PORT_CMD_FIS_RX = (1 << 4), /* Enable FIS receive DMA engine */
148 PORT_CMD_CLO = (1 << 3), /* Command list override */
149 PORT_CMD_POWER_ON = (1 << 2), /* Power up device */
150 PORT_CMD_SPIN_UP = (1 << 1), /* Spin up device */
151 PORT_CMD_START = (1 << 0), /* Enable port DMA engine */
153 PORT_CMD_ICC_ACTIVE = (0x1 << 28), /* Put i/f in active state */
154 PORT_CMD_ICC_PARTIAL = (0x2 << 28), /* Put i/f in partial state */
155 PORT_CMD_ICC_SLUMBER = (0x6 << 28), /* Put i/f in slumber state */
157 /* hpriv->flags bits */
158 AHCI_FLAG_MSI = (1 << 0),
161 AHCI_FLAG_RESET_NEEDS_CLO = (1 << 24),
164 struct ahci_cmd_hdr {
179 struct ahci_host_priv {
181 u32 cap; /* cache of HOST_CAP register */
182 u32 port_map; /* cache of HOST_PORTS_IMPL reg */
185 struct ahci_port_priv {
186 struct ahci_cmd_hdr *cmd_slot;
187 dma_addr_t cmd_slot_dma;
189 dma_addr_t cmd_tbl_dma;
190 struct ahci_sg *cmd_tbl_sg;
192 dma_addr_t rx_fis_dma;
195 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg);
196 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
197 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
198 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc);
199 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
200 static int ahci_probe_reset(struct ata_port *ap, unsigned int *classes);
201 static void ahci_irq_clear(struct ata_port *ap);
202 static int ahci_port_start(struct ata_port *ap);
203 static void ahci_port_stop(struct ata_port *ap);
204 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
205 static void ahci_qc_prep(struct ata_queued_cmd *qc);
206 static u8 ahci_check_status(struct ata_port *ap);
207 static void ahci_freeze(struct ata_port *ap);
208 static void ahci_thaw(struct ata_port *ap);
209 static void ahci_error_handler(struct ata_port *ap);
210 static void ahci_post_internal_cmd(struct ata_queued_cmd *qc);
211 static void ahci_remove_one (struct pci_dev *pdev);
213 static struct scsi_host_template ahci_sht = {
214 .module = THIS_MODULE,
216 .ioctl = ata_scsi_ioctl,
217 .queuecommand = ata_scsi_queuecmd,
218 .can_queue = ATA_DEF_QUEUE,
219 .this_id = ATA_SHT_THIS_ID,
220 .sg_tablesize = AHCI_MAX_SG,
221 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
222 .emulated = ATA_SHT_EMULATED,
223 .use_clustering = AHCI_USE_CLUSTERING,
224 .proc_name = DRV_NAME,
225 .dma_boundary = AHCI_DMA_BOUNDARY,
226 .slave_configure = ata_scsi_slave_config,
227 .bios_param = ata_std_bios_param,
230 static const struct ata_port_operations ahci_ops = {
231 .port_disable = ata_port_disable,
233 .check_status = ahci_check_status,
234 .check_altstatus = ahci_check_status,
235 .dev_select = ata_noop_dev_select,
237 .tf_read = ahci_tf_read,
239 .probe_reset = ahci_probe_reset,
241 .qc_prep = ahci_qc_prep,
242 .qc_issue = ahci_qc_issue,
244 .irq_handler = ahci_interrupt,
245 .irq_clear = ahci_irq_clear,
247 .scr_read = ahci_scr_read,
248 .scr_write = ahci_scr_write,
250 .freeze = ahci_freeze,
253 .error_handler = ahci_error_handler,
254 .post_internal_cmd = ahci_post_internal_cmd,
256 .port_start = ahci_port_start,
257 .port_stop = ahci_port_stop,
260 static const struct ata_port_info ahci_port_info[] = {
264 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
265 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA,
266 .pio_mask = 0x1f, /* pio0-4 */
267 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
268 .port_ops = &ahci_ops,
270 /* board_ahci_vt8251 */
273 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
274 ATA_FLAG_MMIO | ATA_FLAG_PIO_DMA |
275 AHCI_FLAG_RESET_NEEDS_CLO,
276 .pio_mask = 0x1f, /* pio0-4 */
277 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
278 .port_ops = &ahci_ops,
282 static const struct pci_device_id ahci_pci_tbl[] = {
283 { PCI_VENDOR_ID_INTEL, 0x2652, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
284 board_ahci }, /* ICH6 */
285 { PCI_VENDOR_ID_INTEL, 0x2653, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
286 board_ahci }, /* ICH6M */
287 { PCI_VENDOR_ID_INTEL, 0x27c1, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
288 board_ahci }, /* ICH7 */
289 { PCI_VENDOR_ID_INTEL, 0x27c5, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
290 board_ahci }, /* ICH7M */
291 { PCI_VENDOR_ID_INTEL, 0x27c3, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
292 board_ahci }, /* ICH7R */
293 { PCI_VENDOR_ID_AL, 0x5288, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
294 board_ahci }, /* ULi M5288 */
295 { PCI_VENDOR_ID_INTEL, 0x2681, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
296 board_ahci }, /* ESB2 */
297 { PCI_VENDOR_ID_INTEL, 0x2682, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
298 board_ahci }, /* ESB2 */
299 { PCI_VENDOR_ID_INTEL, 0x2683, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
300 board_ahci }, /* ESB2 */
301 { PCI_VENDOR_ID_INTEL, 0x27c6, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
302 board_ahci }, /* ICH7-M DH */
303 { PCI_VENDOR_ID_INTEL, 0x2821, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
304 board_ahci }, /* ICH8 */
305 { PCI_VENDOR_ID_INTEL, 0x2822, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
306 board_ahci }, /* ICH8 */
307 { PCI_VENDOR_ID_INTEL, 0x2824, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
308 board_ahci }, /* ICH8 */
309 { PCI_VENDOR_ID_INTEL, 0x2829, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
310 board_ahci }, /* ICH8M */
311 { PCI_VENDOR_ID_INTEL, 0x282a, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
312 board_ahci }, /* ICH8M */
313 { 0x197b, 0x2360, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
314 board_ahci }, /* JMicron JMB360 */
315 { 0x197b, 0x2363, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
316 board_ahci }, /* JMicron JMB363 */
317 { PCI_VENDOR_ID_ATI, 0x4380, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
318 board_ahci }, /* ATI SB600 non-raid */
319 { PCI_VENDOR_ID_ATI, 0x4381, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
320 board_ahci }, /* ATI SB600 raid */
321 { PCI_VENDOR_ID_VIA, 0x3349, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
322 board_ahci_vt8251 }, /* VIA VT8251 */
323 { } /* terminate list */
327 static struct pci_driver ahci_pci_driver = {
329 .id_table = ahci_pci_tbl,
330 .probe = ahci_init_one,
331 .remove = ahci_remove_one,
335 static inline unsigned long ahci_port_base_ul (unsigned long base, unsigned int port)
337 return base + 0x100 + (port * 0x80);
340 static inline void __iomem *ahci_port_base (void __iomem *base, unsigned int port)
342 return (void __iomem *) ahci_port_base_ul((unsigned long)base, port);
345 static int ahci_port_start(struct ata_port *ap)
347 struct device *dev = ap->host_set->dev;
348 struct ahci_host_priv *hpriv = ap->host_set->private_data;
349 struct ahci_port_priv *pp;
350 void __iomem *mmio = ap->host_set->mmio_base;
351 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
356 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
359 memset(pp, 0, sizeof(*pp));
361 rc = ata_pad_alloc(ap, dev);
367 mem = dma_alloc_coherent(dev, AHCI_PORT_PRIV_DMA_SZ, &mem_dma, GFP_KERNEL);
369 ata_pad_free(ap, dev);
373 memset(mem, 0, AHCI_PORT_PRIV_DMA_SZ);
376 * First item in chunk of DMA memory: 32-slot command table,
377 * 32 bytes each in size
380 pp->cmd_slot_dma = mem_dma;
382 mem += AHCI_CMD_SLOT_SZ;
383 mem_dma += AHCI_CMD_SLOT_SZ;
386 * Second item: Received-FIS area
389 pp->rx_fis_dma = mem_dma;
391 mem += AHCI_RX_FIS_SZ;
392 mem_dma += AHCI_RX_FIS_SZ;
395 * Third item: data area for storing a single command
396 * and its scatter-gather table
399 pp->cmd_tbl_dma = mem_dma;
401 pp->cmd_tbl_sg = mem + AHCI_CMD_TBL_HDR;
403 ap->private_data = pp;
405 if (hpriv->cap & HOST_CAP_64)
406 writel((pp->cmd_slot_dma >> 16) >> 16, port_mmio + PORT_LST_ADDR_HI);
407 writel(pp->cmd_slot_dma & 0xffffffff, port_mmio + PORT_LST_ADDR);
408 readl(port_mmio + PORT_LST_ADDR); /* flush */
410 if (hpriv->cap & HOST_CAP_64)
411 writel((pp->rx_fis_dma >> 16) >> 16, port_mmio + PORT_FIS_ADDR_HI);
412 writel(pp->rx_fis_dma & 0xffffffff, port_mmio + PORT_FIS_ADDR);
413 readl(port_mmio + PORT_FIS_ADDR); /* flush */
415 writel(PORT_CMD_ICC_ACTIVE | PORT_CMD_FIS_RX |
416 PORT_CMD_POWER_ON | PORT_CMD_SPIN_UP |
417 PORT_CMD_START, port_mmio + PORT_CMD);
418 readl(port_mmio + PORT_CMD); /* flush */
424 static void ahci_port_stop(struct ata_port *ap)
426 struct device *dev = ap->host_set->dev;
427 struct ahci_port_priv *pp = ap->private_data;
428 void __iomem *mmio = ap->host_set->mmio_base;
429 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
432 tmp = readl(port_mmio + PORT_CMD);
433 tmp &= ~(PORT_CMD_START | PORT_CMD_FIS_RX);
434 writel(tmp, port_mmio + PORT_CMD);
435 readl(port_mmio + PORT_CMD); /* flush */
437 /* spec says 500 msecs for each PORT_CMD_{START,FIS_RX} bit, so
438 * this is slightly incorrect.
442 ap->private_data = NULL;
443 dma_free_coherent(dev, AHCI_PORT_PRIV_DMA_SZ,
444 pp->cmd_slot, pp->cmd_slot_dma);
445 ata_pad_free(ap, dev);
449 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg_in)
454 case SCR_STATUS: sc_reg = 0; break;
455 case SCR_CONTROL: sc_reg = 1; break;
456 case SCR_ERROR: sc_reg = 2; break;
457 case SCR_ACTIVE: sc_reg = 3; break;
462 return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
466 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg_in,
472 case SCR_STATUS: sc_reg = 0; break;
473 case SCR_CONTROL: sc_reg = 1; break;
474 case SCR_ERROR: sc_reg = 2; break;
475 case SCR_ACTIVE: sc_reg = 3; break;
480 writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
483 static int ahci_stop_engine(struct ata_port *ap)
485 void __iomem *mmio = ap->host_set->mmio_base;
486 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
490 tmp = readl(port_mmio + PORT_CMD);
491 tmp &= ~PORT_CMD_START;
492 writel(tmp, port_mmio + PORT_CMD);
494 /* wait for engine to stop. TODO: this could be
495 * as long as 500 msec
499 tmp = readl(port_mmio + PORT_CMD);
500 if ((tmp & PORT_CMD_LIST_ON) == 0)
508 static void ahci_start_engine(struct ata_port *ap)
510 void __iomem *mmio = ap->host_set->mmio_base;
511 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
514 tmp = readl(port_mmio + PORT_CMD);
515 tmp |= PORT_CMD_START;
516 writel(tmp, port_mmio + PORT_CMD);
517 readl(port_mmio + PORT_CMD); /* flush */
520 static unsigned int ahci_dev_classify(struct ata_port *ap)
522 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
523 struct ata_taskfile tf;
526 tmp = readl(port_mmio + PORT_SIG);
527 tf.lbah = (tmp >> 24) & 0xff;
528 tf.lbam = (tmp >> 16) & 0xff;
529 tf.lbal = (tmp >> 8) & 0xff;
530 tf.nsect = (tmp) & 0xff;
532 return ata_dev_classify(&tf);
535 static void ahci_fill_cmd_slot(struct ahci_port_priv *pp, u32 opts)
537 pp->cmd_slot[0].opts = cpu_to_le32(opts);
538 pp->cmd_slot[0].status = 0;
539 pp->cmd_slot[0].tbl_addr = cpu_to_le32(pp->cmd_tbl_dma & 0xffffffff);
540 pp->cmd_slot[0].tbl_addr_hi = cpu_to_le32((pp->cmd_tbl_dma >> 16) >> 16);
543 static int ahci_clo(struct ata_port *ap)
545 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
546 struct ahci_host_priv *hpriv = ap->host_set->private_data;
549 if (!(hpriv->cap & HOST_CAP_CLO))
552 tmp = readl(port_mmio + PORT_CMD);
554 writel(tmp, port_mmio + PORT_CMD);
556 tmp = ata_wait_register(port_mmio + PORT_CMD,
557 PORT_CMD_CLO, PORT_CMD_CLO, 1, 500);
558 if (tmp & PORT_CMD_CLO)
564 static int ahci_softreset(struct ata_port *ap, unsigned int *class)
566 struct ahci_port_priv *pp = ap->private_data;
567 void __iomem *mmio = ap->host_set->mmio_base;
568 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
569 const u32 cmd_fis_len = 5; /* five dwords */
570 const char *reason = NULL;
571 struct ata_taskfile tf;
578 if (ata_port_offline(ap)) {
579 DPRINTK("PHY reports no device\n");
580 *class = ATA_DEV_NONE;
584 /* prepare for SRST (AHCI-1.1 10.4.1) */
585 rc = ahci_stop_engine(ap);
587 reason = "failed to stop engine";
591 /* check BUSY/DRQ, perform Command List Override if necessary */
592 ahci_tf_read(ap, &tf);
593 if (tf.command & (ATA_BUSY | ATA_DRQ)) {
596 if (rc == -EOPNOTSUPP) {
597 reason = "port busy but CLO unavailable";
600 reason = "port busy but CLO failed";
606 ahci_start_engine(ap);
608 ata_tf_init(ap->device, &tf);
611 /* issue the first D2H Register FIS */
612 ahci_fill_cmd_slot(pp, cmd_fis_len | AHCI_CMD_RESET | AHCI_CMD_CLR_BUSY);
615 ata_tf_to_fis(&tf, fis, 0);
616 fis[1] &= ~(1 << 7); /* turn off Command FIS bit */
618 writel(1, port_mmio + PORT_CMD_ISSUE);
620 tmp = ata_wait_register(port_mmio + PORT_CMD_ISSUE, 0x1, 0x1, 1, 500);
623 reason = "1st FIS failed";
627 /* spec says at least 5us, but be generous and sleep for 1ms */
630 /* issue the second D2H Register FIS */
631 ahci_fill_cmd_slot(pp, cmd_fis_len);
634 ata_tf_to_fis(&tf, fis, 0);
635 fis[1] &= ~(1 << 7); /* turn off Command FIS bit */
637 writel(1, port_mmio + PORT_CMD_ISSUE);
638 readl(port_mmio + PORT_CMD_ISSUE); /* flush */
640 /* spec mandates ">= 2ms" before checking status.
641 * We wait 150ms, because that was the magic delay used for
642 * ATAPI devices in Hale Landis's ATADRVR, for the period of time
643 * between when the ATA command register is written, and then
644 * status is checked. Because waiting for "a while" before
645 * checking status is fine, post SRST, we perform this magic
646 * delay here as well.
650 *class = ATA_DEV_NONE;
651 if (ata_port_online(ap)) {
652 if (ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT)) {
654 reason = "device not ready";
657 *class = ahci_dev_classify(ap);
660 DPRINTK("EXIT, class=%u\n", *class);
664 ahci_start_engine(ap);
666 ata_port_printk(ap, KERN_ERR, "softreset failed (%s)\n", reason);
670 static int ahci_hardreset(struct ata_port *ap, unsigned int *class)
676 ahci_stop_engine(ap);
677 rc = sata_std_hardreset(ap, class);
678 ahci_start_engine(ap);
680 if (rc == 0 && ata_port_online(ap))
681 *class = ahci_dev_classify(ap);
682 if (*class == ATA_DEV_UNKNOWN)
683 *class = ATA_DEV_NONE;
685 DPRINTK("EXIT, rc=%d, class=%u\n", rc, *class);
689 static void ahci_postreset(struct ata_port *ap, unsigned int *class)
691 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
694 ata_std_postreset(ap, class);
696 /* Make sure port's ATAPI bit is set appropriately */
697 new_tmp = tmp = readl(port_mmio + PORT_CMD);
698 if (*class == ATA_DEV_ATAPI)
699 new_tmp |= PORT_CMD_ATAPI;
701 new_tmp &= ~PORT_CMD_ATAPI;
702 if (new_tmp != tmp) {
703 writel(new_tmp, port_mmio + PORT_CMD);
704 readl(port_mmio + PORT_CMD); /* flush */
708 static int ahci_probe_reset(struct ata_port *ap, unsigned int *classes)
710 if ((ap->flags & AHCI_FLAG_RESET_NEEDS_CLO) &&
711 (ata_busy_wait(ap, ATA_BUSY, 1000) & ATA_BUSY)) {
712 /* ATA_BUSY hasn't cleared, so send a CLO */
716 return ata_drive_probe_reset(ap, ata_std_probeinit,
717 ahci_softreset, ahci_hardreset,
718 ahci_postreset, classes);
721 static u8 ahci_check_status(struct ata_port *ap)
723 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr;
725 return readl(mmio + PORT_TFDATA) & 0xFF;
728 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
730 struct ahci_port_priv *pp = ap->private_data;
731 u8 *d2h_fis = pp->rx_fis + RX_FIS_D2H_REG;
733 ata_tf_from_fis(d2h_fis, tf);
736 static unsigned int ahci_fill_sg(struct ata_queued_cmd *qc)
738 struct ahci_port_priv *pp = qc->ap->private_data;
739 struct scatterlist *sg;
740 struct ahci_sg *ahci_sg;
741 unsigned int n_sg = 0;
746 * Next, the S/G list.
748 ahci_sg = pp->cmd_tbl_sg;
749 ata_for_each_sg(sg, qc) {
750 dma_addr_t addr = sg_dma_address(sg);
751 u32 sg_len = sg_dma_len(sg);
753 ahci_sg->addr = cpu_to_le32(addr & 0xffffffff);
754 ahci_sg->addr_hi = cpu_to_le32((addr >> 16) >> 16);
755 ahci_sg->flags_size = cpu_to_le32(sg_len - 1);
764 static void ahci_qc_prep(struct ata_queued_cmd *qc)
766 struct ata_port *ap = qc->ap;
767 struct ahci_port_priv *pp = ap->private_data;
768 int is_atapi = is_atapi_taskfile(&qc->tf);
770 const u32 cmd_fis_len = 5; /* five dwords */
774 * Fill in command table information. First, the header,
775 * a SATA Register - Host to Device command FIS.
777 ata_tf_to_fis(&qc->tf, pp->cmd_tbl, 0);
779 memset(pp->cmd_tbl + AHCI_CMD_TBL_CDB, 0, 32);
780 memcpy(pp->cmd_tbl + AHCI_CMD_TBL_CDB, qc->cdb,
785 if (qc->flags & ATA_QCFLAG_DMAMAP)
786 n_elem = ahci_fill_sg(qc);
789 * Fill in command slot information.
791 opts = cmd_fis_len | n_elem << 16;
792 if (qc->tf.flags & ATA_TFLAG_WRITE)
793 opts |= AHCI_CMD_WRITE;
795 opts |= AHCI_CMD_ATAPI | AHCI_CMD_PREFETCH;
797 ahci_fill_cmd_slot(pp, opts);
800 static void ahci_error_intr(struct ata_port *ap, u32 irq_stat)
802 struct ahci_port_priv *pp = ap->private_data;
803 struct ata_eh_info *ehi = &ap->eh_info;
804 unsigned int err_mask = 0, action = 0;
805 struct ata_queued_cmd *qc;
808 ata_ehi_clear_desc(ehi);
810 /* AHCI needs SError cleared; otherwise, it might lock up */
811 serror = ahci_scr_read(ap, SCR_ERROR);
812 ahci_scr_write(ap, SCR_ERROR, serror);
814 /* analyze @irq_stat */
815 ata_ehi_push_desc(ehi, "irq_stat 0x%08x", irq_stat);
817 if (irq_stat & PORT_IRQ_TF_ERR)
818 err_mask |= AC_ERR_DEV;
820 if (irq_stat & (PORT_IRQ_HBUS_ERR | PORT_IRQ_HBUS_DATA_ERR)) {
821 err_mask |= AC_ERR_HOST_BUS;
822 action |= ATA_EH_SOFTRESET;
825 if (irq_stat & PORT_IRQ_IF_ERR) {
826 err_mask |= AC_ERR_ATA_BUS;
827 action |= ATA_EH_SOFTRESET;
828 ata_ehi_push_desc(ehi, ", interface fatal error");
831 if (irq_stat & (PORT_IRQ_CONNECT | PORT_IRQ_PHYRDY)) {
832 err_mask |= AC_ERR_ATA_BUS;
833 action |= ATA_EH_SOFTRESET;
834 ata_ehi_push_desc(ehi, ", %s", irq_stat & PORT_IRQ_CONNECT ?
835 "connection status changed" : "PHY RDY changed");
838 if (irq_stat & PORT_IRQ_UNK_FIS) {
839 u32 *unk = (u32 *)(pp->rx_fis + RX_FIS_UNK);
841 err_mask |= AC_ERR_HSM;
842 action |= ATA_EH_SOFTRESET;
843 ata_ehi_push_desc(ehi, ", unknown FIS %08x %08x %08x %08x",
844 unk[0], unk[1], unk[2], unk[3]);
847 /* okay, let's hand over to EH */
848 ehi->serror |= serror;
849 ehi->action |= action;
851 qc = ata_qc_from_tag(ap, ap->active_tag);
853 qc->err_mask |= err_mask;
855 ehi->err_mask |= err_mask;
857 if (irq_stat & PORT_IRQ_FREEZE)
863 static void ahci_host_intr(struct ata_port *ap)
865 void __iomem *mmio = ap->host_set->mmio_base;
866 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
867 struct ata_queued_cmd *qc;
870 status = readl(port_mmio + PORT_IRQ_STAT);
871 writel(status, port_mmio + PORT_IRQ_STAT);
873 if (unlikely(status & PORT_IRQ_ERROR)) {
874 ahci_error_intr(ap, status);
878 if ((qc = ata_qc_from_tag(ap, ap->active_tag))) {
879 ci = readl(port_mmio + PORT_CMD_ISSUE);
880 if ((ci & 0x1) == 0) {
886 /* hmmm... a spurious interupt */
888 /* ignore interim PIO setup fis interrupts */
889 if (ata_tag_valid(ap->active_tag)) {
890 struct ata_queued_cmd *qc =
891 ata_qc_from_tag(ap, ap->active_tag);
893 if (qc && qc->tf.protocol == ATA_PROT_PIO &&
894 (status & PORT_IRQ_PIOS_FIS))
899 ata_port_printk(ap, KERN_INFO, "spurious interrupt "
900 "(irq_stat 0x%x active_tag %d)\n",
901 status, ap->active_tag);
904 static void ahci_irq_clear(struct ata_port *ap)
909 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
911 struct ata_host_set *host_set = dev_instance;
912 struct ahci_host_priv *hpriv;
913 unsigned int i, handled = 0;
915 u32 irq_stat, irq_ack = 0;
919 hpriv = host_set->private_data;
920 mmio = host_set->mmio_base;
922 /* sigh. 0xffffffff is a valid return from h/w */
923 irq_stat = readl(mmio + HOST_IRQ_STAT);
924 irq_stat &= hpriv->port_map;
928 spin_lock(&host_set->lock);
930 for (i = 0; i < host_set->n_ports; i++) {
933 if (!(irq_stat & (1 << i)))
936 ap = host_set->ports[i];
939 VPRINTK("port %u\n", i);
941 VPRINTK("port %u (no irq)\n", i);
943 dev_printk(KERN_WARNING, host_set->dev,
944 "interrupt on disabled port %u\n", i);
951 writel(irq_ack, mmio + HOST_IRQ_STAT);
955 spin_unlock(&host_set->lock);
959 return IRQ_RETVAL(handled);
962 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc)
964 struct ata_port *ap = qc->ap;
965 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
967 writel(1, port_mmio + PORT_CMD_ISSUE);
968 readl(port_mmio + PORT_CMD_ISSUE); /* flush */
973 static void ahci_freeze(struct ata_port *ap)
975 void __iomem *mmio = ap->host_set->mmio_base;
976 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
979 writel(0, port_mmio + PORT_IRQ_MASK);
982 static void ahci_thaw(struct ata_port *ap)
984 void __iomem *mmio = ap->host_set->mmio_base;
985 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
989 tmp = readl(port_mmio + PORT_IRQ_STAT);
990 writel(tmp, port_mmio + PORT_IRQ_STAT);
991 writel(1 << ap->id, mmio + HOST_IRQ_STAT);
993 /* turn IRQ back on */
994 writel(DEF_PORT_IRQ, port_mmio + PORT_IRQ_MASK);
997 static void ahci_error_handler(struct ata_port *ap)
999 if (!(ap->flags & ATA_FLAG_FROZEN)) {
1000 /* restart engine */
1001 ahci_stop_engine(ap);
1002 ahci_start_engine(ap);
1005 /* perform recovery */
1006 ata_do_eh(ap, ahci_softreset, ahci_hardreset, ahci_postreset);
1009 static void ahci_post_internal_cmd(struct ata_queued_cmd *qc)
1011 struct ata_port *ap = qc->ap;
1013 if (qc->flags & ATA_QCFLAG_FAILED)
1014 qc->err_mask |= AC_ERR_OTHER;
1017 /* make DMA engine forget about the failed command */
1018 ahci_stop_engine(ap);
1019 ahci_start_engine(ap);
1023 static void ahci_setup_port(struct ata_ioports *port, unsigned long base,
1024 unsigned int port_idx)
1026 VPRINTK("ENTER, base==0x%lx, port_idx %u\n", base, port_idx);
1027 base = ahci_port_base_ul(base, port_idx);
1028 VPRINTK("base now==0x%lx\n", base);
1030 port->cmd_addr = base;
1031 port->scr_addr = base + PORT_SCR;
1036 static int ahci_host_init(struct ata_probe_ent *probe_ent)
1038 struct ahci_host_priv *hpriv = probe_ent->private_data;
1039 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
1040 void __iomem *mmio = probe_ent->mmio_base;
1042 unsigned int i, j, using_dac;
1044 void __iomem *port_mmio;
1046 cap_save = readl(mmio + HOST_CAP);
1047 cap_save &= ( (1<<28) | (1<<17) );
1048 cap_save |= (1 << 27);
1050 /* global controller reset */
1051 tmp = readl(mmio + HOST_CTL);
1052 if ((tmp & HOST_RESET) == 0) {
1053 writel(tmp | HOST_RESET, mmio + HOST_CTL);
1054 readl(mmio + HOST_CTL); /* flush */
1057 /* reset must complete within 1 second, or
1058 * the hardware should be considered fried.
1062 tmp = readl(mmio + HOST_CTL);
1063 if (tmp & HOST_RESET) {
1064 dev_printk(KERN_ERR, &pdev->dev,
1065 "controller reset failed (0x%x)\n", tmp);
1069 writel(HOST_AHCI_EN, mmio + HOST_CTL);
1070 (void) readl(mmio + HOST_CTL); /* flush */
1071 writel(cap_save, mmio + HOST_CAP);
1072 writel(0xf, mmio + HOST_PORTS_IMPL);
1073 (void) readl(mmio + HOST_PORTS_IMPL); /* flush */
1075 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
1078 pci_read_config_word(pdev, 0x92, &tmp16);
1080 pci_write_config_word(pdev, 0x92, tmp16);
1083 hpriv->cap = readl(mmio + HOST_CAP);
1084 hpriv->port_map = readl(mmio + HOST_PORTS_IMPL);
1085 probe_ent->n_ports = (hpriv->cap & 0x1f) + 1;
1087 VPRINTK("cap 0x%x port_map 0x%x n_ports %d\n",
1088 hpriv->cap, hpriv->port_map, probe_ent->n_ports);
1090 using_dac = hpriv->cap & HOST_CAP_64;
1092 !pci_set_dma_mask(pdev, DMA_64BIT_MASK)) {
1093 rc = pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK);
1095 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
1097 dev_printk(KERN_ERR, &pdev->dev,
1098 "64-bit DMA enable failed\n");
1103 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
1105 dev_printk(KERN_ERR, &pdev->dev,
1106 "32-bit DMA enable failed\n");
1109 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
1111 dev_printk(KERN_ERR, &pdev->dev,
1112 "32-bit consistent DMA enable failed\n");
1117 for (i = 0; i < probe_ent->n_ports; i++) {
1118 #if 0 /* BIOSen initialize this incorrectly */
1119 if (!(hpriv->port_map & (1 << i)))
1123 port_mmio = ahci_port_base(mmio, i);
1124 VPRINTK("mmio %p port_mmio %p\n", mmio, port_mmio);
1126 ahci_setup_port(&probe_ent->port[i],
1127 (unsigned long) mmio, i);
1129 /* make sure port is not active */
1130 tmp = readl(port_mmio + PORT_CMD);
1131 VPRINTK("PORT_CMD 0x%x\n", tmp);
1132 if (tmp & (PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
1133 PORT_CMD_FIS_RX | PORT_CMD_START)) {
1134 tmp &= ~(PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
1135 PORT_CMD_FIS_RX | PORT_CMD_START);
1136 writel(tmp, port_mmio + PORT_CMD);
1137 readl(port_mmio + PORT_CMD); /* flush */
1139 /* spec says 500 msecs for each bit, so
1140 * this is slightly incorrect.
1145 writel(PORT_CMD_SPIN_UP, port_mmio + PORT_CMD);
1150 tmp = readl(port_mmio + PORT_SCR_STAT);
1151 if ((tmp & 0xf) == 0x3)
1156 tmp = readl(port_mmio + PORT_SCR_ERR);
1157 VPRINTK("PORT_SCR_ERR 0x%x\n", tmp);
1158 writel(tmp, port_mmio + PORT_SCR_ERR);
1160 /* ack any pending irq events for this port */
1161 tmp = readl(port_mmio + PORT_IRQ_STAT);
1162 VPRINTK("PORT_IRQ_STAT 0x%x\n", tmp);
1164 writel(tmp, port_mmio + PORT_IRQ_STAT);
1166 writel(1 << i, mmio + HOST_IRQ_STAT);
1169 tmp = readl(mmio + HOST_CTL);
1170 VPRINTK("HOST_CTL 0x%x\n", tmp);
1171 writel(tmp | HOST_IRQ_EN, mmio + HOST_CTL);
1172 tmp = readl(mmio + HOST_CTL);
1173 VPRINTK("HOST_CTL 0x%x\n", tmp);
1175 pci_set_master(pdev);
1180 static void ahci_print_info(struct ata_probe_ent *probe_ent)
1182 struct ahci_host_priv *hpriv = probe_ent->private_data;
1183 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
1184 void __iomem *mmio = probe_ent->mmio_base;
1185 u32 vers, cap, impl, speed;
1186 const char *speed_s;
1190 vers = readl(mmio + HOST_VERSION);
1192 impl = hpriv->port_map;
1194 speed = (cap >> 20) & 0xf;
1197 else if (speed == 2)
1202 pci_read_config_word(pdev, 0x0a, &cc);
1205 else if (cc == 0x0106)
1207 else if (cc == 0x0104)
1212 dev_printk(KERN_INFO, &pdev->dev,
1213 "AHCI %02x%02x.%02x%02x "
1214 "%u slots %u ports %s Gbps 0x%x impl %s mode\n"
1217 (vers >> 24) & 0xff,
1218 (vers >> 16) & 0xff,
1222 ((cap >> 8) & 0x1f) + 1,
1228 dev_printk(KERN_INFO, &pdev->dev,
1234 cap & (1 << 31) ? "64bit " : "",
1235 cap & (1 << 30) ? "ncq " : "",
1236 cap & (1 << 28) ? "ilck " : "",
1237 cap & (1 << 27) ? "stag " : "",
1238 cap & (1 << 26) ? "pm " : "",
1239 cap & (1 << 25) ? "led " : "",
1241 cap & (1 << 24) ? "clo " : "",
1242 cap & (1 << 19) ? "nz " : "",
1243 cap & (1 << 18) ? "only " : "",
1244 cap & (1 << 17) ? "pmp " : "",
1245 cap & (1 << 15) ? "pio " : "",
1246 cap & (1 << 14) ? "slum " : "",
1247 cap & (1 << 13) ? "part " : ""
1251 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
1253 static int printed_version;
1254 struct ata_probe_ent *probe_ent = NULL;
1255 struct ahci_host_priv *hpriv;
1257 void __iomem *mmio_base;
1258 unsigned int board_idx = (unsigned int) ent->driver_data;
1259 int have_msi, pci_dev_busy = 0;
1264 if (!printed_version++)
1265 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
1267 rc = pci_enable_device(pdev);
1271 rc = pci_request_regions(pdev, DRV_NAME);
1277 if (pci_enable_msi(pdev) == 0)
1284 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
1285 if (probe_ent == NULL) {
1290 memset(probe_ent, 0, sizeof(*probe_ent));
1291 probe_ent->dev = pci_dev_to_dev(pdev);
1292 INIT_LIST_HEAD(&probe_ent->node);
1294 mmio_base = pci_iomap(pdev, AHCI_PCI_BAR, 0);
1295 if (mmio_base == NULL) {
1297 goto err_out_free_ent;
1299 base = (unsigned long) mmio_base;
1301 hpriv = kmalloc(sizeof(*hpriv), GFP_KERNEL);
1304 goto err_out_iounmap;
1306 memset(hpriv, 0, sizeof(*hpriv));
1308 probe_ent->sht = ahci_port_info[board_idx].sht;
1309 probe_ent->host_flags = ahci_port_info[board_idx].host_flags;
1310 probe_ent->pio_mask = ahci_port_info[board_idx].pio_mask;
1311 probe_ent->udma_mask = ahci_port_info[board_idx].udma_mask;
1312 probe_ent->port_ops = ahci_port_info[board_idx].port_ops;
1314 probe_ent->irq = pdev->irq;
1315 probe_ent->irq_flags = SA_SHIRQ;
1316 probe_ent->mmio_base = mmio_base;
1317 probe_ent->private_data = hpriv;
1320 hpriv->flags |= AHCI_FLAG_MSI;
1322 /* JMicron-specific fixup: make sure we're in AHCI mode */
1323 if (pdev->vendor == 0x197b)
1324 pci_write_config_byte(pdev, 0x41, 0xa1);
1326 /* initialize adapter */
1327 rc = ahci_host_init(probe_ent);
1331 ahci_print_info(probe_ent);
1333 /* FIXME: check ata_device_add return value */
1334 ata_device_add(probe_ent);
1342 pci_iounmap(pdev, mmio_base);
1347 pci_disable_msi(pdev);
1350 pci_release_regions(pdev);
1353 pci_disable_device(pdev);
1357 static void ahci_remove_one (struct pci_dev *pdev)
1359 struct device *dev = pci_dev_to_dev(pdev);
1360 struct ata_host_set *host_set = dev_get_drvdata(dev);
1361 struct ahci_host_priv *hpriv = host_set->private_data;
1362 struct ata_port *ap;
1366 for (i = 0; i < host_set->n_ports; i++) {
1367 ap = host_set->ports[i];
1369 scsi_remove_host(ap->host);
1372 have_msi = hpriv->flags & AHCI_FLAG_MSI;
1373 free_irq(host_set->irq, host_set);
1375 for (i = 0; i < host_set->n_ports; i++) {
1376 ap = host_set->ports[i];
1378 ata_scsi_release(ap->host);
1379 scsi_host_put(ap->host);
1383 pci_iounmap(pdev, host_set->mmio_base);
1387 pci_disable_msi(pdev);
1390 pci_release_regions(pdev);
1391 pci_disable_device(pdev);
1392 dev_set_drvdata(dev, NULL);
1395 static int __init ahci_init(void)
1397 return pci_module_init(&ahci_pci_driver);
1400 static void __exit ahci_exit(void)
1402 pci_unregister_driver(&ahci_pci_driver);
1406 MODULE_AUTHOR("Jeff Garzik");
1407 MODULE_DESCRIPTION("AHCI SATA low-level driver");
1408 MODULE_LICENSE("GPL");
1409 MODULE_DEVICE_TABLE(pci, ahci_pci_tbl);
1410 MODULE_VERSION(DRV_VERSION);
1412 module_init(ahci_init);
1413 module_exit(ahci_exit);