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