718cf2ccb9
Mainly focus on files that use BSD 2-Clause license, however the tool I was using misidentified many licenses so this was mostly a manual - error prone - task. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts.
432 lines
16 KiB
C
432 lines
16 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause OR GPL-2.0
|
|
*
|
|
* This file is provided under a dual BSD/GPLv2 license. When using or
|
|
* redistributing this file, you may do so under either license.
|
|
*
|
|
* GPL LICENSE SUMMARY
|
|
*
|
|
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of version 2 of the GNU General Public License as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
|
|
* The full GNU General Public License is included in this distribution
|
|
* in the file called LICENSE.GPL.
|
|
*
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#include <sys/cdefs.h>
|
|
__FBSDID("$FreeBSD$");
|
|
|
|
/**
|
|
* @file
|
|
* @brief This file contains the method implementations required to
|
|
* translate the SCSI mode sense 6-byte commands.
|
|
*/
|
|
|
|
#if !defined(DISABLE_SATI_MODE_SENSE)
|
|
|
|
#include <dev/isci/scil/sati_mode_sense.h>
|
|
#include <dev/isci/scil/sati_mode_sense_6.h>
|
|
#include <dev/isci/scil/sati_mode_pages.h>
|
|
#include <dev/isci/scil/sati_callbacks.h>
|
|
#include <dev/isci/scil/sati_util.h>
|
|
#include <dev/isci/scil/intel_scsi.h>
|
|
#include <dev/isci/scil/intel_ata.h>
|
|
|
|
//******************************************************************************
|
|
//* P R I V A T E M E T H O D S
|
|
//******************************************************************************
|
|
|
|
/**
|
|
* @brief This method builds the mode parameter header for a 6-byte SCSI
|
|
* mode sense data response. The parameter header is 4 bytes in
|
|
* size.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_command().
|
|
*
|
|
* @param[in] identify This parameter specifies the ATA remote device's
|
|
* received IDENTIFY DEVICE data.
|
|
* @param[in] mode_data_length This parameter specifies the amount of data
|
|
* to be returned as part of this mode sense request.
|
|
*
|
|
* @return This method returns the number of bytes written into the
|
|
* data buffer.
|
|
*/
|
|
static
|
|
U32 sati_mode_sense_6_build_header(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * scsi_io,
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify,
|
|
U8 mode_data_length
|
|
)
|
|
{
|
|
U8 * cdb = sati_cb_get_cdb_address(scsi_io);
|
|
|
|
// Fill in the length of the mode parameter data returned (do not include
|
|
// the size of the mode data length field in the total).
|
|
sati_set_data_byte(sequence, scsi_io, 0, (U8)mode_data_length-1);
|
|
|
|
// Medium Type is 0 for SBC devices
|
|
sati_set_data_byte(sequence, scsi_io, 1, SCSI_MODE_HEADER_MEDIUM_TYPE_SBC);
|
|
|
|
// Write Protect (WP), Rsvd, DPOFUA, Rsvd
|
|
if (sequence->device->capabilities & SATI_DEVICE_CAP_DMA_FUA_ENABLE)
|
|
sati_set_data_byte(sequence,scsi_io,2,SCSI_MODE_SENSE_HEADER_FUA_ENABLE);
|
|
else
|
|
sati_set_data_byte(sequence, scsi_io, 2, 0);
|
|
|
|
// Set the block descriptor length if block descriptors are utilized.
|
|
if (sati_get_cdb_byte(cdb, 1) & SCSI_MODE_SENSE_DBD_ENABLE)
|
|
sati_set_data_byte(sequence, scsi_io, 3, 0);
|
|
else
|
|
sati_set_data_byte(
|
|
sequence, scsi_io, 3, SCSI_MODE_SENSE_STD_BLOCK_DESCRIPTOR_LENGTH
|
|
);
|
|
|
|
return SCSI_MODE_SENSE_6_HEADER_LENGTH;
|
|
}
|
|
|
|
/**
|
|
* @brief This method perform the data translation common to all SCSI MODE
|
|
* SENSE 6 byte commands. This includes building the mode page
|
|
* header and block descriptor (if requested).
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_command().
|
|
*
|
|
* @param[in] identify This parameter specifies the remote device's IDENTIFY
|
|
* DEVICE data to be used during translation.
|
|
* @param[in] transfer_length This parameter specifies the size of the
|
|
* mode page (including header & block descriptor).
|
|
*
|
|
* @return This method returns the number of bytes written into the user's
|
|
* mode page data buffer.
|
|
*/
|
|
static
|
|
U32 sati_mode_sense_6_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify,
|
|
void * scsi_io,
|
|
U8 transfer_length
|
|
)
|
|
{
|
|
U8 * cdb = sati_cb_get_cdb_address(scsi_io);
|
|
U32 offset;
|
|
|
|
offset = sati_mode_sense_6_build_header(
|
|
sequence, scsi_io, identify, transfer_length
|
|
);
|
|
|
|
// Determine if the caller disabled block descriptors (DBD). If not,
|
|
// then generate a block descriptor.
|
|
if ((sati_get_cdb_byte(cdb, 1) & SCSI_MODE_SENSE_DBD_ENABLE) == 0)
|
|
offset += sati_mode_sense_build_std_block_descriptor(
|
|
sequence, scsi_io, identify, offset
|
|
);
|
|
|
|
return offset;
|
|
}
|
|
|
|
//******************************************************************************
|
|
//* P R O T E C T E D M E T H O D S
|
|
//******************************************************************************
|
|
|
|
/**
|
|
* @brief This method will translate the SCSI mode sense 6 byte command
|
|
* into corresponding ATA commands. If the command is well-formed,
|
|
* then the translation will result in an ATA IDENTIFY DEVICE
|
|
* command.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_command().
|
|
*
|
|
* @return Indicate if the command translation succeeded.
|
|
* @retval SCI_SUCCESS This is returned if the command translation was
|
|
* successful.
|
|
* @retval SATI_FAILURE_CHECK_RESPONSE_DATA This value is returned if
|
|
* sense data has been created as a result of something specified
|
|
* in the CDB.
|
|
*/
|
|
SATI_STATUS sati_mode_sense_6_translate_command(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * scsi_io,
|
|
void * ata_io
|
|
)
|
|
{
|
|
U8 * cdb = sati_cb_get_cdb_address(scsi_io);
|
|
|
|
// Set the data length based on the allocation length field in the CDB.
|
|
sequence->allocation_length = sati_get_cdb_byte(cdb, 4);
|
|
|
|
return sati_mode_sense_translate_command(sequence, scsi_io, ata_io, 6);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a CACHING
|
|
* mode page format. The data will be written into the user's mode
|
|
* page data buffer. This function operates specifically for MODE
|
|
* SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_caching_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_08_LENGTH;
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_caching_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a INFORMATIONAL
|
|
* EXCEPTIONS CONTROL mode page format. The data will be written
|
|
* into the user's mode page data buffer. This function operates
|
|
* specifically for MODE SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_informational_excp_control_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_1C_LENGTH;
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_informational_excp_control_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a DISCONNECT
|
|
* RECONNECT mode page format. The data will be written
|
|
* into the user's mode page data buffer. This function operates
|
|
* specifically for MODE SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_disconnect_reconnect_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_02_LENGTH ;
|
|
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_disconnect_reconnect_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a READ WRITE ERROR
|
|
* mode page format. The data will be written
|
|
* into the user's mode page data buffer. This function operates
|
|
* specifically for MODE SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_read_write_error_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_01_LENGTH;
|
|
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_read_write_error_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a CONTROL
|
|
* mode page format. The data will be written
|
|
* into the user's mode page data buffer. This function operates
|
|
* specifically for MODE SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_control_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_0A_LENGTH;
|
|
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_control_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into a Power
|
|
* Condition mode page format. The data will be written
|
|
* into the user's mode page data buffer. This function operates
|
|
* specifically for MODE SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_power_condition_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
|
|
U8 data_length;
|
|
U32 page_offset;
|
|
|
|
data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_1A_LENGTH;
|
|
|
|
page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_power_condition_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* @brief This method will perform data translation from the supplied ATA
|
|
* input data (i.e. an ATA IDENTIFY DEVICE block) into an ALL
|
|
* PAGES mode page format. The ALL PAGES mode page is basically a
|
|
* conglomeration of all mode pages and sub-pages into a single
|
|
* page. The data will be written into the user's mode page
|
|
* data buffer. This function operates specifically for MODE
|
|
* SENSE 6 commands.
|
|
* For more information on the parameters passed to this method,
|
|
* please reference sati_translate_data().
|
|
*
|
|
* @return none.
|
|
*/
|
|
void sati_mode_sense_6_all_pages_translate_data(
|
|
SATI_TRANSLATOR_SEQUENCE_T * sequence,
|
|
void * ata_input_data,
|
|
void * scsi_io
|
|
)
|
|
{
|
|
ATA_IDENTIFY_DEVICE_DATA_T * identify = (ATA_IDENTIFY_DEVICE_DATA_T*)
|
|
ata_input_data;
|
|
U8 data_length = (U8) sati_mode_sense_calculate_page_header(scsi_io, 6)
|
|
+ SCSI_MODE_PAGE_01_LENGTH
|
|
+ SCSI_MODE_PAGE_02_LENGTH
|
|
+ SCSI_MODE_PAGE_08_LENGTH
|
|
+ SCSI_MODE_PAGE_0A_LENGTH
|
|
+ SCSI_MODE_PAGE_1C_LENGTH;
|
|
|
|
U32 page_offset = sati_mode_sense_6_translate_data(
|
|
sequence, identify, scsi_io, data_length
|
|
);
|
|
|
|
sati_mode_sense_all_pages_translate_data(
|
|
sequence, scsi_io, identify, page_offset
|
|
);
|
|
}
|
|
|
|
#endif // !defined(DISABLE_SATI_MODE_SENSE)
|
|
|