2 * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
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.
9 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
28 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
29 * All rights reserved.
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions
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
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.
55 #include <sys/cdefs.h>
56 __FBSDID("$FreeBSD$");
60 * @brief This file contains the implementation to translate
61 * SCSI Read Buffer command based on the SAT spec.
64 #if !defined(DISABLE_SATI_READ_BUFFER)
66 #include <dev/isci/scil/sati_read_buffer.h>
67 #include <dev/isci/scil/sati_callbacks.h>
68 #include <dev/isci/scil/sati_util.h>
72 * @brief This method will translate the SCSI Read Buffer command
73 * into a corresponding ATA Read Buffer command.
74 * For more information on the parameters passed to this method,
75 * please reference sati_translate_command().
77 * @return Indicates if the command translation succeeded.
78 * @retval SATI_SUCCESS indicates that the translation was supported and occurred
80 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA This value is returned if
81 * there is a translation failure.
82 * @retval SATI_COMPLETE indicates that the translation was supported, occurred without
83 * error, and no additional translation is necessary.
85 SATI_STATUS sati_read_buffer_translate_command(
86 SATI_TRANSLATOR_SEQUENCE_T * sequence,
91 U8 * cdb = sati_cb_get_cdb_address(scsi_io);
92 SATI_STATUS status = SATI_FAILURE;
93 U32 allocation_length;
96 allocation_length = ((sati_get_cdb_byte(cdb, 6) << 16) |
97 (sati_get_cdb_byte(cdb, 7) << 8) |
98 (sati_get_cdb_byte(cdb, 8)));
100 buffer_offset = ((sati_get_cdb_byte(cdb, 3) << 16) |
101 (sati_get_cdb_byte(cdb, 4) << 8) |
102 (sati_get_cdb_byte(cdb, 5)));
104 sequence->allocation_length = allocation_length;
106 switch(sati_get_cdb_byte(cdb, 1))
108 case SATI_READ_BUFFER_MODE_DATA:
109 if((allocation_length == 512) && (buffer_offset == 0) &&
110 (sati_get_cdb_byte(cdb, 2) == 0))
112 sati_ata_read_buffer_construct(ata_io, sequence);
113 sequence->type = SATI_SEQUENCE_READ_BUFFER;
114 sequence->state = SATI_SEQUENCE_STATE_AWAIT_RESPONSE;
115 status = SATI_SUCCESS;
119 sati_scsi_sense_data_construct(
122 SCSI_STATUS_CHECK_CONDITION,
123 SCSI_SENSE_ILLEGAL_REQUEST,
124 SCSI_ASC_INVALID_FIELD_IN_CDB,
125 SCSI_ASCQ_INVALID_FIELD_IN_CDB
127 sequence->state = SATI_SEQUENCE_STATE_FINAL;
128 status = SATI_FAILURE_CHECK_RESPONSE_DATA;
132 case SATI_READ_BUFFER_MODE_DESCRIPTOR:
134 //allocation legnth must be at least four to return translated data
135 if(allocation_length < 4)
137 sati_scsi_sense_data_construct(
140 SCSI_STATUS_CHECK_CONDITION,
141 SCSI_SENSE_ILLEGAL_REQUEST,
142 SCSI_ASC_INVALID_FIELD_IN_CDB,
143 SCSI_ASCQ_INVALID_FIELD_IN_CDB
145 sequence->state = SATI_SEQUENCE_STATE_FINAL;
146 status = SATI_FAILURE_CHECK_RESPONSE_DATA;
150 //figure out if we support other buffer id's
151 sati_set_data_byte(sequence, scsi_io, 0, 0x09); //offset boundary
152 sati_set_data_byte(sequence, scsi_io, 1, 0x00);
153 sati_set_data_byte(sequence, scsi_io, 2, 0x02); //buffer capacity 0x200
154 sati_set_data_byte(sequence, scsi_io, 3, 0x00);
155 sequence->state = SATI_SEQUENCE_STATE_FINAL;
156 status = SATI_COMPLETE;
161 //Unspecified sat2v7, returning invalid cdb
162 sati_scsi_sense_data_construct(
165 SCSI_STATUS_CHECK_CONDITION,
166 SCSI_SENSE_ILLEGAL_REQUEST,
167 SCSI_ASC_INVALID_FIELD_IN_CDB,
168 SCSI_ASCQ_INVALID_FIELD_IN_CDB
170 sequence->state = SATI_SEQUENCE_STATE_FINAL;
171 status = SATI_FAILURE_CHECK_RESPONSE_DATA;
177 * @brief This method will complete the Read Buffer Translation by copying the
178 ATA response data into the SCSI request DATA buffer.
179 * For more information on the parameters passed to this method,
180 * please reference sati_translate_command().
182 * @return Indicates if the command translation succeeded.
183 * @retval SATI_FAILURE_CHECK_RESPONSE_DATA This value is returned if
184 * there is a translation failure.
185 * @retval SATI_COMPLETE indicates that the translation was supported, occurred without
186 * error, and no additional translation is necessary.
188 SATI_STATUS sati_read_buffer_translate_response(
189 SATI_TRANSLATOR_SEQUENCE_T * sequence,
194 U8 * register_fis = sati_cb_get_d2h_register_fis_address(ata_io);
195 U8 ata_status = (U8) sati_get_ata_status(register_fis);
196 SATI_STATUS status = SATI_COMPLETE;
198 if (ata_status & ATA_STATUS_REG_ERROR_BIT)
200 sati_scsi_sense_data_construct(
203 SCSI_STATUS_CHECK_CONDITION,
204 SCSI_SENSE_ABORTED_COMMAND,
205 SCSI_ASC_NO_ADDITIONAL_SENSE,
206 SCSI_ASCQ_NO_ADDITIONAL_SENSE
209 status = SATI_FAILURE_CHECK_RESPONSE_DATA;
213 void * ata_data = sati_cb_get_ata_data_address(ata_io);
217 status = SATI_FAILURE;
221 //copy ATA data into SCSI data buffer
232 sequence->state = SATI_SEQUENCE_STATE_FINAL;
237 #endif //!defined(DISABLE_SATI_READ_BUFFER)