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.2"
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_RESET = (1 << 8),
70 AHCI_CMD_CLR_BUSY = (1 << 10),
72 RX_FIS_D2H_REG = 0x40, /* offset of D2H Register FIS data */
76 /* global controller registers */
77 HOST_CAP = 0x00, /* host capabilities */
78 HOST_CTL = 0x04, /* global host control */
79 HOST_IRQ_STAT = 0x08, /* interrupt status */
80 HOST_PORTS_IMPL = 0x0c, /* bitmap of implemented ports */
81 HOST_VERSION = 0x10, /* AHCI spec. version compliancy */
84 HOST_RESET = (1 << 0), /* reset controller; self-clear */
85 HOST_IRQ_EN = (1 << 1), /* global IRQ enable */
86 HOST_AHCI_EN = (1 << 31), /* AHCI enabled */
89 HOST_CAP_64 = (1 << 31), /* PCI DAC (64-bit DMA) support */
90 HOST_CAP_CLO = (1 << 24), /* Command List Override support */
92 /* registers for each SATA port */
93 PORT_LST_ADDR = 0x00, /* command list DMA addr */
94 PORT_LST_ADDR_HI = 0x04, /* command list DMA addr hi */
95 PORT_FIS_ADDR = 0x08, /* FIS rx buf addr */
96 PORT_FIS_ADDR_HI = 0x0c, /* FIS rx buf addr hi */
97 PORT_IRQ_STAT = 0x10, /* interrupt status */
98 PORT_IRQ_MASK = 0x14, /* interrupt enable/disable mask */
99 PORT_CMD = 0x18, /* port command */
100 PORT_TFDATA = 0x20, /* taskfile data */
101 PORT_SIG = 0x24, /* device TF signature */
102 PORT_CMD_ISSUE = 0x38, /* command issue */
103 PORT_SCR = 0x28, /* SATA phy register block */
104 PORT_SCR_STAT = 0x28, /* SATA phy register: SStatus */
105 PORT_SCR_CTL = 0x2c, /* SATA phy register: SControl */
106 PORT_SCR_ERR = 0x30, /* SATA phy register: SError */
107 PORT_SCR_ACT = 0x34, /* SATA phy register: SActive */
109 /* PORT_IRQ_{STAT,MASK} bits */
110 PORT_IRQ_COLD_PRES = (1 << 31), /* cold presence detect */
111 PORT_IRQ_TF_ERR = (1 << 30), /* task file error */
112 PORT_IRQ_HBUS_ERR = (1 << 29), /* host bus fatal error */
113 PORT_IRQ_HBUS_DATA_ERR = (1 << 28), /* host bus data error */
114 PORT_IRQ_IF_ERR = (1 << 27), /* interface fatal error */
115 PORT_IRQ_IF_NONFATAL = (1 << 26), /* interface non-fatal error */
116 PORT_IRQ_OVERFLOW = (1 << 24), /* xfer exhausted available S/G */
117 PORT_IRQ_BAD_PMP = (1 << 23), /* incorrect port multiplier */
119 PORT_IRQ_PHYRDY = (1 << 22), /* PhyRdy changed */
120 PORT_IRQ_DEV_ILCK = (1 << 7), /* device interlock */
121 PORT_IRQ_CONNECT = (1 << 6), /* port connect change status */
122 PORT_IRQ_SG_DONE = (1 << 5), /* descriptor processed */
123 PORT_IRQ_UNK_FIS = (1 << 4), /* unknown FIS rx'd */
124 PORT_IRQ_SDB_FIS = (1 << 3), /* Set Device Bits FIS rx'd */
125 PORT_IRQ_DMAS_FIS = (1 << 2), /* DMA Setup FIS rx'd */
126 PORT_IRQ_PIOS_FIS = (1 << 1), /* PIO Setup FIS rx'd */
127 PORT_IRQ_D2H_REG_FIS = (1 << 0), /* D2H Register FIS rx'd */
129 PORT_IRQ_FATAL = PORT_IRQ_TF_ERR |
131 PORT_IRQ_HBUS_DATA_ERR |
133 DEF_PORT_IRQ = PORT_IRQ_FATAL | PORT_IRQ_PHYRDY |
134 PORT_IRQ_CONNECT | PORT_IRQ_SG_DONE |
135 PORT_IRQ_UNK_FIS | PORT_IRQ_SDB_FIS |
136 PORT_IRQ_DMAS_FIS | PORT_IRQ_PIOS_FIS |
137 PORT_IRQ_D2H_REG_FIS,
140 PORT_CMD_ATAPI = (1 << 24), /* Device is ATAPI */
141 PORT_CMD_LIST_ON = (1 << 15), /* cmd list DMA engine running */
142 PORT_CMD_FIS_ON = (1 << 14), /* FIS DMA engine running */
143 PORT_CMD_FIS_RX = (1 << 4), /* Enable FIS receive DMA engine */
144 PORT_CMD_CLO = (1 << 3), /* Command list override */
145 PORT_CMD_POWER_ON = (1 << 2), /* Power up device */
146 PORT_CMD_SPIN_UP = (1 << 1), /* Spin up device */
147 PORT_CMD_START = (1 << 0), /* Enable port DMA engine */
149 PORT_CMD_ICC_ACTIVE = (0x1 << 28), /* Put i/f in active state */
150 PORT_CMD_ICC_PARTIAL = (0x2 << 28), /* Put i/f in partial state */
151 PORT_CMD_ICC_SLUMBER = (0x6 << 28), /* Put i/f in slumber state */
153 /* hpriv->flags bits */
154 AHCI_FLAG_MSI = (1 << 0),
157 struct ahci_cmd_hdr {
172 struct ahci_host_priv {
174 u32 cap; /* cache of HOST_CAP register */
175 u32 port_map; /* cache of HOST_PORTS_IMPL reg */
178 struct ahci_port_priv {
179 struct ahci_cmd_hdr *cmd_slot;
180 dma_addr_t cmd_slot_dma;
182 dma_addr_t cmd_tbl_dma;
183 struct ahci_sg *cmd_tbl_sg;
185 dma_addr_t rx_fis_dma;
188 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg);
189 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
190 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
191 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc);
192 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
193 static void ahci_phy_reset(struct ata_port *ap);
194 static void ahci_irq_clear(struct ata_port *ap);
195 static void ahci_eng_timeout(struct ata_port *ap);
196 static int ahci_port_start(struct ata_port *ap);
197 static void ahci_port_stop(struct ata_port *ap);
198 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf);
199 static void ahci_qc_prep(struct ata_queued_cmd *qc);
200 static u8 ahci_check_status(struct ata_port *ap);
201 static inline int ahci_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc);
202 static void ahci_remove_one (struct pci_dev *pdev);
204 static struct scsi_host_template ahci_sht = {
205 .module = THIS_MODULE,
207 .ioctl = ata_scsi_ioctl,
208 .queuecommand = ata_scsi_queuecmd,
209 .eh_strategy_handler = ata_scsi_error,
210 .can_queue = ATA_DEF_QUEUE,
211 .this_id = ATA_SHT_THIS_ID,
212 .sg_tablesize = AHCI_MAX_SG,
213 .max_sectors = ATA_MAX_SECTORS,
214 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
215 .emulated = ATA_SHT_EMULATED,
216 .use_clustering = AHCI_USE_CLUSTERING,
217 .proc_name = DRV_NAME,
218 .dma_boundary = AHCI_DMA_BOUNDARY,
219 .slave_configure = ata_scsi_slave_config,
220 .bios_param = ata_std_bios_param,
223 static const struct ata_port_operations ahci_ops = {
224 .port_disable = ata_port_disable,
226 .check_status = ahci_check_status,
227 .check_altstatus = ahci_check_status,
228 .dev_select = ata_noop_dev_select,
230 .tf_read = ahci_tf_read,
232 .phy_reset = ahci_phy_reset,
234 .qc_prep = ahci_qc_prep,
235 .qc_issue = ahci_qc_issue,
237 .eng_timeout = ahci_eng_timeout,
239 .irq_handler = ahci_interrupt,
240 .irq_clear = ahci_irq_clear,
242 .scr_read = ahci_scr_read,
243 .scr_write = ahci_scr_write,
245 .port_start = ahci_port_start,
246 .port_stop = ahci_port_stop,
249 static const struct ata_port_info ahci_port_info[] = {
253 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
254 ATA_FLAG_SATA_RESET | ATA_FLAG_MMIO |
256 .pio_mask = 0x1f, /* pio0-4 */
257 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
258 .port_ops = &ahci_ops,
262 static const struct pci_device_id ahci_pci_tbl[] = {
263 { PCI_VENDOR_ID_INTEL, 0x2652, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
264 board_ahci }, /* ICH6 */
265 { PCI_VENDOR_ID_INTEL, 0x2653, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
266 board_ahci }, /* ICH6M */
267 { PCI_VENDOR_ID_INTEL, 0x27c1, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
268 board_ahci }, /* ICH7 */
269 { PCI_VENDOR_ID_INTEL, 0x27c5, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
270 board_ahci }, /* ICH7M */
271 { PCI_VENDOR_ID_INTEL, 0x27c3, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
272 board_ahci }, /* ICH7R */
273 { PCI_VENDOR_ID_AL, 0x5288, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
274 board_ahci }, /* ULi M5288 */
275 { PCI_VENDOR_ID_INTEL, 0x2681, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
276 board_ahci }, /* ESB2 */
277 { PCI_VENDOR_ID_INTEL, 0x2682, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
278 board_ahci }, /* ESB2 */
279 { PCI_VENDOR_ID_INTEL, 0x2683, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
280 board_ahci }, /* ESB2 */
281 { PCI_VENDOR_ID_INTEL, 0x27c6, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
282 board_ahci }, /* ICH7-M DH */
283 { PCI_VENDOR_ID_INTEL, 0x2821, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
284 board_ahci }, /* ICH8 */
285 { PCI_VENDOR_ID_INTEL, 0x2822, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
286 board_ahci }, /* ICH8 */
287 { PCI_VENDOR_ID_INTEL, 0x2824, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
288 board_ahci }, /* ICH8 */
289 { PCI_VENDOR_ID_INTEL, 0x2829, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
290 board_ahci }, /* ICH8M */
291 { PCI_VENDOR_ID_INTEL, 0x282a, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
292 board_ahci }, /* ICH8M */
293 { 0x197b, 0x2360, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
294 board_ahci }, /* JMicron JMB360 */
295 { 0x197b, 0x2363, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
296 board_ahci }, /* JMicron JMB363 */
297 { } /* terminate list */
301 static struct pci_driver ahci_pci_driver = {
303 .id_table = ahci_pci_tbl,
304 .probe = ahci_init_one,
305 .remove = ahci_remove_one,
309 static inline unsigned long ahci_port_base_ul (unsigned long base, unsigned int port)
311 return base + 0x100 + (port * 0x80);
314 static inline void __iomem *ahci_port_base (void __iomem *base, unsigned int port)
316 return (void __iomem *) ahci_port_base_ul((unsigned long)base, port);
319 static int ahci_port_start(struct ata_port *ap)
321 struct device *dev = ap->host_set->dev;
322 struct ahci_host_priv *hpriv = ap->host_set->private_data;
323 struct ahci_port_priv *pp;
324 void __iomem *mmio = ap->host_set->mmio_base;
325 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
330 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
333 memset(pp, 0, sizeof(*pp));
335 rc = ata_pad_alloc(ap, dev);
341 mem = dma_alloc_coherent(dev, AHCI_PORT_PRIV_DMA_SZ, &mem_dma, GFP_KERNEL);
343 ata_pad_free(ap, dev);
347 memset(mem, 0, AHCI_PORT_PRIV_DMA_SZ);
350 * First item in chunk of DMA memory: 32-slot command table,
351 * 32 bytes each in size
354 pp->cmd_slot_dma = mem_dma;
356 mem += AHCI_CMD_SLOT_SZ;
357 mem_dma += AHCI_CMD_SLOT_SZ;
360 * Second item: Received-FIS area
363 pp->rx_fis_dma = mem_dma;
365 mem += AHCI_RX_FIS_SZ;
366 mem_dma += AHCI_RX_FIS_SZ;
369 * Third item: data area for storing a single command
370 * and its scatter-gather table
373 pp->cmd_tbl_dma = mem_dma;
375 pp->cmd_tbl_sg = mem + AHCI_CMD_TBL_HDR;
377 ap->private_data = pp;
379 if (hpriv->cap & HOST_CAP_64)
380 writel((pp->cmd_slot_dma >> 16) >> 16, port_mmio + PORT_LST_ADDR_HI);
381 writel(pp->cmd_slot_dma & 0xffffffff, port_mmio + PORT_LST_ADDR);
382 readl(port_mmio + PORT_LST_ADDR); /* flush */
384 if (hpriv->cap & HOST_CAP_64)
385 writel((pp->rx_fis_dma >> 16) >> 16, port_mmio + PORT_FIS_ADDR_HI);
386 writel(pp->rx_fis_dma & 0xffffffff, port_mmio + PORT_FIS_ADDR);
387 readl(port_mmio + PORT_FIS_ADDR); /* flush */
389 writel(PORT_CMD_ICC_ACTIVE | PORT_CMD_FIS_RX |
390 PORT_CMD_POWER_ON | PORT_CMD_SPIN_UP |
391 PORT_CMD_START, port_mmio + PORT_CMD);
392 readl(port_mmio + PORT_CMD); /* flush */
398 static void ahci_port_stop(struct ata_port *ap)
400 struct device *dev = ap->host_set->dev;
401 struct ahci_port_priv *pp = ap->private_data;
402 void __iomem *mmio = ap->host_set->mmio_base;
403 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
406 tmp = readl(port_mmio + PORT_CMD);
407 tmp &= ~(PORT_CMD_START | PORT_CMD_FIS_RX);
408 writel(tmp, port_mmio + PORT_CMD);
409 readl(port_mmio + PORT_CMD); /* flush */
411 /* spec says 500 msecs for each PORT_CMD_{START,FIS_RX} bit, so
412 * this is slightly incorrect.
416 ap->private_data = NULL;
417 dma_free_coherent(dev, AHCI_PORT_PRIV_DMA_SZ,
418 pp->cmd_slot, pp->cmd_slot_dma);
419 ata_pad_free(ap, dev);
423 static u32 ahci_scr_read (struct ata_port *ap, unsigned int sc_reg_in)
428 case SCR_STATUS: sc_reg = 0; break;
429 case SCR_CONTROL: sc_reg = 1; break;
430 case SCR_ERROR: sc_reg = 2; break;
431 case SCR_ACTIVE: sc_reg = 3; break;
436 return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
440 static void ahci_scr_write (struct ata_port *ap, unsigned int sc_reg_in,
446 case SCR_STATUS: sc_reg = 0; break;
447 case SCR_CONTROL: sc_reg = 1; break;
448 case SCR_ERROR: sc_reg = 2; break;
449 case SCR_ACTIVE: sc_reg = 3; break;
454 writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
457 static int ahci_stop_engine(struct ata_port *ap)
459 void __iomem *mmio = ap->host_set->mmio_base;
460 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
464 tmp = readl(port_mmio + PORT_CMD);
465 tmp &= ~PORT_CMD_START;
466 writel(tmp, port_mmio + PORT_CMD);
468 /* wait for engine to stop. TODO: this could be
469 * as long as 500 msec
473 tmp = readl(port_mmio + PORT_CMD);
474 if ((tmp & PORT_CMD_LIST_ON) == 0)
482 static void ahci_start_engine(struct ata_port *ap)
484 void __iomem *mmio = ap->host_set->mmio_base;
485 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
488 tmp = readl(port_mmio + PORT_CMD);
489 tmp |= PORT_CMD_START;
490 writel(tmp, port_mmio + PORT_CMD);
491 readl(port_mmio + PORT_CMD); /* flush */
494 static unsigned int ahci_dev_classify(struct ata_port *ap)
496 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
497 struct ata_taskfile tf;
500 tmp = readl(port_mmio + PORT_SIG);
501 tf.lbah = (tmp >> 24) & 0xff;
502 tf.lbam = (tmp >> 16) & 0xff;
503 tf.lbal = (tmp >> 8) & 0xff;
504 tf.nsect = (tmp) & 0xff;
506 return ata_dev_classify(&tf);
509 static void ahci_phy_reset(struct ata_port *ap)
511 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
512 struct ata_device *dev = &ap->device[0];
515 ahci_stop_engine(ap);
516 __sata_phy_reset(ap);
517 ahci_start_engine(ap);
519 if (ap->flags & ATA_FLAG_PORT_DISABLED)
522 dev->class = ahci_dev_classify(ap);
523 if (!ata_dev_present(dev)) {
524 ata_port_disable(ap);
528 /* Make sure port's ATAPI bit is set appropriately */
529 new_tmp = tmp = readl(port_mmio + PORT_CMD);
530 if (dev->class == ATA_DEV_ATAPI)
531 new_tmp |= PORT_CMD_ATAPI;
533 new_tmp &= ~PORT_CMD_ATAPI;
534 if (new_tmp != tmp) {
535 writel(new_tmp, port_mmio + PORT_CMD);
536 readl(port_mmio + PORT_CMD); /* flush */
540 static u8 ahci_check_status(struct ata_port *ap)
542 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr;
544 return readl(mmio + PORT_TFDATA) & 0xFF;
547 static void ahci_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
549 struct ahci_port_priv *pp = ap->private_data;
550 u8 *d2h_fis = pp->rx_fis + RX_FIS_D2H_REG;
552 ata_tf_from_fis(d2h_fis, tf);
555 static unsigned int ahci_fill_sg(struct ata_queued_cmd *qc)
557 struct ahci_port_priv *pp = qc->ap->private_data;
558 struct scatterlist *sg;
559 struct ahci_sg *ahci_sg;
560 unsigned int n_sg = 0;
565 * Next, the S/G list.
567 ahci_sg = pp->cmd_tbl_sg;
568 ata_for_each_sg(sg, qc) {
569 dma_addr_t addr = sg_dma_address(sg);
570 u32 sg_len = sg_dma_len(sg);
572 ahci_sg->addr = cpu_to_le32(addr & 0xffffffff);
573 ahci_sg->addr_hi = cpu_to_le32((addr >> 16) >> 16);
574 ahci_sg->flags_size = cpu_to_le32(sg_len - 1);
583 static void ahci_qc_prep(struct ata_queued_cmd *qc)
585 struct ata_port *ap = qc->ap;
586 struct ahci_port_priv *pp = ap->private_data;
588 const u32 cmd_fis_len = 5; /* five dwords */
592 * Fill in command slot information (currently only one slot,
593 * slot 0, is currently since we don't do queueing)
597 if (qc->tf.flags & ATA_TFLAG_WRITE)
598 opts |= AHCI_CMD_WRITE;
599 if (is_atapi_taskfile(&qc->tf))
600 opts |= AHCI_CMD_ATAPI;
602 pp->cmd_slot[0].opts = cpu_to_le32(opts);
603 pp->cmd_slot[0].status = 0;
604 pp->cmd_slot[0].tbl_addr = cpu_to_le32(pp->cmd_tbl_dma & 0xffffffff);
605 pp->cmd_slot[0].tbl_addr_hi = cpu_to_le32((pp->cmd_tbl_dma >> 16) >> 16);
608 * Fill in command table information. First, the header,
609 * a SATA Register - Host to Device command FIS.
611 ata_tf_to_fis(&qc->tf, pp->cmd_tbl, 0);
612 if (opts & AHCI_CMD_ATAPI) {
613 memset(pp->cmd_tbl + AHCI_CMD_TBL_CDB, 0, 32);
614 memcpy(pp->cmd_tbl + AHCI_CMD_TBL_CDB, qc->cdb, ap->cdb_len);
617 if (!(qc->flags & ATA_QCFLAG_DMAMAP))
620 n_elem = ahci_fill_sg(qc);
622 pp->cmd_slot[0].opts |= cpu_to_le32(n_elem << 16);
625 static void ahci_restart_port(struct ata_port *ap, u32 irq_stat)
627 void __iomem *mmio = ap->host_set->mmio_base;
628 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
631 if ((ap->device[0].class != ATA_DEV_ATAPI) ||
632 ((irq_stat & PORT_IRQ_TF_ERR) == 0))
633 printk(KERN_WARNING "ata%u: port reset, "
634 "p_is %x is %x pis %x cmd %x tf %x ss %x se %x\n",
637 readl(mmio + HOST_IRQ_STAT),
638 readl(port_mmio + PORT_IRQ_STAT),
639 readl(port_mmio + PORT_CMD),
640 readl(port_mmio + PORT_TFDATA),
641 readl(port_mmio + PORT_SCR_STAT),
642 readl(port_mmio + PORT_SCR_ERR));
645 ahci_stop_engine(ap);
647 /* clear SATA phy error, if any */
648 tmp = readl(port_mmio + PORT_SCR_ERR);
649 writel(tmp, port_mmio + PORT_SCR_ERR);
651 /* if DRQ/BSY is set, device needs to be reset.
652 * if so, issue COMRESET
654 tmp = readl(port_mmio + PORT_TFDATA);
655 if (tmp & (ATA_BUSY | ATA_DRQ)) {
656 writel(0x301, port_mmio + PORT_SCR_CTL);
657 readl(port_mmio + PORT_SCR_CTL); /* flush */
659 writel(0x300, port_mmio + PORT_SCR_CTL);
660 readl(port_mmio + PORT_SCR_CTL); /* flush */
664 ahci_start_engine(ap);
667 static void ahci_eng_timeout(struct ata_port *ap)
669 struct ata_host_set *host_set = ap->host_set;
670 void __iomem *mmio = host_set->mmio_base;
671 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
672 struct ata_queued_cmd *qc;
675 printk(KERN_WARNING "ata%u: handling error/timeout\n", ap->id);
677 spin_lock_irqsave(&host_set->lock, flags);
679 qc = ata_qc_from_tag(ap, ap->active_tag);
681 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
684 ahci_restart_port(ap, readl(port_mmio + PORT_IRQ_STAT));
685 qc->err_mask |= AC_ERR_TIMEOUT;
688 spin_unlock_irqrestore(&host_set->lock, flags);
691 ata_eh_qc_complete(qc);
694 static inline int ahci_host_intr(struct ata_port *ap, struct ata_queued_cmd *qc)
696 void __iomem *mmio = ap->host_set->mmio_base;
697 void __iomem *port_mmio = ahci_port_base(mmio, ap->port_no);
698 u32 status, serr, ci;
700 serr = readl(port_mmio + PORT_SCR_ERR);
701 writel(serr, port_mmio + PORT_SCR_ERR);
703 status = readl(port_mmio + PORT_IRQ_STAT);
704 writel(status, port_mmio + PORT_IRQ_STAT);
706 ci = readl(port_mmio + PORT_CMD_ISSUE);
707 if (likely((ci & 0x1) == 0)) {
709 assert(qc->err_mask == 0);
715 if (status & PORT_IRQ_FATAL) {
716 unsigned int err_mask;
717 if (status & PORT_IRQ_TF_ERR)
718 err_mask = AC_ERR_DEV;
719 else if (status & PORT_IRQ_IF_ERR)
720 err_mask = AC_ERR_ATA_BUS;
722 err_mask = AC_ERR_HOST_BUS;
724 /* command processing has stopped due to error; restart */
725 ahci_restart_port(ap, status);
728 qc->err_mask |= err_mask;
736 static void ahci_irq_clear(struct ata_port *ap)
741 static irqreturn_t ahci_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
743 struct ata_host_set *host_set = dev_instance;
744 struct ahci_host_priv *hpriv;
745 unsigned int i, handled = 0;
747 u32 irq_stat, irq_ack = 0;
751 hpriv = host_set->private_data;
752 mmio = host_set->mmio_base;
754 /* sigh. 0xffffffff is a valid return from h/w */
755 irq_stat = readl(mmio + HOST_IRQ_STAT);
756 irq_stat &= hpriv->port_map;
760 spin_lock(&host_set->lock);
762 for (i = 0; i < host_set->n_ports; i++) {
765 if (!(irq_stat & (1 << i)))
768 ap = host_set->ports[i];
770 struct ata_queued_cmd *qc;
771 qc = ata_qc_from_tag(ap, ap->active_tag);
772 if (!ahci_host_intr(ap, qc))
773 if (ata_ratelimit()) {
774 struct pci_dev *pdev =
775 to_pci_dev(ap->host_set->dev);
776 dev_printk(KERN_WARNING, &pdev->dev,
777 "unhandled interrupt on port %u\n",
781 VPRINTK("port %u\n", i);
783 VPRINTK("port %u (no irq)\n", i);
784 if (ata_ratelimit()) {
785 struct pci_dev *pdev =
786 to_pci_dev(ap->host_set->dev);
787 dev_printk(KERN_WARNING, &pdev->dev,
788 "interrupt on disabled port %u\n", i);
796 writel(irq_ack, mmio + HOST_IRQ_STAT);
800 spin_unlock(&host_set->lock);
804 return IRQ_RETVAL(handled);
807 static unsigned int ahci_qc_issue(struct ata_queued_cmd *qc)
809 struct ata_port *ap = qc->ap;
810 void __iomem *port_mmio = (void __iomem *) ap->ioaddr.cmd_addr;
812 writel(1, port_mmio + PORT_CMD_ISSUE);
813 readl(port_mmio + PORT_CMD_ISSUE); /* flush */
818 static void ahci_setup_port(struct ata_ioports *port, unsigned long base,
819 unsigned int port_idx)
821 VPRINTK("ENTER, base==0x%lx, port_idx %u\n", base, port_idx);
822 base = ahci_port_base_ul(base, port_idx);
823 VPRINTK("base now==0x%lx\n", base);
825 port->cmd_addr = base;
826 port->scr_addr = base + PORT_SCR;
831 static int ahci_host_init(struct ata_probe_ent *probe_ent)
833 struct ahci_host_priv *hpriv = probe_ent->private_data;
834 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
835 void __iomem *mmio = probe_ent->mmio_base;
837 unsigned int i, j, using_dac;
839 void __iomem *port_mmio;
841 cap_save = readl(mmio + HOST_CAP);
842 cap_save &= ( (1<<28) | (1<<17) );
843 cap_save |= (1 << 27);
845 /* global controller reset */
846 tmp = readl(mmio + HOST_CTL);
847 if ((tmp & HOST_RESET) == 0) {
848 writel(tmp | HOST_RESET, mmio + HOST_CTL);
849 readl(mmio + HOST_CTL); /* flush */
852 /* reset must complete within 1 second, or
853 * the hardware should be considered fried.
857 tmp = readl(mmio + HOST_CTL);
858 if (tmp & HOST_RESET) {
859 dev_printk(KERN_ERR, &pdev->dev,
860 "controller reset failed (0x%x)\n", tmp);
864 writel(HOST_AHCI_EN, mmio + HOST_CTL);
865 (void) readl(mmio + HOST_CTL); /* flush */
866 writel(cap_save, mmio + HOST_CAP);
867 writel(0xf, mmio + HOST_PORTS_IMPL);
868 (void) readl(mmio + HOST_PORTS_IMPL); /* flush */
870 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
873 pci_read_config_word(pdev, 0x92, &tmp16);
875 pci_write_config_word(pdev, 0x92, tmp16);
878 hpriv->cap = readl(mmio + HOST_CAP);
879 hpriv->port_map = readl(mmio + HOST_PORTS_IMPL);
880 probe_ent->n_ports = (hpriv->cap & 0x1f) + 1;
882 VPRINTK("cap 0x%x port_map 0x%x n_ports %d\n",
883 hpriv->cap, hpriv->port_map, probe_ent->n_ports);
885 using_dac = hpriv->cap & HOST_CAP_64;
887 !pci_set_dma_mask(pdev, DMA_64BIT_MASK)) {
888 rc = pci_set_consistent_dma_mask(pdev, DMA_64BIT_MASK);
890 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
892 dev_printk(KERN_ERR, &pdev->dev,
893 "64-bit DMA enable failed\n");
898 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
900 dev_printk(KERN_ERR, &pdev->dev,
901 "32-bit DMA enable failed\n");
904 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
906 dev_printk(KERN_ERR, &pdev->dev,
907 "32-bit consistent DMA enable failed\n");
912 for (i = 0; i < probe_ent->n_ports; i++) {
913 #if 0 /* BIOSen initialize this incorrectly */
914 if (!(hpriv->port_map & (1 << i)))
918 port_mmio = ahci_port_base(mmio, i);
919 VPRINTK("mmio %p port_mmio %p\n", mmio, port_mmio);
921 ahci_setup_port(&probe_ent->port[i],
922 (unsigned long) mmio, i);
924 /* make sure port is not active */
925 tmp = readl(port_mmio + PORT_CMD);
926 VPRINTK("PORT_CMD 0x%x\n", tmp);
927 if (tmp & (PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
928 PORT_CMD_FIS_RX | PORT_CMD_START)) {
929 tmp &= ~(PORT_CMD_LIST_ON | PORT_CMD_FIS_ON |
930 PORT_CMD_FIS_RX | PORT_CMD_START);
931 writel(tmp, port_mmio + PORT_CMD);
932 readl(port_mmio + PORT_CMD); /* flush */
934 /* spec says 500 msecs for each bit, so
935 * this is slightly incorrect.
940 writel(PORT_CMD_SPIN_UP, port_mmio + PORT_CMD);
945 tmp = readl(port_mmio + PORT_SCR_STAT);
946 if ((tmp & 0xf) == 0x3)
951 tmp = readl(port_mmio + PORT_SCR_ERR);
952 VPRINTK("PORT_SCR_ERR 0x%x\n", tmp);
953 writel(tmp, port_mmio + PORT_SCR_ERR);
955 /* ack any pending irq events for this port */
956 tmp = readl(port_mmio + PORT_IRQ_STAT);
957 VPRINTK("PORT_IRQ_STAT 0x%x\n", tmp);
959 writel(tmp, port_mmio + PORT_IRQ_STAT);
961 writel(1 << i, mmio + HOST_IRQ_STAT);
963 /* set irq mask (enables interrupts) */
964 writel(DEF_PORT_IRQ, port_mmio + PORT_IRQ_MASK);
967 tmp = readl(mmio + HOST_CTL);
968 VPRINTK("HOST_CTL 0x%x\n", tmp);
969 writel(tmp | HOST_IRQ_EN, mmio + HOST_CTL);
970 tmp = readl(mmio + HOST_CTL);
971 VPRINTK("HOST_CTL 0x%x\n", tmp);
973 pci_set_master(pdev);
978 static void ahci_print_info(struct ata_probe_ent *probe_ent)
980 struct ahci_host_priv *hpriv = probe_ent->private_data;
981 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
982 void __iomem *mmio = probe_ent->mmio_base;
983 u32 vers, cap, impl, speed;
988 vers = readl(mmio + HOST_VERSION);
990 impl = hpriv->port_map;
992 speed = (cap >> 20) & 0xf;
1000 pci_read_config_word(pdev, 0x0a, &cc);
1003 else if (cc == 0x0106)
1005 else if (cc == 0x0104)
1010 dev_printk(KERN_INFO, &pdev->dev,
1011 "AHCI %02x%02x.%02x%02x "
1012 "%u slots %u ports %s Gbps 0x%x impl %s mode\n"
1015 (vers >> 24) & 0xff,
1016 (vers >> 16) & 0xff,
1020 ((cap >> 8) & 0x1f) + 1,
1026 dev_printk(KERN_INFO, &pdev->dev,
1032 cap & (1 << 31) ? "64bit " : "",
1033 cap & (1 << 30) ? "ncq " : "",
1034 cap & (1 << 28) ? "ilck " : "",
1035 cap & (1 << 27) ? "stag " : "",
1036 cap & (1 << 26) ? "pm " : "",
1037 cap & (1 << 25) ? "led " : "",
1039 cap & (1 << 24) ? "clo " : "",
1040 cap & (1 << 19) ? "nz " : "",
1041 cap & (1 << 18) ? "only " : "",
1042 cap & (1 << 17) ? "pmp " : "",
1043 cap & (1 << 15) ? "pio " : "",
1044 cap & (1 << 14) ? "slum " : "",
1045 cap & (1 << 13) ? "part " : ""
1049 static int ahci_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
1051 static int printed_version;
1052 struct ata_probe_ent *probe_ent = NULL;
1053 struct ahci_host_priv *hpriv;
1055 void __iomem *mmio_base;
1056 unsigned int board_idx = (unsigned int) ent->driver_data;
1057 int have_msi, pci_dev_busy = 0;
1062 if (!printed_version++)
1063 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
1065 rc = pci_enable_device(pdev);
1069 rc = pci_request_regions(pdev, DRV_NAME);
1075 if (pci_enable_msi(pdev) == 0)
1082 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
1083 if (probe_ent == NULL) {
1088 memset(probe_ent, 0, sizeof(*probe_ent));
1089 probe_ent->dev = pci_dev_to_dev(pdev);
1090 INIT_LIST_HEAD(&probe_ent->node);
1092 mmio_base = pci_iomap(pdev, AHCI_PCI_BAR, 0);
1093 if (mmio_base == NULL) {
1095 goto err_out_free_ent;
1097 base = (unsigned long) mmio_base;
1099 hpriv = kmalloc(sizeof(*hpriv), GFP_KERNEL);
1102 goto err_out_iounmap;
1104 memset(hpriv, 0, sizeof(*hpriv));
1106 probe_ent->sht = ahci_port_info[board_idx].sht;
1107 probe_ent->host_flags = ahci_port_info[board_idx].host_flags;
1108 probe_ent->pio_mask = ahci_port_info[board_idx].pio_mask;
1109 probe_ent->udma_mask = ahci_port_info[board_idx].udma_mask;
1110 probe_ent->port_ops = ahci_port_info[board_idx].port_ops;
1112 probe_ent->irq = pdev->irq;
1113 probe_ent->irq_flags = SA_SHIRQ;
1114 probe_ent->mmio_base = mmio_base;
1115 probe_ent->private_data = hpriv;
1118 hpriv->flags |= AHCI_FLAG_MSI;
1120 /* JMicron-specific fixup: make sure we're in AHCI mode */
1121 if (pdev->vendor == 0x197b)
1122 pci_write_config_byte(pdev, 0x41, 0xa1);
1124 /* initialize adapter */
1125 rc = ahci_host_init(probe_ent);
1129 ahci_print_info(probe_ent);
1131 /* FIXME: check ata_device_add return value */
1132 ata_device_add(probe_ent);
1140 pci_iounmap(pdev, mmio_base);
1145 pci_disable_msi(pdev);
1148 pci_release_regions(pdev);
1151 pci_disable_device(pdev);
1155 static void ahci_remove_one (struct pci_dev *pdev)
1157 struct device *dev = pci_dev_to_dev(pdev);
1158 struct ata_host_set *host_set = dev_get_drvdata(dev);
1159 struct ahci_host_priv *hpriv = host_set->private_data;
1160 struct ata_port *ap;
1164 for (i = 0; i < host_set->n_ports; i++) {
1165 ap = host_set->ports[i];
1167 scsi_remove_host(ap->host);
1170 have_msi = hpriv->flags & AHCI_FLAG_MSI;
1171 free_irq(host_set->irq, host_set);
1173 for (i = 0; i < host_set->n_ports; i++) {
1174 ap = host_set->ports[i];
1176 ata_scsi_release(ap->host);
1177 scsi_host_put(ap->host);
1181 pci_iounmap(pdev, host_set->mmio_base);
1185 pci_disable_msi(pdev);
1188 pci_release_regions(pdev);
1189 pci_disable_device(pdev);
1190 dev_set_drvdata(dev, NULL);
1193 static int __init ahci_init(void)
1195 return pci_module_init(&ahci_pci_driver);
1198 static void __exit ahci_exit(void)
1200 pci_unregister_driver(&ahci_pci_driver);
1204 MODULE_AUTHOR("Jeff Garzik");
1205 MODULE_DESCRIPTION("AHCI SATA low-level driver");
1206 MODULE_LICENSE("GPL");
1207 MODULE_DEVICE_TABLE(pci, ahci_pci_tbl);
1208 MODULE_VERSION(DRV_VERSION);
1210 module_init(ahci_init);
1211 module_exit(ahci_exit);