3 * Linux MegaRAID device driver
5 * Copyright (c) 2003-2004 LSI Logic Corporation.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version
10 * 2 of the License, or (at your option) any later version.
12 * FILE : megaraid_mbox.c
13 * Version : v2.20.4.6 (Mar 07 2005)
16 * Atul Mukker <Atul.Mukker@lsil.com>
17 * Sreenivas Bagalkote <Sreenivas.Bagalkote@lsil.com>
18 * Manoj Jose <Manoj.Jose@lsil.com>
20 * List of supported controllers
22 * OEM Product Name VID DID SSVID SSID
23 * --- ------------ --- --- ---- ----
24 * Dell PERC3/QC 101E 1960 1028 0471
25 * Dell PERC3/DC 101E 1960 1028 0493
26 * Dell PERC3/SC 101E 1960 1028 0475
27 * Dell PERC3/Di 1028 1960 1028 0123
28 * Dell PERC4/SC 1000 1960 1028 0520
29 * Dell PERC4/DC 1000 1960 1028 0518
30 * Dell PERC4/QC 1000 0407 1028 0531
31 * Dell PERC4/Di 1028 000F 1028 014A
32 * Dell PERC 4e/Si 1028 0013 1028 016c
33 * Dell PERC 4e/Di 1028 0013 1028 016d
34 * Dell PERC 4e/Di 1028 0013 1028 016e
35 * Dell PERC 4e/Di 1028 0013 1028 016f
36 * Dell PERC 4e/Di 1028 0013 1028 0170
37 * Dell PERC 4e/DC 1000 0408 1028 0002
38 * Dell PERC 4e/SC 1000 0408 1028 0001
41 * LSI MegaRAID SCSI 320-0 1000 1960 1000 A520
42 * LSI MegaRAID SCSI 320-1 1000 1960 1000 0520
43 * LSI MegaRAID SCSI 320-2 1000 1960 1000 0518
44 * LSI MegaRAID SCSI 320-0X 1000 0407 1000 0530
45 * LSI MegaRAID SCSI 320-2X 1000 0407 1000 0532
46 * LSI MegaRAID SCSI 320-4X 1000 0407 1000 0531
47 * LSI MegaRAID SCSI 320-1E 1000 0408 1000 0001
48 * LSI MegaRAID SCSI 320-2E 1000 0408 1000 0002
49 * LSI MegaRAID SATA 150-4 1000 1960 1000 4523
50 * LSI MegaRAID SATA 150-6 1000 1960 1000 0523
51 * LSI MegaRAID SATA 300-4X 1000 0409 1000 3004
52 * LSI MegaRAID SATA 300-8X 1000 0409 1000 3008
54 * INTEL RAID Controller SRCU42X 1000 0407 8086 0532
55 * INTEL RAID Controller SRCS16 1000 1960 8086 0523
56 * INTEL RAID Controller SRCU42E 1000 0408 8086 0002
57 * INTEL RAID Controller SRCZCRX 1000 0407 8086 0530
58 * INTEL RAID Controller SRCS28X 1000 0409 8086 3008
59 * INTEL RAID Controller SROMBU42E 1000 0408 8086 3431
60 * INTEL RAID Controller SROMBU42E 1000 0408 8086 3499
61 * INTEL RAID Controller SRCU51L 1000 1960 8086 0520
63 * FSC MegaRAID PCI Express ROMB 1000 0408 1734 1065
65 * ACER MegaRAID ROMB-2E 1000 0408 1025 004D
67 * NEC MegaRAID PCI Express ROMB 1000 0408 1033 8287
69 * For history of changes, see Documentation/ChangeLog.megaraid
72 #include "megaraid_mbox.h"
74 static int megaraid_init(void);
75 static void megaraid_exit(void);
77 static int megaraid_probe_one(struct pci_dev*, const struct pci_device_id *);
78 static void megaraid_detach_one(struct pci_dev *);
79 static void megaraid_mbox_shutdown(struct device *);
81 static int megaraid_io_attach(adapter_t *);
82 static void megaraid_io_detach(adapter_t *);
84 static int megaraid_init_mbox(adapter_t *);
85 static void megaraid_fini_mbox(adapter_t *);
87 static int megaraid_alloc_cmd_packets(adapter_t *);
88 static void megaraid_free_cmd_packets(adapter_t *);
90 static int megaraid_mbox_setup_dma_pools(adapter_t *);
91 static void megaraid_mbox_teardown_dma_pools(adapter_t *);
93 static int megaraid_sysfs_alloc_resources(adapter_t *);
94 static void megaraid_sysfs_free_resources(adapter_t *);
96 static int megaraid_abort_handler(struct scsi_cmnd *);
97 static int megaraid_reset_handler(struct scsi_cmnd *);
99 static int mbox_post_sync_cmd(adapter_t *, uint8_t []);
100 static int mbox_post_sync_cmd_fast(adapter_t *, uint8_t []);
101 static int megaraid_busywait_mbox(mraid_device_t *);
102 static int megaraid_mbox_product_info(adapter_t *);
103 static int megaraid_mbox_extended_cdb(adapter_t *);
104 static int megaraid_mbox_support_ha(adapter_t *, uint16_t *);
105 static int megaraid_mbox_support_random_del(adapter_t *);
106 static int megaraid_mbox_get_max_sg(adapter_t *);
107 static void megaraid_mbox_enum_raid_scsi(adapter_t *);
108 static void megaraid_mbox_flush_cache(adapter_t *);
110 static void megaraid_mbox_display_scb(adapter_t *, scb_t *);
111 static void megaraid_mbox_setup_device_map(adapter_t *);
113 static int megaraid_queue_command(struct scsi_cmnd *,
114 void (*)(struct scsi_cmnd *));
115 static scb_t *megaraid_mbox_build_cmd(adapter_t *, struct scsi_cmnd *, int *);
116 static void megaraid_mbox_runpendq(adapter_t *, scb_t *);
117 static void megaraid_mbox_prepare_pthru(adapter_t *, scb_t *,
119 static void megaraid_mbox_prepare_epthru(adapter_t *, scb_t *,
122 static irqreturn_t megaraid_isr(int, void *, struct pt_regs *);
124 static void megaraid_mbox_dpc(unsigned long);
126 static ssize_t megaraid_sysfs_show_app_hndl(struct class_device *, char *);
127 static ssize_t megaraid_sysfs_show_ldnum(struct device *, struct device_attribute *attr, char *);
129 static int megaraid_cmm_register(adapter_t *);
130 static int megaraid_cmm_unregister(adapter_t *);
131 static int megaraid_mbox_mm_handler(unsigned long, uioc_t *, uint32_t);
132 static int megaraid_mbox_mm_command(adapter_t *, uioc_t *);
133 static void megaraid_mbox_mm_done(adapter_t *, scb_t *);
134 static int gather_hbainfo(adapter_t *, mraid_hba_info_t *);
135 static int wait_till_fw_empty(adapter_t *);
139 MODULE_AUTHOR("LSI Logic Corporation");
140 MODULE_DESCRIPTION("LSI Logic MegaRAID Mailbox Driver");
141 MODULE_LICENSE("GPL");
142 MODULE_VERSION(MEGARAID_VERSION);
145 * ### modules parameters for driver ###
149 * Set to enable driver to expose unconfigured disk to kernel
151 static int megaraid_expose_unconf_disks = 0;
152 module_param_named(unconf_disks, megaraid_expose_unconf_disks, int, 0);
153 MODULE_PARM_DESC(unconf_disks,
154 "Set to expose unconfigured disks to kernel (default=0)");
157 * driver wait time if the adapter's mailbox is busy
159 static unsigned int max_mbox_busy_wait = MBOX_BUSY_WAIT;
160 module_param_named(busy_wait, max_mbox_busy_wait, int, 0);
161 MODULE_PARM_DESC(busy_wait,
162 "Max wait for mailbox in microseconds if busy (default=10)");
165 * number of sectors per IO command
167 static unsigned int megaraid_max_sectors = MBOX_MAX_SECTORS;
168 module_param_named(max_sectors, megaraid_max_sectors, int, 0);
169 MODULE_PARM_DESC(max_sectors,
170 "Maximum number of sectors per IO command (default=128)");
173 * number of commands per logical unit
175 static unsigned int megaraid_cmd_per_lun = MBOX_DEF_CMD_PER_LUN;
176 module_param_named(cmd_per_lun, megaraid_cmd_per_lun, int, 0);
177 MODULE_PARM_DESC(cmd_per_lun,
178 "Maximum number of commands per logical unit (default=64)");
182 * Fast driver load option, skip scanning for physical devices during load.
183 * This would result in non-disk devices being skipped during driver load
184 * time. These can be later added though, using /proc/scsi/scsi
186 static unsigned int megaraid_fast_load = 0;
187 module_param_named(fast_load, megaraid_fast_load, int, 0);
188 MODULE_PARM_DESC(fast_load,
189 "Faster loading of the driver, skips physical devices! (default=0)");
193 * mraid_debug level - threshold for amount of information to be displayed by
194 * the driver. This level can be changed through modules parameters, ioctl or
195 * sysfs/proc interface. By default, print the announcement messages only.
197 int mraid_debug_level = CL_ANN;
198 module_param_named(debug_level, mraid_debug_level, int, 0);
199 MODULE_PARM_DESC(debug_level, "Debug level for driver (default=0)");
202 * ### global data ###
204 static uint8_t megaraid_mbox_version[8] =
205 { 0x02, 0x20, 0x04, 0x06, 3, 7, 20, 5 };
209 * PCI table for all supported controllers.
211 static struct pci_device_id pci_id_table_g[] = {
214 PCI_DEVICE_ID_PERC4_DI_DISCOVERY,
216 PCI_SUBSYS_ID_PERC4_DI_DISCOVERY,
219 PCI_VENDOR_ID_LSI_LOGIC,
220 PCI_DEVICE_ID_PERC4_SC,
222 PCI_SUBSYS_ID_PERC4_SC,
225 PCI_VENDOR_ID_LSI_LOGIC,
226 PCI_DEVICE_ID_PERC4_DC,
228 PCI_SUBSYS_ID_PERC4_DC,
231 PCI_VENDOR_ID_LSI_LOGIC,
238 PCI_DEVICE_ID_PERC4_DI_EVERGLADES,
240 PCI_SUBSYS_ID_PERC4_DI_EVERGLADES,
244 PCI_DEVICE_ID_PERC4E_SI_BIGBEND,
246 PCI_SUBSYS_ID_PERC4E_SI_BIGBEND,
250 PCI_DEVICE_ID_PERC4E_DI_KOBUK,
252 PCI_SUBSYS_ID_PERC4E_DI_KOBUK,
256 PCI_DEVICE_ID_PERC4E_DI_CORVETTE,
258 PCI_SUBSYS_ID_PERC4E_DI_CORVETTE,
262 PCI_DEVICE_ID_PERC4E_DI_EXPEDITION,
264 PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION,
268 PCI_DEVICE_ID_PERC4E_DI_GUADALUPE,
270 PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE,
273 PCI_VENDOR_ID_LSI_LOGIC,
274 PCI_DEVICE_ID_DOBSON,
280 PCI_DEVICE_ID_AMI_MEGARAID3,
282 PCI_SUBSYS_ID_PERC3_QC,
286 PCI_DEVICE_ID_AMI_MEGARAID3,
288 PCI_SUBSYS_ID_PERC3_DC,
292 PCI_DEVICE_ID_AMI_MEGARAID3,
294 PCI_SUBSYS_ID_PERC3_SC,
298 PCI_DEVICE_ID_AMI_MEGARAID3,
300 PCI_SUBSYS_ID_PERC3_SC,
304 PCI_DEVICE_ID_AMI_MEGARAID3,
306 PCI_SUBSYS_ID_PERC3_DC,
309 PCI_VENDOR_ID_LSI_LOGIC,
310 PCI_DEVICE_ID_MEGARAID_SCSI_320_0,
311 PCI_VENDOR_ID_LSI_LOGIC,
312 PCI_SUBSYS_ID_MEGARAID_SCSI_320_0,
315 PCI_VENDOR_ID_LSI_LOGIC,
316 PCI_DEVICE_ID_MEGARAID_SCSI_320_1,
317 PCI_VENDOR_ID_LSI_LOGIC,
318 PCI_SUBSYS_ID_MEGARAID_SCSI_320_1,
321 PCI_VENDOR_ID_LSI_LOGIC,
322 PCI_DEVICE_ID_MEGARAID_SCSI_320_2,
323 PCI_VENDOR_ID_LSI_LOGIC,
324 PCI_SUBSYS_ID_MEGARAID_SCSI_320_2,
327 PCI_VENDOR_ID_LSI_LOGIC,
328 PCI_DEVICE_ID_MEGARAID_I4_133_RAID,
329 PCI_VENDOR_ID_LSI_LOGIC,
330 PCI_SUBSYS_ID_MEGARAID_I4_133_RAID,
333 PCI_VENDOR_ID_LSI_LOGIC,
334 PCI_DEVICE_ID_MEGARAID_SATA_150_4,
335 PCI_VENDOR_ID_LSI_LOGIC,
336 PCI_SUBSYS_ID_MEGARAID_SATA_150_4,
339 PCI_VENDOR_ID_LSI_LOGIC,
340 PCI_DEVICE_ID_MEGARAID_SATA_150_6,
341 PCI_VENDOR_ID_LSI_LOGIC,
342 PCI_SUBSYS_ID_MEGARAID_SATA_150_6,
345 PCI_VENDOR_ID_LSI_LOGIC,
346 PCI_DEVICE_ID_LINDSAY,
351 PCI_VENDOR_ID_LSI_LOGIC,
352 PCI_DEVICE_ID_INTEL_RAID_SRCS16,
354 PCI_SUBSYS_ID_INTEL_RAID_SRCS16,
357 PCI_VENDOR_ID_LSI_LOGIC,
358 PCI_DEVICE_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK,
360 PCI_SUBSYS_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK,
362 {0} /* Terminating entry */
364 MODULE_DEVICE_TABLE(pci, pci_id_table_g);
367 static struct pci_driver megaraid_pci_driver_g = {
369 .id_table = pci_id_table_g,
370 .probe = megaraid_probe_one,
371 .remove = __devexit_p(megaraid_detach_one),
373 .shutdown = megaraid_mbox_shutdown,
379 // definitions for the device attributes for exporting logical drive number
380 // for a scsi address (Host, Channel, Id, Lun)
382 CLASS_DEVICE_ATTR(megaraid_mbox_app_hndl, S_IRUSR, megaraid_sysfs_show_app_hndl,
385 // Host template initializer for megaraid mbox sysfs device attributes
386 static struct class_device_attribute *megaraid_shost_attrs[] = {
387 &class_device_attr_megaraid_mbox_app_hndl,
392 DEVICE_ATTR(megaraid_mbox_ld, S_IRUSR, megaraid_sysfs_show_ldnum, NULL);
394 // Host template initializer for megaraid mbox sysfs device attributes
395 static struct device_attribute *megaraid_sdev_attrs[] = {
396 &dev_attr_megaraid_mbox_ld,
402 * Scsi host template for megaraid unified driver
404 static struct scsi_host_template megaraid_template_g = {
405 .module = THIS_MODULE,
406 .name = "LSI Logic MegaRAID driver",
407 .proc_name = "megaraid",
408 .queuecommand = megaraid_queue_command,
409 .eh_abort_handler = megaraid_abort_handler,
410 .eh_device_reset_handler = megaraid_reset_handler,
411 .eh_bus_reset_handler = megaraid_reset_handler,
412 .eh_host_reset_handler = megaraid_reset_handler,
413 .use_clustering = ENABLE_CLUSTERING,
414 .sdev_attrs = megaraid_sdev_attrs,
415 .shost_attrs = megaraid_shost_attrs,
420 * megaraid_init - module load hook
422 * We register ourselves as hotplug enabled module and let PCI subsystem
423 * discover our adaters
430 // Announce the driver version
431 con_log(CL_ANN, (KERN_INFO "megaraid: %s %s\n", MEGARAID_VERSION,
432 MEGARAID_EXT_VERSION));
434 // check validity of module parameters
435 if (megaraid_cmd_per_lun > MBOX_MAX_SCSI_CMDS) {
437 con_log(CL_ANN, (KERN_WARNING
438 "megaraid mailbox: max commands per lun reset to %d\n",
439 MBOX_MAX_SCSI_CMDS));
441 megaraid_cmd_per_lun = MBOX_MAX_SCSI_CMDS;
445 // register as a PCI hot-plug driver module
446 rval = pci_register_driver(&megaraid_pci_driver_g);
448 con_log(CL_ANN, (KERN_WARNING
449 "megaraid: could not register hotplug support.\n"));
457 * megaraid_exit - driver unload entry point
459 * We simply unwrap the megaraid_init routine here
464 con_log(CL_DLEVEL1, (KERN_NOTICE "megaraid: unloading framework\n"));
466 // unregister as PCI hotplug driver
467 pci_unregister_driver(&megaraid_pci_driver_g);
474 * megaraid_probe_one - PCI hotplug entry point
475 * @param pdev : handle to this controller's PCI configuration space
476 * @param id : pci device id of the class of controllers
478 * This routine should be called whenever a new adapter is detected by the
479 * PCI hotplug susbsytem.
482 megaraid_probe_one(struct pci_dev *pdev, const struct pci_device_id *id)
487 // detected a new controller
488 con_log(CL_ANN, (KERN_INFO
489 "megaraid: probe new device %#4.04x:%#4.04x:%#4.04x:%#4.04x: ",
490 pdev->vendor, pdev->device, pdev->subsystem_vendor,
491 pdev->subsystem_device));
493 con_log(CL_ANN, ("bus %d:slot %d:func %d\n", pdev->bus->number,
494 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn)));
496 if (pci_enable_device(pdev)) {
497 con_log(CL_ANN, (KERN_WARNING
498 "megaraid: pci_enable_device failed\n"));
503 // Enable bus-mastering on this controller
504 pci_set_master(pdev);
506 // Allocate the per driver initialization structure
507 adapter = kmalloc(sizeof(adapter_t), GFP_KERNEL);
509 if (adapter == NULL) {
510 con_log(CL_ANN, (KERN_WARNING
511 "megaraid: out of memory, %s %d.\n", __FUNCTION__, __LINE__));
515 memset(adapter, 0, sizeof(adapter_t));
518 // set up PCI related soft state and other pre-known parameters
519 adapter->unique_id = pdev->bus->number << 8 | pdev->devfn;
520 adapter->irq = pdev->irq;
521 adapter->pdev = pdev;
523 atomic_set(&adapter->being_detached, 0);
525 // Setup the default DMA mask. This would be changed later on
526 // depending on hardware capabilities
527 if (pci_set_dma_mask(adapter->pdev, DMA_32BIT_MASK) != 0) {
529 con_log(CL_ANN, (KERN_WARNING
530 "megaraid: pci_set_dma_mask failed:%d\n", __LINE__));
532 goto out_free_adapter;
536 // Initialize the synchronization lock for kernel and LLD
537 spin_lock_init(&adapter->lock);
538 adapter->host_lock = &adapter->lock;
541 // Initialize the command queues: the list of free SCBs and the list
543 INIT_LIST_HEAD(&adapter->kscb_pool);
544 spin_lock_init(SCSI_FREE_LIST_LOCK(adapter));
546 INIT_LIST_HEAD(&adapter->pend_list);
547 spin_lock_init(PENDING_LIST_LOCK(adapter));
549 INIT_LIST_HEAD(&adapter->completed_list);
550 spin_lock_init(COMPLETED_LIST_LOCK(adapter));
553 // Start the mailbox based controller
554 if (megaraid_init_mbox(adapter) != 0) {
555 con_log(CL_ANN, (KERN_WARNING
556 "megaraid: maibox adapter did not initialize\n"));
558 goto out_free_adapter;
561 // Register with LSI Common Management Module
562 if (megaraid_cmm_register(adapter) != 0) {
564 con_log(CL_ANN, (KERN_WARNING
565 "megaraid: could not register with management module\n"));
570 // setup adapter handle in PCI soft state
571 pci_set_drvdata(pdev, adapter);
573 // attach with scsi mid-layer
574 if (megaraid_io_attach(adapter) != 0) {
576 con_log(CL_ANN, (KERN_WARNING "megaraid: io attach failed\n"));
584 pci_set_drvdata(pdev, NULL);
585 megaraid_cmm_unregister(adapter);
587 megaraid_fini_mbox(adapter);
591 pci_disable_device(pdev);
598 * megaraid_detach_one - release the framework resources and call LLD release
600 * @param pdev : handle for our PCI cofiguration space
602 * This routine is called during driver unload. We free all the allocated
603 * resources and call the corresponding LLD so that it can also release all
606 * This routine is also called from the PCI hotplug system
609 megaraid_detach_one(struct pci_dev *pdev)
612 struct Scsi_Host *host;
615 // Start a rollback on this adapter
616 adapter = pci_get_drvdata(pdev);
619 con_log(CL_ANN, (KERN_CRIT
620 "megaraid: Invalid detach on %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
621 pdev->vendor, pdev->device, pdev->subsystem_vendor,
622 pdev->subsystem_device));
627 con_log(CL_ANN, (KERN_NOTICE
628 "megaraid: detaching device %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
629 pdev->vendor, pdev->device, pdev->subsystem_vendor,
630 pdev->subsystem_device));
634 host = adapter->host;
636 // do not allow any more requests from the management module for this
638 // FIXME: How do we account for the request which might still be
640 atomic_set(&adapter->being_detached, 1);
642 // detach from the IO sub-system
643 megaraid_io_detach(adapter);
645 // reset the device state in the PCI structure. We check this
646 // condition when we enter here. If the device state is NULL,
647 // that would mean the device has already been removed
648 pci_set_drvdata(pdev, NULL);
650 // Unregister from common management module
652 // FIXME: this must return success or failure for conditions if there
653 // is a command pending with LLD or not.
654 megaraid_cmm_unregister(adapter);
656 // finalize the mailbox based controller and release all resources
657 megaraid_fini_mbox(adapter);
663 pci_disable_device(pdev);
670 * megaraid_mbox_shutdown - PCI shutdown for megaraid HBA
671 * @param device : generice driver model device
673 * Shutdown notification, perform flush cache
676 megaraid_mbox_shutdown(struct device *device)
678 adapter_t *adapter = pci_get_drvdata(to_pci_dev(device));
682 con_log(CL_ANN, (KERN_WARNING
683 "megaraid: null device in shutdown\n"));
688 con_log(CL_ANN, (KERN_INFO "megaraid: flushing adapter %d...",
691 megaraid_mbox_flush_cache(adapter);
693 con_log(CL_ANN, ("done\n"));
698 * megaraid_io_attach - attach a device with the IO subsystem
699 * @param adapter : controller's soft state
701 * Attach this device with the IO subsystem
704 megaraid_io_attach(adapter_t *adapter)
706 struct Scsi_Host *host;
708 // Initialize SCSI Host structure
709 host = scsi_host_alloc(&megaraid_template_g, 8);
711 con_log(CL_ANN, (KERN_WARNING
712 "megaraid mbox: scsi_register failed\n"));
717 SCSIHOST2ADAP(host) = (caddr_t)adapter;
718 adapter->host = host;
720 // export the parameters required by the mid-layer
721 scsi_assign_lock(host, adapter->host_lock);
723 host->irq = adapter->irq;
724 host->unique_id = adapter->unique_id;
725 host->can_queue = adapter->max_cmds;
726 host->this_id = adapter->init_id;
727 host->sg_tablesize = adapter->sglen;
728 host->max_sectors = adapter->max_sectors;
729 host->cmd_per_lun = adapter->cmd_per_lun;
730 host->max_channel = adapter->max_channel;
731 host->max_id = adapter->max_target;
732 host->max_lun = adapter->max_lun;
735 // notify mid-layer about the new controller
736 if (scsi_add_host(host, &adapter->pdev->dev)) {
738 con_log(CL_ANN, (KERN_WARNING
739 "megaraid mbox: scsi_add_host failed\n"));
746 scsi_scan_host(host);
753 * megaraid_io_detach - detach a device from the IO subsystem
754 * @param adapter : controller's soft state
756 * Detach this device from the IO subsystem
759 megaraid_io_detach(adapter_t *adapter)
761 struct Scsi_Host *host;
763 con_log(CL_DLEVEL1, (KERN_INFO "megaraid: io detach\n"));
765 host = adapter->host;
767 scsi_remove_host(host);
774 * START: Mailbox Low Level Driver
776 * This is section specific to the single mailbox based controllers
780 * megaraid_init_mbox - initialize controller
781 * @param adapter - our soft state
783 * . Allocate 16-byte aligned mailbox memory for firmware handshake
784 * . Allocate controller's memory resources
785 * . Find out all initialization data
786 * . Allocate memory required for all the commands
787 * . Use internal library of FW routines, build up complete soft state
790 megaraid_init_mbox(adapter_t *adapter)
792 struct pci_dev *pdev;
793 mraid_device_t *raid_dev;
797 adapter->ito = MBOX_TIMEOUT;
798 pdev = adapter->pdev;
801 * Allocate and initialize the init data structure for mailbox
804 raid_dev = kmalloc(sizeof(mraid_device_t), GFP_KERNEL);
805 if (raid_dev == NULL) return -1;
807 memset(raid_dev, 0, sizeof(mraid_device_t));
810 * Attach the adapter soft state to raid device soft state
812 adapter->raid_device = (caddr_t)raid_dev;
813 raid_dev->fast_load = megaraid_fast_load;
817 raid_dev->baseport = pci_resource_start(pdev, 0);
819 if (pci_request_regions(pdev, "MegaRAID: LSI Logic Corporation") != 0) {
821 con_log(CL_ANN, (KERN_WARNING
822 "megaraid: mem region busy\n"));
824 goto out_free_raid_dev;
827 raid_dev->baseaddr = ioremap_nocache(raid_dev->baseport, 128);
829 if (!raid_dev->baseaddr) {
831 con_log(CL_ANN, (KERN_WARNING
832 "megaraid: could not map hba memory\n") );
834 goto out_release_regions;
838 // Setup the rest of the soft state using the library of FW routines
841 // request IRQ and register the interrupt service routine
842 if (request_irq(adapter->irq, megaraid_isr, SA_SHIRQ, "megaraid",
845 con_log(CL_ANN, (KERN_WARNING
846 "megaraid: Couldn't register IRQ %d!\n", adapter->irq));
852 // initialize the mutual exclusion lock for the mailbox
853 spin_lock_init(&raid_dev->mailbox_lock);
855 // allocate memory required for commands
856 if (megaraid_alloc_cmd_packets(adapter) != 0) {
861 if (megaraid_mbox_product_info(adapter) != 0) {
865 // Do we support extended CDBs
866 adapter->max_cdb_sz = 10;
867 if (megaraid_mbox_extended_cdb(adapter) == 0) {
868 adapter->max_cdb_sz = 16;
872 * Do we support cluster environment, if we do, what is the initiator
874 * NOTE: In a non-cluster aware firmware environment, the LLD should
875 * return 7 as initiator id.
878 adapter->init_id = -1;
879 if (megaraid_mbox_support_ha(adapter, &adapter->init_id) == 0) {
884 * Prepare the device ids array to have the mapping between the kernel
885 * device address and megaraid device address.
886 * We export the physical devices on their actual addresses. The
887 * logical drives are exported on a virtual SCSI channel
889 megaraid_mbox_setup_device_map(adapter);
891 // If the firmware supports random deletion, update the device id map
892 if (megaraid_mbox_support_random_del(adapter)) {
894 // Change the logical drives numbers in device_ids array one
895 // slot in device_ids is reserved for target id, that's why
897 for (i = 0; i <= MAX_LOGICAL_DRIVES_40LD; i++) {
898 adapter->device_ids[adapter->max_channel][i] += 0x80;
900 adapter->device_ids[adapter->max_channel][adapter->init_id] =
903 raid_dev->random_del_supported = 1;
907 * find out the maximum number of scatter-gather elements supported by
910 adapter->sglen = megaraid_mbox_get_max_sg(adapter);
912 // enumerate RAID and SCSI channels so that all devices on SCSI
913 // channels can later be exported, including disk devices
914 megaraid_mbox_enum_raid_scsi(adapter);
917 * Other parameters required by upper layer
919 * maximum number of sectors per IO command
921 adapter->max_sectors = megaraid_max_sectors;
924 * number of queued commands per LUN.
926 adapter->cmd_per_lun = megaraid_cmd_per_lun;
929 * Allocate resources required to issue FW calls, when sysfs is
932 if (megaraid_sysfs_alloc_resources(adapter) != 0) {
936 // Set the DMA mask to 64-bit. All supported controllers as capable of
938 if (pci_set_dma_mask(adapter->pdev, DMA_64BIT_MASK) != 0) {
940 con_log(CL_ANN, (KERN_WARNING
941 "megaraid: could not set DMA mask for 64-bit.\n"));
943 goto out_free_sysfs_res;
946 // setup tasklet for DPC
947 tasklet_init(&adapter->dpc_h, megaraid_mbox_dpc,
948 (unsigned long)adapter);
950 con_log(CL_DLEVEL1, (KERN_INFO
951 "megaraid mbox hba successfully initialized\n"));
956 megaraid_sysfs_free_resources(adapter);
958 megaraid_free_cmd_packets(adapter);
960 free_irq(adapter->irq, adapter);
962 iounmap(raid_dev->baseaddr);
964 pci_release_regions(pdev);
973 * megaraid_fini_mbox - undo controller initialization
974 * @param adapter : our soft state
977 megaraid_fini_mbox(adapter_t *adapter)
979 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
982 megaraid_mbox_flush_cache(adapter);
984 tasklet_kill(&adapter->dpc_h);
986 megaraid_sysfs_free_resources(adapter);
988 megaraid_free_cmd_packets(adapter);
990 free_irq(adapter->irq, adapter);
992 iounmap(raid_dev->baseaddr);
994 pci_release_regions(adapter->pdev);
1003 * megaraid_alloc_cmd_packets - allocate shared mailbox
1004 * @param adapter : soft state of the raid controller
1006 * Allocate and align the shared mailbox. This maibox is used to issue
1007 * all the commands. For IO based controllers, the mailbox is also regsitered
1008 * with the FW. Allocate memory for all commands as well.
1009 * This is our big allocator
1012 megaraid_alloc_cmd_packets(adapter_t *adapter)
1014 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1015 struct pci_dev *pdev;
1016 unsigned long align;
1019 struct mraid_pci_blk *epthru_pci_blk;
1020 struct mraid_pci_blk *sg_pci_blk;
1021 struct mraid_pci_blk *mbox_pci_blk;
1024 pdev = adapter->pdev;
1028 * Allocate the common 16-byte aligned memory for the handshake
1031 raid_dev->una_mbox64 = pci_alloc_consistent(adapter->pdev,
1032 sizeof(mbox64_t), &raid_dev->una_mbox64_dma);
1034 if (!raid_dev->una_mbox64) {
1035 con_log(CL_ANN, (KERN_WARNING
1036 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1040 memset(raid_dev->una_mbox64, 0, sizeof(mbox64_t));
1043 * Align the mailbox at 16-byte boundary
1045 raid_dev->mbox = &raid_dev->una_mbox64->mbox32;
1047 raid_dev->mbox = (mbox_t *)((((unsigned long)raid_dev->mbox) + 15) &
1050 raid_dev->mbox64 = (mbox64_t *)(((unsigned long)raid_dev->mbox) - 8);
1052 align = ((void *)raid_dev->mbox -
1053 ((void *)&raid_dev->una_mbox64->mbox32));
1055 raid_dev->mbox_dma = (unsigned long)raid_dev->una_mbox64_dma + 8 +
1058 // Allocate memory for commands issued internally
1059 adapter->ibuf = pci_alloc_consistent(pdev, MBOX_IBUF_SIZE,
1060 &adapter->ibuf_dma_h);
1061 if (!adapter->ibuf) {
1063 con_log(CL_ANN, (KERN_WARNING
1064 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1067 goto out_free_common_mbox;
1069 memset(adapter->ibuf, 0, MBOX_IBUF_SIZE);
1071 // Allocate memory for our SCSI Command Blocks and their associated
1075 * Allocate memory for the base list of scb. Later allocate memory for
1076 * CCBs and embedded components of each CCB and point the pointers in
1077 * scb to the allocated components
1078 * NOTE: The code to allocate SCB will be duplicated in all the LLD
1079 * since the calling routine does not yet know the number of available
1082 adapter->kscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_SCSI_CMDS,
1085 if (adapter->kscb_list == NULL) {
1086 con_log(CL_ANN, (KERN_WARNING
1087 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1091 memset(adapter->kscb_list, 0, sizeof(scb_t) * MBOX_MAX_SCSI_CMDS);
1093 // memory allocation for our command packets
1094 if (megaraid_mbox_setup_dma_pools(adapter) != 0) {
1095 con_log(CL_ANN, (KERN_WARNING
1096 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1098 goto out_free_scb_list;
1101 // Adjust the scb pointers and link in the free pool
1102 epthru_pci_blk = raid_dev->epthru_pool;
1103 sg_pci_blk = raid_dev->sg_pool;
1104 mbox_pci_blk = raid_dev->mbox_pool;
1106 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1107 scb = adapter->kscb_list + i;
1108 ccb = raid_dev->ccb_list + i;
1110 ccb->mbox = (mbox_t *)(mbox_pci_blk[i].vaddr + 16);
1111 ccb->raw_mbox = (uint8_t *)ccb->mbox;
1112 ccb->mbox64 = (mbox64_t *)(mbox_pci_blk[i].vaddr + 8);
1113 ccb->mbox_dma_h = (unsigned long)mbox_pci_blk[i].dma_addr + 16;
1115 // make sure the mailbox is aligned properly
1116 if (ccb->mbox_dma_h & 0x0F) {
1117 con_log(CL_ANN, (KERN_CRIT
1118 "megaraid mbox: not aligned on 16-bytes\n"));
1120 goto out_teardown_dma_pools;
1123 ccb->epthru = (mraid_epassthru_t *)
1124 epthru_pci_blk[i].vaddr;
1125 ccb->epthru_dma_h = epthru_pci_blk[i].dma_addr;
1126 ccb->pthru = (mraid_passthru_t *)ccb->epthru;
1127 ccb->pthru_dma_h = ccb->epthru_dma_h;
1130 ccb->sgl64 = (mbox_sgl64 *)sg_pci_blk[i].vaddr;
1131 ccb->sgl_dma_h = sg_pci_blk[i].dma_addr;
1132 ccb->sgl32 = (mbox_sgl32 *)ccb->sgl64;
1134 scb->ccb = (caddr_t)ccb;
1137 scb->sno = i; // command index
1140 scb->state = SCB_FREE;
1141 scb->dma_direction = PCI_DMA_NONE;
1142 scb->dma_type = MRAID_DMA_NONE;
1143 scb->dev_channel = -1;
1144 scb->dev_target = -1;
1146 // put scb in the free pool
1147 list_add_tail(&scb->list, &adapter->kscb_pool);
1152 out_teardown_dma_pools:
1153 megaraid_mbox_teardown_dma_pools(adapter);
1155 kfree(adapter->kscb_list);
1157 pci_free_consistent(pdev, MBOX_IBUF_SIZE, (void *)adapter->ibuf,
1158 adapter->ibuf_dma_h);
1159 out_free_common_mbox:
1160 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1161 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1168 * megaraid_free_cmd_packets - free memory
1169 * @param adapter : soft state of the raid controller
1171 * Release memory resources allocated for commands
1174 megaraid_free_cmd_packets(adapter_t *adapter)
1176 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1178 megaraid_mbox_teardown_dma_pools(adapter);
1180 kfree(adapter->kscb_list);
1182 pci_free_consistent(adapter->pdev, MBOX_IBUF_SIZE,
1183 (void *)adapter->ibuf, adapter->ibuf_dma_h);
1185 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1186 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1192 * megaraid_mbox_setup_dma_pools - setup dma pool for command packets
1193 * @param adapter : HBA soft state
1195 * setup the dma pools for mailbox, passthru and extended passthru structures,
1196 * and scatter-gather lists
1199 megaraid_mbox_setup_dma_pools(adapter_t *adapter)
1201 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1202 struct mraid_pci_blk *epthru_pci_blk;
1203 struct mraid_pci_blk *sg_pci_blk;
1204 struct mraid_pci_blk *mbox_pci_blk;
1209 // Allocate memory for 16-bytes aligned mailboxes
1210 raid_dev->mbox_pool_handle = pci_pool_create("megaraid mbox pool",
1212 sizeof(mbox64_t) + 16,
1215 if (raid_dev->mbox_pool_handle == NULL) {
1216 goto fail_setup_dma_pool;
1219 mbox_pci_blk = raid_dev->mbox_pool;
1220 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1221 mbox_pci_blk[i].vaddr = pci_pool_alloc(
1222 raid_dev->mbox_pool_handle,
1224 &mbox_pci_blk[i].dma_addr);
1225 if (!mbox_pci_blk[i].vaddr) {
1226 goto fail_setup_dma_pool;
1231 * Allocate memory for each embedded passthru strucuture pointer
1232 * Request for a 128 bytes aligned structure for each passthru command
1234 * Since passthru and extended passthru commands are exclusive, they
1235 * share common memory pool. Passthru structures piggyback on memory
1236 * allocted to extended passthru since passthru is smaller of the two
1238 raid_dev->epthru_pool_handle = pci_pool_create("megaraid mbox pthru",
1239 adapter->pdev, sizeof(mraid_epassthru_t), 128, 0);
1241 if (raid_dev->epthru_pool_handle == NULL) {
1242 goto fail_setup_dma_pool;
1245 epthru_pci_blk = raid_dev->epthru_pool;
1246 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1247 epthru_pci_blk[i].vaddr = pci_pool_alloc(
1248 raid_dev->epthru_pool_handle,
1250 &epthru_pci_blk[i].dma_addr);
1251 if (!epthru_pci_blk[i].vaddr) {
1252 goto fail_setup_dma_pool;
1257 // Allocate memory for each scatter-gather list. Request for 512 bytes
1258 // alignment for each sg list
1259 raid_dev->sg_pool_handle = pci_pool_create("megaraid mbox sg",
1261 sizeof(mbox_sgl64) * MBOX_MAX_SG_SIZE,
1264 if (raid_dev->sg_pool_handle == NULL) {
1265 goto fail_setup_dma_pool;
1268 sg_pci_blk = raid_dev->sg_pool;
1269 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1270 sg_pci_blk[i].vaddr = pci_pool_alloc(
1271 raid_dev->sg_pool_handle,
1273 &sg_pci_blk[i].dma_addr);
1274 if (!sg_pci_blk[i].vaddr) {
1275 goto fail_setup_dma_pool;
1281 fail_setup_dma_pool:
1282 megaraid_mbox_teardown_dma_pools(adapter);
1288 * megaraid_mbox_teardown_dma_pools - teardown dma pools for command packets
1289 * @param adapter : HBA soft state
1291 * teardown the dma pool for mailbox, passthru and extended passthru
1292 * structures, and scatter-gather lists
1295 megaraid_mbox_teardown_dma_pools(adapter_t *adapter)
1297 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1298 struct mraid_pci_blk *epthru_pci_blk;
1299 struct mraid_pci_blk *sg_pci_blk;
1300 struct mraid_pci_blk *mbox_pci_blk;
1304 sg_pci_blk = raid_dev->sg_pool;
1305 for (i = 0; i < MBOX_MAX_SCSI_CMDS && sg_pci_blk[i].vaddr; i++) {
1306 pci_pool_free(raid_dev->sg_pool_handle, sg_pci_blk[i].vaddr,
1307 sg_pci_blk[i].dma_addr);
1309 if (raid_dev->sg_pool_handle)
1310 pci_pool_destroy(raid_dev->sg_pool_handle);
1313 epthru_pci_blk = raid_dev->epthru_pool;
1314 for (i = 0; i < MBOX_MAX_SCSI_CMDS && epthru_pci_blk[i].vaddr; i++) {
1315 pci_pool_free(raid_dev->epthru_pool_handle,
1316 epthru_pci_blk[i].vaddr, epthru_pci_blk[i].dma_addr);
1318 if (raid_dev->epthru_pool_handle)
1319 pci_pool_destroy(raid_dev->epthru_pool_handle);
1322 mbox_pci_blk = raid_dev->mbox_pool;
1323 for (i = 0; i < MBOX_MAX_SCSI_CMDS && mbox_pci_blk[i].vaddr; i++) {
1324 pci_pool_free(raid_dev->mbox_pool_handle,
1325 mbox_pci_blk[i].vaddr, mbox_pci_blk[i].dma_addr);
1327 if (raid_dev->mbox_pool_handle)
1328 pci_pool_destroy(raid_dev->mbox_pool_handle);
1335 * megaraid_alloc_scb - detach and return a scb from the free list
1336 * @adapter : controller's soft state
1338 * return the scb from the head of the free list. NULL if there are none
1341 static inline scb_t *
1342 megaraid_alloc_scb(adapter_t *adapter, struct scsi_cmnd *scp)
1344 struct list_head *head = &adapter->kscb_pool;
1346 unsigned long flags;
1348 // detach scb from free pool
1349 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1351 if (list_empty(head)) {
1352 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1356 scb = list_entry(head->next, scb_t, list);
1357 list_del_init(&scb->list);
1359 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1361 scb->state = SCB_ACTIVE;
1363 scb->dma_type = MRAID_DMA_NONE;
1370 * megaraid_dealloc_scb - return the scb to the free pool
1371 * @adapter : controller's soft state
1372 * @scb : scb to be freed
1374 * return the scb back to the free list of scbs. The caller must 'flush' the
1375 * SCB before calling us. E.g., performing pci_unamp and/or pci_sync etc.
1376 * NOTE NOTE: Make sure the scb is not on any list before calling this
1380 megaraid_dealloc_scb(adapter_t *adapter, scb_t *scb)
1382 unsigned long flags;
1384 // put scb in the free pool
1385 scb->state = SCB_FREE;
1387 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1389 list_add(&scb->list, &adapter->kscb_pool);
1391 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1398 * megaraid_mbox_mksgl - make the scatter-gather list
1399 * @adapter - controller's soft state
1400 * @scb - scsi control block
1402 * prepare the scatter-gather list
1405 megaraid_mbox_mksgl(adapter_t *adapter, scb_t *scb)
1407 struct scatterlist *sgl;
1410 unsigned long offset;
1411 struct scsi_cmnd *scp;
1417 ccb = (mbox_ccb_t *)scb->ccb;
1419 // no mapping required if no data to be transferred
1420 if (!scp->request_buffer || !scp->request_bufflen)
1423 if (!scp->use_sg) { /* scatter-gather list not used */
1425 page = virt_to_page(scp->request_buffer);
1427 offset = ((unsigned long)scp->request_buffer & ~PAGE_MASK);
1429 ccb->buf_dma_h = pci_map_page(adapter->pdev, page, offset,
1430 scp->request_bufflen,
1431 scb->dma_direction);
1432 scb->dma_type = MRAID_DMA_WBUF;
1435 * We need to handle special 64-bit commands that need a
1439 ccb->sgl64[0].address = ccb->buf_dma_h;
1440 ccb->sgl64[0].length = scp->request_bufflen;
1445 sgl = (struct scatterlist *)scp->request_buffer;
1447 // The number of sg elements returned must not exceed our limit
1448 sgcnt = pci_map_sg(adapter->pdev, sgl, scp->use_sg,
1449 scb->dma_direction);
1451 if (sgcnt > adapter->sglen) {
1452 con_log(CL_ANN, (KERN_CRIT
1453 "megaraid critical: too many sg elements:%d\n",
1458 scb->dma_type = MRAID_DMA_WSG;
1460 for (i = 0; i < sgcnt; i++, sgl++) {
1461 ccb->sgl64[i].address = sg_dma_address(sgl);
1462 ccb->sgl64[i].length = sg_dma_len(sgl);
1465 // Return count of SG nodes
1471 * mbox_post_cmd - issue a mailbox command
1472 * @adapter - controller's soft state
1473 * @scb - command to be issued
1475 * post the command to the controller if mailbox is availble.
1478 mbox_post_cmd(adapter_t *adapter, scb_t *scb)
1480 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1484 unsigned long flags;
1488 ccb = (mbox_ccb_t *)scb->ccb;
1489 mbox = raid_dev->mbox;
1490 mbox64 = raid_dev->mbox64;
1493 * Check for busy mailbox. If it is, return failure - the caller
1494 * should retry later.
1496 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
1498 if (unlikely(mbox->busy)) {
1503 } while(mbox->busy && (i < max_mbox_busy_wait));
1507 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1514 // Copy this command's mailbox data into "adapter's" mailbox
1515 memcpy((caddr_t)mbox64, (caddr_t)ccb->mbox64, 22);
1516 mbox->cmdid = scb->sno;
1518 adapter->outstanding_cmds++;
1520 if (scb->dma_direction == PCI_DMA_TODEVICE) {
1521 if (!scb->scp->use_sg) { // sg list not used
1522 pci_dma_sync_single_for_device(adapter->pdev,
1524 scb->scp->request_bufflen,
1528 pci_dma_sync_sg_for_device(adapter->pdev,
1529 scb->scp->request_buffer,
1530 scb->scp->use_sg, PCI_DMA_TODEVICE);
1534 mbox->busy = 1; // Set busy
1539 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
1541 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1548 * megaraid_queue_command - generic queue entry point for all LLDs
1549 * @scp : pointer to the scsi command to be executed
1550 * @done : callback routine to be called after the cmd has be completed
1552 * Queue entry point for mailbox based controllers.
1555 megaraid_queue_command(struct scsi_cmnd *scp, void (* done)(struct scsi_cmnd *))
1561 adapter = SCP2ADAPTER(scp);
1562 scp->scsi_done = done;
1565 assert_spin_locked(adapter->host_lock);
1567 spin_unlock(adapter->host_lock);
1570 * Allocate and build a SCB request
1571 * if_busy flag will be set if megaraid_mbox_build_cmd() command could
1572 * not allocate scb. We will return non-zero status in that case.
1573 * NOTE: scb can be null even though certain commands completed
1574 * successfully, e.g., MODE_SENSE and TEST_UNIT_READY, it would
1575 * return 0 in that case, and we would do the callback right away.
1578 scb = megaraid_mbox_build_cmd(adapter, scp, &if_busy);
1581 megaraid_mbox_runpendq(adapter, scb);
1584 spin_lock(adapter->host_lock);
1586 if (!scb) { // command already completed
1596 * megaraid_mbox_build_cmd - transform the mid-layer scsi command to megaraid
1598 * @adapter - controller's soft state
1599 * @scp - mid-layer scsi command pointer
1600 * @busy - set if request could not be completed because of lack of
1603 * convert the command issued by mid-layer to format understood by megaraid
1604 * firmware. We also complete certain command without sending them to firmware
1607 megaraid_mbox_build_cmd(adapter_t *adapter, struct scsi_cmnd *scp, int *busy)
1609 mraid_device_t *rdev = ADAP2RAIDDEV(adapter);
1614 mraid_passthru_t *pthru;
1618 char skip[] = "skipping";
1619 char scan[] = "scanning";
1624 * Get the appropriate device map for the device this command is
1627 MRAID_GET_DEVICE_MAP(adapter, scp, channel, target, islogical);
1630 * Logical drive commands
1633 switch (scp->cmnd[0]) {
1634 case TEST_UNIT_READY:
1636 * Do we support clustering and is the support enabled
1637 * If no, return success always
1640 scp->result = (DID_OK << 16);
1644 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1645 scp->result = (DID_ERROR << 16);
1650 scb->dma_direction = scp->sc_data_direction;
1651 scb->dev_channel = 0xFF;
1652 scb->dev_target = target;
1653 ccb = (mbox_ccb_t *)scb->ccb;
1656 * The command id will be provided by the command
1659 ccb->raw_mbox[0] = CLUSTER_CMD;
1660 ccb->raw_mbox[2] = RESERVATION_STATUS;
1661 ccb->raw_mbox[3] = target;
1667 struct scatterlist *sgl;
1670 sgl = (struct scatterlist *)scp->request_buffer;
1673 (page_address((&sgl[0])->page)
1674 + (&sgl[0])->offset);
1676 memset(vaddr, 0, scp->cmnd[4]);
1679 con_log(CL_ANN, (KERN_WARNING
1680 "megaraid mailbox: invalid sg:%d\n",
1685 memset(scp->request_buffer, 0, scp->cmnd[4]);
1687 scp->result = (DID_OK << 16);
1692 * Display the channel scan for logical drives
1693 * Do not display scan for a channel if already done.
1695 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1697 con_log(CL_ANN, (KERN_INFO
1698 "scsi[%d]: scanning scsi channel %d",
1699 adapter->host->host_no,
1703 " [virtual] for logical drives\n"));
1705 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1712 * Do not allow LUN > 0 for logical drives and
1713 * requests for more than 40 logical drives
1716 scp->result = (DID_BAD_TARGET << 16);
1719 if ((target % 0x80) >= MAX_LOGICAL_DRIVES_40LD) {
1720 scp->result = (DID_BAD_TARGET << 16);
1725 /* Allocate a SCB and initialize passthru */
1726 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1727 scp->result = (DID_ERROR << 16);
1732 ccb = (mbox_ccb_t *)scb->ccb;
1733 scb->dev_channel = 0xFF;
1734 scb->dev_target = target;
1737 mbox64 = ccb->mbox64;
1741 pthru->reqsenselen = 14;
1742 pthru->islogical = 1;
1743 pthru->logdrv = target;
1744 pthru->cdblen = scp->cmd_len;
1745 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
1747 mbox->cmd = MBOXCMD_PASSTHRU64;
1748 scb->dma_direction = scp->sc_data_direction;
1750 pthru->dataxferlen = scp->request_bufflen;
1751 pthru->dataxferaddr = ccb->sgl_dma_h;
1752 pthru->numsge = megaraid_mbox_mksgl(adapter,
1755 mbox->xferaddr = 0xFFFFFFFF;
1756 mbox64->xferaddr_lo = (uint32_t )ccb->pthru_dma_h;
1757 mbox64->xferaddr_hi = 0;
1769 * Allocate a SCB and initialize mailbox
1771 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1772 scp->result = (DID_ERROR << 16);
1776 ccb = (mbox_ccb_t *)scb->ccb;
1777 scb->dev_channel = 0xFF;
1778 scb->dev_target = target;
1780 mbox64 = ccb->mbox64;
1781 mbox->logdrv = target;
1784 * A little HACK: 2nd bit is zero for all scsi read
1785 * commands and is set for all scsi write commands
1787 mbox->cmd = (scp->cmnd[0] & 0x02) ? MBOXCMD_LWRITE64:
1791 * 6-byte READ(0x08) or WRITE(0x0A) cdb
1793 if (scp->cmd_len == 6) {
1794 mbox->numsectors = (uint32_t)scp->cmnd[4];
1796 ((uint32_t)scp->cmnd[1] << 16) |
1797 ((uint32_t)scp->cmnd[2] << 8) |
1798 (uint32_t)scp->cmnd[3];
1800 mbox->lba &= 0x1FFFFF;
1804 * 10-byte READ(0x28) or WRITE(0x2A) cdb
1806 else if (scp->cmd_len == 10) {
1808 (uint32_t)scp->cmnd[8] |
1809 ((uint32_t)scp->cmnd[7] << 8);
1811 ((uint32_t)scp->cmnd[2] << 24) |
1812 ((uint32_t)scp->cmnd[3] << 16) |
1813 ((uint32_t)scp->cmnd[4] << 8) |
1814 (uint32_t)scp->cmnd[5];
1818 * 12-byte READ(0xA8) or WRITE(0xAA) cdb
1820 else if (scp->cmd_len == 12) {
1822 ((uint32_t)scp->cmnd[2] << 24) |
1823 ((uint32_t)scp->cmnd[3] << 16) |
1824 ((uint32_t)scp->cmnd[4] << 8) |
1825 (uint32_t)scp->cmnd[5];
1828 ((uint32_t)scp->cmnd[6] << 24) |
1829 ((uint32_t)scp->cmnd[7] << 16) |
1830 ((uint32_t)scp->cmnd[8] << 8) |
1831 (uint32_t)scp->cmnd[9];
1834 con_log(CL_ANN, (KERN_WARNING
1835 "megaraid: unsupported CDB length\n"));
1837 megaraid_dealloc_scb(adapter, scb);
1839 scp->result = (DID_ERROR << 16);
1843 scb->dma_direction = scp->sc_data_direction;
1845 // Calculate Scatter-Gather info
1846 mbox64->xferaddr_lo = (uint32_t )ccb->sgl_dma_h;
1847 mbox->numsge = megaraid_mbox_mksgl(adapter,
1849 mbox->xferaddr = 0xFFFFFFFF;
1850 mbox64->xferaddr_hi = 0;
1857 * Do we support clustering and is the support enabled
1860 scp->result = (DID_BAD_TARGET << 16);
1865 * Allocate a SCB and initialize mailbox
1867 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1868 scp->result = (DID_ERROR << 16);
1873 ccb = (mbox_ccb_t *)scb->ccb;
1874 scb->dev_channel = 0xFF;
1875 scb->dev_target = target;
1876 ccb->raw_mbox[0] = CLUSTER_CMD;
1877 ccb->raw_mbox[2] = (scp->cmnd[0] == RESERVE) ?
1878 RESERVE_LD : RELEASE_LD;
1880 ccb->raw_mbox[3] = target;
1881 scb->dma_direction = scp->sc_data_direction;
1886 scp->result = (DID_BAD_TARGET << 16);
1890 else { // Passthru device commands
1892 // Do not allow access to target id > 15 or LUN > 7
1893 if (target > 15 || SCP2LUN(scp) > 7) {
1894 scp->result = (DID_BAD_TARGET << 16);
1898 // if fast load option was set and scan for last device is
1899 // over, reset the fast_load flag so that during a possible
1900 // next scan, devices can be made available
1901 if (rdev->fast_load && (target == 15) &&
1902 (SCP2CHANNEL(scp) == adapter->max_channel -1)) {
1904 con_log(CL_ANN, (KERN_INFO
1905 "megaraid[%d]: physical device scan re-enabled\n",
1906 adapter->host->host_no));
1907 rdev->fast_load = 0;
1911 * Display the channel scan for physical devices
1913 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1915 ss = rdev->fast_load ? skip : scan;
1917 con_log(CL_ANN, (KERN_INFO
1918 "scsi[%d]: %s scsi channel %d [Phy %d]",
1919 adapter->host->host_no, ss, SCP2CHANNEL(scp),
1923 " for non-raid devices\n"));
1925 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1928 // disable channel sweep if fast load option given
1929 if (rdev->fast_load) {
1930 scp->result = (DID_BAD_TARGET << 16);
1934 // Allocate a SCB and initialize passthru
1935 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1936 scp->result = (DID_ERROR << 16);
1941 ccb = (mbox_ccb_t *)scb->ccb;
1942 scb->dev_channel = channel;
1943 scb->dev_target = target;
1944 scb->dma_direction = scp->sc_data_direction;
1946 mbox64 = ccb->mbox64;
1948 // Does this firmware support extended CDBs
1949 if (adapter->max_cdb_sz == 16) {
1950 mbox->cmd = MBOXCMD_EXTPTHRU;
1952 megaraid_mbox_prepare_epthru(adapter, scb, scp);
1954 mbox64->xferaddr_lo = (uint32_t)ccb->epthru_dma_h;
1955 mbox64->xferaddr_hi = 0;
1956 mbox->xferaddr = 0xFFFFFFFF;
1959 mbox->cmd = MBOXCMD_PASSTHRU64;
1961 megaraid_mbox_prepare_pthru(adapter, scb, scp);
1963 mbox64->xferaddr_lo = (uint32_t)ccb->pthru_dma_h;
1964 mbox64->xferaddr_hi = 0;
1965 mbox->xferaddr = 0xFFFFFFFF;
1975 * megaraid_mbox_runpendq - execute commands queued in the pending queue
1976 * @adapter : controller's soft state
1977 * @scb : SCB to be queued in the pending list
1979 * scan the pending list for commands which are not yet issued and try to
1980 * post to the controller. The SCB can be a null pointer, which would indicate
1981 * no SCB to be queue, just try to execute the ones in the pending list.
1983 * NOTE: We do not actually traverse the pending list. The SCBs are plucked
1984 * out from the head of the pending list. If it is successfully issued, the
1985 * next SCB is at the head now.
1988 megaraid_mbox_runpendq(adapter_t *adapter, scb_t *scb_q)
1991 unsigned long flags;
1993 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1996 scb_q->state = SCB_PENDQ;
1997 list_add_tail(&scb_q->list, &adapter->pend_list);
2000 // if the adapter in not in quiescent mode, post the commands to FW
2001 if (adapter->quiescent) {
2002 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2006 while (!list_empty(&adapter->pend_list)) {
2008 assert_spin_locked(PENDING_LIST_LOCK(adapter));
2010 scb = list_entry(adapter->pend_list.next, scb_t, list);
2012 // remove the scb from the pending list and try to
2013 // issue. If we are unable to issue it, put back in
2014 // the pending list and return
2016 list_del_init(&scb->list);
2018 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2020 // if mailbox was busy, return SCB back to pending
2021 // list. Make sure to add at the head, since that's
2022 // where it would have been removed from
2024 scb->state = SCB_ISSUED;
2026 if (mbox_post_cmd(adapter, scb) != 0) {
2028 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2030 scb->state = SCB_PENDQ;
2032 list_add(&scb->list, &adapter->pend_list);
2034 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2040 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2043 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2051 * megaraid_mbox_prepare_pthru - prepare a command for physical devices
2052 * @adapter - pointer to controller's soft state
2053 * @scb - scsi control block
2054 * @scp - scsi command from the mid-layer
2056 * prepare a command for the scsi physical devices
2059 megaraid_mbox_prepare_pthru(adapter_t *adapter, scb_t *scb,
2060 struct scsi_cmnd *scp)
2063 mraid_passthru_t *pthru;
2067 ccb = (mbox_ccb_t *)scb->ccb;
2069 channel = scb->dev_channel;
2070 target = scb->dev_target;
2072 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2075 pthru->islogical = 0;
2077 pthru->target = (channel << 4) | target;
2078 pthru->logdrv = SCP2LUN(scp);
2079 pthru->reqsenselen = 14;
2080 pthru->cdblen = scp->cmd_len;
2082 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
2084 if (scp->request_bufflen) {
2085 pthru->dataxferlen = scp->request_bufflen;
2086 pthru->dataxferaddr = ccb->sgl_dma_h;
2087 pthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2090 pthru->dataxferaddr = 0;
2091 pthru->dataxferlen = 0;
2099 * megaraid_mbox_prepare_epthru - prepare a command for physical devices
2100 * @adapter - pointer to controller's soft state
2101 * @scb - scsi control block
2102 * @scp - scsi command from the mid-layer
2104 * prepare a command for the scsi physical devices. This rountine prepares
2105 * commands for devices which can take extended CDBs (>10 bytes)
2108 megaraid_mbox_prepare_epthru(adapter_t *adapter, scb_t *scb,
2109 struct scsi_cmnd *scp)
2112 mraid_epassthru_t *epthru;
2116 ccb = (mbox_ccb_t *)scb->ccb;
2117 epthru = ccb->epthru;
2118 channel = scb->dev_channel;
2119 target = scb->dev_target;
2121 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2122 epthru->timeout = 4;
2124 epthru->islogical = 0;
2125 epthru->channel = 0;
2126 epthru->target = (channel << 4) | target;
2127 epthru->logdrv = SCP2LUN(scp);
2128 epthru->reqsenselen = 14;
2129 epthru->cdblen = scp->cmd_len;
2131 memcpy(epthru->cdb, scp->cmnd, scp->cmd_len);
2133 if (scp->request_bufflen) {
2134 epthru->dataxferlen = scp->request_bufflen;
2135 epthru->dataxferaddr = ccb->sgl_dma_h;
2136 epthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2139 epthru->dataxferaddr = 0;
2140 epthru->dataxferlen = 0;
2148 * megaraid_ack_sequence - interrupt ack sequence for memory mapped HBAs
2149 * @adapter - controller's soft state
2151 * Interrupt ackrowledgement sequence for memory mapped HBAs. Find out the
2152 * completed command and put them on the completed list for later processing.
2154 * Returns: 1 if the interrupt is valid, 0 otherwise
2157 megaraid_ack_sequence(adapter_t *adapter)
2159 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2163 uint8_t completed[MBOX_MAX_FIRMWARE_STATUS];
2164 struct list_head clist;
2167 unsigned long flags;
2171 mbox = raid_dev->mbox;
2173 // move the SCBs from the firmware completed array to our local list
2174 INIT_LIST_HEAD(&clist);
2176 // loop till F/W has more commands for us to complete
2178 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
2181 * Check if a valid interrupt is pending. If found, force the
2182 * interrupt line low.
2184 dword = RDOUTDOOR(raid_dev);
2185 if (dword != 0x10001234) break;
2189 WROUTDOOR(raid_dev, 0x10001234);
2192 // wait for valid numstatus to post
2193 for (i = 0; i < 0xFFFFF; i++) {
2194 if (mbox->numstatus != 0xFF) {
2195 nstatus = mbox->numstatus;
2200 mbox->numstatus = 0xFF;
2202 adapter->outstanding_cmds -= nstatus;
2204 for (i = 0; i < nstatus; i++) {
2206 // wait for valid command index to post
2207 for (j = 0; j < 0xFFFFF; j++) {
2208 if (mbox->completed[i] != 0xFF) break;
2211 completed[i] = mbox->completed[i];
2212 mbox->completed[i] = 0xFF;
2214 if (completed[i] == 0xFF) {
2215 con_log(CL_ANN, (KERN_CRIT
2216 "megaraid: command posting timed out\n"));
2222 // Get SCB associated with this command id
2223 if (completed[i] >= MBOX_MAX_SCSI_CMDS) {
2225 scb = adapter->uscb_list + (completed[i] -
2226 MBOX_MAX_SCSI_CMDS);
2230 scb = adapter->kscb_list + completed[i];
2233 scb->status = mbox->status;
2234 list_add_tail(&scb->list, &clist);
2237 // Acknowledge interrupt
2238 WRINDOOR(raid_dev, 0x02);
2242 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
2245 // put the completed commands in the completed list. DPC would
2246 // complete these commands later
2247 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2249 list_splice(&clist, &adapter->completed_list);
2251 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2254 // schedule the DPC if there is some work for it
2256 tasklet_schedule(&adapter->dpc_h);
2263 * megaraid_isr - isr for memory based mailbox based controllers
2265 * @devp - pointer to our soft state
2268 * Interrupt service routine for memory-mapped mailbox controllers.
2271 megaraid_isr(int irq, void *devp, struct pt_regs *regs)
2273 adapter_t *adapter = devp;
2276 handled = megaraid_ack_sequence(adapter);
2278 /* Loop through any pending requests */
2279 if (!adapter->quiescent) {
2280 megaraid_mbox_runpendq(adapter, NULL);
2283 return IRQ_RETVAL(handled);
2288 * megaraid_mbox_sync_scb - sync kernel buffers
2289 * @adapter : controller's soft state
2290 * @scb : pointer to the resource packet
2292 * DMA sync if required.
2295 megaraid_mbox_sync_scb(adapter_t *adapter, scb_t *scb)
2299 ccb = (mbox_ccb_t *)scb->ccb;
2301 switch (scb->dma_type) {
2303 case MRAID_DMA_WBUF:
2304 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2305 pci_dma_sync_single_for_cpu(adapter->pdev,
2307 scb->scp->request_bufflen,
2308 PCI_DMA_FROMDEVICE);
2311 pci_unmap_page(adapter->pdev, ccb->buf_dma_h,
2312 scb->scp->request_bufflen, scb->dma_direction);
2317 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2318 pci_dma_sync_sg_for_cpu(adapter->pdev,
2319 scb->scp->request_buffer,
2320 scb->scp->use_sg, PCI_DMA_FROMDEVICE);
2323 pci_unmap_sg(adapter->pdev, scb->scp->request_buffer,
2324 scb->scp->use_sg, scb->dma_direction);
2337 * megaraid_mbox_dpc - the tasklet to complete the commands from completed list
2338 * @devp : pointer to HBA soft state
2340 * Pick up the commands from the completed list and send back to the owners.
2341 * This is a reentrant function and does not assume any locks are held while
2342 * it is being called.
2345 megaraid_mbox_dpc(unsigned long devp)
2347 adapter_t *adapter = (adapter_t *)devp;
2348 mraid_device_t *raid_dev;
2349 struct list_head clist;
2350 struct scatterlist *sgl;
2353 struct scsi_cmnd *scp;
2354 mraid_passthru_t *pthru;
2355 mraid_epassthru_t *epthru;
2361 unsigned long flags;
2366 if (!adapter) return;
2368 raid_dev = ADAP2RAIDDEV(adapter);
2370 // move the SCBs from the completed list to our local list
2371 INIT_LIST_HEAD(&clist);
2373 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2375 list_splice_init(&adapter->completed_list, &clist);
2377 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2380 list_for_each_entry_safe(scb, tmp, &clist, list) {
2382 status = scb->status;
2384 ccb = (mbox_ccb_t *)scb->ccb;
2386 epthru = ccb->epthru;
2389 // Make sure f/w has completed a valid command
2390 if (scb->state != SCB_ISSUED) {
2391 con_log(CL_ANN, (KERN_CRIT
2392 "megaraid critical err: invalid command %d:%d:%p\n",
2393 scb->sno, scb->state, scp));
2395 continue; // Must never happen!
2398 // check for the management command and complete it right away
2399 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2400 scb->state = SCB_FREE;
2401 scb->status = status;
2403 // remove from local clist
2404 list_del_init(&scb->list);
2406 megaraid_mbox_mm_done(adapter, scb);
2411 // Was an abort issued for this command earlier
2412 if (scb->state & SCB_ABORT) {
2413 con_log(CL_ANN, (KERN_NOTICE
2414 "megaraid: aborted cmd %lx[%x] completed\n",
2415 scp->serial_number, scb->sno));
2419 * If the inquiry came of a disk drive which is not part of
2420 * any RAID array, expose it to the kernel. For this to be
2421 * enabled, user must set the "megaraid_expose_unconf_disks"
2422 * flag to 1 by specifying it on module parameter list.
2423 * This would enable data migration off drives from other
2426 islogical = MRAID_IS_LOGICAL(adapter, scp);
2427 if (scp->cmnd[0] == INQUIRY && status == 0 && islogical == 0
2428 && IS_RAID_CH(raid_dev, scb->dev_channel)) {
2431 sgl = (struct scatterlist *)
2432 scp->request_buffer;
2435 c = *(unsigned char *)
2436 (page_address((&sgl[0])->page) +
2440 con_log(CL_ANN, (KERN_WARNING
2441 "megaraid mailbox: invalid sg:%d\n",
2447 c = *(uint8_t *)scp->request_buffer;
2450 if ((c & 0x1F ) == TYPE_DISK) {
2451 pdev_index = (scb->dev_channel * 16) +
2454 raid_dev->pdrv_state[pdev_index] & 0x0F;
2456 if (pdev_state == PDRV_ONLINE ||
2457 pdev_state == PDRV_FAILED ||
2458 pdev_state == PDRV_RBLD ||
2459 pdev_state == PDRV_HOTSPARE ||
2460 megaraid_expose_unconf_disks == 0) {
2467 // Convert MegaRAID status to Linux error code
2472 scp->result = (DID_OK << 16);
2477 /* set sense_buffer and result fields */
2478 if (mbox->cmd == MBOXCMD_PASSTHRU ||
2479 mbox->cmd == MBOXCMD_PASSTHRU64) {
2481 memcpy(scp->sense_buffer, pthru->reqsensearea,
2484 scp->result = DRIVER_SENSE << 24 |
2485 DID_OK << 16 | CHECK_CONDITION << 1;
2488 if (mbox->cmd == MBOXCMD_EXTPTHRU) {
2490 memcpy(scp->sense_buffer,
2491 epthru->reqsensearea, 14);
2493 scp->result = DRIVER_SENSE << 24 |
2495 CHECK_CONDITION << 1;
2497 scp->sense_buffer[0] = 0x70;
2498 scp->sense_buffer[2] = ABORTED_COMMAND;
2499 scp->result = CHECK_CONDITION << 1;
2506 scp->result = DID_BUS_BUSY << 16 | status;
2512 * If TEST_UNIT_READY fails, we know RESERVATION_STATUS
2515 if (scp->cmnd[0] == TEST_UNIT_READY) {
2516 scp->result = DID_ERROR << 16 |
2517 RESERVATION_CONFLICT << 1;
2521 * Error code returned is 1 if Reserve or Release
2522 * failed or the input parameter is invalid
2524 if (status == 1 && (scp->cmnd[0] == RESERVE ||
2525 scp->cmnd[0] == RELEASE)) {
2527 scp->result = DID_ERROR << 16 |
2528 RESERVATION_CONFLICT << 1;
2531 scp->result = DID_BAD_TARGET << 16 | status;
2535 // print a debug message for all failed commands
2537 megaraid_mbox_display_scb(adapter, scb);
2540 // Free our internal resources and call the mid-layer callback
2542 megaraid_mbox_sync_scb(adapter, scb);
2544 // remove from local clist
2545 list_del_init(&scb->list);
2547 // put back in free list
2548 megaraid_dealloc_scb(adapter, scb);
2550 // send the scsi packet back to kernel
2551 spin_lock(adapter->host_lock);
2552 scp->scsi_done(scp);
2553 spin_unlock(adapter->host_lock);
2561 * megaraid_abort_handler - abort the scsi command
2562 * @scp : command to be aborted
2564 * Abort a previous SCSI request. Only commands on the pending list can be
2565 * aborted. All the commands issued to the F/W must complete.
2568 __megaraid_abort_handler(struct scsi_cmnd *scp)
2571 mraid_device_t *raid_dev;
2575 unsigned long flags;
2579 adapter = SCP2ADAPTER(scp);
2580 raid_dev = ADAP2RAIDDEV(adapter);
2582 assert_spin_locked(adapter->host_lock);
2584 con_log(CL_ANN, (KERN_WARNING
2585 "megaraid: aborting-%ld cmd=%x <c=%d t=%d l=%d>\n",
2586 scp->serial_number, scp->cmnd[0], SCP2CHANNEL(scp),
2587 SCP2TARGET(scp), SCP2LUN(scp)));
2589 // If FW has stopped responding, simply return failure
2590 if (raid_dev->hw_error) {
2591 con_log(CL_ANN, (KERN_NOTICE
2592 "megaraid: hw error, not aborting\n"));
2596 // There might a race here, where the command was completed by the
2597 // firmware and now it is on the completed list. Before we could
2598 // complete the command to the kernel in dpc, the abort came.
2599 // Find out if this is the case to avoid the race.
2601 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2602 list_for_each_entry_safe(scb, tmp, &adapter->completed_list, list) {
2604 if (scb->scp == scp) { // Found command
2606 list_del_init(&scb->list); // from completed list
2608 con_log(CL_ANN, (KERN_WARNING
2609 "megaraid: %ld:%d[%d:%d], abort from completed list\n",
2610 scp->serial_number, scb->sno,
2611 scb->dev_channel, scb->dev_target));
2613 scp->result = (DID_ABORT << 16);
2614 scp->scsi_done(scp);
2616 megaraid_dealloc_scb(adapter, scb);
2618 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter),
2624 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2627 // Find out if this command is still on the pending list. If it is and
2628 // was never issued, abort and return success. If the command is owned
2629 // by the firmware, we must wait for it to complete by the FW.
2630 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2631 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2633 if (scb->scp == scp) { // Found command
2635 list_del_init(&scb->list); // from pending list
2637 ASSERT(!(scb->state & SCB_ISSUED));
2639 con_log(CL_ANN, (KERN_WARNING
2640 "megaraid abort: %ld[%d:%d], driver owner\n",
2641 scp->serial_number, scb->dev_channel,
2644 scp->result = (DID_ABORT << 16);
2645 scp->scsi_done(scp);
2647 megaraid_dealloc_scb(adapter, scb);
2649 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2655 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2658 // Check do we even own this command, in which case this would be
2659 // owned by the firmware. The only way to locate the FW scb is to
2660 // traverse through the list of all SCB, since driver does not
2661 // maintain these SCBs on any list
2663 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
2664 scb = adapter->kscb_list + i;
2666 if (scb->scp == scp) {
2670 if (!(scb->state & SCB_ISSUED)) {
2671 con_log(CL_ANN, (KERN_WARNING
2672 "megaraid abort: %ld%d[%d:%d], invalid state\n",
2673 scp->serial_number, scb->sno, scb->dev_channel,
2678 con_log(CL_ANN, (KERN_WARNING
2679 "megaraid abort: %ld:%d[%d:%d], fw owner\n",
2680 scp->serial_number, scb->sno, scb->dev_channel,
2687 con_log(CL_ANN, (KERN_WARNING
2688 "megaraid abort: scsi cmd:%ld, do now own\n",
2689 scp->serial_number));
2691 // FIXME: Should there be a callback for this command?
2695 // We cannot actually abort a command owned by firmware, return
2696 // failure and wait for reset. In host reset handler, we will find out
2697 // if the HBA is still live
2702 megaraid_abort_handler(struct scsi_cmnd *scp)
2707 adapter = SCP2ADAPTER(scp);
2709 spin_lock_irq(adapter->host_lock);
2710 rc = __megaraid_abort_handler(scp);
2711 spin_unlock_irq(adapter->host_lock);
2718 * megaraid_reset_handler - device reset hadler for mailbox based driver
2719 * @scp : reference command
2721 * Reset handler for the mailbox based controller. First try to find out if
2722 * the FW is still live, in which case the outstanding commands counter mut go
2723 * down to 0. If that happens, also issue the reservation reset command to
2724 * relinquish (possible) reservations on the logical drives connected to this
2728 __megaraid_reset_handler(struct scsi_cmnd *scp)
2733 mraid_device_t *raid_dev;
2734 unsigned long flags;
2735 uint8_t raw_mbox[sizeof(mbox_t)];
2737 int recovery_window;
2741 adapter = SCP2ADAPTER(scp);
2742 raid_dev = ADAP2RAIDDEV(adapter);
2744 assert_spin_locked(adapter->host_lock);
2746 con_log(CL_ANN, (KERN_WARNING "megaraid: reseting the host...\n"));
2748 // return failure if adapter is not responding
2749 if (raid_dev->hw_error) {
2750 con_log(CL_ANN, (KERN_NOTICE
2751 "megaraid: hw error, cannot reset\n"));
2756 // Under exceptional conditions, FW can take up to 3 minutes to
2757 // complete command processing. Wait for additional 2 minutes for the
2758 // pending commands counter to go down to 0. If it doesn't, let the
2759 // controller be marked offline
2760 // Also, reset all the commands currently owned by the driver
2761 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2762 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2764 list_del_init(&scb->list); // from pending list
2766 con_log(CL_ANN, (KERN_WARNING
2767 "megaraid: %ld:%d[%d:%d], reset from pending list\n",
2768 scp->serial_number, scb->sno,
2769 scb->dev_channel, scb->dev_target));
2771 scp->result = (DID_RESET << 16);
2772 scp->scsi_done(scp);
2774 megaraid_dealloc_scb(adapter, scb);
2776 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2778 if (adapter->outstanding_cmds) {
2779 con_log(CL_ANN, (KERN_NOTICE
2780 "megaraid: %d outstanding commands. Max wait %d sec\n",
2781 adapter->outstanding_cmds, MBOX_RESET_WAIT));
2784 spin_unlock(adapter->host_lock);
2786 recovery_window = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
2788 recovering = adapter->outstanding_cmds;
2790 for (i = 0; i < recovery_window && adapter->outstanding_cmds; i++) {
2792 megaraid_ack_sequence(adapter);
2794 // print a message once every 5 seconds only
2797 "megaraid mbox: Wait for %d commands to complete:%d\n",
2798 adapter->outstanding_cmds,
2799 MBOX_RESET_WAIT - i));
2802 // bailout if no recovery happended in reset time
2803 if ((i == MBOX_RESET_WAIT) &&
2804 (recovering == adapter->outstanding_cmds)) {
2811 spin_lock(adapter->host_lock);
2813 // If still outstanding commands, bail out
2814 if (adapter->outstanding_cmds) {
2815 con_log(CL_ANN, (KERN_WARNING
2816 "megaraid mbox: critical hardware error!\n"));
2818 raid_dev->hw_error = 1;
2823 con_log(CL_ANN, (KERN_NOTICE
2824 "megaraid mbox: reset sequence completed sucessfully\n"));
2828 // If the controller supports clustering, reset reservations
2829 if (!adapter->ha) return SUCCESS;
2831 // clear reservations if any
2832 raw_mbox[0] = CLUSTER_CMD;
2833 raw_mbox[2] = RESET_RESERVATIONS;
2836 if (mbox_post_sync_cmd_fast(adapter, raw_mbox) == 0) {
2838 (KERN_INFO "megaraid: reservation reset\n"));
2842 con_log(CL_ANN, (KERN_WARNING
2843 "megaraid: reservation reset failed\n"));
2850 megaraid_reset_handler(struct scsi_cmnd *cmd)
2854 spin_lock_irq(cmd->device->host->host_lock);
2855 rc = __megaraid_reset_handler(cmd);
2856 spin_unlock_irq(cmd->device->host->host_lock);
2863 * START: internal commands library
2865 * This section of the driver has the common routine used by the driver and
2866 * also has all the FW routines
2870 * mbox_post_sync_cmd() - blocking command to the mailbox based controllers
2871 * @adapter - controller's soft state
2872 * @raw_mbox - the mailbox
2874 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2878 mbox_post_sync_cmd(adapter_t *adapter, uint8_t raw_mbox[])
2880 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2887 mbox64 = raid_dev->mbox64;
2888 mbox = raid_dev->mbox;
2891 * Wait until mailbox is free
2893 if (megaraid_busywait_mbox(raid_dev) != 0)
2894 goto blocked_mailbox;
2897 * Copy mailbox data into host structure
2899 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
2904 mbox->numstatus = 0xFF;
2905 mbox->status = 0xFF;
2908 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2910 // wait for maximum 1 second for status to post. If the status is not
2911 // available within 1 second, assume FW is initializing and wait
2912 // for an extended amount of time
2913 if (mbox->numstatus == 0xFF) { // status not yet available
2916 for (i = 0; mbox->numstatus == 0xFF && i < 1000; i++) {
2923 con_log(CL_ANN, (KERN_NOTICE
2924 "megaraid mailbox: wait for FW to boot "));
2926 for (i = 0; (mbox->numstatus == 0xFF) &&
2927 (i < MBOX_RESET_WAIT); i++) {
2929 con_log(CL_ANN, ("\b\b\b\b\b[%03d]",
2930 MBOX_RESET_WAIT - i));
2934 if (i == MBOX_RESET_WAIT) {
2937 "\nmegaraid mailbox: status not available\n"));
2941 con_log(CL_ANN, ("\b\b\b\b\b[ok] \n"));
2945 // wait for maximum 1 second for poll semaphore
2946 if (mbox->poll != 0x77) {
2949 for (i = 0; (mbox->poll != 0x77) && (i < 1000); i++) {
2955 con_log(CL_ANN, (KERN_WARNING
2956 "megaraid mailbox: could not get poll semaphore\n"));
2961 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2964 // wait for maximum 1 second for acknowledgement
2965 if (RDINDOOR(raid_dev) & 0x2) {
2968 for (i = 0; (RDINDOOR(raid_dev) & 0x2) && (i < 1000); i++) {
2974 con_log(CL_ANN, (KERN_WARNING
2975 "megaraid mailbox: could not acknowledge\n"));
2982 status = mbox->status;
2984 // invalidate the completed command id array. After command
2985 // completion, firmware would write the valid id.
2986 mbox->numstatus = 0xFF;
2987 mbox->status = 0xFF;
2988 for (i = 0; i < MBOX_MAX_FIRMWARE_STATUS; i++) {
2989 mbox->completed[i] = 0xFF;
2996 con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n") );
3002 * mbox_post_sync_cmd_fast - blocking command to the mailbox based controllers
3003 * @adapter - controller's soft state
3004 * @raw_mbox - the mailbox
3006 * Issue a scb in synchronous and non-interrupt mode for mailbox based
3007 * controllers. This is a faster version of the synchronous command and
3008 * therefore can be called in interrupt-context as well
3011 mbox_post_sync_cmd_fast(adapter_t *adapter, uint8_t raw_mbox[])
3013 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3018 mbox = raid_dev->mbox;
3020 // return immediately if the mailbox is busy
3021 if (mbox->busy) return -1;
3023 // Copy mailbox data into host structure
3024 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 14);
3029 mbox->numstatus = 0xFF;
3030 mbox->status = 0xFF;
3033 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
3035 for (i = 0; i < 0xFFFFF; i++) {
3036 if (mbox->numstatus != 0xFF) break;
3040 // We may need to re-calibrate the counter
3041 con_log(CL_ANN, (KERN_CRIT
3042 "megaraid: fast sync command timed out\n"));
3045 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
3048 return mbox->status;
3053 * megaraid_busywait_mbox() - Wait until the controller's mailbox is available
3054 * @raid_dev - RAID device (HBA) soft state
3056 * wait until the controller's mailbox is available to accept more commands.
3057 * wait for at most 1 second
3060 megaraid_busywait_mbox(mraid_device_t *raid_dev)
3062 mbox_t *mbox = raid_dev->mbox;
3067 for (i = 0; mbox->busy && i < 1000; i++)
3071 if (i < 1000) return 0;
3077 * megaraid_mbox_product_info - some static information about the controller
3078 * @adapter - our soft state
3080 * issue commands to the controller to grab some parameters required by our
3084 megaraid_mbox_product_info(adapter_t *adapter)
3086 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3088 uint8_t raw_mbox[sizeof(mbox_t)];
3089 mraid_pinfo_t *pinfo;
3090 dma_addr_t pinfo_dma_h;
3091 mraid_inquiry3_t *mraid_inq3;
3095 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3096 mbox = (mbox_t *)raw_mbox;
3099 * Issue an ENQUIRY3 command to find out certain adapter parameters,
3100 * e.g., max channels, max commands etc.
3102 pinfo = pci_alloc_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3105 if (pinfo == NULL) {
3106 con_log(CL_ANN, (KERN_WARNING
3107 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3112 memset(pinfo, 0, sizeof(mraid_pinfo_t));
3114 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3115 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3117 raw_mbox[0] = FC_NEW_CONFIG;
3118 raw_mbox[2] = NC_SUBOP_ENQUIRY3;
3119 raw_mbox[3] = ENQ3_GET_SOLICITED_FULL;
3121 // Issue the command
3122 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3124 con_log(CL_ANN, (KERN_WARNING "megaraid: Inquiry3 failed\n"));
3126 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3127 pinfo, pinfo_dma_h);
3133 * Collect information about state of each physical drive
3134 * attached to the controller. We will expose all the disks
3135 * which are not part of RAID
3137 mraid_inq3 = (mraid_inquiry3_t *)adapter->ibuf;
3138 for (i = 0; i < MBOX_MAX_PHYSICAL_DRIVES; i++) {
3139 raid_dev->pdrv_state[i] = mraid_inq3->pdrv_state[i];
3143 * Get product info for information like number of channels,
3144 * maximum commands supported.
3146 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3147 mbox->xferaddr = (uint32_t)pinfo_dma_h;
3149 raw_mbox[0] = FC_NEW_CONFIG;
3150 raw_mbox[2] = NC_SUBOP_PRODUCT_INFO;
3152 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3154 con_log(CL_ANN, (KERN_WARNING
3155 "megaraid: product info failed\n"));
3157 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3158 pinfo, pinfo_dma_h);
3164 * Setup some parameters for host, as required by our caller
3166 adapter->max_channel = pinfo->nchannels;
3169 * we will export all the logical drives on a single channel.
3170 * Add 1 since inquires do not come for inititor ID
3172 adapter->max_target = MAX_LOGICAL_DRIVES_40LD + 1;
3173 adapter->max_lun = 8; // up to 8 LUNs for non-disk devices
3176 * These are the maximum outstanding commands for the scsi-layer
3178 adapter->max_cmds = MBOX_MAX_SCSI_CMDS;
3180 memset(adapter->fw_version, 0, VERSION_SIZE);
3181 memset(adapter->bios_version, 0, VERSION_SIZE);
3183 memcpy(adapter->fw_version, pinfo->fw_version, 4);
3184 adapter->fw_version[4] = 0;
3186 memcpy(adapter->bios_version, pinfo->bios_version, 4);
3187 adapter->bios_version[4] = 0;
3189 con_log(CL_ANN, (KERN_NOTICE
3190 "megaraid: fw version:[%s] bios version:[%s]\n",
3191 adapter->fw_version, adapter->bios_version));
3193 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t), pinfo,
3202 * megaraid_mbox_extended_cdb - check for support for extended CDBs
3203 * @adapter - soft state for the controller
3205 * this routine check whether the controller in question supports extended
3206 * ( > 10 bytes ) CDBs
3209 megaraid_mbox_extended_cdb(adapter_t *adapter)
3212 uint8_t raw_mbox[sizeof(mbox_t)];
3215 mbox = (mbox_t *)raw_mbox;
3217 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3218 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3220 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3222 raw_mbox[0] = MAIN_MISC_OPCODE;
3223 raw_mbox[2] = SUPPORT_EXT_CDB;
3229 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3238 * megaraid_mbox_support_ha - Do we support clustering
3239 * @adapter - soft state for the controller
3240 * @init_id - ID of the initiator
3242 * Determine if the firmware supports clustering and the ID of the initiator.
3245 megaraid_mbox_support_ha(adapter_t *adapter, uint16_t *init_id)
3248 uint8_t raw_mbox[sizeof(mbox_t)];
3252 mbox = (mbox_t *)raw_mbox;
3254 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3256 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3258 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3260 raw_mbox[0] = GET_TARGET_ID;
3262 // Issue the command
3265 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3267 *init_id = *(uint8_t *)adapter->ibuf;
3269 con_log(CL_ANN, (KERN_INFO
3270 "megaraid: cluster firmware, initiator ID: %d\n",
3281 * megaraid_mbox_support_random_del - Do we support random deletion
3282 * @adapter - soft state for the controller
3284 * Determine if the firmware supports random deletion
3285 * Return: 1 is operation supported, 0 otherwise
3288 megaraid_mbox_support_random_del(adapter_t *adapter)
3291 uint8_t raw_mbox[sizeof(mbox_t)];
3295 mbox = (mbox_t *)raw_mbox;
3297 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3299 raw_mbox[0] = FC_DEL_LOGDRV;
3300 raw_mbox[2] = OP_SUP_DEL_LOGDRV;
3302 // Issue the command
3304 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3306 con_log(CL_DLEVEL1, ("megaraid: supports random deletion\n"));
3316 * megaraid_mbox_get_max_sg - maximum sg elements supported by the firmware
3317 * @adapter - soft state for the controller
3319 * Find out the maximum number of scatter-gather elements supported by the
3323 megaraid_mbox_get_max_sg(adapter_t *adapter)
3326 uint8_t raw_mbox[sizeof(mbox_t)];
3330 mbox = (mbox_t *)raw_mbox;
3332 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3334 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3336 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3338 raw_mbox[0] = MAIN_MISC_OPCODE;
3339 raw_mbox[2] = GET_MAX_SG_SUPPORT;
3341 // Issue the command
3342 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3343 nsg = *(uint8_t *)adapter->ibuf;
3346 nsg = MBOX_DEFAULT_SG_SIZE;
3349 if (nsg > MBOX_MAX_SG_SIZE) nsg = MBOX_MAX_SG_SIZE;
3356 * megaraid_mbox_enum_raid_scsi - enumerate the RAID and SCSI channels
3357 * @adapter - soft state for the controller
3359 * Enumerate the RAID and SCSI channels for ROMB platoforms so that channels
3360 * can be exported as regular SCSI channels
3363 megaraid_mbox_enum_raid_scsi(adapter_t *adapter)
3365 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3367 uint8_t raw_mbox[sizeof(mbox_t)];
3370 mbox = (mbox_t *)raw_mbox;
3372 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3374 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3376 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3378 raw_mbox[0] = CHNL_CLASS;
3379 raw_mbox[2] = GET_CHNL_CLASS;
3381 // Issue the command. If the command fails, all channels are RAID
3383 raid_dev->channel_class = 0xFF;
3384 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3385 raid_dev->channel_class = *(uint8_t *)adapter->ibuf;
3393 * megaraid_mbox_flush_cache - flush adapter and disks cache
3394 * @param adapter : soft state for the controller
3396 * Flush adapter cache followed by disks cache
3399 megaraid_mbox_flush_cache(adapter_t *adapter)
3402 uint8_t raw_mbox[sizeof(mbox_t)];
3405 mbox = (mbox_t *)raw_mbox;
3407 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3409 raw_mbox[0] = FLUSH_ADAPTER;
3411 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3412 con_log(CL_ANN, ("megaraid: flush adapter failed\n"));
3415 raw_mbox[0] = FLUSH_SYSTEM;
3417 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3418 con_log(CL_ANN, ("megaraid: flush disks cache failed\n"));
3426 * megaraid_mbox_display_scb - display SCB information, mostly debug purposes
3427 * @param adapter : controllers' soft state
3428 * @param scb : SCB to be displayed
3429 * @param level : debug level for console print
3431 * Diplay information about the given SCB iff the current debug level is
3435 megaraid_mbox_display_scb(adapter_t *adapter, scb_t *scb)
3438 struct scsi_cmnd *scp;
3444 ccb = (mbox_ccb_t *)scb->ccb;
3450 con_log(level, (KERN_NOTICE
3451 "megaraid mailbox: status:%#x cmd:%#x id:%#x ", scb->status,
3452 mbox->cmd, scb->sno));
3454 con_log(level, ("sec:%#x lba:%#x addr:%#x ld:%d sg:%d\n",
3455 mbox->numsectors, mbox->lba, mbox->xferaddr, mbox->logdrv,
3460 con_log(level, (KERN_NOTICE "scsi cmnd: "));
3462 for (i = 0; i < scp->cmd_len; i++) {
3463 con_log(level, ("%#2.02x ", scp->cmnd[i]));
3466 con_log(level, ("\n"));
3473 * megaraid_mbox_setup_device_map - manage device ids
3474 * @adapter : Driver's soft state
3476 * Manange the device ids to have an appropraite mapping between the kernel
3477 * scsi addresses and megaraid scsi and logical drive addresses. We export
3478 * scsi devices on their actual addresses, whereas the logical drives are
3479 * exported on a virtual scsi channel.
3482 megaraid_mbox_setup_device_map(adapter_t *adapter)
3488 * First fill the values on the logical drive channel
3490 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3491 adapter->device_ids[adapter->max_channel][t] =
3492 (t < adapter->init_id) ? t : t - 1;
3494 adapter->device_ids[adapter->max_channel][adapter->init_id] = 0xFF;
3497 * Fill the values on the physical devices channels
3499 for (c = 0; c < adapter->max_channel; c++)
3500 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3501 adapter->device_ids[c][t] = (c << 8) | t;
3506 * END: internal commands library
3510 * START: Interface for the common management module
3512 * This is the module, which interfaces with the common mangement module to
3513 * provide support for ioctl and sysfs
3517 * megaraid_cmm_register - register with the mangement module
3518 * @param adapter : HBA soft state
3520 * Register with the management module, which allows applications to issue
3521 * ioctl calls to the drivers. This interface is used by the management module
3522 * to setup sysfs support as well.
3525 megaraid_cmm_register(adapter_t *adapter)
3527 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3534 // Allocate memory for the base list of scb for management module.
3535 adapter->uscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_USER_CMDS,
3538 if (adapter->uscb_list == NULL) {
3539 con_log(CL_ANN, (KERN_WARNING
3540 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3544 memset(adapter->uscb_list, 0, sizeof(scb_t) * MBOX_MAX_USER_CMDS);
3547 // Initialize the synchronization parameters for resources for
3548 // commands for management module
3549 INIT_LIST_HEAD(&adapter->uscb_pool);
3551 spin_lock_init(USER_FREE_LIST_LOCK(adapter));
3555 // link all the packets. Note, CCB for commands, coming from the
3556 // commom management module, mailbox physical address are already
3557 // setup by it. We just need placeholder for that in our local command
3559 for (i = 0; i < MBOX_MAX_USER_CMDS; i++) {
3561 scb = adapter->uscb_list + i;
3562 ccb = raid_dev->uccb_list + i;
3564 scb->ccb = (caddr_t)ccb;
3565 ccb->mbox64 = raid_dev->umbox64 + i;
3566 ccb->mbox = &ccb->mbox64->mbox32;
3567 ccb->raw_mbox = (uint8_t *)ccb->mbox;
3571 // COMMAND ID 0 - (MBOX_MAX_SCSI_CMDS-1) ARE RESERVED FOR
3572 // COMMANDS COMING FROM IO SUBSYSTEM (MID-LAYER)
3573 scb->sno = i + MBOX_MAX_SCSI_CMDS;
3576 scb->state = SCB_FREE;
3577 scb->dma_direction = PCI_DMA_NONE;
3578 scb->dma_type = MRAID_DMA_NONE;
3579 scb->dev_channel = -1;
3580 scb->dev_target = -1;
3582 // put scb in the free pool
3583 list_add_tail(&scb->list, &adapter->uscb_pool);
3586 adp.unique_id = adapter->unique_id;
3587 adp.drvr_type = DRVRTYPE_MBOX;
3588 adp.drvr_data = (unsigned long)adapter;
3589 adp.pdev = adapter->pdev;
3590 adp.issue_uioc = megaraid_mbox_mm_handler;
3592 adp.max_kioc = MBOX_MAX_USER_CMDS;
3594 if ((rval = mraid_mm_register_adp(&adp)) != 0) {
3596 con_log(CL_ANN, (KERN_WARNING
3597 "megaraid mbox: did not register with CMM\n"));
3599 kfree(adapter->uscb_list);
3607 * megaraid_cmm_unregister - un-register with the mangement module
3608 * @param adapter : HBA soft state
3610 * Un-register with the management module.
3611 * FIXME: mgmt module must return failure for unregister if it has pending
3615 megaraid_cmm_unregister(adapter_t *adapter)
3617 kfree(adapter->uscb_list);
3618 mraid_mm_unregister_adp(adapter->unique_id);
3624 * megaraid_mbox_mm_handler - interface for CMM to issue commands to LLD
3625 * @param drvr_data : LLD specific data
3626 * @param kioc : CMM interface packet
3627 * @param action : command action
3629 * This routine is invoked whenever the Common Mangement Module (CMM) has a
3630 * command for us. The 'action' parameter specifies if this is a new command
3634 megaraid_mbox_mm_handler(unsigned long drvr_data, uioc_t *kioc, uint32_t action)
3638 if (action != IOCTL_ISSUE) {
3639 con_log(CL_ANN, (KERN_WARNING
3640 "megaraid: unsupported management action:%#2x\n",
3645 adapter = (adapter_t *)drvr_data;
3647 // make sure this adapter is not being detached right now.
3648 if (atomic_read(&adapter->being_detached)) {
3649 con_log(CL_ANN, (KERN_WARNING
3650 "megaraid: reject management request, detaching\n"));
3654 switch (kioc->opcode) {
3658 kioc->status = gather_hbainfo(adapter, (mraid_hba_info_t *)
3659 (unsigned long)kioc->buf_vaddr);
3663 return kioc->status;
3667 return megaraid_mbox_mm_command(adapter, kioc);
3670 kioc->status = (-EINVAL);
3675 return 0; // not reached
3679 * megaraid_mbox_mm_command - issues commands routed through CMM
3680 * @param adapter : HBA soft state
3681 * @param kioc : management command packet
3683 * Issues commands, which are routed through the management module.
3686 megaraid_mbox_mm_command(adapter_t *adapter, uioc_t *kioc)
3688 struct list_head *head = &adapter->uscb_pool;
3693 unsigned long flags;
3695 // detach one scb from free pool
3696 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3698 if (list_empty(head)) { // should never happen because of CMM
3700 con_log(CL_ANN, (KERN_WARNING
3701 "megaraid mbox: bug in cmm handler, lost resources\n"));
3703 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3708 scb = list_entry(head->next, scb_t, list);
3709 list_del_init(&scb->list);
3711 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3713 scb->state = SCB_ACTIVE;
3714 scb->dma_type = MRAID_DMA_NONE;
3715 scb->dma_direction = PCI_DMA_NONE;
3717 ccb = (mbox_ccb_t *)scb->ccb;
3718 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3719 raw_mbox = (uint8_t *)&mbox64->mbox32;
3721 memcpy(ccb->mbox64, mbox64, sizeof(mbox64_t));
3723 scb->gp = (unsigned long)kioc;
3726 * If it is a logdrv random delete operation, we have to wait till
3727 * there are no outstanding cmds at the fw and then issue it directly
3729 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3731 if (wait_till_fw_empty(adapter)) {
3732 con_log(CL_ANN, (KERN_NOTICE
3733 "megaraid mbox: LD delete, timed out\n"));
3735 kioc->status = -ETIME;
3739 megaraid_mbox_mm_done(adapter, scb);
3744 INIT_LIST_HEAD(&scb->list);
3746 scb->state = SCB_ISSUED;
3747 if (mbox_post_cmd(adapter, scb) != 0) {
3749 con_log(CL_ANN, (KERN_NOTICE
3750 "megaraid mbox: LD delete, mailbox busy\n"));
3752 kioc->status = -EBUSY;
3756 megaraid_mbox_mm_done(adapter, scb);
3764 // put the command on the pending list and execute
3765 megaraid_mbox_runpendq(adapter, scb);
3772 wait_till_fw_empty(adapter_t *adapter)
3774 unsigned long flags = 0;
3779 * Set the quiescent flag to stop issuing cmds to FW.
3781 spin_lock_irqsave(adapter->host_lock, flags);
3782 adapter->quiescent++;
3783 spin_unlock_irqrestore(adapter->host_lock, flags);
3786 * Wait till there are no more cmds outstanding at FW. Try for at most
3789 for (i = 0; i < 60 && adapter->outstanding_cmds; i++) {
3790 con_log(CL_DLEVEL1, (KERN_INFO
3791 "megaraid: FW has %d pending commands\n",
3792 adapter->outstanding_cmds));
3797 return adapter->outstanding_cmds;
3802 * megaraid_mbox_mm_done - callback for CMM commands
3803 * @adapter : HBA soft state
3804 * @scb : completed command
3806 * Callback routine for internal commands originated from the management
3810 megaraid_mbox_mm_done(adapter_t *adapter, scb_t *scb)
3815 unsigned long flags;
3817 kioc = (uioc_t *)scb->gp;
3819 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3820 mbox64->mbox32.status = scb->status;
3821 raw_mbox = (uint8_t *)&mbox64->mbox32;
3824 // put scb in the free pool
3825 scb->state = SCB_FREE;
3828 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3830 list_add(&scb->list, &adapter->uscb_pool);
3832 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3834 // if a delete logical drive operation succeeded, restart the
3836 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3838 adapter->quiescent--;
3840 megaraid_mbox_runpendq(adapter, NULL);
3850 * gather_hbainfo - HBA characteristics for the applications
3851 * @param adapter : HBA soft state
3852 * @param hinfo : pointer to the caller's host info strucuture
3855 gather_hbainfo(adapter_t *adapter, mraid_hba_info_t *hinfo)
3859 dmajor = megaraid_mbox_version[0];
3861 hinfo->pci_vendor_id = adapter->pdev->vendor;
3862 hinfo->pci_device_id = adapter->pdev->device;
3863 hinfo->subsys_vendor_id = adapter->pdev->subsystem_vendor;
3864 hinfo->subsys_device_id = adapter->pdev->subsystem_device;
3866 hinfo->pci_bus = adapter->pdev->bus->number;
3867 hinfo->pci_dev_fn = adapter->pdev->devfn;
3868 hinfo->pci_slot = PCI_SLOT(adapter->pdev->devfn);
3869 hinfo->irq = adapter->host->irq;
3870 hinfo->baseport = ADAP2RAIDDEV(adapter)->baseport;
3872 hinfo->unique_id = (hinfo->pci_bus << 8) | adapter->pdev->devfn;
3873 hinfo->host_no = adapter->host->host_no;
3879 * END: Interface for the common management module
3885 * megaraid_sysfs_alloc_resources - allocate sysfs related resources
3887 * Allocate packets required to issue FW calls whenever the sysfs attributes
3888 * are read. These attributes would require up-to-date information from the
3889 * FW. Also set up resources for mutual exclusion to share these resources and
3892 * @param adapter : controller's soft state
3894 * @return 0 on success
3895 * @return -ERROR_CODE on failure
3898 megaraid_sysfs_alloc_resources(adapter_t *adapter)
3900 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3903 raid_dev->sysfs_uioc = kmalloc(sizeof(uioc_t), GFP_KERNEL);
3905 raid_dev->sysfs_mbox64 = kmalloc(sizeof(mbox64_t), GFP_KERNEL);
3907 raid_dev->sysfs_buffer = pci_alloc_consistent(adapter->pdev,
3908 PAGE_SIZE, &raid_dev->sysfs_buffer_dma);
3910 if (!raid_dev->sysfs_uioc || !raid_dev->sysfs_mbox64 ||
3911 !raid_dev->sysfs_buffer) {
3913 con_log(CL_ANN, (KERN_WARNING
3914 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3919 megaraid_sysfs_free_resources(adapter);
3922 sema_init(&raid_dev->sysfs_sem, 1);
3924 init_waitqueue_head(&raid_dev->sysfs_wait_q);
3931 * megaraid_sysfs_free_resources - free sysfs related resources
3933 * Free packets allocated for sysfs FW commands
3935 * @param adapter : controller's soft state
3938 megaraid_sysfs_free_resources(adapter_t *adapter)
3940 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3942 if (raid_dev->sysfs_uioc) kfree(raid_dev->sysfs_uioc);
3944 if (raid_dev->sysfs_mbox64) kfree(raid_dev->sysfs_mbox64);
3946 if (raid_dev->sysfs_buffer) {
3947 pci_free_consistent(adapter->pdev, PAGE_SIZE,
3948 raid_dev->sysfs_buffer, raid_dev->sysfs_buffer_dma);
3954 * megaraid_sysfs_get_ldmap_done - callback for get ldmap
3956 * Callback routine called in the ISR/tasklet context for get ldmap call
3958 * @param uioc : completed packet
3961 megaraid_sysfs_get_ldmap_done(uioc_t *uioc)
3963 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3964 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3968 wake_up(&raid_dev->sysfs_wait_q);
3973 * megaraid_sysfs_get_ldmap_timeout - timeout handling for get ldmap
3975 * Timeout routine to recover and return to application, in case the adapter
3976 * has stopped responding. A timeout of 60 seconds for this command seem like
3979 * @param uioc : timed out packet
3982 megaraid_sysfs_get_ldmap_timeout(unsigned long data)
3984 uioc_t *uioc = (uioc_t *)data;
3985 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3986 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3988 uioc->status = -ETIME;
3990 wake_up(&raid_dev->sysfs_wait_q);
3995 * megaraid_sysfs_get_ldmap - get update logical drive map
3997 * This routine will be called whenever user reads the logical drive
3998 * attributes, go get the current logical drive mapping table from the
3999 * firmware. We use the managment API's to issue commands to the controller.
4001 * NOTE: The commands issuance functionality is not generalized and
4002 * implemented in context of "get ld map" command only. If required, the
4003 * command issuance logical can be trivially pulled out and implemented as a
4004 * standalone libary. For now, this should suffice since there is no other
4005 * user of this interface.
4007 * @param adapter : controller's soft state
4009 * @return 0 on success
4010 * @return -1 on failure
4013 megaraid_sysfs_get_ldmap(adapter_t *adapter)
4015 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4020 struct timer_list sysfs_timer;
4021 struct timer_list *timerp;
4026 * Allow only one read at a time to go through the sysfs attributes
4028 down(&raid_dev->sysfs_sem);
4030 uioc = raid_dev->sysfs_uioc;
4031 mbox64 = raid_dev->sysfs_mbox64;
4032 ldmap = raid_dev->sysfs_buffer;
4034 memset(uioc, 0, sizeof(uioc_t));
4035 memset(mbox64, 0, sizeof(mbox64_t));
4036 memset(ldmap, 0, sizeof(raid_dev->curr_ldmap));
4038 mbox = &mbox64->mbox32;
4039 raw_mbox = (char *)mbox;
4040 uioc->cmdbuf = (uint64_t)(unsigned long)mbox64;
4041 uioc->buf_vaddr = (caddr_t)adapter;
4042 uioc->status = -ENODATA;
4043 uioc->done = megaraid_sysfs_get_ldmap_done;
4046 * Prepare the mailbox packet to get the current logical drive mapping
4049 mbox->xferaddr = (uint32_t)raid_dev->sysfs_buffer_dma;
4051 raw_mbox[0] = FC_DEL_LOGDRV;
4052 raw_mbox[2] = OP_GET_LDID_MAP;
4055 * Setup a timer to recover from a non-responding controller
4057 timerp = &sysfs_timer;
4060 timerp->function = megaraid_sysfs_get_ldmap_timeout;
4061 timerp->data = (unsigned long)uioc;
4062 timerp->expires = jiffies + 60 * HZ;
4067 * Send the command to the firmware
4069 rval = megaraid_mbox_mm_command(adapter, uioc);
4071 if (rval == 0) { // command successfully issued
4072 wait_event(raid_dev->sysfs_wait_q, (uioc->status != -ENODATA));
4075 * Check if the command timed out
4077 if (uioc->status == -ETIME) {
4078 con_log(CL_ANN, (KERN_NOTICE
4079 "megaraid: sysfs get ld map timed out\n"));
4084 rval = mbox->status;
4088 memcpy(raid_dev->curr_ldmap, ldmap,
4089 sizeof(raid_dev->curr_ldmap));
4092 con_log(CL_ANN, (KERN_NOTICE
4093 "megaraid: get ld map failed with %x\n", rval));
4097 con_log(CL_ANN, (KERN_NOTICE
4098 "megaraid: could not issue ldmap command:%x\n", rval));
4102 del_timer_sync(timerp);
4104 up(&raid_dev->sysfs_sem);
4111 * megaraid_sysfs_show_app_hndl - display application handle for this adapter
4113 * Display the handle used by the applications while executing management
4114 * tasks on the adapter. We invoke a management module API to get the adapter
4115 * handle, since we do not interface with applications directly.
4117 * @param cdev : class device object representation for the host
4118 * @param buf : buffer to send data to
4121 megaraid_sysfs_show_app_hndl(struct class_device *cdev, char *buf)
4123 struct Scsi_Host *shost = class_to_shost(cdev);
4124 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(shost);
4127 app_hndl = mraid_mm_adapter_app_handle(adapter->unique_id);
4129 return snprintf(buf, 8, "%u\n", app_hndl);
4134 * megaraid_sysfs_show_ldnum - display the logical drive number for this device
4136 * Display the logical drive number for the device in question, if it a valid
4137 * logical drive. For physical devices, "-1" is returned
4138 * The logical drive number is displayed in following format
4140 * <SCSI ID> <LD NUM> <LD STICKY ID> <APP ADAPTER HANDLE>
4141 * <int> <int> <int> <int>
4143 * @param dev : device object representation for the scsi device
4144 * @param buf : buffer to send data to
4147 megaraid_sysfs_show_ldnum(struct device *dev, struct device_attribute *attr, char *buf)
4149 struct scsi_device *sdev = to_scsi_device(dev);
4150 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(sdev->host);
4151 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4153 int logical_drv = -1;
4155 uint32_t app_hndl = 0;
4160 if (raid_dev->random_del_supported &&
4161 MRAID_IS_LOGICAL_SDEV(adapter, sdev)) {
4163 rval = megaraid_sysfs_get_ldmap(adapter);
4166 for (i = 0; i < MAX_LOGICAL_DRIVES_40LD; i++) {
4168 mapped_sdev_id = sdev->id;
4170 if (sdev->id > adapter->init_id) {
4171 mapped_sdev_id -= 1;
4174 if (raid_dev->curr_ldmap[i] == mapped_sdev_id) {
4180 ldid_map = raid_dev->curr_ldmap[i];
4182 app_hndl = mraid_mm_adapter_app_handle(
4183 adapter->unique_id);
4190 con_log(CL_ANN, (KERN_NOTICE
4191 "megaraid: sysfs get ld map failed: %x\n",
4196 return snprintf(buf, 36, "%d %d %d %d\n", scsi_id, logical_drv,
4197 ldid_map, app_hndl);
4202 * END: Mailbox Low Level Driver
4204 module_init(megaraid_init);
4205 module_exit(megaraid_exit);
4207 /* vim: set ts=8 sw=8 tw=78 ai si: */