1f11c7f63SJim Harris /*- 2*718cf2ccSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0 3*718cf2ccSPedro 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 implementation to translate 61f11c7f63SJim Harris * SCSI Write Long 10 and 16 commands based on the SAT spec. 62f11c7f63SJim Harris */ 63f11c7f63SJim Harris 64f11c7f63SJim Harris #if !defined(DISABLE_SATI_WRITE_LONG) 65f11c7f63SJim Harris 66f11c7f63SJim Harris #include <dev/isci/scil/sati_write_long.h> 67f11c7f63SJim Harris #include <dev/isci/scil/sati_device.h> 68f11c7f63SJim Harris #include <dev/isci/scil/sati_util.h> 69f11c7f63SJim Harris #include <dev/isci/scil/intel_scsi.h> 70f11c7f63SJim Harris #include <dev/isci/scil/intel_ata.h> 71f11c7f63SJim Harris #include <dev/isci/scil/intel_sat.h> 72f11c7f63SJim Harris #include <dev/isci/scil/sati_callbacks.h> 73f11c7f63SJim Harris #include <dev/isci/scil/sati_move.h> 74f11c7f63SJim Harris 75f11c7f63SJim Harris #define LOGICAL_PER_PHYSICAL_SECTOR 0xF 76f11c7f63SJim Harris 77f11c7f63SJim Harris #define WR_UNCOR_BIT 0x02 78f11c7f63SJim Harris #define WR_UNCOR_PBLOCK_BIT 0x03 79f11c7f63SJim Harris #define COR_DIS_WR_UNCORR_BIT 0x06 80f11c7f63SJim Harris 81f11c7f63SJim Harris 82f11c7f63SJim Harris /** 83f11c7f63SJim Harris * @brief This method will translate the write long 10 & 16 SCSI commands into 84f11c7f63SJim Harris * ATA write uncorrectable commands. For more information on the 85f11c7f63SJim Harris * parameters passed to this method, please reference 86f11c7f63SJim Harris * sati_translate_command(). 87f11c7f63SJim Harris * 88f11c7f63SJim Harris * @return Indicate if the command translation succeeded. 89f11c7f63SJim Harris * @retval SCI_SUCCESS This is returned if the command translation was 90f11c7f63SJim Harris * successful. 91f11c7f63SJim Harris * @retval SATI_FAILURE_CHECK_RESPONSE_DATA is returned if there was 92f11c7f63SJim Harris * a problem with the translation of write long. 93f11c7f63SJim Harris * 94f11c7f63SJim Harris */ 95f11c7f63SJim Harris SATI_STATUS sati_write_long_translate_command( 96f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 97f11c7f63SJim Harris void * scsi_io, 98f11c7f63SJim Harris void * ata_io 99f11c7f63SJim Harris ) 100f11c7f63SJim Harris { 101f11c7f63SJim Harris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 102f11c7f63SJim Harris SATI_STATUS status = SATI_FAILURE; 103f11c7f63SJim Harris U16 byte_transfer_length; 104f11c7f63SJim Harris U8 device_head = 0; 105f11c7f63SJim Harris 106f11c7f63SJim Harris if((sequence->device->capabilities & 107f11c7f63SJim Harris SATI_DEVICE_CAP_WRITE_UNCORRECTABLE_ENABLE) == 0) 108f11c7f63SJim Harris { 109f11c7f63SJim Harris sati_scsi_sense_data_construct( 110f11c7f63SJim Harris sequence, 111f11c7f63SJim Harris scsi_io, 112f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 113f11c7f63SJim Harris SCSI_SENSE_ILLEGAL_REQUEST, 114f11c7f63SJim Harris SCSI_ASC_INVALID_COMMAND_OPERATION_CODE, 115f11c7f63SJim Harris SCSI_ASCQ_INVALID_COMMAND_OPERATION_CODE 116f11c7f63SJim Harris ); 117f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 118f11c7f63SJim Harris } 119f11c7f63SJim Harris 120f11c7f63SJim Harris //Write Long 10 121f11c7f63SJim Harris if(sati_get_cdb_byte(cdb, 0) == SCSI_WRITE_LONG_10) 122f11c7f63SJim Harris { 123f11c7f63SJim Harris byte_transfer_length = (sati_get_cdb_byte(cdb, 7) << 8) | 124f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 8)); 125f11c7f63SJim Harris 126f11c7f63SJim Harris sati_move_translate_32_bit_lba(sequence, scsi_io, ata_io); 127f11c7f63SJim Harris } 128f11c7f63SJim Harris else //Write Long 16 129f11c7f63SJim Harris { 130f11c7f63SJim Harris byte_transfer_length = (sati_get_cdb_byte(cdb, 12) << 8) | 131f11c7f63SJim Harris (sati_get_cdb_byte(cdb, 13)); 132f11c7f63SJim Harris 133f11c7f63SJim Harris status = sati_move_translate_64_bit_lba(sequence, scsi_io, ata_io); 134f11c7f63SJim Harris 135f11c7f63SJim Harris if( status == SATI_FAILURE_CHECK_RESPONSE_DATA) 136f11c7f63SJim Harris { 137f11c7f63SJim Harris return status; 138f11c7f63SJim Harris } 139f11c7f63SJim Harris } 140f11c7f63SJim Harris 141f11c7f63SJim Harris 142f11c7f63SJim Harris sati_move_translate_command(sequence, scsi_io, ata_io, device_head); 143f11c7f63SJim Harris 144f11c7f63SJim Harris if( byte_transfer_length != 0 ) 145f11c7f63SJim Harris { 146f11c7f63SJim Harris sati_scsi_sense_data_construct( 147f11c7f63SJim Harris sequence, 148f11c7f63SJim Harris scsi_io, 149f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 150f11c7f63SJim Harris SCSI_SENSE_ILLEGAL_REQUEST, 151f11c7f63SJim Harris SCSI_ASC_INVALID_FIELD_IN_CDB, 152f11c7f63SJim Harris SCSI_ASCQ_INVALID_FIELD_IN_CDB 153f11c7f63SJim Harris ); 154f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 155f11c7f63SJim Harris } 156f11c7f63SJim Harris 157f11c7f63SJim Harris switch(SATI_WRITE_LONG_GET_COR_WR_PB_BITS(cdb)) 158f11c7f63SJim Harris { 159f11c7f63SJim Harris case WR_UNCOR_BIT : 160f11c7f63SJim Harris 161f11c7f63SJim Harris if( (sequence->device->capabilities & 162f11c7f63SJim Harris SATI_DEVICE_CAP_MULTIPLE_SECTORS_PER_PHYSCIAL_SECTOR) != 0 ) 163f11c7f63SJim Harris { 164f11c7f63SJim Harris sati_scsi_sense_data_construct( 165f11c7f63SJim Harris sequence, 166f11c7f63SJim Harris scsi_io, 167f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 168f11c7f63SJim Harris SCSI_SENSE_ILLEGAL_REQUEST, 169f11c7f63SJim Harris SCSI_ASC_INVALID_FIELD_IN_CDB, 170f11c7f63SJim Harris SCSI_ASCQ_INVALID_FIELD_IN_CDB 171f11c7f63SJim Harris ); 172f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 173f11c7f63SJim Harris } 174f11c7f63SJim Harris else 175f11c7f63SJim Harris { 176f11c7f63SJim Harris sati_ata_write_uncorrectable_construct( 177f11c7f63SJim Harris ata_io, 178f11c7f63SJim Harris sequence, 179f11c7f63SJim Harris ATA_WRITE_UNCORRECTABLE_PSUEDO 180f11c7f63SJim Harris ); 181f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_WRITE_LONG; 182f11c7f63SJim Harris status = SATI_SUCCESS; 183f11c7f63SJim Harris } 184f11c7f63SJim Harris break; 185f11c7f63SJim Harris 186f11c7f63SJim Harris case WR_UNCOR_PBLOCK_BIT : 187f11c7f63SJim Harris 188f11c7f63SJim Harris sati_ata_write_uncorrectable_construct( 189f11c7f63SJim Harris ata_io, 190f11c7f63SJim Harris sequence, 191f11c7f63SJim Harris ATA_WRITE_UNCORRECTABLE_PSUEDO 192f11c7f63SJim Harris ); 193f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_WRITE_LONG; 194f11c7f63SJim Harris status = SATI_SUCCESS; 195f11c7f63SJim Harris break; 196f11c7f63SJim Harris 197f11c7f63SJim Harris case COR_DIS_WR_UNCORR_BIT : 198f11c7f63SJim Harris 199f11c7f63SJim Harris sati_ata_write_uncorrectable_construct( 200f11c7f63SJim Harris ata_io, 201f11c7f63SJim Harris sequence, 202f11c7f63SJim Harris ATA_WRITE_UNCORRECTABLE_FLAGGED 203f11c7f63SJim Harris ); 204f11c7f63SJim Harris sequence->type = SATI_SEQUENCE_WRITE_LONG; 205f11c7f63SJim Harris status = SATI_SUCCESS; 206f11c7f63SJim Harris break; 207f11c7f63SJim Harris 208f11c7f63SJim Harris default : 209f11c7f63SJim Harris 210f11c7f63SJim Harris sati_scsi_sense_data_construct( 211f11c7f63SJim Harris sequence, 212f11c7f63SJim Harris scsi_io, 213f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 214f11c7f63SJim Harris SCSI_SENSE_ILLEGAL_REQUEST, 215f11c7f63SJim Harris SCSI_ASC_INVALID_FIELD_IN_CDB, 216f11c7f63SJim Harris SCSI_ASCQ_INVALID_FIELD_IN_CDB 217f11c7f63SJim Harris ); 218f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 219f11c7f63SJim Harris break; 220f11c7f63SJim Harris } 221f11c7f63SJim Harris return status; 222f11c7f63SJim Harris } 223f11c7f63SJim Harris 224f11c7f63SJim Harris /** 225f11c7f63SJim Harris * @brief This method will translate the response to the SATI Write Long 226f11c7f63SJim Harris * translation. This response is only error checking the 227f11c7f63SJim Harris * ATA Write Uncorrectable command. 228f11c7f63SJim Harris * 229f11c7f63SJim Harris * @return SATI_STATUS Indicates if the response translation succeeded. 230f11c7f63SJim Harris * @retval SCI_COMPLETE This is returned if the command translation was 231f11c7f63SJim Harris * successful. 232f11c7f63SJim Harris * @retval SATI_FAILURE_CHECK_RESPONSE_DATA is returned if there was 233f11c7f63SJim Harris * a problem with the translation of write long. 234f11c7f63SJim Harris */ 235f11c7f63SJim Harris SATI_STATUS sati_write_long_translate_response( 236f11c7f63SJim Harris SATI_TRANSLATOR_SEQUENCE_T * sequence, 237f11c7f63SJim Harris void * scsi_io, 238f11c7f63SJim Harris void * ata_io 239f11c7f63SJim Harris ) 240f11c7f63SJim Harris { 241f11c7f63SJim Harris U8 * register_fis = sati_cb_get_d2h_register_fis_address(ata_io); 242f11c7f63SJim Harris 243f11c7f63SJim Harris if (sati_get_ata_status(register_fis) & ATA_STATUS_REG_ERROR_BIT) 244f11c7f63SJim Harris { 245f11c7f63SJim Harris sati_scsi_sense_data_construct( 246f11c7f63SJim Harris sequence, 247f11c7f63SJim Harris scsi_io, 248f11c7f63SJim Harris SCSI_STATUS_CHECK_CONDITION, 249f11c7f63SJim Harris SCSI_SENSE_ABORTED_COMMAND, 250f11c7f63SJim Harris SCSI_ASC_COMMAND_SEQUENCE_ERROR, 251f11c7f63SJim Harris SCSI_ASCQ_NO_ADDITIONAL_SENSE 252f11c7f63SJim Harris ); 253f11c7f63SJim Harris return SATI_FAILURE_CHECK_RESPONSE_DATA; 254f11c7f63SJim Harris } 255f11c7f63SJim Harris else 256f11c7f63SJim Harris { 257f11c7f63SJim Harris return SATI_COMPLETE; 258f11c7f63SJim Harris } 259f11c7f63SJim Harris } 260f11c7f63SJim Harris 261f11c7f63SJim Harris #endif // !defined(DISABLE_SATI_WRITE_LONG) 262