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);
722 scsi_set_device(host, &adapter->pdev->dev);
724 host->irq = adapter->irq;
725 host->unique_id = adapter->unique_id;
726 host->can_queue = adapter->max_cmds;
727 host->this_id = adapter->init_id;
728 host->sg_tablesize = adapter->sglen;
729 host->max_sectors = adapter->max_sectors;
730 host->cmd_per_lun = adapter->cmd_per_lun;
731 host->max_channel = adapter->max_channel;
732 host->max_id = adapter->max_target;
733 host->max_lun = adapter->max_lun;
736 // notify mid-layer about the new controller
737 if (scsi_add_host(host, &adapter->pdev->dev)) {
739 con_log(CL_ANN, (KERN_WARNING
740 "megaraid mbox: scsi_add_host failed\n"));
747 scsi_scan_host(host);
754 * megaraid_io_detach - detach a device from the IO subsystem
755 * @param adapter : controller's soft state
757 * Detach this device from the IO subsystem
760 megaraid_io_detach(adapter_t *adapter)
762 struct Scsi_Host *host;
764 con_log(CL_DLEVEL1, (KERN_INFO "megaraid: io detach\n"));
766 host = adapter->host;
768 scsi_remove_host(host);
775 * START: Mailbox Low Level Driver
777 * This is section specific to the single mailbox based controllers
781 * megaraid_init_mbox - initialize controller
782 * @param adapter - our soft state
784 * . Allocate 16-byte aligned mailbox memory for firmware handshake
785 * . Allocate controller's memory resources
786 * . Find out all initialization data
787 * . Allocate memory required for all the commands
788 * . Use internal library of FW routines, build up complete soft state
791 megaraid_init_mbox(adapter_t *adapter)
793 struct pci_dev *pdev;
794 mraid_device_t *raid_dev;
798 adapter->ito = MBOX_TIMEOUT;
799 pdev = adapter->pdev;
802 * Allocate and initialize the init data structure for mailbox
805 raid_dev = kmalloc(sizeof(mraid_device_t), GFP_KERNEL);
806 if (raid_dev == NULL) return -1;
808 memset(raid_dev, 0, sizeof(mraid_device_t));
811 * Attach the adapter soft state to raid device soft state
813 adapter->raid_device = (caddr_t)raid_dev;
814 raid_dev->fast_load = megaraid_fast_load;
818 raid_dev->baseport = pci_resource_start(pdev, 0);
820 if (pci_request_regions(pdev, "MegaRAID: LSI Logic Corporation") != 0) {
822 con_log(CL_ANN, (KERN_WARNING
823 "megaraid: mem region busy\n"));
825 goto out_free_raid_dev;
828 raid_dev->baseaddr = ioremap_nocache(raid_dev->baseport, 128);
830 if (!raid_dev->baseaddr) {
832 con_log(CL_ANN, (KERN_WARNING
833 "megaraid: could not map hba memory\n") );
835 goto out_release_regions;
839 // Setup the rest of the soft state using the library of FW routines
842 // request IRQ and register the interrupt service routine
843 if (request_irq(adapter->irq, megaraid_isr, SA_SHIRQ, "megaraid",
846 con_log(CL_ANN, (KERN_WARNING
847 "megaraid: Couldn't register IRQ %d!\n", adapter->irq));
853 // initialize the mutual exclusion lock for the mailbox
854 spin_lock_init(&raid_dev->mailbox_lock);
856 // allocate memory required for commands
857 if (megaraid_alloc_cmd_packets(adapter) != 0) {
862 if (megaraid_mbox_product_info(adapter) != 0) {
866 // Do we support extended CDBs
867 adapter->max_cdb_sz = 10;
868 if (megaraid_mbox_extended_cdb(adapter) == 0) {
869 adapter->max_cdb_sz = 16;
873 * Do we support cluster environment, if we do, what is the initiator
875 * NOTE: In a non-cluster aware firmware environment, the LLD should
876 * return 7 as initiator id.
879 adapter->init_id = -1;
880 if (megaraid_mbox_support_ha(adapter, &adapter->init_id) == 0) {
885 * Prepare the device ids array to have the mapping between the kernel
886 * device address and megaraid device address.
887 * We export the physical devices on their actual addresses. The
888 * logical drives are exported on a virtual SCSI channel
890 megaraid_mbox_setup_device_map(adapter);
892 // If the firmware supports random deletion, update the device id map
893 if (megaraid_mbox_support_random_del(adapter)) {
895 // Change the logical drives numbers in device_ids array one
896 // slot in device_ids is reserved for target id, that's why
898 for (i = 0; i <= MAX_LOGICAL_DRIVES_40LD; i++) {
899 adapter->device_ids[adapter->max_channel][i] += 0x80;
901 adapter->device_ids[adapter->max_channel][adapter->init_id] =
904 raid_dev->random_del_supported = 1;
908 * find out the maximum number of scatter-gather elements supported by
911 adapter->sglen = megaraid_mbox_get_max_sg(adapter);
913 // enumerate RAID and SCSI channels so that all devices on SCSI
914 // channels can later be exported, including disk devices
915 megaraid_mbox_enum_raid_scsi(adapter);
918 * Other parameters required by upper layer
920 * maximum number of sectors per IO command
922 adapter->max_sectors = megaraid_max_sectors;
925 * number of queued commands per LUN.
927 adapter->cmd_per_lun = megaraid_cmd_per_lun;
930 * Allocate resources required to issue FW calls, when sysfs is
933 if (megaraid_sysfs_alloc_resources(adapter) != 0) {
937 // Set the DMA mask to 64-bit. All supported controllers as capable of
939 if (pci_set_dma_mask(adapter->pdev, DMA_64BIT_MASK) != 0) {
941 con_log(CL_ANN, (KERN_WARNING
942 "megaraid: could not set DMA mask for 64-bit.\n"));
944 goto out_free_sysfs_res;
947 // setup tasklet for DPC
948 tasklet_init(&adapter->dpc_h, megaraid_mbox_dpc,
949 (unsigned long)adapter);
951 con_log(CL_DLEVEL1, (KERN_INFO
952 "megaraid mbox hba successfully initialized\n"));
957 megaraid_sysfs_free_resources(adapter);
959 megaraid_free_cmd_packets(adapter);
961 free_irq(adapter->irq, adapter);
963 iounmap(raid_dev->baseaddr);
965 pci_release_regions(pdev);
974 * megaraid_fini_mbox - undo controller initialization
975 * @param adapter : our soft state
978 megaraid_fini_mbox(adapter_t *adapter)
980 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
983 megaraid_mbox_flush_cache(adapter);
985 tasklet_kill(&adapter->dpc_h);
987 megaraid_sysfs_free_resources(adapter);
989 megaraid_free_cmd_packets(adapter);
991 free_irq(adapter->irq, adapter);
993 iounmap(raid_dev->baseaddr);
995 pci_release_regions(adapter->pdev);
1004 * megaraid_alloc_cmd_packets - allocate shared mailbox
1005 * @param adapter : soft state of the raid controller
1007 * Allocate and align the shared mailbox. This maibox is used to issue
1008 * all the commands. For IO based controllers, the mailbox is also regsitered
1009 * with the FW. Allocate memory for all commands as well.
1010 * This is our big allocator
1013 megaraid_alloc_cmd_packets(adapter_t *adapter)
1015 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1016 struct pci_dev *pdev;
1017 unsigned long align;
1020 struct mraid_pci_blk *epthru_pci_blk;
1021 struct mraid_pci_blk *sg_pci_blk;
1022 struct mraid_pci_blk *mbox_pci_blk;
1025 pdev = adapter->pdev;
1029 * Allocate the common 16-byte aligned memory for the handshake
1032 raid_dev->una_mbox64 = pci_alloc_consistent(adapter->pdev,
1033 sizeof(mbox64_t), &raid_dev->una_mbox64_dma);
1035 if (!raid_dev->una_mbox64) {
1036 con_log(CL_ANN, (KERN_WARNING
1037 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1041 memset(raid_dev->una_mbox64, 0, sizeof(mbox64_t));
1044 * Align the mailbox at 16-byte boundary
1046 raid_dev->mbox = &raid_dev->una_mbox64->mbox32;
1048 raid_dev->mbox = (mbox_t *)((((unsigned long)raid_dev->mbox) + 15) &
1051 raid_dev->mbox64 = (mbox64_t *)(((unsigned long)raid_dev->mbox) - 8);
1053 align = ((void *)raid_dev->mbox -
1054 ((void *)&raid_dev->una_mbox64->mbox32));
1056 raid_dev->mbox_dma = (unsigned long)raid_dev->una_mbox64_dma + 8 +
1059 // Allocate memory for commands issued internally
1060 adapter->ibuf = pci_alloc_consistent(pdev, MBOX_IBUF_SIZE,
1061 &adapter->ibuf_dma_h);
1062 if (!adapter->ibuf) {
1064 con_log(CL_ANN, (KERN_WARNING
1065 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1068 goto out_free_common_mbox;
1070 memset(adapter->ibuf, 0, MBOX_IBUF_SIZE);
1072 // Allocate memory for our SCSI Command Blocks and their associated
1076 * Allocate memory for the base list of scb. Later allocate memory for
1077 * CCBs and embedded components of each CCB and point the pointers in
1078 * scb to the allocated components
1079 * NOTE: The code to allocate SCB will be duplicated in all the LLD
1080 * since the calling routine does not yet know the number of available
1083 adapter->kscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_SCSI_CMDS,
1086 if (adapter->kscb_list == NULL) {
1087 con_log(CL_ANN, (KERN_WARNING
1088 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1092 memset(adapter->kscb_list, 0, sizeof(scb_t) * MBOX_MAX_SCSI_CMDS);
1094 // memory allocation for our command packets
1095 if (megaraid_mbox_setup_dma_pools(adapter) != 0) {
1096 con_log(CL_ANN, (KERN_WARNING
1097 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1099 goto out_free_scb_list;
1102 // Adjust the scb pointers and link in the free pool
1103 epthru_pci_blk = raid_dev->epthru_pool;
1104 sg_pci_blk = raid_dev->sg_pool;
1105 mbox_pci_blk = raid_dev->mbox_pool;
1107 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1108 scb = adapter->kscb_list + i;
1109 ccb = raid_dev->ccb_list + i;
1111 ccb->mbox = (mbox_t *)(mbox_pci_blk[i].vaddr + 16);
1112 ccb->raw_mbox = (uint8_t *)ccb->mbox;
1113 ccb->mbox64 = (mbox64_t *)(mbox_pci_blk[i].vaddr + 8);
1114 ccb->mbox_dma_h = (unsigned long)mbox_pci_blk[i].dma_addr + 16;
1116 // make sure the mailbox is aligned properly
1117 if (ccb->mbox_dma_h & 0x0F) {
1118 con_log(CL_ANN, (KERN_CRIT
1119 "megaraid mbox: not aligned on 16-bytes\n"));
1121 goto out_teardown_dma_pools;
1124 ccb->epthru = (mraid_epassthru_t *)
1125 epthru_pci_blk[i].vaddr;
1126 ccb->epthru_dma_h = epthru_pci_blk[i].dma_addr;
1127 ccb->pthru = (mraid_passthru_t *)ccb->epthru;
1128 ccb->pthru_dma_h = ccb->epthru_dma_h;
1131 ccb->sgl64 = (mbox_sgl64 *)sg_pci_blk[i].vaddr;
1132 ccb->sgl_dma_h = sg_pci_blk[i].dma_addr;
1133 ccb->sgl32 = (mbox_sgl32 *)ccb->sgl64;
1135 scb->ccb = (caddr_t)ccb;
1138 scb->sno = i; // command index
1141 scb->state = SCB_FREE;
1142 scb->dma_direction = PCI_DMA_NONE;
1143 scb->dma_type = MRAID_DMA_NONE;
1144 scb->dev_channel = -1;
1145 scb->dev_target = -1;
1147 // put scb in the free pool
1148 list_add_tail(&scb->list, &adapter->kscb_pool);
1153 out_teardown_dma_pools:
1154 megaraid_mbox_teardown_dma_pools(adapter);
1156 kfree(adapter->kscb_list);
1158 pci_free_consistent(pdev, MBOX_IBUF_SIZE, (void *)adapter->ibuf,
1159 adapter->ibuf_dma_h);
1160 out_free_common_mbox:
1161 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1162 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1169 * megaraid_free_cmd_packets - free memory
1170 * @param adapter : soft state of the raid controller
1172 * Release memory resources allocated for commands
1175 megaraid_free_cmd_packets(adapter_t *adapter)
1177 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1179 megaraid_mbox_teardown_dma_pools(adapter);
1181 kfree(adapter->kscb_list);
1183 pci_free_consistent(adapter->pdev, MBOX_IBUF_SIZE,
1184 (void *)adapter->ibuf, adapter->ibuf_dma_h);
1186 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1187 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1193 * megaraid_mbox_setup_dma_pools - setup dma pool for command packets
1194 * @param adapter : HBA soft state
1196 * setup the dma pools for mailbox, passthru and extended passthru structures,
1197 * and scatter-gather lists
1200 megaraid_mbox_setup_dma_pools(adapter_t *adapter)
1202 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1203 struct mraid_pci_blk *epthru_pci_blk;
1204 struct mraid_pci_blk *sg_pci_blk;
1205 struct mraid_pci_blk *mbox_pci_blk;
1210 // Allocate memory for 16-bytes aligned mailboxes
1211 raid_dev->mbox_pool_handle = pci_pool_create("megaraid mbox pool",
1213 sizeof(mbox64_t) + 16,
1216 if (raid_dev->mbox_pool_handle == NULL) {
1217 goto fail_setup_dma_pool;
1220 mbox_pci_blk = raid_dev->mbox_pool;
1221 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1222 mbox_pci_blk[i].vaddr = pci_pool_alloc(
1223 raid_dev->mbox_pool_handle,
1225 &mbox_pci_blk[i].dma_addr);
1226 if (!mbox_pci_blk[i].vaddr) {
1227 goto fail_setup_dma_pool;
1232 * Allocate memory for each embedded passthru strucuture pointer
1233 * Request for a 128 bytes aligned structure for each passthru command
1235 * Since passthru and extended passthru commands are exclusive, they
1236 * share common memory pool. Passthru structures piggyback on memory
1237 * allocted to extended passthru since passthru is smaller of the two
1239 raid_dev->epthru_pool_handle = pci_pool_create("megaraid mbox pthru",
1240 adapter->pdev, sizeof(mraid_epassthru_t), 128, 0);
1242 if (raid_dev->epthru_pool_handle == NULL) {
1243 goto fail_setup_dma_pool;
1246 epthru_pci_blk = raid_dev->epthru_pool;
1247 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1248 epthru_pci_blk[i].vaddr = pci_pool_alloc(
1249 raid_dev->epthru_pool_handle,
1251 &epthru_pci_blk[i].dma_addr);
1252 if (!epthru_pci_blk[i].vaddr) {
1253 goto fail_setup_dma_pool;
1258 // Allocate memory for each scatter-gather list. Request for 512 bytes
1259 // alignment for each sg list
1260 raid_dev->sg_pool_handle = pci_pool_create("megaraid mbox sg",
1262 sizeof(mbox_sgl64) * MBOX_MAX_SG_SIZE,
1265 if (raid_dev->sg_pool_handle == NULL) {
1266 goto fail_setup_dma_pool;
1269 sg_pci_blk = raid_dev->sg_pool;
1270 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1271 sg_pci_blk[i].vaddr = pci_pool_alloc(
1272 raid_dev->sg_pool_handle,
1274 &sg_pci_blk[i].dma_addr);
1275 if (!sg_pci_blk[i].vaddr) {
1276 goto fail_setup_dma_pool;
1282 fail_setup_dma_pool:
1283 megaraid_mbox_teardown_dma_pools(adapter);
1289 * megaraid_mbox_teardown_dma_pools - teardown dma pools for command packets
1290 * @param adapter : HBA soft state
1292 * teardown the dma pool for mailbox, passthru and extended passthru
1293 * structures, and scatter-gather lists
1296 megaraid_mbox_teardown_dma_pools(adapter_t *adapter)
1298 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1299 struct mraid_pci_blk *epthru_pci_blk;
1300 struct mraid_pci_blk *sg_pci_blk;
1301 struct mraid_pci_blk *mbox_pci_blk;
1305 sg_pci_blk = raid_dev->sg_pool;
1306 for (i = 0; i < MBOX_MAX_SCSI_CMDS && sg_pci_blk[i].vaddr; i++) {
1307 pci_pool_free(raid_dev->sg_pool_handle, sg_pci_blk[i].vaddr,
1308 sg_pci_blk[i].dma_addr);
1310 if (raid_dev->sg_pool_handle)
1311 pci_pool_destroy(raid_dev->sg_pool_handle);
1314 epthru_pci_blk = raid_dev->epthru_pool;
1315 for (i = 0; i < MBOX_MAX_SCSI_CMDS && epthru_pci_blk[i].vaddr; i++) {
1316 pci_pool_free(raid_dev->epthru_pool_handle,
1317 epthru_pci_blk[i].vaddr, epthru_pci_blk[i].dma_addr);
1319 if (raid_dev->epthru_pool_handle)
1320 pci_pool_destroy(raid_dev->epthru_pool_handle);
1323 mbox_pci_blk = raid_dev->mbox_pool;
1324 for (i = 0; i < MBOX_MAX_SCSI_CMDS && mbox_pci_blk[i].vaddr; i++) {
1325 pci_pool_free(raid_dev->mbox_pool_handle,
1326 mbox_pci_blk[i].vaddr, mbox_pci_blk[i].dma_addr);
1328 if (raid_dev->mbox_pool_handle)
1329 pci_pool_destroy(raid_dev->mbox_pool_handle);
1336 * megaraid_alloc_scb - detach and return a scb from the free list
1337 * @adapter : controller's soft state
1339 * return the scb from the head of the free list. NULL if there are none
1342 static inline scb_t *
1343 megaraid_alloc_scb(adapter_t *adapter, struct scsi_cmnd *scp)
1345 struct list_head *head = &adapter->kscb_pool;
1347 unsigned long flags;
1349 // detach scb from free pool
1350 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1352 if (list_empty(head)) {
1353 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1357 scb = list_entry(head->next, scb_t, list);
1358 list_del_init(&scb->list);
1360 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1362 scb->state = SCB_ACTIVE;
1364 scb->dma_type = MRAID_DMA_NONE;
1371 * megaraid_dealloc_scb - return the scb to the free pool
1372 * @adapter : controller's soft state
1373 * @scb : scb to be freed
1375 * return the scb back to the free list of scbs. The caller must 'flush' the
1376 * SCB before calling us. E.g., performing pci_unamp and/or pci_sync etc.
1377 * NOTE NOTE: Make sure the scb is not on any list before calling this
1381 megaraid_dealloc_scb(adapter_t *adapter, scb_t *scb)
1383 unsigned long flags;
1385 // put scb in the free pool
1386 scb->state = SCB_FREE;
1388 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1390 list_add(&scb->list, &adapter->kscb_pool);
1392 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1399 * megaraid_mbox_mksgl - make the scatter-gather list
1400 * @adapter - controller's soft state
1401 * @scb - scsi control block
1403 * prepare the scatter-gather list
1406 megaraid_mbox_mksgl(adapter_t *adapter, scb_t *scb)
1408 struct scatterlist *sgl;
1411 unsigned long offset;
1412 struct scsi_cmnd *scp;
1418 ccb = (mbox_ccb_t *)scb->ccb;
1420 // no mapping required if no data to be transferred
1421 if (!scp->request_buffer || !scp->request_bufflen)
1424 if (!scp->use_sg) { /* scatter-gather list not used */
1426 page = virt_to_page(scp->request_buffer);
1428 offset = ((unsigned long)scp->request_buffer & ~PAGE_MASK);
1430 ccb->buf_dma_h = pci_map_page(adapter->pdev, page, offset,
1431 scp->request_bufflen,
1432 scb->dma_direction);
1433 scb->dma_type = MRAID_DMA_WBUF;
1436 * We need to handle special 64-bit commands that need a
1440 ccb->sgl64[0].address = ccb->buf_dma_h;
1441 ccb->sgl64[0].length = scp->request_bufflen;
1446 sgl = (struct scatterlist *)scp->request_buffer;
1448 // The number of sg elements returned must not exceed our limit
1449 sgcnt = pci_map_sg(adapter->pdev, sgl, scp->use_sg,
1450 scb->dma_direction);
1452 if (sgcnt > adapter->sglen) {
1453 con_log(CL_ANN, (KERN_CRIT
1454 "megaraid critical: too many sg elements:%d\n",
1459 scb->dma_type = MRAID_DMA_WSG;
1461 for (i = 0; i < sgcnt; i++, sgl++) {
1462 ccb->sgl64[i].address = sg_dma_address(sgl);
1463 ccb->sgl64[i].length = sg_dma_len(sgl);
1466 // Return count of SG nodes
1472 * mbox_post_cmd - issue a mailbox command
1473 * @adapter - controller's soft state
1474 * @scb - command to be issued
1476 * post the command to the controller if mailbox is availble.
1479 mbox_post_cmd(adapter_t *adapter, scb_t *scb)
1481 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1485 unsigned long flags;
1489 ccb = (mbox_ccb_t *)scb->ccb;
1490 mbox = raid_dev->mbox;
1491 mbox64 = raid_dev->mbox64;
1494 * Check for busy mailbox. If it is, return failure - the caller
1495 * should retry later.
1497 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
1499 if (unlikely(mbox->busy)) {
1504 } while(mbox->busy && (i < max_mbox_busy_wait));
1508 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1515 // Copy this command's mailbox data into "adapter's" mailbox
1516 memcpy((caddr_t)mbox64, (caddr_t)ccb->mbox64, 22);
1517 mbox->cmdid = scb->sno;
1519 adapter->outstanding_cmds++;
1521 if (scb->dma_direction == PCI_DMA_TODEVICE) {
1522 if (!scb->scp->use_sg) { // sg list not used
1523 pci_dma_sync_single_for_device(adapter->pdev,
1525 scb->scp->request_bufflen,
1529 pci_dma_sync_sg_for_device(adapter->pdev,
1530 scb->scp->request_buffer,
1531 scb->scp->use_sg, PCI_DMA_TODEVICE);
1535 mbox->busy = 1; // Set busy
1540 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
1542 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1549 * megaraid_queue_command - generic queue entry point for all LLDs
1550 * @scp : pointer to the scsi command to be executed
1551 * @done : callback routine to be called after the cmd has be completed
1553 * Queue entry point for mailbox based controllers.
1556 megaraid_queue_command(struct scsi_cmnd *scp, void (* done)(struct scsi_cmnd *))
1562 adapter = SCP2ADAPTER(scp);
1563 scp->scsi_done = done;
1566 assert_spin_locked(adapter->host_lock);
1568 spin_unlock(adapter->host_lock);
1571 * Allocate and build a SCB request
1572 * if_busy flag will be set if megaraid_mbox_build_cmd() command could
1573 * not allocate scb. We will return non-zero status in that case.
1574 * NOTE: scb can be null even though certain commands completed
1575 * successfully, e.g., MODE_SENSE and TEST_UNIT_READY, it would
1576 * return 0 in that case, and we would do the callback right away.
1579 scb = megaraid_mbox_build_cmd(adapter, scp, &if_busy);
1582 megaraid_mbox_runpendq(adapter, scb);
1585 spin_lock(adapter->host_lock);
1587 if (!scb) { // command already completed
1597 * megaraid_mbox_build_cmd - transform the mid-layer scsi command to megaraid
1599 * @adapter - controller's soft state
1600 * @scp - mid-layer scsi command pointer
1601 * @busy - set if request could not be completed because of lack of
1604 * convert the command issued by mid-layer to format understood by megaraid
1605 * firmware. We also complete certain command without sending them to firmware
1608 megaraid_mbox_build_cmd(adapter_t *adapter, struct scsi_cmnd *scp, int *busy)
1610 mraid_device_t *rdev = ADAP2RAIDDEV(adapter);
1615 mraid_passthru_t *pthru;
1619 char skip[] = "skipping";
1620 char scan[] = "scanning";
1625 * Get the appropriate device map for the device this command is
1628 MRAID_GET_DEVICE_MAP(adapter, scp, channel, target, islogical);
1631 * Logical drive commands
1634 switch (scp->cmnd[0]) {
1635 case TEST_UNIT_READY:
1637 * Do we support clustering and is the support enabled
1638 * If no, return success always
1641 scp->result = (DID_OK << 16);
1645 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1646 scp->result = (DID_ERROR << 16);
1651 scb->dma_direction = scp->sc_data_direction;
1652 scb->dev_channel = 0xFF;
1653 scb->dev_target = target;
1654 ccb = (mbox_ccb_t *)scb->ccb;
1657 * The command id will be provided by the command
1660 ccb->raw_mbox[0] = CLUSTER_CMD;
1661 ccb->raw_mbox[2] = RESERVATION_STATUS;
1662 ccb->raw_mbox[3] = target;
1668 struct scatterlist *sgl;
1671 sgl = (struct scatterlist *)scp->request_buffer;
1674 (page_address((&sgl[0])->page)
1675 + (&sgl[0])->offset);
1677 memset(vaddr, 0, scp->cmnd[4]);
1680 con_log(CL_ANN, (KERN_WARNING
1681 "megaraid mailbox: invalid sg:%d\n",
1686 memset(scp->request_buffer, 0, scp->cmnd[4]);
1688 scp->result = (DID_OK << 16);
1693 * Display the channel scan for logical drives
1694 * Do not display scan for a channel if already done.
1696 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1698 con_log(CL_ANN, (KERN_INFO
1699 "scsi[%d]: scanning scsi channel %d",
1700 adapter->host->host_no,
1704 " [virtual] for logical drives\n"));
1706 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1713 * Do not allow LUN > 0 for logical drives and
1714 * requests for more than 40 logical drives
1717 scp->result = (DID_BAD_TARGET << 16);
1720 if ((target % 0x80) >= MAX_LOGICAL_DRIVES_40LD) {
1721 scp->result = (DID_BAD_TARGET << 16);
1726 /* Allocate a SCB and initialize passthru */
1727 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1728 scp->result = (DID_ERROR << 16);
1733 ccb = (mbox_ccb_t *)scb->ccb;
1734 scb->dev_channel = 0xFF;
1735 scb->dev_target = target;
1738 mbox64 = ccb->mbox64;
1742 pthru->reqsenselen = 14;
1743 pthru->islogical = 1;
1744 pthru->logdrv = target;
1745 pthru->cdblen = scp->cmd_len;
1746 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
1748 mbox->cmd = MBOXCMD_PASSTHRU64;
1749 scb->dma_direction = scp->sc_data_direction;
1751 pthru->dataxferlen = scp->request_bufflen;
1752 pthru->dataxferaddr = ccb->sgl_dma_h;
1753 pthru->numsge = megaraid_mbox_mksgl(adapter,
1756 mbox->xferaddr = 0xFFFFFFFF;
1757 mbox64->xferaddr_lo = (uint32_t )ccb->pthru_dma_h;
1758 mbox64->xferaddr_hi = 0;
1770 * Allocate a SCB and initialize mailbox
1772 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1773 scp->result = (DID_ERROR << 16);
1777 ccb = (mbox_ccb_t *)scb->ccb;
1778 scb->dev_channel = 0xFF;
1779 scb->dev_target = target;
1781 mbox64 = ccb->mbox64;
1782 mbox->logdrv = target;
1785 * A little HACK: 2nd bit is zero for all scsi read
1786 * commands and is set for all scsi write commands
1788 mbox->cmd = (scp->cmnd[0] & 0x02) ? MBOXCMD_LWRITE64:
1792 * 6-byte READ(0x08) or WRITE(0x0A) cdb
1794 if (scp->cmd_len == 6) {
1795 mbox->numsectors = (uint32_t)scp->cmnd[4];
1797 ((uint32_t)scp->cmnd[1] << 16) |
1798 ((uint32_t)scp->cmnd[2] << 8) |
1799 (uint32_t)scp->cmnd[3];
1801 mbox->lba &= 0x1FFFFF;
1805 * 10-byte READ(0x28) or WRITE(0x2A) cdb
1807 else if (scp->cmd_len == 10) {
1809 (uint32_t)scp->cmnd[8] |
1810 ((uint32_t)scp->cmnd[7] << 8);
1812 ((uint32_t)scp->cmnd[2] << 24) |
1813 ((uint32_t)scp->cmnd[3] << 16) |
1814 ((uint32_t)scp->cmnd[4] << 8) |
1815 (uint32_t)scp->cmnd[5];
1819 * 12-byte READ(0xA8) or WRITE(0xAA) cdb
1821 else if (scp->cmd_len == 12) {
1823 ((uint32_t)scp->cmnd[2] << 24) |
1824 ((uint32_t)scp->cmnd[3] << 16) |
1825 ((uint32_t)scp->cmnd[4] << 8) |
1826 (uint32_t)scp->cmnd[5];
1829 ((uint32_t)scp->cmnd[6] << 24) |
1830 ((uint32_t)scp->cmnd[7] << 16) |
1831 ((uint32_t)scp->cmnd[8] << 8) |
1832 (uint32_t)scp->cmnd[9];
1835 con_log(CL_ANN, (KERN_WARNING
1836 "megaraid: unsupported CDB length\n"));
1838 megaraid_dealloc_scb(adapter, scb);
1840 scp->result = (DID_ERROR << 16);
1844 scb->dma_direction = scp->sc_data_direction;
1846 // Calculate Scatter-Gather info
1847 mbox64->xferaddr_lo = (uint32_t )ccb->sgl_dma_h;
1848 mbox->numsge = megaraid_mbox_mksgl(adapter,
1850 mbox->xferaddr = 0xFFFFFFFF;
1851 mbox64->xferaddr_hi = 0;
1858 * Do we support clustering and is the support enabled
1861 scp->result = (DID_BAD_TARGET << 16);
1866 * Allocate a SCB and initialize mailbox
1868 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1869 scp->result = (DID_ERROR << 16);
1874 ccb = (mbox_ccb_t *)scb->ccb;
1875 scb->dev_channel = 0xFF;
1876 scb->dev_target = target;
1877 ccb->raw_mbox[0] = CLUSTER_CMD;
1878 ccb->raw_mbox[2] = (scp->cmnd[0] == RESERVE) ?
1879 RESERVE_LD : RELEASE_LD;
1881 ccb->raw_mbox[3] = target;
1882 scb->dma_direction = scp->sc_data_direction;
1887 scp->result = (DID_BAD_TARGET << 16);
1891 else { // Passthru device commands
1893 // Do not allow access to target id > 15 or LUN > 7
1894 if (target > 15 || SCP2LUN(scp) > 7) {
1895 scp->result = (DID_BAD_TARGET << 16);
1899 // if fast load option was set and scan for last device is
1900 // over, reset the fast_load flag so that during a possible
1901 // next scan, devices can be made available
1902 if (rdev->fast_load && (target == 15) &&
1903 (SCP2CHANNEL(scp) == adapter->max_channel -1)) {
1905 con_log(CL_ANN, (KERN_INFO
1906 "megaraid[%d]: physical device scan re-enabled\n",
1907 adapter->host->host_no));
1908 rdev->fast_load = 0;
1912 * Display the channel scan for physical devices
1914 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1916 ss = rdev->fast_load ? skip : scan;
1918 con_log(CL_ANN, (KERN_INFO
1919 "scsi[%d]: %s scsi channel %d [Phy %d]",
1920 adapter->host->host_no, ss, SCP2CHANNEL(scp),
1924 " for non-raid devices\n"));
1926 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1929 // disable channel sweep if fast load option given
1930 if (rdev->fast_load) {
1931 scp->result = (DID_BAD_TARGET << 16);
1935 // Allocate a SCB and initialize passthru
1936 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1937 scp->result = (DID_ERROR << 16);
1942 ccb = (mbox_ccb_t *)scb->ccb;
1943 scb->dev_channel = channel;
1944 scb->dev_target = target;
1945 scb->dma_direction = scp->sc_data_direction;
1947 mbox64 = ccb->mbox64;
1949 // Does this firmware support extended CDBs
1950 if (adapter->max_cdb_sz == 16) {
1951 mbox->cmd = MBOXCMD_EXTPTHRU;
1953 megaraid_mbox_prepare_epthru(adapter, scb, scp);
1955 mbox64->xferaddr_lo = (uint32_t)ccb->epthru_dma_h;
1956 mbox64->xferaddr_hi = 0;
1957 mbox->xferaddr = 0xFFFFFFFF;
1960 mbox->cmd = MBOXCMD_PASSTHRU64;
1962 megaraid_mbox_prepare_pthru(adapter, scb, scp);
1964 mbox64->xferaddr_lo = (uint32_t)ccb->pthru_dma_h;
1965 mbox64->xferaddr_hi = 0;
1966 mbox->xferaddr = 0xFFFFFFFF;
1976 * megaraid_mbox_runpendq - execute commands queued in the pending queue
1977 * @adapter : controller's soft state
1978 * @scb : SCB to be queued in the pending list
1980 * scan the pending list for commands which are not yet issued and try to
1981 * post to the controller. The SCB can be a null pointer, which would indicate
1982 * no SCB to be queue, just try to execute the ones in the pending list.
1984 * NOTE: We do not actually traverse the pending list. The SCBs are plucked
1985 * out from the head of the pending list. If it is successfully issued, the
1986 * next SCB is at the head now.
1989 megaraid_mbox_runpendq(adapter_t *adapter, scb_t *scb_q)
1992 unsigned long flags;
1994 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1997 scb_q->state = SCB_PENDQ;
1998 list_add_tail(&scb_q->list, &adapter->pend_list);
2001 // if the adapter in not in quiescent mode, post the commands to FW
2002 if (adapter->quiescent) {
2003 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2007 while (!list_empty(&adapter->pend_list)) {
2009 assert_spin_locked(PENDING_LIST_LOCK(adapter));
2011 scb = list_entry(adapter->pend_list.next, scb_t, list);
2013 // remove the scb from the pending list and try to
2014 // issue. If we are unable to issue it, put back in
2015 // the pending list and return
2017 list_del_init(&scb->list);
2019 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2021 // if mailbox was busy, return SCB back to pending
2022 // list. Make sure to add at the head, since that's
2023 // where it would have been removed from
2025 scb->state = SCB_ISSUED;
2027 if (mbox_post_cmd(adapter, scb) != 0) {
2029 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2031 scb->state = SCB_PENDQ;
2033 list_add(&scb->list, &adapter->pend_list);
2035 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2041 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2044 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2052 * megaraid_mbox_prepare_pthru - prepare a command for physical devices
2053 * @adapter - pointer to controller's soft state
2054 * @scb - scsi control block
2055 * @scp - scsi command from the mid-layer
2057 * prepare a command for the scsi physical devices
2060 megaraid_mbox_prepare_pthru(adapter_t *adapter, scb_t *scb,
2061 struct scsi_cmnd *scp)
2064 mraid_passthru_t *pthru;
2068 ccb = (mbox_ccb_t *)scb->ccb;
2070 channel = scb->dev_channel;
2071 target = scb->dev_target;
2073 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2076 pthru->islogical = 0;
2078 pthru->target = (channel << 4) | target;
2079 pthru->logdrv = SCP2LUN(scp);
2080 pthru->reqsenselen = 14;
2081 pthru->cdblen = scp->cmd_len;
2083 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
2085 if (scp->request_bufflen) {
2086 pthru->dataxferlen = scp->request_bufflen;
2087 pthru->dataxferaddr = ccb->sgl_dma_h;
2088 pthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2091 pthru->dataxferaddr = 0;
2092 pthru->dataxferlen = 0;
2100 * megaraid_mbox_prepare_epthru - prepare a command for physical devices
2101 * @adapter - pointer to controller's soft state
2102 * @scb - scsi control block
2103 * @scp - scsi command from the mid-layer
2105 * prepare a command for the scsi physical devices. This rountine prepares
2106 * commands for devices which can take extended CDBs (>10 bytes)
2109 megaraid_mbox_prepare_epthru(adapter_t *adapter, scb_t *scb,
2110 struct scsi_cmnd *scp)
2113 mraid_epassthru_t *epthru;
2117 ccb = (mbox_ccb_t *)scb->ccb;
2118 epthru = ccb->epthru;
2119 channel = scb->dev_channel;
2120 target = scb->dev_target;
2122 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2123 epthru->timeout = 4;
2125 epthru->islogical = 0;
2126 epthru->channel = 0;
2127 epthru->target = (channel << 4) | target;
2128 epthru->logdrv = SCP2LUN(scp);
2129 epthru->reqsenselen = 14;
2130 epthru->cdblen = scp->cmd_len;
2132 memcpy(epthru->cdb, scp->cmnd, scp->cmd_len);
2134 if (scp->request_bufflen) {
2135 epthru->dataxferlen = scp->request_bufflen;
2136 epthru->dataxferaddr = ccb->sgl_dma_h;
2137 epthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2140 epthru->dataxferaddr = 0;
2141 epthru->dataxferlen = 0;
2149 * megaraid_ack_sequence - interrupt ack sequence for memory mapped HBAs
2150 * @adapter - controller's soft state
2152 * Interrupt ackrowledgement sequence for memory mapped HBAs. Find out the
2153 * completed command and put them on the completed list for later processing.
2155 * Returns: 1 if the interrupt is valid, 0 otherwise
2158 megaraid_ack_sequence(adapter_t *adapter)
2160 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2164 uint8_t completed[MBOX_MAX_FIRMWARE_STATUS];
2165 struct list_head clist;
2168 unsigned long flags;
2172 mbox = raid_dev->mbox;
2174 // move the SCBs from the firmware completed array to our local list
2175 INIT_LIST_HEAD(&clist);
2177 // loop till F/W has more commands for us to complete
2179 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
2182 * Check if a valid interrupt is pending. If found, force the
2183 * interrupt line low.
2185 dword = RDOUTDOOR(raid_dev);
2186 if (dword != 0x10001234) break;
2190 WROUTDOOR(raid_dev, 0x10001234);
2193 // wait for valid numstatus to post
2194 for (i = 0; i < 0xFFFFF; i++) {
2195 if (mbox->numstatus != 0xFF) {
2196 nstatus = mbox->numstatus;
2201 mbox->numstatus = 0xFF;
2203 adapter->outstanding_cmds -= nstatus;
2205 for (i = 0; i < nstatus; i++) {
2207 // wait for valid command index to post
2208 for (j = 0; j < 0xFFFFF; j++) {
2209 if (mbox->completed[i] != 0xFF) break;
2212 completed[i] = mbox->completed[i];
2213 mbox->completed[i] = 0xFF;
2215 if (completed[i] == 0xFF) {
2216 con_log(CL_ANN, (KERN_CRIT
2217 "megaraid: command posting timed out\n"));
2223 // Get SCB associated with this command id
2224 if (completed[i] >= MBOX_MAX_SCSI_CMDS) {
2226 scb = adapter->uscb_list + (completed[i] -
2227 MBOX_MAX_SCSI_CMDS);
2231 scb = adapter->kscb_list + completed[i];
2234 scb->status = mbox->status;
2235 list_add_tail(&scb->list, &clist);
2238 // Acknowledge interrupt
2239 WRINDOOR(raid_dev, 0x02);
2243 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
2246 // put the completed commands in the completed list. DPC would
2247 // complete these commands later
2248 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2250 list_splice(&clist, &adapter->completed_list);
2252 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2255 // schedule the DPC if there is some work for it
2257 tasklet_schedule(&adapter->dpc_h);
2264 * megaraid_isr - isr for memory based mailbox based controllers
2266 * @devp - pointer to our soft state
2269 * Interrupt service routine for memory-mapped mailbox controllers.
2272 megaraid_isr(int irq, void *devp, struct pt_regs *regs)
2274 adapter_t *adapter = devp;
2277 handled = megaraid_ack_sequence(adapter);
2279 /* Loop through any pending requests */
2280 if (!adapter->quiescent) {
2281 megaraid_mbox_runpendq(adapter, NULL);
2284 return IRQ_RETVAL(handled);
2289 * megaraid_mbox_sync_scb - sync kernel buffers
2290 * @adapter : controller's soft state
2291 * @scb : pointer to the resource packet
2293 * DMA sync if required.
2296 megaraid_mbox_sync_scb(adapter_t *adapter, scb_t *scb)
2300 ccb = (mbox_ccb_t *)scb->ccb;
2302 switch (scb->dma_type) {
2304 case MRAID_DMA_WBUF:
2305 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2306 pci_dma_sync_single_for_cpu(adapter->pdev,
2308 scb->scp->request_bufflen,
2309 PCI_DMA_FROMDEVICE);
2312 pci_unmap_page(adapter->pdev, ccb->buf_dma_h,
2313 scb->scp->request_bufflen, scb->dma_direction);
2318 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2319 pci_dma_sync_sg_for_cpu(adapter->pdev,
2320 scb->scp->request_buffer,
2321 scb->scp->use_sg, PCI_DMA_FROMDEVICE);
2324 pci_unmap_sg(adapter->pdev, scb->scp->request_buffer,
2325 scb->scp->use_sg, scb->dma_direction);
2338 * megaraid_mbox_dpc - the tasklet to complete the commands from completed list
2339 * @devp : pointer to HBA soft state
2341 * Pick up the commands from the completed list and send back to the owners.
2342 * This is a reentrant function and does not assume any locks are held while
2343 * it is being called.
2346 megaraid_mbox_dpc(unsigned long devp)
2348 adapter_t *adapter = (adapter_t *)devp;
2349 mraid_device_t *raid_dev;
2350 struct list_head clist;
2351 struct scatterlist *sgl;
2354 struct scsi_cmnd *scp;
2355 mraid_passthru_t *pthru;
2356 mraid_epassthru_t *epthru;
2362 unsigned long flags;
2367 if (!adapter) return;
2369 raid_dev = ADAP2RAIDDEV(adapter);
2371 // move the SCBs from the completed list to our local list
2372 INIT_LIST_HEAD(&clist);
2374 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2376 list_splice_init(&adapter->completed_list, &clist);
2378 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2381 list_for_each_entry_safe(scb, tmp, &clist, list) {
2383 status = scb->status;
2385 ccb = (mbox_ccb_t *)scb->ccb;
2387 epthru = ccb->epthru;
2390 // Make sure f/w has completed a valid command
2391 if (scb->state != SCB_ISSUED) {
2392 con_log(CL_ANN, (KERN_CRIT
2393 "megaraid critical err: invalid command %d:%d:%p\n",
2394 scb->sno, scb->state, scp));
2396 continue; // Must never happen!
2399 // check for the management command and complete it right away
2400 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2401 scb->state = SCB_FREE;
2402 scb->status = status;
2404 // remove from local clist
2405 list_del_init(&scb->list);
2407 megaraid_mbox_mm_done(adapter, scb);
2412 // Was an abort issued for this command earlier
2413 if (scb->state & SCB_ABORT) {
2414 con_log(CL_ANN, (KERN_NOTICE
2415 "megaraid: aborted cmd %lx[%x] completed\n",
2416 scp->serial_number, scb->sno));
2420 * If the inquiry came of a disk drive which is not part of
2421 * any RAID array, expose it to the kernel. For this to be
2422 * enabled, user must set the "megaraid_expose_unconf_disks"
2423 * flag to 1 by specifying it on module parameter list.
2424 * This would enable data migration off drives from other
2427 islogical = MRAID_IS_LOGICAL(adapter, scp);
2428 if (scp->cmnd[0] == INQUIRY && status == 0 && islogical == 0
2429 && IS_RAID_CH(raid_dev, scb->dev_channel)) {
2432 sgl = (struct scatterlist *)
2433 scp->request_buffer;
2436 c = *(unsigned char *)
2437 (page_address((&sgl[0])->page) +
2441 con_log(CL_ANN, (KERN_WARNING
2442 "megaraid mailbox: invalid sg:%d\n",
2448 c = *(uint8_t *)scp->request_buffer;
2451 if ((c & 0x1F ) == TYPE_DISK) {
2452 pdev_index = (scb->dev_channel * 16) +
2455 raid_dev->pdrv_state[pdev_index] & 0x0F;
2457 if (pdev_state == PDRV_ONLINE ||
2458 pdev_state == PDRV_FAILED ||
2459 pdev_state == PDRV_RBLD ||
2460 pdev_state == PDRV_HOTSPARE ||
2461 megaraid_expose_unconf_disks == 0) {
2468 // Convert MegaRAID status to Linux error code
2473 scp->result = (DID_OK << 16);
2478 /* set sense_buffer and result fields */
2479 if (mbox->cmd == MBOXCMD_PASSTHRU ||
2480 mbox->cmd == MBOXCMD_PASSTHRU64) {
2482 memcpy(scp->sense_buffer, pthru->reqsensearea,
2485 scp->result = DRIVER_SENSE << 24 |
2486 DID_OK << 16 | CHECK_CONDITION << 1;
2489 if (mbox->cmd == MBOXCMD_EXTPTHRU) {
2491 memcpy(scp->sense_buffer,
2492 epthru->reqsensearea, 14);
2494 scp->result = DRIVER_SENSE << 24 |
2496 CHECK_CONDITION << 1;
2498 scp->sense_buffer[0] = 0x70;
2499 scp->sense_buffer[2] = ABORTED_COMMAND;
2500 scp->result = CHECK_CONDITION << 1;
2507 scp->result = DID_BUS_BUSY << 16 | status;
2513 * If TEST_UNIT_READY fails, we know RESERVATION_STATUS
2516 if (scp->cmnd[0] == TEST_UNIT_READY) {
2517 scp->result = DID_ERROR << 16 |
2518 RESERVATION_CONFLICT << 1;
2522 * Error code returned is 1 if Reserve or Release
2523 * failed or the input parameter is invalid
2525 if (status == 1 && (scp->cmnd[0] == RESERVE ||
2526 scp->cmnd[0] == RELEASE)) {
2528 scp->result = DID_ERROR << 16 |
2529 RESERVATION_CONFLICT << 1;
2532 scp->result = DID_BAD_TARGET << 16 | status;
2536 // print a debug message for all failed commands
2538 megaraid_mbox_display_scb(adapter, scb);
2541 // Free our internal resources and call the mid-layer callback
2543 megaraid_mbox_sync_scb(adapter, scb);
2545 // remove from local clist
2546 list_del_init(&scb->list);
2548 // put back in free list
2549 megaraid_dealloc_scb(adapter, scb);
2551 // send the scsi packet back to kernel
2552 spin_lock(adapter->host_lock);
2553 scp->scsi_done(scp);
2554 spin_unlock(adapter->host_lock);
2562 * megaraid_abort_handler - abort the scsi command
2563 * @scp : command to be aborted
2565 * Abort a previous SCSI request. Only commands on the pending list can be
2566 * aborted. All the commands issued to the F/W must complete.
2569 __megaraid_abort_handler(struct scsi_cmnd *scp)
2572 mraid_device_t *raid_dev;
2576 unsigned long flags;
2580 adapter = SCP2ADAPTER(scp);
2581 raid_dev = ADAP2RAIDDEV(adapter);
2583 assert_spin_locked(adapter->host_lock);
2585 con_log(CL_ANN, (KERN_WARNING
2586 "megaraid: aborting-%ld cmd=%x <c=%d t=%d l=%d>\n",
2587 scp->serial_number, scp->cmnd[0], SCP2CHANNEL(scp),
2588 SCP2TARGET(scp), SCP2LUN(scp)));
2590 // If FW has stopped responding, simply return failure
2591 if (raid_dev->hw_error) {
2592 con_log(CL_ANN, (KERN_NOTICE
2593 "megaraid: hw error, not aborting\n"));
2597 // There might a race here, where the command was completed by the
2598 // firmware and now it is on the completed list. Before we could
2599 // complete the command to the kernel in dpc, the abort came.
2600 // Find out if this is the case to avoid the race.
2602 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2603 list_for_each_entry_safe(scb, tmp, &adapter->completed_list, list) {
2605 if (scb->scp == scp) { // Found command
2607 list_del_init(&scb->list); // from completed list
2609 con_log(CL_ANN, (KERN_WARNING
2610 "megaraid: %ld:%d[%d:%d], abort from completed list\n",
2611 scp->serial_number, scb->sno,
2612 scb->dev_channel, scb->dev_target));
2614 scp->result = (DID_ABORT << 16);
2615 scp->scsi_done(scp);
2617 megaraid_dealloc_scb(adapter, scb);
2619 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter),
2625 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2628 // Find out if this command is still on the pending list. If it is and
2629 // was never issued, abort and return success. If the command is owned
2630 // by the firmware, we must wait for it to complete by the FW.
2631 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2632 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2634 if (scb->scp == scp) { // Found command
2636 list_del_init(&scb->list); // from pending list
2638 ASSERT(!(scb->state & SCB_ISSUED));
2640 con_log(CL_ANN, (KERN_WARNING
2641 "megaraid abort: %ld[%d:%d], driver owner\n",
2642 scp->serial_number, scb->dev_channel,
2645 scp->result = (DID_ABORT << 16);
2646 scp->scsi_done(scp);
2648 megaraid_dealloc_scb(adapter, scb);
2650 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2656 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2659 // Check do we even own this command, in which case this would be
2660 // owned by the firmware. The only way to locate the FW scb is to
2661 // traverse through the list of all SCB, since driver does not
2662 // maintain these SCBs on any list
2664 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
2665 scb = adapter->kscb_list + i;
2667 if (scb->scp == scp) {
2671 if (!(scb->state & SCB_ISSUED)) {
2672 con_log(CL_ANN, (KERN_WARNING
2673 "megaraid abort: %ld%d[%d:%d], invalid state\n",
2674 scp->serial_number, scb->sno, scb->dev_channel,
2679 con_log(CL_ANN, (KERN_WARNING
2680 "megaraid abort: %ld:%d[%d:%d], fw owner\n",
2681 scp->serial_number, scb->sno, scb->dev_channel,
2688 con_log(CL_ANN, (KERN_WARNING
2689 "megaraid abort: scsi cmd:%ld, do now own\n",
2690 scp->serial_number));
2692 // FIXME: Should there be a callback for this command?
2696 // We cannot actually abort a command owned by firmware, return
2697 // failure and wait for reset. In host reset handler, we will find out
2698 // if the HBA is still live
2703 megaraid_abort_handler(struct scsi_cmnd *scp)
2708 adapter = SCP2ADAPTER(scp);
2710 spin_lock_irq(adapter->host_lock);
2711 rc = __megaraid_abort_handler(scp);
2712 spin_unlock_irq(adapter->host_lock);
2719 * megaraid_reset_handler - device reset hadler for mailbox based driver
2720 * @scp : reference command
2722 * Reset handler for the mailbox based controller. First try to find out if
2723 * the FW is still live, in which case the outstanding commands counter mut go
2724 * down to 0. If that happens, also issue the reservation reset command to
2725 * relinquish (possible) reservations on the logical drives connected to this
2729 __megaraid_reset_handler(struct scsi_cmnd *scp)
2734 mraid_device_t *raid_dev;
2735 unsigned long flags;
2736 uint8_t raw_mbox[sizeof(mbox_t)];
2738 int recovery_window;
2742 adapter = SCP2ADAPTER(scp);
2743 raid_dev = ADAP2RAIDDEV(adapter);
2745 assert_spin_locked(adapter->host_lock);
2747 con_log(CL_ANN, (KERN_WARNING "megaraid: reseting the host...\n"));
2749 // return failure if adapter is not responding
2750 if (raid_dev->hw_error) {
2751 con_log(CL_ANN, (KERN_NOTICE
2752 "megaraid: hw error, cannot reset\n"));
2757 // Under exceptional conditions, FW can take up to 3 minutes to
2758 // complete command processing. Wait for additional 2 minutes for the
2759 // pending commands counter to go down to 0. If it doesn't, let the
2760 // controller be marked offline
2761 // Also, reset all the commands currently owned by the driver
2762 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2763 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2765 list_del_init(&scb->list); // from pending list
2767 con_log(CL_ANN, (KERN_WARNING
2768 "megaraid: %ld:%d[%d:%d], reset from pending list\n",
2769 scp->serial_number, scb->sno,
2770 scb->dev_channel, scb->dev_target));
2772 scp->result = (DID_RESET << 16);
2773 scp->scsi_done(scp);
2775 megaraid_dealloc_scb(adapter, scb);
2777 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2779 if (adapter->outstanding_cmds) {
2780 con_log(CL_ANN, (KERN_NOTICE
2781 "megaraid: %d outstanding commands. Max wait %d sec\n",
2782 adapter->outstanding_cmds, MBOX_RESET_WAIT));
2785 spin_unlock(adapter->host_lock);
2787 recovery_window = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
2789 recovering = adapter->outstanding_cmds;
2791 for (i = 0; i < recovery_window && adapter->outstanding_cmds; i++) {
2793 megaraid_ack_sequence(adapter);
2795 // print a message once every 5 seconds only
2798 "megaraid mbox: Wait for %d commands to complete:%d\n",
2799 adapter->outstanding_cmds,
2800 MBOX_RESET_WAIT - i));
2803 // bailout if no recovery happended in reset time
2804 if ((i == MBOX_RESET_WAIT) &&
2805 (recovering == adapter->outstanding_cmds)) {
2812 spin_lock(adapter->host_lock);
2814 // If still outstanding commands, bail out
2815 if (adapter->outstanding_cmds) {
2816 con_log(CL_ANN, (KERN_WARNING
2817 "megaraid mbox: critical hardware error!\n"));
2819 raid_dev->hw_error = 1;
2824 con_log(CL_ANN, (KERN_NOTICE
2825 "megaraid mbox: reset sequence completed sucessfully\n"));
2829 // If the controller supports clustering, reset reservations
2830 if (!adapter->ha) return SUCCESS;
2832 // clear reservations if any
2833 raw_mbox[0] = CLUSTER_CMD;
2834 raw_mbox[2] = RESET_RESERVATIONS;
2837 if (mbox_post_sync_cmd_fast(adapter, raw_mbox) == 0) {
2839 (KERN_INFO "megaraid: reservation reset\n"));
2843 con_log(CL_ANN, (KERN_WARNING
2844 "megaraid: reservation reset failed\n"));
2851 megaraid_reset_handler(struct scsi_cmnd *cmd)
2855 spin_lock_irq(cmd->device->host->host_lock);
2856 rc = __megaraid_reset_handler(cmd);
2857 spin_unlock_irq(cmd->device->host->host_lock);
2864 * START: internal commands library
2866 * This section of the driver has the common routine used by the driver and
2867 * also has all the FW routines
2871 * mbox_post_sync_cmd() - blocking command to the mailbox based controllers
2872 * @adapter - controller's soft state
2873 * @raw_mbox - the mailbox
2875 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2879 mbox_post_sync_cmd(adapter_t *adapter, uint8_t raw_mbox[])
2881 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2888 mbox64 = raid_dev->mbox64;
2889 mbox = raid_dev->mbox;
2892 * Wait until mailbox is free
2894 if (megaraid_busywait_mbox(raid_dev) != 0)
2895 goto blocked_mailbox;
2898 * Copy mailbox data into host structure
2900 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
2905 mbox->numstatus = 0xFF;
2906 mbox->status = 0xFF;
2909 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2911 // wait for maximum 1 second for status to post. If the status is not
2912 // available within 1 second, assume FW is initializing and wait
2913 // for an extended amount of time
2914 if (mbox->numstatus == 0xFF) { // status not yet available
2917 for (i = 0; mbox->numstatus == 0xFF && i < 1000; i++) {
2924 con_log(CL_ANN, (KERN_NOTICE
2925 "megaraid mailbox: wait for FW to boot "));
2927 for (i = 0; (mbox->numstatus == 0xFF) &&
2928 (i < MBOX_RESET_WAIT); i++) {
2930 con_log(CL_ANN, ("\b\b\b\b\b[%03d]",
2931 MBOX_RESET_WAIT - i));
2935 if (i == MBOX_RESET_WAIT) {
2938 "\nmegaraid mailbox: status not available\n"));
2942 con_log(CL_ANN, ("\b\b\b\b\b[ok] \n"));
2946 // wait for maximum 1 second for poll semaphore
2947 if (mbox->poll != 0x77) {
2950 for (i = 0; (mbox->poll != 0x77) && (i < 1000); i++) {
2956 con_log(CL_ANN, (KERN_WARNING
2957 "megaraid mailbox: could not get poll semaphore\n"));
2962 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2965 // wait for maximum 1 second for acknowledgement
2966 if (RDINDOOR(raid_dev) & 0x2) {
2969 for (i = 0; (RDINDOOR(raid_dev) & 0x2) && (i < 1000); i++) {
2975 con_log(CL_ANN, (KERN_WARNING
2976 "megaraid mailbox: could not acknowledge\n"));
2983 status = mbox->status;
2985 // invalidate the completed command id array. After command
2986 // completion, firmware would write the valid id.
2987 mbox->numstatus = 0xFF;
2988 mbox->status = 0xFF;
2989 for (i = 0; i < MBOX_MAX_FIRMWARE_STATUS; i++) {
2990 mbox->completed[i] = 0xFF;
2997 con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n") );
3003 * mbox_post_sync_cmd_fast - blocking command to the mailbox based controllers
3004 * @adapter - controller's soft state
3005 * @raw_mbox - the mailbox
3007 * Issue a scb in synchronous and non-interrupt mode for mailbox based
3008 * controllers. This is a faster version of the synchronous command and
3009 * therefore can be called in interrupt-context as well
3012 mbox_post_sync_cmd_fast(adapter_t *adapter, uint8_t raw_mbox[])
3014 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3019 mbox = raid_dev->mbox;
3021 // return immediately if the mailbox is busy
3022 if (mbox->busy) return -1;
3024 // Copy mailbox data into host structure
3025 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 14);
3030 mbox->numstatus = 0xFF;
3031 mbox->status = 0xFF;
3034 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
3036 for (i = 0; i < 0xFFFFF; i++) {
3037 if (mbox->numstatus != 0xFF) break;
3041 // We may need to re-calibrate the counter
3042 con_log(CL_ANN, (KERN_CRIT
3043 "megaraid: fast sync command timed out\n"));
3046 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
3049 return mbox->status;
3054 * megaraid_busywait_mbox() - Wait until the controller's mailbox is available
3055 * @raid_dev - RAID device (HBA) soft state
3057 * wait until the controller's mailbox is available to accept more commands.
3058 * wait for at most 1 second
3061 megaraid_busywait_mbox(mraid_device_t *raid_dev)
3063 mbox_t *mbox = raid_dev->mbox;
3068 for (i = 0; mbox->busy && i < 1000; i++)
3072 if (i < 1000) return 0;
3078 * megaraid_mbox_product_info - some static information about the controller
3079 * @adapter - our soft state
3081 * issue commands to the controller to grab some parameters required by our
3085 megaraid_mbox_product_info(adapter_t *adapter)
3087 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3089 uint8_t raw_mbox[sizeof(mbox_t)];
3090 mraid_pinfo_t *pinfo;
3091 dma_addr_t pinfo_dma_h;
3092 mraid_inquiry3_t *mraid_inq3;
3096 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3097 mbox = (mbox_t *)raw_mbox;
3100 * Issue an ENQUIRY3 command to find out certain adapter parameters,
3101 * e.g., max channels, max commands etc.
3103 pinfo = pci_alloc_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3106 if (pinfo == NULL) {
3107 con_log(CL_ANN, (KERN_WARNING
3108 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3113 memset(pinfo, 0, sizeof(mraid_pinfo_t));
3115 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3116 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3118 raw_mbox[0] = FC_NEW_CONFIG;
3119 raw_mbox[2] = NC_SUBOP_ENQUIRY3;
3120 raw_mbox[3] = ENQ3_GET_SOLICITED_FULL;
3122 // Issue the command
3123 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3125 con_log(CL_ANN, (KERN_WARNING "megaraid: Inquiry3 failed\n"));
3127 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3128 pinfo, pinfo_dma_h);
3134 * Collect information about state of each physical drive
3135 * attached to the controller. We will expose all the disks
3136 * which are not part of RAID
3138 mraid_inq3 = (mraid_inquiry3_t *)adapter->ibuf;
3139 for (i = 0; i < MBOX_MAX_PHYSICAL_DRIVES; i++) {
3140 raid_dev->pdrv_state[i] = mraid_inq3->pdrv_state[i];
3144 * Get product info for information like number of channels,
3145 * maximum commands supported.
3147 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3148 mbox->xferaddr = (uint32_t)pinfo_dma_h;
3150 raw_mbox[0] = FC_NEW_CONFIG;
3151 raw_mbox[2] = NC_SUBOP_PRODUCT_INFO;
3153 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3155 con_log(CL_ANN, (KERN_WARNING
3156 "megaraid: product info failed\n"));
3158 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3159 pinfo, pinfo_dma_h);
3165 * Setup some parameters for host, as required by our caller
3167 adapter->max_channel = pinfo->nchannels;
3170 * we will export all the logical drives on a single channel.
3171 * Add 1 since inquires do not come for inititor ID
3173 adapter->max_target = MAX_LOGICAL_DRIVES_40LD + 1;
3174 adapter->max_lun = 8; // up to 8 LUNs for non-disk devices
3177 * These are the maximum outstanding commands for the scsi-layer
3179 adapter->max_cmds = MBOX_MAX_SCSI_CMDS;
3181 memset(adapter->fw_version, 0, VERSION_SIZE);
3182 memset(adapter->bios_version, 0, VERSION_SIZE);
3184 memcpy(adapter->fw_version, pinfo->fw_version, 4);
3185 adapter->fw_version[4] = 0;
3187 memcpy(adapter->bios_version, pinfo->bios_version, 4);
3188 adapter->bios_version[4] = 0;
3190 con_log(CL_ANN, (KERN_NOTICE
3191 "megaraid: fw version:[%s] bios version:[%s]\n",
3192 adapter->fw_version, adapter->bios_version));
3194 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t), pinfo,
3203 * megaraid_mbox_extended_cdb - check for support for extended CDBs
3204 * @adapter - soft state for the controller
3206 * this routine check whether the controller in question supports extended
3207 * ( > 10 bytes ) CDBs
3210 megaraid_mbox_extended_cdb(adapter_t *adapter)
3213 uint8_t raw_mbox[sizeof(mbox_t)];
3216 mbox = (mbox_t *)raw_mbox;
3218 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3219 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3221 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3223 raw_mbox[0] = MAIN_MISC_OPCODE;
3224 raw_mbox[2] = SUPPORT_EXT_CDB;
3230 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3239 * megaraid_mbox_support_ha - Do we support clustering
3240 * @adapter - soft state for the controller
3241 * @init_id - ID of the initiator
3243 * Determine if the firmware supports clustering and the ID of the initiator.
3246 megaraid_mbox_support_ha(adapter_t *adapter, uint16_t *init_id)
3249 uint8_t raw_mbox[sizeof(mbox_t)];
3253 mbox = (mbox_t *)raw_mbox;
3255 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3257 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3259 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3261 raw_mbox[0] = GET_TARGET_ID;
3263 // Issue the command
3266 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3268 *init_id = *(uint8_t *)adapter->ibuf;
3270 con_log(CL_ANN, (KERN_INFO
3271 "megaraid: cluster firmware, initiator ID: %d\n",
3282 * megaraid_mbox_support_random_del - Do we support random deletion
3283 * @adapter - soft state for the controller
3285 * Determine if the firmware supports random deletion
3286 * Return: 1 is operation supported, 0 otherwise
3289 megaraid_mbox_support_random_del(adapter_t *adapter)
3292 uint8_t raw_mbox[sizeof(mbox_t)];
3296 mbox = (mbox_t *)raw_mbox;
3298 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3300 raw_mbox[0] = FC_DEL_LOGDRV;
3301 raw_mbox[2] = OP_SUP_DEL_LOGDRV;
3303 // Issue the command
3305 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3307 con_log(CL_DLEVEL1, ("megaraid: supports random deletion\n"));
3317 * megaraid_mbox_get_max_sg - maximum sg elements supported by the firmware
3318 * @adapter - soft state for the controller
3320 * Find out the maximum number of scatter-gather elements supported by the
3324 megaraid_mbox_get_max_sg(adapter_t *adapter)
3327 uint8_t raw_mbox[sizeof(mbox_t)];
3331 mbox = (mbox_t *)raw_mbox;
3333 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3335 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3337 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3339 raw_mbox[0] = MAIN_MISC_OPCODE;
3340 raw_mbox[2] = GET_MAX_SG_SUPPORT;
3342 // Issue the command
3343 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3344 nsg = *(uint8_t *)adapter->ibuf;
3347 nsg = MBOX_DEFAULT_SG_SIZE;
3350 if (nsg > MBOX_MAX_SG_SIZE) nsg = MBOX_MAX_SG_SIZE;
3357 * megaraid_mbox_enum_raid_scsi - enumerate the RAID and SCSI channels
3358 * @adapter - soft state for the controller
3360 * Enumerate the RAID and SCSI channels for ROMB platoforms so that channels
3361 * can be exported as regular SCSI channels
3364 megaraid_mbox_enum_raid_scsi(adapter_t *adapter)
3366 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3368 uint8_t raw_mbox[sizeof(mbox_t)];
3371 mbox = (mbox_t *)raw_mbox;
3373 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3375 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3377 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3379 raw_mbox[0] = CHNL_CLASS;
3380 raw_mbox[2] = GET_CHNL_CLASS;
3382 // Issue the command. If the command fails, all channels are RAID
3384 raid_dev->channel_class = 0xFF;
3385 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3386 raid_dev->channel_class = *(uint8_t *)adapter->ibuf;
3394 * megaraid_mbox_flush_cache - flush adapter and disks cache
3395 * @param adapter : soft state for the controller
3397 * Flush adapter cache followed by disks cache
3400 megaraid_mbox_flush_cache(adapter_t *adapter)
3403 uint8_t raw_mbox[sizeof(mbox_t)];
3406 mbox = (mbox_t *)raw_mbox;
3408 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3410 raw_mbox[0] = FLUSH_ADAPTER;
3412 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3413 con_log(CL_ANN, ("megaraid: flush adapter failed\n"));
3416 raw_mbox[0] = FLUSH_SYSTEM;
3418 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3419 con_log(CL_ANN, ("megaraid: flush disks cache failed\n"));
3427 * megaraid_mbox_display_scb - display SCB information, mostly debug purposes
3428 * @param adapter : controllers' soft state
3429 * @param scb : SCB to be displayed
3430 * @param level : debug level for console print
3432 * Diplay information about the given SCB iff the current debug level is
3436 megaraid_mbox_display_scb(adapter_t *adapter, scb_t *scb)
3439 struct scsi_cmnd *scp;
3445 ccb = (mbox_ccb_t *)scb->ccb;
3451 con_log(level, (KERN_NOTICE
3452 "megaraid mailbox: status:%#x cmd:%#x id:%#x ", scb->status,
3453 mbox->cmd, scb->sno));
3455 con_log(level, ("sec:%#x lba:%#x addr:%#x ld:%d sg:%d\n",
3456 mbox->numsectors, mbox->lba, mbox->xferaddr, mbox->logdrv,
3461 con_log(level, (KERN_NOTICE "scsi cmnd: "));
3463 for (i = 0; i < scp->cmd_len; i++) {
3464 con_log(level, ("%#2.02x ", scp->cmnd[i]));
3467 con_log(level, ("\n"));
3474 * megaraid_mbox_setup_device_map - manage device ids
3475 * @adapter : Driver's soft state
3477 * Manange the device ids to have an appropraite mapping between the kernel
3478 * scsi addresses and megaraid scsi and logical drive addresses. We export
3479 * scsi devices on their actual addresses, whereas the logical drives are
3480 * exported on a virtual scsi channel.
3483 megaraid_mbox_setup_device_map(adapter_t *adapter)
3489 * First fill the values on the logical drive channel
3491 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3492 adapter->device_ids[adapter->max_channel][t] =
3493 (t < adapter->init_id) ? t : t - 1;
3495 adapter->device_ids[adapter->max_channel][adapter->init_id] = 0xFF;
3498 * Fill the values on the physical devices channels
3500 for (c = 0; c < adapter->max_channel; c++)
3501 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3502 adapter->device_ids[c][t] = (c << 8) | t;
3507 * END: internal commands library
3511 * START: Interface for the common management module
3513 * This is the module, which interfaces with the common mangement module to
3514 * provide support for ioctl and sysfs
3518 * megaraid_cmm_register - register with the mangement module
3519 * @param adapter : HBA soft state
3521 * Register with the management module, which allows applications to issue
3522 * ioctl calls to the drivers. This interface is used by the management module
3523 * to setup sysfs support as well.
3526 megaraid_cmm_register(adapter_t *adapter)
3528 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3535 // Allocate memory for the base list of scb for management module.
3536 adapter->uscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_USER_CMDS,
3539 if (adapter->uscb_list == NULL) {
3540 con_log(CL_ANN, (KERN_WARNING
3541 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3545 memset(adapter->uscb_list, 0, sizeof(scb_t) * MBOX_MAX_USER_CMDS);
3548 // Initialize the synchronization parameters for resources for
3549 // commands for management module
3550 INIT_LIST_HEAD(&adapter->uscb_pool);
3552 spin_lock_init(USER_FREE_LIST_LOCK(adapter));
3556 // link all the packets. Note, CCB for commands, coming from the
3557 // commom management module, mailbox physical address are already
3558 // setup by it. We just need placeholder for that in our local command
3560 for (i = 0; i < MBOX_MAX_USER_CMDS; i++) {
3562 scb = adapter->uscb_list + i;
3563 ccb = raid_dev->uccb_list + i;
3565 scb->ccb = (caddr_t)ccb;
3566 ccb->mbox64 = raid_dev->umbox64 + i;
3567 ccb->mbox = &ccb->mbox64->mbox32;
3568 ccb->raw_mbox = (uint8_t *)ccb->mbox;
3572 // COMMAND ID 0 - (MBOX_MAX_SCSI_CMDS-1) ARE RESERVED FOR
3573 // COMMANDS COMING FROM IO SUBSYSTEM (MID-LAYER)
3574 scb->sno = i + MBOX_MAX_SCSI_CMDS;
3577 scb->state = SCB_FREE;
3578 scb->dma_direction = PCI_DMA_NONE;
3579 scb->dma_type = MRAID_DMA_NONE;
3580 scb->dev_channel = -1;
3581 scb->dev_target = -1;
3583 // put scb in the free pool
3584 list_add_tail(&scb->list, &adapter->uscb_pool);
3587 adp.unique_id = adapter->unique_id;
3588 adp.drvr_type = DRVRTYPE_MBOX;
3589 adp.drvr_data = (unsigned long)adapter;
3590 adp.pdev = adapter->pdev;
3591 adp.issue_uioc = megaraid_mbox_mm_handler;
3593 adp.max_kioc = MBOX_MAX_USER_CMDS;
3595 if ((rval = mraid_mm_register_adp(&adp)) != 0) {
3597 con_log(CL_ANN, (KERN_WARNING
3598 "megaraid mbox: did not register with CMM\n"));
3600 kfree(adapter->uscb_list);
3608 * megaraid_cmm_unregister - un-register with the mangement module
3609 * @param adapter : HBA soft state
3611 * Un-register with the management module.
3612 * FIXME: mgmt module must return failure for unregister if it has pending
3616 megaraid_cmm_unregister(adapter_t *adapter)
3618 kfree(adapter->uscb_list);
3619 mraid_mm_unregister_adp(adapter->unique_id);
3625 * megaraid_mbox_mm_handler - interface for CMM to issue commands to LLD
3626 * @param drvr_data : LLD specific data
3627 * @param kioc : CMM interface packet
3628 * @param action : command action
3630 * This routine is invoked whenever the Common Mangement Module (CMM) has a
3631 * command for us. The 'action' parameter specifies if this is a new command
3635 megaraid_mbox_mm_handler(unsigned long drvr_data, uioc_t *kioc, uint32_t action)
3639 if (action != IOCTL_ISSUE) {
3640 con_log(CL_ANN, (KERN_WARNING
3641 "megaraid: unsupported management action:%#2x\n",
3646 adapter = (adapter_t *)drvr_data;
3648 // make sure this adapter is not being detached right now.
3649 if (atomic_read(&adapter->being_detached)) {
3650 con_log(CL_ANN, (KERN_WARNING
3651 "megaraid: reject management request, detaching\n"));
3655 switch (kioc->opcode) {
3659 kioc->status = gather_hbainfo(adapter, (mraid_hba_info_t *)
3660 (unsigned long)kioc->buf_vaddr);
3664 return kioc->status;
3668 return megaraid_mbox_mm_command(adapter, kioc);
3671 kioc->status = (-EINVAL);
3676 return 0; // not reached
3680 * megaraid_mbox_mm_command - issues commands routed through CMM
3681 * @param adapter : HBA soft state
3682 * @param kioc : management command packet
3684 * Issues commands, which are routed through the management module.
3687 megaraid_mbox_mm_command(adapter_t *adapter, uioc_t *kioc)
3689 struct list_head *head = &adapter->uscb_pool;
3694 unsigned long flags;
3696 // detach one scb from free pool
3697 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3699 if (list_empty(head)) { // should never happen because of CMM
3701 con_log(CL_ANN, (KERN_WARNING
3702 "megaraid mbox: bug in cmm handler, lost resources\n"));
3704 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3709 scb = list_entry(head->next, scb_t, list);
3710 list_del_init(&scb->list);
3712 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3714 scb->state = SCB_ACTIVE;
3715 scb->dma_type = MRAID_DMA_NONE;
3716 scb->dma_direction = PCI_DMA_NONE;
3718 ccb = (mbox_ccb_t *)scb->ccb;
3719 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3720 raw_mbox = (uint8_t *)&mbox64->mbox32;
3722 memcpy(ccb->mbox64, mbox64, sizeof(mbox64_t));
3724 scb->gp = (unsigned long)kioc;
3727 * If it is a logdrv random delete operation, we have to wait till
3728 * there are no outstanding cmds at the fw and then issue it directly
3730 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3732 if (wait_till_fw_empty(adapter)) {
3733 con_log(CL_ANN, (KERN_NOTICE
3734 "megaraid mbox: LD delete, timed out\n"));
3736 kioc->status = -ETIME;
3740 megaraid_mbox_mm_done(adapter, scb);
3745 INIT_LIST_HEAD(&scb->list);
3747 scb->state = SCB_ISSUED;
3748 if (mbox_post_cmd(adapter, scb) != 0) {
3750 con_log(CL_ANN, (KERN_NOTICE
3751 "megaraid mbox: LD delete, mailbox busy\n"));
3753 kioc->status = -EBUSY;
3757 megaraid_mbox_mm_done(adapter, scb);
3765 // put the command on the pending list and execute
3766 megaraid_mbox_runpendq(adapter, scb);
3773 wait_till_fw_empty(adapter_t *adapter)
3775 unsigned long flags = 0;
3780 * Set the quiescent flag to stop issuing cmds to FW.
3782 spin_lock_irqsave(adapter->host_lock, flags);
3783 adapter->quiescent++;
3784 spin_unlock_irqrestore(adapter->host_lock, flags);
3787 * Wait till there are no more cmds outstanding at FW. Try for at most
3790 for (i = 0; i < 60 && adapter->outstanding_cmds; i++) {
3791 con_log(CL_DLEVEL1, (KERN_INFO
3792 "megaraid: FW has %d pending commands\n",
3793 adapter->outstanding_cmds));
3798 return adapter->outstanding_cmds;
3803 * megaraid_mbox_mm_done - callback for CMM commands
3804 * @adapter : HBA soft state
3805 * @scb : completed command
3807 * Callback routine for internal commands originated from the management
3811 megaraid_mbox_mm_done(adapter_t *adapter, scb_t *scb)
3816 unsigned long flags;
3818 kioc = (uioc_t *)scb->gp;
3820 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3821 mbox64->mbox32.status = scb->status;
3822 raw_mbox = (uint8_t *)&mbox64->mbox32;
3825 // put scb in the free pool
3826 scb->state = SCB_FREE;
3829 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3831 list_add(&scb->list, &adapter->uscb_pool);
3833 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3835 // if a delete logical drive operation succeeded, restart the
3837 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3839 adapter->quiescent--;
3841 megaraid_mbox_runpendq(adapter, NULL);
3851 * gather_hbainfo - HBA characteristics for the applications
3852 * @param adapter : HBA soft state
3853 * @param hinfo : pointer to the caller's host info strucuture
3856 gather_hbainfo(adapter_t *adapter, mraid_hba_info_t *hinfo)
3860 dmajor = megaraid_mbox_version[0];
3862 hinfo->pci_vendor_id = adapter->pdev->vendor;
3863 hinfo->pci_device_id = adapter->pdev->device;
3864 hinfo->subsys_vendor_id = adapter->pdev->subsystem_vendor;
3865 hinfo->subsys_device_id = adapter->pdev->subsystem_device;
3867 hinfo->pci_bus = adapter->pdev->bus->number;
3868 hinfo->pci_dev_fn = adapter->pdev->devfn;
3869 hinfo->pci_slot = PCI_SLOT(adapter->pdev->devfn);
3870 hinfo->irq = adapter->host->irq;
3871 hinfo->baseport = ADAP2RAIDDEV(adapter)->baseport;
3873 hinfo->unique_id = (hinfo->pci_bus << 8) | adapter->pdev->devfn;
3874 hinfo->host_no = adapter->host->host_no;
3880 * END: Interface for the common management module
3886 * megaraid_sysfs_alloc_resources - allocate sysfs related resources
3888 * Allocate packets required to issue FW calls whenever the sysfs attributes
3889 * are read. These attributes would require up-to-date information from the
3890 * FW. Also set up resources for mutual exclusion to share these resources and
3893 * @param adapter : controller's soft state
3895 * @return 0 on success
3896 * @return -ERROR_CODE on failure
3899 megaraid_sysfs_alloc_resources(adapter_t *adapter)
3901 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3904 raid_dev->sysfs_uioc = kmalloc(sizeof(uioc_t), GFP_KERNEL);
3906 raid_dev->sysfs_mbox64 = kmalloc(sizeof(mbox64_t), GFP_KERNEL);
3908 raid_dev->sysfs_buffer = pci_alloc_consistent(adapter->pdev,
3909 PAGE_SIZE, &raid_dev->sysfs_buffer_dma);
3911 if (!raid_dev->sysfs_uioc || !raid_dev->sysfs_mbox64 ||
3912 !raid_dev->sysfs_buffer) {
3914 con_log(CL_ANN, (KERN_WARNING
3915 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3920 megaraid_sysfs_free_resources(adapter);
3923 sema_init(&raid_dev->sysfs_sem, 1);
3925 init_waitqueue_head(&raid_dev->sysfs_wait_q);
3932 * megaraid_sysfs_free_resources - free sysfs related resources
3934 * Free packets allocated for sysfs FW commands
3936 * @param adapter : controller's soft state
3939 megaraid_sysfs_free_resources(adapter_t *adapter)
3941 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3943 if (raid_dev->sysfs_uioc) kfree(raid_dev->sysfs_uioc);
3945 if (raid_dev->sysfs_mbox64) kfree(raid_dev->sysfs_mbox64);
3947 if (raid_dev->sysfs_buffer) {
3948 pci_free_consistent(adapter->pdev, PAGE_SIZE,
3949 raid_dev->sysfs_buffer, raid_dev->sysfs_buffer_dma);
3955 * megaraid_sysfs_get_ldmap_done - callback for get ldmap
3957 * Callback routine called in the ISR/tasklet context for get ldmap call
3959 * @param uioc : completed packet
3962 megaraid_sysfs_get_ldmap_done(uioc_t *uioc)
3964 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3965 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3969 wake_up(&raid_dev->sysfs_wait_q);
3974 * megaraid_sysfs_get_ldmap_timeout - timeout handling for get ldmap
3976 * Timeout routine to recover and return to application, in case the adapter
3977 * has stopped responding. A timeout of 60 seconds for this command seem like
3980 * @param uioc : timed out packet
3983 megaraid_sysfs_get_ldmap_timeout(unsigned long data)
3985 uioc_t *uioc = (uioc_t *)data;
3986 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3987 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3989 uioc->status = -ETIME;
3991 wake_up(&raid_dev->sysfs_wait_q);
3996 * megaraid_sysfs_get_ldmap - get update logical drive map
3998 * This routine will be called whenever user reads the logical drive
3999 * attributes, go get the current logical drive mapping table from the
4000 * firmware. We use the managment API's to issue commands to the controller.
4002 * NOTE: The commands issuance functionality is not generalized and
4003 * implemented in context of "get ld map" command only. If required, the
4004 * command issuance logical can be trivially pulled out and implemented as a
4005 * standalone libary. For now, this should suffice since there is no other
4006 * user of this interface.
4008 * @param adapter : controller's soft state
4010 * @return 0 on success
4011 * @return -1 on failure
4014 megaraid_sysfs_get_ldmap(adapter_t *adapter)
4016 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4021 struct timer_list sysfs_timer;
4022 struct timer_list *timerp;
4027 * Allow only one read at a time to go through the sysfs attributes
4029 down(&raid_dev->sysfs_sem);
4031 uioc = raid_dev->sysfs_uioc;
4032 mbox64 = raid_dev->sysfs_mbox64;
4033 ldmap = raid_dev->sysfs_buffer;
4035 memset(uioc, 0, sizeof(uioc_t));
4036 memset(mbox64, 0, sizeof(mbox64_t));
4037 memset(ldmap, 0, sizeof(raid_dev->curr_ldmap));
4039 mbox = &mbox64->mbox32;
4040 raw_mbox = (char *)mbox;
4041 uioc->cmdbuf = (uint64_t)(unsigned long)mbox64;
4042 uioc->buf_vaddr = (caddr_t)adapter;
4043 uioc->status = -ENODATA;
4044 uioc->done = megaraid_sysfs_get_ldmap_done;
4047 * Prepare the mailbox packet to get the current logical drive mapping
4050 mbox->xferaddr = (uint32_t)raid_dev->sysfs_buffer_dma;
4052 raw_mbox[0] = FC_DEL_LOGDRV;
4053 raw_mbox[2] = OP_GET_LDID_MAP;
4056 * Setup a timer to recover from a non-responding controller
4058 timerp = &sysfs_timer;
4061 timerp->function = megaraid_sysfs_get_ldmap_timeout;
4062 timerp->data = (unsigned long)uioc;
4063 timerp->expires = jiffies + 60 * HZ;
4068 * Send the command to the firmware
4070 rval = megaraid_mbox_mm_command(adapter, uioc);
4072 if (rval == 0) { // command successfully issued
4073 wait_event(raid_dev->sysfs_wait_q, (uioc->status != -ENODATA));
4076 * Check if the command timed out
4078 if (uioc->status == -ETIME) {
4079 con_log(CL_ANN, (KERN_NOTICE
4080 "megaraid: sysfs get ld map timed out\n"));
4085 rval = mbox->status;
4089 memcpy(raid_dev->curr_ldmap, ldmap,
4090 sizeof(raid_dev->curr_ldmap));
4093 con_log(CL_ANN, (KERN_NOTICE
4094 "megaraid: get ld map failed with %x\n", rval));
4098 con_log(CL_ANN, (KERN_NOTICE
4099 "megaraid: could not issue ldmap command:%x\n", rval));
4103 del_timer_sync(timerp);
4105 up(&raid_dev->sysfs_sem);
4112 * megaraid_sysfs_show_app_hndl - display application handle for this adapter
4114 * Display the handle used by the applications while executing management
4115 * tasks on the adapter. We invoke a management module API to get the adapter
4116 * handle, since we do not interface with applications directly.
4118 * @param cdev : class device object representation for the host
4119 * @param buf : buffer to send data to
4122 megaraid_sysfs_show_app_hndl(struct class_device *cdev, char *buf)
4124 struct Scsi_Host *shost = class_to_shost(cdev);
4125 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(shost);
4128 app_hndl = mraid_mm_adapter_app_handle(adapter->unique_id);
4130 return snprintf(buf, 8, "%u\n", app_hndl);
4135 * megaraid_sysfs_show_ldnum - display the logical drive number for this device
4137 * Display the logical drive number for the device in question, if it a valid
4138 * logical drive. For physical devices, "-1" is returned
4139 * The logical drive number is displayed in following format
4141 * <SCSI ID> <LD NUM> <LD STICKY ID> <APP ADAPTER HANDLE>
4142 * <int> <int> <int> <int>
4144 * @param dev : device object representation for the scsi device
4145 * @param buf : buffer to send data to
4148 megaraid_sysfs_show_ldnum(struct device *dev, struct device_attribute *attr, char *buf)
4150 struct scsi_device *sdev = to_scsi_device(dev);
4151 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(sdev->host);
4152 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4154 int logical_drv = -1;
4156 uint32_t app_hndl = 0;
4161 if (raid_dev->random_del_supported &&
4162 MRAID_IS_LOGICAL_SDEV(adapter, sdev)) {
4164 rval = megaraid_sysfs_get_ldmap(adapter);
4167 for (i = 0; i < MAX_LOGICAL_DRIVES_40LD; i++) {
4169 mapped_sdev_id = sdev->id;
4171 if (sdev->id > adapter->init_id) {
4172 mapped_sdev_id -= 1;
4175 if (raid_dev->curr_ldmap[i] == mapped_sdev_id) {
4181 ldid_map = raid_dev->curr_ldmap[i];
4183 app_hndl = mraid_mm_adapter_app_handle(
4184 adapter->unique_id);
4191 con_log(CL_ANN, (KERN_NOTICE
4192 "megaraid: sysfs get ld map failed: %x\n",
4197 return snprintf(buf, 36, "%d %d %d %d\n", scsi_id, logical_drv,
4198 ldid_map, app_hndl);
4203 * END: Mailbox Low Level Driver
4205 module_init(megaraid_init);
4206 module_exit(megaraid_exit);
4208 /* vim: set ts=8 sw=8 tw=78 ai si: */