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 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 * $FreeBSD$
53 */
54#ifndef _SCIC_SDS_STP_PACKET_REQUEST_H_
55#define _SCIC_SDS_STP_PACKET_REQUEST_H_
56
57#ifdef __cplusplus
58extern "C" {
59#endif // __cplusplus
60
61#include <dev/isci/scil/intel_sas.h>
62#include <dev/isci/scil/sci_types.h>
63#include <dev/isci/scil/scic_sds_stp_request.h>
64
65/**
66 * @file
67 *
68 * @brief This file contains the structures and constants for PACKET protocol
69 *        requests.
70 */
71
72
73/**
74 * @enum
75 *
76 * This is the enumeration of the SATA PIO DATA IN started substate machine.
77 */
78enum _SCIC_SDS_STP_PACKET_REQUEST_STARTED_SUBSTATES
79{
80   /**
81    * While in this state the IO request object is waiting for the TC completion
82    * notification for the H2D Register FIS
83    */
84   SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
85
86   /**
87    * While in this state the IO request object is waiting for either a PIO Setup.
88    */
89   SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE,
90
91   /**
92    * While in this state the IO request object is waiting for TC completion for
93    * the Packet DMA DATA fis or Raw Frame.
94    */
95   SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE,
96
97   /**
98    * The non-data IO transit to this state in this state after receiving TC
99    * completion. While in this state IO request object is waiting for D2H status
100    * frame as UF.
101    */
102   SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE,
103
104   /**
105    * The IO transit to this state in this state if the previous TC completion status
106    * is not success and the atapi device is suspended due to target device failed the IO.
107    * While in this state IO request object is waiting for device coming out of the
108    * suspension state then complete the IO.
109    */
110   SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE,
111
112   SCIC_SDS_STP_PACKET_REQUEST_STARTED_MAX_SUBSTATES
113};
114
115
116
117#if !defined(DISABLE_ATAPI)
118extern SCI_BASE_STATE_T scic_sds_stp_packet_request_started_substate_table[];
119extern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T
120	scic_sds_stp_packet_request_started_substate_handler_table[];
121#endif // !defined(DISABLE_ATAPI)
122
123#if !defined(DISABLE_ATAPI)
124SCI_STATUS scic_sds_stp_packet_request_construct(
125   SCIC_SDS_REQUEST_T * this_request
126);
127#else  // !defined(DISABLE_ATAPI)
128#define scic_sds_stp_packet_request_construct(request) SCI_FAILURE
129#endif // !defined(DISABLE_ATAPI)
130
131#if !defined(DISABLE_ATAPI)
132void scu_stp_packet_request_command_phase_construct_task_context(
133   SCIC_SDS_REQUEST_T * this_request,
134   SCU_TASK_CONTEXT_T * task_context
135);
136#else  // !defined(DISABLE_ATAPI)
137#define scu_stp_packet_request_command_phase_construct_task_context(reqeust, tc)
138#endif // !defined(DISABLE_ATAPI)
139
140#if !defined(DISABLE_ATAPI)
141void scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(
142   SCIC_SDS_REQUEST_T * this_request,
143   SCU_TASK_CONTEXT_T * task_context
144);
145#else  // !defined(DISABLE_ATAPI)
146#define scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(reqeust, tc)
147#endif // !defined(DISABLE_ATAPI)
148
149#if !defined(DISABLE_ATAPI)
150SCI_STATUS scic_sds_stp_packet_request_process_status_fis(
151   SCIC_SDS_REQUEST_T * this_request,
152   SATA_FIS_REG_D2H_T * status_fis
153);
154#else  // !defined(DISABLE_ATAPI)
155#define scic_sds_stp_packet_request_process_status_fis(reqeust, fis) SCI_FAILURE
156#endif // !defined(DISABLE_ATAPI)
157
158#if !defined(DISABLE_ATAPI)
159void scic_sds_stp_packet_internal_request_sense_build_sgl(
160   SCIC_SDS_REQUEST_T * this_request
161);
162#else  // !defined(DISABLE_ATAPI)
163#define scic_sds_stp_packet_internal_request_sense_build_sgl(request)
164#endif // !defined(DISABLE_ATAPI)
165
166#ifdef __cplusplus
167}
168#endif // __cplusplus
169
170#endif // _SCIC_SDS_STP_PACKET_REQUEST_H_
171
172