sati_device.c revision 230557
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 defintions for the SATI remote 59230557Sjimharris * device object. Some translations require information to be 60230557Sjimharris * remembered on a per device basis. This information is stored 61230557Sjimharris * in the object defined in this file. 62230557Sjimharris */ 63230557Sjimharris 64230557Sjimharris#include <dev/isci/scil/sati_device.h> 65230557Sjimharris#include <dev/isci/scil/sci_util.h> // Move this file. 66230557Sjimharris#include <dev/isci/scil/sati_unmap.h> 67230557Sjimharris#include <dev/isci/scil/intel_scsi.h> 68230557Sjimharris 69230557Sjimharris/** 70230557Sjimharris * @brief This method simply initializes the data members in the device 71230557Sjimharris * object to their appropriate values. 72230557Sjimharris * 73230557Sjimharris * @param[in] device This parameter specifies the device for which to 74230557Sjimharris * initialize the data members. 75230557Sjimharris * @param[in] is_ncq_enabled This parameter specifies if NCQ is to be 76230557Sjimharris * utilized for this particular SATI device. 77230557Sjimharris * @param[in] max_ncq_depth This parameter specifies the maximum desired 78230557Sjimharris * NCQ depth. Once this value is set it can never be increased. 79230557Sjimharris * @param[in] ignore_fua This parameter specifies FUA is to be ignored and not 80230557Sjimharris * sent to the end device. Some OS (Windows) has quirky behaviors with FUA 81230557Sjimharris * and recommend driver developers ignore the bit. 82230557Sjimharris * 83230557Sjimharris * @return none 84230557Sjimharris */ 85230557Sjimharrisvoid sati_device_construct( 86230557Sjimharris SATI_DEVICE_T * device, 87230557Sjimharris BOOL is_ncq_enabled, 88230557Sjimharris U8 max_ncq_depth, 89230557Sjimharris BOOL ignore_fua 90230557Sjimharris) 91230557Sjimharris{ 92230557Sjimharris device->state = SATI_DEVICE_STATE_OPERATIONAL; 93230557Sjimharris device->capabilities = 0; 94230557Sjimharris device->descriptor_sense_enable = SCSI_MODE_PAGE_CONTROL_D_SENSE_DISABLE; 95230557Sjimharris 96230557Sjimharris // The user requested that NCQ be utilized if it is supported by 97230557Sjimharris // the device. 98230557Sjimharris if (is_ncq_enabled == TRUE) 99230557Sjimharris device->capabilities |= SATI_DEVICE_CAP_NCQ_REQUESTED_ENABLE; 100230557Sjimharris 101230557Sjimharris device->ncq_depth = max_ncq_depth; 102230557Sjimharris 103230557Sjimharris // The user requested that FUA is ignored (windows performance issue) 104230557Sjimharris if (ignore_fua == TRUE) 105230557Sjimharris device->capabilities |= SATI_DEVICE_CAP_IGNORE_FUA; 106230557Sjimharris 107230557Sjimharris} 108230557Sjimharris 109230557Sjimharris/** 110230557Sjimharris * @brief This method will update the SATI_DEVICE capabilities based on 111230557Sjimharris * the supplied ATA_IDENTIFY_DEVICE_DATA. 112230557Sjimharris * 113230557Sjimharris * @param[in] device This parameter specifies the device for which to update 114230557Sjimharris * the supported capabilities. 115230557Sjimharris * @param[in] identify This parameter specifies the ata identify device 116230557Sjimharris * information from which to extract the capabilities of the 117230557Sjimharris * device. 118230557Sjimharris * 119230557Sjimharris * @return none 120230557Sjimharris */ 121230557Sjimharrisvoid sati_device_update_capabilities( 122230557Sjimharris SATI_DEVICE_T * device, 123230557Sjimharris ATA_IDENTIFY_DEVICE_DATA_T * identify 124230557Sjimharris) 125230557Sjimharris{ 126230557Sjimharris U16 capabilities = 0; 127230557Sjimharris 128230557Sjimharris if (identify->capabilities1 & ATA_IDENTIFY_CAPABILITIES1_NORMAL_DMA_ENABLE) 129230557Sjimharris capabilities |= SATI_DEVICE_CAP_UDMA_ENABLE; 130230557Sjimharris 131230557Sjimharris if (identify->command_set_supported1 132230557Sjimharris & ATA_IDENTIFY_COMMAND_SET_SUPPORTED1_48BIT_ENABLE) 133230557Sjimharris { 134230557Sjimharris capabilities |= SATI_DEVICE_CAP_48BIT_ENABLE; 135230557Sjimharris } 136230557Sjimharris 137230557Sjimharris if (identify->command_set_supported0 138230557Sjimharris & ATA_IDENTIFY_COMMAND_SET_SUPPORTED0_SMART_ENABLE) 139230557Sjimharris { 140230557Sjimharris capabilities |= SATI_DEVICE_CAP_SMART_SUPPORT; 141230557Sjimharris } 142230557Sjimharris 143230557Sjimharris if (identify->command_set_enabled0 144230557Sjimharris & ATA_IDENTIFY_COMMAND_SET_SUPPORTED0_SMART_ENABLE) 145230557Sjimharris { 146230557Sjimharris capabilities |= SATI_DEVICE_CAP_SMART_ENABLE; 147230557Sjimharris } 148230557Sjimharris 149230557Sjimharris // Save the NCQ related capabilities information. 150230557Sjimharris if (identify->serial_ata_capabilities 151230557Sjimharris & ATA_IDENTIFY_SATA_CAPABILITIES_NCQ_ENABLE) 152230557Sjimharris { 153230557Sjimharris if (device->capabilities & SATI_DEVICE_CAP_NCQ_REQUESTED_ENABLE) 154230557Sjimharris { 155230557Sjimharris capabilities |= SATI_DEVICE_CAP_NCQ_REQUESTED_ENABLE; 156230557Sjimharris capabilities |= SATI_DEVICE_CAP_NCQ_SUPPORTED_ENABLE; 157230557Sjimharris capabilities |= SATI_DEVICE_CAP_DMA_FUA_ENABLE; 158230557Sjimharris device->ncq_depth = MIN( 159230557Sjimharris device->ncq_depth, 160230557Sjimharris (U8) (identify->queue_depth 161230557Sjimharris & ATA_IDENTIFY_NCQ_QUEUE_DEPTH_ENABLE) + 1 162230557Sjimharris ); 163230557Sjimharris } 164230557Sjimharris } 165230557Sjimharris 166230557Sjimharris // if the user requested that FUA is ignored; transfer it so we don't lose on update. 167230557Sjimharris if (device->capabilities & SATI_DEVICE_CAP_IGNORE_FUA) 168230557Sjimharris capabilities |= SATI_DEVICE_CAP_IGNORE_FUA; 169230557Sjimharris 170230557Sjimharris if (identify->general_config_bits & ATA_IDENTIFY_REMOVABLE_MEDIA_ENABLE) 171230557Sjimharris capabilities |= SATI_DEVICE_CAP_REMOVABLE_MEDIA; 172230557Sjimharris 173230557Sjimharris if(identify->command_set_supported2 & ATA_IDENTIFY_WRITE_UNCORRECTABLE_SUPPORT ) 174230557Sjimharris { 175230557Sjimharris capabilities |= SATI_DEVICE_CAP_WRITE_UNCORRECTABLE_ENABLE; 176230557Sjimharris } 177230557Sjimharris 178230557Sjimharris if(identify->physical_logical_sector_info & 179230557Sjimharris ATA_IDENTIFY_LOGICAL_SECTOR_PER_PHYSICAL_SECTOR_ENABLE) 180230557Sjimharris { 181230557Sjimharris capabilities |= SATI_DEVICE_CAP_MULTIPLE_SECTORS_PER_PHYSCIAL_SECTOR; 182230557Sjimharris } 183230557Sjimharris 184230557Sjimharris if(identify->command_set_supported_extention & 185230557Sjimharris ATA_IDENTIFY_COMMAND_SET_SMART_SELF_TEST_SUPPORTED) 186230557Sjimharris { 187230557Sjimharris capabilities |= SATI_DEVICE_CAP_SMART_SELF_TEST_SUPPORT; 188230557Sjimharris } 189230557Sjimharris 190230557Sjimharris if (identify->nominal_media_rotation_rate == 1) 191230557Sjimharris { 192230557Sjimharris capabilities |= SATI_DEVICE_CAP_SSD; 193230557Sjimharris } 194230557Sjimharris 195230557Sjimharris // Save off the logical block size reported by the drive 196230557Sjimharris // See if Word 106 is valid and reports a logical sector size 197230557Sjimharris if ((identify->physical_logical_sector_info & 0x5000) == 0x5000) 198230557Sjimharris { 199230557Sjimharris device->logical_block_size = (identify->words_per_logical_sector[3] << 24) | 200230557Sjimharris (identify->words_per_logical_sector[2] << 16) | 201230557Sjimharris (identify->words_per_logical_sector[1] << 8) | 202230557Sjimharris (identify->words_per_logical_sector[0]); 203230557Sjimharris } 204230557Sjimharris else 205230557Sjimharris { 206230557Sjimharris device->logical_block_size = 512; 207230557Sjimharris } 208230557Sjimharris 209230557Sjimharris // Determine DSM TRIM capabilities 210230557Sjimharris // Defend against SSDs which report TRIM support, but set 211230557Sjimharris // max_lba_range_entry_blocks to zero, by disabling TRIM for 212230557Sjimharris // those SSDs. 213230557Sjimharris if ( 214230557Sjimharris (identify->data_set_management & ATA_IDENTIFY_COMMAND_SET_DSM_TRIM_SUPPORTED) 215230557Sjimharris && (identify->max_lba_range_entry_blocks > 0) 216230557Sjimharris ) 217230557Sjimharris { 218230557Sjimharris capabilities |= SATI_DEVICE_CAP_DSM_TRIM_SUPPORT; 219230557Sjimharris device->max_lba_range_entry_blocks = identify->max_lba_range_entry_blocks; 220230557Sjimharris } 221230557Sjimharris 222230557Sjimharris if (identify->additional_supported 223230557Sjimharris & ATA_IDENTIFY_COMMAND_ADDL_SUPPORTED_DETERMINISTIC_READ) 224230557Sjimharris { 225230557Sjimharris capabilities |= SATI_DEVICE_CAP_DETERMINISTIC_READ_AFTER_TRIM; 226230557Sjimharris } 227230557Sjimharris 228230557Sjimharris if (identify->additional_supported 229230557Sjimharris & ATA_IDENTIFY_COMMAND_ADDL_SUPPORTED_READ_ZERO) 230230557Sjimharris { 231230557Sjimharris capabilities |= SATI_DEVICE_CAP_READ_ZERO_AFTER_TRIM; 232230557Sjimharris } 233230557Sjimharris 234230557Sjimharris if (identify->capabilities1 235230557Sjimharris & ATA_IDENTIFY_CAPABILITIES1_STANDBY_ENABLE) 236230557Sjimharris { 237230557Sjimharris capabilities |= SATI_DEVICE_CAP_STANDBY_ENABLE; 238230557Sjimharris } 239230557Sjimharris 240230557Sjimharris device->min_blocks_per_microcode_command = identify->min_num_blocks_per_microcode; 241230557Sjimharris device->max_blocks_per_microcode_command = identify->max_num_blocks_per_microcode; 242230557Sjimharris 243230557Sjimharris device->capabilities = capabilities; 244230557Sjimharris} 245230557Sjimharris 246