| Current Path : /sys/amd64/compile/hs32/modules/usr/src/sys/modules/ixgb/@/dev/isci/scil/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //sys/amd64/compile/hs32/modules/usr/src/sys/modules/ixgb/@/dev/isci/scil/sati_atapi.h |
/*- * This file is provided under a dual BSD/GPLv2 license. When using or * redistributing this file, you may do so under either license. * * GPL LICENSE SUMMARY * * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. * * This program is free software; you can redistribute it and/or modify * it under the terms of version 2 of the GNU General Public License as * published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. * The full GNU General Public License is included in this distribution * in the file called LICENSE.GPL. * * BSD LICENSE * * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * $FreeBSD: release/9.1.0/sys/dev/isci/scil/sati_atapi.h 231689 2012-02-14 15:58:49Z jimharris $ */ #ifndef _SATI_ATAPI_H_ #define _SATI_ATAPI_H_ /** * @file * @brief This file contains all of the interface methods, macros, structures * that can be utilized by a user to perform SCSI-to-ATA PACKET IO * Translation. */ #include <dev/isci/scil/sati_types.h> #include <dev/isci/scil/sati_translator_sequence.h> /** * @brief This method translates the supplied SCSI command into a * corresponding ATA packet protocol command. * * @param[in] sequence This parameter specifies the sequence * data associated with the translation. * @param[in] sati_device This parameter specifies the remote device * for which the translated request is destined. * @param[in,out] scsi_io This parameter specifies the user's SCSI IO request * object. SATI expects that the user can access the SCSI CDB, * response, and data from this pointer. For example, if there * is a failure in translation resulting in sense data, then * SATI will call sati_cb_set_status() and pass the scsi_io * pointer as a parameter. * @param[out] atapi_io This parameter specifies the location of the * ATA Packet FIS into which the translator can write the resultant * ATA command if translation is successful. This parameter is * passed back to the user through the SATI_SATA_CALLBACKS when it * is necessary to write fields in the ata_io. * * @return Indicate if the translation was successful. * @retval SATI_SUCCESS * @retval SATI_FAILURE_CHECK_RESPONSE_DATA */ SATI_STATUS sati_atapi_translate_command( SATI_TRANSLATOR_SEQUENCE_T * sequence, SATI_DEVICE_T * sati_device, void * scsi_io, void * atapi_io ); /** * @brief This method translates the supplied ATA packet IO response into the * corresponding SCSI command response. * * @param[out] sequence This parameter specifies the sequence * data associated with the translation and will be updated * according to the command response. * @param[out] scsi_io This parameter specifies the user's SCSI IO request * object. SATI expects that the user can access the SCSI CDB, * response, and data from this pointer. For example, if there * is a failure in translation resulting in sense data, then * SATI will call sati_cb_set_status() and pass the scsi_io * pointer as a parameter. * @param[in] atapi_io This parameter specifies the location of the * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which * the translator can read the received ATA status and error * fields. * * @return Indicate if the translation was successful. * @retval SATI_SUCCESS * @retval SATI_FAILURE_CHECK_RESPONSE_DATA */ SATI_STATUS sati_atapi_translate_command_response( SATI_TRANSLATOR_SEQUENCE_T * sequence, void * scsi_io, void * atapi_io ); /** * @brief This method translates the internal Request Sense command response * and set the sense data for the previous failed SCSI command. * * @param[out] sequence This parameter specifies the sequence * data associated with the translation and to be updated to * final state. * @param[out] scsi_io This parameter specifies the user's SCSI IO request * object. SATI expects that the user can access the SCSI CDB, * response, and data from this pointer. For example, if there * is a failure in translation resulting in sense data, then * SATI will call sati_cb_set_status() and pass the scsi_io * pointer as a parameter. * @param[in] atapi_io This parameter specifies the location of the * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which * the translator can read the received ATA status and error * fields. * * @return None. */ void sati_atapi_translate_request_sense_response( SATI_TRANSLATOR_SEQUENCE_T * sequence, void * scsi_io, void * atapi_io ); /** * @brief This method retrieve ATA packet IO actual transferred data length. * * @param[in] sequence This parameter specifies the sequence * data associated with the translation. * @param[out] scsi_io This parameter specifies the user's SCSI IO request * object. SATI expects that the user can access the SCSI CDB, * response, and data from this pointer. For example, if there * is a failure in translation resulting in sense data, then * SATI will call sati_cb_set_status() and pass the scsi_io * pointer as a parameter. * @param[out] atapi_io This parameter specifies the location of the * ATAPI IO request (e.g. register FIS, PIO Setup etc.) from which * the translator can read the received ATA status and error * fields. * * @return Actual data transfer length. */ U32 sati_atapi_translate_number_of_bytes_transferred( SATI_TRANSLATOR_SEQUENCE_T * sequence, void * scsi_io, void * atapi_io ); #endif