6b911e0aea3f90b829615424d6393c4a444f84e1
[linux-2.6.git] / drivers / scsi / isci / init.c
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 1
69 #define BUILD 0
70 #define DRV_VERSION __stringify(MAJ) "." __stringify(MIN) "." \
71         __stringify(BUILD)
72
73 MODULE_VERSION(DRV_VERSION);
74
75 static struct scsi_transport_template *isci_transport_template;
76
77 static 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
93 MODULE_DEVICE_TABLE(pci, isci_id_table);
94
95 /* linux isci specific settings */
96
97 unsigned char no_outbound_task_to = 2;
98 module_param(no_outbound_task_to, byte, 0);
99 MODULE_PARM_DESC(no_outbound_task_to, "No Outbound Task Timeout (1us incr)");
100
101 u16 ssp_max_occ_to = 20;
102 module_param(ssp_max_occ_to, ushort, 0);
103 MODULE_PARM_DESC(ssp_max_occ_to, "SSP Max occupancy timeout (100us incr)");
104
105 u16 stp_max_occ_to = 5;
106 module_param(stp_max_occ_to, ushort, 0);
107 MODULE_PARM_DESC(stp_max_occ_to, "STP Max occupancy timeout (100us incr)");
108
109 u16 ssp_inactive_to = 5;
110 module_param(ssp_inactive_to, ushort, 0);
111 MODULE_PARM_DESC(ssp_inactive_to, "SSP inactivity timeout (100us incr)");
112
113 u16 stp_inactive_to = 5;
114 module_param(stp_inactive_to, ushort, 0);
115 MODULE_PARM_DESC(stp_inactive_to, "STP inactivity timeout (100us incr)");
116
117 unsigned char phy_gen = SCIC_SDS_PARM_GEN2_SPEED;
118 module_param(phy_gen, byte, 0);
119 MODULE_PARM_DESC(phy_gen, "PHY generation (1: 1.5Gbps 2: 3.0Gbps 3: 6.0Gbps)");
120
121 unsigned char max_concurr_spinup;
122 module_param(max_concurr_spinup, byte, 0);
123 MODULE_PARM_DESC(max_concurr_spinup, "Max concurrent device spinup");
124
125 uint cable_selection_override = CABLE_OVERRIDE_DISABLED;
126 module_param(cable_selection_override, uint, 0);
127
128 MODULE_PARM_DESC(cable_selection_override,
129                  "This field indicates length of the SAS/SATA cable between "
130                  "host and device. If any bits > 15 are set (default) "
131                  "indicates \"use platform defaults\"");
132
133 static ssize_t isci_show_id(struct device *dev, struct device_attribute *attr, char *buf)
134 {
135         struct Scsi_Host *shost = container_of(dev, typeof(*shost), shost_dev);
136         struct sas_ha_struct *sas_ha = SHOST_TO_SAS_HA(shost);
137         struct isci_host *ihost = container_of(sas_ha, typeof(*ihost), sas_ha);
138
139         return snprintf(buf, PAGE_SIZE, "%d\n", ihost->id);
140 }
141
142 static DEVICE_ATTR(isci_id, S_IRUGO, isci_show_id, NULL);
143
144 struct device_attribute *isci_host_attrs[] = {
145         &dev_attr_isci_id,
146         NULL
147 };
148
149 static struct scsi_host_template isci_sht = {
150
151         .module                         = THIS_MODULE,
152         .name                           = DRV_NAME,
153         .proc_name                      = DRV_NAME,
154         .queuecommand                   = sas_queuecommand,
155         .target_alloc                   = sas_target_alloc,
156         .slave_configure                = sas_slave_configure,
157         .slave_destroy                  = sas_slave_destroy,
158         .scan_finished                  = isci_host_scan_finished,
159         .scan_start                     = isci_host_scan_start,
160         .change_queue_depth             = sas_change_queue_depth,
161         .change_queue_type              = sas_change_queue_type,
162         .bios_param                     = sas_bios_param,
163         .can_queue                      = ISCI_CAN_QUEUE_VAL,
164         .cmd_per_lun                    = 1,
165         .this_id                        = -1,
166         .sg_tablesize                   = SG_ALL,
167         .max_sectors                    = SCSI_DEFAULT_MAX_SECTORS,
168         .use_clustering                 = ENABLE_CLUSTERING,
169         .eh_device_reset_handler        = sas_eh_device_reset_handler,
170         .eh_bus_reset_handler           = isci_bus_reset_handler,
171         .slave_alloc                    = sas_slave_alloc,
172         .target_destroy                 = sas_target_destroy,
173         .ioctl                          = sas_ioctl,
174         .shost_attrs                    = isci_host_attrs,
175 };
176
177 static struct sas_domain_function_template isci_transport_ops  = {
178
179         /* The class calls these to notify the LLDD of an event. */
180         .lldd_port_formed       = isci_port_formed,
181         .lldd_port_deformed     = isci_port_deformed,
182
183         /* The class calls these when a device is found or gone. */
184         .lldd_dev_found         = isci_remote_device_found,
185         .lldd_dev_gone          = isci_remote_device_gone,
186
187         .lldd_execute_task      = isci_task_execute_task,
188         /* Task Management Functions. Must be called from process context. */
189         .lldd_abort_task        = isci_task_abort_task,
190         .lldd_abort_task_set    = isci_task_abort_task_set,
191         .lldd_clear_aca         = isci_task_clear_aca,
192         .lldd_clear_task_set    = isci_task_clear_task_set,
193         .lldd_I_T_nexus_reset   = isci_task_I_T_nexus_reset,
194         .lldd_lu_reset          = isci_task_lu_reset,
195         .lldd_query_task        = isci_task_query_task,
196
197         /* Port and Adapter management */
198         .lldd_clear_nexus_port  = isci_task_clear_nexus_port,
199         .lldd_clear_nexus_ha    = isci_task_clear_nexus_ha,
200
201         /* Phy management */
202         .lldd_control_phy       = isci_phy_control,
203
204         /* GPIO support */
205         .lldd_write_gpio        = isci_gpio_write,
206 };
207
208
209 /******************************************************************************
210 * P R O T E C T E D  M E T H O D S
211 ******************************************************************************/
212
213
214
215 /**
216  * isci_register_sas_ha() - This method initializes various lldd
217  *    specific members of the sas_ha struct and calls the libsas
218  *    sas_register_ha() function.
219  * @isci_host: This parameter specifies the lldd specific wrapper for the
220  *    libsas sas_ha struct.
221  *
222  * This method returns an error code indicating sucess or failure. The user
223  * should check for possible memory allocation error return otherwise, a zero
224  * indicates success.
225  */
226 static int isci_register_sas_ha(struct isci_host *isci_host)
227 {
228         int i;
229         struct sas_ha_struct *sas_ha = &(isci_host->sas_ha);
230         struct asd_sas_phy **sas_phys;
231         struct asd_sas_port **sas_ports;
232
233         sas_phys = devm_kzalloc(&isci_host->pdev->dev,
234                                 SCI_MAX_PHYS * sizeof(void *),
235                                 GFP_KERNEL);
236         if (!sas_phys)
237                 return -ENOMEM;
238
239         sas_ports = devm_kzalloc(&isci_host->pdev->dev,
240                                  SCI_MAX_PORTS * sizeof(void *),
241                                  GFP_KERNEL);
242         if (!sas_ports)
243                 return -ENOMEM;
244
245         /*----------------- Libsas Initialization Stuff----------------------
246          * Set various fields in the sas_ha struct:
247          */
248
249         sas_ha->sas_ha_name = DRV_NAME;
250         sas_ha->lldd_module = THIS_MODULE;
251         sas_ha->sas_addr    = &isci_host->phys[0].sas_addr[0];
252
253         /* set the array of phy and port structs.  */
254         for (i = 0; i < SCI_MAX_PHYS; i++) {
255                 sas_phys[i] = &isci_host->phys[i].sas_phy;
256                 sas_ports[i] = &isci_host->ports[i].sas_port;
257         }
258
259         sas_ha->sas_phy  = sas_phys;
260         sas_ha->sas_port = sas_ports;
261         sas_ha->num_phys = SCI_MAX_PHYS;
262
263         sas_ha->lldd_queue_size = ISCI_CAN_QUEUE_VAL;
264         sas_ha->lldd_max_execute_num = 1;
265         sas_ha->strict_wide_ports = 1;
266
267         sas_register_ha(sas_ha);
268
269         return 0;
270 }
271
272 static void isci_unregister(struct isci_host *isci_host)
273 {
274         struct Scsi_Host *shost;
275
276         if (!isci_host)
277                 return;
278
279         shost = isci_host->shost;
280
281         sas_unregister_ha(&isci_host->sas_ha);
282
283         sas_remove_host(isci_host->shost);
284         scsi_remove_host(isci_host->shost);
285         scsi_host_put(isci_host->shost);
286 }
287
288 static int __devinit isci_pci_init(struct pci_dev *pdev)
289 {
290         int err, bar_num, bar_mask = 0;
291         void __iomem * const *iomap;
292
293         err = pcim_enable_device(pdev);
294         if (err) {
295                 dev_err(&pdev->dev,
296                         "failed enable PCI device %s!\n",
297                         pci_name(pdev));
298                 return err;
299         }
300
301         for (bar_num = 0; bar_num < SCI_PCI_BAR_COUNT; bar_num++)
302                 bar_mask |= 1 << (bar_num * 2);
303
304         err = pcim_iomap_regions(pdev, bar_mask, DRV_NAME);
305         if (err)
306                 return err;
307
308         iomap = pcim_iomap_table(pdev);
309         if (!iomap)
310                 return -ENOMEM;
311
312         pci_set_master(pdev);
313
314         err = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
315         if (err) {
316                 err = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
317                 if (err)
318                         return err;
319         }
320
321         err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64));
322         if (err) {
323                 err = pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(32));
324                 if (err)
325                         return err;
326         }
327
328         return 0;
329 }
330
331 static int num_controllers(struct pci_dev *pdev)
332 {
333         /* bar size alone can tell us if we are running with a dual controller
334          * part, no need to trust revision ids that might be under broken firmware
335          * control
336          */
337         resource_size_t scu_bar_size = pci_resource_len(pdev, SCI_SCU_BAR*2);
338         resource_size_t smu_bar_size = pci_resource_len(pdev, SCI_SMU_BAR*2);
339
340         if (scu_bar_size >= SCI_SCU_BAR_SIZE*SCI_MAX_CONTROLLERS &&
341             smu_bar_size >= SCI_SMU_BAR_SIZE*SCI_MAX_CONTROLLERS)
342                 return SCI_MAX_CONTROLLERS;
343         else
344                 return 1;
345 }
346
347 static int isci_setup_interrupts(struct pci_dev *pdev)
348 {
349         int err, i, num_msix;
350         struct isci_host *ihost;
351         struct isci_pci_info *pci_info = to_pci_info(pdev);
352
353         /*
354          *  Determine the number of vectors associated with this
355          *  PCI function.
356          */
357         num_msix = num_controllers(pdev) * SCI_NUM_MSI_X_INT;
358
359         for (i = 0; i < num_msix; i++)
360                 pci_info->msix_entries[i].entry = i;
361
362         err = pci_enable_msix(pdev, pci_info->msix_entries, num_msix);
363         if (err)
364                 goto intx;
365
366         for (i = 0; i < num_msix; i++) {
367                 int id = i / SCI_NUM_MSI_X_INT;
368                 struct msix_entry *msix = &pci_info->msix_entries[i];
369                 irq_handler_t isr;
370
371                 ihost = pci_info->hosts[id];
372                 /* odd numbered vectors are error interrupts */
373                 if (i & 1)
374                         isr = isci_error_isr;
375                 else
376                         isr = isci_msix_isr;
377
378                 err = devm_request_irq(&pdev->dev, msix->vector, isr, 0,
379                                        DRV_NAME"-msix", ihost);
380                 if (!err)
381                         continue;
382
383                 dev_info(&pdev->dev, "msix setup failed falling back to intx\n");
384                 while (i--) {
385                         id = i / SCI_NUM_MSI_X_INT;
386                         ihost = pci_info->hosts[id];
387                         msix = &pci_info->msix_entries[i];
388                         devm_free_irq(&pdev->dev, msix->vector, ihost);
389                 }
390                 pci_disable_msix(pdev);
391                 goto intx;
392         }
393         return 0;
394
395  intx:
396         for_each_isci_host(i, ihost, pdev) {
397                 err = devm_request_irq(&pdev->dev, pdev->irq, isci_intx_isr,
398                                        IRQF_SHARED, DRV_NAME"-intx", ihost);
399                 if (err)
400                         break;
401         }
402         return err;
403 }
404
405 static struct isci_host *isci_host_alloc(struct pci_dev *pdev, int id)
406 {
407         struct isci_host *isci_host;
408         struct Scsi_Host *shost;
409         int err;
410
411         isci_host = devm_kzalloc(&pdev->dev, sizeof(*isci_host), GFP_KERNEL);
412         if (!isci_host)
413                 return NULL;
414
415         isci_host->pdev = pdev;
416         isci_host->id = id;
417
418         shost = scsi_host_alloc(&isci_sht, sizeof(void *));
419         if (!shost)
420                 return NULL;
421         isci_host->shost = shost;
422
423         dev_info(&pdev->dev, "%sSCU controller %d: phy 3-0 cables: "
424                  "{%s, %s, %s, %s}\n",
425                  (is_cable_select_overridden() ? "* " : ""), isci_host->id,
426                  lookup_cable_names(decode_cable_selection(isci_host, 3)),
427                  lookup_cable_names(decode_cable_selection(isci_host, 2)),
428                  lookup_cable_names(decode_cable_selection(isci_host, 1)),
429                  lookup_cable_names(decode_cable_selection(isci_host, 0)));
430
431         err = isci_host_init(isci_host);
432         if (err)
433                 goto err_shost;
434
435         SHOST_TO_SAS_HA(shost) = &isci_host->sas_ha;
436         isci_host->sas_ha.core.shost = shost;
437         shost->transportt = isci_transport_template;
438
439         shost->max_id = ~0;
440         shost->max_lun = ~0;
441         shost->max_cmd_len = MAX_COMMAND_SIZE;
442
443         err = scsi_add_host(shost, &pdev->dev);
444         if (err)
445                 goto err_shost;
446
447         err = isci_register_sas_ha(isci_host);
448         if (err)
449                 goto err_shost_remove;
450
451         return isci_host;
452
453  err_shost_remove:
454         scsi_remove_host(shost);
455  err_shost:
456         scsi_host_put(shost);
457
458         return NULL;
459 }
460
461 static int __devinit isci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
462 {
463         struct isci_pci_info *pci_info;
464         int err, i;
465         struct isci_host *isci_host;
466         const struct firmware *fw = NULL;
467         struct isci_orom *orom = NULL;
468         char *source = "(platform)";
469
470         dev_info(&pdev->dev, "driver configured for rev: %d silicon\n",
471                  pdev->revision);
472
473         pci_info = devm_kzalloc(&pdev->dev, sizeof(*pci_info), GFP_KERNEL);
474         if (!pci_info)
475                 return -ENOMEM;
476         pci_set_drvdata(pdev, pci_info);
477
478         if (efi_enabled)
479                 orom = isci_get_efi_var(pdev);
480
481         if (!orom)
482                 orom = isci_request_oprom(pdev);
483
484         for (i = 0; orom && i < ARRAY_SIZE(orom->ctrl); i++) {
485                 if (sci_oem_parameters_validate(&orom->ctrl[i],
486                                                 orom->hdr.version)) {
487                         dev_warn(&pdev->dev,
488                                  "[%d]: invalid oem parameters detected, falling back to firmware\n", i);
489                         devm_kfree(&pdev->dev, orom);
490                         orom = NULL;
491                         break;
492                 }
493         }
494
495         if (!orom) {
496                 source = "(firmware)";
497                 orom = isci_request_firmware(pdev, fw);
498                 if (!orom) {
499                         /* TODO convert this to WARN_TAINT_ONCE once the
500                          * orom/efi parameter support is widely available
501                          */
502                         dev_warn(&pdev->dev,
503                                  "Loading user firmware failed, using default "
504                                  "values\n");
505                         dev_warn(&pdev->dev,
506                                  "Default OEM configuration being used: 4 "
507                                  "narrow ports, and default SAS Addresses\n");
508                 }
509         }
510
511         if (orom)
512                 dev_info(&pdev->dev,
513                          "OEM SAS parameters (version: %u.%u) loaded %s\n",
514                          (orom->hdr.version & 0xf0) >> 4,
515                          (orom->hdr.version & 0xf), source);
516
517         pci_info->orom = orom;
518
519         err = isci_pci_init(pdev);
520         if (err)
521                 return err;
522
523         for (i = 0; i < num_controllers(pdev); i++) {
524                 struct isci_host *h = isci_host_alloc(pdev, i);
525
526                 if (!h) {
527                         err = -ENOMEM;
528                         goto err_host_alloc;
529                 }
530                 pci_info->hosts[i] = h;
531
532                 /* turn on DIF support */
533                 scsi_host_set_prot(h->shost,
534                                    SHOST_DIF_TYPE1_PROTECTION |
535                                    SHOST_DIF_TYPE2_PROTECTION |
536                                    SHOST_DIF_TYPE3_PROTECTION);
537                 scsi_host_set_guard(h->shost, SHOST_DIX_GUARD_CRC);
538         }
539
540         err = isci_setup_interrupts(pdev);
541         if (err)
542                 goto err_host_alloc;
543
544         for_each_isci_host(i, isci_host, pdev)
545                 scsi_scan_host(isci_host->shost);
546
547         return 0;
548
549  err_host_alloc:
550         for_each_isci_host(i, isci_host, pdev)
551                 isci_unregister(isci_host);
552         return err;
553 }
554
555 static void __devexit isci_pci_remove(struct pci_dev *pdev)
556 {
557         struct isci_host *ihost;
558         int i;
559
560         for_each_isci_host(i, ihost, pdev) {
561                 isci_unregister(ihost);
562                 isci_host_deinit(ihost);
563                 sci_controller_disable_interrupts(ihost);
564         }
565 }
566
567 static struct pci_driver isci_pci_driver = {
568         .name           = DRV_NAME,
569         .id_table       = isci_id_table,
570         .probe          = isci_pci_probe,
571         .remove         = __devexit_p(isci_pci_remove),
572 };
573
574 static __init int isci_init(void)
575 {
576         int err;
577
578         pr_info("%s: Intel(R) C600 SAS Controller Driver - version %s\n",
579                 DRV_NAME, DRV_VERSION);
580
581         isci_transport_template = sas_domain_attach_transport(&isci_transport_ops);
582         if (!isci_transport_template)
583                 return -ENOMEM;
584
585         err = pci_register_driver(&isci_pci_driver);
586         if (err)
587                 sas_release_transport(isci_transport_template);
588
589         return err;
590 }
591
592 static __exit void isci_exit(void)
593 {
594         pci_unregister_driver(&isci_pci_driver);
595         sas_release_transport(isci_transport_template);
596 }
597
598 MODULE_LICENSE("Dual BSD/GPL");
599 MODULE_FIRMWARE(ISCI_FW_NAME);
600 module_init(isci_init);
601 module_exit(isci_exit);