Merge remote-tracking branch 's5p/for-next'
[linux-2.6/next.git] / drivers / scsi / isci / task.h
blob4a7fa90287ef3553dc6ade693d2a1e6a2f25b19c
1 /*
2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
5 * GPL LICENSE SUMMARY
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
24 * BSD LICENSE
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
38 * distribution.
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55 #ifndef _ISCI_TASK_H_
56 #define _ISCI_TASK_H_
58 #include <scsi/sas_ata.h>
59 #include "host.h"
61 struct isci_request;
63 /**
64 * enum isci_tmf_cb_state - This enum defines the possible states in which the
65 * TMF callback function is invoked during the TMF execution process.
69 enum isci_tmf_cb_state {
71 isci_tmf_init_state = 0,
72 isci_tmf_started,
73 isci_tmf_timed_out
76 /**
77 * enum isci_tmf_function_codes - This enum defines the possible preparations
78 * of task management requests.
82 enum isci_tmf_function_codes {
84 isci_tmf_func_none = 0,
85 isci_tmf_ssp_task_abort = TMF_ABORT_TASK,
86 isci_tmf_ssp_lun_reset = TMF_LU_RESET,
87 isci_tmf_sata_srst_high = TMF_LU_RESET + 0x100, /* Non SCSI */
88 isci_tmf_sata_srst_low = TMF_LU_RESET + 0x101 /* Non SCSI */
90 /**
91 * struct isci_tmf - This class represents the task management object which
92 * acts as an interface to libsas for processing task management requests
96 struct isci_tmf {
98 struct completion *complete;
99 enum sas_protocol proto;
100 union {
101 struct ssp_response_iu resp_iu;
102 struct dev_to_host_fis d2h_fis;
103 u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
104 } resp;
105 unsigned char lun[8];
106 u16 io_tag;
107 struct isci_remote_device *device;
108 enum isci_tmf_function_codes tmf_code;
109 int status;
111 /* The optional callback function allows the user process to
112 * track the TMF transmit / timeout conditions.
114 void (*cb_state_func)(
115 enum isci_tmf_cb_state,
116 struct isci_tmf *, void *);
117 void *cb_data;
121 static inline void isci_print_tmf(struct isci_tmf *tmf)
123 if (SAS_PROTOCOL_SATA == tmf->proto)
124 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
125 "%s: status = %x\n"
126 "tmf->resp.d2h_fis.status = %x\n"
127 "tmf->resp.d2h_fis.error = %x\n",
128 __func__,
129 tmf->status,
130 tmf->resp.d2h_fis.status,
131 tmf->resp.d2h_fis.error);
132 else
133 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
134 "%s: status = %x\n"
135 "tmf->resp.resp_iu.data_present = %x\n"
136 "tmf->resp.resp_iu.status = %x\n"
137 "tmf->resp.resp_iu.data_length = %x\n"
138 "tmf->resp.resp_iu.data[0] = %x\n"
139 "tmf->resp.resp_iu.data[1] = %x\n"
140 "tmf->resp.resp_iu.data[2] = %x\n"
141 "tmf->resp.resp_iu.data[3] = %x\n",
142 __func__,
143 tmf->status,
144 tmf->resp.resp_iu.datapres,
145 tmf->resp.resp_iu.status,
146 be32_to_cpu(tmf->resp.resp_iu.response_data_len),
147 tmf->resp.resp_iu.resp_data[0],
148 tmf->resp.resp_iu.resp_data[1],
149 tmf->resp.resp_iu.resp_data[2],
150 tmf->resp.resp_iu.resp_data[3]);
154 int isci_task_execute_task(
155 struct sas_task *task,
156 int num,
157 gfp_t gfp_flags);
159 int isci_task_abort_task(
160 struct sas_task *task);
162 int isci_task_abort_task_set(
163 struct domain_device *d_device,
164 u8 *lun);
166 int isci_task_clear_aca(
167 struct domain_device *d_device,
168 u8 *lun);
170 int isci_task_clear_task_set(
171 struct domain_device *d_device,
172 u8 *lun);
174 int isci_task_query_task(
175 struct sas_task *task);
177 int isci_task_lu_reset(
178 struct domain_device *d_device,
179 u8 *lun);
181 int isci_task_clear_nexus_port(
182 struct asd_sas_port *port);
184 int isci_task_clear_nexus_ha(
185 struct sas_ha_struct *ha);
187 int isci_task_I_T_nexus_reset(
188 struct domain_device *d_device);
190 void isci_task_request_complete(
191 struct isci_host *isci_host,
192 struct isci_request *request,
193 enum sci_task_status completion_status);
195 u16 isci_task_ssp_request_get_io_tag_to_manage(
196 struct isci_request *request);
198 u8 isci_task_ssp_request_get_function(
199 struct isci_request *request);
202 void *isci_task_ssp_request_get_response_data_address(
203 struct isci_request *request);
205 u32 isci_task_ssp_request_get_response_data_length(
206 struct isci_request *request);
208 int isci_queuecommand(
209 struct scsi_cmnd *scsi_cmd,
210 void (*donefunc)(struct scsi_cmnd *));
212 int isci_bus_reset_handler(struct scsi_cmnd *cmd);
215 * enum isci_completion_selection - This enum defines the possible actions to
216 * take with respect to a given request's notification back to libsas.
220 enum isci_completion_selection {
222 isci_perform_normal_io_completion, /* Normal notify (task_done) */
223 isci_perform_aborted_io_completion, /* No notification. */
224 isci_perform_error_io_completion /* Use sas_task_abort */
227 static inline void isci_set_task_doneflags(
228 struct sas_task *task)
230 /* Since no futher action will be taken on this task,
231 * make sure to mark it complete from the lldd perspective.
233 task->task_state_flags |= SAS_TASK_STATE_DONE;
234 task->task_state_flags &= ~SAS_TASK_AT_INITIATOR;
235 task->task_state_flags &= ~SAS_TASK_STATE_PENDING;
238 * isci_task_all_done() - This function clears the task bits to indicate the
239 * LLDD is done with the task.
243 static inline void isci_task_all_done(
244 struct sas_task *task)
246 unsigned long flags;
248 /* Since no futher action will be taken on this task,
249 * make sure to mark it complete from the lldd perspective.
251 spin_lock_irqsave(&task->task_state_lock, flags);
252 isci_set_task_doneflags(task);
253 spin_unlock_irqrestore(&task->task_state_lock, flags);
257 * isci_task_set_completion_status() - This function sets the completion status
258 * for the request.
259 * @task: This parameter is the completed request.
260 * @response: This parameter is the response code for the completed task.
261 * @status: This parameter is the status code for the completed task.
263 * @return The new notification mode for the request.
265 static inline enum isci_completion_selection
266 isci_task_set_completion_status(
267 struct sas_task *task,
268 enum service_response response,
269 enum exec_status status,
270 enum isci_completion_selection task_notification_selection)
272 unsigned long flags;
274 spin_lock_irqsave(&task->task_state_lock, flags);
276 /* If a device reset is being indicated, make sure the I/O
277 * is in the error path.
279 if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET) {
280 /* Fail the I/O to make sure it goes into the error path. */
281 response = SAS_TASK_UNDELIVERED;
282 status = SAM_STAT_TASK_ABORTED;
284 task_notification_selection = isci_perform_error_io_completion;
286 task->task_status.resp = response;
287 task->task_status.stat = status;
289 switch (task_notification_selection) {
291 case isci_perform_error_io_completion:
293 if (task->task_proto == SAS_PROTOCOL_SMP) {
294 /* There is no error escalation in the SMP case.
295 * Convert to a normal completion to avoid the
296 * timeout in the discovery path and to let the
297 * next action take place quickly.
299 task_notification_selection
300 = isci_perform_normal_io_completion;
302 /* Fall through to the normal case... */
303 } else {
304 /* Use sas_task_abort */
305 /* Leave SAS_TASK_STATE_DONE clear
306 * Leave SAS_TASK_AT_INITIATOR set.
308 break;
311 case isci_perform_aborted_io_completion:
312 /* This path can occur with task-managed requests as well as
313 * requests terminated because of LUN or device resets.
315 /* Fall through to the normal case... */
316 case isci_perform_normal_io_completion:
317 /* Normal notification (task_done) */
318 isci_set_task_doneflags(task);
319 break;
320 default:
321 WARN_ONCE(1, "unknown task_notification_selection: %d\n",
322 task_notification_selection);
323 break;
326 spin_unlock_irqrestore(&task->task_state_lock, flags);
328 return task_notification_selection;
332 * isci_execpath_callback() - This function is called from the task
333 * execute path when the task needs to callback libsas about the submit-time
334 * task failure. The callback occurs either through the task's done function
335 * or through sas_task_abort. In the case of regular non-discovery SATA/STP I/O
336 * requests, libsas takes the host lock before calling execute task. Therefore
337 * in this situation the host lock must be managed before calling the func.
339 * @ihost: This parameter is the controller to which the I/O request was sent.
340 * @task: This parameter is the I/O request.
341 * @func: This parameter is the function to call in the correct context.
342 * @status: This parameter is the status code for the completed task.
345 static inline void isci_execpath_callback(struct isci_host *ihost,
346 struct sas_task *task,
347 void (*func)(struct sas_task *))
349 struct domain_device *dev = task->dev;
351 if (dev_is_sata(dev) && task->uldd_task) {
352 unsigned long flags;
354 /* Since we are still in the submit path, and since
355 * libsas takes the host lock on behalf of SATA
356 * devices before I/O starts (in the non-discovery case),
357 * we need to unlock before we can call the callback function.
359 raw_local_irq_save(flags);
360 spin_unlock(dev->sata_dev.ap->lock);
361 func(task);
362 spin_lock(dev->sata_dev.ap->lock);
363 raw_local_irq_restore(flags);
364 } else
365 func(task);
367 #endif /* !defined(_SCI_TASK_H_) */