1f11c7f63SJim Harris /*- 2718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3718cf2ccSPedro F. Giffuni * 4f11c7f63SJim Harris * This file is provided under a dual BSD/GPLv2 license. When using or 5f11c7f63SJim Harris * redistributing this file, you may do so under either license. 6f11c7f63SJim Harris * 7f11c7f63SJim Harris * GPL LICENSE SUMMARY 8f11c7f63SJim Harris * 9f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 10f11c7f63SJim Harris * 11f11c7f63SJim Harris * This program is free software; you can redistribute it and/or modify 12f11c7f63SJim Harris * it under the terms of version 2 of the GNU General Public License as 13f11c7f63SJim Harris * published by the Free Software Foundation. 14f11c7f63SJim Harris * 15f11c7f63SJim Harris * This program is distributed in the hope that it will be useful, but 16f11c7f63SJim Harris * WITHOUT ANY WARRANTY; without even the implied warranty of 17f11c7f63SJim Harris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 18f11c7f63SJim Harris * General Public License for more details. 19f11c7f63SJim Harris * 20f11c7f63SJim Harris * You should have received a copy of the GNU General Public License 21f11c7f63SJim Harris * along with this program; if not, write to the Free Software 22f11c7f63SJim Harris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 23f11c7f63SJim Harris * The full GNU General Public License is included in this distribution 24f11c7f63SJim Harris * in the file called LICENSE.GPL. 25f11c7f63SJim Harris * 26f11c7f63SJim Harris * BSD LICENSE 27f11c7f63SJim Harris * 28f11c7f63SJim Harris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 29f11c7f63SJim Harris * All rights reserved. 30f11c7f63SJim Harris * 31f11c7f63SJim Harris * Redistribution and use in source and binary forms, with or without 32f11c7f63SJim Harris * modification, are permitted provided that the following conditions 33f11c7f63SJim Harris * are met: 34f11c7f63SJim Harris * 35f11c7f63SJim Harris * * Redistributions of source code must retain the above copyright 36f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer. 37f11c7f63SJim Harris * * Redistributions in binary form must reproduce the above copyright 38f11c7f63SJim Harris * notice, this list of conditions and the following disclaimer in 39f11c7f63SJim Harris * the documentation and/or other materials provided with the 40f11c7f63SJim Harris * distribution. 41f11c7f63SJim Harris * 42f11c7f63SJim Harris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 43f11c7f63SJim Harris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 44f11c7f63SJim Harris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 45f11c7f63SJim Harris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 46f11c7f63SJim Harris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 47f11c7f63SJim Harris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 48f11c7f63SJim Harris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 49f11c7f63SJim Harris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 50f11c7f63SJim Harris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 51f11c7f63SJim Harris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 52f11c7f63SJim Harris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 53f11c7f63SJim Harris */ 54f11c7f63SJim Harris 55f11c7f63SJim Harris #include <sys/cdefs.h> 56f11c7f63SJim Harris __FBSDID("$FreeBSD$"); 57f11c7f63SJim Harris 58f11c7f63SJim Harris /** 59f11c7f63SJim Harris * @file 60f11c7f63SJim Harris * @brief This file contains the method implementations for translating 61f11c7f63SJim Harris * the SCSI VERIFY (10, 12, 16-byte) commands. 62f11c7f63SJim Harris */ 63f11c7f63SJim Harris 64f11c7f63SJim Harris #if !defined(DISABLE_SATI_VERIFY) 65f11c7f63SJim Harris 66f11c7f63SJim Harris #include <dev/isci/scil/sati_verify.h> 67f11c7f63SJim Harris #include <dev/isci/scil/sati_callbacks.h> 68f11c7f63SJim Harris #include <dev/isci/scil/sati_util.h> 69f11c7f63SJim Harris #include <dev/isci/scil/sati_move.h> 70f11c7f63SJim Harris 71f11c7f63SJim Harris #include <dev/isci/scil/intel_ata.h> 72f11c7f63SJim Harris #include <dev/isci/scil/intel_scsi.h> 73f11c7f63SJim Harris #include <dev/isci/scil/intel_sat.h> 74f11c7f63SJim Harris 75f11c7f63SJim Harris //****************************************************************************** 76f11c7f63SJim Harris //* P R I V A T E M E T H O D S 77f11c7f63SJim Harris //****************************************************************************** 78f11c7f63SJim Harris 79f11c7f63SJim Harris /** 80f11c7f63SJim Harris * @brief This method performs the SCSI VERIFY command translation 81f11c7f63SJim Harris * functionality common to all VERIFY command sizes. 82f11c7f63SJim Harris * This includes: 83f11c7f63SJim Harris * - setting the command register 84f11c7f63SJim Harris * - setting the device head register 85f11c7f63SJim Harris * - filling in fields in the SATI_TRANSLATOR_SEQUENCE object. 86f11c7f63SJim Harris * For more information on the parameters passed to this method, 87f11c7f63SJim Harris * please reference sati_translate_command(). 88f11c7f63SJim Harris * 89f11c7f63SJim Harris * @return Indicate if the method was successfully completed. 90f11c7f63SJim Harris * @retval SATI_SUCCESS This is returned in all other cases. 91f11c7f63SJim Harris */ 92f11c7f63SJim Harris static 93f11c7f63SJim Harris SATI_STATUS sati_verify_translate_command( 94f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 95f11c7f63SJim Harris void * scsi_io, 96f11c7f63SJim Harris void * ata_io 97f11c7f63SJim Harris ) 98f11c7f63SJim Harris { 99f11c7f63SJim Harris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 100f11c7f63SJim Harris U8 * register_fis = sati_cb_get_h2d_register_fis_address(ata_io); 101f11c7f63SJim Harris 102f11c7f63SJim Harris /** 103f11c7f63SJim Harris * The translator doesn't support performing the byte check operation. 104f11c7f63SJim Harris * As a result, error the request if the BYTCHK bit is set. 105f11c7f63SJim Harris */ 106f11c7f63SJim Harris if ((sati_get_cdb_byte(cdb, 1) & SCSI_VERIFY_BYTCHK_ENABLED)) 107f11c7f63SJim Harris { 108f11c7f63SJim Harris sati_scsi_sense_data_construct( 109f11c7f63SJim Harris sequence, 110f11c7f63SJim Harris scsi_io, 111f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 112f11c7f63SJim Harris SCSI_SENSE_ILLEGAL_REQUEST, 113f11c7f63SJim Harris SCSI_ASC_INVALID_FIELD_IN_CDB, 114f11c7f63SJim Harris SCSI_ASCQ_INVALID_FIELD_IN_CDB 115f11c7f63SJim Harris ); 116f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 117f11c7f63SJim Harris } 118f11c7f63SJim Harris 119f11c7f63SJim Harris sequence->protocol = SAT_PROTOCOL_NON_DATA; 120f11c7f63SJim Harris sequence->data_direction = SATI_DATA_DIRECTION_NONE; 121f11c7f63SJim Harris 122f11c7f63SJim Harris sati_set_ata_device_head(register_fis, ATA_DEV_HEAD_REG_LBA_MODE_ENABLE); 123f11c7f63SJim Harris 124f11c7f63SJim Harris // Ensure the device supports the 48 bit feature set. 125f11c7f63SJim Harris if (sequence->device->capabilities & SATI_DEVICE_CAP_48BIT_ENABLE) 126f11c7f63SJim Harris sati_set_ata_command(register_fis, ATA_READ_VERIFY_SECTORS_EXT); 127f11c7f63SJim Harris else 128f11c7f63SJim Harris sati_set_ata_command(register_fis, ATA_READ_VERIFY_SECTORS); 129f11c7f63SJim Harris 130f11c7f63SJim Harris return SATI_SUCCESS; 131f11c7f63SJim Harris } 132f11c7f63SJim Harris 133f11c7f63SJim Harris //****************************************************************************** 134f11c7f63SJim Harris //* P U B L I C M E T H O D S 135f11c7f63SJim Harris //****************************************************************************** 136f11c7f63SJim Harris 137f11c7f63SJim Harris /** 138f11c7f63SJim Harris * @brief This method performs all of the translation required for a 139f11c7f63SJim Harris * SCSI VERIFY 10 byte CDB. 140f11c7f63SJim Harris * This includes: 141f11c7f63SJim Harris * - logical block address translation 142f11c7f63SJim Harris * - transfer length (sector count) translation 143f11c7f63SJim Harris * - translation items common to all VERIFY CDB sizes. 144f11c7f63SJim Harris * For more information on the parameters passed to this method, 145f11c7f63SJim Harris * please reference sati_translate_command(). 146f11c7f63SJim Harris * 147f11c7f63SJim Harris * @return Indicate if the command translation was successful. 148f11c7f63SJim Harris * For more information on return values please reference 149f11c7f63SJim Harris * sati_move_set_sector_count(), sati_verify_translate_command() 150f11c7f63SJim Harris */ 151f11c7f63SJim Harris SATI_STATUS sati_verify_10_translate_command( 152f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 153f11c7f63SJim Harris void * scsi_io, 154f11c7f63SJim Harris void * ata_io 155f11c7f63SJim Harris ) 156f11c7f63SJim Harris { 157f11c7f63SJim Harris SATI_STATUS status; 158f11c7f63SJim Harris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 159f11c7f63SJim Harris U32 sector_count = (sati_get_cdb_byte(cdb, 7) << 8) | 160f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 8)); 161f11c7f63SJim Harris 162f11c7f63SJim Harris if(sati_device_state_stopped(sequence, scsi_io)) 163f11c7f63SJim Harris { 164f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 165f11c7f63SJim Harris } 166f11c7f63SJim Harris else 167f11c7f63SJim Harris { 168f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_VERIFY_10; 169f11c7f63SJim Harris 170f11c7f63SJim Harris // Fill in the Logical Block Address fields and sector count registers. 171f11c7f63SJim Harris sati_move_translate_32_bit_lba(sequence, scsi_io, ata_io); 172f11c7f63SJim Harris status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0); 173f11c7f63SJim Harris if (status != SATI_SUCCESS) 174f11c7f63SJim Harris return status; 175f11c7f63SJim Harris 176f11c7f63SJim Harris return sati_verify_translate_command(sequence, scsi_io, ata_io); 177f11c7f63SJim Harris } 178f11c7f63SJim Harris } 179f11c7f63SJim Harris 180f11c7f63SJim Harris /** 181f11c7f63SJim Harris * @brief This method performs all of the translation required for a 182f11c7f63SJim Harris * SCSI VERIFY 12 byte CDB. 183f11c7f63SJim Harris * This includes: 184f11c7f63SJim Harris * - logical block address translation 185f11c7f63SJim Harris * - transfer length (sector count) translation 186f11c7f63SJim Harris * - translation items common to all VERIFY CDB sizes. 187f11c7f63SJim Harris * For more information on the parameters passed to this method, 188f11c7f63SJim Harris * please reference sati_translate_command(). 189f11c7f63SJim Harris * 190f11c7f63SJim Harris * @return Indicate if the command translation was successful. 191f11c7f63SJim Harris * For more information on return values please reference 192f11c7f63SJim Harris * sati_move_set_sector_count(), sati_verify_translate_command() 193f11c7f63SJim Harris */ 194f11c7f63SJim Harris SATI_STATUS sati_verify_12_translate_command( 195f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 196f11c7f63SJim Harris void * scsi_io, 197f11c7f63SJim Harris void * ata_io 198f11c7f63SJim Harris ) 199f11c7f63SJim Harris { 200f11c7f63SJim Harris SATI_STATUS status; 201f11c7f63SJim Harris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 202f11c7f63SJim Harris U32 sector_count = (sati_get_cdb_byte(cdb, 6) << 24) | 203f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 7) << 16) | 204f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 8) << 8) | 205f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 9)); 206f11c7f63SJim Harris 207f11c7f63SJim Harris if(sati_device_state_stopped(sequence, scsi_io)) 208f11c7f63SJim Harris { 209f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 210f11c7f63SJim Harris } 211f11c7f63SJim Harris else 212f11c7f63SJim Harris { 213f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_VERIFY_12; 214f11c7f63SJim Harris 215f11c7f63SJim Harris // Fill in the Logical Block Address fields and sector count registers. 216f11c7f63SJim Harris sati_move_translate_32_bit_lba(sequence, scsi_io, ata_io); 217f11c7f63SJim Harris status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0); 218f11c7f63SJim Harris if (status != SATI_SUCCESS) 219f11c7f63SJim Harris return status; 220f11c7f63SJim Harris 221f11c7f63SJim Harris return sati_verify_translate_command(sequence, scsi_io, ata_io); 222f11c7f63SJim Harris } 223f11c7f63SJim Harris } 224f11c7f63SJim Harris 225f11c7f63SJim Harris /** 226f11c7f63SJim Harris * @brief This method performs all of the translation required for a 227f11c7f63SJim Harris * SCSI VERIFY 16 byte CDB. 228f11c7f63SJim Harris * This includes: 229f11c7f63SJim Harris * - logical block address translation 230f11c7f63SJim Harris * - transfer length (sector count) translation 231f11c7f63SJim Harris * - translation items common to all VERIFY CDB sizes. 232f11c7f63SJim Harris * For more information on the parameters passed to this method, 233f11c7f63SJim Harris * please reference sati_translate_command(). 234f11c7f63SJim Harris * 235f11c7f63SJim Harris * @return Indicate if the command translation was successful. 236f11c7f63SJim Harris * For more information on return values please reference 237f11c7f63SJim Harris * sati_move_set_sector_count(), sati_verify_translate_command() 238f11c7f63SJim Harris */ 239f11c7f63SJim Harris SATI_STATUS sati_verify_16_translate_command( 240f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 241f11c7f63SJim Harris void * scsi_io, 242f11c7f63SJim Harris void * ata_io 243f11c7f63SJim Harris ) 244f11c7f63SJim Harris { 245f11c7f63SJim Harris SATI_STATUS status; 246f11c7f63SJim Harris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 247f11c7f63SJim Harris U32 sector_count = (sati_get_cdb_byte(cdb, 10) << 24) | 248f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 11) << 16) | 249f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 12) << 8) | 250f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 13)); 251f11c7f63SJim Harris 252f11c7f63SJim Harris if(sati_device_state_stopped(sequence, scsi_io)) 253f11c7f63SJim Harris { 254f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 255f11c7f63SJim Harris } 256f11c7f63SJim Harris else 257f11c7f63SJim Harris { 258f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_VERIFY_16; 259f11c7f63SJim Harris 260f11c7f63SJim Harris // Fill in the Logical Block Address field. 261f11c7f63SJim Harris status = sati_move_translate_64_bit_lba(sequence, scsi_io, ata_io); 262f11c7f63SJim Harris if (status != SATI_SUCCESS) 263f11c7f63SJim Harris return status; 264f11c7f63SJim Harris 265f11c7f63SJim Harris // Fill in the Sector Count fields. 266f11c7f63SJim Harris status = sati_move_set_sector_count(sequence,scsi_io,ata_io,sector_count,0); 267f11c7f63SJim Harris if (status != SATI_SUCCESS) 268f11c7f63SJim Harris return status; 269f11c7f63SJim Harris 270f11c7f63SJim Harris return sati_verify_translate_command(sequence, scsi_io, ata_io); 271f11c7f63SJim Harris } 272f11c7f63SJim Harris } 273f11c7f63SJim Harris 274f11c7f63SJim Harris #endif // !defined(DISABLE_SATI_VERIFY) 275f11c7f63SJim Harris 276