2 * Copyright (c) 2003 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 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
17 * Mountain View, CA 94043, or:
21 * For further information regarding this notice, see:
23 * http://oss.sgi.com/projects/GenInfo/NoticeExplan
26 #include <linux/module.h>
27 #include <linux/types.h>
28 #include <linux/pci.h>
29 #include <linux/delay.h>
30 #include <linux/hdreg.h>
31 #include <linux/init.h>
32 #include <linux/kernel.h>
33 #include <linux/timer.h>
35 #include <linux/ioport.h>
36 #include <linux/blkdev.h>
37 #include <linux/ioc4.h>
40 #include <linux/ide.h>
42 /* IOC4 Specific Definitions */
43 #define IOC4_CMD_OFFSET 0x100
44 #define IOC4_CTRL_OFFSET 0x120
45 #define IOC4_DMA_OFFSET 0x140
46 #define IOC4_INTR_OFFSET 0x0
48 #define IOC4_TIMING 0x00
49 #define IOC4_DMA_PTR_L 0x01
50 #define IOC4_DMA_PTR_H 0x02
51 #define IOC4_DMA_ADDR_L 0x03
52 #define IOC4_DMA_ADDR_H 0x04
53 #define IOC4_BC_DEV 0x05
54 #define IOC4_BC_MEM 0x06
55 #define IOC4_DMA_CTRL 0x07
56 #define IOC4_DMA_END_ADDR 0x08
58 /* Bits in the IOC4 Control/Status Register */
59 #define IOC4_S_DMA_START 0x01
60 #define IOC4_S_DMA_STOP 0x02
61 #define IOC4_S_DMA_DIR 0x04
62 #define IOC4_S_DMA_ACTIVE 0x08
63 #define IOC4_S_DMA_ERROR 0x10
64 #define IOC4_ATA_MEMERR 0x02
66 /* Read/Write Directions */
67 #define IOC4_DMA_WRITE 0x04
68 #define IOC4_DMA_READ 0x00
70 /* Interrupt Register Offsets */
71 #define IOC4_INTR_REG 0x03
72 #define IOC4_INTR_SET 0x05
73 #define IOC4_INTR_CLEAR 0x07
75 #define IOC4_IDE_CACHELINE_SIZE 128
76 #define IOC4_CMD_CTL_BLK_SIZE 0x20
77 #define IOC4_SUPPORTED_FIRMWARE_REV 46
91 /* Each Physical Region Descriptor Entry size is 16 bytes (2 * 64 bits) */
92 /* IOC4 has only 1 IDE channel */
93 #define IOC4_PRD_BYTES 16
94 #define IOC4_PRD_ENTRIES (PAGE_SIZE /(4*IOC4_PRD_BYTES))
98 sgiioc4_init_hwif_ports(hw_regs_t * hw, unsigned long data_port,
99 unsigned long ctrl_port, unsigned long irq_port)
101 unsigned long reg = data_port;
104 /* Registers are word (32 bit) aligned */
105 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++)
106 hw->io_ports[i] = reg + i * 4;
109 hw->io_ports[IDE_CONTROL_OFFSET] = ctrl_port;
112 hw->io_ports[IDE_IRQ_OFFSET] = irq_port;
116 sgiioc4_maskproc(ide_drive_t * drive, int mask)
118 ide_hwif_t *hwif = HWIF(drive);
119 hwif->OUTB(mask ? (drive->ctl | 2) : (drive->ctl & ~2),
125 sgiioc4_checkirq(ide_hwif_t * hwif)
128 hwif->INL(hwif->io_ports[IDE_IRQ_OFFSET] + IOC4_INTR_REG * 4);
138 sgiioc4_clearirq(ide_drive_t * drive)
141 ide_hwif_t *hwif = HWIF(drive);
142 unsigned long other_ir =
143 hwif->io_ports[IDE_IRQ_OFFSET] + (IOC4_INTR_REG << 2);
145 /* Code to check for PCI error conditions */
146 intr_reg = hwif->INL(other_ir);
147 if (intr_reg & 0x03) { /* Valid IOC4-IDE interrupt */
149 * Using hwif->INB to read the IDE_STATUS_REG has a side effect
150 * of clearing the interrupt. The first read should clear it
151 * if it is set. The second read should return a "clear" status
152 * if it got cleared. If not, then spin for a bit trying to
155 u8 stat = hwif->INB(IDE_STATUS_REG);
157 stat = hwif->INB(IDE_STATUS_REG);
158 while ((stat & 0x80) && (count++ < 100)) {
160 stat = hwif->INB(IDE_STATUS_REG);
163 if (intr_reg & 0x02) {
164 /* Error when transferring DMA data on PCI bus */
165 u32 pci_err_addr_low, pci_err_addr_high,
169 hwif->INL(hwif->io_ports[IDE_IRQ_OFFSET]);
171 hwif->INL(hwif->io_ports[IDE_IRQ_OFFSET] + 4);
172 pci_read_config_dword(hwif->pci_dev, PCI_COMMAND,
175 "%s(%s) : PCI Bus Error when doing DMA:"
176 " status-cmd reg is 0x%x\n",
177 __FUNCTION__, drive->name, pci_stat_cmd_reg);
179 "%s(%s) : PCI Error Address is 0x%x%x\n",
180 __FUNCTION__, drive->name,
181 pci_err_addr_high, pci_err_addr_low);
182 /* Clear the PCI Error indicator */
183 pci_write_config_dword(hwif->pci_dev, PCI_COMMAND,
187 /* Clear the Interrupt, Error bits on the IOC4 */
188 hwif->OUTL(0x03, other_ir);
190 intr_reg = hwif->INL(other_ir);
196 static void sgiioc4_ide_dma_start(ide_drive_t * drive)
198 ide_hwif_t *hwif = HWIF(drive);
199 unsigned int reg = hwif->INL(hwif->dma_base + IOC4_DMA_CTRL * 4);
200 unsigned int temp_reg = reg | IOC4_S_DMA_START;
202 hwif->OUTL(temp_reg, hwif->dma_base + IOC4_DMA_CTRL * 4);
206 sgiioc4_ide_dma_stop(ide_hwif_t *hwif, u64 dma_base)
212 ioc4_dma = hwif->INL(dma_base + IOC4_DMA_CTRL * 4);
213 while ((ioc4_dma & IOC4_S_DMA_STOP) && (count++ < 200)) {
215 ioc4_dma = hwif->INL(dma_base + IOC4_DMA_CTRL * 4);
220 /* Stops the IOC4 DMA Engine */
222 sgiioc4_ide_dma_end(ide_drive_t * drive)
224 u32 ioc4_dma, bc_dev, bc_mem, num, valid = 0, cnt = 0;
225 ide_hwif_t *hwif = HWIF(drive);
226 u64 dma_base = hwif->dma_base;
228 unsigned long *ending_dma = (unsigned long *) hwif->dma_base2;
230 hwif->OUTL(IOC4_S_DMA_STOP, dma_base + IOC4_DMA_CTRL * 4);
232 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
234 if (ioc4_dma & IOC4_S_DMA_STOP) {
236 "%s(%s): IOC4 DMA STOP bit is still 1 :"
237 "ioc4_dma_reg 0x%x\n",
238 __FUNCTION__, drive->name, ioc4_dma);
243 * The IOC4 will DMA 1's to the ending dma area to indicate that
244 * previous data DMA is complete. This is necessary because of relaxed
245 * ordering between register reads and DMA writes on the Altix.
247 while ((cnt++ < 200) && (!valid)) {
248 for (num = 0; num < 16; num++) {
249 if (ending_dma[num]) {
257 printk(KERN_ERR "%s(%s) : DMA incomplete\n", __FUNCTION__,
262 bc_dev = hwif->INL(dma_base + IOC4_BC_DEV * 4);
263 bc_mem = hwif->INL(dma_base + IOC4_BC_MEM * 4);
265 if ((bc_dev & 0x01FF) || (bc_mem & 0x1FF)) {
266 if (bc_dev > bc_mem + 8) {
268 "%s(%s): WARNING!! byte_count_dev %d "
269 "!= byte_count_mem %d\n",
270 __FUNCTION__, drive->name, bc_dev, bc_mem);
274 drive->waiting_for_dma = 0;
275 ide_destroy_dmatable(drive);
281 sgiioc4_ide_dma_check(ide_drive_t * drive)
283 if (ide_config_drive_speed(drive, XFER_MW_DMA_2) != 0) {
285 "Couldnot set %s in Multimode-2 DMA mode | "
286 "Drive %s using PIO instead\n",
287 drive->name, drive->name);
288 drive->using_dma = 0;
290 drive->using_dma = 1;
296 sgiioc4_ide_dma_on(ide_drive_t * drive)
298 drive->using_dma = 1;
300 return HWIF(drive)->ide_dma_host_on(drive);
304 sgiioc4_ide_dma_off_quietly(ide_drive_t * drive)
306 drive->using_dma = 0;
308 return HWIF(drive)->ide_dma_host_off(drive);
311 /* returns 1 if dma irq issued, 0 otherwise */
313 sgiioc4_ide_dma_test_irq(ide_drive_t * drive)
315 return sgiioc4_checkirq(HWIF(drive));
319 sgiioc4_ide_dma_host_on(ide_drive_t * drive)
321 if (drive->using_dma)
328 sgiioc4_ide_dma_host_off(ide_drive_t * drive)
330 sgiioc4_clearirq(drive);
336 sgiioc4_ide_dma_lostirq(ide_drive_t * drive)
338 HWIF(drive)->resetproc(drive);
340 return __ide_dma_lostirq(drive);
344 sgiioc4_resetproc(ide_drive_t * drive)
346 sgiioc4_ide_dma_end(drive);
347 sgiioc4_clearirq(drive);
351 sgiioc4_INB(unsigned long port)
353 u8 reg = (u8) inb(port);
355 if ((port & 0xFFF) == 0x11C) { /* Status register of IOC4 */
356 if (reg & 0x51) { /* Not busy...check for interrupt */
357 unsigned long other_ir = port - 0x110;
358 unsigned int intr_reg = (u32) inl(other_ir);
360 /* Clear the Interrupt, Error bits on the IOC4 */
361 if (intr_reg & 0x03) {
362 outl(0x03, other_ir);
363 intr_reg = (u32) inl(other_ir);
371 /* Creates a dma map for the scatter-gather list entries */
372 static void __devinit
373 ide_dma_sgiioc4(ide_hwif_t * hwif, unsigned long dma_base)
375 int num_ports = sizeof (ioc4_dma_regs_t);
377 printk(KERN_INFO "%s: BM-DMA at 0x%04lx-0x%04lx\n", hwif->name,
378 dma_base, dma_base + num_ports - 1);
380 if (!request_region(dma_base, num_ports, hwif->name)) {
382 "%s(%s) -- ERROR, Addresses 0x%p to 0x%p "
384 __FUNCTION__, hwif->name, (void *) dma_base,
385 (void *) dma_base + num_ports - 1);
386 goto dma_alloc_failure;
389 hwif->dma_base = dma_base;
390 hwif->dmatable_cpu = pci_alloc_consistent(hwif->pci_dev,
391 IOC4_PRD_ENTRIES * IOC4_PRD_BYTES,
392 &hwif->dmatable_dma);
394 if (!hwif->dmatable_cpu)
395 goto dma_alloc_failure;
397 hwif->sg_max_nents = IOC4_PRD_ENTRIES;
399 hwif->dma_base2 = (unsigned long)
400 pci_alloc_consistent(hwif->pci_dev,
401 IOC4_IDE_CACHELINE_SIZE,
402 (dma_addr_t *) &(hwif->dma_status));
404 if (!hwif->dma_base2)
405 goto dma_base2alloc_failure;
409 dma_base2alloc_failure:
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);
420 /* Disable DMA because we couldnot allocate any DMA maps */
425 /* Initializes the IOC4 DMA Engine */
427 sgiioc4_configure_for_dma(int dma_direction, ide_drive_t * drive)
430 ide_hwif_t *hwif = HWIF(drive);
431 u64 dma_base = hwif->dma_base;
432 u32 dma_addr, ending_dma_addr;
434 ioc4_dma = hwif->INL(dma_base + IOC4_DMA_CTRL * 4);
436 if (ioc4_dma & IOC4_S_DMA_ACTIVE) {
438 "%s(%s):Warning!! DMA from previous transfer was still active\n",
439 __FUNCTION__, drive->name);
440 hwif->OUTL(IOC4_S_DMA_STOP, dma_base + IOC4_DMA_CTRL * 4);
441 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
443 if (ioc4_dma & IOC4_S_DMA_STOP)
445 "%s(%s) : IOC4 Dma STOP bit is still 1\n",
446 __FUNCTION__, drive->name);
449 ioc4_dma = hwif->INL(dma_base + IOC4_DMA_CTRL * 4);
450 if (ioc4_dma & IOC4_S_DMA_ERROR) {
452 "%s(%s) : Warning!! - DMA Error during Previous"
453 " transfer | status 0x%x\n",
454 __FUNCTION__, drive->name, ioc4_dma);
455 hwif->OUTL(IOC4_S_DMA_STOP, dma_base + IOC4_DMA_CTRL * 4);
456 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
458 if (ioc4_dma & IOC4_S_DMA_STOP)
460 "%s(%s) : IOC4 DMA STOP bit is still 1\n",
461 __FUNCTION__, drive->name);
464 /* Address of the Scatter Gather List */
465 dma_addr = cpu_to_le32(hwif->dmatable_dma);
466 hwif->OUTL(dma_addr, dma_base + IOC4_DMA_PTR_L * 4);
468 /* Address of the Ending DMA */
469 memset((unsigned int *) hwif->dma_base2, 0, IOC4_IDE_CACHELINE_SIZE);
470 ending_dma_addr = cpu_to_le32(hwif->dma_status);
471 hwif->OUTL(ending_dma_addr, dma_base + IOC4_DMA_END_ADDR * 4);
473 hwif->OUTL(dma_direction, dma_base + IOC4_DMA_CTRL * 4);
474 drive->waiting_for_dma = 1;
477 /* IOC4 Scatter Gather list Format */
478 /* 128 Bit entries to support 64 bit addresses in the future */
479 /* The Scatter Gather list Entry should be in the BIG-ENDIAN Format */
480 /* --------------------------------------------------------------------- */
481 /* | Upper 32 bits - Zero | Lower 32 bits- address | */
482 /* --------------------------------------------------------------------- */
483 /* | Upper 32 bits - Zero |EOL| 15 unused | 16 Bit Length| */
484 /* --------------------------------------------------------------------- */
485 /* Creates the scatter gather list, DMA Table */
487 sgiioc4_build_dma_table(ide_drive_t * drive, struct request *rq, int ddir)
489 ide_hwif_t *hwif = HWIF(drive);
490 unsigned int *table = hwif->dmatable_cpu;
491 unsigned int count = 0, i = 1;
492 struct scatterlist *sg;
494 hwif->sg_nents = i = ide_build_sglist(drive, rq);
497 return 0; /* sglist of length Zero */
500 while (i && sg_dma_len(sg)) {
503 cur_addr = sg_dma_address(sg);
504 cur_len = sg_dma_len(sg);
507 if (count++ >= IOC4_PRD_ENTRIES) {
509 "%s: DMA table too small\n",
511 goto use_pio_instead;
514 0x10000 - (cur_addr & 0xffff);
516 if (bcount > cur_len)
519 /* put the addr, length in
520 * the IOC4 dma-table format */
523 *table = cpu_to_be32(cur_addr);
528 xcount = bcount & 0xffff;
529 *table = cpu_to_be32(xcount);
543 *table |= cpu_to_be32(0x80000000);
548 pci_unmap_sg(hwif->pci_dev, hwif->sg_table, hwif->sg_nents,
549 hwif->sg_dma_direction);
551 return 0; /* revert to PIO for this request */
554 static int sgiioc4_ide_dma_setup(ide_drive_t *drive)
556 struct request *rq = HWGROUP(drive)->rq;
557 unsigned int count = 0;
561 ddir = PCI_DMA_TODEVICE;
563 ddir = PCI_DMA_FROMDEVICE;
565 if (!(count = sgiioc4_build_dma_table(drive, rq, ddir))) {
566 /* try PIO instead of DMA */
567 ide_map_sg(drive, rq);
572 /* Writes TO the IOC4 FROM Main Memory */
573 ddir = IOC4_DMA_READ;
575 /* Writes FROM the IOC4 TO Main Memory */
576 ddir = IOC4_DMA_WRITE;
578 sgiioc4_configure_for_dma(ddir, drive);
583 static void __devinit
584 ide_init_sgiioc4(ide_hwif_t * hwif)
589 hwif->ultra_mask = 0x0; /* Disable Ultra DMA */
590 hwif->mwdma_mask = 0x2; /* Multimode-2 DMA */
591 hwif->swdma_mask = 0x2;
592 hwif->tuneproc = NULL; /* Sets timing for PIO mode */
593 hwif->speedproc = NULL; /* Sets timing for DMA &/or PIO modes */
594 hwif->selectproc = NULL;/* Use the default routine to select drive */
595 hwif->reset_poll = NULL;/* No HBA specific reset_poll needed */
596 hwif->pre_reset = NULL; /* No HBA specific pre_set needed */
597 hwif->resetproc = &sgiioc4_resetproc;/* Reset DMA engine,
599 hwif->intrproc = NULL; /* Enable or Disable interrupt from drive */
600 hwif->maskproc = &sgiioc4_maskproc; /* Mask on/off NIEN register */
601 hwif->quirkproc = NULL;
602 hwif->busproc = NULL;
604 hwif->dma_setup = &sgiioc4_ide_dma_setup;
605 hwif->dma_start = &sgiioc4_ide_dma_start;
606 hwif->ide_dma_end = &sgiioc4_ide_dma_end;
607 hwif->ide_dma_check = &sgiioc4_ide_dma_check;
608 hwif->ide_dma_on = &sgiioc4_ide_dma_on;
609 hwif->ide_dma_off_quietly = &sgiioc4_ide_dma_off_quietly;
610 hwif->ide_dma_test_irq = &sgiioc4_ide_dma_test_irq;
611 hwif->ide_dma_host_on = &sgiioc4_ide_dma_host_on;
612 hwif->ide_dma_host_off = &sgiioc4_ide_dma_host_off;
613 hwif->ide_dma_lostirq = &sgiioc4_ide_dma_lostirq;
614 hwif->ide_dma_timeout = &__ide_dma_timeout;
615 hwif->INB = &sgiioc4_INB;
619 sgiioc4_ide_setup_pci_device(struct pci_dev *dev, ide_pci_device_t * d)
621 unsigned long base, ctl, dma_base, irqport;
625 for (h = 0; h < MAX_HWIFS; ++h) {
626 hwif = &ide_hwifs[h];
627 /* Find an empty HWIF */
628 if (hwif->chipset == ide_unknown)
632 /* Get the CmdBlk and CtrlBlk Base Registers */
633 base = pci_resource_start(dev, 0) + IOC4_CMD_OFFSET;
634 ctl = pci_resource_start(dev, 0) + IOC4_CTRL_OFFSET;
635 irqport = pci_resource_start(dev, 0) + IOC4_INTR_OFFSET;
636 dma_base = pci_resource_start(dev, 0) + IOC4_DMA_OFFSET;
638 if (!request_region(base, IOC4_CMD_CTL_BLK_SIZE, hwif->name)) {
640 "%s : %s -- ERROR, Port Addresses "
641 "0x%p to 0x%p ALREADY in use\n",
642 __FUNCTION__, hwif->name, (void *) base,
643 (void *) base + IOC4_CMD_CTL_BLK_SIZE);
647 if (hwif->io_ports[IDE_DATA_OFFSET] != base) {
648 /* Initialize the IO registers */
649 sgiioc4_init_hwif_ports(&hwif->hw, base, ctl, irqport);
650 memcpy(hwif->io_ports, hwif->hw.io_ports,
651 sizeof (hwif->io_ports));
652 hwif->noprobe = !hwif->io_ports[IDE_DATA_OFFSET];
655 hwif->irq = dev->irq;
656 hwif->chipset = ide_pci;
658 hwif->channel = 0; /* Single Channel chip */
659 hwif->cds = (struct ide_pci_device_s *) d;
660 hwif->gendev.parent = &dev->dev;/* setup proper ancestral information */
662 /* Initializing chipset IRQ Registers */
663 hwif->OUTL(0x03, irqport + IOC4_INTR_SET * 4);
665 ide_init_sgiioc4(hwif);
668 ide_dma_sgiioc4(hwif, dma_base);
670 printk(KERN_INFO "%s: %s Bus-Master DMA disabled\n",
671 hwif->name, d->name);
673 if (probe_hwif_init(hwif))
676 /* Create /proc/ide entries */
677 create_proc_ide_interfaces();
682 static unsigned int __devinit
683 pci_init_sgiioc4(struct pci_dev *dev, ide_pci_device_t * d)
685 unsigned int class_rev;
688 pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_rev);
690 printk(KERN_INFO "%s: IDE controller at PCI slot %s, revision %d\n",
691 d->name, pci_name(dev), class_rev);
692 if (class_rev < IOC4_SUPPORTED_FIRMWARE_REV) {
693 printk(KERN_ERR "Skipping %s IDE controller in slot %s: "
694 "firmware is obsolete - please upgrade to revision"
695 "46 or higher\n", d->name, pci_name(dev));
699 ret = sgiioc4_ide_setup_pci_device(dev, d);
704 static ide_pci_device_t sgiioc4_chipsets[] __devinitdata = {
708 .init_hwif = ide_init_sgiioc4,
709 .init_dma = ide_dma_sgiioc4,
712 /* SGI IOC4 doesn't have enablebits. */
713 .bootable = ON_BOARD,
718 ioc4_ide_attach_one(struct ioc4_driver_data *idd)
720 return pci_init_sgiioc4(idd->idd_pdev,
721 &sgiioc4_chipsets[idd->idd_pci_id->driver_data]);
724 static struct ioc4_submodule ioc4_ide_submodule = {
725 .is_name = "IOC4_ide",
726 .is_owner = THIS_MODULE,
727 .is_probe = ioc4_ide_attach_one,
728 /* .is_remove = ioc4_ide_remove_one, */
734 return ioc4_register_submodule(&ioc4_ide_submodule);
737 static void __devexit
740 ioc4_unregister_submodule(&ioc4_ide_submodule);
743 module_init(ioc4_ide_init);
744 module_exit(ioc4_ide_exit);
746 MODULE_AUTHOR("Aniket Malatpure - Silicon Graphics Inc. (SGI)");
747 MODULE_DESCRIPTION("IDE PCI driver module for SGI IOC4 Base-IO Card");
748 MODULE_LICENSE("GPL");