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_SATA_PIO_REQUEST_H_
55#define _SCIC_SDS_SATA_PIO_REQUEST_H_
56
57#ifdef __cplusplus
58extern "C" {
59#endif // __cplusplus
60
61#include <dev/isci/scil/sci_base_state.h>
62#include <dev/isci/scil/scic_sds_request.h>
63#include <dev/isci/scil/scu_task_context.h>
64
65/**
66 * @file
67 *
68 * @brief This file contains the structures and constants for SATA PIO
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_REQUEST_STARTED_PIO_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_REQUEST_STARTED_PIO_AWAIT_H2D_COMPLETION_SUBSTATE,
85
86   /**
87    * While in this state the IO request object is waiting for either a PIO Setup
88    * FIS or a D2H register FIS.  The type of frame received is based on the
89    * result of the prior frame and line conditions.
90    */
91   SCIC_SDS_STP_REQUEST_STARTED_PIO_AWAIT_FRAME_SUBSTATE,
92
93   /**
94    * While in this state the IO request object is waiting for a DATA frame from
95    * the device.
96    */
97   SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_IN_AWAIT_DATA_SUBSTATE,
98
99   /**
100    * While in this state the IO request object is waiting to transmit the next data
101    * frame to the device.
102    */
103   SCIC_SDS_STP_REQUEST_STARTED_PIO_DATA_OUT_TRANSMIT_DATA_SUBSTATE,
104
105   SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES
106};
107
108
109
110
111// ---------------------------------------------------------------------------
112
113extern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T
114   scic_sds_stp_request_started_pio_substate_handler_table[
115      SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES];
116
117extern SCI_BASE_STATE_T
118   scic_sds_stp_request_started_pio_substate_table[
119      SCIC_SDS_STP_REQUEST_STARTED_PIO_MAX_SUBSTATES];
120
121// ---------------------------------------------------------------------------
122
123SCU_SGL_ELEMENT_T * scic_sds_stp_request_pio_get_next_sgl(
124   SCIC_SDS_STP_REQUEST_T * this_request
125);
126
127#ifdef __cplusplus
128}
129#endif // __cplusplus
130
131#endif   // _SCIC_SDS_SATA_PIO_REQUEST_H_
132