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 method implementations for translating
61 * the SCSI VERIFY (10, 12, 16-byte) commands.
64 #if !defined(DISABLE_SATI_VERIFY)
66 #include <dev/isci/scil/sati_verify.h>
67 #include <dev/isci/scil/sati_callbacks.h>
68 #include <dev/isci/scil/sati_util.h>
69 #include <dev/isci/scil/sati_move.h>
71 #include <dev/isci/scil/intel_ata.h>
72 #include <dev/isci/scil/intel_scsi.h>
73 #include <dev/isci/scil/intel_sat.h>
75 //******************************************************************************
76 //* P R I V A T E M E T H O D S
77 //******************************************************************************
80 * @brief This method performs the SCSI VERIFY command translation
81 * functionality common to all VERIFY command sizes.
83 * - setting the command register
84 * - setting the device head register
85 * - filling in fields in the SATI_TRANSLATOR_SEQUENCE object.
86 * For more information on the parameters passed to this method,
87 * please reference sati_translate_command().
89 * @return Indicate if the method was successfully completed.
90 * @retval SATI_SUCCESS This is returned in all other cases.
93 SATI_STATUS sati_verify_translate_command(
94 SATI_TRANSLATOR_SEQUENCE_T * sequence,
99 U8 * cdb = sati_cb_get_cdb_address(scsi_io);
100 U8 * register_fis = sati_cb_get_h2d_register_fis_address(ata_io);
103 * The translator doesn't support performing the byte check operation.
104 * As a result, error the request if the BYTCHK bit is set.
106 if ((sati_get_cdb_byte(cdb, 1) & SCSI_VERIFY_BYTCHK_ENABLED))
108 sati_scsi_sense_data_construct(
111 SCSI_STATUS_CHECK_CONDITION,
112 SCSI_SENSE_ILLEGAL_REQUEST,
113 SCSI_ASC_INVALID_FIELD_IN_CDB,
114 SCSI_ASCQ_INVALID_FIELD_IN_CDB
116 return SATI_FAILURE_CHECK_RESPONSE_DATA;
119 sequence->protocol = SAT_PROTOCOL_NON_DATA;
120 sequence->data_direction = SATI_DATA_DIRECTION_NONE;
122 sati_set_ata_device_head(register_fis, ATA_DEV_HEAD_REG_LBA_MODE_ENABLE);
124 // Ensure the device supports the 48 bit feature set.
125 if (sequence->device->capabilities & SATI_DEVICE_CAP_48BIT_ENABLE)
126 sati_set_ata_command(register_fis, ATA_READ_VERIFY_SECTORS_EXT);
128 sati_set_ata_command(register_fis, ATA_READ_VERIFY_SECTORS);
133 //******************************************************************************
134 //* P U B L I C M E T H O D S
135 //******************************************************************************
138 * @brief This method performs all of the translation required for a
139 * SCSI VERIFY 10 byte CDB.
141 * - logical block address translation
142 * - transfer length (sector count) translation
143 * - translation items common to all VERIFY CDB sizes.
144 * For more information on the parameters passed to this method,
145 * please reference sati_translate_command().
147 * @return Indicate if the command translation was successful.
148 * For more information on return values please reference
149 * sati_move_set_sector_count(), sati_verify_translate_command()
151 SATI_STATUS sati_verify_10_translate_command(
152 SATI_TRANSLATOR_SEQUENCE_T * sequence,
158 U8 * cdb = sati_cb_get_cdb_address(scsi_io);
159 U32 sector_count = (sati_get_cdb_byte(cdb, 7) << 8) |
160 (sati_get_cdb_byte(cdb, 8));
162 if(sati_device_state_stopped(sequence, scsi_io))
164 return SATI_FAILURE_CHECK_RESPONSE_DATA;
168 sequence->type = SATI_SEQUENCE_VERIFY_10;
170 // Fill in the Logical Block Address fields and sector count registers.
171 sati_move_translate_32_bit_lba(sequence, scsi_io, ata_io);
172 status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0);
173 if (status != SATI_SUCCESS)
176 return sati_verify_translate_command(sequence, scsi_io, ata_io);
181 * @brief This method performs all of the translation required for a
182 * SCSI VERIFY 12 byte CDB.
184 * - logical block address translation
185 * - transfer length (sector count) translation
186 * - translation items common to all VERIFY CDB sizes.
187 * For more information on the parameters passed to this method,
188 * please reference sati_translate_command().
190 * @return Indicate if the command translation was successful.
191 * For more information on return values please reference
192 * sati_move_set_sector_count(), sati_verify_translate_command()
194 SATI_STATUS sati_verify_12_translate_command(
195 SATI_TRANSLATOR_SEQUENCE_T * sequence,
201 U8 * cdb = sati_cb_get_cdb_address(scsi_io);
202 U32 sector_count = (sati_get_cdb_byte(cdb, 6) << 24) |
203 (sati_get_cdb_byte(cdb, 7) << 16) |
204 (sati_get_cdb_byte(cdb, 8) << 8) |
205 (sati_get_cdb_byte(cdb, 9));
207 if(sati_device_state_stopped(sequence, scsi_io))
209 return SATI_FAILURE_CHECK_RESPONSE_DATA;
213 sequence->type = SATI_SEQUENCE_VERIFY_12;
215 // Fill in the Logical Block Address fields and sector count registers.
216 sati_move_translate_32_bit_lba(sequence, scsi_io, ata_io);
217 status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0);
218 if (status != SATI_SUCCESS)
221 return sati_verify_translate_command(sequence, scsi_io, ata_io);
226 * @brief This method performs all of the translation required for a
227 * SCSI VERIFY 16 byte CDB.
229 * - logical block address translation
230 * - transfer length (sector count) translation
231 * - translation items common to all VERIFY CDB sizes.
232 * For more information on the parameters passed to this method,
233 * please reference sati_translate_command().
235 * @return Indicate if the command translation was successful.
236 * For more information on return values please reference
237 * sati_move_set_sector_count(), sati_verify_translate_command()
239 SATI_STATUS sati_verify_16_translate_command(
240 SATI_TRANSLATOR_SEQUENCE_T * sequence,
246 U8 * cdb = sati_cb_get_cdb_address(scsi_io);
247 U32 sector_count = (sati_get_cdb_byte(cdb, 10) << 24) |
248 (sati_get_cdb_byte(cdb, 11) << 16) |
249 (sati_get_cdb_byte(cdb, 12) << 8) |
250 (sati_get_cdb_byte(cdb, 13));
252 if(sati_device_state_stopped(sequence, scsi_io))
254 return SATI_FAILURE_CHECK_RESPONSE_DATA;
258 sequence->type = SATI_SEQUENCE_VERIFY_16;
260 // Fill in the Logical Block Address field.
261 status = sati_move_translate_64_bit_lba(sequence, scsi_io, ata_io);
262 if (status != SATI_SUCCESS)
265 // Fill in the Sector Count fields.
266 status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0);
267 if (status != SATI_SUCCESS)
270 return sati_verify_translate_command(sequence, scsi_io, ata_io);
274 #endif // !defined(DISABLE_SATI_VERIFY)