1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
3 *
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.
6 *
7 * GPL LICENSE SUMMARY
8 *
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
10 *
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.
14 *
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.
19 *
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.
25 *
26 * BSD LICENSE
27 *
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
30 *
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
33 * are met:
34 *
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
40 * distribution.
41 *
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.
53 *
54 * $FreeBSD$
55 */
56 #ifndef _SCIC_SDS_SATA_PIO_REQUEST_H_
57 #define _SCIC_SDS_SATA_PIO_REQUEST_H_
58
59 #ifdef __cplusplus
60 extern "C" {
61 #endif // __cplusplus
62
63 #include <dev/isci/scil/sci_base_state.h>
64 #include <dev/isci/scil/scic_sds_request.h>
65 #include <dev/isci/scil/scu_task_context.h>
66
67 /**
68 * @file
69 *
70 * @brief This file contains the structures and constants for SATA PIO
71 * requests.
72 */
73
74
75 /**
76 * @enum
77 *
78 * This is the enumeration of the SATA PIO DATA IN started substate machine.
79 */
80 enum _SCIC_SDS_STP_REQUEST_STARTED_PIO_SUBSTATES
81 {
82 /**
83 * While in this state the IO request object is waiting for the TC completion
84 * notification for the H2D Register FIS
85 */
86 SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_H2D_COMPLETION_SUBSTATE,
87
88 /**
89 * While in this state the IO request object is waiting for either a PIO Setup
90 * FIS or a D2H register FIS. The type of frame received is based on the
91 * result of the prior frame and line conditions.
92 */
93 SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_FRAME_SUBSTATE,
94
95 /**
96 * While in this state the IO request object is waiting for a DATA frame from
97 * the device.
98 */
99 SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_IN_AWAIT_DATA_SUBSTATE,
100
101 /**
102 * While in this state the IO request object is waiting to transmit the next data
103 * frame to the device.
104 */
105 SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_OUT_TRANSMIT_DATA_SUBSTATE,
106
107 SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES
108 };
109
110
111
112
113 // ---------------------------------------------------------------------------
114
115 extern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T
116 scic_sds_stp_request_started_pio_substate_handler_table[
117 SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES];
118
119 extern SCI_BASE_STATE_T
120 scic_sds_stp_request_started_pio_substate_table[
121 SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES];
122
123 // ---------------------------------------------------------------------------
124
125 SCU_SGL_ELEMENT_T * scic_sds_stp_request_pio_get_next_sgl(
126 SCIC_SDS_STP_REQUEST_T * this_request
127 );
128
129 #ifdef __cplusplus
130 }
131 #endif // __cplusplus
132
133 #endif // _SCIC_SDS_SATA_PIO_REQUEST_H_
Cache object: 6fa0ed097fd892cc8024b72f7329b2fd
|