blob: 3e849752bffa225c6a482ea852ae503616ac63ac [file] [log] [blame]
Dan Williams6f231dd2011-07-02 22:56:22 -07001/*
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
Dan Williamscc9203b2011-05-08 17:34:44 -070056#include "host.h"
Edmund Nadolski12ef6542011-06-02 00:10:50 +000057#include "isci.h"
Dan Williams88f3b622011-04-22 19:18:03 -070058#include "remote_device.h"
59#include "remote_node_context.h"
Dan Williams6f231dd2011-07-02 22:56:22 -070060#include "scu_event_codes.h"
61#include "scu_task_context.h"
62
Dan Williamsd7a0ccd2012-02-10 01:18:44 -080063#undef C
64#define C(a) (#a)
65const char *rnc_state_name(enum scis_sds_remote_node_context_states state)
66{
67 static const char * const strings[] = RNC_STATES;
Dan Williams6f231dd2011-07-02 22:56:22 -070068
Dan Williamsd7a0ccd2012-02-10 01:18:44 -080069 return strings[state];
70}
71#undef C
Dan Williams6f231dd2011-07-02 22:56:22 -070072
73/**
74 *
Dave Jiange2023b82011-04-21 05:34:49 +000075 * @sci_rnc: The state of the remote node context object to check.
Dan Williams6f231dd2011-07-02 22:56:22 -070076 *
77 * This method will return true if the remote node context is in a READY state
78 * otherwise it will return false bool true if the remote node context is in
79 * the ready state. false if the remote node context is not in the ready state.
80 */
Dan Williams89a73012011-06-30 19:14:33 -070081bool sci_remote_node_context_is_ready(
82 struct sci_remote_node_context *sci_rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -070083{
Edmund Nadolskie3013702011-06-02 00:10:43 +000084 u32 current_state = sci_rnc->sm.current_state_id;
Dan Williams6f231dd2011-07-02 22:56:22 -070085
Edmund Nadolskie3013702011-06-02 00:10:43 +000086 if (current_state == SCI_RNC_READY) {
Dan Williams6f231dd2011-07-02 22:56:22 -070087 return true;
88 }
89
90 return false;
91}
92
Dan Williams89a73012011-06-30 19:14:33 -070093static union scu_remote_node_context *sci_rnc_by_id(struct isci_host *ihost, u16 id)
94{
95 if (id < ihost->remote_node_entries &&
96 ihost->device_table[id])
97 return &ihost->remote_node_context_table[id];
98
99 return NULL;
100}
101
102static void sci_remote_node_context_construct_buffer(struct sci_remote_node_context *sci_rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -0700103{
Dan Williams78a6f062011-06-30 16:31:37 -0700104 struct isci_remote_device *idev = rnc_to_dev(sci_rnc);
105 struct domain_device *dev = idev->domain_dev;
Dan Williams1f4fa1f2011-04-26 11:44:06 -0700106 int rni = sci_rnc->remote_node_index;
Dan Williamsa1a113b2011-04-21 18:44:45 -0700107 union scu_remote_node_context *rnc;
Dan Williamsd9dcb4b2011-06-30 17:38:32 -0700108 struct isci_host *ihost;
Dan Williamsa3d568f02011-04-26 09:41:52 -0700109 __le64 sas_addr;
Dan Williams6f231dd2011-07-02 22:56:22 -0700110
Dan Williams34a99152011-07-01 02:25:15 -0700111 ihost = idev->owning_port->owning_controller;
Dan Williams89a73012011-06-30 19:14:33 -0700112 rnc = sci_rnc_by_id(ihost, rni);
Dan Williams6f231dd2011-07-02 22:56:22 -0700113
Dan Williams96143952011-04-19 18:35:58 -0700114 memset(rnc, 0, sizeof(union scu_remote_node_context)
Dan Williams89a73012011-06-30 19:14:33 -0700115 * sci_remote_device_node_count(idev));
Dan Williams6f231dd2011-07-02 22:56:22 -0700116
Dan Williams1f4fa1f2011-04-26 11:44:06 -0700117 rnc->ssp.remote_node_index = rni;
Dan Williams78a6f062011-06-30 16:31:37 -0700118 rnc->ssp.remote_node_port_width = idev->device_port_width;
119 rnc->ssp.logical_port_index = idev->owning_port->physical_port_index;
Dan Williams6f231dd2011-07-02 22:56:22 -0700120
Dan Williamsa3d568f02011-04-26 09:41:52 -0700121 /* sas address is __be64, context ram format is __le64 */
122 sas_addr = cpu_to_le64(SAS_ADDR(dev->sas_addr));
123 rnc->ssp.remote_sas_address_hi = upper_32_bits(sas_addr);
124 rnc->ssp.remote_sas_address_lo = lower_32_bits(sas_addr);
Dan Williams6f231dd2011-07-02 22:56:22 -0700125
126 rnc->ssp.nexus_loss_timer_enable = true;
127 rnc->ssp.check_bit = false;
128 rnc->ssp.is_valid = false;
129 rnc->ssp.is_remote_node_context = true;
130 rnc->ssp.function_number = 0;
131
132 rnc->ssp.arbitration_wait_time = 0;
133
Dan Williams11cc5182012-02-01 00:23:10 -0800134 if (dev_is_sata(dev)) {
Dan Williams6f231dd2011-07-02 22:56:22 -0700135 rnc->ssp.connection_occupancy_timeout =
Dan Williams89a73012011-06-30 19:14:33 -0700136 ihost->user_parameters.stp_max_occupancy_timeout;
Dan Williams6f231dd2011-07-02 22:56:22 -0700137 rnc->ssp.connection_inactivity_timeout =
Dan Williams89a73012011-06-30 19:14:33 -0700138 ihost->user_parameters.stp_inactivity_timeout;
Dan Williams6f231dd2011-07-02 22:56:22 -0700139 } else {
140 rnc->ssp.connection_occupancy_timeout =
Dan Williams89a73012011-06-30 19:14:33 -0700141 ihost->user_parameters.ssp_max_occupancy_timeout;
Dan Williams6f231dd2011-07-02 22:56:22 -0700142 rnc->ssp.connection_inactivity_timeout =
Dan Williams89a73012011-06-30 19:14:33 -0700143 ihost->user_parameters.ssp_inactivity_timeout;
Dan Williams6f231dd2011-07-02 22:56:22 -0700144 }
145
146 rnc->ssp.initial_arbitration_wait_time = 0;
147
148 /* Open Address Frame Parameters */
Dan Williams78a6f062011-06-30 16:31:37 -0700149 rnc->ssp.oaf_connection_rate = idev->connection_rate;
Dan Williams6f231dd2011-07-02 22:56:22 -0700150 rnc->ssp.oaf_features = 0;
151 rnc->ssp.oaf_source_zone_group = 0;
152 rnc->ssp.oaf_more_compatibility_features = 0;
153}
154
155/**
156 *
Dave Jiange2023b82011-04-21 05:34:49 +0000157 * @sci_rnc:
158 * @callback:
Dan Williams6f231dd2011-07-02 22:56:22 -0700159 * @callback_parameter:
160 *
161 * This method will setup the remote node context object so it will transition
162 * to its ready state. If the remote node context is already setup to
163 * transition to its final state then this function does nothing. none
164 */
Dan Williams89a73012011-06-30 19:14:33 -0700165static void sci_remote_node_context_setup_to_resume(
166 struct sci_remote_node_context *sci_rnc,
Dave Jiange2023b82011-04-21 05:34:49 +0000167 scics_sds_remote_node_context_callback callback,
Dan Williams6f231dd2011-07-02 22:56:22 -0700168 void *callback_parameter)
169{
Dave Jiange2023b82011-04-21 05:34:49 +0000170 if (sci_rnc->destination_state != SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL) {
171 sci_rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY;
172 sci_rnc->user_callback = callback;
173 sci_rnc->user_cookie = callback_parameter;
Dan Williams6f231dd2011-07-02 22:56:22 -0700174 }
175}
176
Dan Williams89a73012011-06-30 19:14:33 -0700177static void sci_remote_node_context_setup_to_destory(
178 struct sci_remote_node_context *sci_rnc,
Dave Jiange2023b82011-04-21 05:34:49 +0000179 scics_sds_remote_node_context_callback callback,
Dan Williams6f231dd2011-07-02 22:56:22 -0700180 void *callback_parameter)
181{
Dave Jiange2023b82011-04-21 05:34:49 +0000182 sci_rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL;
183 sci_rnc->user_callback = callback;
184 sci_rnc->user_cookie = callback_parameter;
Dan Williams6f231dd2011-07-02 22:56:22 -0700185}
186
Dan Williams6f231dd2011-07-02 22:56:22 -0700187/**
188 *
189 *
190 * This method just calls the user callback function and then resets the
191 * callback.
192 */
Dan Williams89a73012011-06-30 19:14:33 -0700193static void sci_remote_node_context_notify_user(
194 struct sci_remote_node_context *rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -0700195{
196 if (rnc->user_callback != NULL) {
197 (*rnc->user_callback)(rnc->user_cookie);
198
199 rnc->user_callback = NULL;
200 rnc->user_cookie = NULL;
201 }
202}
203
Dan Williams89a73012011-06-30 19:14:33 -0700204static void sci_remote_node_context_continue_state_transitions(struct sci_remote_node_context *rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -0700205{
Dan Williamsed3efb72011-05-12 08:50:23 -0700206 if (rnc->destination_state == SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY)
Dan Williams89a73012011-06-30 19:14:33 -0700207 sci_remote_node_context_resume(rnc, rnc->user_callback,
Dan Williamsed3efb72011-05-12 08:50:23 -0700208 rnc->user_cookie);
Dan Williams6f231dd2011-07-02 22:56:22 -0700209}
210
Dan Williams89a73012011-06-30 19:14:33 -0700211static void sci_remote_node_context_validate_context_buffer(struct sci_remote_node_context *sci_rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -0700212{
Dan Williams89a73012011-06-30 19:14:33 -0700213 union scu_remote_node_context *rnc_buffer;
Dan Williams78a6f062011-06-30 16:31:37 -0700214 struct isci_remote_device *idev = rnc_to_dev(sci_rnc);
215 struct domain_device *dev = idev->domain_dev;
Dan Williams89a73012011-06-30 19:14:33 -0700216 struct isci_host *ihost = idev->owning_port->owning_controller;
Dan Williams6f231dd2011-07-02 22:56:22 -0700217
Dan Williams89a73012011-06-30 19:14:33 -0700218 rnc_buffer = sci_rnc_by_id(ihost, sci_rnc->remote_node_index);
Dan Williams6f231dd2011-07-02 22:56:22 -0700219
220 rnc_buffer->ssp.is_valid = true;
221
Dan Williams11cc5182012-02-01 00:23:10 -0800222 if (dev_is_sata(dev) && dev->parent) {
Dan Williams89a73012011-06-30 19:14:33 -0700223 sci_remote_device_post_request(idev, SCU_CONTEXT_COMMAND_POST_RNC_96);
Dan Williams6f231dd2011-07-02 22:56:22 -0700224 } else {
Dan Williams89a73012011-06-30 19:14:33 -0700225 sci_remote_device_post_request(idev, SCU_CONTEXT_COMMAND_POST_RNC_32);
Dan Williams6f231dd2011-07-02 22:56:22 -0700226
Dan Williams11cc5182012-02-01 00:23:10 -0800227 if (!dev->parent)
Dan Williams89a73012011-06-30 19:14:33 -0700228 sci_port_setup_transports(idev->owning_port,
229 sci_rnc->remote_node_index);
Dan Williams6f231dd2011-07-02 22:56:22 -0700230 }
231}
232
Dan Williams89a73012011-06-30 19:14:33 -0700233static void sci_remote_node_context_invalidate_context_buffer(struct sci_remote_node_context *sci_rnc)
Dan Williams6f231dd2011-07-02 22:56:22 -0700234{
235 union scu_remote_node_context *rnc_buffer;
Dan Williams89a73012011-06-30 19:14:33 -0700236 struct isci_remote_device *idev = rnc_to_dev(sci_rnc);
237 struct isci_host *ihost = idev->owning_port->owning_controller;
Dan Williams6f231dd2011-07-02 22:56:22 -0700238
Dan Williams89a73012011-06-30 19:14:33 -0700239 rnc_buffer = sci_rnc_by_id(ihost, sci_rnc->remote_node_index);
Dan Williams6f231dd2011-07-02 22:56:22 -0700240
241 rnc_buffer->ssp.is_valid = false;
242
Dan Williams89a73012011-06-30 19:14:33 -0700243 sci_remote_device_post_request(rnc_to_dev(sci_rnc),
244 SCU_CONTEXT_COMMAND_POST_RNC_INVALIDATE);
Dan Williams6f231dd2011-07-02 22:56:22 -0700245}
246
Dan Williams89a73012011-06-30 19:14:33 -0700247static void sci_remote_node_context_initial_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700248{
Dan Williams89a73012011-06-30 19:14:33 -0700249 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700250
Dan Williamsf34d9e52011-05-12 09:27:52 -0700251 /* Check to see if we have gotten back to the initial state because
252 * someone requested to destroy the remote node context object.
253 */
Edmund Nadolskie3013702011-06-02 00:10:43 +0000254 if (sm->previous_state_id == SCI_RNC_INVALIDATING) {
Dan Williams6f231dd2011-07-02 22:56:22 -0700255 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
Dan Williams89a73012011-06-30 19:14:33 -0700256 sci_remote_node_context_notify_user(rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700257 }
258}
259
Dan Williams89a73012011-06-30 19:14:33 -0700260static void sci_remote_node_context_posting_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700261{
Dan Williams89a73012011-06-30 19:14:33 -0700262 struct sci_remote_node_context *sci_rnc = container_of(sm, typeof(*sci_rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700263
Dan Williams89a73012011-06-30 19:14:33 -0700264 sci_remote_node_context_validate_context_buffer(sci_rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700265}
266
Dan Williams89a73012011-06-30 19:14:33 -0700267static void sci_remote_node_context_invalidating_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700268{
Dan Williams89a73012011-06-30 19:14:33 -0700269 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700270
Dan Williams89a73012011-06-30 19:14:33 -0700271 sci_remote_node_context_invalidate_context_buffer(rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700272}
273
Dan Williams89a73012011-06-30 19:14:33 -0700274static void sci_remote_node_context_resuming_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700275{
Dan Williams89a73012011-06-30 19:14:33 -0700276 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams78a6f062011-06-30 16:31:37 -0700277 struct isci_remote_device *idev;
Dan Williamsa1a113b2011-04-21 18:44:45 -0700278 struct domain_device *dev;
Dan Williams6f231dd2011-07-02 22:56:22 -0700279
Dan Williams78a6f062011-06-30 16:31:37 -0700280 idev = rnc_to_dev(rnc);
281 dev = idev->domain_dev;
Dan Williams6f231dd2011-07-02 22:56:22 -0700282
Henryk Dembkowski24621462011-02-23 00:08:52 -0800283 /*
284 * For direct attached SATA devices we need to clear the TLCR
285 * NCQ to TCi tag mapping on the phy and in cases where we
286 * resume because of a target reset we also need to update
287 * the STPTLDARNI register with the RNi of the device
288 */
Dan Williams11cc5182012-02-01 00:23:10 -0800289 if (dev_is_sata(dev) && !dev->parent)
290 sci_port_setup_transports(idev->owning_port, rnc->remote_node_index);
Henryk Dembkowski24621462011-02-23 00:08:52 -0800291
Dan Williams89a73012011-06-30 19:14:33 -0700292 sci_remote_device_post_request(idev, SCU_CONTEXT_COMMAND_POST_RNC_RESUME);
Dan Williams6f231dd2011-07-02 22:56:22 -0700293}
294
Dan Williams89a73012011-06-30 19:14:33 -0700295static void sci_remote_node_context_ready_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700296{
Dan Williams89a73012011-06-30 19:14:33 -0700297 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700298
Dan Williams6f231dd2011-07-02 22:56:22 -0700299 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
300
Dan Williamsf34d9e52011-05-12 09:27:52 -0700301 if (rnc->user_callback)
Dan Williams89a73012011-06-30 19:14:33 -0700302 sci_remote_node_context_notify_user(rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700303}
304
Dan Williams89a73012011-06-30 19:14:33 -0700305static void sci_remote_node_context_tx_suspended_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700306{
Dan Williams89a73012011-06-30 19:14:33 -0700307 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700308
Dan Williams89a73012011-06-30 19:14:33 -0700309 sci_remote_node_context_continue_state_transitions(rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700310}
311
Dan Williams89a73012011-06-30 19:14:33 -0700312static void sci_remote_node_context_tx_rx_suspended_state_enter(struct sci_base_state_machine *sm)
Dan Williams6f231dd2011-07-02 22:56:22 -0700313{
Dan Williams89a73012011-06-30 19:14:33 -0700314 struct sci_remote_node_context *rnc = container_of(sm, typeof(*rnc), sm);
Dan Williams6f231dd2011-07-02 22:56:22 -0700315
Dan Williams89a73012011-06-30 19:14:33 -0700316 sci_remote_node_context_continue_state_transitions(rnc);
Dan Williams6f231dd2011-07-02 22:56:22 -0700317}
318
Jeff Skirvin6f488442012-03-08 22:41:48 -0800319static void sci_remote_node_context_await_suspend_state_exit(
320 struct sci_base_state_machine *sm)
321{
322 struct sci_remote_node_context *rnc
323 = container_of(sm, typeof(*rnc), sm);
324
325 isci_dev_set_hang_detection_timeout(rnc_to_dev(rnc), 0);
326}
327
Dan Williams89a73012011-06-30 19:14:33 -0700328static const struct sci_base_state sci_remote_node_context_state_table[] = {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000329 [SCI_RNC_INITIAL] = {
Dan Williams89a73012011-06-30 19:14:33 -0700330 .enter_state = sci_remote_node_context_initial_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700331 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000332 [SCI_RNC_POSTING] = {
Dan Williams89a73012011-06-30 19:14:33 -0700333 .enter_state = sci_remote_node_context_posting_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700334 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000335 [SCI_RNC_INVALIDATING] = {
Dan Williams89a73012011-06-30 19:14:33 -0700336 .enter_state = sci_remote_node_context_invalidating_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700337 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000338 [SCI_RNC_RESUMING] = {
Dan Williams89a73012011-06-30 19:14:33 -0700339 .enter_state = sci_remote_node_context_resuming_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700340 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000341 [SCI_RNC_READY] = {
Dan Williams89a73012011-06-30 19:14:33 -0700342 .enter_state = sci_remote_node_context_ready_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700343 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000344 [SCI_RNC_TX_SUSPENDED] = {
Dan Williams89a73012011-06-30 19:14:33 -0700345 .enter_state = sci_remote_node_context_tx_suspended_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700346 },
Edmund Nadolskie3013702011-06-02 00:10:43 +0000347 [SCI_RNC_TX_RX_SUSPENDED] = {
Dan Williams89a73012011-06-30 19:14:33 -0700348 .enter_state = sci_remote_node_context_tx_rx_suspended_state_enter,
Dan Williams6f231dd2011-07-02 22:56:22 -0700349 },
Jeff Skirvin6f488442012-03-08 22:41:48 -0800350 [SCI_RNC_AWAIT_SUSPENSION] = {
351 .exit_state = sci_remote_node_context_await_suspend_state_exit,
352 },
Dan Williams6f231dd2011-07-02 22:56:22 -0700353};
354
Dan Williams89a73012011-06-30 19:14:33 -0700355void sci_remote_node_context_construct(struct sci_remote_node_context *rnc,
Dan Williams96143952011-04-19 18:35:58 -0700356 u16 remote_node_index)
Dan Williams35173d52011-03-26 16:43:01 -0700357{
Dan Williams89a73012011-06-30 19:14:33 -0700358 memset(rnc, 0, sizeof(struct sci_remote_node_context));
Dan Williams35173d52011-03-26 16:43:01 -0700359
360 rnc->remote_node_index = remote_node_index;
Dan Williams35173d52011-03-26 16:43:01 -0700361 rnc->destination_state = SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED;
362
Dan Williams89a73012011-06-30 19:14:33 -0700363 sci_init_sm(&rnc->sm, sci_remote_node_context_state_table, SCI_RNC_INITIAL);
Dan Williams35173d52011-03-26 16:43:01 -0700364}
Dan Williams338e3862011-05-12 07:46:59 -0700365
Dan Williams89a73012011-06-30 19:14:33 -0700366enum sci_status sci_remote_node_context_event_handler(struct sci_remote_node_context *sci_rnc,
Dan Williams338e3862011-05-12 07:46:59 -0700367 u32 event_code)
368{
369 enum scis_sds_remote_node_context_states state;
370
Edmund Nadolskie3013702011-06-02 00:10:43 +0000371 state = sci_rnc->sm.current_state_id;
Dan Williams338e3862011-05-12 07:46:59 -0700372 switch (state) {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000373 case SCI_RNC_POSTING:
Dan Williams338e3862011-05-12 07:46:59 -0700374 switch (scu_get_event_code(event_code)) {
375 case SCU_EVENT_POST_RNC_COMPLETE:
Edmund Nadolskie3013702011-06-02 00:10:43 +0000376 sci_change_state(&sci_rnc->sm, SCI_RNC_READY);
Dan Williams338e3862011-05-12 07:46:59 -0700377 break;
378 default:
379 goto out;
380 }
381 break;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000382 case SCI_RNC_INVALIDATING:
Dan Williams338e3862011-05-12 07:46:59 -0700383 if (scu_get_event_code(event_code) == SCU_EVENT_POST_RNC_INVALIDATE_COMPLETE) {
384 if (sci_rnc->destination_state == SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL)
Edmund Nadolskie3013702011-06-02 00:10:43 +0000385 state = SCI_RNC_INITIAL;
Dan Williams338e3862011-05-12 07:46:59 -0700386 else
Edmund Nadolskie3013702011-06-02 00:10:43 +0000387 state = SCI_RNC_POSTING;
388 sci_change_state(&sci_rnc->sm, state);
Dan Williams338e3862011-05-12 07:46:59 -0700389 } else {
390 switch (scu_get_event_type(event_code)) {
391 case SCU_EVENT_TYPE_RNC_SUSPEND_TX:
392 case SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX:
393 /* We really dont care if the hardware is going to suspend
394 * the device since it's being invalidated anyway */
395 dev_dbg(scirdev_to_dev(rnc_to_dev(sci_rnc)),
396 "%s: SCIC Remote Node Context 0x%p was "
397 "suspeneded by hardware while being "
398 "invalidated.\n", __func__, sci_rnc);
399 break;
400 default:
401 goto out;
402 }
403 }
404 break;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000405 case SCI_RNC_RESUMING:
Dan Williams338e3862011-05-12 07:46:59 -0700406 if (scu_get_event_code(event_code) == SCU_EVENT_POST_RCN_RELEASE) {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000407 sci_change_state(&sci_rnc->sm, SCI_RNC_READY);
Dan Williams338e3862011-05-12 07:46:59 -0700408 } else {
409 switch (scu_get_event_type(event_code)) {
410 case SCU_EVENT_TYPE_RNC_SUSPEND_TX:
411 case SCU_EVENT_TYPE_RNC_SUSPEND_TX_RX:
412 /* We really dont care if the hardware is going to suspend
413 * the device since it's being resumed anyway */
414 dev_dbg(scirdev_to_dev(rnc_to_dev(sci_rnc)),
415 "%s: SCIC Remote Node Context 0x%p was "
416 "suspeneded by hardware while being resumed.\n",
417 __func__, sci_rnc);
418 break;
419 default:
420 goto out;
421 }
422 }
423 break;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000424 case SCI_RNC_READY:
Dan Williams338e3862011-05-12 07:46:59 -0700425 switch (scu_get_event_type(event_code)) {
426 case SCU_EVENT_TL_RNC_SUSPEND_TX:
Edmund Nadolskie3013702011-06-02 00:10:43 +0000427 sci_change_state(&sci_rnc->sm, SCI_RNC_TX_SUSPENDED);
Dan Williams338e3862011-05-12 07:46:59 -0700428 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
429 break;
430 case SCU_EVENT_TL_RNC_SUSPEND_TX_RX:
Edmund Nadolskie3013702011-06-02 00:10:43 +0000431 sci_change_state(&sci_rnc->sm, SCI_RNC_TX_RX_SUSPENDED);
Dan Williams338e3862011-05-12 07:46:59 -0700432 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
433 break;
434 default:
435 goto out;
436 }
437 break;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000438 case SCI_RNC_AWAIT_SUSPENSION:
Dan Williams338e3862011-05-12 07:46:59 -0700439 switch (scu_get_event_type(event_code)) {
440 case SCU_EVENT_TL_RNC_SUSPEND_TX:
Edmund Nadolskie3013702011-06-02 00:10:43 +0000441 sci_change_state(&sci_rnc->sm, SCI_RNC_TX_SUSPENDED);
Dan Williams338e3862011-05-12 07:46:59 -0700442 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
443 break;
444 case SCU_EVENT_TL_RNC_SUSPEND_TX_RX:
Edmund Nadolskie3013702011-06-02 00:10:43 +0000445 sci_change_state(&sci_rnc->sm, SCI_RNC_TX_RX_SUSPENDED);
Dan Williams338e3862011-05-12 07:46:59 -0700446 sci_rnc->suspension_code = scu_get_event_specifier(event_code);
447 break;
448 default:
449 goto out;
450 }
451 break;
452 default:
453 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800454 "%s: invalid state: %s\n", __func__,
455 rnc_state_name(state));
Dan Williams338e3862011-05-12 07:46:59 -0700456 return SCI_FAILURE_INVALID_STATE;
457 }
458 return SCI_SUCCESS;
459
460 out:
461 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800462 "%s: code: %#x state: %s\n", __func__, event_code,
463 rnc_state_name(state));
Dan Williams338e3862011-05-12 07:46:59 -0700464 return SCI_FAILURE;
465
466}
Dan Williamsc845ae92011-05-12 08:26:56 -0700467
Dan Williams89a73012011-06-30 19:14:33 -0700468enum sci_status sci_remote_node_context_destruct(struct sci_remote_node_context *sci_rnc,
Dan Williamsc845ae92011-05-12 08:26:56 -0700469 scics_sds_remote_node_context_callback cb_fn,
470 void *cb_p)
471{
472 enum scis_sds_remote_node_context_states state;
473
Edmund Nadolskie3013702011-06-02 00:10:43 +0000474 state = sci_rnc->sm.current_state_id;
Dan Williamsc845ae92011-05-12 08:26:56 -0700475 switch (state) {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000476 case SCI_RNC_INVALIDATING:
Dan Williams89a73012011-06-30 19:14:33 -0700477 sci_remote_node_context_setup_to_destory(sci_rnc, cb_fn, cb_p);
Dan Williamsc845ae92011-05-12 08:26:56 -0700478 return SCI_SUCCESS;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000479 case SCI_RNC_POSTING:
480 case SCI_RNC_RESUMING:
481 case SCI_RNC_READY:
482 case SCI_RNC_TX_SUSPENDED:
483 case SCI_RNC_TX_RX_SUSPENDED:
484 case SCI_RNC_AWAIT_SUSPENSION:
Dan Williams89a73012011-06-30 19:14:33 -0700485 sci_remote_node_context_setup_to_destory(sci_rnc, cb_fn, cb_p);
Edmund Nadolskie3013702011-06-02 00:10:43 +0000486 sci_change_state(&sci_rnc->sm, SCI_RNC_INVALIDATING);
Dan Williamsc845ae92011-05-12 08:26:56 -0700487 return SCI_SUCCESS;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000488 case SCI_RNC_INITIAL:
Dan Williamsc845ae92011-05-12 08:26:56 -0700489 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800490 "%s: invalid state: %s\n", __func__,
491 rnc_state_name(state));
Dan Williamsc845ae92011-05-12 08:26:56 -0700492 /* We have decided that the destruct request on the remote node context
493 * can not fail since it is either in the initial/destroyed state or is
494 * can be destroyed.
495 */
496 return SCI_SUCCESS;
497 default:
498 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800499 "%s: invalid state %s\n", __func__,
500 rnc_state_name(state));
Dan Williamsc845ae92011-05-12 08:26:56 -0700501 return SCI_FAILURE_INVALID_STATE;
502 }
503}
Dan Williamsed3efb72011-05-12 08:50:23 -0700504
Dan Williams89a73012011-06-30 19:14:33 -0700505enum sci_status sci_remote_node_context_suspend(struct sci_remote_node_context *sci_rnc,
Dan Williamsed3efb72011-05-12 08:50:23 -0700506 u32 suspend_type,
507 scics_sds_remote_node_context_callback cb_fn,
508 void *cb_p)
509{
510 enum scis_sds_remote_node_context_states state;
511
Edmund Nadolskie3013702011-06-02 00:10:43 +0000512 state = sci_rnc->sm.current_state_id;
513 if (state != SCI_RNC_READY) {
Dan Williamsed3efb72011-05-12 08:50:23 -0700514 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800515 "%s: invalid state %s\n", __func__,
516 rnc_state_name(state));
Dan Williamsed3efb72011-05-12 08:50:23 -0700517 return SCI_FAILURE_INVALID_STATE;
518 }
519
520 sci_rnc->user_callback = cb_fn;
521 sci_rnc->user_cookie = cb_p;
522 sci_rnc->suspension_code = suspend_type;
523
524 if (suspend_type == SCI_SOFTWARE_SUSPENSION) {
Dan Williams89a73012011-06-30 19:14:33 -0700525 sci_remote_device_post_request(rnc_to_dev(sci_rnc),
Dan Williamsed3efb72011-05-12 08:50:23 -0700526 SCU_CONTEXT_COMMAND_POST_RNC_SUSPEND_TX);
Jeff Skirvin6f488442012-03-08 22:41:48 -0800527 isci_dev_set_hang_detection_timeout(rnc_to_dev(sci_rnc),
528 0x00000001);
Dan Williamsed3efb72011-05-12 08:50:23 -0700529 }
530
Edmund Nadolskie3013702011-06-02 00:10:43 +0000531 sci_change_state(&sci_rnc->sm, SCI_RNC_AWAIT_SUSPENSION);
Dan Williamsed3efb72011-05-12 08:50:23 -0700532 return SCI_SUCCESS;
533}
534
Dan Williams89a73012011-06-30 19:14:33 -0700535enum sci_status sci_remote_node_context_resume(struct sci_remote_node_context *sci_rnc,
Dan Williamsed3efb72011-05-12 08:50:23 -0700536 scics_sds_remote_node_context_callback cb_fn,
537 void *cb_p)
538{
539 enum scis_sds_remote_node_context_states state;
540
Edmund Nadolskie3013702011-06-02 00:10:43 +0000541 state = sci_rnc->sm.current_state_id;
Dan Williamsed3efb72011-05-12 08:50:23 -0700542 switch (state) {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000543 case SCI_RNC_INITIAL:
Dan Williamsed3efb72011-05-12 08:50:23 -0700544 if (sci_rnc->remote_node_index == SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX)
545 return SCI_FAILURE_INVALID_STATE;
546
Dan Williams89a73012011-06-30 19:14:33 -0700547 sci_remote_node_context_setup_to_resume(sci_rnc, cb_fn, cb_p);
548 sci_remote_node_context_construct_buffer(sci_rnc);
Edmund Nadolskie3013702011-06-02 00:10:43 +0000549 sci_change_state(&sci_rnc->sm, SCI_RNC_POSTING);
Dan Williamsed3efb72011-05-12 08:50:23 -0700550 return SCI_SUCCESS;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000551 case SCI_RNC_POSTING:
552 case SCI_RNC_INVALIDATING:
553 case SCI_RNC_RESUMING:
Dan Williamsed3efb72011-05-12 08:50:23 -0700554 if (sci_rnc->destination_state != SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY)
555 return SCI_FAILURE_INVALID_STATE;
556
557 sci_rnc->user_callback = cb_fn;
558 sci_rnc->user_cookie = cb_p;
559 return SCI_SUCCESS;
Jeff Skirvin56d7c012012-03-08 22:41:49 -0800560 case SCI_RNC_TX_SUSPENDED:
561 case SCI_RNC_TX_RX_SUSPENDED: {
Dan Williams78a6f062011-06-30 16:31:37 -0700562 struct isci_remote_device *idev = rnc_to_dev(sci_rnc);
563 struct domain_device *dev = idev->domain_dev;
Dan Williamsed3efb72011-05-12 08:50:23 -0700564
Jeff Skirvin56d7c012012-03-08 22:41:49 -0800565 /* If this is an expander attached SATA device we must
566 * invalidate and repost the RNC since this is the only way
567 * to clear the TCi to NCQ tag mapping table for the RNi.
568 * All other device types we can just resume.
569 */
Dan Williams89a73012011-06-30 19:14:33 -0700570 sci_remote_node_context_setup_to_resume(sci_rnc, cb_fn, cb_p);
Dan Williamsed3efb72011-05-12 08:50:23 -0700571
Dan Williams11cc5182012-02-01 00:23:10 -0800572 if (dev_is_sata(dev) && dev->parent)
573 sci_change_state(&sci_rnc->sm, SCI_RNC_INVALIDATING);
574 else
Edmund Nadolskie3013702011-06-02 00:10:43 +0000575 sci_change_state(&sci_rnc->sm, SCI_RNC_RESUMING);
Dan Williamsed3efb72011-05-12 08:50:23 -0700576 return SCI_SUCCESS;
577 }
Edmund Nadolskie3013702011-06-02 00:10:43 +0000578 case SCI_RNC_AWAIT_SUSPENSION:
Dan Williams89a73012011-06-30 19:14:33 -0700579 sci_remote_node_context_setup_to_resume(sci_rnc, cb_fn, cb_p);
Dan Williamsed3efb72011-05-12 08:50:23 -0700580 return SCI_SUCCESS;
581 default:
582 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800583 "%s: invalid state %s\n", __func__,
584 rnc_state_name(state));
Dan Williamsed3efb72011-05-12 08:50:23 -0700585 return SCI_FAILURE_INVALID_STATE;
586 }
587}
Dan Williamsf34d9e52011-05-12 09:27:52 -0700588
Dan Williams89a73012011-06-30 19:14:33 -0700589enum sci_status sci_remote_node_context_start_io(struct sci_remote_node_context *sci_rnc,
Dan Williams5076a1a2011-06-27 14:57:03 -0700590 struct isci_request *ireq)
Dan Williamsf34d9e52011-05-12 09:27:52 -0700591{
592 enum scis_sds_remote_node_context_states state;
593
Edmund Nadolskie3013702011-06-02 00:10:43 +0000594 state = sci_rnc->sm.current_state_id;
Jeff Skirvinfd536602011-06-20 14:09:22 -0700595
596 switch (state) {
597 case SCI_RNC_READY:
598 return SCI_SUCCESS;
599 case SCI_RNC_TX_SUSPENDED:
600 case SCI_RNC_TX_RX_SUSPENDED:
601 case SCI_RNC_AWAIT_SUSPENSION:
Dan Williamsf34d9e52011-05-12 09:27:52 -0700602 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800603 "%s: invalid state %s\n", __func__,
604 rnc_state_name(state));
Dan Williamsf34d9e52011-05-12 09:27:52 -0700605 return SCI_FAILURE_REMOTE_DEVICE_RESET_REQUIRED;
Jeff Skirvinfd536602011-06-20 14:09:22 -0700606 default:
Dan Williams14e99b42012-02-10 01:05:43 -0800607 dev_dbg(scirdev_to_dev(rnc_to_dev(sci_rnc)),
608 "%s: invalid state %s\n", __func__,
609 rnc_state_name(state));
610 return SCI_FAILURE_INVALID_STATE;
Dan Williamsf34d9e52011-05-12 09:27:52 -0700611 }
Dan Williamsf34d9e52011-05-12 09:27:52 -0700612}
613
Dan Williams89a73012011-06-30 19:14:33 -0700614enum sci_status sci_remote_node_context_start_task(struct sci_remote_node_context *sci_rnc,
Dan Williams5076a1a2011-06-27 14:57:03 -0700615 struct isci_request *ireq)
Dan Williamsf34d9e52011-05-12 09:27:52 -0700616{
617 enum scis_sds_remote_node_context_states state;
618
Edmund Nadolskie3013702011-06-02 00:10:43 +0000619 state = sci_rnc->sm.current_state_id;
Dan Williamsf34d9e52011-05-12 09:27:52 -0700620 switch (state) {
Edmund Nadolskie3013702011-06-02 00:10:43 +0000621 case SCI_RNC_RESUMING:
622 case SCI_RNC_READY:
623 case SCI_RNC_AWAIT_SUSPENSION:
Dan Williamsf34d9e52011-05-12 09:27:52 -0700624 return SCI_SUCCESS;
Edmund Nadolskie3013702011-06-02 00:10:43 +0000625 case SCI_RNC_TX_SUSPENDED:
626 case SCI_RNC_TX_RX_SUSPENDED:
Dan Williams89a73012011-06-30 19:14:33 -0700627 sci_remote_node_context_resume(sci_rnc, NULL, NULL);
Dan Williamsf34d9e52011-05-12 09:27:52 -0700628 return SCI_SUCCESS;
629 default:
630 dev_warn(scirdev_to_dev(rnc_to_dev(sci_rnc)),
Dan Williams14e99b42012-02-10 01:05:43 -0800631 "%s: invalid state %s\n", __func__,
632 rnc_state_name(state));
Dan Williamsf34d9e52011-05-12 09:27:52 -0700633 return SCI_FAILURE_INVALID_STATE;
634 }
635}