drivers/scsi/isci/core/scic_sds_stp_pio_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_SATA_PIO_REQUEST_H_
  57 #define _SCIC_SDS_SATA_PIO_REQUEST_H_
  58
  59 #include "sci_base_state.h"
  60 #include "scic_sds_request.h"
  61 #include "scu_task_context.h"
  62
  63 /**
  64  * This file contains the structures and constants for SATA PIO requests.
  65  *
  66  *
  67  */
  68
  69
  70 /**
  71  *
  72  *
  73  * This is the enumeration of the SATA PIO DATA IN started substate machine.
  74  */
  75 enum _SCIC_SDS_STP_REQUEST_STARTED_PIO_SUBSTATES {
  76         /**
  77          * While in this state the IO request object is waiting for the TC completion
  78          * notification for the H2D Register FIS
  79          */
  80         SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_H2D_COMPLETION_SUBSTATE,
  81
  82         /**
  83          * While in this state the IO request object is waiting for either a PIO Setup
  84          * FIS or a D2H register FIS.  The type of frame received is based on the
  85          * result of the prior frame and line conditions.
  86          */
  87         SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_FRAME_SUBSTATE,
  88
  89         /**
  90          * While in this state the IO request object is waiting for a DATA frame from
  91          * the device.
  92          */
  93         SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_IN_AWAIT_DATA_SUBSTATE,
  94
  95         /**
  96          * While in this state the IO request object is waiting to transmit the next data
  97          * frame to the device.
  98          */
  99         SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_OUT_TRANSMIT_DATA_SUBSTATE,
 100 };
 101
 102
 103 /* --------------------------------------------------------------------------- */
 104
 105 extern const struct scic_sds_io_request_state_handler scic_sds_stp_request_started_pio_substate_handler_table[];
 106
 107 extern const struct sci_base_state scic_sds_stp_request_started_pio_substate_table[];
 108
 109 /* --------------------------------------------------------------------------- */
 110
 111 struct scic_sds_stp_request;
 112
 113 struct scu_sgl_element *scic_sds_stp_request_pio_get_next_sgl(
 114         struct scic_sds_stp_request *this_request);
 115
 116 #endif   /* _SCIC_SDS_SATA_PIO_REQUEST_H_ */