/*
   * 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.
   *   * Neither the name of Intel Corporation nor the names of its
   *     contributors may be used to endorse or promote products derived
   *     from this software without specific prior written permission.
   *
   * 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.
   */
  #ifndef _ISCI_TASK_H_
  #define _ISCI_TASK_H_
  
  #include <scsi/sas_ata.h>
  #include "host.h"
  
  #define ISCI_TERMINATION_TIMEOUT_MSEC 500
  
  struct isci_request;
  
  /**
   * enum isci_tmf_function_codes - This enum defines the possible preparations
   *    of task management requests.
   *
   *
   */
  enum isci_tmf_function_codes {
  
  	isci_tmf_func_none      = 0,
  	isci_tmf_ssp_task_abort = TMF_ABORT_TASK,
  	isci_tmf_ssp_lun_reset  = TMF_LU_RESET,
  };
  
  /**
   * struct isci_tmf - This class represents the task management object which
   *    acts as an interface to libsas for processing task management requests
   *
   *
   */
  struct isci_tmf {
  
  	struct completion *complete;
  	enum sas_protocol proto;
  	union {
  		struct ssp_response_iu resp_iu;
  		struct dev_to_host_fis d2h_fis;
  		u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
  	} resp;
  	unsigned char lun[8];
  	u16 io_tag;
  	enum isci_tmf_function_codes tmf_code;
  	int status;
  };
  
  static inline void isci_print_tmf(struct isci_host *ihost, struct isci_tmf *tmf)
  {
  	if (SAS_PROTOCOL_SATA == tmf->proto)
  		dev_dbg(&ihost->pdev->dev,
  			"%s: status = %x
  "
  			"tmf->resp.d2h_fis.status = %x
  "
  			"tmf->resp.d2h_fis.error = %x
  ",
  			__func__,
  			tmf->status,
  			tmf->resp.d2h_fis.status,
  			tmf->resp.d2h_fis.error);
  	else
  		dev_dbg(&ihost->pdev->dev,
  			"%s: status = %x
  "
  			"tmf->resp.resp_iu.data_present = %x
  "
  			"tmf->resp.resp_iu.status = %x
  "
  			"tmf->resp.resp_iu.data_length = %x
  "
  			"tmf->resp.resp_iu.data[0] = %x
  "
  			"tmf->resp.resp_iu.data[1] = %x
  "
  			"tmf->resp.resp_iu.data[2] = %x
  "
  			"tmf->resp.resp_iu.data[3] = %x
  ",
  			__func__,
  			tmf->status,
  			tmf->resp.resp_iu.datapres,
  			tmf->resp.resp_iu.status,
  			be32_to_cpu(tmf->resp.resp_iu.response_data_len),
  			tmf->resp.resp_iu.resp_data[0],
  			tmf->resp.resp_iu.resp_data[1],
  			tmf->resp.resp_iu.resp_data[2],
  			tmf->resp.resp_iu.resp_data[3]);
  }
  
  
  int isci_task_execute_task(
  	struct sas_task *task,
  	int num,
  	gfp_t gfp_flags);
  
  int isci_task_abort_task(
  	struct sas_task *task);
  
  int isci_task_abort_task_set(
  	struct domain_device *d_device,
  	u8 *lun);
  
  int isci_task_clear_aca(
  	struct domain_device *d_device,
  	u8 *lun);
  
  int isci_task_clear_task_set(
  	struct domain_device *d_device,
  	u8 *lun);
  
  int isci_task_query_task(
  	struct sas_task *task);
  
  int isci_task_lu_reset(
  	struct domain_device *d_device,
  	u8 *lun);
  
  int isci_task_clear_nexus_port(
  	struct asd_sas_port *port);
  
  int isci_task_clear_nexus_ha(
  	struct sas_ha_struct *ha);
  
  int isci_task_I_T_nexus_reset(
  	struct domain_device *d_device);
  
  void isci_task_request_complete(
  	struct isci_host *isci_host,
  	struct isci_request *request,
  	enum sci_task_status completion_status);
  
  u16 isci_task_ssp_request_get_io_tag_to_manage(
  	struct isci_request *request);
  
  u8 isci_task_ssp_request_get_function(
  	struct isci_request *request);
  
  
  void *isci_task_ssp_request_get_response_data_address(
  	struct isci_request *request);
  
  u32 isci_task_ssp_request_get_response_data_length(
  	struct isci_request *request);
  
  int isci_queuecommand(
  	struct scsi_cmnd *scsi_cmd,
  	void (*donefunc)(struct scsi_cmnd *));
  
  #endif /* !defined(_SCI_TASK_H_) */