projects / deliverable / linux.git / blob
? search:


36c2b310c1757cb8b4c92fe2c73a24e6924c869a
[deliverable/linux.git] / drivers / scsi / isci / core / scic_sds_request.c
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.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
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.
12 *
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.
17 *
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.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
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.
42 *
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.
54 */
55
56 #include <scsi/sas.h>
57 #include "scic_controller.h"
58 #include "scic_io_request.h"
59 #include "scic_sds_controller.h"
60 #include "scu_registers.h"
61 #include "scic_sds_port.h"
62 #include "remote_device.h"
63 #include "scic_sds_request.h"
64 #include "scic_sds_smp_request.h"
65 #include "scic_sds_stp_request.h"
66 #include "scic_sds_unsolicited_frame_control.h"
67 #include "sci_environment.h"
68 #include "sci_util.h"
69 #include "scu_completion_codes.h"
70 #include "scu_constants.h"
71 #include "scu_task_context.h"
72
73 /*
74 * ****************************************************************************
75 * * SCIC SDS IO REQUEST CONSTANTS
76 * **************************************************************************** */
77
78 /**
79 *
80 *
81 * We have no timer requirements for IO requests right now
82 */
83 #define SCIC_SDS_IO_REQUEST_MINIMUM_TIMER_COUNT (0)
84 #define SCIC_SDS_IO_REQUEST_MAXIMUM_TIMER_COUNT (0)
85
86 /**
87 * This method returns the sgl element pair for the specificed sgl_pair index.
88 * @sci_req: This parameter specifies the IO request for which to retrieve
89 * the Scatter-Gather List element pair.
90 * @sgl_pair_index: This parameter specifies the index into the SGL element
91 * pair to be retrieved.
92 *
93 * This method returns a pointer to an struct scu_sgl_element_pair.
94 */
95 static struct scu_sgl_element_pair *scic_sds_request_get_sgl_element_pair(
96 struct scic_sds_request *sci_req,
97 u32 sgl_pair_index
98 ) {
99 struct scu_task_context *task_context;
100
101 task_context = (struct scu_task_context *)sci_req->task_context_buffer;
102
103 if (sgl_pair_index == 0) {
104 return &task_context->sgl_pair_ab;
105 } else if (sgl_pair_index == 1) {
106 return &task_context->sgl_pair_cd;
107 }
108
109 return &sci_req->sg_table[sgl_pair_index - 2];
110 }
111
112 /**
113 * This function will build the SGL list for an IO request.
114 * @sci_req: This parameter specifies the IO request for which to build
115 * the Scatter-Gather List.
116 *
117 */
118 void scic_sds_request_build_sgl(struct scic_sds_request *sds_request)
119 {
120 struct isci_request *isci_request = sds_request->ireq;
121 struct isci_host *isci_host = isci_request->isci_host;
122 struct sas_task *task = isci_request_access_task(isci_request);
123 struct scatterlist *sg = NULL;
124 dma_addr_t dma_addr;
125 u32 sg_idx = 0;
126 struct scu_sgl_element_pair *scu_sg = NULL;
127 struct scu_sgl_element_pair *prev_sg = NULL;
128
129 if (task->num_scatter > 0) {
130 sg = task->scatter;
131
132 while (sg) {
133 scu_sg = scic_sds_request_get_sgl_element_pair(
134 sds_request,
135 sg_idx);
136
137 SCU_SGL_COPY(scu_sg->A, sg);
138
139 sg = sg_next(sg);
140
141 if (sg) {
142 SCU_SGL_COPY(scu_sg->B, sg);
143 sg = sg_next(sg);
144 } else
145 SCU_SGL_ZERO(scu_sg->B);
146
147 if (prev_sg) {
148 dma_addr =
149 scic_io_request_get_dma_addr(
150 sds_request,
151 scu_sg);
152
153 prev_sg->next_pair_upper =
154 upper_32_bits(dma_addr);
155 prev_sg->next_pair_lower =
156 lower_32_bits(dma_addr);
157 }
158
159 prev_sg = scu_sg;
160 sg_idx++;
161 }
162 } else { /* handle when no sg */
163 scu_sg = scic_sds_request_get_sgl_element_pair(sds_request,
164 sg_idx);
165
166 dma_addr = dma_map_single(&isci_host->pdev->dev,
167 task->scatter,
168 task->total_xfer_len,
169 task->data_dir);
170
171 isci_request->zero_scatter_daddr = dma_addr;
172
173 scu_sg->A.length = task->total_xfer_len;
174 scu_sg->A.address_upper = upper_32_bits(dma_addr);
175 scu_sg->A.address_lower = lower_32_bits(dma_addr);
176 }
177
178 if (scu_sg) {
179 scu_sg->next_pair_upper = 0;
180 scu_sg->next_pair_lower = 0;
181 }
182 }
183
184 static void scic_sds_ssp_io_request_assign_buffers(struct scic_sds_request *sci_req)
185 {
186 if (sci_req->was_tag_assigned_by_user == false)
187 sci_req->task_context_buffer = &sci_req->tc;
188 }
189
190 static void scic_sds_io_request_build_ssp_command_iu(struct scic_sds_request *sci_req)
191 {
192 struct ssp_cmd_iu *cmd_iu;
193 struct isci_request *ireq = sci_req->ireq;
194 struct sas_task *task = isci_request_access_task(ireq);
195
196 cmd_iu = &sci_req->ssp.cmd;
197
198 memcpy(cmd_iu->LUN, task->ssp_task.LUN, 8);
199 cmd_iu->add_cdb_len = 0;
200 cmd_iu->_r_a = 0;
201 cmd_iu->_r_b = 0;
202 cmd_iu->en_fburst = 0; /* unsupported */
203 cmd_iu->task_prio = task->ssp_task.task_prio;
204 cmd_iu->task_attr = task->ssp_task.task_attr;
205 cmd_iu->_r_c = 0;
206
207 sci_swab32_cpy(&cmd_iu->cdb, task->ssp_task.cdb,
208 sizeof(task->ssp_task.cdb) / sizeof(u32));
209 }
210
211 static void scic_sds_task_request_build_ssp_task_iu(struct scic_sds_request *sci_req)
212 {
213 struct ssp_task_iu *task_iu;
214 struct isci_request *ireq = sci_req->ireq;
215 struct sas_task *task = isci_request_access_task(ireq);
216 struct isci_tmf *isci_tmf = isci_request_access_tmf(ireq);
217
218 task_iu = &sci_req->ssp.tmf;
219
220 memset(task_iu, 0, sizeof(struct ssp_task_iu));
221
222 memcpy(task_iu->LUN, task->ssp_task.LUN, 8);
223
224 task_iu->task_func = isci_tmf->tmf_code;
225 task_iu->task_tag =
226 (ireq->ttype == tmf_task) ?
227 isci_tmf->io_tag :
228 SCI_CONTROLLER_INVALID_IO_TAG;
229 }
230
231 /**
232 * This method is will fill in the SCU Task Context for any type of SSP request.
233 * @sci_req:
234 * @task_context:
235 *
236 */
237 static void scu_ssp_reqeust_construct_task_context(
238 struct scic_sds_request *sds_request,
239 struct scu_task_context *task_context)
240 {
241 dma_addr_t dma_addr;
242 struct scic_sds_controller *controller;
243 struct scic_sds_remote_device *target_device;
244 struct scic_sds_port *target_port;
245
246 controller = scic_sds_request_get_controller(sds_request);
247 target_device = scic_sds_request_get_device(sds_request);
248 target_port = scic_sds_request_get_port(sds_request);
249
250 /* Fill in the TC with the its required data */
251 task_context->abort = 0;
252 task_context->priority = 0;
253 task_context->initiator_request = 1;
254 task_context->connection_rate = target_device->connection_rate;
255 task_context->protocol_engine_index =
256 scic_sds_controller_get_protocol_engine_group(controller);
257 task_context->logical_port_index =
258 scic_sds_port_get_index(target_port);
259 task_context->protocol_type = SCU_TASK_CONTEXT_PROTOCOL_SSP;
260 task_context->valid = SCU_TASK_CONTEXT_VALID;
261 task_context->context_type = SCU_TASK_CONTEXT_TYPE;
262
263 task_context->remote_node_index =
264 scic_sds_remote_device_get_index(sds_request->target_device);
265 task_context->command_code = 0;
266
267 task_context->link_layer_control = 0;
268 task_context->do_not_dma_ssp_good_response = 1;
269 task_context->strict_ordering = 0;
270 task_context->control_frame = 0;
271 task_context->timeout_enable = 0;
272 task_context->block_guard_enable = 0;
273
274 task_context->address_modifier = 0;
275
276 /* task_context->type.ssp.tag = sci_req->io_tag; */
277 task_context->task_phase = 0x01;
278
279 if (sds_request->was_tag_assigned_by_user) {
280 /*
281 * Build the task context now since we have already read
282 * the data
283 */
284 sds_request->post_context =
285 (SCU_CONTEXT_COMMAND_REQUEST_TYPE_POST_TC |
286 (scic_sds_controller_get_protocol_engine_group(
287 controller) <<
288 SCU_CONTEXT_COMMAND_PROTOCOL_ENGINE_GROUP_SHIFT) |
289 (scic_sds_port_get_index(target_port) <<
290 SCU_CONTEXT_COMMAND_LOGICAL_PORT_SHIFT) |
291 scic_sds_io_tag_get_index(sds_request->io_tag));
292 } else {
293 /*
294 * Build the task context now since we have already read
295 * the data
296 *
297 * I/O tag index is not assigned because we have to wait
298 * until we get a TCi
299 */
300 sds_request->post_context =
301 (SCU_CONTEXT_COMMAND_REQUEST_TYPE_POST_TC |
302 (scic_sds_controller_get_protocol_engine_group(
303 owning_controller) <<
304 SCU_CONTEXT_COMMAND_PROTOCOL_ENGINE_GROUP_SHIFT) |
305 (scic_sds_port_get_index(target_port) <<
306 SCU_CONTEXT_COMMAND_LOGICAL_PORT_SHIFT));
307 }
308
309 /*
310 * Copy the physical address for the command buffer to the
311 * SCU Task Context
312 */
313 dma_addr = scic_io_request_get_dma_addr(sds_request,
314 &sds_request->ssp.cmd);
315
316 task_context->command_iu_upper = upper_32_bits(dma_addr);
317 task_context->command_iu_lower = lower_32_bits(dma_addr);
318
319 /*
320 * Copy the physical address for the response buffer to the
321 * SCU Task Context
322 */
323 dma_addr = scic_io_request_get_dma_addr(sds_request,
324 &sds_request->ssp.rsp);
325
326 task_context->response_iu_upper = upper_32_bits(dma_addr);
327 task_context->response_iu_lower = lower_32_bits(dma_addr);
328 }
329
330 /**
331 * This method is will fill in the SCU Task Context for a SSP IO request.
332 * @sci_req:
333 *
334 */
335 static void scu_ssp_io_request_construct_task_context(
336 struct scic_sds_request *sci_req,
337 enum dma_data_direction dir,
338 u32 len)
339 {
340 struct scu_task_context *task_context;
341
342 task_context = scic_sds_request_get_task_context(sci_req);
343
344 scu_ssp_reqeust_construct_task_context(sci_req, task_context);
345
346 task_context->ssp_command_iu_length =
347 sizeof(struct ssp_cmd_iu) / sizeof(u32);
348 task_context->type.ssp.frame_type = SSP_COMMAND;
349
350 switch (dir) {
351 case DMA_FROM_DEVICE:
352 case DMA_NONE:
353 default:
354 task_context->task_type = SCU_TASK_TYPE_IOREAD;
355 break;
356 case DMA_TO_DEVICE:
357 task_context->task_type = SCU_TASK_TYPE_IOWRITE;
358 break;
359 }
360
361 task_context->transfer_length_bytes = len;
362
363 if (task_context->transfer_length_bytes > 0)
364 scic_sds_request_build_sgl(sci_req);
365 }
366
367 static void scic_sds_ssp_task_request_assign_buffers(struct scic_sds_request *sci_req)
368 {
369 if (sci_req->was_tag_assigned_by_user == false)
370 sci_req->task_context_buffer = &sci_req->tc;
371 }
372
373 /**
374 * This method will fill in the SCU Task Context for a SSP Task request. The
375 * following important settings are utilized: -# priority ==
376 * SCU_TASK_PRIORITY_HIGH. This ensures that the task request is issued
377 * ahead of other task destined for the same Remote Node. -# task_type ==
378 * SCU_TASK_TYPE_IOREAD. This simply indicates that a normal request type
379 * (i.e. non-raw frame) is being utilized to perform task management. -#
380 * control_frame == 1. This ensures that the proper endianess is set so
381 * that the bytes are transmitted in the right order for a task frame.
382 * @sci_req: This parameter specifies the task request object being
383 * constructed.
384 *
385 */
386 static void scu_ssp_task_request_construct_task_context(
387 struct scic_sds_request *sci_req)
388 {
389 struct scu_task_context *task_context;
390
391 task_context = scic_sds_request_get_task_context(sci_req);
392
393 scu_ssp_reqeust_construct_task_context(sci_req, task_context);
394
395 task_context->control_frame = 1;
396 task_context->priority = SCU_TASK_PRIORITY_HIGH;
397 task_context->task_type = SCU_TASK_TYPE_RAW_FRAME;
398 task_context->transfer_length_bytes = 0;
399 task_context->type.ssp.frame_type = SSP_TASK;
400 task_context->ssp_command_iu_length =
401 sizeof(struct ssp_task_iu) / sizeof(u32);
402 }
403
404
405 /**
406 * This method constructs the SSP Command IU data for this ssp passthrough
407 * comand request object.
408 * @sci_req: This parameter specifies the request object for which the SSP
409 * command information unit is being built.
410 *
411 * enum sci_status, returns invalid parameter is cdb > 16
412 */
413
414
415 /**
416 * This method constructs the SATA request object.
417 * @sci_req:
418 * @sat_protocol:
419 * @transfer_length:
420 * @data_direction:
421 * @copy_rx_frame:
422 *
423 * enum sci_status
424 */
425 static enum sci_status
426 scic_io_request_construct_sata(struct scic_sds_request *sci_req,
427 u32 len,
428 enum dma_data_direction dir,
429 bool copy)
430 {
431 enum sci_status status = SCI_SUCCESS;
432 struct isci_request *ireq = sci_req->ireq;
433 struct sas_task *task = isci_request_access_task(ireq);
434
435 /* check for management protocols */
436 if (ireq->ttype == tmf_task) {
437 struct isci_tmf *tmf = isci_request_access_tmf(ireq);
438
439 if (tmf->tmf_code == isci_tmf_sata_srst_high ||
440 tmf->tmf_code == isci_tmf_sata_srst_low)
441 return scic_sds_stp_soft_reset_request_construct(sci_req);
442 else {
443 dev_err(scic_to_dev(sci_req->owning_controller),
444 "%s: Request 0x%p received un-handled SAT "
445 "management protocol 0x%x.\n",
446 __func__, sci_req, tmf->tmf_code);
447
448 return SCI_FAILURE;
449 }
450 }
451
452 if (!sas_protocol_ata(task->task_proto)) {
453 dev_err(scic_to_dev(sci_req->owning_controller),
454 "%s: Non-ATA protocol in SATA path: 0x%x\n",
455 __func__,
456 task->task_proto);
457 return SCI_FAILURE;
458
459 }
460
461 /* non data */
462 if (task->data_dir == DMA_NONE)
463 return scic_sds_stp_non_data_request_construct(sci_req);
464
465 /* NCQ */
466 if (task->ata_task.use_ncq)
467 return scic_sds_stp_ncq_request_construct(sci_req, len, dir);
468
469 /* DMA */
470 if (task->ata_task.dma_xfer)
471 return scic_sds_stp_udma_request_construct(sci_req, len, dir);
472 else /* PIO */
473 return scic_sds_stp_pio_request_construct(sci_req, copy);
474
475 return status;
476 }
477
478 enum sci_status scic_io_request_construct_basic_ssp(
479 struct scic_sds_request *sci_req)
480 {
481 struct isci_request *ireq = sci_req->ireq;
482 struct sas_task *task = isci_request_access_task(ireq);
483
484 sci_req->protocol = SCIC_SSP_PROTOCOL;
485
486 scu_ssp_io_request_construct_task_context(sci_req,
487 task->data_dir,
488 task->total_xfer_len);
489
490 scic_sds_io_request_build_ssp_command_iu(sci_req);
491
492 sci_base_state_machine_change_state(
493 &sci_req->state_machine,
494 SCI_BASE_REQUEST_STATE_CONSTRUCTED);
495
496 return SCI_SUCCESS;
497 }
498
499
500 enum sci_status scic_task_request_construct_ssp(
501 struct scic_sds_request *sci_req)
502 {
503 /* Construct the SSP Task SCU Task Context */
504 scu_ssp_task_request_construct_task_context(sci_req);
505
506 /* Fill in the SSP Task IU */
507 scic_sds_task_request_build_ssp_task_iu(sci_req);
508
509 sci_base_state_machine_change_state(&sci_req->state_machine,
510 SCI_BASE_REQUEST_STATE_CONSTRUCTED);
511
512 return SCI_SUCCESS;
513 }
514
515
516 enum sci_status scic_io_request_construct_basic_sata(
517 struct scic_sds_request *sci_req)
518 {
519 enum sci_status status;
520 struct scic_sds_stp_request *stp_req;
521 bool copy = false;
522 struct isci_request *isci_request = sci_req->ireq;
523 struct sas_task *task = isci_request_access_task(isci_request);
524
525 stp_req = &sci_req->stp.req;
526 sci_req->protocol = SCIC_STP_PROTOCOL;
527
528 copy = (task->data_dir == DMA_NONE) ? false : true;
529
530 status = scic_io_request_construct_sata(sci_req,
531 task->total_xfer_len,
532 task->data_dir,
533 copy);
534
535 if (status == SCI_SUCCESS)
536 sci_base_state_machine_change_state(&sci_req->state_machine,
537 SCI_BASE_REQUEST_STATE_CONSTRUCTED);
538
539 return status;
540 }
541
542
543 enum sci_status scic_task_request_construct_sata(
544 struct scic_sds_request *sci_req)
545 {
546 enum sci_status status = SCI_SUCCESS;
547 struct isci_request *ireq = sci_req->ireq;
548
549 /* check for management protocols */
550 if (ireq->ttype == tmf_task) {
551 struct isci_tmf *tmf = isci_request_access_tmf(ireq);
552
553 if (tmf->tmf_code == isci_tmf_sata_srst_high ||
554 tmf->tmf_code == isci_tmf_sata_srst_low) {
555 status = scic_sds_stp_soft_reset_request_construct(sci_req);
556 } else {
557 dev_err(scic_to_dev(sci_req->owning_controller),
558 "%s: Request 0x%p received un-handled SAT "
559 "Protocol 0x%x.\n",
560 __func__, sci_req, tmf->tmf_code);
561
562 return SCI_FAILURE;
563 }
564 }
565
566 if (status == SCI_SUCCESS)
567 sci_base_state_machine_change_state(
568 &sci_req->state_machine,
569 SCI_BASE_REQUEST_STATE_CONSTRUCTED);
570
571 return status;
572 }
573
574
575 u16 scic_io_request_get_io_tag(
576 struct scic_sds_request *sci_req)
577 {
578 return sci_req->io_tag;
579 }
580
581
582 u32 scic_request_get_controller_status(
583 struct scic_sds_request *sci_req)
584 {
585 return sci_req->scu_status;
586 }
587
588 #define SCU_TASK_CONTEXT_SRAM 0x200000
589 u32 scic_io_request_get_number_of_bytes_transferred(
590 struct scic_sds_request *scic_sds_request)
591 {
592 struct scic_sds_controller *scic = scic_sds_request->owning_controller;
593 u32 ret_val = 0;
594
595 if (readl(&scic->smu_registers->address_modifier) == 0) {
596 void __iomem *scu_reg_base = scic->scu_registers;
597 /*
598 * get the bytes of data from the Address == BAR1 + 20002Ch + (256*TCi) where
599 * BAR1 is the scu_registers
600 * 0x20002C = 0x200000 + 0x2c
601 * = start of task context SRAM + offset of (type.ssp.data_offset)
602 * TCi is the io_tag of struct scic_sds_request */
603 ret_val = readl(scu_reg_base +
604 (SCU_TASK_CONTEXT_SRAM + offsetof(struct scu_task_context, type.ssp.data_offset)) +
605 ((sizeof(struct scu_task_context)) * scic_sds_io_tag_get_index(scic_sds_request->io_tag)));
606 }
607
608 return ret_val;
609 }
610
611
612 /*
613 * ****************************************************************************
614 * * SCIC SDS Interface Implementation
615 * **************************************************************************** */
616
617 enum sci_status
618 scic_sds_request_start(struct scic_sds_request *request)
619 {
620 if (request->device_sequence !=
621 scic_sds_remote_device_get_sequence(request->target_device))
622 return SCI_FAILURE;
623
624 if (request->state_handlers->start_handler)
625 return request->state_handlers->start_handler(request);
626
627 dev_warn(scic_to_dev(request->owning_controller),
628 "%s: SCIC IO Request requested to start while in wrong "
629 "state %d\n",
630 __func__,
631 sci_base_state_machine_get_state(&request->state_machine));
632
633 return SCI_FAILURE_INVALID_STATE;
634 }
635
636 enum sci_status
637 scic_sds_io_request_terminate(struct scic_sds_request *request)
638 {
639 if (request->state_handlers->abort_handler)
640 return request->state_handlers->abort_handler(request);
641
642 dev_warn(scic_to_dev(request->owning_controller),
643 "%s: SCIC IO Request requested to abort while in wrong "
644 "state %d\n",
645 __func__,
646 sci_base_state_machine_get_state(&request->state_machine));
647
648 return SCI_FAILURE_INVALID_STATE;
649 }
650
651 enum sci_status
652 scic_sds_io_request_complete(struct scic_sds_request *request)
653 {
654 if (request->state_handlers->complete_handler)
655 return request->state_handlers->complete_handler(request);
656
657 dev_warn(scic_to_dev(request->owning_controller),
658 "%s: SCIC IO Request requested to complete while in wrong "
659 "state %d\n",
660 __func__,
661 sci_base_state_machine_get_state(&request->state_machine));
662
663 return SCI_FAILURE_INVALID_STATE;
664 }
665
666 enum sci_status scic_sds_io_request_event_handler(
667 struct scic_sds_request *request,
668 u32 event_code)
669 {
670 if (request->state_handlers->event_handler)
671 return request->state_handlers->event_handler(request, event_code);
672
673 dev_warn(scic_to_dev(request->owning_controller),
674 "%s: SCIC IO Request given event code notification %x while "
675 "in wrong state %d\n",
676 __func__,
677 event_code,
678 sci_base_state_machine_get_state(&request->state_machine));
679
680 return SCI_FAILURE_INVALID_STATE;
681 }
682
683 enum sci_status
684 scic_sds_io_request_tc_completion(struct scic_sds_request *request, u32 completion_code)
685 {
686 if (request->state_machine.current_state_id == SCI_BASE_REQUEST_STATE_STARTED &&
687 request->has_started_substate_machine == false)
688 return scic_sds_request_started_state_tc_completion_handler(request, completion_code);
689 else if (request->state_handlers->tc_completion_handler)
690 return request->state_handlers->tc_completion_handler(request, completion_code);
691
692 dev_warn(scic_to_dev(request->owning_controller),
693 "%s: SCIC IO Request given task completion notification %x "
694 "while in wrong state %d\n",
695 __func__,
696 completion_code,
697 sci_base_state_machine_get_state(&request->state_machine));
698
699 return SCI_FAILURE_INVALID_STATE;
700
701 }
702
703
704 /**
705 *
706 * @sci_req: The SCIC_SDS_IO_REQUEST_T object for which the start
707 * operation is to be executed.
708 * @frame_index: The frame index returned by the hardware for the reqeust
709 * object.
710 *
711 * This method invokes the core state frame handler for the
712 * SCIC_SDS_IO_REQUEST_T object. enum sci_status
713 */
714 enum sci_status scic_sds_io_request_frame_handler(
715 struct scic_sds_request *request,
716 u32 frame_index)
717 {
718 if (request->state_handlers->frame_handler)
719 return request->state_handlers->frame_handler(request, frame_index);
720
721 dev_warn(scic_to_dev(request->owning_controller),
722 "%s: SCIC IO Request given unexpected frame %x while in "
723 "state %d\n",
724 __func__,
725 frame_index,
726 sci_base_state_machine_get_state(&request->state_machine));
727
728 scic_sds_controller_release_frame(request->owning_controller, frame_index);
729 return SCI_FAILURE_INVALID_STATE;
730 }
731
732 /*
733 * This function copies response data for requests returning response data
734 * instead of sense data.
735 * @sci_req: This parameter specifies the request object for which to copy
736 * the response data.
737 */
738 void scic_sds_io_request_copy_response(struct scic_sds_request *sci_req)
739 {
740 void *resp_buf;
741 u32 len;
742 struct ssp_response_iu *ssp_response;
743 struct isci_request *ireq = sci_req->ireq;
744 struct isci_tmf *isci_tmf = isci_request_access_tmf(ireq);
745
746 ssp_response = &sci_req->ssp.rsp;
747
748 resp_buf = &isci_tmf->resp.resp_iu;
749
750 len = min_t(u32,
751 SSP_RESP_IU_MAX_SIZE,
752 be32_to_cpu(ssp_response->response_data_len));
753
754 memcpy(resp_buf, ssp_response->resp_data, len);
755 }
756
757 /*
758 * *****************************************************************************
759 * * CONSTRUCTED STATE HANDLERS
760 * ***************************************************************************** */
761
762 /*
763 * This method implements the action taken when a constructed
764 * SCIC_SDS_IO_REQUEST_T object receives a scic_sds_request_start() request.
765 * This method will, if necessary, allocate a TCi for the io request object and
766 * then will, if necessary, copy the constructed TC data into the actual TC
767 * buffer. If everything is successful the post context field is updated with
768 * the TCi so the controller can post the request to the hardware. enum sci_status
769 * SCI_SUCCESS SCI_FAILURE_INSUFFICIENT_RESOURCES
770 */
771 static enum sci_status scic_sds_request_constructed_state_start_handler(
772 struct scic_sds_request *request)
773 {
774 struct scu_task_context *task_context;
775
776 if (request->io_tag == SCI_CONTROLLER_INVALID_IO_TAG) {
777 request->io_tag =
778 scic_controller_allocate_io_tag(request->owning_controller);
779 }
780
781 /* Record the IO Tag in the request */
782 if (request->io_tag != SCI_CONTROLLER_INVALID_IO_TAG) {
783 task_context = request->task_context_buffer;
784
785 task_context->task_index = scic_sds_io_tag_get_index(request->io_tag);
786
787 switch (task_context->protocol_type) {
788 case SCU_TASK_CONTEXT_PROTOCOL_SMP:
789 case SCU_TASK_CONTEXT_PROTOCOL_SSP:
790 /* SSP/SMP Frame */
791 task_context->type.ssp.tag = request->io_tag;
792 task_context->type.ssp.target_port_transfer_tag = 0xFFFF;
793 break;
794
795 case SCU_TASK_CONTEXT_PROTOCOL_STP:
796 /*
797 * STP/SATA Frame
798 * task_context->type.stp.ncq_tag = request->ncq_tag; */
799 break;
800
801 case SCU_TASK_CONTEXT_PROTOCOL_NONE:
802 /* / @todo When do we set no protocol type? */
803 break;
804
805 default:
806 /* This should never happen since we build the IO requests */
807 break;
808 }
809
810 /*
811 * Check to see if we need to copy the task context buffer
812 * or have been building into the task context buffer */
813 if (request->was_tag_assigned_by_user == false) {
814 scic_sds_controller_copy_task_context(
815 request->owning_controller, request);
816 }
817
818 /* Add to the post_context the io tag value */
819 request->post_context |= scic_sds_io_tag_get_index(request->io_tag);
820
821 /* Everything is good go ahead and change state */
822 sci_base_state_machine_change_state(&request->state_machine,
823 SCI_BASE_REQUEST_STATE_STARTED);
824
825 return SCI_SUCCESS;
826 }
827
828 return SCI_FAILURE_INSUFFICIENT_RESOURCES;
829 }
830
831 /*
832 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
833 * object receives a scic_sds_request_terminate() request. Since the request
834 * has not yet been posted to the hardware the request transitions to the
835 * completed state. enum sci_status SCI_SUCCESS
836 */
837 static enum sci_status scic_sds_request_constructed_state_abort_handler(
838 struct scic_sds_request *request)
839 {
840 /*
841 * This request has been terminated by the user make sure that the correct
842 * status code is returned */
843 scic_sds_request_set_status(request,
844 SCU_TASK_DONE_TASK_ABORT,
845 SCI_FAILURE_IO_TERMINATED);
846
847 sci_base_state_machine_change_state(&request->state_machine,
848 SCI_BASE_REQUEST_STATE_COMPLETED);
849 return SCI_SUCCESS;
850 }
851
852 /*
853 * *****************************************************************************
854 * * STARTED STATE HANDLERS
855 * ***************************************************************************** */
856
857 /*
858 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
859 * object receives a scic_sds_request_terminate() request. Since the request
860 * has been posted to the hardware the io request state is changed to the
861 * aborting state. enum sci_status SCI_SUCCESS
862 */
863 enum sci_status scic_sds_request_started_state_abort_handler(
864 struct scic_sds_request *request)
865 {
866 if (request->has_started_substate_machine)
867 sci_base_state_machine_stop(&request->started_substate_machine);
868
869 sci_base_state_machine_change_state(&request->state_machine,
870 SCI_BASE_REQUEST_STATE_ABORTING);
871 return SCI_SUCCESS;
872 }
873
874 /*
875 * scic_sds_request_started_state_tc_completion_handler() - This method process
876 * TC (task context) completions for normal IO request (i.e. Task/Abort
877 * Completions of type 0). This method will update the
878 * SCIC_SDS_IO_REQUEST_T::status field.
879 * @sci_req: This parameter specifies the request for which a completion
880 * occurred.
881 * @completion_code: This parameter specifies the completion code received from
882 * the SCU.
883 *
884 */
885 enum sci_status
886 scic_sds_request_started_state_tc_completion_handler(
887 struct scic_sds_request *sci_req,
888 u32 completion_code)
889 {
890 u8 datapres;
891 struct ssp_response_iu *resp_iu;
892
893 /*
894 * TODO: Any SDMA return code of other than 0 is bad
895 * decode 0x003C0000 to determine SDMA status
896 */
897 switch (SCU_GET_COMPLETION_TL_STATUS(completion_code)) {
898 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_GOOD):
899 scic_sds_request_set_status(sci_req,
900 SCU_TASK_DONE_GOOD,
901 SCI_SUCCESS);
902 break;
903
904 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_EARLY_RESP):
905 {
906 /*
907 * There are times when the SCU hardware will return an early
908 * response because the io request specified more data than is
909 * returned by the target device (mode pages, inquiry data,
910 * etc.). We must check the response stats to see if this is
911 * truly a failed request or a good request that just got
912 * completed early.
913 */
914 struct ssp_response_iu *resp = &sci_req->ssp.rsp;
915 ssize_t word_cnt = SSP_RESP_IU_MAX_SIZE / sizeof(u32);
916
917 sci_swab32_cpy(&sci_req->ssp.rsp,
918 &sci_req->ssp.rsp,
919 word_cnt);
920
921 if (resp->status == 0) {
922 scic_sds_request_set_status(
923 sci_req,
924 SCU_TASK_DONE_GOOD,
925 SCI_SUCCESS_IO_DONE_EARLY);
926 } else {
927 scic_sds_request_set_status(
928 sci_req,
929 SCU_TASK_DONE_CHECK_RESPONSE,
930 SCI_FAILURE_IO_RESPONSE_VALID);
931 }
932 }
933 break;
934
935 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_CHECK_RESPONSE):
936 {
937 ssize_t word_cnt = SSP_RESP_IU_MAX_SIZE / sizeof(u32);
938
939 sci_swab32_cpy(&sci_req->ssp.rsp,
940 &sci_req->ssp.rsp,
941 word_cnt);
942
943 scic_sds_request_set_status(sci_req,
944 SCU_TASK_DONE_CHECK_RESPONSE,
945 SCI_FAILURE_IO_RESPONSE_VALID);
946 break;
947 }
948
949 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_RESP_LEN_ERR):
950 /*
951 * / @todo With TASK_DONE_RESP_LEN_ERR is the response frame
952 * guaranteed to be received before this completion status is
953 * posted?
954 */
955 resp_iu = &sci_req->ssp.rsp;
956 datapres = resp_iu->datapres;
957
958 if ((datapres == 0x01) || (datapres == 0x02)) {
959 scic_sds_request_set_status(
960 sci_req,
961 SCU_TASK_DONE_CHECK_RESPONSE,
962 SCI_FAILURE_IO_RESPONSE_VALID);
963 } else
964 scic_sds_request_set_status(
965 sci_req, SCU_TASK_DONE_GOOD, SCI_SUCCESS);
966 break;
967
968 /* only stp device gets suspended. */
969 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_ACK_NAK_TO):
970 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_LL_PERR):
971 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_NAK_ERR):
972 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_DATA_LEN_ERR):
973 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_LL_ABORT_ERR):
974 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_XR_WD_LEN):
975 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_MAX_PLD_ERR):
976 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_UNEXP_RESP):
977 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_UNEXP_SDBFIS):
978 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_REG_ERR):
979 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SDB_ERR):
980 if (sci_req->protocol == SCIC_STP_PROTOCOL) {
981 scic_sds_request_set_status(
982 sci_req,
983 SCU_GET_COMPLETION_TL_STATUS(completion_code) >>
984 SCU_COMPLETION_TL_STATUS_SHIFT,
985 SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED);
986 } else {
987 scic_sds_request_set_status(
988 sci_req,
989 SCU_GET_COMPLETION_TL_STATUS(completion_code) >>
990 SCU_COMPLETION_TL_STATUS_SHIFT,
991 SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR);
992 }
993 break;
994
995 /* both stp/ssp device gets suspended */
996 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_LF_ERR):
997 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_WRONG_DESTINATION):
998 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1):
999 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2):
1000 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3):
1001 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_BAD_DESTINATION):
1002 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_ZONE_VIOLATION):
1003 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY):
1004 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED):
1005 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED):
1006 scic_sds_request_set_status(
1007 sci_req,
1008 SCU_GET_COMPLETION_TL_STATUS(completion_code) >>
1009 SCU_COMPLETION_TL_STATUS_SHIFT,
1010 SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED);
1011 break;
1012
1013 /* neither ssp nor stp gets suspended. */
1014 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_NAK_CMD_ERR):
1015 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_UNEXP_XR):
1016 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_XR_IU_LEN_ERR):
1017 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SDMA_ERR):
1018 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_OFFSET_ERR):
1019 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_EXCESS_DATA):
1020 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SMP_RESP_TO_ERR):
1021 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SMP_UFI_ERR):
1022 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SMP_FRM_TYPE_ERR):
1023 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_SMP_LL_RX_ERR):
1024 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_UNEXP_DATA):
1025 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_OPEN_FAIL):
1026 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_VIIT_ENTRY_NV):
1027 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_IIT_ENTRY_NV):
1028 case SCU_MAKE_COMPLETION_STATUS(SCU_TASK_DONE_RNCNV_OUTBOUND):
1029 default:
1030 scic_sds_request_set_status(
1031 sci_req,
1032 SCU_GET_COMPLETION_TL_STATUS(completion_code) >>
1033 SCU_COMPLETION_TL_STATUS_SHIFT,
1034 SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR);
1035 break;
1036 }
1037
1038 /*
1039 * TODO: This is probably wrong for ACK/NAK timeout conditions
1040 */
1041
1042 /* In all cases we will treat this as the completion of the IO req. */
1043 sci_base_state_machine_change_state(
1044 &sci_req->state_machine,
1045 SCI_BASE_REQUEST_STATE_COMPLETED);
1046 return SCI_SUCCESS;
1047 }
1048
1049 /*
1050 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
1051 * object receives a scic_sds_request_frame_handler() request. This method
1052 * first determines the frame type received. If this is a response frame then
1053 * the response data is copied to the io request response buffer for processing
1054 * at completion time. If the frame type is not a response buffer an error is
1055 * logged. enum sci_status SCI_SUCCESS SCI_FAILURE_INVALID_PARAMETER_VALUE
1056 */
1057 static enum sci_status
1058 scic_sds_request_started_state_frame_handler(struct scic_sds_request *sci_req,
1059 u32 frame_index)
1060 {
1061 enum sci_status status;
1062 u32 *frame_header;
1063 struct ssp_frame_hdr ssp_hdr;
1064 ssize_t word_cnt;
1065
1066 status = scic_sds_unsolicited_frame_control_get_header(
1067 &(scic_sds_request_get_controller(sci_req)->uf_control),
1068 frame_index,
1069 (void **)&frame_header);
1070
1071 word_cnt = sizeof(struct ssp_frame_hdr) / sizeof(u32);
1072 sci_swab32_cpy(&ssp_hdr, frame_header, word_cnt);
1073
1074 if (ssp_hdr.frame_type == SSP_RESPONSE) {
1075 struct ssp_response_iu *resp_iu;
1076 ssize_t word_cnt = SSP_RESP_IU_MAX_SIZE / sizeof(u32);
1077
1078 status = scic_sds_unsolicited_frame_control_get_buffer(
1079 &(scic_sds_request_get_controller(sci_req)->uf_control),
1080 frame_index,
1081 (void **)&resp_iu);
1082
1083 sci_swab32_cpy(&sci_req->ssp.rsp,
1084 resp_iu, word_cnt);
1085
1086 resp_iu = &sci_req->ssp.rsp;
1087
1088 if ((resp_iu->datapres == 0x01) ||
1089 (resp_iu->datapres == 0x02)) {
1090 scic_sds_request_set_status(
1091 sci_req,
1092 SCU_TASK_DONE_CHECK_RESPONSE,
1093 SCI_FAILURE_CONTROLLER_SPECIFIC_IO_ERR);
1094 } else
1095 scic_sds_request_set_status(
1096 sci_req, SCU_TASK_DONE_GOOD, SCI_SUCCESS);
1097 } else {
1098 /* This was not a response frame why did it get forwarded? */
1099 dev_err(scic_to_dev(sci_req->owning_controller),
1100 "%s: SCIC IO Request 0x%p received unexpected "
1101 "frame %d type 0x%02x\n",
1102 __func__,
1103 sci_req,
1104 frame_index,
1105 ssp_hdr.frame_type);
1106 }
1107
1108 /*
1109 * In any case we are done with this frame buffer return it to the
1110 * controller
1111 */
1112 scic_sds_controller_release_frame(
1113 sci_req->owning_controller, frame_index);
1114
1115 return SCI_SUCCESS;
1116 }
1117
1118 /*
1119 * *****************************************************************************
1120 * * COMPLETED STATE HANDLERS
1121 * ***************************************************************************** */
1122
1123
1124 /*
1125 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
1126 * object receives a scic_sds_request_complete() request. This method frees up
1127 * any io request resources that have been allocated and transitions the
1128 * request to its final state. Consider stopping the state machine instead of
1129 * transitioning to the final state? enum sci_status SCI_SUCCESS
1130 */
1131 static enum sci_status scic_sds_request_completed_state_complete_handler(
1132 struct scic_sds_request *request)
1133 {
1134 if (request->was_tag_assigned_by_user != true) {
1135 scic_controller_free_io_tag(
1136 request->owning_controller, request->io_tag);
1137 }
1138
1139 if (request->saved_rx_frame_index != SCU_INVALID_FRAME_INDEX) {
1140 scic_sds_controller_release_frame(
1141 request->owning_controller, request->saved_rx_frame_index);
1142 }
1143
1144 sci_base_state_machine_change_state(&request->state_machine,
1145 SCI_BASE_REQUEST_STATE_FINAL);
1146 return SCI_SUCCESS;
1147 }
1148
1149 /*
1150 * *****************************************************************************
1151 * * ABORTING STATE HANDLERS
1152 * ***************************************************************************** */
1153
1154 /*
1155 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
1156 * object receives a scic_sds_request_terminate() request. This method is the
1157 * io request aborting state abort handlers. On receipt of a multiple
1158 * terminate requests the io request will transition to the completed state.
1159 * This should not happen in normal operation. enum sci_status SCI_SUCCESS
1160 */
1161 static enum sci_status scic_sds_request_aborting_state_abort_handler(
1162 struct scic_sds_request *request)
1163 {
1164 sci_base_state_machine_change_state(&request->state_machine,
1165 SCI_BASE_REQUEST_STATE_COMPLETED);
1166 return SCI_SUCCESS;
1167 }
1168
1169 /*
1170 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
1171 * object receives a scic_sds_request_task_completion() request. This method
1172 * decodes the completion type waiting for the abort task complete
1173 * notification. When the abort task complete is received the io request
1174 * transitions to the completed state. enum sci_status SCI_SUCCESS
1175 */
1176 static enum sci_status scic_sds_request_aborting_state_tc_completion_handler(
1177 struct scic_sds_request *sci_req,
1178 u32 completion_code)
1179 {
1180 switch (SCU_GET_COMPLETION_TL_STATUS(completion_code)) {
1181 case (SCU_TASK_DONE_GOOD << SCU_COMPLETION_TL_STATUS_SHIFT):
1182 case (SCU_TASK_DONE_TASK_ABORT << SCU_COMPLETION_TL_STATUS_SHIFT):
1183 scic_sds_request_set_status(
1184 sci_req, SCU_TASK_DONE_TASK_ABORT, SCI_FAILURE_IO_TERMINATED
1185 );
1186
1187 sci_base_state_machine_change_state(&sci_req->state_machine,
1188 SCI_BASE_REQUEST_STATE_COMPLETED);
1189 break;
1190
1191 default:
1192 /*
1193 * Unless we get some strange error wait for the task abort to complete
1194 * TODO: Should there be a state change for this completion? */
1195 break;
1196 }
1197
1198 return SCI_SUCCESS;
1199 }
1200
1201 /*
1202 * This method implements the action to be taken when an SCIC_SDS_IO_REQUEST_T
1203 * object receives a scic_sds_request_frame_handler() request. This method
1204 * discards the unsolicited frame since we are waiting for the abort task
1205 * completion. enum sci_status SCI_SUCCESS
1206 */
1207 static enum sci_status scic_sds_request_aborting_state_frame_handler(
1208 struct scic_sds_request *sci_req,
1209 u32 frame_index)
1210 {
1211 /* TODO: Is it even possible to get an unsolicited frame in the aborting state? */
1212
1213 scic_sds_controller_release_frame(
1214 sci_req->owning_controller, frame_index);
1215
1216 return SCI_SUCCESS;
1217 }
1218
1219 static const struct scic_sds_io_request_state_handler scic_sds_request_state_handler_table[] = {
1220 [SCI_BASE_REQUEST_STATE_INITIAL] = {
1221 },
1222 [SCI_BASE_REQUEST_STATE_CONSTRUCTED] = {
1223 .start_handler = scic_sds_request_constructed_state_start_handler,
1224 .abort_handler = scic_sds_request_constructed_state_abort_handler,
1225 },
1226 [SCI_BASE_REQUEST_STATE_STARTED] = {
1227 .abort_handler = scic_sds_request_started_state_abort_handler,
1228 .tc_completion_handler = scic_sds_request_started_state_tc_completion_handler,
1229 .frame_handler = scic_sds_request_started_state_frame_handler,
1230 },
1231 [SCI_BASE_REQUEST_STATE_COMPLETED] = {
1232 .complete_handler = scic_sds_request_completed_state_complete_handler,
1233 },
1234 [SCI_BASE_REQUEST_STATE_ABORTING] = {
1235 .abort_handler = scic_sds_request_aborting_state_abort_handler,
1236 .tc_completion_handler = scic_sds_request_aborting_state_tc_completion_handler,
1237 .frame_handler = scic_sds_request_aborting_state_frame_handler,
1238 },
1239 [SCI_BASE_REQUEST_STATE_FINAL] = {
1240 },
1241 };
1242
1243 /**
1244 * scic_sds_request_initial_state_enter() -
1245 * @object: This parameter specifies the base object for which the state
1246 * transition is occurring.
1247 *
1248 * This method implements the actions taken when entering the
1249 * SCI_BASE_REQUEST_STATE_INITIAL state. This state is entered when the initial
1250 * base request is constructed. Entry into the initial state sets all handlers
1251 * for the io request object to their default handlers. none
1252 */
1253 static void scic_sds_request_initial_state_enter(void *object)
1254 {
1255 struct scic_sds_request *sci_req = object;
1256
1257 SET_STATE_HANDLER(
1258 sci_req,
1259 scic_sds_request_state_handler_table,
1260 SCI_BASE_REQUEST_STATE_INITIAL
1261 );
1262 }
1263
1264 /**
1265 * scic_sds_request_constructed_state_enter() -
1266 * @object: The io request object that is to enter the constructed state.
1267 *
1268 * This method implements the actions taken when entering the
1269 * SCI_BASE_REQUEST_STATE_CONSTRUCTED state. The method sets the state handlers
1270 * for the the constructed state. none
1271 */
1272 static void scic_sds_request_constructed_state_enter(void *object)
1273 {
1274 struct scic_sds_request *sci_req = object;
1275
1276 SET_STATE_HANDLER(
1277 sci_req,
1278 scic_sds_request_state_handler_table,
1279 SCI_BASE_REQUEST_STATE_CONSTRUCTED
1280 );
1281 }
1282
1283 /**
1284 * scic_sds_request_started_state_enter() -
1285 * @object: This parameter specifies the base object for which the state
1286 * transition is occurring. This is cast into a SCIC_SDS_IO_REQUEST object.
1287 *
1288 * This method implements the actions taken when entering the
1289 * SCI_BASE_REQUEST_STATE_STARTED state. If the io request object type is a
1290 * SCSI Task request we must enter the started substate machine. none
1291 */
1292 static void scic_sds_request_started_state_enter(void *object)
1293 {
1294 struct scic_sds_request *sci_req = object;
1295
1296 SET_STATE_HANDLER(
1297 sci_req,
1298 scic_sds_request_state_handler_table,
1299 SCI_BASE_REQUEST_STATE_STARTED
1300 );
1301
1302 /*
1303 * Most of the request state machines have a started substate machine so
1304 * start its execution on the entry to the started state. */
1305 if (sci_req->has_started_substate_machine == true)
1306 sci_base_state_machine_start(&sci_req->started_substate_machine);
1307 }
1308
1309 /**
1310 * scic_sds_request_started_state_exit() -
1311 * @object: This parameter specifies the base object for which the state
1312 * transition is occurring. This object is cast into a SCIC_SDS_IO_REQUEST
1313 * object.
1314 *
1315 * This method implements the actions taken when exiting the
1316 * SCI_BASE_REQUEST_STATE_STARTED state. For task requests the action will be
1317 * to stop the started substate machine. none
1318 */
1319 static void scic_sds_request_started_state_exit(void *object)
1320 {
1321 struct scic_sds_request *sci_req = object;
1322
1323 if (sci_req->has_started_substate_machine == true)
1324 sci_base_state_machine_stop(&sci_req->started_substate_machine);
1325 }
1326
1327 /**
1328 * scic_sds_request_completed_state_enter() -
1329 * @object: This parameter specifies the base object for which the state
1330 * transition is occurring. This object is cast into a SCIC_SDS_IO_REQUEST
1331 * object.
1332 *
1333 * This method implements the actions taken when entering the
1334 * SCI_BASE_REQUEST_STATE_COMPLETED state. This state is entered when the
1335 * SCIC_SDS_IO_REQUEST has completed. The method will decode the request
1336 * completion status and convert it to an enum sci_status to return in the
1337 * completion callback function. none
1338 */
1339 static void scic_sds_request_completed_state_enter(void *object)
1340 {
1341 struct scic_sds_request *sci_req = object;
1342 struct scic_sds_controller *scic =
1343 scic_sds_request_get_controller(sci_req);
1344 struct isci_host *ihost = scic_to_ihost(scic);
1345 struct isci_request *ireq = sci_req->ireq;
1346
1347 SET_STATE_HANDLER(sci_req,
1348 scic_sds_request_state_handler_table,
1349 SCI_BASE_REQUEST_STATE_COMPLETED);
1350
1351 /* Tell the SCI_USER that the IO request is complete */
1352 if (sci_req->is_task_management_request == false)
1353 isci_request_io_request_complete(ihost,
1354 ireq,
1355 sci_req->sci_status);
1356 else
1357 isci_task_request_complete(ihost, ireq, sci_req->sci_status);
1358 }
1359
1360 /**
1361 * scic_sds_request_aborting_state_enter() -
1362 * @object: This parameter specifies the base object for which the state
1363 * transition is occurring. This object is cast into a SCIC_SDS_IO_REQUEST
1364 * object.
1365 *
1366 * This method implements the actions taken when entering the
1367 * SCI_BASE_REQUEST_STATE_ABORTING state. none
1368 */
1369 static void scic_sds_request_aborting_state_enter(void *object)
1370 {
1371 struct scic_sds_request *sci_req = object;
1372
1373 /* Setting the abort bit in the Task Context is required by the silicon. */
1374 sci_req->task_context_buffer->abort = 1;
1375
1376 SET_STATE_HANDLER(
1377 sci_req,
1378 scic_sds_request_state_handler_table,
1379 SCI_BASE_REQUEST_STATE_ABORTING
1380 );
1381 }
1382
1383 /**
1384 * scic_sds_request_final_state_enter() -
1385 * @object: This parameter specifies the base object for which the state
1386 * transition is occurring. This is cast into a SCIC_SDS_IO_REQUEST object.
1387 *
1388 * This method implements the actions taken when entering the
1389 * SCI_BASE_REQUEST_STATE_FINAL state. The only action required is to put the
1390 * state handlers in place. none
1391 */
1392 static void scic_sds_request_final_state_enter(void *object)
1393 {
1394 struct scic_sds_request *sci_req = object;
1395
1396 SET_STATE_HANDLER(
1397 sci_req,
1398 scic_sds_request_state_handler_table,
1399 SCI_BASE_REQUEST_STATE_FINAL
1400 );
1401 }
1402
1403 static const struct sci_base_state scic_sds_request_state_table[] = {
1404 [SCI_BASE_REQUEST_STATE_INITIAL] = {
1405 .enter_state = scic_sds_request_initial_state_enter,
1406 },
1407 [SCI_BASE_REQUEST_STATE_CONSTRUCTED] = {
1408 .enter_state = scic_sds_request_constructed_state_enter,
1409 },
1410 [SCI_BASE_REQUEST_STATE_STARTED] = {
1411 .enter_state = scic_sds_request_started_state_enter,
1412 .exit_state = scic_sds_request_started_state_exit
1413 },
1414 [SCI_BASE_REQUEST_STATE_COMPLETED] = {
1415 .enter_state = scic_sds_request_completed_state_enter,
1416 },
1417 [SCI_BASE_REQUEST_STATE_ABORTING] = {
1418 .enter_state = scic_sds_request_aborting_state_enter,
1419 },
1420 [SCI_BASE_REQUEST_STATE_FINAL] = {
1421 .enter_state = scic_sds_request_final_state_enter,
1422 },
1423 };
1424
1425 static void scic_sds_general_request_construct(struct scic_sds_controller *scic,
1426 struct scic_sds_remote_device *sci_dev,
1427 u16 io_tag,
1428 void *user_io_request_object,
1429 struct scic_sds_request *sci_req)
1430 {
1431 sci_base_state_machine_construct(&sci_req->state_machine, sci_req,
1432 scic_sds_request_state_table, SCI_BASE_REQUEST_STATE_INITIAL);
1433 sci_base_state_machine_start(&sci_req->state_machine);
1434
1435 sci_req->io_tag = io_tag;
1436 sci_req->user_request = user_io_request_object;
1437 sci_req->owning_controller = scic;
1438 sci_req->target_device = sci_dev;
1439 sci_req->has_started_substate_machine = false;
1440 sci_req->protocol = SCIC_NO_PROTOCOL;
1441 sci_req->saved_rx_frame_index = SCU_INVALID_FRAME_INDEX;
1442 sci_req->device_sequence = scic_sds_remote_device_get_sequence(sci_dev);
1443
1444 sci_req->sci_status = SCI_SUCCESS;
1445 sci_req->scu_status = 0;
1446 sci_req->post_context = 0xFFFFFFFF;
1447
1448 sci_req->is_task_management_request = false;
1449
1450 if (io_tag == SCI_CONTROLLER_INVALID_IO_TAG) {
1451 sci_req->was_tag_assigned_by_user = false;
1452 sci_req->task_context_buffer = NULL;
1453 } else {
1454 sci_req->was_tag_assigned_by_user = true;
1455
1456 sci_req->task_context_buffer =
1457 scic_sds_controller_get_task_context_buffer(scic, io_tag);
1458 }
1459 }
1460
1461 enum sci_status
1462 scic_io_request_construct(struct scic_sds_controller *scic,
1463 struct scic_sds_remote_device *sci_dev,
1464 u16 io_tag,
1465 void *user_req,
1466 struct scic_sds_request *sci_req,
1467 struct scic_sds_request **new_sci_req)
1468 {
1469 struct domain_device *dev = sci_dev_to_domain(sci_dev);
1470 enum sci_status status = SCI_SUCCESS;
1471
1472 /* Build the common part of the request */
1473 scic_sds_general_request_construct(scic,
1474 sci_dev,
1475 io_tag,
1476 user_req,
1477 sci_req);
1478
1479 if (sci_dev->rnc.remote_node_index ==
1480 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX)
1481 return SCI_FAILURE_INVALID_REMOTE_DEVICE;
1482
1483 if (dev->dev_type == SAS_END_DEV)
1484 scic_sds_ssp_io_request_assign_buffers(sci_req);
1485 else if ((dev->dev_type == SATA_DEV) ||
1486 (dev->tproto & SAS_PROTOCOL_STP)) {
1487 scic_sds_stp_request_assign_buffers(sci_req);
1488 memset(&sci_req->stp.cmd, 0, sizeof(sci_req->stp.cmd));
1489 } else if (dev_is_expander(dev)) {
1490 scic_sds_smp_request_assign_buffers(sci_req);
1491 memset(&sci_req->smp.cmd, 0, sizeof(sci_req->smp.cmd));
1492 } else
1493 status = SCI_FAILURE_UNSUPPORTED_PROTOCOL;
1494
1495 if (status == SCI_SUCCESS) {
1496 memset(sci_req->task_context_buffer,
1497 0,
1498 SCI_FIELD_OFFSET(struct scu_task_context, sgl_pair_ab));
1499 *new_sci_req = sci_req;
1500 }
1501
1502 return status;
1503 }
1504
1505 enum sci_status scic_task_request_construct(struct scic_sds_controller *scic,
1506 struct scic_sds_remote_device *sci_dev,
1507 u16 io_tag,
1508 void *user_io_request_object,
1509 struct scic_sds_request *sci_req,
1510 struct scic_sds_request **new_sci_req)
1511 {
1512 struct domain_device *dev = sci_dev_to_domain(sci_dev);
1513 enum sci_status status = SCI_SUCCESS;
1514
1515 /* Build the common part of the request */
1516 scic_sds_general_request_construct(scic, sci_dev, io_tag,
1517 user_io_request_object,
1518 sci_req);
1519
1520 if (dev->dev_type == SAS_END_DEV) {
1521 scic_sds_ssp_task_request_assign_buffers(sci_req);
1522
1523 sci_req->has_started_substate_machine = true;
1524
1525 /* Construct the started sub-state machine. */
1526 sci_base_state_machine_construct(
1527 &sci_req->started_substate_machine,
1528 sci_req,
1529 scic_sds_io_request_started_task_mgmt_substate_table,
1530 SCIC_SDS_IO_REQUEST_STARTED_TASK_MGMT_SUBSTATE_AWAIT_TC_COMPLETION
1531 );
1532 } else if (dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP))
1533 scic_sds_stp_request_assign_buffers(sci_req);
1534 else
1535 status = SCI_FAILURE_UNSUPPORTED_PROTOCOL;
1536
1537 if (status == SCI_SUCCESS) {
1538 sci_req->is_task_management_request = true;
1539 memset(sci_req->task_context_buffer, 0, sizeof(struct scu_task_context));
1540 *new_sci_req = sci_req;
1541 }
1542
1543 return status;
1544 }
Linux kernel - Deliverables
This page took 0.096314 seconds and 4 git commands to generate.