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: Contains all routines for control of the AFA comm layer
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/completion.h>
38 #include <linux/dma-mapping.h>
39 #include <linux/blkdev.h>
40 #include <linux/delay.h> /* ssleep prototype */
41 #include <linux/kthread.h>
42 #include <asm/semaphore.h>
43 #include <asm/uaccess.h>
48 * ioctl_send_fib - send a FIB from userspace
49 * @dev: adapter is being processed
50 * @arg: arguments to the ioctl call
52 * This routine sends a fib to the adapter on behalf of a user level
55 # define AAC_DEBUG_PREAMBLE KERN_INFO
56 # define AAC_DEBUG_POSTAMBLE
58 static int ioctl_send_fib(struct aac_dev * dev, void __user *arg)
62 struct hw_fib * hw_fib = (struct hw_fib *)0;
63 dma_addr_t hw_fib_pa = (dma_addr_t)0LL;
70 fibptr = aac_fib_alloc(dev);
75 kfib = fibptr->hw_fib_va;
77 * First copy in the header so that we can check the size field.
79 if (copy_from_user((void *)kfib, arg, sizeof(struct aac_fibhdr))) {
84 * Since we copy based on the fib header size, make sure that we
85 * will not overrun the buffer when we copy the memory. Return
86 * an error if we would.
88 size = le16_to_cpu(kfib->header.Size) + sizeof(struct aac_fibhdr);
89 if (size < le16_to_cpu(kfib->header.SenderSize))
90 size = le16_to_cpu(kfib->header.SenderSize);
91 if (size > dev->max_fib_size) {
96 /* Highjack the hw_fib */
97 hw_fib = fibptr->hw_fib_va;
98 hw_fib_pa = fibptr->hw_fib_pa;
99 fibptr->hw_fib_va = kfib = pci_alloc_consistent(dev->pdev, size, &fibptr->hw_fib_pa);
100 memset(((char *)kfib) + dev->max_fib_size, 0, size - dev->max_fib_size);
101 memcpy(kfib, hw_fib, dev->max_fib_size);
104 if (copy_from_user(kfib, arg, size)) {
109 if (kfib->header.Command == cpu_to_le16(TakeABreakPt)) {
110 aac_adapter_interrupt(dev);
112 * Since we didn't really send a fib, zero out the state to allow
113 * cleanup code not to assert.
115 kfib->header.XferState = 0;
117 retval = aac_fib_send(le16_to_cpu(kfib->header.Command), fibptr,
118 le16_to_cpu(kfib->header.Size) , FsaNormal,
123 if (aac_fib_complete(fibptr) != 0) {
129 * Make sure that the size returned by the adapter (which includes
130 * the header) is less than or equal to the size of a fib, so we
131 * don't corrupt application data. Then copy that size to the user
132 * buffer. (Don't try to add the header information again, since it
133 * was already included by the adapter.)
137 if (copy_to_user(arg, (void *)kfib, size))
141 pci_free_consistent(dev->pdev, size, kfib, fibptr->hw_fib_pa);
142 fibptr->hw_fib_pa = hw_fib_pa;
143 fibptr->hw_fib_va = hw_fib;
145 if (retval != -EINTR)
146 aac_fib_free(fibptr);
151 * open_getadapter_fib - Get the next fib
153 * This routine will get the next Fib, if available, from the AdapterFibContext
154 * passed in from the user.
157 static int open_getadapter_fib(struct aac_dev * dev, void __user *arg)
159 struct aac_fib_context * fibctx;
162 fibctx = kmalloc(sizeof(struct aac_fib_context), GFP_KERNEL);
163 if (fibctx == NULL) {
167 struct list_head * entry;
168 struct aac_fib_context * context;
170 fibctx->type = FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT;
171 fibctx->size = sizeof(struct aac_fib_context);
173 * Yes yes, I know this could be an index, but we have a
174 * better guarantee of uniqueness for the locked loop below.
175 * Without the aid of a persistent history, this also helps
176 * reduce the chance that the opaque context would be reused.
178 fibctx->unique = (u32)((ulong)fibctx & 0xFFFFFFFF);
180 * Initialize the mutex used to wait for the next AIF.
182 init_MUTEX_LOCKED(&fibctx->wait_sem);
185 * Initialize the fibs and set the count of fibs on
189 INIT_LIST_HEAD(&fibctx->fib_list);
190 fibctx->jiffies = jiffies/HZ;
192 * Now add this context onto the adapter's
193 * AdapterFibContext list.
195 spin_lock_irqsave(&dev->fib_lock, flags);
196 /* Ensure that we have a unique identifier */
197 entry = dev->fib_list.next;
198 while (entry != &dev->fib_list) {
199 context = list_entry(entry, struct aac_fib_context, next);
200 if (context->unique == fibctx->unique) {
201 /* Not unique (32 bits) */
203 entry = dev->fib_list.next;
208 list_add_tail(&fibctx->next, &dev->fib_list);
209 spin_unlock_irqrestore(&dev->fib_lock, flags);
210 if (copy_to_user(arg, &fibctx->unique,
211 sizeof(fibctx->unique))) {
221 * next_getadapter_fib - get the next fib
222 * @dev: adapter to use
223 * @arg: ioctl argument
225 * This routine will get the next Fib, if available, from the AdapterFibContext
226 * passed in from the user.
229 static int next_getadapter_fib(struct aac_dev * dev, void __user *arg)
233 struct aac_fib_context *fibctx;
235 struct list_head * entry;
238 if(copy_from_user((void *)&f, arg, sizeof(struct fib_ioctl)))
241 * Verify that the HANDLE passed in was a valid AdapterFibContext
243 * Search the list of AdapterFibContext addresses on the adapter
244 * to be sure this is a valid address
246 spin_lock_irqsave(&dev->fib_lock, flags);
247 entry = dev->fib_list.next;
250 while (entry != &dev->fib_list) {
251 fibctx = list_entry(entry, struct aac_fib_context, next);
253 * Extract the AdapterFibContext from the Input parameters.
255 if (fibctx->unique == f.fibctx) { /* We found a winner */
262 spin_unlock_irqrestore(&dev->fib_lock, flags);
263 dprintk ((KERN_INFO "Fib Context not found\n"));
267 if((fibctx->type != FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT) ||
268 (fibctx->size != sizeof(struct aac_fib_context))) {
269 spin_unlock_irqrestore(&dev->fib_lock, flags);
270 dprintk ((KERN_INFO "Fib Context corrupt?\n"));
275 * If there are no fibs to send back, then either wait or return
279 if (!list_empty(&fibctx->fib_list)) {
281 * Pull the next fib from the fibs
283 entry = fibctx->fib_list.next;
286 fib = list_entry(entry, struct fib, fiblink);
288 spin_unlock_irqrestore(&dev->fib_lock, flags);
289 if (copy_to_user(f.fib, fib->hw_fib_va, sizeof(struct hw_fib))) {
290 kfree(fib->hw_fib_va);
295 * Free the space occupied by this copy of the fib.
297 kfree(fib->hw_fib_va);
301 spin_unlock_irqrestore(&dev->fib_lock, flags);
302 /* If someone killed the AIF aacraid thread, restart it */
303 status = !dev->aif_thread;
304 if (status && !dev->in_reset && dev->queues && dev->fsa_dev) {
305 /* Be paranoid, be very paranoid! */
306 kthread_stop(dev->thread);
309 dev->thread = kthread_run(aac_command_thread, dev, dev->name);
313 if(down_interruptible(&fibctx->wait_sem) < 0) {
316 /* Lock again and retry */
317 spin_lock_irqsave(&dev->fib_lock, flags);
324 fibctx->jiffies = jiffies/HZ;
328 int aac_close_fib_context(struct aac_dev * dev, struct aac_fib_context * fibctx)
333 spin_lock_irqsave(&dev->fib_lock, flags);
335 * First free any FIBs that have not been consumed.
337 while (!list_empty(&fibctx->fib_list)) {
338 struct list_head * entry;
340 * Pull the next fib from the fibs
342 entry = fibctx->fib_list.next;
344 fib = list_entry(entry, struct fib, fiblink);
347 * Free the space occupied by this copy of the fib.
349 kfree(fib->hw_fib_va);
353 * Remove the Context from the AdapterFibContext List
355 list_del(&fibctx->next);
356 spin_unlock_irqrestore(&dev->fib_lock, flags);
362 * Free the space occupied by the Context
369 * close_getadapter_fib - close down user fib context
371 * @arg: ioctl arguments
373 * This routine will close down the fibctx passed in from the user.
376 static int close_getadapter_fib(struct aac_dev * dev, void __user *arg)
378 struct aac_fib_context *fibctx;
381 struct list_head * entry;
384 * Verify that the HANDLE passed in was a valid AdapterFibContext
386 * Search the list of AdapterFibContext addresses on the adapter
387 * to be sure this is a valid address
390 entry = dev->fib_list.next;
393 while(entry != &dev->fib_list) {
394 fibctx = list_entry(entry, struct aac_fib_context, next);
396 * Extract the fibctx from the input parameters
398 if (fibctx->unique == (u32)(uintptr_t)arg) /* We found a winner */
405 return 0; /* Already gone */
407 if((fibctx->type != FSAFS_NTC_GET_ADAPTER_FIB_CONTEXT) ||
408 (fibctx->size != sizeof(struct aac_fib_context)))
410 spin_lock_irqsave(&dev->fib_lock, flags);
411 status = aac_close_fib_context(dev, fibctx);
412 spin_unlock_irqrestore(&dev->fib_lock, flags);
417 * check_revision - close down user fib context
419 * @arg: ioctl arguments
421 * This routine returns the driver version.
422 * Under Linux, there have been no version incompatibilities, so this is
426 static int check_revision(struct aac_dev *dev, void __user *arg)
428 struct revision response;
429 char *driver_version = aac_driver_version;
433 version = (simple_strtol(driver_version,
434 &driver_version, 10) << 24) | 0x00000400;
435 version += simple_strtol(driver_version + 1, &driver_version, 10) << 16;
436 version += simple_strtol(driver_version + 1, NULL, 10);
437 response.version = cpu_to_le32(version);
438 # ifdef AAC_DRIVER_BUILD
439 response.build = cpu_to_le32(AAC_DRIVER_BUILD);
441 response.build = cpu_to_le32(9999);
444 if (copy_to_user(arg, &response, sizeof(response)))
456 static int aac_send_raw_srb(struct aac_dev* dev, void __user * arg)
460 struct aac_srb *srbcmd = NULL;
461 struct user_aac_srb *user_srbcmd = NULL;
462 struct user_aac_srb __user *user_srb = arg;
463 struct aac_srb_reply __user *user_reply;
464 struct aac_srb_reply* reply;
469 void __user *sg_user[32];
473 u32 actual_fibsize64, actual_fibsize = 0;
478 dprintk((KERN_DEBUG"aacraid: send raw srb -EBUSY\n"));
481 if (!capable(CAP_SYS_ADMIN)){
482 dprintk((KERN_DEBUG"aacraid: No permission to send raw srb\n"));
486 * Allocate and initialize a Fib then setup a SRB command
488 if (!(srbfib = aac_fib_alloc(dev))) {
491 aac_fib_init(srbfib);
493 srbcmd = (struct aac_srb*) fib_data(srbfib);
495 memset(sg_list, 0, sizeof(sg_list)); /* cleanup may take issue */
496 if(copy_from_user(&fibsize, &user_srb->count,sizeof(u32))){
497 dprintk((KERN_DEBUG"aacraid: Could not copy data size from user\n"));
502 if (fibsize > (dev->max_fib_size - sizeof(struct aac_fibhdr))) {
507 user_srbcmd = kmalloc(fibsize, GFP_KERNEL);
509 dprintk((KERN_DEBUG"aacraid: Could not make a copy of the srb\n"));
513 if(copy_from_user(user_srbcmd, user_srb,fibsize)){
514 dprintk((KERN_DEBUG"aacraid: Could not copy srb from user\n"));
519 user_reply = arg+fibsize;
521 flags = user_srbcmd->flags; /* from user in cpu order */
522 // Fix up srb for endian and force some values
524 srbcmd->function = cpu_to_le32(SRBF_ExecuteScsi); // Force this
525 srbcmd->channel = cpu_to_le32(user_srbcmd->channel);
526 srbcmd->id = cpu_to_le32(user_srbcmd->id);
527 srbcmd->lun = cpu_to_le32(user_srbcmd->lun);
528 srbcmd->timeout = cpu_to_le32(user_srbcmd->timeout);
529 srbcmd->flags = cpu_to_le32(flags);
530 srbcmd->retry_limit = 0; // Obsolete parameter
531 srbcmd->cdb_size = cpu_to_le32(user_srbcmd->cdb_size);
532 memcpy(srbcmd->cdb, user_srbcmd->cdb, sizeof(srbcmd->cdb));
534 switch (flags & (SRB_DataIn | SRB_DataOut)) {
536 data_dir = DMA_TO_DEVICE;
538 case (SRB_DataIn | SRB_DataOut):
539 data_dir = DMA_BIDIRECTIONAL;
542 data_dir = DMA_FROM_DEVICE;
547 if (user_srbcmd->sg.count > ARRAY_SIZE(sg_list)) {
548 dprintk((KERN_DEBUG"aacraid: too many sg entries %d\n",
549 le32_to_cpu(srbcmd->sg.count)));
553 actual_fibsize = sizeof(struct aac_srb) - sizeof(struct sgentry) +
554 ((user_srbcmd->sg.count & 0xff) * sizeof(struct sgentry));
555 actual_fibsize64 = actual_fibsize + (user_srbcmd->sg.count & 0xff) *
556 (sizeof(struct sgentry64) - sizeof(struct sgentry));
557 /* User made a mistake - should not continue */
558 if ((actual_fibsize != fibsize) && (actual_fibsize64 != fibsize)) {
559 dprintk((KERN_DEBUG"aacraid: Bad Size specified in "
560 "Raw SRB command calculated fibsize=%lu;%lu "
561 "user_srbcmd->sg.count=%d aac_srb=%lu sgentry=%lu;%lu "
562 "issued fibsize=%d\n",
563 actual_fibsize, actual_fibsize64, user_srbcmd->sg.count,
564 sizeof(struct aac_srb), sizeof(struct sgentry),
565 sizeof(struct sgentry64), fibsize));
569 if ((data_dir == DMA_NONE) && user_srbcmd->sg.count) {
570 dprintk((KERN_DEBUG"aacraid: SG with no direction specified in Raw SRB command\n"));
575 if (dev->adapter_info.options & AAC_OPT_SGMAP_HOST64) {
576 struct user_sgmap64* upsg = (struct user_sgmap64*)&user_srbcmd->sg;
577 struct sgmap64* psg = (struct sgmap64*)&srbcmd->sg;
580 * This should also catch if user used the 32 bit sgmap
582 if (actual_fibsize64 == fibsize) {
583 actual_fibsize = actual_fibsize64;
584 for (i = 0; i < upsg->count; i++) {
587 /* Does this really need to be GFP_DMA? */
588 p = kmalloc(upsg->sg[i].count,GFP_KERNEL|__GFP_DMA);
590 dprintk((KERN_DEBUG"aacraid: Could not allocate SG buffer - size = %d buffer number %d of %d\n",
591 upsg->sg[i].count,i,upsg->count));
595 addr = (u64)upsg->sg[i].addr[0];
596 addr += ((u64)upsg->sg[i].addr[1]) << 32;
597 sg_user[i] = (void __user *)(uintptr_t)addr;
598 sg_list[i] = p; // save so we can clean up later
601 if (flags & SRB_DataOut) {
602 if(copy_from_user(p,sg_user[i],upsg->sg[i].count)){
603 dprintk((KERN_DEBUG"aacraid: Could not copy sg data from user\n"));
608 addr = pci_map_single(dev->pdev, p, upsg->sg[i].count, data_dir);
610 psg->sg[i].addr[0] = cpu_to_le32(addr & 0xffffffff);
611 psg->sg[i].addr[1] = cpu_to_le32(addr>>32);
612 byte_count += upsg->sg[i].count;
613 psg->sg[i].count = cpu_to_le32(upsg->sg[i].count);
616 struct user_sgmap* usg;
617 usg = kmalloc(actual_fibsize - sizeof(struct aac_srb)
618 + sizeof(struct sgmap), GFP_KERNEL);
620 dprintk((KERN_DEBUG"aacraid: Allocation error in Raw SRB command\n"));
624 memcpy (usg, upsg, actual_fibsize - sizeof(struct aac_srb)
625 + sizeof(struct sgmap));
626 actual_fibsize = actual_fibsize64;
628 for (i = 0; i < usg->count; i++) {
631 /* Does this really need to be GFP_DMA? */
632 p = kmalloc(usg->sg[i].count,GFP_KERNEL|__GFP_DMA);
635 dprintk((KERN_DEBUG"aacraid: Could not allocate SG buffer - size = %d buffer number %d of %d\n",
636 usg->sg[i].count,i,usg->count));
640 sg_user[i] = (void __user *)(uintptr_t)usg->sg[i].addr;
641 sg_list[i] = p; // save so we can clean up later
644 if (flags & SRB_DataOut) {
645 if(copy_from_user(p,sg_user[i],upsg->sg[i].count)){
647 dprintk((KERN_DEBUG"aacraid: Could not copy sg data from user\n"));
652 addr = pci_map_single(dev->pdev, p, usg->sg[i].count, data_dir);
654 psg->sg[i].addr[0] = cpu_to_le32(addr & 0xffffffff);
655 psg->sg[i].addr[1] = cpu_to_le32(addr>>32);
656 byte_count += usg->sg[i].count;
657 psg->sg[i].count = cpu_to_le32(usg->sg[i].count);
661 srbcmd->count = cpu_to_le32(byte_count);
662 psg->count = cpu_to_le32(sg_indx+1);
663 status = aac_fib_send(ScsiPortCommand64, srbfib, actual_fibsize, FsaNormal, 1, 1,NULL,NULL);
665 struct user_sgmap* upsg = &user_srbcmd->sg;
666 struct sgmap* psg = &srbcmd->sg;
668 if (actual_fibsize64 == fibsize) {
669 struct user_sgmap64* usg = (struct user_sgmap64 *)upsg;
670 for (i = 0; i < upsg->count; i++) {
673 /* Does this really need to be GFP_DMA? */
674 p = kmalloc(usg->sg[i].count,GFP_KERNEL|__GFP_DMA);
676 dprintk((KERN_DEBUG"aacraid: Could not allocate SG buffer - size = %d buffer number %d of %d\n",
677 usg->sg[i].count,i,usg->count));
681 addr = (u64)usg->sg[i].addr[0];
682 addr += ((u64)usg->sg[i].addr[1]) << 32;
683 sg_user[i] = (void __user *)addr;
684 sg_list[i] = p; // save so we can clean up later
687 if (flags & SRB_DataOut) {
688 if(copy_from_user(p,sg_user[i],usg->sg[i].count)){
689 dprintk((KERN_DEBUG"aacraid: Could not copy sg data from user\n"));
694 addr = pci_map_single(dev->pdev, p, usg->sg[i].count, data_dir);
696 psg->sg[i].addr = cpu_to_le32(addr & 0xffffffff);
697 byte_count += usg->sg[i].count;
698 psg->sg[i].count = cpu_to_le32(usg->sg[i].count);
701 for (i = 0; i < upsg->count; i++) {
704 p = kmalloc(upsg->sg[i].count, GFP_KERNEL);
706 dprintk((KERN_DEBUG"aacraid: Could not allocate SG buffer - size = %d buffer number %d of %d\n",
707 upsg->sg[i].count, i, upsg->count));
711 sg_user[i] = (void __user *)(uintptr_t)upsg->sg[i].addr;
712 sg_list[i] = p; // save so we can clean up later
715 if (flags & SRB_DataOut) {
716 if(copy_from_user(p, sg_user[i],
717 upsg->sg[i].count)) {
718 dprintk((KERN_DEBUG"aacraid: Could not copy sg data from user\n"));
723 addr = pci_map_single(dev->pdev, p,
724 upsg->sg[i].count, data_dir);
726 psg->sg[i].addr = cpu_to_le32(addr);
727 byte_count += upsg->sg[i].count;
728 psg->sg[i].count = cpu_to_le32(upsg->sg[i].count);
731 srbcmd->count = cpu_to_le32(byte_count);
732 psg->count = cpu_to_le32(sg_indx+1);
733 status = aac_fib_send(ScsiPortCommand, srbfib, actual_fibsize, FsaNormal, 1, 1, NULL, NULL);
735 if (status == -EINTR) {
741 dprintk((KERN_DEBUG"aacraid: Could not send raw srb fib to hba\n"));
746 if (flags & SRB_DataIn) {
747 for(i = 0 ; i <= sg_indx; i++){
748 byte_count = le32_to_cpu(
749 (dev->adapter_info.options & AAC_OPT_SGMAP_HOST64)
750 ? ((struct sgmap64*)&srbcmd->sg)->sg[i].count
751 : srbcmd->sg.sg[i].count);
752 if(copy_to_user(sg_user[i], sg_list[i], byte_count)){
753 dprintk((KERN_DEBUG"aacraid: Could not copy sg data to user\n"));
761 reply = (struct aac_srb_reply *) fib_data(srbfib);
762 if(copy_to_user(user_reply,reply,sizeof(struct aac_srb_reply))){
763 dprintk((KERN_DEBUG"aacraid: Could not copy reply to user\n"));
770 for(i=0; i <= sg_indx; i++){
773 if (rcode != -EINTR) {
774 aac_fib_complete(srbfib);
775 aac_fib_free(srbfib);
781 struct aac_pci_info {
787 static int aac_get_pci_info(struct aac_dev* dev, void __user *arg)
789 struct aac_pci_info pci_info;
791 pci_info.bus = dev->pdev->bus->number;
792 pci_info.slot = PCI_SLOT(dev->pdev->devfn);
794 if (copy_to_user(arg, &pci_info, sizeof(struct aac_pci_info))) {
795 dprintk((KERN_DEBUG "aacraid: Could not copy pci info\n"));
802 int aac_do_ioctl(struct aac_dev * dev, int cmd, void __user *arg)
807 * HBA gets first crack
810 status = aac_dev_ioctl(dev, cmd, arg);
811 if(status != -ENOTTY)
815 case FSACTL_MINIPORT_REV_CHECK:
816 status = check_revision(dev, arg);
818 case FSACTL_SEND_LARGE_FIB:
820 status = ioctl_send_fib(dev, arg);
822 case FSACTL_OPEN_GET_ADAPTER_FIB:
823 status = open_getadapter_fib(dev, arg);
825 case FSACTL_GET_NEXT_ADAPTER_FIB:
826 status = next_getadapter_fib(dev, arg);
828 case FSACTL_CLOSE_GET_ADAPTER_FIB:
829 status = close_getadapter_fib(dev, arg);
831 case FSACTL_SEND_RAW_SRB:
832 status = aac_send_raw_srb(dev,arg);
834 case FSACTL_GET_PCI_INFO:
835 status = aac_get_pci_info(dev,arg);