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