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