2 * Copyright (c) 2003-2006 Silicon Graphics, Inc. All Rights Reserved.
3 * Copyright (C) 2008 MontaVista Software, Inc.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of version 2 of the GNU General Public License
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it would be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
17 * For further information regarding this notice, see:
19 * http://oss.sgi.com/projects/GenInfo/NoticeExplan
22 #include <linux/module.h>
23 #include <linux/types.h>
24 #include <linux/pci.h>
25 #include <linux/delay.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/ioport.h>
29 #include <linux/blkdev.h>
30 #include <linux/scatterlist.h>
31 #include <linux/ioc4.h>
34 #include <linux/ide.h>
36 #define DRV_NAME "SGIIOC4"
38 /* IOC4 Specific Definitions */
39 #define IOC4_CMD_OFFSET 0x100
40 #define IOC4_CTRL_OFFSET 0x120
41 #define IOC4_DMA_OFFSET 0x140
42 #define IOC4_INTR_OFFSET 0x0
44 #define IOC4_TIMING 0x00
45 #define IOC4_DMA_PTR_L 0x01
46 #define IOC4_DMA_PTR_H 0x02
47 #define IOC4_DMA_ADDR_L 0x03
48 #define IOC4_DMA_ADDR_H 0x04
49 #define IOC4_BC_DEV 0x05
50 #define IOC4_BC_MEM 0x06
51 #define IOC4_DMA_CTRL 0x07
52 #define IOC4_DMA_END_ADDR 0x08
54 /* Bits in the IOC4 Control/Status Register */
55 #define IOC4_S_DMA_START 0x01
56 #define IOC4_S_DMA_STOP 0x02
57 #define IOC4_S_DMA_DIR 0x04
58 #define IOC4_S_DMA_ACTIVE 0x08
59 #define IOC4_S_DMA_ERROR 0x10
60 #define IOC4_ATA_MEMERR 0x02
62 /* Read/Write Directions */
63 #define IOC4_DMA_WRITE 0x04
64 #define IOC4_DMA_READ 0x00
66 /* Interrupt Register Offsets */
67 #define IOC4_INTR_REG 0x03
68 #define IOC4_INTR_SET 0x05
69 #define IOC4_INTR_CLEAR 0x07
71 #define IOC4_IDE_CACHELINE_SIZE 128
72 #define IOC4_CMD_CTL_BLK_SIZE 0x20
73 #define IOC4_SUPPORTED_FIRMWARE_REV 46
87 /* Each Physical Region Descriptor Entry size is 16 bytes (2 * 64 bits) */
88 /* IOC4 has only 1 IDE channel */
89 #define IOC4_PRD_BYTES 16
90 #define IOC4_PRD_ENTRIES (PAGE_SIZE /(4*IOC4_PRD_BYTES))
94 sgiioc4_init_hwif_ports(hw_regs_t * hw, unsigned long data_port,
95 unsigned long ctrl_port, unsigned long irq_port)
97 unsigned long reg = data_port;
100 /* Registers are word (32 bit) aligned */
101 for (i = 0; i <= 7; i++)
102 hw->io_ports_array[i] = reg + i * 4;
104 hw->io_ports.ctl_addr = ctrl_port;
105 hw->io_ports.irq_addr = irq_port;
109 sgiioc4_checkirq(ide_hwif_t * hwif)
111 unsigned long intr_addr =
112 hwif->io_ports.irq_addr + IOC4_INTR_REG * 4;
114 if ((u8)readl((void __iomem *)intr_addr) & 0x03)
120 static u8 sgiioc4_read_status(ide_hwif_t *);
123 sgiioc4_clearirq(ide_drive_t * drive)
126 ide_hwif_t *hwif = drive->hwif;
127 struct ide_io_ports *io_ports = &hwif->io_ports;
128 unsigned long other_ir = io_ports->irq_addr + (IOC4_INTR_REG << 2);
130 /* Code to check for PCI error conditions */
131 intr_reg = readl((void __iomem *)other_ir);
132 if (intr_reg & 0x03) { /* Valid IOC4-IDE interrupt */
134 * Using sgiioc4_read_status to read the Status register has a
135 * side effect of clearing the interrupt. The first read should
136 * clear it if it is set. The second read should return
137 * a "clear" status if it got cleared. If not, then spin
138 * for a bit trying to clear it.
140 u8 stat = sgiioc4_read_status(hwif);
143 stat = sgiioc4_read_status(hwif);
144 while ((stat & ATA_BUSY) && (count++ < 100)) {
146 stat = sgiioc4_read_status(hwif);
149 if (intr_reg & 0x02) {
150 struct pci_dev *dev = to_pci_dev(hwif->dev);
151 /* Error when transferring DMA data on PCI bus */
152 u32 pci_err_addr_low, pci_err_addr_high,
156 readl((void __iomem *)io_ports->irq_addr);
158 readl((void __iomem *)(io_ports->irq_addr + 4));
159 pci_read_config_dword(dev, PCI_COMMAND,
162 "%s(%s) : PCI Bus Error when doing DMA:"
163 " status-cmd reg is 0x%x\n",
164 __func__, drive->name, pci_stat_cmd_reg);
166 "%s(%s) : PCI Error Address is 0x%x%x\n",
167 __func__, drive->name,
168 pci_err_addr_high, pci_err_addr_low);
169 /* Clear the PCI Error indicator */
170 pci_write_config_dword(dev, PCI_COMMAND, 0x00000146);
173 /* Clear the Interrupt, Error bits on the IOC4 */
174 writel(0x03, (void __iomem *)other_ir);
176 intr_reg = readl((void __iomem *)other_ir);
182 static void sgiioc4_dma_start(ide_drive_t *drive)
184 ide_hwif_t *hwif = drive->hwif;
185 unsigned long ioc4_dma_addr = hwif->dma_base + IOC4_DMA_CTRL * 4;
186 unsigned int reg = readl((void __iomem *)ioc4_dma_addr);
187 unsigned int temp_reg = reg | IOC4_S_DMA_START;
189 writel(temp_reg, (void __iomem *)ioc4_dma_addr);
193 sgiioc4_ide_dma_stop(ide_hwif_t *hwif, u64 dma_base)
195 unsigned long ioc4_dma_addr = dma_base + IOC4_DMA_CTRL * 4;
200 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
201 while ((ioc4_dma & IOC4_S_DMA_STOP) && (count++ < 200)) {
203 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
208 /* Stops the IOC4 DMA Engine */
209 static int sgiioc4_dma_end(ide_drive_t *drive)
211 u32 ioc4_dma, bc_dev, bc_mem, num, valid = 0, cnt = 0;
212 ide_hwif_t *hwif = drive->hwif;
213 unsigned long dma_base = hwif->dma_base;
215 unsigned long *ending_dma = ide_get_hwifdata(hwif);
217 writel(IOC4_S_DMA_STOP, (void __iomem *)(dma_base + IOC4_DMA_CTRL * 4));
219 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
221 if (ioc4_dma & IOC4_S_DMA_STOP) {
223 "%s(%s): IOC4 DMA STOP bit is still 1 :"
224 "ioc4_dma_reg 0x%x\n",
225 __func__, drive->name, ioc4_dma);
230 * The IOC4 will DMA 1's to the ending dma area to indicate that
231 * previous data DMA is complete. This is necessary because of relaxed
232 * ordering between register reads and DMA writes on the Altix.
234 while ((cnt++ < 200) && (!valid)) {
235 for (num = 0; num < 16; num++) {
236 if (ending_dma[num]) {
244 printk(KERN_ERR "%s(%s) : DMA incomplete\n", __func__,
249 bc_dev = readl((void __iomem *)(dma_base + IOC4_BC_DEV * 4));
250 bc_mem = readl((void __iomem *)(dma_base + IOC4_BC_MEM * 4));
252 if ((bc_dev & 0x01FF) || (bc_mem & 0x1FF)) {
253 if (bc_dev > bc_mem + 8) {
255 "%s(%s): WARNING!! byte_count_dev %d "
256 "!= byte_count_mem %d\n",
257 __func__, drive->name, bc_dev, bc_mem);
261 drive->waiting_for_dma = 0;
262 ide_destroy_dmatable(drive);
267 static void sgiioc4_set_dma_mode(ide_drive_t *drive, const u8 speed)
271 /* returns 1 if dma irq issued, 0 otherwise */
272 static int sgiioc4_dma_test_irq(ide_drive_t *drive)
274 return sgiioc4_checkirq(drive->hwif);
277 static void sgiioc4_dma_host_set(ide_drive_t *drive, int on)
280 sgiioc4_clearirq(drive);
284 sgiioc4_resetproc(ide_drive_t * drive)
286 sgiioc4_dma_end(drive);
287 sgiioc4_clearirq(drive);
291 sgiioc4_dma_lost_irq(ide_drive_t * drive)
293 sgiioc4_resetproc(drive);
295 ide_dma_lost_irq(drive);
298 static u8 sgiioc4_read_status(ide_hwif_t *hwif)
300 unsigned long port = hwif->io_ports.status_addr;
301 u8 reg = (u8) readb((void __iomem *) port);
303 if (!(reg & ATA_BUSY)) { /* Not busy... check for interrupt */
304 unsigned long other_ir = port - 0x110;
305 unsigned int intr_reg = (u32) readl((void __iomem *) other_ir);
307 /* Clear the Interrupt, Error bits on the IOC4 */
308 if (intr_reg & 0x03) {
309 writel(0x03, (void __iomem *) other_ir);
310 intr_reg = (u32) readl((void __iomem *) other_ir);
317 /* Creates a dma map for the scatter-gather list entries */
319 ide_dma_sgiioc4(ide_hwif_t *hwif, const struct ide_port_info *d)
321 struct pci_dev *dev = to_pci_dev(hwif->dev);
322 unsigned long dma_base = pci_resource_start(dev, 0) + IOC4_DMA_OFFSET;
323 int num_ports = sizeof (ioc4_dma_regs_t);
326 printk(KERN_INFO " %s: MMIO-DMA\n", hwif->name);
328 if (request_mem_region(dma_base, num_ports, hwif->name) == NULL) {
329 printk(KERN_ERR "%s(%s) -- ERROR: addresses 0x%08lx to 0x%08lx "
330 "already in use\n", __func__, hwif->name,
331 dma_base, dma_base + num_ports - 1);
335 hwif->dma_base = (unsigned long)hwif->io_ports.irq_addr +
338 hwif->sg_max_nents = IOC4_PRD_ENTRIES;
340 hwif->prd_max_nents = IOC4_PRD_ENTRIES;
341 hwif->prd_ent_size = IOC4_PRD_BYTES;
343 if (ide_allocate_dma_engine(hwif))
344 goto dma_pci_alloc_failure;
346 pad = pci_alloc_consistent(dev, IOC4_IDE_CACHELINE_SIZE,
347 (dma_addr_t *)&hwif->extra_base);
349 ide_set_hwifdata(hwif, pad);
353 ide_release_dma_engine(hwif);
355 printk(KERN_ERR "%s(%s) -- ERROR: Unable to allocate DMA maps\n",
356 __func__, hwif->name);
357 printk(KERN_INFO "%s: changing from DMA to PIO mode", hwif->name);
359 dma_pci_alloc_failure:
360 release_mem_region(dma_base, num_ports);
365 /* Initializes the IOC4 DMA Engine */
367 sgiioc4_configure_for_dma(int dma_direction, ide_drive_t * drive)
370 ide_hwif_t *hwif = drive->hwif;
371 unsigned long dma_base = hwif->dma_base;
372 unsigned long ioc4_dma_addr = dma_base + IOC4_DMA_CTRL * 4;
373 u32 dma_addr, ending_dma_addr;
375 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
377 if (ioc4_dma & IOC4_S_DMA_ACTIVE) {
379 "%s(%s):Warning!! DMA from previous transfer was still active\n",
380 __func__, drive->name);
381 writel(IOC4_S_DMA_STOP, (void __iomem *)ioc4_dma_addr);
382 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
384 if (ioc4_dma & IOC4_S_DMA_STOP)
386 "%s(%s) : IOC4 Dma STOP bit is still 1\n",
387 __func__, drive->name);
390 ioc4_dma = readl((void __iomem *)ioc4_dma_addr);
391 if (ioc4_dma & IOC4_S_DMA_ERROR) {
393 "%s(%s) : Warning!! - DMA Error during Previous"
394 " transfer | status 0x%x\n",
395 __func__, drive->name, ioc4_dma);
396 writel(IOC4_S_DMA_STOP, (void __iomem *)ioc4_dma_addr);
397 ioc4_dma = sgiioc4_ide_dma_stop(hwif, dma_base);
399 if (ioc4_dma & IOC4_S_DMA_STOP)
401 "%s(%s) : IOC4 DMA STOP bit is still 1\n",
402 __func__, drive->name);
405 /* Address of the Scatter Gather List */
406 dma_addr = cpu_to_le32(hwif->dmatable_dma);
407 writel(dma_addr, (void __iomem *)(dma_base + IOC4_DMA_PTR_L * 4));
409 /* Address of the Ending DMA */
410 memset(ide_get_hwifdata(hwif), 0, IOC4_IDE_CACHELINE_SIZE);
411 ending_dma_addr = cpu_to_le32(hwif->extra_base);
412 writel(ending_dma_addr, (void __iomem *)(dma_base + IOC4_DMA_END_ADDR * 4));
414 writel(dma_direction, (void __iomem *)ioc4_dma_addr);
415 drive->waiting_for_dma = 1;
418 /* IOC4 Scatter Gather list Format */
419 /* 128 Bit entries to support 64 bit addresses in the future */
420 /* The Scatter Gather list Entry should be in the BIG-ENDIAN Format */
421 /* --------------------------------------------------------------------- */
422 /* | Upper 32 bits - Zero | Lower 32 bits- address | */
423 /* --------------------------------------------------------------------- */
424 /* | Upper 32 bits - Zero |EOL| 15 unused | 16 Bit Length| */
425 /* --------------------------------------------------------------------- */
426 /* Creates the scatter gather list, DMA Table */
427 static int sgiioc4_build_dmatable(ide_drive_t *drive, struct ide_cmd *cmd)
429 ide_hwif_t *hwif = drive->hwif;
430 unsigned int *table = hwif->dmatable_cpu;
431 unsigned int count = 0, i = cmd->sg_nents;
432 struct scatterlist *sg = hwif->sg_table;
434 while (i && sg_dma_len(sg)) {
437 cur_addr = sg_dma_address(sg);
438 cur_len = sg_dma_len(sg);
441 if (count++ >= IOC4_PRD_ENTRIES) {
443 "%s: DMA table too small\n",
445 goto use_pio_instead;
448 0x10000 - (cur_addr & 0xffff);
450 if (bcount > cur_len)
453 /* put the addr, length in
454 * the IOC4 dma-table format */
457 *table = cpu_to_be32(cur_addr);
462 *table = cpu_to_be32(bcount);
476 *table |= cpu_to_be32(0x80000000);
481 ide_destroy_dmatable(drive);
483 return 0; /* revert to PIO for this request */
486 static int sgiioc4_dma_setup(ide_drive_t *drive, struct ide_cmd *cmd)
489 u8 write = !!(cmd->tf_flags & IDE_TFLAG_WRITE);
491 if (sgiioc4_build_dmatable(drive, cmd) == 0) {
492 /* try PIO instead of DMA */
493 ide_map_sg(drive, cmd);
498 /* Writes TO the IOC4 FROM Main Memory */
499 ddir = IOC4_DMA_READ;
501 /* Writes FROM the IOC4 TO Main Memory */
502 ddir = IOC4_DMA_WRITE;
504 sgiioc4_configure_for_dma(ddir, drive);
509 static const struct ide_tp_ops sgiioc4_tp_ops = {
510 .exec_command = ide_exec_command,
511 .read_status = sgiioc4_read_status,
512 .read_altstatus = ide_read_altstatus,
514 .set_irq = ide_set_irq,
516 .tf_load = ide_tf_load,
517 .tf_read = ide_tf_read,
519 .input_data = ide_input_data,
520 .output_data = ide_output_data,
523 static const struct ide_port_ops sgiioc4_port_ops = {
524 .set_dma_mode = sgiioc4_set_dma_mode,
525 /* reset DMA engine, clear IRQs */
526 .resetproc = sgiioc4_resetproc,
529 static const struct ide_dma_ops sgiioc4_dma_ops = {
530 .dma_host_set = sgiioc4_dma_host_set,
531 .dma_setup = sgiioc4_dma_setup,
532 .dma_start = sgiioc4_dma_start,
533 .dma_end = sgiioc4_dma_end,
534 .dma_test_irq = sgiioc4_dma_test_irq,
535 .dma_lost_irq = sgiioc4_dma_lost_irq,
536 .dma_timeout = ide_dma_timeout,
539 static const struct ide_port_info sgiioc4_port_info __devinitconst = {
542 .init_dma = ide_dma_sgiioc4,
543 .tp_ops = &sgiioc4_tp_ops,
544 .port_ops = &sgiioc4_port_ops,
545 .dma_ops = &sgiioc4_dma_ops,
546 .host_flags = IDE_HFLAG_MMIO,
547 .irq_flags = IRQF_SHARED,
548 .mwdma_mask = ATA_MWDMA2_ONLY,
552 sgiioc4_ide_setup_pci_device(struct pci_dev *dev)
554 unsigned long cmd_base, irqport;
555 unsigned long bar0, cmd_phys_base, ctl;
556 void __iomem *virt_base;
557 hw_regs_t hw, *hws[] = { &hw, NULL, NULL, NULL };
560 /* Get the CmdBlk and CtrlBlk Base Registers */
561 bar0 = pci_resource_start(dev, 0);
562 virt_base = pci_ioremap_bar(dev, 0);
563 if (virt_base == NULL) {
564 printk(KERN_ERR "%s: Unable to remap BAR 0 address: 0x%lx\n",
568 cmd_base = (unsigned long) virt_base + IOC4_CMD_OFFSET;
569 ctl = (unsigned long) virt_base + IOC4_CTRL_OFFSET;
570 irqport = (unsigned long) virt_base + IOC4_INTR_OFFSET;
572 cmd_phys_base = bar0 + IOC4_CMD_OFFSET;
573 if (request_mem_region(cmd_phys_base, IOC4_CMD_CTL_BLK_SIZE,
575 printk(KERN_ERR "%s %s -- ERROR: addresses 0x%08lx to 0x%08lx "
576 "already in use\n", DRV_NAME, pci_name(dev),
577 cmd_phys_base, cmd_phys_base + IOC4_CMD_CTL_BLK_SIZE);
579 goto req_mem_rgn_err;
582 /* Initialize the IO registers */
583 memset(&hw, 0, sizeof(hw));
584 sgiioc4_init_hwif_ports(&hw, cmd_base, ctl, irqport);
586 hw.chipset = ide_pci;
589 /* Initializing chipset IRQ Registers */
590 writel(0x03, (void __iomem *)(irqport + IOC4_INTR_SET * 4));
592 rc = ide_host_add(&sgiioc4_port_info, hws, NULL);
596 release_mem_region(cmd_phys_base, IOC4_CMD_CTL_BLK_SIZE);
602 static unsigned int __devinit
603 pci_init_sgiioc4(struct pci_dev *dev)
607 printk(KERN_INFO "%s: IDE controller at PCI slot %s, revision %d\n",
608 DRV_NAME, pci_name(dev), dev->revision);
610 if (dev->revision < IOC4_SUPPORTED_FIRMWARE_REV) {
611 printk(KERN_ERR "Skipping %s IDE controller in slot %s: "
612 "firmware is obsolete - please upgrade to "
613 "revision46 or higher\n",
614 DRV_NAME, pci_name(dev));
618 ret = sgiioc4_ide_setup_pci_device(dev);
624 ioc4_ide_attach_one(struct ioc4_driver_data *idd)
626 /* PCI-RT does not bring out IDE connection.
627 * Do not attach to this particular IOC4.
629 if (idd->idd_variant == IOC4_VARIANT_PCI_RT)
632 return pci_init_sgiioc4(idd->idd_pdev);
635 static struct ioc4_submodule __devinitdata ioc4_ide_submodule = {
636 .is_name = "IOC4_ide",
637 .is_owner = THIS_MODULE,
638 .is_probe = ioc4_ide_attach_one,
639 /* .is_remove = ioc4_ide_remove_one, */
642 static int __init ioc4_ide_init(void)
644 return ioc4_register_submodule(&ioc4_ide_submodule);
647 late_initcall(ioc4_ide_init); /* Call only after IDE init is done */
649 MODULE_AUTHOR("Aniket Malatpure/Jeremy Higdon");
650 MODULE_DESCRIPTION("IDE PCI driver module for SGI IOC4 Base-IO Card");
651 MODULE_LICENSE("GPL");