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.
55 #ifndef _SCIC_SDS_STP_PACKET_REQUEST_H_
56 #define _SCIC_SDS_STP_PACKET_REQUEST_H_
58 #include "intel_sas.h"
59 #include "scic_sds_stp_request.h"
62 * This file contains the structures and constants for PACKET protocol requests.
71 * This is the enumeration of the SATA PIO DATA IN started substate machine.
73 enum _scic_sds_stp_packet_request_started_substates
{
75 * While in this state the IO request object is waiting for the TC completion
76 * notification for the H2D Register FIS
78 SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
,
81 * While in this state the IO request object is waiting for either a PIO Setup.
83 SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE
,
86 * While in this state the IO request object is waiting for TC completion for
87 * the Packet DMA DATA fis or Raw Frame.
89 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
,
92 * The non-data IO transit to this state in this state after receiving TC
93 * completion. While in this state IO request object is waiting for D2H status
96 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE
,
99 * The IO transit to this state in this state if the previous TC completion status
100 * is not success and the atapi device is suspended due to target device failed the IO.
101 * While in this state IO request object is waiting for device coming out of the
102 * suspension state then complete the IO.
104 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE
,
109 #if !defined(DISABLE_ATAPI)
110 extern const struct sci_base_state scic_sds_stp_packet_request_started_substate_table
[];
111 extern const struct scic_sds_io_request_state_handler scic_sds_stp_packet_request_started_substate_handler_table
[];
112 #endif /* !defined(DISABLE_ATAPI) */
114 #if !defined(DISABLE_ATAPI)
115 enum sci_status
scic_sds_stp_packet_request_construct(
116 struct scic_sds_request
*sci_req
);
117 #else /* !defined(DISABLE_ATAPI) */
118 #define scic_sds_stp_packet_request_construct(request) SCI_FAILURE
119 #endif /* !defined(DISABLE_ATAPI) */
121 #if !defined(DISABLE_ATAPI)
122 void scu_stp_packet_request_command_phase_construct_task_context(
123 struct scic_sds_request
*sci_req
,
124 struct scu_task_context
*task_context
);
125 #else /* !defined(DISABLE_ATAPI) */
126 #define scu_stp_packet_request_command_phase_construct_task_context(reqeust, tc)
127 #endif /* !defined(DISABLE_ATAPI) */
129 #if !defined(DISABLE_ATAPI)
130 void scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(
131 struct scic_sds_request
*sci_req
,
132 struct scu_task_context
*task_context
);
133 #else /* !defined(DISABLE_ATAPI) */
134 #define scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(reqeust, tc)
135 #endif /* !defined(DISABLE_ATAPI) */
137 #if !defined(DISABLE_ATAPI)
138 enum sci_status
scic_sds_stp_packet_request_process_status_fis(
139 struct scic_sds_request
*sci_req
,
140 struct sata_fis_reg_d2h
*status_fis
);
141 #else /* !defined(DISABLE_ATAPI) */
142 #define scic_sds_stp_packet_request_process_status_fis(reqeust, fis) SCI_FAILURE
143 #endif /* !defined(DISABLE_ATAPI) */
145 #if !defined(DISABLE_ATAPI)
146 void scic_sds_stp_packet_internal_request_sense_build_sgl(
147 struct scic_sds_request
*sci_req
);
148 #else /* !defined(DISABLE_ATAPI) */
149 #define scic_sds_stp_packet_internal_request_sense_build_sgl(request)
150 #endif /* !defined(DISABLE_ATAPI) */
152 #endif /* _SCIC_SDS_STP_PACKET_REQUEST_H_ */