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 _SCIF_SAS_SATI_BINDING_H_ 55230557Sjimharris#define _SCIF_SAS_SATI_BINDING_H_ 56230557Sjimharris 57230557Sjimharris/** 58230557Sjimharris * @file 59230557Sjimharris * 60230557Sjimharris * @brief This file contains the SATI (SCSI to ATA Translation Implementation) 61230557Sjimharris * callback implementations that can be implemented by the SCI 62230557Sjimharris * Framework (or core in some cases). 63230557Sjimharris */ 64230557Sjimharris 65230557Sjimharris#ifdef __cplusplus 66230557Sjimharrisextern "C" { 67230557Sjimharris#endif // __cplusplus 68230557Sjimharris 69230557Sjimharris#include <dev/isci/scil/scif_user_callback.h> 70230557Sjimharris#include <dev/isci/scil/scif_io_request.h> 71230557Sjimharris#include <dev/isci/scil/scif_remote_device.h> 72230557Sjimharris#include <dev/isci/scil/scic_user_callback.h> 73230557Sjimharris#include <dev/isci/scil/scic_io_request.h> 74230557Sjimharris#include <dev/isci/scil/scic_remote_device.h> 75230557Sjimharris//#include <dev/isci/scil/scic_sds_request.h> 76230557Sjimharris//#include <dev/isci/scil/scu_task_context.h> 77230557Sjimharris#include <dev/isci/scil/sci_object.h> 78230557Sjimharris#include <dev/isci/scil/scif_sas_request.h> 79230557Sjimharris#include <dev/isci/scil/sci_base_memory_descriptor_list.h> 80230557Sjimharris#include <dev/isci/scil/scif_sas_stp_remote_device.h> 81230557Sjimharris#include <dev/isci/scil/scif_sas_remote_device.h> 82230557Sjimharris#include <dev/isci/scil/scif_sas_domain.h> 83230557Sjimharris#include <dev/isci/scil/scif_sas_controller.h> 84230557Sjimharris#include <dev/isci/scil/scic_sds_request.h> 85230557Sjimharris#include <dev/isci/sci_environment.h> 86230557Sjimharris 87230557Sjimharris// SATI callbacks fulfilled by the framework user. 88230557Sjimharris 89230557Sjimharris#define sati_cb_get_data_byte(scsi_io, byte_offset, value) \ 90230557Sjimharris{ \ 91230557Sjimharris U8 * virtual_address = scif_cb_io_request_get_virtual_address_from_sgl( \ 92230557Sjimharris sci_object_get_association(scsi_io),(byte_offset)\ 93230557Sjimharris ); \ 94230557Sjimharris *(value) = *(virtual_address); \ 95230557Sjimharris} 96230557Sjimharris 97230557Sjimharris#define sati_cb_set_data_byte(scsi_io, byte_offset, value) \ 98230557Sjimharris{ \ 99230557Sjimharris U8 * virtual_address = scif_cb_io_request_get_virtual_address_from_sgl( \ 100230557Sjimharris sci_object_get_association(scsi_io),(byte_offset)\ 101230557Sjimharris ); \ 102230557Sjimharris *(virtual_address) = value; \ 103230557Sjimharris} 104230557Sjimharris 105230557Sjimharris#define sati_cb_get_cdb_address(scsi_io) \ 106230557Sjimharris scif_cb_io_request_get_cdb_address(sci_object_get_association(scsi_io)) 107230557Sjimharris 108230557Sjimharris#define sati_cb_get_cdb_length(scsi_io) \ 109230557Sjimharris scif_cb_io_request_get_cdb_length(sci_object_get_association(scsi_io)) 110230557Sjimharris 111230557Sjimharris#define sati_cb_get_data_direction(scsi_io, sati_data_direction) \ 112230557Sjimharris{ \ 113230557Sjimharris SCI_IO_REQUEST_DATA_DIRECTION sci_data_direction = \ 114230557Sjimharris scif_cb_io_request_get_data_direction( \ 115230557Sjimharris sci_object_get_association(scsi_io) \ 116230557Sjimharris ); \ 117230557Sjimharris if (sci_data_direction == SCI_IO_REQUEST_DATA_IN) \ 118230557Sjimharris *(sati_data_direction) = SATI_DATA_DIRECTION_IN; \ 119230557Sjimharris else if (sci_data_direction == SCI_IO_REQUEST_DATA_OUT) \ 120230557Sjimharris *(sati_data_direction) = SATI_DATA_DIRECTION_OUT; \ 121230557Sjimharris else if (sci_data_direction == SCI_IO_REQUEST_NO_DATA) \ 122230557Sjimharris *(sati_data_direction) = SATI_DATA_DIRECTION_NONE; \ 123230557Sjimharris} 124230557Sjimharris 125230557Sjimharris#define sati_cb_get_lun(scsi_io) \ 126230557Sjimharris scif_cb_io_request_get_lun(sci_object_get_association(scsi_io)) 127230557Sjimharris 128230557Sjimharris// SATI callbacks fulfilled by the framework. 129230557Sjimharris 130230557Sjimharris/** 131230557Sjimharris * This method implements the functionality necessary to fulfill the 132230557Sjimharris * SCSI-to-ATA Translation requirements. It ensures that the SAS 133230557Sjimharris * address for the remote device associated with the supplied IO 134230557Sjimharris * is written into the sas_address parameter. 135230557Sjimharris * For more information on the parameters utilized in this method, 136230557Sjimharris * please refer to sati_cb_device_get_sas_address(). 137230557Sjimharris */ 138230557Sjimharris#define sati_cb_device_get_sas_address(scsi_io, sas_address) \ 139230557Sjimharris{ \ 140230557Sjimharris SCIF_SAS_REQUEST_T* fw_request = (SCIF_SAS_REQUEST_T*)scsi_io; \ 141230557Sjimharris SCI_REMOTE_DEVICE_HANDLE_T scic_device \ 142230557Sjimharris = scif_remote_device_get_scic_handle(fw_request->device); \ 143230557Sjimharris scic_remote_device_get_sas_address(scic_device, sas_address); \ 144230557Sjimharris} 145230557Sjimharris 146230557Sjimharris#define sati_cb_device_get_request_by_ncq_tag(scsi_io, ncq_tag, matching_req) \ 147230557Sjimharris{ \ 148230557Sjimharris SCIF_SAS_REQUEST_T* fw_request = (SCIF_SAS_REQUEST_T*)scsi_io; \ 149230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T* fw_device = fw_request->device; \ 150230557Sjimharris matching_req = scif_sas_stp_remote_device_get_request_by_ncq_tag(fw_device, ncq_tag); \ 151230557Sjimharris} 152230557Sjimharris 153230557Sjimharris#define sati_cb_io_request_complete(scsi_io, completion_status) \ 154230557Sjimharris{ \ 155230557Sjimharris SCIF_SAS_REQUEST_T* fw_request = (SCIF_SAS_REQUEST_T*)scsi_io; \ 156230557Sjimharris SCIF_SAS_REMOTE_DEVICE_T* fw_device = fw_request->device; \ 157230557Sjimharris SCIF_SAS_DOMAIN_T* fw_domain = fw_device->domain; \ 158230557Sjimharris SCIF_SAS_CONTROLLER_T* fw_controller = fw_domain->controller; \ 159230557Sjimharris scif_cb_io_request_complete( \ 160230557Sjimharris fw_controller, fw_device, fw_request, completion_status \ 161230557Sjimharris ); \ 162230557Sjimharris} 163230557Sjimharris 164230557Sjimharris#define sati_cb_get_response_iu_address scif_io_request_get_response_iu_address 165230557Sjimharris#define sati_cb_get_task_function scic_cb_ssp_task_request_get_function 166230557Sjimharris 167230557Sjimharris#define sati_cb_get_ata_data_address(the_ata_io) \ 168230557Sjimharris scic_io_request_get_rx_frame( \ 169230557Sjimharris scif_io_request_get_scic_handle((the_ata_io)), 0 \ 170230557Sjimharris ) 171230557Sjimharris 172230557Sjimharris#define sati_cb_get_h2d_register_fis_address(the_ata_io) \ 173230557Sjimharris (U8*) scic_stp_io_request_get_h2d_reg_address( \ 174230557Sjimharris scif_io_request_get_scic_handle((the_ata_io)) \ 175230557Sjimharris ) 176230557Sjimharris 177230557Sjimharris#define sati_cb_get_d2h_register_fis_address(the_ata_io) \ 178230557Sjimharris (U8*) scic_stp_io_request_get_d2h_reg_address( \ 179230557Sjimharris scif_io_request_get_scic_handle((the_ata_io)) \ 180230557Sjimharris ) 181230557Sjimharris 182230557Sjimharris#define sati_cb_allocate_dma_buffer(scsi_io, length, virt_address, phys_address_low, phys_address_high) \ 183230557Sjimharris{ \ 184230557Sjimharris SCIF_SAS_REQUEST_T* fw_request = (SCIF_SAS_REQUEST_T*)scsi_io; \ 185230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T mde; \ 186230557Sjimharris mde.virtual_address = NULL; \ 187230557Sjimharris sci_base_mde_construct( \ 188230557Sjimharris &mde, 4, length, SCI_MDE_ATTRIBUTE_PHYSICALLY_CONTIGUOUS \ 189230557Sjimharris ); \ 190230557Sjimharris scif_cb_controller_allocate_memory( \ 191230557Sjimharris fw_request->device->domain->controller, &mde \ 192230557Sjimharris ); \ 193230557Sjimharris *(virt_address) = mde.virtual_address; \ 194239545Sjimharris *(phys_address_low) = sci_cb_physical_address_lower(mde.physical_address); \ 195239545Sjimharris *(phys_address_high) = sci_cb_physical_address_upper(mde.physical_address); \ 196230557Sjimharris} 197230557Sjimharris 198230557Sjimharris#define sati_cb_free_dma_buffer(scsi_io, virt_address) \ 199230557Sjimharris{ \ 200230557Sjimharris SCIF_SAS_REQUEST_T* fw_request = (SCIF_SAS_REQUEST_T*)scsi_io; \ 201230557Sjimharris SCI_PHYSICAL_MEMORY_DESCRIPTOR_T mde; \ 202230557Sjimharris mde.virtual_address = virt_address; \ 203230557Sjimharris sci_base_mde_construct( \ 204230557Sjimharris &mde, 4, 0, SCI_MDE_ATTRIBUTE_PHYSICALLY_CONTIGUOUS \ 205230557Sjimharris ); \ 206230557Sjimharris scif_cb_controller_free_memory( \ 207230557Sjimharris fw_request->device->domain->controller, &mde \ 208230557Sjimharris ); \ 209230557Sjimharris} 210230557Sjimharris 211230557Sjimharris#define sati_cb_sgl_next_sge(scsi_io, ata_io, current_sge, next_sge) \ 212230557Sjimharris{ \ 213230557Sjimharris /* For now just 2 SGEs are supported. */ \ 214230557Sjimharris SCIC_SDS_REQUEST_T *scic_request; \ 215230557Sjimharris SCU_SGL_ELEMENT_PAIR_T *sgl_pair; \ 216230557Sjimharris scic_request = scif_io_request_get_scic_handle((scsi_io)); \ 217230557Sjimharris sgl_pair = scic_sds_request_get_sgl_element_pair(scic_request, 0); \ 218230557Sjimharris \ 219230557Sjimharris if ((current_sge) == NULL) \ 220230557Sjimharris { \ 221230557Sjimharris *(next_sge) = &(sgl_pair->A); \ 222230557Sjimharris } \ 223230557Sjimharris else \ 224230557Sjimharris { \ 225230557Sjimharris *(next_sge) = &(sgl_pair->B); \ 226230557Sjimharris } \ 227230557Sjimharris} 228230557Sjimharris 229230557Sjimharris#define sati_cb_sge_write(current_sge, phys_address_low, phys_address_high, byte_length) \ 230230557Sjimharris{ \ 231230557Sjimharris SCU_SGL_ELEMENT_T * scu_sge = (SCU_SGL_ELEMENT_T*) (current_sge); \ 232230557Sjimharris scu_sge->address_upper = (phys_address_high); \ 233230557Sjimharris scu_sge->address_lower = (phys_address_low); \ 234230557Sjimharris scu_sge->length = (byte_length); \ 235230557Sjimharris scu_sge->address_modifier = 0; \ 236230557Sjimharris} 237230557Sjimharris 238230557Sjimharris#define sati_cb_do_translate_response(request) \ 239230557Sjimharris (request)->stp.sequence.is_translate_response_required 240230557Sjimharris 241230557Sjimharris#ifdef __cplusplus 242230557Sjimharris} 243230557Sjimharris#endif // __cplusplus 244230557Sjimharris 245230557Sjimharris#endif // _SCIF_SAS_SATI_BINDING_H_ 246230557Sjimharris 247