isci: fix dma_unmap_sg usage
[linux-2.6.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_req cmd;
248                         struct smp_resp rsp;
249                 } smp;
250
251                 struct {
252                         struct scic_sds_stp_request req;
253                         struct host_to_dev_fis cmd;
254                         struct dev_to_host_fis rsp;
255                 } stp;
256         };
257 };
258
259 static inline struct scic_sds_request *to_sci_req(struct scic_sds_stp_request *stp_req)
260 {
261         struct scic_sds_request *sci_req;
262
263         sci_req = container_of(stp_req, typeof(*sci_req), stp.req);
264         return sci_req;
265 }
266
267 struct isci_request {
268         enum isci_request_status status;
269         enum task_type ttype;
270         unsigned short io_tag;
271         bool complete_in_target;
272         bool terminated;
273
274         union ttype_ptr_union {
275                 struct sas_task *io_task_ptr;   /* When ttype==io_task  */
276                 struct isci_tmf *tmf_task_ptr;  /* When ttype==tmf_task */
277         } ttype_ptr;
278         struct isci_host *isci_host;
279         /* For use in the requests_to_{complete|abort} lists: */
280         struct list_head completed_node;
281         /* For use in the reqs_in_process list: */
282         struct list_head dev_node;
283         spinlock_t state_lock;
284         dma_addr_t request_daddr;
285         dma_addr_t zero_scatter_daddr;
286
287         unsigned int num_sg_entries;                    /* returned by pci_alloc_sg */
288
289         /** Note: "io_request_completion" is completed in two different ways
290          * depending on whether this is a TMF or regular request.
291          * - TMF requests are completed in the thread that started them;
292          * - regular requests are completed in the request completion callback
293          *   function.
294          * This difference in operation allows the aborter of a TMF request
295          * to be sure that once the TMF request completes, the I/O that the
296          * TMF was aborting is guaranteed to have completed.
297          */
298         struct completion *io_request_completion;
299         struct scic_sds_request sci;
300 };
301
302 static inline struct isci_request *sci_req_to_ireq(struct scic_sds_request *sci_req)
303 {
304         struct isci_request *ireq = container_of(sci_req, typeof(*ireq), sci);
305
306         return ireq;
307 }
308
309 /**
310  * enum sci_base_request_states - This enumeration depicts all the states for
311  *    the common request state machine.
312  *
313  *
314  */
315 enum sci_base_request_states {
316         /*
317          * Simply the initial state for the base request state machine.
318          */
319         SCI_REQ_INIT,
320
321         /*
322          * This state indicates that the request has been constructed.
323          * This state is entered from the INITIAL state.
324          */
325         SCI_REQ_CONSTRUCTED,
326
327         /*
328          * This state indicates that the request has been started. This state
329          * is entered from the CONSTRUCTED state.
330          */
331         SCI_REQ_STARTED,
332
333         SCI_REQ_STP_UDMA_WAIT_TC_COMP,
334         SCI_REQ_STP_UDMA_WAIT_D2H,
335
336         SCI_REQ_STP_NON_DATA_WAIT_H2D,
337         SCI_REQ_STP_NON_DATA_WAIT_D2H,
338
339         SCI_REQ_STP_SOFT_RESET_WAIT_H2D_ASSERTED,
340         SCI_REQ_STP_SOFT_RESET_WAIT_H2D_DIAG,
341         SCI_REQ_STP_SOFT_RESET_WAIT_D2H,
342
343         /*
344          * While in this state the IO request object is waiting for the TC
345          * completion notification for the H2D Register FIS
346          */
347         SCI_REQ_STP_PIO_WAIT_H2D,
348
349         /*
350          * While in this state the IO request object is waiting for either a
351          * PIO Setup FIS or a D2H register FIS.  The type of frame received is
352          * based on the result of the prior frame and line conditions.
353          */
354         SCI_REQ_STP_PIO_WAIT_FRAME,
355
356         /*
357          * While in this state the IO request object is waiting for a DATA
358          * frame from the device.
359          */
360         SCI_REQ_STP_PIO_DATA_IN,
361
362         /*
363          * While in this state the IO request object is waiting to transmit
364          * the next data frame to the device.
365          */
366         SCI_REQ_STP_PIO_DATA_OUT,
367
368         /*
369          * The AWAIT_TC_COMPLETION sub-state indicates that the started raw
370          * task management request is waiting for the transmission of the
371          * initial frame (i.e. command, task, etc.).
372          */
373         SCI_REQ_TASK_WAIT_TC_COMP,
374
375         /*
376          * This sub-state indicates that the started task management request
377          * is waiting for the reception of an unsolicited frame
378          * (i.e. response IU).
379          */
380         SCI_REQ_TASK_WAIT_TC_RESP,
381
382         /*
383          * This sub-state indicates that the started task management request
384          * is waiting for the reception of an unsolicited frame
385          * (i.e. response IU).
386          */
387         SCI_REQ_SMP_WAIT_RESP,
388
389         /*
390          * The AWAIT_TC_COMPLETION sub-state indicates that the started SMP
391          * request is waiting for the transmission of the initial frame
392          * (i.e. command, task, etc.).
393          */
394         SCI_REQ_SMP_WAIT_TC_COMP,
395
396         /*
397          * This state indicates that the request has completed.
398          * This state is entered from the STARTED state. This state is entered
399          * from the ABORTING state.
400          */
401         SCI_REQ_COMPLETED,
402
403         /*
404          * This state indicates that the request is in the process of being
405          * terminated/aborted.
406          * This state is entered from the CONSTRUCTED state.
407          * This state is entered from the STARTED state.
408          */
409         SCI_REQ_ABORTING,
410
411         /*
412          * Simply the final state for the base request state machine.
413          */
414         SCI_REQ_FINAL,
415 };
416
417 /**
418  * scic_sds_request_get_controller() -
419  *
420  * This macro will return the controller for this io request object
421  */
422 #define scic_sds_request_get_controller(sci_req) \
423         ((sci_req)->owning_controller)
424
425 /**
426  * scic_sds_request_get_device() -
427  *
428  * This macro will return the device for this io request object
429  */
430 #define scic_sds_request_get_device(sci_req) \
431         ((sci_req)->target_device)
432
433 /**
434  * scic_sds_request_get_port() -
435  *
436  * This macro will return the port for this io request object
437  */
438 #define scic_sds_request_get_port(sci_req)      \
439         scic_sds_remote_device_get_port(scic_sds_request_get_device(sci_req))
440
441 /**
442  * scic_sds_request_get_post_context() -
443  *
444  * This macro returns the constructed post context result for the io request.
445  */
446 #define scic_sds_request_get_post_context(sci_req)      \
447         ((sci_req)->post_context)
448
449 /**
450  * scic_sds_request_get_task_context() -
451  *
452  * This is a helper macro to return the os handle for this request object.
453  */
454 #define scic_sds_request_get_task_context(request) \
455         ((request)->task_context_buffer)
456
457 /**
458  * scic_sds_request_set_status() -
459  *
460  * This macro will set the scu hardware status and sci request completion
461  * status for an io request.
462  */
463 #define scic_sds_request_set_status(request, scu_status_code, sci_status_code) \
464         { \
465                 (request)->scu_status = (scu_status_code); \
466                 (request)->sci_status = (sci_status_code); \
467         }
468
469 /**
470  * SCU_SGL_ZERO() -
471  *
472  * This macro zeros the hardware SGL element data
473  */
474 #define SCU_SGL_ZERO(scu_sge) \
475         { \
476                 (scu_sge).length = 0; \
477                 (scu_sge).address_lower = 0; \
478                 (scu_sge).address_upper = 0; \
479                 (scu_sge).address_modifier = 0; \
480         }
481
482 /**
483  * SCU_SGL_COPY() -
484  *
485  * This macro copys the SGL Element data from the host os to the hardware SGL
486  * elment data
487  */
488 #define SCU_SGL_COPY(scu_sge, os_sge) \
489         { \
490                 (scu_sge).length = sg_dma_len(sg); \
491                 (scu_sge).address_upper = \
492                         upper_32_bits(sg_dma_address(sg)); \
493                 (scu_sge).address_lower = \
494                         lower_32_bits(sg_dma_address(sg)); \
495                 (scu_sge).address_modifier = 0; \
496         }
497
498 enum sci_status scic_sds_request_start(struct scic_sds_request *sci_req);
499 enum sci_status scic_sds_io_request_terminate(struct scic_sds_request *sci_req);
500 enum sci_status
501 scic_sds_io_request_event_handler(struct scic_sds_request *sci_req,
502                                   u32 event_code);
503 enum sci_status
504 scic_sds_io_request_frame_handler(struct scic_sds_request *sci_req,
505                                   u32 frame_index);
506 enum sci_status
507 scic_sds_task_request_terminate(struct scic_sds_request *sci_req);
508 extern enum sci_status
509 scic_sds_request_complete(struct scic_sds_request *sci_req);
510 extern enum sci_status
511 scic_sds_io_request_tc_completion(struct scic_sds_request *sci_req, u32 code);
512
513 /* XXX open code in caller */
514 static inline void *scic_request_get_virt_addr(struct scic_sds_request *sci_req,
515                                                dma_addr_t phys_addr)
516 {
517         struct isci_request *ireq = sci_req_to_ireq(sci_req);
518         dma_addr_t offset;
519
520         BUG_ON(phys_addr < ireq->request_daddr);
521
522         offset = phys_addr - ireq->request_daddr;
523
524         BUG_ON(offset >= sizeof(*ireq));
525
526         return (char *)ireq + offset;
527 }
528
529 /* XXX open code in caller */
530 static inline dma_addr_t
531 scic_io_request_get_dma_addr(struct scic_sds_request *sci_req, void *virt_addr)
532 {
533         struct isci_request *ireq = sci_req_to_ireq(sci_req);
534
535         char *requested_addr = (char *)virt_addr;
536         char *base_addr = (char *)ireq;
537
538         BUG_ON(requested_addr < base_addr);
539         BUG_ON((requested_addr - base_addr) >= sizeof(*ireq));
540
541         return ireq->request_daddr + (requested_addr - base_addr);
542 }
543
544 /**
545  * This function gets the status of the request object.
546  * @request: This parameter points to the isci_request object
547  *
548  * status of the object as a isci_request_status enum.
549  */
550 static inline enum isci_request_status
551 isci_request_get_state(struct isci_request *isci_request)
552 {
553         BUG_ON(isci_request == NULL);
554
555         /*probably a bad sign...        */
556         if (isci_request->status == unallocated)
557                 dev_warn(&isci_request->isci_host->pdev->dev,
558                          "%s: isci_request->status == unallocated\n",
559                          __func__);
560
561         return isci_request->status;
562 }
563
564
565 /**
566  * isci_request_change_state() - This function sets the status of the request
567  *    object.
568  * @request: This parameter points to the isci_request object
569  * @status: This Parameter is the new status of the object
570  *
571  */
572 static inline enum isci_request_status
573 isci_request_change_state(struct isci_request *isci_request,
574                           enum isci_request_status status)
575 {
576         enum isci_request_status old_state;
577         unsigned long flags;
578
579         dev_dbg(&isci_request->isci_host->pdev->dev,
580                 "%s: isci_request = %p, state = 0x%x\n",
581                 __func__,
582                 isci_request,
583                 status);
584
585         BUG_ON(isci_request == NULL);
586
587         spin_lock_irqsave(&isci_request->state_lock, flags);
588         old_state = isci_request->status;
589         isci_request->status = status;
590         spin_unlock_irqrestore(&isci_request->state_lock, flags);
591
592         return old_state;
593 }
594
595 /**
596  * isci_request_change_started_to_newstate() - This function sets the status of
597  *    the request object.
598  * @request: This parameter points to the isci_request object
599  * @status: This Parameter is the new status of the object
600  *
601  * state previous to any change.
602  */
603 static inline enum isci_request_status
604 isci_request_change_started_to_newstate(struct isci_request *isci_request,
605                                         struct completion *completion_ptr,
606                                         enum isci_request_status newstate)
607 {
608         enum isci_request_status old_state;
609         unsigned long flags;
610
611         spin_lock_irqsave(&isci_request->state_lock, flags);
612
613         old_state = isci_request->status;
614
615         if (old_state == started || old_state == aborting) {
616                 BUG_ON(isci_request->io_request_completion != NULL);
617
618                 isci_request->io_request_completion = completion_ptr;
619                 isci_request->status = newstate;
620         }
621
622         spin_unlock_irqrestore(&isci_request->state_lock, flags);
623
624         dev_dbg(&isci_request->isci_host->pdev->dev,
625                 "%s: isci_request = %p, old_state = 0x%x\n",
626                 __func__,
627                 isci_request,
628                 old_state);
629
630         return old_state;
631 }
632
633 /**
634  * isci_request_change_started_to_aborted() - This function sets the status of
635  *    the request object.
636  * @request: This parameter points to the isci_request object
637  * @completion_ptr: This parameter is saved as the kernel completion structure
638  *    signalled when the old request completes.
639  *
640  * state previous to any change.
641  */
642 static inline enum isci_request_status
643 isci_request_change_started_to_aborted(struct isci_request *isci_request,
644                                        struct completion *completion_ptr)
645 {
646         return isci_request_change_started_to_newstate(isci_request,
647                                                        completion_ptr,
648                                                        aborted);
649 }
650 /**
651  * isci_request_free() - This function frees the request object.
652  * @isci_host: This parameter specifies the ISCI host object
653  * @isci_request: This parameter points to the isci_request object
654  *
655  */
656 static inline void isci_request_free(struct isci_host *isci_host,
657                                      struct isci_request *isci_request)
658 {
659         if (!isci_request)
660                 return;
661
662         /* release the dma memory if we fail. */
663         dma_pool_free(isci_host->dma_pool,
664                       isci_request,
665                       isci_request->request_daddr);
666 }
667
668 #define isci_request_access_task(req) ((req)->ttype_ptr.io_task_ptr)
669
670 #define isci_request_access_tmf(req) ((req)->ttype_ptr.tmf_task_ptr)
671
672 struct isci_request *isci_request_alloc_tmf(struct isci_host *ihost,
673                                             struct isci_tmf *isci_tmf,
674                                             gfp_t gfp_flags);
675 int isci_request_execute(struct isci_host *ihost, struct isci_remote_device *idev,
676                          struct sas_task *task, gfp_t gfp_flags);
677 void isci_terminate_pending_requests(struct isci_host *ihost,
678                                      struct isci_remote_device *idev);
679 enum sci_status
680 scic_task_request_construct(struct scic_sds_controller *scic,
681                             struct scic_sds_remote_device *sci_dev,
682                             u16 io_tag,
683                             struct scic_sds_request *sci_req);
684 enum sci_status
685 scic_task_request_construct_ssp(struct scic_sds_request *sci_req);
686 enum sci_status
687 scic_task_request_construct_sata(struct scic_sds_request *sci_req);
688 void
689 scic_stp_io_request_set_ncq_tag(struct scic_sds_request *sci_req, u16 ncq_tag);
690 void scic_sds_smp_request_copy_response(struct scic_sds_request *sci_req);
691 #endif /* !defined(_ISCI_REQUEST_H_) */