[SCSI] zfcp: Introduce header file for qdio structs and inline functions
[linux-2.6.git] / drivers / s390 / scsi / zfcp_qdio.h
1 /*
2  * zfcp device driver
3  *
4  * Header file for zfcp qdio interface
5  *
6  * Copyright IBM Corporation 2010
7  */
8
9 #ifndef ZFCP_QDIO_H
10 #define ZFCP_QDIO_H
11
12 #include <asm/qdio.h>
13
14 /**
15  * struct zfcp_qdio_queue - qdio queue buffer, zfcp index and free count
16  * @sbal: qdio buffers
17  * @first: index of next free buffer in queue
18  * @count: number of free buffers in queue
19  */
20 struct zfcp_qdio_queue {
21         struct qdio_buffer *sbal[QDIO_MAX_BUFFERS_PER_Q];
22         u8                 first;
23         atomic_t           count;
24 };
25
26 /**
27  * struct zfcp_qdio - basic qdio data structure
28  * @resp_q: response queue
29  * @req_q: request queue
30  * @stat_lock: lock to protect req_q_util and req_q_time
31  * @req_q_lock: lock to serialize access to request queue
32  * @req_q_time: time of last fill level change
33  * @req_q_util: used for accounting
34  * @req_q_full: queue full incidents
35  * @req_q_wq: used to wait for SBAL availability
36  * @adapter: adapter used in conjunction with this qdio structure
37  */
38 struct zfcp_qdio {
39         struct zfcp_qdio_queue  resp_q;
40         struct zfcp_qdio_queue  req_q;
41         spinlock_t              stat_lock;
42         spinlock_t              req_q_lock;
43         unsigned long long      req_q_time;
44         u64                     req_q_util;
45         atomic_t                req_q_full;
46         wait_queue_head_t       req_q_wq;
47         struct zfcp_adapter     *adapter;
48 };
49
50 /**
51  * struct zfcp_qdio_req - qdio queue related values for a request
52  * @sbal_number: number of free sbals
53  * @sbal_first: first sbal for this request
54  * @sbal_last: last sbal for this request
55  * @sbal_limit: last possible sbal for this request
56  * @sbale_curr: current sbale at creation of this request
57  * @sbal_response: sbal used in interrupt
58  * @qdio_outb_usage: usage of outbound queue
59  * @qdio_inb_usage: usage of inbound queue
60  */
61 struct zfcp_qdio_req {
62         u8      sbal_number;
63         u8      sbal_first;
64         u8      sbal_last;
65         u8      sbal_limit;
66         u8      sbale_curr;
67         u8      sbal_response;
68         u16     qdio_outb_usage;
69         u16     qdio_inb_usage;
70 };
71
72 /**
73  * zfcp_qdio_sbale - return pointer to sbale in qdio queue
74  * @q: queue where to find sbal
75  * @sbal_idx: sbal index in queue
76  * @sbale_idx: sbale index in sbal
77  */
78 static inline struct qdio_buffer_element *
79 zfcp_qdio_sbale(struct zfcp_qdio_queue *q, int sbal_idx, int sbale_idx)
80 {
81         return &q->sbal[sbal_idx]->element[sbale_idx];
82 }
83
84 /**
85  * zfcp_qdio_sbale_req - return pointer to sbale on req_q for a request
86  * @qdio: pointer to struct zfcp_qdio
87  * @q_rec: pointer to struct zfcp_qdio_req
88  * Returns: pointer to qdio_buffer_element (sbale) structure
89  */
90 static inline struct qdio_buffer_element *
91 zfcp_qdio_sbale_req(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
92 {
93         return zfcp_qdio_sbale(&qdio->req_q, q_req->sbal_last, 0);
94 }
95
96 /**
97  * zfcp_qdio_sbale_curr - return current sbale on req_q for a request
98  * @qdio: pointer to struct zfcp_qdio
99  * @fsf_req: pointer to struct zfcp_fsf_req
100  * Returns: pointer to qdio_buffer_element (sbale) structure
101  */
102 static inline struct qdio_buffer_element *
103 zfcp_qdio_sbale_curr(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
104 {
105         return zfcp_qdio_sbale(&qdio->req_q, q_req->sbal_last,
106                                q_req->sbale_curr);
107 }
108
109 #endif /* ZFCP_QDIO_H */