isci: unify remote_device suspend_handlers
[linux-2.6.git] / drivers / scsi / isci / remote_device.h
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 "sci_status.h"
60 #include "intel_sas.h"
61 #include "scu_remote_node_context.h"
62 #include "remote_node_context.h"
63 #include "port.h"
64
65 enum scic_remote_device_not_ready_reason_code {
66         SCIC_REMOTE_DEVICE_NOT_READY_START_REQUESTED,
67         SCIC_REMOTE_DEVICE_NOT_READY_STOP_REQUESTED,
68         SCIC_REMOTE_DEVICE_NOT_READY_SATA_REQUEST_STARTED,
69         SCIC_REMOTE_DEVICE_NOT_READY_SATA_SDB_ERROR_FIS_RECEIVED,
70         SCIC_REMOTE_DEVICE_NOT_READY_SMP_REQUEST_STARTED,
71         SCIC_REMOTE_DEVICE_NOT_READY_REASON_CODE_MAX
72 };
73
74 struct scic_sds_remote_device {
75         /**
76          * This field contains the information for the base remote device state
77          * machine.
78          */
79         struct sci_base_state_machine state_machine;
80
81         /**
82          * This field is the programmed device port width.  This value is
83          * written to the RCN data structure to tell the SCU how many open
84          * connections this device can have.
85          */
86         u32 device_port_width;
87
88         /**
89          * This field is the programmed connection rate for this remote device.  It is
90          * used to program the TC with the maximum allowed connection rate.
91          */
92         enum sas_linkrate connection_rate;
93
94         /**
95          * This filed is assinged the value of true if the device is directly
96          * attached to the port.
97          */
98         bool is_direct_attached;
99
100         /**
101          * This filed contains a pointer back to the port to which this device
102          * is assigned.
103          */
104         struct scic_sds_port *owning_port;
105
106         /**
107          * This field contains the SCU silicon remote node context specific
108          * information.
109          */
110         struct scic_sds_remote_node_context rnc;
111
112         /**
113          * This field contains the stated request count for the remote device.  The
114          * device can not reach the SCI_BASE_REMOTE_DEVICE_STATE_STOPPED until all
115          * requests are complete and the rnc_posted value is false.
116          */
117         u32 started_request_count;
118
119         /**
120          * This field contains a pointer to the working request object.  It is only
121          * used only for SATA requests since the unsolicited frames we get from the
122          * hardware have no Tag value to look up the io request object.
123          */
124         struct scic_sds_request *working_request;
125
126         /**
127          * This field contains the reason for the remote device going not_ready.  It is
128          * assigned in the state handlers and used in the state transition.
129          */
130         u32 not_ready_reason;
131
132         /**
133          * This field maintains the set of state handlers for the remote device
134          * object.  These are changed each time the remote device enters a new state.
135          */
136         const struct scic_sds_remote_device_state_handler *state_handlers;
137 };
138
139 struct isci_remote_device {
140         enum isci_status status;
141         #define IDEV_START_PENDING 0
142         #define IDEV_STOP_PENDING 1
143         #define IDEV_ALLOCATED 2
144         unsigned long flags;
145         struct isci_port *isci_port;
146         struct domain_device *domain_dev;
147         struct list_head node;
148         struct list_head reqs_in_process;
149         spinlock_t state_lock;
150         struct scic_sds_remote_device sci;
151 };
152
153 #define ISCI_REMOTE_DEVICE_START_TIMEOUT 5000
154
155 enum sci_status isci_remote_device_stop(struct isci_host *ihost,
156                                         struct isci_remote_device *idev);
157 void isci_remote_device_nuke_requests(struct isci_host *ihost,
158                                       struct isci_remote_device *idev);
159 void isci_remote_device_gone(struct domain_device *domain_dev);
160 int isci_remote_device_found(struct domain_device *domain_dev);
161 bool isci_device_is_reset_pending(struct isci_host *ihost,
162                                   struct isci_remote_device *idev);
163 void isci_device_clear_reset_pending(struct isci_host *ihost,
164                                      struct isci_remote_device *idev);
165 void isci_remote_device_change_state(struct isci_remote_device *idev,
166                                      enum isci_status status);
167 /**
168  * scic_remote_device_stop() - This method will stop both transmission and
169  *    reception of link activity for the supplied remote device.  This method
170  *    disables normal IO requests from flowing through to the remote device.
171  * @remote_device: This parameter specifies the device to be stopped.
172  * @timeout: This parameter specifies the number of milliseconds in which the
173  *    stop operation should complete.
174  *
175  * An indication of whether the device was successfully stopped. SCI_SUCCESS
176  * This value is returned if the transmission and reception for the device was
177  * successfully stopped.
178  */
179 enum sci_status scic_remote_device_stop(
180         struct scic_sds_remote_device *remote_device,
181         u32 timeout);
182
183 /**
184  * scic_remote_device_reset() - This method will reset the device making it
185  *    ready for operation. This method must be called anytime the device is
186  *    reset either through a SMP phy control or a port hard reset request.
187  * @remote_device: This parameter specifies the device to be reset.
188  *
189  * This method does not actually cause the device hardware to be reset. This
190  * method resets the software object so that it will be operational after a
191  * device hardware reset completes. An indication of whether the device reset
192  * was accepted. SCI_SUCCESS This value is returned if the device reset is
193  * started.
194  */
195 enum sci_status scic_remote_device_reset(
196         struct scic_sds_remote_device *remote_device);
197
198 /**
199  * scic_remote_device_reset_complete() - This method informs the device object
200  *    that the reset operation is complete and the device can resume operation
201  *    again.
202  * @remote_device: This parameter specifies the device which is to be informed
203  *    of the reset complete operation.
204  *
205  * An indication that the device is resuming operation. SCI_SUCCESS the device
206  * is resuming operation.
207  */
208 enum sci_status scic_remote_device_reset_complete(
209         struct scic_sds_remote_device *remote_device);
210
211 #define scic_remote_device_is_atapi(device_handle) false
212
213 /**
214  * enum scic_sds_remote_device_states - This enumeration depicts all the states
215  *    for the common remote device state machine.
216  *
217  *
218  */
219 enum scic_sds_remote_device_states {
220         /**
221          * Simply the initial state for the base remote device state machine.
222          */
223         SCI_BASE_REMOTE_DEVICE_STATE_INITIAL,
224
225         /**
226          * This state indicates that the remote device has successfully been
227          * stopped.  In this state no new IO operations are permitted.
228          * This state is entered from the INITIAL state.
229          * This state is entered from the STOPPING state.
230          */
231         SCI_BASE_REMOTE_DEVICE_STATE_STOPPED,
232
233         /**
234          * This state indicates the the remote device is in the process of
235          * becoming ready (i.e. starting).  In this state no new IO operations
236          * are permitted.
237          * This state is entered from the STOPPED state.
238          */
239         SCI_BASE_REMOTE_DEVICE_STATE_STARTING,
240
241         /**
242          * This state indicates the remote device is now ready.  Thus, the user
243          * is able to perform IO operations on the remote device.
244          * This state is entered from the STARTING state.
245          */
246         SCI_BASE_REMOTE_DEVICE_STATE_READY,
247
248         /**
249          * This is the idle substate for the stp remote device.  When there are no
250          * active IO for the device it is is in this state.
251          */
252         SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_IDLE,
253
254         /**
255          * This is the command state for for the STP remote device.  This state is
256          * entered when the device is processing a non-NCQ command.  The device object
257          * will fail any new start IO requests until this command is complete.
258          */
259         SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_CMD,
260
261         /**
262          * This is the NCQ state for the STP remote device.  This state is entered
263          * when the device is processing an NCQ reuqest.  It will remain in this state
264          * so long as there is one or more NCQ requests being processed.
265          */
266         SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ,
267
268         /**
269          * This is the NCQ error state for the STP remote device.  This state is
270          * entered when an SDB error FIS is received by the device object while in the
271          * NCQ state.  The device object will only accept a READ LOG command while in
272          * this state.
273          */
274         SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_NCQ_ERROR,
275
276         /**
277          * This is the READY substate indicates the device is waiting for the RESET task
278          * coming to be recovered from certain hardware specific error.
279          */
280         SCIC_SDS_STP_REMOTE_DEVICE_READY_SUBSTATE_AWAIT_RESET,
281
282         /**
283          * This is the ready operational substate for the remote device.  This is the
284          * normal operational state for a remote device.
285          */
286         SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_IDLE,
287
288         /**
289          * This is the suspended state for the remote device.  This is the state that
290          * the device is placed in when a RNC suspend is received by the SCU hardware.
291          */
292         SCIC_SDS_SMP_REMOTE_DEVICE_READY_SUBSTATE_CMD,
293
294         /**
295          * This state indicates that the remote device is in the process of
296          * stopping.  In this state no new IO operations are permitted, but
297          * existing IO operations are allowed to complete.
298          * This state is entered from the READY state.
299          * This state is entered from the FAILED state.
300          */
301         SCI_BASE_REMOTE_DEVICE_STATE_STOPPING,
302
303         /**
304          * This state indicates that the remote device has failed.
305          * In this state no new IO operations are permitted.
306          * This state is entered from the INITIALIZING state.
307          * This state is entered from the READY state.
308          */
309         SCI_BASE_REMOTE_DEVICE_STATE_FAILED,
310
311         /**
312          * This state indicates the device is being reset.
313          * In this state no new IO operations are permitted.
314          * This state is entered from the READY state.
315          */
316         SCI_BASE_REMOTE_DEVICE_STATE_RESETTING,
317
318         /**
319          * Simply the final state for the base remote device state machine.
320          */
321         SCI_BASE_REMOTE_DEVICE_STATE_FINAL,
322 };
323
324 static inline struct scic_sds_remote_device *rnc_to_dev(struct scic_sds_remote_node_context *rnc)
325 {
326         struct scic_sds_remote_device *sci_dev;
327
328         sci_dev = container_of(rnc, typeof(*sci_dev), rnc);
329
330         return sci_dev;
331 }
332
333 static inline struct isci_remote_device *sci_dev_to_idev(struct scic_sds_remote_device *sci_dev)
334 {
335         struct isci_remote_device *idev = container_of(sci_dev, typeof(*idev), sci);
336
337         return idev;
338 }
339
340 static inline struct domain_device *sci_dev_to_domain(struct scic_sds_remote_device *sci_dev)
341 {
342         return sci_dev_to_idev(sci_dev)->domain_dev;
343 }
344
345 static inline bool dev_is_expander(struct domain_device *dev)
346 {
347         return dev->dev_type == EDGE_DEV || dev->dev_type == FANOUT_DEV;
348 }
349
350 typedef enum sci_status (*scic_sds_remote_device_request_handler_t)(
351         struct scic_sds_remote_device *device,
352         struct scic_sds_request *request);
353
354 typedef enum sci_status (*scic_sds_remote_device_high_priority_request_complete_handler_t)(
355         struct scic_sds_remote_device *device,
356         struct scic_sds_request *request,
357         void *,
358         enum sci_io_status);
359
360 typedef enum sci_status (*scic_sds_remote_device_handler_t)(
361         struct scic_sds_remote_device *sci_dev);
362
363 typedef enum sci_status (*scic_sds_remote_device_suspend_handler_t)(
364         struct scic_sds_remote_device *sci_dev,
365         u32 suspend_type);
366
367 typedef enum sci_status (*scic_sds_remote_device_resume_handler_t)(
368         struct scic_sds_remote_device *sci_dev);
369
370 typedef enum sci_status (*scic_sds_remote_device_frame_handler_t)(
371         struct scic_sds_remote_device *sci_dev,
372         u32 frame_index);
373
374 typedef enum sci_status (*scic_sds_remote_device_event_handler_t)(
375         struct scic_sds_remote_device *sci_dev,
376         u32 event_code);
377
378 typedef void (*scic_sds_remote_device_ready_not_ready_handler_t)(
379         struct scic_sds_remote_device *sci_dev);
380
381 /**
382  * struct scic_sds_remote_device_state_handler - This structure conains the
383  *    state handlers that are needed to process requests for the SCU remote
384  *    device objects.
385  *
386  *
387  */
388 struct scic_sds_remote_device_state_handler {
389         scic_sds_remote_device_resume_handler_t resume_handler;
390         scic_sds_remote_device_event_handler_t event_handler;
391         scic_sds_remote_device_frame_handler_t frame_handler;
392 };
393
394 /**
395  * scic_sds_remote_device_increment_request_count() -
396  *
397  * This macro incrments the request count for this device
398  */
399 #define scic_sds_remote_device_increment_request_count(sci_dev) \
400         ((sci_dev)->started_request_count++)
401
402 /**
403  * scic_sds_remote_device_decrement_request_count() -
404  *
405  * This macro decrements the request count for this device.  This count will
406  * never decrment past 0.
407  */
408 #define scic_sds_remote_device_decrement_request_count(sci_dev) \
409         ((sci_dev)->started_request_count > 0 ? \
410          (sci_dev)->started_request_count-- : 0)
411
412 /**
413  * scic_sds_remote_device_get_request_count() -
414  *
415  * This is a helper macro to return the current device request count.
416  */
417 #define scic_sds_remote_device_get_request_count(sci_dev) \
418         ((sci_dev)->started_request_count)
419
420 /**
421  * scic_sds_remote_device_get_port() -
422  *
423  * This macro returns the owning port of this remote device obejct.
424  */
425 #define scic_sds_remote_device_get_port(sci_dev) \
426         ((sci_dev)->owning_port)
427
428 /**
429  * scic_sds_remote_device_get_controller() -
430  *
431  * This macro returns the controller object that contains this device object
432  */
433 #define scic_sds_remote_device_get_controller(sci_dev) \
434         scic_sds_port_get_controller(scic_sds_remote_device_get_port(sci_dev))
435
436 /**
437  * scic_sds_remote_device_set_state_handlers() -
438  *
439  * This macro sets the remote device state handlers pointer and is set on entry
440  * to each device state.
441  */
442 #define scic_sds_remote_device_set_state_handlers(sci_dev, handlers) \
443         ((sci_dev)->state_handlers = (handlers))
444
445 /**
446  * scic_sds_remote_device_get_port() -
447  *
448  * This macro returns the owning port of this device
449  */
450 #define scic_sds_remote_device_get_port(sci_dev) \
451         ((sci_dev)->owning_port)
452
453 /**
454  * scic_sds_remote_device_get_sequence() -
455  *
456  * This macro returns the remote device sequence value
457  */
458 #define scic_sds_remote_device_get_sequence(sci_dev) \
459         (\
460                 scic_sds_remote_device_get_controller(sci_dev)-> \
461                 remote_device_sequence[(sci_dev)->rnc.remote_node_index] \
462         )
463
464 /**
465  * scic_sds_remote_device_get_controller_peg() -
466  *
467  * This macro returns the controllers protocol engine group
468  */
469 #define scic_sds_remote_device_get_controller_peg(sci_dev) \
470         (\
471                 scic_sds_controller_get_protocol_engine_group(\
472                         scic_sds_port_get_controller(\
473                                 scic_sds_remote_device_get_port(sci_dev) \
474                                 ) \
475                         ) \
476         )
477
478 /**
479  * scic_sds_remote_device_get_index() -
480  *
481  * This macro returns the remote node index for this device object
482  */
483 #define scic_sds_remote_device_get_index(sci_dev) \
484         ((sci_dev)->rnc.remote_node_index)
485
486 /**
487  * scic_sds_remote_device_build_command_context() -
488  *
489  * This macro builds a remote device context for the SCU post request operation
490  */
491 #define scic_sds_remote_device_build_command_context(device, command) \
492         ((command) \
493          | (scic_sds_remote_device_get_controller_peg((device)) << SCU_CONTEXT_COMMAND_PROTOCOL_ENGINE_GROUP_SHIFT) \
494          | ((device)->owning_port->physical_port_index << SCU_CONTEXT_COMMAND_LOGICAL_PORT_SHIFT) \
495          | (scic_sds_remote_device_get_index((device))) \
496         )
497
498 /**
499  * scic_sds_remote_device_set_working_request() -
500  *
501  * This macro makes the working request assingment for the remote device
502  * object. To clear the working request use this macro with a NULL request
503  * object.
504  */
505 #define scic_sds_remote_device_set_working_request(device, request) \
506         ((device)->working_request = (request))
507
508 enum sci_status scic_sds_remote_device_frame_handler(
509         struct scic_sds_remote_device *sci_dev,
510         u32 frame_index);
511
512 enum sci_status scic_sds_remote_device_event_handler(
513         struct scic_sds_remote_device *sci_dev,
514         u32 event_code);
515
516 enum sci_status scic_sds_remote_device_start_io(
517         struct scic_sds_controller *controller,
518         struct scic_sds_remote_device *sci_dev,
519         struct scic_sds_request *io_request);
520
521 enum sci_status scic_sds_remote_device_start_task(
522         struct scic_sds_controller *controller,
523         struct scic_sds_remote_device *sci_dev,
524         struct scic_sds_request *io_request);
525
526 enum sci_status scic_sds_remote_device_complete_io(
527         struct scic_sds_controller *controller,
528         struct scic_sds_remote_device *sci_dev,
529         struct scic_sds_request *io_request);
530
531 enum sci_status scic_sds_remote_device_suspend(
532         struct scic_sds_remote_device *sci_dev,
533         u32 suspend_type);
534
535 void scic_sds_remote_device_post_request(
536         struct scic_sds_remote_device *sci_dev,
537         u32 request);
538
539 #define scic_sds_remote_device_is_atapi(sci_dev) false
540
541 #endif /* !defined(_ISCI_REMOTE_DEVICE_H_) */