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