isci: fix support for arbitrarily large smp requests
[profile/ivi/kernel-adaptation-intel-automotive.git] / drivers / scsi / isci / request.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_REQUEST_H_
57 #define _ISCI_REQUEST_H_
58
59 #include "isci.h"
60 #include "host.h"
61 #include "scu_task_context.h"
62
63 /**
64  * struct isci_request_status - This enum defines the possible states of an I/O
65  *    request.
66  *
67  *
68  */
69 enum isci_request_status {
70         unallocated = 0x00,
71         allocated   = 0x01,
72         started     = 0x02,
73         completed   = 0x03,
74         aborting    = 0x04,
75         aborted     = 0x05,
76         terminating = 0x06,
77         dead        = 0x07
78 };
79
80 enum task_type {
81         io_task  = 0,
82         tmf_task = 1
83 };
84
85 enum sci_request_protocol {
86         SCIC_NO_PROTOCOL,
87         SCIC_SMP_PROTOCOL,
88         SCIC_SSP_PROTOCOL,
89         SCIC_STP_PROTOCOL
90 }; /* XXX remove me, use sas_task.{dev|task_proto} instead */;
91
92 struct scic_sds_stp_request {
93         union {
94                 u32 ncq;
95
96                 u32 udma;
97
98                 struct scic_sds_stp_pio_request {
99                         /*
100                          * Total transfer for the entire PIO request recorded
101                          * at request constuction time.
102                          *
103                          * @todo Should we just decrement this value for each
104                          * byte of data transitted or received to elemenate
105                          * the current_transfer_bytes field?
106                          */
107                         u32 total_transfer_bytes;
108
109                         /*
110                          * Total number of bytes received/transmitted in data
111                          * frames since the start of the IO request.  At the
112                          * end of the IO request this should equal the
113                          * total_transfer_bytes.
114                          */
115                         u32 current_transfer_bytes;
116
117                         /*
118                          * The number of bytes requested in the in the PIO
119                          * setup.
120                          */
121                         u32 pio_transfer_bytes;
122
123                         /*
124                          * PIO Setup ending status value to tell us if we need
125                          * to wait for another FIS or if the transfer is
126                          * complete. On the receipt of a D2H FIS this will be
127                          * the status field of that FIS.
128                          */
129                         u8 ending_status;
130
131                         /*
132                          * On receipt of a D2H FIS this will be the ending
133                          * error field if the ending_status has the
134                          * SATA_STATUS_ERR bit set.
135                          */
136                         u8 ending_error;
137
138                         struct scic_sds_request_pio_sgl {
139                                 struct scu_sgl_element_pair *sgl_pair;
140                                 u8 sgl_set;
141                                 u32 sgl_offset;
142                         } request_current;
143                 } pio;
144
145                 struct {
146                         /*
147                          * The number of bytes requested in the PIO setup
148                          * before CDB data frame.
149                          */
150                         u32 device_preferred_cdb_length;
151                 } packet;
152         } type;
153 };
154
155 struct scic_sds_request {
156         /*
157          * This field contains the information for the base request state
158          * machine.
159          */
160         struct sci_base_state_machine sm;
161
162         /*
163          * This field simply points to the controller to which this IO request
164          * is associated.
165          */
166         struct scic_sds_controller *owning_controller;
167
168         /*
169          * This field simply points to the remote device to which this IO
170          * request is associated.
171          */
172         struct scic_sds_remote_device *target_device;
173
174         /*
175          * This field is utilized to determine if the SCI user is managing
176          * the IO tag for this request or if the core is managing it.
177          */
178         bool was_tag_assigned_by_user;
179
180         /*
181          * This field indicates the IO tag for this request.  The IO tag is
182          * comprised of the task_index and a sequence count. The sequence count
183          * is utilized to help identify tasks from one life to another.
184          */
185         u16 io_tag;
186
187         /*
188          * This field specifies the protocol being utilized for this
189          * IO request.
190          */
191         enum sci_request_protocol protocol;
192
193         /*
194          * This field indicates the completion status taken from the SCUs
195          * completion code.  It indicates the completion result for the SCU
196          * hardware.
197          */
198         u32 scu_status;
199
200         /*
201          * This field indicates the completion status returned to the SCI user.
202          * It indicates the users view of the io request completion.
203          */
204         u32 sci_status;
205
206         /*
207          * This field contains the value to be utilized when posting
208          * (e.g. Post_TC, * Post_TC_Abort) this request to the silicon.
209          */
210         u32 post_context;
211
212         struct scu_task_context *task_context_buffer;
213         struct scu_task_context tc ____cacheline_aligned;
214
215         /* could be larger with sg chaining */
216         #define SCU_SGL_SIZE ((SCI_MAX_SCATTER_GATHER_ELEMENTS + 1) / 2)
217         struct scu_sgl_element_pair sg_table[SCU_SGL_SIZE] __attribute__ ((aligned(32)));
218
219         /*
220          * This field indicates if this request is a task management request or
221          * normal IO request.
222          */
223         bool is_task_management_request;
224
225         /*
226          * This field is a pointer to the stored rx frame data.  It is used in
227          * STP internal requests and SMP response frames.  If this field is
228          * non-NULL the saved frame must be released on IO request completion.
229          *
230          * @todo In the future do we want to keep a list of RX frame buffers?
231          */
232         u32 saved_rx_frame_index;
233
234         union {
235                 struct {
236                         union {
237                                 struct ssp_cmd_iu cmd;
238                                 struct ssp_task_iu tmf;
239                         };
240                         union {
241                                 struct ssp_response_iu rsp;
242                                 u8 rsp_buf[SSP_RESP_IU_MAX_SIZE];
243                         };
244                 } ssp;
245
246                 struct {
247                         struct smp_resp rsp;
248                 } smp;
249
250                 struct {
251                         struct scic_sds_stp_request req;
252                         struct host_to_dev_fis cmd;
253                         struct dev_to_host_fis rsp;
254                 } stp;
255         };
256 };
257
258 static inline struct scic_sds_request *to_sci_req(struct scic_sds_stp_request *stp_req)
259 {
260         struct scic_sds_request *sci_req;
261
262         sci_req = container_of(stp_req, typeof(*sci_req), stp.req);
263         return sci_req;
264 }
265
266 struct isci_request {
267         enum isci_request_status status;
268         enum task_type ttype;
269         unsigned short io_tag;
270         bool complete_in_target;
271         bool terminated;
272
273         union ttype_ptr_union {
274                 struct sas_task *io_task_ptr;   /* When ttype==io_task  */
275                 struct isci_tmf *tmf_task_ptr;  /* When ttype==tmf_task */
276         } ttype_ptr;
277         struct isci_host *isci_host;
278         /* For use in the requests_to_{complete|abort} lists: */
279         struct list_head completed_node;
280         /* For use in the reqs_in_process list: */
281         struct list_head dev_node;
282         spinlock_t state_lock;
283         dma_addr_t request_daddr;
284         dma_addr_t zero_scatter_daddr;
285
286         unsigned int num_sg_entries;                    /* returned by pci_alloc_sg */
287
288         /** Note: "io_request_completion" is completed in two different ways
289          * depending on whether this is a TMF or regular request.
290          * - TMF requests are completed in the thread that started them;
291          * - regular requests are completed in the request completion callback
292          *   function.
293          * This difference in operation allows the aborter of a TMF request
294          * to be sure that once the TMF request completes, the I/O that the
295          * TMF was aborting is guaranteed to have completed.
296          */
297         struct completion *io_request_completion;
298         struct scic_sds_request sci;
299 };
300
301 static inline struct isci_request *sci_req_to_ireq(struct scic_sds_request *sci_req)
302 {
303         struct isci_request *ireq = container_of(sci_req, typeof(*ireq), sci);
304
305         return ireq;
306 }
307
308 /**
309  * enum sci_base_request_states - This enumeration depicts all the states for
310  *    the common request state machine.
311  *
312  *
313  */
314 enum sci_base_request_states {
315         /*
316          * Simply the initial state for the base request state machine.
317          */
318         SCI_REQ_INIT,
319
320         /*
321          * This state indicates that the request has been constructed.
322          * This state is entered from the INITIAL state.
323          */
324         SCI_REQ_CONSTRUCTED,
325
326         /*
327          * This state indicates that the request has been started. This state
328          * is entered from the CONSTRUCTED state.
329          */
330         SCI_REQ_STARTED,
331
332         SCI_REQ_STP_UDMA_WAIT_TC_COMP,
333         SCI_REQ_STP_UDMA_WAIT_D2H,
334
335         SCI_REQ_STP_NON_DATA_WAIT_H2D,
336         SCI_REQ_STP_NON_DATA_WAIT_D2H,
337
338         SCI_REQ_STP_SOFT_RESET_WAIT_H2D_ASSERTED,
339         SCI_REQ_STP_SOFT_RESET_WAIT_H2D_DIAG,
340         SCI_REQ_STP_SOFT_RESET_WAIT_D2H,
341
342         /*
343          * While in this state the IO request object is waiting for the TC
344          * completion notification for the H2D Register FIS
345          */
346         SCI_REQ_STP_PIO_WAIT_H2D,
347
348         /*
349          * While in this state the IO request object is waiting for either a
350          * PIO Setup FIS or a D2H register FIS.  The type of frame received is
351          * based on the result of the prior frame and line conditions.
352          */
353         SCI_REQ_STP_PIO_WAIT_FRAME,
354
355         /*
356          * While in this state the IO request object is waiting for a DATA
357          * frame from the device.
358          */
359         SCI_REQ_STP_PIO_DATA_IN,
360
361         /*
362          * While in this state the IO request object is waiting to transmit
363          * the next data frame to the device.
364          */
365         SCI_REQ_STP_PIO_DATA_OUT,
366
367         /*
368          * The AWAIT_TC_COMPLETION sub-state indicates that the started raw
369          * task management request is waiting for the transmission of the
370          * initial frame (i.e. command, task, etc.).
371          */
372         SCI_REQ_TASK_WAIT_TC_COMP,
373
374         /*
375          * This sub-state indicates that the started task management request
376          * is waiting for the reception of an unsolicited frame
377          * (i.e. response IU).
378          */
379         SCI_REQ_TASK_WAIT_TC_RESP,
380
381         /*
382          * This sub-state indicates that the started task management request
383          * is waiting for the reception of an unsolicited frame
384          * (i.e. response IU).
385          */
386         SCI_REQ_SMP_WAIT_RESP,
387
388         /*
389          * The AWAIT_TC_COMPLETION sub-state indicates that the started SMP
390          * request is waiting for the transmission of the initial frame
391          * (i.e. command, task, etc.).
392          */
393         SCI_REQ_SMP_WAIT_TC_COMP,
394
395         /*
396          * This state indicates that the request has completed.
397          * This state is entered from the STARTED state. This state is entered
398          * from the ABORTING state.
399          */
400         SCI_REQ_COMPLETED,
401
402         /*
403          * This state indicates that the request is in the process of being
404          * terminated/aborted.
405          * This state is entered from the CONSTRUCTED state.
406          * This state is entered from the STARTED state.
407          */
408         SCI_REQ_ABORTING,
409
410         /*
411          * Simply the final state for the base request state machine.
412          */
413         SCI_REQ_FINAL,
414 };
415
416 /**
417  * scic_sds_request_get_controller() -
418  *
419  * This macro will return the controller for this io request object
420  */
421 #define scic_sds_request_get_controller(sci_req) \
422         ((sci_req)->owning_controller)
423
424 /**
425  * scic_sds_request_get_device() -
426  *
427  * This macro will return the device for this io request object
428  */
429 #define scic_sds_request_get_device(sci_req) \
430         ((sci_req)->target_device)
431
432 /**
433  * scic_sds_request_get_port() -
434  *
435  * This macro will return the port for this io request object
436  */
437 #define scic_sds_request_get_port(sci_req)      \
438         scic_sds_remote_device_get_port(scic_sds_request_get_device(sci_req))
439
440 /**
441  * scic_sds_request_get_post_context() -
442  *
443  * This macro returns the constructed post context result for the io request.
444  */
445 #define scic_sds_request_get_post_context(sci_req)      \
446         ((sci_req)->post_context)
447
448 /**
449  * scic_sds_request_get_task_context() -
450  *
451  * This is a helper macro to return the os handle for this request object.
452  */
453 #define scic_sds_request_get_task_context(request) \
454         ((request)->task_context_buffer)
455
456 /**
457  * scic_sds_request_set_status() -
458  *
459  * This macro will set the scu hardware status and sci request completion
460  * status for an io request.
461  */
462 #define scic_sds_request_set_status(request, scu_status_code, sci_status_code) \
463         { \
464                 (request)->scu_status = (scu_status_code); \
465                 (request)->sci_status = (sci_status_code); \
466         }
467
468 /**
469  * SCU_SGL_ZERO() -
470  *
471  * This macro zeros the hardware SGL element data
472  */
473 #define SCU_SGL_ZERO(scu_sge) \
474         { \
475                 (scu_sge).length = 0; \
476                 (scu_sge).address_lower = 0; \
477                 (scu_sge).address_upper = 0; \
478                 (scu_sge).address_modifier = 0; \
479         }
480
481 /**
482  * SCU_SGL_COPY() -
483  *
484  * This macro copys the SGL Element data from the host os to the hardware SGL
485  * elment data
486  */
487 #define SCU_SGL_COPY(scu_sge, os_sge) \
488         { \
489                 (scu_sge).length = sg_dma_len(sg); \
490                 (scu_sge).address_upper = \
491                         upper_32_bits(sg_dma_address(sg)); \
492                 (scu_sge).address_lower = \
493                         lower_32_bits(sg_dma_address(sg)); \
494                 (scu_sge).address_modifier = 0; \
495         }
496
497 enum sci_status scic_sds_request_start(struct scic_sds_request *sci_req);
498 enum sci_status scic_sds_io_request_terminate(struct scic_sds_request *sci_req);
499 enum sci_status
500 scic_sds_io_request_event_handler(struct scic_sds_request *sci_req,
501                                   u32 event_code);
502 enum sci_status
503 scic_sds_io_request_frame_handler(struct scic_sds_request *sci_req,
504                                   u32 frame_index);
505 enum sci_status
506 scic_sds_task_request_terminate(struct scic_sds_request *sci_req);
507 extern enum sci_status
508 scic_sds_request_complete(struct scic_sds_request *sci_req);
509 extern enum sci_status
510 scic_sds_io_request_tc_completion(struct scic_sds_request *sci_req, u32 code);
511
512 /* XXX open code in caller */
513 static inline void *scic_request_get_virt_addr(struct scic_sds_request *sci_req,
514                                                dma_addr_t phys_addr)
515 {
516         struct isci_request *ireq = sci_req_to_ireq(sci_req);
517         dma_addr_t offset;
518
519         BUG_ON(phys_addr < ireq->request_daddr);
520
521         offset = phys_addr - ireq->request_daddr;
522
523         BUG_ON(offset >= sizeof(*ireq));
524
525         return (char *)ireq + offset;
526 }
527
528 /* XXX open code in caller */
529 static inline dma_addr_t
530 scic_io_request_get_dma_addr(struct scic_sds_request *sci_req, void *virt_addr)
531 {
532         struct isci_request *ireq = sci_req_to_ireq(sci_req);
533
534         char *requested_addr = (char *)virt_addr;
535         char *base_addr = (char *)ireq;
536
537         BUG_ON(requested_addr < base_addr);
538         BUG_ON((requested_addr - base_addr) >= sizeof(*ireq));
539
540         return ireq->request_daddr + (requested_addr - base_addr);
541 }
542
543 /**
544  * This function gets the status of the request object.
545  * @request: This parameter points to the isci_request object
546  *
547  * status of the object as a isci_request_status enum.
548  */
549 static inline enum isci_request_status
550 isci_request_get_state(struct isci_request *isci_request)
551 {
552         BUG_ON(isci_request == NULL);
553
554         /*probably a bad sign...        */
555         if (isci_request->status == unallocated)
556                 dev_warn(&isci_request->isci_host->pdev->dev,
557                          "%s: isci_request->status == unallocated\n",
558                          __func__);
559
560         return isci_request->status;
561 }
562
563
564 /**
565  * isci_request_change_state() - This function sets the status of the request
566  *    object.
567  * @request: This parameter points to the isci_request object
568  * @status: This Parameter is the new status of the object
569  *
570  */
571 static inline enum isci_request_status
572 isci_request_change_state(struct isci_request *isci_request,
573                           enum isci_request_status status)
574 {
575         enum isci_request_status old_state;
576         unsigned long flags;
577
578         dev_dbg(&isci_request->isci_host->pdev->dev,
579                 "%s: isci_request = %p, state = 0x%x\n",
580                 __func__,
581                 isci_request,
582                 status);
583
584         BUG_ON(isci_request == NULL);
585
586         spin_lock_irqsave(&isci_request->state_lock, flags);
587         old_state = isci_request->status;
588         isci_request->status = status;
589         spin_unlock_irqrestore(&isci_request->state_lock, flags);
590
591         return old_state;
592 }
593
594 /**
595  * isci_request_change_started_to_newstate() - This function sets the status of
596  *    the request object.
597  * @request: This parameter points to the isci_request object
598  * @status: This Parameter is the new status of the object
599  *
600  * state previous to any change.
601  */
602 static inline enum isci_request_status
603 isci_request_change_started_to_newstate(struct isci_request *isci_request,
604                                         struct completion *completion_ptr,
605                                         enum isci_request_status newstate)
606 {
607         enum isci_request_status old_state;
608         unsigned long flags;
609
610         spin_lock_irqsave(&isci_request->state_lock, flags);
611
612         old_state = isci_request->status;
613
614         if (old_state == started || old_state == aborting) {
615                 BUG_ON(isci_request->io_request_completion != NULL);
616
617                 isci_request->io_request_completion = completion_ptr;
618                 isci_request->status = newstate;
619         }
620
621         spin_unlock_irqrestore(&isci_request->state_lock, flags);
622
623         dev_dbg(&isci_request->isci_host->pdev->dev,
624                 "%s: isci_request = %p, old_state = 0x%x\n",
625                 __func__,
626                 isci_request,
627                 old_state);
628
629         return old_state;
630 }
631
632 /**
633  * isci_request_change_started_to_aborted() - This function sets the status of
634  *    the request object.
635  * @request: This parameter points to the isci_request object
636  * @completion_ptr: This parameter is saved as the kernel completion structure
637  *    signalled when the old request completes.
638  *
639  * state previous to any change.
640  */
641 static inline enum isci_request_status
642 isci_request_change_started_to_aborted(struct isci_request *isci_request,
643                                        struct completion *completion_ptr)
644 {
645         return isci_request_change_started_to_newstate(isci_request,
646                                                        completion_ptr,
647                                                        aborted);
648 }
649 /**
650  * isci_request_free() - This function frees the request object.
651  * @isci_host: This parameter specifies the ISCI host object
652  * @isci_request: This parameter points to the isci_request object
653  *
654  */
655 static inline void isci_request_free(struct isci_host *isci_host,
656                                      struct isci_request *isci_request)
657 {
658         if (!isci_request)
659                 return;
660
661         /* release the dma memory if we fail. */
662         dma_pool_free(isci_host->dma_pool,
663                       isci_request,
664                       isci_request->request_daddr);
665 }
666
667 #define isci_request_access_task(req) ((req)->ttype_ptr.io_task_ptr)
668
669 #define isci_request_access_tmf(req) ((req)->ttype_ptr.tmf_task_ptr)
670
671 struct isci_request *isci_request_alloc_tmf(struct isci_host *ihost,
672                                             struct isci_tmf *isci_tmf,
673                                             gfp_t gfp_flags);
674 int isci_request_execute(struct isci_host *ihost, struct isci_remote_device *idev,
675                          struct sas_task *task, gfp_t gfp_flags);
676 void isci_terminate_pending_requests(struct isci_host *ihost,
677                                      struct isci_remote_device *idev);
678 enum sci_status
679 scic_task_request_construct(struct scic_sds_controller *scic,
680                             struct scic_sds_remote_device *sci_dev,
681                             u16 io_tag,
682                             struct scic_sds_request *sci_req);
683 enum sci_status
684 scic_task_request_construct_ssp(struct scic_sds_request *sci_req);
685 enum sci_status
686 scic_task_request_construct_sata(struct scic_sds_request *sci_req);
687 void
688 scic_stp_io_request_set_ncq_tag(struct scic_sds_request *sci_req, u16 ncq_tag);
689 void scic_sds_smp_request_copy_response(struct scic_sds_request *sci_req);
690 #endif /* !defined(_ISCI_REQUEST_H_) */