sati_atapi.h revision 231134
184685Sobrien/*- 284685Sobrien * This file is provided under a dual BSD/GPLv2 license. When using or 3103373Sobrien * redistributing this file, you may do so under either license. 484685Sobrien * 584685Sobrien * GPL LICENSE SUMMARY 684685Sobrien * 784685Sobrien * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 884685Sobrien * 984685Sobrien * This program is free software; you can redistribute it and/or modify 10103373Sobrien * it under the terms of version 2 of the GNU General Public License as 1184685Sobrien * published by the Free Software Foundation. 12192350Sdelphij * 13234449Sobrien * This program is distributed in the hope that it will be useful, but 14234449Sobrien * WITHOUT ANY WARRANTY; without even the implied warranty of 15234449Sobrien * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1684685Sobrien * General Public License for more details. 1784685Sobrien * 18234449Sobrien * You should have received a copy of the GNU General Public License 19234449Sobrien * along with this program; if not, write to the Free Software 20234449Sobrien * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21234449Sobrien * The full GNU General Public License is included in this distribution 22234449Sobrien * in the file called LICENSE.GPL. 2384685Sobrien * 24103373Sobrien * BSD LICENSE 2584685Sobrien * 2684685Sobrien * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 2784685Sobrien * All rights reserved. 2884685Sobrien * 2984685Sobrien * Redistribution and use in source and binary forms, with or without 3084685Sobrien * modification, are permitted provided that the following conditions 3184685Sobrien * are met: 32186691Sobrien * 3384685Sobrien * * Redistributions of source code must retain the above copyright 34192350Sdelphij * notice, this list of conditions and the following disclaimer. 35234449Sobrien * * Redistributions in binary form must reproduce the above copyright 36234449Sobrien * notice, this list of conditions and the following disclaimer in 3784685Sobrien * the documentation and/or other materials provided with the 3884685Sobrien * distribution. 3984685Sobrien * 4084685Sobrien * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41234449Sobrien * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 4284685Sobrien * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 4384685Sobrien * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 4484685Sobrien * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4584685Sobrien * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 4684685Sobrien * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47186691Sobrien * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 4884685Sobrien * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 4984685Sobrien * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50192350Sdelphij * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51192350Sdelphij * 52192350Sdelphij * $FreeBSD$ 53192350Sdelphij */ 54192350Sdelphij#ifndef _SATI_ATAPI_H_ 55192350Sdelphij#define _SATI_ATAPI_H_ 56192350Sdelphij 57192350Sdelphij/** 58192350Sdelphij * @file 59 * @brief This file contains all of the interface methods, macros, structures 60 * that can be utilized by a user to perform SCSI-to-ATA PACKET IO 61 * Translation. 62 */ 63#include <dev/isci/scil/sati_types.h> 64#include <dev/isci/scil/sati_translator_sequence.h> 65 66/** 67 * @brief This method translates the supplied SCSI command into a 68 * corresponding ATA packet protocol command. 69 * 70 * @param[in] sequence This parameter specifies the sequence 71 * data associated with the translation. 72 * @param[in] sati_device This parameter specifies the remote device 73 * for which the translated request is destined. 74 * @param[in,out] scsi_io This parameter specifies the user's SCSI IO request 75 * object. SATI expects that the user can access the SCSI CDB, 76 * response, and data from this pointer. For example, if there 77 * is a failure in translation resulting in sense data, then 78 * SATI will call sati_cb_set_status() and pass the scsi_io 79 * pointer as a parameter. 80 * @param[out] atapi_io This parameter specifies the location of the 81 * ATA Packet FIS into which the translator can write the resultant 82 * ATA command if translation is successful. This parameter is 83 * passed back to the user through the SATI_SATA_CALLBACKS when it 84 * is necessary to write fields in the ata_io. 85 * 86 * @return Indicate if the translation was successful. 87 * @retval SATI_SUCCESS 88 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA 89 */ 90SATI_STATUS sati_atapi_translate_command( 91 SATI_TRANSLATOR_SEQUENCE_T * sequence, 92 SATI_DEVICE_T * sati_device, 93 void * scsi_io, 94 void * atapi_io 95); 96 97 98/** 99 * @brief This method translates the supplied ATA packet IO response into the 100 * corresponding SCSI command response. 101 * 102 * @param[out] sequence This parameter specifies the sequence 103 * data associated with the translation and will be updated 104 * according to the command response. 105 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 106 * object. SATI expects that the user can access the SCSI CDB, 107 * response, and data from this pointer. For example, if there 108 * is a failure in translation resulting in sense data, then 109 * SATI will call sati_cb_set_status() and pass the scsi_io 110 * pointer as a parameter. 111 * @param[in] atapi_io This parameter specifies the location of the 112 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 113 * the translator can read the received ATA status and error 114 * fields. 115 * 116 * @return Indicate if the translation was successful. 117 * @retval SATI_SUCCESS 118 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA 119 */ 120SATI_STATUS sati_atapi_translate_command_response( 121 SATI_TRANSLATOR_SEQUENCE_T * sequence, 122 void * scsi_io, 123 void * atapi_io 124); 125 126 127/** 128 * @brief This method translates the internal Request Sense command response 129 * and set the sense data for the previous failed SCSI command. 130 * 131 * @param[out] sequence This parameter specifies the sequence 132 * data associated with the translation and to be updated to 133 * final state. 134 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 135 * object. SATI expects that the user can access the SCSI CDB, 136 * response, and data from this pointer. For example, if there 137 * is a failure in translation resulting in sense data, then 138 * SATI will call sati_cb_set_status() and pass the scsi_io 139 * pointer as a parameter. 140 * @param[in] atapi_io This parameter specifies the location of the 141 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 142 * the translator can read the received ATA status and error 143 * fields. 144 * 145 * @return None. 146 */ 147void sati_atapi_translate_request_sense_response( 148 SATI_TRANSLATOR_SEQUENCE_T * sequence, 149 void * scsi_io, 150 void * atapi_io 151); 152 153 154/** 155 * @brief This method retrieve ATA packet IO actual transferred data length. 156 * 157 * @param[in] sequence This parameter specifies the sequence 158 * data associated with the translation. 159 * @param[out] scsi_io This parameter specifies the user's SCSI IO request 160 * object. SATI expects that the user can access the SCSI CDB, 161 * response, and data from this pointer. For example, if there 162 * is a failure in translation resulting in sense data, then 163 * SATI will call sati_cb_set_status() and pass the scsi_io 164 * pointer as a parameter. 165 * @param[out] atapi_io This parameter specifies the location of the 166 * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which 167 * the translator can read the received ATA status and error 168 * fields. 169 * 170 * @return Actual data transfer length. 171 */ 172U32 sati_atapi_translate_number_of_bytes_transferred( 173 SATI_TRANSLATOR_SEQUENCE_T * sequence, 174 void * scsi_io, 175 void * atapi_io 176); 177#endif 178