Commit | Line | Data |
---|---|---|
6f231dda DW |
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 | #ifndef _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ | |
57 | #define _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ | |
58 | ||
59 | /** | |
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. | |
63 | * | |
64 | * | |
65 | */ | |
66 | ||
6f231dda DW |
67 | #include "sci_base_state.h" |
68 | #include "sci_base_state_machine.h" | |
69 | ||
6f231dda DW |
70 | /** |
71 | * | |
72 | * | |
73 | * This constant represents an invalid remote device id, it is used to program | |
74 | * the STPDARNI register so the driver knows when it has received a SIGNATURE | |
75 | * FIS from the SCU. | |
76 | */ | |
77 | #define SCIC_SDS_REMOTE_NODE_CONTEXT_INVALID_INDEX 0x0FFF | |
78 | ||
79 | #define SCU_HARDWARE_SUSPENSION (0) | |
80 | #define SCI_SOFTWARE_SUSPENSION (1) | |
81 | ||
82 | struct scic_sds_request; | |
83 | struct scic_sds_remote_device; | |
84 | struct scic_sds_remote_node_context; | |
85 | ||
7fbafaa5 | 86 | typedef void (*scics_sds_remote_node_context_callback)(void *); |
6f231dda | 87 | |
7fbafaa5 | 88 | typedef enum sci_status (*scic_sds_remote_node_context_operation)( |
e2023b87 DJ |
89 | struct scic_sds_remote_node_context *sci_rnc, |
90 | scics_sds_remote_node_context_callback callback, | |
6f231dda DW |
91 | void *callback_parameter |
92 | ); | |
93 | ||
7fbafaa5 | 94 | typedef enum sci_status (*scic_sds_remote_node_context_suspend_operation)( |
e2023b87 | 95 | struct scic_sds_remote_node_context *sci_rnc, |
6f231dda | 96 | u32 suspension_type, |
e2023b87 | 97 | scics_sds_remote_node_context_callback callback, |
6f231dda DW |
98 | void *callback_parameter |
99 | ); | |
100 | ||
7fbafaa5 | 101 | typedef enum sci_status (*scic_sds_remote_node_context_io_request)( |
e2023b87 DJ |
102 | struct scic_sds_remote_node_context *sci_rnc, |
103 | struct scic_sds_request *sci_req | |
6f231dda DW |
104 | ); |
105 | ||
7fbafaa5 | 106 | typedef enum sci_status (*scic_sds_remote_node_context_event_handler)( |
e2023b87 | 107 | struct scic_sds_remote_node_context *sci_rnc, |
6f231dda DW |
108 | u32 event_code |
109 | ); | |
110 | ||
6f231dda DW |
111 | struct scic_sds_remote_node_context_handlers { |
112 | /** | |
113 | * This handle is invoked to stop the RNC. The callback is invoked when after | |
114 | * the hardware notification that the RNC has been invalidated. | |
115 | */ | |
7fbafaa5 | 116 | scic_sds_remote_node_context_operation destruct_handler; |
6f231dda DW |
117 | |
118 | /** | |
119 | * This handler is invoked when there is a request to suspend the RNC. The | |
120 | * callback is invoked after the hardware notification that the remote node is | |
121 | * suspended. | |
122 | */ | |
7fbafaa5 | 123 | scic_sds_remote_node_context_suspend_operation suspend_handler; |
6f231dda DW |
124 | |
125 | /** | |
126 | * This handler is invoked when there is a request to resume the RNC. The | |
127 | * callback is invoked when after the RNC has reached the ready state. | |
128 | */ | |
7fbafaa5 | 129 | scic_sds_remote_node_context_operation resume_handler; |
6f231dda DW |
130 | |
131 | /** | |
132 | * This handler is invoked when there is a request to start an io request | |
133 | * operation. | |
134 | */ | |
7fbafaa5 | 135 | scic_sds_remote_node_context_io_request start_io_handler; |
6f231dda DW |
136 | |
137 | /** | |
138 | * This handler is invoked when there is a request to start a task request | |
139 | * operation. | |
140 | */ | |
7fbafaa5 | 141 | scic_sds_remote_node_context_io_request start_task_handler; |
6f231dda DW |
142 | |
143 | /** | |
144 | * This handler is invoked where there is an RNC event that must be processed. | |
145 | */ | |
7fbafaa5 | 146 | scic_sds_remote_node_context_event_handler event_handler; |
6f231dda DW |
147 | |
148 | }; | |
149 | ||
6f231dda | 150 | /** |
6f231dda DW |
151 | * This is the enumeration of the remote node context states. |
152 | */ | |
153 | enum scis_sds_remote_node_context_states { | |
154 | /** | |
155 | * This state is the initial state for a remote node context. On a resume | |
156 | * request the remote node context will transition to the posting state. | |
157 | */ | |
158 | SCIC_SDS_REMOTE_NODE_CONTEXT_INITIAL_STATE, | |
159 | ||
160 | /** | |
161 | * This is a transition state that posts the RNi to the hardware. Once the RNC | |
162 | * is posted the remote node context will be made ready. | |
163 | */ | |
164 | SCIC_SDS_REMOTE_NODE_CONTEXT_POSTING_STATE, | |
165 | ||
166 | /** | |
167 | * This is a transition state that will post an RNC invalidate to the | |
168 | * hardware. Once the invalidate is complete the remote node context will | |
169 | * transition to the posting state. | |
170 | */ | |
171 | SCIC_SDS_REMOTE_NODE_CONTEXT_INVALIDATING_STATE, | |
172 | ||
173 | /** | |
174 | * This is a transition state that will post an RNC resume to the hardare. | |
175 | * Once the event notification of resume complete is received the remote node | |
176 | * context will transition to the ready state. | |
177 | */ | |
178 | SCIC_SDS_REMOTE_NODE_CONTEXT_RESUMING_STATE, | |
179 | ||
180 | /** | |
181 | * This is the state that the remote node context must be in to accept io | |
182 | * request operations. | |
183 | */ | |
184 | SCIC_SDS_REMOTE_NODE_CONTEXT_READY_STATE, | |
185 | ||
186 | /** | |
187 | * This is the state that the remote node context transitions to when it gets | |
188 | * a TX suspend notification from the hardware. | |
189 | */ | |
190 | SCIC_SDS_REMOTE_NODE_CONTEXT_TX_SUSPENDED_STATE, | |
191 | ||
192 | /** | |
193 | * This is the state that the remote node context transitions to when it gets | |
194 | * a TX RX suspend notification from the hardware. | |
195 | */ | |
196 | SCIC_SDS_REMOTE_NODE_CONTEXT_TX_RX_SUSPENDED_STATE, | |
197 | ||
198 | /** | |
199 | * This state is a wait state for the remote node context that waits for a | |
200 | * suspend notification from the hardware. This state is entered when either | |
201 | * there is a request to supend the remote node context or when there is a TC | |
202 | * completion where the remote node will be suspended by the hardware. | |
203 | */ | |
a98a7426 | 204 | SCIC_SDS_REMOTE_NODE_CONTEXT_AWAIT_SUSPENSION_STATE |
6f231dda DW |
205 | }; |
206 | ||
207 | /** | |
208 | * | |
209 | * | |
210 | * This enumeration is used to define the end destination state for the remote | |
211 | * node context. | |
212 | */ | |
de728b7d | 213 | enum scic_sds_remote_node_context_destination_state { |
6f231dda DW |
214 | SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_UNSPECIFIED, |
215 | SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_READY, | |
216 | SCIC_SDS_REMOTE_NODE_DESTINATION_STATE_FINAL | |
217 | }; | |
218 | ||
219 | /** | |
220 | * struct scic_sds_remote_node_context - This structure contains the data | |
221 | * associated with the remote node context object. The remote node context | |
222 | * (RNC) object models the the remote device information necessary to manage | |
223 | * the silicon RNC. | |
6f231dda DW |
224 | */ |
225 | struct scic_sds_remote_node_context { | |
6f231dda DW |
226 | /** |
227 | * This field indicates the remote node index (RNI) associated with | |
228 | * this RNC. | |
229 | */ | |
230 | u16 remote_node_index; | |
231 | ||
232 | /** | |
233 | * This field is the recored suspension code or the reason for the remote node | |
234 | * context suspension. | |
235 | */ | |
236 | u32 suspension_code; | |
237 | ||
238 | /** | |
239 | * This field is true if the remote node context is resuming from its current | |
240 | * state. This can cause an automatic resume on receiving a suspension | |
241 | * notification. | |
242 | */ | |
de728b7d | 243 | enum scic_sds_remote_node_context_destination_state destination_state; |
6f231dda DW |
244 | |
245 | /** | |
246 | * This field contains the callback function that the user requested to be | |
247 | * called when the requested state transition is complete. | |
248 | */ | |
7fbafaa5 | 249 | scics_sds_remote_node_context_callback user_callback; |
6f231dda DW |
250 | |
251 | /** | |
252 | * This field contains the parameter that is called when the user requested | |
253 | * state transition is completed. | |
254 | */ | |
255 | void *user_cookie; | |
256 | ||
257 | /** | |
258 | * This field contains the data for the object's state machine. | |
259 | */ | |
260 | struct sci_base_state_machine state_machine; | |
261 | ||
262 | struct scic_sds_remote_node_context_handlers *state_handlers; | |
263 | }; | |
264 | ||
9614395e DW |
265 | void scic_sds_remote_node_context_construct(struct scic_sds_remote_node_context *rnc, |
266 | u16 remote_node_index); | |
6f231dda | 267 | |
6f231dda | 268 | |
6f231dda | 269 | bool scic_sds_remote_node_context_is_ready( |
e2023b87 | 270 | struct scic_sds_remote_node_context *sci_rnc); |
6f231dda | 271 | |
6f231dda DW |
272 | #define scic_sds_remote_node_context_get_remote_node_index(rcn) \ |
273 | ((rnc)->remote_node_index) | |
274 | ||
275 | #define scic_sds_remote_node_context_event_handler(rnc, event_code) \ | |
276 | ((rnc)->state_handlers->event_handler(rnc, event_code)) | |
277 | ||
278 | #define scic_sds_remote_node_context_resume(rnc, callback, parameter) \ | |
279 | ((rnc)->state_handlers->resume_handler(rnc, callback, parameter)) | |
280 | ||
281 | #define scic_sds_remote_node_context_suspend(rnc, suspend_type, callback, parameter) \ | |
282 | ((rnc)->state_handlers->suspend_handler(rnc, suspend_type, callback, parameter)) | |
283 | ||
284 | #define scic_sds_remote_node_context_destruct(rnc, callback, parameter) \ | |
285 | ((rnc)->state_handlers->destruct_handler(rnc, callback, parameter)) | |
286 | ||
287 | #define scic_sds_remote_node_context_start_io(rnc, request) \ | |
288 | ((rnc)->state_handlers->start_io_handler(rnc, request)) | |
289 | ||
290 | #define scic_sds_remote_node_context_start_task(rnc, task) \ | |
291 | ((rnc)->state_handlers->start_task_handler(rnc, task)) | |
292 | ||
6f231dda | 293 | #endif /* _SCIC_SDS_REMOTE_NODE_CONTEXT_H_ */ |