2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
4 * This file is provided under a dual BSD/GPLv2 license. When using or
5 * redistributing this file, you may do so under either license.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23 * The full GNU General Public License is included in this distribution
24 * in the file called LICENSE.GPL.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
35 * * Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * * Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in
39 * the documentation and/or other materials provided with the
42 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 #ifndef _SCIC_SDS_STP_PACKET_REQUEST_H_
57 #define _SCIC_SDS_STP_PACKET_REQUEST_H_
63 #include <dev/isci/scil/intel_sas.h>
64 #include <dev/isci/scil/sci_types.h>
65 #include <dev/isci/scil/scic_sds_stp_request.h>
70 * @brief This file contains the structures and constants for PACKET protocol
78 * This is the enumeration of the SATA PIO DATA IN started substate machine.
80 enum _SCIC_SDS_STP_PACKET_REQUEST_STARTED_SUBSTATES
83 * While in this state the IO request object is waiting for the TC completion
84 * notification for the H2D Register FIS
86 SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
89 * While in this state the IO request object is waiting for either a PIO Setup.
91 SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE,
94 * While in this state the IO request object is waiting for TC completion for
95 * the Packet DMA DATA fis or Raw Frame.
97 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
100 * The non-data IO transit to this state in this state after receiving TC
101 * completion. While in this state IO request object is waiting for D2H status
104 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE,
107 * The IO transit to this state in this state if the previous TC completion status
108 * is not success and the atapi device is suspended due to target device failed the IO.
109 * While in this state IO request object is waiting for device coming out of the
110 * suspension state then complete the IO.
112 SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE,
114 SCIC_SDS_STP_PACKET_REQUEST_STARTED_MAX_SUBSTATES
119 #if !defined(DISABLE_ATAPI)
120 extern SCI_BASE_STATE_T scic_sds_stp_packet_request_started_substate_table[];
121 extern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T
122 scic_sds_stp_packet_request_started_substate_handler_table[];
123 #endif // !defined(DISABLE_ATAPI)
125 #if !defined(DISABLE_ATAPI)
126 SCI_STATUS scic_sds_stp_packet_request_construct(
127 SCIC_SDS_REQUEST_T * this_request
129 #else // !defined(DISABLE_ATAPI)
130 #define scic_sds_stp_packet_request_construct(request) SCI_FAILURE
131 #endif // !defined(DISABLE_ATAPI)
133 #if !defined(DISABLE_ATAPI)
134 void scu_stp_packet_request_command_phase_construct_task_context(
135 SCIC_SDS_REQUEST_T * this_request,
136 SCU_TASK_CONTEXT_T * task_context
138 #else // !defined(DISABLE_ATAPI)
139 #define scu_stp_packet_request_command_phase_construct_task_context(reqeust, tc)
140 #endif // !defined(DISABLE_ATAPI)
142 #if !defined(DISABLE_ATAPI)
143 void scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(
144 SCIC_SDS_REQUEST_T * this_request,
145 SCU_TASK_CONTEXT_T * task_context
147 #else // !defined(DISABLE_ATAPI)
148 #define scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(reqeust, tc)
149 #endif // !defined(DISABLE_ATAPI)
151 #if !defined(DISABLE_ATAPI)
152 SCI_STATUS scic_sds_stp_packet_request_process_status_fis(
153 SCIC_SDS_REQUEST_T * this_request,
154 SATA_FIS_REG_D2H_T * status_fis
156 #else // !defined(DISABLE_ATAPI)
157 #define scic_sds_stp_packet_request_process_status_fis(reqeust, fis) SCI_FAILURE
158 #endif // !defined(DISABLE_ATAPI)
160 #if !defined(DISABLE_ATAPI)
161 void scic_sds_stp_packet_internal_request_sense_build_sgl(
162 SCIC_SDS_REQUEST_T * this_request
164 #else // !defined(DISABLE_ATAPI)
165 #define scic_sds_stp_packet_internal_request_sense_build_sgl(request)
166 #endif // !defined(DISABLE_ATAPI)
170 #endif // __cplusplus
172 #endif // _SCIC_SDS_STP_PACKET_REQUEST_H_