^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) * This file is provided under a dual BSD/GPLv2 license. When using or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * redistributing this file, you may do so under either license.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * GPL LICENSE SUMMARY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * This program is free software; you can redistribute it and/or modify
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) * it under the terms of version 2 of the GNU General Public License as
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) * published by the Free Software Foundation.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) * This program is distributed in the hope that it will be useful, but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * WITHOUT ANY WARRANTY; without even the implied warranty of
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) * General Public License for more details.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) * You should have received a copy of the GNU General Public License
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) * along with this program; if not, write to the Free Software
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) * The full GNU General Public License is included in this distribution
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) * in the file called LICENSE.GPL.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * BSD LICENSE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) * All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * Redistribution and use in source and binary forms, with or without
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) * modification, are permitted provided that the following conditions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * are met:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * * Redistributions of source code must retain the above copyright
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * notice, this list of conditions and the following disclaimer.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * * Redistributions in binary form must reproduce the above copyright
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * notice, this list of conditions and the following disclaimer in
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) * the documentation and/or other materials provided with the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) * distribution.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) * * Neither the name of Intel Corporation nor the names of its
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * contributors may be used to endorse or promote products derived
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) * from this software without specific prior written permission.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) #ifndef _ISCI_TASK_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define _ISCI_TASK_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) #include <scsi/sas_ata.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) #include "host.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) #define ISCI_TERMINATION_TIMEOUT_MSEC 500
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) struct isci_request;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) * enum isci_tmf_function_codes - This enum defines the possible preparations
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) * of task management requests.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) enum isci_tmf_function_codes {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) isci_tmf_func_none = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) isci_tmf_ssp_task_abort = TMF_ABORT_TASK,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) isci_tmf_ssp_lun_reset = TMF_LU_RESET,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) * struct isci_tmf - This class represents the task management object which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) * acts as an interface to libsas for processing task management requests
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) struct isci_tmf {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) struct completion *complete;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) enum sas_protocol proto;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) union {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) struct ssp_response_iu resp_iu;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) struct dev_to_host_fis d2h_fis;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) } resp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) unsigned char lun[8];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) u16 io_tag;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) enum isci_tmf_function_codes tmf_code;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) int status;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) static inline void isci_print_tmf(struct isci_host *ihost, struct isci_tmf *tmf)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) if (SAS_PROTOCOL_SATA == tmf->proto)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) dev_dbg(&ihost->pdev->dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) "%s: status = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) "tmf->resp.d2h_fis.status = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) "tmf->resp.d2h_fis.error = %x\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) __func__,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) tmf->status,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) tmf->resp.d2h_fis.status,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) tmf->resp.d2h_fis.error);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) dev_dbg(&ihost->pdev->dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) "%s: status = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) "tmf->resp.resp_iu.data_present = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) "tmf->resp.resp_iu.status = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) "tmf->resp.resp_iu.data_length = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) "tmf->resp.resp_iu.data[0] = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) "tmf->resp.resp_iu.data[1] = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) "tmf->resp.resp_iu.data[2] = %x\n"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) "tmf->resp.resp_iu.data[3] = %x\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) __func__,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) tmf->status,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) tmf->resp.resp_iu.datapres,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) tmf->resp.resp_iu.status,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) be32_to_cpu(tmf->resp.resp_iu.response_data_len),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) tmf->resp.resp_iu.resp_data[0],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) tmf->resp.resp_iu.resp_data[1],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) tmf->resp.resp_iu.resp_data[2],
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) tmf->resp.resp_iu.resp_data[3]);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) int isci_task_execute_task(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) struct sas_task *task,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) gfp_t gfp_flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) int isci_task_abort_task(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) struct sas_task *task);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) int isci_task_abort_task_set(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) struct domain_device *d_device,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) u8 *lun);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) int isci_task_clear_aca(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) struct domain_device *d_device,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) u8 *lun);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) int isci_task_clear_task_set(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) struct domain_device *d_device,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) u8 *lun);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) int isci_task_query_task(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) struct sas_task *task);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) int isci_task_lu_reset(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) struct domain_device *d_device,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) u8 *lun);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) int isci_task_clear_nexus_port(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) struct asd_sas_port *port);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) int isci_task_clear_nexus_ha(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) struct sas_ha_struct *ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) int isci_task_I_T_nexus_reset(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) struct domain_device *d_device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) void isci_task_request_complete(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) struct isci_host *isci_host,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) struct isci_request *request,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) enum sci_task_status completion_status);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) u16 isci_task_ssp_request_get_io_tag_to_manage(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) struct isci_request *request);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) u8 isci_task_ssp_request_get_function(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) struct isci_request *request);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) void *isci_task_ssp_request_get_response_data_address(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) struct isci_request *request);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) u32 isci_task_ssp_request_get_response_data_length(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) struct isci_request *request);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) int isci_queuecommand(
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) struct scsi_cmnd *scsi_cmd,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) void (*donefunc)(struct scsi_cmnd *));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) #endif /* !defined(_SCI_TASK_H_) */