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