2  *      Adaptec AAC series RAID controller driver
 
   3  *      (c) Copyright 2001 Red Hat Inc. <alan@redhat.com>
 
   5  * based on the old aacraid driver that is..
 
   6  * Adaptec aacraid device driver for Linux.
 
   8  * Copyright (c) 2000-2007 Adaptec, Inc. (aacraid@adaptec.com)
 
  10  * This program is free software; you can redistribute it and/or modify
 
  11  * it under the terms of the GNU General Public License as published by
 
  12  * the Free Software Foundation; either version 2, or (at your option)
 
  15  * This program is distributed in the hope that it will be useful,
 
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  18  * GNU General Public License for more details.
 
  20  * You should have received a copy of the GNU General Public License
 
  21  * along with this program; see the file COPYING.  If not, write to
 
  22  * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
 
  27  * Abstract: Hardware miniport for Drawbridge specific hardware functions.
 
  31 #include <linux/kernel.h>
 
  32 #include <linux/init.h>
 
  33 #include <linux/types.h>
 
  34 #include <linux/pci.h>
 
  35 #include <linux/spinlock.h>
 
  36 #include <linux/slab.h>
 
  37 #include <linux/blkdev.h>
 
  38 #include <linux/delay.h>
 
  39 #include <linux/completion.h>
 
  40 #include <linux/time.h>
 
  41 #include <linux/interrupt.h>
 
  42 #include <asm/semaphore.h>
 
  44 #include <scsi/scsi_host.h>
 
  48 static irqreturn_t aac_rx_intr_producer(int irq, void *dev_id)
 
  50         struct aac_dev *dev = dev_id;
 
  51         unsigned long bellbits;
 
  52         u8 intstat = rx_readb(dev, MUnit.OISR);
 
  55          *      Read mask and invert because drawbridge is reversed.
 
  56          *      This allows us to only service interrupts that have
 
  58          *      Check to see if this is our interrupt.  If it isn't just return
 
  60         if (likely(intstat & ~(dev->OIMR))) {
 
  61                 bellbits = rx_readl(dev, OutboundDoorbellReg);
 
  62                 if (unlikely(bellbits & DoorBellPrintfReady)) {
 
  63                         aac_printf(dev, readl (&dev->IndexRegs->Mailbox[5]));
 
  64                         rx_writel(dev, MUnit.ODR,DoorBellPrintfReady);
 
  65                         rx_writel(dev, InboundDoorbellReg,DoorBellPrintfDone);
 
  67                 else if (unlikely(bellbits & DoorBellAdapterNormCmdReady)) {
 
  68                         rx_writel(dev, MUnit.ODR, DoorBellAdapterNormCmdReady);
 
  69                         aac_command_normal(&dev->queues->queue[HostNormCmdQueue]);
 
  71                 else if (likely(bellbits & DoorBellAdapterNormRespReady)) {
 
  72                         rx_writel(dev, MUnit.ODR,DoorBellAdapterNormRespReady);
 
  73                         aac_response_normal(&dev->queues->queue[HostNormRespQueue]);
 
  75                 else if (unlikely(bellbits & DoorBellAdapterNormCmdNotFull)) {
 
  76                         rx_writel(dev, MUnit.ODR, DoorBellAdapterNormCmdNotFull);
 
  78                 else if (unlikely(bellbits & DoorBellAdapterNormRespNotFull)) {
 
  79                         rx_writel(dev, MUnit.ODR, DoorBellAdapterNormCmdNotFull);
 
  80                         rx_writel(dev, MUnit.ODR, DoorBellAdapterNormRespNotFull);
 
  87 static irqreturn_t aac_rx_intr_message(int irq, void *dev_id)
 
  89         struct aac_dev *dev = dev_id;
 
  90         u32 Index = rx_readl(dev, MUnit.OutboundQueue);
 
  91         if (unlikely(Index == 0xFFFFFFFFL))
 
  92                 Index = rx_readl(dev, MUnit.OutboundQueue);
 
  93         if (likely(Index != 0xFFFFFFFFL)) {
 
  95                         if (unlikely(aac_intr_normal(dev, Index))) {
 
  96                                 rx_writel(dev, MUnit.OutboundQueue, Index);
 
  97                                 rx_writel(dev, MUnit.ODR, DoorBellAdapterNormRespReady);
 
  99                         Index = rx_readl(dev, MUnit.OutboundQueue);
 
 100                 } while (Index != 0xFFFFFFFFL);
 
 107  *      aac_rx_disable_interrupt        -       Disable interrupts
 
 111 static void aac_rx_disable_interrupt(struct aac_dev *dev)
 
 113         rx_writeb(dev, MUnit.OIMR, dev->OIMR = 0xff);
 
 117  *      aac_rx_enable_interrupt_producer        -       Enable interrupts
 
 121 static void aac_rx_enable_interrupt_producer(struct aac_dev *dev)
 
 123         rx_writeb(dev, MUnit.OIMR, dev->OIMR = 0xfb);
 
 127  *      aac_rx_enable_interrupt_message -       Enable interrupts
 
 131 static void aac_rx_enable_interrupt_message(struct aac_dev *dev)
 
 133         rx_writeb(dev, MUnit.OIMR, dev->OIMR = 0xf7);
 
 137  *      rx_sync_cmd     -       send a command and wait
 
 139  *      @command: Command to execute
 
 140  *      @p1: first parameter
 
 141  *      @ret: adapter status
 
 143  *      This routine will send a synchronous command to the adapter and wait 
 
 144  *      for its completion.
 
 147 static int rx_sync_cmd(struct aac_dev *dev, u32 command,
 
 148         u32 p1, u32 p2, u32 p3, u32 p4, u32 p5, u32 p6,
 
 149         u32 *status, u32 * r1, u32 * r2, u32 * r3, u32 * r4)
 
 154          *      Write the command into Mailbox 0
 
 156         writel(command, &dev->IndexRegs->Mailbox[0]);
 
 158          *      Write the parameters into Mailboxes 1 - 6
 
 160         writel(p1, &dev->IndexRegs->Mailbox[1]);
 
 161         writel(p2, &dev->IndexRegs->Mailbox[2]);
 
 162         writel(p3, &dev->IndexRegs->Mailbox[3]);
 
 163         writel(p4, &dev->IndexRegs->Mailbox[4]);
 
 165          *      Clear the synch command doorbell to start on a clean slate.
 
 167         rx_writel(dev, OutboundDoorbellReg, OUTBOUNDDOORBELL_0);
 
 169          *      Disable doorbell interrupts
 
 171         rx_writeb(dev, MUnit.OIMR, dev->OIMR = 0xff);
 
 173          *      Force the completion of the mask register write before issuing
 
 176         rx_readb (dev, MUnit.OIMR);
 
 178          *      Signal that there is a new synch command
 
 180         rx_writel(dev, InboundDoorbellReg, INBOUNDDOORBELL_0);
 
 186          *      Wait up to 30 seconds
 
 188         while (time_before(jiffies, start+30*HZ)) 
 
 190                 udelay(5);      /* Delay 5 microseconds to let Mon960 get info. */
 
 192                  *      Mon960 will set doorbell0 bit when it has completed the command.
 
 194                 if (rx_readl(dev, OutboundDoorbellReg) & OUTBOUNDDOORBELL_0) {
 
 196                          *      Clear the doorbell.
 
 198                         rx_writel(dev, OutboundDoorbellReg, OUTBOUNDDOORBELL_0);
 
 203                  *      Yield the processor in case we are slow 
 
 207         if (unlikely(ok != 1)) {
 
 209                  *      Restore interrupt mask even though we timed out
 
 211                 aac_adapter_enable_int(dev);
 
 215          *      Pull the synch status from Mailbox 0.
 
 218                 *status = readl(&dev->IndexRegs->Mailbox[0]);
 
 220                 *r1 = readl(&dev->IndexRegs->Mailbox[1]);
 
 222                 *r2 = readl(&dev->IndexRegs->Mailbox[2]);
 
 224                 *r3 = readl(&dev->IndexRegs->Mailbox[3]);
 
 226                 *r4 = readl(&dev->IndexRegs->Mailbox[4]);
 
 228          *      Clear the synch command doorbell.
 
 230         rx_writel(dev, OutboundDoorbellReg, OUTBOUNDDOORBELL_0);
 
 232          *      Restore interrupt mask
 
 234         aac_adapter_enable_int(dev);
 
 240  *      aac_rx_interrupt_adapter        -       interrupt adapter
 
 243  *      Send an interrupt to the i960 and breakpoint it.
 
 246 static void aac_rx_interrupt_adapter(struct aac_dev *dev)
 
 248         rx_sync_cmd(dev, BREAKPOINT_REQUEST, 0, 0, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL);
 
 252  *      aac_rx_notify_adapter           -       send an event to the adapter
 
 254  *      @event: Event to send
 
 256  *      Notify the i960 that something it probably cares about has
 
 260 static void aac_rx_notify_adapter(struct aac_dev *dev, u32 event)
 
 265                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_1);
 
 267         case HostNormRespNotFull:
 
 268                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_4);
 
 270         case AdapNormRespQue:
 
 271                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_2);
 
 273         case HostNormCmdNotFull:
 
 274                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_3);
 
 279                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_6);
 
 282                 rx_writel(dev, MUnit.IDR,INBOUNDDOORBELL_5);
 
 291  *      aac_rx_start_adapter            -       activate adapter
 
 294  *      Start up processing on an i960 based AAC adapter
 
 297 static void aac_rx_start_adapter(struct aac_dev *dev)
 
 299         struct aac_init *init;
 
 302         init->HostElapsedSeconds = cpu_to_le32(get_seconds());
 
 303         // We can only use a 32 bit address here
 
 304         rx_sync_cmd(dev, INIT_STRUCT_BASE_ADDRESS, (u32)(ulong)dev->init_pa,
 
 305           0, 0, 0, 0, 0, NULL, NULL, NULL, NULL, NULL);
 
 309  *      aac_rx_check_health
 
 310  *      @dev: device to check if healthy
 
 312  *      Will attempt to determine if the specified adapter is alive and
 
 313  *      capable of handling requests, returning 0 if alive.
 
 315 static int aac_rx_check_health(struct aac_dev *dev)
 
 317         u32 status = rx_readl(dev, MUnit.OMRx[0]);
 
 320          *      Check to see if the board failed any self tests.
 
 322         if (unlikely(status & SELF_TEST_FAILED))
 
 325          *      Check to see if the board panic'd.
 
 327         if (unlikely(status & KERNEL_PANIC)) {
 
 333                 dma_addr_t paddr, baddr;
 
 336                 if (likely((status & 0xFF000000L) == 0xBC000000L))
 
 337                         return (status >> 16) & 0xFF;
 
 338                 buffer = pci_alloc_consistent(dev->pdev, 512, &baddr);
 
 340                 if (unlikely(buffer == NULL))
 
 342                 post = pci_alloc_consistent(dev->pdev,
 
 343                   sizeof(struct POSTSTATUS), &paddr);
 
 344                 if (unlikely(post == NULL)) {
 
 345                         pci_free_consistent(dev->pdev, 512, buffer, baddr);
 
 348                 memset(buffer, 0, 512);
 
 349                 post->Post_Command = cpu_to_le32(COMMAND_POST_RESULTS);
 
 350                 post->Post_Address = cpu_to_le32(baddr);
 
 351                 rx_writel(dev, MUnit.IMRx[0], paddr);
 
 352                 rx_sync_cmd(dev, COMMAND_POST_RESULTS, baddr, 0, 0, 0, 0, 0,
 
 353                   NULL, NULL, NULL, NULL, NULL);
 
 354                 pci_free_consistent(dev->pdev, sizeof(struct POSTSTATUS),
 
 356                 if (likely((buffer[0] == '0') && ((buffer[1] == 'x') || (buffer[1] == 'X')))) {
 
 357                         ret = (buffer[2] <= '9') ? (buffer[2] - '0') : (buffer[2] - 'A' + 10);
 
 359                         ret += (buffer[3] <= '9') ? (buffer[3] - '0') : (buffer[3] - 'A' + 10);
 
 361                 pci_free_consistent(dev->pdev, 512, buffer, baddr);
 
 365          *      Wait for the adapter to be up and running.
 
 367         if (unlikely(!(status & KERNEL_UP_AND_RUNNING)))
 
 376  *      aac_rx_deliver_producer
 
 379  *      Will send a fib, returning 0 if successful.
 
 381 int aac_rx_deliver_producer(struct fib * fib)
 
 383         struct aac_dev *dev = fib->dev;
 
 384         struct aac_queue *q = &dev->queues->queue[AdapNormCmdQueue];
 
 385         unsigned long qflags;
 
 387         unsigned long nointr = 0;
 
 389         spin_lock_irqsave(q->lock, qflags);
 
 390         aac_queue_get( dev, &Index, AdapNormCmdQueue, fib->hw_fib_va, 1, fib, &nointr);
 
 393         *(q->headers.producer) = cpu_to_le32(Index + 1);
 
 394         spin_unlock_irqrestore(q->lock, qflags);
 
 395         if (!(nointr & aac_config.irq_mod))
 
 396                 aac_adapter_notify(dev, AdapNormCmdQueue);
 
 402  *      aac_rx_deliver_message
 
 405  *      Will send a fib, returning 0 if successful.
 
 407 static int aac_rx_deliver_message(struct fib * fib)
 
 409         struct aac_dev *dev = fib->dev;
 
 410         struct aac_queue *q = &dev->queues->queue[AdapNormCmdQueue];
 
 411         unsigned long qflags;
 
 414         volatile void __iomem *device;
 
 416         unsigned long count = 10000000L; /* 50 seconds */
 
 417         spin_lock_irqsave(q->lock, qflags);
 
 419         spin_unlock_irqrestore(q->lock, qflags);
 
 421                 Index = rx_readl(dev, MUnit.InboundQueue);
 
 422                 if (unlikely(Index == 0xFFFFFFFFL))
 
 423                         Index = rx_readl(dev, MUnit.InboundQueue);
 
 424                 if (likely(Index != 0xFFFFFFFFL))
 
 427                         spin_lock_irqsave(q->lock, qflags);
 
 429                         spin_unlock_irqrestore(q->lock, qflags);
 
 434         device = dev->base + Index;
 
 435         addr = fib->hw_fib_pa;
 
 436         writel((u32)(addr & 0xffffffff), device);
 
 437         device += sizeof(u32);
 
 438         writel((u32)(addr >> 32), device);
 
 439         device += sizeof(u32);
 
 440         writel(le16_to_cpu(fib->hw_fib_va->header.Size), device);
 
 441         rx_writel(dev, MUnit.InboundQueue, Index);
 
 447  *      @size: mapping resize request
 
 450 static int aac_rx_ioremap(struct aac_dev * dev, u32 size)
 
 453                 iounmap(dev->regs.rx);
 
 456         dev->base = dev->regs.rx = ioremap(dev->scsi_host_ptr->base, size);
 
 457         if (dev->base == NULL)
 
 459         dev->IndexRegs = &dev->regs.rx->IndexRegs;
 
 463 static int aac_rx_restart_adapter(struct aac_dev *dev, int bled)
 
 467         if (!(dev->supplement_adapter_info.SupportedOptions2 &
 
 468           AAC_OPTION_MU_RESET) || (bled >= 0) || (bled == -2)) {
 
 470                         printk(KERN_ERR "%s%d: adapter kernel panic'd %x.\n",
 
 471                                 dev->name, dev->id, bled);
 
 473                         bled = aac_adapter_sync_cmd(dev, IOP_RESET_ALWAYS,
 
 474                           0, 0, 0, 0, 0, 0, &var, NULL, NULL, NULL, NULL);
 
 475                         if (!bled && (var != 0x00000001) && (var != 0x3803000F))
 
 478                 if (bled && (bled != -ETIMEDOUT))
 
 479                         bled = aac_adapter_sync_cmd(dev, IOP_RESET,
 
 480                           0, 0, 0, 0, 0, 0, &var, NULL, NULL, NULL, NULL);
 
 482                 if (bled && (bled != -ETIMEDOUT))
 
 485         if (bled || (var == 0x3803000F)) { /* USE_OTHER_METHOD */
 
 486                 rx_writel(dev, MUnit.reserved2, 3);
 
 487                 msleep(5000); /* Delay 5 seconds */
 
 490         if (var != 0x00000001)
 
 492         if (rx_readl(dev, MUnit.OMRx[0]) & KERNEL_PANIC)
 
 494         if (startup_timeout < 300)
 
 495                 startup_timeout = 300;
 
 500  *      aac_rx_select_comm      -       Select communications method
 
 502  *      @comm: communications method
 
 505 int aac_rx_select_comm(struct aac_dev *dev, int comm)
 
 508         case AAC_COMM_PRODUCER:
 
 509                 dev->a_ops.adapter_enable_int = aac_rx_enable_interrupt_producer;
 
 510                 dev->a_ops.adapter_intr = aac_rx_intr_producer;
 
 511                 dev->a_ops.adapter_deliver = aac_rx_deliver_producer;
 
 513         case AAC_COMM_MESSAGE:
 
 514                 dev->a_ops.adapter_enable_int = aac_rx_enable_interrupt_message;
 
 515                 dev->a_ops.adapter_intr = aac_rx_intr_message;
 
 516                 dev->a_ops.adapter_deliver = aac_rx_deliver_message;
 
 525  *      aac_rx_init     -       initialize an i960 based AAC card
 
 526  *      @dev: device to configure
 
 528  *      Allocate and set up resources for the i960 based AAC variants. The 
 
 529  *      device_interface in the commregion will be allocated and linked 
 
 530  *      to the comm region.
 
 533 int _aac_rx_init(struct aac_dev *dev)
 
 536         unsigned long status;
 
 538         int instance = dev->id;
 
 539         const char * name = dev->name;
 
 541         if (aac_adapter_ioremap(dev, dev->base_size)) {
 
 542                 printk(KERN_WARNING "%s: unable to map adapter.\n", name);
 
 546         /* Failure to reset here is an option ... */
 
 547         dev->a_ops.adapter_sync_cmd = rx_sync_cmd;
 
 548         dev->a_ops.adapter_enable_int = aac_rx_disable_interrupt;
 
 549         dev->OIMR = status = rx_readb (dev, MUnit.OIMR);
 
 550         if ((((status & 0x0c) != 0x0c) || aac_reset_devices || reset_devices) &&
 
 551           !aac_rx_restart_adapter(dev, 0))
 
 552                 /* Make sure the Hardware FIFO is empty */
 
 553                 while ((++restart < 512) &&
 
 554                   (rx_readl(dev, MUnit.OutboundQueue) != 0xFFFFFFFFL));
 
 556          *      Check to see if the board panic'd while booting.
 
 558         status = rx_readl(dev, MUnit.OMRx[0]);
 
 559         if (status & KERNEL_PANIC) {
 
 560                 if (aac_rx_restart_adapter(dev, aac_rx_check_health(dev)))
 
 565          *      Check to see if the board failed any self tests.
 
 567         status = rx_readl(dev, MUnit.OMRx[0]);
 
 568         if (status & SELF_TEST_FAILED) {
 
 569                 printk(KERN_ERR "%s%d: adapter self-test failed.\n", dev->name, instance);
 
 573          *      Check to see if the monitor panic'd while booting.
 
 575         if (status & MONITOR_PANIC) {
 
 576                 printk(KERN_ERR "%s%d: adapter monitor panic.\n", dev->name, instance);
 
 581          *      Wait for the adapter to be up and running. Wait up to 3 minutes
 
 583         while (!((status = rx_readl(dev, MUnit.OMRx[0])) & KERNEL_UP_AND_RUNNING))
 
 586                   (status & (KERNEL_PANIC|SELF_TEST_FAILED|MONITOR_PANIC))) ||
 
 587                   time_after(jiffies, start+HZ*startup_timeout)) {
 
 588                         printk(KERN_ERR "%s%d: adapter kernel failed to start, init status = %lx.\n", 
 
 589                                         dev->name, instance, status);
 
 593                   ((status & (KERNEL_PANIC|SELF_TEST_FAILED|MONITOR_PANIC)) ||
 
 594                   time_after(jiffies, start + HZ *
 
 595                   ((startup_timeout > 60)
 
 596                     ? (startup_timeout - 60)
 
 597                     : (startup_timeout / 2))))) {
 
 598                         if (likely(!aac_rx_restart_adapter(dev, aac_rx_check_health(dev))))
 
 604         if (restart && aac_commit)
 
 607          *      Fill in the common function dispatch table.
 
 609         dev->a_ops.adapter_interrupt = aac_rx_interrupt_adapter;
 
 610         dev->a_ops.adapter_disable_int = aac_rx_disable_interrupt;
 
 611         dev->a_ops.adapter_notify = aac_rx_notify_adapter;
 
 612         dev->a_ops.adapter_sync_cmd = rx_sync_cmd;
 
 613         dev->a_ops.adapter_check_health = aac_rx_check_health;
 
 614         dev->a_ops.adapter_restart = aac_rx_restart_adapter;
 
 617          *      First clear out all interrupts.  Then enable the one's that we
 
 620         aac_adapter_comm(dev, AAC_COMM_PRODUCER);
 
 621         aac_adapter_disable_int(dev);
 
 622         rx_writel(dev, MUnit.ODR, 0xffffffff);
 
 623         aac_adapter_enable_int(dev);
 
 625         if (aac_init_adapter(dev) == NULL)
 
 627         aac_adapter_comm(dev, dev->comm_interface);
 
 628         if (request_irq(dev->scsi_host_ptr->irq, dev->a_ops.adapter_intr,
 
 629                         IRQF_SHARED|IRQF_DISABLED, "aacraid", dev) < 0) {
 
 630                 printk(KERN_ERR "%s%d: Interrupt unavailable.\n",
 
 634         aac_adapter_enable_int(dev);
 
 636          *      Tell the adapter that all is configured, and it can
 
 637          * start accepting requests
 
 639         aac_rx_start_adapter(dev);
 
 648 int aac_rx_init(struct aac_dev *dev)
 
 651          *      Fill in the function dispatch table.
 
 653         dev->a_ops.adapter_ioremap = aac_rx_ioremap;
 
 654         dev->a_ops.adapter_comm = aac_rx_select_comm;
 
 656         return _aac_rx_init(dev);