2 * This file is provided under a dual BSD/GPLv2 license. When using or
3 * redistributing this file, you may do so under either license.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
33 * * Redistributions of source code must retain the above copyright
34 * notice, this list of conditions and the following disclaimer.
35 * * Redistributions in binary form must reproduce the above copyright
36 * notice, this list of conditions and the following disclaimer in
37 * the documentation and/or other materials provided with the
39 * * Neither the name of Intel Corporation nor the names of its
40 * contributors may be used to endorse or promote products derived
41 * from this software without specific prior written permission.
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56 #ifndef _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
57 #define _SCIC_SDS_REMOTE_NODE_CONTEXT_H_
60 * This file contains the structures, constants, and prototypes associated with
61 * the remote node context in the silicon. It exists to model and manage
62 * the remote node context in the silicon.
67 #include "state_machine.h"
72 * This constant represents an invalid remote device id, it is used to program
73 * the STPDARNI register so the driver knows when it has received a SIGNATURE
76 #define SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX 0x0FFF
78 #define SCU_HARDWARE_SUSPENSION (0)
79 #define SCI_SOFTWARE_SUSPENSION (1)
81 struct scic_sds_request;
82 struct scic_sds_remote_device;
83 struct scic_sds_remote_node_context;
85 typedef void (*scics_sds_remote_node_context_callback)(void *);
87 typedef enum sci_status (*scic_sds_remote_node_context_operation)(
88 struct scic_sds_remote_node_context *sci_rnc,
89 scics_sds_remote_node_context_callback callback,
90 void *callback_parameter
93 typedef enum sci_status (*scic_sds_remote_node_context_suspend_operation)(
94 struct scic_sds_remote_node_context *sci_rnc,
96 scics_sds_remote_node_context_callback callback,
97 void *callback_parameter
100 typedef enum sci_status (*scic_sds_remote_node_context_io_request)(
101 struct scic_sds_remote_node_context *sci_rnc,
102 struct scic_sds_request *sci_req
105 struct scic_sds_remote_node_context_handlers {
107 * This handler is invoked when there is a request to suspend the RNC. The
108 * callback is invoked after the hardware notification that the remote node is
111 scic_sds_remote_node_context_suspend_operation suspend_handler;
114 * This handler is invoked when there is a request to resume the RNC. The
115 * callback is invoked when after the RNC has reached the ready state.
117 scic_sds_remote_node_context_operation resume_handler;
120 * This handler is invoked when there is a request to start an io request
123 scic_sds_remote_node_context_io_request start_io_handler;
126 * This handler is invoked when there is a request to start a task request
129 scic_sds_remote_node_context_io_request start_task_handler;
133 * This is the enumeration of the remote node context states.
135 enum scis_sds_remote_node_context_states {
137 * This state is the initial state for a remote node context. On a resume
138 * request the remote node context will transition to the posting state.
140 SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE,
143 * This is a transition state that posts the RNi to the hardware. Once the RNC
144 * is posted the remote node context will be made ready.
146 SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE,
149 * This is a transition state that will post an RNC invalidate to the
150 * hardware. Once the invalidate is complete the remote node context will
151 * transition to the posting state.
153 SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE,
156 * This is a transition state that will post an RNC resume to the hardare.
157 * Once the event notification of resume complete is received the remote node
158 * context will transition to the ready state.
160 SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE,
163 * This is the state that the remote node context must be in to accept io
164 * request operations.
166 SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE,
169 * This is the state that the remote node context transitions to when it gets
170 * a TX suspend notification from the hardware.
172 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE,
175 * This is the state that the remote node context transitions to when it gets
176 * a TX RX suspend notification from the hardware.
178 SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE,
181 * This state is a wait state for the remote node context that waits for a
182 * suspend notification from the hardware. This state is entered when either
183 * there is a request to supend the remote node context or when there is a TC
184 * completion where the remote node will be suspended by the hardware.
186 SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE
192 * This enumeration is used to define the end destination state for the remote
195 enum scic_sds_remote_node_context_destination_state {
196 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED,
197 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY,
198 SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL
202 * struct scic_sds_remote_node_context - This structure contains the data
203 * associated with the remote node context object. The remote node context
204 * (RNC) object models the the remote device information necessary to manage
207 struct scic_sds_remote_node_context {
209 * This field indicates the remote node index (RNI) associated with
212 u16 remote_node_index;
215 * This field is the recored suspension code or the reason for the remote node
216 * context suspension.
221 * This field is true if the remote node context is resuming from its current
222 * state. This can cause an automatic resume on receiving a suspension
225 enum scic_sds_remote_node_context_destination_state destination_state;
228 * This field contains the callback function that the user requested to be
229 * called when the requested state transition is complete.
231 scics_sds_remote_node_context_callback user_callback;
234 * This field contains the parameter that is called when the user requested
235 * state transition is completed.
240 * This field contains the data for the object's state machine.
242 struct sci_base_state_machine state_machine;
244 struct scic_sds_remote_node_context_handlers *state_handlers;
247 void scic_sds_remote_node_context_construct(struct scic_sds_remote_node_context *rnc,
248 u16 remote_node_index);
251 bool scic_sds_remote_node_context_is_ready(
252 struct scic_sds_remote_node_context *sci_rnc);
254 #define scic_sds_remote_node_context_get_remote_node_index(rcn) \
255 ((rnc)->remote_node_index)
257 enum sci_status scic_sds_remote_node_context_event_handler(struct scic_sds_remote_node_context *sci_rnc,
260 enum sci_status scic_sds_remote_node_context_destruct(struct scic_sds_remote_node_context *sci_rnc,
261 scics_sds_remote_node_context_callback callback,
262 void *callback_parameter);
263 #define scic_sds_remote_node_context_resume(rnc, callback, parameter) \
264 ((rnc)->state_handlers->resume_handler(rnc, callback, parameter))
266 #define scic_sds_remote_node_context_suspend(rnc, suspend_type, callback, parameter) \
267 ((rnc)->state_handlers->suspend_handler(rnc, suspend_type, callback, parameter))
269 #define scic_sds_remote_node_context_start_io(rnc, request) \
270 ((rnc)->state_handlers->start_io_handler(rnc, request))
272 #define scic_sds_remote_node_context_start_task(rnc, task) \
273 ((rnc)->state_handlers->start_task_handler(rnc, task))
275 #endif /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */