xref: /openbmc/linux/drivers/scsi/isci/init.c (revision 7af6fbdd)
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 device_attribute *isci_host_attrs[] = {
146 	&dev_attr_isci_id,
147 	NULL
148 };
149 
150 static struct scsi_host_template isci_sht = {
151 
152 	.module				= THIS_MODULE,
153 	.name				= DRV_NAME,
154 	.proc_name			= DRV_NAME,
155 	.queuecommand			= sas_queuecommand,
156 	.dma_need_drain			= ata_scsi_dma_need_drain,
157 	.target_alloc			= sas_target_alloc,
158 	.slave_configure		= sas_slave_configure,
159 	.scan_finished			= isci_host_scan_finished,
160 	.scan_start			= isci_host_start,
161 	.change_queue_depth		= sas_change_queue_depth,
162 	.bios_param			= sas_bios_param,
163 	.can_queue			= ISCI_CAN_QUEUE_VAL,
164 	.this_id			= -1,
165 	.sg_tablesize			= SG_ALL,
166 	.max_sectors			= SCSI_DEFAULT_MAX_SECTORS,
167 	.eh_abort_handler		= sas_eh_abort_handler,
168 	.eh_device_reset_handler        = sas_eh_device_reset_handler,
169 	.eh_target_reset_handler        = sas_eh_target_reset_handler,
170 	.target_destroy			= sas_target_destroy,
171 	.ioctl				= sas_ioctl,
172 #ifdef CONFIG_COMPAT
173 	.compat_ioctl			= sas_ioctl,
174 #endif
175 	.shost_attrs			= isci_host_attrs,
176 	.track_queue_depth		= 1,
177 };
178 
179 static struct sas_domain_function_template isci_transport_ops  = {
180 
181 	/* The class calls these to notify the LLDD of an event. */
182 	.lldd_port_formed	= isci_port_formed,
183 	.lldd_port_deformed	= isci_port_deformed,
184 
185 	/* The class calls these when a device is found or gone. */
186 	.lldd_dev_found		= isci_remote_device_found,
187 	.lldd_dev_gone		= isci_remote_device_gone,
188 
189 	.lldd_execute_task	= isci_task_execute_task,
190 	/* Task Management Functions. Must be called from process context. */
191 	.lldd_abort_task	= isci_task_abort_task,
192 	.lldd_abort_task_set	= isci_task_abort_task_set,
193 	.lldd_clear_aca		= isci_task_clear_aca,
194 	.lldd_clear_task_set	= isci_task_clear_task_set,
195 	.lldd_I_T_nexus_reset	= isci_task_I_T_nexus_reset,
196 	.lldd_lu_reset		= isci_task_lu_reset,
197 	.lldd_query_task	= isci_task_query_task,
198 
199 	/* ata recovery called from ata-eh */
200 	.lldd_ata_check_ready	= isci_ata_check_ready,
201 
202 	/* Port and Adapter management */
203 	.lldd_clear_nexus_port	= isci_task_clear_nexus_port,
204 	.lldd_clear_nexus_ha	= isci_task_clear_nexus_ha,
205 
206 	/* Phy management */
207 	.lldd_control_phy	= isci_phy_control,
208 
209 	/* GPIO support */
210 	.lldd_write_gpio	= isci_gpio_write,
211 };
212 
213 
214 /******************************************************************************
215 * P R O T E C T E D  M E T H O D S
216 ******************************************************************************/
217 
218 
219 
220 /**
221  * isci_register_sas_ha() - This method initializes various lldd
222  *    specific members of the sas_ha struct and calls the libsas
223  *    sas_register_ha() function.
224  * @isci_host: This parameter specifies the lldd specific wrapper for the
225  *    libsas sas_ha struct.
226  *
227  * This method returns an error code indicating success or failure. The user
228  * should check for possible memory allocation error return otherwise, a zero
229  * indicates success.
230  */
231 static int isci_register_sas_ha(struct isci_host *isci_host)
232 {
233 	int i;
234 	struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
235 	struct asd_sas_phy **sas_phys;
236 	struct asd_sas_port **sas_ports;
237 
238 	sas_phys = devm_kcalloc(&isci_host->pdev->dev,
239 				SCI_MAX_PHYS, sizeof(void *),
240 				GFP_KERNEL);
241 	if (!sas_phys)
242 		return -ENOMEM;
243 
244 	sas_ports = devm_kcalloc(&isci_host->pdev->dev,
245 				 SCI_MAX_PORTS, sizeof(void *),
246 				 GFP_KERNEL);
247 	if (!sas_ports)
248 		return -ENOMEM;
249 
250 	sas_ha->sas_ha_name = DRV_NAME;
251 	sas_ha->lldd_module = THIS_MODULE;
252 	sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
253 
254 	for (i = 0; i < SCI_MAX_PHYS; i++) {
255 		sas_phys[i] = &isci_host->phys[i].sas_phy;
256 		sas_ports[i] = &isci_host->sas_ports[i];
257 	}
258 
259 	sas_ha->sas_phy  = sas_phys;
260 	sas_ha->sas_port = sas_ports;
261 	sas_ha->num_phys = SCI_MAX_PHYS;
262 
263 	sas_ha->strict_wide_ports = 1;
264 
265 	sas_register_ha(sas_ha);
266 
267 	return 0;
268 }
269 
270 static void isci_unregister(struct isci_host *isci_host)
271 {
272 	struct Scsi_Host *shost;
273 
274 	if (!isci_host)
275 		return;
276 
277 	shost = to_shost(isci_host);
278 	sas_unregister_ha(&isci_host->sas_ha);
279 
280 	sas_remove_host(shost);
281 	scsi_host_put(shost);
282 }
283 
284 static int isci_pci_init(struct pci_dev *pdev)
285 {
286 	int err, bar_num, bar_mask = 0;
287 	void __iomem * const *iomap;
288 
289 	err = pcim_enable_device(pdev);
290 	if (err) {
291 		dev_err(&pdev->dev,
292 			"failed enable PCI device %s!\n",
293 			pci_name(pdev));
294 		return err;
295 	}
296 
297 	for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
298 		bar_mask |= 1 << (bar_num * 2);
299 
300 	err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
301 	if (err)
302 		return err;
303 
304 	iomap = pcim_iomap_table(pdev);
305 	if (!iomap)
306 		return -ENOMEM;
307 
308 	pci_set_master(pdev);
309 
310 	err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
311 	if (err)
312 		err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
313 	return err;
314 }
315 
316 static int num_controllers(struct pci_dev *pdev)
317 {
318 	/* bar size alone can tell us if we are running with a dual controller
319 	 * part, no need to trust revision ids that might be under broken firmware
320 	 * control
321 	 */
322 	resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
323 	resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
324 
325 	if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
326 	    smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
327 		return SCI_MAX_CONTROLLERS;
328 	else
329 		return 1;
330 }
331 
332 static int isci_setup_interrupts(struct pci_dev *pdev)
333 {
334 	int err, i, num_msix;
335 	struct isci_host *ihost;
336 	struct isci_pci_info *pci_info = to_pci_info(pdev);
337 
338 	/*
339 	 *  Determine the number of vectors associated with this
340 	 *  PCI function.
341 	 */
342 	num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
343 
344 	err = pci_alloc_irq_vectors(pdev, num_msix, num_msix, PCI_IRQ_MSIX);
345 	if (err < 0)
346 		goto intx;
347 
348 	for (i = 0; i < num_msix; i++) {
349 		int id = i / SCI_NUM_MSI_X_INT;
350 		irq_handler_t isr;
351 
352 		ihost = pci_info->hosts[id];
353 		/* odd numbered vectors are error interrupts */
354 		if (i & 1)
355 			isr = isci_error_isr;
356 		else
357 			isr = isci_msix_isr;
358 
359 		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
360 				isr, 0, DRV_NAME"-msix", ihost);
361 		if (!err)
362 			continue;
363 
364 		dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
365 		while (i--) {
366 			id = i / SCI_NUM_MSI_X_INT;
367 			ihost = pci_info->hosts[id];
368 			devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
369 					ihost);
370 		}
371 		pci_free_irq_vectors(pdev);
372 		goto intx;
373 	}
374 	return 0;
375 
376  intx:
377 	for_each_isci_host(i, ihost, pdev) {
378 		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, 0),
379 				isci_intx_isr, IRQF_SHARED, DRV_NAME"-intx",
380 				ihost);
381 		if (err)
382 			break;
383 	}
384 	return err;
385 }
386 
387 static void isci_user_parameters_get(struct sci_user_parameters *u)
388 {
389 	int i;
390 
391 	for (i = 0; i < SCI_MAX_PHYS; i++) {
392 		struct sci_phy_user_params *u_phy = &u->phys[i];
393 
394 		u_phy->max_speed_generation = phy_gen;
395 
396 		/* we are not exporting these for now */
397 		u_phy->align_insertion_frequency = 0x7f;
398 		u_phy->in_connection_align_insertion_frequency = 0xff;
399 		u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
400 	}
401 
402 	u->stp_inactivity_timeout = stp_inactive_to;
403 	u->ssp_inactivity_timeout = ssp_inactive_to;
404 	u->stp_max_occupancy_timeout = stp_max_occ_to;
405 	u->ssp_max_occupancy_timeout = ssp_max_occ_to;
406 	u->no_outbound_task_timeout = no_outbound_task_to;
407 	u->max_concurr_spinup = max_concurr_spinup;
408 }
409 
410 static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
411 					       struct sci_user_parameters *sci_parms)
412 {
413 	u16 index;
414 
415 	/*
416 	 * Validate the user parameters.  If they are not legal, then
417 	 * return a failure.
418 	 */
419 	for (index = 0; index < SCI_MAX_PHYS; index++) {
420 		struct sci_phy_user_params *u;
421 
422 		u = &sci_parms->phys[index];
423 
424 		if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
425 		      (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
426 			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
427 
428 		if ((u->in_connection_align_insertion_frequency < 3) ||
429 		    (u->align_insertion_frequency == 0) ||
430 		    (u->notify_enable_spin_up_insertion_frequency == 0))
431 			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
432 	}
433 
434 	if ((sci_parms->stp_inactivity_timeout == 0) ||
435 	    (sci_parms->ssp_inactivity_timeout == 0) ||
436 	    (sci_parms->stp_max_occupancy_timeout == 0) ||
437 	    (sci_parms->ssp_max_occupancy_timeout == 0) ||
438 	    (sci_parms->no_outbound_task_timeout == 0))
439 		return SCI_FAILURE_INVALID_PARAMETER_VALUE;
440 
441 	memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
442 
443 	return SCI_SUCCESS;
444 }
445 
446 static void sci_oem_defaults(struct isci_host *ihost)
447 {
448 	/* these defaults are overridden by the platform / firmware */
449 	struct sci_user_parameters *user = &ihost->user_parameters;
450 	struct sci_oem_params *oem = &ihost->oem_parameters;
451 	int i;
452 
453 	/* Default to APC mode. */
454 	oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
455 
456 	/* Default to APC mode. */
457 	oem->controller.max_concurr_spin_up = 1;
458 
459 	/* Default to no SSC operation. */
460 	oem->controller.do_enable_ssc = false;
461 
462 	/* Default to short cables on all phys. */
463 	oem->controller.cable_selection_mask = 0;
464 
465 	/* Initialize all of the port parameter information to narrow ports. */
466 	for (i = 0; i < SCI_MAX_PORTS; i++)
467 		oem->ports[i].phy_mask = 0;
468 
469 	/* Initialize all of the phy parameter information. */
470 	for (i = 0; i < SCI_MAX_PHYS; i++) {
471 		/* Default to 3G (i.e. Gen 2). */
472 		user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
473 
474 		/* the frequencies cannot be 0 */
475 		user->phys[i].align_insertion_frequency = 0x7f;
476 		user->phys[i].in_connection_align_insertion_frequency = 0xff;
477 		user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
478 
479 		/* Previous Vitesse based expanders had a arbitration issue that
480 		 * is worked around by having the upper 32-bits of SAS address
481 		 * with a value greater then the Vitesse company identifier.
482 		 * Hence, usage of 0x5FCFFFFF.
483 		 */
484 		oem->phys[i].sas_address.low = 0x1 + ihost->id;
485 		oem->phys[i].sas_address.high = 0x5FCFFFFF;
486 	}
487 
488 	user->stp_inactivity_timeout = 5;
489 	user->ssp_inactivity_timeout = 5;
490 	user->stp_max_occupancy_timeout = 5;
491 	user->ssp_max_occupancy_timeout = 20;
492 	user->no_outbound_task_timeout = 2;
493 }
494 
495 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
496 {
497 	struct isci_orom *orom = to_pci_info(pdev)->orom;
498 	struct sci_user_parameters sci_user_params;
499 	u8 oem_version = ISCI_ROM_VER_1_0;
500 	struct isci_host *ihost;
501 	struct Scsi_Host *shost;
502 	int err, i;
503 
504 	ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
505 	if (!ihost)
506 		return NULL;
507 
508 	ihost->pdev = pdev;
509 	ihost->id = id;
510 	spin_lock_init(&ihost->scic_lock);
511 	init_waitqueue_head(&ihost->eventq);
512 	ihost->sas_ha.dev = &ihost->pdev->dev;
513 	ihost->sas_ha.lldd_ha = ihost;
514 	tasklet_init(&ihost->completion_tasklet,
515 		     isci_host_completion_routine, (unsigned long)ihost);
516 
517 	/* validate module parameters */
518 	/* TODO: kill struct sci_user_parameters and reference directly */
519 	sci_oem_defaults(ihost);
520 	isci_user_parameters_get(&sci_user_params);
521 	if (sci_user_parameters_set(ihost, &sci_user_params)) {
522 		dev_warn(&pdev->dev,
523 			 "%s: sci_user_parameters_set failed\n", __func__);
524 		return NULL;
525 	}
526 
527 	/* sanity check platform (or 'firmware') oem parameters */
528 	if (orom) {
529 		if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
530 			dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
531 			return NULL;
532 		}
533 		ihost->oem_parameters = orom->ctrl[id];
534 		oem_version = orom->hdr.version;
535 	}
536 
537 	/* validate oem parameters (platform, firmware, or built-in defaults) */
538 	if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
539 		dev_warn(&pdev->dev, "oem parameter validation failed\n");
540 		return NULL;
541 	}
542 
543 	for (i = 0; i < SCI_MAX_PORTS; i++) {
544 		struct isci_port *iport = &ihost->ports[i];
545 
546 		INIT_LIST_HEAD(&iport->remote_dev_list);
547 		iport->isci_host = ihost;
548 	}
549 
550 	for (i = 0; i < SCI_MAX_PHYS; i++)
551 		isci_phy_init(&ihost->phys[i], ihost, i);
552 
553 	for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
554 		struct isci_remote_device *idev = &ihost->devices[i];
555 
556 		INIT_LIST_HEAD(&idev->node);
557 	}
558 
559 	shost = scsi_host_alloc(&isci_sht, sizeof(void *));
560 	if (!shost)
561 		return NULL;
562 
563 	dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
564 		 "{%s, %s, %s, %s}\n",
565 		 (is_cable_select_overridden() ? "* " : ""), ihost->id,
566 		 lookup_cable_names(decode_cable_selection(ihost, 3)),
567 		 lookup_cable_names(decode_cable_selection(ihost, 2)),
568 		 lookup_cable_names(decode_cable_selection(ihost, 1)),
569 		 lookup_cable_names(decode_cable_selection(ihost, 0)));
570 
571 	err = isci_host_init(ihost);
572 	if (err)
573 		goto err_shost;
574 
575 	SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
576 	ihost->sas_ha.core.shost = shost;
577 	shost->transportt = isci_transport_template;
578 
579 	shost->max_id = ~0;
580 	shost->max_lun = ~0;
581 	shost->max_cmd_len = MAX_COMMAND_SIZE;
582 
583 	/* turn on DIF support */
584 	scsi_host_set_prot(shost,
585 			   SHOST_DIF_TYPE1_PROTECTION |
586 			   SHOST_DIF_TYPE2_PROTECTION |
587 			   SHOST_DIF_TYPE3_PROTECTION);
588 	scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
589 
590 	err = scsi_add_host(shost, &pdev->dev);
591 	if (err)
592 		goto err_shost;
593 
594 	err = isci_register_sas_ha(ihost);
595 	if (err)
596 		goto err_shost_remove;
597 
598 	return ihost;
599 
600  err_shost_remove:
601 	scsi_remove_host(shost);
602  err_shost:
603 	scsi_host_put(shost);
604 
605 	return NULL;
606 }
607 
608 static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
609 {
610 	struct isci_pci_info *pci_info;
611 	int err, i;
612 	struct isci_host *isci_host;
613 	const struct firmware *fw = NULL;
614 	struct isci_orom *orom = NULL;
615 	char *source = "(platform)";
616 
617 	dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
618 		 pdev->revision);
619 
620 	pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
621 	if (!pci_info)
622 		return -ENOMEM;
623 	pci_set_drvdata(pdev, pci_info);
624 
625 	if (efi_rt_services_supported(EFI_RT_SUPPORTED_GET_VARIABLE))
626 		orom = isci_get_efi_var(pdev);
627 
628 	if (!orom)
629 		orom = isci_request_oprom(pdev);
630 
631 	for (i = 0; orom && i < num_controllers(pdev); i++) {
632 		if (sci_oem_parameters_validate(&orom->ctrl[i],
633 						orom->hdr.version)) {
634 			dev_warn(&pdev->dev,
635 				 "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
636 			orom = NULL;
637 			break;
638 		}
639 	}
640 
641 	if (!orom) {
642 		source = "(firmware)";
643 		orom = isci_request_firmware(pdev, fw);
644 		if (!orom) {
645 			/* TODO convert this to WARN_TAINT_ONCE once the
646 			 * orom/efi parameter support is widely available
647 			 */
648 			dev_warn(&pdev->dev,
649 				 "Loading user firmware failed, using default "
650 				 "values\n");
651 			dev_warn(&pdev->dev,
652 				 "Default OEM configuration being used: 4 "
653 				 "narrow ports, and default SAS Addresses\n");
654 		}
655 	}
656 
657 	if (orom)
658 		dev_info(&pdev->dev,
659 			 "OEM SAS parameters (version: %u.%u) loaded %s\n",
660 			 (orom->hdr.version & 0xf0) >> 4,
661 			 (orom->hdr.version & 0xf), source);
662 
663 	pci_info->orom = orom;
664 
665 	err = isci_pci_init(pdev);
666 	if (err)
667 		return err;
668 
669 	for (i = 0; i < num_controllers(pdev); i++) {
670 		struct isci_host *h = isci_host_alloc(pdev, i);
671 
672 		if (!h) {
673 			err = -ENOMEM;
674 			goto err_host_alloc;
675 		}
676 		pci_info->hosts[i] = h;
677 	}
678 
679 	err = isci_setup_interrupts(pdev);
680 	if (err)
681 		goto err_host_alloc;
682 
683 	for_each_isci_host(i, isci_host, pdev)
684 		scsi_scan_host(to_shost(isci_host));
685 
686 	return 0;
687 
688  err_host_alloc:
689 	for_each_isci_host(i, isci_host, pdev)
690 		isci_unregister(isci_host);
691 	return err;
692 }
693 
694 static void isci_pci_remove(struct pci_dev *pdev)
695 {
696 	struct isci_host *ihost;
697 	int i;
698 
699 	for_each_isci_host(i, ihost, pdev) {
700 		wait_for_start(ihost);
701 		isci_unregister(ihost);
702 		isci_host_deinit(ihost);
703 	}
704 }
705 
706 #ifdef CONFIG_PM_SLEEP
707 static int isci_suspend(struct device *dev)
708 {
709 	struct pci_dev *pdev = to_pci_dev(dev);
710 	struct isci_host *ihost;
711 	int i;
712 
713 	for_each_isci_host(i, ihost, pdev) {
714 		sas_suspend_ha(&ihost->sas_ha);
715 		isci_host_deinit(ihost);
716 	}
717 
718 	pci_save_state(pdev);
719 	pci_disable_device(pdev);
720 	pci_set_power_state(pdev, PCI_D3hot);
721 
722 	return 0;
723 }
724 
725 static int isci_resume(struct device *dev)
726 {
727 	struct pci_dev *pdev = to_pci_dev(dev);
728 	struct isci_host *ihost;
729 	int rc, i;
730 
731 	pci_set_power_state(pdev, PCI_D0);
732 	pci_restore_state(pdev);
733 
734 	rc = pcim_enable_device(pdev);
735 	if (rc) {
736 		dev_err(&pdev->dev,
737 			"enabling device failure after resume(%d)\n", rc);
738 		return rc;
739 	}
740 
741 	pci_set_master(pdev);
742 
743 	for_each_isci_host(i, ihost, pdev) {
744 		sas_prep_resume_ha(&ihost->sas_ha);
745 
746 		isci_host_init(ihost);
747 		isci_host_start(ihost->sas_ha.core.shost);
748 		wait_for_start(ihost);
749 
750 		sas_resume_ha(&ihost->sas_ha);
751 	}
752 
753 	return 0;
754 }
755 #endif
756 
757 static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
758 
759 static struct pci_driver isci_pci_driver = {
760 	.name		= DRV_NAME,
761 	.id_table	= isci_id_table,
762 	.probe		= isci_pci_probe,
763 	.remove		= isci_pci_remove,
764 	.driver.pm      = &isci_pm_ops,
765 };
766 
767 static __init int isci_init(void)
768 {
769 	int err;
770 
771 	pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
772 		DRV_NAME, DRV_VERSION);
773 
774 	isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
775 	if (!isci_transport_template)
776 		return -ENOMEM;
777 
778 	err = pci_register_driver(&isci_pci_driver);
779 	if (err)
780 		sas_release_transport(isci_transport_template);
781 
782 	return err;
783 }
784 
785 static __exit void isci_exit(void)
786 {
787 	pci_unregister_driver(&isci_pci_driver);
788 	sas_release_transport(isci_transport_template);
789 }
790 
791 MODULE_LICENSE("Dual BSD/GPL");
792 MODULE_FIRMWARE(ISCI_FW_NAME);
793 module_init(isci_init);
794 module_exit(isci_exit);
795