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