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_PACKET_REQUEST_H_ 55230557Sjimharris#define _SCIC_SDS_STP_PACKET_REQUEST_H_ 56230557Sjimharris 57230557Sjimharris#ifdef __cplusplus 58230557Sjimharrisextern "C" { 59230557Sjimharris#endif // __cplusplus 60230557Sjimharris 61230557Sjimharris#include <dev/isci/scil/intel_sas.h> 62230557Sjimharris#include <dev/isci/scil/sci_types.h> 63230557Sjimharris#include <dev/isci/scil/scic_sds_stp_request.h> 64230557Sjimharris 65230557Sjimharris/** 66230557Sjimharris * @file 67230557Sjimharris * 68230557Sjimharris * @brief This file contains the structures and constants for PACKET protocol 69230557Sjimharris * requests. 70230557Sjimharris */ 71230557Sjimharris 72230557Sjimharris 73230557Sjimharris/** 74230557Sjimharris * @enum 75230557Sjimharris * 76230557Sjimharris * This is the enumeration of the SATA PIO DATA IN started substate machine. 77230557Sjimharris */ 78230557Sjimharrisenum _SCIC_SDS_STP_PACKET_REQUEST_STARTED_SUBSTATES 79230557Sjimharris{ 80230557Sjimharris /** 81230557Sjimharris * While in this state the IO request object is waiting for the TC completion 82230557Sjimharris * notification for the H2D Register FIS 83230557Sjimharris */ 84230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_TC_COMPLETION_SUBSTATE, 85230557Sjimharris 86230557Sjimharris /** 87230557Sjimharris * While in this state the IO request object is waiting for either a PIO Setup. 88230557Sjimharris */ 89230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_PACKET_PHASE_AWAIT_PIO_SETUP_SUBSTATE, 90230557Sjimharris 91230557Sjimharris /** 92230557Sjimharris * While in this state the IO request object is waiting for TC completion for 93230557Sjimharris * the Packet DMA DATA fis or Raw Frame. 94230557Sjimharris */ 95230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_TC_COMPLETION_SUBSTATE, 96230557Sjimharris 97230557Sjimharris /** 98230557Sjimharris * The non-data IO transit to this state in this state after receiving TC 99230557Sjimharris * completion. While in this state IO request object is waiting for D2H status 100230557Sjimharris * frame as UF. 101230557Sjimharris */ 102230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMMAND_PHASE_AWAIT_D2H_FIS_SUBSTATE, 103230557Sjimharris 104230557Sjimharris /** 105230557Sjimharris * The IO transit to this state in this state if the previous TC completion status 106230557Sjimharris * is not success and the atapi device is suspended due to target device failed the IO. 107230557Sjimharris * While in this state IO request object is waiting for device coming out of the 108230557Sjimharris * suspension state then complete the IO. 109230557Sjimharris */ 110230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_COMPLETION_DELAY_SUBSTATE, 111230557Sjimharris 112230557Sjimharris SCIC_SDS_STP_PACKET_REQUEST_STARTED_MAX_SUBSTATES 113230557Sjimharris}; 114230557Sjimharris 115230557Sjimharris 116230557Sjimharris 117230557Sjimharris#if !defined(DISABLE_ATAPI) 118230557Sjimharrisextern SCI_BASE_STATE_T scic_sds_stp_packet_request_started_substate_table[]; 119230557Sjimharrisextern SCIC_SDS_IO_REQUEST_STATE_HANDLER_T 120230557Sjimharris scic_sds_stp_packet_request_started_substate_handler_table[]; 121230557Sjimharris#endif // !defined(DISABLE_ATAPI) 122230557Sjimharris 123230557Sjimharris#if !defined(DISABLE_ATAPI) 124230557SjimharrisSCI_STATUS scic_sds_stp_packet_request_construct( 125230557Sjimharris SCIC_SDS_REQUEST_T * this_request 126230557Sjimharris); 127230557Sjimharris#else // !defined(DISABLE_ATAPI) 128230557Sjimharris#define scic_sds_stp_packet_request_construct(request) SCI_FAILURE 129230557Sjimharris#endif // !defined(DISABLE_ATAPI) 130230557Sjimharris 131230557Sjimharris#if !defined(DISABLE_ATAPI) 132230557Sjimharrisvoid scu_stp_packet_request_command_phase_construct_task_context( 133230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 134230557Sjimharris SCU_TASK_CONTEXT_T * task_context 135230557Sjimharris); 136230557Sjimharris#else // !defined(DISABLE_ATAPI) 137230557Sjimharris#define scu_stp_packet_request_command_phase_construct_task_context(reqeust, tc) 138230557Sjimharris#endif // !defined(DISABLE_ATAPI) 139230557Sjimharris 140230557Sjimharris#if !defined(DISABLE_ATAPI) 141230557Sjimharrisvoid scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context( 142230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 143230557Sjimharris SCU_TASK_CONTEXT_T * task_context 144230557Sjimharris); 145230557Sjimharris#else // !defined(DISABLE_ATAPI) 146230557Sjimharris#define scu_stp_packet_request_command_phase_reconstruct_raw_frame_task_context(reqeust, tc) 147230557Sjimharris#endif // !defined(DISABLE_ATAPI) 148230557Sjimharris 149230557Sjimharris#if !defined(DISABLE_ATAPI) 150230557SjimharrisSCI_STATUS scic_sds_stp_packet_request_process_status_fis( 151230557Sjimharris SCIC_SDS_REQUEST_T * this_request, 152230557Sjimharris SATA_FIS_REG_D2H_T * status_fis 153230557Sjimharris); 154230557Sjimharris#else // !defined(DISABLE_ATAPI) 155230557Sjimharris#define scic_sds_stp_packet_request_process_status_fis(reqeust, fis) SCI_FAILURE 156230557Sjimharris#endif // !defined(DISABLE_ATAPI) 157230557Sjimharris 158230557Sjimharris#if !defined(DISABLE_ATAPI) 159230557Sjimharrisvoid scic_sds_stp_packet_internal_request_sense_build_sgl( 160230557Sjimharris SCIC_SDS_REQUEST_T * this_request 161230557Sjimharris); 162230557Sjimharris#else // !defined(DISABLE_ATAPI) 163230557Sjimharris#define scic_sds_stp_packet_internal_request_sense_build_sgl(request) 164230557Sjimharris#endif // !defined(DISABLE_ATAPI) 165230557Sjimharris 166230557Sjimharris#ifdef __cplusplus 167230557Sjimharris} 168230557Sjimharris#endif // __cplusplus 169230557Sjimharris 170230557Sjimharris#endif // _SCIC_SDS_STP_PACKET_REQUEST_H_ 171230557Sjimharris 172