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 _SATI_ATAPI_H_ 57 #define _SATI_ATAPI_H_ 58 59 /** 60 * @file 61 * @brief This file contains all of the interface methods, macros, structures 62 * that can be utilized by a user to perform SCSI-to-ATA PACKET IO 63 * Translation. 64 */ 65 #include <dev/isci/scil/sati_types.h> 66 #include <dev/isci/scil/sati_translator_sequence.h> 67 68 /** 69 * @brief This method translates the supplied SCSI command into a 70 * corresponding ATA packet protocol command. 71 * 72 * @param[in] sequence This parameter specifies the sequence 73 * data associated with the translation. 74 * @param[in] sati_device This parameter specifies the remote device 75 * for which the translated request is destined. 76 * @param[in,out] scsi_io This parameter specifies the user's SCSI IO request 77 * object. SATI expects that the user can access the SCSI CDB, 78 * response, and data from this pointer. For example, if there 79 * is a failure in translation resulting in sense data, then 80 * SATI will call sati_cb_set_status() and pass the scsi_io 81 * pointer as a parameter. 82 * @param[out] atapi_io This parameter specifies the location of the 83 * ATA Packet FIS into which the translator can write the resultant 84 * ATA command if translation is successful. This parameter is 85 * passed back to the user through the SATI_SATA_CALLBACKS when it 86 * is necessary to write fields in the ata_io. 87 * 88 * @return Indicate if the translation was successful. 89 * @retval SATI_SUCCESS 90 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA 91 */ 92 SATI_STATUS sati_atapi_translate_command( 93 SATI_TRANSLATOR_SEQUENCE_T * sequence, 94 SATI_DEVICE_T * sati_device, 95 void * scsi_io, 96 void * atapi_io 97 ); 98 99 100 /** 101 * @brief This method translates the supplied ATA packet IO response into the 102 * corresponding SCSI command response. 103 * 104 * @param[out] sequence This parameter specifies the sequence 105 * data associated with the translation and will be updated 106 * according to the command response. 107 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 108 * object. SATI expects that the user can access the SCSI CDB, 109 * response, and data from this pointer. For example, if there 110 * is a failure in translation resulting in sense data, then 111 * SATI will call sati_cb_set_status() and pass the scsi_io 112 * pointer as a parameter. 113 * @param[in] atapi_io This parameter specifies the location of the 114 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 115 * the translator can read the received ATA status and error 116 * fields. 117 * 118 * @return Indicate if the translation was successful. 119 * @retval SATI_SUCCESS 120 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA 121 */ 122 SATI_STATUS sati_atapi_translate_command_response( 123 SATI_TRANSLATOR_SEQUENCE_T * sequence, 124 void * scsi_io, 125 void * atapi_io 126 ); 127 128 129 /** 130 * @brief This method translates the internal Request Sense command response 131 * and set the sense data for the previous failed SCSI command. 132 * 133 * @param[out] sequence This parameter specifies the sequence 134 * data associated with the translation and to be updated to 135 * final state. 136 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 137 * object. SATI expects that the user can access the SCSI CDB, 138 * response, and data from this pointer. For example, if there 139 * is a failure in translation resulting in sense data, then 140 * SATI will call sati_cb_set_status() and pass the scsi_io 141 * pointer as a parameter. 142 * @param[in] atapi_io This parameter specifies the location of the 143 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 144 * the translator can read the received ATA status and error 145 * fields. 146 * 147 * @return None. 148 */ 149 void sati_atapi_translate_request_sense_response( 150 SATI_TRANSLATOR_SEQUENCE_T * sequence, 151 void * scsi_io, 152 void * atapi_io 153 ); 154 155 156 /** 157 * @brief This method retrieve ATA packet IO actual transferred data length. 158 * 159 * @param[in] sequence This parameter specifies the sequence 160 * data associated with the translation. 161 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 162 * object. SATI expects that the user can access the SCSI CDB, 163 * response, and data from this pointer. For example, if there 164 * is a failure in translation resulting in sense data, then 165 * SATI will call sati_cb_set_status() and pass the scsi_io 166 * pointer as a parameter. 167 * @param[out] atapi_io This parameter specifies the location of the 168 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 169 * the translator can read the received ATA status and error 170 * fields. 171 * 172 * @return Actual data transfer length. 173 */ 174 U32 sati_atapi_translate_number_of_bytes_transferred( 175 SATI_TRANSLATOR_SEQUENCE_T * sequence, 176 void * scsi_io, 177 void * atapi_io 178 ); 179 #endif 180