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 * $FreeBSD$ 53230557Sjimharris */ 54230557Sjimharris#ifndef _SATI_UTIL_H_ 55230557Sjimharris#define _SATI_UTIL_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * @brief This file contains all of the interface methods, macros, structures 60230557Sjimharris * that provide general support for SATI. Some methods can be utilized 61230557Sjimharris * by a user to construct ATA/ATAPI commands, copy ATA device 62230557Sjimharris * structure data, fill in sense data, etc. 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#include <dev/isci/scil/sati_types.h> 66230557Sjimharris#include <dev/isci/scil/sati_translator_sequence.h> 67230557Sjimharris 68230557Sjimharris#include <dev/isci/scil/intel_sata.h> 69230557Sjimharris#include <dev/isci/scil/intel_sas.h> 70230557Sjimharris 71230557Sjimharris/** 72230557Sjimharris * This macro allows the translator to be able to handle environments where 73230557Sjimharris * the contents of the CDB are of a different endian nature of byte swapped 74230557Sjimharris * in some fashion. 75230557Sjimharris */ 76230557Sjimharris#define sati_get_cdb_byte(the_cdb, index) (the_cdb)[(index)] 77230557Sjimharris 78230557Sjimharris#define sati_get_ata_status(the_reg_fis) ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->status 79230557Sjimharris#define sati_get_ata_error(the_reg_fis) ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->error 80230557Sjimharris 81230557Sjimharris#define sati_get_ata_command(the_reg_fis) \ 82230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->command 83230557Sjimharris 84230557Sjimharris#define sati_get_ata_sector_count(the_reg_fis) \ 85230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->sector_count 86230557Sjimharris#define sati_get_ata_sector_count_exp(the_reg_fis) \ 87230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->sector_count_exp 88230557Sjimharris#define sati_get_ata_lba_low(the_reg_fis) \ 89230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_low 90230557Sjimharris#define sati_get_ata_lba_mid(the_reg_fis) \ 91230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_mid 92230557Sjimharris#define sati_get_ata_lba_high(the_reg_fis) \ 93230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_high 94230557Sjimharris#define sati_get_ata_sector_count_ext(the_reg_fis) \ 95230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->sector_count_exp 96230557Sjimharris#define sati_get_ata_lba_low_ext(the_reg_fis) \ 97230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_low_exp 98230557Sjimharris#define sati_get_ata_lba_mid_ext(the_reg_fis) \ 99230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_mid_exp 100230557Sjimharris#define sati_get_ata_lba_high_ext(the_reg_fis) \ 101230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->lba_high_exp 102230557Sjimharris#define sati_get_ata_device(the_reg_fis) \ 103230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->device 104230557Sjimharris 105230557Sjimharris#define sati_set_ata_status(the_reg_fis, value) \ 106230557Sjimharris ((SATA_FIS_REG_D2H_T*)(the_reg_fis))->status = (value) 107230557Sjimharris#define sati_set_sata_fis_type(the_reg_fis, value) \ 108230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->fis_type = (value) 109230557Sjimharris#define sati_set_sata_command_flag(the_reg_fis) \ 110230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->command_flag = 1 111230557Sjimharris#define sati_clear_sata_command_flag(the_reg_fis) \ 112230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->command_flag = 0 113230557Sjimharris 114230557Sjimharris#define sati_set_ata_command(the_reg_fis, value) \ 115230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->command = (value) 116230557Sjimharris#define sati_set_ata_features(the_reg_fis, value) \ 117230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->features = (value) 118230557Sjimharris#define sati_set_ata_features_exp(the_reg_fis, value) \ 119230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->features_exp = (value) 120230557Sjimharris#define sati_set_ata_control(the_reg_fis, value) \ 121230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->control = (value) 122230557Sjimharris#define sati_set_ata_sector_count(the_reg_fis, value) \ 123230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->sector_count = (value) 124230557Sjimharris#define sati_set_ata_sector_count_exp(the_reg_fis, value) \ 125230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->sector_count_exp = (value) 126230557Sjimharris#define sati_set_ata_lba_low(the_reg_fis, value) \ 127230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_low = (value) 128230557Sjimharris#define sati_set_ata_lba_mid(the_reg_fis, value) \ 129230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_mid = (value) 130230557Sjimharris#define sati_set_ata_lba_high(the_reg_fis, value) \ 131230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_high = (value) 132230557Sjimharris#define sati_set_ata_lba_low_exp(the_reg_fis, value) \ 133230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_low_exp = (value) 134230557Sjimharris#define sati_set_ata_lba_mid_exp(the_reg_fis, value) \ 135230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_mid_exp = (value) 136230557Sjimharris#define sati_set_ata_lba_high_exp(the_reg_fis, value) \ 137230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->lba_high_exp = (value) 138230557Sjimharris#define sati_set_ata_device_head(the_reg_fis, value) \ 139230557Sjimharris ((SATA_FIS_REG_H2D_T*)(the_reg_fis))->device = (value) 140230557Sjimharris 141230557Sjimharris#define ATA_MID_REGISTER_THRESHOLD_EXCEEDED 0xF4 142230557Sjimharris#define ATA_HIGH_REGISTER_THRESHOLD_EXCEEDED 0x2C 143230557Sjimharris 144230557Sjimharris#define ATA_MICROCODE_OFFSET_DOWNLOAD 0x03 145230557Sjimharris#define ATA_MICROCODE_DOWNLOAD_SAVE 0x07 146230557Sjimharris 147230557Sjimharris#ifndef MIN 148230557Sjimharris#define MIN(x,y) ((x) < (y) ? (x) : (y)) 149230557Sjimharris#endif 150230557Sjimharris 151230557Sjimharris#ifndef MAX 152230557Sjimharris#define MAX(x,y) ((x) > (y) ? (x) : (y)) 153230557Sjimharris#endif 154230557Sjimharris 155230557Sjimharris 156230557Sjimharrisvoid sati_ata_non_data_command( 157230557Sjimharris void * ata_io, 158230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 159230557Sjimharris); 160230557Sjimharris 161230557Sjimharrisvoid sati_ata_identify_device_construct( 162230557Sjimharris void * ata_io, 163230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 164230557Sjimharris); 165230557Sjimharris 166230557Sjimharrisvoid sati_ata_execute_device_diagnostic_construct( 167230557Sjimharris void * ata_io, 168230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 169230557Sjimharris); 170230557Sjimharris 171230557Sjimharrisvoid sati_ata_identify_device_copy_data( 172230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 173230557Sjimharris void * destination_scsi_io, 174230557Sjimharris U32 destination_offset, 175230557Sjimharris U8 * source_buffer, 176230557Sjimharris U32 source_offset, 177230557Sjimharris U32 length, 178230557Sjimharris BOOL use_printable_chars 179230557Sjimharris); 180230557Sjimharris 181230557Sjimharrisvoid sati_copy_data( 182230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 183230557Sjimharris void * destination_scsi_io, 184230557Sjimharris U32 destination_offset, 185230557Sjimharris U8 * source_buffer, 186230557Sjimharris U32 length 187230557Sjimharris); 188230557Sjimharris 189230557Sjimharrisvoid sati_ata_identify_device_get_sector_info( 190230557Sjimharris ATA_IDENTIFY_DEVICE_DATA_T * identify, 191230557Sjimharris U32 * lba_high, 192230557Sjimharris U32 * lba_low, 193230557Sjimharris U32 * sector_size 194230557Sjimharris); 195230557Sjimharris 196230557Sjimharrisvoid sati_ata_check_power_mode_construct( 197230557Sjimharris void * ata_io, 198230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 199230557Sjimharris); 200230557Sjimharris 201230557SjimharrisU8 sati_scsi_get_sense_data_length( 202230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 203230557Sjimharris void * scsi_io 204230557Sjimharris); 205230557Sjimharris 206230557Sjimharrisvoid sati_scsi_common_response_iu_construct( 207230557Sjimharris SCI_SSP_RESPONSE_IU_T * rsp_iu, 208230557Sjimharris U8 scsi_status, 209230557Sjimharris U8 sense_data_length, 210230557Sjimharris U8 data_present 211230557Sjimharris); 212230557Sjimharris 213230557Sjimharrisvoid sati_scsi_sense_data_construct( 214230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 215230557Sjimharris void * scsi_io, 216230557Sjimharris U8 status, 217230557Sjimharris U8 sense_key, 218230557Sjimharris U8 additional_sense_code, 219230557Sjimharris U8 additional_sense_code_qualifier 220230557Sjimharris); 221230557Sjimharris 222230557Sjimharrisvoid sati_scsi_fixed_sense_data_construct( 223230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 224230557Sjimharris void * scsi_io, 225230557Sjimharris U8 response_code, 226230557Sjimharris U8 scsi_status, 227230557Sjimharris U8 sense_key, 228230557Sjimharris U8 additional_sense_code, 229230557Sjimharris U8 additional_sense_code_qualifier 230230557Sjimharris); 231230557Sjimharris 232230557Sjimharrisvoid sati_scsi_descriptor_sense_data_construct( 233230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 234230557Sjimharris void * scsi_io, 235230557Sjimharris U8 response_code, 236230557Sjimharris U8 scsi_status, 237230557Sjimharris U8 sense_key, 238230557Sjimharris U8 additional_sense_code, 239230557Sjimharris U8 additional_sense_code_qualifier 240230557Sjimharris); 241230557Sjimharris 242230557Sjimharrisvoid sati_scsi_read_ncq_error_sense_construct( 243230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 244230557Sjimharris void * scsi_io, 245230557Sjimharris void * ata_input_data, 246230557Sjimharris U8 scsi_status, 247230557Sjimharris U8 sense_key, 248230557Sjimharris U8 additional_sense_code, 249230557Sjimharris U8 additional_sense_code_qualifier 250230557Sjimharris); 251230557Sjimharris 252230557Sjimharrisvoid sati_scsi_read_error_sense_construct( 253230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 254230557Sjimharris void * scsi_io, 255230557Sjimharris void * ata_io, 256230557Sjimharris U8 status, 257230557Sjimharris U8 sense_key, 258230557Sjimharris U8 additional_sense_code, 259230557Sjimharris U8 additional_sense_code_qualifier 260230557Sjimharris); 261230557Sjimharris 262230557Sjimharrisvoid sati_scsi_response_data_construct( 263230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 264230557Sjimharris void * scsi_io, 265230557Sjimharris U8 response_data 266230557Sjimharris); 267230557Sjimharris 268230557Sjimharrisvoid sati_get_data_byte( 269230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 270230557Sjimharris void * scsi_io, 271230557Sjimharris U32 byte_offset, 272230557Sjimharris U8 * value 273230557Sjimharris); 274230557Sjimharris 275230557Sjimharrisvoid sati_set_data_byte( 276230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 277230557Sjimharris void * scsi_io, 278230557Sjimharris U32 byte_offset, 279230557Sjimharris U8 value 280230557Sjimharris); 281230557Sjimharris 282230557Sjimharrisvoid sati_set_data_dword( 283230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 284230557Sjimharris void * scsi_io, 285230557Sjimharris U32 byte_offset, 286230557Sjimharris U32 value 287230557Sjimharris); 288230557Sjimharris 289230557Sjimharrisvoid sati_set_sense_data_byte( 290230557Sjimharris U8 * sense_data, 291230557Sjimharris U32 max_sense_data_len, 292230557Sjimharris U32 byte_offset, 293230557Sjimharris U8 value 294230557Sjimharris); 295230557Sjimharris 296230557Sjimharrisvoid sati_ata_flush_cache_construct( 297230557Sjimharris void * ata_io, 298230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 299230557Sjimharris); 300230557Sjimharris 301230557Sjimharrisvoid sati_ata_standby_construct( 302230557Sjimharris void * ata_io, 303230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 304230557Sjimharris U16 count 305230557Sjimharris); 306230557Sjimharris 307230557Sjimharrisvoid sati_ata_standby_immediate_construct( 308230557Sjimharris void * ata_io, 309230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 310230557Sjimharris); 311230557Sjimharris 312230557Sjimharrisvoid sati_ata_idle_immediate_construct( 313230557Sjimharris void * ata_io, 314230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 315230557Sjimharris); 316230557Sjimharris 317230557Sjimharrisvoid sati_ata_idle_immediate_unload_construct( 318230557Sjimharris void * ata_io, 319230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 320230557Sjimharris); 321230557Sjimharris 322230557Sjimharrisvoid sati_ata_idle_construct( 323230557Sjimharris void * ata_io, 324230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 325230557Sjimharris); 326230557Sjimharris 327230557Sjimharrisvoid sati_ata_media_eject_construct( 328230557Sjimharris void * ata_io, 329230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 330230557Sjimharris); 331230557Sjimharris 332230557Sjimharrisvoid sati_ata_read_verify_sectors_construct( 333230557Sjimharris void * ata_io, 334230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 335230557Sjimharris); 336230557Sjimharris 337230557Sjimharrisvoid sati_ata_smart_return_status_construct( 338230557Sjimharris void * ata_io, 339230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 340230557Sjimharris U8 feature_value 341230557Sjimharris); 342230557Sjimharris 343230557Sjimharrisvoid sati_ata_smart_read_log_construct( 344230557Sjimharris void * ata_io, 345230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 346230557Sjimharris U8 log_address, 347230557Sjimharris U32 transfer_length 348230557Sjimharris); 349230557Sjimharris 350230557Sjimharrisvoid sati_ata_write_uncorrectable_construct( 351230557Sjimharris void * ata_io, 352230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 353230557Sjimharris U8 feature_value 354230557Sjimharris); 355230557Sjimharris 356230557Sjimharrisvoid sati_ata_set_features_construct( 357230557Sjimharris void * ata_io, 358230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 359230557Sjimharris U8 feature 360230557Sjimharris); 361230557Sjimharris 362230557Sjimharrisvoid sati_ata_read_log_ext_construct( 363230557Sjimharris void * ata_io, 364230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 365230557Sjimharris U8 log_address, 366230557Sjimharris U32 transfer_length 367230557Sjimharris); 368230557Sjimharris 369230557SjimharrisBOOL sati_device_state_stopped( 370230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 371230557Sjimharris void * scsi_io 372230557Sjimharris); 373230557Sjimharris 374230557Sjimharrisvoid sati_ata_read_buffer_construct( 375230557Sjimharris void * ata_io, 376230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 377230557Sjimharris); 378230557Sjimharris 379230557Sjimharrisvoid sati_ata_write_buffer_construct( 380230557Sjimharris void * ata_io, 381230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence 382230557Sjimharris); 383230557Sjimharris 384230557Sjimharrisvoid sati_ata_download_microcode_construct( 385230557Sjimharris void * ata_io, 386230557Sjimharris SATI_TRANSLATOR_SEQUENCE_T * sequence, 387230557Sjimharris U8 mode, 388230557Sjimharris U32 block_count, 389230557Sjimharris U32 buffer_offset 390230557Sjimharris); 391230557Sjimharris 392230557Sjimharris#endif // _SATI_UTIL_H_ 393230557Sjimharris 394