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
74MODULE_VERSION(DRV_VERSION);
75
76static struct scsi_transport_template *isci_transport_template;
77
78static 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
94MODULE_DEVICE_TABLE(pci, isci_id_table);
95
96/* linux isci specific settings */
97
98unsigned char no_outbound_task_to = 2;
99module_param(no_outbound_task_to, byte, 0);
100MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
101
102u16 ssp_max_occ_to = 20;
103module_param(ssp_max_occ_to, ushort, 0);
104MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
105
106u16 stp_max_occ_to = 5;
107module_param(stp_max_occ_to, ushort, 0);
108MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
109
110u16 ssp_inactive_to = 5;
111module_param(ssp_inactive_to, ushort, 0);
112MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
113
114u16 stp_inactive_to = 5;
115module_param(stp_inactive_to, ushort, 0);
116MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
117
118unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
119module_param(phy_gen, byte, 0);
120MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
121
122unsigned char max_concurr_spinup;
123module_param(max_concurr_spinup, byte, 0);
124MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
125
126uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
127module_param(cable_selection_override, uint, 0);
128
129MODULE_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
134static 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 sysfs_emit(buf, "%d\n", ihost->id);
141}
142
143static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
144
145static struct attribute *isci_host_attrs[] = {
146	&dev_attr_isci_id.attr,
147	NULL
148};
149
150ATTRIBUTE_GROUPS(isci_host);
151
152static const 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
182static 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 */
233static 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->sas_addr    = &isci_host->phys[0].sas_addr[0];
254
255	for (i = 0; i < SCI_MAX_PHYS; i++) {
256		sas_phys[i] = &isci_host->phys[i].sas_phy;
257		sas_ports[i] = &isci_host->sas_ports[i];
258	}
259
260	sas_ha->sas_phy  = sas_phys;
261	sas_ha->sas_port = sas_ports;
262	sas_ha->num_phys = SCI_MAX_PHYS;
263
264	sas_ha->strict_wide_ports = 1;
265
266	return sas_register_ha(sas_ha);
267}
268
269static void isci_unregister(struct isci_host *isci_host)
270{
271	struct Scsi_Host *shost;
272
273	if (!isci_host)
274		return;
275
276	shost = to_shost(isci_host);
277	sas_unregister_ha(&isci_host->sas_ha);
278
279	sas_remove_host(shost);
280	scsi_host_put(shost);
281}
282
283static int isci_pci_init(struct pci_dev *pdev)
284{
285	int err, bar_num, bar_mask = 0;
286	void __iomem * const *iomap;
287
288	err = pcim_enable_device(pdev);
289	if (err) {
290		dev_err(&pdev->dev,
291			"failed enable PCI device %s!\n",
292			pci_name(pdev));
293		return err;
294	}
295
296	for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
297		bar_mask |= 1 << (bar_num * 2);
298
299	err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
300	if (err)
301		return err;
302
303	iomap = pcim_iomap_table(pdev);
304	if (!iomap)
305		return -ENOMEM;
306
307	pci_set_master(pdev);
308
309	err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(64));
310	if (err)
311		err = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
312	return err;
313}
314
315static int num_controllers(struct pci_dev *pdev)
316{
317	/* bar size alone can tell us if we are running with a dual controller
318	 * part, no need to trust revision ids that might be under broken firmware
319	 * control
320	 */
321	resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
322	resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
323
324	if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
325	    smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
326		return SCI_MAX_CONTROLLERS;
327	else
328		return 1;
329}
330
331static int isci_setup_interrupts(struct pci_dev *pdev)
332{
333	int err, i, num_msix;
334	struct isci_host *ihost;
335	struct isci_pci_info *pci_info = to_pci_info(pdev);
336
337	/*
338	 *  Determine the number of vectors associated with this
339	 *  PCI function.
340	 */
341	num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
342
343	err = pci_alloc_irq_vectors(pdev, num_msix, num_msix, PCI_IRQ_MSIX);
344	if (err < 0)
345		goto intx;
346
347	for (i = 0; i < num_msix; i++) {
348		int id = i / SCI_NUM_MSI_X_INT;
349		irq_handler_t isr;
350
351		ihost = pci_info->hosts[id];
352		/* odd numbered vectors are error interrupts */
353		if (i & 1)
354			isr = isci_error_isr;
355		else
356			isr = isci_msix_isr;
357
358		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, i),
359				isr, 0, DRV_NAME"-msix", ihost);
360		if (!err)
361			continue;
362
363		dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
364		while (i--) {
365			id = i / SCI_NUM_MSI_X_INT;
366			ihost = pci_info->hosts[id];
367			devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
368					ihost);
369		}
370		pci_free_irq_vectors(pdev);
371		goto intx;
372	}
373	return 0;
374
375 intx:
376	for_each_isci_host(i, ihost, pdev) {
377		err = devm_request_irq(&pdev->dev, pci_irq_vector(pdev, 0),
378				isci_intx_isr, IRQF_SHARED, DRV_NAME"-intx",
379				ihost);
380		if (err)
381			break;
382	}
383	return err;
384}
385
386static void isci_user_parameters_get(struct sci_user_parameters *u)
387{
388	int i;
389
390	for (i = 0; i < SCI_MAX_PHYS; i++) {
391		struct sci_phy_user_params *u_phy = &u->phys[i];
392
393		u_phy->max_speed_generation = phy_gen;
394
395		/* we are not exporting these for now */
396		u_phy->align_insertion_frequency = 0x7f;
397		u_phy->in_connection_align_insertion_frequency = 0xff;
398		u_phy->notify_enable_spin_up_insertion_frequency = 0x33;
399	}
400
401	u->stp_inactivity_timeout = stp_inactive_to;
402	u->ssp_inactivity_timeout = ssp_inactive_to;
403	u->stp_max_occupancy_timeout = stp_max_occ_to;
404	u->ssp_max_occupancy_timeout = ssp_max_occ_to;
405	u->no_outbound_task_timeout = no_outbound_task_to;
406	u->max_concurr_spinup = max_concurr_spinup;
407}
408
409static enum sci_status sci_user_parameters_set(struct isci_host *ihost,
410					       struct sci_user_parameters *sci_parms)
411{
412	u16 index;
413
414	/*
415	 * Validate the user parameters.  If they are not legal, then
416	 * return a failure.
417	 */
418	for (index = 0; index < SCI_MAX_PHYS; index++) {
419		struct sci_phy_user_params *u;
420
421		u = &sci_parms->phys[index];
422
423		if (!((u->max_speed_generation <= SCIC_SDS_PARM_MAX_SPEED) &&
424		      (u->max_speed_generation > SCIC_SDS_PARM_NO_SPEED)))
425			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
426
427		if ((u->in_connection_align_insertion_frequency < 3) ||
428		    (u->align_insertion_frequency == 0) ||
429		    (u->notify_enable_spin_up_insertion_frequency == 0))
430			return SCI_FAILURE_INVALID_PARAMETER_VALUE;
431	}
432
433	if ((sci_parms->stp_inactivity_timeout == 0) ||
434	    (sci_parms->ssp_inactivity_timeout == 0) ||
435	    (sci_parms->stp_max_occupancy_timeout == 0) ||
436	    (sci_parms->ssp_max_occupancy_timeout == 0) ||
437	    (sci_parms->no_outbound_task_timeout == 0))
438		return SCI_FAILURE_INVALID_PARAMETER_VALUE;
439
440	memcpy(&ihost->user_parameters, sci_parms, sizeof(*sci_parms));
441
442	return SCI_SUCCESS;
443}
444
445static void sci_oem_defaults(struct isci_host *ihost)
446{
447	/* these defaults are overridden by the platform / firmware */
448	struct sci_user_parameters *user = &ihost->user_parameters;
449	struct sci_oem_params *oem = &ihost->oem_parameters;
450	int i;
451
452	/* Default to APC mode. */
453	oem->controller.mode_type = SCIC_PORT_AUTOMATIC_CONFIGURATION_MODE;
454
455	/* Default to APC mode. */
456	oem->controller.max_concurr_spin_up = 1;
457
458	/* Default to no SSC operation. */
459	oem->controller.do_enable_ssc = false;
460
461	/* Default to short cables on all phys. */
462	oem->controller.cable_selection_mask = 0;
463
464	/* Initialize all of the port parameter information to narrow ports. */
465	for (i = 0; i < SCI_MAX_PORTS; i++)
466		oem->ports[i].phy_mask = 0;
467
468	/* Initialize all of the phy parameter information. */
469	for (i = 0; i < SCI_MAX_PHYS; i++) {
470		/* Default to 3G (i.e. Gen 2). */
471		user->phys[i].max_speed_generation = SCIC_SDS_PARM_GEN2_SPEED;
472
473		/* the frequencies cannot be 0 */
474		user->phys[i].align_insertion_frequency = 0x7f;
475		user->phys[i].in_connection_align_insertion_frequency = 0xff;
476		user->phys[i].notify_enable_spin_up_insertion_frequency = 0x33;
477
478		/* Previous Vitesse based expanders had a arbitration issue that
479		 * is worked around by having the upper 32-bits of SAS address
480		 * with a value greater then the Vitesse company identifier.
481		 * Hence, usage of 0x5FCFFFFF.
482		 */
483		oem->phys[i].sas_address.low = 0x1 + ihost->id;
484		oem->phys[i].sas_address.high = 0x5FCFFFFF;
485	}
486
487	user->stp_inactivity_timeout = 5;
488	user->ssp_inactivity_timeout = 5;
489	user->stp_max_occupancy_timeout = 5;
490	user->ssp_max_occupancy_timeout = 20;
491	user->no_outbound_task_timeout = 2;
492}
493
494static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
495{
496	struct isci_orom *orom = to_pci_info(pdev)->orom;
497	struct sci_user_parameters sci_user_params;
498	u8 oem_version = ISCI_ROM_VER_1_0;
499	struct isci_host *ihost;
500	struct Scsi_Host *shost;
501	int err, i;
502
503	ihost = devm_kzalloc(&pdev->dev, sizeof(*ihost), GFP_KERNEL);
504	if (!ihost)
505		return NULL;
506
507	ihost->pdev = pdev;
508	ihost->id = id;
509	spin_lock_init(&ihost->scic_lock);
510	init_waitqueue_head(&ihost->eventq);
511	ihost->sas_ha.dev = &ihost->pdev->dev;
512	ihost->sas_ha.lldd_ha = ihost;
513	tasklet_init(&ihost->completion_tasklet,
514		     isci_host_completion_routine, (unsigned long)ihost);
515
516	/* validate module parameters */
517	/* TODO: kill struct sci_user_parameters and reference directly */
518	sci_oem_defaults(ihost);
519	isci_user_parameters_get(&sci_user_params);
520	if (sci_user_parameters_set(ihost, &sci_user_params)) {
521		dev_warn(&pdev->dev,
522			 "%s: sci_user_parameters_set failed\n", __func__);
523		return NULL;
524	}
525
526	/* sanity check platform (or 'firmware') oem parameters */
527	if (orom) {
528		if (id < 0 || id >= SCI_MAX_CONTROLLERS || id > orom->hdr.num_elements) {
529			dev_warn(&pdev->dev, "parsing firmware oem parameters failed\n");
530			return NULL;
531		}
532		ihost->oem_parameters = orom->ctrl[id];
533		oem_version = orom->hdr.version;
534	}
535
536	/* validate oem parameters (platform, firmware, or built-in defaults) */
537	if (sci_oem_parameters_validate(&ihost->oem_parameters, oem_version)) {
538		dev_warn(&pdev->dev, "oem parameter validation failed\n");
539		return NULL;
540	}
541
542	for (i = 0; i < SCI_MAX_PORTS; i++) {
543		struct isci_port *iport = &ihost->ports[i];
544
545		INIT_LIST_HEAD(&iport->remote_dev_list);
546		iport->isci_host = ihost;
547	}
548
549	for (i = 0; i < SCI_MAX_PHYS; i++)
550		isci_phy_init(&ihost->phys[i], ihost, i);
551
552	for (i = 0; i < SCI_MAX_REMOTE_DEVICES; i++) {
553		struct isci_remote_device *idev = &ihost->devices[i];
554
555		INIT_LIST_HEAD(&idev->node);
556	}
557
558	shost = scsi_host_alloc(&isci_sht, sizeof(void *));
559	if (!shost)
560		return NULL;
561
562	dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
563		 "{%s, %s, %s, %s}\n",
564		 (is_cable_select_overridden() ? "* " : ""), ihost->id,
565		 lookup_cable_names(decode_cable_selection(ihost, 3)),
566		 lookup_cable_names(decode_cable_selection(ihost, 2)),
567		 lookup_cable_names(decode_cable_selection(ihost, 1)),
568		 lookup_cable_names(decode_cable_selection(ihost, 0)));
569
570	err = isci_host_init(ihost);
571	if (err)
572		goto err_shost;
573
574	SHOST_TO_SAS_HA(shost) = &ihost->sas_ha;
575	ihost->sas_ha.shost = shost;
576	shost->transportt = isci_transport_template;
577
578	shost->max_id = ~0;
579	shost->max_lun = ~0;
580	shost->max_cmd_len = MAX_COMMAND_SIZE;
581
582	/* turn on DIF support */
583	scsi_host_set_prot(shost,
584			   SHOST_DIF_TYPE1_PROTECTION |
585			   SHOST_DIF_TYPE2_PROTECTION |
586			   SHOST_DIF_TYPE3_PROTECTION);
587	scsi_host_set_guard(shost, SHOST_DIX_GUARD_CRC);
588
589	err = scsi_add_host(shost, &pdev->dev);
590	if (err)
591		goto err_shost;
592
593	err = isci_register_sas_ha(ihost);
594	if (err)
595		goto err_shost_remove;
596
597	return ihost;
598
599 err_shost_remove:
600	scsi_remove_host(shost);
601 err_shost:
602	scsi_host_put(shost);
603
604	return NULL;
605}
606
607static int isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
608{
609	struct isci_pci_info *pci_info;
610	int err, i;
611	struct isci_host *isci_host;
612	const struct firmware *fw = NULL;
613	struct isci_orom *orom = NULL;
614	char *source = "(platform)";
615
616	dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
617		 pdev->revision);
618
619	pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
620	if (!pci_info)
621		return -ENOMEM;
622	pci_set_drvdata(pdev, pci_info);
623
624	if (efi_rt_services_supported(EFI_RT_SUPPORTED_GET_VARIABLE))
625		orom = isci_get_efi_var(pdev);
626
627	if (!orom)
628		orom = isci_request_oprom(pdev);
629
630	for (i = 0; orom && i < num_controllers(pdev); i++) {
631		if (sci_oem_parameters_validate(&orom->ctrl[i],
632						orom->hdr.version)) {
633			dev_warn(&pdev->dev,
634				 "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
635			orom = NULL;
636			break;
637		}
638	}
639
640	if (!orom) {
641		source = "(firmware)";
642		orom = isci_request_firmware(pdev, fw);
643		if (!orom) {
644			/* TODO convert this to WARN_TAINT_ONCE once the
645			 * orom/efi parameter support is widely available
646			 */
647			dev_warn(&pdev->dev,
648				 "Loading user firmware failed, using default "
649				 "values\n");
650			dev_warn(&pdev->dev,
651				 "Default OEM configuration being used: 4 "
652				 "narrow ports, and default SAS Addresses\n");
653		}
654	}
655
656	if (orom)
657		dev_info(&pdev->dev,
658			 "OEM SAS parameters (version: %u.%u) loaded %s\n",
659			 (orom->hdr.version & 0xf0) >> 4,
660			 (orom->hdr.version & 0xf), source);
661
662	pci_info->orom = orom;
663
664	err = isci_pci_init(pdev);
665	if (err)
666		return err;
667
668	for (i = 0; i < num_controllers(pdev); i++) {
669		struct isci_host *h = isci_host_alloc(pdev, i);
670
671		if (!h) {
672			err = -ENOMEM;
673			goto err_host_alloc;
674		}
675		pci_info->hosts[i] = h;
676	}
677
678	err = isci_setup_interrupts(pdev);
679	if (err)
680		goto err_host_alloc;
681
682	for_each_isci_host(i, isci_host, pdev)
683		scsi_scan_host(to_shost(isci_host));
684
685	return 0;
686
687 err_host_alloc:
688	for_each_isci_host(i, isci_host, pdev)
689		isci_unregister(isci_host);
690	return err;
691}
692
693static void isci_pci_remove(struct pci_dev *pdev)
694{
695	struct isci_host *ihost;
696	int i;
697
698	for_each_isci_host(i, ihost, pdev) {
699		wait_for_start(ihost);
700		isci_unregister(ihost);
701		isci_host_deinit(ihost);
702	}
703}
704
705#ifdef CONFIG_PM_SLEEP
706static int isci_suspend(struct device *dev)
707{
708	struct pci_dev *pdev = to_pci_dev(dev);
709	struct isci_host *ihost;
710	int i;
711
712	for_each_isci_host(i, ihost, pdev) {
713		sas_suspend_ha(&ihost->sas_ha);
714		isci_host_deinit(ihost);
715	}
716
717	return 0;
718}
719
720static int isci_resume(struct device *dev)
721{
722	struct pci_dev *pdev = to_pci_dev(dev);
723	struct isci_host *ihost;
724	int i;
725
726	for_each_isci_host(i, ihost, pdev) {
727		sas_prep_resume_ha(&ihost->sas_ha);
728
729		isci_host_init(ihost);
730		isci_host_start(ihost->sas_ha.shost);
731		wait_for_start(ihost);
732
733		sas_resume_ha(&ihost->sas_ha);
734	}
735
736	return 0;
737}
738#endif
739
740static SIMPLE_DEV_PM_OPS(isci_pm_ops, isci_suspend, isci_resume);
741
742static struct pci_driver isci_pci_driver = {
743	.name		= DRV_NAME,
744	.id_table	= isci_id_table,
745	.probe		= isci_pci_probe,
746	.remove		= isci_pci_remove,
747	.driver.pm      = &isci_pm_ops,
748};
749
750static __init int isci_init(void)
751{
752	int err;
753
754	pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
755		DRV_NAME, DRV_VERSION);
756
757	isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
758	if (!isci_transport_template)
759		return -ENOMEM;
760
761	err = pci_register_driver(&isci_pci_driver);
762	if (err)
763		sas_release_transport(isci_transport_template);
764
765	return err;
766}
767
768static __exit void isci_exit(void)
769{
770	pci_unregister_driver(&isci_pci_driver);
771	sas_release_transport(isci_transport_template);
772}
773
774MODULE_LICENSE("Dual BSD/GPL");
775MODULE_FIRMWARE(ISCI_FW_NAME);
776module_init(isci_init);
777module_exit(isci_exit);
778