drivers/scsi/isci/port.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 /**
  57  * This file contains the isci port implementation.
  58  *
  59  *
  60  */
  61
  62
  63 #include <linux/workqueue.h>
  64 #include "isci.h"
  65 #include "scic_io_request.h"
  66 #include "scic_phy.h"
  67 #include "scic_sds_phy.h"
  68 #include "scic_port.h"
  69 #include "port.h"
  70 #include "request.h"
  71 #include "core/scic_sds_controller.h"
  72
  73 static void isci_port_change_state(
  74         struct isci_port *isci_port,
  75         enum isci_status status);
  76
  77
  78
  79 /**
  80  * isci_port_init() - This function initializes the given isci_port object.
  81  * @isci_port: This parameter specifies the port object to be initialized.
  82  * @isci_host: This parameter specifies parent controller object for the port.
  83  * @index: This parameter specifies which SCU port the isci_port associates
  84  *    with. Generally, SCU port 0 relates to isci_port 0, etc.
  85  *
  86  */
  87 void isci_port_init(
  88         struct isci_port *isci_port,
  89         struct isci_host *isci_host,
  90         int index)
  91 {
  92         struct scic_sds_port *scic_port;
  93         struct scic_sds_controller *controller = isci_host->core_controller;
  94
  95         INIT_LIST_HEAD(&isci_port->remote_dev_list);
  96         INIT_LIST_HEAD(&isci_port->domain_dev_list);
  97         spin_lock_init(&isci_port->state_lock);
  98         init_completion(&isci_port->start_complete);
  99         isci_port->isci_host = isci_host;
 100         isci_port_change_state(isci_port, isci_freed);
 101
 102         (void)scic_controller_get_port_handle(controller, index, &scic_port);
 103         sci_object_set_association(scic_port, isci_port);
 104         isci_port->sci_port_handle = scic_port;
 105 }
 106
 107
 108 /**
 109  * isci_port_get_state() - This function gets the status of the port object.
 110  * @isci_port: This parameter points to the isci_port object
 111  *
 112  * status of the object as a isci_status enum.
 113  */
 114 enum isci_status isci_port_get_state(
 115         struct isci_port *isci_port)
 116 {
 117         return isci_port->status;
 118 }
 119
 120 static void isci_port_change_state(
 121         struct isci_port *isci_port,
 122         enum isci_status status)
 123 {
 124         unsigned long flags;
 125
 126         dev_dbg(&isci_port->isci_host->pdev->dev,
 127                 "%s: isci_port = %p, state = 0x%x\n",
 128                 __func__, isci_port, status);
 129
 130         spin_lock_irqsave(&isci_port->state_lock, flags);
 131         isci_port->status = status;
 132         spin_unlock_irqrestore(&isci_port->state_lock, flags);
 133 }
 134
 135 void isci_port_bc_change_received(
 136         struct isci_host *isci_host,
 137         struct scic_sds_port *port,
 138         struct scic_sds_phy *phy)
 139 {
 140         struct isci_phy *isci_phy = phy->iphy;
 141
 142         dev_dbg(&isci_host->pdev->dev,
 143                 "%s: isci_phy = %p, sas_phy = %p\n",
 144                 __func__,
 145                 isci_phy,
 146                 &isci_phy->sas_phy);
 147
 148         isci_host->sas_ha.notify_port_event(
 149                 &isci_phy->sas_phy,
 150                 PORTE_BROADCAST_RCVD
 151                 );
 152
 153         scic_port_enable_broadcast_change_notification(port);
 154 }
 155
 156 /**
 157  * isci_port_link_up() - This function is called by the sci core when a link
 158  *    becomes active. the identify address frame is retrieved from the core and
 159  *    a notify port event is sent to libsas.
 160  * @isci_host: This parameter specifies the isci host object.
 161  * @port: This parameter specifies the sci port with the active link.
 162  * @phy: This parameter specifies the sci phy with the active link.
 163  *
 164  */
 165 void isci_port_link_up(
 166         struct isci_host *isci_host,
 167         struct scic_sds_port *port,
 168         struct scic_sds_phy *phy)
 169 {
 170         unsigned long flags;
 171         struct scic_port_properties properties;
 172         struct isci_port *isci_port
 173                 = (struct isci_port *)sci_object_get_association(port);
 174         struct isci_phy *isci_phy = phy->iphy;
 175         enum sci_status call_status;
 176         unsigned long success = true;
 177
 178         BUG_ON(isci_phy->isci_port != NULL);
 179
 180         isci_phy->isci_port = isci_port;
 181
 182         dev_dbg(&isci_host->pdev->dev,
 183                 "%s: isci_port = %p\n",
 184                 __func__, isci_port);
 185
 186         spin_lock_irqsave(&isci_phy->sas_phy.frame_rcvd_lock, flags);
 187
 188         isci_port_change_state(isci_phy->isci_port, isci_starting);
 189
 190         scic_port_get_properties(port, &properties);
 191
 192         if (properties.remote.protocols.u.bits.stp_target) {
 193                 u64 attached_sas_address;
 194
 195                 struct scic_sata_phy_properties sata_phy_properties;
 196
 197                 isci_phy->sas_phy.oob_mode = SATA_OOB_MODE;
 198
 199                 /* Get a copy of the signature fis for libsas */
 200                 call_status = scic_sata_phy_get_properties(phy,
 201                                                            &sata_phy_properties);
 202
 203                 /*
 204                  * XXX I am concerned about this "assert". shouldn't we
 205                  * handle the return appropriately?
 206                  */
 207                 BUG_ON(call_status != SCI_SUCCESS);
 208
 209                 memcpy(isci_phy->frame_rcvd.fis,
 210                        &sata_phy_properties.signature_fis,
 211                        sizeof(struct sata_fis_reg_d2h));
 212
 213                 isci_phy->sas_phy.frame_rcvd_size = sizeof(struct sata_fis_reg_d2h);
 214
 215                 /*
 216                  * For direct-attached SATA devices, the SCI core will
 217                  * automagically assign a SAS address to the end device
 218                  * for the purpose of creating a port. This SAS address
 219                  * will not be the same as assigned to the PHY and needs
 220                  * to be obtained from struct scic_port_properties properties.
 221                  */
 222                 attached_sas_address = properties.remote.sas_address.high;
 223                 attached_sas_address <<= 32;
 224                 attached_sas_address |= properties.remote.sas_address.low;
 225                 swab64s(&attached_sas_address);
 226
 227                 memcpy(&isci_phy->sas_phy.attached_sas_addr,
 228                        &attached_sas_address, sizeof(attached_sas_address));
 229
 230         } else if (properties.remote.protocols.u.bits.ssp_target ||
 231                    properties.remote.protocols.u.bits.smp_target) {
 232
 233                 struct scic_sas_phy_properties sas_phy_properties;
 234
 235                 isci_phy->sas_phy.oob_mode = SAS_OOB_MODE;
 236
 237                 /* Get a copy of the identify address frame for libsas */
 238                 call_status = scic_sas_phy_get_properties(phy,
 239                                                           &sas_phy_properties);
 240
 241                 BUG_ON(call_status != SCI_SUCCESS);
 242
 243                 memcpy(isci_phy->frame_rcvd.aif,
 244                        &(sas_phy_properties.received_iaf),
 245                        sizeof(struct sci_sas_identify_address_frame));
 246
 247                 isci_phy->sas_phy.frame_rcvd_size
 248                         = sizeof(struct sci_sas_identify_address_frame);
 249
 250                 /* Copy the attached SAS address from the IAF */
 251                 memcpy(isci_phy->sas_phy.attached_sas_addr,
 252                        ((struct sas_identify_frame *)
 253                         (&isci_phy->frame_rcvd.aif))->sas_addr,
 254                        SAS_ADDR_SIZE);
 255
 256         } else {
 257                 dev_err(&isci_host->pdev->dev, "%s: unkown target\n", __func__);
 258                 success = false;
 259         }
 260
 261         isci_phy->sas_phy.phy->negotiated_linkrate = sci_phy_linkrate(phy);
 262
 263         spin_unlock_irqrestore(&isci_phy->sas_phy.frame_rcvd_lock, flags);
 264
 265         /* Notify libsas that we have an address frame, if indeed
 266          * we've found an SSP, SMP, or STP target */
 267         if (success)
 268                 isci_host->sas_ha.notify_port_event(&isci_phy->sas_phy,
 269                                                     PORTE_BYTES_DMAED);
 270 }
 271
 272
 273 /**
 274  * isci_port_link_down() - This function is called by the sci core when a link
 275  *    becomes inactive.
 276  * @isci_host: This parameter specifies the isci host object.
 277  * @phy: This parameter specifies the isci phy with the active link.
 278  * @port: This parameter specifies the isci port with the active link.
 279  *
 280  */
 281 void isci_port_link_down(struct isci_host *isci_host, struct isci_phy *isci_phy,
 282                          struct isci_port *isci_port)
 283 {
 284         struct isci_remote_device *isci_device;
 285
 286         dev_dbg(&isci_host->pdev->dev,
 287                 "%s: isci_port = %p\n", __func__, isci_port);
 288
 289         if (isci_port) {
 290
 291                 /* check to see if this is the last phy on this port. */
 292                 if (isci_phy->sas_phy.port
 293                     && isci_phy->sas_phy.port->num_phys == 1) {
 294
 295                         /* change the state for all devices on this port.
 296                          * The next task sent to this device will be returned
 297                          * as SAS_TASK_UNDELIVERED, and the scsi mid layer
 298                          * will remove the target
 299                          */
 300                         list_for_each_entry(isci_device,
 301                                             &isci_port->remote_dev_list,
 302                                             node) {
 303                                 dev_dbg(&isci_host->pdev->dev,
 304                                         "%s: isci_device = %p\n",
 305                                         __func__, isci_device);
 306                                 isci_remote_device_change_state(isci_device,
 307                                                                 isci_stopping);
 308                         }
 309                 }
 310                 isci_port_change_state(isci_port, isci_stopping);
 311         }
 312
 313         /* Notify libsas of the borken link, this will trigger calls to our
 314          * isci_port_deformed and isci_dev_gone functions.
 315          */
 316         sas_phy_disconnected(&isci_phy->sas_phy);
 317         isci_host->sas_ha.notify_phy_event(&isci_phy->sas_phy,
 318                                            PHYE_LOSS_OF_SIGNAL);
 319
 320         isci_phy->isci_port = NULL;
 321
 322         dev_dbg(&isci_host->pdev->dev,
 323                 "%s: isci_port = %p - Done\n", __func__, isci_port);
 324 }
 325
 326
 327 /**
 328  * isci_port_deformed() - This function is called by libsas when a port becomes
 329  *    inactive.
 330  * @phy: This parameter specifies the libsas phy with the inactive port.
 331  *
 332  */
 333 void isci_port_deformed(
 334         struct asd_sas_phy *phy)
 335 {
 336         pr_debug("%s: sas_phy = %p\n", __func__, phy);
 337 }
 338
 339 /**
 340  * isci_port_formed() - This function is called by libsas when a port becomes
 341  *    active.
 342  * @phy: This parameter specifies the libsas phy with the active port.
 343  *
 344  */
 345 void isci_port_formed(
 346         struct asd_sas_phy *phy)
 347 {
 348         pr_debug("%s: sas_phy = %p, sas_port = %p\n", __func__, phy, phy->port);
 349 }
 350
 351 /**
 352  * isci_port_ready() - This function is called by the sci core when a link
 353  *    becomes ready.
 354  * @isci_host: This parameter specifies the isci host object.
 355  * @port: This parameter specifies the sci port with the active link.
 356  *
 357  */
 358 void isci_port_ready(struct isci_host *isci_host, struct isci_port *isci_port)
 359 {
 360         dev_dbg(&isci_host->pdev->dev,
 361                 "%s: isci_port = %p\n", __func__, isci_port);
 362
 363         complete_all(&isci_port->start_complete);
 364         isci_port_change_state(isci_port, isci_ready);
 365         return;
 366 }
 367
 368 /**
 369  * isci_port_not_ready() - This function is called by the sci core when a link
 370  *    is not ready. All remote devices on this link will be removed if they are
 371  *    in the stopping state.
 372  * @isci_host: This parameter specifies the isci host object.
 373  * @port: This parameter specifies the sci port with the active link.
 374  *
 375  */
 376 void isci_port_not_ready(struct isci_host *isci_host, struct isci_port *isci_port)
 377 {
 378         dev_dbg(&isci_host->pdev->dev,
 379                 "%s: isci_port = %p\n", __func__, isci_port);
 380 }
 381
 382 /**
 383  * isci_port_hard_reset_complete() - This function is called by the sci core
 384  *    when the hard reset complete notification has been received.
 385  * @port: This parameter specifies the sci port with the active link.
 386  * @completion_status: This parameter specifies the core status for the reset
 387  *    process.
 388  *
 389  */
 390 void isci_port_hard_reset_complete(struct isci_port *isci_port,
 391                                    enum sci_status completion_status)
 392 {
 393         dev_dbg(&isci_port->isci_host->pdev->dev,
 394                 "%s: isci_port = %p, completion_status=%x\n",
 395                      __func__, isci_port, completion_status);
 396
 397         /* Save the status of the hard reset from the port. */
 398         isci_port->hard_reset_status = completion_status;
 399
 400         complete_all(&isci_port->hard_reset_complete);
 401 }
 402
 403 int isci_port_perform_hard_reset(struct isci_host *ihost, struct isci_port *iport,
 404                                  struct isci_phy *iphy)
 405 {
 406         unsigned long flags;
 407         enum sci_status status;
 408         int ret = TMF_RESP_FUNC_COMPLETE;
 409
 410         dev_dbg(&ihost->pdev->dev, "%s: iport = %p\n",
 411                 __func__, iport);
 412
 413         init_completion(&iport->hard_reset_complete);
 414
 415         spin_lock_irqsave(&ihost->scic_lock, flags);
 416
 417         #define ISCI_PORT_RESET_TIMEOUT SCIC_SDS_SIGNATURE_FIS_TIMEOUT
 418         status = scic_port_hard_reset(iport->sci_port_handle,
 419                                       ISCI_PORT_RESET_TIMEOUT);
 420
 421         spin_unlock_irqrestore(&ihost->scic_lock, flags);
 422
 423         if (status == SCI_SUCCESS) {
 424                 wait_for_completion(&iport->hard_reset_complete);
 425
 426                 dev_dbg(&ihost->pdev->dev,
 427                         "%s: iport = %p; hard reset completion\n",
 428                         __func__, iport);
 429
 430                 if (iport->hard_reset_status != SCI_SUCCESS)
 431                         ret = TMF_RESP_FUNC_FAILED;
 432         } else {
 433                 ret = TMF_RESP_FUNC_FAILED;
 434
 435                 dev_err(&ihost->pdev->dev,
 436                         "%s: iport = %p; scic_port_hard_reset call"
 437                         " failed 0x%x\n",
 438                         __func__, iport, status);
 439
 440         }
 441
 442         /* If the hard reset for the port has failed, consider this
 443          * the same as link failures on all phys in the port.
 444          */
 445         if (ret != TMF_RESP_FUNC_COMPLETE) {
 446                 dev_err(&ihost->pdev->dev,
 447                         "%s: iport = %p; hard reset failed "
 448                         "(0x%x) - sending link down to libsas for phy %p\n",
 449                         __func__, iport, iport->hard_reset_status, iphy);
 450
 451                 isci_port_link_down(ihost, iphy, iport);
 452         }
 453
 454         return ret;
 455 }
 456
 457 /**
 458  * isci_port_invalid_link_up() - This function informs the SCI Core user that
 459  *    a phy/link became ready, but the phy is not allowed in the port.  In some
 460  *    situations the underlying hardware only allows for certain phy to port
 461  *    mappings.  If these mappings are violated, then this API is invoked.
 462  * @controller: This parameter represents the controller which contains the
 463  *    port.
 464  * @port: This parameter specifies the SCI port object for which the callback
 465  *    is being invoked.
 466  * @phy: This parameter specifies the phy that came ready, but the phy can't be
 467  *    a valid member of the port.
 468  *
 469  */
 470 void isci_port_invalid_link_up(struct scic_sds_controller *scic,
 471                                       struct scic_sds_port *sci_port,
 472                                       struct scic_sds_phy *phy)
 473 {
 474         struct isci_host *ihost = scic->ihost;
 475
 476         dev_warn(&ihost->pdev->dev, "Invalid link up!\n");
 477 }
 478
 479 void isci_port_stop_complete(struct scic_sds_controller *scic,
 480                                           struct scic_sds_port *sci_port,
 481                                           enum sci_status completion_status)
 482 {
 483         struct isci_host *ihost = scic->ihost;
 484
 485         dev_dbg(&ihost->pdev->dev, "Port stop complete\n");
 486 }