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: releng/10.2/sys/dev/isci/scil/sati_read_capacity.c 233663 2012-03-29 15:43:07Z jimharris $"); 55230557Sjimharris 56230557Sjimharris/** 57230557Sjimharris * @file 58230557Sjimharris * @brief This file contains the method implementations required to 59230557Sjimharris * translate the SCSI read capacity (10 byte) command. 60230557Sjimharris */ 61230557Sjimharris 62230557Sjimharris#if !defined(DISABLE_SATI_READ_CAPACITY) 63230557Sjimharris 64230557Sjimharris#include <dev/isci/scil/sati_read_capacity.h> 65230557Sjimharris#include <dev/isci/scil/sati_callbacks.h> 66230557Sjimharris#include <dev/isci/scil/sati_util.h> 67230557Sjimharris#include <dev/isci/scil/intel_ata.h> 68230557Sjimharris#include <dev/isci/scil/intel_scsi.h> 69230557Sjimharris 70230557Sjimharris/** 71230557Sjimharris * @brief This method will translate the read capacity 10 SCSI command into 72230557Sjimharris * an ATA IDENTIFY DEVICE command. 73230557Sjimharris * For more information on the parameters passed to this method, 74230557Sjimharris * please reference sati_translate_command(). 75230557Sjimharris * 76230557Sjimharris * @return Indicate if the command translation succeeded. 77230557Sjimharris * @retval SCI_SUCCESS This is returned if the command translation was 78230557Sjimharris * successful. 79230557Sjimharris * @retval SATI_FAILURE_CHECK_RESPONSE_DATA This value is returned if the 80230557Sjimharris * LBA field is not 0, the PMI bit is not 0. 81230557Sjimharris */ 82230557SjimharrisSATI_STATUS sati_read_capacity_10_translate_command( 83230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 84230557Sjimharris void * scsi_io, 85230557Sjimharris void * ata_io 86230557Sjimharris) 87230557Sjimharris{ 88230557Sjimharris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 89230557Sjimharris 90230557Sjimharris /** 91230557Sjimharris * SAT dictates: 92230557Sjimharris * - the LBA field must be 0 93230557Sjimharris * - the PMI bit must be 0 94230557Sjimharris */ 95230557Sjimharris if ( 96230557Sjimharris ( 97230557Sjimharris (sati_get_cdb_byte(cdb, 2) != 0) 98230557Sjimharris || (sati_get_cdb_byte(cdb, 3) != 0) 99230557Sjimharris || (sati_get_cdb_byte(cdb, 4) != 0) 100230557Sjimharris || (sati_get_cdb_byte(cdb, 5) != 0) 101230557Sjimharris ) 102230557Sjimharris || ((sati_get_cdb_byte(cdb, 8) & SCSI_READ_CAPACITY_PMI_BIT_ENABLE) 103230557Sjimharris == 1) 104230557Sjimharris ) 105230557Sjimharris { 106230557Sjimharris sati_scsi_sense_data_construct( 107230557Sjimharris sequence, 108230557Sjimharris scsi_io, 109230557Sjimharris SCSI_STATUS_CHECK_CONDITION, 110230557Sjimharris SCSI_SENSE_ILLEGAL_REQUEST, 111230557Sjimharris SCSI_ASC_INVALID_FIELD_IN_CDB, 112230557Sjimharris SCSI_ASCQ_INVALID_FIELD_IN_CDB 113230557Sjimharris ); 114230557Sjimharris return SATI_FAILURE_CHECK_RESPONSE_DATA; 115230557Sjimharris } 116230557Sjimharris 117230557Sjimharris // The CDB is properly formed. 118230557Sjimharris sequence->allocation_length = SCSI_READ_CAPACITY_10_DATA_LENGTH; 119230557Sjimharris sequence->type = SATI_SEQUENCE_READ_CAPACITY_10; 120230557Sjimharris 121230557Sjimharris sati_ata_identify_device_construct(ata_io, sequence); 122230557Sjimharris return SATI_SUCCESS; 123230557Sjimharris} 124230557Sjimharris 125230557Sjimharris 126230557Sjimharris 127230557Sjimharris/** 128230557Sjimharris * @brief This method will translate the read capacity 16 SCSI command into 129230557Sjimharris * an ATA IDENTIFY DEVICE command. 130230557Sjimharris * For more information on the parameters passed to this method, 131230557Sjimharris * please reference sati_translate_command(). 132230557Sjimharris * 133230557Sjimharris * @return Indicate if the command translation succeeded. 134230557Sjimharris * @retval SCI_SUCCESS This is returned if the command translation was 135230557Sjimharris * successful. 136230557Sjimharris * @retval SATI_FAILURE_CHECK_RESPONSE_DATA This value is returned if the 137230557Sjimharris * LBA field is not 0, the PMI bit is not 0. 138230557Sjimharris */ 139230557SjimharrisSATI_STATUS sati_read_capacity_16_translate_command( 140230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 141230557Sjimharris void * scsi_io, 142230557Sjimharris void * ata_io 143230557Sjimharris) 144230557Sjimharris{ 145230557Sjimharris U8 * cdb = sati_cb_get_cdb_address(scsi_io); 146230557Sjimharris 147230557Sjimharris /** 148230557Sjimharris * SAT dictates: 149230557Sjimharris * - the LBA field must be 0 150230557Sjimharris * - the PMI bit must be 0 151230557Sjimharris */ 152230557Sjimharris if ( 153230557Sjimharris ( 154230557Sjimharris (sati_get_cdb_byte(cdb, 2) != 0) 155230557Sjimharris || (sati_get_cdb_byte(cdb, 3) != 0) 156230557Sjimharris || (sati_get_cdb_byte(cdb, 4) != 0) 157230557Sjimharris || (sati_get_cdb_byte(cdb, 5) != 0) 158230557Sjimharris || (sati_get_cdb_byte(cdb, 6) != 0) 159230557Sjimharris || (sati_get_cdb_byte(cdb, 7) != 0) 160230557Sjimharris || (sati_get_cdb_byte(cdb, 8) != 0) 161230557Sjimharris || (sati_get_cdb_byte(cdb, 9) != 0) 162230557Sjimharris ) 163230557Sjimharris || ((sati_get_cdb_byte(cdb, 14) & SCSI_READ_CAPACITY_PMI_BIT_ENABLE) 164230557Sjimharris == 1) 165230557Sjimharris ) 166230557Sjimharris { 167230557Sjimharris sati_scsi_sense_data_construct( 168230557Sjimharris sequence, 169230557Sjimharris scsi_io, 170230557Sjimharris SCSI_STATUS_CHECK_CONDITION, 171230557Sjimharris SCSI_SENSE_ILLEGAL_REQUEST, 172230557Sjimharris SCSI_ASC_INVALID_FIELD_IN_CDB, 173230557Sjimharris SCSI_ASCQ_INVALID_FIELD_IN_CDB 174230557Sjimharris ); 175230557Sjimharris return SATI_FAILURE_CHECK_RESPONSE_DATA; 176230557Sjimharris } 177230557Sjimharris 178230557Sjimharris // The CDB is properly formed. 179230557Sjimharris sequence->allocation_length = (sati_get_cdb_byte(cdb, 10) << 24) | 180230557Sjimharris (sati_get_cdb_byte(cdb, 11) << 16) | 181230557Sjimharris (sati_get_cdb_byte(cdb, 12) << 8) | 182230557Sjimharris (sati_get_cdb_byte(cdb, 13)); 183230557Sjimharris 184230557Sjimharris sequence->type = SATI_SEQUENCE_READ_CAPACITY_16; 185230557Sjimharris 186230557Sjimharris sati_ata_identify_device_construct(ata_io, sequence); 187230557Sjimharris return SATI_SUCCESS; 188230557Sjimharris} 189230557Sjimharris 190230557Sjimharris/** 191230557Sjimharris * @brief This method will translate the ATA Identify Device data into 192230557Sjimharris * SCSI read capacity 10 data. 193230557Sjimharris * For more information on the parameters passed to this method, 194230557Sjimharris * please reference sati_translate_data(). 195230557Sjimharris * 196230557Sjimharris * @return none 197230557Sjimharris */ 198230557Sjimharrisvoid sati_read_capacity_10_translate_data( 199230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 200230557Sjimharris void * ata_input_data, 201230557Sjimharris void * scsi_io 202230557Sjimharris) 203230557Sjimharris{ 204230557Sjimharris U32 lba_low = 0; 205230557Sjimharris U32 lba_high = 0; 206230557Sjimharris U32 sector_size = 0; 207230557Sjimharris 208230557Sjimharris // Extract the sector information (sector size, logical blocks) from 209230557Sjimharris // the retrieved ATA identify device data. 210230557Sjimharris sati_ata_identify_device_get_sector_info( 211230557Sjimharris (ATA_IDENTIFY_DEVICE_DATA_T*)ata_input_data, 212230557Sjimharris &lba_high, 213230557Sjimharris &lba_low, 214230557Sjimharris §or_size 215230557Sjimharris ); 216230557Sjimharris 217230557Sjimharris // SATA drives report a value that is one LBA larger than the last LBA. 218230557Sjimharris // SCSI wants the last LBA. Make the correction here. lba_low is 219230557Sjimharris // always decremented since it is an unsigned long the value 0 will 220230557Sjimharris // wrap to 0xFFFFFFFF. 221230557Sjimharris if ((lba_low == 0) && (lba_high == 0)) 222230557Sjimharris lba_high -= 1; 223230557Sjimharris lba_low -= 1; 224230557Sjimharris 225230557Sjimharris if(lba_high != 0) 226230557Sjimharris { 227230557Sjimharris sati_set_data_byte(sequence, scsi_io, 0, 0xFF); 228230557Sjimharris sati_set_data_byte(sequence, scsi_io, 1, 0xFF); 229230557Sjimharris sati_set_data_byte(sequence, scsi_io, 2, 0xFF); 230230557Sjimharris sati_set_data_byte(sequence, scsi_io, 3, 0xFF); 231230557Sjimharris } 232230557Sjimharris else 233230557Sjimharris { 234230557Sjimharris // Build CDB for Read Capacity 10 235230557Sjimharris // Fill in the Logical Block Address bytes. 236230557Sjimharris sati_set_data_byte(sequence, scsi_io, 0, (U8)((lba_low >> 24) & 0xFF)); 237230557Sjimharris sati_set_data_byte(sequence, scsi_io, 1, (U8)((lba_low >> 16) & 0xFF)); 238230557Sjimharris sati_set_data_byte(sequence, scsi_io, 2, (U8)((lba_low >> 8) & 0xFF)); 239230557Sjimharris sati_set_data_byte(sequence, scsi_io, 3, (U8)(lba_low & 0xFF)); 240230557Sjimharris } 241230557Sjimharris // Fill in the sector size field. 242230557Sjimharris sati_set_data_byte(sequence, scsi_io, 4, (U8)((sector_size >> 24) & 0xFF)); 243230557Sjimharris sati_set_data_byte(sequence, scsi_io, 5, (U8)((sector_size >> 16) & 0xFF)); 244230557Sjimharris sati_set_data_byte(sequence, scsi_io, 6, (U8)((sector_size >> 8) & 0xFF)); 245230557Sjimharris sati_set_data_byte(sequence, scsi_io, 7, (U8)(sector_size & 0xFF)); 246230557Sjimharris} 247230557Sjimharris 248230557Sjimharris/** 249230557Sjimharris * @brief This method will translate the ATA Identify Device data into 250230557Sjimharris * SCSI read capacity 16 data. 251230557Sjimharris * For more information on the parameters passed to this method, 252230557Sjimharris * please reference sati_translate_data(). 253230557Sjimharris * 254230557Sjimharris * @return none 255230557Sjimharris */ 256230557Sjimharrisvoid sati_read_capacity_16_translate_data( 257230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 258230557Sjimharris void * ata_input_data, 259230557Sjimharris void * scsi_io 260230557Sjimharris) 261230557Sjimharris{ 262230557Sjimharris U32 lba_low = 0; 263230557Sjimharris U32 lba_high = 0; 264230557Sjimharris U32 sector_size = 0; 265230557Sjimharris ATA_IDENTIFY_DEVICE_DATA_T * identify_device_data; 266230557Sjimharris U16 physical_per_logical_enable_bit = 0; 267230557Sjimharris U8 physical_per_logical_sector_exponent = 0; 268230557Sjimharris U16 physical_per_logical_sector = 0; 269230557Sjimharris U16 logical_sector_alignment = 0; 270230557Sjimharris U16 scsi_logical_sector_alignment = 0; 271230557Sjimharris U8 byte14 = 0; 272230557Sjimharris 273230557Sjimharris //A number of data fields need to be extracted from ATA identify device data 274230557Sjimharris identify_device_data = (ATA_IDENTIFY_DEVICE_DATA_T*)ata_input_data; 275230557Sjimharris 276230557Sjimharris // Extract the sector information (sector size, logical blocks) from 277230557Sjimharris // the retrieved ATA identify device data. 278230557Sjimharris sati_ata_identify_device_get_sector_info( 279230557Sjimharris (ATA_IDENTIFY_DEVICE_DATA_T*)ata_input_data, 280230557Sjimharris &lba_high, 281230557Sjimharris &lba_low, 282230557Sjimharris §or_size 283230557Sjimharris ); 284230557Sjimharris 285230557Sjimharris // SATA drives report a value that is one LBA larger than the last LBA. 286230557Sjimharris // SCSI wants the last LBA. Make the correction here. lba_low is 287230557Sjimharris // always decremented since it is an unsigned long the value 0 will 288230557Sjimharris // wrap to 0xFFFFFFFF. 289230557Sjimharris if ((lba_low == 0) && (lba_high == 0)) 290230557Sjimharris lba_high -= 1; 291230557Sjimharris lba_low -= 1; 292230557Sjimharris 293230557Sjimharris // Build the CDB for Read Capacity 16 294230557Sjimharris // Fill in the Logical Block Address bytes. 295230557Sjimharris sati_set_data_byte(sequence, scsi_io, 0, (U8)((lba_high >> 24) & 0xFF)); 296230557Sjimharris sati_set_data_byte(sequence, scsi_io, 1, (U8)((lba_high >> 16) & 0xFF)); 297230557Sjimharris sati_set_data_byte(sequence, scsi_io, 2, (U8)((lba_high >> 8) & 0xFF)); 298230557Sjimharris sati_set_data_byte(sequence, scsi_io, 3, (U8)(lba_high & 0xFF)); 299230557Sjimharris 300230557Sjimharris sati_set_data_byte(sequence, scsi_io, 4, (U8)((lba_low >> 24) & 0xFF)); 301230557Sjimharris sati_set_data_byte(sequence, scsi_io, 5, (U8)((lba_low >> 16) & 0xFF)); 302230557Sjimharris sati_set_data_byte(sequence, scsi_io, 6, (U8)((lba_low >> 8) & 0xFF)); 303230557Sjimharris sati_set_data_byte(sequence, scsi_io, 7, (U8)(lba_low & 0xFF)); 304230557Sjimharris 305230557Sjimharris //Fill in the sector size field. 306230557Sjimharris sati_set_data_byte(sequence, scsi_io, 8, (U8)((sector_size >> 24) & 0xFF)); 307230557Sjimharris sati_set_data_byte(sequence, scsi_io, 9, (U8)((sector_size >> 16) & 0xFF)); 308230557Sjimharris sati_set_data_byte(sequence, scsi_io, 10, (U8)((sector_size >> 8) & 0xFF)); 309230557Sjimharris sati_set_data_byte(sequence, scsi_io, 11, (U8)(sector_size & 0xFF)); 310230557Sjimharris 311233663Sjimharris //Explicitly set byte 12 to 0. SATI requires that all bytes in the data 312233663Sjimharris //response be explicitly set to some value. 313233663Sjimharris sati_set_data_byte(sequence, scsi_io, 12, 0); 314233663Sjimharris 315230557Sjimharris //Check Bit 13 of ATA_IDENTIFY_DEVICE_DATA physical_logical_sector_info 316230557Sjimharris //(Word 106) is enabled 317230557Sjimharris physical_per_logical_enable_bit = (identify_device_data->physical_logical_sector_info 318230557Sjimharris & ATA_IDENTIFY_LOGICAL_SECTOR_PER_PHYSICAL_SECTOR_ENABLE); 319230557Sjimharris 320230557Sjimharris //Extract the Physical per logical sector exponent field and calculate 321230557Sjimharris //Physical per logical sector value 322230557Sjimharris physical_per_logical_sector_exponent = (U8) (identify_device_data->physical_logical_sector_info 323230557Sjimharris & ATA_IDENTIFY_LOGICAL_SECTOR_PER_PHYSICAL_SECTOR_MASK); 324230557Sjimharris physical_per_logical_sector = 1 << (physical_per_logical_sector_exponent); 325230557Sjimharris 326230557Sjimharris //If the data is valid, fill in the logical blocks per physical block exponent field. 327230557Sjimharris //Else set logical blocks per physical block exponent to 1 328230557Sjimharris if (physical_per_logical_enable_bit != 0) 329230557Sjimharris sati_set_data_byte( 330230557Sjimharris sequence, 331230557Sjimharris scsi_io, 332230557Sjimharris 13, 333230557Sjimharris (U8)(physical_per_logical_sector_exponent & 0xFF) 334230557Sjimharris ); 335230557Sjimharris else 336230557Sjimharris sati_set_data_byte(sequence, scsi_io, 13, 0); 337230557Sjimharris 338230557Sjimharris //Fill in the lowest aligned logical block address field. 339230557Sjimharris logical_sector_alignment = identify_device_data->logical_sector_alignment; 340230557Sjimharris if (logical_sector_alignment == 0) 341230557Sjimharris scsi_logical_sector_alignment = 0; 342230557Sjimharris else 343230557Sjimharris scsi_logical_sector_alignment = (physical_per_logical_sector - logical_sector_alignment) 344230557Sjimharris % physical_per_logical_sector; 345230557Sjimharris 346230557Sjimharris //Follow SAT for reporting tprz and tpe 347230557Sjimharris if ((sequence->device->capabilities & SATI_DEVICE_CAP_DSM_TRIM_SUPPORT) && 348230557Sjimharris (sequence->device->capabilities & SATI_DEVICE_CAP_DETERMINISTIC_READ_AFTER_TRIM)) 349230557Sjimharris { 350230557Sjimharris // tpe 351230557Sjimharris byte14 |= 0x80; 352230557Sjimharris // tprz 353230557Sjimharris if (sequence->device->capabilities & SATI_DEVICE_CAP_READ_ZERO_AFTER_TRIM) 354230557Sjimharris byte14 |= 0x40; 355230557Sjimharris } 356230557Sjimharris sati_set_data_byte( 357230557Sjimharris sequence, 358230557Sjimharris scsi_io, 359230557Sjimharris 14, 360230557Sjimharris (U8)(((scsi_logical_sector_alignment >>8) & 0x3F) | byte14)); 361230557Sjimharris 362230557Sjimharris sati_set_data_byte( 363230557Sjimharris sequence, 364230557Sjimharris scsi_io, 365230557Sjimharris 15, 366230557Sjimharris (U8)(scsi_logical_sector_alignment & 0xFF)); 367230557Sjimharris} 368230557Sjimharris 369230557Sjimharris#endif // !defined(DISABLE_SATI_READ_CAPACITY) 370230557Sjimharris 371