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 _ISCI_REMOTE_DEVICE_H_
57 #define _ISCI_REMOTE_DEVICE_H_
58 #include <scsi/libsas.h>
59 #include <linux/kref.h>
60 #include "scu_remote_node_context.h"
61 #include "remote_node_context.h"
62 #include "port.h"
63
64 enum sci_remote_device_not_ready_reason_code {
65 SCIC_REMOTE_DEVICE_NOT_READY_START_REQUESTED,
66 SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED,
67 SCIC_REMOTE_DEVICE_NOT_READY_SATA_REQUEST_STARTED,
68 SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED,
69 SCIC_REMOTE_DEVICE_NOT_READY_SMP_REQUEST_STARTED,
70 SCIC_REMOTE_DEVICE_NOT_READY_REASON_CODE_MAX
71 };
72
73 /**
74 * isci_remote_device - isci representation of a sas expander / end point
75 * @device_port_width: hw setting for number of simultaneous connections
76 * @connection_rate: per-taskcontext connection rate for this device
77 * @working_request: SATA requests have no tag we for unaccelerated
78 * protocols we need a method to associate unsolicited
79 * frames with a pending request
80 */
81 struct isci_remote_device {
82 #define IDEV_START_PENDING 0
83 #define IDEV_STOP_PENDING 1
84 #define IDEV_ALLOCATED 2
85 #define IDEV_GONE 3
86 #define IDEV_IO_READY 4
87 #define IDEV_IO_NCQERROR 5
88 #define IDEV_RNC_LLHANG_ENABLED 6
89 #define IDEV_ABORT_PATH_ACTIVE 7
90 #define IDEV_ABORT_PATH_RESUME_PENDING 8
91 unsigned long flags;
92 struct kref kref;
93 struct isci_port *isci_port;
94 struct domain_device *domain_dev;
95 struct list_head node;
96 struct sci_base_state_machine sm;
97 u32 device_port_width;
98 enum sas_linkrate connection_rate;
99 struct isci_port *owning_port;
100 struct sci_remote_node_context rnc;
101 /* XXX unify with device reference counting and delete */
102 u32 started_request_count;
103 struct isci_request *working_request;
104 u32 not_ready_reason;
105 scics_sds_remote_node_context_callback abort_resume_cb;
106 void *abort_resume_cbparam;
107 };
108
109 #define ISCI_REMOTE_DEVICE_START_TIMEOUT 5000
110
111 /* device reference routines must be called under sci_lock */
isci_get_device(struct isci_remote_device * idev)112 static inline struct isci_remote_device *isci_get_device(
113 struct isci_remote_device *idev)
114 {
115 if (idev)
116 kref_get(&idev->kref);
117 return idev;
118 }
119
isci_lookup_device(struct domain_device * dev)120 static inline struct isci_remote_device *isci_lookup_device(struct domain_device *dev)
121 {
122 struct isci_remote_device *idev = dev->lldd_dev;
123
124 if (idev && !test_bit(IDEV_GONE, &idev->flags)) {
125 kref_get(&idev->kref);
126 return idev;
127 }
128
129 return NULL;
130 }
131
132 void isci_remote_device_release(struct kref *kref);
isci_put_device(struct isci_remote_device * idev)133 static inline void isci_put_device(struct isci_remote_device *idev)
134 {
135 if (idev)
136 kref_put(&idev->kref, isci_remote_device_release);
137 }
138
139 enum sci_status isci_remote_device_stop(struct isci_host *ihost,
140 struct isci_remote_device *idev);
141 void isci_remote_device_nuke_requests(struct isci_host *ihost,
142 struct isci_remote_device *idev);
143 void isci_remote_device_gone(struct domain_device *domain_dev);
144 int isci_remote_device_found(struct domain_device *domain_dev);
145
146 /**
147 * sci_remote_device_stop() - This method will stop both transmission and
148 * reception of link activity for the supplied remote device. This method
149 * disables normal IO requests from flowing through to the remote device.
150 * @remote_device: This parameter specifies the device to be stopped.
151 * @timeout: This parameter specifies the number of milliseconds in which the
152 * stop operation should complete.
153 *
154 * An indication of whether the device was successfully stopped. SCI_SUCCESS
155 * This value is returned if the transmission and reception for the device was
156 * successfully stopped.
157 */
158 enum sci_status sci_remote_device_stop(
159 struct isci_remote_device *idev,
160 u32 timeout);
161
162 /**
163 * sci_remote_device_reset() - This method will reset the device making it
164 * ready for operation. This method must be called anytime the device is
165 * reset either through a SMP phy control or a port hard reset request.
166 * @remote_device: This parameter specifies the device to be reset.
167 *
168 * This method does not actually cause the device hardware to be reset. This
169 * method resets the software object so that it will be operational after a
170 * device hardware reset completes. An indication of whether the device reset
171 * was accepted. SCI_SUCCESS This value is returned if the device reset is
172 * started.
173 */
174 enum sci_status sci_remote_device_reset(
175 struct isci_remote_device *idev);
176
177 /**
178 * enum sci_remote_device_states - This enumeration depicts all the states
179 * for the common remote device state machine.
180 * @SCI_DEV_INITIAL: Simply the initial state for the base remote device
181 * state machine.
182 *
183 * @SCI_DEV_STOPPED: This state indicates that the remote device has
184 * successfully been stopped. In this state no new IO operations are
185 * permitted. This state is entered from the INITIAL state. This state
186 * is entered from the STOPPING state.
187 *
188 * @SCI_DEV_STARTING: This state indicates the the remote device is in
189 * the process of becoming ready (i.e. starting). In this state no new
190 * IO operations are permitted. This state is entered from the STOPPED
191 * state.
192 *
193 * @SCI_DEV_READY: This state indicates the remote device is now ready.
194 * Thus, the user is able to perform IO operations on the remote device.
195 * This state is entered from the STARTING state.
196 *
197 * @SCI_STP_DEV_IDLE: This is the idle substate for the stp remote
198 * device. When there are no active IO for the device it is is in this
199 * state.
200 *
201 * @SCI_STP_DEV_CMD: This is the command state for for the STP remote
202 * device. This state is entered when the device is processing a
203 * non-NCQ command. The device object will fail any new start IO
204 * requests until this command is complete.
205 *
206 * @SCI_STP_DEV_NCQ: This is the NCQ state for the STP remote device.
207 * This state is entered when the device is processing an NCQ reuqest.
208 * It will remain in this state so long as there is one or more NCQ
209 * requests being processed.
210 *
211 * @SCI_STP_DEV_NCQ_ERROR: This is the NCQ error state for the STP
212 * remote device. This state is entered when an SDB error FIS is
213 * received by the device object while in the NCQ state. The device
214 * object will only accept a READ LOG command while in this state.
215 *
216 * @SCI_STP_DEV_ATAPI_ERROR: This is the ATAPI error state for the STP
217 * ATAPI remote device. This state is entered when ATAPI device sends
218 * error status FIS without data while the device object is in CMD
219 * state. A suspension event is expected in this state. The device
220 * object will resume right away.
221 *
222 * @SCI_STP_DEV_AWAIT_RESET: This is the READY substate indicates the
223 * device is waiting for the RESET task coming to be recovered from
224 * certain hardware specific error.
225 *
226 * @SCI_SMP_DEV_IDLE: This is the ready operational substate for the
227 * remote device. This is the normal operational state for a remote
228 * device.
229 *
230 * @SCI_SMP_DEV_CMD: This is the suspended state for the remote device.
231 * This is the state that the device is placed in when a RNC suspend is
232 * received by the SCU hardware.
233 *
234 * @SCI_DEV_STOPPING: This state indicates that the remote device is in
235 * the process of stopping. In this state no new IO operations are
236 * permitted, but existing IO operations are allowed to complete. This
237 * state is entered from the READY state. This state is entered from
238 * the FAILED state.
239 *
240 * @SCI_DEV_FAILED: This state indicates that the remote device has
241 * failed. In this state no new IO operations are permitted. This
242 * state is entered from the INITIALIZING state. This state is entered
243 * from the READY state.
244 *
245 * @SCI_DEV_RESETTING: This state indicates the device is being reset.
246 * In this state no new IO operations are permitted. This state is
247 * entered from the READY state.
248 *
249 * @SCI_DEV_FINAL: Simply the final state for the base remote device
250 * state machine.
251 */
252 #define REMOTE_DEV_STATES {\
253 C(DEV_INITIAL),\
254 C(DEV_STOPPED),\
255 C(DEV_STARTING),\
256 C(DEV_READY),\
257 C(STP_DEV_IDLE),\
258 C(STP_DEV_CMD),\
259 C(STP_DEV_NCQ),\
260 C(STP_DEV_NCQ_ERROR),\
261 C(STP_DEV_ATAPI_ERROR),\
262 C(STP_DEV_AWAIT_RESET),\
263 C(SMP_DEV_IDLE),\
264 C(SMP_DEV_CMD),\
265 C(DEV_STOPPING),\
266 C(DEV_FAILED),\
267 C(DEV_RESETTING),\
268 C(DEV_FINAL),\
269 }
270 #undef C
271 #define C(a) SCI_##a
272 enum sci_remote_device_states REMOTE_DEV_STATES;
273 #undef C
274 const char *dev_state_name(enum sci_remote_device_states state);
275
rnc_to_dev(struct sci_remote_node_context * rnc)276 static inline struct isci_remote_device *rnc_to_dev(struct sci_remote_node_context *rnc)
277 {
278 struct isci_remote_device *idev;
279
280 idev = container_of(rnc, typeof(*idev), rnc);
281
282 return idev;
283 }
284
sci_remote_device_decrement_request_count(struct isci_remote_device * idev)285 static inline void sci_remote_device_decrement_request_count(struct isci_remote_device *idev)
286 {
287 /* XXX delete this voodoo when converting to the top-level device
288 * reference count
289 */
290 if (WARN_ONCE(idev->started_request_count == 0,
291 "%s: tried to decrement started_request_count past 0!?",
292 __func__))
293 /* pass */;
294 else
295 idev->started_request_count--;
296 }
297
298 void isci_dev_set_hang_detection_timeout(struct isci_remote_device *idev, u32 timeout);
299
300 enum sci_status sci_remote_device_frame_handler(
301 struct isci_remote_device *idev,
302 u32 frame_index);
303
304 enum sci_status sci_remote_device_event_handler(
305 struct isci_remote_device *idev,
306 u32 event_code);
307
308 enum sci_status sci_remote_device_start_io(
309 struct isci_host *ihost,
310 struct isci_remote_device *idev,
311 struct isci_request *ireq);
312
313 enum sci_status sci_remote_device_start_task(
314 struct isci_host *ihost,
315 struct isci_remote_device *idev,
316 struct isci_request *ireq);
317
318 enum sci_status sci_remote_device_complete_io(
319 struct isci_host *ihost,
320 struct isci_remote_device *idev,
321 struct isci_request *ireq);
322
323 void sci_remote_device_post_request(
324 struct isci_remote_device *idev,
325 u32 request);
326
327 enum sci_status sci_remote_device_terminate_requests(
328 struct isci_remote_device *idev);
329
330 int isci_remote_device_is_safe_to_abort(
331 struct isci_remote_device *idev);
332
333 enum sci_status
334 sci_remote_device_abort_requests_pending_abort(
335 struct isci_remote_device *idev);
336
337 enum sci_status isci_remote_device_suspend(
338 struct isci_host *ihost,
339 struct isci_remote_device *idev);
340
341 enum sci_status sci_remote_device_resume(
342 struct isci_remote_device *idev,
343 scics_sds_remote_node_context_callback cb_fn,
344 void *cb_p);
345
346 enum sci_status isci_remote_device_resume_from_abort(
347 struct isci_host *ihost,
348 struct isci_remote_device *idev);
349
350 enum sci_status isci_remote_device_reset(
351 struct isci_host *ihost,
352 struct isci_remote_device *idev);
353
354 enum sci_status isci_remote_device_suspend_terminate(
355 struct isci_host *ihost,
356 struct isci_remote_device *idev,
357 struct isci_request *ireq);
358
359 enum sci_status isci_remote_device_terminate_requests(
360 struct isci_host *ihost,
361 struct isci_remote_device *idev,
362 struct isci_request *ireq);
363 enum sci_status sci_remote_device_suspend(struct isci_remote_device *idev,
364 enum sci_remote_node_suspension_reasons reason);
365 #endif /* !defined(_ISCI_REMOTE_DEVICE_H_) */
366