drivers/scsi/isci/core/scic_task_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_TASK_REQUEST_H_
  57 #define _SCIC_TASK_REQUEST_H_
  58
  59 /**
  60  * This file contains the structures and interface methods that can be
  61  *    referenced and used by the SCI user for to utilize task management
  62  *    requests.
  63  *
  64  *
  65  */
  66
  67
  68 #include "sci_status.h"
  69
  70 struct scic_sds_request;
  71 struct scic_sds_remote_device;
  72 struct scic_sds_controller;
  73
  74
  75 enum sci_status scic_task_request_construct(
  76         struct scic_sds_controller *scic_controller,
  77         struct scic_sds_remote_device *scic_remote_device,
  78         u16 io_tag, struct scic_sds_request *sci_req);
  79
  80 /**
  81  * scic_task_request_construct_ssp() - This method is called by the SCI user to
  82  *    construct all SCI Core SSP task management requests.  Memory
  83  *    initialization and functionality common to all task request types is
  84  *    performed in this method.
  85  * @scic_task_request: This parameter specifies the handle to the core task
  86  *    request object for which to construct a SATA specific task management
  87  *    request.
  88  *
  89  * Indicate if the controller successfully built the task request. SCI_SUCCESS
  90  * This value is returned if the task request was successfully built.
  91  */
  92 enum sci_status scic_task_request_construct_ssp(
  93         struct scic_sds_request *scic_task_request);
  94
  95 /**
  96  * scic_task_request_construct_sata() - This method is called by the SCI user
  97  *    to construct all SCI Core SATA task management requests.  Memory
  98  *    initialization and functionality common to all task request types is
  99  *    performed in this method.
 100  * @scic_task_request_handle: This parameter specifies the handle to the core
 101  *    task request object for which to construct a SATA specific task
 102  *    management request.
 103  *
 104  * Indicate if the controller successfully built the task request. SCI_SUCCESS
 105  * This value is returned if the task request was successfully built.
 106  */
 107 enum sci_status scic_task_request_construct_sata(
 108         struct scic_sds_request *scic_task_request_handle);
 109
 110
 111
 112 #endif  /* _SCIC_TASK_REQUEST_H_ */
 113