drivers/scsi/isci/remote_node_context.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 _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
  57 #define _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
  58
  59 /**
  60  * This file contains the structures, constants, and prototypes associated with
  61  *    the remote node context in the silicon.  It exists to model and manage
  62  *    the remote node context in the silicon.
  63  *
  64  *
  65  */
  66
  67 #include "state_machine.h"
  68
  69 /**
  70  *
  71  *
  72  * This constant represents an invalid remote device id, it is used to program
  73  * the STPDARNI register so the driver knows when it has received a SIGNATURE
  74  * FIS from the SCU.
  75  */
  76 #define SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX    0x0FFF
  77
  78 #define SCU_HARDWARE_SUSPENSION  (0)
  79 #define SCI_SOFTWARE_SUSPENSION  (1)
  80
  81 struct scic_sds_request;
  82 struct scic_sds_remote_device;
  83 struct scic_sds_remote_node_context;
  84
  85 typedef void (*scics_sds_remote_node_context_callback)(void *);
  86
  87 typedef enum sci_status (*scic_sds_remote_node_context_operation)(
  88         struct scic_sds_remote_node_context *sci_rnc,
  89         scics_sds_remote_node_context_callback callback,
  90         void *callback_parameter
  91         );
  92
  93 typedef enum sci_status (*scic_sds_remote_node_context_suspend_operation)(
  94         struct scic_sds_remote_node_context *sci_rnc,
  95         u32 suspension_type,
  96         scics_sds_remote_node_context_callback callback,
  97         void *callback_parameter
  98         );
  99
 100 typedef enum sci_status (*scic_sds_remote_node_context_io_request)(
 101         struct scic_sds_remote_node_context *sci_rnc,
 102         struct scic_sds_request *sci_req
 103         );
 104
 105 typedef enum sci_status (*scic_sds_remote_node_context_event_handler)(
 106         struct scic_sds_remote_node_context *sci_rnc,
 107         u32 event_code
 108         );
 109
 110 struct scic_sds_remote_node_context_handlers {
 111         /**
 112          * This handle is invoked to stop the RNC.  The callback is invoked when after
 113          * the hardware notification that the RNC has been invalidated.
 114          */
 115         scic_sds_remote_node_context_operation destruct_handler;
 116
 117         /**
 118          * This handler is invoked when there is a request to suspend  the RNC.  The
 119          * callback is invoked after the hardware notification that the remote node is
 120          * suspended.
 121          */
 122         scic_sds_remote_node_context_suspend_operation suspend_handler;
 123
 124         /**
 125          * This handler is invoked when there is a request to resume the RNC.  The
 126          * callback is invoked when after the RNC has reached the ready state.
 127          */
 128         scic_sds_remote_node_context_operation resume_handler;
 129
 130         /**
 131          * This handler is invoked when there is a request to start an io request
 132          * operation.
 133          */
 134         scic_sds_remote_node_context_io_request start_io_handler;
 135
 136         /**
 137          * This handler is invoked when there is a request to start a task request
 138          * operation.
 139          */
 140         scic_sds_remote_node_context_io_request start_task_handler;
 141
 142         /**
 143          * This handler is invoked where there is an RNC event that must be processed.
 144          */
 145         scic_sds_remote_node_context_event_handler event_handler;
 146
 147 };
 148
 149 /**
 150  * This is the enumeration of the remote node context states.
 151  */
 152 enum scis_sds_remote_node_context_states {
 153         /**
 154          * This state is the initial state for a remote node context.  On a resume
 155          * request the remote node context will transition to the posting state.
 156          */
 157         SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE,
 158
 159         /**
 160          * This is a transition state that posts the RNi to the hardware. Once the RNC
 161          * is posted the remote node context will be made ready.
 162          */
 163         SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE,
 164
 165         /**
 166          * This is a transition state that will post an RNC invalidate to the
 167          * hardware.  Once the invalidate is complete the remote node context will
 168          * transition to the posting state.
 169          */
 170         SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE,
 171
 172         /**
 173          * This is a transition state that will post an RNC resume to the hardare.
 174          * Once the event notification of resume complete is received the remote node
 175          * context will transition to the ready state.
 176          */
 177         SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE,
 178
 179         /**
 180          * This is the state that the remote node context must be in to accept io
 181          * request operations.
 182          */
 183         SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE,
 184
 185         /**
 186          * This is the state that the remote node context transitions to when it gets
 187          * a TX suspend notification from the hardware.
 188          */
 189         SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE,
 190
 191         /**
 192          * This is the state that the remote node context transitions to when it gets
 193          * a TX RX suspend notification from the hardware.
 194          */
 195         SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE,
 196
 197         /**
 198          * This state is a wait state for the remote node context that waits for a
 199          * suspend notification from the hardware.  This state is entered when either
 200          * there is a request to supend the remote node context or when there is a TC
 201          * completion where the remote node will be suspended by the hardware.
 202          */
 203         SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE
 204 };
 205
 206 /**
 207  *
 208  *
 209  * This enumeration is used to define the end destination state for the remote
 210  * node context.
 211  */
 212 enum scic_sds_remote_node_context_destination_state {
 213         SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED,
 214         SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY,
 215         SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL
 216 };
 217
 218 /**
 219  * struct scic_sds_remote_node_context - This structure contains the data
 220  *    associated with the remote node context object.  The remote node context
 221  *    (RNC) object models the the remote device information necessary to manage
 222  *    the silicon RNC.
 223  */
 224 struct scic_sds_remote_node_context {
 225         /**
 226          * This field indicates the remote node index (RNI) associated with
 227          * this RNC.
 228          */
 229         u16 remote_node_index;
 230
 231         /**
 232          * This field is the recored suspension code or the reason for the remote node
 233          * context suspension.
 234          */
 235         u32 suspension_code;
 236
 237         /**
 238          * This field is true if the remote node context is resuming from its current
 239          * state.  This can cause an automatic resume on receiving a suspension
 240          * notification.
 241          */
 242         enum scic_sds_remote_node_context_destination_state destination_state;
 243
 244         /**
 245          * This field contains the callback function that the user requested to be
 246          * called when the requested state transition is complete.
 247          */
 248         scics_sds_remote_node_context_callback user_callback;
 249
 250         /**
 251          * This field contains the parameter that is called when the user requested
 252          * state transition is completed.
 253          */
 254         void *user_cookie;
 255
 256         /**
 257          * This field contains the data for the object's state machine.
 258          */
 259         struct sci_base_state_machine state_machine;
 260
 261         struct scic_sds_remote_node_context_handlers *state_handlers;
 262 };
 263
 264 void scic_sds_remote_node_context_construct(struct scic_sds_remote_node_context *rnc,
 265                                             u16 remote_node_index);
 266
 267
 268 bool scic_sds_remote_node_context_is_ready(
 269         struct scic_sds_remote_node_context *sci_rnc);
 270
 271 #define scic_sds_remote_node_context_get_remote_node_index(rcn) \
 272         ((rnc)->remote_node_index)
 273
 274 #define scic_sds_remote_node_context_event_handler(rnc, event_code) \
 275         ((rnc)->state_handlers->event_handler(rnc, event_code))
 276
 277 #define scic_sds_remote_node_context_resume(rnc, callback, parameter) \
 278         ((rnc)->state_handlers->resume_handler(rnc, callback, parameter))
 279
 280 #define scic_sds_remote_node_context_suspend(rnc, suspend_type, callback, parameter) \
 281         ((rnc)->state_handlers->suspend_handler(rnc, suspend_type, callback, parameter))
 282
 283 #define scic_sds_remote_node_context_destruct(rnc, callback, parameter) \
 284         ((rnc)->state_handlers->destruct_handler(rnc, callback, parameter))
 285
 286 #define scic_sds_remote_node_context_start_io(rnc, request) \
 287         ((rnc)->state_handlers->start_io_handler(rnc, request))
 288
 289 #define scic_sds_remote_node_context_start_task(rnc, task) \
 290         ((rnc)->state_handlers->start_task_handler(rnc, task))
 291
 292 #endif  /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */