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


5891f3d501772449e927016d1df175a0d87ffed6
[deliverable/linux.git] / drivers / scsi / isci / remote_node_context.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 "host.h"
57 #include "state_machine.h"
58 #include "scic_sds_port.h"
59 #include "remote_device.h"
60 #include "remote_node_context.h"
61 #include "sci_util.h"
62 #include "scu_event_codes.h"
63 #include "scu_task_context.h"
64
65
66 /**
67 *
68 * @sci_rnc: The RNC for which the is posted request is being made.
69 *
70 * This method will return true if the RNC is not in the initial state. In all
71 * other states the RNC is considered active and this will return true. The
72 * destroy request of the state machine drives the RNC back to the initial
73 * state. If the state machine changes then this routine will also have to be
74 * changed. bool true if the state machine is not in the initial state false if
75 * the state machine is in the initial state
76 */
77
78 /**
79 *
80 * @sci_rnc: The state of the remote node context object to check.
81 *
82 * This method will return true if the remote node context is in a READY state
83 * otherwise it will return false bool true if the remote node context is in
84 * the ready state. false if the remote node context is not in the ready state.
85 */
86 bool scic_sds_remote_node_context_is_ready(
87 struct scic_sds_remote_node_context *sci_rnc)
88 {
89 u32 current_state = sci_base_state_machine_get_state(&sci_rnc->state_machine);
90
91 if (current_state == SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE) {
92 return true;
93 }
94
95 return false;
96 }
97
98 /**
99 *
100 * @sci_dev: The remote device to use to construct the RNC buffer.
101 * @rnc: The buffer into which the remote device data will be copied.
102 *
103 * This method will construct the RNC buffer for this remote device object. none
104 */
105 static void scic_sds_remote_node_context_construct_buffer(
106 struct scic_sds_remote_node_context *sci_rnc)
107 {
108 struct scic_sds_remote_device *sci_dev = rnc_to_dev(sci_rnc);
109 struct domain_device *dev = sci_dev_to_domain(sci_dev);
110 int rni = sci_rnc->remote_node_index;
111 union scu_remote_node_context *rnc;
112 struct scic_sds_controller *scic;
113 __le64 sas_addr;
114
115 scic = scic_sds_remote_device_get_controller(sci_dev);
116 rnc = scic_sds_controller_get_remote_node_context_buffer(scic, rni);
117
118 memset(rnc, 0, sizeof(union scu_remote_node_context)
119 * scic_sds_remote_device_node_count(sci_dev));
120
121 rnc->ssp.remote_node_index = rni;
122 rnc->ssp.remote_node_port_width = sci_dev->device_port_width;
123 rnc->ssp.logical_port_index = sci_dev->owning_port->physical_port_index;
124
125 /* sas address is __be64, context ram format is __le64 */
126 sas_addr = cpu_to_le64(SAS_ADDR(dev->sas_addr));
127 rnc->ssp.remote_sas_address_hi = upper_32_bits(sas_addr);
128 rnc->ssp.remote_sas_address_lo = lower_32_bits(sas_addr);
129
130 rnc->ssp.nexus_loss_timer_enable = true;
131 rnc->ssp.check_bit = false;
132 rnc->ssp.is_valid = false;
133 rnc->ssp.is_remote_node_context = true;
134 rnc->ssp.function_number = 0;
135
136 rnc->ssp.arbitration_wait_time = 0;
137
138 if (dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) {
139 rnc->ssp.connection_occupancy_timeout =
140 scic->user_parameters.sds1.stp_max_occupancy_timeout;
141 rnc->ssp.connection_inactivity_timeout =
142 scic->user_parameters.sds1.stp_inactivity_timeout;
143 } else {
144 rnc->ssp.connection_occupancy_timeout =
145 scic->user_parameters.sds1.ssp_max_occupancy_timeout;
146 rnc->ssp.connection_inactivity_timeout =
147 scic->user_parameters.sds1.ssp_inactivity_timeout;
148 }
149
150 rnc->ssp.initial_arbitration_wait_time = 0;
151
152 /* Open Address Frame Parameters */
153 rnc->ssp.oaf_connection_rate = sci_dev->connection_rate;
154 rnc->ssp.oaf_features = 0;
155 rnc->ssp.oaf_source_zone_group = 0;
156 rnc->ssp.oaf_more_compatibility_features = 0;
157 }
158
159 /**
160 *
161 * @sci_rnc:
162 * @callback:
163 * @callback_parameter:
164 *
165 * This method will setup the remote node context object so it will transition
166 * to its ready state. If the remote node context is already setup to
167 * transition to its final state then this function does nothing. none
168 */
169 static void scic_sds_remote_node_context_setup_to_resume(
170 struct scic_sds_remote_node_context *sci_rnc,
171 scics_sds_remote_node_context_callback callback,
172 void *callback_parameter)
173 {
174 if (sci_rnc->destination_state != SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL) {
175 sci_rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY;
176 sci_rnc->user_callback = callback;
177 sci_rnc->user_cookie = callback_parameter;
178 }
179 }
180
181 /**
182 *
183 * @sci_rnc:
184 * @callback:
185 * @callback_parameter:
186 *
187 * This method will setup the remote node context object so it will transistion
188 * to its final state. none
189 */
190 static void scic_sds_remote_node_context_setup_to_destory(
191 struct scic_sds_remote_node_context *sci_rnc,
192 scics_sds_remote_node_context_callback callback,
193 void *callback_parameter)
194 {
195 sci_rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL;
196 sci_rnc->user_callback = callback;
197 sci_rnc->user_cookie = callback_parameter;
198 }
199
200 /**
201 *
202 * @sci_rnc:
203 * @callback:
204 *
205 * This method will continue to resume a remote node context. This is used in
206 * the states where a resume is requested while a resume is in progress.
207 */
208 static enum sci_status scic_sds_remote_node_context_continue_to_resume_handler(
209 struct scic_sds_remote_node_context *sci_rnc,
210 scics_sds_remote_node_context_callback callback,
211 void *callback_parameter)
212 {
213 if (sci_rnc->destination_state == SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY) {
214 sci_rnc->user_callback = callback;
215 sci_rnc->user_cookie = callback_parameter;
216
217 return SCI_SUCCESS;
218 }
219
220 return SCI_FAILURE_INVALID_STATE;
221 }
222
223 /* --------------------------------------------------------------------------- */
224
225 static enum sci_status scic_sds_remote_node_context_default_destruct_handler(
226 struct scic_sds_remote_node_context *sci_rnc,
227 scics_sds_remote_node_context_callback callback,
228 void *callback_parameter)
229 {
230 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
231 "%s: SCIC Remote Node Context 0x%p requested to stop while "
232 "in unexpected state %d\n",
233 __func__,
234 sci_rnc,
235 sci_base_state_machine_get_state(&sci_rnc->state_machine));
236
237 /*
238 * We have decided that the destruct request on the remote node context can not fail
239 * since it is either in the initial/destroyed state or is can be destroyed. */
240 return SCI_SUCCESS;
241 }
242
243 static enum sci_status scic_sds_remote_node_context_default_suspend_handler(
244 struct scic_sds_remote_node_context *sci_rnc,
245 u32 suspend_type,
246 scics_sds_remote_node_context_callback callback,
247 void *callback_parameter)
248 {
249 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
250 "%s: SCIC Remote Node Context 0x%p requested to suspend "
251 "while in wrong state %d\n",
252 __func__,
253 sci_rnc,
254 sci_base_state_machine_get_state(&sci_rnc->state_machine));
255
256 return SCI_FAILURE_INVALID_STATE;
257 }
258
259 static enum sci_status scic_sds_remote_node_context_default_resume_handler(
260 struct scic_sds_remote_node_context *sci_rnc,
261 scics_sds_remote_node_context_callback callback,
262 void *callback_parameter)
263 {
264 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
265 "%s: SCIC Remote Node Context 0x%p requested to resume "
266 "while in wrong state %d\n",
267 __func__,
268 sci_rnc,
269 sci_base_state_machine_get_state(&sci_rnc->state_machine));
270
271 return SCI_FAILURE_INVALID_STATE;
272 }
273
274 static enum sci_status scic_sds_remote_node_context_default_start_io_handler(
275 struct scic_sds_remote_node_context *sci_rnc,
276 struct scic_sds_request *sci_req)
277 {
278 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
279 "%s: SCIC Remote Node Context 0x%p requested to start io "
280 "0x%p while in wrong state %d\n",
281 __func__,
282 sci_rnc,
283 sci_req,
284 sci_base_state_machine_get_state(&sci_rnc->state_machine));
285
286 return SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED;
287 }
288
289 static enum sci_status scic_sds_remote_node_context_default_start_task_handler(
290 struct scic_sds_remote_node_context *sci_rnc,
291 struct scic_sds_request *sci_req)
292 {
293 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
294 "%s: SCIC Remote Node Context 0x%p requested to start "
295 "task 0x%p while in wrong state %d\n",
296 __func__,
297 sci_rnc,
298 sci_req,
299 sci_base_state_machine_get_state(&sci_rnc->state_machine));
300
301 return SCI_FAILURE;
302 }
303
304 static enum sci_status scic_sds_remote_node_context_default_event_handler(
305 struct scic_sds_remote_node_context *sci_rnc,
306 u32 event_code)
307 {
308 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
309 "%s: SCIC Remote Node Context 0x%p requested to process "
310 "event 0x%x while in wrong state %d\n",
311 __func__,
312 sci_rnc,
313 event_code,
314 sci_base_state_machine_get_state(&sci_rnc->state_machine));
315
316 return SCI_FAILURE_INVALID_STATE;
317 }
318
319 /**
320 *
321 * @sci_rnc: The rnc for which the task request is targeted.
322 * @sci_req: The request which is going to be started.
323 *
324 * This method determines if the task request can be started by the SCU
325 * hardware. When the RNC is in the ready state any task can be started.
326 * enum sci_status SCI_SUCCESS
327 */
328 static enum sci_status scic_sds_remote_node_context_success_start_task_handler(
329 struct scic_sds_remote_node_context *sci_rnc,
330 struct scic_sds_request *sci_req)
331 {
332 return SCI_SUCCESS;
333 }
334
335 /**
336 *
337 * @sci_rnc:
338 * @callback:
339 * @callback_parameter:
340 *
341 * This method handles destruct calls from the various state handlers. The
342 * remote node context can be requested to destroy from any state. If there was
343 * a user callback it is always replaced with the request to destroy user
344 * callback. enum sci_status
345 */
346 static enum sci_status scic_sds_remote_node_context_general_destruct_handler(
347 struct scic_sds_remote_node_context *sci_rnc,
348 scics_sds_remote_node_context_callback callback,
349 void *callback_parameter)
350 {
351 scic_sds_remote_node_context_setup_to_destory(
352 sci_rnc, callback, callback_parameter
353 );
354
355 sci_base_state_machine_change_state(
356 &sci_rnc->state_machine,
357 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE
358 );
359
360 return SCI_SUCCESS;
361 }
362
363 /* --------------------------------------------------------------------------- */
364
365 static enum sci_status scic_sds_remote_node_context_initial_state_resume_handler(
366 struct scic_sds_remote_node_context *sci_rnc,
367 scics_sds_remote_node_context_callback callback,
368 void *callback_parameter)
369 {
370 if (sci_rnc->remote_node_index != SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX) {
371 scic_sds_remote_node_context_setup_to_resume(
372 sci_rnc, callback, callback_parameter
373 );
374
375 scic_sds_remote_node_context_construct_buffer(sci_rnc);
376
377 sci_base_state_machine_change_state(
378 &sci_rnc->state_machine,
379 SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE
380 );
381
382 return SCI_SUCCESS;
383 }
384
385 return SCI_FAILURE_INVALID_STATE;
386 }
387
388 /* --------------------------------------------------------------------------- */
389
390 static enum sci_status scic_sds_remote_node_context_posting_state_event_handler(
391 struct scic_sds_remote_node_context *sci_rnc,
392 u32 event_code)
393 {
394 enum sci_status status;
395
396 switch (scu_get_event_code(event_code)) {
397 case SCU_EVENT_POST_RNC_COMPLETE:
398 status = SCI_SUCCESS;
399
400 sci_base_state_machine_change_state(
401 &sci_rnc->state_machine,
402 SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE
403 );
404 break;
405
406 default:
407 status = SCI_FAILURE;
408 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
409 "%s: SCIC Remote Node Context 0x%p requested to "
410 "process unexpected event 0x%x while in posting "
411 "state\n",
412 __func__,
413 sci_rnc,
414 event_code);
415 break;
416 }
417
418 return status;
419 }
420
421 /* --------------------------------------------------------------------------- */
422
423 static enum sci_status scic_sds_remote_node_context_invalidating_state_destruct_handler(
424 struct scic_sds_remote_node_context *sci_rnc,
425 scics_sds_remote_node_context_callback callback,
426 void *callback_parameter)
427 {
428 scic_sds_remote_node_context_setup_to_destory(
429 sci_rnc, callback, callback_parameter
430 );
431
432 return SCI_SUCCESS;
433 }
434
435 static enum sci_status scic_sds_remote_node_context_invalidating_state_event_handler(
436 struct scic_sds_remote_node_context *sci_rnc,
437 u32 event_code)
438 {
439 enum sci_status status;
440
441 if (scu_get_event_code(event_code) == SCU_EVENT_POST_RNC_INVALIDATE_COMPLETE) {
442 status = SCI_SUCCESS;
443
444 if (sci_rnc->destination_state == SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL) {
445 sci_base_state_machine_change_state(
446 &sci_rnc->state_machine,
447 SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE
448 );
449 } else {
450 sci_base_state_machine_change_state(
451 &sci_rnc->state_machine,
452 SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE
453 );
454 }
455 } else {
456 switch (scu_get_event_type(event_code)) {
457 case SCU_EVENT_TYPE_RNC_SUSPEND_TX:
458 case SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX:
459 /*
460 * We really dont care if the hardware is going to suspend
461 * the device since it's being invalidated anyway */
462 dev_dbg(scirdev_to_dev(rnc_to_dev(sci_rnc)),
463 "%s: SCIC Remote Node Context 0x%p was "
464 "suspeneded by hardware while being "
465 "invalidated.\n",
466 __func__,
467 sci_rnc);
468 status = SCI_SUCCESS;
469 break;
470
471 default:
472 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
473 "%s: SCIC Remote Node Context 0x%p "
474 "requested to process event 0x%x while "
475 "in state %d.\n",
476 __func__,
477 sci_rnc,
478 event_code,
479 sci_base_state_machine_get_state(
480 &sci_rnc->state_machine));
481 status = SCI_FAILURE;
482 break;
483 }
484 }
485
486 return status;
487 }
488
489 /* --------------------------------------------------------------------------- */
490
491
492 static enum sci_status scic_sds_remote_node_context_resuming_state_event_handler(
493 struct scic_sds_remote_node_context *sci_rnc,
494 u32 event_code)
495 {
496 enum sci_status status;
497
498 if (scu_get_event_code(event_code) == SCU_EVENT_POST_RCN_RELEASE) {
499 status = SCI_SUCCESS;
500
501 sci_base_state_machine_change_state(
502 &sci_rnc->state_machine,
503 SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE
504 );
505 } else {
506 switch (scu_get_event_type(event_code)) {
507 case SCU_EVENT_TYPE_RNC_SUSPEND_TX:
508 case SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX:
509 /*
510 * We really dont care if the hardware is going to suspend
511 * the device since it's being resumed anyway */
512 dev_dbg(scirdev_to_dev(rnc_to_dev(sci_rnc)),
513 "%s: SCIC Remote Node Context 0x%p was "
514 "suspeneded by hardware while being resumed.\n",
515 __func__,
516 sci_rnc);
517 status = SCI_SUCCESS;
518 break;
519
520 default:
521 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
522 "%s: SCIC Remote Node Context 0x%p requested "
523 "to process event 0x%x while in state %d.\n",
524 __func__,
525 sci_rnc,
526 event_code,
527 sci_base_state_machine_get_state(
528 &sci_rnc->state_machine));
529 status = SCI_FAILURE;
530 break;
531 }
532 }
533
534 return status;
535 }
536
537 /* --------------------------------------------------------------------------- */
538
539 /**
540 *
541 * @sci_rnc: The remote node context object being suspended.
542 * @callback: The callback when the suspension is complete.
543 * @callback_parameter: The parameter that is to be passed into the callback.
544 *
545 * This method will handle the suspend requests from the ready state.
546 * SCI_SUCCESS
547 */
548 static enum sci_status scic_sds_remote_node_context_ready_state_suspend_handler(
549 struct scic_sds_remote_node_context *sci_rnc,
550 u32 suspend_type,
551 scics_sds_remote_node_context_callback callback,
552 void *callback_parameter)
553 {
554 sci_rnc->user_callback = callback;
555 sci_rnc->user_cookie = callback_parameter;
556 sci_rnc->suspension_code = suspend_type;
557
558 if (suspend_type == SCI_SOFTWARE_SUSPENSION) {
559 scic_sds_remote_device_post_request(rnc_to_dev(sci_rnc),
560 SCU_CONTEXT_COMMAND_POST_RNC_SUSPEND_TX);
561 }
562
563 sci_base_state_machine_change_state(
564 &sci_rnc->state_machine,
565 SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE
566 );
567
568 return SCI_SUCCESS;
569 }
570
571 /**
572 *
573 * @sci_rnc: The rnc for which the io request is targeted.
574 * @sci_req: The request which is going to be started.
575 *
576 * This method determines if the io request can be started by the SCU hardware.
577 * When the RNC is in the ready state any io request can be started. enum sci_status
578 * SCI_SUCCESS
579 */
580 static enum sci_status scic_sds_remote_node_context_ready_state_start_io_handler(
581 struct scic_sds_remote_node_context *sci_rnc,
582 struct scic_sds_request *sci_req)
583 {
584 return SCI_SUCCESS;
585 }
586
587
588 static enum sci_status scic_sds_remote_node_context_ready_state_event_handler(
589 struct scic_sds_remote_node_context *sci_rnc,
590 u32 event_code)
591 {
592 enum sci_status status;
593
594 switch (scu_get_event_type(event_code)) {
595 case SCU_EVENT_TL_RNC_SUSPEND_TX:
596 sci_base_state_machine_change_state(
597 &sci_rnc->state_machine,
598 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE
599 );
600
601 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
602 status = SCI_SUCCESS;
603 break;
604
605 case SCU_EVENT_TL_RNC_SUSPEND_TX_RX:
606 sci_base_state_machine_change_state(
607 &sci_rnc->state_machine,
608 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE
609 );
610
611 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
612 status = SCI_SUCCESS;
613 break;
614
615 default:
616 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
617 "%s: SCIC Remote Node Context 0x%p requested to "
618 "process event 0x%x while in state %d.\n",
619 __func__,
620 sci_rnc,
621 event_code,
622 sci_base_state_machine_get_state(
623 &sci_rnc->state_machine));
624
625 status = SCI_FAILURE;
626 break;
627 }
628
629 return status;
630 }
631
632 /* --------------------------------------------------------------------------- */
633
634 static enum sci_status scic_sds_remote_node_context_tx_suspended_state_resume_handler(
635 struct scic_sds_remote_node_context *sci_rnc,
636 scics_sds_remote_node_context_callback callback,
637 void *callback_parameter)
638 {
639 struct scic_sds_remote_device *sci_dev = rnc_to_dev(sci_rnc);
640 struct domain_device *dev = sci_dev_to_domain(sci_dev);
641 enum sci_status status = SCI_SUCCESS;
642
643 scic_sds_remote_node_context_setup_to_resume(sci_rnc, callback,
644 callback_parameter);
645
646 /* TODO: consider adding a resume action of NONE, INVALIDATE, WRITE_TLCR */
647 if (dev->dev_type == SAS_END_DEV || dev_is_expander(dev))
648 sci_base_state_machine_change_state(&sci_rnc->state_machine,
649 SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE);
650 else if (dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) {
651 if (sci_dev->is_direct_attached) {
652 /* @todo Fix this since I am being silly in writing to the STPTLDARNI register. */
653 sci_base_state_machine_change_state(
654 &sci_rnc->state_machine,
655 SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE);
656 } else {
657 sci_base_state_machine_change_state(
658 &sci_rnc->state_machine,
659 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE);
660 }
661 } else
662 status = SCI_FAILURE;
663
664 return status;
665 }
666
667 /**
668 *
669 * @sci_rnc: The remote node context which is to receive the task request.
670 * @sci_req: The task request to be transmitted to to the remote target
671 * device.
672 *
673 * This method will report a success or failure attempt to start a new task
674 * request to the hardware. Since all task requests are sent on the high
675 * priority queue they can be sent when the RCN is in a TX suspend state.
676 * enum sci_status SCI_SUCCESS
677 */
678 static enum sci_status scic_sds_remote_node_context_suspended_start_task_handler(
679 struct scic_sds_remote_node_context *sci_rnc,
680 struct scic_sds_request *sci_req)
681 {
682 scic_sds_remote_node_context_resume(sci_rnc, NULL, NULL);
683
684 return SCI_SUCCESS;
685 }
686
687 /* --------------------------------------------------------------------------- */
688
689 static enum sci_status scic_sds_remote_node_context_tx_rx_suspended_state_resume_handler(
690 struct scic_sds_remote_node_context *sci_rnc,
691 scics_sds_remote_node_context_callback callback,
692 void *callback_parameter)
693 {
694 scic_sds_remote_node_context_setup_to_resume(
695 sci_rnc, callback, callback_parameter
696 );
697
698 sci_base_state_machine_change_state(
699 &sci_rnc->state_machine,
700 SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE
701 );
702
703 return SCI_FAILURE_INVALID_STATE;
704 }
705
706 /* --------------------------------------------------------------------------- */
707
708 /**
709 *
710 *
711 *
712 */
713 static enum sci_status scic_sds_remote_node_context_await_suspension_state_resume_handler(
714 struct scic_sds_remote_node_context *sci_rnc,
715 scics_sds_remote_node_context_callback callback,
716 void *callback_parameter)
717 {
718 scic_sds_remote_node_context_setup_to_resume(
719 sci_rnc, callback, callback_parameter
720 );
721
722 return SCI_SUCCESS;
723 }
724
725 /**
726 *
727 * @sci_rnc: The remote node context which is to receive the task request.
728 * @sci_req: The task request to be transmitted to to the remote target
729 * device.
730 *
731 * This method will report a success or failure attempt to start a new task
732 * request to the hardware. Since all task requests are sent on the high
733 * priority queue they can be sent when the RCN is in a TX suspend state.
734 * enum sci_status SCI_SUCCESS
735 */
736 static enum sci_status scic_sds_remote_node_context_await_suspension_state_start_task_handler(
737 struct scic_sds_remote_node_context *sci_rnc,
738 struct scic_sds_request *sci_req)
739 {
740 return SCI_SUCCESS;
741 }
742
743 static enum sci_status scic_sds_remote_node_context_await_suspension_state_event_handler(
744 struct scic_sds_remote_node_context *sci_rnc,
745 u32 event_code)
746 {
747 enum sci_status status;
748
749 switch (scu_get_event_type(event_code)) {
750 case SCU_EVENT_TL_RNC_SUSPEND_TX:
751 sci_base_state_machine_change_state(
752 &sci_rnc->state_machine,
753 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE
754 );
755
756 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
757 status = SCI_SUCCESS;
758 break;
759
760 case SCU_EVENT_TL_RNC_SUSPEND_TX_RX:
761 sci_base_state_machine_change_state(
762 &sci_rnc->state_machine,
763 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE
764 );
765
766 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
767 status = SCI_SUCCESS;
768 break;
769
770 default:
771 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
772 "%s: SCIC Remote Node Context 0x%p requested to "
773 "process event 0x%x while in state %d.\n",
774 __func__,
775 sci_rnc,
776 event_code,
777 sci_base_state_machine_get_state(
778 &sci_rnc->state_machine));
779
780 status = SCI_FAILURE;
781 break;
782 }
783
784 return status;
785 }
786
787 /* --------------------------------------------------------------------------- */
788
789 static struct scic_sds_remote_node_context_handlers
790 scic_sds_remote_node_context_state_handler_table[] = {
791 [SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE] = {
792 .destruct_handler = scic_sds_remote_node_context_default_destruct_handler,
793 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
794 .resume_handler = scic_sds_remote_node_context_initial_state_resume_handler,
795 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
796 .start_task_handler = scic_sds_remote_node_context_default_start_task_handler,
797 .event_handler = scic_sds_remote_node_context_default_event_handler
798 },
799 [SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE] = {
800 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
801 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
802 .resume_handler = scic_sds_remote_node_context_continue_to_resume_handler,
803 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
804 .start_task_handler = scic_sds_remote_node_context_default_start_task_handler,
805 .event_handler = scic_sds_remote_node_context_posting_state_event_handler
806 },
807 [SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE] = {
808 .destruct_handler = scic_sds_remote_node_context_invalidating_state_destruct_handler,
809 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
810 .resume_handler = scic_sds_remote_node_context_continue_to_resume_handler,
811 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
812 .start_task_handler = scic_sds_remote_node_context_default_start_task_handler,
813 .event_handler = scic_sds_remote_node_context_invalidating_state_event_handler
814 },
815 [SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE] = {
816 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
817 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
818 .resume_handler = scic_sds_remote_node_context_continue_to_resume_handler,
819 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
820 .start_task_handler = scic_sds_remote_node_context_success_start_task_handler,
821 .event_handler = scic_sds_remote_node_context_resuming_state_event_handler
822 },
823 [SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE] = {
824 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
825 .suspend_handler = scic_sds_remote_node_context_ready_state_suspend_handler,
826 .resume_handler = scic_sds_remote_node_context_default_resume_handler,
827 .start_io_handler = scic_sds_remote_node_context_ready_state_start_io_handler,
828 .start_task_handler = scic_sds_remote_node_context_success_start_task_handler,
829 .event_handler = scic_sds_remote_node_context_ready_state_event_handler
830 },
831 [SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE] = {
832 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
833 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
834 .resume_handler = scic_sds_remote_node_context_tx_suspended_state_resume_handler,
835 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
836 .start_task_handler = scic_sds_remote_node_context_suspended_start_task_handler,
837 .event_handler = scic_sds_remote_node_context_default_event_handler
838 },
839 [SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE] = {
840 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
841 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
842 .resume_handler = scic_sds_remote_node_context_tx_rx_suspended_state_resume_handler,
843 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
844 .start_task_handler = scic_sds_remote_node_context_suspended_start_task_handler,
845 .event_handler = scic_sds_remote_node_context_default_event_handler
846 },
847 [SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE] = {
848 .destruct_handler = scic_sds_remote_node_context_general_destruct_handler,
849 .suspend_handler = scic_sds_remote_node_context_default_suspend_handler,
850 .resume_handler = scic_sds_remote_node_context_await_suspension_state_resume_handler,
851 .start_io_handler = scic_sds_remote_node_context_default_start_io_handler,
852 .start_task_handler = scic_sds_remote_node_context_await_suspension_state_start_task_handler,
853 .event_handler = scic_sds_remote_node_context_await_suspension_state_event_handler
854 }
855 };
856
857 /*
858 * *****************************************************************************
859 * * REMOTE NODE CONTEXT PRIVATE METHODS
860 * ***************************************************************************** */
861
862 /**
863 *
864 *
865 * This method just calls the user callback function and then resets the
866 * callback.
867 */
868 static void scic_sds_remote_node_context_notify_user(
869 struct scic_sds_remote_node_context *rnc)
870 {
871 if (rnc->user_callback != NULL) {
872 (*rnc->user_callback)(rnc->user_cookie);
873
874 rnc->user_callback = NULL;
875 rnc->user_cookie = NULL;
876 }
877 }
878
879 /**
880 *
881 *
882 * This method will continue the remote node context state machine by
883 * requesting to resume the remote node context state machine from its current
884 * state.
885 */
886 static void scic_sds_remote_node_context_continue_state_transitions(
887 struct scic_sds_remote_node_context *rnc)
888 {
889 if (rnc->destination_state == SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY) {
890 rnc->state_handlers->resume_handler(
891 rnc, rnc->user_callback, rnc->user_cookie
892 );
893 }
894 }
895
896 /**
897 *
898 * @sci_rnc: The remote node context object that is to be validated.
899 *
900 * This method will mark the rnc buffer as being valid and post the request to
901 * the hardware. none
902 */
903 static void scic_sds_remote_node_context_validate_context_buffer(
904 struct scic_sds_remote_node_context *sci_rnc)
905 {
906 struct scic_sds_remote_device *sci_dev = rnc_to_dev(sci_rnc);
907 struct domain_device *dev = sci_dev_to_domain(sci_dev);
908 union scu_remote_node_context *rnc_buffer;
909
910 rnc_buffer = scic_sds_controller_get_remote_node_context_buffer(
911 scic_sds_remote_device_get_controller(sci_dev),
912 sci_rnc->remote_node_index
913 );
914
915 rnc_buffer->ssp.is_valid = true;
916
917 if (!sci_dev->is_direct_attached &&
918 (dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP))) {
919 scic_sds_remote_device_post_request(sci_dev,
920 SCU_CONTEXT_COMMAND_POST_RNC_96);
921 } else {
922 scic_sds_remote_device_post_request(sci_dev, SCU_CONTEXT_COMMAND_POST_RNC_32);
923
924 if (sci_dev->is_direct_attached) {
925 scic_sds_port_setup_transports(sci_dev->owning_port,
926 sci_rnc->remote_node_index);
927 }
928 }
929 }
930
931 /**
932 *
933 * @sci_rnc: The remote node context object that is to be invalidated.
934 *
935 * This method will update the RNC buffer and post the invalidate request. none
936 */
937 static void scic_sds_remote_node_context_invalidate_context_buffer(
938 struct scic_sds_remote_node_context *sci_rnc)
939 {
940 union scu_remote_node_context *rnc_buffer;
941
942 rnc_buffer = scic_sds_controller_get_remote_node_context_buffer(
943 scic_sds_remote_device_get_controller(rnc_to_dev(sci_rnc)),
944 sci_rnc->remote_node_index);
945
946 rnc_buffer->ssp.is_valid = false;
947
948 scic_sds_remote_device_post_request(rnc_to_dev(sci_rnc),
949 SCU_CONTEXT_COMMAND_POST_RNC_INVALIDATE);
950 }
951
952 /*
953 * *****************************************************************************
954 * * REMOTE NODE CONTEXT STATE ENTER AND EXIT METHODS
955 * ***************************************************************************** */
956
957 /**
958 *
959 *
960 *
961 */
962 static void scic_sds_remote_node_context_initial_state_enter(void *object)
963 {
964 struct scic_sds_remote_node_context *rnc = object;
965
966 SET_STATE_HANDLER(
967 rnc,
968 scic_sds_remote_node_context_state_handler_table,
969 SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE
970 );
971
972 /*
973 * Check to see if we have gotten back to the initial state because someone
974 * requested to destroy the remote node context object. */
975 if (
976 rnc->state_machine.previous_state_id
977 == SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE
978 ) {
979 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
980
981 scic_sds_remote_node_context_notify_user(rnc);
982 }
983 }
984
985 /**
986 *
987 *
988 *
989 */
990 static void scic_sds_remote_node_context_posting_state_enter(void *object)
991 {
992 struct scic_sds_remote_node_context *sci_rnc = object;
993
994 SET_STATE_HANDLER(
995 sci_rnc,
996 scic_sds_remote_node_context_state_handler_table,
997 SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE
998 );
999
1000 scic_sds_remote_node_context_validate_context_buffer(sci_rnc);
1001 }
1002
1003 /**
1004 *
1005 *
1006 *
1007 */
1008 static void scic_sds_remote_node_context_invalidating_state_enter(void *object)
1009 {
1010 struct scic_sds_remote_node_context *rnc = object;
1011
1012 SET_STATE_HANDLER(
1013 rnc,
1014 scic_sds_remote_node_context_state_handler_table,
1015 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE
1016 );
1017
1018 scic_sds_remote_node_context_invalidate_context_buffer(rnc);
1019 }
1020
1021 /**
1022 *
1023 *
1024 *
1025 */
1026 static void scic_sds_remote_node_context_resuming_state_enter(void *object)
1027 {
1028 struct scic_sds_remote_node_context *rnc = object;
1029 struct scic_sds_remote_device *sci_dev;
1030 struct domain_device *dev;
1031
1032 sci_dev = rnc_to_dev(rnc);
1033 dev = sci_dev_to_domain(sci_dev);
1034
1035 SET_STATE_HANDLER(
1036 rnc,
1037 scic_sds_remote_node_context_state_handler_table,
1038 SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE
1039 );
1040
1041 /*
1042 * For direct attached SATA devices we need to clear the TLCR
1043 * NCQ to TCi tag mapping on the phy and in cases where we
1044 * resume because of a target reset we also need to update
1045 * the STPTLDARNI register with the RNi of the device
1046 */
1047 if ((dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) &&
1048 sci_dev->is_direct_attached)
1049 scic_sds_port_setup_transports(sci_dev->owning_port,
1050 rnc->remote_node_index);
1051
1052 scic_sds_remote_device_post_request(sci_dev, SCU_CONTEXT_COMMAND_POST_RNC_RESUME);
1053 }
1054
1055 /**
1056 *
1057 *
1058 *
1059 */
1060 static void scic_sds_remote_node_context_ready_state_enter(void *object)
1061 {
1062 struct scic_sds_remote_node_context *rnc = object;
1063
1064 SET_STATE_HANDLER(
1065 rnc,
1066 scic_sds_remote_node_context_state_handler_table,
1067 SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE
1068 );
1069
1070 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
1071
1072 if (rnc->user_callback != NULL) {
1073 scic_sds_remote_node_context_notify_user(rnc);
1074 }
1075 }
1076
1077 /**
1078 *
1079 *
1080 *
1081 */
1082 static void scic_sds_remote_node_context_tx_suspended_state_enter(void *object)
1083 {
1084 struct scic_sds_remote_node_context *rnc = object;
1085
1086 SET_STATE_HANDLER(
1087 rnc,
1088 scic_sds_remote_node_context_state_handler_table,
1089 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE
1090 );
1091
1092 scic_sds_remote_node_context_continue_state_transitions(rnc);
1093 }
1094
1095 /**
1096 *
1097 *
1098 *
1099 */
1100 static void scic_sds_remote_node_context_tx_rx_suspended_state_enter(
1101 void *object)
1102 {
1103 struct scic_sds_remote_node_context *rnc = object;
1104
1105 SET_STATE_HANDLER(
1106 rnc,
1107 scic_sds_remote_node_context_state_handler_table,
1108 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE
1109 );
1110
1111 scic_sds_remote_node_context_continue_state_transitions(rnc);
1112 }
1113
1114 /**
1115 *
1116 *
1117 *
1118 */
1119 static void scic_sds_remote_node_context_await_suspension_state_enter(
1120 void *object)
1121 {
1122 struct scic_sds_remote_node_context *rnc = object;
1123
1124 SET_STATE_HANDLER(
1125 rnc,
1126 scic_sds_remote_node_context_state_handler_table,
1127 SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE
1128 );
1129 }
1130
1131 /* --------------------------------------------------------------------------- */
1132
1133 static const struct sci_base_state scic_sds_remote_node_context_state_table[] = {
1134 [SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE] = {
1135 .enter_state = scic_sds_remote_node_context_initial_state_enter,
1136 },
1137 [SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE] = {
1138 .enter_state = scic_sds_remote_node_context_posting_state_enter,
1139 },
1140 [SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE] = {
1141 .enter_state = scic_sds_remote_node_context_invalidating_state_enter,
1142 },
1143 [SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE] = {
1144 .enter_state = scic_sds_remote_node_context_resuming_state_enter,
1145 },
1146 [SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE] = {
1147 .enter_state = scic_sds_remote_node_context_ready_state_enter,
1148 },
1149 [SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE] = {
1150 .enter_state = scic_sds_remote_node_context_tx_suspended_state_enter,
1151 },
1152 [SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE] = {
1153 .enter_state = scic_sds_remote_node_context_tx_rx_suspended_state_enter,
1154 },
1155 [SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE] = {
1156 .enter_state = scic_sds_remote_node_context_await_suspension_state_enter,
1157 },
1158 };
1159
1160 void scic_sds_remote_node_context_construct(struct scic_sds_remote_node_context *rnc,
1161 u16 remote_node_index)
1162 {
1163 memset(rnc, 0, sizeof(struct scic_sds_remote_node_context));
1164
1165 rnc->remote_node_index = remote_node_index;
1166 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
1167
1168 sci_base_state_machine_construct(
1169 &rnc->state_machine,
1170 rnc,
1171 scic_sds_remote_node_context_state_table,
1172 SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE
1173 );
1174
1175 sci_base_state_machine_start(&rnc->state_machine);
1176 }
Linux kernel - Deliverables
This page took 0.056139 seconds and 4 git commands to generate.