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