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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
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.
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.
56 #ifndef _SCIC_SDS_STP_REQUEST_T_
57 #define _SCIC_SDS_STP_REQUEST_T_
59 #include <linux/dma-mapping.h>
62 struct scic_sds_stp_request
{
68 struct scic_sds_stp_pio_request
{
70 * Total transfer for the entire PIO request recorded at request constuction
73 * @todo Should we just decrement this value for each byte of data transitted
74 * or received to elemenate the current_transfer_bytes field?
76 u32 total_transfer_bytes
;
79 * Total number of bytes received/transmitted in data frames since the start
80 * of the IO request. At the end of the IO request this should equal the
81 * total_transfer_bytes.
83 u32 current_transfer_bytes
;
86 * The number of bytes requested in the in the PIO setup.
88 u32 pio_transfer_bytes
;
91 * PIO Setup ending status value to tell us if we need to wait for another FIS
92 * or if the transfer is complete. On the receipt of a D2H FIS this will be
93 * the status field of that FIS.
98 * On receipt of a D2H FIS this will be the ending error field if the
99 * ending_status has the SATA_STATUS_ERR bit set.
103 struct scic_sds_request_pio_sgl
{
104 struct scu_sgl_element_pair
*sgl_pair
;
112 * The number of bytes requested in the PIO setup before CDB data frame.
114 u32 device_preferred_cdb_length
;
120 * enum scic_sds_stp_request_started_udma_substates - This enumeration depicts
121 * the various sub-states associated with a SATA/STP UDMA protocol operation.
125 enum scic_sds_stp_request_started_udma_substates
{
126 SCIC_SDS_STP_REQUEST_STARTED_UDMA_AWAIT_TC_COMPLETION_SUBSTATE
,
127 SCIC_SDS_STP_REQUEST_STARTED_UDMA_AWAIT_D2H_REG_FIS_SUBSTATE
,
131 * enum scic_sds_stp_request_started_non_data_substates - This enumeration
132 * depicts the various sub-states associated with a SATA/STP non-data
133 * protocol operation.
137 enum scic_sds_stp_request_started_non_data_substates
{
138 SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_AWAIT_H2D_COMPLETION_SUBSTATE
,
139 SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_AWAIT_D2H_SUBSTATE
,
143 * enum scic_sds_stp_request_started_soft_reset_substates - THis enumeration
144 * depicts the various sub-states associated with a SATA/STP soft reset
149 enum scic_sds_stp_request_started_soft_reset_substates
{
150 SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_H2D_ASSERTED_COMPLETION_SUBSTATE
,
151 SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_H2D_DIAGNOSTIC_COMPLETION_SUBSTATE
,
152 SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_D2H_RESPONSE_FRAME_SUBSTATE
,
155 /* This is the enumeration of the SATA PIO DATA IN started substate machine. */
156 enum _scic_sds_stp_request_started_pio_substates
{
158 * While in this state the IO request object is waiting for the TC completion
159 * notification for the H2D Register FIS
161 SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_H2D_COMPLETION_SUBSTATE
,
164 * While in this state the IO request object is waiting for either a PIO Setup
165 * FIS or a D2H register FIS. The type of frame received is based on the
166 * result of the prior frame and line conditions.
168 SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_FRAME_SUBSTATE
,
171 * While in this state the IO request object is waiting for a DATA frame from
174 SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_IN_AWAIT_DATA_SUBSTATE
,
177 * While in this state the IO request object is waiting to transmit the next data
178 * frame to the device.
180 SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_OUT_TRANSMIT_DATA_SUBSTATE
,
183 struct scic_sds_request
;
185 enum sci_status
scic_sds_stp_pio_request_construct(struct scic_sds_request
*sci_req
,
187 enum sci_status
scic_sds_stp_udma_request_construct(struct scic_sds_request
*sci_req
,
189 enum dma_data_direction dir
);
190 enum sci_status
scic_sds_stp_non_data_request_construct(struct scic_sds_request
*sci_req
);
191 enum sci_status
scic_sds_stp_soft_reset_request_construct(struct scic_sds_request
*sci_req
);
192 enum sci_status
scic_sds_stp_ncq_request_construct(struct scic_sds_request
*sci_req
,
194 enum dma_data_direction dir
);
195 #endif /* _SCIC_SDS_STP_REQUEST_T_ */