xref: /openbmc/linux/drivers/scsi/isci/init.c (revision 2fa5ebe3)
1 /*
2  * This file is provided under a dual BSD/GPLv2 license.  When using or
3  * redistributing this file, you may do so under either license.
4  *
5  * GPL LICENSE SUMMARY
6  *
7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21  * The full GNU General Public License is included in this distribution
22  * in the file called LICENSE.GPL.
23  *
24  * BSD LICENSE
25  *
26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27  * All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  *
33  *   * Redistributions of source code must retain the above copyright
34  *     notice, this list of conditions and the following disclaimer.
35  *   * Redistributions in binary form must reproduce the above copyright
36  *     notice, this list of conditions and the following disclaimer in
37  *     the documentation and/or other materials provided with the
38  *     distribution.
39  *   * Neither the name of Intel Corporation nor the names of its
40  *     contributors may be used to endorse or promote products derived
41  *     from this software without specific prior written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54  */
55 
56 #include <linux/kernel.h>
57 #include <linux/init.h>
58 #include <linux/module.h>
59 #include <linux/firmware.h>
60 #include <linux/efi.h>
61 #include <asm/string.h>
62 #include <scsi/scsi_host.h>
63 #include "host.h"
64 #include "isci.h"
65 #include "task.h"
66 #include "probe_roms.h"
67 
68 #define MAJ 1
69 #define MIN 2
70 #define BUILD 0
71 #define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
72 	__stringify(BUILD)
73 
74 MODULE_VERSION(DRV_VERSION);
75 
76 static struct scsi_transport_template *isci_transport_template;
77 
78 static const struct pci_device_id isci_id_table[] = {
79 	{ PCI_VDEVICE(INTEL, 0x1D61),},
80 	{ PCI_VDEVICE(INTEL, 0x1D63),},
81 	{ PCI_VDEVICE(INTEL, 0x1D65),},
82 	{ PCI_VDEVICE(INTEL, 0x1D67),},
83 	{ PCI_VDEVICE(INTEL, 0x1D69),},
84 	{ PCI_VDEVICE(INTEL, 0x1D6B),},
85 	{ PCI_VDEVICE(INTEL, 0x1D60),},
86 	{ PCI_VDEVICE(INTEL, 0x1D62),},
87 	{ PCI_VDEVICE(INTEL, 0x1D64),},
88 	{ PCI_VDEVICE(INTEL, 0x1D66),},
89 	{ PCI_VDEVICE(INTEL, 0x1D68),},
90 	{ PCI_VDEVICE(INTEL, 0x1D6A),},
91 	{}
92 };
93 
94 MODULE_DEVICE_TABLE(pci, isci_id_table);
95 
96 /* linux isci specific settings */
97 
98 unsigned char no_outbound_task_to = 2;
99 module_param(no_outbound_task_to, byte, 0);
100 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
101 
102 u16 ssp_max_occ_to = 20;
103 module_param(ssp_max_occ_to, ushort, 0);
104 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
105 
106 u16 stp_max_occ_to = 5;
107 module_param(stp_max_occ_to, ushort, 0);
108 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
109 
110 u16 ssp_inactive_to = 5;
111 module_param(ssp_inactive_to, ushort, 0);
112 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
113 
114 u16 stp_inactive_to = 5;
115 module_param(stp_inactive_to, ushort, 0);
116 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
117 
118 unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
119 module_param(phy_gen, byte, 0);
120 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
121 
122 unsigned char max_concurr_spinup;
123 module_param(max_concurr_spinup, byte, 0);
124 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
125 
126 uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
127 module_param(cable_selection_override, uint, 0);
128 
129 MODULE_PARM_DESC(cable_selection_override,
130 		 "This field indicates length of the SAS/SATA cable between "
131 		 "host and device. If any bits > 15 are set (default) "
132 		 "indicates \"use platform defaults\"");
133 
134 static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
135 {
136 	struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
137 	struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
138 	struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
139 
140 	return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
141 }
142 
143 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
144 
145 static struct attribute *isci_host_attrs[] = {
146 	&dev_attr_isci_id.attr,
147 	NULL
148 };
149 
150 ATTRIBUTE_GROUPS(isci_host);
151 
152 static struct scsi_host_template isci_sht = {
153 
154 	.module				= THIS_MODULE,
155 	.name				= DRV_NAME,
156 	.proc_name			= DRV_NAME,
157 	.queuecommand			= sas_queuecommand,
158 	.dma_need_drain			= ata_scsi_dma_need_drain,
159 	.target_alloc			= sas_target_alloc,
160 	.slave_configure		= sas_slave_configure,
161 	.scan_finished			= isci_host_scan_finished,
162 	.scan_start			= isci_host_start,
163 	.change_queue_depth		= sas_change_queue_depth,
164 	.bios_param			= sas_bios_param,
165 	.can_queue			= ISCI_CAN_QUEUE_VAL,
166 	.this_id			= -1,
167 	.sg_tablesize			= SG_ALL,
168 	.max_sectors			= SCSI_DEFAULT_MAX_SECTORS,
169 	.eh_abort_handler		= sas_eh_abort_handler,
170 	.eh_device_reset_handler        = sas_eh_device_reset_handler,
171 	.eh_target_reset_handler        = sas_eh_target_reset_handler,
172 	.slave_alloc			= sas_slave_alloc,
173 	.target_destroy			= sas_target_destroy,
174 	.ioctl				= sas_ioctl,
175 #ifdef CONFIG_COMPAT
176 	.compat_ioctl			= sas_ioctl,
177 #endif
178 	.shost_groups			= isci_host_groups,
179 	.track_queue_depth		= 1,
180 };
181 
182 static struct sas_domain_function_template isci_transport_ops  = {
183 
184 	/* The class calls these to notify the LLDD of an event. */
185 	.lldd_port_formed	= isci_port_formed,
186 	.lldd_port_deformed	= isci_port_deformed,
187 
188 	/* The class calls these when a device is found or gone. */
189 	.lldd_dev_found		= isci_remote_device_found,
190 	.lldd_dev_gone		= isci_remote_device_gone,
191 
192 	.lldd_execute_task	= isci_task_execute_task,
193 	/* Task Management Functions. Must be called from process context. */
194 	.lldd_abort_task	= isci_task_abort_task,
195 	.lldd_abort_task_set	= isci_task_abort_task_set,
196 	.lldd_clear_task_set	= isci_task_clear_task_set,
197 	.lldd_I_T_nexus_reset	= isci_task_I_T_nexus_reset,
198 	.lldd_lu_reset		= isci_task_lu_reset,
199 	.lldd_query_task	= isci_task_query_task,
200 
201 	/* ata recovery called from ata-eh */
202 	.lldd_ata_check_ready	= isci_ata_check_ready,
203 
204 	/* Port and Adapter management */
205 	.lldd_clear_nexus_port	= isci_task_clear_nexus_port,
206 	.lldd_clear_nexus_ha	= isci_task_clear_nexus_ha,
207 
208 	/* Phy management */
209 	.lldd_control_phy	= isci_phy_control,
210 
211 	/* GPIO support */
212 	.lldd_write_gpio	= isci_gpio_write,
213 };
214 
215 
216 /******************************************************************************
217 * P R O T E C T E D  M E T H O D S
218 ******************************************************************************/
219 
220 
221 
222 /**
223  * isci_register_sas_ha() - This method initializes various lldd
224  *    specific members of the sas_ha struct and calls the libsas
225  *    sas_register_ha() function.
226  * @isci_host: This parameter specifies the lldd specific wrapper for the
227  *    libsas sas_ha struct.
228  *
229  * This method returns an error code indicating success or failure. The user
230  * should check for possible memory allocation error return otherwise, a zero
231  * indicates success.
232  */
233 static int isci_register_sas_ha(struct isci_host *isci_host)
234 {
235 	int i;
236 	struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
237 	struct asd_sas_phy **sas_phys;
238 	struct asd_sas_port **sas_ports;
239 
240 	sas_phys = devm_kcalloc(&isci_host->pdev->dev,
241 				SCI_MAX_PHYS, sizeof(void *),
242 				GFP_KERNEL);
243 	if (!sas_phys)
244 		return -ENOMEM;
245 
246 	sas_ports = devm_kcalloc(&isci_host->pdev->dev,
247 				 SCI_MAX_PORTS, sizeof(void *),
248 				 GFP_KERNEL);
249 	if (!sas_ports)
250 		return -ENOMEM;
251 
252 	sas_ha->sas_ha_name = DRV_NAME;
253 	sas_ha->lldd_module = THIS_MODULE;
254 	sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
255 
256 	for (i = 0; i < SCI_MAX_PHYS; i++) {
257 		sas_phys[i] = &isci_host->phys[i].sas_phy;
258 		sas_ports[i] = &isci_host->sas_ports[i];
259 	}
260 
261 	sas_ha->sas_phy  = sas_phys;
262 	sas_ha->sas_port = sas_ports;
263 	sas_ha->num_phys = SCI_MAX_PHYS;
264 
265 	sas_ha->strict_wide_ports = 1;
266 
267 	sas_register_ha(sas_ha);
268 
269 	return 0;
270 }
271 
272 static void isci_unregister(struct isci_host *isci_host)
273 {
274 	struct Scsi_Host *shost;
275 
276 	if (!isci_host)
277 		return;
278 
279 	shost = to_shost(isci_host);
280 	sas_unregister_ha(&isci_host->sas_ha);
281 
282 	sas_remove_host(shost);
283 	scsi_host_put(shost);
284 }
285 
286 static int isci_pci_init(struct pci_dev *pdev)
287 {
288 	int err, bar_num, bar_mask = 0;
289 	void __iomem * const *iomap;
290 
291 	err = pcim_enable_device(pdev);
292 	if (err) {
293 		dev_err(&pdev->dev,
294 			"failed enable PCI device %s!\n",
295 			pci_name(pdev));
296 		return err;
297 	}
298 
299 	for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
300 		bar_mask |= 1 << (bar_num * 2);
301 
302 	err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
303 	if (err)
304 		return err;
305 
306 	iomap = pcim_iomap_table(pdev);
307 	if (!iomap)
308 		return -ENOMEM;
309 
310 	pci_set_master(pdev);
311 
312 	err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
313 	if (err)
314 		err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
315 	return err;
316 }
317 
318 static int num_controllers(struct pci_dev *pdev)
319 {
320 	/* bar size alone can tell us if we are running with a dual controller
321 	 * part, no need to trust revision ids that might be under broken firmware
322 	 * control
323 	 */
324 	resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
325 	resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
326 
327 	if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
328 	    smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
329 		return SCI_MAX_CONTROLLERS;
330 	else
331 		return 1;
332 }
333 
334 static int isci_setup_interrupts(struct pci_dev *pdev)
335 {
336 	int err, i, num_msix;
337 	struct isci_host *ihost;
338 	struct isci_pci_info *pci_info = to_pci_info(pdev);
339 
340 	/*
341 	 *  Determine the number of vectors associated with this
342 	 *  PCI function.
343 	 */
344 	num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
345 
346 	err = pci_alloc_irq_vectors(pdev, num_msix, num_msix, PCI_IRQ_MSIX);
347 	if (err < 0)
348 		goto intx;
349 
350 	for (i = 0; i < num_msix; i++) {
351 		int id = i / SCI_NUM_MSI_X_INT;
352 		irq_handler_t isr;
353 
354 		ihost = pci_info->hosts[id];
355 		/* odd numbered vectors are error interrupts */
356 		if (i & 1)
357 			isr = isci_error_isr;
358 		else
359 			isr = isci_msix_isr;
360 
361 		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
362 				isr, 0, DRV_NAME"-msix", ihost);
363 		if (!err)
364 			continue;
365 
366 		dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
367 		while (i--) {
368 			id = i / SCI_NUM_MSI_X_INT;
369 			ihost = pci_info->hosts[id];
370 			devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
371 					ihost);
372 		}
373 		pci_free_irq_vectors(pdev);
374 		goto intx;
375 	}
376 	return 0;
377 
378  intx:
379 	for_each_isci_host(i, ihost, pdev) {
380 		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, 0),
381 				isci_intx_isr, IRQF_SHARED, DRV_NAME"-intx",
382 				ihost);
383 		if (err)
384 			break;
385 	}
386 	return err;
387 }
388 
389 static void isci_user_parameters_get(struct sci_user_parameters *u)
390 {
391 	int i;
392 
393 	for (i = 0; i < SCI_MAX_PHYS; i++) {
394 		struct sci_phy_user_params *u_phy = &u->phys[i];
395 
396 		u_phy->max_speed_generation = phy_gen;
397 
398 		/* we are not exporting these for now */
399 		u_phy->align_insertion_frequency = 0x7f;
400 		u_phy->in_connection_align_insertion_frequency = 0xff;
401 		u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
402 	}
403 
404 	u->stp_inactivity_timeout = stp_inactive_to;
405 	u->ssp_inactivity_timeout = ssp_inactive_to;
406 	u->stp_max_occupancy_timeout = stp_max_occ_to;
407 	u->ssp_max_occupancy_timeout = ssp_max_occ_to;
408 	u->no_outbound_task_timeout = no_outbound_task_to;
409 	u->max_concurr_spinup = max_concurr_spinup;
410 }
411 
412 static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
413 					       struct sci_user_parameters *sci_parms)
414 {
415 	u16 index;
416 
417 	/*
418 	 * Validate the user parameters.  If they are not legal, then
419 	 * return a failure.
420 	 */
421 	for (index = 0; index < SCI_MAX_PHYS; index++) {
422 		struct sci_phy_user_params *u;
423 
424 		u = &sci_parms->phys[index];
425 
426 		if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
427 		      (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
428 			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
429 
430 		if ((u->in_connection_align_insertion_frequency < 3) ||
431 		    (u->align_insertion_frequency == 0) ||
432 		    (u->notify_enable_spin_up_insertion_frequency == 0))
433 			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
434 	}
435 
436 	if ((sci_parms->stp_inactivity_timeout == 0) ||
437 	    (sci_parms->ssp_inactivity_timeout == 0) ||
438 	    (sci_parms->stp_max_occupancy_timeout == 0) ||
439 	    (sci_parms->ssp_max_occupancy_timeout == 0) ||
440 	    (sci_parms->no_outbound_task_timeout == 0))
441 		return SCI_FAILURE_INVALID_PARAMETER_VALUE;
442 
443 	memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
444 
445 	return SCI_SUCCESS;
446 }
447 
448 static void sci_oem_defaults(struct isci_host *ihost)
449 {
450 	/* these defaults are overridden by the platform / firmware */
451 	struct sci_user_parameters *user = &ihost->user_parameters;
452 	struct sci_oem_params *oem = &ihost->oem_parameters;
453 	int i;
454 
455 	/* Default to APC mode. */
456 	oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
457 
458 	/* Default to APC mode. */
459 	oem->controller.max_concurr_spin_up = 1;
460 
461 	/* Default to no SSC operation. */
462 	oem->controller.do_enable_ssc = false;
463 
464 	/* Default to short cables on all phys. */
465 	oem->controller.cable_selection_mask = 0;
466 
467 	/* Initialize all of the port parameter information to narrow ports. */
468 	for (i = 0; i < SCI_MAX_PORTS; i++)
469 		oem->ports[i].phy_mask = 0;
470 
471 	/* Initialize all of the phy parameter information. */
472 	for (i = 0; i < SCI_MAX_PHYS; i++) {
473 		/* Default to 3G (i.e. Gen 2). */
474 		user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
475 
476 		/* the frequencies cannot be 0 */
477 		user->phys[i].align_insertion_frequency = 0x7f;
478 		user->phys[i].in_connection_align_insertion_frequency = 0xff;
479 		user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
480 
481 		/* Previous Vitesse based expanders had a arbitration issue that
482 		 * is worked around by having the upper 32-bits of SAS address
483 		 * with a value greater then the Vitesse company identifier.
484 		 * Hence, usage of 0x5FCFFFFF.
485 		 */
486 		oem->phys[i].sas_address.low = 0x1 + ihost->id;
487 		oem->phys[i].sas_address.high = 0x5FCFFFFF;
488 	}
489 
490 	user->stp_inactivity_timeout = 5;
491 	user->ssp_inactivity_timeout = 5;
492 	user->stp_max_occupancy_timeout = 5;
493 	user->ssp_max_occupancy_timeout = 20;
494 	user->no_outbound_task_timeout = 2;
495 }
496 
497 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
498 {
499 	struct isci_orom *orom = to_pci_info(pdev)->orom;
500 	struct sci_user_parameters sci_user_params;
501 	u8 oem_version = ISCI_ROM_VER_1_0;
502 	struct isci_host *ihost;
503 	struct Scsi_Host *shost;
504 	int err, i;
505 
506 	ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
507 	if (!ihost)
508 		return NULL;
509 
510 	ihost->pdev = pdev;
511 	ihost->id = id;
512 	spin_lock_init(&ihost->scic_lock);
513 	init_waitqueue_head(&ihost->eventq);
514 	ihost->sas_ha.dev = &ihost->pdev->dev;
515 	ihost->sas_ha.lldd_ha = ihost;
516 	tasklet_init(&ihost->completion_tasklet,
517 		     isci_host_completion_routine, (unsigned long)ihost);
518 
519 	/* validate module parameters */
520 	/* TODO: kill struct sci_user_parameters and reference directly */
521 	sci_oem_defaults(ihost);
522 	isci_user_parameters_get(&sci_user_params);
523 	if (sci_user_parameters_set(ihost, &sci_user_params)) {
524 		dev_warn(&pdev->dev,
525 			 "%s: sci_user_parameters_set failed\n", __func__);
526 		return NULL;
527 	}
528 
529 	/* sanity check platform (or 'firmware') oem parameters */
530 	if (orom) {
531 		if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
532 			dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
533 			return NULL;
534 		}
535 		ihost->oem_parameters = orom->ctrl[id];
536 		oem_version = orom->hdr.version;
537 	}
538 
539 	/* validate oem parameters (platform, firmware, or built-in defaults) */
540 	if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
541 		dev_warn(&pdev->dev, "oem parameter validation failed\n");
542 		return NULL;
543 	}
544 
545 	for (i = 0; i < SCI_MAX_PORTS; i++) {
546 		struct isci_port *iport = &ihost->ports[i];
547 
548 		INIT_LIST_HEAD(&iport->remote_dev_list);
549 		iport->isci_host = ihost;
550 	}
551 
552 	for (i = 0; i < SCI_MAX_PHYS; i++)
553 		isci_phy_init(&ihost->phys[i], ihost, i);
554 
555 	for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
556 		struct isci_remote_device *idev = &ihost->devices[i];
557 
558 		INIT_LIST_HEAD(&idev->node);
559 	}
560 
561 	shost = scsi_host_alloc(&isci_sht, sizeof(void *));
562 	if (!shost)
563 		return NULL;
564 
565 	dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
566 		 "{%s, %s, %s, %s}\n",
567 		 (is_cable_select_overridden() ? "* " : ""), ihost->id,
568 		 lookup_cable_names(decode_cable_selection(ihost, 3)),
569 		 lookup_cable_names(decode_cable_selection(ihost, 2)),
570 		 lookup_cable_names(decode_cable_selection(ihost, 1)),
571 		 lookup_cable_names(decode_cable_selection(ihost, 0)));
572 
573 	err = isci_host_init(ihost);
574 	if (err)
575 		goto err_shost;
576 
577 	SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
578 	ihost->sas_ha.core.shost = shost;
579 	shost->transportt = isci_transport_template;
580 
581 	shost->max_id = ~0;
582 	shost->max_lun = ~0;
583 	shost->max_cmd_len = MAX_COMMAND_SIZE;
584 
585 	/* turn on DIF support */
586 	scsi_host_set_prot(shost,
587 			   SHOST_DIF_TYPE1_PROTECTION |
588 			   SHOST_DIF_TYPE2_PROTECTION |
589 			   SHOST_DIF_TYPE3_PROTECTION);
590 	scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
591 
592 	err = scsi_add_host(shost, &pdev->dev);
593 	if (err)
594 		goto err_shost;
595 
596 	err = isci_register_sas_ha(ihost);
597 	if (err)
598 		goto err_shost_remove;
599 
600 	return ihost;
601 
602  err_shost_remove:
603 	scsi_remove_host(shost);
604  err_shost:
605 	scsi_host_put(shost);
606 
607 	return NULL;
608 }
609 
610 static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
611 {
612 	struct isci_pci_info *pci_info;
613 	int err, i;
614 	struct isci_host *isci_host;
615 	const struct firmware *fw = NULL;
616 	struct isci_orom *orom = NULL;
617 	char *source = "(platform)";
618 
619 	dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
620 		 pdev->revision);
621 
622 	pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
623 	if (!pci_info)
624 		return -ENOMEM;
625 	pci_set_drvdata(pdev, pci_info);
626 
627 	if (efi_rt_services_supported(EFI_RT_SUPPORTED_GET_VARIABLE))
628 		orom = isci_get_efi_var(pdev);
629 
630 	if (!orom)
631 		orom = isci_request_oprom(pdev);
632 
633 	for (i = 0; orom && i < num_controllers(pdev); i++) {
634 		if (sci_oem_parameters_validate(&orom->ctrl[i],
635 						orom->hdr.version)) {
636 			dev_warn(&pdev->dev,
637 				 "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
638 			orom = NULL;
639 			break;
640 		}
641 	}
642 
643 	if (!orom) {
644 		source = "(firmware)";
645 		orom = isci_request_firmware(pdev, fw);
646 		if (!orom) {
647 			/* TODO convert this to WARN_TAINT_ONCE once the
648 			 * orom/efi parameter support is widely available
649 			 */
650 			dev_warn(&pdev->dev,
651 				 "Loading user firmware failed, using default "
652 				 "values\n");
653 			dev_warn(&pdev->dev,
654 				 "Default OEM configuration being used: 4 "
655 				 "narrow ports, and default SAS Addresses\n");
656 		}
657 	}
658 
659 	if (orom)
660 		dev_info(&pdev->dev,
661 			 "OEM SAS parameters (version: %u.%u) loaded %s\n",
662 			 (orom->hdr.version & 0xf0) >> 4,
663 			 (orom->hdr.version & 0xf), source);
664 
665 	pci_info->orom = orom;
666 
667 	err = isci_pci_init(pdev);
668 	if (err)
669 		return err;
670 
671 	for (i = 0; i < num_controllers(pdev); i++) {
672 		struct isci_host *h = isci_host_alloc(pdev, i);
673 
674 		if (!h) {
675 			err = -ENOMEM;
676 			goto err_host_alloc;
677 		}
678 		pci_info->hosts[i] = h;
679 	}
680 
681 	err = isci_setup_interrupts(pdev);
682 	if (err)
683 		goto err_host_alloc;
684 
685 	for_each_isci_host(i, isci_host, pdev)
686 		scsi_scan_host(to_shost(isci_host));
687 
688 	return 0;
689 
690  err_host_alloc:
691 	for_each_isci_host(i, isci_host, pdev)
692 		isci_unregister(isci_host);
693 	return err;
694 }
695 
696 static void isci_pci_remove(struct pci_dev *pdev)
697 {
698 	struct isci_host *ihost;
699 	int i;
700 
701 	for_each_isci_host(i, ihost, pdev) {
702 		wait_for_start(ihost);
703 		isci_unregister(ihost);
704 		isci_host_deinit(ihost);
705 	}
706 }
707 
708 #ifdef CONFIG_PM_SLEEP
709 static int isci_suspend(struct device *dev)
710 {
711 	struct pci_dev *pdev = to_pci_dev(dev);
712 	struct isci_host *ihost;
713 	int i;
714 
715 	for_each_isci_host(i, ihost, pdev) {
716 		sas_suspend_ha(&ihost->sas_ha);
717 		isci_host_deinit(ihost);
718 	}
719 
720 	return 0;
721 }
722 
723 static int isci_resume(struct device *dev)
724 {
725 	struct pci_dev *pdev = to_pci_dev(dev);
726 	struct isci_host *ihost;
727 	int i;
728 
729 	for_each_isci_host(i, ihost, pdev) {
730 		sas_prep_resume_ha(&ihost->sas_ha);
731 
732 		isci_host_init(ihost);
733 		isci_host_start(ihost->sas_ha.core.shost);
734 		wait_for_start(ihost);
735 
736 		sas_resume_ha(&ihost->sas_ha);
737 	}
738 
739 	return 0;
740 }
741 #endif
742 
743 static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
744 
745 static struct pci_driver isci_pci_driver = {
746 	.name		= DRV_NAME,
747 	.id_table	= isci_id_table,
748 	.probe		= isci_pci_probe,
749 	.remove		= isci_pci_remove,
750 	.driver.pm      = &isci_pm_ops,
751 };
752 
753 static __init int isci_init(void)
754 {
755 	int err;
756 
757 	pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
758 		DRV_NAME, DRV_VERSION);
759 
760 	isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
761 	if (!isci_transport_template)
762 		return -ENOMEM;
763 
764 	err = pci_register_driver(&isci_pci_driver);
765 	if (err)
766 		sas_release_transport(isci_transport_template);
767 
768 	return err;
769 }
770 
771 static __exit void isci_exit(void)
772 {
773 	pci_unregister_driver(&isci_pci_driver);
774 	sas_release_transport(isci_transport_template);
775 }
776 
777 MODULE_LICENSE("Dual BSD/GPL");
778 MODULE_FIRMWARE(ISCI_FW_NAME);
779 module_init(isci_init);
780 module_exit(isci_exit);
781