2 * Copyright (c) 2003-2006 Silicon Graphics, Inc. All Rights Reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of version 2 of the GNU General Public License
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it would be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12 * You should have received a copy of the GNU General Public
13 * License along with this program; if not, write the Free Software
14 * Foundation, Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
16 * For further information regarding this notice, see:
18 * http://oss.sgi.com/projects/GenInfo/NoticeExplan
21 #include <linux/module.h>
22 #include <linux/types.h>
23 #include <linux/pci.h>
24 #include <linux/delay.h>
25 #include <linux/hdreg.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/timer.h>
30 #include <linux/ioport.h>
31 #include <linux/blkdev.h>
32 #include <linux/ioc4.h>
35 #include <linux/ide.h>
37 #define DRV_NAME "SGIIOC4"
39 /* IOC4 Specific Definitions */
40 #define IOC4_CMD_OFFSET 0x100
41 #define IOC4_CTRL_OFFSET 0x120
42 #define IOC4_DMA_OFFSET 0x140
43 #define IOC4_INTR_OFFSET 0x0
45 #define IOC4_TIMING 0x00
46 #define IOC4_DMA_PTR_L 0x01
47 #define IOC4_DMA_PTR_H 0x02
48 #define IOC4_DMA_ADDR_L 0x03
49 #define IOC4_DMA_ADDR_H 0x04
50 #define IOC4_BC_DEV 0x05
51 #define IOC4_BC_MEM 0x06
52 #define IOC4_DMA_CTRL 0x07
53 #define IOC4_DMA_END_ADDR 0x08
55 /* Bits in the IOC4 Control/Status Register */
56 #define IOC4_S_DMA_START 0x01
57 #define IOC4_S_DMA_STOP 0x02
58 #define IOC4_S_DMA_DIR 0x04
59 #define IOC4_S_DMA_ACTIVE 0x08
60 #define IOC4_S_DMA_ERROR 0x10
61 #define IOC4_ATA_MEMERR 0x02
63 /* Read/Write Directions */
64 #define IOC4_DMA_WRITE 0x04
65 #define IOC4_DMA_READ 0x00
67 /* Interrupt Register Offsets */
68 #define IOC4_INTR_REG 0x03
69 #define IOC4_INTR_SET 0x05
70 #define IOC4_INTR_CLEAR 0x07
72 #define IOC4_IDE_CACHELINE_SIZE 128
73 #define IOC4_CMD_CTL_BLK_SIZE 0x20
74 #define IOC4_SUPPORTED_FIRMWARE_REV 46
88 /* Each Physical Region Descriptor Entry size is 16 bytes (2 * 64 bits) */
89 /* IOC4 has only 1 IDE channel */
90 #define IOC4_PRD_BYTES 16
91 #define IOC4_PRD_ENTRIES (PAGE_SIZE /(4*IOC4_PRD_BYTES))
95 sgiioc4_init_hwif_ports(hw_regs_t * hw, unsigned long data_port,
96 unsigned long ctrl_port, unsigned long irq_port)
98 unsigned long reg = data_port;
101 /* Registers are word (32 bit) aligned */
102 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
103 hw->io_ports[i] = reg + i * 4;
106 hw->io_ports[IDE_CONTROL_OFFSET] = ctrl_port;
109 hw->io_ports[IDE_IRQ_OFFSET] = irq_port;
113 sgiioc4_maskproc(ide_drive_t * drive, int mask)
115 writeb(mask ? (drive->ctl | 2) : (drive->ctl & ~2),
116 (void __iomem *)IDE_CONTROL_REG);
121 sgiioc4_checkirq(ide_hwif_t * hwif)
123 unsigned long intr_addr =
124 hwif->io_ports[IDE_IRQ_OFFSET] + IOC4_INTR_REG * 4;
126 if ((u8)readl((void __iomem *)intr_addr) & 0x03)
132 static u8 sgiioc4_INB(unsigned long);
135 sgiioc4_clearirq(ide_drive_t * drive)
138 ide_hwif_t *hwif = HWIF(drive);
139 unsigned long other_ir =
140 hwif->io_ports[IDE_IRQ_OFFSET] + (IOC4_INTR_REG << 2);
142 /* Code to check for PCI error conditions */
143 intr_reg = readl((void __iomem *)other_ir);
144 if (intr_reg & 0x03) { /* Valid IOC4-IDE interrupt */
146 * Using sgiioc4_INB to read the IDE_STATUS_REG has a side effect
147 * of clearing the interrupt. The first read should clear it
148 * if it is set. The second read should return a "clear" status
149 * if it got cleared. If not, then spin for a bit trying to
152 u8 stat = sgiioc4_INB(IDE_STATUS_REG);
154 stat = sgiioc4_INB(IDE_STATUS_REG);
155 while ((stat & 0x80) && (count++ < 100)) {
157 stat = sgiioc4_INB(IDE_STATUS_REG);
160 if (intr_reg & 0x02) {
161 /* Error when transferring DMA data on PCI bus */
162 u32 pci_err_addr_low, pci_err_addr_high,
166 readl((void __iomem *)hwif->io_ports[IDE_IRQ_OFFSET]);
168 readl((void __iomem *)(hwif->io_ports[IDE_IRQ_OFFSET] + 4));
169 pci_read_config_dword(hwif->pci_dev, PCI_COMMAND,
172 "%s(%s) : PCI Bus Error when doing DMA:"
173 " status-cmd reg is 0x%x\n",
174 __FUNCTION__, drive->name, pci_stat_cmd_reg);
176 "%s(%s) : PCI Error Address is 0x%x%x\n",
177 __FUNCTION__, drive->name,
178 pci_err_addr_high, pci_err_addr_low);
179 /* Clear the PCI Error indicator */
180 pci_write_config_dword(hwif->pci_dev, PCI_COMMAND,
184 /* Clear the Interrupt, Error bits on the IOC4 */
185 writel(0x03, (void __iomem *)other_ir);
187 intr_reg = readl((void __iomem *)other_ir);
193 static void sgiioc4_ide_dma_start(ide_drive_t * drive)
195 ide_hwif_t *hwif = HWIF(drive);
196 unsigned long ioc4_dma_addr = hwif->dma_base + IOC4_DMA_CTRL * 4;
197 unsigned int reg = readl((void __iomem *)ioc4_dma_addr);
198 unsigned int temp_reg = reg | IOC4_S_DMA_START;
200 writel(temp_reg, (void __iomem *)ioc4_dma_addr);
204 sgiioc4_ide_dma_stop(ide_hwif_t *hwif, u64 dma_base)
206 unsigned long ioc4_dma_addr = dma_base + IOC4_DMA_CTRL * 4;
211 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
212 while ((ioc4_dma & IOC4_S_DMA_STOP) && (count++ < 200)) {
214 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
219 /* Stops the IOC4 DMA Engine */
221 sgiioc4_ide_dma_end(ide_drive_t * drive)
223 u32 ioc4_dma, bc_dev, bc_mem, num, valid = 0, cnt = 0;
224 ide_hwif_t *hwif = HWIF(drive);
225 unsigned long dma_base = hwif->dma_base;
227 unsigned long *ending_dma = ide_get_hwifdata(hwif);
229 writel(IOC4_S_DMA_STOP, (void __iomem *)(dma_base + IOC4_DMA_CTRL * 4));
231 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
233 if (ioc4_dma & IOC4_S_DMA_STOP) {
235 "%s(%s): IOC4 DMA STOP bit is still 1 :"
236 "ioc4_dma_reg 0x%x\n",
237 __FUNCTION__, drive->name, ioc4_dma);
242 * The IOC4 will DMA 1's to the ending dma area to indicate that
243 * previous data DMA is complete. This is necessary because of relaxed
244 * ordering between register reads and DMA writes on the Altix.
246 while ((cnt++ < 200) && (!valid)) {
247 for (num = 0; num < 16; num++) {
248 if (ending_dma[num]) {
256 printk(KERN_ERR "%s(%s) : DMA incomplete\n", __FUNCTION__,
261 bc_dev = readl((void __iomem *)(dma_base + IOC4_BC_DEV * 4));
262 bc_mem = readl((void __iomem *)(dma_base + IOC4_BC_MEM * 4));
264 if ((bc_dev & 0x01FF) || (bc_mem & 0x1FF)) {
265 if (bc_dev > bc_mem + 8) {
267 "%s(%s): WARNING!! byte_count_dev %d "
268 "!= byte_count_mem %d\n",
269 __FUNCTION__, drive->name, bc_dev, bc_mem);
273 drive->waiting_for_dma = 0;
274 ide_destroy_dmatable(drive);
280 sgiioc4_ide_dma_on(ide_drive_t * drive)
282 drive->using_dma = 1;
287 static void sgiioc4_dma_off_quietly(ide_drive_t *drive)
289 drive->using_dma = 0;
291 drive->hwif->dma_host_off(drive);
294 static void sgiioc4_set_dma_mode(ide_drive_t *drive, const u8 speed)
298 static int sgiioc4_ide_dma_check(ide_drive_t *drive)
300 if (ide_tune_dma(drive))
304 * ->set_pio_mode is not implemented currently
305 * so this is just for the completness
307 ide_set_max_pio(drive);
312 /* returns 1 if dma irq issued, 0 otherwise */
314 sgiioc4_ide_dma_test_irq(ide_drive_t * drive)
316 return sgiioc4_checkirq(HWIF(drive));
319 static void sgiioc4_dma_host_on(ide_drive_t * drive)
323 static void sgiioc4_dma_host_off(ide_drive_t * drive)
325 sgiioc4_clearirq(drive);
329 sgiioc4_resetproc(ide_drive_t * drive)
331 sgiioc4_ide_dma_end(drive);
332 sgiioc4_clearirq(drive);
336 sgiioc4_dma_lost_irq(ide_drive_t * drive)
338 sgiioc4_resetproc(drive);
340 ide_dma_lost_irq(drive);
344 sgiioc4_INB(unsigned long port)
346 u8 reg = (u8) readb((void __iomem *) port);
348 if ((port & 0xFFF) == 0x11C) { /* Status register of IOC4 */
349 if (reg & 0x51) { /* Not busy...check for interrupt */
350 unsigned long other_ir = port - 0x110;
351 unsigned int intr_reg = (u32) readl((void __iomem *) other_ir);
353 /* Clear the Interrupt, Error bits on the IOC4 */
354 if (intr_reg & 0x03) {
355 writel(0x03, (void __iomem *) other_ir);
356 intr_reg = (u32) readl((void __iomem *) other_ir);
364 /* Creates a dma map for the scatter-gather list entries */
366 ide_dma_sgiioc4(ide_hwif_t * hwif, unsigned long dma_base)
368 void __iomem *virt_dma_base;
369 int num_ports = sizeof (ioc4_dma_regs_t);
372 printk(KERN_INFO "%s: BM-DMA at 0x%04lx-0x%04lx\n", hwif->name,
373 dma_base, dma_base + num_ports - 1);
375 if (!request_mem_region(dma_base, num_ports, hwif->name)) {
377 "%s(%s) -- ERROR, Addresses 0x%p to 0x%p "
379 __FUNCTION__, hwif->name, (void *) dma_base,
380 (void *) dma_base + num_ports - 1);
384 virt_dma_base = ioremap(dma_base, num_ports);
385 if (virt_dma_base == NULL) {
387 "%s(%s) -- ERROR, Unable to map addresses 0x%lx to 0x%lx\n",
388 __FUNCTION__, hwif->name, dma_base, dma_base + num_ports - 1);
389 goto dma_remap_failure;
391 hwif->dma_base = (unsigned long) virt_dma_base;
393 hwif->dmatable_cpu = pci_alloc_consistent(hwif->pci_dev,
394 IOC4_PRD_ENTRIES * IOC4_PRD_BYTES,
395 &hwif->dmatable_dma);
397 if (!hwif->dmatable_cpu)
398 goto dma_pci_alloc_failure;
400 hwif->sg_max_nents = IOC4_PRD_ENTRIES;
402 pad = pci_alloc_consistent(hwif->pci_dev, IOC4_IDE_CACHELINE_SIZE,
403 (dma_addr_t *) &(hwif->dma_status));
406 ide_set_hwifdata(hwif, pad);
410 pci_free_consistent(hwif->pci_dev,
411 IOC4_PRD_ENTRIES * IOC4_PRD_BYTES,
412 hwif->dmatable_cpu, hwif->dmatable_dma);
414 "%s() -- Error! Unable to allocate DMA Maps for drive %s\n",
415 __FUNCTION__, hwif->name);
417 "Changing from DMA to PIO mode for Drive %s\n", hwif->name);
419 dma_pci_alloc_failure:
420 iounmap(virt_dma_base);
423 release_mem_region(dma_base, num_ports);
428 /* Initializes the IOC4 DMA Engine */
430 sgiioc4_configure_for_dma(int dma_direction, ide_drive_t * drive)
433 ide_hwif_t *hwif = HWIF(drive);
434 unsigned long dma_base = hwif->dma_base;
435 unsigned long ioc4_dma_addr = dma_base + IOC4_DMA_CTRL * 4;
436 u32 dma_addr, ending_dma_addr;
438 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
440 if (ioc4_dma & IOC4_S_DMA_ACTIVE) {
442 "%s(%s):Warning!! DMA from previous transfer was still active\n",
443 __FUNCTION__, drive->name);
444 writel(IOC4_S_DMA_STOP, (void __iomem *)ioc4_dma_addr);
445 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
447 if (ioc4_dma & IOC4_S_DMA_STOP)
449 "%s(%s) : IOC4 Dma STOP bit is still 1\n",
450 __FUNCTION__, drive->name);
453 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
454 if (ioc4_dma & IOC4_S_DMA_ERROR) {
456 "%s(%s) : Warning!! - DMA Error during Previous"
457 " transfer | status 0x%x\n",
458 __FUNCTION__, drive->name, ioc4_dma);
459 writel(IOC4_S_DMA_STOP, (void __iomem *)ioc4_dma_addr);
460 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
462 if (ioc4_dma & IOC4_S_DMA_STOP)
464 "%s(%s) : IOC4 DMA STOP bit is still 1\n",
465 __FUNCTION__, drive->name);
468 /* Address of the Scatter Gather List */
469 dma_addr = cpu_to_le32(hwif->dmatable_dma);
470 writel(dma_addr, (void __iomem *)(dma_base + IOC4_DMA_PTR_L * 4));
472 /* Address of the Ending DMA */
473 memset(ide_get_hwifdata(hwif), 0, IOC4_IDE_CACHELINE_SIZE);
474 ending_dma_addr = cpu_to_le32(hwif->dma_status);
475 writel(ending_dma_addr, (void __iomem *)(dma_base + IOC4_DMA_END_ADDR * 4));
477 writel(dma_direction, (void __iomem *)ioc4_dma_addr);
478 drive->waiting_for_dma = 1;
481 /* IOC4 Scatter Gather list Format */
482 /* 128 Bit entries to support 64 bit addresses in the future */
483 /* The Scatter Gather list Entry should be in the BIG-ENDIAN Format */
484 /* --------------------------------------------------------------------- */
485 /* | Upper 32 bits - Zero | Lower 32 bits- address | */
486 /* --------------------------------------------------------------------- */
487 /* | Upper 32 bits - Zero |EOL| 15 unused | 16 Bit Length| */
488 /* --------------------------------------------------------------------- */
489 /* Creates the scatter gather list, DMA Table */
491 sgiioc4_build_dma_table(ide_drive_t * drive, struct request *rq, int ddir)
493 ide_hwif_t *hwif = HWIF(drive);
494 unsigned int *table = hwif->dmatable_cpu;
495 unsigned int count = 0, i = 1;
496 struct scatterlist *sg;
498 hwif->sg_nents = i = ide_build_sglist(drive, rq);
501 return 0; /* sglist of length Zero */
504 while (i && sg_dma_len(sg)) {
507 cur_addr = sg_dma_address(sg);
508 cur_len = sg_dma_len(sg);
511 if (count++ >= IOC4_PRD_ENTRIES) {
513 "%s: DMA table too small\n",
515 goto use_pio_instead;
518 0x10000 - (cur_addr & 0xffff);
520 if (bcount > cur_len)
523 /* put the addr, length in
524 * the IOC4 dma-table format */
527 *table = cpu_to_be32(cur_addr);
532 *table = cpu_to_be32(bcount);
546 *table |= cpu_to_be32(0x80000000);
551 pci_unmap_sg(hwif->pci_dev, hwif->sg_table, hwif->sg_nents,
552 hwif->sg_dma_direction);
554 return 0; /* revert to PIO for this request */
557 static int sgiioc4_ide_dma_setup(ide_drive_t *drive)
559 struct request *rq = HWGROUP(drive)->rq;
560 unsigned int count = 0;
564 ddir = PCI_DMA_TODEVICE;
566 ddir = PCI_DMA_FROMDEVICE;
568 if (!(count = sgiioc4_build_dma_table(drive, rq, ddir))) {
569 /* try PIO instead of DMA */
570 ide_map_sg(drive, rq);
575 /* Writes TO the IOC4 FROM Main Memory */
576 ddir = IOC4_DMA_READ;
578 /* Writes FROM the IOC4 TO Main Memory */
579 ddir = IOC4_DMA_WRITE;
581 sgiioc4_configure_for_dma(ddir, drive);
586 static void __devinit
587 ide_init_sgiioc4(ide_hwif_t * hwif)
590 hwif->pio_mask = 0x00;
591 hwif->set_pio_mode = NULL; /* Sets timing for PIO mode */
592 hwif->set_dma_mode = &sgiioc4_set_dma_mode;
593 hwif->selectproc = NULL;/* Use the default routine to select drive */
594 hwif->reset_poll = NULL;/* No HBA specific reset_poll needed */
595 hwif->pre_reset = NULL; /* No HBA specific pre_set needed */
596 hwif->resetproc = &sgiioc4_resetproc;/* Reset DMA engine,
598 hwif->intrproc = NULL; /* Enable or Disable interrupt from drive */
599 hwif->maskproc = &sgiioc4_maskproc; /* Mask on/off NIEN register */
600 hwif->quirkproc = NULL;
601 hwif->busproc = NULL;
603 hwif->INB = &sgiioc4_INB;
605 if (hwif->dma_base == 0)
609 hwif->mwdma_mask = 0x04;
611 hwif->dma_setup = &sgiioc4_ide_dma_setup;
612 hwif->dma_start = &sgiioc4_ide_dma_start;
613 hwif->ide_dma_end = &sgiioc4_ide_dma_end;
614 hwif->ide_dma_check = &sgiioc4_ide_dma_check;
615 hwif->ide_dma_on = &sgiioc4_ide_dma_on;
616 hwif->dma_off_quietly = &sgiioc4_dma_off_quietly;
617 hwif->ide_dma_test_irq = &sgiioc4_ide_dma_test_irq;
618 hwif->dma_host_on = &sgiioc4_dma_host_on;
619 hwif->dma_host_off = &sgiioc4_dma_host_off;
620 hwif->dma_lost_irq = &sgiioc4_dma_lost_irq;
621 hwif->dma_timeout = &ide_dma_timeout;
625 sgiioc4_ide_setup_pci_device(struct pci_dev *dev)
627 unsigned long cmd_base, dma_base, irqport;
628 unsigned long bar0, cmd_phys_base, ctl;
629 void __iomem *virt_base;
634 * Find an empty HWIF; if none available, return -ENOMEM.
636 for (h = 0; h < MAX_HWIFS; ++h) {
637 hwif = &ide_hwifs[h];
638 if (hwif->chipset == ide_unknown)
641 if (h == MAX_HWIFS) {
642 printk(KERN_ERR "%s: too many IDE interfaces, no room in table\n",
647 /* Get the CmdBlk and CtrlBlk Base Registers */
648 bar0 = pci_resource_start(dev, 0);
649 virt_base = ioremap(bar0, pci_resource_len(dev, 0));
650 if (virt_base == NULL) {
651 printk(KERN_ERR "%s: Unable to remap BAR 0 address: 0x%lx\n",
655 cmd_base = (unsigned long) virt_base + IOC4_CMD_OFFSET;
656 ctl = (unsigned long) virt_base + IOC4_CTRL_OFFSET;
657 irqport = (unsigned long) virt_base + IOC4_INTR_OFFSET;
658 dma_base = pci_resource_start(dev, 0) + IOC4_DMA_OFFSET;
660 cmd_phys_base = bar0 + IOC4_CMD_OFFSET;
661 if (!request_mem_region(cmd_phys_base, IOC4_CMD_CTL_BLK_SIZE,
664 "%s : %s -- ERROR, Addresses "
665 "0x%p to 0x%p ALREADY in use\n",
666 __FUNCTION__, hwif->name, (void *) cmd_phys_base,
667 (void *) cmd_phys_base + IOC4_CMD_CTL_BLK_SIZE);
671 if (hwif->io_ports[IDE_DATA_OFFSET] != cmd_base) {
672 /* Initialize the IO registers */
673 sgiioc4_init_hwif_ports(&hwif->hw, cmd_base, ctl, irqport);
674 memcpy(hwif->io_ports, hwif->hw.io_ports,
675 sizeof (hwif->io_ports));
676 hwif->noprobe = !hwif->io_ports[IDE_DATA_OFFSET];
679 hwif->irq = dev->irq;
680 hwif->chipset = ide_pci;
682 hwif->channel = 0; /* Single Channel chip */
683 hwif->gendev.parent = &dev->dev;/* setup proper ancestral information */
685 /* The IOC4 uses MMIO rather than Port IO. */
686 default_hwif_mmiops(hwif);
688 /* Initializing chipset IRQ Registers */
689 writel(0x03, (void __iomem *)(irqport + IOC4_INTR_SET * 4));
693 if (dma_base && ide_dma_sgiioc4(hwif, dma_base) == 0) {
695 hwif->drives[1].autodma = hwif->drives[0].autodma = 1;
697 printk(KERN_INFO "%s: %s Bus-Master DMA disabled\n",
698 hwif->name, DRV_NAME);
700 ide_init_sgiioc4(hwif);
702 if (probe_hwif_init(hwif))
705 /* Create /proc/ide entries */
706 ide_proc_register_port(hwif);
711 static unsigned int __devinit
712 pci_init_sgiioc4(struct pci_dev *dev)
714 unsigned int class_rev;
717 pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_rev);
719 printk(KERN_INFO "%s: IDE controller at PCI slot %s, revision %d\n",
720 DRV_NAME, pci_name(dev), class_rev);
721 if (class_rev < IOC4_SUPPORTED_FIRMWARE_REV) {
722 printk(KERN_ERR "Skipping %s IDE controller in slot %s: "
723 "firmware is obsolete - please upgrade to "
724 "revision46 or higher\n",
725 DRV_NAME, pci_name(dev));
729 ret = sgiioc4_ide_setup_pci_device(dev);
735 ioc4_ide_attach_one(struct ioc4_driver_data *idd)
737 /* PCI-RT does not bring out IDE connection.
738 * Do not attach to this particular IOC4.
740 if (idd->idd_variant == IOC4_VARIANT_PCI_RT)
743 return pci_init_sgiioc4(idd->idd_pdev);
746 static struct ioc4_submodule ioc4_ide_submodule = {
747 .is_name = "IOC4_ide",
748 .is_owner = THIS_MODULE,
749 .is_probe = ioc4_ide_attach_one,
750 /* .is_remove = ioc4_ide_remove_one, */
753 static int __init ioc4_ide_init(void)
755 return ioc4_register_submodule(&ioc4_ide_submodule);
758 late_initcall(ioc4_ide_init); /* Call only after IDE init is done */
760 MODULE_AUTHOR("Aniket Malatpure/Jeremy Higdon");
761 MODULE_DESCRIPTION("IDE PCI driver module for SGI IOC4 Base-IO Card");
762 MODULE_LICENSE("GPL");