1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris * 52230557Sjimharris * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SCIC_SDS_STP_REQUEST_T_ 55230557Sjimharris#define _SCIC_SDS_STP_REQUEST_T_ 56230557Sjimharris 57230557Sjimharris#ifdef __cplusplus 58230557Sjimharrisextern "C" { 59230557Sjimharris#endif // __cplusplus 60230557Sjimharris 61230557Sjimharris#include <dev/isci/scil/intel_sata.h> 62230557Sjimharris#include <dev/isci/scil/sci_types.h> 63230557Sjimharris#include <dev/isci/scil/scic_sds_request.h> 64230557Sjimharris 65230557Sjimharris/** 66230557Sjimharris * @struct 67230557Sjimharris * 68230557Sjimharris * @brief This structure represents the additional information that is 69230557Sjimharris * required to handle SATA PIO requests. 70230557Sjimharris */ 71230557Sjimharristypedef struct SCIC_SDS_STP_REQUEST 72230557Sjimharris{ 73230557Sjimharris SCIC_SDS_REQUEST_T parent; 74230557Sjimharris 75230557Sjimharris SATA_FIS_REG_D2H_T d2h_reg_fis; 76230557Sjimharris 77230557Sjimharris union 78230557Sjimharris { 79230557Sjimharris U32 ncq; 80230557Sjimharris 81230557Sjimharris U32 udma; 82230557Sjimharris 83230557Sjimharris struct 84230557Sjimharris { 85230557Sjimharris /** 86230557Sjimharris * Total transfer for the entire PIO request recorded at request constuction 87230557Sjimharris * time. 88230557Sjimharris * 89230557Sjimharris * @todo Should we just decrement this value for each byte of data transitted 90230557Sjimharris * or received to elemenate the current_transfer_bytes field? 91230557Sjimharris */ 92230557Sjimharris U32 total_transfer_bytes; 93230557Sjimharris 94230557Sjimharris /** 95230557Sjimharris * Total number of bytes received/transmitted in data frames since the start 96230557Sjimharris * of the IO request. At the end of the IO request this should equal the 97230557Sjimharris * total_transfer_bytes. 98230557Sjimharris */ 99230557Sjimharris U32 current_transfer_bytes; 100230557Sjimharris 101230557Sjimharris /** 102230557Sjimharris * The number of bytes requested in the in the PIO setup. 103230557Sjimharris */ 104230557Sjimharris U32 pio_transfer_bytes; 105230557Sjimharris 106230557Sjimharris /** 107230557Sjimharris * PIO Setup ending status value to tell us if we need to wait for another FIS 108230557Sjimharris * or if the transfer is complete. On the receipt of a D2H FIS this will be 109230557Sjimharris * the status field of that FIS. 110230557Sjimharris */ 111230557Sjimharris U8 ending_status; 112230557Sjimharris 113230557Sjimharris /** 114230557Sjimharris * On receipt of a D2H FIS this will be the ending error field if the 115230557Sjimharris * ending_status has the SATA_STATUS_ERR bit set. 116230557Sjimharris */ 117230557Sjimharris U8 ending_error; 118230557Sjimharris 119230557Sjimharris /** 120230557Sjimharris * Protocol Type. This is filled in by core during IO Request construction type. 121230557Sjimharris */ 122230557Sjimharris U8 sat_protocol; 123230557Sjimharris 124230557Sjimharris /** 125230557Sjimharris * This field keeps track of sgl pair to be retrieved from OS memory for processing. 126230557Sjimharris */ 127230557Sjimharris U8 sgl_pair_index; 128230557Sjimharris 129230557Sjimharris struct 130230557Sjimharris { 131230557Sjimharris SCU_SGL_ELEMENT_PAIR_T * sgl_pair; 132230557Sjimharris U8 sgl_set; 133230557Sjimharris U32 sgl_offset; 134230557Sjimharris } request_current; 135230557Sjimharris } pio; 136230557Sjimharris 137230557Sjimharris struct 138230557Sjimharris { 139230557Sjimharris /** 140230557Sjimharris * The number of bytes requested in the PIO setup before CDB data frame. 141230557Sjimharris */ 142230557Sjimharris U32 device_preferred_cdb_length; 143230557Sjimharris } packet; 144230557Sjimharris } type; 145230557Sjimharris 146230557Sjimharris} SCIC_SDS_STP_REQUEST_T; 147230557Sjimharris 148230557Sjimharris/** 149230557Sjimharris * @enum SCIC_SDS_STP_REQUEST_STARTED_UDMA_SUBSTATES 150230557Sjimharris * 151230557Sjimharris * @brief This enumeration depicts the various sub-states associated with 152230557Sjimharris * a SATA/STP UDMA protocol operation. 153230557Sjimharris */ 154230557Sjimharrisenum SCIC_SDS_STP_REQUEST_STARTED_UDMA_SUBSTATES 155230557Sjimharris{ 156230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_UDMA_AWAIT_TC_COMPLETION_SUBSTATE, 157230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_UDMA_AWAIT_D2H_REG_FIS_SUBSTATE, 158230557Sjimharris 159230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_UDMA_MAX_SUBSTATES 160230557Sjimharris}; 161230557Sjimharris 162230557Sjimharris/** 163230557Sjimharris * @enum SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_SUBSTATES 164230557Sjimharris * 165230557Sjimharris * @brief This enumeration depicts the various sub-states associated with 166230557Sjimharris * a SATA/STP non-data protocol operation. 167230557Sjimharris */ 168230557Sjimharrisenum SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_SUBSTATES 169230557Sjimharris{ 170230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_AWAIT_H2D_COMPLETION_SUBSTATE, 171230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_AWAIT_D2H_SUBSTATE, 172230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_MAX_SUBSTATES 173230557Sjimharris}; 174230557Sjimharris 175230557Sjimharris/** 176230557Sjimharris * @enum SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_SUBSTATES 177230557Sjimharris * 178230557Sjimharris * @brief THis enumeration depicts the various sub-states associated with a 179230557Sjimharris * SATA/STP soft reset operation. 180230557Sjimharris */ 181230557Sjimharrisenum SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_SUBSTATES 182230557Sjimharris{ 183230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_H2D_ASSERTED_COMPLETION_SUBSTATE, 184230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_H2D_DIAGNOSTIC_COMPLETION_SUBSTATE, 185230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_AWAIT_D2H_RESPONSE_FRAME_SUBSTATE, 186230557Sjimharris 187230557Sjimharris SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_MAX_SUBSTATES 188230557Sjimharris}; 189230557Sjimharris 190230557Sjimharrisextern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T 191230557Sjimharris scic_sds_stp_request_started_udma_substate_handler_table 192230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_UDMA_MAX_SUBSTATES]; 193230557Sjimharris 194230557Sjimharrisextern SCI_BASE_STATE_T 195230557Sjimharris scic_sds_stp_request_started_udma_substate_table 196230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_UDMA_MAX_SUBSTATES]; 197230557Sjimharris 198230557Sjimharrisextern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T 199230557Sjimharris scic_sds_stp_request_started_non_data_substate_handler_table 200230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_MAX_SUBSTATES]; 201230557Sjimharris 202230557Sjimharrisextern SCI_BASE_STATE_T 203230557Sjimharris scic_sds_stp_request_started_non_data_substate_table 204230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_NON_DATA_MAX_SUBSTATES]; 205230557Sjimharris 206230557Sjimharris 207230557Sjimharrisextern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T 208230557Sjimharris scic_sds_stp_request_started_soft_reset_substate_handler_table 209230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_MAX_SUBSTATES]; 210230557Sjimharris 211230557Sjimharrisextern SCI_BASE_STATE_T 212230557Sjimharris scic_sds_stp_request_started_soft_reset_substate_table 213230557Sjimharris [SCIC_SDS_STP_REQUEST_STARTED_SOFT_RESET_MAX_SUBSTATES]; 214230557Sjimharris 215230557Sjimharris// --------------------------------------------------------------------------- 216230557Sjimharris 217230557SjimharrisU32 scic_sds_stp_request_get_object_size(void); 218230557Sjimharris 219230557SjimharrisU32 scic_sds_stp_task_request_get_object_size(void); 220230557Sjimharris 221230557Sjimharrisvoid scu_sata_reqeust_construct_task_context( 222230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 223230557Sjimharris SCU_TASK_CONTEXT_T * task_context 224230557Sjimharris); 225230557Sjimharris 226230557Sjimharrisvoid scic_sds_stp_non_ncq_request_construct( 227230557Sjimharris SCIC_SDS_REQUEST_T *this_request 228230557Sjimharris); 229230557Sjimharris 230230557SjimharrisSCI_STATUS scic_sds_stp_pio_request_construct( 231230557Sjimharris SCIC_SDS_REQUEST_T * scic_io_request, 232230557Sjimharris U8 sat_protocol, 233230557Sjimharris BOOL copy_rx_frame 234230557Sjimharris); 235230557Sjimharris 236230557SjimharrisSCI_STATUS scic_sds_stp_pio_request_construct_pass_through ( 237230557Sjimharris SCIC_SDS_REQUEST_T * scic_io_request, 238230557Sjimharris SCIC_STP_PASSTHRU_REQUEST_CALLBACKS_T *passthru_cb 239230557Sjimharris); 240230557Sjimharris 241230557SjimharrisSCI_STATUS scic_sds_stp_udma_request_construct( 242230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 243230557Sjimharris U32 transfer_length, 244230557Sjimharris SCI_IO_REQUEST_DATA_DIRECTION data_direction 245230557Sjimharris); 246230557Sjimharris 247230557SjimharrisSCI_STATUS scic_sds_stp_non_data_request_construct( 248230557Sjimharris SCIC_SDS_REQUEST_T * this_request 249230557Sjimharris); 250230557Sjimharris 251230557SjimharrisSCI_STATUS scic_sds_stp_soft_reset_request_construct( 252230557Sjimharris SCIC_SDS_REQUEST_T * this_request 253230557Sjimharris); 254230557Sjimharris 255230557SjimharrisSCI_STATUS scic_sds_stp_ncq_request_construct( 256230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 257230557Sjimharris U32 transfer_length, 258230557Sjimharris SCI_IO_REQUEST_DATA_DIRECTION data_direction 259230557Sjimharris); 260230557Sjimharris 261230557Sjimharrisvoid scu_stp_raw_request_construct_task_context( 262230557Sjimharris SCIC_SDS_STP_REQUEST_T * this_request, 263230557Sjimharris SCU_TASK_CONTEXT_T * task_context 264230557Sjimharris 265230557Sjimharris); 266230557Sjimharris 267230557SjimharrisSCI_STATUS scic_sds_io_request_construct_sata( 268230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 269230557Sjimharris U8 sat_protocol, 270230557Sjimharris U32 transfer_length, 271230557Sjimharris SCI_IO_REQUEST_DATA_DIRECTION data_direction, 272230557Sjimharris BOOL copy_rx_frame, 273230557Sjimharris BOOL do_translate_sgl 274230557Sjimharris); 275230557Sjimharris 276230557Sjimharris#ifdef __cplusplus 277230557Sjimharris} 278230557Sjimharris#endif // __cplusplus 279230557Sjimharris 280230557Sjimharris#endif // _SCIC_SDS_STP_REQUEST_T_ 281