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.7 (Nov 14 2005)
16 * Atul Mukker <Atul.Mukker@lsil.com>
17 * Sreenivas Bagalkote <Sreenivas.Bagalkote@lsil.com>
18 * Manoj Jose <Manoj.Jose@lsil.com>
19 * Seokmann Ju <Seokmann.Ju@lsil.com>
21 * List of supported controllers
23 * OEM Product Name VID DID SSVID SSID
24 * --- ------------ --- --- ---- ----
25 * Dell PERC3/QC 101E 1960 1028 0471
26 * Dell PERC3/DC 101E 1960 1028 0493
27 * Dell PERC3/SC 101E 1960 1028 0475
28 * Dell PERC3/Di 1028 1960 1028 0123
29 * Dell PERC4/SC 1000 1960 1028 0520
30 * Dell PERC4/DC 1000 1960 1028 0518
31 * Dell PERC4/QC 1000 0407 1028 0531
32 * Dell PERC4/Di 1028 000F 1028 014A
33 * Dell PERC 4e/Si 1028 0013 1028 016c
34 * Dell PERC 4e/Di 1028 0013 1028 016d
35 * Dell PERC 4e/Di 1028 0013 1028 016e
36 * Dell PERC 4e/Di 1028 0013 1028 016f
37 * Dell PERC 4e/Di 1028 0013 1028 0170
38 * Dell PERC 4e/DC 1000 0408 1028 0002
39 * Dell PERC 4e/SC 1000 0408 1028 0001
42 * LSI MegaRAID SCSI 320-0 1000 1960 1000 A520
43 * LSI MegaRAID SCSI 320-1 1000 1960 1000 0520
44 * LSI MegaRAID SCSI 320-2 1000 1960 1000 0518
45 * LSI MegaRAID SCSI 320-0X 1000 0407 1000 0530
46 * LSI MegaRAID SCSI 320-2X 1000 0407 1000 0532
47 * LSI MegaRAID SCSI 320-4X 1000 0407 1000 0531
48 * LSI MegaRAID SCSI 320-1E 1000 0408 1000 0001
49 * LSI MegaRAID SCSI 320-2E 1000 0408 1000 0002
50 * LSI MegaRAID SATA 150-4 1000 1960 1000 4523
51 * LSI MegaRAID SATA 150-6 1000 1960 1000 0523
52 * LSI MegaRAID SATA 300-4X 1000 0409 1000 3004
53 * LSI MegaRAID SATA 300-8X 1000 0409 1000 3008
55 * INTEL RAID Controller SRCU42X 1000 0407 8086 0532
56 * INTEL RAID Controller SRCS16 1000 1960 8086 0523
57 * INTEL RAID Controller SRCU42E 1000 0408 8086 0002
58 * INTEL RAID Controller SRCZCRX 1000 0407 8086 0530
59 * INTEL RAID Controller SRCS28X 1000 0409 8086 3008
60 * INTEL RAID Controller SROMBU42E 1000 0408 8086 3431
61 * INTEL RAID Controller SROMBU42E 1000 0408 8086 3499
62 * INTEL RAID Controller SRCU51L 1000 1960 8086 0520
64 * FSC MegaRAID PCI Express ROMB 1000 0408 1734 1065
66 * ACER MegaRAID ROMB-2E 1000 0408 1025 004D
68 * NEC MegaRAID PCI Express ROMB 1000 0408 1033 8287
70 * For history of changes, see Documentation/ChangeLog.megaraid
73 #include "megaraid_mbox.h"
75 static int megaraid_init(void);
76 static void megaraid_exit(void);
78 static int megaraid_probe_one(struct pci_dev*, const struct pci_device_id *);
79 static void megaraid_detach_one(struct pci_dev *);
80 static void megaraid_mbox_shutdown(struct pci_dev *);
82 static int megaraid_io_attach(adapter_t *);
83 static void megaraid_io_detach(adapter_t *);
85 static int megaraid_init_mbox(adapter_t *);
86 static void megaraid_fini_mbox(adapter_t *);
88 static int megaraid_alloc_cmd_packets(adapter_t *);
89 static void megaraid_free_cmd_packets(adapter_t *);
91 static int megaraid_mbox_setup_dma_pools(adapter_t *);
92 static void megaraid_mbox_teardown_dma_pools(adapter_t *);
94 static int megaraid_sysfs_alloc_resources(adapter_t *);
95 static void megaraid_sysfs_free_resources(adapter_t *);
97 static int megaraid_abort_handler(struct scsi_cmnd *);
98 static int megaraid_reset_handler(struct scsi_cmnd *);
100 static int mbox_post_sync_cmd(adapter_t *, uint8_t []);
101 static int mbox_post_sync_cmd_fast(adapter_t *, uint8_t []);
102 static int megaraid_busywait_mbox(mraid_device_t *);
103 static int megaraid_mbox_product_info(adapter_t *);
104 static int megaraid_mbox_extended_cdb(adapter_t *);
105 static int megaraid_mbox_support_ha(adapter_t *, uint16_t *);
106 static int megaraid_mbox_support_random_del(adapter_t *);
107 static int megaraid_mbox_get_max_sg(adapter_t *);
108 static void megaraid_mbox_enum_raid_scsi(adapter_t *);
109 static void megaraid_mbox_flush_cache(adapter_t *);
111 static void megaraid_mbox_display_scb(adapter_t *, scb_t *);
112 static void megaraid_mbox_setup_device_map(adapter_t *);
114 static int megaraid_queue_command(struct scsi_cmnd *,
115 void (*)(struct scsi_cmnd *));
116 static scb_t *megaraid_mbox_build_cmd(adapter_t *, struct scsi_cmnd *, int *);
117 static void megaraid_mbox_runpendq(adapter_t *, scb_t *);
118 static void megaraid_mbox_prepare_pthru(adapter_t *, scb_t *,
120 static void megaraid_mbox_prepare_epthru(adapter_t *, scb_t *,
123 static irqreturn_t megaraid_isr(int, void *, struct pt_regs *);
125 static void megaraid_mbox_dpc(unsigned long);
127 static ssize_t megaraid_sysfs_show_app_hndl(struct class_device *, char *);
128 static ssize_t megaraid_sysfs_show_ldnum(struct device *, struct device_attribute *attr, char *);
130 static int megaraid_cmm_register(adapter_t *);
131 static int megaraid_cmm_unregister(adapter_t *);
132 static int megaraid_mbox_mm_handler(unsigned long, uioc_t *, uint32_t);
133 static int megaraid_mbox_mm_command(adapter_t *, uioc_t *);
134 static void megaraid_mbox_mm_done(adapter_t *, scb_t *);
135 static int gather_hbainfo(adapter_t *, mraid_hba_info_t *);
136 static int wait_till_fw_empty(adapter_t *);
140 MODULE_AUTHOR("sju@lsil.com");
141 MODULE_DESCRIPTION("LSI Logic MegaRAID Mailbox Driver");
142 MODULE_LICENSE("GPL");
143 MODULE_VERSION(MEGARAID_VERSION);
146 * ### modules parameters for driver ###
150 * Set to enable driver to expose unconfigured disk to kernel
152 static int megaraid_expose_unconf_disks = 0;
153 module_param_named(unconf_disks, megaraid_expose_unconf_disks, int, 0);
154 MODULE_PARM_DESC(unconf_disks,
155 "Set to expose unconfigured disks to kernel (default=0)");
158 * driver wait time if the adapter's mailbox is busy
160 static unsigned int max_mbox_busy_wait = MBOX_BUSY_WAIT;
161 module_param_named(busy_wait, max_mbox_busy_wait, int, 0);
162 MODULE_PARM_DESC(busy_wait,
163 "Max wait for mailbox in microseconds if busy (default=10)");
166 * number of sectors per IO command
168 static unsigned int megaraid_max_sectors = MBOX_MAX_SECTORS;
169 module_param_named(max_sectors, megaraid_max_sectors, int, 0);
170 MODULE_PARM_DESC(max_sectors,
171 "Maximum number of sectors per IO command (default=128)");
174 * number of commands per logical unit
176 static unsigned int megaraid_cmd_per_lun = MBOX_DEF_CMD_PER_LUN;
177 module_param_named(cmd_per_lun, megaraid_cmd_per_lun, int, 0);
178 MODULE_PARM_DESC(cmd_per_lun,
179 "Maximum number of commands per logical unit (default=64)");
183 * Fast driver load option, skip scanning for physical devices during load.
184 * This would result in non-disk devices being skipped during driver load
185 * time. These can be later added though, using /proc/scsi/scsi
187 static unsigned int megaraid_fast_load = 0;
188 module_param_named(fast_load, megaraid_fast_load, int, 0);
189 MODULE_PARM_DESC(fast_load,
190 "Faster loading of the driver, skips physical devices! (default=0)");
194 * mraid_debug level - threshold for amount of information to be displayed by
195 * the driver. This level can be changed through modules parameters, ioctl or
196 * sysfs/proc interface. By default, print the announcement messages only.
198 int mraid_debug_level = CL_ANN;
199 module_param_named(debug_level, mraid_debug_level, int, 0);
200 MODULE_PARM_DESC(debug_level, "Debug level for driver (default=0)");
203 * ### global data ###
205 static uint8_t megaraid_mbox_version[8] =
206 { 0x02, 0x20, 0x04, 0x06, 3, 7, 20, 5 };
210 * PCI table for all supported controllers.
212 static struct pci_device_id pci_id_table_g[] = {
215 PCI_DEVICE_ID_PERC4_DI_DISCOVERY,
217 PCI_SUBSYS_ID_PERC4_DI_DISCOVERY,
220 PCI_VENDOR_ID_LSI_LOGIC,
221 PCI_DEVICE_ID_PERC4_SC,
223 PCI_SUBSYS_ID_PERC4_SC,
226 PCI_VENDOR_ID_LSI_LOGIC,
227 PCI_DEVICE_ID_PERC4_DC,
229 PCI_SUBSYS_ID_PERC4_DC,
232 PCI_VENDOR_ID_LSI_LOGIC,
239 PCI_DEVICE_ID_PERC4_DI_EVERGLADES,
241 PCI_SUBSYS_ID_PERC4_DI_EVERGLADES,
245 PCI_DEVICE_ID_PERC4E_SI_BIGBEND,
247 PCI_SUBSYS_ID_PERC4E_SI_BIGBEND,
251 PCI_DEVICE_ID_PERC4E_DI_KOBUK,
253 PCI_SUBSYS_ID_PERC4E_DI_KOBUK,
257 PCI_DEVICE_ID_PERC4E_DI_CORVETTE,
259 PCI_SUBSYS_ID_PERC4E_DI_CORVETTE,
263 PCI_DEVICE_ID_PERC4E_DI_EXPEDITION,
265 PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION,
269 PCI_DEVICE_ID_PERC4E_DI_GUADALUPE,
271 PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE,
274 PCI_VENDOR_ID_LSI_LOGIC,
275 PCI_DEVICE_ID_DOBSON,
281 PCI_DEVICE_ID_AMI_MEGARAID3,
286 PCI_VENDOR_ID_LSI_LOGIC,
287 PCI_DEVICE_ID_AMI_MEGARAID3,
292 PCI_VENDOR_ID_LSI_LOGIC,
293 PCI_DEVICE_ID_LINDSAY,
297 {0} /* Terminating entry */
299 MODULE_DEVICE_TABLE(pci, pci_id_table_g);
302 static struct pci_driver megaraid_pci_driver_g = {
304 .id_table = pci_id_table_g,
305 .probe = megaraid_probe_one,
306 .remove = __devexit_p(megaraid_detach_one),
307 .shutdown = megaraid_mbox_shutdown,
312 // definitions for the device attributes for exporting logical drive number
313 // for a scsi address (Host, Channel, Id, Lun)
315 CLASS_DEVICE_ATTR(megaraid_mbox_app_hndl, S_IRUSR, megaraid_sysfs_show_app_hndl,
318 // Host template initializer for megaraid mbox sysfs device attributes
319 static struct class_device_attribute *megaraid_shost_attrs[] = {
320 &class_device_attr_megaraid_mbox_app_hndl,
325 DEVICE_ATTR(megaraid_mbox_ld, S_IRUSR, megaraid_sysfs_show_ldnum, NULL);
327 // Host template initializer for megaraid mbox sysfs device attributes
328 static struct device_attribute *megaraid_sdev_attrs[] = {
329 &dev_attr_megaraid_mbox_ld,
335 * Scsi host template for megaraid unified driver
337 static struct scsi_host_template megaraid_template_g = {
338 .module = THIS_MODULE,
339 .name = "LSI Logic MegaRAID driver",
340 .proc_name = "megaraid",
341 .queuecommand = megaraid_queue_command,
342 .eh_abort_handler = megaraid_abort_handler,
343 .eh_device_reset_handler = megaraid_reset_handler,
344 .eh_bus_reset_handler = megaraid_reset_handler,
345 .eh_host_reset_handler = megaraid_reset_handler,
346 .use_clustering = ENABLE_CLUSTERING,
347 .sdev_attrs = megaraid_sdev_attrs,
348 .shost_attrs = megaraid_shost_attrs,
353 * megaraid_init - module load hook
355 * We register ourselves as hotplug enabled module and let PCI subsystem
356 * discover our adaters
363 // Announce the driver version
364 con_log(CL_ANN, (KERN_INFO "megaraid: %s %s\n", MEGARAID_VERSION,
365 MEGARAID_EXT_VERSION));
367 // check validity of module parameters
368 if (megaraid_cmd_per_lun > MBOX_MAX_SCSI_CMDS) {
370 con_log(CL_ANN, (KERN_WARNING
371 "megaraid mailbox: max commands per lun reset to %d\n",
372 MBOX_MAX_SCSI_CMDS));
374 megaraid_cmd_per_lun = MBOX_MAX_SCSI_CMDS;
378 // register as a PCI hot-plug driver module
379 rval = pci_register_driver(&megaraid_pci_driver_g);
381 con_log(CL_ANN, (KERN_WARNING
382 "megaraid: could not register hotplug support.\n"));
390 * megaraid_exit - driver unload entry point
392 * We simply unwrap the megaraid_init routine here
397 con_log(CL_DLEVEL1, (KERN_NOTICE "megaraid: unloading framework\n"));
399 // unregister as PCI hotplug driver
400 pci_unregister_driver(&megaraid_pci_driver_g);
407 * megaraid_probe_one - PCI hotplug entry point
408 * @param pdev : handle to this controller's PCI configuration space
409 * @param id : pci device id of the class of controllers
411 * This routine should be called whenever a new adapter is detected by the
412 * PCI hotplug susbsytem.
415 megaraid_probe_one(struct pci_dev *pdev, const struct pci_device_id *id)
420 // detected a new controller
421 con_log(CL_ANN, (KERN_INFO
422 "megaraid: probe new device %#4.04x:%#4.04x:%#4.04x:%#4.04x: ",
423 pdev->vendor, pdev->device, pdev->subsystem_vendor,
424 pdev->subsystem_device));
426 con_log(CL_ANN, ("bus %d:slot %d:func %d\n", pdev->bus->number,
427 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn)));
429 if (pci_enable_device(pdev)) {
430 con_log(CL_ANN, (KERN_WARNING
431 "megaraid: pci_enable_device failed\n"));
436 // Enable bus-mastering on this controller
437 pci_set_master(pdev);
439 // Allocate the per driver initialization structure
440 adapter = kmalloc(sizeof(adapter_t), GFP_KERNEL);
442 if (adapter == NULL) {
443 con_log(CL_ANN, (KERN_WARNING
444 "megaraid: out of memory, %s %d.\n", __FUNCTION__, __LINE__));
448 memset(adapter, 0, sizeof(adapter_t));
451 // set up PCI related soft state and other pre-known parameters
452 adapter->unique_id = pdev->bus->number << 8 | pdev->devfn;
453 adapter->irq = pdev->irq;
454 adapter->pdev = pdev;
456 atomic_set(&adapter->being_detached, 0);
458 // Setup the default DMA mask. This would be changed later on
459 // depending on hardware capabilities
460 if (pci_set_dma_mask(adapter->pdev, DMA_32BIT_MASK) != 0) {
462 con_log(CL_ANN, (KERN_WARNING
463 "megaraid: pci_set_dma_mask failed:%d\n", __LINE__));
465 goto out_free_adapter;
469 // Initialize the synchronization lock for kernel and LLD
470 spin_lock_init(&adapter->lock);
472 // Initialize the command queues: the list of free SCBs and the list
474 INIT_LIST_HEAD(&adapter->kscb_pool);
475 spin_lock_init(SCSI_FREE_LIST_LOCK(adapter));
477 INIT_LIST_HEAD(&adapter->pend_list);
478 spin_lock_init(PENDING_LIST_LOCK(adapter));
480 INIT_LIST_HEAD(&adapter->completed_list);
481 spin_lock_init(COMPLETED_LIST_LOCK(adapter));
484 // Start the mailbox based controller
485 if (megaraid_init_mbox(adapter) != 0) {
486 con_log(CL_ANN, (KERN_WARNING
487 "megaraid: maibox adapter did not initialize\n"));
489 goto out_free_adapter;
492 // Register with LSI Common Management Module
493 if (megaraid_cmm_register(adapter) != 0) {
495 con_log(CL_ANN, (KERN_WARNING
496 "megaraid: could not register with management module\n"));
501 // setup adapter handle in PCI soft state
502 pci_set_drvdata(pdev, adapter);
504 // attach with scsi mid-layer
505 if (megaraid_io_attach(adapter) != 0) {
507 con_log(CL_ANN, (KERN_WARNING "megaraid: io attach failed\n"));
515 pci_set_drvdata(pdev, NULL);
516 megaraid_cmm_unregister(adapter);
518 megaraid_fini_mbox(adapter);
522 pci_disable_device(pdev);
529 * megaraid_detach_one - release the framework resources and call LLD release
531 * @param pdev : handle for our PCI cofiguration space
533 * This routine is called during driver unload. We free all the allocated
534 * resources and call the corresponding LLD so that it can also release all
537 * This routine is also called from the PCI hotplug system
540 megaraid_detach_one(struct pci_dev *pdev)
543 struct Scsi_Host *host;
546 // Start a rollback on this adapter
547 adapter = pci_get_drvdata(pdev);
550 con_log(CL_ANN, (KERN_CRIT
551 "megaraid: Invalid detach on %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
552 pdev->vendor, pdev->device, pdev->subsystem_vendor,
553 pdev->subsystem_device));
558 con_log(CL_ANN, (KERN_NOTICE
559 "megaraid: detaching device %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
560 pdev->vendor, pdev->device, pdev->subsystem_vendor,
561 pdev->subsystem_device));
565 host = adapter->host;
567 // do not allow any more requests from the management module for this
569 // FIXME: How do we account for the request which might still be
571 atomic_set(&adapter->being_detached, 1);
573 // detach from the IO sub-system
574 megaraid_io_detach(adapter);
576 // reset the device state in the PCI structure. We check this
577 // condition when we enter here. If the device state is NULL,
578 // that would mean the device has already been removed
579 pci_set_drvdata(pdev, NULL);
581 // Unregister from common management module
583 // FIXME: this must return success or failure for conditions if there
584 // is a command pending with LLD or not.
585 megaraid_cmm_unregister(adapter);
587 // finalize the mailbox based controller and release all resources
588 megaraid_fini_mbox(adapter);
594 pci_disable_device(pdev);
601 * megaraid_mbox_shutdown - PCI shutdown for megaraid HBA
602 * @param device : generice driver model device
604 * Shutdown notification, perform flush cache
607 megaraid_mbox_shutdown(struct pci_dev *pdev)
609 adapter_t *adapter = pci_get_drvdata(pdev);
613 con_log(CL_ANN, (KERN_WARNING
614 "megaraid: null device in shutdown\n"));
619 con_log(CL_ANN, (KERN_INFO "megaraid: flushing adapter %d...",
622 megaraid_mbox_flush_cache(adapter);
624 con_log(CL_ANN, ("done\n"));
629 * megaraid_io_attach - attach a device with the IO subsystem
630 * @param adapter : controller's soft state
632 * Attach this device with the IO subsystem
635 megaraid_io_attach(adapter_t *adapter)
637 struct Scsi_Host *host;
639 // Initialize SCSI Host structure
640 host = scsi_host_alloc(&megaraid_template_g, 8);
642 con_log(CL_ANN, (KERN_WARNING
643 "megaraid mbox: scsi_register failed\n"));
648 SCSIHOST2ADAP(host) = (caddr_t)adapter;
649 adapter->host = host;
651 host->irq = adapter->irq;
652 host->unique_id = adapter->unique_id;
653 host->can_queue = adapter->max_cmds;
654 host->this_id = adapter->init_id;
655 host->sg_tablesize = adapter->sglen;
656 host->max_sectors = adapter->max_sectors;
657 host->cmd_per_lun = adapter->cmd_per_lun;
658 host->max_channel = adapter->max_channel;
659 host->max_id = adapter->max_target;
660 host->max_lun = adapter->max_lun;
663 // notify mid-layer about the new controller
664 if (scsi_add_host(host, &adapter->pdev->dev)) {
666 con_log(CL_ANN, (KERN_WARNING
667 "megaraid mbox: scsi_add_host failed\n"));
674 scsi_scan_host(host);
681 * megaraid_io_detach - detach a device from the IO subsystem
682 * @param adapter : controller's soft state
684 * Detach this device from the IO subsystem
687 megaraid_io_detach(adapter_t *adapter)
689 struct Scsi_Host *host;
691 con_log(CL_DLEVEL1, (KERN_INFO "megaraid: io detach\n"));
693 host = adapter->host;
695 scsi_remove_host(host);
702 * START: Mailbox Low Level Driver
704 * This is section specific to the single mailbox based controllers
708 * megaraid_init_mbox - initialize controller
709 * @param adapter - our soft state
711 * . Allocate 16-byte aligned mailbox memory for firmware handshake
712 * . Allocate controller's memory resources
713 * . Find out all initialization data
714 * . Allocate memory required for all the commands
715 * . Use internal library of FW routines, build up complete soft state
718 megaraid_init_mbox(adapter_t *adapter)
720 struct pci_dev *pdev;
721 mraid_device_t *raid_dev;
725 adapter->ito = MBOX_TIMEOUT;
726 pdev = adapter->pdev;
729 * Allocate and initialize the init data structure for mailbox
732 raid_dev = kmalloc(sizeof(mraid_device_t), GFP_KERNEL);
733 if (raid_dev == NULL) return -1;
735 memset(raid_dev, 0, sizeof(mraid_device_t));
738 * Attach the adapter soft state to raid device soft state
740 adapter->raid_device = (caddr_t)raid_dev;
741 raid_dev->fast_load = megaraid_fast_load;
745 raid_dev->baseport = pci_resource_start(pdev, 0);
747 if (pci_request_regions(pdev, "MegaRAID: LSI Logic Corporation") != 0) {
749 con_log(CL_ANN, (KERN_WARNING
750 "megaraid: mem region busy\n"));
752 goto out_free_raid_dev;
755 raid_dev->baseaddr = ioremap_nocache(raid_dev->baseport, 128);
757 if (!raid_dev->baseaddr) {
759 con_log(CL_ANN, (KERN_WARNING
760 "megaraid: could not map hba memory\n") );
762 goto out_release_regions;
766 // Setup the rest of the soft state using the library of FW routines
769 // request IRQ and register the interrupt service routine
770 if (request_irq(adapter->irq, megaraid_isr, SA_SHIRQ, "megaraid",
773 con_log(CL_ANN, (KERN_WARNING
774 "megaraid: Couldn't register IRQ %d!\n", adapter->irq));
780 // initialize the mutual exclusion lock for the mailbox
781 spin_lock_init(&raid_dev->mailbox_lock);
783 // allocate memory required for commands
784 if (megaraid_alloc_cmd_packets(adapter) != 0) {
789 if (megaraid_mbox_product_info(adapter) != 0) {
793 // Do we support extended CDBs
794 adapter->max_cdb_sz = 10;
795 if (megaraid_mbox_extended_cdb(adapter) == 0) {
796 adapter->max_cdb_sz = 16;
800 * Do we support cluster environment, if we do, what is the initiator
802 * NOTE: In a non-cluster aware firmware environment, the LLD should
803 * return 7 as initiator id.
806 adapter->init_id = -1;
807 if (megaraid_mbox_support_ha(adapter, &adapter->init_id) == 0) {
812 * Prepare the device ids array to have the mapping between the kernel
813 * device address and megaraid device address.
814 * We export the physical devices on their actual addresses. The
815 * logical drives are exported on a virtual SCSI channel
817 megaraid_mbox_setup_device_map(adapter);
819 // If the firmware supports random deletion, update the device id map
820 if (megaraid_mbox_support_random_del(adapter)) {
822 // Change the logical drives numbers in device_ids array one
823 // slot in device_ids is reserved for target id, that's why
825 for (i = 0; i <= MAX_LOGICAL_DRIVES_40LD; i++) {
826 adapter->device_ids[adapter->max_channel][i] += 0x80;
828 adapter->device_ids[adapter->max_channel][adapter->init_id] =
831 raid_dev->random_del_supported = 1;
835 * find out the maximum number of scatter-gather elements supported by
838 adapter->sglen = megaraid_mbox_get_max_sg(adapter);
840 // enumerate RAID and SCSI channels so that all devices on SCSI
841 // channels can later be exported, including disk devices
842 megaraid_mbox_enum_raid_scsi(adapter);
845 * Other parameters required by upper layer
847 * maximum number of sectors per IO command
849 adapter->max_sectors = megaraid_max_sectors;
852 * number of queued commands per LUN.
854 adapter->cmd_per_lun = megaraid_cmd_per_lun;
857 * Allocate resources required to issue FW calls, when sysfs is
860 if (megaraid_sysfs_alloc_resources(adapter) != 0) {
864 // Set the DMA mask to 64-bit. All supported controllers as capable of
866 if (pci_set_dma_mask(adapter->pdev, DMA_64BIT_MASK) != 0) {
868 con_log(CL_ANN, (KERN_WARNING
869 "megaraid: could not set DMA mask for 64-bit.\n"));
871 goto out_free_sysfs_res;
874 // setup tasklet for DPC
875 tasklet_init(&adapter->dpc_h, megaraid_mbox_dpc,
876 (unsigned long)adapter);
878 con_log(CL_DLEVEL1, (KERN_INFO
879 "megaraid mbox hba successfully initialized\n"));
884 megaraid_sysfs_free_resources(adapter);
886 megaraid_free_cmd_packets(adapter);
888 free_irq(adapter->irq, adapter);
890 iounmap(raid_dev->baseaddr);
892 pci_release_regions(pdev);
901 * megaraid_fini_mbox - undo controller initialization
902 * @param adapter : our soft state
905 megaraid_fini_mbox(adapter_t *adapter)
907 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
910 megaraid_mbox_flush_cache(adapter);
912 tasklet_kill(&adapter->dpc_h);
914 megaraid_sysfs_free_resources(adapter);
916 megaraid_free_cmd_packets(adapter);
918 free_irq(adapter->irq, adapter);
920 iounmap(raid_dev->baseaddr);
922 pci_release_regions(adapter->pdev);
931 * megaraid_alloc_cmd_packets - allocate shared mailbox
932 * @param adapter : soft state of the raid controller
934 * Allocate and align the shared mailbox. This maibox is used to issue
935 * all the commands. For IO based controllers, the mailbox is also regsitered
936 * with the FW. Allocate memory for all commands as well.
937 * This is our big allocator
940 megaraid_alloc_cmd_packets(adapter_t *adapter)
942 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
943 struct pci_dev *pdev;
947 struct mraid_pci_blk *epthru_pci_blk;
948 struct mraid_pci_blk *sg_pci_blk;
949 struct mraid_pci_blk *mbox_pci_blk;
952 pdev = adapter->pdev;
956 * Allocate the common 16-byte aligned memory for the handshake
959 raid_dev->una_mbox64 = pci_alloc_consistent(adapter->pdev,
960 sizeof(mbox64_t), &raid_dev->una_mbox64_dma);
962 if (!raid_dev->una_mbox64) {
963 con_log(CL_ANN, (KERN_WARNING
964 "megaraid: out of memory, %s %d\n", __FUNCTION__,
968 memset(raid_dev->una_mbox64, 0, sizeof(mbox64_t));
971 * Align the mailbox at 16-byte boundary
973 raid_dev->mbox = &raid_dev->una_mbox64->mbox32;
975 raid_dev->mbox = (mbox_t *)((((unsigned long)raid_dev->mbox) + 15) &
978 raid_dev->mbox64 = (mbox64_t *)(((unsigned long)raid_dev->mbox) - 8);
980 align = ((void *)raid_dev->mbox -
981 ((void *)&raid_dev->una_mbox64->mbox32));
983 raid_dev->mbox_dma = (unsigned long)raid_dev->una_mbox64_dma + 8 +
986 // Allocate memory for commands issued internally
987 adapter->ibuf = pci_alloc_consistent(pdev, MBOX_IBUF_SIZE,
988 &adapter->ibuf_dma_h);
989 if (!adapter->ibuf) {
991 con_log(CL_ANN, (KERN_WARNING
992 "megaraid: out of memory, %s %d\n", __FUNCTION__,
995 goto out_free_common_mbox;
997 memset(adapter->ibuf, 0, MBOX_IBUF_SIZE);
999 // Allocate memory for our SCSI Command Blocks and their associated
1003 * Allocate memory for the base list of scb. Later allocate memory for
1004 * CCBs and embedded components of each CCB and point the pointers in
1005 * scb to the allocated components
1006 * NOTE: The code to allocate SCB will be duplicated in all the LLD
1007 * since the calling routine does not yet know the number of available
1010 adapter->kscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_SCSI_CMDS,
1013 if (adapter->kscb_list == NULL) {
1014 con_log(CL_ANN, (KERN_WARNING
1015 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1019 memset(adapter->kscb_list, 0, sizeof(scb_t) * MBOX_MAX_SCSI_CMDS);
1021 // memory allocation for our command packets
1022 if (megaraid_mbox_setup_dma_pools(adapter) != 0) {
1023 con_log(CL_ANN, (KERN_WARNING
1024 "megaraid: out of memory, %s %d\n", __FUNCTION__,
1026 goto out_free_scb_list;
1029 // Adjust the scb pointers and link in the free pool
1030 epthru_pci_blk = raid_dev->epthru_pool;
1031 sg_pci_blk = raid_dev->sg_pool;
1032 mbox_pci_blk = raid_dev->mbox_pool;
1034 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1035 scb = adapter->kscb_list + i;
1036 ccb = raid_dev->ccb_list + i;
1038 ccb->mbox = (mbox_t *)(mbox_pci_blk[i].vaddr + 16);
1039 ccb->raw_mbox = (uint8_t *)ccb->mbox;
1040 ccb->mbox64 = (mbox64_t *)(mbox_pci_blk[i].vaddr + 8);
1041 ccb->mbox_dma_h = (unsigned long)mbox_pci_blk[i].dma_addr + 16;
1043 // make sure the mailbox is aligned properly
1044 if (ccb->mbox_dma_h & 0x0F) {
1045 con_log(CL_ANN, (KERN_CRIT
1046 "megaraid mbox: not aligned on 16-bytes\n"));
1048 goto out_teardown_dma_pools;
1051 ccb->epthru = (mraid_epassthru_t *)
1052 epthru_pci_blk[i].vaddr;
1053 ccb->epthru_dma_h = epthru_pci_blk[i].dma_addr;
1054 ccb->pthru = (mraid_passthru_t *)ccb->epthru;
1055 ccb->pthru_dma_h = ccb->epthru_dma_h;
1058 ccb->sgl64 = (mbox_sgl64 *)sg_pci_blk[i].vaddr;
1059 ccb->sgl_dma_h = sg_pci_blk[i].dma_addr;
1060 ccb->sgl32 = (mbox_sgl32 *)ccb->sgl64;
1062 scb->ccb = (caddr_t)ccb;
1065 scb->sno = i; // command index
1068 scb->state = SCB_FREE;
1069 scb->dma_direction = PCI_DMA_NONE;
1070 scb->dma_type = MRAID_DMA_NONE;
1071 scb->dev_channel = -1;
1072 scb->dev_target = -1;
1074 // put scb in the free pool
1075 list_add_tail(&scb->list, &adapter->kscb_pool);
1080 out_teardown_dma_pools:
1081 megaraid_mbox_teardown_dma_pools(adapter);
1083 kfree(adapter->kscb_list);
1085 pci_free_consistent(pdev, MBOX_IBUF_SIZE, (void *)adapter->ibuf,
1086 adapter->ibuf_dma_h);
1087 out_free_common_mbox:
1088 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1089 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1096 * megaraid_free_cmd_packets - free memory
1097 * @param adapter : soft state of the raid controller
1099 * Release memory resources allocated for commands
1102 megaraid_free_cmd_packets(adapter_t *adapter)
1104 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1106 megaraid_mbox_teardown_dma_pools(adapter);
1108 kfree(adapter->kscb_list);
1110 pci_free_consistent(adapter->pdev, MBOX_IBUF_SIZE,
1111 (void *)adapter->ibuf, adapter->ibuf_dma_h);
1113 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1114 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1120 * megaraid_mbox_setup_dma_pools - setup dma pool for command packets
1121 * @param adapter : HBA soft state
1123 * setup the dma pools for mailbox, passthru and extended passthru structures,
1124 * and scatter-gather lists
1127 megaraid_mbox_setup_dma_pools(adapter_t *adapter)
1129 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1130 struct mraid_pci_blk *epthru_pci_blk;
1131 struct mraid_pci_blk *sg_pci_blk;
1132 struct mraid_pci_blk *mbox_pci_blk;
1137 // Allocate memory for 16-bytes aligned mailboxes
1138 raid_dev->mbox_pool_handle = pci_pool_create("megaraid mbox pool",
1140 sizeof(mbox64_t) + 16,
1143 if (raid_dev->mbox_pool_handle == NULL) {
1144 goto fail_setup_dma_pool;
1147 mbox_pci_blk = raid_dev->mbox_pool;
1148 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1149 mbox_pci_blk[i].vaddr = pci_pool_alloc(
1150 raid_dev->mbox_pool_handle,
1152 &mbox_pci_blk[i].dma_addr);
1153 if (!mbox_pci_blk[i].vaddr) {
1154 goto fail_setup_dma_pool;
1159 * Allocate memory for each embedded passthru strucuture pointer
1160 * Request for a 128 bytes aligned structure for each passthru command
1162 * Since passthru and extended passthru commands are exclusive, they
1163 * share common memory pool. Passthru structures piggyback on memory
1164 * allocted to extended passthru since passthru is smaller of the two
1166 raid_dev->epthru_pool_handle = pci_pool_create("megaraid mbox pthru",
1167 adapter->pdev, sizeof(mraid_epassthru_t), 128, 0);
1169 if (raid_dev->epthru_pool_handle == NULL) {
1170 goto fail_setup_dma_pool;
1173 epthru_pci_blk = raid_dev->epthru_pool;
1174 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1175 epthru_pci_blk[i].vaddr = pci_pool_alloc(
1176 raid_dev->epthru_pool_handle,
1178 &epthru_pci_blk[i].dma_addr);
1179 if (!epthru_pci_blk[i].vaddr) {
1180 goto fail_setup_dma_pool;
1185 // Allocate memory for each scatter-gather list. Request for 512 bytes
1186 // alignment for each sg list
1187 raid_dev->sg_pool_handle = pci_pool_create("megaraid mbox sg",
1189 sizeof(mbox_sgl64) * MBOX_MAX_SG_SIZE,
1192 if (raid_dev->sg_pool_handle == NULL) {
1193 goto fail_setup_dma_pool;
1196 sg_pci_blk = raid_dev->sg_pool;
1197 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1198 sg_pci_blk[i].vaddr = pci_pool_alloc(
1199 raid_dev->sg_pool_handle,
1201 &sg_pci_blk[i].dma_addr);
1202 if (!sg_pci_blk[i].vaddr) {
1203 goto fail_setup_dma_pool;
1209 fail_setup_dma_pool:
1210 megaraid_mbox_teardown_dma_pools(adapter);
1216 * megaraid_mbox_teardown_dma_pools - teardown dma pools for command packets
1217 * @param adapter : HBA soft state
1219 * teardown the dma pool for mailbox, passthru and extended passthru
1220 * structures, and scatter-gather lists
1223 megaraid_mbox_teardown_dma_pools(adapter_t *adapter)
1225 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1226 struct mraid_pci_blk *epthru_pci_blk;
1227 struct mraid_pci_blk *sg_pci_blk;
1228 struct mraid_pci_blk *mbox_pci_blk;
1232 sg_pci_blk = raid_dev->sg_pool;
1233 for (i = 0; i < MBOX_MAX_SCSI_CMDS && sg_pci_blk[i].vaddr; i++) {
1234 pci_pool_free(raid_dev->sg_pool_handle, sg_pci_blk[i].vaddr,
1235 sg_pci_blk[i].dma_addr);
1237 if (raid_dev->sg_pool_handle)
1238 pci_pool_destroy(raid_dev->sg_pool_handle);
1241 epthru_pci_blk = raid_dev->epthru_pool;
1242 for (i = 0; i < MBOX_MAX_SCSI_CMDS && epthru_pci_blk[i].vaddr; i++) {
1243 pci_pool_free(raid_dev->epthru_pool_handle,
1244 epthru_pci_blk[i].vaddr, epthru_pci_blk[i].dma_addr);
1246 if (raid_dev->epthru_pool_handle)
1247 pci_pool_destroy(raid_dev->epthru_pool_handle);
1250 mbox_pci_blk = raid_dev->mbox_pool;
1251 for (i = 0; i < MBOX_MAX_SCSI_CMDS && mbox_pci_blk[i].vaddr; i++) {
1252 pci_pool_free(raid_dev->mbox_pool_handle,
1253 mbox_pci_blk[i].vaddr, mbox_pci_blk[i].dma_addr);
1255 if (raid_dev->mbox_pool_handle)
1256 pci_pool_destroy(raid_dev->mbox_pool_handle);
1263 * megaraid_alloc_scb - detach and return a scb from the free list
1264 * @adapter : controller's soft state
1266 * return the scb from the head of the free list. NULL if there are none
1269 static inline scb_t *
1270 megaraid_alloc_scb(adapter_t *adapter, struct scsi_cmnd *scp)
1272 struct list_head *head = &adapter->kscb_pool;
1274 unsigned long flags;
1276 // detach scb from free pool
1277 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1279 if (list_empty(head)) {
1280 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1284 scb = list_entry(head->next, scb_t, list);
1285 list_del_init(&scb->list);
1287 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1289 scb->state = SCB_ACTIVE;
1291 scb->dma_type = MRAID_DMA_NONE;
1298 * megaraid_dealloc_scb - return the scb to the free pool
1299 * @adapter : controller's soft state
1300 * @scb : scb to be freed
1302 * return the scb back to the free list of scbs. The caller must 'flush' the
1303 * SCB before calling us. E.g., performing pci_unamp and/or pci_sync etc.
1304 * NOTE NOTE: Make sure the scb is not on any list before calling this
1308 megaraid_dealloc_scb(adapter_t *adapter, scb_t *scb)
1310 unsigned long flags;
1312 // put scb in the free pool
1313 scb->state = SCB_FREE;
1315 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1317 list_add(&scb->list, &adapter->kscb_pool);
1319 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1326 * megaraid_mbox_mksgl - make the scatter-gather list
1327 * @adapter - controller's soft state
1328 * @scb - scsi control block
1330 * prepare the scatter-gather list
1333 megaraid_mbox_mksgl(adapter_t *adapter, scb_t *scb)
1335 struct scatterlist *sgl;
1338 unsigned long offset;
1339 struct scsi_cmnd *scp;
1345 ccb = (mbox_ccb_t *)scb->ccb;
1347 // no mapping required if no data to be transferred
1348 if (!scp->request_buffer || !scp->request_bufflen)
1351 if (!scp->use_sg) { /* scatter-gather list not used */
1353 page = virt_to_page(scp->request_buffer);
1355 offset = ((unsigned long)scp->request_buffer & ~PAGE_MASK);
1357 ccb->buf_dma_h = pci_map_page(adapter->pdev, page, offset,
1358 scp->request_bufflen,
1359 scb->dma_direction);
1360 scb->dma_type = MRAID_DMA_WBUF;
1363 * We need to handle special 64-bit commands that need a
1367 ccb->sgl64[0].address = ccb->buf_dma_h;
1368 ccb->sgl64[0].length = scp->request_bufflen;
1373 sgl = (struct scatterlist *)scp->request_buffer;
1375 // The number of sg elements returned must not exceed our limit
1376 sgcnt = pci_map_sg(adapter->pdev, sgl, scp->use_sg,
1377 scb->dma_direction);
1379 if (sgcnt > adapter->sglen) {
1380 con_log(CL_ANN, (KERN_CRIT
1381 "megaraid critical: too many sg elements:%d\n",
1386 scb->dma_type = MRAID_DMA_WSG;
1388 for (i = 0; i < sgcnt; i++, sgl++) {
1389 ccb->sgl64[i].address = sg_dma_address(sgl);
1390 ccb->sgl64[i].length = sg_dma_len(sgl);
1393 // Return count of SG nodes
1399 * mbox_post_cmd - issue a mailbox command
1400 * @adapter - controller's soft state
1401 * @scb - command to be issued
1403 * post the command to the controller if mailbox is availble.
1406 mbox_post_cmd(adapter_t *adapter, scb_t *scb)
1408 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1412 unsigned long flags;
1416 ccb = (mbox_ccb_t *)scb->ccb;
1417 mbox = raid_dev->mbox;
1418 mbox64 = raid_dev->mbox64;
1421 * Check for busy mailbox. If it is, return failure - the caller
1422 * should retry later.
1424 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
1426 if (unlikely(mbox->busy)) {
1431 } while(mbox->busy && (i < max_mbox_busy_wait));
1435 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1442 // Copy this command's mailbox data into "adapter's" mailbox
1443 memcpy((caddr_t)mbox64, (caddr_t)ccb->mbox64, 22);
1444 mbox->cmdid = scb->sno;
1446 adapter->outstanding_cmds++;
1448 if (scb->dma_direction == PCI_DMA_TODEVICE) {
1449 if (!scb->scp->use_sg) { // sg list not used
1450 pci_dma_sync_single_for_device(adapter->pdev,
1452 scb->scp->request_bufflen,
1456 pci_dma_sync_sg_for_device(adapter->pdev,
1457 scb->scp->request_buffer,
1458 scb->scp->use_sg, PCI_DMA_TODEVICE);
1462 mbox->busy = 1; // Set busy
1467 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
1469 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1476 * megaraid_queue_command - generic queue entry point for all LLDs
1477 * @scp : pointer to the scsi command to be executed
1478 * @done : callback routine to be called after the cmd has be completed
1480 * Queue entry point for mailbox based controllers.
1483 megaraid_queue_command(struct scsi_cmnd *scp, void (* done)(struct scsi_cmnd *))
1489 adapter = SCP2ADAPTER(scp);
1490 scp->scsi_done = done;
1494 * Allocate and build a SCB request
1495 * if_busy flag will be set if megaraid_mbox_build_cmd() command could
1496 * not allocate scb. We will return non-zero status in that case.
1497 * NOTE: scb can be null even though certain commands completed
1498 * successfully, e.g., MODE_SENSE and TEST_UNIT_READY, it would
1499 * return 0 in that case, and we would do the callback right away.
1502 scb = megaraid_mbox_build_cmd(adapter, scp, &if_busy);
1503 if (!scb) { // command already completed
1508 megaraid_mbox_runpendq(adapter, scb);
1513 * megaraid_mbox_build_cmd - transform the mid-layer scsi command to megaraid
1515 * @adapter - controller's soft state
1516 * @scp - mid-layer scsi command pointer
1517 * @busy - set if request could not be completed because of lack of
1520 * convert the command issued by mid-layer to format understood by megaraid
1521 * firmware. We also complete certain command without sending them to firmware
1524 megaraid_mbox_build_cmd(adapter_t *adapter, struct scsi_cmnd *scp, int *busy)
1526 mraid_device_t *rdev = ADAP2RAIDDEV(adapter);
1531 mraid_passthru_t *pthru;
1535 char skip[] = "skipping";
1536 char scan[] = "scanning";
1541 * Get the appropriate device map for the device this command is
1544 MRAID_GET_DEVICE_MAP(adapter, scp, channel, target, islogical);
1547 * Logical drive commands
1550 switch (scp->cmnd[0]) {
1551 case TEST_UNIT_READY:
1553 * Do we support clustering and is the support enabled
1554 * If no, return success always
1557 scp->result = (DID_OK << 16);
1561 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1562 scp->result = (DID_ERROR << 16);
1567 scb->dma_direction = scp->sc_data_direction;
1568 scb->dev_channel = 0xFF;
1569 scb->dev_target = target;
1570 ccb = (mbox_ccb_t *)scb->ccb;
1573 * The command id will be provided by the command
1576 ccb->raw_mbox[0] = CLUSTER_CMD;
1577 ccb->raw_mbox[2] = RESERVATION_STATUS;
1578 ccb->raw_mbox[3] = target;
1584 struct scatterlist *sgl;
1587 sgl = (struct scatterlist *)scp->request_buffer;
1590 (page_address((&sgl[0])->page)
1591 + (&sgl[0])->offset);
1593 memset(vaddr, 0, scp->cmnd[4]);
1596 con_log(CL_ANN, (KERN_WARNING
1597 "megaraid mailbox: invalid sg:%d\n",
1602 memset(scp->request_buffer, 0, scp->cmnd[4]);
1604 scp->result = (DID_OK << 16);
1609 * Display the channel scan for logical drives
1610 * Do not display scan for a channel if already done.
1612 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1614 con_log(CL_ANN, (KERN_INFO
1615 "scsi[%d]: scanning scsi channel %d",
1616 adapter->host->host_no,
1620 " [virtual] for logical drives\n"));
1622 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1629 * Do not allow LUN > 0 for logical drives and
1630 * requests for more than 40 logical drives
1633 scp->result = (DID_BAD_TARGET << 16);
1636 if ((target % 0x80) >= MAX_LOGICAL_DRIVES_40LD) {
1637 scp->result = (DID_BAD_TARGET << 16);
1642 /* Allocate a SCB and initialize passthru */
1643 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1644 scp->result = (DID_ERROR << 16);
1649 ccb = (mbox_ccb_t *)scb->ccb;
1650 scb->dev_channel = 0xFF;
1651 scb->dev_target = target;
1654 mbox64 = ccb->mbox64;
1658 pthru->reqsenselen = 14;
1659 pthru->islogical = 1;
1660 pthru->logdrv = target;
1661 pthru->cdblen = scp->cmd_len;
1662 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
1664 mbox->cmd = MBOXCMD_PASSTHRU64;
1665 scb->dma_direction = scp->sc_data_direction;
1667 pthru->dataxferlen = scp->request_bufflen;
1668 pthru->dataxferaddr = ccb->sgl_dma_h;
1669 pthru->numsge = megaraid_mbox_mksgl(adapter,
1672 mbox->xferaddr = 0xFFFFFFFF;
1673 mbox64->xferaddr_lo = (uint32_t )ccb->pthru_dma_h;
1674 mbox64->xferaddr_hi = 0;
1686 * Allocate a SCB and initialize mailbox
1688 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1689 scp->result = (DID_ERROR << 16);
1693 ccb = (mbox_ccb_t *)scb->ccb;
1694 scb->dev_channel = 0xFF;
1695 scb->dev_target = target;
1697 mbox64 = ccb->mbox64;
1698 mbox->logdrv = target;
1701 * A little HACK: 2nd bit is zero for all scsi read
1702 * commands and is set for all scsi write commands
1704 mbox->cmd = (scp->cmnd[0] & 0x02) ? MBOXCMD_LWRITE64:
1708 * 6-byte READ(0x08) or WRITE(0x0A) cdb
1710 if (scp->cmd_len == 6) {
1711 mbox->numsectors = (uint32_t)scp->cmnd[4];
1713 ((uint32_t)scp->cmnd[1] << 16) |
1714 ((uint32_t)scp->cmnd[2] << 8) |
1715 (uint32_t)scp->cmnd[3];
1717 mbox->lba &= 0x1FFFFF;
1721 * 10-byte READ(0x28) or WRITE(0x2A) cdb
1723 else if (scp->cmd_len == 10) {
1725 (uint32_t)scp->cmnd[8] |
1726 ((uint32_t)scp->cmnd[7] << 8);
1728 ((uint32_t)scp->cmnd[2] << 24) |
1729 ((uint32_t)scp->cmnd[3] << 16) |
1730 ((uint32_t)scp->cmnd[4] << 8) |
1731 (uint32_t)scp->cmnd[5];
1735 * 12-byte READ(0xA8) or WRITE(0xAA) cdb
1737 else if (scp->cmd_len == 12) {
1739 ((uint32_t)scp->cmnd[2] << 24) |
1740 ((uint32_t)scp->cmnd[3] << 16) |
1741 ((uint32_t)scp->cmnd[4] << 8) |
1742 (uint32_t)scp->cmnd[5];
1745 ((uint32_t)scp->cmnd[6] << 24) |
1746 ((uint32_t)scp->cmnd[7] << 16) |
1747 ((uint32_t)scp->cmnd[8] << 8) |
1748 (uint32_t)scp->cmnd[9];
1751 con_log(CL_ANN, (KERN_WARNING
1752 "megaraid: unsupported CDB length\n"));
1754 megaraid_dealloc_scb(adapter, scb);
1756 scp->result = (DID_ERROR << 16);
1760 scb->dma_direction = scp->sc_data_direction;
1762 // Calculate Scatter-Gather info
1763 mbox64->xferaddr_lo = (uint32_t )ccb->sgl_dma_h;
1764 mbox->numsge = megaraid_mbox_mksgl(adapter,
1766 mbox->xferaddr = 0xFFFFFFFF;
1767 mbox64->xferaddr_hi = 0;
1774 * Do we support clustering and is the support enabled
1777 scp->result = (DID_BAD_TARGET << 16);
1782 * Allocate a SCB and initialize mailbox
1784 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1785 scp->result = (DID_ERROR << 16);
1790 ccb = (mbox_ccb_t *)scb->ccb;
1791 scb->dev_channel = 0xFF;
1792 scb->dev_target = target;
1793 ccb->raw_mbox[0] = CLUSTER_CMD;
1794 ccb->raw_mbox[2] = (scp->cmnd[0] == RESERVE) ?
1795 RESERVE_LD : RELEASE_LD;
1797 ccb->raw_mbox[3] = target;
1798 scb->dma_direction = scp->sc_data_direction;
1803 scp->result = (DID_BAD_TARGET << 16);
1807 else { // Passthru device commands
1809 // Do not allow access to target id > 15 or LUN > 7
1810 if (target > 15 || SCP2LUN(scp) > 7) {
1811 scp->result = (DID_BAD_TARGET << 16);
1815 // if fast load option was set and scan for last device is
1816 // over, reset the fast_load flag so that during a possible
1817 // next scan, devices can be made available
1818 if (rdev->fast_load && (target == 15) &&
1819 (SCP2CHANNEL(scp) == adapter->max_channel -1)) {
1821 con_log(CL_ANN, (KERN_INFO
1822 "megaraid[%d]: physical device scan re-enabled\n",
1823 adapter->host->host_no));
1824 rdev->fast_load = 0;
1828 * Display the channel scan for physical devices
1830 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1832 ss = rdev->fast_load ? skip : scan;
1834 con_log(CL_ANN, (KERN_INFO
1835 "scsi[%d]: %s scsi channel %d [Phy %d]",
1836 adapter->host->host_no, ss, SCP2CHANNEL(scp),
1840 " for non-raid devices\n"));
1842 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1845 // disable channel sweep if fast load option given
1846 if (rdev->fast_load) {
1847 scp->result = (DID_BAD_TARGET << 16);
1851 // Allocate a SCB and initialize passthru
1852 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1853 scp->result = (DID_ERROR << 16);
1858 ccb = (mbox_ccb_t *)scb->ccb;
1859 scb->dev_channel = channel;
1860 scb->dev_target = target;
1861 scb->dma_direction = scp->sc_data_direction;
1863 mbox64 = ccb->mbox64;
1865 // Does this firmware support extended CDBs
1866 if (adapter->max_cdb_sz == 16) {
1867 mbox->cmd = MBOXCMD_EXTPTHRU;
1869 megaraid_mbox_prepare_epthru(adapter, scb, scp);
1871 mbox64->xferaddr_lo = (uint32_t)ccb->epthru_dma_h;
1872 mbox64->xferaddr_hi = 0;
1873 mbox->xferaddr = 0xFFFFFFFF;
1876 mbox->cmd = MBOXCMD_PASSTHRU64;
1878 megaraid_mbox_prepare_pthru(adapter, scb, scp);
1880 mbox64->xferaddr_lo = (uint32_t)ccb->pthru_dma_h;
1881 mbox64->xferaddr_hi = 0;
1882 mbox->xferaddr = 0xFFFFFFFF;
1892 * megaraid_mbox_runpendq - execute commands queued in the pending queue
1893 * @adapter : controller's soft state
1894 * @scb : SCB to be queued in the pending list
1896 * scan the pending list for commands which are not yet issued and try to
1897 * post to the controller. The SCB can be a null pointer, which would indicate
1898 * no SCB to be queue, just try to execute the ones in the pending list.
1900 * NOTE: We do not actually traverse the pending list. The SCBs are plucked
1901 * out from the head of the pending list. If it is successfully issued, the
1902 * next SCB is at the head now.
1905 megaraid_mbox_runpendq(adapter_t *adapter, scb_t *scb_q)
1908 unsigned long flags;
1910 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1913 scb_q->state = SCB_PENDQ;
1914 list_add_tail(&scb_q->list, &adapter->pend_list);
1917 // if the adapter in not in quiescent mode, post the commands to FW
1918 if (adapter->quiescent) {
1919 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1923 while (!list_empty(&adapter->pend_list)) {
1925 assert_spin_locked(PENDING_LIST_LOCK(adapter));
1927 scb = list_entry(adapter->pend_list.next, scb_t, list);
1929 // remove the scb from the pending list and try to
1930 // issue. If we are unable to issue it, put back in
1931 // the pending list and return
1933 list_del_init(&scb->list);
1935 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1937 // if mailbox was busy, return SCB back to pending
1938 // list. Make sure to add at the head, since that's
1939 // where it would have been removed from
1941 scb->state = SCB_ISSUED;
1943 if (mbox_post_cmd(adapter, scb) != 0) {
1945 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1947 scb->state = SCB_PENDQ;
1949 list_add(&scb->list, &adapter->pend_list);
1951 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
1957 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1960 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1968 * megaraid_mbox_prepare_pthru - prepare a command for physical devices
1969 * @adapter - pointer to controller's soft state
1970 * @scb - scsi control block
1971 * @scp - scsi command from the mid-layer
1973 * prepare a command for the scsi physical devices
1976 megaraid_mbox_prepare_pthru(adapter_t *adapter, scb_t *scb,
1977 struct scsi_cmnd *scp)
1980 mraid_passthru_t *pthru;
1984 ccb = (mbox_ccb_t *)scb->ccb;
1986 channel = scb->dev_channel;
1987 target = scb->dev_target;
1989 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
1992 pthru->islogical = 0;
1994 pthru->target = (channel << 4) | target;
1995 pthru->logdrv = SCP2LUN(scp);
1996 pthru->reqsenselen = 14;
1997 pthru->cdblen = scp->cmd_len;
1999 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
2001 if (scp->request_bufflen) {
2002 pthru->dataxferlen = scp->request_bufflen;
2003 pthru->dataxferaddr = ccb->sgl_dma_h;
2004 pthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2007 pthru->dataxferaddr = 0;
2008 pthru->dataxferlen = 0;
2016 * megaraid_mbox_prepare_epthru - prepare a command for physical devices
2017 * @adapter - pointer to controller's soft state
2018 * @scb - scsi control block
2019 * @scp - scsi command from the mid-layer
2021 * prepare a command for the scsi physical devices. This rountine prepares
2022 * commands for devices which can take extended CDBs (>10 bytes)
2025 megaraid_mbox_prepare_epthru(adapter_t *adapter, scb_t *scb,
2026 struct scsi_cmnd *scp)
2029 mraid_epassthru_t *epthru;
2033 ccb = (mbox_ccb_t *)scb->ccb;
2034 epthru = ccb->epthru;
2035 channel = scb->dev_channel;
2036 target = scb->dev_target;
2038 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2039 epthru->timeout = 4;
2041 epthru->islogical = 0;
2042 epthru->channel = 0;
2043 epthru->target = (channel << 4) | target;
2044 epthru->logdrv = SCP2LUN(scp);
2045 epthru->reqsenselen = 14;
2046 epthru->cdblen = scp->cmd_len;
2048 memcpy(epthru->cdb, scp->cmnd, scp->cmd_len);
2050 if (scp->request_bufflen) {
2051 epthru->dataxferlen = scp->request_bufflen;
2052 epthru->dataxferaddr = ccb->sgl_dma_h;
2053 epthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2056 epthru->dataxferaddr = 0;
2057 epthru->dataxferlen = 0;
2065 * megaraid_ack_sequence - interrupt ack sequence for memory mapped HBAs
2066 * @adapter - controller's soft state
2068 * Interrupt ackrowledgement sequence for memory mapped HBAs. Find out the
2069 * completed command and put them on the completed list for later processing.
2071 * Returns: 1 if the interrupt is valid, 0 otherwise
2074 megaraid_ack_sequence(adapter_t *adapter)
2076 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2080 uint8_t completed[MBOX_MAX_FIRMWARE_STATUS];
2081 struct list_head clist;
2084 unsigned long flags;
2088 mbox = raid_dev->mbox;
2090 // move the SCBs from the firmware completed array to our local list
2091 INIT_LIST_HEAD(&clist);
2093 // loop till F/W has more commands for us to complete
2095 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
2098 * Check if a valid interrupt is pending. If found, force the
2099 * interrupt line low.
2101 dword = RDOUTDOOR(raid_dev);
2102 if (dword != 0x10001234) break;
2106 WROUTDOOR(raid_dev, 0x10001234);
2109 // wait for valid numstatus to post
2110 for (i = 0; i < 0xFFFFF; i++) {
2111 if (mbox->numstatus != 0xFF) {
2112 nstatus = mbox->numstatus;
2117 mbox->numstatus = 0xFF;
2119 adapter->outstanding_cmds -= nstatus;
2121 for (i = 0; i < nstatus; i++) {
2123 // wait for valid command index to post
2124 for (j = 0; j < 0xFFFFF; j++) {
2125 if (mbox->completed[i] != 0xFF) break;
2128 completed[i] = mbox->completed[i];
2129 mbox->completed[i] = 0xFF;
2131 if (completed[i] == 0xFF) {
2132 con_log(CL_ANN, (KERN_CRIT
2133 "megaraid: command posting timed out\n"));
2139 // Get SCB associated with this command id
2140 if (completed[i] >= MBOX_MAX_SCSI_CMDS) {
2142 scb = adapter->uscb_list + (completed[i] -
2143 MBOX_MAX_SCSI_CMDS);
2147 scb = adapter->kscb_list + completed[i];
2150 scb->status = mbox->status;
2151 list_add_tail(&scb->list, &clist);
2154 // Acknowledge interrupt
2155 WRINDOOR(raid_dev, 0x02);
2159 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
2162 // put the completed commands in the completed list. DPC would
2163 // complete these commands later
2164 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2166 list_splice(&clist, &adapter->completed_list);
2168 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2171 // schedule the DPC if there is some work for it
2173 tasklet_schedule(&adapter->dpc_h);
2180 * megaraid_isr - isr for memory based mailbox based controllers
2182 * @devp - pointer to our soft state
2185 * Interrupt service routine for memory-mapped mailbox controllers.
2188 megaraid_isr(int irq, void *devp, struct pt_regs *regs)
2190 adapter_t *adapter = devp;
2193 handled = megaraid_ack_sequence(adapter);
2195 /* Loop through any pending requests */
2196 if (!adapter->quiescent) {
2197 megaraid_mbox_runpendq(adapter, NULL);
2200 return IRQ_RETVAL(handled);
2205 * megaraid_mbox_sync_scb - sync kernel buffers
2206 * @adapter : controller's soft state
2207 * @scb : pointer to the resource packet
2209 * DMA sync if required.
2212 megaraid_mbox_sync_scb(adapter_t *adapter, scb_t *scb)
2216 ccb = (mbox_ccb_t *)scb->ccb;
2218 switch (scb->dma_type) {
2220 case MRAID_DMA_WBUF:
2221 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2222 pci_dma_sync_single_for_cpu(adapter->pdev,
2224 scb->scp->request_bufflen,
2225 PCI_DMA_FROMDEVICE);
2228 pci_unmap_page(adapter->pdev, ccb->buf_dma_h,
2229 scb->scp->request_bufflen, scb->dma_direction);
2234 if (scb->dma_direction == PCI_DMA_FROMDEVICE) {
2235 pci_dma_sync_sg_for_cpu(adapter->pdev,
2236 scb->scp->request_buffer,
2237 scb->scp->use_sg, PCI_DMA_FROMDEVICE);
2240 pci_unmap_sg(adapter->pdev, scb->scp->request_buffer,
2241 scb->scp->use_sg, scb->dma_direction);
2254 * megaraid_mbox_dpc - the tasklet to complete the commands from completed list
2255 * @devp : pointer to HBA soft state
2257 * Pick up the commands from the completed list and send back to the owners.
2258 * This is a reentrant function and does not assume any locks are held while
2259 * it is being called.
2262 megaraid_mbox_dpc(unsigned long devp)
2264 adapter_t *adapter = (adapter_t *)devp;
2265 mraid_device_t *raid_dev;
2266 struct list_head clist;
2267 struct scatterlist *sgl;
2270 struct scsi_cmnd *scp;
2271 mraid_passthru_t *pthru;
2272 mraid_epassthru_t *epthru;
2278 unsigned long flags;
2283 if (!adapter) return;
2285 raid_dev = ADAP2RAIDDEV(adapter);
2287 // move the SCBs from the completed list to our local list
2288 INIT_LIST_HEAD(&clist);
2290 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2292 list_splice_init(&adapter->completed_list, &clist);
2294 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2297 list_for_each_entry_safe(scb, tmp, &clist, list) {
2299 status = scb->status;
2301 ccb = (mbox_ccb_t *)scb->ccb;
2303 epthru = ccb->epthru;
2306 // Make sure f/w has completed a valid command
2307 if (scb->state != SCB_ISSUED) {
2308 con_log(CL_ANN, (KERN_CRIT
2309 "megaraid critical err: invalid command %d:%d:%p\n",
2310 scb->sno, scb->state, scp));
2312 continue; // Must never happen!
2315 // check for the management command and complete it right away
2316 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2317 scb->state = SCB_FREE;
2318 scb->status = status;
2320 // remove from local clist
2321 list_del_init(&scb->list);
2323 megaraid_mbox_mm_done(adapter, scb);
2328 // Was an abort issued for this command earlier
2329 if (scb->state & SCB_ABORT) {
2330 con_log(CL_ANN, (KERN_NOTICE
2331 "megaraid: aborted cmd %lx[%x] completed\n",
2332 scp->serial_number, scb->sno));
2336 * If the inquiry came of a disk drive which is not part of
2337 * any RAID array, expose it to the kernel. For this to be
2338 * enabled, user must set the "megaraid_expose_unconf_disks"
2339 * flag to 1 by specifying it on module parameter list.
2340 * This would enable data migration off drives from other
2343 islogical = MRAID_IS_LOGICAL(adapter, scp);
2344 if (scp->cmnd[0] == INQUIRY && status == 0 && islogical == 0
2345 && IS_RAID_CH(raid_dev, scb->dev_channel)) {
2348 sgl = (struct scatterlist *)
2349 scp->request_buffer;
2352 c = *(unsigned char *)
2353 (page_address((&sgl[0])->page) +
2357 con_log(CL_ANN, (KERN_WARNING
2358 "megaraid mailbox: invalid sg:%d\n",
2364 c = *(uint8_t *)scp->request_buffer;
2367 if ((c & 0x1F ) == TYPE_DISK) {
2368 pdev_index = (scb->dev_channel * 16) +
2371 raid_dev->pdrv_state[pdev_index] & 0x0F;
2373 if (pdev_state == PDRV_ONLINE ||
2374 pdev_state == PDRV_FAILED ||
2375 pdev_state == PDRV_RBLD ||
2376 pdev_state == PDRV_HOTSPARE ||
2377 megaraid_expose_unconf_disks == 0) {
2384 // Convert MegaRAID status to Linux error code
2389 scp->result = (DID_OK << 16);
2394 /* set sense_buffer and result fields */
2395 if (mbox->cmd == MBOXCMD_PASSTHRU ||
2396 mbox->cmd == MBOXCMD_PASSTHRU64) {
2398 memcpy(scp->sense_buffer, pthru->reqsensearea,
2401 scp->result = DRIVER_SENSE << 24 |
2402 DID_OK << 16 | CHECK_CONDITION << 1;
2405 if (mbox->cmd == MBOXCMD_EXTPTHRU) {
2407 memcpy(scp->sense_buffer,
2408 epthru->reqsensearea, 14);
2410 scp->result = DRIVER_SENSE << 24 |
2412 CHECK_CONDITION << 1;
2414 scp->sense_buffer[0] = 0x70;
2415 scp->sense_buffer[2] = ABORTED_COMMAND;
2416 scp->result = CHECK_CONDITION << 1;
2423 scp->result = DID_BUS_BUSY << 16 | status;
2429 * If TEST_UNIT_READY fails, we know RESERVATION_STATUS
2432 if (scp->cmnd[0] == TEST_UNIT_READY) {
2433 scp->result = DID_ERROR << 16 |
2434 RESERVATION_CONFLICT << 1;
2438 * Error code returned is 1 if Reserve or Release
2439 * failed or the input parameter is invalid
2441 if (status == 1 && (scp->cmnd[0] == RESERVE ||
2442 scp->cmnd[0] == RELEASE)) {
2444 scp->result = DID_ERROR << 16 |
2445 RESERVATION_CONFLICT << 1;
2448 scp->result = DID_BAD_TARGET << 16 | status;
2452 // print a debug message for all failed commands
2454 megaraid_mbox_display_scb(adapter, scb);
2457 // Free our internal resources and call the mid-layer callback
2459 megaraid_mbox_sync_scb(adapter, scb);
2461 // remove from local clist
2462 list_del_init(&scb->list);
2464 // put back in free list
2465 megaraid_dealloc_scb(adapter, scb);
2467 // send the scsi packet back to kernel
2468 scp->scsi_done(scp);
2476 * megaraid_abort_handler - abort the scsi command
2477 * @scp : command to be aborted
2479 * Abort a previous SCSI request. Only commands on the pending list can be
2480 * aborted. All the commands issued to the F/W must complete.
2483 megaraid_abort_handler(struct scsi_cmnd *scp)
2486 mraid_device_t *raid_dev;
2490 unsigned long flags;
2494 adapter = SCP2ADAPTER(scp);
2495 raid_dev = ADAP2RAIDDEV(adapter);
2497 con_log(CL_ANN, (KERN_WARNING
2498 "megaraid: aborting-%ld cmd=%x <c=%d t=%d l=%d>\n",
2499 scp->serial_number, scp->cmnd[0], SCP2CHANNEL(scp),
2500 SCP2TARGET(scp), SCP2LUN(scp)));
2502 // If FW has stopped responding, simply return failure
2503 if (raid_dev->hw_error) {
2504 con_log(CL_ANN, (KERN_NOTICE
2505 "megaraid: hw error, not aborting\n"));
2509 // There might a race here, where the command was completed by the
2510 // firmware and now it is on the completed list. Before we could
2511 // complete the command to the kernel in dpc, the abort came.
2512 // Find out if this is the case to avoid the race.
2514 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2515 list_for_each_entry_safe(scb, tmp, &adapter->completed_list, list) {
2517 if (scb->scp == scp) { // Found command
2519 list_del_init(&scb->list); // from completed list
2521 con_log(CL_ANN, (KERN_WARNING
2522 "megaraid: %ld:%d[%d:%d], abort from completed list\n",
2523 scp->serial_number, scb->sno,
2524 scb->dev_channel, scb->dev_target));
2526 scp->result = (DID_ABORT << 16);
2527 scp->scsi_done(scp);
2529 megaraid_dealloc_scb(adapter, scb);
2531 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter),
2537 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2540 // Find out if this command is still on the pending list. If it is and
2541 // was never issued, abort and return success. If the command is owned
2542 // by the firmware, we must wait for it to complete by the FW.
2543 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2544 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2546 if (scb->scp == scp) { // Found command
2548 list_del_init(&scb->list); // from pending list
2550 ASSERT(!(scb->state & SCB_ISSUED));
2552 con_log(CL_ANN, (KERN_WARNING
2553 "megaraid abort: %ld[%d:%d], driver owner\n",
2554 scp->serial_number, scb->dev_channel,
2557 scp->result = (DID_ABORT << 16);
2558 scp->scsi_done(scp);
2560 megaraid_dealloc_scb(adapter, scb);
2562 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2568 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2571 // Check do we even own this command, in which case this would be
2572 // owned by the firmware. The only way to locate the FW scb is to
2573 // traverse through the list of all SCB, since driver does not
2574 // maintain these SCBs on any list
2576 spin_lock_irq(&adapter->lock);
2577 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
2578 scb = adapter->kscb_list + i;
2580 if (scb->scp == scp) {
2584 if (!(scb->state & SCB_ISSUED)) {
2585 con_log(CL_ANN, (KERN_WARNING
2586 "megaraid abort: %ld%d[%d:%d], invalid state\n",
2587 scp->serial_number, scb->sno, scb->dev_channel,
2592 con_log(CL_ANN, (KERN_WARNING
2593 "megaraid abort: %ld:%d[%d:%d], fw owner\n",
2594 scp->serial_number, scb->sno, scb->dev_channel,
2599 spin_unlock_irq(&adapter->lock);
2602 con_log(CL_ANN, (KERN_WARNING
2603 "megaraid abort: scsi cmd:%ld, do now own\n",
2604 scp->serial_number));
2606 // FIXME: Should there be a callback for this command?
2610 // We cannot actually abort a command owned by firmware, return
2611 // failure and wait for reset. In host reset handler, we will find out
2612 // if the HBA is still live
2617 * megaraid_reset_handler - device reset hadler for mailbox based driver
2618 * @scp : reference command
2620 * Reset handler for the mailbox based controller. First try to find out if
2621 * the FW is still live, in which case the outstanding commands counter mut go
2622 * down to 0. If that happens, also issue the reservation reset command to
2623 * relinquish (possible) reservations on the logical drives connected to this
2627 megaraid_reset_handler(struct scsi_cmnd *scp)
2632 mraid_device_t *raid_dev;
2633 unsigned long flags;
2634 uint8_t raw_mbox[sizeof(mbox_t)];
2636 int recovery_window;
2640 adapter = SCP2ADAPTER(scp);
2641 raid_dev = ADAP2RAIDDEV(adapter);
2643 // return failure if adapter is not responding
2644 if (raid_dev->hw_error) {
2645 con_log(CL_ANN, (KERN_NOTICE
2646 "megaraid: hw error, cannot reset\n"));
2651 // Under exceptional conditions, FW can take up to 3 minutes to
2652 // complete command processing. Wait for additional 2 minutes for the
2653 // pending commands counter to go down to 0. If it doesn't, let the
2654 // controller be marked offline
2655 // Also, reset all the commands currently owned by the driver
2656 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2657 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2659 list_del_init(&scb->list); // from pending list
2661 con_log(CL_ANN, (KERN_WARNING
2662 "megaraid: %ld:%d[%d:%d], reset from pending list\n",
2663 scp->serial_number, scb->sno,
2664 scb->dev_channel, scb->dev_target));
2666 scp->result = (DID_RESET << 16);
2667 scp->scsi_done(scp);
2669 megaraid_dealloc_scb(adapter, scb);
2671 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2673 if (adapter->outstanding_cmds) {
2674 con_log(CL_ANN, (KERN_NOTICE
2675 "megaraid: %d outstanding commands. Max wait %d sec\n",
2676 adapter->outstanding_cmds, MBOX_RESET_WAIT));
2679 recovery_window = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
2681 recovering = adapter->outstanding_cmds;
2683 for (i = 0; i < recovery_window && adapter->outstanding_cmds; i++) {
2685 megaraid_ack_sequence(adapter);
2687 // print a message once every 5 seconds only
2690 "megaraid mbox: Wait for %d commands to complete:%d\n",
2691 adapter->outstanding_cmds,
2692 MBOX_RESET_WAIT - i));
2695 // bailout if no recovery happended in reset time
2696 if ((i == MBOX_RESET_WAIT) &&
2697 (recovering == adapter->outstanding_cmds)) {
2704 spin_lock(&adapter->lock);
2706 // If still outstanding commands, bail out
2707 if (adapter->outstanding_cmds) {
2708 con_log(CL_ANN, (KERN_WARNING
2709 "megaraid mbox: critical hardware error!\n"));
2711 raid_dev->hw_error = 1;
2717 con_log(CL_ANN, (KERN_NOTICE
2718 "megaraid mbox: reset sequence completed sucessfully\n"));
2722 // If the controller supports clustering, reset reservations
2728 // clear reservations if any
2729 raw_mbox[0] = CLUSTER_CMD;
2730 raw_mbox[2] = RESET_RESERVATIONS;
2733 if (mbox_post_sync_cmd_fast(adapter, raw_mbox) == 0) {
2735 (KERN_INFO "megaraid: reservation reset\n"));
2739 con_log(CL_ANN, (KERN_WARNING
2740 "megaraid: reservation reset failed\n"));
2744 spin_unlock_irq(&adapter->lock);
2749 * START: internal commands library
2751 * This section of the driver has the common routine used by the driver and
2752 * also has all the FW routines
2756 * mbox_post_sync_cmd() - blocking command to the mailbox based controllers
2757 * @adapter - controller's soft state
2758 * @raw_mbox - the mailbox
2760 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2764 mbox_post_sync_cmd(adapter_t *adapter, uint8_t raw_mbox[])
2766 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2773 mbox64 = raid_dev->mbox64;
2774 mbox = raid_dev->mbox;
2777 * Wait until mailbox is free
2779 if (megaraid_busywait_mbox(raid_dev) != 0)
2780 goto blocked_mailbox;
2783 * Copy mailbox data into host structure
2785 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
2790 mbox->numstatus = 0xFF;
2791 mbox->status = 0xFF;
2794 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2796 // wait for maximum 1 second for status to post. If the status is not
2797 // available within 1 second, assume FW is initializing and wait
2798 // for an extended amount of time
2799 if (mbox->numstatus == 0xFF) { // status not yet available
2802 for (i = 0; mbox->numstatus == 0xFF && i < 1000; i++) {
2809 con_log(CL_ANN, (KERN_NOTICE
2810 "megaraid mailbox: wait for FW to boot "));
2812 for (i = 0; (mbox->numstatus == 0xFF) &&
2813 (i < MBOX_RESET_WAIT); i++) {
2815 con_log(CL_ANN, ("\b\b\b\b\b[%03d]",
2816 MBOX_RESET_WAIT - i));
2820 if (i == MBOX_RESET_WAIT) {
2823 "\nmegaraid mailbox: status not available\n"));
2827 con_log(CL_ANN, ("\b\b\b\b\b[ok] \n"));
2831 // wait for maximum 1 second for poll semaphore
2832 if (mbox->poll != 0x77) {
2835 for (i = 0; (mbox->poll != 0x77) && (i < 1000); i++) {
2841 con_log(CL_ANN, (KERN_WARNING
2842 "megaraid mailbox: could not get poll semaphore\n"));
2847 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2850 // wait for maximum 1 second for acknowledgement
2851 if (RDINDOOR(raid_dev) & 0x2) {
2854 for (i = 0; (RDINDOOR(raid_dev) & 0x2) && (i < 1000); i++) {
2860 con_log(CL_ANN, (KERN_WARNING
2861 "megaraid mailbox: could not acknowledge\n"));
2868 status = mbox->status;
2870 // invalidate the completed command id array. After command
2871 // completion, firmware would write the valid id.
2872 mbox->numstatus = 0xFF;
2873 mbox->status = 0xFF;
2874 for (i = 0; i < MBOX_MAX_FIRMWARE_STATUS; i++) {
2875 mbox->completed[i] = 0xFF;
2882 con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n") );
2888 * mbox_post_sync_cmd_fast - blocking command to the mailbox based controllers
2889 * @adapter - controller's soft state
2890 * @raw_mbox - the mailbox
2892 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2893 * controllers. This is a faster version of the synchronous command and
2894 * therefore can be called in interrupt-context as well
2897 mbox_post_sync_cmd_fast(adapter_t *adapter, uint8_t raw_mbox[])
2899 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2904 mbox = raid_dev->mbox;
2906 // return immediately if the mailbox is busy
2907 if (mbox->busy) return -1;
2909 // Copy mailbox data into host structure
2910 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 14);
2915 mbox->numstatus = 0xFF;
2916 mbox->status = 0xFF;
2919 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2921 for (i = 0; i < 0xFFFFF; i++) {
2922 if (mbox->numstatus != 0xFF) break;
2927 // We may need to re-calibrate the counter
2928 con_log(CL_ANN, (KERN_CRIT
2929 "megaraid: fast sync command timed out\n"));
2932 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2935 return mbox->status;
2940 * megaraid_busywait_mbox() - Wait until the controller's mailbox is available
2941 * @raid_dev - RAID device (HBA) soft state
2943 * wait until the controller's mailbox is available to accept more commands.
2944 * wait for at most 1 second
2947 megaraid_busywait_mbox(mraid_device_t *raid_dev)
2949 mbox_t *mbox = raid_dev->mbox;
2954 for (i = 0; mbox->busy && i < 1000; i++)
2958 if (i < 1000) return 0;
2964 * megaraid_mbox_product_info - some static information about the controller
2965 * @adapter - our soft state
2967 * issue commands to the controller to grab some parameters required by our
2971 megaraid_mbox_product_info(adapter_t *adapter)
2973 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2975 uint8_t raw_mbox[sizeof(mbox_t)];
2976 mraid_pinfo_t *pinfo;
2977 dma_addr_t pinfo_dma_h;
2978 mraid_inquiry3_t *mraid_inq3;
2982 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
2983 mbox = (mbox_t *)raw_mbox;
2986 * Issue an ENQUIRY3 command to find out certain adapter parameters,
2987 * e.g., max channels, max commands etc.
2989 pinfo = pci_alloc_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
2992 if (pinfo == NULL) {
2993 con_log(CL_ANN, (KERN_WARNING
2994 "megaraid: out of memory, %s %d\n", __FUNCTION__,
2999 memset(pinfo, 0, sizeof(mraid_pinfo_t));
3001 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3002 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3004 raw_mbox[0] = FC_NEW_CONFIG;
3005 raw_mbox[2] = NC_SUBOP_ENQUIRY3;
3006 raw_mbox[3] = ENQ3_GET_SOLICITED_FULL;
3008 // Issue the command
3009 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3011 con_log(CL_ANN, (KERN_WARNING "megaraid: Inquiry3 failed\n"));
3013 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3014 pinfo, pinfo_dma_h);
3020 * Collect information about state of each physical drive
3021 * attached to the controller. We will expose all the disks
3022 * which are not part of RAID
3024 mraid_inq3 = (mraid_inquiry3_t *)adapter->ibuf;
3025 for (i = 0; i < MBOX_MAX_PHYSICAL_DRIVES; i++) {
3026 raid_dev->pdrv_state[i] = mraid_inq3->pdrv_state[i];
3030 * Get product info for information like number of channels,
3031 * maximum commands supported.
3033 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3034 mbox->xferaddr = (uint32_t)pinfo_dma_h;
3036 raw_mbox[0] = FC_NEW_CONFIG;
3037 raw_mbox[2] = NC_SUBOP_PRODUCT_INFO;
3039 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3041 con_log(CL_ANN, (KERN_WARNING
3042 "megaraid: product info failed\n"));
3044 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3045 pinfo, pinfo_dma_h);
3051 * Setup some parameters for host, as required by our caller
3053 adapter->max_channel = pinfo->nchannels;
3056 * we will export all the logical drives on a single channel.
3057 * Add 1 since inquires do not come for inititor ID
3059 adapter->max_target = MAX_LOGICAL_DRIVES_40LD + 1;
3060 adapter->max_lun = 8; // up to 8 LUNs for non-disk devices
3063 * These are the maximum outstanding commands for the scsi-layer
3065 adapter->max_cmds = MBOX_MAX_SCSI_CMDS;
3067 memset(adapter->fw_version, 0, VERSION_SIZE);
3068 memset(adapter->bios_version, 0, VERSION_SIZE);
3070 memcpy(adapter->fw_version, pinfo->fw_version, 4);
3071 adapter->fw_version[4] = 0;
3073 memcpy(adapter->bios_version, pinfo->bios_version, 4);
3074 adapter->bios_version[4] = 0;
3076 con_log(CL_ANN, (KERN_NOTICE
3077 "megaraid: fw version:[%s] bios version:[%s]\n",
3078 adapter->fw_version, adapter->bios_version));
3080 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t), pinfo,
3089 * megaraid_mbox_extended_cdb - check for support for extended CDBs
3090 * @adapter - soft state for the controller
3092 * this routine check whether the controller in question supports extended
3093 * ( > 10 bytes ) CDBs
3096 megaraid_mbox_extended_cdb(adapter_t *adapter)
3099 uint8_t raw_mbox[sizeof(mbox_t)];
3102 mbox = (mbox_t *)raw_mbox;
3104 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3105 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3107 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3109 raw_mbox[0] = MAIN_MISC_OPCODE;
3110 raw_mbox[2] = SUPPORT_EXT_CDB;
3116 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3125 * megaraid_mbox_support_ha - Do we support clustering
3126 * @adapter - soft state for the controller
3127 * @init_id - ID of the initiator
3129 * Determine if the firmware supports clustering and the ID of the initiator.
3132 megaraid_mbox_support_ha(adapter_t *adapter, uint16_t *init_id)
3135 uint8_t raw_mbox[sizeof(mbox_t)];
3139 mbox = (mbox_t *)raw_mbox;
3141 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3143 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3145 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3147 raw_mbox[0] = GET_TARGET_ID;
3149 // Issue the command
3152 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3154 *init_id = *(uint8_t *)adapter->ibuf;
3156 con_log(CL_ANN, (KERN_INFO
3157 "megaraid: cluster firmware, initiator ID: %d\n",
3168 * megaraid_mbox_support_random_del - Do we support random deletion
3169 * @adapter - soft state for the controller
3171 * Determine if the firmware supports random deletion
3172 * Return: 1 is operation supported, 0 otherwise
3175 megaraid_mbox_support_random_del(adapter_t *adapter)
3178 uint8_t raw_mbox[sizeof(mbox_t)];
3182 mbox = (mbox_t *)raw_mbox;
3184 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3186 raw_mbox[0] = FC_DEL_LOGDRV;
3187 raw_mbox[2] = OP_SUP_DEL_LOGDRV;
3189 // Issue the command
3191 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3193 con_log(CL_DLEVEL1, ("megaraid: supports random deletion\n"));
3203 * megaraid_mbox_get_max_sg - maximum sg elements supported by the firmware
3204 * @adapter - soft state for the controller
3206 * Find out the maximum number of scatter-gather elements supported by the
3210 megaraid_mbox_get_max_sg(adapter_t *adapter)
3213 uint8_t raw_mbox[sizeof(mbox_t)];
3217 mbox = (mbox_t *)raw_mbox;
3219 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3221 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3223 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3225 raw_mbox[0] = MAIN_MISC_OPCODE;
3226 raw_mbox[2] = GET_MAX_SG_SUPPORT;
3228 // Issue the command
3229 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3230 nsg = *(uint8_t *)adapter->ibuf;
3233 nsg = MBOX_DEFAULT_SG_SIZE;
3236 if (nsg > MBOX_MAX_SG_SIZE) nsg = MBOX_MAX_SG_SIZE;
3243 * megaraid_mbox_enum_raid_scsi - enumerate the RAID and SCSI channels
3244 * @adapter - soft state for the controller
3246 * Enumerate the RAID and SCSI channels for ROMB platoforms so that channels
3247 * can be exported as regular SCSI channels
3250 megaraid_mbox_enum_raid_scsi(adapter_t *adapter)
3252 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3254 uint8_t raw_mbox[sizeof(mbox_t)];
3257 mbox = (mbox_t *)raw_mbox;
3259 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3261 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3263 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3265 raw_mbox[0] = CHNL_CLASS;
3266 raw_mbox[2] = GET_CHNL_CLASS;
3268 // Issue the command. If the command fails, all channels are RAID
3270 raid_dev->channel_class = 0xFF;
3271 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3272 raid_dev->channel_class = *(uint8_t *)adapter->ibuf;
3280 * megaraid_mbox_flush_cache - flush adapter and disks cache
3281 * @param adapter : soft state for the controller
3283 * Flush adapter cache followed by disks cache
3286 megaraid_mbox_flush_cache(adapter_t *adapter)
3289 uint8_t raw_mbox[sizeof(mbox_t)];
3292 mbox = (mbox_t *)raw_mbox;
3294 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3296 raw_mbox[0] = FLUSH_ADAPTER;
3298 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3299 con_log(CL_ANN, ("megaraid: flush adapter failed\n"));
3302 raw_mbox[0] = FLUSH_SYSTEM;
3304 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3305 con_log(CL_ANN, ("megaraid: flush disks cache failed\n"));
3313 * megaraid_mbox_display_scb - display SCB information, mostly debug purposes
3314 * @param adapter : controllers' soft state
3315 * @param scb : SCB to be displayed
3316 * @param level : debug level for console print
3318 * Diplay information about the given SCB iff the current debug level is
3322 megaraid_mbox_display_scb(adapter_t *adapter, scb_t *scb)
3325 struct scsi_cmnd *scp;
3331 ccb = (mbox_ccb_t *)scb->ccb;
3337 con_log(level, (KERN_NOTICE
3338 "megaraid mailbox: status:%#x cmd:%#x id:%#x ", scb->status,
3339 mbox->cmd, scb->sno));
3341 con_log(level, ("sec:%#x lba:%#x addr:%#x ld:%d sg:%d\n",
3342 mbox->numsectors, mbox->lba, mbox->xferaddr, mbox->logdrv,
3347 con_log(level, (KERN_NOTICE "scsi cmnd: "));
3349 for (i = 0; i < scp->cmd_len; i++) {
3350 con_log(level, ("%#2.02x ", scp->cmnd[i]));
3353 con_log(level, ("\n"));
3360 * megaraid_mbox_setup_device_map - manage device ids
3361 * @adapter : Driver's soft state
3363 * Manange the device ids to have an appropraite mapping between the kernel
3364 * scsi addresses and megaraid scsi and logical drive addresses. We export
3365 * scsi devices on their actual addresses, whereas the logical drives are
3366 * exported on a virtual scsi channel.
3369 megaraid_mbox_setup_device_map(adapter_t *adapter)
3375 * First fill the values on the logical drive channel
3377 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3378 adapter->device_ids[adapter->max_channel][t] =
3379 (t < adapter->init_id) ? t : t - 1;
3381 adapter->device_ids[adapter->max_channel][adapter->init_id] = 0xFF;
3384 * Fill the values on the physical devices channels
3386 for (c = 0; c < adapter->max_channel; c++)
3387 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3388 adapter->device_ids[c][t] = (c << 8) | t;
3393 * END: internal commands library
3397 * START: Interface for the common management module
3399 * This is the module, which interfaces with the common mangement module to
3400 * provide support for ioctl and sysfs
3404 * megaraid_cmm_register - register with the mangement module
3405 * @param adapter : HBA soft state
3407 * Register with the management module, which allows applications to issue
3408 * ioctl calls to the drivers. This interface is used by the management module
3409 * to setup sysfs support as well.
3412 megaraid_cmm_register(adapter_t *adapter)
3414 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3421 // Allocate memory for the base list of scb for management module.
3422 adapter->uscb_list = kmalloc(sizeof(scb_t) * MBOX_MAX_USER_CMDS,
3425 if (adapter->uscb_list == NULL) {
3426 con_log(CL_ANN, (KERN_WARNING
3427 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3431 memset(adapter->uscb_list, 0, sizeof(scb_t) * MBOX_MAX_USER_CMDS);
3434 // Initialize the synchronization parameters for resources for
3435 // commands for management module
3436 INIT_LIST_HEAD(&adapter->uscb_pool);
3438 spin_lock_init(USER_FREE_LIST_LOCK(adapter));
3442 // link all the packets. Note, CCB for commands, coming from the
3443 // commom management module, mailbox physical address are already
3444 // setup by it. We just need placeholder for that in our local command
3446 for (i = 0; i < MBOX_MAX_USER_CMDS; i++) {
3448 scb = adapter->uscb_list + i;
3449 ccb = raid_dev->uccb_list + i;
3451 scb->ccb = (caddr_t)ccb;
3452 ccb->mbox64 = raid_dev->umbox64 + i;
3453 ccb->mbox = &ccb->mbox64->mbox32;
3454 ccb->raw_mbox = (uint8_t *)ccb->mbox;
3458 // COMMAND ID 0 - (MBOX_MAX_SCSI_CMDS-1) ARE RESERVED FOR
3459 // COMMANDS COMING FROM IO SUBSYSTEM (MID-LAYER)
3460 scb->sno = i + MBOX_MAX_SCSI_CMDS;
3463 scb->state = SCB_FREE;
3464 scb->dma_direction = PCI_DMA_NONE;
3465 scb->dma_type = MRAID_DMA_NONE;
3466 scb->dev_channel = -1;
3467 scb->dev_target = -1;
3469 // put scb in the free pool
3470 list_add_tail(&scb->list, &adapter->uscb_pool);
3473 adp.unique_id = adapter->unique_id;
3474 adp.drvr_type = DRVRTYPE_MBOX;
3475 adp.drvr_data = (unsigned long)adapter;
3476 adp.pdev = adapter->pdev;
3477 adp.issue_uioc = megaraid_mbox_mm_handler;
3479 adp.max_kioc = MBOX_MAX_USER_CMDS;
3481 if ((rval = mraid_mm_register_adp(&adp)) != 0) {
3483 con_log(CL_ANN, (KERN_WARNING
3484 "megaraid mbox: did not register with CMM\n"));
3486 kfree(adapter->uscb_list);
3494 * megaraid_cmm_unregister - un-register with the mangement module
3495 * @param adapter : HBA soft state
3497 * Un-register with the management module.
3498 * FIXME: mgmt module must return failure for unregister if it has pending
3502 megaraid_cmm_unregister(adapter_t *adapter)
3504 kfree(adapter->uscb_list);
3505 mraid_mm_unregister_adp(adapter->unique_id);
3511 * megaraid_mbox_mm_handler - interface for CMM to issue commands to LLD
3512 * @param drvr_data : LLD specific data
3513 * @param kioc : CMM interface packet
3514 * @param action : command action
3516 * This routine is invoked whenever the Common Mangement Module (CMM) has a
3517 * command for us. The 'action' parameter specifies if this is a new command
3521 megaraid_mbox_mm_handler(unsigned long drvr_data, uioc_t *kioc, uint32_t action)
3525 if (action != IOCTL_ISSUE) {
3526 con_log(CL_ANN, (KERN_WARNING
3527 "megaraid: unsupported management action:%#2x\n",
3532 adapter = (adapter_t *)drvr_data;
3534 // make sure this adapter is not being detached right now.
3535 if (atomic_read(&adapter->being_detached)) {
3536 con_log(CL_ANN, (KERN_WARNING
3537 "megaraid: reject management request, detaching\n"));
3541 switch (kioc->opcode) {
3545 kioc->status = gather_hbainfo(adapter, (mraid_hba_info_t *)
3546 (unsigned long)kioc->buf_vaddr);
3550 return kioc->status;
3554 return megaraid_mbox_mm_command(adapter, kioc);
3557 kioc->status = (-EINVAL);
3562 return 0; // not reached
3566 * megaraid_mbox_mm_command - issues commands routed through CMM
3567 * @param adapter : HBA soft state
3568 * @param kioc : management command packet
3570 * Issues commands, which are routed through the management module.
3573 megaraid_mbox_mm_command(adapter_t *adapter, uioc_t *kioc)
3575 struct list_head *head = &adapter->uscb_pool;
3580 unsigned long flags;
3582 // detach one scb from free pool
3583 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3585 if (list_empty(head)) { // should never happen because of CMM
3587 con_log(CL_ANN, (KERN_WARNING
3588 "megaraid mbox: bug in cmm handler, lost resources\n"));
3590 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3595 scb = list_entry(head->next, scb_t, list);
3596 list_del_init(&scb->list);
3598 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3600 scb->state = SCB_ACTIVE;
3601 scb->dma_type = MRAID_DMA_NONE;
3602 scb->dma_direction = PCI_DMA_NONE;
3604 ccb = (mbox_ccb_t *)scb->ccb;
3605 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3606 raw_mbox = (uint8_t *)&mbox64->mbox32;
3608 memcpy(ccb->mbox64, mbox64, sizeof(mbox64_t));
3610 scb->gp = (unsigned long)kioc;
3613 * If it is a logdrv random delete operation, we have to wait till
3614 * there are no outstanding cmds at the fw and then issue it directly
3616 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3618 if (wait_till_fw_empty(adapter)) {
3619 con_log(CL_ANN, (KERN_NOTICE
3620 "megaraid mbox: LD delete, timed out\n"));
3622 kioc->status = -ETIME;
3626 megaraid_mbox_mm_done(adapter, scb);
3631 INIT_LIST_HEAD(&scb->list);
3633 scb->state = SCB_ISSUED;
3634 if (mbox_post_cmd(adapter, scb) != 0) {
3636 con_log(CL_ANN, (KERN_NOTICE
3637 "megaraid mbox: LD delete, mailbox busy\n"));
3639 kioc->status = -EBUSY;
3643 megaraid_mbox_mm_done(adapter, scb);
3651 // put the command on the pending list and execute
3652 megaraid_mbox_runpendq(adapter, scb);
3659 wait_till_fw_empty(adapter_t *adapter)
3661 unsigned long flags = 0;
3666 * Set the quiescent flag to stop issuing cmds to FW.
3668 spin_lock_irqsave(&adapter->lock, flags);
3669 adapter->quiescent++;
3670 spin_unlock_irqrestore(&adapter->lock, flags);
3673 * Wait till there are no more cmds outstanding at FW. Try for at most
3676 for (i = 0; i < 60 && adapter->outstanding_cmds; i++) {
3677 con_log(CL_DLEVEL1, (KERN_INFO
3678 "megaraid: FW has %d pending commands\n",
3679 adapter->outstanding_cmds));
3684 return adapter->outstanding_cmds;
3689 * megaraid_mbox_mm_done - callback for CMM commands
3690 * @adapter : HBA soft state
3691 * @scb : completed command
3693 * Callback routine for internal commands originated from the management
3697 megaraid_mbox_mm_done(adapter_t *adapter, scb_t *scb)
3702 unsigned long flags;
3704 kioc = (uioc_t *)scb->gp;
3706 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3707 mbox64->mbox32.status = scb->status;
3708 raw_mbox = (uint8_t *)&mbox64->mbox32;
3711 // put scb in the free pool
3712 scb->state = SCB_FREE;
3715 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3717 list_add(&scb->list, &adapter->uscb_pool);
3719 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3721 // if a delete logical drive operation succeeded, restart the
3723 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3725 adapter->quiescent--;
3727 megaraid_mbox_runpendq(adapter, NULL);
3737 * gather_hbainfo - HBA characteristics for the applications
3738 * @param adapter : HBA soft state
3739 * @param hinfo : pointer to the caller's host info strucuture
3742 gather_hbainfo(adapter_t *adapter, mraid_hba_info_t *hinfo)
3746 dmajor = megaraid_mbox_version[0];
3748 hinfo->pci_vendor_id = adapter->pdev->vendor;
3749 hinfo->pci_device_id = adapter->pdev->device;
3750 hinfo->subsys_vendor_id = adapter->pdev->subsystem_vendor;
3751 hinfo->subsys_device_id = adapter->pdev->subsystem_device;
3753 hinfo->pci_bus = adapter->pdev->bus->number;
3754 hinfo->pci_dev_fn = adapter->pdev->devfn;
3755 hinfo->pci_slot = PCI_SLOT(adapter->pdev->devfn);
3756 hinfo->irq = adapter->host->irq;
3757 hinfo->baseport = ADAP2RAIDDEV(adapter)->baseport;
3759 hinfo->unique_id = (hinfo->pci_bus << 8) | adapter->pdev->devfn;
3760 hinfo->host_no = adapter->host->host_no;
3766 * END: Interface for the common management module
3772 * megaraid_sysfs_alloc_resources - allocate sysfs related resources
3774 * Allocate packets required to issue FW calls whenever the sysfs attributes
3775 * are read. These attributes would require up-to-date information from the
3776 * FW. Also set up resources for mutual exclusion to share these resources and
3779 * @param adapter : controller's soft state
3781 * @return 0 on success
3782 * @return -ERROR_CODE on failure
3785 megaraid_sysfs_alloc_resources(adapter_t *adapter)
3787 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3790 raid_dev->sysfs_uioc = kmalloc(sizeof(uioc_t), GFP_KERNEL);
3792 raid_dev->sysfs_mbox64 = kmalloc(sizeof(mbox64_t), GFP_KERNEL);
3794 raid_dev->sysfs_buffer = pci_alloc_consistent(adapter->pdev,
3795 PAGE_SIZE, &raid_dev->sysfs_buffer_dma);
3797 if (!raid_dev->sysfs_uioc || !raid_dev->sysfs_mbox64 ||
3798 !raid_dev->sysfs_buffer) {
3800 con_log(CL_ANN, (KERN_WARNING
3801 "megaraid: out of memory, %s %d\n", __FUNCTION__,
3806 megaraid_sysfs_free_resources(adapter);
3809 sema_init(&raid_dev->sysfs_sem, 1);
3811 init_waitqueue_head(&raid_dev->sysfs_wait_q);
3818 * megaraid_sysfs_free_resources - free sysfs related resources
3820 * Free packets allocated for sysfs FW commands
3822 * @param adapter : controller's soft state
3825 megaraid_sysfs_free_resources(adapter_t *adapter)
3827 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3829 kfree(raid_dev->sysfs_uioc);
3830 kfree(raid_dev->sysfs_mbox64);
3832 if (raid_dev->sysfs_buffer) {
3833 pci_free_consistent(adapter->pdev, PAGE_SIZE,
3834 raid_dev->sysfs_buffer, raid_dev->sysfs_buffer_dma);
3840 * megaraid_sysfs_get_ldmap_done - callback for get ldmap
3842 * Callback routine called in the ISR/tasklet context for get ldmap call
3844 * @param uioc : completed packet
3847 megaraid_sysfs_get_ldmap_done(uioc_t *uioc)
3849 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3850 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3854 wake_up(&raid_dev->sysfs_wait_q);
3859 * megaraid_sysfs_get_ldmap_timeout - timeout handling for get ldmap
3861 * Timeout routine to recover and return to application, in case the adapter
3862 * has stopped responding. A timeout of 60 seconds for this command seem like
3865 * @param uioc : timed out packet
3868 megaraid_sysfs_get_ldmap_timeout(unsigned long data)
3870 uioc_t *uioc = (uioc_t *)data;
3871 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3872 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3874 uioc->status = -ETIME;
3876 wake_up(&raid_dev->sysfs_wait_q);
3881 * megaraid_sysfs_get_ldmap - get update logical drive map
3883 * This routine will be called whenever user reads the logical drive
3884 * attributes, go get the current logical drive mapping table from the
3885 * firmware. We use the managment API's to issue commands to the controller.
3887 * NOTE: The commands issuance functionality is not generalized and
3888 * implemented in context of "get ld map" command only. If required, the
3889 * command issuance logical can be trivially pulled out and implemented as a
3890 * standalone libary. For now, this should suffice since there is no other
3891 * user of this interface.
3893 * @param adapter : controller's soft state
3895 * @return 0 on success
3896 * @return -1 on failure
3899 megaraid_sysfs_get_ldmap(adapter_t *adapter)
3901 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3906 struct timer_list sysfs_timer;
3907 struct timer_list *timerp;
3912 * Allow only one read at a time to go through the sysfs attributes
3914 down(&raid_dev->sysfs_sem);
3916 uioc = raid_dev->sysfs_uioc;
3917 mbox64 = raid_dev->sysfs_mbox64;
3918 ldmap = raid_dev->sysfs_buffer;
3920 memset(uioc, 0, sizeof(uioc_t));
3921 memset(mbox64, 0, sizeof(mbox64_t));
3922 memset(ldmap, 0, sizeof(raid_dev->curr_ldmap));
3924 mbox = &mbox64->mbox32;
3925 raw_mbox = (char *)mbox;
3926 uioc->cmdbuf = (uint64_t)(unsigned long)mbox64;
3927 uioc->buf_vaddr = (caddr_t)adapter;
3928 uioc->status = -ENODATA;
3929 uioc->done = megaraid_sysfs_get_ldmap_done;
3932 * Prepare the mailbox packet to get the current logical drive mapping
3935 mbox->xferaddr = (uint32_t)raid_dev->sysfs_buffer_dma;
3937 raw_mbox[0] = FC_DEL_LOGDRV;
3938 raw_mbox[2] = OP_GET_LDID_MAP;
3941 * Setup a timer to recover from a non-responding controller
3943 timerp = &sysfs_timer;
3946 timerp->function = megaraid_sysfs_get_ldmap_timeout;
3947 timerp->data = (unsigned long)uioc;
3948 timerp->expires = jiffies + 60 * HZ;
3953 * Send the command to the firmware
3955 rval = megaraid_mbox_mm_command(adapter, uioc);
3957 if (rval == 0) { // command successfully issued
3958 wait_event(raid_dev->sysfs_wait_q, (uioc->status != -ENODATA));
3961 * Check if the command timed out
3963 if (uioc->status == -ETIME) {
3964 con_log(CL_ANN, (KERN_NOTICE
3965 "megaraid: sysfs get ld map timed out\n"));
3970 rval = mbox->status;
3974 memcpy(raid_dev->curr_ldmap, ldmap,
3975 sizeof(raid_dev->curr_ldmap));
3978 con_log(CL_ANN, (KERN_NOTICE
3979 "megaraid: get ld map failed with %x\n", rval));
3983 con_log(CL_ANN, (KERN_NOTICE
3984 "megaraid: could not issue ldmap command:%x\n", rval));
3988 del_timer_sync(timerp);
3990 up(&raid_dev->sysfs_sem);
3997 * megaraid_sysfs_show_app_hndl - display application handle for this adapter
3999 * Display the handle used by the applications while executing management
4000 * tasks on the adapter. We invoke a management module API to get the adapter
4001 * handle, since we do not interface with applications directly.
4003 * @param cdev : class device object representation for the host
4004 * @param buf : buffer to send data to
4007 megaraid_sysfs_show_app_hndl(struct class_device *cdev, char *buf)
4009 struct Scsi_Host *shost = class_to_shost(cdev);
4010 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(shost);
4013 app_hndl = mraid_mm_adapter_app_handle(adapter->unique_id);
4015 return snprintf(buf, 8, "%u\n", app_hndl);
4020 * megaraid_sysfs_show_ldnum - display the logical drive number for this device
4022 * Display the logical drive number for the device in question, if it a valid
4023 * logical drive. For physical devices, "-1" is returned
4024 * The logical drive number is displayed in following format
4026 * <SCSI ID> <LD NUM> <LD STICKY ID> <APP ADAPTER HANDLE>
4027 * <int> <int> <int> <int>
4029 * @param dev : device object representation for the scsi device
4030 * @param buf : buffer to send data to
4033 megaraid_sysfs_show_ldnum(struct device *dev, struct device_attribute *attr, char *buf)
4035 struct scsi_device *sdev = to_scsi_device(dev);
4036 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(sdev->host);
4037 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4039 int logical_drv = -1;
4041 uint32_t app_hndl = 0;
4046 if (raid_dev->random_del_supported &&
4047 MRAID_IS_LOGICAL_SDEV(adapter, sdev)) {
4049 rval = megaraid_sysfs_get_ldmap(adapter);
4052 for (i = 0; i < MAX_LOGICAL_DRIVES_40LD; i++) {
4054 mapped_sdev_id = sdev->id;
4056 if (sdev->id > adapter->init_id) {
4057 mapped_sdev_id -= 1;
4060 if (raid_dev->curr_ldmap[i] == mapped_sdev_id) {
4066 ldid_map = raid_dev->curr_ldmap[i];
4068 app_hndl = mraid_mm_adapter_app_handle(
4069 adapter->unique_id);
4076 con_log(CL_ANN, (KERN_NOTICE
4077 "megaraid: sysfs get ld map failed: %x\n",
4082 return snprintf(buf, 36, "%d %d %d %d\n", scsi_id, logical_drv,
4083 ldid_map, app_hndl);
4088 * END: Mailbox Low Level Driver
4090 module_init(megaraid_init);
4091 module_exit(megaraid_exit);
4093 /* vim: set ts=8 sw=8 tw=78 ai si: */