]> err.no Git - linux-2.6/blob - drivers/scsi/megaraid/megaraid_mbox.c
Pull acpi-debug into release branch
[linux-2.6] / drivers / scsi / megaraid / megaraid_mbox.c
1 /*
2  *
3  *                      Linux MegaRAID device driver
4  *
5  * Copyright (c) 2003-2004  LSI Logic Corporation.
6  *
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.
11  *
12  * FILE         : megaraid_mbox.c
13  * Version      : v2.20.5.1 (Nov 16 2006)
14  *
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
20  *
21  * List of supported controllers
22  *
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
40  *
41  *
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
54  *
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
63  *
64  * FSC  MegaRAID PCI Express ROMB       1000    0408    1734    1065
65  *
66  * ACER MegaRAID ROMB-2E                1000    0408    1025    004D
67  *
68  * NEC  MegaRAID PCI Express ROMB       1000    0408    1033    8287
69  *
70  * For history of changes, see Documentation/ChangeLog.megaraid
71  */
72
73 #include "megaraid_mbox.h"
74
75 static int megaraid_init(void);
76 static void megaraid_exit(void);
77
78 static int megaraid_probe_one(struct pci_dev*, const struct pci_device_id *);
79 static void megaraid_detach_one(struct pci_dev *);
80 static void megaraid_mbox_shutdown(struct pci_dev *);
81
82 static int megaraid_io_attach(adapter_t *);
83 static void megaraid_io_detach(adapter_t *);
84
85 static int megaraid_init_mbox(adapter_t *);
86 static void megaraid_fini_mbox(adapter_t *);
87
88 static int megaraid_alloc_cmd_packets(adapter_t *);
89 static void megaraid_free_cmd_packets(adapter_t *);
90
91 static int megaraid_mbox_setup_dma_pools(adapter_t *);
92 static void megaraid_mbox_teardown_dma_pools(adapter_t *);
93
94 static int megaraid_sysfs_alloc_resources(adapter_t *);
95 static void megaraid_sysfs_free_resources(adapter_t *);
96
97 static int megaraid_abort_handler(struct scsi_cmnd *);
98 static int megaraid_reset_handler(struct scsi_cmnd *);
99
100 static int mbox_post_sync_cmd(adapter_t *, uint8_t []);
101 static int mbox_post_sync_cmd_fast(adapter_t *, uint8_t []);
102 static int megaraid_busywait_mbox(mraid_device_t *);
103 static int megaraid_mbox_product_info(adapter_t *);
104 static int megaraid_mbox_extended_cdb(adapter_t *);
105 static int megaraid_mbox_support_ha(adapter_t *, uint16_t *);
106 static int megaraid_mbox_support_random_del(adapter_t *);
107 static int megaraid_mbox_get_max_sg(adapter_t *);
108 static void megaraid_mbox_enum_raid_scsi(adapter_t *);
109 static void megaraid_mbox_flush_cache(adapter_t *);
110 static int megaraid_mbox_fire_sync_cmd(adapter_t *);
111
112 static void megaraid_mbox_display_scb(adapter_t *, scb_t *);
113 static void megaraid_mbox_setup_device_map(adapter_t *);
114
115 static int megaraid_queue_command(struct scsi_cmnd *,
116                 void (*)(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 *);
123
124 static irqreturn_t megaraid_isr(int, void *);
125
126 static void megaraid_mbox_dpc(unsigned long);
127
128 static ssize_t megaraid_sysfs_show_app_hndl(struct class_device *, char *);
129 static ssize_t megaraid_sysfs_show_ldnum(struct device *, struct device_attribute *attr, char *);
130
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 *);
138
139
140
141 MODULE_AUTHOR("megaraidlinux@lsi.com");
142 MODULE_DESCRIPTION("LSI Logic MegaRAID Mailbox Driver");
143 MODULE_LICENSE("GPL");
144 MODULE_VERSION(MEGARAID_VERSION);
145
146 /*
147  * ### modules parameters for driver ###
148  */
149
150 /*
151  * Set to enable driver to expose unconfigured disk to kernel
152  */
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)");
157
158 /*
159  * driver wait time if the adapter's mailbox is busy
160  */
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)");
165
166 /*
167  * number of sectors per IO command
168  */
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)");
173
174 /*
175  * number of commands per logical unit
176  */
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)");
181
182
183 /*
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
187  */
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)");
192
193
194 /*
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.
198  */
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)");
202
203 /*
204  * ### global data ###
205  */
206 static uint8_t megaraid_mbox_version[8] =
207         { 0x02, 0x20, 0x04, 0x06, 3, 7, 20, 5 };
208
209
210 /*
211  * PCI table for all supported controllers.
212  */
213 static struct pci_device_id pci_id_table_g[] =  {
214         {
215                 PCI_VENDOR_ID_DELL,
216                 PCI_DEVICE_ID_PERC4_DI_DISCOVERY,
217                 PCI_VENDOR_ID_DELL,
218                 PCI_SUBSYS_ID_PERC4_DI_DISCOVERY,
219         },
220         {
221                 PCI_VENDOR_ID_LSI_LOGIC,
222                 PCI_DEVICE_ID_PERC4_SC,
223                 PCI_VENDOR_ID_DELL,
224                 PCI_SUBSYS_ID_PERC4_SC,
225         },
226         {
227                 PCI_VENDOR_ID_LSI_LOGIC,
228                 PCI_DEVICE_ID_PERC4_DC,
229                 PCI_VENDOR_ID_DELL,
230                 PCI_SUBSYS_ID_PERC4_DC,
231         },
232         {
233                 PCI_VENDOR_ID_LSI_LOGIC,
234                 PCI_DEVICE_ID_VERDE,
235                 PCI_ANY_ID,
236                 PCI_ANY_ID,
237         },
238         {
239                 PCI_VENDOR_ID_DELL,
240                 PCI_DEVICE_ID_PERC4_DI_EVERGLADES,
241                 PCI_VENDOR_ID_DELL,
242                 PCI_SUBSYS_ID_PERC4_DI_EVERGLADES,
243         },
244         {
245                 PCI_VENDOR_ID_DELL,
246                 PCI_DEVICE_ID_PERC4E_SI_BIGBEND,
247                 PCI_VENDOR_ID_DELL,
248                 PCI_SUBSYS_ID_PERC4E_SI_BIGBEND,
249         },
250         {
251                 PCI_VENDOR_ID_DELL,
252                 PCI_DEVICE_ID_PERC4E_DI_KOBUK,
253                 PCI_VENDOR_ID_DELL,
254                 PCI_SUBSYS_ID_PERC4E_DI_KOBUK,
255         },
256         {
257                 PCI_VENDOR_ID_DELL,
258                 PCI_DEVICE_ID_PERC4E_DI_CORVETTE,
259                 PCI_VENDOR_ID_DELL,
260                 PCI_SUBSYS_ID_PERC4E_DI_CORVETTE,
261         },
262         {
263                 PCI_VENDOR_ID_DELL,
264                 PCI_DEVICE_ID_PERC4E_DI_EXPEDITION,
265                 PCI_VENDOR_ID_DELL,
266                 PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION,
267         },
268         {
269                 PCI_VENDOR_ID_DELL,
270                 PCI_DEVICE_ID_PERC4E_DI_GUADALUPE,
271                 PCI_VENDOR_ID_DELL,
272                 PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE,
273         },
274         {
275                 PCI_VENDOR_ID_LSI_LOGIC,
276                 PCI_DEVICE_ID_DOBSON,
277                 PCI_ANY_ID,
278                 PCI_ANY_ID,
279         },
280         {
281                 PCI_VENDOR_ID_AMI,
282                 PCI_DEVICE_ID_AMI_MEGARAID3,
283                 PCI_ANY_ID,
284                 PCI_ANY_ID,
285         },
286         {
287                 PCI_VENDOR_ID_LSI_LOGIC,
288                 PCI_DEVICE_ID_AMI_MEGARAID3,
289                 PCI_ANY_ID,
290                 PCI_ANY_ID,
291         },
292         {
293                 PCI_VENDOR_ID_LSI_LOGIC,
294                 PCI_DEVICE_ID_LINDSAY,
295                 PCI_ANY_ID,
296                 PCI_ANY_ID,
297         },
298         {0}     /* Terminating entry */
299 };
300 MODULE_DEVICE_TABLE(pci, pci_id_table_g);
301
302
303 static struct pci_driver megaraid_pci_driver_g = {
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,
309 };
310
311
312
313 // definitions for the device attributes for exporting logical drive number
314 // for a scsi address (Host, Channel, Id, Lun)
315
316 CLASS_DEVICE_ATTR(megaraid_mbox_app_hndl, S_IRUSR, megaraid_sysfs_show_app_hndl,
317                 NULL);
318
319 // Host template initializer for megaraid mbox sysfs device attributes
320 static struct class_device_attribute *megaraid_shost_attrs[] = {
321         &class_device_attr_megaraid_mbox_app_hndl,
322         NULL,
323 };
324
325
326 DEVICE_ATTR(megaraid_mbox_ld, S_IRUSR, megaraid_sysfs_show_ldnum, NULL);
327
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,
332 };
333
334 /**
335  * megaraid_change_queue_depth - Change the device's queue depth
336  * @sdev:       scsi device struct
337  * @qdepth:     depth to set
338  *
339  * Return value:
340  *      actual depth set
341  */
342 static int megaraid_change_queue_depth(struct scsi_device *sdev, int qdepth)
343 {
344         if (qdepth > MBOX_MAX_SCSI_CMDS)
345                 qdepth = MBOX_MAX_SCSI_CMDS;
346         scsi_adjust_queue_depth(sdev, 0, qdepth);
347         return sdev->queue_depth;
348 }
349
350 /*
351  * Scsi host template for megaraid unified driver
352  */
353 static struct scsi_host_template megaraid_template_g = {
354         .module                         = THIS_MODULE,
355         .name                           = "LSI Logic MegaRAID driver",
356         .proc_name                      = "megaraid",
357         .queuecommand                   = megaraid_queue_command,
358         .eh_abort_handler               = megaraid_abort_handler,
359         .eh_device_reset_handler        = megaraid_reset_handler,
360         .eh_bus_reset_handler           = megaraid_reset_handler,
361         .eh_host_reset_handler          = megaraid_reset_handler,
362         .change_queue_depth             = megaraid_change_queue_depth,
363         .use_clustering                 = ENABLE_CLUSTERING,
364         .sdev_attrs                     = megaraid_sdev_attrs,
365         .shost_attrs                    = megaraid_shost_attrs,
366 };
367
368
369 /**
370  * megaraid_init - module load hook
371  *
372  * We register ourselves as hotplug enabled module and let PCI subsystem
373  * discover our adapters.
374  */
375 static int __init
376 megaraid_init(void)
377 {
378         int     rval;
379
380         // Announce the driver version
381         con_log(CL_ANN, (KERN_INFO "megaraid: %s %s\n", MEGARAID_VERSION,
382                 MEGARAID_EXT_VERSION));
383
384         // check validity of module parameters
385         if (megaraid_cmd_per_lun > MBOX_MAX_SCSI_CMDS) {
386
387                 con_log(CL_ANN, (KERN_WARNING
388                         "megaraid mailbox: max commands per lun reset to %d\n",
389                         MBOX_MAX_SCSI_CMDS));
390
391                 megaraid_cmd_per_lun = MBOX_MAX_SCSI_CMDS;
392         }
393
394
395         // register as a PCI hot-plug driver module
396         rval = pci_register_driver(&megaraid_pci_driver_g);
397         if (rval < 0) {
398                 con_log(CL_ANN, (KERN_WARNING
399                         "megaraid: could not register hotplug support.\n"));
400         }
401
402         return rval;
403 }
404
405
406 /**
407  * megaraid_exit - driver unload entry point
408  *
409  * We simply unwrap the megaraid_init routine here.
410  */
411 static void __exit
412 megaraid_exit(void)
413 {
414         con_log(CL_DLEVEL1, (KERN_NOTICE "megaraid: unloading framework\n"));
415
416         // unregister as PCI hotplug driver
417         pci_unregister_driver(&megaraid_pci_driver_g);
418
419         return;
420 }
421
422
423 /**
424  * megaraid_probe_one - PCI hotplug entry point
425  * @pdev        : handle to this controller's PCI configuration space
426  * @id          : pci device id of the class of controllers
427  *
428  * This routine should be called whenever a new adapter is detected by the
429  * PCI hotplug susbsytem.
430  */
431 static int __devinit
432 megaraid_probe_one(struct pci_dev *pdev, const struct pci_device_id *id)
433 {
434         adapter_t       *adapter;
435
436
437         // detected a new controller
438         con_log(CL_ANN, (KERN_INFO
439                 "megaraid: probe new device %#4.04x:%#4.04x:%#4.04x:%#4.04x: ",
440                 pdev->vendor, pdev->device, pdev->subsystem_vendor,
441                 pdev->subsystem_device));
442
443         con_log(CL_ANN, ("bus %d:slot %d:func %d\n", pdev->bus->number,
444                 PCI_SLOT(pdev->devfn), PCI_FUNC(pdev->devfn)));
445
446         if (pci_enable_device(pdev)) {
447                 con_log(CL_ANN, (KERN_WARNING
448                                 "megaraid: pci_enable_device failed\n"));
449
450                 return -ENODEV;
451         }
452
453         // Enable bus-mastering on this controller
454         pci_set_master(pdev);
455
456         // Allocate the per driver initialization structure
457         adapter = kzalloc(sizeof(adapter_t), GFP_KERNEL);
458
459         if (adapter == NULL) {
460                 con_log(CL_ANN, (KERN_WARNING
461                 "megaraid: out of memory, %s %d.\n", __FUNCTION__, __LINE__));
462
463                 goto out_probe_one;
464         }
465
466
467         // set up PCI related soft state and other pre-known parameters
468         adapter->unique_id      = pdev->bus->number << 8 | pdev->devfn;
469         adapter->irq            = pdev->irq;
470         adapter->pdev           = pdev;
471
472         atomic_set(&adapter->being_detached, 0);
473
474         // Setup the default DMA mask. This would be changed later on
475         // depending on hardware capabilities
476         if (pci_set_dma_mask(adapter->pdev, DMA_32BIT_MASK) != 0) {
477
478                 con_log(CL_ANN, (KERN_WARNING
479                         "megaraid: pci_set_dma_mask failed:%d\n", __LINE__));
480
481                 goto out_free_adapter;
482         }
483
484
485         // Initialize the synchronization lock for kernel and LLD
486         spin_lock_init(&adapter->lock);
487
488         // Initialize the command queues: the list of free SCBs and the list
489         // of pending SCBs.
490         INIT_LIST_HEAD(&adapter->kscb_pool);
491         spin_lock_init(SCSI_FREE_LIST_LOCK(adapter));
492
493         INIT_LIST_HEAD(&adapter->pend_list);
494         spin_lock_init(PENDING_LIST_LOCK(adapter));
495
496         INIT_LIST_HEAD(&adapter->completed_list);
497         spin_lock_init(COMPLETED_LIST_LOCK(adapter));
498
499
500         // Start the mailbox based controller
501         if (megaraid_init_mbox(adapter) != 0) {
502                 con_log(CL_ANN, (KERN_WARNING
503                         "megaraid: maibox adapter did not initialize\n"));
504
505                 goto out_free_adapter;
506         }
507
508         // Register with LSI Common Management Module
509         if (megaraid_cmm_register(adapter) != 0) {
510
511                 con_log(CL_ANN, (KERN_WARNING
512                 "megaraid: could not register with management module\n"));
513
514                 goto out_fini_mbox;
515         }
516
517         // setup adapter handle in PCI soft state
518         pci_set_drvdata(pdev, adapter);
519
520         // attach with scsi mid-layer
521         if (megaraid_io_attach(adapter) != 0) {
522
523                 con_log(CL_ANN, (KERN_WARNING "megaraid: io attach failed\n"));
524
525                 goto out_cmm_unreg;
526         }
527
528         return 0;
529
530 out_cmm_unreg:
531         pci_set_drvdata(pdev, NULL);
532         megaraid_cmm_unregister(adapter);
533 out_fini_mbox:
534         megaraid_fini_mbox(adapter);
535 out_free_adapter:
536         kfree(adapter);
537 out_probe_one:
538         pci_disable_device(pdev);
539
540         return -ENODEV;
541 }
542
543
544 /**
545  * megaraid_detach_one - release framework resources and call LLD release routine
546  * @pdev        : handle for our PCI cofiguration space
547  *
548  * This routine is called during driver unload. We free all the allocated
549  * resources and call the corresponding LLD so that it can also release all
550  * its resources.
551  *
552  * This routine is also called from the PCI hotplug system.
553  */
554 static void
555 megaraid_detach_one(struct pci_dev *pdev)
556 {
557         adapter_t               *adapter;
558         struct Scsi_Host        *host;
559
560
561         // Start a rollback on this adapter
562         adapter = pci_get_drvdata(pdev);
563
564         if (!adapter) {
565                 con_log(CL_ANN, (KERN_CRIT
566                 "megaraid: Invalid detach on %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
567                         pdev->vendor, pdev->device, pdev->subsystem_vendor,
568                         pdev->subsystem_device));
569
570                 return;
571         }
572         else {
573                 con_log(CL_ANN, (KERN_NOTICE
574                 "megaraid: detaching device %#4.04x:%#4.04x:%#4.04x:%#4.04x\n",
575                         pdev->vendor, pdev->device, pdev->subsystem_vendor,
576                         pdev->subsystem_device));
577         }
578
579
580         host = adapter->host;
581
582         // do not allow any more requests from the management module for this
583         // adapter.
584         // FIXME: How do we account for the request which might still be
585         // pending with us?
586         atomic_set(&adapter->being_detached, 1);
587
588         // detach from the IO sub-system
589         megaraid_io_detach(adapter);
590
591         // reset the device state in the PCI structure. We check this
592         // condition when we enter here. If the device state is NULL,
593         // that would mean the device has already been removed
594         pci_set_drvdata(pdev, NULL);
595
596         // Unregister from common management module
597         //
598         // FIXME: this must return success or failure for conditions if there
599         // is a command pending with LLD or not.
600         megaraid_cmm_unregister(adapter);
601
602         // finalize the mailbox based controller and release all resources
603         megaraid_fini_mbox(adapter);
604
605         kfree(adapter);
606
607         scsi_host_put(host);
608
609         pci_disable_device(pdev);
610
611         return;
612 }
613
614
615 /**
616  * megaraid_mbox_shutdown - PCI shutdown for megaraid HBA
617  * @pdev                : generic driver model device
618  *
619  * Shutdown notification, perform flush cache.
620  */
621 static void
622 megaraid_mbox_shutdown(struct pci_dev *pdev)
623 {
624         adapter_t               *adapter = pci_get_drvdata(pdev);
625         static int              counter;
626
627         if (!adapter) {
628                 con_log(CL_ANN, (KERN_WARNING
629                         "megaraid: null device in shutdown\n"));
630                 return;
631         }
632
633         // flush caches now
634         con_log(CL_ANN, (KERN_INFO "megaraid: flushing adapter %d...",
635                 counter++));
636
637         megaraid_mbox_flush_cache(adapter);
638
639         con_log(CL_ANN, ("done\n"));
640 }
641
642
643 /**
644  * megaraid_io_attach - attach a device with the IO subsystem
645  * @adapter             : controller's soft state
646  *
647  * Attach this device with the IO subsystem.
648  */
649 static int
650 megaraid_io_attach(adapter_t *adapter)
651 {
652         struct Scsi_Host        *host;
653
654         // Initialize SCSI Host structure
655         host = scsi_host_alloc(&megaraid_template_g, 8);
656         if (!host) {
657                 con_log(CL_ANN, (KERN_WARNING
658                         "megaraid mbox: scsi_register failed\n"));
659
660                 return -1;
661         }
662
663         SCSIHOST2ADAP(host)     = (caddr_t)adapter;
664         adapter->host           = host;
665
666         host->irq               = adapter->irq;
667         host->unique_id         = adapter->unique_id;
668         host->can_queue         = adapter->max_cmds;
669         host->this_id           = adapter->init_id;
670         host->sg_tablesize      = adapter->sglen;
671         host->max_sectors       = adapter->max_sectors;
672         host->cmd_per_lun       = adapter->cmd_per_lun;
673         host->max_channel       = adapter->max_channel;
674         host->max_id            = adapter->max_target;
675         host->max_lun           = adapter->max_lun;
676
677
678         // notify mid-layer about the new controller
679         if (scsi_add_host(host, &adapter->pdev->dev)) {
680
681                 con_log(CL_ANN, (KERN_WARNING
682                         "megaraid mbox: scsi_add_host failed\n"));
683
684                 scsi_host_put(host);
685
686                 return -1;
687         }
688
689         scsi_scan_host(host);
690
691         return 0;
692 }
693
694
695 /**
696  * megaraid_io_detach - detach a device from the IO subsystem
697  * @adapter             : controller's soft state
698  *
699  * Detach this device from the IO subsystem.
700  */
701 static void
702 megaraid_io_detach(adapter_t *adapter)
703 {
704         struct Scsi_Host        *host;
705
706         con_log(CL_DLEVEL1, (KERN_INFO "megaraid: io detach\n"));
707
708         host = adapter->host;
709
710         scsi_remove_host(host);
711
712         return;
713 }
714
715
716 /*
717  * START: Mailbox Low Level Driver
718  *
719  * This is section specific to the single mailbox based controllers
720  */
721
722 /**
723  * megaraid_init_mbox - initialize controller
724  * @adapter             : our soft state
725  *
726  * - Allocate 16-byte aligned mailbox memory for firmware handshake
727  * - Allocate controller's memory resources
728  * - Find out all initialization data
729  * - Allocate memory required for all the commands
730  * - Use internal library of FW routines, build up complete soft state
731  */
732 static int __devinit
733 megaraid_init_mbox(adapter_t *adapter)
734 {
735         struct pci_dev          *pdev;
736         mraid_device_t          *raid_dev;
737         int                     i;
738         uint32_t                magic64;
739
740
741         adapter->ito    = MBOX_TIMEOUT;
742         pdev            = adapter->pdev;
743
744         /*
745          * Allocate and initialize the init data structure for mailbox
746          * controllers
747          */
748         raid_dev = kzalloc(sizeof(mraid_device_t), GFP_KERNEL);
749         if (raid_dev == NULL) return -1;
750
751
752         /*
753          * Attach the adapter soft state to raid device soft state
754          */
755         adapter->raid_device    = (caddr_t)raid_dev;
756         raid_dev->fast_load     = megaraid_fast_load;
757
758
759         // our baseport
760         raid_dev->baseport = pci_resource_start(pdev, 0);
761
762         if (pci_request_regions(pdev, "MegaRAID: LSI Logic Corporation") != 0) {
763
764                 con_log(CL_ANN, (KERN_WARNING
765                                 "megaraid: mem region busy\n"));
766
767                 goto out_free_raid_dev;
768         }
769
770         raid_dev->baseaddr = ioremap_nocache(raid_dev->baseport, 128);
771
772         if (!raid_dev->baseaddr) {
773
774                 con_log(CL_ANN, (KERN_WARNING
775                         "megaraid: could not map hba memory\n") );
776
777                 goto out_release_regions;
778         }
779
780         /* initialize the mutual exclusion lock for the mailbox */
781         spin_lock_init(&raid_dev->mailbox_lock);
782
783         /* allocate memory required for commands */
784         if (megaraid_alloc_cmd_packets(adapter) != 0)
785                 goto out_iounmap;
786
787         /*
788          * Issue SYNC cmd to flush the pending cmds in the adapter
789          * and initialize its internal state
790          */
791
792         if (megaraid_mbox_fire_sync_cmd(adapter))
793                 con_log(CL_ANN, ("megaraid: sync cmd failed\n"));
794
795         /*
796          * Setup the rest of the soft state using the library of
797          * FW routines
798          */
799
800         /* request IRQ and register the interrupt service routine */
801         if (request_irq(adapter->irq, megaraid_isr, IRQF_SHARED, "megaraid",
802                 adapter)) {
803
804                 con_log(CL_ANN, (KERN_WARNING
805                         "megaraid: Couldn't register IRQ %d!\n", adapter->irq));
806                 goto out_alloc_cmds;
807
808         }
809
810         // Product info
811         if (megaraid_mbox_product_info(adapter) != 0)
812                 goto out_free_irq;
813
814         // Do we support extended CDBs
815         adapter->max_cdb_sz = 10;
816         if (megaraid_mbox_extended_cdb(adapter) == 0) {
817                 adapter->max_cdb_sz = 16;
818         }
819
820         /*
821          * Do we support cluster environment, if we do, what is the initiator
822          * id.
823          * NOTE: In a non-cluster aware firmware environment, the LLD should
824          * return 7 as initiator id.
825          */
826         adapter->ha             = 0;
827         adapter->init_id        = -1;
828         if (megaraid_mbox_support_ha(adapter, &adapter->init_id) == 0) {
829                 adapter->ha = 1;
830         }
831
832         /*
833          * Prepare the device ids array to have the mapping between the kernel
834          * device address and megaraid device address.
835          * We export the physical devices on their actual addresses. The
836          * logical drives are exported on a virtual SCSI channel
837          */
838         megaraid_mbox_setup_device_map(adapter);
839
840         // If the firmware supports random deletion, update the device id map
841         if (megaraid_mbox_support_random_del(adapter)) {
842
843                 // Change the logical drives numbers in device_ids array one
844                 // slot in device_ids is reserved for target id, that's why
845                 // "<=" below
846                 for (i = 0; i <= MAX_LOGICAL_DRIVES_40LD; i++) {
847                         adapter->device_ids[adapter->max_channel][i] += 0x80;
848                 }
849                 adapter->device_ids[adapter->max_channel][adapter->init_id] =
850                         0xFF;
851
852                 raid_dev->random_del_supported = 1;
853         }
854
855         /*
856          * find out the maximum number of scatter-gather elements supported by
857          * this firmware
858          */
859         adapter->sglen = megaraid_mbox_get_max_sg(adapter);
860
861         // enumerate RAID and SCSI channels so that all devices on SCSI
862         // channels can later be exported, including disk devices
863         megaraid_mbox_enum_raid_scsi(adapter);
864
865         /*
866          * Other parameters required by upper layer
867          *
868          * maximum number of sectors per IO command
869          */
870         adapter->max_sectors = megaraid_max_sectors;
871
872         /*
873          * number of queued commands per LUN.
874          */
875         adapter->cmd_per_lun = megaraid_cmd_per_lun;
876
877         /*
878          * Allocate resources required to issue FW calls, when sysfs is
879          * accessed
880          */
881         if (megaraid_sysfs_alloc_resources(adapter) != 0)
882                 goto out_free_irq;
883
884         // Set the DMA mask to 64-bit. All supported controllers as capable of
885         // DMA in this range
886         pci_read_config_dword(adapter->pdev, PCI_CONF_AMISIG64, &magic64);
887
888         if (((magic64 == HBA_SIGNATURE_64_BIT) &&
889                 ((adapter->pdev->subsystem_device !=
890                 PCI_SUBSYS_ID_MEGARAID_SATA_150_6) &&
891                 (adapter->pdev->subsystem_device !=
892                 PCI_SUBSYS_ID_MEGARAID_SATA_150_4))) ||
893                 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
894                 adapter->pdev->device == PCI_DEVICE_ID_VERDE) ||
895                 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
896                 adapter->pdev->device == PCI_DEVICE_ID_DOBSON) ||
897                 (adapter->pdev->vendor == PCI_VENDOR_ID_LSI_LOGIC &&
898                 adapter->pdev->device == PCI_DEVICE_ID_LINDSAY) ||
899                 (adapter->pdev->vendor == PCI_VENDOR_ID_DELL &&
900                 adapter->pdev->device == PCI_DEVICE_ID_PERC4_DI_EVERGLADES) ||
901                 (adapter->pdev->vendor == PCI_VENDOR_ID_DELL &&
902                 adapter->pdev->device == PCI_DEVICE_ID_PERC4E_DI_KOBUK)) {
903                 if (pci_set_dma_mask(adapter->pdev, DMA_64BIT_MASK)) {
904                         con_log(CL_ANN, (KERN_WARNING
905                                 "megaraid: DMA mask for 64-bit failed\n"));
906
907                         if (pci_set_dma_mask (adapter->pdev, DMA_32BIT_MASK)) {
908                                 con_log(CL_ANN, (KERN_WARNING
909                                         "megaraid: 32-bit DMA mask failed\n"));
910                                 goto out_free_sysfs_res;
911                         }
912                 }
913         }
914
915         // setup tasklet for DPC
916         tasklet_init(&adapter->dpc_h, megaraid_mbox_dpc,
917                         (unsigned long)adapter);
918
919         con_log(CL_DLEVEL1, (KERN_INFO
920                 "megaraid mbox hba successfully initialized\n"));
921
922         return 0;
923
924 out_free_sysfs_res:
925         megaraid_sysfs_free_resources(adapter);
926 out_free_irq:
927         free_irq(adapter->irq, adapter);
928 out_alloc_cmds:
929         megaraid_free_cmd_packets(adapter);
930 out_iounmap:
931         iounmap(raid_dev->baseaddr);
932 out_release_regions:
933         pci_release_regions(pdev);
934 out_free_raid_dev:
935         kfree(raid_dev);
936
937         return -1;
938 }
939
940
941 /**
942  * megaraid_fini_mbox - undo controller initialization
943  * @adapter             : our soft state
944  */
945 static void
946 megaraid_fini_mbox(adapter_t *adapter)
947 {
948         mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
949
950         // flush all caches
951         megaraid_mbox_flush_cache(adapter);
952
953         tasklet_kill(&adapter->dpc_h);
954
955         megaraid_sysfs_free_resources(adapter);
956
957         megaraid_free_cmd_packets(adapter);
958
959         free_irq(adapter->irq, adapter);
960
961         iounmap(raid_dev->baseaddr);
962
963         pci_release_regions(adapter->pdev);
964
965         kfree(raid_dev);
966
967         return;
968 }
969
970
971 /**
972  * megaraid_alloc_cmd_packets - allocate shared mailbox
973  * @adapter             : soft state of the raid controller
974  *
975  * Allocate and align the shared mailbox. This maibox is used to issue
976  * all the commands. For IO based controllers, the mailbox is also regsitered
977  * with the FW. Allocate memory for all commands as well.
978  * This is our big allocator.
979  */
980 static int
981 megaraid_alloc_cmd_packets(adapter_t *adapter)
982 {
983         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
984         struct pci_dev          *pdev;
985         unsigned long           align;
986         scb_t                   *scb;
987         mbox_ccb_t              *ccb;
988         struct mraid_pci_blk    *epthru_pci_blk;
989         struct mraid_pci_blk    *sg_pci_blk;
990         struct mraid_pci_blk    *mbox_pci_blk;
991         int                     i;
992
993         pdev = adapter->pdev;
994
995         /*
996          * Setup the mailbox
997          * Allocate the common 16-byte aligned memory for the handshake
998          * mailbox.
999          */
1000         raid_dev->una_mbox64 = pci_alloc_consistent(adapter->pdev,
1001                         sizeof(mbox64_t), &raid_dev->una_mbox64_dma);
1002
1003         if (!raid_dev->una_mbox64) {
1004                 con_log(CL_ANN, (KERN_WARNING
1005                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
1006                         __LINE__));
1007                 return -1;
1008         }
1009         memset(raid_dev->una_mbox64, 0, sizeof(mbox64_t));
1010
1011         /*
1012          * Align the mailbox at 16-byte boundary
1013          */
1014         raid_dev->mbox  = &raid_dev->una_mbox64->mbox32;
1015
1016         raid_dev->mbox  = (mbox_t *)((((unsigned long)raid_dev->mbox) + 15) &
1017                                 (~0UL ^ 0xFUL));
1018
1019         raid_dev->mbox64 = (mbox64_t *)(((unsigned long)raid_dev->mbox) - 8);
1020
1021         align = ((void *)raid_dev->mbox -
1022                         ((void *)&raid_dev->una_mbox64->mbox32));
1023
1024         raid_dev->mbox_dma = (unsigned long)raid_dev->una_mbox64_dma + 8 +
1025                         align;
1026
1027         // Allocate memory for commands issued internally
1028         adapter->ibuf = pci_alloc_consistent(pdev, MBOX_IBUF_SIZE,
1029                                 &adapter->ibuf_dma_h);
1030         if (!adapter->ibuf) {
1031
1032                 con_log(CL_ANN, (KERN_WARNING
1033                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
1034                         __LINE__));
1035
1036                 goto out_free_common_mbox;
1037         }
1038         memset(adapter->ibuf, 0, MBOX_IBUF_SIZE);
1039
1040         // Allocate memory for our SCSI Command Blocks and their associated
1041         // memory
1042
1043         /*
1044          * Allocate memory for the base list of scb. Later allocate memory for
1045          * CCBs and embedded components of each CCB and point the pointers in
1046          * scb to the allocated components
1047          * NOTE: The code to allocate SCB will be duplicated in all the LLD
1048          * since the calling routine does not yet know the number of available
1049          * commands.
1050          */
1051         adapter->kscb_list = kcalloc(MBOX_MAX_SCSI_CMDS, sizeof(scb_t), GFP_KERNEL);
1052
1053         if (adapter->kscb_list == NULL) {
1054                 con_log(CL_ANN, (KERN_WARNING
1055                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
1056                         __LINE__));
1057                 goto out_free_ibuf;
1058         }
1059
1060         // memory allocation for our command packets
1061         if (megaraid_mbox_setup_dma_pools(adapter) != 0) {
1062                 con_log(CL_ANN, (KERN_WARNING
1063                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
1064                         __LINE__));
1065                 goto out_free_scb_list;
1066         }
1067
1068         // Adjust the scb pointers and link in the free pool
1069         epthru_pci_blk  = raid_dev->epthru_pool;
1070         sg_pci_blk      = raid_dev->sg_pool;
1071         mbox_pci_blk    = raid_dev->mbox_pool;
1072
1073         for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1074                 scb                     = adapter->kscb_list + i;
1075                 ccb                     = raid_dev->ccb_list + i;
1076
1077                 ccb->mbox       = (mbox_t *)(mbox_pci_blk[i].vaddr + 16);
1078                 ccb->raw_mbox   = (uint8_t *)ccb->mbox;
1079                 ccb->mbox64     = (mbox64_t *)(mbox_pci_blk[i].vaddr + 8);
1080                 ccb->mbox_dma_h = (unsigned long)mbox_pci_blk[i].dma_addr + 16;
1081
1082                 // make sure the mailbox is aligned properly
1083                 if (ccb->mbox_dma_h & 0x0F) {
1084                         con_log(CL_ANN, (KERN_CRIT
1085                                 "megaraid mbox: not aligned on 16-bytes\n"));
1086
1087                         goto out_teardown_dma_pools;
1088                 }
1089
1090                 ccb->epthru             = (mraid_epassthru_t *)
1091                                                 epthru_pci_blk[i].vaddr;
1092                 ccb->epthru_dma_h       = epthru_pci_blk[i].dma_addr;
1093                 ccb->pthru              = (mraid_passthru_t *)ccb->epthru;
1094                 ccb->pthru_dma_h        = ccb->epthru_dma_h;
1095
1096
1097                 ccb->sgl64              = (mbox_sgl64 *)sg_pci_blk[i].vaddr;
1098                 ccb->sgl_dma_h          = sg_pci_blk[i].dma_addr;
1099                 ccb->sgl32              = (mbox_sgl32 *)ccb->sgl64;
1100
1101                 scb->ccb                = (caddr_t)ccb;
1102                 scb->gp                 = 0;
1103
1104                 scb->sno                = i;    // command index
1105
1106                 scb->scp                = NULL;
1107                 scb->state              = SCB_FREE;
1108                 scb->dma_direction      = PCI_DMA_NONE;
1109                 scb->dma_type           = MRAID_DMA_NONE;
1110                 scb->dev_channel        = -1;
1111                 scb->dev_target         = -1;
1112
1113                 // put scb in the free pool
1114                 list_add_tail(&scb->list, &adapter->kscb_pool);
1115         }
1116
1117         return 0;
1118
1119 out_teardown_dma_pools:
1120         megaraid_mbox_teardown_dma_pools(adapter);
1121 out_free_scb_list:
1122         kfree(adapter->kscb_list);
1123 out_free_ibuf:
1124         pci_free_consistent(pdev, MBOX_IBUF_SIZE, (void *)adapter->ibuf,
1125                 adapter->ibuf_dma_h);
1126 out_free_common_mbox:
1127         pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1128                 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1129
1130         return -1;
1131 }
1132
1133
1134 /**
1135  * megaraid_free_cmd_packets - free memory
1136  * @adapter             : soft state of the raid controller
1137  *
1138  * Release memory resources allocated for commands.
1139  */
1140 static void
1141 megaraid_free_cmd_packets(adapter_t *adapter)
1142 {
1143         mraid_device_t *raid_dev = ADAP2RAIDDEV(adapter);
1144
1145         megaraid_mbox_teardown_dma_pools(adapter);
1146
1147         kfree(adapter->kscb_list);
1148
1149         pci_free_consistent(adapter->pdev, MBOX_IBUF_SIZE,
1150                 (void *)adapter->ibuf, adapter->ibuf_dma_h);
1151
1152         pci_free_consistent(adapter->pdev, sizeof(mbox64_t),
1153                 (caddr_t)raid_dev->una_mbox64, raid_dev->una_mbox64_dma);
1154         return;
1155 }
1156
1157
1158 /**
1159  * megaraid_mbox_setup_dma_pools - setup dma pool for command packets
1160  * @adapter             : HBA soft state
1161  *
1162  * Setup the dma pools for mailbox, passthru and extended passthru structures,
1163  * and scatter-gather lists.
1164  */
1165 static int
1166 megaraid_mbox_setup_dma_pools(adapter_t *adapter)
1167 {
1168         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
1169         struct mraid_pci_blk    *epthru_pci_blk;
1170         struct mraid_pci_blk    *sg_pci_blk;
1171         struct mraid_pci_blk    *mbox_pci_blk;
1172         int                     i;
1173
1174
1175
1176         // Allocate memory for 16-bytes aligned mailboxes
1177         raid_dev->mbox_pool_handle = pci_pool_create("megaraid mbox pool",
1178                                                 adapter->pdev,
1179                                                 sizeof(mbox64_t) + 16,
1180                                                 16, 0);
1181
1182         if (raid_dev->mbox_pool_handle == NULL) {
1183                 goto fail_setup_dma_pool;
1184         }
1185
1186         mbox_pci_blk = raid_dev->mbox_pool;
1187         for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1188                 mbox_pci_blk[i].vaddr = pci_pool_alloc(
1189                                                 raid_dev->mbox_pool_handle,
1190                                                 GFP_KERNEL,
1191                                                 &mbox_pci_blk[i].dma_addr);
1192                 if (!mbox_pci_blk[i].vaddr) {
1193                         goto fail_setup_dma_pool;
1194                 }
1195         }
1196
1197         /*
1198          * Allocate memory for each embedded passthru strucuture pointer
1199          * Request for a 128 bytes aligned structure for each passthru command
1200          * structure
1201          * Since passthru and extended passthru commands are exclusive, they
1202          * share common memory pool. Passthru structures piggyback on memory
1203          * allocted to extended passthru since passthru is smaller of the two
1204          */
1205         raid_dev->epthru_pool_handle = pci_pool_create("megaraid mbox pthru",
1206                         adapter->pdev, sizeof(mraid_epassthru_t), 128, 0);
1207
1208         if (raid_dev->epthru_pool_handle == NULL) {
1209                 goto fail_setup_dma_pool;
1210         }
1211
1212         epthru_pci_blk = raid_dev->epthru_pool;
1213         for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1214                 epthru_pci_blk[i].vaddr = pci_pool_alloc(
1215                                                 raid_dev->epthru_pool_handle,
1216                                                 GFP_KERNEL,
1217                                                 &epthru_pci_blk[i].dma_addr);
1218                 if (!epthru_pci_blk[i].vaddr) {
1219                         goto fail_setup_dma_pool;
1220                 }
1221         }
1222
1223
1224         // Allocate memory for each scatter-gather list. Request for 512 bytes
1225         // alignment for each sg list
1226         raid_dev->sg_pool_handle = pci_pool_create("megaraid mbox sg",
1227                                         adapter->pdev,
1228                                         sizeof(mbox_sgl64) * MBOX_MAX_SG_SIZE,
1229                                         512, 0);
1230
1231         if (raid_dev->sg_pool_handle == NULL) {
1232                 goto fail_setup_dma_pool;
1233         }
1234
1235         sg_pci_blk = raid_dev->sg_pool;
1236         for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
1237                 sg_pci_blk[i].vaddr = pci_pool_alloc(
1238                                                 raid_dev->sg_pool_handle,
1239                                                 GFP_KERNEL,
1240                                                 &sg_pci_blk[i].dma_addr);
1241                 if (!sg_pci_blk[i].vaddr) {
1242                         goto fail_setup_dma_pool;
1243                 }
1244         }
1245
1246         return 0;
1247
1248 fail_setup_dma_pool:
1249         megaraid_mbox_teardown_dma_pools(adapter);
1250         return -1;
1251 }
1252
1253
1254 /**
1255  * megaraid_mbox_teardown_dma_pools - teardown dma pools for command packets
1256  * @adapter             : HBA soft state
1257  *
1258  * Teardown the dma pool for mailbox, passthru and extended passthru
1259  * structures, and scatter-gather lists.
1260  */
1261 static void
1262 megaraid_mbox_teardown_dma_pools(adapter_t *adapter)
1263 {
1264         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
1265         struct mraid_pci_blk    *epthru_pci_blk;
1266         struct mraid_pci_blk    *sg_pci_blk;
1267         struct mraid_pci_blk    *mbox_pci_blk;
1268         int                     i;
1269
1270
1271         sg_pci_blk = raid_dev->sg_pool;
1272         for (i = 0; i < MBOX_MAX_SCSI_CMDS && sg_pci_blk[i].vaddr; i++) {
1273                 pci_pool_free(raid_dev->sg_pool_handle, sg_pci_blk[i].vaddr,
1274                         sg_pci_blk[i].dma_addr);
1275         }
1276         if (raid_dev->sg_pool_handle)
1277                 pci_pool_destroy(raid_dev->sg_pool_handle);
1278
1279
1280         epthru_pci_blk = raid_dev->epthru_pool;
1281         for (i = 0; i < MBOX_MAX_SCSI_CMDS && epthru_pci_blk[i].vaddr; i++) {
1282                 pci_pool_free(raid_dev->epthru_pool_handle,
1283                         epthru_pci_blk[i].vaddr, epthru_pci_blk[i].dma_addr);
1284         }
1285         if (raid_dev->epthru_pool_handle)
1286                 pci_pool_destroy(raid_dev->epthru_pool_handle);
1287
1288
1289         mbox_pci_blk = raid_dev->mbox_pool;
1290         for (i = 0; i < MBOX_MAX_SCSI_CMDS && mbox_pci_blk[i].vaddr; i++) {
1291                 pci_pool_free(raid_dev->mbox_pool_handle,
1292                         mbox_pci_blk[i].vaddr, mbox_pci_blk[i].dma_addr);
1293         }
1294         if (raid_dev->mbox_pool_handle)
1295                 pci_pool_destroy(raid_dev->mbox_pool_handle);
1296
1297         return;
1298 }
1299
1300
1301 /**
1302  * megaraid_alloc_scb - detach and return a scb from the free list
1303  * @adapter     : controller's soft state
1304  * @scp         : pointer to the scsi command to be executed
1305  *
1306  * Return the scb from the head of the free list. %NULL if there are none
1307  * available.
1308  */
1309 static scb_t *
1310 megaraid_alloc_scb(adapter_t *adapter, struct scsi_cmnd *scp)
1311 {
1312         struct list_head        *head = &adapter->kscb_pool;
1313         scb_t                   *scb = NULL;
1314         unsigned long           flags;
1315
1316         // detach scb from free pool
1317         spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1318
1319         if (list_empty(head)) {
1320                 spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1321                 return NULL;
1322         }
1323
1324         scb = list_entry(head->next, scb_t, list);
1325         list_del_init(&scb->list);
1326
1327         spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1328
1329         scb->state      = SCB_ACTIVE;
1330         scb->scp        = scp;
1331         scb->dma_type   = MRAID_DMA_NONE;
1332
1333         return scb;
1334 }
1335
1336
1337 /**
1338  * megaraid_dealloc_scb - return the scb to the free pool
1339  * @adapter     : controller's soft state
1340  * @scb         : scb to be freed
1341  *
1342  * Return the scb back to the free list of scbs. The caller must 'flush' the
1343  * SCB before calling us. E.g., performing pci_unamp and/or pci_sync etc.
1344  * NOTE NOTE: Make sure the scb is not on any list before calling this
1345  * routine.
1346  */
1347 static inline void
1348 megaraid_dealloc_scb(adapter_t *adapter, scb_t *scb)
1349 {
1350         unsigned long           flags;
1351
1352         // put scb in the free pool
1353         scb->state      = SCB_FREE;
1354         scb->scp        = NULL;
1355         spin_lock_irqsave(SCSI_FREE_LIST_LOCK(adapter), flags);
1356
1357         list_add(&scb->list, &adapter->kscb_pool);
1358
1359         spin_unlock_irqrestore(SCSI_FREE_LIST_LOCK(adapter), flags);
1360
1361         return;
1362 }
1363
1364
1365 /**
1366  * megaraid_mbox_mksgl - make the scatter-gather list
1367  * @adapter     : controller's soft state
1368  * @scb         : scsi control block
1369  *
1370  * Prepare the scatter-gather list.
1371  */
1372 static int
1373 megaraid_mbox_mksgl(adapter_t *adapter, scb_t *scb)
1374 {
1375         struct scatterlist      *sgl;
1376         mbox_ccb_t              *ccb;
1377         struct scsi_cmnd        *scp;
1378         int                     sgcnt;
1379         int                     i;
1380
1381
1382         scp     = scb->scp;
1383         ccb     = (mbox_ccb_t *)scb->ccb;
1384
1385         sgcnt = scsi_dma_map(scp);
1386         BUG_ON(sgcnt < 0 || sgcnt > adapter->sglen);
1387
1388         // no mapping required if no data to be transferred
1389         if (!sgcnt)
1390                 return 0;
1391
1392         scb->dma_type = MRAID_DMA_WSG;
1393
1394         scsi_for_each_sg(scp, sgl, sgcnt, i) {
1395                 ccb->sgl64[i].address   = sg_dma_address(sgl);
1396                 ccb->sgl64[i].length    = sg_dma_len(sgl);
1397         }
1398
1399         // Return count of SG nodes
1400         return sgcnt;
1401 }
1402
1403
1404 /**
1405  * mbox_post_cmd - issue a mailbox command
1406  * @adapter     : controller's soft state
1407  * @scb         : command to be issued
1408  *
1409  * Post the command to the controller if mailbox is available.
1410  */
1411 static int
1412 mbox_post_cmd(adapter_t *adapter, scb_t *scb)
1413 {
1414         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
1415         mbox64_t        *mbox64;
1416         mbox_t          *mbox;
1417         mbox_ccb_t      *ccb;
1418         unsigned long   flags;
1419         unsigned int    i = 0;
1420
1421
1422         ccb     = (mbox_ccb_t *)scb->ccb;
1423         mbox    = raid_dev->mbox;
1424         mbox64  = raid_dev->mbox64;
1425
1426         /*
1427          * Check for busy mailbox. If it is, return failure - the caller
1428          * should retry later.
1429          */
1430         spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
1431
1432         if (unlikely(mbox->busy)) {
1433                 do {
1434                         udelay(1);
1435                         i++;
1436                         rmb();
1437                 } while(mbox->busy && (i < max_mbox_busy_wait));
1438
1439                 if (mbox->busy) {
1440
1441                         spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1442
1443                         return -1;
1444                 }
1445         }
1446
1447
1448         // Copy this command's mailbox data into "adapter's" mailbox
1449         memcpy((caddr_t)mbox64, (caddr_t)ccb->mbox64, 22);
1450         mbox->cmdid = scb->sno;
1451
1452         adapter->outstanding_cmds++;
1453
1454         if (scb->dma_direction == PCI_DMA_TODEVICE)
1455                 pci_dma_sync_sg_for_device(adapter->pdev,
1456                                            scsi_sglist(scb->scp),
1457                                            scsi_sg_count(scb->scp),
1458                                            PCI_DMA_TODEVICE);
1459
1460         mbox->busy      = 1;    // Set busy
1461         mbox->poll      = 0;
1462         mbox->ack       = 0;
1463         wmb();
1464
1465         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
1466
1467         spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
1468
1469         return 0;
1470 }
1471
1472
1473 /**
1474  * megaraid_queue_command - generic queue entry point for all LLDs
1475  * @scp         : pointer to the scsi command to be executed
1476  * @done        : callback routine to be called after the cmd has be completed
1477  *
1478  * Queue entry point for mailbox based controllers.
1479  */
1480 static int
1481 megaraid_queue_command(struct scsi_cmnd *scp, void (*done)(struct scsi_cmnd *))
1482 {
1483         adapter_t       *adapter;
1484         scb_t           *scb;
1485         int             if_busy;
1486
1487         adapter         = SCP2ADAPTER(scp);
1488         scp->scsi_done  = done;
1489         scp->result     = 0;
1490
1491         /*
1492          * Allocate and build a SCB request
1493          * if_busy flag will be set if megaraid_mbox_build_cmd() command could
1494          * not allocate scb. We will return non-zero status in that case.
1495          * NOTE: scb can be null even though certain commands completed
1496          * successfully, e.g., MODE_SENSE and TEST_UNIT_READY, it would
1497          * return 0 in that case, and we would do the callback right away.
1498          */
1499         if_busy = 0;
1500         scb = megaraid_mbox_build_cmd(adapter, scp, &if_busy);
1501         if (!scb) {     // command already completed
1502                 done(scp);
1503                 return 0;
1504         }
1505
1506         megaraid_mbox_runpendq(adapter, scb);
1507         return if_busy;
1508 }
1509
1510 /**
1511  * megaraid_mbox_build_cmd - transform the mid-layer scsi commands
1512  * @adapter     : controller's soft state
1513  * @scp         : mid-layer scsi command pointer
1514  * @busy        : set if request could not be completed because of lack of
1515  *              resources
1516  *
1517  * Transform the mid-layer scsi command to megaraid firmware lingua.
1518  * Convert the command issued by mid-layer to format understood by megaraid
1519  * firmware. We also complete certain commands without sending them to firmware.
1520  */
1521 static scb_t *
1522 megaraid_mbox_build_cmd(adapter_t *adapter, struct scsi_cmnd *scp, int *busy)
1523 {
1524         mraid_device_t          *rdev = ADAP2RAIDDEV(adapter);
1525         int                     channel;
1526         int                     target;
1527         int                     islogical;
1528         mbox_ccb_t              *ccb;
1529         mraid_passthru_t        *pthru;
1530         mbox64_t                *mbox64;
1531         mbox_t                  *mbox;
1532         scb_t                   *scb;
1533         char                    skip[] = "skipping";
1534         char                    scan[] = "scanning";
1535         char                    *ss;
1536
1537
1538         /*
1539          * Get the appropriate device map for the device this command is
1540          * intended for
1541          */
1542         MRAID_GET_DEVICE_MAP(adapter, scp, channel, target, islogical);
1543
1544         /*
1545          * Logical drive commands
1546          */
1547         if (islogical) {
1548                 switch (scp->cmnd[0]) {
1549                 case TEST_UNIT_READY:
1550                         /*
1551                          * Do we support clustering and is the support enabled
1552                          * If no, return success always
1553                          */
1554                         if (!adapter->ha) {
1555                                 scp->result = (DID_OK << 16);
1556                                 return NULL;
1557                         }
1558
1559                         if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1560                                 scp->result = (DID_ERROR << 16);
1561                                 *busy = 1;
1562                                 return NULL;
1563                         }
1564
1565                         scb->dma_direction      = scp->sc_data_direction;
1566                         scb->dev_channel        = 0xFF;
1567                         scb->dev_target         = target;
1568                         ccb                     = (mbox_ccb_t *)scb->ccb;
1569
1570                         /*
1571                          * The command id will be provided by the command
1572                          * issuance routine
1573                          */
1574                         ccb->raw_mbox[0]        = CLUSTER_CMD;
1575                         ccb->raw_mbox[2]        = RESERVATION_STATUS;
1576                         ccb->raw_mbox[3]        = target;
1577
1578                         return scb;
1579
1580                 case MODE_SENSE:
1581                 {
1582                         struct scatterlist      *sgl;
1583                         caddr_t                 vaddr;
1584
1585                         sgl = scsi_sglist(scp);
1586                         if (sgl->page) {
1587                                 vaddr = (caddr_t)
1588                                         (page_address((&sgl[0])->page)
1589                                          + (&sgl[0])->offset);
1590
1591                                 memset(vaddr, 0, scp->cmnd[4]);
1592                         }
1593                         else {
1594                                 con_log(CL_ANN, (KERN_WARNING
1595                                                  "megaraid mailbox: invalid sg:%d\n",
1596                                                  __LINE__));
1597                         }
1598                 }
1599                 scp->result = (DID_OK << 16);
1600                 return NULL;
1601
1602                 case INQUIRY:
1603                         /*
1604                          * Display the channel scan for logical drives
1605                          * Do not display scan for a channel if already done.
1606                          */
1607                         if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1608
1609                                 con_log(CL_ANN, (KERN_INFO
1610                                         "scsi[%d]: scanning scsi channel %d",
1611                                         adapter->host->host_no,
1612                                         SCP2CHANNEL(scp)));
1613
1614                                 con_log(CL_ANN, (
1615                                         " [virtual] for logical drives\n"));
1616
1617                                 rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1618                         }
1619
1620                         if (scp->cmnd[1] & MEGA_SCSI_INQ_EVPD) {
1621                                 scp->sense_buffer[0] = 0x70;
1622                                 scp->sense_buffer[2] = ILLEGAL_REQUEST;
1623                                 scp->sense_buffer[12] = MEGA_INVALID_FIELD_IN_CDB;
1624                                 scp->result = CHECK_CONDITION << 1;
1625                                 return NULL;
1626                         }
1627
1628                         /* Fall through */
1629
1630                 case READ_CAPACITY:
1631                         /*
1632                          * Do not allow LUN > 0 for logical drives and
1633                          * requests for more than 40 logical drives
1634                          */
1635                         if (SCP2LUN(scp)) {
1636                                 scp->result = (DID_BAD_TARGET << 16);
1637                                 return NULL;
1638                         }
1639                         if ((target % 0x80) >= MAX_LOGICAL_DRIVES_40LD) {
1640                                 scp->result = (DID_BAD_TARGET << 16);
1641                                 return NULL;
1642                         }
1643
1644
1645                         /* Allocate a SCB and initialize passthru */
1646                         if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1647                                 scp->result = (DID_ERROR << 16);
1648                                 *busy = 1;
1649                                 return NULL;
1650                         }
1651
1652                         ccb                     = (mbox_ccb_t *)scb->ccb;
1653                         scb->dev_channel        = 0xFF;
1654                         scb->dev_target         = target;
1655                         pthru                   = ccb->pthru;
1656                         mbox                    = ccb->mbox;
1657                         mbox64                  = ccb->mbox64;
1658
1659                         pthru->timeout          = 0;
1660                         pthru->ars              = 1;
1661                         pthru->reqsenselen      = 14;
1662                         pthru->islogical        = 1;
1663                         pthru->logdrv           = target;
1664                         pthru->cdblen           = scp->cmd_len;
1665                         memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
1666
1667                         mbox->cmd               = MBOXCMD_PASSTHRU64;
1668                         scb->dma_direction      = scp->sc_data_direction;
1669
1670                         pthru->dataxferlen      = scsi_bufflen(scp);
1671                         pthru->dataxferaddr     = ccb->sgl_dma_h;
1672                         pthru->numsge           = megaraid_mbox_mksgl(adapter,
1673                                                         scb);
1674
1675                         mbox->xferaddr          = 0xFFFFFFFF;
1676                         mbox64->xferaddr_lo     = (uint32_t )ccb->pthru_dma_h;
1677                         mbox64->xferaddr_hi     = 0;
1678
1679                         return scb;
1680
1681                 case READ_6:
1682                 case WRITE_6:
1683                 case READ_10:
1684                 case WRITE_10:
1685                 case READ_12:
1686                 case WRITE_12:
1687
1688                         /*
1689                          * Allocate a SCB and initialize mailbox
1690                          */
1691                         if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1692                                 scp->result = (DID_ERROR << 16);
1693                                 *busy = 1;
1694                                 return NULL;
1695                         }
1696                         ccb                     = (mbox_ccb_t *)scb->ccb;
1697                         scb->dev_channel        = 0xFF;
1698                         scb->dev_target         = target;
1699                         mbox                    = ccb->mbox;
1700                         mbox64                  = ccb->mbox64;
1701                         mbox->logdrv            = target;
1702
1703                         /*
1704                          * A little HACK: 2nd bit is zero for all scsi read
1705                          * commands and is set for all scsi write commands
1706                          */
1707                         mbox->cmd = (scp->cmnd[0] & 0x02) ?  MBOXCMD_LWRITE64:
1708                                         MBOXCMD_LREAD64 ;
1709
1710                         /*
1711                          * 6-byte READ(0x08) or WRITE(0x0A) cdb
1712                          */
1713                         if (scp->cmd_len == 6) {
1714                                 mbox->numsectors = (uint32_t)scp->cmnd[4];
1715                                 mbox->lba =
1716                                         ((uint32_t)scp->cmnd[1] << 16)  |
1717                                         ((uint32_t)scp->cmnd[2] << 8)   |
1718                                         (uint32_t)scp->cmnd[3];
1719
1720                                 mbox->lba &= 0x1FFFFF;
1721                         }
1722
1723                         /*
1724                          * 10-byte READ(0x28) or WRITE(0x2A) cdb
1725                          */
1726                         else if (scp->cmd_len == 10) {
1727                                 mbox->numsectors =
1728                                         (uint32_t)scp->cmnd[8] |
1729                                         ((uint32_t)scp->cmnd[7] << 8);
1730                                 mbox->lba =
1731                                         ((uint32_t)scp->cmnd[2] << 24) |
1732                                         ((uint32_t)scp->cmnd[3] << 16) |
1733                                         ((uint32_t)scp->cmnd[4] << 8) |
1734                                         (uint32_t)scp->cmnd[5];
1735                         }
1736
1737                         /*
1738                          * 12-byte READ(0xA8) or WRITE(0xAA) cdb
1739                          */
1740                         else if (scp->cmd_len == 12) {
1741                                 mbox->lba =
1742                                         ((uint32_t)scp->cmnd[2] << 24) |
1743                                         ((uint32_t)scp->cmnd[3] << 16) |
1744                                         ((uint32_t)scp->cmnd[4] << 8) |
1745                                         (uint32_t)scp->cmnd[5];
1746
1747                                 mbox->numsectors =
1748                                         ((uint32_t)scp->cmnd[6] << 24) |
1749                                         ((uint32_t)scp->cmnd[7] << 16) |
1750                                         ((uint32_t)scp->cmnd[8] << 8) |
1751                                         (uint32_t)scp->cmnd[9];
1752                         }
1753                         else {
1754                                 con_log(CL_ANN, (KERN_WARNING
1755                                         "megaraid: unsupported CDB length\n"));
1756
1757                                 megaraid_dealloc_scb(adapter, scb);
1758
1759                                 scp->result = (DID_ERROR << 16);
1760                                 return NULL;
1761                         }
1762
1763                         scb->dma_direction = scp->sc_data_direction;
1764
1765                         // Calculate Scatter-Gather info
1766                         mbox64->xferaddr_lo     = (uint32_t )ccb->sgl_dma_h;
1767                         mbox->numsge            = megaraid_mbox_mksgl(adapter,
1768                                                         scb);
1769                         mbox->xferaddr          = 0xFFFFFFFF;
1770                         mbox64->xferaddr_hi     = 0;
1771
1772                         return scb;
1773
1774                 case RESERVE:
1775                 case RELEASE:
1776                         /*
1777                          * Do we support clustering and is the support enabled
1778                          */
1779                         if (!adapter->ha) {
1780                                 scp->result = (DID_BAD_TARGET << 16);
1781                                 return NULL;
1782                         }
1783
1784                         /*
1785                          * Allocate a SCB and initialize mailbox
1786                          */
1787                         if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1788                                 scp->result = (DID_ERROR << 16);
1789                                 *busy = 1;
1790                                 return NULL;
1791                         }
1792
1793                         ccb                     = (mbox_ccb_t *)scb->ccb;
1794                         scb->dev_channel        = 0xFF;
1795                         scb->dev_target         = target;
1796                         ccb->raw_mbox[0]        = CLUSTER_CMD;
1797                         ccb->raw_mbox[2]        =  (scp->cmnd[0] == RESERVE) ?
1798                                                 RESERVE_LD : RELEASE_LD;
1799
1800                         ccb->raw_mbox[3]        = target;
1801                         scb->dma_direction      = scp->sc_data_direction;
1802
1803                         return scb;
1804
1805                 default:
1806                         scp->result = (DID_BAD_TARGET << 16);
1807                         return NULL;
1808                 }
1809         }
1810         else { // Passthru device commands
1811
1812                 // Do not allow access to target id > 15 or LUN > 7
1813                 if (target > 15 || SCP2LUN(scp) > 7) {
1814                         scp->result = (DID_BAD_TARGET << 16);
1815                         return NULL;
1816                 }
1817
1818                 // if fast load option was set and scan for last device is
1819                 // over, reset the fast_load flag so that during a possible
1820                 // next scan, devices can be made available
1821                 if (rdev->fast_load && (target == 15) &&
1822                         (SCP2CHANNEL(scp) == adapter->max_channel -1)) {
1823
1824                         con_log(CL_ANN, (KERN_INFO
1825                         "megaraid[%d]: physical device scan re-enabled\n",
1826                                 adapter->host->host_no));
1827                         rdev->fast_load = 0;
1828                 }
1829
1830                 /*
1831                  * Display the channel scan for physical devices
1832                  */
1833                 if (!(rdev->last_disp & (1L << SCP2CHANNEL(scp)))) {
1834
1835                         ss = rdev->fast_load ? skip : scan;
1836
1837                         con_log(CL_ANN, (KERN_INFO
1838                                 "scsi[%d]: %s scsi channel %d [Phy %d]",
1839                                 adapter->host->host_no, ss, SCP2CHANNEL(scp),
1840                                 channel));
1841
1842                         con_log(CL_ANN, (
1843                                 " for non-raid devices\n"));
1844
1845                         rdev->last_disp |= (1L << SCP2CHANNEL(scp));
1846                 }
1847
1848                 // disable channel sweep if fast load option given
1849                 if (rdev->fast_load) {
1850                         scp->result = (DID_BAD_TARGET << 16);
1851                         return NULL;
1852                 }
1853
1854                 // Allocate a SCB and initialize passthru
1855                 if (!(scb = megaraid_alloc_scb(adapter, scp))) {
1856                         scp->result = (DID_ERROR << 16);
1857                         *busy = 1;
1858                         return NULL;
1859                 }
1860
1861                 ccb                     = (mbox_ccb_t *)scb->ccb;
1862                 scb->dev_channel        = channel;
1863                 scb->dev_target         = target;
1864                 scb->dma_direction      = scp->sc_data_direction;
1865                 mbox                    = ccb->mbox;
1866                 mbox64                  = ccb->mbox64;
1867
1868                 // Does this firmware support extended CDBs
1869                 if (adapter->max_cdb_sz == 16) {
1870                         mbox->cmd               = MBOXCMD_EXTPTHRU;
1871
1872                         megaraid_mbox_prepare_epthru(adapter, scb, scp);
1873
1874                         mbox64->xferaddr_lo     = (uint32_t)ccb->epthru_dma_h;
1875                         mbox64->xferaddr_hi     = 0;
1876                         mbox->xferaddr          = 0xFFFFFFFF;
1877                 }
1878                 else {
1879                         mbox->cmd = MBOXCMD_PASSTHRU64;
1880
1881                         megaraid_mbox_prepare_pthru(adapter, scb, scp);
1882
1883                         mbox64->xferaddr_lo     = (uint32_t)ccb->pthru_dma_h;
1884                         mbox64->xferaddr_hi     = 0;
1885                         mbox->xferaddr          = 0xFFFFFFFF;
1886                 }
1887                 return scb;
1888         }
1889
1890         // NOT REACHED
1891 }
1892
1893
1894 /**
1895  * megaraid_mbox_runpendq - execute commands queued in the pending queue
1896  * @adapter     : controller's soft state
1897  * @scb_q       : SCB to be queued in the pending list
1898  *
1899  * Scan the pending list for commands which are not yet issued and try to
1900  * post to the controller. The SCB can be a null pointer, which would indicate
1901  * no SCB to be queue, just try to execute the ones in the pending list.
1902  *
1903  * NOTE: We do not actually traverse the pending list. The SCBs are plucked
1904  * out from the head of the pending list. If it is successfully issued, the
1905  * next SCB is at the head now.
1906  */
1907 static void
1908 megaraid_mbox_runpendq(adapter_t *adapter, scb_t *scb_q)
1909 {
1910         scb_t                   *scb;
1911         unsigned long           flags;
1912
1913         spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1914
1915         if (scb_q) {
1916                 scb_q->state = SCB_PENDQ;
1917                 list_add_tail(&scb_q->list, &adapter->pend_list);
1918         }
1919
1920         // if the adapter in not in quiescent mode, post the commands to FW
1921         if (adapter->quiescent) {
1922                 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1923                 return;
1924         }
1925
1926         while (!list_empty(&adapter->pend_list)) {
1927
1928                 assert_spin_locked(PENDING_LIST_LOCK(adapter));
1929
1930                 scb = list_entry(adapter->pend_list.next, scb_t, list);
1931
1932                 // remove the scb from the pending list and try to
1933                 // issue. If we are unable to issue it, put back in
1934                 // the pending list and return
1935
1936                 list_del_init(&scb->list);
1937
1938                 spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1939
1940                 // if mailbox was busy, return SCB back to pending
1941                 // list. Make sure to add at the head, since that's
1942                 // where it would have been removed from
1943
1944                 scb->state = SCB_ISSUED;
1945
1946                 if (mbox_post_cmd(adapter, scb) != 0) {
1947
1948                         spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1949
1950                         scb->state = SCB_PENDQ;
1951
1952                         list_add(&scb->list, &adapter->pend_list);
1953
1954                         spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
1955                                 flags);
1956
1957                         return;
1958                 }
1959
1960                 spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
1961         }
1962
1963         spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
1964
1965
1966         return;
1967 }
1968
1969
1970 /**
1971  * megaraid_mbox_prepare_pthru - prepare a command for physical devices
1972  * @adapter     : pointer to controller's soft state
1973  * @scb         : scsi control block
1974  * @scp         : scsi command from the mid-layer
1975  *
1976  * Prepare a command for the scsi physical devices.
1977  */
1978 static void
1979 megaraid_mbox_prepare_pthru(adapter_t *adapter, scb_t *scb,
1980                 struct scsi_cmnd *scp)
1981 {
1982         mbox_ccb_t              *ccb;
1983         mraid_passthru_t        *pthru;
1984         uint8_t                 channel;
1985         uint8_t                 target;
1986
1987         ccb     = (mbox_ccb_t *)scb->ccb;
1988         pthru   = ccb->pthru;
1989         channel = scb->dev_channel;
1990         target  = scb->dev_target;
1991
1992         // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
1993         pthru->timeout          = 4;    
1994         pthru->ars              = 1;
1995         pthru->islogical        = 0;
1996         pthru->channel          = 0;
1997         pthru->target           = (channel << 4) | target;
1998         pthru->logdrv           = SCP2LUN(scp);
1999         pthru->reqsenselen      = 14;
2000         pthru->cdblen           = scp->cmd_len;
2001
2002         memcpy(pthru->cdb, scp->cmnd, scp->cmd_len);
2003
2004         if (scsi_bufflen(scp)) {
2005                 pthru->dataxferlen      = scsi_bufflen(scp);
2006                 pthru->dataxferaddr     = ccb->sgl_dma_h;
2007                 pthru->numsge           = megaraid_mbox_mksgl(adapter, scb);
2008         }
2009         else {
2010                 pthru->dataxferaddr     = 0;
2011                 pthru->dataxferlen      = 0;
2012                 pthru->numsge           = 0;
2013         }
2014         return;
2015 }
2016
2017
2018 /**
2019  * megaraid_mbox_prepare_epthru - prepare a command for physical devices
2020  * @adapter     : pointer to controller's soft state
2021  * @scb         : scsi control block
2022  * @scp         : scsi command from the mid-layer
2023  *
2024  * Prepare a command for the scsi physical devices. This rountine prepares
2025  * commands for devices which can take extended CDBs (>10 bytes).
2026  */
2027 static void
2028 megaraid_mbox_prepare_epthru(adapter_t *adapter, scb_t *scb,
2029                 struct scsi_cmnd *scp)
2030 {
2031         mbox_ccb_t              *ccb;
2032         mraid_epassthru_t       *epthru;
2033         uint8_t                 channel;
2034         uint8_t                 target;
2035
2036         ccb     = (mbox_ccb_t *)scb->ccb;
2037         epthru  = ccb->epthru;
2038         channel = scb->dev_channel;
2039         target  = scb->dev_target;
2040
2041         // 0=6sec, 1=60sec, 2=10min, 3=3hrs, 4=NO timeout
2042         epthru->timeout         = 4;    
2043         epthru->ars             = 1;
2044         epthru->islogical       = 0;
2045         epthru->channel         = 0;
2046         epthru->target          = (channel << 4) | target;
2047         epthru->logdrv          = SCP2LUN(scp);
2048         epthru->reqsenselen     = 14;
2049         epthru->cdblen          = scp->cmd_len;
2050
2051         memcpy(epthru->cdb, scp->cmnd, scp->cmd_len);
2052
2053         if (scsi_bufflen(scp)) {
2054                 epthru->dataxferlen     = scsi_bufflen(scp);
2055                 epthru->dataxferaddr    = ccb->sgl_dma_h;
2056                 epthru->numsge          = megaraid_mbox_mksgl(adapter, scb);
2057         }
2058         else {
2059                 epthru->dataxferaddr    = 0;
2060                 epthru->dataxferlen     = 0;
2061                 epthru->numsge          = 0;
2062         }
2063         return;
2064 }
2065
2066
2067 /**
2068  * megaraid_ack_sequence - interrupt ack sequence for memory mapped HBAs
2069  * @adapter     : controller's soft state
2070  *
2071  * Interrupt acknowledgement sequence for memory mapped HBAs. Find out the
2072  * completed command and put them on the completed list for later processing.
2073  *
2074  * Returns:     1 if the interrupt is valid, 0 otherwise
2075  */
2076 static int
2077 megaraid_ack_sequence(adapter_t *adapter)
2078 {
2079         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
2080         mbox_t                  *mbox;
2081         scb_t                   *scb;
2082         uint8_t                 nstatus;
2083         uint8_t                 completed[MBOX_MAX_FIRMWARE_STATUS];
2084         struct list_head        clist;
2085         int                     handled;
2086         uint32_t                dword;
2087         unsigned long           flags;
2088         int                     i, j;
2089
2090
2091         mbox    = raid_dev->mbox;
2092
2093         // move the SCBs from the firmware completed array to our local list
2094         INIT_LIST_HEAD(&clist);
2095
2096         // loop till F/W has more commands for us to complete
2097         handled = 0;
2098         spin_lock_irqsave(MAILBOX_LOCK(raid_dev), flags);
2099         do {
2100                 /*
2101                  * Check if a valid interrupt is pending. If found, force the
2102                  * interrupt line low.
2103                  */
2104                 dword = RDOUTDOOR(raid_dev);
2105                 if (dword != 0x10001234) break;
2106
2107                 handled = 1;
2108
2109                 WROUTDOOR(raid_dev, 0x10001234);
2110
2111                 nstatus = 0;
2112                 // wait for valid numstatus to post
2113                 for (i = 0; i < 0xFFFFF; i++) {
2114                         if (mbox->numstatus != 0xFF) {
2115                                 nstatus = mbox->numstatus;
2116                                 break;
2117                         }
2118                         rmb();
2119                 }
2120                 mbox->numstatus = 0xFF;
2121
2122                 adapter->outstanding_cmds -= nstatus;
2123
2124                 for (i = 0; i < nstatus; i++) {
2125
2126                         // wait for valid command index to post
2127                         for (j = 0; j < 0xFFFFF; j++) {
2128                                 if (mbox->completed[i] != 0xFF) break;
2129                                 rmb();
2130                         }
2131                         completed[i]            = mbox->completed[i];
2132                         mbox->completed[i]      = 0xFF;
2133
2134                         if (completed[i] == 0xFF) {
2135                                 con_log(CL_ANN, (KERN_CRIT
2136                                 "megaraid: command posting timed out\n"));
2137
2138                                 BUG();
2139                                 continue;
2140                         }
2141
2142                         // Get SCB associated with this command id
2143                         if (completed[i] >= MBOX_MAX_SCSI_CMDS) {
2144                                 // a cmm command
2145                                 scb = adapter->uscb_list + (completed[i] -
2146                                                 MBOX_MAX_SCSI_CMDS);
2147                         }
2148                         else {
2149                                 // an os command
2150                                 scb = adapter->kscb_list + completed[i];
2151                         }
2152
2153                         scb->status = mbox->status;
2154                         list_add_tail(&scb->list, &clist);
2155                 }
2156
2157                 // Acknowledge interrupt
2158                 WRINDOOR(raid_dev, 0x02);
2159
2160         } while(1);
2161
2162         spin_unlock_irqrestore(MAILBOX_LOCK(raid_dev), flags);
2163
2164
2165         // put the completed commands in the completed list. DPC would
2166         // complete these commands later
2167         spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2168
2169         list_splice(&clist, &adapter->completed_list);
2170
2171         spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2172
2173
2174         // schedule the DPC if there is some work for it
2175         if (handled)
2176                 tasklet_schedule(&adapter->dpc_h);
2177
2178         return handled;
2179 }
2180
2181
2182 /**
2183  * megaraid_isr - isr for memory based mailbox based controllers
2184  * @irq         : irq
2185  * @devp        : pointer to our soft state
2186  *
2187  * Interrupt service routine for memory-mapped mailbox controllers.
2188  */
2189 static irqreturn_t
2190 megaraid_isr(int irq, void *devp)
2191 {
2192         adapter_t       *adapter = devp;
2193         int             handled;
2194
2195         handled = megaraid_ack_sequence(adapter);
2196
2197         /* Loop through any pending requests */
2198         if (!adapter->quiescent) {
2199                 megaraid_mbox_runpendq(adapter, NULL);
2200         }
2201
2202         return IRQ_RETVAL(handled);
2203 }
2204
2205
2206 /**
2207  * megaraid_mbox_sync_scb - sync kernel buffers
2208  * @adapter     : controller's soft state
2209  * @scb         : pointer to the resource packet
2210  *
2211  * DMA sync if required.
2212  */
2213 static void
2214 megaraid_mbox_sync_scb(adapter_t *adapter, scb_t *scb)
2215 {
2216         mbox_ccb_t      *ccb;
2217
2218         ccb     = (mbox_ccb_t *)scb->ccb;
2219
2220         if (scb->dma_direction == PCI_DMA_FROMDEVICE)
2221                 pci_dma_sync_sg_for_cpu(adapter->pdev,
2222                                         scsi_sglist(scb->scp),
2223                                         scsi_sg_count(scb->scp),
2224                                         PCI_DMA_FROMDEVICE);
2225
2226         scsi_dma_unmap(scb->scp);
2227         return;
2228 }
2229
2230
2231 /**
2232  * megaraid_mbox_dpc - the tasklet to complete the commands from completed list
2233  * @devp        : pointer to HBA soft state
2234  *
2235  * Pick up the commands from the completed list and send back to the owners.
2236  * This is a reentrant function and does not assume any locks are held while
2237  * it is being called.
2238  */
2239 static void
2240 megaraid_mbox_dpc(unsigned long devp)
2241 {
2242         adapter_t               *adapter = (adapter_t *)devp;
2243         mraid_device_t          *raid_dev;
2244         struct list_head        clist;
2245         struct scatterlist      *sgl;
2246         scb_t                   *scb;
2247         scb_t                   *tmp;
2248         struct scsi_cmnd        *scp;
2249         mraid_passthru_t        *pthru;
2250         mraid_epassthru_t       *epthru;
2251         mbox_ccb_t              *ccb;
2252         int                     islogical;
2253         int                     pdev_index;
2254         int                     pdev_state;
2255         mbox_t                  *mbox;
2256         unsigned long           flags;
2257         uint8_t                 c;
2258         int                     status;
2259         uioc_t                  *kioc;
2260
2261
2262         if (!adapter) return;
2263
2264         raid_dev = ADAP2RAIDDEV(adapter);
2265
2266         // move the SCBs from the completed list to our local list
2267         INIT_LIST_HEAD(&clist);
2268
2269         spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2270
2271         list_splice_init(&adapter->completed_list, &clist);
2272
2273         spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2274
2275
2276         list_for_each_entry_safe(scb, tmp, &clist, list) {
2277
2278                 status          = scb->status;
2279                 scp             = scb->scp;
2280                 ccb             = (mbox_ccb_t *)scb->ccb;
2281                 pthru           = ccb->pthru;
2282                 epthru          = ccb->epthru;
2283                 mbox            = ccb->mbox;
2284
2285                 // Make sure f/w has completed a valid command
2286                 if (scb->state != SCB_ISSUED) {
2287                         con_log(CL_ANN, (KERN_CRIT
2288                         "megaraid critical err: invalid command %d:%d:%p\n",
2289                                 scb->sno, scb->state, scp));
2290                         BUG();
2291                         continue;       // Must never happen!
2292                 }
2293
2294                 // check for the management command and complete it right away
2295                 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2296                         scb->state      = SCB_FREE;
2297                         scb->status     = status;
2298
2299                         // remove from local clist
2300                         list_del_init(&scb->list);
2301
2302                         kioc                    = (uioc_t *)scb->gp;
2303                         kioc->status            = 0;
2304
2305                         megaraid_mbox_mm_done(adapter, scb);
2306
2307                         continue;
2308                 }
2309
2310                 // Was an abort issued for this command earlier
2311                 if (scb->state & SCB_ABORT) {
2312                         con_log(CL_ANN, (KERN_NOTICE
2313                         "megaraid: aborted cmd %lx[%x] completed\n",
2314                                 scp->serial_number, scb->sno));
2315                 }
2316
2317                 /*
2318                  * If the inquiry came of a disk drive which is not part of
2319                  * any RAID array, expose it to the kernel. For this to be
2320                  * enabled, user must set the "megaraid_expose_unconf_disks"
2321                  * flag to 1 by specifying it on module parameter list.
2322                  * This would enable data migration off drives from other
2323                  * configurations.
2324                  */
2325                 islogical = MRAID_IS_LOGICAL(adapter, scp);
2326                 if (scp->cmnd[0] == INQUIRY && status == 0 && islogical == 0
2327                                 && IS_RAID_CH(raid_dev, scb->dev_channel)) {
2328
2329                         sgl = scsi_sglist(scp);
2330                         if (sgl->page) {
2331                                 c = *(unsigned char *)
2332                                         (page_address((&sgl[0])->page) +
2333                                          (&sgl[0])->offset);
2334                         } else {
2335                                 con_log(CL_ANN, (KERN_WARNING
2336                                                  "megaraid mailbox: invalid sg:%d\n",
2337                                                  __LINE__));
2338                                 c = 0;
2339                         }
2340
2341                         if ((c & 0x1F ) == TYPE_DISK) {
2342                                 pdev_index = (scb->dev_channel * 16) +
2343                                         scb->dev_target;
2344                                 pdev_state =
2345                                         raid_dev->pdrv_state[pdev_index] & 0x0F;
2346
2347                                 if (pdev_state == PDRV_ONLINE           ||
2348                                         pdev_state == PDRV_FAILED       ||
2349                                         pdev_state == PDRV_RBLD         ||
2350                                         pdev_state == PDRV_HOTSPARE     ||
2351                                         megaraid_expose_unconf_disks == 0) {
2352
2353                                         status = 0xF0;
2354                                 }
2355                         }
2356                 }
2357
2358                 // Convert MegaRAID status to Linux error code
2359                 switch (status) {
2360
2361                 case 0x00:
2362
2363                         scp->result = (DID_OK << 16);
2364                         break;
2365
2366                 case 0x02:
2367
2368                         /* set sense_buffer and result fields */
2369                         if (mbox->cmd == MBOXCMD_PASSTHRU ||
2370                                 mbox->cmd == MBOXCMD_PASSTHRU64) {
2371
2372                                 memcpy(scp->sense_buffer, pthru->reqsensearea,
2373                                                 14);
2374
2375                                 scp->result = DRIVER_SENSE << 24 |
2376                                         DID_OK << 16 | CHECK_CONDITION << 1;
2377                         }
2378                         else {
2379                                 if (mbox->cmd == MBOXCMD_EXTPTHRU) {
2380
2381                                         memcpy(scp->sense_buffer,
2382                                                 epthru->reqsensearea, 14);
2383
2384                                         scp->result = DRIVER_SENSE << 24 |
2385                                                 DID_OK << 16 |
2386                                                 CHECK_CONDITION << 1;
2387                                 } else {
2388                                         scp->sense_buffer[0] = 0x70;
2389                                         scp->sense_buffer[2] = ABORTED_COMMAND;
2390                                         scp->result = CHECK_CONDITION << 1;
2391                                 }
2392                         }
2393                         break;
2394
2395                 case 0x08:
2396
2397                         scp->result = DID_BUS_BUSY << 16 | status;
2398                         break;
2399
2400                 default:
2401
2402                         /*
2403                          * If TEST_UNIT_READY fails, we know RESERVATION_STATUS
2404                          * failed
2405                          */
2406                         if (scp->cmnd[0] == TEST_UNIT_READY) {
2407                                 scp->result = DID_ERROR << 16 |
2408                                         RESERVATION_CONFLICT << 1;
2409                         }
2410                         else
2411                         /*
2412                          * Error code returned is 1 if Reserve or Release
2413                          * failed or the input parameter is invalid
2414                          */
2415                         if (status == 1 && (scp->cmnd[0] == RESERVE ||
2416                                          scp->cmnd[0] == RELEASE)) {
2417
2418                                 scp->result = DID_ERROR << 16 |
2419                                         RESERVATION_CONFLICT << 1;
2420                         }
2421                         else {
2422                                 scp->result = DID_BAD_TARGET << 16 | status;
2423                         }
2424                 }
2425
2426                 // print a debug message for all failed commands
2427                 if (status) {
2428                         megaraid_mbox_display_scb(adapter, scb);
2429                 }
2430
2431                 // Free our internal resources and call the mid-layer callback
2432                 // routine
2433                 megaraid_mbox_sync_scb(adapter, scb);
2434
2435                 // remove from local clist
2436                 list_del_init(&scb->list);
2437
2438                 // put back in free list
2439                 megaraid_dealloc_scb(adapter, scb);
2440
2441                 // send the scsi packet back to kernel
2442                 scp->scsi_done(scp);
2443         }
2444
2445         return;
2446 }
2447
2448
2449 /**
2450  * megaraid_abort_handler - abort the scsi command
2451  * @scp         : command to be aborted
2452  *
2453  * Abort a previous SCSI request. Only commands on the pending list can be
2454  * aborted. All the commands issued to the F/W must complete.
2455  **/
2456 static int
2457 megaraid_abort_handler(struct scsi_cmnd *scp)
2458 {
2459         adapter_t               *adapter;
2460         mraid_device_t          *raid_dev;
2461         scb_t                   *scb;
2462         scb_t                   *tmp;
2463         int                     found;
2464         unsigned long           flags;
2465         int                     i;
2466
2467
2468         adapter         = SCP2ADAPTER(scp);
2469         raid_dev        = ADAP2RAIDDEV(adapter);
2470
2471         con_log(CL_ANN, (KERN_WARNING
2472                 "megaraid: aborting-%ld cmd=%x <c=%d t=%d l=%d>\n",
2473                 scp->serial_number, scp->cmnd[0], SCP2CHANNEL(scp),
2474                 SCP2TARGET(scp), SCP2LUN(scp)));
2475
2476         // If FW has stopped responding, simply return failure
2477         if (raid_dev->hw_error) {
2478                 con_log(CL_ANN, (KERN_NOTICE
2479                         "megaraid: hw error, not aborting\n"));
2480                 return FAILED;
2481         }
2482
2483         // There might a race here, where the command was completed by the
2484         // firmware and now it is on the completed list. Before we could
2485         // complete the command to the kernel in dpc, the abort came.
2486         // Find out if this is the case to avoid the race.
2487         scb = NULL;
2488         spin_lock_irqsave(COMPLETED_LIST_LOCK(adapter), flags);
2489         list_for_each_entry_safe(scb, tmp, &adapter->completed_list, list) {
2490
2491                 if (scb->scp == scp) {  // Found command
2492
2493                         list_del_init(&scb->list);      // from completed list
2494
2495                         con_log(CL_ANN, (KERN_WARNING
2496                         "megaraid: %ld:%d[%d:%d], abort from completed list\n",
2497                                 scp->serial_number, scb->sno,
2498                                 scb->dev_channel, scb->dev_target));
2499
2500                         scp->result = (DID_ABORT << 16);
2501                         scp->scsi_done(scp);
2502
2503                         megaraid_dealloc_scb(adapter, scb);
2504
2505                         spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter),
2506                                 flags);
2507
2508                         return SUCCESS;
2509                 }
2510         }
2511         spin_unlock_irqrestore(COMPLETED_LIST_LOCK(adapter), flags);
2512
2513
2514         // Find out if this command is still on the pending list. If it is and
2515         // was never issued, abort and return success. If the command is owned
2516         // by the firmware, we must wait for it to complete by the FW.
2517         spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2518         list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2519
2520                 if (scb->scp == scp) {  // Found command
2521
2522                         list_del_init(&scb->list);      // from pending list
2523
2524                         ASSERT(!(scb->state & SCB_ISSUED));
2525
2526                         con_log(CL_ANN, (KERN_WARNING
2527                                 "megaraid abort: %ld[%d:%d], driver owner\n",
2528                                 scp->serial_number, scb->dev_channel,
2529                                 scb->dev_target));
2530
2531                         scp->result = (DID_ABORT << 16);
2532                         scp->scsi_done(scp);
2533
2534                         megaraid_dealloc_scb(adapter, scb);
2535
2536                         spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter),
2537                                 flags);
2538
2539                         return SUCCESS;
2540                 }
2541         }
2542         spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2543
2544
2545         // Check do we even own this command, in which case this would be
2546         // owned by the firmware. The only way to locate the FW scb is to
2547         // traverse through the list of all SCB, since driver does not
2548         // maintain these SCBs on any list
2549         found = 0;
2550         spin_lock_irq(&adapter->lock);
2551         for (i = 0; i < MBOX_MAX_SCSI_CMDS; i++) {
2552                 scb = adapter->kscb_list + i;
2553
2554                 if (scb->scp == scp) {
2555
2556                         found = 1;
2557
2558                         if (!(scb->state & SCB_ISSUED)) {
2559                                 con_log(CL_ANN, (KERN_WARNING
2560                                 "megaraid abort: %ld%d[%d:%d], invalid state\n",
2561                                 scp->serial_number, scb->sno, scb->dev_channel,
2562                                 scb->dev_target));
2563                                 BUG();
2564                         }
2565                         else {
2566                                 con_log(CL_ANN, (KERN_WARNING
2567                                 "megaraid abort: %ld:%d[%d:%d], fw owner\n",
2568                                 scp->serial_number, scb->sno, scb->dev_channel,
2569                                 scb->dev_target));
2570                         }
2571                 }
2572         }
2573         spin_unlock_irq(&adapter->lock);
2574
2575         if (!found) {
2576                 con_log(CL_ANN, (KERN_WARNING
2577                         "megaraid abort: scsi cmd:%ld, do now own\n",
2578                         scp->serial_number));
2579
2580                 // FIXME: Should there be a callback for this command?
2581                 return SUCCESS;
2582         }
2583
2584         // We cannot actually abort a command owned by firmware, return
2585         // failure and wait for reset. In host reset handler, we will find out
2586         // if the HBA is still live
2587         return FAILED;
2588 }
2589
2590 /**
2591  * megaraid_reset_handler - device reset hadler for mailbox based driver
2592  * @scp         : reference command
2593  *
2594  * Reset handler for the mailbox based controller. First try to find out if
2595  * the FW is still live, in which case the outstanding commands counter mut go
2596  * down to 0. If that happens, also issue the reservation reset command to
2597  * relinquish (possible) reservations on the logical drives connected to this
2598  * host.
2599  **/
2600 static int
2601 megaraid_reset_handler(struct scsi_cmnd *scp)
2602 {
2603         adapter_t       *adapter;
2604         scb_t           *scb;
2605         scb_t           *tmp;
2606         mraid_device_t  *raid_dev;
2607         unsigned long   flags;
2608         uint8_t         raw_mbox[sizeof(mbox_t)];
2609         int             rval;
2610         int             recovery_window;
2611         int             recovering;
2612         int             i;
2613         uioc_t          *kioc;
2614
2615         adapter         = SCP2ADAPTER(scp);
2616         raid_dev        = ADAP2RAIDDEV(adapter);
2617
2618         // return failure if adapter is not responding
2619         if (raid_dev->hw_error) {
2620                 con_log(CL_ANN, (KERN_NOTICE
2621                         "megaraid: hw error, cannot reset\n"));
2622                 return FAILED;
2623         }
2624
2625
2626         // Under exceptional conditions, FW can take up to 3 minutes to
2627         // complete command processing. Wait for additional 2 minutes for the
2628         // pending commands counter to go down to 0. If it doesn't, let the
2629         // controller be marked offline
2630         // Also, reset all the commands currently owned by the driver
2631         spin_lock_irqsave(PENDING_LIST_LOCK(adapter), flags);
2632         list_for_each_entry_safe(scb, tmp, &adapter->pend_list, list) {
2633                 list_del_init(&scb->list);      // from pending list
2634
2635                 if (scb->sno >= MBOX_MAX_SCSI_CMDS) {
2636                         con_log(CL_ANN, (KERN_WARNING
2637                         "megaraid: IOCTL packet with %d[%d:%d] being reset\n",
2638                         scb->sno, scb->dev_channel, scb->dev_target));
2639
2640                         scb->status = -1;
2641
2642                         kioc                    = (uioc_t *)scb->gp;
2643                         kioc->status            = -EFAULT;
2644
2645                         megaraid_mbox_mm_done(adapter, scb);
2646                 } else {
2647                         if (scb->scp == scp) {  // Found command
2648                                 con_log(CL_ANN, (KERN_WARNING
2649                                         "megaraid: %ld:%d[%d:%d], reset from pending list\n",
2650                                         scp->serial_number, scb->sno,
2651                                         scb->dev_channel, scb->dev_target));
2652                         } else {
2653                                 con_log(CL_ANN, (KERN_WARNING
2654                                 "megaraid: IO packet with %d[%d:%d] being reset\n",
2655                                 scb->sno, scb->dev_channel, scb->dev_target));
2656                         }
2657
2658                         scb->scp->result = (DID_RESET << 16);
2659                         scb->scp->scsi_done(scb->scp);
2660
2661                         megaraid_dealloc_scb(adapter, scb);
2662                 }
2663         }
2664         spin_unlock_irqrestore(PENDING_LIST_LOCK(adapter), flags);
2665
2666         if (adapter->outstanding_cmds) {
2667                 con_log(CL_ANN, (KERN_NOTICE
2668                         "megaraid: %d outstanding commands. Max wait %d sec\n",
2669                         adapter->outstanding_cmds,
2670                         (MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT)));
2671         }
2672
2673         recovery_window = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
2674
2675         recovering = adapter->outstanding_cmds;
2676
2677         for (i = 0; i < recovery_window; i++) {
2678
2679                 megaraid_ack_sequence(adapter);
2680
2681                 // print a message once every 5 seconds only
2682                 if (!(i % 5)) {
2683                         con_log(CL_ANN, (
2684                         "megaraid mbox: Wait for %d commands to complete:%d\n",
2685                                 adapter->outstanding_cmds,
2686                                 (MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT) - i));
2687                 }
2688
2689                 // bailout if no recovery happended in reset time
2690                 if (adapter->outstanding_cmds == 0) {
2691                         break;
2692                 }
2693
2694                 msleep(1000);
2695         }
2696
2697         spin_lock(&adapter->lock);
2698
2699         // If still outstanding commands, bail out
2700         if (adapter->outstanding_cmds) {
2701                 con_log(CL_ANN, (KERN_WARNING
2702                         "megaraid mbox: critical hardware error!\n"));
2703
2704                 raid_dev->hw_error = 1;
2705
2706                 rval = FAILED;
2707                 goto out;
2708         }
2709         else {
2710                 con_log(CL_ANN, (KERN_NOTICE
2711                 "megaraid mbox: reset sequence completed sucessfully\n"));
2712         }
2713
2714
2715         // If the controller supports clustering, reset reservations
2716         if (!adapter->ha) {
2717                 rval = SUCCESS;
2718                 goto out;
2719         }
2720
2721         // clear reservations if any
2722         raw_mbox[0] = CLUSTER_CMD;
2723         raw_mbox[2] = RESET_RESERVATIONS;
2724
2725         rval = SUCCESS;
2726         if (mbox_post_sync_cmd_fast(adapter, raw_mbox) == 0) {
2727                 con_log(CL_ANN,
2728                         (KERN_INFO "megaraid: reservation reset\n"));
2729         }
2730         else {
2731                 rval = FAILED;
2732                 con_log(CL_ANN, (KERN_WARNING
2733                                 "megaraid: reservation reset failed\n"));
2734         }
2735
2736  out:
2737         spin_unlock_irq(&adapter->lock);
2738         return rval;
2739 }
2740
2741 /*
2742  * START: internal commands library
2743  *
2744  * This section of the driver has the common routine used by the driver and
2745  * also has all the FW routines
2746  */
2747
2748 /**
2749  * mbox_post_sync_cmd() - blocking command to the mailbox based controllers
2750  * @adapter     : controller's soft state
2751  * @raw_mbox    : the mailbox
2752  *
2753  * Issue a scb in synchronous and non-interrupt mode for mailbox based
2754  * controllers.
2755  */
2756 static int
2757 mbox_post_sync_cmd(adapter_t *adapter, uint8_t raw_mbox[])
2758 {
2759         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
2760         mbox64_t        *mbox64;
2761         mbox_t          *mbox;
2762         uint8_t         status;
2763         int             i;
2764
2765
2766         mbox64  = raid_dev->mbox64;
2767         mbox    = raid_dev->mbox;
2768
2769         /*
2770          * Wait until mailbox is free
2771          */
2772         if (megaraid_busywait_mbox(raid_dev) != 0)
2773                 goto blocked_mailbox;
2774
2775         /*
2776          * Copy mailbox data into host structure
2777          */
2778         memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
2779         mbox->cmdid             = 0xFE;
2780         mbox->busy              = 1;
2781         mbox->poll              = 0;
2782         mbox->ack               = 0;
2783         mbox->numstatus         = 0xFF;
2784         mbox->status            = 0xFF;
2785
2786         wmb();
2787         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2788
2789         // wait for maximum 1 second for status to post. If the status is not
2790         // available within 1 second, assume FW is initializing and wait
2791         // for an extended amount of time
2792         if (mbox->numstatus == 0xFF) {  // status not yet available
2793                 udelay(25);
2794
2795                 for (i = 0; mbox->numstatus == 0xFF && i < 1000; i++) {
2796                         rmb();
2797                         msleep(1);
2798                 }
2799
2800
2801                 if (i == 1000) {
2802                         con_log(CL_ANN, (KERN_NOTICE
2803                                 "megaraid mailbox: wait for FW to boot      "));
2804
2805                         for (i = 0; (mbox->numstatus == 0xFF) &&
2806                                         (i < MBOX_RESET_WAIT); i++) {
2807                                 rmb();
2808                                 con_log(CL_ANN, ("\b\b\b\b\b[%03d]",
2809                                                         MBOX_RESET_WAIT - i));
2810                                 msleep(1000);
2811                         }
2812
2813                         if (i == MBOX_RESET_WAIT) {
2814
2815                                 con_log(CL_ANN, (
2816                                 "\nmegaraid mailbox: status not available\n"));
2817
2818                                 return -1;
2819                         }
2820                         con_log(CL_ANN, ("\b\b\b\b\b[ok] \n"));
2821                 }
2822         }
2823
2824         // wait for maximum 1 second for poll semaphore
2825         if (mbox->poll != 0x77) {
2826                 udelay(25);
2827
2828                 for (i = 0; (mbox->poll != 0x77) && (i < 1000); i++) {
2829                         rmb();
2830                         msleep(1);
2831                 }
2832
2833                 if (i == 1000) {
2834                         con_log(CL_ANN, (KERN_WARNING
2835                         "megaraid mailbox: could not get poll semaphore\n"));
2836                         return -1;
2837                 }
2838         }
2839
2840         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2841         wmb();
2842
2843         // wait for maximum 1 second for acknowledgement
2844         if (RDINDOOR(raid_dev) & 0x2) {
2845                 udelay(25);
2846
2847                 for (i = 0; (RDINDOOR(raid_dev) & 0x2) && (i < 1000); i++) {
2848                         rmb();
2849                         msleep(1);
2850                 }
2851
2852                 if (i == 1000) {
2853                         con_log(CL_ANN, (KERN_WARNING
2854                                 "megaraid mailbox: could not acknowledge\n"));
2855                         return -1;
2856                 }
2857         }
2858         mbox->poll      = 0;
2859         mbox->ack       = 0x77;
2860
2861         status = mbox->status;
2862
2863         // invalidate the completed command id array. After command
2864         // completion, firmware would write the valid id.
2865         mbox->numstatus = 0xFF;
2866         mbox->status    = 0xFF;
2867         for (i = 0; i < MBOX_MAX_FIRMWARE_STATUS; i++) {
2868                 mbox->completed[i] = 0xFF;
2869         }
2870
2871         return status;
2872
2873 blocked_mailbox:
2874
2875         con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n") );
2876         return -1;
2877 }
2878
2879
2880 /**
2881  * mbox_post_sync_cmd_fast - blocking command to the mailbox based controllers
2882  * @adapter     : controller's soft state
2883  * @raw_mbox    : the mailbox
2884  *
2885  * Issue a scb in synchronous and non-interrupt mode for mailbox based
2886  * controllers. This is a faster version of the synchronous command and
2887  * therefore can be called in interrupt-context as well.
2888  */
2889 static int
2890 mbox_post_sync_cmd_fast(adapter_t *adapter, uint8_t raw_mbox[])
2891 {
2892         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
2893         mbox_t          *mbox;
2894         long            i;
2895
2896
2897         mbox    = raid_dev->mbox;
2898
2899         // return immediately if the mailbox is busy
2900         if (mbox->busy) return -1;
2901
2902         // Copy mailbox data into host structure
2903         memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 14);
2904         mbox->cmdid             = 0xFE;
2905         mbox->busy              = 1;
2906         mbox->poll              = 0;
2907         mbox->ack               = 0;
2908         mbox->numstatus         = 0xFF;
2909         mbox->status            = 0xFF;
2910
2911         wmb();
2912         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
2913
2914         for (i = 0; i < MBOX_SYNC_WAIT_CNT; i++) {
2915                 if (mbox->numstatus != 0xFF) break;
2916                 rmb();
2917                 udelay(MBOX_SYNC_DELAY_200);
2918         }
2919
2920         if (i == MBOX_SYNC_WAIT_CNT) {
2921                 // We may need to re-calibrate the counter
2922                 con_log(CL_ANN, (KERN_CRIT
2923                         "megaraid: fast sync command timed out\n"));
2924         }
2925
2926         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x2);
2927         wmb();
2928
2929         return mbox->status;
2930 }
2931
2932
2933 /**
2934  * megaraid_busywait_mbox() - Wait until the controller's mailbox is available
2935  * @raid_dev    : RAID device (HBA) soft state
2936  *
2937  * Wait until the controller's mailbox is available to accept more commands.
2938  * Wait for at most 1 second.
2939  */
2940 static int
2941 megaraid_busywait_mbox(mraid_device_t *raid_dev)
2942 {
2943         mbox_t  *mbox = raid_dev->mbox;
2944         int     i = 0;
2945
2946         if (mbox->busy) {
2947                 udelay(25);
2948                 for (i = 0; mbox->busy && i < 1000; i++)
2949                         msleep(1);
2950         }
2951
2952         if (i < 1000) return 0;
2953         else return -1;
2954 }
2955
2956
2957 /**
2958  * megaraid_mbox_product_info - some static information about the controller
2959  * @adapter     : our soft state
2960  *
2961  * Issue commands to the controller to grab some parameters required by our
2962  * caller.
2963  */
2964 static int
2965 megaraid_mbox_product_info(adapter_t *adapter)
2966 {
2967         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
2968         mbox_t                  *mbox;
2969         uint8_t                 raw_mbox[sizeof(mbox_t)];
2970         mraid_pinfo_t           *pinfo;
2971         dma_addr_t              pinfo_dma_h;
2972         mraid_inquiry3_t        *mraid_inq3;
2973         int                     i;
2974
2975
2976         memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
2977         mbox = (mbox_t *)raw_mbox;
2978
2979         /*
2980          * Issue an ENQUIRY3 command to find out certain adapter parameters,
2981          * e.g., max channels, max commands etc.
2982          */
2983         pinfo = pci_alloc_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
2984                         &pinfo_dma_h);
2985
2986         if (pinfo == NULL) {
2987                 con_log(CL_ANN, (KERN_WARNING
2988                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
2989                         __LINE__));
2990
2991                 return -1;
2992         }
2993         memset(pinfo, 0, sizeof(mraid_pinfo_t));
2994
2995         mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
2996         memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
2997
2998         raw_mbox[0] = FC_NEW_CONFIG;
2999         raw_mbox[2] = NC_SUBOP_ENQUIRY3;
3000         raw_mbox[3] = ENQ3_GET_SOLICITED_FULL;
3001
3002         // Issue the command
3003         if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3004
3005                 con_log(CL_ANN, (KERN_WARNING "megaraid: Inquiry3 failed\n"));
3006
3007                 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3008                         pinfo, pinfo_dma_h);
3009
3010                 return -1;
3011         }
3012
3013         /*
3014          * Collect information about state of each physical drive
3015          * attached to the controller. We will expose all the disks
3016          * which are not part of RAID
3017          */
3018         mraid_inq3 = (mraid_inquiry3_t *)adapter->ibuf;
3019         for (i = 0; i < MBOX_MAX_PHYSICAL_DRIVES; i++) {
3020                 raid_dev->pdrv_state[i] = mraid_inq3->pdrv_state[i];
3021         }
3022
3023         /*
3024          * Get product info for information like number of channels,
3025          * maximum commands supported.
3026          */
3027         memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3028         mbox->xferaddr = (uint32_t)pinfo_dma_h;
3029
3030         raw_mbox[0] = FC_NEW_CONFIG;
3031         raw_mbox[2] = NC_SUBOP_PRODUCT_INFO;
3032
3033         if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3034
3035                 con_log(CL_ANN, (KERN_WARNING
3036                         "megaraid: product info failed\n"));
3037
3038                 pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t),
3039                         pinfo, pinfo_dma_h);
3040
3041                 return -1;
3042         }
3043
3044         /*
3045          * Setup some parameters for host, as required by our caller
3046          */
3047         adapter->max_channel = pinfo->nchannels;
3048
3049         /*
3050          * we will export all the logical drives on a single channel.
3051          * Add 1 since inquires do not come for inititor ID
3052          */
3053         adapter->max_target     = MAX_LOGICAL_DRIVES_40LD + 1;
3054         adapter->max_lun        = 8;    // up to 8 LUNs for non-disk devices
3055
3056         /*
3057          * These are the maximum outstanding commands for the scsi-layer
3058          */
3059         adapter->max_cmds       = MBOX_MAX_SCSI_CMDS;
3060
3061         memset(adapter->fw_version, 0, VERSION_SIZE);
3062         memset(adapter->bios_version, 0, VERSION_SIZE);
3063
3064         memcpy(adapter->fw_version, pinfo->fw_version, 4);
3065         adapter->fw_version[4] = 0;
3066
3067         memcpy(adapter->bios_version, pinfo->bios_version, 4);
3068         adapter->bios_version[4] = 0;
3069
3070         con_log(CL_ANN, (KERN_NOTICE
3071                 "megaraid: fw version:[%s] bios version:[%s]\n",
3072                 adapter->fw_version, adapter->bios_version));
3073
3074         pci_free_consistent(adapter->pdev, sizeof(mraid_pinfo_t), pinfo,
3075                         pinfo_dma_h);
3076
3077         return 0;
3078 }
3079
3080
3081
3082 /**
3083  * megaraid_mbox_extended_cdb - check for support for extended CDBs
3084  * @adapter     : soft state for the controller
3085  *
3086  * This routine check whether the controller in question supports extended
3087  * ( > 10 bytes ) CDBs.
3088  */
3089 static int
3090 megaraid_mbox_extended_cdb(adapter_t *adapter)
3091 {
3092         mbox_t          *mbox;
3093         uint8_t         raw_mbox[sizeof(mbox_t)];
3094         int             rval;
3095
3096         mbox = (mbox_t *)raw_mbox;
3097
3098         memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3099         mbox->xferaddr  = (uint32_t)adapter->ibuf_dma_h;
3100
3101         memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3102
3103         raw_mbox[0] = MAIN_MISC_OPCODE;
3104         raw_mbox[2] = SUPPORT_EXT_CDB;
3105
3106         /*
3107          * Issue the command
3108          */
3109         rval = 0;
3110         if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3111                 rval = -1;
3112         }
3113
3114         return rval;
3115 }
3116
3117
3118 /**
3119  * megaraid_mbox_support_ha - Do we support clustering
3120  * @adapter     : soft state for the controller
3121  * @init_id     : ID of the initiator
3122  *
3123  * Determine if the firmware supports clustering and the ID of the initiator.
3124  */
3125 static int
3126 megaraid_mbox_support_ha(adapter_t *adapter, uint16_t *init_id)
3127 {
3128         mbox_t          *mbox;
3129         uint8_t         raw_mbox[sizeof(mbox_t)];
3130         int             rval;
3131
3132
3133         mbox = (mbox_t *)raw_mbox;
3134
3135         memset((caddr_t)raw_mbox, 0, sizeof(raw_mbox));
3136
3137         mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3138
3139         memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3140
3141         raw_mbox[0] = GET_TARGET_ID;
3142
3143         // Issue the command
3144         *init_id = 7;
3145         rval =  -1;
3146         if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3147
3148                 *init_id = *(uint8_t *)adapter->ibuf;
3149
3150                 con_log(CL_ANN, (KERN_INFO
3151                         "megaraid: cluster firmware, initiator ID: %d\n",
3152                         *init_id));
3153
3154                 rval =  0;
3155         }
3156
3157         return rval;
3158 }
3159
3160
3161 /**
3162  * megaraid_mbox_support_random_del - Do we support random deletion
3163  * @adapter     : soft state for the controller
3164  *
3165  * Determine if the firmware supports random deletion.
3166  * Return:      1 is operation supported, 0 otherwise
3167  */
3168 static int
3169 megaraid_mbox_support_random_del(adapter_t *adapter)
3170 {
3171         mbox_t          *mbox;
3172         uint8_t         raw_mbox[sizeof(mbox_t)];
3173         int             rval;
3174
3175
3176         mbox = (mbox_t *)raw_mbox;
3177
3178         memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3179
3180         raw_mbox[0] = FC_DEL_LOGDRV;
3181         raw_mbox[2] = OP_SUP_DEL_LOGDRV;
3182
3183         // Issue the command
3184         rval = 0;
3185         if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3186
3187                 con_log(CL_DLEVEL1, ("megaraid: supports random deletion\n"));
3188
3189                 rval =  1;
3190         }
3191
3192         return rval;
3193 }
3194
3195
3196 /**
3197  * megaraid_mbox_get_max_sg - maximum sg elements supported by the firmware
3198  * @adapter     : soft state for the controller
3199  *
3200  * Find out the maximum number of scatter-gather elements supported by the
3201  * firmware.
3202  */
3203 static int
3204 megaraid_mbox_get_max_sg(adapter_t *adapter)
3205 {
3206         mbox_t          *mbox;
3207         uint8_t         raw_mbox[sizeof(mbox_t)];
3208         int             nsg;
3209
3210
3211         mbox = (mbox_t *)raw_mbox;
3212
3213         memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3214
3215         mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3216
3217         memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3218
3219         raw_mbox[0] = MAIN_MISC_OPCODE;
3220         raw_mbox[2] = GET_MAX_SG_SUPPORT;
3221
3222         // Issue the command
3223         if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3224                 nsg =  *(uint8_t *)adapter->ibuf;
3225         }
3226         else {
3227                 nsg =  MBOX_DEFAULT_SG_SIZE;
3228         }
3229
3230         if (nsg > MBOX_MAX_SG_SIZE) nsg = MBOX_MAX_SG_SIZE;
3231
3232         return nsg;
3233 }
3234
3235
3236 /**
3237  * megaraid_mbox_enum_raid_scsi - enumerate the RAID and SCSI channels
3238  * @adapter     : soft state for the controller
3239  *
3240  * Enumerate the RAID and SCSI channels for ROMB platforms so that channels
3241  * can be exported as regular SCSI channels.
3242  */
3243 static void
3244 megaraid_mbox_enum_raid_scsi(adapter_t *adapter)
3245 {
3246         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3247         mbox_t          *mbox;
3248         uint8_t         raw_mbox[sizeof(mbox_t)];
3249
3250
3251         mbox = (mbox_t *)raw_mbox;
3252
3253         memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3254
3255         mbox->xferaddr = (uint32_t)adapter->ibuf_dma_h;
3256
3257         memset((void *)adapter->ibuf, 0, MBOX_IBUF_SIZE);
3258
3259         raw_mbox[0] = CHNL_CLASS;
3260         raw_mbox[2] = GET_CHNL_CLASS;
3261
3262         // Issue the command. If the command fails, all channels are RAID
3263         // channels
3264         raid_dev->channel_class = 0xFF;
3265         if (mbox_post_sync_cmd(adapter, raw_mbox) == 0) {
3266                 raid_dev->channel_class =  *(uint8_t *)adapter->ibuf;
3267         }
3268
3269         return;
3270 }
3271
3272
3273 /**
3274  * megaraid_mbox_flush_cache - flush adapter and disks cache
3275  * @adapter             : soft state for the controller
3276  *
3277  * Flush adapter cache followed by disks cache.
3278  */
3279 static void
3280 megaraid_mbox_flush_cache(adapter_t *adapter)
3281 {
3282         mbox_t  *mbox;
3283         uint8_t raw_mbox[sizeof(mbox_t)];
3284
3285
3286         mbox = (mbox_t *)raw_mbox;
3287
3288         memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3289
3290         raw_mbox[0] = FLUSH_ADAPTER;
3291
3292         if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3293                 con_log(CL_ANN, ("megaraid: flush adapter failed\n"));
3294         }
3295
3296         raw_mbox[0] = FLUSH_SYSTEM;
3297
3298         if (mbox_post_sync_cmd(adapter, raw_mbox) != 0) {
3299                 con_log(CL_ANN, ("megaraid: flush disks cache failed\n"));
3300         }
3301
3302         return;
3303 }
3304
3305
3306 /**
3307  * megaraid_mbox_fire_sync_cmd - fire the sync cmd
3308  * @adapter             : soft state for the controller
3309  *
3310  * Clears the pending cmds in FW and reinits its RAID structs.
3311  */
3312 static int
3313 megaraid_mbox_fire_sync_cmd(adapter_t *adapter)
3314 {
3315         mbox_t  *mbox;
3316         uint8_t raw_mbox[sizeof(mbox_t)];
3317         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3318         mbox64_t *mbox64;
3319         int     status = 0;
3320         int i;
3321         uint32_t dword;
3322
3323         mbox = (mbox_t *)raw_mbox;
3324
3325         memset((caddr_t)raw_mbox, 0, sizeof(mbox_t));
3326
3327         raw_mbox[0] = 0xFF;
3328
3329         mbox64  = raid_dev->mbox64;
3330         mbox    = raid_dev->mbox;
3331
3332         /* Wait until mailbox is free */
3333         if (megaraid_busywait_mbox(raid_dev) != 0) {
3334                 status = 1;
3335                 goto blocked_mailbox;
3336         }
3337
3338         /* Copy mailbox data into host structure */
3339         memcpy((caddr_t)mbox, (caddr_t)raw_mbox, 16);
3340         mbox->cmdid             = 0xFE;
3341         mbox->busy              = 1;
3342         mbox->poll              = 0;
3343         mbox->ack               = 0;
3344         mbox->numstatus         = 0;
3345         mbox->status            = 0;
3346
3347         wmb();
3348         WRINDOOR(raid_dev, raid_dev->mbox_dma | 0x1);
3349
3350         /* Wait for maximum 1 min for status to post.
3351          * If the Firmware SUPPORTS the ABOVE COMMAND,
3352          * mbox->cmd will be set to 0
3353          * else
3354          * the firmware will reject the command with
3355          * mbox->numstatus set to 1
3356          */
3357
3358         i = 0;
3359         status = 0;
3360         while (!mbox->numstatus && mbox->cmd == 0xFF) {
3361                 rmb();
3362                 msleep(1);
3363                 i++;
3364                 if (i > 1000 * 60) {
3365                         status = 1;
3366                         break;
3367                 }
3368         }
3369         if (mbox->numstatus == 1)
3370                 status = 1; /*cmd not supported*/
3371
3372         /* Check for interrupt line */
3373         dword = RDOUTDOOR(raid_dev);
3374         WROUTDOOR(raid_dev, dword);
3375         WRINDOOR(raid_dev,2);
3376
3377         return status;
3378
3379 blocked_mailbox:
3380         con_log(CL_ANN, (KERN_WARNING "megaraid: blocked mailbox\n"));
3381         return status;
3382 }
3383
3384 /**
3385  * megaraid_mbox_display_scb - display SCB information, mostly debug purposes
3386  * @adapter             : controller's soft state
3387  * @scb                 : SCB to be displayed
3388  * @level               : debug level for console print
3389  *
3390  * Diplay information about the given SCB iff the current debug level is
3391  * verbose.
3392  */
3393 static void
3394 megaraid_mbox_display_scb(adapter_t *adapter, scb_t *scb)
3395 {
3396         mbox_ccb_t              *ccb;
3397         struct scsi_cmnd        *scp;
3398         mbox_t                  *mbox;
3399         int                     level;
3400         int                     i;
3401
3402
3403         ccb     = (mbox_ccb_t *)scb->ccb;
3404         scp     = scb->scp;
3405         mbox    = ccb->mbox;
3406
3407         level = CL_DLEVEL3;
3408
3409         con_log(level, (KERN_NOTICE
3410                 "megaraid mailbox: status:%#x cmd:%#x id:%#x ", scb->status,
3411                 mbox->cmd, scb->sno));
3412
3413         con_log(level, ("sec:%#x lba:%#x addr:%#x ld:%d sg:%d\n",
3414                 mbox->numsectors, mbox->lba, mbox->xferaddr, mbox->logdrv,
3415                 mbox->numsge));
3416
3417         if (!scp) return;
3418
3419         con_log(level, (KERN_NOTICE "scsi cmnd: "));
3420
3421         for (i = 0; i < scp->cmd_len; i++) {
3422                 con_log(level, ("%#2.02x ", scp->cmnd[i]));
3423         }
3424
3425         con_log(level, ("\n"));
3426
3427         return;
3428 }
3429
3430
3431 /**
3432  * megaraid_mbox_setup_device_map - manage device ids
3433  * @adapter     : Driver's soft state
3434  *
3435  * Manange the device ids to have an appropraite mapping between the kernel
3436  * scsi addresses and megaraid scsi and logical drive addresses. We export
3437  * scsi devices on their actual addresses, whereas the logical drives are
3438  * exported on a virtual scsi channel.
3439  */
3440 static void
3441 megaraid_mbox_setup_device_map(adapter_t *adapter)
3442 {
3443         uint8_t         c;
3444         uint8_t         t;
3445
3446         /*
3447          * First fill the values on the logical drive channel
3448          */
3449         for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3450                 adapter->device_ids[adapter->max_channel][t] =
3451                         (t < adapter->init_id) ?  t : t - 1;
3452
3453         adapter->device_ids[adapter->max_channel][adapter->init_id] = 0xFF;
3454
3455         /*
3456          * Fill the values on the physical devices channels
3457          */
3458         for (c = 0; c < adapter->max_channel; c++)
3459                 for (t = 0; t < LSI_MAX_LOGICAL_DRIVES_64LD; t++)
3460                         adapter->device_ids[c][t] = (c << 8) | t;
3461 }
3462
3463
3464 /*
3465  * END: internal commands library
3466  */
3467
3468 /*
3469  * START: Interface for the common management module
3470  *
3471  * This is the module, which interfaces with the common mangement module to
3472  * provide support for ioctl and sysfs
3473  */
3474
3475 /**
3476  * megaraid_cmm_register - register with the mangement module
3477  * @adapter             : HBA soft state
3478  *
3479  * Register with the management module, which allows applications to issue
3480  * ioctl calls to the drivers. This interface is used by the management module
3481  * to setup sysfs support as well.
3482  */
3483 static int
3484 megaraid_cmm_register(adapter_t *adapter)
3485 {
3486         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3487         mraid_mmadp_t   adp;
3488         scb_t           *scb;
3489         mbox_ccb_t      *ccb;
3490         int             rval;
3491         int             i;
3492
3493         // Allocate memory for the base list of scb for management module.
3494         adapter->uscb_list = kcalloc(MBOX_MAX_USER_CMDS, sizeof(scb_t), GFP_KERNEL);
3495
3496         if (adapter->uscb_list == NULL) {
3497                 con_log(CL_ANN, (KERN_WARNING
3498                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
3499                         __LINE__));
3500                 return -1;
3501         }
3502
3503
3504         // Initialize the synchronization parameters for resources for
3505         // commands for management module
3506         INIT_LIST_HEAD(&adapter->uscb_pool);
3507
3508         spin_lock_init(USER_FREE_LIST_LOCK(adapter));
3509
3510
3511
3512         // link all the packets. Note, CCB for commands, coming from the
3513         // commom management module, mailbox physical address are already
3514         // setup by it. We just need placeholder for that in our local command
3515         // control blocks
3516         for (i = 0; i < MBOX_MAX_USER_CMDS; i++) {
3517
3518                 scb                     = adapter->uscb_list + i;
3519                 ccb                     = raid_dev->uccb_list + i;
3520
3521                 scb->ccb                = (caddr_t)ccb;
3522                 ccb->mbox64             = raid_dev->umbox64 + i;
3523                 ccb->mbox               = &ccb->mbox64->mbox32;
3524                 ccb->raw_mbox           = (uint8_t *)ccb->mbox;
3525
3526                 scb->gp                 = 0;
3527
3528                 // COMMAND ID 0 - (MBOX_MAX_SCSI_CMDS-1) ARE RESERVED FOR
3529                 // COMMANDS COMING FROM IO SUBSYSTEM (MID-LAYER)
3530                 scb->sno                = i + MBOX_MAX_SCSI_CMDS;
3531
3532                 scb->scp                = NULL;
3533                 scb->state              = SCB_FREE;
3534                 scb->dma_direction      = PCI_DMA_NONE;
3535                 scb->dma_type           = MRAID_DMA_NONE;
3536                 scb->dev_channel        = -1;
3537                 scb->dev_target         = -1;
3538
3539                 // put scb in the free pool
3540                 list_add_tail(&scb->list, &adapter->uscb_pool);
3541         }
3542
3543         adp.unique_id           = adapter->unique_id;
3544         adp.drvr_type           = DRVRTYPE_MBOX;
3545         adp.drvr_data           = (unsigned long)adapter;
3546         adp.pdev                = adapter->pdev;
3547         adp.issue_uioc          = megaraid_mbox_mm_handler;
3548         adp.timeout             = MBOX_RESET_WAIT + MBOX_RESET_EXT_WAIT;
3549         adp.max_kioc            = MBOX_MAX_USER_CMDS;
3550
3551         if ((rval = mraid_mm_register_adp(&adp)) != 0) {
3552
3553                 con_log(CL_ANN, (KERN_WARNING
3554                         "megaraid mbox: did not register with CMM\n"));
3555
3556                 kfree(adapter->uscb_list);
3557         }
3558
3559         return rval;
3560 }
3561
3562
3563 /**
3564  * megaraid_cmm_unregister - un-register with the mangement module
3565  * @adapter             : HBA soft state
3566  *
3567  * Un-register with the management module.
3568  * FIXME: mgmt module must return failure for unregister if it has pending
3569  * commands in LLD.
3570  */
3571 static int
3572 megaraid_cmm_unregister(adapter_t *adapter)
3573 {
3574         kfree(adapter->uscb_list);
3575         mraid_mm_unregister_adp(adapter->unique_id);
3576         return 0;
3577 }
3578
3579
3580 /**
3581  * megaraid_mbox_mm_handler - interface for CMM to issue commands to LLD
3582  * @drvr_data           : LLD specific data
3583  * @kioc                : CMM interface packet
3584  * @action              : command action
3585  *
3586  * This routine is invoked whenever the Common Mangement Module (CMM) has a
3587  * command for us. The 'action' parameter specifies if this is a new command
3588  * or otherwise.
3589  */
3590 static int
3591 megaraid_mbox_mm_handler(unsigned long drvr_data, uioc_t *kioc, uint32_t action)
3592 {
3593         adapter_t *adapter;
3594
3595         if (action != IOCTL_ISSUE) {
3596                 con_log(CL_ANN, (KERN_WARNING
3597                         "megaraid: unsupported management action:%#2x\n",
3598                         action));
3599                 return (-ENOTSUPP);
3600         }
3601
3602         adapter = (adapter_t *)drvr_data;
3603
3604         // make sure this adapter is not being detached right now.
3605         if (atomic_read(&adapter->being_detached)) {
3606                 con_log(CL_ANN, (KERN_WARNING
3607                         "megaraid: reject management request, detaching\n"));
3608                 return (-ENODEV);
3609         }
3610
3611         switch (kioc->opcode) {
3612
3613         case GET_ADAP_INFO:
3614
3615                 kioc->status =  gather_hbainfo(adapter, (mraid_hba_info_t *)
3616                                         (unsigned long)kioc->buf_vaddr);
3617
3618                 kioc->done(kioc);
3619
3620                 return kioc->status;
3621
3622         case MBOX_CMD:
3623
3624                 return megaraid_mbox_mm_command(adapter, kioc);
3625
3626         default:
3627                 kioc->status = (-EINVAL);
3628                 kioc->done(kioc);
3629                 return (-EINVAL);
3630         }
3631
3632         return 0;       // not reached
3633 }
3634
3635 /**
3636  * megaraid_mbox_mm_command - issues commands routed through CMM
3637  * @adapter             : HBA soft state
3638  * @kioc                : management command packet
3639  *
3640  * Issues commands, which are routed through the management module.
3641  */
3642 static int
3643 megaraid_mbox_mm_command(adapter_t *adapter, uioc_t *kioc)
3644 {
3645         struct list_head        *head = &adapter->uscb_pool;
3646         mbox64_t                *mbox64;
3647         uint8_t                 *raw_mbox;
3648         scb_t                   *scb;
3649         mbox_ccb_t              *ccb;
3650         unsigned long           flags;
3651
3652         // detach one scb from free pool
3653         spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3654
3655         if (list_empty(head)) { // should never happen because of CMM
3656
3657                 con_log(CL_ANN, (KERN_WARNING
3658                         "megaraid mbox: bug in cmm handler, lost resources\n"));
3659
3660                 spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3661
3662                 return (-EINVAL);
3663         }
3664
3665         scb = list_entry(head->next, scb_t, list);
3666         list_del_init(&scb->list);
3667
3668         spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3669
3670         scb->state              = SCB_ACTIVE;
3671         scb->dma_type           = MRAID_DMA_NONE;
3672         scb->dma_direction      = PCI_DMA_NONE;
3673
3674         ccb             = (mbox_ccb_t *)scb->ccb;
3675         mbox64          = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3676         raw_mbox        = (uint8_t *)&mbox64->mbox32;
3677
3678         memcpy(ccb->mbox64, mbox64, sizeof(mbox64_t));
3679
3680         scb->gp         = (unsigned long)kioc;
3681
3682         /*
3683          * If it is a logdrv random delete operation, we have to wait till
3684          * there are no outstanding cmds at the fw and then issue it directly
3685          */
3686         if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3687
3688                 if (wait_till_fw_empty(adapter)) {
3689                         con_log(CL_ANN, (KERN_NOTICE
3690                                 "megaraid mbox: LD delete, timed out\n"));
3691
3692                         kioc->status = -ETIME;
3693
3694                         scb->status = -1;
3695
3696                         megaraid_mbox_mm_done(adapter, scb);
3697
3698                         return (-ETIME);
3699                 }
3700
3701                 INIT_LIST_HEAD(&scb->list);
3702
3703                 scb->state = SCB_ISSUED;
3704                 if (mbox_post_cmd(adapter, scb) != 0) {
3705
3706                         con_log(CL_ANN, (KERN_NOTICE
3707                                 "megaraid mbox: LD delete, mailbox busy\n"));
3708
3709                         kioc->status = -EBUSY;
3710
3711                         scb->status = -1;
3712
3713                         megaraid_mbox_mm_done(adapter, scb);
3714
3715                         return (-EBUSY);
3716                 }
3717
3718                 return 0;
3719         }
3720
3721         // put the command on the pending list and execute
3722         megaraid_mbox_runpendq(adapter, scb);
3723
3724         return 0;
3725 }
3726
3727
3728 static int
3729 wait_till_fw_empty(adapter_t *adapter)
3730 {
3731         unsigned long   flags = 0;
3732         int             i;
3733
3734
3735         /*
3736          * Set the quiescent flag to stop issuing cmds to FW.
3737          */
3738         spin_lock_irqsave(&adapter->lock, flags);
3739         adapter->quiescent++;
3740         spin_unlock_irqrestore(&adapter->lock, flags);
3741
3742         /*
3743          * Wait till there are no more cmds outstanding at FW. Try for at most
3744          * 60 seconds
3745          */
3746         for (i = 0; i < 60 && adapter->outstanding_cmds; i++) {
3747                 con_log(CL_DLEVEL1, (KERN_INFO
3748                         "megaraid: FW has %d pending commands\n",
3749                         adapter->outstanding_cmds));
3750
3751                 msleep(1000);
3752         }
3753
3754         return adapter->outstanding_cmds;
3755 }
3756
3757
3758 /**
3759  * megaraid_mbox_mm_done - callback for CMM commands
3760  * @adapter     : HBA soft state
3761  * @scb         : completed command
3762  *
3763  * Callback routine for internal commands originated from the management
3764  * module.
3765  */
3766 static void
3767 megaraid_mbox_mm_done(adapter_t *adapter, scb_t *scb)
3768 {
3769         uioc_t                  *kioc;
3770         mbox64_t                *mbox64;
3771         uint8_t                 *raw_mbox;
3772         unsigned long           flags;
3773
3774         kioc                    = (uioc_t *)scb->gp;
3775         mbox64                  = (mbox64_t *)(unsigned long)kioc->cmdbuf;
3776         mbox64->mbox32.status   = scb->status;
3777         raw_mbox                = (uint8_t *)&mbox64->mbox32;
3778
3779
3780         // put scb in the free pool
3781         scb->state      = SCB_FREE;
3782         scb->scp        = NULL;
3783
3784         spin_lock_irqsave(USER_FREE_LIST_LOCK(adapter), flags);
3785
3786         list_add(&scb->list, &adapter->uscb_pool);
3787
3788         spin_unlock_irqrestore(USER_FREE_LIST_LOCK(adapter), flags);
3789
3790         // if a delete logical drive operation succeeded, restart the
3791         // controller
3792         if (raw_mbox[0] == FC_DEL_LOGDRV && raw_mbox[2] == OP_DEL_LOGDRV) {
3793
3794                 adapter->quiescent--;
3795
3796                 megaraid_mbox_runpendq(adapter, NULL);
3797         }
3798
3799         kioc->done(kioc);
3800
3801         return;
3802 }
3803
3804
3805 /**
3806  * gather_hbainfo - HBA characteristics for the applications
3807  * @adapter             : HBA soft state
3808  * @hinfo               : pointer to the caller's host info strucuture
3809  */
3810 static int
3811 gather_hbainfo(adapter_t *adapter, mraid_hba_info_t *hinfo)
3812 {
3813         uint8_t dmajor;
3814
3815         dmajor                  = megaraid_mbox_version[0];
3816
3817         hinfo->pci_vendor_id    = adapter->pdev->vendor;
3818         hinfo->pci_device_id    = adapter->pdev->device;
3819         hinfo->subsys_vendor_id = adapter->pdev->subsystem_vendor;
3820         hinfo->subsys_device_id = adapter->pdev->subsystem_device;
3821
3822         hinfo->pci_bus          = adapter->pdev->bus->number;
3823         hinfo->pci_dev_fn       = adapter->pdev->devfn;
3824         hinfo->pci_slot         = PCI_SLOT(adapter->pdev->devfn);
3825         hinfo->irq              = adapter->host->irq;
3826         hinfo->baseport         = ADAP2RAIDDEV(adapter)->baseport;
3827
3828         hinfo->unique_id        = (hinfo->pci_bus << 8) | adapter->pdev->devfn;
3829         hinfo->host_no          = adapter->host->host_no;
3830
3831         return 0;
3832 }
3833
3834 /*
3835  * END: Interface for the common management module
3836  */
3837
3838
3839
3840 /**
3841  * megaraid_sysfs_alloc_resources - allocate sysfs related resources
3842  * @adapter     : controller's soft state
3843  *
3844  * Allocate packets required to issue FW calls whenever the sysfs attributes
3845  * are read. These attributes would require up-to-date information from the
3846  * FW. Also set up resources for mutual exclusion to share these resources and
3847  * the wait queue.
3848  *
3849  * Return 0 on success.
3850  * Return -ERROR_CODE on failure.
3851  */
3852 static int
3853 megaraid_sysfs_alloc_resources(adapter_t *adapter)
3854 {
3855         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3856         int             rval = 0;
3857
3858         raid_dev->sysfs_uioc = kmalloc(sizeof(uioc_t), GFP_KERNEL);
3859
3860         raid_dev->sysfs_mbox64 = kmalloc(sizeof(mbox64_t), GFP_KERNEL);
3861
3862         raid_dev->sysfs_buffer = pci_alloc_consistent(adapter->pdev,
3863                         PAGE_SIZE, &raid_dev->sysfs_buffer_dma);
3864
3865         if (!raid_dev->sysfs_uioc || !raid_dev->sysfs_mbox64 ||
3866                 !raid_dev->sysfs_buffer) {
3867
3868                 con_log(CL_ANN, (KERN_WARNING
3869                         "megaraid: out of memory, %s %d\n", __FUNCTION__,
3870                         __LINE__));
3871
3872                 rval = -ENOMEM;
3873
3874                 megaraid_sysfs_free_resources(adapter);
3875         }
3876
3877         mutex_init(&raid_dev->sysfs_mtx);
3878
3879         init_waitqueue_head(&raid_dev->sysfs_wait_q);
3880
3881         return rval;
3882 }
3883
3884
3885 /**
3886  * megaraid_sysfs_free_resources - free sysfs related resources
3887  * @adapter     : controller's soft state
3888  *
3889  * Free packets allocated for sysfs FW commands
3890  */
3891 static void
3892 megaraid_sysfs_free_resources(adapter_t *adapter)
3893 {
3894         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3895
3896         kfree(raid_dev->sysfs_uioc);
3897         kfree(raid_dev->sysfs_mbox64);
3898
3899         if (raid_dev->sysfs_buffer) {
3900                 pci_free_consistent(adapter->pdev, PAGE_SIZE,
3901                         raid_dev->sysfs_buffer, raid_dev->sysfs_buffer_dma);
3902         }
3903 }
3904
3905
3906 /**
3907  * megaraid_sysfs_get_ldmap_done - callback for get ldmap
3908  * @uioc        : completed packet
3909  *
3910  * Callback routine called in the ISR/tasklet context for get ldmap call
3911  */
3912 static void
3913 megaraid_sysfs_get_ldmap_done(uioc_t *uioc)
3914 {
3915         adapter_t       *adapter = (adapter_t *)uioc->buf_vaddr;
3916         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3917
3918         uioc->status = 0;
3919
3920         wake_up(&raid_dev->sysfs_wait_q);
3921 }
3922
3923
3924 /**
3925  * megaraid_sysfs_get_ldmap_timeout - timeout handling for get ldmap
3926  * @data        : timed out packet
3927  *
3928  * Timeout routine to recover and return to application, in case the adapter
3929  * has stopped responding. A timeout of 60 seconds for this command seems like
3930  * a good value.
3931  */
3932 static void
3933 megaraid_sysfs_get_ldmap_timeout(unsigned long data)
3934 {
3935         uioc_t          *uioc = (uioc_t *)data;
3936         adapter_t       *adapter = (adapter_t *)uioc->buf_vaddr;
3937         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
3938
3939         uioc->status = -ETIME;
3940
3941         wake_up(&raid_dev->sysfs_wait_q);
3942 }
3943
3944
3945 /**
3946  * megaraid_sysfs_get_ldmap - get update logical drive map
3947  * @adapter     : controller's soft state
3948  *
3949  * This routine will be called whenever user reads the logical drive
3950  * attributes, go get the current logical drive mapping table from the
3951  * firmware. We use the managment API's to issue commands to the controller.
3952  *
3953  * NOTE: The commands issuance functionality is not generalized and
3954  * implemented in context of "get ld map" command only. If required, the
3955  * command issuance logical can be trivially pulled out and implemented as a
3956  * standalone libary. For now, this should suffice since there is no other
3957  * user of this interface.
3958  *
3959  * Return 0 on success.
3960  * Return -1 on failure.
3961  */
3962 static int
3963 megaraid_sysfs_get_ldmap(adapter_t *adapter)
3964 {
3965         mraid_device_t          *raid_dev = ADAP2RAIDDEV(adapter);
3966         uioc_t                  *uioc;
3967         mbox64_t                *mbox64;
3968         mbox_t                  *mbox;
3969         char                    *raw_mbox;
3970         struct timer_list       sysfs_timer;
3971         struct timer_list       *timerp;
3972         caddr_t                 ldmap;
3973         int                     rval = 0;
3974
3975         /*
3976          * Allow only one read at a time to go through the sysfs attributes
3977          */
3978         mutex_lock(&raid_dev->sysfs_mtx);
3979
3980         uioc    = raid_dev->sysfs_uioc;
3981         mbox64  = raid_dev->sysfs_mbox64;
3982         ldmap   = raid_dev->sysfs_buffer;
3983
3984         memset(uioc, 0, sizeof(uioc_t));
3985         memset(mbox64, 0, sizeof(mbox64_t));
3986         memset(ldmap, 0, sizeof(raid_dev->curr_ldmap));
3987
3988         mbox            = &mbox64->mbox32;
3989         raw_mbox        = (char *)mbox;
3990         uioc->cmdbuf    = (uint64_t)(unsigned long)mbox64;
3991         uioc->buf_vaddr = (caddr_t)adapter;
3992         uioc->status    = -ENODATA;
3993         uioc->done      = megaraid_sysfs_get_ldmap_done;
3994
3995         /*
3996          * Prepare the mailbox packet to get the current logical drive mapping
3997          * table
3998          */
3999         mbox->xferaddr = (uint32_t)raid_dev->sysfs_buffer_dma;
4000
4001         raw_mbox[0] = FC_DEL_LOGDRV;
4002         raw_mbox[2] = OP_GET_LDID_MAP;
4003
4004         /*
4005          * Setup a timer to recover from a non-responding controller
4006          */
4007         timerp  = &sysfs_timer;
4008         init_timer(timerp);
4009
4010         timerp->function        = megaraid_sysfs_get_ldmap_timeout;
4011         timerp->data            = (unsigned long)uioc;
4012         timerp->expires         = jiffies + 60 * HZ;
4013
4014         add_timer(timerp);
4015
4016         /*
4017          * Send the command to the firmware
4018          */
4019         rval = megaraid_mbox_mm_command(adapter, uioc);
4020
4021         if (rval == 0) {        // command successfully issued
4022                 wait_event(raid_dev->sysfs_wait_q, (uioc->status != -ENODATA));
4023
4024                 /*
4025                  * Check if the command timed out
4026                  */
4027                 if (uioc->status == -ETIME) {
4028                         con_log(CL_ANN, (KERN_NOTICE
4029                                 "megaraid: sysfs get ld map timed out\n"));
4030
4031                         rval = -ETIME;
4032                 }
4033                 else {
4034                         rval = mbox->status;
4035                 }
4036
4037                 if (rval == 0) {
4038                         memcpy(raid_dev->curr_ldmap, ldmap,
4039                                 sizeof(raid_dev->curr_ldmap));
4040                 }
4041                 else {
4042                         con_log(CL_ANN, (KERN_NOTICE
4043                                 "megaraid: get ld map failed with %x\n", rval));
4044                 }
4045         }
4046         else {
4047                 con_log(CL_ANN, (KERN_NOTICE
4048                         "megaraid: could not issue ldmap command:%x\n", rval));
4049         }
4050
4051
4052         del_timer_sync(timerp);
4053
4054         mutex_unlock(&raid_dev->sysfs_mtx);
4055
4056         return rval;
4057 }
4058
4059
4060 /**
4061  * megaraid_sysfs_show_app_hndl - display application handle for this adapter
4062  * @cdev        : class device object representation for the host
4063  * @buf         : buffer to send data to
4064  *
4065  * Display the handle used by the applications while executing management
4066  * tasks on the adapter. We invoke a management module API to get the adapter
4067  * handle, since we do not interface with applications directly.
4068  */
4069 static ssize_t
4070 megaraid_sysfs_show_app_hndl(struct class_device *cdev, char *buf)
4071 {
4072         struct Scsi_Host *shost = class_to_shost(cdev);
4073         adapter_t       *adapter = (adapter_t *)SCSIHOST2ADAP(shost);
4074         uint32_t        app_hndl;
4075
4076         app_hndl = mraid_mm_adapter_app_handle(adapter->unique_id);
4077
4078         return snprintf(buf, 8, "%u\n", app_hndl);
4079 }
4080
4081
4082 /**
4083  * megaraid_sysfs_show_ldnum - display the logical drive number for this device
4084  * @dev         : device object representation for the scsi device
4085  * @attr        : device attribute to show
4086  * @buf         : buffer to send data to
4087  *
4088  * Display the logical drive number for the device in question, if it a valid
4089  * logical drive. For physical devices, "-1" is returned.
4090  *
4091  * The logical drive number is displayed in following format:
4092  *
4093  * <SCSI ID> <LD NUM> <LD STICKY ID> <APP ADAPTER HANDLE>
4094  *
4095  *   <int>     <int>       <int>            <int>
4096  */
4097 static ssize_t
4098 megaraid_sysfs_show_ldnum(struct device *dev, struct device_attribute *attr, char *buf)
4099 {
4100         struct scsi_device *sdev = to_scsi_device(dev);
4101         adapter_t       *adapter = (adapter_t *)SCSIHOST2ADAP(sdev->host);
4102         mraid_device_t  *raid_dev = ADAP2RAIDDEV(adapter);
4103         int             scsi_id = -1;
4104         int             logical_drv = -1;
4105         int             ldid_map = -1;
4106         uint32_t        app_hndl = 0;
4107         int             mapped_sdev_id;
4108         int             rval;
4109         int             i;
4110
4111         if (raid_dev->random_del_supported &&
4112                         MRAID_IS_LOGICAL_SDEV(adapter, sdev)) {
4113
4114                 rval = megaraid_sysfs_get_ldmap(adapter);
4115                 if (rval == 0) {
4116
4117                         for (i = 0; i < MAX_LOGICAL_DRIVES_40LD; i++) {
4118
4119                                 mapped_sdev_id = sdev->id;
4120
4121                                 if (sdev->id > adapter->init_id) {
4122                                         mapped_sdev_id -= 1;
4123                                 }
4124
4125                                 if (raid_dev->curr_ldmap[i] == mapped_sdev_id) {
4126
4127                                         scsi_id = sdev->id;
4128
4129                                         logical_drv = i;
4130
4131                                         ldid_map = raid_dev->curr_ldmap[i];
4132
4133                                         app_hndl = mraid_mm_adapter_app_handle(
4134                                                         adapter->unique_id);
4135
4136                                         break;
4137                                 }
4138                         }
4139                 }
4140                 else {
4141                         con_log(CL_ANN, (KERN_NOTICE
4142                                 "megaraid: sysfs get ld map failed: %x\n",
4143                                 rval));
4144                 }
4145         }
4146
4147         return snprintf(buf, 36, "%d %d %d %d\n", scsi_id, logical_drv,
4148                         ldid_map, app_hndl);
4149 }
4150
4151
4152 /*
4153  * END: Mailbox Low Level Driver
4154  */
4155 module_init(megaraid_init);
4156 module_exit(megaraid_exit);
4157
4158 /* vim: set ts=8 sw=8 tw=78 ai si: */