Merge branch 'master' of git://git.kernel.org/pub/scm/linux/kernel/git/linville/wirel...
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / megaraid / megaraid_mbox.c
blob1dba32870b4c16cc58cbb4ed28d74b370bb39c57
1 /*
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.5.1 (Nov 16 2006)
15 * Authors:
16 * Atul Mukker <Atul.Mukker@lsi.com>
17 * Sreenivas Bagalkote <Sreenivas.Bagalkote@lsi.com>
18 * Manoj Jose <Manoj.Jose@lsi.com>
19 * Seokmann Ju
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 <linux/slab.h>
74 #include "megaraid_mbox.h"
76 static int megaraid_init(void);
77 static void megaraid_exit(void);
79 static int megaraid_probe_one(struct pci_dev*, const struct pci_device_id *);
80 static void megaraid_detach_one(struct pci_dev *);
81 static void megaraid_mbox_shutdown(struct pci_dev *);
83 static int megaraid_io_attach(adapter_t *);
84 static void megaraid_io_detach(adapter_t *);
86 static int megaraid_init_mbox(adapter_t *);
87 static void megaraid_fini_mbox(adapter_t *);
89 static int megaraid_alloc_cmd_packets(adapter_t *);
90 static void megaraid_free_cmd_packets(adapter_t *);
92 static int megaraid_mbox_setup_dma_pools(adapter_t *);
93 static void megaraid_mbox_teardown_dma_pools(adapter_t *);
95 static int megaraid_sysfs_alloc_resources(adapter_t *);
96 static void megaraid_sysfs_free_resources(adapter_t *);
98 static int megaraid_abort_handler(struct scsi_cmnd *);
99 static int megaraid_reset_handler(struct scsi_cmnd *);
101 static int mbox_post_sync_cmd(adapter_t *, uint8_t []);
102 static int mbox_post_sync_cmd_fast(adapter_t *, uint8_t []);
103 static int megaraid_busywait_mbox(mraid_device_t *);
104 static int megaraid_mbox_product_info(adapter_t *);
105 static int megaraid_mbox_extended_cdb(adapter_t *);
106 static int megaraid_mbox_support_ha(adapter_t *, uint16_t *);
107 static int megaraid_mbox_support_random_del(adapter_t *);
108 static int megaraid_mbox_get_max_sg(adapter_t *);
109 static void megaraid_mbox_enum_raid_scsi(adapter_t *);
110 static void megaraid_mbox_flush_cache(adapter_t *);
111 static int megaraid_mbox_fire_sync_cmd(adapter_t *);
113 static void megaraid_mbox_display_scb(adapter_t *, scb_t *);
114 static void megaraid_mbox_setup_device_map(adapter_t *);
116 static int megaraid_queue_command(struct Scsi_Host *, struct scsi_cmnd *);
117 static scb_t *megaraid_mbox_build_cmd(adapter_t *, struct scsi_cmnd *, int *);
118 static void megaraid_mbox_runpendq(adapter_t *, scb_t *);
119 static void megaraid_mbox_prepare_pthru(adapter_t *, scb_t *,
120 struct scsi_cmnd *);
121 static void megaraid_mbox_prepare_epthru(adapter_t *, scb_t *,
122 struct scsi_cmnd *);
124 static irqreturn_t megaraid_isr(int, void *);
126 static void megaraid_mbox_dpc(unsigned long);
128 static ssize_t megaraid_sysfs_show_app_hndl(struct device *, struct device_attribute *attr, char *);
129 static ssize_t megaraid_sysfs_show_ldnum(struct device *, struct device_attribute *attr, char *);
131 static int megaraid_cmm_register(adapter_t *);
132 static int megaraid_cmm_unregister(adapter_t *);
133 static int megaraid_mbox_mm_handler(unsigned long, uioc_t *, uint32_t);
134 static int megaraid_mbox_mm_command(adapter_t *, uioc_t *);
135 static void megaraid_mbox_mm_done(adapter_t *, scb_t *);
136 static int gather_hbainfo(adapter_t *, mraid_hba_info_t *);
137 static int wait_till_fw_empty(adapter_t *);
141 MODULE_AUTHOR("megaraidlinux@lsi.com");
142 MODULE_DESCRIPTION("LSI Logic MegaRAID Mailbox Driver");
143 MODULE_LICENSE("GPL");
144 MODULE_VERSION(MEGARAID_VERSION);
147 * ### modules parameters for driver ###
151 * Set to enable driver to expose unconfigured disk to kernel
153 static int megaraid_expose_unconf_disks = 0;
154 module_param_named(unconf_disks, megaraid_expose_unconf_disks, int, 0);
155 MODULE_PARM_DESC(unconf_disks,
156 "Set to expose unconfigured disks to kernel (default=0)");
159 * driver wait time if the adapter's mailbox is busy
161 static unsigned int max_mbox_busy_wait = MBOX_BUSY_WAIT;
162 module_param_named(busy_wait, max_mbox_busy_wait, int, 0);
163 MODULE_PARM_DESC(busy_wait,
164 "Max wait for mailbox in microseconds if busy (default=10)");
167 * number of sectors per IO command
169 static unsigned int megaraid_max_sectors = MBOX_MAX_SECTORS;
170 module_param_named(max_sectors, megaraid_max_sectors, int, 0);
171 MODULE_PARM_DESC(max_sectors,
172 "Maximum number of sectors per IO command (default=128)");
175 * number of commands per logical unit
177 static unsigned int megaraid_cmd_per_lun = MBOX_DEF_CMD_PER_LUN;
178 module_param_named(cmd_per_lun, megaraid_cmd_per_lun, int, 0);
179 MODULE_PARM_DESC(cmd_per_lun,
180 "Maximum number of commands per logical unit (default=64)");
184 * Fast driver load option, skip scanning for physical devices during load.
185 * This would result in non-disk devices being skipped during driver load
186 * time. These can be later added though, using /proc/scsi/scsi
188 static unsigned int megaraid_fast_load = 0;
189 module_param_named(fast_load, megaraid_fast_load, int, 0);
190 MODULE_PARM_DESC(fast_load,
191 "Faster loading of the driver, skips physical devices! (default=0)");
195 * mraid_debug level - threshold for amount of information to be displayed by
196 * the driver. This level can be changed through modules parameters, ioctl or
197 * sysfs/proc interface. By default, print the announcement messages only.
199 int mraid_debug_level = CL_ANN;
200 module_param_named(debug_level, mraid_debug_level, int, 0);
201 MODULE_PARM_DESC(debug_level, "Debug level for driver (default=0)");
204 * ### global data ###
206 static uint8_t megaraid_mbox_version[8] =
207 { 0x02, 0x20, 0x04, 0x06, 3, 7, 20, 5 };
211 * PCI table for all supported controllers.
213 static struct pci_device_id pci_id_table_g[] = {
215 PCI_VENDOR_ID_DELL,
216 PCI_DEVICE_ID_PERC4_DI_DISCOVERY,
217 PCI_VENDOR_ID_DELL,
218 PCI_SUBSYS_ID_PERC4_DI_DISCOVERY,
221 PCI_VENDOR_ID_LSI_LOGIC,
222 PCI_DEVICE_ID_PERC4_SC,
223 PCI_VENDOR_ID_DELL,
224 PCI_SUBSYS_ID_PERC4_SC,
227 PCI_VENDOR_ID_LSI_LOGIC,
228 PCI_DEVICE_ID_PERC4_DC,
229 PCI_VENDOR_ID_DELL,
230 PCI_SUBSYS_ID_PERC4_DC,
233 PCI_VENDOR_ID_LSI_LOGIC,
234 PCI_DEVICE_ID_VERDE,
235 PCI_ANY_ID,
236 PCI_ANY_ID,
239 PCI_VENDOR_ID_DELL,
240 PCI_DEVICE_ID_PERC4_DI_EVERGLADES,
241 PCI_VENDOR_ID_DELL,
242 PCI_SUBSYS_ID_PERC4_DI_EVERGLADES,
245 PCI_VENDOR_ID_DELL,
246 PCI_DEVICE_ID_PERC4E_SI_BIGBEND,
247 PCI_VENDOR_ID_DELL,
248 PCI_SUBSYS_ID_PERC4E_SI_BIGBEND,
251 PCI_VENDOR_ID_DELL,
252 PCI_DEVICE_ID_PERC4E_DI_KOBUK,
253 PCI_VENDOR_ID_DELL,
254 PCI_SUBSYS_ID_PERC4E_DI_KOBUK,
257 PCI_VENDOR_ID_DELL,
258 PCI_DEVICE_ID_PERC4E_DI_CORVETTE,
259 PCI_VENDOR_ID_DELL,
260 PCI_SUBSYS_ID_PERC4E_DI_CORVETTE,
263 PCI_VENDOR_ID_DELL,
264 PCI_DEVICE_ID_PERC4E_DI_EXPEDITION,
265 PCI_VENDOR_ID_DELL,
266 PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION,
269 PCI_VENDOR_ID_DELL,
270 PCI_DEVICE_ID_PERC4E_DI_GUADALUPE,
271 PCI_VENDOR_ID_DELL,
272 PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE,
275 PCI_VENDOR_ID_LSI_LOGIC,
276 PCI_DEVICE_ID_DOBSON,
277 PCI_ANY_ID,
278 PCI_ANY_ID,
281 PCI_VENDOR_ID_AMI,
282 PCI_DEVICE_ID_AMI_MEGARAID3,
283 PCI_ANY_ID,
284 PCI_ANY_ID,
287 PCI_VENDOR_ID_LSI_LOGIC,
288 PCI_DEVICE_ID_AMI_MEGARAID3,
289 PCI_ANY_ID,
290 PCI_ANY_ID,
293 PCI_VENDOR_ID_LSI_LOGIC,
294 PCI_DEVICE_ID_LINDSAY,
295 PCI_ANY_ID,
296 PCI_ANY_ID,
298 {0} /* Terminating entry */
300 MODULE_DEVICE_TABLE(pci, pci_id_table_g);
303 static struct pci_driver megaraid_pci_driver = {
304 .name = "megaraid",
305 .id_table = pci_id_table_g,
306 .probe = megaraid_probe_one,
307 .remove = __devexit_p(megaraid_detach_one),
308 .shutdown = megaraid_mbox_shutdown,
313 // definitions for the device attributes for exporting logical drive number
314 // for a scsi address (Host, Channel, Id, Lun)
316 DEVICE_ATTR(megaraid_mbox_app_hndl, S_IRUSR, megaraid_sysfs_show_app_hndl,
317 NULL);
319 // Host template initializer for megaraid mbox sysfs device attributes
320 static struct device_attribute *megaraid_shost_attrs[] = {
321 &dev_attr_megaraid_mbox_app_hndl,
322 NULL,
326 DEVICE_ATTR(megaraid_mbox_ld, S_IRUSR, megaraid_sysfs_show_ldnum, NULL);
328 // Host template initializer for megaraid mbox sysfs device attributes
329 static struct device_attribute *megaraid_sdev_attrs[] = {
330 &dev_attr_megaraid_mbox_ld,
331 NULL,
335 * megaraid_change_queue_depth - Change the device's queue depth
336 * @sdev: scsi device struct
337 * @qdepth: depth to set
338 * @reason: calling context
340 * Return value:
341 * actual depth set
343 static int megaraid_change_queue_depth(struct scsi_device *sdev, int qdepth,
344 int reason)
346 if (reason != SCSI_QDEPTH_DEFAULT)
347 return -EOPNOTSUPP;
349 if (qdepth > MBOX_MAX_SCSI_CMDS)
350 qdepth = MBOX_MAX_SCSI_CMDS;
351 scsi_adjust_queue_depth(sdev, 0, qdepth);
352 return sdev->queue_depth;
356 * Scsi host template for megaraid unified driver
358 static struct scsi_host_template megaraid_template_g = {
359 .module = THIS_MODULE,
360 .name = "LSI Logic MegaRAID driver",
361 .proc_name = "megaraid",
362 .queuecommand = megaraid_queue_command,
363 .eh_abort_handler = megaraid_abort_handler,
364 .eh_device_reset_handler = megaraid_reset_handler,
365 .eh_bus_reset_handler = megaraid_reset_handler,
366 .eh_host_reset_handler = megaraid_reset_handler,
367 .change_queue_depth = megaraid_change_queue_depth,
368 .use_clustering = ENABLE_CLUSTERING,
369 .sdev_attrs = megaraid_sdev_attrs,
370 .shost_attrs = megaraid_shost_attrs,
375 * megaraid_init - module load hook
377 * We register ourselves as hotplug enabled module and let PCI subsystem
378 * discover our adapters.
380 static int __init
381 megaraid_init(void)
383 int rval;
385 // Announce the driver version
386 con_log(CL_ANN, (KERN_INFO "megaraid: %s %s\n", MEGARAID_VERSION,
387 MEGARAID_EXT_VERSION));
389 // check validity of module parameters
390 if (megaraid_cmd_per_lun > MBOX_MAX_SCSI_CMDS) {
392 con_log(CL_ANN, (KERN_WARNING
393 "megaraid mailbox: max commands per lun reset to %d\n",
394 MBOX_MAX_SCSI_CMDS));
396 megaraid_cmd_per_lun = MBOX_MAX_SCSI_CMDS;
400 // register as a PCI hot-plug driver module
401 rval = pci_register_driver(&megaraid_pci_driver);
402 if (rval < 0) {
403 con_log(CL_ANN, (KERN_WARNING
404 "megaraid: could not register hotplug support.\n"));
407 return rval;
412 * megaraid_exit - driver unload entry point
414 * We simply unwrap the megaraid_init routine here.
416 static void __exit
417 megaraid_exit(void)
419 con_log(CL_DLEVEL1, (KERN_NOTICE "megaraid: unloading framework\n"));
421 // unregister as PCI hotplug driver
422 pci_unregister_driver(&megaraid_pci_driver);
424 return;
429 * megaraid_probe_one - PCI hotplug entry point
430 * @pdev : handle to this controller's PCI configuration space
431 * @id : pci device id of the class of controllers
433 * This routine should be called whenever a new adapter is detected by the
434 * PCI hotplug susbsystem.
436 static int __devinit
437 megaraid_probe_one(struct pci_dev *pdev, const struct pci_device_id *id)
439 adapter_t *adapter;
442 // detected a new controller
443 con_log(CL_ANN, (KERN_INFO
444 "megaraid: probe new device %#4.04x:%#4.04x:%#4.04x:%#4.04x: ",
445 pdev->vendor, pdev->device, pdev->subsystem_vendor,
446 pdev->subsystem_device));
448 con_log(CL_ANN, ("bus %d:slot %d:func %d\n", pdev->bus->number,
449 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn)));
451 if (pci_enable_device(pdev)) {
452 con_log(CL_ANN, (KERN_WARNING
453 "megaraid: pci_enable_device failed\n"));
455 return -ENODEV;
458 // Enable bus-mastering on this controller
459 pci_set_master(pdev);
461 // Allocate the per driver initialization structure
462 adapter = kzalloc(sizeof(adapter_t), GFP_KERNEL);
464 if (adapter == NULL) {
465 con_log(CL_ANN, (KERN_WARNING
466 "megaraid: out of memory, %s %d.\n", __func__, __LINE__));
468 goto out_probe_one;
472 // set up PCI related soft state and other pre-known parameters
473 adapter->unique_id = pdev->bus->number << 8 | pdev->devfn;
474 adapter->irq = pdev->irq;
475 adapter->pdev = pdev;
477 atomic_set(&adapter->being_detached, 0);
479 // Setup the default DMA mask. This would be changed later on
480 // depending on hardware capabilities
481 if (pci_set_dma_mask(adapter->pdev, DMA_BIT_MASK(32)) != 0) {
483 con_log(CL_ANN, (KERN_WARNING
484 "megaraid: pci_set_dma_mask failed:%d\n", __LINE__));
486 goto out_free_adapter;
490 // Initialize the synchronization lock for kernel and LLD
491 spin_lock_init(&adapter->lock);
493 // Initialize the command queues: the list of free SCBs and the list
494 // of pending SCBs.
495 INIT_LIST_HEAD(&adapter->kscb_pool);
496 spin_lock_init(SCSI_FREE_LIST_LOCK(adapter));
498 INIT_LIST_HEAD(&adapter->pend_list);
499 spin_lock_init(PENDING_LIST_LOCK(adapter));
501 INIT_LIST_HEAD(&adapter->completed_list);
502 spin_lock_init(COMPLETED_LIST_LOCK(adapter));
505 // Start the mailbox based controller
506 if (megaraid_init_mbox(adapter) != 0) {
507 con_log(CL_ANN, (KERN_WARNING
508 "megaraid: maibox adapter did not initialize\n"));
510 goto out_free_adapter;
513 // Register with LSI Common Management Module
514 if (megaraid_cmm_register(adapter) != 0) {
516 con_log(CL_ANN, (KERN_WARNING
517 "megaraid: could not register with management module\n"));
519 goto out_fini_mbox;
522 // setup adapter handle in PCI soft state
523 pci_set_drvdata(pdev, adapter);
525 // attach with scsi mid-layer
526 if (megaraid_io_attach(adapter) != 0) {
528 con_log(CL_ANN, (KERN_WARNING "megaraid: io attach failed\n"));
530 goto out_cmm_unreg;
533 return 0;
535 out_cmm_unreg:
536 pci_set_drvdata(pdev, NULL);
537 megaraid_cmm_unregister(adapter);
538 out_fini_mbox:
539 megaraid_fini_mbox(adapter);
540 out_free_adapter:
541 kfree(adapter);
542 out_probe_one:
543 pci_disable_device(pdev);
545 return -ENODEV;
550 * megaraid_detach_one - release framework resources and call LLD release routine
551 * @pdev : handle for our PCI cofiguration space
553 * This routine is called during driver unload. We free all the allocated
554 * resources and call the corresponding LLD so that it can also release all
555 * its resources.
557 * This routine is also called from the PCI hotplug system.
559 static void
560 megaraid_detach_one(struct pci_dev *pdev)
562 adapter_t *adapter;
563 struct Scsi_Host *host;
566 // Start a rollback on this adapter
567 adapter = pci_get_drvdata(pdev);
569 if (!adapter) {
570 con_log(CL_ANN, (KERN_CRIT
571 "megaraid: Invalid detach on %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
572 pdev->vendor, pdev->device, pdev->subsystem_vendor,
573 pdev->subsystem_device));
575 return;
577 else {
578 con_log(CL_ANN, (KERN_NOTICE
579 "megaraid: detaching device %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
580 pdev->vendor, pdev->device, pdev->subsystem_vendor,
581 pdev->subsystem_device));
585 host = adapter->host;
587 // do not allow any more requests from the management module for this
588 // adapter.
589 // FIXME: How do we account for the request which might still be
590 // pending with us?
591 atomic_set(&adapter->being_detached, 1);
593 // detach from the IO sub-system
594 megaraid_io_detach(adapter);
596 // reset the device state in the PCI structure. We check this
597 // condition when we enter here. If the device state is NULL,
598 // that would mean the device has already been removed
599 pci_set_drvdata(pdev, NULL);
601 // Unregister from common management module
603 // FIXME: this must return success or failure for conditions if there
604 // is a command pending with LLD or not.
605 megaraid_cmm_unregister(adapter);
607 // finalize the mailbox based controller and release all resources
608 megaraid_fini_mbox(adapter);
610 kfree(adapter);
612 scsi_host_put(host);
614 pci_disable_device(pdev);
616 return;
621 * megaraid_mbox_shutdown - PCI shutdown for megaraid HBA
622 * @pdev : generic driver model device
624 * Shutdown notification, perform flush cache.
626 static void
627 megaraid_mbox_shutdown(struct pci_dev *pdev)
629 adapter_t *adapter = pci_get_drvdata(pdev);
630 static int counter;
632 if (!adapter) {
633 con_log(CL_ANN, (KERN_WARNING
634 "megaraid: null device in shutdown\n"));
635 return;
638 // flush caches now
639 con_log(CL_ANN, (KERN_INFO "megaraid: flushing adapter %d...",
640 counter++));
642 megaraid_mbox_flush_cache(adapter);
644 con_log(CL_ANN, ("done\n"));
649 * megaraid_io_attach - attach a device with the IO subsystem
650 * @adapter : controller's soft state
652 * Attach this device with the IO subsystem.
654 static int
655 megaraid_io_attach(adapter_t *adapter)
657 struct Scsi_Host *host;
659 // Initialize SCSI Host structure
660 host = scsi_host_alloc(&megaraid_template_g, 8);
661 if (!host) {
662 con_log(CL_ANN, (KERN_WARNING
663 "megaraid mbox: scsi_register failed\n"));
665 return -1;
668 SCSIHOST2ADAP(host) = (caddr_t)adapter;
669 adapter->host = host;
671 host->irq = adapter->irq;
672 host->unique_id = adapter->unique_id;
673 host->can_queue = adapter->max_cmds;
674 host->this_id = adapter->init_id;
675 host->sg_tablesize = adapter->sglen;
676 host->max_sectors = adapter->max_sectors;
677 host->cmd_per_lun = adapter->cmd_per_lun;
678 host->max_channel = adapter->max_channel;
679 host->max_id = adapter->max_target;
680 host->max_lun = adapter->max_lun;
683 // notify mid-layer about the new controller
684 if (scsi_add_host(host, &adapter->pdev->dev)) {
686 con_log(CL_ANN, (KERN_WARNING
687 "megaraid mbox: scsi_add_host failed\n"));
689 scsi_host_put(host);
691 return -1;
694 scsi_scan_host(host);
696 return 0;
701 * megaraid_io_detach - detach a device from the IO subsystem
702 * @adapter : controller's soft state
704 * Detach this device from the IO subsystem.
706 static void
707 megaraid_io_detach(adapter_t *adapter)
709 struct Scsi_Host *host;
711 con_log(CL_DLEVEL1, (KERN_INFO "megaraid: io detach\n"));
713 host = adapter->host;
715 scsi_remove_host(host);
717 return;
722 * START: Mailbox Low Level Driver
724 * This is section specific to the single mailbox based controllers
728 * megaraid_init_mbox - initialize controller
729 * @adapter : our soft state
731 * - Allocate 16-byte aligned mailbox memory for firmware handshake
732 * - Allocate controller's memory resources
733 * - Find out all initialization data
734 * - Allocate memory required for all the commands
735 * - Use internal library of FW routines, build up complete soft state
737 static int __devinit
738 megaraid_init_mbox(adapter_t *adapter)
740 struct pci_dev *pdev;
741 mraid_device_t *raid_dev;
742 int i;
743 uint32_t magic64;
746 adapter->ito = MBOX_TIMEOUT;
747 pdev = adapter->pdev;
750 * Allocate and initialize the init data structure for mailbox
751 * controllers
753 raid_dev = kzalloc(sizeof(mraid_device_t), GFP_KERNEL);
754 if (raid_dev == NULL) return -1;
758 * Attach the adapter soft state to raid device soft state
760 adapter->raid_device = (caddr_t)raid_dev;
761 raid_dev->fast_load = megaraid_fast_load;
764 // our baseport
765 raid_dev->baseport = pci_resource_start(pdev, 0);
767 if (pci_request_regions(pdev, "MegaRAID: LSI Logic Corporation") != 0) {
769 con_log(CL_ANN, (KERN_WARNING
770 "megaraid: mem region busy\n"));
772 goto out_free_raid_dev;
775 raid_dev->baseaddr = ioremap_nocache(raid_dev->baseport, 128);
777 if (!raid_dev->baseaddr) {
779 con_log(CL_ANN, (KERN_WARNING
780 "megaraid: could not map hba memory\n") );
782 goto out_release_regions;
785 /* initialize the mutual exclusion lock for the mailbox */
786 spin_lock_init(&raid_dev->mailbox_lock);
788 /* allocate memory required for commands */
789 if (megaraid_alloc_cmd_packets(adapter) != 0)
790 goto out_iounmap;
793 * Issue SYNC cmd to flush the pending cmds in the adapter
794 * and initialize its internal state
797 if (megaraid_mbox_fire_sync_cmd(adapter))
798 con_log(CL_ANN, ("megaraid: sync cmd failed\n"));
801 * Setup the rest of the soft state using the library of
802 * FW routines
805 /* request IRQ and register the interrupt service routine */
806 if (request_irq(adapter->irq, megaraid_isr, IRQF_SHARED, "megaraid",
807 adapter)) {
809 con_log(CL_ANN, (KERN_WARNING
810 "megaraid: Couldn't register IRQ %d!\n", adapter->irq));
811 goto out_alloc_cmds;
815 // Product info
816 if (megaraid_mbox_product_info(adapter) != 0)
817 goto out_free_irq;
819 // Do we support extended CDBs
820 adapter->max_cdb_sz = 10;
821 if (megaraid_mbox_extended_cdb(adapter) == 0) {
822 adapter->max_cdb_sz = 16;
826 * Do we support cluster environment, if we do, what is the initiator
827 * id.
828 * NOTE: In a non-cluster aware firmware environment, the LLD should
829 * return 7 as initiator id.
831 adapter->ha = 0;
832 adapter->init_id = -1;
833 if (megaraid_mbox_support_ha(adapter, &adapter->init_id) == 0) {
834 adapter->ha = 1;
838 * Prepare the device ids array to have the mapping between the kernel
839 * device address and megaraid device address.
840 * We export the physical devices on their actual addresses. The
841 * logical drives are exported on a virtual SCSI channel
843 megaraid_mbox_setup_device_map(adapter);
845 // If the firmware supports random deletion, update the device id map
846 if (megaraid_mbox_support_random_del(adapter)) {
848 // Change the logical drives numbers in device_ids array one
849 // slot in device_ids is reserved for target id, that's why
850 // "<=" below
851 for (i = 0; i <= MAX_LOGICAL_DRIVES_40LD; i++) {
852 adapter->device_ids[adapter->max_channel][i] += 0x80;
854 adapter->device_ids[adapter->max_channel][adapter->init_id] =
855 0xFF;
857 raid_dev->random_del_supported = 1;
861 * find out the maximum number of scatter-gather elements supported by
862 * this firmware
864 adapter->sglen = megaraid_mbox_get_max_sg(adapter);
866 // enumerate RAID and SCSI channels so that all devices on SCSI
867 // channels can later be exported, including disk devices
868 megaraid_mbox_enum_raid_scsi(adapter);
871 * Other parameters required by upper layer
873 * maximum number of sectors per IO command
875 adapter->max_sectors = megaraid_max_sectors;
878 * number of queued commands per LUN.
880 adapter->cmd_per_lun = megaraid_cmd_per_lun;
883 * Allocate resources required to issue FW calls, when sysfs is
884 * accessed
886 if (megaraid_sysfs_alloc_resources(adapter) != 0)
887 goto out_free_irq;
889 // Set the DMA mask to 64-bit. All supported controllers as capable of
890 // DMA in this range
891 pci_read_config_dword(adapter->pdev, PCI_CONF_AMISIG64, &magic64);
893 if (((magic64 == HBA_SIGNATURE_64_BIT) &&
894 ((adapter->pdev->subsystem_device !=
895 PCI_SUBSYS_ID_MEGARAID_SATA_150_6) &&
896 (adapter->pdev->subsystem_device !=
897 PCI_SUBSYS_ID_MEGARAID_SATA_150_4))) ||
898 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
899 adapter->pdev->device == PCI_DEVICE_ID_VERDE) ||
900 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
901 adapter->pdev->device == PCI_DEVICE_ID_DOBSON) ||
902 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
903 adapter->pdev->device == PCI_DEVICE_ID_LINDSAY) ||
904 (adapter->pdev->vendor == PCI_VENDOR_ID_DELL &&
905 adapter->pdev->device == PCI_DEVICE_ID_PERC4_DI_EVERGLADES) ||
906 (adapter->pdev->vendor == PCI_VENDOR_ID_DELL &&
907 adapter->pdev->device == PCI_DEVICE_ID_PERC4E_DI_KOBUK)) {
908 if (pci_set_dma_mask(adapter->pdev, DMA_BIT_MASK(64))) {
909 con_log(CL_ANN, (KERN_WARNING
910 "megaraid: DMA mask for 64-bit failed\n"));
912 if (pci_set_dma_mask (adapter->pdev, DMA_BIT_MASK(32))) {
913 con_log(CL_ANN, (KERN_WARNING
914 "megaraid: 32-bit DMA mask failed\n"));
915 goto out_free_sysfs_res;
920 // setup tasklet for DPC
921 tasklet_init(&adapter->dpc_h, megaraid_mbox_dpc,
922 (unsigned long)adapter);
924 con_log(CL_DLEVEL1, (KERN_INFO
925 "megaraid mbox hba successfully initialized\n"));
927 return 0;
929 out_free_sysfs_res:
930 megaraid_sysfs_free_resources(adapter);
931 out_free_irq:
932 free_irq(adapter->irq, adapter);
933 out_alloc_cmds:
934 megaraid_free_cmd_packets(adapter);
935 out_iounmap:
936 iounmap(raid_dev->baseaddr);
937 out_release_regions:
938 pci_release_regions(pdev);
939 out_free_raid_dev:
940 kfree(raid_dev);
942 return -1;
947 * megaraid_fini_mbox - undo controller initialization
948 * @adapter : our soft state
950 static void
951 megaraid_fini_mbox(adapter_t *adapter)
953 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
955 // flush all caches
956 megaraid_mbox_flush_cache(adapter);
958 tasklet_kill(&adapter->dpc_h);
960 megaraid_sysfs_free_resources(adapter);
962 megaraid_free_cmd_packets(adapter);
964 free_irq(adapter->irq, adapter);
966 iounmap(raid_dev->baseaddr);
968 pci_release_regions(adapter->pdev);
970 kfree(raid_dev);
972 return;
977 * megaraid_alloc_cmd_packets - allocate shared mailbox
978 * @adapter : soft state of the raid controller
980 * Allocate and align the shared mailbox. This maibox is used to issue
981 * all the commands. For IO based controllers, the mailbox is also regsitered
982 * with the FW. Allocate memory for all commands as well.
983 * This is our big allocator.
985 static int
986 megaraid_alloc_cmd_packets(adapter_t *adapter)
988 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
989 struct pci_dev *pdev;
990 unsigned long align;
991 scb_t *scb;
992 mbox_ccb_t *ccb;
993 struct mraid_pci_blk *epthru_pci_blk;
994 struct mraid_pci_blk *sg_pci_blk;
995 struct mraid_pci_blk *mbox_pci_blk;
996 int i;
998 pdev = adapter->pdev;
1001 * Setup the mailbox
1002 * Allocate the common 16-byte aligned memory for the handshake
1003 * mailbox.
1005 raid_dev->una_mbox64 = pci_alloc_consistent(adapter->pdev,
1006 sizeof(mbox64_t), &raid_dev->una_mbox64_dma);
1008 if (!raid_dev->una_mbox64) {
1009 con_log(CL_ANN, (KERN_WARNING
1010 "megaraid: out of memory, %s %d\n", __func__,
1011 __LINE__));
1012 return -1;
1014 memset(raid_dev->una_mbox64, 0, sizeof(mbox64_t));
1017 * Align the mailbox at 16-byte boundary
1019 raid_dev->mbox = &raid_dev->una_mbox64->mbox32;
1021 raid_dev->mbox = (mbox_t *)((((unsigned long)raid_dev->mbox) + 15) &
1022 (~0UL ^ 0xFUL));
1024 raid_dev->mbox64 = (mbox64_t *)(((unsigned long)raid_dev->mbox) - 8);
1026 align = ((void *)raid_dev->mbox -
1027 ((void *)&raid_dev->una_mbox64->mbox32));
1029 raid_dev->mbox_dma = (unsigned long)raid_dev->una_mbox64_dma + 8 +
1030 align;
1032 // Allocate memory for commands issued internally
1033 adapter->ibuf = pci_alloc_consistent(pdev, MBOX_IBUF_SIZE,
1034 &adapter->ibuf_dma_h);
1035 if (!adapter->ibuf) {
1037 con_log(CL_ANN, (KERN_WARNING
1038 "megaraid: out of memory, %s %d\n", __func__,
1039 __LINE__));
1041 goto out_free_common_mbox;
1043 memset(adapter->ibuf, 0, MBOX_IBUF_SIZE);
1045 // Allocate memory for our SCSI Command Blocks and their associated
1046 // memory
1049 * Allocate memory for the base list of scb. Later allocate memory for
1050 * CCBs and embedded components of each CCB and point the pointers in
1051 * scb to the allocated components
1052 * NOTE: The code to allocate SCB will be duplicated in all the LLD
1053 * since the calling routine does not yet know the number of available
1054 * commands.
1056 adapter->kscb_list = kcalloc(MBOX_MAX_SCSI_CMDS, sizeof(scb_t), GFP_KERNEL);
1058 if (adapter->kscb_list == NULL) {
1059 con_log(CL_ANN, (KERN_WARNING
1060 "megaraid: out of memory, %s %d\n", __func__,
1061 __LINE__));
1062 goto out_free_ibuf;
1065 // memory allocation for our command packets
1066 if (megaraid_mbox_setup_dma_pools(adapter) != 0) {
1067 con_log(CL_ANN, (KERN_WARNING
1068 "megaraid: out of memory, %s %d\n", __func__,
1069 __LINE__));
1070 goto out_free_scb_list;
1073 // Adjust the scb pointers and link in the free pool
1074 epthru_pci_blk = raid_dev->epthru_pool;
1075 sg_pci_blk = raid_dev->sg_pool;
1076 mbox_pci_blk = raid_dev->mbox_pool;
1078 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1079 scb = adapter->kscb_list + i;
1080 ccb = raid_dev->ccb_list + i;
1082 ccb->mbox = (mbox_t *)(mbox_pci_blk[i].vaddr + 16);
1083 ccb->raw_mbox = (uint8_t *)ccb->mbox;
1084 ccb->mbox64 = (mbox64_t *)(mbox_pci_blk[i].vaddr + 8);
1085 ccb->mbox_dma_h = (unsigned long)mbox_pci_blk[i].dma_addr + 16;
1087 // make sure the mailbox is aligned properly
1088 if (ccb->mbox_dma_h & 0x0F) {
1089 con_log(CL_ANN, (KERN_CRIT
1090 "megaraid mbox: not aligned on 16-bytes\n"));
1092 goto out_teardown_dma_pools;
1095 ccb->epthru = (mraid_epassthru_t *)
1096 epthru_pci_blk[i].vaddr;
1097 ccb->epthru_dma_h = epthru_pci_blk[i].dma_addr;
1098 ccb->pthru = (mraid_passthru_t *)ccb->epthru;
1099 ccb->pthru_dma_h = ccb->epthru_dma_h;
1102 ccb->sgl64 = (mbox_sgl64 *)sg_pci_blk[i].vaddr;
1103 ccb->sgl_dma_h = sg_pci_blk[i].dma_addr;
1104 ccb->sgl32 = (mbox_sgl32 *)ccb->sgl64;
1106 scb->ccb = (caddr_t)ccb;
1107 scb->gp = 0;
1109 scb->sno = i; // command index
1111 scb->scp = NULL;
1112 scb->state = SCB_FREE;
1113 scb->dma_direction = PCI_DMA_NONE;
1114 scb->dma_type = MRAID_DMA_NONE;
1115 scb->dev_channel = -1;
1116 scb->dev_target = -1;
1118 // put scb in the free pool
1119 list_add_tail(&scb->list, &adapter->kscb_pool);
1122 return 0;
1124 out_teardown_dma_pools:
1125 megaraid_mbox_teardown_dma_pools(adapter);
1126 out_free_scb_list:
1127 kfree(adapter->kscb_list);
1128 out_free_ibuf:
1129 pci_free_consistent(pdev, MBOX_IBUF_SIZE, (void *)adapter->ibuf,
1130 adapter->ibuf_dma_h);
1131 out_free_common_mbox:
1132 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1133 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1135 return -1;
1140 * megaraid_free_cmd_packets - free memory
1141 * @adapter : soft state of the raid controller
1143 * Release memory resources allocated for commands.
1145 static void
1146 megaraid_free_cmd_packets(adapter_t *adapter)
1148 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1150 megaraid_mbox_teardown_dma_pools(adapter);
1152 kfree(adapter->kscb_list);
1154 pci_free_consistent(adapter->pdev, MBOX_IBUF_SIZE,
1155 (void *)adapter->ibuf, adapter->ibuf_dma_h);
1157 pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1158 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1159 return;
1164 * megaraid_mbox_setup_dma_pools - setup dma pool for command packets
1165 * @adapter : HBA soft state
1167 * Setup the dma pools for mailbox, passthru and extended passthru structures,
1168 * and scatter-gather lists.
1170 static int
1171 megaraid_mbox_setup_dma_pools(adapter_t *adapter)
1173 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1174 struct mraid_pci_blk *epthru_pci_blk;
1175 struct mraid_pci_blk *sg_pci_blk;
1176 struct mraid_pci_blk *mbox_pci_blk;
1177 int i;
1181 // Allocate memory for 16-bytes aligned mailboxes
1182 raid_dev->mbox_pool_handle = pci_pool_create("megaraid mbox pool",
1183 adapter->pdev,
1184 sizeof(mbox64_t) + 16,
1185 16, 0);
1187 if (raid_dev->mbox_pool_handle == NULL) {
1188 goto fail_setup_dma_pool;
1191 mbox_pci_blk = raid_dev->mbox_pool;
1192 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1193 mbox_pci_blk[i].vaddr = pci_pool_alloc(
1194 raid_dev->mbox_pool_handle,
1195 GFP_KERNEL,
1196 &mbox_pci_blk[i].dma_addr);
1197 if (!mbox_pci_blk[i].vaddr) {
1198 goto fail_setup_dma_pool;
1203 * Allocate memory for each embedded passthru strucuture pointer
1204 * Request for a 128 bytes aligned structure for each passthru command
1205 * structure
1206 * Since passthru and extended passthru commands are exclusive, they
1207 * share common memory pool. Passthru structures piggyback on memory
1208 * allocted to extended passthru since passthru is smaller of the two
1210 raid_dev->epthru_pool_handle = pci_pool_create("megaraid mbox pthru",
1211 adapter->pdev, sizeof(mraid_epassthru_t), 128, 0);
1213 if (raid_dev->epthru_pool_handle == NULL) {
1214 goto fail_setup_dma_pool;
1217 epthru_pci_blk = raid_dev->epthru_pool;
1218 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1219 epthru_pci_blk[i].vaddr = pci_pool_alloc(
1220 raid_dev->epthru_pool_handle,
1221 GFP_KERNEL,
1222 &epthru_pci_blk[i].dma_addr);
1223 if (!epthru_pci_blk[i].vaddr) {
1224 goto fail_setup_dma_pool;
1229 // Allocate memory for each scatter-gather list. Request for 512 bytes
1230 // alignment for each sg list
1231 raid_dev->sg_pool_handle = pci_pool_create("megaraid mbox sg",
1232 adapter->pdev,
1233 sizeof(mbox_sgl64) * MBOX_MAX_SG_SIZE,
1234 512, 0);
1236 if (raid_dev->sg_pool_handle == NULL) {
1237 goto fail_setup_dma_pool;
1240 sg_pci_blk = raid_dev->sg_pool;
1241 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1242 sg_pci_blk[i].vaddr = pci_pool_alloc(
1243 raid_dev->sg_pool_handle,
1244 GFP_KERNEL,
1245 &sg_pci_blk[i].dma_addr);
1246 if (!sg_pci_blk[i].vaddr) {
1247 goto fail_setup_dma_pool;
1251 return 0;
1253 fail_setup_dma_pool:
1254 megaraid_mbox_teardown_dma_pools(adapter);
1255 return -1;
1260 * megaraid_mbox_teardown_dma_pools - teardown dma pools for command packets
1261 * @adapter : HBA soft state
1263 * Teardown the dma pool for mailbox, passthru and extended passthru
1264 * structures, and scatter-gather lists.
1266 static void
1267 megaraid_mbox_teardown_dma_pools(adapter_t *adapter)
1269 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1270 struct mraid_pci_blk *epthru_pci_blk;
1271 struct mraid_pci_blk *sg_pci_blk;
1272 struct mraid_pci_blk *mbox_pci_blk;
1273 int i;
1276 sg_pci_blk = raid_dev->sg_pool;
1277 for (i = 0; i < MBOX_MAX_SCSI_CMDS && sg_pci_blk[i].vaddr; i++) {
1278 pci_pool_free(raid_dev->sg_pool_handle, sg_pci_blk[i].vaddr,
1279 sg_pci_blk[i].dma_addr);
1281 if (raid_dev->sg_pool_handle)
1282 pci_pool_destroy(raid_dev->sg_pool_handle);
1285 epthru_pci_blk = raid_dev->epthru_pool;
1286 for (i = 0; i < MBOX_MAX_SCSI_CMDS && epthru_pci_blk[i].vaddr; i++) {
1287 pci_pool_free(raid_dev->epthru_pool_handle,
1288 epthru_pci_blk[i].vaddr, epthru_pci_blk[i].dma_addr);
1290 if (raid_dev->epthru_pool_handle)
1291 pci_pool_destroy(raid_dev->epthru_pool_handle);
1294 mbox_pci_blk = raid_dev->mbox_pool;
1295 for (i = 0; i < MBOX_MAX_SCSI_CMDS && mbox_pci_blk[i].vaddr; i++) {
1296 pci_pool_free(raid_dev->mbox_pool_handle,
1297 mbox_pci_blk[i].vaddr, mbox_pci_blk[i].dma_addr);
1299 if (raid_dev->mbox_pool_handle)
1300 pci_pool_destroy(raid_dev->mbox_pool_handle);
1302 return;
1307 * megaraid_alloc_scb - detach and return a scb from the free list
1308 * @adapter : controller's soft state
1309 * @scp : pointer to the scsi command to be executed
1311 * Return the scb from the head of the free list. %NULL if there are none
1312 * available.
1314 static scb_t *
1315 megaraid_alloc_scb(adapter_t *adapter, struct scsi_cmnd *scp)
1317 struct list_head *head = &adapter->kscb_pool;
1318 scb_t *scb = NULL;
1319 unsigned long flags;
1321 // detach scb from free pool
1322 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1324 if (list_empty(head)) {
1325 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1326 return NULL;
1329 scb = list_entry(head->next, scb_t, list);
1330 list_del_init(&scb->list);
1332 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1334 scb->state = SCB_ACTIVE;
1335 scb->scp = scp;
1336 scb->dma_type = MRAID_DMA_NONE;
1338 return scb;
1343 * megaraid_dealloc_scb - return the scb to the free pool
1344 * @adapter : controller's soft state
1345 * @scb : scb to be freed
1347 * Return the scb back to the free list of scbs. The caller must 'flush' the
1348 * SCB before calling us. E.g., performing pci_unamp and/or pci_sync etc.
1349 * NOTE NOTE: Make sure the scb is not on any list before calling this
1350 * routine.
1352 static inline void
1353 megaraid_dealloc_scb(adapter_t *adapter, scb_t *scb)
1355 unsigned long flags;
1357 // put scb in the free pool
1358 scb->state = SCB_FREE;
1359 scb->scp = NULL;
1360 spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1362 list_add(&scb->list, &adapter->kscb_pool);
1364 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1366 return;
1371 * megaraid_mbox_mksgl - make the scatter-gather list
1372 * @adapter : controller's soft state
1373 * @scb : scsi control block
1375 * Prepare the scatter-gather list.
1377 static int
1378 megaraid_mbox_mksgl(adapter_t *adapter, scb_t *scb)
1380 struct scatterlist *sgl;
1381 mbox_ccb_t *ccb;
1382 struct scsi_cmnd *scp;
1383 int sgcnt;
1384 int i;
1387 scp = scb->scp;
1388 ccb = (mbox_ccb_t *)scb->ccb;
1390 sgcnt = scsi_dma_map(scp);
1391 BUG_ON(sgcnt < 0 || sgcnt > adapter->sglen);
1393 // no mapping required if no data to be transferred
1394 if (!sgcnt)
1395 return 0;
1397 scb->dma_type = MRAID_DMA_WSG;
1399 scsi_for_each_sg(scp, sgl, sgcnt, i) {
1400 ccb->sgl64[i].address = sg_dma_address(sgl);
1401 ccb->sgl64[i].length = sg_dma_len(sgl);
1404 // Return count of SG nodes
1405 return sgcnt;
1410 * mbox_post_cmd - issue a mailbox command
1411 * @adapter : controller's soft state
1412 * @scb : command to be issued
1414 * Post the command to the controller if mailbox is available.
1416 static int
1417 mbox_post_cmd(adapter_t *adapter, scb_t *scb)
1419 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1420 mbox64_t *mbox64;
1421 mbox_t *mbox;
1422 mbox_ccb_t *ccb;
1423 unsigned long flags;
1424 unsigned int i = 0;
1427 ccb = (mbox_ccb_t *)scb->ccb;
1428 mbox = raid_dev->mbox;
1429 mbox64 = raid_dev->mbox64;
1432 * Check for busy mailbox. If it is, return failure - the caller
1433 * should retry later.
1435 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
1437 if (unlikely(mbox->busy)) {
1438 do {
1439 udelay(1);
1440 i++;
1441 rmb();
1442 } while(mbox->busy && (i < max_mbox_busy_wait));
1444 if (mbox->busy) {
1446 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1448 return -1;
1453 // Copy this command's mailbox data into "adapter's" mailbox
1454 memcpy((caddr_t)mbox64, (caddr_t)ccb->mbox64, 22);
1455 mbox->cmdid = scb->sno;
1457 adapter->outstanding_cmds++;
1459 if (scb->dma_direction == PCI_DMA_TODEVICE)
1460 pci_dma_sync_sg_for_device(adapter->pdev,
1461 scsi_sglist(scb->scp),
1462 scsi_sg_count(scb->scp),
1463 PCI_DMA_TODEVICE);
1465 mbox->busy = 1; // Set busy
1466 mbox->poll = 0;
1467 mbox->ack = 0;
1468 wmb();
1470 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
1472 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1474 return 0;
1479 * megaraid_queue_command - generic queue entry point for all LLDs
1480 * @scp : pointer to the scsi command to be executed
1481 * @done : callback routine to be called after the cmd has be completed
1483 * Queue entry point for mailbox based controllers.
1485 static int
1486 megaraid_queue_command_lck(struct scsi_cmnd *scp, void (*done)(struct scsi_cmnd *))
1488 adapter_t *adapter;
1489 scb_t *scb;
1490 int if_busy;
1492 adapter = SCP2ADAPTER(scp);
1493 scp->scsi_done = done;
1494 scp->result = 0;
1497 * Allocate and build a SCB request
1498 * if_busy flag will be set if megaraid_mbox_build_cmd() command could
1499 * not allocate scb. We will return non-zero status in that case.
1500 * NOTE: scb can be null even though certain commands completed
1501 * successfully, e.g., MODE_SENSE and TEST_UNIT_READY, it would
1502 * return 0 in that case, and we would do the callback right away.
1504 if_busy = 0;
1505 scb = megaraid_mbox_build_cmd(adapter, scp, &if_busy);
1506 if (!scb) { // command already completed
1507 done(scp);
1508 return 0;
1511 megaraid_mbox_runpendq(adapter, scb);
1512 return if_busy;
1515 static DEF_SCSI_QCMD(megaraid_queue_command)
1518 * megaraid_mbox_build_cmd - transform the mid-layer scsi commands
1519 * @adapter : controller's soft state
1520 * @scp : mid-layer scsi command pointer
1521 * @busy : set if request could not be completed because of lack of
1522 * resources
1524 * Transform the mid-layer scsi command to megaraid firmware lingua.
1525 * Convert the command issued by mid-layer to format understood by megaraid
1526 * firmware. We also complete certain commands without sending them to firmware.
1528 static scb_t *
1529 megaraid_mbox_build_cmd(adapter_t *adapter, struct scsi_cmnd *scp, int *busy)
1531 mraid_device_t *rdev = ADAP2RAIDDEV(adapter);
1532 int channel;
1533 int target;
1534 int islogical;
1535 mbox_ccb_t *ccb;
1536 mraid_passthru_t *pthru;
1537 mbox64_t *mbox64;
1538 mbox_t *mbox;
1539 scb_t *scb;
1540 char skip[] = "skipping";
1541 char scan[] = "scanning";
1542 char *ss;
1546 * Get the appropriate device map for the device this command is
1547 * intended for
1549 MRAID_GET_DEVICE_MAP(adapter, scp, channel, target, islogical);
1552 * Logical drive commands
1554 if (islogical) {
1555 switch (scp->cmnd[0]) {
1556 case TEST_UNIT_READY:
1558 * Do we support clustering and is the support enabled
1559 * If no, return success always
1561 if (!adapter->ha) {
1562 scp->result = (DID_OK << 16);
1563 return NULL;
1566 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1567 scp->result = (DID_ERROR << 16);
1568 *busy = 1;
1569 return NULL;
1572 scb->dma_direction = scp->sc_data_direction;
1573 scb->dev_channel = 0xFF;
1574 scb->dev_target = target;
1575 ccb = (mbox_ccb_t *)scb->ccb;
1578 * The command id will be provided by the command
1579 * issuance routine
1581 ccb->raw_mbox[0] = CLUSTER_CMD;
1582 ccb->raw_mbox[2] = RESERVATION_STATUS;
1583 ccb->raw_mbox[3] = target;
1585 return scb;
1587 case MODE_SENSE:
1589 struct scatterlist *sgl;
1590 caddr_t vaddr;
1592 sgl = scsi_sglist(scp);
1593 if (sg_page(sgl)) {
1594 vaddr = (caddr_t) sg_virt(&sgl[0]);
1596 memset(vaddr, 0, scp->cmnd[4]);
1598 else {
1599 con_log(CL_ANN, (KERN_WARNING
1600 "megaraid mailbox: invalid sg:%d\n",
1601 __LINE__));
1604 scp->result = (DID_OK << 16);
1605 return NULL;
1607 case INQUIRY:
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,
1617 SCP2CHANNEL(scp)));
1619 con_log(CL_ANN, (
1620 " [virtual] for logical drives\n"));
1622 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1625 if (scp->cmnd[1] & MEGA_SCSI_INQ_EVPD) {
1626 scp->sense_buffer[0] = 0x70;
1627 scp->sense_buffer[2] = ILLEGAL_REQUEST;
1628 scp->sense_buffer[12] = MEGA_INVALID_FIELD_IN_CDB;
1629 scp->result = CHECK_CONDITION << 1;
1630 return NULL;
1633 /* Fall through */
1635 case READ_CAPACITY:
1637 * Do not allow LUN > 0 for logical drives and
1638 * requests for more than 40 logical drives
1640 if (SCP2LUN(scp)) {
1641 scp->result = (DID_BAD_TARGET << 16);
1642 return NULL;
1644 if ((target % 0x80) >= MAX_LOGICAL_DRIVES_40LD) {
1645 scp->result = (DID_BAD_TARGET << 16);
1646 return NULL;
1650 /* Allocate a SCB and initialize passthru */
1651 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1652 scp->result = (DID_ERROR << 16);
1653 *busy = 1;
1654 return NULL;
1657 ccb = (mbox_ccb_t *)scb->ccb;
1658 scb->dev_channel = 0xFF;
1659 scb->dev_target = target;
1660 pthru = ccb->pthru;
1661 mbox = ccb->mbox;
1662 mbox64 = ccb->mbox64;
1664 pthru->timeout = 0;
1665 pthru->ars = 1;
1666 pthru->reqsenselen = 14;
1667 pthru->islogical = 1;
1668 pthru->logdrv = target;
1669 pthru->cdblen = scp->cmd_len;
1670 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
1672 mbox->cmd = MBOXCMD_PASSTHRU64;
1673 scb->dma_direction = scp->sc_data_direction;
1675 pthru->dataxferlen = scsi_bufflen(scp);
1676 pthru->dataxferaddr = ccb->sgl_dma_h;
1677 pthru->numsge = megaraid_mbox_mksgl(adapter,
1678 scb);
1680 mbox->xferaddr = 0xFFFFFFFF;
1681 mbox64->xferaddr_lo = (uint32_t )ccb->pthru_dma_h;
1682 mbox64->xferaddr_hi = 0;
1684 return scb;
1686 case READ_6:
1687 case WRITE_6:
1688 case READ_10:
1689 case WRITE_10:
1690 case READ_12:
1691 case WRITE_12:
1694 * Allocate a SCB and initialize mailbox
1696 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1697 scp->result = (DID_ERROR << 16);
1698 *busy = 1;
1699 return NULL;
1701 ccb = (mbox_ccb_t *)scb->ccb;
1702 scb->dev_channel = 0xFF;
1703 scb->dev_target = target;
1704 mbox = ccb->mbox;
1705 mbox64 = ccb->mbox64;
1706 mbox->logdrv = target;
1709 * A little HACK: 2nd bit is zero for all scsi read
1710 * commands and is set for all scsi write commands
1712 mbox->cmd = (scp->cmnd[0] & 0x02) ? MBOXCMD_LWRITE64:
1713 MBOXCMD_LREAD64 ;
1716 * 6-byte READ(0x08) or WRITE(0x0A) cdb
1718 if (scp->cmd_len == 6) {
1719 mbox->numsectors = (uint32_t)scp->cmnd[4];
1720 mbox->lba =
1721 ((uint32_t)scp->cmnd[1] << 16) |
1722 ((uint32_t)scp->cmnd[2] << 8) |
1723 (uint32_t)scp->cmnd[3];
1725 mbox->lba &= 0x1FFFFF;
1729 * 10-byte READ(0x28) or WRITE(0x2A) cdb
1731 else if (scp->cmd_len == 10) {
1732 mbox->numsectors =
1733 (uint32_t)scp->cmnd[8] |
1734 ((uint32_t)scp->cmnd[7] << 8);
1735 mbox->lba =
1736 ((uint32_t)scp->cmnd[2] << 24) |
1737 ((uint32_t)scp->cmnd[3] << 16) |
1738 ((uint32_t)scp->cmnd[4] << 8) |
1739 (uint32_t)scp->cmnd[5];
1743 * 12-byte READ(0xA8) or WRITE(0xAA) cdb
1745 else if (scp->cmd_len == 12) {
1746 mbox->lba =
1747 ((uint32_t)scp->cmnd[2] << 24) |
1748 ((uint32_t)scp->cmnd[3] << 16) |
1749 ((uint32_t)scp->cmnd[4] << 8) |
1750 (uint32_t)scp->cmnd[5];
1752 mbox->numsectors =
1753 ((uint32_t)scp->cmnd[6] << 24) |
1754 ((uint32_t)scp->cmnd[7] << 16) |
1755 ((uint32_t)scp->cmnd[8] << 8) |
1756 (uint32_t)scp->cmnd[9];
1758 else {
1759 con_log(CL_ANN, (KERN_WARNING
1760 "megaraid: unsupported CDB length\n"));
1762 megaraid_dealloc_scb(adapter, scb);
1764 scp->result = (DID_ERROR << 16);
1765 return NULL;
1768 scb->dma_direction = scp->sc_data_direction;
1770 // Calculate Scatter-Gather info
1771 mbox64->xferaddr_lo = (uint32_t )ccb->sgl_dma_h;
1772 mbox->numsge = megaraid_mbox_mksgl(adapter,
1773 scb);
1774 mbox->xferaddr = 0xFFFFFFFF;
1775 mbox64->xferaddr_hi = 0;
1777 return scb;
1779 case RESERVE:
1780 case RELEASE:
1782 * Do we support clustering and is the support enabled
1784 if (!adapter->ha) {
1785 scp->result = (DID_BAD_TARGET << 16);
1786 return NULL;
1790 * Allocate a SCB and initialize mailbox
1792 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1793 scp->result = (DID_ERROR << 16);
1794 *busy = 1;
1795 return NULL;
1798 ccb = (mbox_ccb_t *)scb->ccb;
1799 scb->dev_channel = 0xFF;
1800 scb->dev_target = target;
1801 ccb->raw_mbox[0] = CLUSTER_CMD;
1802 ccb->raw_mbox[2] = (scp->cmnd[0] == RESERVE) ?
1803 RESERVE_LD : RELEASE_LD;
1805 ccb->raw_mbox[3] = target;
1806 scb->dma_direction = scp->sc_data_direction;
1808 return scb;
1810 default:
1811 scp->result = (DID_BAD_TARGET << 16);
1812 return NULL;
1815 else { // Passthru device commands
1817 // Do not allow access to target id > 15 or LUN > 7
1818 if (target > 15 || SCP2LUN(scp) > 7) {
1819 scp->result = (DID_BAD_TARGET << 16);
1820 return NULL;
1823 // if fast load option was set and scan for last device is
1824 // over, reset the fast_load flag so that during a possible
1825 // next scan, devices can be made available
1826 if (rdev->fast_load && (target == 15) &&
1827 (SCP2CHANNEL(scp) == adapter->max_channel -1)) {
1829 con_log(CL_ANN, (KERN_INFO
1830 "megaraid[%d]: physical device scan re-enabled\n",
1831 adapter->host->host_no));
1832 rdev->fast_load = 0;
1836 * Display the channel scan for physical devices
1838 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1840 ss = rdev->fast_load ? skip : scan;
1842 con_log(CL_ANN, (KERN_INFO
1843 "scsi[%d]: %s scsi channel %d [Phy %d]",
1844 adapter->host->host_no, ss, SCP2CHANNEL(scp),
1845 channel));
1847 con_log(CL_ANN, (
1848 " for non-raid devices\n"));
1850 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1853 // disable channel sweep if fast load option given
1854 if (rdev->fast_load) {
1855 scp->result = (DID_BAD_TARGET << 16);
1856 return NULL;
1859 // Allocate a SCB and initialize passthru
1860 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1861 scp->result = (DID_ERROR << 16);
1862 *busy = 1;
1863 return NULL;
1866 ccb = (mbox_ccb_t *)scb->ccb;
1867 scb->dev_channel = channel;
1868 scb->dev_target = target;
1869 scb->dma_direction = scp->sc_data_direction;
1870 mbox = ccb->mbox;
1871 mbox64 = ccb->mbox64;
1873 // Does this firmware support extended CDBs
1874 if (adapter->max_cdb_sz == 16) {
1875 mbox->cmd = MBOXCMD_EXTPTHRU;
1877 megaraid_mbox_prepare_epthru(adapter, scb, scp);
1879 mbox64->xferaddr_lo = (uint32_t)ccb->epthru_dma_h;
1880 mbox64->xferaddr_hi = 0;
1881 mbox->xferaddr = 0xFFFFFFFF;
1883 else {
1884 mbox->cmd = MBOXCMD_PASSTHRU64;
1886 megaraid_mbox_prepare_pthru(adapter, scb, scp);
1888 mbox64->xferaddr_lo = (uint32_t)ccb->pthru_dma_h;
1889 mbox64->xferaddr_hi = 0;
1890 mbox->xferaddr = 0xFFFFFFFF;
1892 return scb;
1895 // NOT REACHED
1900 * megaraid_mbox_runpendq - execute commands queued in the pending queue
1901 * @adapter : controller's soft state
1902 * @scb_q : SCB to be queued in the pending list
1904 * Scan the pending list for commands which are not yet issued and try to
1905 * post to the controller. The SCB can be a null pointer, which would indicate
1906 * no SCB to be queue, just try to execute the ones in the pending list.
1908 * NOTE: We do not actually traverse the pending list. The SCBs are plucked
1909 * out from the head of the pending list. If it is successfully issued, the
1910 * next SCB is at the head now.
1912 static void
1913 megaraid_mbox_runpendq(adapter_t *adapter, scb_t *scb_q)
1915 scb_t *scb;
1916 unsigned long flags;
1918 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1920 if (scb_q) {
1921 scb_q->state = SCB_PENDQ;
1922 list_add_tail(&scb_q->list, &adapter->pend_list);
1925 // if the adapter in not in quiescent mode, post the commands to FW
1926 if (adapter->quiescent) {
1927 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1928 return;
1931 while (!list_empty(&adapter->pend_list)) {
1933 assert_spin_locked(PENDING_LIST_LOCK(adapter));
1935 scb = list_entry(adapter->pend_list.next, scb_t, list);
1937 // remove the scb from the pending list and try to
1938 // issue. If we are unable to issue it, put back in
1939 // the pending list and return
1941 list_del_init(&scb->list);
1943 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1945 // if mailbox was busy, return SCB back to pending
1946 // list. Make sure to add at the head, since that's
1947 // where it would have been removed from
1949 scb->state = SCB_ISSUED;
1951 if (mbox_post_cmd(adapter, scb) != 0) {
1953 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1955 scb->state = SCB_PENDQ;
1957 list_add(&scb->list, &adapter->pend_list);
1959 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
1960 flags);
1962 return;
1965 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1968 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1971 return;
1976 * megaraid_mbox_prepare_pthru - prepare a command for physical devices
1977 * @adapter : pointer to controller's soft state
1978 * @scb : scsi control block
1979 * @scp : scsi command from the mid-layer
1981 * Prepare a command for the scsi physical devices.
1983 static void
1984 megaraid_mbox_prepare_pthru(adapter_t *adapter, scb_t *scb,
1985 struct scsi_cmnd *scp)
1987 mbox_ccb_t *ccb;
1988 mraid_passthru_t *pthru;
1989 uint8_t channel;
1990 uint8_t target;
1992 ccb = (mbox_ccb_t *)scb->ccb;
1993 pthru = ccb->pthru;
1994 channel = scb->dev_channel;
1995 target = scb->dev_target;
1997 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
1998 pthru->timeout = 4;
1999 pthru->ars = 1;
2000 pthru->islogical = 0;
2001 pthru->channel = 0;
2002 pthru->target = (channel << 4) | target;
2003 pthru->logdrv = SCP2LUN(scp);
2004 pthru->reqsenselen = 14;
2005 pthru->cdblen = scp->cmd_len;
2007 memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
2009 if (scsi_bufflen(scp)) {
2010 pthru->dataxferlen = scsi_bufflen(scp);
2011 pthru->dataxferaddr = ccb->sgl_dma_h;
2012 pthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2014 else {
2015 pthru->dataxferaddr = 0;
2016 pthru->dataxferlen = 0;
2017 pthru->numsge = 0;
2019 return;
2024 * megaraid_mbox_prepare_epthru - prepare a command for physical devices
2025 * @adapter : pointer to controller's soft state
2026 * @scb : scsi control block
2027 * @scp : scsi command from the mid-layer
2029 * Prepare a command for the scsi physical devices. This rountine prepares
2030 * commands for devices which can take extended CDBs (>10 bytes).
2032 static void
2033 megaraid_mbox_prepare_epthru(adapter_t *adapter, scb_t *scb,
2034 struct scsi_cmnd *scp)
2036 mbox_ccb_t *ccb;
2037 mraid_epassthru_t *epthru;
2038 uint8_t channel;
2039 uint8_t target;
2041 ccb = (mbox_ccb_t *)scb->ccb;
2042 epthru = ccb->epthru;
2043 channel = scb->dev_channel;
2044 target = scb->dev_target;
2046 // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2047 epthru->timeout = 4;
2048 epthru->ars = 1;
2049 epthru->islogical = 0;
2050 epthru->channel = 0;
2051 epthru->target = (channel << 4) | target;
2052 epthru->logdrv = SCP2LUN(scp);
2053 epthru->reqsenselen = 14;
2054 epthru->cdblen = scp->cmd_len;
2056 memcpy(epthru->cdb, scp->cmnd, scp->cmd_len);
2058 if (scsi_bufflen(scp)) {
2059 epthru->dataxferlen = scsi_bufflen(scp);
2060 epthru->dataxferaddr = ccb->sgl_dma_h;
2061 epthru->numsge = megaraid_mbox_mksgl(adapter, scb);
2063 else {
2064 epthru->dataxferaddr = 0;
2065 epthru->dataxferlen = 0;
2066 epthru->numsge = 0;
2068 return;
2073 * megaraid_ack_sequence - interrupt ack sequence for memory mapped HBAs
2074 * @adapter : controller's soft state
2076 * Interrupt acknowledgement sequence for memory mapped HBAs. Find out the
2077 * completed command and put them on the completed list for later processing.
2079 * Returns: 1 if the interrupt is valid, 0 otherwise
2081 static int
2082 megaraid_ack_sequence(adapter_t *adapter)
2084 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2085 mbox_t *mbox;
2086 scb_t *scb;
2087 uint8_t nstatus;
2088 uint8_t completed[MBOX_MAX_FIRMWARE_STATUS];
2089 struct list_head clist;
2090 int handled;
2091 uint32_t dword;
2092 unsigned long flags;
2093 int i, j;
2096 mbox = raid_dev->mbox;
2098 // move the SCBs from the firmware completed array to our local list
2099 INIT_LIST_HEAD(&clist);
2101 // loop till F/W has more commands for us to complete
2102 handled = 0;
2103 spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
2104 do {
2106 * Check if a valid interrupt is pending. If found, force the
2107 * interrupt line low.
2109 dword = RDOUTDOOR(raid_dev);
2110 if (dword != 0x10001234) break;
2112 handled = 1;
2114 WROUTDOOR(raid_dev, 0x10001234);
2116 nstatus = 0;
2117 // wait for valid numstatus to post
2118 for (i = 0; i < 0xFFFFF; i++) {
2119 if (mbox->numstatus != 0xFF) {
2120 nstatus = mbox->numstatus;
2121 break;
2123 rmb();
2125 mbox->numstatus = 0xFF;
2127 adapter->outstanding_cmds -= nstatus;
2129 for (i = 0; i < nstatus; i++) {
2131 // wait for valid command index to post
2132 for (j = 0; j < 0xFFFFF; j++) {
2133 if (mbox->completed[i] != 0xFF) break;
2134 rmb();
2136 completed[i] = mbox->completed[i];
2137 mbox->completed[i] = 0xFF;
2139 if (completed[i] == 0xFF) {
2140 con_log(CL_ANN, (KERN_CRIT
2141 "megaraid: command posting timed out\n"));
2143 BUG();
2144 continue;
2147 // Get SCB associated with this command id
2148 if (completed[i] >= MBOX_MAX_SCSI_CMDS) {
2149 // a cmm command
2150 scb = adapter->uscb_list + (completed[i] -
2151 MBOX_MAX_SCSI_CMDS);
2153 else {
2154 // an os command
2155 scb = adapter->kscb_list + completed[i];
2158 scb->status = mbox->status;
2159 list_add_tail(&scb->list, &clist);
2162 // Acknowledge interrupt
2163 WRINDOOR(raid_dev, 0x02);
2165 } while(1);
2167 spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
2170 // put the completed commands in the completed list. DPC would
2171 // complete these commands later
2172 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2174 list_splice(&clist, &adapter->completed_list);
2176 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2179 // schedule the DPC if there is some work for it
2180 if (handled)
2181 tasklet_schedule(&adapter->dpc_h);
2183 return handled;
2188 * megaraid_isr - isr for memory based mailbox based controllers
2189 * @irq : irq
2190 * @devp : pointer to our soft state
2192 * Interrupt service routine for memory-mapped mailbox controllers.
2194 static irqreturn_t
2195 megaraid_isr(int irq, void *devp)
2197 adapter_t *adapter = devp;
2198 int handled;
2200 handled = megaraid_ack_sequence(adapter);
2202 /* Loop through any pending requests */
2203 if (!adapter->quiescent) {
2204 megaraid_mbox_runpendq(adapter, NULL);
2207 return IRQ_RETVAL(handled);
2212 * megaraid_mbox_sync_scb - sync kernel buffers
2213 * @adapter : controller's soft state
2214 * @scb : pointer to the resource packet
2216 * DMA sync if required.
2218 static void
2219 megaraid_mbox_sync_scb(adapter_t *adapter, scb_t *scb)
2221 mbox_ccb_t *ccb;
2223 ccb = (mbox_ccb_t *)scb->ccb;
2225 if (scb->dma_direction == PCI_DMA_FROMDEVICE)
2226 pci_dma_sync_sg_for_cpu(adapter->pdev,
2227 scsi_sglist(scb->scp),
2228 scsi_sg_count(scb->scp),
2229 PCI_DMA_FROMDEVICE);
2231 scsi_dma_unmap(scb->scp);
2232 return;
2237 * megaraid_mbox_dpc - the tasklet to complete the commands from completed list
2238 * @devp : pointer to HBA soft state
2240 * Pick up the commands from the completed list and send back to the owners.
2241 * This is a reentrant function and does not assume any locks are held while
2242 * it is being called.
2244 static void
2245 megaraid_mbox_dpc(unsigned long devp)
2247 adapter_t *adapter = (adapter_t *)devp;
2248 mraid_device_t *raid_dev;
2249 struct list_head clist;
2250 struct scatterlist *sgl;
2251 scb_t *scb;
2252 scb_t *tmp;
2253 struct scsi_cmnd *scp;
2254 mraid_passthru_t *pthru;
2255 mraid_epassthru_t *epthru;
2256 mbox_ccb_t *ccb;
2257 int islogical;
2258 int pdev_index;
2259 int pdev_state;
2260 mbox_t *mbox;
2261 unsigned long flags;
2262 uint8_t c;
2263 int status;
2264 uioc_t *kioc;
2267 if (!adapter) return;
2269 raid_dev = ADAP2RAIDDEV(adapter);
2271 // move the SCBs from the completed list to our local list
2272 INIT_LIST_HEAD(&clist);
2274 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2276 list_splice_init(&adapter->completed_list, &clist);
2278 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2281 list_for_each_entry_safe(scb, tmp, &clist, list) {
2283 status = scb->status;
2284 scp = scb->scp;
2285 ccb = (mbox_ccb_t *)scb->ccb;
2286 pthru = ccb->pthru;
2287 epthru = ccb->epthru;
2288 mbox = ccb->mbox;
2290 // Make sure f/w has completed a valid command
2291 if (scb->state != SCB_ISSUED) {
2292 con_log(CL_ANN, (KERN_CRIT
2293 "megaraid critical err: invalid command %d:%d:%p\n",
2294 scb->sno, scb->state, scp));
2295 BUG();
2296 continue; // Must never happen!
2299 // check for the management command and complete it right away
2300 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2301 scb->state = SCB_FREE;
2302 scb->status = status;
2304 // remove from local clist
2305 list_del_init(&scb->list);
2307 kioc = (uioc_t *)scb->gp;
2308 kioc->status = 0;
2310 megaraid_mbox_mm_done(adapter, scb);
2312 continue;
2315 // Was an abort issued for this command earlier
2316 if (scb->state & SCB_ABORT) {
2317 con_log(CL_ANN, (KERN_NOTICE
2318 "megaraid: aborted cmd %lx[%x] completed\n",
2319 scp->serial_number, scb->sno));
2323 * If the inquiry came of a disk drive which is not part of
2324 * any RAID array, expose it to the kernel. For this to be
2325 * enabled, user must set the "megaraid_expose_unconf_disks"
2326 * flag to 1 by specifying it on module parameter list.
2327 * This would enable data migration off drives from other
2328 * configurations.
2330 islogical = MRAID_IS_LOGICAL(adapter, scp);
2331 if (scp->cmnd[0] == INQUIRY && status == 0 && islogical == 0
2332 && IS_RAID_CH(raid_dev, scb->dev_channel)) {
2334 sgl = scsi_sglist(scp);
2335 if (sg_page(sgl)) {
2336 c = *(unsigned char *) sg_virt(&sgl[0]);
2337 } else {
2338 con_log(CL_ANN, (KERN_WARNING
2339 "megaraid mailbox: invalid sg:%d\n",
2340 __LINE__));
2341 c = 0;
2344 if ((c & 0x1F ) == TYPE_DISK) {
2345 pdev_index = (scb->dev_channel * 16) +
2346 scb->dev_target;
2347 pdev_state =
2348 raid_dev->pdrv_state[pdev_index] & 0x0F;
2350 if (pdev_state == PDRV_ONLINE ||
2351 pdev_state == PDRV_FAILED ||
2352 pdev_state == PDRV_RBLD ||
2353 pdev_state == PDRV_HOTSPARE ||
2354 megaraid_expose_unconf_disks == 0) {
2356 status = 0xF0;
2361 // Convert MegaRAID status to Linux error code
2362 switch (status) {
2364 case 0x00:
2366 scp->result = (DID_OK << 16);
2367 break;
2369 case 0x02:
2371 /* set sense_buffer and result fields */
2372 if (mbox->cmd == MBOXCMD_PASSTHRU ||
2373 mbox->cmd == MBOXCMD_PASSTHRU64) {
2375 memcpy(scp->sense_buffer, pthru->reqsensearea,
2376 14);
2378 scp->result = DRIVER_SENSE << 24 |
2379 DID_OK << 16 | CHECK_CONDITION << 1;
2381 else {
2382 if (mbox->cmd == MBOXCMD_EXTPTHRU) {
2384 memcpy(scp->sense_buffer,
2385 epthru->reqsensearea, 14);
2387 scp->result = DRIVER_SENSE << 24 |
2388 DID_OK << 16 |
2389 CHECK_CONDITION << 1;
2390 } else {
2391 scp->sense_buffer[0] = 0x70;
2392 scp->sense_buffer[2] = ABORTED_COMMAND;
2393 scp->result = CHECK_CONDITION << 1;
2396 break;
2398 case 0x08:
2400 scp->result = DID_BUS_BUSY << 16 | status;
2401 break;
2403 default:
2406 * If TEST_UNIT_READY fails, we know RESERVATION_STATUS
2407 * failed
2409 if (scp->cmnd[0] == TEST_UNIT_READY) {
2410 scp->result = DID_ERROR << 16 |
2411 RESERVATION_CONFLICT << 1;
2413 else
2415 * Error code returned is 1 if Reserve or Release
2416 * failed or the input parameter is invalid
2418 if (status == 1 && (scp->cmnd[0] == RESERVE ||
2419 scp->cmnd[0] == RELEASE)) {
2421 scp->result = DID_ERROR << 16 |
2422 RESERVATION_CONFLICT << 1;
2424 else {
2425 scp->result = DID_BAD_TARGET << 16 | status;
2429 // print a debug message for all failed commands
2430 if (status) {
2431 megaraid_mbox_display_scb(adapter, scb);
2434 // Free our internal resources and call the mid-layer callback
2435 // routine
2436 megaraid_mbox_sync_scb(adapter, scb);
2438 // remove from local clist
2439 list_del_init(&scb->list);
2441 // put back in free list
2442 megaraid_dealloc_scb(adapter, scb);
2444 // send the scsi packet back to kernel
2445 scp->scsi_done(scp);
2448 return;
2453 * megaraid_abort_handler - abort the scsi command
2454 * @scp : command to be aborted
2456 * Abort a previous SCSI request. Only commands on the pending list can be
2457 * aborted. All the commands issued to the F/W must complete.
2459 static int
2460 megaraid_abort_handler(struct scsi_cmnd *scp)
2462 adapter_t *adapter;
2463 mraid_device_t *raid_dev;
2464 scb_t *scb;
2465 scb_t *tmp;
2466 int found;
2467 unsigned long flags;
2468 int i;
2471 adapter = SCP2ADAPTER(scp);
2472 raid_dev = ADAP2RAIDDEV(adapter);
2474 con_log(CL_ANN, (KERN_WARNING
2475 "megaraid: aborting-%ld cmd=%x <c=%d t=%d l=%d>\n",
2476 scp->serial_number, scp->cmnd[0], SCP2CHANNEL(scp),
2477 SCP2TARGET(scp), SCP2LUN(scp)));
2479 // If FW has stopped responding, simply return failure
2480 if (raid_dev->hw_error) {
2481 con_log(CL_ANN, (KERN_NOTICE
2482 "megaraid: hw error, not aborting\n"));
2483 return FAILED;
2486 // There might a race here, where the command was completed by the
2487 // firmware and now it is on the completed list. Before we could
2488 // complete the command to the kernel in dpc, the abort came.
2489 // Find out if this is the case to avoid the race.
2490 scb = NULL;
2491 spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2492 list_for_each_entry_safe(scb, tmp, &adapter->completed_list, list) {
2494 if (scb->scp == scp) { // Found command
2496 list_del_init(&scb->list); // from completed list
2498 con_log(CL_ANN, (KERN_WARNING
2499 "megaraid: %ld:%d[%d:%d], abort from completed list\n",
2500 scp->serial_number, scb->sno,
2501 scb->dev_channel, scb->dev_target));
2503 scp->result = (DID_ABORT << 16);
2504 scp->scsi_done(scp);
2506 megaraid_dealloc_scb(adapter, scb);
2508 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter),
2509 flags);
2511 return SUCCESS;
2514 spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2517 // Find out if this command is still on the pending list. If it is and
2518 // was never issued, abort and return success. If the command is owned
2519 // by the firmware, we must wait for it to complete by the FW.
2520 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2521 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2523 if (scb->scp == scp) { // Found command
2525 list_del_init(&scb->list); // from pending list
2527 ASSERT(!(scb->state & SCB_ISSUED));
2529 con_log(CL_ANN, (KERN_WARNING
2530 "megaraid abort: %ld[%d:%d], driver owner\n",
2531 scp->serial_number, scb->dev_channel,
2532 scb->dev_target));
2534 scp->result = (DID_ABORT << 16);
2535 scp->scsi_done(scp);
2537 megaraid_dealloc_scb(adapter, scb);
2539 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2540 flags);
2542 return SUCCESS;
2545 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2548 // Check do we even own this command, in which case this would be
2549 // owned by the firmware. The only way to locate the FW scb is to
2550 // traverse through the list of all SCB, since driver does not
2551 // maintain these SCBs on any list
2552 found = 0;
2553 spin_lock_irq(&adapter->lock);
2554 for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
2555 scb = adapter->kscb_list + i;
2557 if (scb->scp == scp) {
2559 found = 1;
2561 if (!(scb->state & SCB_ISSUED)) {
2562 con_log(CL_ANN, (KERN_WARNING
2563 "megaraid abort: %ld%d[%d:%d], invalid state\n",
2564 scp->serial_number, scb->sno, scb->dev_channel,
2565 scb->dev_target));
2566 BUG();
2568 else {
2569 con_log(CL_ANN, (KERN_WARNING
2570 "megaraid abort: %ld:%d[%d:%d], fw owner\n",
2571 scp->serial_number, scb->sno, scb->dev_channel,
2572 scb->dev_target));
2576 spin_unlock_irq(&adapter->lock);
2578 if (!found) {
2579 con_log(CL_ANN, (KERN_WARNING
2580 "megaraid abort: scsi cmd:%ld, do now own\n",
2581 scp->serial_number));
2583 // FIXME: Should there be a callback for this command?
2584 return SUCCESS;
2587 // We cannot actually abort a command owned by firmware, return
2588 // failure and wait for reset. In host reset handler, we will find out
2589 // if the HBA is still live
2590 return FAILED;
2594 * megaraid_reset_handler - device reset hadler for mailbox based driver
2595 * @scp : reference command
2597 * Reset handler for the mailbox based controller. First try to find out if
2598 * the FW is still live, in which case the outstanding commands counter mut go
2599 * down to 0. If that happens, also issue the reservation reset command to
2600 * relinquish (possible) reservations on the logical drives connected to this
2601 * host.
2603 static int
2604 megaraid_reset_handler(struct scsi_cmnd *scp)
2606 adapter_t *adapter;
2607 scb_t *scb;
2608 scb_t *tmp;
2609 mraid_device_t *raid_dev;
2610 unsigned long flags;
2611 uint8_t raw_mbox[sizeof(mbox_t)];
2612 int rval;
2613 int recovery_window;
2614 int recovering;
2615 int i;
2616 uioc_t *kioc;
2618 adapter = SCP2ADAPTER(scp);
2619 raid_dev = ADAP2RAIDDEV(adapter);
2621 // return failure if adapter is not responding
2622 if (raid_dev->hw_error) {
2623 con_log(CL_ANN, (KERN_NOTICE
2624 "megaraid: hw error, cannot reset\n"));
2625 return FAILED;
2629 // Under exceptional conditions, FW can take up to 3 minutes to
2630 // complete command processing. Wait for additional 2 minutes for the
2631 // pending commands counter to go down to 0. If it doesn't, let the
2632 // controller be marked offline
2633 // Also, reset all the commands currently owned by the driver
2634 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2635 list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2636 list_del_init(&scb->list); // from pending list
2638 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2639 con_log(CL_ANN, (KERN_WARNING
2640 "megaraid: IOCTL packet with %d[%d:%d] being reset\n",
2641 scb->sno, scb->dev_channel, scb->dev_target));
2643 scb->status = -1;
2645 kioc = (uioc_t *)scb->gp;
2646 kioc->status = -EFAULT;
2648 megaraid_mbox_mm_done(adapter, scb);
2649 } else {
2650 if (scb->scp == scp) { // Found command
2651 con_log(CL_ANN, (KERN_WARNING
2652 "megaraid: %ld:%d[%d:%d], reset from pending list\n",
2653 scp->serial_number, scb->sno,
2654 scb->dev_channel, scb->dev_target));
2655 } else {
2656 con_log(CL_ANN, (KERN_WARNING
2657 "megaraid: IO packet with %d[%d:%d] being reset\n",
2658 scb->sno, scb->dev_channel, scb->dev_target));
2661 scb->scp->result = (DID_RESET << 16);
2662 scb->scp->scsi_done(scb->scp);
2664 megaraid_dealloc_scb(adapter, scb);
2667 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2669 if (adapter->outstanding_cmds) {
2670 con_log(CL_ANN, (KERN_NOTICE
2671 "megaraid: %d outstanding commands. Max wait %d sec\n",
2672 adapter->outstanding_cmds,
2673 (MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT)));
2676 recovery_window = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
2678 recovering = adapter->outstanding_cmds;
2680 for (i = 0; i < recovery_window; i++) {
2682 megaraid_ack_sequence(adapter);
2684 // print a message once every 5 seconds only
2685 if (!(i % 5)) {
2686 con_log(CL_ANN, (
2687 "megaraid mbox: Wait for %d commands to complete:%d\n",
2688 adapter->outstanding_cmds,
2689 (MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT) - i));
2692 // bailout if no recovery happened in reset time
2693 if (adapter->outstanding_cmds == 0) {
2694 break;
2697 msleep(1000);
2700 spin_lock(&adapter->lock);
2702 // If still outstanding commands, bail out
2703 if (adapter->outstanding_cmds) {
2704 con_log(CL_ANN, (KERN_WARNING
2705 "megaraid mbox: critical hardware error!\n"));
2707 raid_dev->hw_error = 1;
2709 rval = FAILED;
2710 goto out;
2712 else {
2713 con_log(CL_ANN, (KERN_NOTICE
2714 "megaraid mbox: reset sequence completed successfully\n"));
2718 // If the controller supports clustering, reset reservations
2719 if (!adapter->ha) {
2720 rval = SUCCESS;
2721 goto out;
2724 // clear reservations if any
2725 raw_mbox[0] = CLUSTER_CMD;
2726 raw_mbox[2] = RESET_RESERVATIONS;
2728 rval = SUCCESS;
2729 if (mbox_post_sync_cmd_fast(adapter, raw_mbox) == 0) {
2730 con_log(CL_ANN,
2731 (KERN_INFO "megaraid: reservation reset\n"));
2733 else {
2734 rval = FAILED;
2735 con_log(CL_ANN, (KERN_WARNING
2736 "megaraid: reservation reset failed\n"));
2739 out:
2740 spin_unlock_irq(&adapter->lock);
2741 return rval;
2745 * START: internal commands library
2747 * This section of the driver has the common routine used by the driver and
2748 * also has all the FW routines
2752 * mbox_post_sync_cmd() - blocking command to the mailbox based controllers
2753 * @adapter : controller's soft state
2754 * @raw_mbox : the mailbox
2756 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2757 * controllers.
2759 static int
2760 mbox_post_sync_cmd(adapter_t *adapter, uint8_t raw_mbox[])
2762 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2763 mbox64_t *mbox64;
2764 mbox_t *mbox;
2765 uint8_t status;
2766 int i;
2769 mbox64 = raid_dev->mbox64;
2770 mbox = raid_dev->mbox;
2773 * Wait until mailbox is free
2775 if (megaraid_busywait_mbox(raid_dev) != 0)
2776 goto blocked_mailbox;
2779 * Copy mailbox data into host structure
2781 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
2782 mbox->cmdid = 0xFE;
2783 mbox->busy = 1;
2784 mbox->poll = 0;
2785 mbox->ack = 0;
2786 mbox->numstatus = 0xFF;
2787 mbox->status = 0xFF;
2789 wmb();
2790 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2792 // wait for maximum 1 second for status to post. If the status is not
2793 // available within 1 second, assume FW is initializing and wait
2794 // for an extended amount of time
2795 if (mbox->numstatus == 0xFF) { // status not yet available
2796 udelay(25);
2798 for (i = 0; mbox->numstatus == 0xFF && i < 1000; i++) {
2799 rmb();
2800 msleep(1);
2804 if (i == 1000) {
2805 con_log(CL_ANN, (KERN_NOTICE
2806 "megaraid mailbox: wait for FW to boot "));
2808 for (i = 0; (mbox->numstatus == 0xFF) &&
2809 (i < MBOX_RESET_WAIT); i++) {
2810 rmb();
2811 con_log(CL_ANN, ("\b\b\b\b\b[%03d]",
2812 MBOX_RESET_WAIT - i));
2813 msleep(1000);
2816 if (i == MBOX_RESET_WAIT) {
2818 con_log(CL_ANN, (
2819 "\nmegaraid mailbox: status not available\n"));
2821 return -1;
2823 con_log(CL_ANN, ("\b\b\b\b\b[ok] \n"));
2827 // wait for maximum 1 second for poll semaphore
2828 if (mbox->poll != 0x77) {
2829 udelay(25);
2831 for (i = 0; (mbox->poll != 0x77) && (i < 1000); i++) {
2832 rmb();
2833 msleep(1);
2836 if (i == 1000) {
2837 con_log(CL_ANN, (KERN_WARNING
2838 "megaraid mailbox: could not get poll semaphore\n"));
2839 return -1;
2843 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2844 wmb();
2846 // wait for maximum 1 second for acknowledgement
2847 if (RDINDOOR(raid_dev) & 0x2) {
2848 udelay(25);
2850 for (i = 0; (RDINDOOR(raid_dev) & 0x2) && (i < 1000); i++) {
2851 rmb();
2852 msleep(1);
2855 if (i == 1000) {
2856 con_log(CL_ANN, (KERN_WARNING
2857 "megaraid mailbox: could not acknowledge\n"));
2858 return -1;
2861 mbox->poll = 0;
2862 mbox->ack = 0x77;
2864 status = mbox->status;
2866 // invalidate the completed command id array. After command
2867 // completion, firmware would write the valid id.
2868 mbox->numstatus = 0xFF;
2869 mbox->status = 0xFF;
2870 for (i = 0; i < MBOX_MAX_FIRMWARE_STATUS; i++) {
2871 mbox->completed[i] = 0xFF;
2874 return status;
2876 blocked_mailbox:
2878 con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n") );
2879 return -1;
2884 * mbox_post_sync_cmd_fast - blocking command to the mailbox based controllers
2885 * @adapter : controller's soft state
2886 * @raw_mbox : the mailbox
2888 * Issue a scb in synchronous and non-interrupt mode for mailbox based
2889 * controllers. This is a faster version of the synchronous command and
2890 * therefore can be called in interrupt-context as well.
2892 static int
2893 mbox_post_sync_cmd_fast(adapter_t *adapter, uint8_t raw_mbox[])
2895 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2896 mbox_t *mbox;
2897 long i;
2900 mbox = raid_dev->mbox;
2902 // return immediately if the mailbox is busy
2903 if (mbox->busy) return -1;
2905 // Copy mailbox data into host structure
2906 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 14);
2907 mbox->cmdid = 0xFE;
2908 mbox->busy = 1;
2909 mbox->poll = 0;
2910 mbox->ack = 0;
2911 mbox->numstatus = 0xFF;
2912 mbox->status = 0xFF;
2914 wmb();
2915 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2917 for (i = 0; i < MBOX_SYNC_WAIT_CNT; i++) {
2918 if (mbox->numstatus != 0xFF) break;
2919 rmb();
2920 udelay(MBOX_SYNC_DELAY_200);
2923 if (i == MBOX_SYNC_WAIT_CNT) {
2924 // We may need to re-calibrate the counter
2925 con_log(CL_ANN, (KERN_CRIT
2926 "megaraid: fast sync command timed out\n"));
2929 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2930 wmb();
2932 return mbox->status;
2937 * megaraid_busywait_mbox() - Wait until the controller's mailbox is available
2938 * @raid_dev : RAID device (HBA) soft state
2940 * Wait until the controller's mailbox is available to accept more commands.
2941 * Wait for at most 1 second.
2943 static int
2944 megaraid_busywait_mbox(mraid_device_t *raid_dev)
2946 mbox_t *mbox = raid_dev->mbox;
2947 int i = 0;
2949 if (mbox->busy) {
2950 udelay(25);
2951 for (i = 0; mbox->busy && i < 1000; i++)
2952 msleep(1);
2955 if (i < 1000) return 0;
2956 else return -1;
2961 * megaraid_mbox_product_info - some static information about the controller
2962 * @adapter : our soft state
2964 * Issue commands to the controller to grab some parameters required by our
2965 * caller.
2967 static int
2968 megaraid_mbox_product_info(adapter_t *adapter)
2970 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
2971 mbox_t *mbox;
2972 uint8_t raw_mbox[sizeof(mbox_t)];
2973 mraid_pinfo_t *pinfo;
2974 dma_addr_t pinfo_dma_h;
2975 mraid_inquiry3_t *mraid_inq3;
2976 int i;
2979 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
2980 mbox = (mbox_t *)raw_mbox;
2983 * Issue an ENQUIRY3 command to find out certain adapter parameters,
2984 * e.g., max channels, max commands etc.
2986 pinfo = pci_alloc_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
2987 &pinfo_dma_h);
2989 if (pinfo == NULL) {
2990 con_log(CL_ANN, (KERN_WARNING
2991 "megaraid: out of memory, %s %d\n", __func__,
2992 __LINE__));
2994 return -1;
2996 memset(pinfo, 0, sizeof(mraid_pinfo_t));
2998 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
2999 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3001 raw_mbox[0] = FC_NEW_CONFIG;
3002 raw_mbox[2] = NC_SUBOP_ENQUIRY3;
3003 raw_mbox[3] = ENQ3_GET_SOLICITED_FULL;
3005 // Issue the command
3006 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3008 con_log(CL_ANN, (KERN_WARNING "megaraid: Inquiry3 failed\n"));
3010 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3011 pinfo, pinfo_dma_h);
3013 return -1;
3017 * Collect information about state of each physical drive
3018 * attached to the controller. We will expose all the disks
3019 * which are not part of RAID
3021 mraid_inq3 = (mraid_inquiry3_t *)adapter->ibuf;
3022 for (i = 0; i < MBOX_MAX_PHYSICAL_DRIVES; i++) {
3023 raid_dev->pdrv_state[i] = mraid_inq3->pdrv_state[i];
3027 * Get product info for information like number of channels,
3028 * maximum commands supported.
3030 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3031 mbox->xferaddr = (uint32_t)pinfo_dma_h;
3033 raw_mbox[0] = FC_NEW_CONFIG;
3034 raw_mbox[2] = NC_SUBOP_PRODUCT_INFO;
3036 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3038 con_log(CL_ANN, (KERN_WARNING
3039 "megaraid: product info failed\n"));
3041 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3042 pinfo, pinfo_dma_h);
3044 return -1;
3048 * Setup some parameters for host, as required by our caller
3050 adapter->max_channel = pinfo->nchannels;
3053 * we will export all the logical drives on a single channel.
3054 * Add 1 since inquires do not come for inititor ID
3056 adapter->max_target = MAX_LOGICAL_DRIVES_40LD + 1;
3057 adapter->max_lun = 8; // up to 8 LUNs for non-disk devices
3060 * These are the maximum outstanding commands for the scsi-layer
3062 adapter->max_cmds = MBOX_MAX_SCSI_CMDS;
3064 memset(adapter->fw_version, 0, VERSION_SIZE);
3065 memset(adapter->bios_version, 0, VERSION_SIZE);
3067 memcpy(adapter->fw_version, pinfo->fw_version, 4);
3068 adapter->fw_version[4] = 0;
3070 memcpy(adapter->bios_version, pinfo->bios_version, 4);
3071 adapter->bios_version[4] = 0;
3073 con_log(CL_ANN, (KERN_NOTICE
3074 "megaraid: fw version:[%s] bios version:[%s]\n",
3075 adapter->fw_version, adapter->bios_version));
3077 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t), pinfo,
3078 pinfo_dma_h);
3080 return 0;
3086 * megaraid_mbox_extended_cdb - check for support for extended CDBs
3087 * @adapter : soft state for the controller
3089 * This routine check whether the controller in question supports extended
3090 * ( > 10 bytes ) CDBs.
3092 static int
3093 megaraid_mbox_extended_cdb(adapter_t *adapter)
3095 mbox_t *mbox;
3096 uint8_t raw_mbox[sizeof(mbox_t)];
3097 int rval;
3099 mbox = (mbox_t *)raw_mbox;
3101 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3102 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3104 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3106 raw_mbox[0] = MAIN_MISC_OPCODE;
3107 raw_mbox[2] = SUPPORT_EXT_CDB;
3110 * Issue the command
3112 rval = 0;
3113 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3114 rval = -1;
3117 return rval;
3122 * megaraid_mbox_support_ha - Do we support clustering
3123 * @adapter : soft state for the controller
3124 * @init_id : ID of the initiator
3126 * Determine if the firmware supports clustering and the ID of the initiator.
3128 static int
3129 megaraid_mbox_support_ha(adapter_t *adapter, uint16_t *init_id)
3131 mbox_t *mbox;
3132 uint8_t raw_mbox[sizeof(mbox_t)];
3133 int rval;
3136 mbox = (mbox_t *)raw_mbox;
3138 memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3140 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3142 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3144 raw_mbox[0] = GET_TARGET_ID;
3146 // Issue the command
3147 *init_id = 7;
3148 rval = -1;
3149 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3151 *init_id = *(uint8_t *)adapter->ibuf;
3153 con_log(CL_ANN, (KERN_INFO
3154 "megaraid: cluster firmware, initiator ID: %d\n",
3155 *init_id));
3157 rval = 0;
3160 return rval;
3165 * megaraid_mbox_support_random_del - Do we support random deletion
3166 * @adapter : soft state for the controller
3168 * Determine if the firmware supports random deletion.
3169 * Return: 1 is operation supported, 0 otherwise
3171 static int
3172 megaraid_mbox_support_random_del(adapter_t *adapter)
3174 mbox_t *mbox;
3175 uint8_t raw_mbox[sizeof(mbox_t)];
3176 int rval;
3179 * Newer firmware on Dell CERC expect a different
3180 * random deletion handling, so disable it.
3182 if (adapter->pdev->vendor == PCI_VENDOR_ID_AMI &&
3183 adapter->pdev->device == PCI_DEVICE_ID_AMI_MEGARAID3 &&
3184 adapter->pdev->subsystem_vendor == PCI_VENDOR_ID_DELL &&
3185 adapter->pdev->subsystem_device == PCI_SUBSYS_ID_CERC_ATA100_4CH &&
3186 (adapter->fw_version[0] > '6' ||
3187 (adapter->fw_version[0] == '6' &&
3188 adapter->fw_version[2] > '6') ||
3189 (adapter->fw_version[0] == '6'
3190 && adapter->fw_version[2] == '6'
3191 && adapter->fw_version[3] > '1'))) {
3192 con_log(CL_DLEVEL1, ("megaraid: disable random deletion\n"));
3193 return 0;
3196 mbox = (mbox_t *)raw_mbox;
3198 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3200 raw_mbox[0] = FC_DEL_LOGDRV;
3201 raw_mbox[2] = OP_SUP_DEL_LOGDRV;
3203 // Issue the command
3204 rval = 0;
3205 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3207 con_log(CL_DLEVEL1, ("megaraid: supports random deletion\n"));
3209 rval = 1;
3212 return rval;
3217 * megaraid_mbox_get_max_sg - maximum sg elements supported by the firmware
3218 * @adapter : soft state for the controller
3220 * Find out the maximum number of scatter-gather elements supported by the
3221 * firmware.
3223 static int
3224 megaraid_mbox_get_max_sg(adapter_t *adapter)
3226 mbox_t *mbox;
3227 uint8_t raw_mbox[sizeof(mbox_t)];
3228 int nsg;
3231 mbox = (mbox_t *)raw_mbox;
3233 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3235 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3237 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3239 raw_mbox[0] = MAIN_MISC_OPCODE;
3240 raw_mbox[2] = GET_MAX_SG_SUPPORT;
3242 // Issue the command
3243 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3244 nsg = *(uint8_t *)adapter->ibuf;
3246 else {
3247 nsg = MBOX_DEFAULT_SG_SIZE;
3250 if (nsg > MBOX_MAX_SG_SIZE) nsg = MBOX_MAX_SG_SIZE;
3252 return nsg;
3257 * megaraid_mbox_enum_raid_scsi - enumerate the RAID and SCSI channels
3258 * @adapter : soft state for the controller
3260 * Enumerate the RAID and SCSI channels for ROMB platforms so that channels
3261 * can be exported as regular SCSI channels.
3263 static void
3264 megaraid_mbox_enum_raid_scsi(adapter_t *adapter)
3266 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3267 mbox_t *mbox;
3268 uint8_t raw_mbox[sizeof(mbox_t)];
3271 mbox = (mbox_t *)raw_mbox;
3273 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3275 mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3277 memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3279 raw_mbox[0] = CHNL_CLASS;
3280 raw_mbox[2] = GET_CHNL_CLASS;
3282 // Issue the command. If the command fails, all channels are RAID
3283 // channels
3284 raid_dev->channel_class = 0xFF;
3285 if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3286 raid_dev->channel_class = *(uint8_t *)adapter->ibuf;
3289 return;
3294 * megaraid_mbox_flush_cache - flush adapter and disks cache
3295 * @adapter : soft state for the controller
3297 * Flush adapter cache followed by disks cache.
3299 static void
3300 megaraid_mbox_flush_cache(adapter_t *adapter)
3302 mbox_t *mbox;
3303 uint8_t raw_mbox[sizeof(mbox_t)];
3306 mbox = (mbox_t *)raw_mbox;
3308 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3310 raw_mbox[0] = FLUSH_ADAPTER;
3312 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3313 con_log(CL_ANN, ("megaraid: flush adapter failed\n"));
3316 raw_mbox[0] = FLUSH_SYSTEM;
3318 if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3319 con_log(CL_ANN, ("megaraid: flush disks cache failed\n"));
3322 return;
3327 * megaraid_mbox_fire_sync_cmd - fire the sync cmd
3328 * @adapter : soft state for the controller
3330 * Clears the pending cmds in FW and reinits its RAID structs.
3332 static int
3333 megaraid_mbox_fire_sync_cmd(adapter_t *adapter)
3335 mbox_t *mbox;
3336 uint8_t raw_mbox[sizeof(mbox_t)];
3337 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3338 mbox64_t *mbox64;
3339 int status = 0;
3340 int i;
3341 uint32_t dword;
3343 mbox = (mbox_t *)raw_mbox;
3345 memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3347 raw_mbox[0] = 0xFF;
3349 mbox64 = raid_dev->mbox64;
3350 mbox = raid_dev->mbox;
3352 /* Wait until mailbox is free */
3353 if (megaraid_busywait_mbox(raid_dev) != 0) {
3354 status = 1;
3355 goto blocked_mailbox;
3358 /* Copy mailbox data into host structure */
3359 memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
3360 mbox->cmdid = 0xFE;
3361 mbox->busy = 1;
3362 mbox->poll = 0;
3363 mbox->ack = 0;
3364 mbox->numstatus = 0;
3365 mbox->status = 0;
3367 wmb();
3368 WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
3370 /* Wait for maximum 1 min for status to post.
3371 * If the Firmware SUPPORTS the ABOVE COMMAND,
3372 * mbox->cmd will be set to 0
3373 * else
3374 * the firmware will reject the command with
3375 * mbox->numstatus set to 1
3378 i = 0;
3379 status = 0;
3380 while (!mbox->numstatus && mbox->cmd == 0xFF) {
3381 rmb();
3382 msleep(1);
3383 i++;
3384 if (i > 1000 * 60) {
3385 status = 1;
3386 break;
3389 if (mbox->numstatus == 1)
3390 status = 1; /*cmd not supported*/
3392 /* Check for interrupt line */
3393 dword = RDOUTDOOR(raid_dev);
3394 WROUTDOOR(raid_dev, dword);
3395 WRINDOOR(raid_dev,2);
3397 return status;
3399 blocked_mailbox:
3400 con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n"));
3401 return status;
3405 * megaraid_mbox_display_scb - display SCB information, mostly debug purposes
3406 * @adapter : controller's soft state
3407 * @scb : SCB to be displayed
3408 * @level : debug level for console print
3410 * Diplay information about the given SCB iff the current debug level is
3411 * verbose.
3413 static void
3414 megaraid_mbox_display_scb(adapter_t *adapter, scb_t *scb)
3416 mbox_ccb_t *ccb;
3417 struct scsi_cmnd *scp;
3418 mbox_t *mbox;
3419 int level;
3420 int i;
3423 ccb = (mbox_ccb_t *)scb->ccb;
3424 scp = scb->scp;
3425 mbox = ccb->mbox;
3427 level = CL_DLEVEL3;
3429 con_log(level, (KERN_NOTICE
3430 "megaraid mailbox: status:%#x cmd:%#x id:%#x ", scb->status,
3431 mbox->cmd, scb->sno));
3433 con_log(level, ("sec:%#x lba:%#x addr:%#x ld:%d sg:%d\n",
3434 mbox->numsectors, mbox->lba, mbox->xferaddr, mbox->logdrv,
3435 mbox->numsge));
3437 if (!scp) return;
3439 con_log(level, (KERN_NOTICE "scsi cmnd: "));
3441 for (i = 0; i < scp->cmd_len; i++) {
3442 con_log(level, ("%#2.02x ", scp->cmnd[i]));
3445 con_log(level, ("\n"));
3447 return;
3452 * megaraid_mbox_setup_device_map - manage device ids
3453 * @adapter : Driver's soft state
3455 * Manange the device ids to have an appropriate mapping between the kernel
3456 * scsi addresses and megaraid scsi and logical drive addresses. We export
3457 * scsi devices on their actual addresses, whereas the logical drives are
3458 * exported on a virtual scsi channel.
3460 static void
3461 megaraid_mbox_setup_device_map(adapter_t *adapter)
3463 uint8_t c;
3464 uint8_t t;
3467 * First fill the values on the logical drive channel
3469 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3470 adapter->device_ids[adapter->max_channel][t] =
3471 (t < adapter->init_id) ? t : t - 1;
3473 adapter->device_ids[adapter->max_channel][adapter->init_id] = 0xFF;
3476 * Fill the values on the physical devices channels
3478 for (c = 0; c < adapter->max_channel; c++)
3479 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3480 adapter->device_ids[c][t] = (c << 8) | t;
3485 * END: internal commands library
3489 * START: Interface for the common management module
3491 * This is the module, which interfaces with the common management module to
3492 * provide support for ioctl and sysfs
3496 * megaraid_cmm_register - register with the management module
3497 * @adapter : HBA soft state
3499 * Register with the management module, which allows applications to issue
3500 * ioctl calls to the drivers. This interface is used by the management module
3501 * to setup sysfs support as well.
3503 static int
3504 megaraid_cmm_register(adapter_t *adapter)
3506 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3507 mraid_mmadp_t adp;
3508 scb_t *scb;
3509 mbox_ccb_t *ccb;
3510 int rval;
3511 int i;
3513 // Allocate memory for the base list of scb for management module.
3514 adapter->uscb_list = kcalloc(MBOX_MAX_USER_CMDS, sizeof(scb_t), GFP_KERNEL);
3516 if (adapter->uscb_list == NULL) {
3517 con_log(CL_ANN, (KERN_WARNING
3518 "megaraid: out of memory, %s %d\n", __func__,
3519 __LINE__));
3520 return -1;
3524 // Initialize the synchronization parameters for resources for
3525 // commands for management module
3526 INIT_LIST_HEAD(&adapter->uscb_pool);
3528 spin_lock_init(USER_FREE_LIST_LOCK(adapter));
3532 // link all the packets. Note, CCB for commands, coming from the
3533 // commom management module, mailbox physical address are already
3534 // setup by it. We just need placeholder for that in our local command
3535 // control blocks
3536 for (i = 0; i < MBOX_MAX_USER_CMDS; i++) {
3538 scb = adapter->uscb_list + i;
3539 ccb = raid_dev->uccb_list + i;
3541 scb->ccb = (caddr_t)ccb;
3542 ccb->mbox64 = raid_dev->umbox64 + i;
3543 ccb->mbox = &ccb->mbox64->mbox32;
3544 ccb->raw_mbox = (uint8_t *)ccb->mbox;
3546 scb->gp = 0;
3548 // COMMAND ID 0 - (MBOX_MAX_SCSI_CMDS-1) ARE RESERVED FOR
3549 // COMMANDS COMING FROM IO SUBSYSTEM (MID-LAYER)
3550 scb->sno = i + MBOX_MAX_SCSI_CMDS;
3552 scb->scp = NULL;
3553 scb->state = SCB_FREE;
3554 scb->dma_direction = PCI_DMA_NONE;
3555 scb->dma_type = MRAID_DMA_NONE;
3556 scb->dev_channel = -1;
3557 scb->dev_target = -1;
3559 // put scb in the free pool
3560 list_add_tail(&scb->list, &adapter->uscb_pool);
3563 adp.unique_id = adapter->unique_id;
3564 adp.drvr_type = DRVRTYPE_MBOX;
3565 adp.drvr_data = (unsigned long)adapter;
3566 adp.pdev = adapter->pdev;
3567 adp.issue_uioc = megaraid_mbox_mm_handler;
3568 adp.timeout = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
3569 adp.max_kioc = MBOX_MAX_USER_CMDS;
3571 if ((rval = mraid_mm_register_adp(&adp)) != 0) {
3573 con_log(CL_ANN, (KERN_WARNING
3574 "megaraid mbox: did not register with CMM\n"));
3576 kfree(adapter->uscb_list);
3579 return rval;
3584 * megaraid_cmm_unregister - un-register with the management module
3585 * @adapter : HBA soft state
3587 * Un-register with the management module.
3588 * FIXME: mgmt module must return failure for unregister if it has pending
3589 * commands in LLD.
3591 static int
3592 megaraid_cmm_unregister(adapter_t *adapter)
3594 kfree(adapter->uscb_list);
3595 mraid_mm_unregister_adp(adapter->unique_id);
3596 return 0;
3601 * megaraid_mbox_mm_handler - interface for CMM to issue commands to LLD
3602 * @drvr_data : LLD specific data
3603 * @kioc : CMM interface packet
3604 * @action : command action
3606 * This routine is invoked whenever the Common Management Module (CMM) has a
3607 * command for us. The 'action' parameter specifies if this is a new command
3608 * or otherwise.
3610 static int
3611 megaraid_mbox_mm_handler(unsigned long drvr_data, uioc_t *kioc, uint32_t action)
3613 adapter_t *adapter;
3615 if (action != IOCTL_ISSUE) {
3616 con_log(CL_ANN, (KERN_WARNING
3617 "megaraid: unsupported management action:%#2x\n",
3618 action));
3619 return (-ENOTSUPP);
3622 adapter = (adapter_t *)drvr_data;
3624 // make sure this adapter is not being detached right now.
3625 if (atomic_read(&adapter->being_detached)) {
3626 con_log(CL_ANN, (KERN_WARNING
3627 "megaraid: reject management request, detaching\n"));
3628 return (-ENODEV);
3631 switch (kioc->opcode) {
3633 case GET_ADAP_INFO:
3635 kioc->status = gather_hbainfo(adapter, (mraid_hba_info_t *)
3636 (unsigned long)kioc->buf_vaddr);
3638 kioc->done(kioc);
3640 return kioc->status;
3642 case MBOX_CMD:
3644 return megaraid_mbox_mm_command(adapter, kioc);
3646 default:
3647 kioc->status = (-EINVAL);
3648 kioc->done(kioc);
3649 return (-EINVAL);
3652 return 0; // not reached
3656 * megaraid_mbox_mm_command - issues commands routed through CMM
3657 * @adapter : HBA soft state
3658 * @kioc : management command packet
3660 * Issues commands, which are routed through the management module.
3662 static int
3663 megaraid_mbox_mm_command(adapter_t *adapter, uioc_t *kioc)
3665 struct list_head *head = &adapter->uscb_pool;
3666 mbox64_t *mbox64;
3667 uint8_t *raw_mbox;
3668 scb_t *scb;
3669 mbox_ccb_t *ccb;
3670 unsigned long flags;
3672 // detach one scb from free pool
3673 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3675 if (list_empty(head)) { // should never happen because of CMM
3677 con_log(CL_ANN, (KERN_WARNING
3678 "megaraid mbox: bug in cmm handler, lost resources\n"));
3680 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3682 return (-EINVAL);
3685 scb = list_entry(head->next, scb_t, list);
3686 list_del_init(&scb->list);
3688 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3690 scb->state = SCB_ACTIVE;
3691 scb->dma_type = MRAID_DMA_NONE;
3692 scb->dma_direction = PCI_DMA_NONE;
3694 ccb = (mbox_ccb_t *)scb->ccb;
3695 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3696 raw_mbox = (uint8_t *)&mbox64->mbox32;
3698 memcpy(ccb->mbox64, mbox64, sizeof(mbox64_t));
3700 scb->gp = (unsigned long)kioc;
3703 * If it is a logdrv random delete operation, we have to wait till
3704 * there are no outstanding cmds at the fw and then issue it directly
3706 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3708 if (wait_till_fw_empty(adapter)) {
3709 con_log(CL_ANN, (KERN_NOTICE
3710 "megaraid mbox: LD delete, timed out\n"));
3712 kioc->status = -ETIME;
3714 scb->status = -1;
3716 megaraid_mbox_mm_done(adapter, scb);
3718 return (-ETIME);
3721 INIT_LIST_HEAD(&scb->list);
3723 scb->state = SCB_ISSUED;
3724 if (mbox_post_cmd(adapter, scb) != 0) {
3726 con_log(CL_ANN, (KERN_NOTICE
3727 "megaraid mbox: LD delete, mailbox busy\n"));
3729 kioc->status = -EBUSY;
3731 scb->status = -1;
3733 megaraid_mbox_mm_done(adapter, scb);
3735 return (-EBUSY);
3738 return 0;
3741 // put the command on the pending list and execute
3742 megaraid_mbox_runpendq(adapter, scb);
3744 return 0;
3748 static int
3749 wait_till_fw_empty(adapter_t *adapter)
3751 unsigned long flags = 0;
3752 int i;
3756 * Set the quiescent flag to stop issuing cmds to FW.
3758 spin_lock_irqsave(&adapter->lock, flags);
3759 adapter->quiescent++;
3760 spin_unlock_irqrestore(&adapter->lock, flags);
3763 * Wait till there are no more cmds outstanding at FW. Try for at most
3764 * 60 seconds
3766 for (i = 0; i < 60 && adapter->outstanding_cmds; i++) {
3767 con_log(CL_DLEVEL1, (KERN_INFO
3768 "megaraid: FW has %d pending commands\n",
3769 adapter->outstanding_cmds));
3771 msleep(1000);
3774 return adapter->outstanding_cmds;
3779 * megaraid_mbox_mm_done - callback for CMM commands
3780 * @adapter : HBA soft state
3781 * @scb : completed command
3783 * Callback routine for internal commands originated from the management
3784 * module.
3786 static void
3787 megaraid_mbox_mm_done(adapter_t *adapter, scb_t *scb)
3789 uioc_t *kioc;
3790 mbox64_t *mbox64;
3791 uint8_t *raw_mbox;
3792 unsigned long flags;
3794 kioc = (uioc_t *)scb->gp;
3795 mbox64 = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3796 mbox64->mbox32.status = scb->status;
3797 raw_mbox = (uint8_t *)&mbox64->mbox32;
3800 // put scb in the free pool
3801 scb->state = SCB_FREE;
3802 scb->scp = NULL;
3804 spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3806 list_add(&scb->list, &adapter->uscb_pool);
3808 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3810 // if a delete logical drive operation succeeded, restart the
3811 // controller
3812 if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3814 adapter->quiescent--;
3816 megaraid_mbox_runpendq(adapter, NULL);
3819 kioc->done(kioc);
3821 return;
3826 * gather_hbainfo - HBA characteristics for the applications
3827 * @adapter : HBA soft state
3828 * @hinfo : pointer to the caller's host info strucuture
3830 static int
3831 gather_hbainfo(adapter_t *adapter, mraid_hba_info_t *hinfo)
3833 uint8_t dmajor;
3835 dmajor = megaraid_mbox_version[0];
3837 hinfo->pci_vendor_id = adapter->pdev->vendor;
3838 hinfo->pci_device_id = adapter->pdev->device;
3839 hinfo->subsys_vendor_id = adapter->pdev->subsystem_vendor;
3840 hinfo->subsys_device_id = adapter->pdev->subsystem_device;
3842 hinfo->pci_bus = adapter->pdev->bus->number;
3843 hinfo->pci_dev_fn = adapter->pdev->devfn;
3844 hinfo->pci_slot = PCI_SLOT(adapter->pdev->devfn);
3845 hinfo->irq = adapter->host->irq;
3846 hinfo->baseport = ADAP2RAIDDEV(adapter)->baseport;
3848 hinfo->unique_id = (hinfo->pci_bus << 8) | adapter->pdev->devfn;
3849 hinfo->host_no = adapter->host->host_no;
3851 return 0;
3855 * END: Interface for the common management module
3861 * megaraid_sysfs_alloc_resources - allocate sysfs related resources
3862 * @adapter : controller's soft state
3864 * Allocate packets required to issue FW calls whenever the sysfs attributes
3865 * are read. These attributes would require up-to-date information from the
3866 * FW. Also set up resources for mutual exclusion to share these resources and
3867 * the wait queue.
3869 * Return 0 on success.
3870 * Return -ERROR_CODE on failure.
3872 static int
3873 megaraid_sysfs_alloc_resources(adapter_t *adapter)
3875 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3876 int rval = 0;
3878 raid_dev->sysfs_uioc = kmalloc(sizeof(uioc_t), GFP_KERNEL);
3880 raid_dev->sysfs_mbox64 = kmalloc(sizeof(mbox64_t), GFP_KERNEL);
3882 raid_dev->sysfs_buffer = pci_alloc_consistent(adapter->pdev,
3883 PAGE_SIZE, &raid_dev->sysfs_buffer_dma);
3885 if (!raid_dev->sysfs_uioc || !raid_dev->sysfs_mbox64 ||
3886 !raid_dev->sysfs_buffer) {
3888 con_log(CL_ANN, (KERN_WARNING
3889 "megaraid: out of memory, %s %d\n", __func__,
3890 __LINE__));
3892 rval = -ENOMEM;
3894 megaraid_sysfs_free_resources(adapter);
3897 mutex_init(&raid_dev->sysfs_mtx);
3899 init_waitqueue_head(&raid_dev->sysfs_wait_q);
3901 return rval;
3906 * megaraid_sysfs_free_resources - free sysfs related resources
3907 * @adapter : controller's soft state
3909 * Free packets allocated for sysfs FW commands
3911 static void
3912 megaraid_sysfs_free_resources(adapter_t *adapter)
3914 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3916 kfree(raid_dev->sysfs_uioc);
3917 kfree(raid_dev->sysfs_mbox64);
3919 if (raid_dev->sysfs_buffer) {
3920 pci_free_consistent(adapter->pdev, PAGE_SIZE,
3921 raid_dev->sysfs_buffer, raid_dev->sysfs_buffer_dma);
3927 * megaraid_sysfs_get_ldmap_done - callback for get ldmap
3928 * @uioc : completed packet
3930 * Callback routine called in the ISR/tasklet context for get ldmap call
3932 static void
3933 megaraid_sysfs_get_ldmap_done(uioc_t *uioc)
3935 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3936 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3938 uioc->status = 0;
3940 wake_up(&raid_dev->sysfs_wait_q);
3945 * megaraid_sysfs_get_ldmap_timeout - timeout handling for get ldmap
3946 * @data : timed out packet
3948 * Timeout routine to recover and return to application, in case the adapter
3949 * has stopped responding. A timeout of 60 seconds for this command seems like
3950 * a good value.
3952 static void
3953 megaraid_sysfs_get_ldmap_timeout(unsigned long data)
3955 uioc_t *uioc = (uioc_t *)data;
3956 adapter_t *adapter = (adapter_t *)uioc->buf_vaddr;
3957 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3959 uioc->status = -ETIME;
3961 wake_up(&raid_dev->sysfs_wait_q);
3966 * megaraid_sysfs_get_ldmap - get update logical drive map
3967 * @adapter : controller's soft state
3969 * This routine will be called whenever user reads the logical drive
3970 * attributes, go get the current logical drive mapping table from the
3971 * firmware. We use the management API's to issue commands to the controller.
3973 * NOTE: The commands issuance functionality is not generalized and
3974 * implemented in context of "get ld map" command only. If required, the
3975 * command issuance logical can be trivially pulled out and implemented as a
3976 * standalone library. For now, this should suffice since there is no other
3977 * user of this interface.
3979 * Return 0 on success.
3980 * Return -1 on failure.
3982 static int
3983 megaraid_sysfs_get_ldmap(adapter_t *adapter)
3985 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
3986 uioc_t *uioc;
3987 mbox64_t *mbox64;
3988 mbox_t *mbox;
3989 char *raw_mbox;
3990 struct timer_list sysfs_timer;
3991 struct timer_list *timerp;
3992 caddr_t ldmap;
3993 int rval = 0;
3996 * Allow only one read at a time to go through the sysfs attributes
3998 mutex_lock(&raid_dev->sysfs_mtx);
4000 uioc = raid_dev->sysfs_uioc;
4001 mbox64 = raid_dev->sysfs_mbox64;
4002 ldmap = raid_dev->sysfs_buffer;
4004 memset(uioc, 0, sizeof(uioc_t));
4005 memset(mbox64, 0, sizeof(mbox64_t));
4006 memset(ldmap, 0, sizeof(raid_dev->curr_ldmap));
4008 mbox = &mbox64->mbox32;
4009 raw_mbox = (char *)mbox;
4010 uioc->cmdbuf = (uint64_t)(unsigned long)mbox64;
4011 uioc->buf_vaddr = (caddr_t)adapter;
4012 uioc->status = -ENODATA;
4013 uioc->done = megaraid_sysfs_get_ldmap_done;
4016 * Prepare the mailbox packet to get the current logical drive mapping
4017 * table
4019 mbox->xferaddr = (uint32_t)raid_dev->sysfs_buffer_dma;
4021 raw_mbox[0] = FC_DEL_LOGDRV;
4022 raw_mbox[2] = OP_GET_LDID_MAP;
4025 * Setup a timer to recover from a non-responding controller
4027 timerp = &sysfs_timer;
4028 init_timer(timerp);
4030 timerp->function = megaraid_sysfs_get_ldmap_timeout;
4031 timerp->data = (unsigned long)uioc;
4032 timerp->expires = jiffies + 60 * HZ;
4034 add_timer(timerp);
4037 * Send the command to the firmware
4039 rval = megaraid_mbox_mm_command(adapter, uioc);
4041 if (rval == 0) { // command successfully issued
4042 wait_event(raid_dev->sysfs_wait_q, (uioc->status != -ENODATA));
4045 * Check if the command timed out
4047 if (uioc->status == -ETIME) {
4048 con_log(CL_ANN, (KERN_NOTICE
4049 "megaraid: sysfs get ld map timed out\n"));
4051 rval = -ETIME;
4053 else {
4054 rval = mbox->status;
4057 if (rval == 0) {
4058 memcpy(raid_dev->curr_ldmap, ldmap,
4059 sizeof(raid_dev->curr_ldmap));
4061 else {
4062 con_log(CL_ANN, (KERN_NOTICE
4063 "megaraid: get ld map failed with %x\n", rval));
4066 else {
4067 con_log(CL_ANN, (KERN_NOTICE
4068 "megaraid: could not issue ldmap command:%x\n", rval));
4072 del_timer_sync(timerp);
4074 mutex_unlock(&raid_dev->sysfs_mtx);
4076 return rval;
4081 * megaraid_sysfs_show_app_hndl - display application handle for this adapter
4082 * @cdev : class device object representation for the host
4083 * @buf : buffer to send data to
4085 * Display the handle used by the applications while executing management
4086 * tasks on the adapter. We invoke a management module API to get the adapter
4087 * handle, since we do not interface with applications directly.
4089 static ssize_t
4090 megaraid_sysfs_show_app_hndl(struct device *dev, struct device_attribute *attr,
4091 char *buf)
4093 struct Scsi_Host *shost = class_to_shost(dev);
4094 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(shost);
4095 uint32_t app_hndl;
4097 app_hndl = mraid_mm_adapter_app_handle(adapter->unique_id);
4099 return snprintf(buf, 8, "%u\n", app_hndl);
4104 * megaraid_sysfs_show_ldnum - display the logical drive number for this device
4105 * @dev : device object representation for the scsi device
4106 * @attr : device attribute to show
4107 * @buf : buffer to send data to
4109 * Display the logical drive number for the device in question, if it a valid
4110 * logical drive. For physical devices, "-1" is returned.
4112 * The logical drive number is displayed in following format:
4114 * <SCSI ID> <LD NUM> <LD STICKY ID> <APP ADAPTER HANDLE>
4116 * <int> <int> <int> <int>
4118 static ssize_t
4119 megaraid_sysfs_show_ldnum(struct device *dev, struct device_attribute *attr, char *buf)
4121 struct scsi_device *sdev = to_scsi_device(dev);
4122 adapter_t *adapter = (adapter_t *)SCSIHOST2ADAP(sdev->host);
4123 mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
4124 int scsi_id = -1;
4125 int logical_drv = -1;
4126 int ldid_map = -1;
4127 uint32_t app_hndl = 0;
4128 int mapped_sdev_id;
4129 int rval;
4130 int i;
4132 if (raid_dev->random_del_supported &&
4133 MRAID_IS_LOGICAL_SDEV(adapter, sdev)) {
4135 rval = megaraid_sysfs_get_ldmap(adapter);
4136 if (rval == 0) {
4138 for (i = 0; i < MAX_LOGICAL_DRIVES_40LD; i++) {
4140 mapped_sdev_id = sdev->id;
4142 if (sdev->id > adapter->init_id) {
4143 mapped_sdev_id -= 1;
4146 if (raid_dev->curr_ldmap[i] == mapped_sdev_id) {
4148 scsi_id = sdev->id;
4150 logical_drv = i;
4152 ldid_map = raid_dev->curr_ldmap[i];
4154 app_hndl = mraid_mm_adapter_app_handle(
4155 adapter->unique_id);
4157 break;
4161 else {
4162 con_log(CL_ANN, (KERN_NOTICE
4163 "megaraid: sysfs get ld map failed: %x\n",
4164 rval));
4168 return snprintf(buf, 36, "%d %d %d %d\n", scsi_id, logical_drv,
4169 ldid_map, app_hndl);
4174 * END: Mailbox Low Level Driver
4176 module_init(megaraid_init);
4177 module_exit(megaraid_exit);
4179 /* vim: set ts=8 sw=8 tw=78 ai si: */