Linux Audio

Check our new training course

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