1230557Sjimharris/*- 2230557Sjimharris * This file is provided under a dual BSD/GPLv2 license. When using or 3230557Sjimharris * redistributing this file, you may do so under either license. 4230557Sjimharris * 5230557Sjimharris * GPL LICENSE SUMMARY 6230557Sjimharris * 7230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 8230557Sjimharris * 9230557Sjimharris * This program is free software; you can redistribute it and/or modify 10230557Sjimharris * it under the terms of version 2 of the GNU General Public License as 11230557Sjimharris * published by the Free Software Foundation. 12230557Sjimharris * 13230557Sjimharris * This program is distributed in the hope that it will be useful, but 14230557Sjimharris * WITHOUT ANY WARRANTY; without even the implied warranty of 15230557Sjimharris * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16230557Sjimharris * General Public License for more details. 17230557Sjimharris * 18230557Sjimharris * You should have received a copy of the GNU General Public License 19230557Sjimharris * along with this program; if not, write to the Free Software 20230557Sjimharris * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA. 21230557Sjimharris * The full GNU General Public License is included in this distribution 22230557Sjimharris * in the file called LICENSE.GPL. 23230557Sjimharris * 24230557Sjimharris * BSD LICENSE 25230557Sjimharris * 26230557Sjimharris * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. 27230557Sjimharris * All rights reserved. 28230557Sjimharris * 29230557Sjimharris * Redistribution and use in source and binary forms, with or without 30230557Sjimharris * modification, are permitted provided that the following conditions 31230557Sjimharris * are met: 32230557Sjimharris * 33230557Sjimharris * * Redistributions of source code must retain the above copyright 34230557Sjimharris * notice, this list of conditions and the following disclaimer. 35230557Sjimharris * * Redistributions in binary form must reproduce the above copyright 36230557Sjimharris * notice, this list of conditions and the following disclaimer in 37230557Sjimharris * the documentation and/or other materials provided with the 38230557Sjimharris * distribution. 39230557Sjimharris * 40230557Sjimharris * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 41230557Sjimharris * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 42230557Sjimharris * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 43230557Sjimharris * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 44230557Sjimharris * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 45230557Sjimharris * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 46230557Sjimharris * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 47230557Sjimharris * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 48230557Sjimharris * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 49230557Sjimharris * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 50230557Sjimharris * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 51230557Sjimharris */ 52230557Sjimharris 53230557Sjimharris#include <sys/cdefs.h> 54230557Sjimharris__FBSDID("$FreeBSD$"); 55230557Sjimharris 56230557Sjimharris/** 57230557Sjimharris * @file 58230557Sjimharris * @brief This file contains all of the method implementations that 59230557Sjimharris * can be utilized by a user to perform SCSI-to-ATA Translation. 60230557Sjimharris * SATI adheres to the www.t10.org SAT specification. 61230557Sjimharris * 62230557Sjimharris * For situations where compliance is not observed, the SATI will 63230557Sjimharris * return an error indication (most likely INVALID FIELD IN CDB sense data). 64230557Sjimharris */ 65230557Sjimharris 66230557Sjimharris#include <dev/isci/scil/sati.h> 67230557Sjimharris#include <dev/isci/scil/sati_util.h> 68230557Sjimharris#include <dev/isci/scil/sati_atapi.h> 69230557Sjimharris#include <dev/isci/scil/sati_callbacks.h> 70230557Sjimharris#include <dev/isci/scil/intel_ata.h> 71230557Sjimharris#include <dev/isci/scil/intel_scsi.h> 72230557Sjimharris#include <dev/isci/scil/intel_sat.h> 73230557Sjimharris#include <dev/isci/scil/sati_report_luns.h> 74230557Sjimharris 75230557Sjimharris 76230557Sjimharris//****************************************************************************** 77230557Sjimharris//* P U B L I C M E T H O D S 78230557Sjimharris//****************************************************************************** 79230557Sjimharris 80230557SjimharrisSATI_STATUS sati_atapi_translate_command( 81230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 82230557Sjimharris SATI_DEVICE_T * sati_device, 83230557Sjimharris void * scsi_io, 84230557Sjimharris void * atapi_io 85230557Sjimharris) 86230557Sjimharris{ 87230557Sjimharris SATI_STATUS status; 88230557Sjimharris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 89230557Sjimharris 90230557Sjimharris SATA_FIS_REG_H2D_T * register_fis = 91230557Sjimharris (SATA_FIS_REG_H2D_T *)sati_cb_get_h2d_register_fis_address(atapi_io); 92230557Sjimharris 93230557Sjimharris U8 io_direction = SATI_DATA_DIRECTION_IN; 94230557Sjimharris 95230557Sjimharris //No sense response has been set for the translation sequence yet 96230557Sjimharris sequence->is_sense_response_set = FALSE; 97230557Sjimharris // Default to no translation response required 98230557Sjimharris sequence->is_translate_response_required = FALSE; 99230557Sjimharris 100230557Sjimharris sequence->number_data_bytes_set = 0; 101230557Sjimharris sequence->device = sati_device; 102230557Sjimharris sequence->command_specific_data.scratch = 0; 103230557Sjimharris 104230557Sjimharris sati_cb_get_data_direction(scsi_io, &io_direction); 105230557Sjimharris 106230557Sjimharris //set sat protocol. 107230557Sjimharris if (io_direction == SATI_DATA_DIRECTION_NONE) 108230557Sjimharris sequence->protocol = SAT_PROTOCOL_PACKET_NON_DATA; 109230557Sjimharris else if (io_direction == SATI_DATA_DIRECTION_IN) 110230557Sjimharris sequence->protocol = SAT_PROTOCOL_PACKET_DMA_DATA_IN; 111230557Sjimharris else if (io_direction == SATI_DATA_DIRECTION_OUT) 112230557Sjimharris sequence->protocol = SAT_PROTOCOL_PACKET_DMA_DATA_OUT; 113230557Sjimharris 114230557Sjimharris // We don't send Report Luns command out. 115230557Sjimharris if (sati_get_cdb_byte(cdb, 0) == SCSI_REPORT_LUNS) 116230557Sjimharris { 117230557Sjimharris status = sati_report_luns_translate_command( 118230557Sjimharris sequence, scsi_io, atapi_io 119230557Sjimharris ); 120230557Sjimharris } 121230557Sjimharris else if (sati_cb_get_lun(scsi_io) != 0) 122230557Sjimharris { 123230557Sjimharris sati_scsi_sense_data_construct( 124230557Sjimharris sequence, 125230557Sjimharris scsi_io, 126230557Sjimharris SCSI_STATUS_CHECK_CONDITION, 127230557Sjimharris SCSI_SENSE_ILLEGAL_REQUEST, 128230557Sjimharris SCSI_ASC_LOGICAL_UNIT_NOT_SUPPORTED, 129230557Sjimharris 0 130230557Sjimharris ); 131230557Sjimharris status = SATI_FAILURE_CHECK_RESPONSE_DATA; 132230557Sjimharris } 133230557Sjimharris else 134230557Sjimharris { 135230557Sjimharris if (sequence->state == SATI_SEQUENCE_STATE_INCOMPLETE) 136230557Sjimharris { //Request Sense command is required. 137230557Sjimharris U8 request_sense_cdb[SATI_ATAPI_REQUEST_SENSE_CDB_LENGTH] = 138230557Sjimharris {0x3, 0x0, 0x0, 0x0, 0x12, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0}; 139230557Sjimharris 140230557Sjimharris //set the sequence->protocol to DATA_IN anyway; 141230557Sjimharris sequence->protocol = SAT_PROTOCOL_PACKET_DMA_DATA_IN; 142230557Sjimharris 143230557Sjimharris //set the cdb for Request Sense using command_specific_data field. 144230557Sjimharris memcpy(sequence->command_specific_data.sati_atapi_data.request_sense_cdb, 145230557Sjimharris request_sense_cdb, 146230557Sjimharris SATI_ATAPI_REQUEST_SENSE_CDB_LENGTH 147230557Sjimharris ); 148230557Sjimharris } 149230557Sjimharris 150230557Sjimharris //build Packet Fis for any other command translation. 151230557Sjimharris register_fis->command = ATA_PACKET; 152230557Sjimharris register_fis->features |= ATA_PACKET_FEATURE_DMA; 153230557Sjimharris 154230557Sjimharris register_fis->fis_type = SATA_FIS_TYPE_REGH2D; 155230557Sjimharris register_fis->command_flag = 1; 156230557Sjimharris 157230557Sjimharris status = SATI_SUCCESS; 158230557Sjimharris } 159230557Sjimharris 160230557Sjimharris return status; 161230557Sjimharris} 162230557Sjimharris 163230557Sjimharris 164230557SjimharrisSATI_STATUS sati_atapi_translate_command_response( 165230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 166230557Sjimharris void * scsi_io, 167230557Sjimharris void * atapi_io 168230557Sjimharris) 169230557Sjimharris{ 170230557Sjimharris SATI_STATUS status = SATI_COMPLETE; 171230557Sjimharris U8 * register_fis = sati_cb_get_d2h_register_fis_address(atapi_io); 172230557Sjimharris U8 ata_status; 173230557Sjimharris 174230557Sjimharris /** 175230557Sjimharris * If the device fault bit is set in the status register, then 176230557Sjimharris * set the sense data and return. 177230557Sjimharris */ 178230557Sjimharris ata_status = (U8) sati_get_ata_status(register_fis); 179230557Sjimharris if (ata_status & ATA_STATUS_REG_DEVICE_FAULT_BIT) 180230557Sjimharris { 181230557Sjimharris sati_scsi_sense_data_construct( 182230557Sjimharris sequence, 183230557Sjimharris scsi_io, 184230557Sjimharris SCSI_STATUS_CHECK_CONDITION, 185230557Sjimharris SCSI_SENSE_HARDWARE_ERROR, 186230557Sjimharris SCSI_ASC_INTERNAL_TARGET_FAILURE, 187230557Sjimharris SCSI_ASCQ_INTERNAL_TARGET_FAILURE 188230557Sjimharris ); 189230557Sjimharris 190230557Sjimharris sequence->device->state = SATI_DEVICE_STATE_DEVICE_FAULT_OCCURRED; 191230557Sjimharris 192230557Sjimharris return SATI_FAILURE_CHECK_RESPONSE_DATA; 193230557Sjimharris } 194230557Sjimharris else if (ata_status & ATA_STATUS_REG_ERROR_BIT) 195230557Sjimharris { 196230557Sjimharris //reset the register_fis. 197230557Sjimharris memset(register_fis, 0, sizeof(SATA_FIS_REG_D2H_T)); 198230557Sjimharris 199230557Sjimharris //Internal Request Sense command is needed. 200230557Sjimharris sequence->state = SATI_SEQUENCE_STATE_INCOMPLETE; 201230557Sjimharris return SATI_SEQUENCE_INCOMPLETE; 202230557Sjimharris } 203230557Sjimharris 204230557Sjimharris return status; 205230557Sjimharris} 206230557Sjimharris 207230557Sjimharrisvoid sati_atapi_translate_request_sense_response( 208230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 209230557Sjimharris void * scsi_io, 210230557Sjimharris void * atapi_io 211230557Sjimharris) 212230557Sjimharris{ 213230557Sjimharris //sense data is already in place. 214230557Sjimharris SCI_SSP_RESPONSE_IU_T * rsp_iu = (SCI_SSP_RESPONSE_IU_T*) 215230557Sjimharris sati_cb_get_response_iu_address(scsi_io); 216230557Sjimharris 217230557Sjimharris sati_scsi_common_response_iu_construct( 218230557Sjimharris rsp_iu, 219230557Sjimharris SCSI_STATUS_CHECK_CONDITION, 220230557Sjimharris sati_scsi_get_sense_data_length(sequence, scsi_io), 221230557Sjimharris SCSI_RESPONSE_DATA_PRES_SENSE_DATA 222230557Sjimharris ); 223230557Sjimharris 224230557Sjimharris sequence->is_sense_response_set = TRUE; 225230557Sjimharris 226230557Sjimharris sequence->state = SATI_SEQUENCE_STATE_FINAL; 227230557Sjimharris} 228230557Sjimharris 229230557Sjimharris 230230557SjimharrisU32 sati_atapi_translate_number_of_bytes_transferred( 231230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 232230557Sjimharris void * scsi_io, 233230557Sjimharris void * atapi_io 234230557Sjimharris) 235230557Sjimharris{ 236230557Sjimharris U8* cdb = sati_cb_get_cdb_address(scsi_io); 237230557Sjimharris U8 response_data; 238230557Sjimharris U32 data_length = 0; 239230557Sjimharris 240230557Sjimharris switch(cdb[0]) 241230557Sjimharris { 242230557Sjimharris case SCSI_MODE_SENSE_10: 243230557Sjimharris sati_cb_get_data_byte(scsi_io, 1, &response_data); 244230557Sjimharris data_length = response_data+2; 245230557Sjimharris break; 246230557Sjimharris 247230557Sjimharris case 0x51: //READ DISC INFORMATION 248230557Sjimharris sati_cb_get_data_byte(scsi_io, 1, &response_data); 249230557Sjimharris data_length = response_data+2; 250230557Sjimharris break; 251230557Sjimharris 252230557Sjimharris default: 253230557Sjimharris break; 254230557Sjimharris } 255230557Sjimharris 256230557Sjimharris return data_length; 257230557Sjimharris} 258