sati_atapi.h revision 230843
188699Stmm/*- 288699Stmm * This file is provided under a dual BSD/GPLv2 license. When using or 388699Stmm * redistributing this file, you may do so under either license. 488699Stmm * 588699Stmm * GPL LICENSE SUMMARY 688699Stmm * 788699Stmm * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 888699Stmm * 988699Stmm * This program is free software; you can redistribute it and/or modify 1088699Stmm * it under the terms of version 2 of the GNU General Public License as 1188699Stmm * published by the Free Software Foundation. 1288699Stmm * 1388699Stmm * This program is distributed in the hope that it will be useful, but 1488699Stmm * WITHOUT ANY WARRANTY; without even the implied warranty of 1588699Stmm * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1688699Stmm * General Public License for more details. 1788699Stmm * 1888699Stmm * You should have received a copy of the GNU General Public License 1988699Stmm * along with this program; if not, write to the Free Software 2088699Stmm * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 2188699Stmm * The full GNU General Public License is included in this distribution 2288699Stmm * in the file called LICENSE.GPL. 2388699Stmm * 2488699Stmm * BSD LICENSE 2588699Stmm * 2688699Stmm * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 2788699Stmm * All rights reserved. 2888699Stmm * 2988699Stmm * Redistribution and use in source and binary forms, with or without 3088699Stmm * modification, are permitted provided that the following conditions 3188699Stmm * are met: 3288699Stmm * 3388699Stmm * * Redistributions of source code must retain the above copyright 3488699Stmm * notice, this list of conditions and the following disclaimer. 3588699Stmm * * Redistributions in binary form must reproduce the above copyright 3688699Stmm * notice, this list of conditions and the following disclaimer in 3788699Stmm * the documentation and/or other materials provided with the 3888699Stmm * distribution. 3988699Stmm * 4088699Stmm * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 4188699Stmm * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 4288699Stmm * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 4388699Stmm * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 4488699Stmm * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 4588699Stmm * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 4688699Stmm * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 4788699Stmm * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 4888699Stmm * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 4988699Stmm * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 5088699Stmm * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51107477Stmm * 52107477Stmm * $FreeBSD$ 53107477Stmm */ 54107477Stmm#ifndef _SATI_ATAPI_H_ 55107477Stmm#define _SATI_ATAPI_H_ 56107477Stmm 57107477Stmm/** 58107477Stmm * @file 59107477Stmm * @brief This file contains all of the interface methods, macros, structures 60107477Stmm * that can be utilized by a user to perform SCSI-to-ATA PACKET IO 61107477Stmm * Translation. 62107477Stmm */ 63107477Stmm#include <dev/isci/scil/sati_types.h> 64107477Stmm#include <dev/isci/scil/sati_translator_sequence.h> 65107477Stmm 66107477Stmm/** 67107477Stmm * @brief This method translates the supplied SCSI command into a 68107477Stmm * corresponding ATA packet protocol command. 6988699Stmm * 7090619Stmm * @param[in] sequence This parameter specifies the sequence 7190619Stmm * data associated with the translation. 7290619Stmm * @param[in] sati_device This parameter specifies the remote device 7390619Stmm * for which the translated request is destined. 7488699Stmm * @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