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.
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.
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
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
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.
56 #if !defined(_ISCI_TASK_H_)
63 * enum isci_tmf_cb_state - This enum defines the possible states in which the
64 * TMF callback function is invoked during the TMF execution process.
68 enum isci_tmf_cb_state {
70 isci_tmf_init_state = 0,
76 * enum isci_tmf_function_codes - This enum defines the possible preparations
77 * of task management requests.
81 enum isci_tmf_function_codes {
83 isci_tmf_func_none = 0,
84 isci_tmf_ssp_task_abort = TMF_ABORT_TASK,
85 isci_tmf_ssp_lun_reset = TMF_LU_RESET,
86 isci_tmf_sata_srst_high = TMF_LU_RESET + 0x100, /* Non SCSI */
87 isci_tmf_sata_srst_low = TMF_LU_RESET + 0x101 /* Non SCSI */
90 * struct isci_tmf - This class represents the task management object which
91 * acts as an interface to libsas for processing task management requests
97 struct completion *complete;
98 enum sas_protocol proto;
100 struct sci_ssp_response_iu resp_iu;
101 struct dev_to_host_fis d2h_fis;
103 unsigned char lun[8];
105 struct isci_remote_device *device;
106 enum isci_tmf_function_codes tmf_code;
109 struct isci_timer *timeout_timer;
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 *);
121 static inline void isci_print_tmf(
122 struct isci_tmf *tmf)
124 if (SAS_PROTOCOL_SATA == tmf->proto)
125 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
127 "tmf->resp.d2h_fis.status = %x\n"
128 "tmf->resp.d2h_fis.error = %x\n",
131 tmf->resp.d2h_fis.status,
132 tmf->resp.d2h_fis.error);
134 dev_dbg(&tmf->device->isci_port->isci_host->pdev->dev,
136 "tmf->resp.resp_iu.data_present = %x\n"
137 "tmf->resp.resp_iu.status = %x\n"
138 "tmf->resp.resp_iu.data_length = %x\n"
139 "tmf->resp.resp_iu.data[0] = %x\n"
140 "tmf->resp.resp_iu.data[1] = %x\n"
141 "tmf->resp.resp_iu.data[2] = %x\n"
142 "tmf->resp.resp_iu.data[3] = %x\n",
145 tmf->resp.resp_iu.data_present,
146 tmf->resp.resp_iu.status,
147 (tmf->resp.resp_iu.response_data_length[0] << 24) +
148 (tmf->resp.resp_iu.response_data_length[1] << 16) +
149 (tmf->resp.resp_iu.response_data_length[2] << 8) +
150 tmf->resp.resp_iu.response_data_length[3],
151 tmf->resp.resp_iu.data[0],
152 tmf->resp.resp_iu.data[1],
153 tmf->resp.resp_iu.data[2],
154 tmf->resp.resp_iu.data[3]);
158 int isci_task_execute_task(
159 struct sas_task *task,
163 int isci_task_abort_task(
164 struct sas_task *task);
166 int isci_task_abort_task_set(
167 struct domain_device *d_device,
170 int isci_task_clear_aca(
171 struct domain_device *d_device,
174 int isci_task_clear_task_set(
175 struct domain_device *d_device,
178 int isci_task_query_task(
179 struct sas_task *task);
181 int isci_task_lu_reset(
182 struct domain_device *d_device,
185 int isci_task_clear_nexus_port(
186 struct asd_sas_port *port);
188 int isci_task_clear_nexus_ha(
189 struct sas_ha_struct *ha);
191 int isci_task_I_T_nexus_reset(
192 struct domain_device *d_device);
194 void isci_task_request_complete(
195 struct isci_host *isci_host,
196 struct isci_request *request,
197 enum sci_task_status completion_status);
199 u16 isci_task_ssp_request_get_io_tag_to_manage(
200 struct isci_request *request);
202 u8 isci_task_ssp_request_get_function(
203 struct isci_request *request);
205 u32 isci_task_ssp_request_get_lun(
206 struct isci_request *request);
208 void *isci_task_ssp_request_get_response_data_address(
209 struct isci_request *request);
211 u32 isci_task_ssp_request_get_response_data_length(
212 struct isci_request *request);
214 int isci_queuecommand(
215 struct scsi_cmnd *scsi_cmd,
216 void (*donefunc)(struct scsi_cmnd *));
218 int isci_bus_reset_handler(struct scsi_cmnd *cmd);
220 void isci_task_build_tmf(
221 struct isci_tmf *tmf,
222 struct isci_remote_device *isci_device,
223 enum isci_tmf_function_codes code,
225 enum isci_tmf_cb_state,
226 struct isci_tmf *, void *),
229 int isci_task_execute_tmf(
230 struct isci_host *isci_host,
231 struct isci_tmf *tmf,
232 unsigned long timeout_ms);
235 * enum isci_completion_selection - This enum defines the possible actions to
236 * take with respect to a given request's notification back to libsas.
240 enum isci_completion_selection {
242 isci_perform_normal_io_completion, /* Normal notify (task_done) */
243 isci_perform_aborted_io_completion, /* No notification. */
244 isci_perform_error_io_completion /* Use sas_task_abort */
247 static inline void isci_set_task_doneflags(
248 struct sas_task *task)
250 /* Since no futher action will be taken on this task,
251 * make sure to mark it complete from the lldd perspective.
253 task->task_state_flags |= SAS_TASK_STATE_DONE;
254 task->task_state_flags &= ~SAS_TASK_AT_INITIATOR;
255 task->task_state_flags &= ~SAS_TASK_STATE_PENDING;
258 * isci_task_all_done() - This function clears the task bits to indicate the
259 * LLDD is done with the task.
263 static inline void isci_task_all_done(
264 struct sas_task *task)
268 /* Since no futher action will be taken on this task,
269 * make sure to mark it complete from the lldd perspective.
271 spin_lock_irqsave(&task->task_state_lock, flags);
272 isci_set_task_doneflags(task);
273 spin_unlock_irqrestore(&task->task_state_lock, flags);
277 * isci_task_set_completion_status() - This function sets the completion status
279 * @task: This parameter is the completed request.
280 * @response: This parameter is the response code for the completed task.
281 * @status: This parameter is the status code for the completed task.
283 * @return The new notification mode for the request.
285 static inline enum isci_completion_selection
286 isci_task_set_completion_status(
287 struct sas_task *task,
288 enum service_response response,
289 enum exec_status status,
290 enum isci_completion_selection task_notification_selection)
294 spin_lock_irqsave(&task->task_state_lock, flags);
296 task->task_status.resp = response;
297 task->task_status.stat = status;
299 /* If a device reset is being indicated, make sure the I/O
300 * is in the error path.
302 if (task->task_state_flags & SAS_TASK_NEED_DEV_RESET)
303 task_notification_selection = isci_perform_error_io_completion;
305 switch (task_notification_selection) {
307 case isci_perform_aborted_io_completion:
308 /* This path can occur with task-managed requests as well as
309 * requests terminated because of LUN or device resets.
311 /* Fall through to the normal case... */
313 case isci_perform_normal_io_completion:
314 /* Normal notification (task_done) */
315 isci_set_task_doneflags(task);
320 /* Fall through to the error case... */
322 case isci_perform_error_io_completion:
323 /* Use sas_task_abort */
324 /* Leave SAS_TASK_STATE_DONE clear
325 * Leave SAS_TASK_AT_INITIATOR set.
330 spin_unlock_irqrestore(&task->task_state_lock, flags);
332 return task_notification_selection;
336 * isci_task_complete_for_upper_layer() - This function completes the request
337 * to the upper layer driver.
338 * @host: This parameter is a pointer to the host on which the the request
339 * should be queued (either as an error or success).
340 * @request: This parameter is the completed request.
341 * @response: This parameter is the response code for the completed task.
342 * @status: This parameter is the status code for the completed task.
346 static inline void isci_task_complete_for_upper_layer(
347 struct sas_task *task,
348 enum service_response response,
349 enum exec_status status,
350 enum isci_completion_selection task_notification_selection)
352 task_notification_selection
353 = isci_task_set_completion_status(task, response, status,
354 task_notification_selection);
356 /* Tasks aborted specifically by a call to the lldd_abort_task
357 * function should not be completed to the host in the regular path.
359 switch (task_notification_selection) {
360 case isci_perform_normal_io_completion:
361 /* Normal notification (task_done) */
362 dev_dbg(task->dev->port->ha->dev,
363 "%s: Normal - task = %p, response=%d, status=%d\n",
364 __func__, task, response, status);
365 task->task_done(task);
366 task->lldd_task = NULL;
369 case isci_perform_aborted_io_completion:
370 /* No notification because this request is already in the
373 dev_warn(task->dev->port->ha->dev,
374 "%s: Aborted - task = %p, response=%d, status=%d\n",
375 __func__, task, response, status);
378 case isci_perform_error_io_completion:
379 /* Use sas_task_abort */
380 dev_warn(task->dev->port->ha->dev,
381 "%s: Error - task = %p, response=%d, status=%d\n",
382 __func__, task, response, status);
383 sas_task_abort(task);
387 dev_warn(task->dev->port->ha->dev,
388 "%s: isci task notification default case!",
390 sas_task_abort(task);
395 #endif /* !defined(_SCI_TASK_H_) */