drivers/scsi/isci/remote_device.h

   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 #ifndef _ISCI_REMOTE_DEVICE_H_
  57 #define _ISCI_REMOTE_DEVICE_H_
  58 #include <scsi/libsas.h>
  59 #include <linux/kref.h>
  60 #include "scu_remote_node_context.h"
  61 #include "remote_node_context.h"
  62 #include "port.h"
  63
  64 enum sci_remote_device_not_ready_reason_code {
  65         SCIC_REMOTE_DEVICE_NOT_READY_START_REQUESTED,
  66         SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED,
  67         SCIC_REMOTE_DEVICE_NOT_READY_SATA_REQUEST_STARTED,
  68         SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED,
  69         SCIC_REMOTE_DEVICE_NOT_READY_SMP_REQUEST_STARTED,
  70         SCIC_REMOTE_DEVICE_NOT_READY_REASON_CODE_MAX
  71 };
  72
  73 /**
  74  * isci_remote_device - isci representation of a sas expander / end point
  75  * @device_port_width: hw setting for number of simultaneous connections
  76  * @connection_rate: per-taskcontext connection rate for this device
  77  * @working_request: SATA requests have no tag we for unaccelerated
  78  *                   protocols we need a method to associate unsolicited
  79  *                   frames with a pending request
  80  */
  81 struct isci_remote_device {
  82         #define IDEV_START_PENDING 0
  83         #define IDEV_STOP_PENDING 1
  84         #define IDEV_ALLOCATED 2
  85         #define IDEV_GONE 3
  86         #define IDEV_IO_READY 4
  87         #define IDEV_IO_NCQERROR 5
  88         unsigned long flags;
  89         struct kref kref;
  90         struct isci_port *isci_port;
  91         struct domain_device *domain_dev;
  92         struct list_head node;
  93         struct list_head reqs_in_process;
  94         struct sci_base_state_machine sm;
  95         u32 device_port_width;
  96         enum sas_linkrate connection_rate;
  97         bool is_direct_attached;
  98         struct isci_port *owning_port;
  99         struct sci_remote_node_context rnc;
 100         /* XXX unify with device reference counting and delete */
 101         u32 started_request_count;
 102         struct isci_request *working_request;
 103         u32 not_ready_reason;
 104 };
 105
 106 #define ISCI_REMOTE_DEVICE_START_TIMEOUT 5000
 107
 108 /* device reference routines must be called under sci_lock */
 109 static inline struct isci_remote_device *isci_lookup_device(struct domain_device *dev)
 110 {
 111         struct isci_remote_device *idev = dev->lldd_dev;
 112
 113         if (idev && !test_bit(IDEV_GONE, &idev->flags)) {
 114                 kref_get(&idev->kref);
 115                 return idev;
 116         }
 117
 118         return NULL;
 119 }
 120
 121 void isci_remote_device_release(struct kref *kref);
 122 static inline void isci_put_device(struct isci_remote_device *idev)
 123 {
 124         if (idev)
 125                 kref_put(&idev->kref, isci_remote_device_release);
 126 }
 127
 128 enum sci_status isci_remote_device_stop(struct isci_host *ihost,
 129                                         struct isci_remote_device *idev);
 130 void isci_remote_device_nuke_requests(struct isci_host *ihost,
 131                                       struct isci_remote_device *idev);
 132 void isci_remote_device_gone(struct domain_device *domain_dev);
 133 int isci_remote_device_found(struct domain_device *domain_dev);
 134
 135 /**
 136  * sci_remote_device_stop() - This method will stop both transmission and
 137  *    reception of link activity for the supplied remote device.  This method
 138  *    disables normal IO requests from flowing through to the remote device.
 139  * @remote_device: This parameter specifies the device to be stopped.
 140  * @timeout: This parameter specifies the number of milliseconds in which the
 141  *    stop operation should complete.
 142  *
 143  * An indication of whether the device was successfully stopped. SCI_SUCCESS
 144  * This value is returned if the transmission and reception for the device was
 145  * successfully stopped.
 146  */
 147 enum sci_status sci_remote_device_stop(
 148         struct isci_remote_device *idev,
 149         u32 timeout);
 150
 151 /**
 152  * sci_remote_device_reset() - This method will reset the device making it
 153  *    ready for operation. This method must be called anytime the device is
 154  *    reset either through a SMP phy control or a port hard reset request.
 155  * @remote_device: This parameter specifies the device to be reset.
 156  *
 157  * This method does not actually cause the device hardware to be reset. This
 158  * method resets the software object so that it will be operational after a
 159  * device hardware reset completes. An indication of whether the device reset
 160  * was accepted. SCI_SUCCESS This value is returned if the device reset is
 161  * started.
 162  */
 163 enum sci_status sci_remote_device_reset(
 164         struct isci_remote_device *idev);
 165
 166 /**
 167  * sci_remote_device_reset_complete() - This method informs the device object
 168  *    that the reset operation is complete and the device can resume operation
 169  *    again.
 170  * @remote_device: This parameter specifies the device which is to be informed
 171  *    of the reset complete operation.
 172  *
 173  * An indication that the device is resuming operation. SCI_SUCCESS the device
 174  * is resuming operation.
 175  */
 176 enum sci_status sci_remote_device_reset_complete(
 177         struct isci_remote_device *idev);
 178
 179 /**
 180  * enum sci_remote_device_states - This enumeration depicts all the states
 181  *    for the common remote device state machine.
 182  *
 183  *
 184  */
 185 enum sci_remote_device_states {
 186         /**
 187          * Simply the initial state for the base remote device state machine.
 188          */
 189         SCI_DEV_INITIAL,
 190
 191         /**
 192          * This state indicates that the remote device has successfully been
 193          * stopped.  In this state no new IO operations are permitted.
 194          * This state is entered from the INITIAL state.
 195          * This state is entered from the STOPPING state.
 196          */
 197         SCI_DEV_STOPPED,
 198
 199         /**
 200          * This state indicates the the remote device is in the process of
 201          * becoming ready (i.e. starting).  In this state no new IO operations
 202          * are permitted.
 203          * This state is entered from the STOPPED state.
 204          */
 205         SCI_DEV_STARTING,
 206
 207         /**
 208          * This state indicates the remote device is now ready.  Thus, the user
 209          * is able to perform IO operations on the remote device.
 210          * This state is entered from the STARTING state.
 211          */
 212         SCI_DEV_READY,
 213
 214         /**
 215          * This is the idle substate for the stp remote device.  When there are no
 216          * active IO for the device it is is in this state.
 217          */
 218         SCI_STP_DEV_IDLE,
 219
 220         /**
 221          * This is the command state for for the STP remote device.  This state is
 222          * entered when the device is processing a non-NCQ command.  The device object
 223          * will fail any new start IO requests until this command is complete.
 224          */
 225         SCI_STP_DEV_CMD,
 226
 227         /**
 228          * This is the NCQ state for the STP remote device.  This state is entered
 229          * when the device is processing an NCQ reuqest.  It will remain in this state
 230          * so long as there is one or more NCQ requests being processed.
 231          */
 232         SCI_STP_DEV_NCQ,
 233
 234         /**
 235          * This is the NCQ error state for the STP remote device.  This state is
 236          * entered when an SDB error FIS is received by the device object while in the
 237          * NCQ state.  The device object will only accept a READ LOG command while in
 238          * this state.
 239          */
 240         SCI_STP_DEV_NCQ_ERROR,
 241
 242         /**
 243          * This is the ATAPI error state for the STP ATAPI remote device.
 244          * This state is entered when ATAPI device sends error status FIS
 245          * without data while the device object is in CMD state.
 246          * A suspension event is expected in this state.
 247          * The device object will resume right away.
 248          */
 249         SCI_STP_DEV_ATAPI_ERROR,
 250
 251         /**
 252          * This is the READY substate indicates the device is waiting for the RESET task
 253          * coming to be recovered from certain hardware specific error.
 254          */
 255         SCI_STP_DEV_AWAIT_RESET,
 256
 257         /**
 258          * This is the ready operational substate for the remote device.  This is the
 259          * normal operational state for a remote device.
 260          */
 261         SCI_SMP_DEV_IDLE,
 262
 263         /**
 264          * This is the suspended state for the remote device.  This is the state that
 265          * the device is placed in when a RNC suspend is received by the SCU hardware.
 266          */
 267         SCI_SMP_DEV_CMD,
 268
 269         /**
 270          * This state indicates that the remote device is in the process of
 271          * stopping.  In this state no new IO operations are permitted, but
 272          * existing IO operations are allowed to complete.
 273          * This state is entered from the READY state.
 274          * This state is entered from the FAILED state.
 275          */
 276         SCI_DEV_STOPPING,
 277
 278         /**
 279          * This state indicates that the remote device has failed.
 280          * In this state no new IO operations are permitted.
 281          * This state is entered from the INITIALIZING state.
 282          * This state is entered from the READY state.
 283          */
 284         SCI_DEV_FAILED,
 285
 286         /**
 287          * This state indicates the device is being reset.
 288          * In this state no new IO operations are permitted.
 289          * This state is entered from the READY state.
 290          */
 291         SCI_DEV_RESETTING,
 292
 293         /**
 294          * Simply the final state for the base remote device state machine.
 295          */
 296         SCI_DEV_FINAL,
 297 };
 298
 299 static inline struct isci_remote_device *rnc_to_dev(struct sci_remote_node_context *rnc)
 300 {
 301         struct isci_remote_device *idev;
 302
 303         idev = container_of(rnc, typeof(*idev), rnc);
 304
 305         return idev;
 306 }
 307
 308 static inline bool dev_is_expander(struct domain_device *dev)
 309 {
 310         return dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV;
 311 }
 312
 313 static inline void sci_remote_device_decrement_request_count(struct isci_remote_device *idev)
 314 {
 315         /* XXX delete this voodoo when converting to the top-level device
 316          * reference count
 317          */
 318         if (WARN_ONCE(idev->started_request_count == 0,
 319                       "%s: tried to decrement started_request_count past 0!?",
 320                         __func__))
 321                 /* pass */;
 322         else
 323                 idev->started_request_count--;
 324 }
 325
 326 enum sci_status sci_remote_device_frame_handler(
 327         struct isci_remote_device *idev,
 328         u32 frame_index);
 329
 330 enum sci_status sci_remote_device_event_handler(
 331         struct isci_remote_device *idev,
 332         u32 event_code);
 333
 334 enum sci_status sci_remote_device_start_io(
 335         struct isci_host *ihost,
 336         struct isci_remote_device *idev,
 337         struct isci_request *ireq);
 338
 339 enum sci_status sci_remote_device_start_task(
 340         struct isci_host *ihost,
 341         struct isci_remote_device *idev,
 342         struct isci_request *ireq);
 343
 344 enum sci_status sci_remote_device_complete_io(
 345         struct isci_host *ihost,
 346         struct isci_remote_device *idev,
 347         struct isci_request *ireq);
 348
 349 enum sci_status sci_remote_device_suspend(
 350         struct isci_remote_device *idev,
 351         u32 suspend_type);
 352
 353 void sci_remote_device_post_request(
 354         struct isci_remote_device *idev,
 355         u32 request);
 356
 357 #endif /* !defined(_ISCI_REMOTE_DEVICE_H_) */