1f11c7f63SJim Harris /*-
2718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3718cf2ccSPedro F. Giffuni *
4f11c7f63SJim Harris * This file is provided under a dual BSD/GPLv2 license. When using or
5f11c7f63SJim Harris * redistributing this file, you may do so under either license.
6f11c7f63SJim Harris *
7f11c7f63SJim Harris * GPL LICENSE SUMMARY
8f11c7f63SJim Harris *
9f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10f11c7f63SJim Harris *
11f11c7f63SJim Harris * This program is free software; you can redistribute it and/or modify
12f11c7f63SJim Harris * it under the terms of version 2 of the GNU General Public License as
13f11c7f63SJim Harris * published by the Free Software Foundation.
14f11c7f63SJim Harris *
15f11c7f63SJim Harris * This program is distributed in the hope that it will be useful, but
16f11c7f63SJim Harris * WITHOUT ANY WARRANTY; without even the implied warranty of
17f11c7f63SJim Harris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18f11c7f63SJim Harris * General Public License for more details.
19f11c7f63SJim Harris *
20f11c7f63SJim Harris * You should have received a copy of the GNU General Public License
21f11c7f63SJim Harris * along with this program; if not, write to the Free Software
22f11c7f63SJim Harris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
23f11c7f63SJim Harris * The full GNU General Public License is included in this distribution
24f11c7f63SJim Harris * in the file called LICENSE.GPL.
25f11c7f63SJim Harris *
26f11c7f63SJim Harris * BSD LICENSE
27f11c7f63SJim Harris *
28f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29f11c7f63SJim Harris * All rights reserved.
30f11c7f63SJim Harris *
31f11c7f63SJim Harris * Redistribution and use in source and binary forms, with or without
32f11c7f63SJim Harris * modification, are permitted provided that the following conditions
33f11c7f63SJim Harris * are met:
34f11c7f63SJim Harris *
35f11c7f63SJim Harris * * Redistributions of source code must retain the above copyright
36f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer.
37f11c7f63SJim Harris * * Redistributions in binary form must reproduce the above copyright
38f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer in
39f11c7f63SJim Harris * the documentation and/or other materials provided with the
40f11c7f63SJim Harris * distribution.
41f11c7f63SJim Harris *
42f11c7f63SJim Harris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43f11c7f63SJim Harris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44f11c7f63SJim Harris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45f11c7f63SJim Harris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46f11c7f63SJim Harris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47f11c7f63SJim Harris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48f11c7f63SJim Harris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49f11c7f63SJim Harris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50f11c7f63SJim Harris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51f11c7f63SJim Harris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52f11c7f63SJim Harris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53f11c7f63SJim Harris */
54f11c7f63SJim Harris
55f11c7f63SJim Harris #include <sys/cdefs.h>
56f11c7f63SJim Harris #if !defined(DISABLE_ATAPI)
57f11c7f63SJim Harris
58f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_stp_packet_request.h>
59f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_logger.h>
60f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_controller.h>
61f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_remote_device.h>
62f11c7f63SJim Harris #include <dev/isci/scil/scic_remote_device.h>
63f11c7f63SJim Harris #include <dev/isci/scil/sci_util.h>
64f11c7f63SJim Harris #include <dev/isci/scil/intel_sas.h>
65f11c7f63SJim Harris #include <dev/isci/scil/intel_ata.h>
66f11c7f63SJim Harris #include <dev/isci/scil/intel_sata.h>
67f11c7f63SJim Harris #include <dev/isci/scil/scic_user_callback.h>
68f11c7f63SJim Harris #include <dev/isci/sci_environment.h>
69f11c7f63SJim Harris #include <dev/isci/scil/intel_sat.h>
70f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_request.h>
71f11c7f63SJim Harris #include <dev/isci/scil/scic_controller.h>
72f11c7f63SJim Harris #include <dev/isci/scil/scu_completion_codes.h>
73f11c7f63SJim Harris #include <dev/isci/scil/scu_task_context.h>
74f11c7f63SJim Harris #include <dev/isci/scil/scic_sds_stp_packet_request.h>
75f11c7f63SJim Harris #include <dev/isci/scil/sci_base_state.h>
76f11c7f63SJim Harris
77f11c7f63SJim Harris /**
78f11c7f63SJim Harris * @brief This method will fill in the SCU Task Context for a PACKET fis. And
79f11c7f63SJim Harris * construct the request STARTED sub-state machine for Packet Protocol
80f11c7f63SJim Harris * IO.
81f11c7f63SJim Harris *
82f11c7f63SJim Harris * @param[in] this_request This parameter specifies the stp packet request object
83f11c7f63SJim Harris * being constructed.
84f11c7f63SJim Harris *
85f11c7f63SJim Harris * @return none
86f11c7f63SJim Harris */
scic_sds_stp_packet_request_construct(SCIC_SDS_REQUEST_T * this_request)87f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_construct(
88f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request
89f11c7f63SJim Harris )
90f11c7f63SJim Harris {
91f11c7f63SJim Harris SATA_FIS_REG_H2D_T * h2d_fis =
92f11c7f63SJim Harris scic_stp_io_request_get_h2d_reg_address(
93f11c7f63SJim Harris this_request
94f11c7f63SJim Harris );
95f11c7f63SJim Harris
96f11c7f63SJim Harris // Work around, we currently only support PACKET DMA protocol, so we
97f11c7f63SJim Harris // need to make change to Packet Fis features field.
98f11c7f63SJim Harris h2d_fis->features = h2d_fis->features | ATA_PACKET_FEATURE_DMA;
99f11c7f63SJim Harris
100f11c7f63SJim Harris scic_sds_stp_non_ncq_request_construct(this_request);
101f11c7f63SJim Harris
102f11c7f63SJim Harris // Build the Packet Fis task context structure
103f11c7f63SJim Harris scu_stp_raw_request_construct_task_context(
104f11c7f63SJim Harris (SCIC_SDS_STP_REQUEST_T*) this_request,
105f11c7f63SJim Harris this_request->task_context_buffer
106f11c7f63SJim Harris );
107f11c7f63SJim Harris
108f11c7f63SJim Harris sci_base_state_machine_construct(
109f11c7f63SJim Harris &this_request->started_substate_machine,
110f11c7f63SJim Harris &this_request->parent.parent,
111f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_table,
112f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
113f11c7f63SJim Harris );
114f11c7f63SJim Harris
115f11c7f63SJim Harris return SCI_SUCCESS;
116f11c7f63SJim Harris }
117f11c7f63SJim Harris
118f11c7f63SJim Harris
119f11c7f63SJim Harris /**
120f11c7f63SJim Harris * @brief This method will fill in the SCU Task Context for a Packet request
121f11c7f63SJim Harris * command phase in PACKET DMA DATA (IN/OUT) type. The following
122f11c7f63SJim Harris * important settings are utilized:
123f11c7f63SJim Harris *
124f11c7f63SJim Harris * -# task_type == SCU_TASK_TYPE_PACKET_DMA. This simply indicates
125f11c7f63SJim Harris * that a normal request type (i.e. non-raw frame) is being
126f11c7f63SJim Harris * utilized to perform task management.
127453130d9SPedro F. Giffuni * -# control_frame == 1. This ensures that the proper endianness
128f11c7f63SJim Harris * is set so that the bytes are transmitted in the right order
129f11c7f63SJim Harris * for a smp request frame.
130f11c7f63SJim Harris *
131f11c7f63SJim Harris * @param[in] this_request This parameter specifies the smp request object
132f11c7f63SJim Harris * being constructed.
133f11c7f63SJim Harris * @param[in] task_context The task_context to be reconstruct for packet
134f11c7f63SJim Harris * request command phase.
135f11c7f63SJim Harris * @return none
136f11c7f63SJim Harris */
scu_stp_packet_request_command_phase_construct_task_context(SCIC_SDS_REQUEST_T * this_request,SCU_TASK_CONTEXT_T * task_context)137f11c7f63SJim Harris void scu_stp_packet_request_command_phase_construct_task_context(
138f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request,
139f11c7f63SJim Harris SCU_TASK_CONTEXT_T * task_context
140f11c7f63SJim Harris )
141f11c7f63SJim Harris {
142f11c7f63SJim Harris void * atapi_cdb;
143f11c7f63SJim Harris U32 atapi_cdb_length;
144f11c7f63SJim Harris SCIC_SDS_STP_REQUEST_T * stp_request = (SCIC_SDS_STP_REQUEST_T *)this_request;
145f11c7f63SJim Harris
146f11c7f63SJim Harris // reference: SSTL 1.13.4.2
147f11c7f63SJim Harris // task_type, sata_direction
148f11c7f63SJim Harris if ( scic_cb_io_request_get_data_direction(this_request->user_request)
149f11c7f63SJim Harris == SCI_IO_REQUEST_DATA_OUT )
150f11c7f63SJim Harris {
151f11c7f63SJim Harris task_context->task_type = SCU_TASK_TYPE_PACKET_DMA_OUT;
152f11c7f63SJim Harris task_context->sata_direction = 0;
153f11c7f63SJim Harris }
154f11c7f63SJim Harris else // todo: for NO_DATA command, we need to send out raw frame.
155f11c7f63SJim Harris {
156f11c7f63SJim Harris task_context->task_type = SCU_TASK_TYPE_PACKET_DMA_IN;
157f11c7f63SJim Harris task_context->sata_direction = 1;
158f11c7f63SJim Harris }
159f11c7f63SJim Harris
160f11c7f63SJim Harris // sata header
161f11c7f63SJim Harris memset(&(task_context->type.stp), 0, sizeof(struct STP_TASK_CONTEXT));
162f11c7f63SJim Harris task_context->type.stp.fis_type = SATA_FIS_TYPE_DATA;
163f11c7f63SJim Harris
164f11c7f63SJim Harris // Copy in the command IU with CDB so that the commandIU address doesn't
165f11c7f63SJim Harris // change.
166f11c7f63SJim Harris memset(this_request->command_buffer, 0, sizeof(SATA_FIS_REG_H2D_T));
167f11c7f63SJim Harris
168f11c7f63SJim Harris atapi_cdb =
169f11c7f63SJim Harris scic_cb_stp_packet_io_request_get_cdb_address(this_request->user_request);
170f11c7f63SJim Harris
171f11c7f63SJim Harris atapi_cdb_length =
172f11c7f63SJim Harris scic_cb_stp_packet_io_request_get_cdb_length(this_request->user_request);
173f11c7f63SJim Harris
174f11c7f63SJim Harris memcpy(((U8 *)this_request->command_buffer+sizeof(U32)), atapi_cdb, atapi_cdb_length);
175f11c7f63SJim Harris
176f11c7f63SJim Harris atapi_cdb_length =
177f11c7f63SJim Harris MAX(atapi_cdb_length, stp_request->type.packet.device_preferred_cdb_length);
178f11c7f63SJim Harris
179f11c7f63SJim Harris task_context->ssp_command_iu_length =
180f11c7f63SJim Harris ((atapi_cdb_length % 4) == 0) ?
181f11c7f63SJim Harris (atapi_cdb_length / 4) : ((atapi_cdb_length / 4) + 1);
182f11c7f63SJim Harris
183f11c7f63SJim Harris // task phase is set to TX_CMD
184f11c7f63SJim Harris task_context->task_phase = 0x1;
185f11c7f63SJim Harris
186f11c7f63SJim Harris // retry counter
187f11c7f63SJim Harris task_context->stp_retry_count = 0;
188f11c7f63SJim Harris
189f11c7f63SJim Harris if (scic_cb_request_is_initial_construction(this_request->user_request))
190f11c7f63SJim Harris {
191f11c7f63SJim Harris // data transfer size.
192f11c7f63SJim Harris task_context->transfer_length_bytes =
193f11c7f63SJim Harris scic_cb_io_request_get_transfer_length(this_request->user_request);
194f11c7f63SJim Harris
195f11c7f63SJim Harris // sgls were already built when request was constructed, so don't need to
196f11c7f63SJim Harris // to do it here
197f11c7f63SJim Harris }
198f11c7f63SJim Harris else
199f11c7f63SJim Harris {
200f11c7f63SJim Harris // data transfer size, need to be 4 bytes aligned.
201f11c7f63SJim Harris task_context->transfer_length_bytes = (SCSI_FIXED_SENSE_DATA_BASE_LENGTH + 2);
202f11c7f63SJim Harris
203f11c7f63SJim Harris scic_sds_stp_packet_internal_request_sense_build_sgl(this_request);
204f11c7f63SJim Harris }
205f11c7f63SJim Harris }
206f11c7f63SJim Harris
207f11c7f63SJim Harris /**
208f11c7f63SJim Harris * @brief This method will fill in the SCU Task Context for a DATA fis
209f11c7f63SJim Harris * containing CDB in Raw Frame type. The TC for previous Packet
210f11c7f63SJim Harris * fis was already there, we only need to change the H2D fis content.
211f11c7f63SJim Harris *
212f11c7f63SJim Harris * @param[in] this_request This parameter specifies the smp request object
213f11c7f63SJim Harris * being constructed.
214f11c7f63SJim Harris * @param[in] task_context The task_context to be reconstruct for packet
215f11c7f63SJim Harris * request command phase.
216f11c7f63SJim Harris * @return none
217f11c7f63SJim Harris */
scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(SCIC_SDS_REQUEST_T * this_request,SCU_TASK_CONTEXT_T * task_context)218f11c7f63SJim Harris void scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(
219f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request,
220f11c7f63SJim Harris SCU_TASK_CONTEXT_T * task_context
221f11c7f63SJim Harris )
222f11c7f63SJim Harris {
223f11c7f63SJim Harris void * atapi_cdb =
224f11c7f63SJim Harris scic_cb_stp_packet_io_request_get_cdb_address(this_request->user_request);
225f11c7f63SJim Harris
226f11c7f63SJim Harris U32 atapi_cdb_length =
227f11c7f63SJim Harris scic_cb_stp_packet_io_request_get_cdb_length(this_request->user_request);
228f11c7f63SJim Harris
229f11c7f63SJim Harris memset(this_request->command_buffer, 0, sizeof(SATA_FIS_REG_H2D_T));
230f11c7f63SJim Harris memcpy( ((U8 *)this_request->command_buffer+sizeof(U32)), atapi_cdb, atapi_cdb_length);
231f11c7f63SJim Harris
232f11c7f63SJim Harris memset(&(task_context->type.stp), 0, sizeof(struct STP_TASK_CONTEXT));
233f11c7f63SJim Harris task_context->type.stp.fis_type = SATA_FIS_TYPE_DATA;
234f11c7f63SJim Harris
235f11c7f63SJim Harris //Note the data send out has to be 4 bytes aligned. Or else out hardware will
236f11c7f63SJim Harris //patch non-zero bytes and cause the target device unhappy.
237f11c7f63SJim Harris task_context->transfer_length_bytes = 12;
238f11c7f63SJim Harris }
239f11c7f63SJim Harris
240f11c7f63SJim Harris
241f11c7f63SJim Harris /*
242f11c7f63SJim Harris *@brief This methods decode the D2H status FIS and retrieve the sense data,
243f11c7f63SJim Harris * then pass the sense data to user request.
244f11c7f63SJim Harris *
245f11c7f63SJim Harris *@param[in] this_request The request receive D2H status FIS.
246f11c7f63SJim Harris *@param[in] status_fis The D2H status fis to be processed.
247f11c7f63SJim Harris *
248f11c7f63SJim Harris */
scic_sds_stp_packet_request_process_status_fis(SCIC_SDS_REQUEST_T * this_request,SATA_FIS_REG_D2H_T * status_fis)249f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_process_status_fis(
250f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request,
251f11c7f63SJim Harris SATA_FIS_REG_D2H_T * status_fis
252f11c7f63SJim Harris )
253f11c7f63SJim Harris {
254f11c7f63SJim Harris SCI_STATUS status = SCI_SUCCESS;
255f11c7f63SJim Harris
256f11c7f63SJim Harris //TODO: Process the error status fis, retrieve sense data.
257f11c7f63SJim Harris if (status_fis->status & ATA_STATUS_REG_ERROR_BIT)
258f11c7f63SJim Harris status = SCI_FAILURE_IO_RESPONSE_VALID;
259f11c7f63SJim Harris
260f11c7f63SJim Harris return status;
261f11c7f63SJim Harris }
262f11c7f63SJim Harris
263f11c7f63SJim Harris /*
264f11c7f63SJim Harris *@brief This methods builds sgl for internal REQUEST SENSE stp packet
265f11c7f63SJim Harris * command using this request response buffer, only one sge is
266f11c7f63SJim Harris * needed.
267f11c7f63SJim Harris *
268f11c7f63SJim Harris *@param[in] this_request The request receive request sense data.
269f11c7f63SJim Harris *
270f11c7f63SJim Harris */
scic_sds_stp_packet_internal_request_sense_build_sgl(SCIC_SDS_REQUEST_T * this_request)271f11c7f63SJim Harris void scic_sds_stp_packet_internal_request_sense_build_sgl(
272f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request
273f11c7f63SJim Harris )
274f11c7f63SJim Harris {
275f11c7f63SJim Harris void *sge;
276f11c7f63SJim Harris SCU_SGL_ELEMENT_PAIR_T *scu_sgl_list = NULL;
277f11c7f63SJim Harris SCU_TASK_CONTEXT_T *task_context;
278f11c7f63SJim Harris SCI_PHYSICAL_ADDRESS physical_address;
279f11c7f63SJim Harris
280f11c7f63SJim Harris SCI_SSP_RESPONSE_IU_T * rsp_iu =
281f11c7f63SJim Harris (SCI_SSP_RESPONSE_IU_T *)this_request->response_buffer;
282f11c7f63SJim Harris sge = (void*)&rsp_iu->data[0];
283f11c7f63SJim Harris
284f11c7f63SJim Harris task_context = (SCU_TASK_CONTEXT_T *)this_request->task_context_buffer;
285f11c7f63SJim Harris scu_sgl_list = &task_context->sgl_pair_ab;
286f11c7f63SJim Harris
287f11c7f63SJim Harris scic_cb_io_request_get_physical_address(
288f11c7f63SJim Harris scic_sds_request_get_controller(this_request),
289f11c7f63SJim Harris this_request,
290f11c7f63SJim Harris ((char *)sge),
291f11c7f63SJim Harris &physical_address
292f11c7f63SJim Harris );
293f11c7f63SJim Harris
294f11c7f63SJim Harris scu_sgl_list->A.address_upper = sci_cb_physical_address_upper(physical_address);
295f11c7f63SJim Harris scu_sgl_list->A.address_lower = sci_cb_physical_address_lower(physical_address);
296f11c7f63SJim Harris scu_sgl_list->A.length = task_context->transfer_length_bytes;
297f11c7f63SJim Harris scu_sgl_list->A.address_modifier = 0;
298f11c7f63SJim Harris
299f11c7f63SJim Harris SCU_SGL_ZERO(scu_sgl_list->B);
300f11c7f63SJim Harris }
301f11c7f63SJim Harris
302f11c7f63SJim Harris //******************************************************************************
303f11c7f63SJim Harris //* STP PACKET REQUEST STATE MACHINES
304f11c7f63SJim Harris //******************************************************************************
305f11c7f63SJim Harris
306f11c7f63SJim Harris /**
307f11c7f63SJim Harris * @brief This method processes the completions transport layer (TL) status
308f11c7f63SJim Harris * to determine if the Packet FIS was sent successfully. If the Packet
309f11c7f63SJim Harris * FIS was sent successfully, then the state for the Packet request
310f11c7f63SJim Harris * transits to waiting for a PIO SETUP frame.
311f11c7f63SJim Harris *
312f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
313f11c7f63SJim Harris * the TC completion was received.
314f11c7f63SJim Harris * @param[in] completion_code This parameter indicates the completion status
315f11c7f63SJim Harris * information for the TC.
316f11c7f63SJim Harris *
317f11c7f63SJim Harris * @return Indicate if the tc completion handler was successful.
318f11c7f63SJim Harris * @retval SCI_SUCCESS currently this method always returns success.
319f11c7f63SJim Harris */
320f11c7f63SJim Harris static
scic_sds_stp_packet_request_packet_phase_await_tc_completion_tc_completion_handler(SCIC_SDS_REQUEST_T * this_request,U32 completion_code)321f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_packet_phase_await_tc_completion_tc_completion_handler(
322f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request,
323f11c7f63SJim Harris U32 completion_code
324f11c7f63SJim Harris )
325f11c7f63SJim Harris {
326f11c7f63SJim Harris SCI_STATUS status = SCI_SUCCESS;
327f11c7f63SJim Harris
328f11c7f63SJim Harris SCIC_LOG_TRACE((
329f11c7f63SJim Harris sci_base_object_get_logger(this_request),
330f11c7f63SJim Harris SCIC_LOG_OBJECT_STP_IO_REQUEST,
331f11c7f63SJim Harris "scic_sds_stp_packet_request_packet_phase_await_tc_completion_tc_completion_handler(0x%x, 0x%x) enter\n",
332f11c7f63SJim Harris this_request, completion_code
333f11c7f63SJim Harris ));
334f11c7f63SJim Harris
335f11c7f63SJim Harris switch (SCU_GET_COMPLETION_TL_STATUS(completion_code))
336f11c7f63SJim Harris {
337f11c7f63SJim Harris case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_GOOD):
338f11c7f63SJim Harris scic_sds_request_set_status(
339f11c7f63SJim Harris this_request, SCU_TASK_DONE_GOOD, SCI_SUCCESS
340f11c7f63SJim Harris );
341f11c7f63SJim Harris
342f11c7f63SJim Harris sci_base_state_machine_change_state(
343f11c7f63SJim Harris &this_request->started_substate_machine,
344f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE
345f11c7f63SJim Harris );
346f11c7f63SJim Harris break;
347f11c7f63SJim Harris
348f11c7f63SJim Harris default:
349f11c7f63SJim Harris // All other completion status cause the IO to be complete. If a NAK
350f11c7f63SJim Harris // was received, then it is up to the user to retry the request.
351f11c7f63SJim Harris scic_sds_request_set_status(
352f11c7f63SJim Harris this_request,
353f11c7f63SJim Harris SCU_NORMALIZE_COMPLETION_STATUS(completion_code),
354f11c7f63SJim Harris SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR
355f11c7f63SJim Harris );
356f11c7f63SJim Harris
357f11c7f63SJim Harris sci_base_state_machine_change_state(
358f11c7f63SJim Harris &this_request->parent.state_machine,
359f11c7f63SJim Harris SCI_BASE_REQUEST_STATE_COMPLETED
360f11c7f63SJim Harris );
361f11c7f63SJim Harris break;
362f11c7f63SJim Harris }
363f11c7f63SJim Harris
364f11c7f63SJim Harris return status;
365f11c7f63SJim Harris }
366f11c7f63SJim Harris
367f11c7f63SJim Harris
368f11c7f63SJim Harris /**
369f11c7f63SJim Harris * @brief This method processes an unsolicited frame while the Packet request
370f11c7f63SJim Harris * is waiting for a PIO SETUP FIS. It will release
371f11c7f63SJim Harris * the unsolicited frame, and transition the request to the
372f11c7f63SJim Harris * COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE state.
373f11c7f63SJim Harris *
374f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
375f11c7f63SJim Harris * the unsolicited frame was received.
376f11c7f63SJim Harris * @param[in] frame_index This parameter indicates the unsolicited frame
377f11c7f63SJim Harris * index that should contain the response.
378f11c7f63SJim Harris *
379f11c7f63SJim Harris * @return This method returns an indication of whether the pio setup
380f11c7f63SJim Harris * frame was handled successfully or not.
381f11c7f63SJim Harris * @retval SCI_SUCCESS Currently this value is always returned and indicates
382f11c7f63SJim Harris * successful processing of the TC response.
383f11c7f63SJim Harris *
384f11c7f63SJim Harris */
385f11c7f63SJim Harris static
scic_sds_stp_packet_request_packet_phase_await_pio_setup_frame_handler(SCIC_SDS_REQUEST_T * request,U32 frame_index)386f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_packet_phase_await_pio_setup_frame_handler(
387f11c7f63SJim Harris SCIC_SDS_REQUEST_T * request,
388f11c7f63SJim Harris U32 frame_index
389f11c7f63SJim Harris )
390f11c7f63SJim Harris {
391f11c7f63SJim Harris SCI_STATUS status;
392f11c7f63SJim Harris SATA_FIS_HEADER_T * frame_header;
393f11c7f63SJim Harris U32 * frame_buffer;
394f11c7f63SJim Harris SCIC_SDS_STP_REQUEST_T * this_request;
395f11c7f63SJim Harris
396f11c7f63SJim Harris this_request = (SCIC_SDS_STP_REQUEST_T *)request;
397f11c7f63SJim Harris
398f11c7f63SJim Harris SCIC_LOG_TRACE((
399f11c7f63SJim Harris sci_base_object_get_logger(this_request),
400f11c7f63SJim Harris SCIC_LOG_OBJECT_STP_IO_REQUEST,
401f11c7f63SJim Harris "scic_sds_stp_packet_request_packet_phase_await_pio_setup_frame_handler(0x%x, 0x%x) enter\n",
402f11c7f63SJim Harris this_request, frame_index
403f11c7f63SJim Harris ));
404f11c7f63SJim Harris
405f11c7f63SJim Harris status = scic_sds_unsolicited_frame_control_get_header(
406f11c7f63SJim Harris &(this_request->parent.owning_controller->uf_control),
407f11c7f63SJim Harris frame_index,
408f11c7f63SJim Harris (void**) &frame_header
409f11c7f63SJim Harris );
410f11c7f63SJim Harris
411f11c7f63SJim Harris if (status == SCI_SUCCESS)
412f11c7f63SJim Harris {
413f11c7f63SJim Harris ASSERT(frame_header->fis_type == SATA_FIS_TYPE_PIO_SETUP);
414f11c7f63SJim Harris
415f11c7f63SJim Harris // Get from the frame buffer the PIO Setup Data, although we don't need
416f11c7f63SJim Harris // any info from this pio setup fis.
417f11c7f63SJim Harris scic_sds_unsolicited_frame_control_get_buffer(
418f11c7f63SJim Harris &(this_request->parent.owning_controller->uf_control),
419f11c7f63SJim Harris frame_index,
420f11c7f63SJim Harris (void**) &frame_buffer
421f11c7f63SJim Harris );
422f11c7f63SJim Harris
423f11c7f63SJim Harris // Get the data from the PIO Setup
424f11c7f63SJim Harris // The SCU Hardware returns first word in the frame_header and the rest
425f11c7f63SJim Harris // of the data is in the frame buffer so we need to back up one dword
426f11c7f63SJim Harris this_request->type.packet.device_preferred_cdb_length =
427f11c7f63SJim Harris (U16)((SATA_FIS_PIO_SETUP_T *)(&frame_buffer[-1]))->transfter_count;
428f11c7f63SJim Harris
429f11c7f63SJim Harris // Frame has been decoded return it to the controller
430f11c7f63SJim Harris scic_sds_controller_release_frame(
431f11c7f63SJim Harris this_request->parent.owning_controller, frame_index
432f11c7f63SJim Harris );
433f11c7f63SJim Harris
434f11c7f63SJim Harris sci_base_state_machine_change_state(
435f11c7f63SJim Harris &this_request->parent.started_substate_machine,
436f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
437f11c7f63SJim Harris );
438f11c7f63SJim Harris }
439f11c7f63SJim Harris else
440f11c7f63SJim Harris {
441f11c7f63SJim Harris SCIC_LOG_ERROR((
442f11c7f63SJim Harris sci_base_object_get_logger(this_request),
443f11c7f63SJim Harris SCIC_LOG_OBJECT_STP_IO_REQUEST,
444f11c7f63SJim Harris "SCIC IO Request 0x%x could not get frame header for frame index %d, status %x\n",
445f11c7f63SJim Harris this_request, frame_index, status
446f11c7f63SJim Harris ));
447f11c7f63SJim Harris }
448f11c7f63SJim Harris
449f11c7f63SJim Harris return status;
450f11c7f63SJim Harris }
451f11c7f63SJim Harris
452f11c7f63SJim Harris
453f11c7f63SJim Harris /**
454f11c7f63SJim Harris * @brief This method processes the completions transport layer (TL) status
455f11c7f63SJim Harris * to determine if the PACKET command data FIS was sent successfully.
456f11c7f63SJim Harris * If successfully, then the state for the packet request
457453130d9SPedro F. Giffuni * transits to COMPLETE state. If not successfully, the request transits
458f11c7f63SJim Harris * to COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE.
459f11c7f63SJim Harris *
460f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
461f11c7f63SJim Harris * the TC completion was received.
462f11c7f63SJim Harris * @param[in] completion_code This parameter indicates the completion status
463f11c7f63SJim Harris * information for the TC.
464f11c7f63SJim Harris *
465f11c7f63SJim Harris * @return Indicate if the tc completion handler was successful.
466f11c7f63SJim Harris * @retval SCI_SUCCESS currently this method always returns success.
467f11c7f63SJim Harris */
468f11c7f63SJim Harris static
scic_sds_stp_packet_request_command_phase_await_tc_completion_tc_completion_handler(SCIC_SDS_REQUEST_T * this_request,U32 completion_code)469f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_command_phase_await_tc_completion_tc_completion_handler(
470f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request,
471f11c7f63SJim Harris U32 completion_code
472f11c7f63SJim Harris )
473f11c7f63SJim Harris {
474f11c7f63SJim Harris SCI_STATUS status = SCI_SUCCESS;
475f11c7f63SJim Harris U8 sat_packet_protocol = this_request->sat_protocol;
476f11c7f63SJim Harris
477f11c7f63SJim Harris SCIC_LOG_TRACE((
478f11c7f63SJim Harris sci_base_object_get_logger(this_request),
479f11c7f63SJim Harris SCIC_LOG_OBJECT_STP_IO_REQUEST,
480f11c7f63SJim Harris "scic_sds_stp_packet_request_command_phase_await_tc_completion_tc_completion_handler(0x%x, 0x%x) enter\n",
481f11c7f63SJim Harris this_request, completion_code
482f11c7f63SJim Harris ));
483f11c7f63SJim Harris
484f11c7f63SJim Harris switch (SCU_GET_COMPLETION_TL_STATUS(completion_code))
485f11c7f63SJim Harris {
486f11c7f63SJim Harris case (SCU_TASK_DONE_GOOD << SCU_COMPLETION_TL_STATUS_SHIFT):
487f11c7f63SJim Harris scic_sds_request_set_status(
488f11c7f63SJim Harris this_request, SCU_TASK_DONE_GOOD, SCI_SUCCESS
489f11c7f63SJim Harris );
490f11c7f63SJim Harris
491f11c7f63SJim Harris if ( sat_packet_protocol == SAT_PROTOCOL_PACKET_DMA_DATA_IN
492f11c7f63SJim Harris || sat_packet_protocol == SAT_PROTOCOL_PACKET_DMA_DATA_OUT
493f11c7f63SJim Harris )
494f11c7f63SJim Harris sci_base_state_machine_change_state(
495f11c7f63SJim Harris &this_request->parent.state_machine,
496f11c7f63SJim Harris SCI_BASE_REQUEST_STATE_COMPLETED
497f11c7f63SJim Harris );
498f11c7f63SJim Harris else
499f11c7f63SJim Harris sci_base_state_machine_change_state(
500f11c7f63SJim Harris &this_request->started_substate_machine,
501f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE
502f11c7f63SJim Harris );
503f11c7f63SJim Harris break;
504f11c7f63SJim Harris
505f11c7f63SJim Harris case (SCU_TASK_DONE_UNEXP_FIS << SCU_COMPLETION_TL_STATUS_SHIFT):
506f11c7f63SJim Harris if (scic_io_request_get_number_of_bytes_transferred(this_request) <
507f11c7f63SJim Harris scic_cb_io_request_get_transfer_length(this_request->user_request))
508f11c7f63SJim Harris {
509f11c7f63SJim Harris scic_sds_request_set_status(
510f11c7f63SJim Harris this_request, SCU_TASK_DONE_GOOD, SCI_SUCCESS_IO_DONE_EARLY
511f11c7f63SJim Harris );
512f11c7f63SJim Harris
513f11c7f63SJim Harris sci_base_state_machine_change_state(
514f11c7f63SJim Harris &this_request->started_substate_machine,
515f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE
516f11c7f63SJim Harris );
517f11c7f63SJim Harris
518f11c7f63SJim Harris //change the device state to ATAPI_ERROR.
519f11c7f63SJim Harris sci_base_state_machine_change_state(
520f11c7f63SJim Harris &this_request->target_device->ready_substate_machine,
521f11c7f63SJim Harris SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR
522f11c7f63SJim Harris );
523f11c7f63SJim Harris
524f11c7f63SJim Harris status = this_request->sci_status;
525f11c7f63SJim Harris }
526f11c7f63SJim Harris break;
527f11c7f63SJim Harris
528f11c7f63SJim Harris case (SCU_TASK_DONE_EXCESS_DATA << SCU_COMPLETION_TL_STATUS_SHIFT):
529f11c7f63SJim Harris //In this case, there is no UF coming after. compelte the IO now.
530f11c7f63SJim Harris scic_sds_request_set_status(
531f11c7f63SJim Harris this_request, SCU_TASK_DONE_GOOD, SCI_SUCCESS
532f11c7f63SJim Harris );
533f11c7f63SJim Harris
534f11c7f63SJim Harris sci_base_state_machine_change_state(
535f11c7f63SJim Harris &this_request->parent.state_machine,
536f11c7f63SJim Harris SCI_BASE_REQUEST_STATE_COMPLETED
537f11c7f63SJim Harris );
538f11c7f63SJim Harris
539f11c7f63SJim Harris break;
540f11c7f63SJim Harris
541f11c7f63SJim Harris default:
542f11c7f63SJim Harris if (this_request->sci_status != SCI_SUCCESS)
543f11c7f63SJim Harris { //The io status was set already. This means an UF for the status
544f11c7f63SJim Harris //fis was received already.
545f11c7f63SJim Harris
546f11c7f63SJim Harris //A device suspension event is expected, we need to have the device
547f11c7f63SJim Harris //coming out of suspension, then complete the IO.
548f11c7f63SJim Harris sci_base_state_machine_change_state(
549f11c7f63SJim Harris &this_request->started_substate_machine,
550f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE
551f11c7f63SJim Harris );
552f11c7f63SJim Harris
553f11c7f63SJim Harris //change the device state to ATAPI_ERROR.
554f11c7f63SJim Harris sci_base_state_machine_change_state(
555f11c7f63SJim Harris &this_request->target_device->ready_substate_machine,
556f11c7f63SJim Harris SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_ATAPI_ERROR
557f11c7f63SJim Harris );
558f11c7f63SJim Harris
559f11c7f63SJim Harris status = this_request->sci_status;
560f11c7f63SJim Harris }
561f11c7f63SJim Harris else
562f11c7f63SJim Harris { //If receiving any non-sucess TC status, no UF received yet, then an UF for
563f11c7f63SJim Harris //the status fis is coming after.
564f11c7f63SJim Harris scic_sds_request_set_status(
565f11c7f63SJim Harris this_request,
566f11c7f63SJim Harris SCU_TASK_DONE_CHECK_RESPONSE,
567f11c7f63SJim Harris SCI_FAILURE_IO_RESPONSE_VALID
568f11c7f63SJim Harris );
569f11c7f63SJim Harris
570f11c7f63SJim Harris sci_base_state_machine_change_state(
571f11c7f63SJim Harris &this_request->started_substate_machine,
572f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE
573f11c7f63SJim Harris );
574f11c7f63SJim Harris }
575f11c7f63SJim Harris break;
576f11c7f63SJim Harris }
577f11c7f63SJim Harris
578f11c7f63SJim Harris return status;
579f11c7f63SJim Harris }
580f11c7f63SJim Harris
581f11c7f63SJim Harris
582f11c7f63SJim Harris /**
583f11c7f63SJim Harris * @brief This method processes an unsolicited frame.
584f11c7f63SJim Harris *
585f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
586f11c7f63SJim Harris * the unsolicited frame was received.
587f11c7f63SJim Harris * @param[in] frame_index This parameter indicates the unsolicited frame
588f11c7f63SJim Harris * index that should contain the response.
589f11c7f63SJim Harris *
590f11c7f63SJim Harris * @return This method returns an indication of whether the UF
591f11c7f63SJim Harris * frame was handled successfully or not.
592f11c7f63SJim Harris * @retval SCI_SUCCESS Currently this value is always returned and indicates
593f11c7f63SJim Harris * successful processing of the TC response.
594f11c7f63SJim Harris *
595f11c7f63SJim Harris */
596f11c7f63SJim Harris static
scic_sds_stp_packet_request_command_phase_common_frame_handler(SCIC_SDS_REQUEST_T * request,U32 frame_index)597f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_command_phase_common_frame_handler(
598f11c7f63SJim Harris SCIC_SDS_REQUEST_T * request,
599f11c7f63SJim Harris U32 frame_index
600f11c7f63SJim Harris )
601f11c7f63SJim Harris {
602f11c7f63SJim Harris SCI_STATUS status;
603f11c7f63SJim Harris SATA_FIS_HEADER_T * frame_header;
604f11c7f63SJim Harris U32 * frame_buffer;
605f11c7f63SJim Harris SCIC_SDS_STP_REQUEST_T * this_request;
606f11c7f63SJim Harris
607f11c7f63SJim Harris this_request = (SCIC_SDS_STP_REQUEST_T *)request;
608f11c7f63SJim Harris
609f11c7f63SJim Harris SCIC_LOG_TRACE((
610f11c7f63SJim Harris sci_base_object_get_logger(this_request),
611f11c7f63SJim Harris SCIC_LOG_OBJECT_STP_IO_REQUEST,
612f11c7f63SJim Harris "scic_sds_stp_packet_request_command_phase_await_d2h_frame_handler(0x%x, 0x%x) enter\n",
613f11c7f63SJim Harris this_request, frame_index
614f11c7f63SJim Harris ));
615f11c7f63SJim Harris
616f11c7f63SJim Harris status = scic_sds_unsolicited_frame_control_get_header(
617f11c7f63SJim Harris &(this_request->parent.owning_controller->uf_control),
618f11c7f63SJim Harris frame_index,
619f11c7f63SJim Harris (void**) &frame_header
620f11c7f63SJim Harris );
621f11c7f63SJim Harris
622f11c7f63SJim Harris if (status == SCI_SUCCESS)
623f11c7f63SJim Harris {
624f11c7f63SJim Harris ASSERT(frame_header->fis_type == SATA_FIS_TYPE_REGD2H);
625f11c7f63SJim Harris
626f11c7f63SJim Harris // Get from the frame buffer the PIO Setup Data, although we don't need
627f11c7f63SJim Harris // any info from this pio setup fis.
628f11c7f63SJim Harris scic_sds_unsolicited_frame_control_get_buffer(
629f11c7f63SJim Harris &(this_request->parent.owning_controller->uf_control),
630f11c7f63SJim Harris frame_index,
631f11c7f63SJim Harris (void**) &frame_buffer
632f11c7f63SJim Harris );
633f11c7f63SJim Harris
634f11c7f63SJim Harris scic_sds_controller_copy_sata_response(
635f11c7f63SJim Harris &this_request->d2h_reg_fis, (U32 *)frame_header, frame_buffer
636f11c7f63SJim Harris );
637f11c7f63SJim Harris
638f11c7f63SJim Harris // Frame has been decoded return it to the controller
639f11c7f63SJim Harris scic_sds_controller_release_frame(
640f11c7f63SJim Harris this_request->parent.owning_controller, frame_index
641f11c7f63SJim Harris );
642f11c7f63SJim Harris }
643f11c7f63SJim Harris
644f11c7f63SJim Harris return status;
645f11c7f63SJim Harris }
646f11c7f63SJim Harris
647f11c7f63SJim Harris /**
648f11c7f63SJim Harris * @brief This method processes an unsolicited frame while the packet request is
649f11c7f63SJim Harris * expecting TC completion. It will process the FIS and construct sense
650f11c7f63SJim Harris * data.
651f11c7f63SJim Harris *
652f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
653f11c7f63SJim Harris * the unsolicited frame was received.
654f11c7f63SJim Harris * @param[in] frame_index This parameter indicates the unsolicited frame
655f11c7f63SJim Harris * index that should contain the response.
656f11c7f63SJim Harris *
657f11c7f63SJim Harris * @return This method returns an indication of whether the UF
658f11c7f63SJim Harris * frame was handled successfully or not.
659f11c7f63SJim Harris * @retval SCI_SUCCESS Currently this value is always returned and indicates
660f11c7f63SJim Harris * successful processing of the TC response.
661f11c7f63SJim Harris *
662f11c7f63SJim Harris */
663f11c7f63SJim Harris static
scic_sds_stp_packet_request_command_phase_await_tc_completion_frame_handler(SCIC_SDS_REQUEST_T * request,U32 frame_index)664f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_command_phase_await_tc_completion_frame_handler(
665f11c7f63SJim Harris SCIC_SDS_REQUEST_T * request,
666f11c7f63SJim Harris U32 frame_index
667f11c7f63SJim Harris )
668f11c7f63SJim Harris {
669f11c7f63SJim Harris SCIC_SDS_STP_REQUEST_T * this_request = (SCIC_SDS_STP_REQUEST_T *)request;
670f11c7f63SJim Harris
671f11c7f63SJim Harris SCI_STATUS status =
672f11c7f63SJim Harris scic_sds_stp_packet_request_command_phase_common_frame_handler(
673f11c7f63SJim Harris request, frame_index);
674f11c7f63SJim Harris
675f11c7f63SJim Harris if (status == SCI_SUCCESS)
676f11c7f63SJim Harris {
677f11c7f63SJim Harris // The command has completed with error status from target device.
678f11c7f63SJim Harris status = scic_sds_stp_packet_request_process_status_fis(
679f11c7f63SJim Harris request, &this_request->d2h_reg_fis);
680f11c7f63SJim Harris
681f11c7f63SJim Harris if (status != SCI_SUCCESS)
682f11c7f63SJim Harris {
683f11c7f63SJim Harris scic_sds_request_set_status(
684f11c7f63SJim Harris &this_request->parent,
685f11c7f63SJim Harris SCU_TASK_DONE_CHECK_RESPONSE,
686f11c7f63SJim Harris status
687f11c7f63SJim Harris );
688f11c7f63SJim Harris }
689f11c7f63SJim Harris else
690f11c7f63SJim Harris scic_sds_request_set_status(
691f11c7f63SJim Harris &this_request->parent, SCU_TASK_DONE_GOOD, SCI_SUCCESS
692f11c7f63SJim Harris );
693f11c7f63SJim Harris }
694f11c7f63SJim Harris
695f11c7f63SJim Harris return status;
696f11c7f63SJim Harris }
697f11c7f63SJim Harris
698f11c7f63SJim Harris
699f11c7f63SJim Harris /**
700f11c7f63SJim Harris * @brief This method processes an unsolicited frame while the packet request is
701f11c7f63SJim Harris * expecting TC completion. It will process the FIS and construct sense
702f11c7f63SJim Harris * data.
703f11c7f63SJim Harris *
704f11c7f63SJim Harris * @param[in] this_request This parameter specifies the request for which
705f11c7f63SJim Harris * the unsolicited frame was received.
706f11c7f63SJim Harris * @param[in] frame_index This parameter indicates the unsolicited frame
707f11c7f63SJim Harris * index that should contain the response.
708f11c7f63SJim Harris *
709f11c7f63SJim Harris * @return This method returns an indication of whether the UF
710f11c7f63SJim Harris * frame was handled successfully or not.
711f11c7f63SJim Harris * @retval SCI_SUCCESS Currently this value is always returned and indicates
712f11c7f63SJim Harris * successful processing of the TC response.
713f11c7f63SJim Harris *
714f11c7f63SJim Harris */
715f11c7f63SJim Harris static
scic_sds_stp_packet_request_command_phase_await_d2h_fis_frame_handler(SCIC_SDS_REQUEST_T * request,U32 frame_index)716f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_command_phase_await_d2h_fis_frame_handler(
717f11c7f63SJim Harris SCIC_SDS_REQUEST_T * request,
718f11c7f63SJim Harris U32 frame_index
719f11c7f63SJim Harris )
720f11c7f63SJim Harris {
721f11c7f63SJim Harris SCI_STATUS status =
722f11c7f63SJim Harris scic_sds_stp_packet_request_command_phase_common_frame_handler(
723f11c7f63SJim Harris request, frame_index);
724f11c7f63SJim Harris
725f11c7f63SJim Harris SCIC_SDS_STP_REQUEST_T * this_request = (SCIC_SDS_STP_REQUEST_T *)request;
726f11c7f63SJim Harris
727f11c7f63SJim Harris if (status == SCI_SUCCESS)
728f11c7f63SJim Harris {
729f11c7f63SJim Harris // The command has completed with error status from target device.
730f11c7f63SJim Harris status = scic_sds_stp_packet_request_process_status_fis(
731f11c7f63SJim Harris request, &this_request->d2h_reg_fis);
732f11c7f63SJim Harris
733f11c7f63SJim Harris if (status != SCI_SUCCESS)
734f11c7f63SJim Harris {
735f11c7f63SJim Harris scic_sds_request_set_status(
736f11c7f63SJim Harris request,
737f11c7f63SJim Harris SCU_TASK_DONE_CHECK_RESPONSE,
738f11c7f63SJim Harris status
739f11c7f63SJim Harris );
740f11c7f63SJim Harris }
741f11c7f63SJim Harris else
742f11c7f63SJim Harris scic_sds_request_set_status(
743f11c7f63SJim Harris request, SCU_TASK_DONE_GOOD, SCI_SUCCESS
744f11c7f63SJim Harris );
745f11c7f63SJim Harris
746f11c7f63SJim Harris //Always complete the NON_DATA command right away, no need to delay completion
747f11c7f63SJim Harris //even an error status fis came from target device.
748f11c7f63SJim Harris sci_base_state_machine_change_state(
749f11c7f63SJim Harris &request->parent.state_machine,
750f11c7f63SJim Harris SCI_BASE_REQUEST_STATE_COMPLETED
751f11c7f63SJim Harris );
752f11c7f63SJim Harris }
753f11c7f63SJim Harris
754f11c7f63SJim Harris return status;
755f11c7f63SJim Harris }
756f11c7f63SJim Harris
757f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_completion_delay_complete_handler(SCI_BASE_REQUEST_T * request)758f11c7f63SJim Harris SCI_STATUS scic_sds_stp_packet_request_started_completion_delay_complete_handler(
759f11c7f63SJim Harris SCI_BASE_REQUEST_T *request
760f11c7f63SJim Harris )
761f11c7f63SJim Harris {
762f11c7f63SJim Harris SCIC_SDS_REQUEST_T * this_request = (SCIC_SDS_REQUEST_T *)request;
763f11c7f63SJim Harris
764f11c7f63SJim Harris sci_base_state_machine_change_state(
765f11c7f63SJim Harris &this_request->parent.state_machine,
766f11c7f63SJim Harris SCI_BASE_REQUEST_STATE_COMPLETED
767f11c7f63SJim Harris );
768f11c7f63SJim Harris
769f11c7f63SJim Harris return this_request->sci_status;
770f11c7f63SJim Harris }
771f11c7f63SJim Harris
772f11c7f63SJim Harris // ---------------------------------------------------------------------------
773f11c7f63SJim Harris
774f11c7f63SJim Harris SCIC_SDS_IO_REQUEST_STATE_HANDLER_T
775f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table
776f11c7f63SJim Harris [SCIC_SDS_STP_PACKET_REQUEST_STARTED_MAX_SUBSTATES] =
777f11c7f63SJim Harris {
778f11c7f63SJim Harris // SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
779f11c7f63SJim Harris {
780f11c7f63SJim Harris {
781f11c7f63SJim Harris scic_sds_request_default_start_handler,
782f11c7f63SJim Harris scic_sds_request_started_state_abort_handler,
783f11c7f63SJim Harris scic_sds_request_default_complete_handler,
784f11c7f63SJim Harris scic_sds_request_default_destruct_handler
785f11c7f63SJim Harris },
786f11c7f63SJim Harris scic_sds_stp_packet_request_packet_phase_await_tc_completion_tc_completion_handler,
787f11c7f63SJim Harris scic_sds_request_default_event_handler,
788f11c7f63SJim Harris scic_sds_request_default_frame_handler
789f11c7f63SJim Harris },
790f11c7f63SJim Harris // SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE
791f11c7f63SJim Harris {
792f11c7f63SJim Harris {
793f11c7f63SJim Harris scic_sds_request_default_start_handler,
794f11c7f63SJim Harris scic_sds_request_started_state_abort_handler,
795f11c7f63SJim Harris scic_sds_request_default_complete_handler,
796f11c7f63SJim Harris scic_sds_request_default_destruct_handler
797f11c7f63SJim Harris },
798f11c7f63SJim Harris scic_sds_request_default_tc_completion_handler,
799f11c7f63SJim Harris scic_sds_request_default_event_handler,
800f11c7f63SJim Harris scic_sds_stp_packet_request_packet_phase_await_pio_setup_frame_handler
801f11c7f63SJim Harris },
802f11c7f63SJim Harris // SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
803f11c7f63SJim Harris {
804f11c7f63SJim Harris {
805f11c7f63SJim Harris scic_sds_request_default_start_handler,
806f11c7f63SJim Harris scic_sds_request_started_state_abort_handler,
807f11c7f63SJim Harris scic_sds_request_default_complete_handler,
808f11c7f63SJim Harris scic_sds_request_default_destruct_handler
809f11c7f63SJim Harris },
810f11c7f63SJim Harris scic_sds_stp_packet_request_command_phase_await_tc_completion_tc_completion_handler,
811f11c7f63SJim Harris scic_sds_request_default_event_handler,
812f11c7f63SJim Harris scic_sds_stp_packet_request_command_phase_await_tc_completion_frame_handler
813f11c7f63SJim Harris },
814f11c7f63SJim Harris // SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE
815f11c7f63SJim Harris {
816f11c7f63SJim Harris {
817f11c7f63SJim Harris scic_sds_request_default_start_handler,
818f11c7f63SJim Harris scic_sds_request_started_state_abort_handler,
819f11c7f63SJim Harris scic_sds_request_default_complete_handler,
820f11c7f63SJim Harris scic_sds_request_default_destruct_handler
821f11c7f63SJim Harris },
822f11c7f63SJim Harris scic_sds_request_default_tc_completion_handler,
823f11c7f63SJim Harris scic_sds_request_default_event_handler,
824f11c7f63SJim Harris scic_sds_stp_packet_request_command_phase_await_d2h_fis_frame_handler
825f11c7f63SJim Harris },
826f11c7f63SJim Harris // SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE
827f11c7f63SJim Harris {
828f11c7f63SJim Harris {
829f11c7f63SJim Harris scic_sds_request_default_start_handler,
830f11c7f63SJim Harris scic_sds_request_started_state_abort_handler,
831f11c7f63SJim Harris scic_sds_stp_packet_request_started_completion_delay_complete_handler,
832f11c7f63SJim Harris scic_sds_request_default_destruct_handler
833f11c7f63SJim Harris },
834f11c7f63SJim Harris scic_sds_request_default_tc_completion_handler,
835f11c7f63SJim Harris scic_sds_request_default_event_handler,
836f11c7f63SJim Harris scic_sds_request_default_frame_handler
837f11c7f63SJim Harris }
838f11c7f63SJim Harris };
839f11c7f63SJim Harris
840f11c7f63SJim Harris /**
841f11c7f63SJim Harris * @file
842f11c7f63SJim Harris *
843f11c7f63SJim Harris * @brief This file contains the Packet IO started substate machine
844f11c7f63SJim Harris * for the SCIC_SDS_IO_REQUEST object.
845f11c7f63SJim Harris */
846f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_packet_phase_await_tc_completion_enter(SCI_BASE_OBJECT_T * object)847f11c7f63SJim Harris void scic_sds_stp_packet_request_started_packet_phase_await_tc_completion_enter(
848f11c7f63SJim Harris SCI_BASE_OBJECT_T *object
849f11c7f63SJim Harris )
850f11c7f63SJim Harris {
851f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request = (SCIC_SDS_REQUEST_T *)object;
852f11c7f63SJim Harris
853f11c7f63SJim Harris SET_STATE_HANDLER(
854f11c7f63SJim Harris this_request,
855f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table,
856f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
857f11c7f63SJim Harris );
858f11c7f63SJim Harris
859f11c7f63SJim Harris scic_sds_remote_device_set_working_request(
860f11c7f63SJim Harris this_request->target_device, this_request
861f11c7f63SJim Harris );
862f11c7f63SJim Harris }
863f11c7f63SJim Harris
864f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_packet_phase_await_pio_setup_enter(SCI_BASE_OBJECT_T * object)865f11c7f63SJim Harris void scic_sds_stp_packet_request_started_packet_phase_await_pio_setup_enter(
866f11c7f63SJim Harris SCI_BASE_OBJECT_T *object
867f11c7f63SJim Harris )
868f11c7f63SJim Harris {
869f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request = (SCIC_SDS_REQUEST_T *)object;
870f11c7f63SJim Harris
871f11c7f63SJim Harris SET_STATE_HANDLER(
872f11c7f63SJim Harris this_request,
873f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table,
874f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE
875f11c7f63SJim Harris );
876f11c7f63SJim Harris }
877f11c7f63SJim Harris
878f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_command_phase_await_tc_completion_enter(SCI_BASE_OBJECT_T * object)879f11c7f63SJim Harris void scic_sds_stp_packet_request_started_command_phase_await_tc_completion_enter(
880f11c7f63SJim Harris SCI_BASE_OBJECT_T *object
881f11c7f63SJim Harris )
882f11c7f63SJim Harris {
883f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request = (SCIC_SDS_REQUEST_T *)object;
884f11c7f63SJim Harris U8 sat_packet_protocol = this_request->sat_protocol;
885f11c7f63SJim Harris
886f11c7f63SJim Harris SCU_TASK_CONTEXT_T *task_context;
887f11c7f63SJim Harris SCI_STATUS status;
888f11c7f63SJim Harris
889f11c7f63SJim Harris // Recycle the TC and reconstruct it for sending out data fis containing
890f11c7f63SJim Harris // CDB.
891f11c7f63SJim Harris task_context = scic_sds_controller_get_task_context_buffer(
892f11c7f63SJim Harris this_request->owning_controller, this_request->io_tag);
893f11c7f63SJim Harris
894f11c7f63SJim Harris if (sat_packet_protocol == SAT_PROTOCOL_PACKET_NON_DATA)
895f11c7f63SJim Harris scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(
896f11c7f63SJim Harris this_request, task_context);
897f11c7f63SJim Harris else
898f11c7f63SJim Harris scu_stp_packet_request_command_phase_construct_task_context(
899f11c7f63SJim Harris this_request, task_context);
900f11c7f63SJim Harris
901f11c7f63SJim Harris // send the new TC out.
902f11c7f63SJim Harris status = this_request->owning_controller->state_handlers->parent.continue_io_handler(
903f11c7f63SJim Harris &this_request->owning_controller->parent,
904f11c7f63SJim Harris &this_request->target_device->parent,
905f11c7f63SJim Harris &this_request->parent
906f11c7f63SJim Harris );
907f11c7f63SJim Harris
908f11c7f63SJim Harris if (status == SCI_SUCCESS)
909f11c7f63SJim Harris SET_STATE_HANDLER(
910f11c7f63SJim Harris this_request,
911f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table,
912f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE
913f11c7f63SJim Harris );
914f11c7f63SJim Harris }
915f11c7f63SJim Harris
916f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_command_phase_await_d2h_fis_enter(SCI_BASE_OBJECT_T * object)917f11c7f63SJim Harris void scic_sds_stp_packet_request_started_command_phase_await_d2h_fis_enter(
918f11c7f63SJim Harris SCI_BASE_OBJECT_T *object
919f11c7f63SJim Harris )
920f11c7f63SJim Harris {
921f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request = (SCIC_SDS_REQUEST_T *)object;
922f11c7f63SJim Harris
923f11c7f63SJim Harris SET_STATE_HANDLER(
924f11c7f63SJim Harris this_request,
925f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table,
926f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE
927f11c7f63SJim Harris );
928f11c7f63SJim Harris }
929f11c7f63SJim Harris
930f11c7f63SJim Harris static
scic_sds_stp_packet_request_started_completion_delay_enter(SCI_BASE_OBJECT_T * object)931f11c7f63SJim Harris void scic_sds_stp_packet_request_started_completion_delay_enter(
932f11c7f63SJim Harris SCI_BASE_OBJECT_T *object
933f11c7f63SJim Harris )
934f11c7f63SJim Harris {
935f11c7f63SJim Harris SCIC_SDS_REQUEST_T *this_request = (SCIC_SDS_REQUEST_T *)object;
936f11c7f63SJim Harris
937f11c7f63SJim Harris SET_STATE_HANDLER(
938f11c7f63SJim Harris this_request,
939f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_handler_table,
940f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE
941f11c7f63SJim Harris );
942f11c7f63SJim Harris }
943f11c7f63SJim Harris
944f11c7f63SJim Harris
945f11c7f63SJim Harris // ---------------------------------------------------------------------------
946f11c7f63SJim Harris SCI_BASE_STATE_T
947f11c7f63SJim Harris scic_sds_stp_packet_request_started_substate_table
948f11c7f63SJim Harris [SCIC_SDS_STP_PACKET_REQUEST_STARTED_MAX_SUBSTATES] =
949f11c7f63SJim Harris {
950f11c7f63SJim Harris {
951f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
952f11c7f63SJim Harris scic_sds_stp_packet_request_started_packet_phase_await_tc_completion_enter,
953f11c7f63SJim Harris NULL
954f11c7f63SJim Harris },
955f11c7f63SJim Harris {
956f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE,
957f11c7f63SJim Harris scic_sds_stp_packet_request_started_packet_phase_await_pio_setup_enter,
958f11c7f63SJim Harris NULL
959f11c7f63SJim Harris },
960f11c7f63SJim Harris {
961f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
962f11c7f63SJim Harris scic_sds_stp_packet_request_started_command_phase_await_tc_completion_enter,
963f11c7f63SJim Harris NULL
964f11c7f63SJim Harris },
965f11c7f63SJim Harris {
966f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE,
967f11c7f63SJim Harris scic_sds_stp_packet_request_started_command_phase_await_d2h_fis_enter,
968f11c7f63SJim Harris NULL
969f11c7f63SJim Harris },
970f11c7f63SJim Harris {
971f11c7f63SJim Harris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE,
972f11c7f63SJim Harris scic_sds_stp_packet_request_started_completion_delay_enter,
973f11c7f63SJim Harris NULL
974f11c7f63SJim Harris }
975f11c7f63SJim Harris };
976f11c7f63SJim Harris
977f11c7f63SJim Harris #endif //#if !defined(DISABLE_ATAPI)
978f11c7f63SJim Harris
979