drivers/scsi/isci/core/scic_sds_request.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_IO_REQUEST_H_
  57 #define _SCIC_SDS_IO_REQUEST_H_
  58
  59 /**
  60  * This file contains the structures, constants and prototypes for the
  61  *    SCIC_SDS_IO_REQUEST object.
  62  *
  63  *
  64  */
  65
  66 #include "scic_io_request.h"
  67 #include "sci_base_state_machine.h"
  68 #include "scu_task_context.h"
  69
  70 struct scic_sds_controller;
  71 struct scic_sds_remote_device;
  72 struct scic_sds_io_request_state_handler;
  73
  74 /**
  75  * enum _scic_sds_io_request_started_task_mgmt_substates - This enumeration
  76  *    depicts all of the substates for a task management request to be
  77  *    performed in the STARTED super-state.
  78  *
  79  *
  80  */
  81 enum scic_sds_raw_request_started_task_mgmt_substates {
  82         /**
  83          * The AWAIT_TC_COMPLETION sub-state indicates that the started raw
  84          * task management request is waiting for the transmission of the
  85          * initial frame (i.e. command, task, etc.).
  86          */
  87         SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_COMPLETION,
  88
  89         /**
  90          * This sub-state indicates that the started task management request
  91          * is waiting for the reception of an unsolicited frame
  92          * (i.e. response IU).
  93          */
  94         SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_RESPONSE,
  95 };
  96
  97
  98 /**
  99  * enum _scic_sds_smp_request_started_substates - This enumeration depicts all
 100  *    of the substates for a SMP request to be performed in the STARTED
 101  *    super-state.
 102  *
 103  *
 104  */
 105 enum scic_sds_smp_request_started_substates {
 106         /**
 107          * This sub-state indicates that the started task management request
 108          * is waiting for the reception of an unsolicited frame
 109          * (i.e. response IU).
 110          */
 111         SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_RESPONSE,
 112
 113         /**
 114          * The AWAIT_TC_COMPLETION sub-state indicates that the started SMP request is
 115          * waiting for the transmission of the initial frame (i.e. command, task, etc.).
 116          */
 117         SCIC_SDS_SMP_REQUEST_STARTED_SUBSTATE_AWAIT_TC_COMPLETION,
 118 };
 119
 120 struct isci_request;
 121 /**
 122  * struct scic_sds_request - This structure contains or references all of
 123  *    the data necessary to process a task management or normal IO request.
 124  *
 125  *
 126  */
 127 struct scic_sds_request {
 128         /**
 129          * The field specifies that the peer object for the request object.
 130          */
 131         struct isci_request *ireq;
 132
 133         /**
 134          * This field contains the information for the base request state machine.
 135          */
 136         struct sci_base_state_machine state_machine;
 137
 138         void *user_request;
 139
 140         /**
 141          * This field simply points to the controller to which this IO request
 142          * is associated.
 143          */
 144         struct scic_sds_controller *owning_controller;
 145
 146         /**
 147          * This field simply points to the remote device to which this IO request
 148          * is associated.
 149          */
 150         struct scic_sds_remote_device *target_device;
 151
 152         /**
 153          * This field is utilized to determine if the SCI user is managing
 154          * the IO tag for this request or if the core is managing it.
 155          */
 156         bool was_tag_assigned_by_user;
 157
 158         /**
 159          * This field indicates the IO tag for this request.  The IO tag is
 160          * comprised of the task_index and a sequence count. The sequence count
 161          * is utilized to help identify tasks from one life to another.
 162          */
 163         u16 io_tag;
 164
 165         /**
 166          * This field specifies the protocol being utilized for this
 167          * IO request.
 168          */
 169         SCIC_TRANSPORT_PROTOCOL protocol;
 170
 171         /**
 172          * This field indicates the completion status taken from the SCUs
 173          * completion code.  It indicates the completion result for the SCU hardware.
 174          */
 175         u32 scu_status;
 176
 177         /**
 178          * This field indicates the completion status returned to the SCI user.  It
 179          * indicates the users view of the io request completion.
 180          */
 181         u32 sci_status;
 182
 183         /**
 184          * This field contains the value to be utilized when posting (e.g. Post_TC,
 185          * Post_TC_Abort) this request to the silicon.
 186          */
 187         u32 post_context;
 188
 189         void *command_buffer;
 190         void *response_buffer;
 191         struct scu_task_context *task_context_buffer;
 192         struct scu_sgl_element_pair *sgl_element_pair_buffer;
 193
 194         /**
 195          * This field indicates if this request is a task management request or
 196          * normal IO request.
 197          */
 198         bool is_task_management_request;
 199
 200         /**
 201          * This field indicates that this request contains an initialized started
 202          * substate machine.
 203          */
 204         bool has_started_substate_machine;
 205
 206         /**
 207          * This field is a pointer to the stored rx frame data.  It is used in STP
 208          * internal requests and SMP response frames.  If this field is non-NULL the
 209          * saved frame must be released on IO request completion.
 210          *
 211          * @todo In the future do we want to keep a list of RX frame buffers?
 212          */
 213         u32 saved_rx_frame_index;
 214
 215         /**
 216          * This field specifies the data necessary to manage the sub-state
 217          * machine executed while in the SCI_BASE_REQUEST_STATE_STARTED state.
 218          */
 219         struct sci_base_state_machine started_substate_machine;
 220
 221         /**
 222          * This field specifies the current state handlers in place for this
 223          * IO Request object.  This field is updated each time the request
 224          * changes state.
 225          */
 226         const struct scic_sds_io_request_state_handler *state_handlers;
 227
 228         /**
 229          * This field in the recorded device sequence for the io request.  This is
 230          * recorded during the build operation and is compared in the start
 231          * operation.  If the sequence is different then there was a change of
 232          * devices from the build to start operations.
 233          */
 234         u8 device_sequence;
 235
 236 };
 237
 238 /**
 239  * enum sci_base_request_states - This enumeration depicts all the states for
 240  *    the common request state machine.
 241  *
 242  *
 243  */
 244 enum sci_base_request_states {
 245         /**
 246          * Simply the initial state for the base request state machine.
 247          */
 248         SCI_BASE_REQUEST_STATE_INITIAL,
 249
 250         /**
 251          * This state indicates that the request has been constructed. This state
 252          * is entered from the INITIAL state.
 253          */
 254         SCI_BASE_REQUEST_STATE_CONSTRUCTED,
 255
 256         /**
 257          * This state indicates that the request has been started. This state is
 258          * entered from the CONSTRUCTED state.
 259          */
 260         SCI_BASE_REQUEST_STATE_STARTED,
 261
 262         /**
 263          * This state indicates that the request has completed.
 264          * This state is entered from the STARTED state. This state is entered from
 265          * the ABORTING state.
 266          */
 267         SCI_BASE_REQUEST_STATE_COMPLETED,
 268
 269         /**
 270          * This state indicates that the request is in the process of being
 271          * terminated/aborted.
 272          * This state is entered from the CONSTRUCTED state.
 273          * This state is entered from the STARTED state.
 274          */
 275         SCI_BASE_REQUEST_STATE_ABORTING,
 276
 277         /**
 278          * Simply the final state for the base request state machine.
 279          */
 280         SCI_BASE_REQUEST_STATE_FINAL,
 281 };
 282
 283 typedef enum sci_status (*scic_sds_io_request_handler_t)
 284                                 (struct scic_sds_request *request);
 285 typedef enum sci_status (*scic_sds_io_request_frame_handler_t)
 286                                 (struct scic_sds_request *req, u32 frame);
 287 typedef enum sci_status (*scic_sds_io_request_event_handler_t)
 288                                 (struct scic_sds_request *req, u32 event);
 289 typedef enum sci_status (*scic_sds_io_request_task_completion_handler_t)
 290                                 (struct scic_sds_request *req, u32 completion_code);
 291
 292 /**
 293  * struct scic_sds_io_request_state_handler - This is the SDS core definition
 294  *    of the state handlers.
 295  *
 296  *
 297  */
 298 struct scic_sds_io_request_state_handler {
 299         /**
 300          * The start_handler specifies the method invoked when a user attempts to
 301          * start a request.
 302          */
 303         scic_sds_io_request_handler_t start_handler;
 304
 305         /**
 306          * The abort_handler specifies the method invoked when a user attempts to
 307          * abort a request.
 308          */
 309         scic_sds_io_request_handler_t abort_handler;
 310
 311         /**
 312          * The complete_handler specifies the method invoked when a user attempts to
 313          * complete a request.
 314          */
 315         scic_sds_io_request_handler_t complete_handler;
 316
 317         scic_sds_io_request_task_completion_handler_t tc_completion_handler;
 318         scic_sds_io_request_event_handler_t event_handler;
 319         scic_sds_io_request_frame_handler_t frame_handler;
 320
 321 };
 322
 323 extern const struct sci_base_state scic_sds_io_request_started_task_mgmt_substate_table[];
 324
 325 /**
 326  *
 327  *
 328  * This macro returns the maximum number of SGL element paris that we will
 329  * support in a single IO request.
 330  */
 331 #define SCU_MAX_SGL_ELEMENT_PAIRS ((SCU_IO_REQUEST_SGE_COUNT + 1) / 2)
 332
 333 /**
 334  * scic_sds_request_get_controller() -
 335  *
 336  * This macro will return the controller for this io request object
 337  */
 338 #define scic_sds_request_get_controller(sci_req) \
 339         ((sci_req)->owning_controller)
 340
 341 /**
 342  * scic_sds_request_get_device() -
 343  *
 344  * This macro will return the device for this io request object
 345  */
 346 #define scic_sds_request_get_device(sci_req) \
 347         ((sci_req)->target_device)
 348
 349 /**
 350  * scic_sds_request_get_port() -
 351  *
 352  * This macro will return the port for this io request object
 353  */
 354 #define scic_sds_request_get_port(sci_req)      \
 355         scic_sds_remote_device_get_port(scic_sds_request_get_device(sci_req))
 356
 357 /**
 358  * scic_sds_request_get_post_context() -
 359  *
 360  * This macro returns the constructed post context result for the io request.
 361  */
 362 #define scic_sds_request_get_post_context(sci_req)      \
 363         ((sci_req)->post_context)
 364
 365 /**
 366  * scic_sds_request_get_task_context() -
 367  *
 368  * This is a helper macro to return the os handle for this request object.
 369  */
 370 #define scic_sds_request_get_task_context(request) \
 371         ((request)->task_context_buffer)
 372
 373 /**
 374  * scic_sds_request_set_status() -
 375  *
 376  * This macro will set the scu hardware status and sci request completion
 377  * status for an io request.
 378  */
 379 #define scic_sds_request_set_status(request, scu_status_code, sci_status_code) \
 380         { \
 381                 (request)->scu_status = (scu_status_code); \
 382                 (request)->sci_status = (sci_status_code); \
 383         }
 384
 385 #define scic_sds_request_complete(a_request) \
 386         ((a_request)->state_handlers->complete_handler(a_request))
 387
 388
 389 extern enum sci_status
 390 scic_sds_io_request_tc_completion(struct scic_sds_request *request, u32 completion_code);
 391
 392 /**
 393  * SCU_SGL_ZERO() -
 394  *
 395  * This macro zeros the hardware SGL element data
 396  */
 397 #define SCU_SGL_ZERO(scu_sge) \
 398         { \
 399                 (scu_sge).length = 0; \
 400                 (scu_sge).address_lower = 0; \
 401                 (scu_sge).address_upper = 0; \
 402                 (scu_sge).address_modifier = 0; \
 403         }
 404
 405 /**
 406  * SCU_SGL_COPY() -
 407  *
 408  * This macro copys the SGL Element data from the host os to the hardware SGL
 409  * elment data
 410  */
 411 #define SCU_SGL_COPY(scu_sge, os_sge) \
 412         { \
 413                 (scu_sge).length = sg_dma_len(sg); \
 414                 (scu_sge).address_upper = \
 415                         upper_32_bits(sg_dma_address(sg)); \
 416                 (scu_sge).address_lower = \
 417                         lower_32_bits(sg_dma_address(sg)); \
 418                 (scu_sge).address_modifier = 0; \
 419         }
 420
 421 /**
 422  * scic_sds_request_get_user_request() -
 423  *
 424  * This is a helper macro to return the os handle for this request object.
 425  */
 426 #define scic_sds_request_get_user_request(request) \
 427         ((request)->user_request)
 428
 429 /*
 430  * *****************************************************************************
 431  * * CORE REQUEST PROTOTYPES
 432  * ***************************************************************************** */
 433
 434 void scic_sds_request_build_sgl(
 435         struct scic_sds_request *sci_req);
 436
 437
 438
 439 void scic_sds_stp_request_assign_buffers(
 440         struct scic_sds_request *sci_req);
 441
 442 void scic_sds_smp_request_assign_buffers(
 443         struct scic_sds_request *sci_req);
 444
 445 /* --------------------------------------------------------------------------- */
 446
 447 enum sci_status scic_sds_request_start(
 448         struct scic_sds_request *sci_req);
 449
 450 enum sci_status scic_sds_io_request_terminate(
 451         struct scic_sds_request *sci_req);
 452
 453 enum sci_status scic_sds_io_request_complete(
 454         struct scic_sds_request *sci_req);
 455
 456 void scic_sds_io_request_copy_response(
 457         struct scic_sds_request *sci_req);
 458
 459 enum sci_status scic_sds_io_request_event_handler(
 460         struct scic_sds_request *sci_req,
 461         u32 event_code);
 462
 463 enum sci_status scic_sds_io_request_frame_handler(
 464         struct scic_sds_request *sci_req,
 465         u32 frame_index);
 466
 467
 468 enum sci_status scic_sds_task_request_terminate(
 469         struct scic_sds_request *sci_req);
 470
 471 /*
 472  * *****************************************************************************
 473  * * STARTED STATE HANDLERS
 474  * ***************************************************************************** */
 475
 476 enum sci_status scic_sds_request_started_state_abort_handler(
 477         struct scic_sds_request *sci_req);
 478
 479 enum sci_status scic_sds_request_started_state_tc_completion_handler(
 480         struct scic_sds_request *sci_req,
 481         u32 completion_code);
 482
 483 #endif /* _SCIC_SDS_IO_REQUEST_H_ */