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