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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifndef _SATI_ATAPI_H_
55 #define _SATI_ATAPI_H_
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
63 #include <dev/isci/scil/sati_types.h>
64 #include <dev/isci/scil/sati_translator_sequence.h>
67 * @brief This method translates the supplied SCSI command into a
68 * corresponding ATA packet protocol command.
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.
86 * @return Indicate if the translation was successful.
87 * @retval SATI_SUCCESS
88 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA
90 SATI_STATUS sati_atapi_translate_command(
91 SATI_TRANSLATOR_SEQUENCE_T * sequence,
92 SATI_DEVICE_T * sati_device,
99 * @brief This method translates the supplied ATA packet IO response into the
100 * corresponding SCSI command response.
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
116 * @return Indicate if the translation was successful.
117 * @retval SATI_SUCCESS
118 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA
120 SATI_STATUS sati_atapi_translate_command_response(
121 SATI_TRANSLATOR_SEQUENCE_T * sequence,
128 * @brief This method translates the internal Request Sense command response
129 * and set the sense data for the previous failed SCSI command.
131 * @param[out] sequence This parameter specifies the sequence
132 * data associated with the translation and to be updated to
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
147 void sati_atapi_translate_request_sense_response(
148 SATI_TRANSLATOR_SEQUENCE_T * sequence,
155 * @brief This method retrieve ATA packet IO actual transferred data length.
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
170 * @return Actual data transfer length.
172 U32 sati_atapi_translate_number_of_bytes_transferred(
173 SATI_TRANSLATOR_SEQUENCE_T * sequence,