Merge branch 'next' into for-linus
[linux-2.6] / drivers / infiniband / hw / ehca / ehca_classes.h
1 /*
2  *  IBM eServer eHCA Infiniband device driver for Linux on POWER
3  *
4  *  Struct definition for eHCA internal structures
5  *
6  *  Authors: Heiko J Schick <schickhj@de.ibm.com>
7  *           Christoph Raisch <raisch@de.ibm.com>
8  *           Joachim Fenkes <fenkes@de.ibm.com>
9  *
10  *  Copyright (c) 2005 IBM Corporation
11  *
12  *  All rights reserved.
13  *
14  *  This source code is distributed under a dual license of GPL v2.0 and OpenIB
15  *  BSD.
16  *
17  * OpenIB BSD License
18  *
19  * Redistribution and use in source and binary forms, with or without
20  * modification, are permitted provided that the following conditions are met:
21  *
22  * Redistributions of source code must retain the above copyright notice, this
23  * list of conditions and the following disclaimer.
24  *
25  * Redistributions in binary form must reproduce the above copyright notice,
26  * this list of conditions and the following disclaimer in the documentation
27  * and/or other materials
28  * provided with the distribution.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
31  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
34  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
35  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
36  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
37  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
38  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
39  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
40  * POSSIBILITY OF SUCH DAMAGE.
41  */
42
43 #ifndef __EHCA_CLASSES_H__
44 #define __EHCA_CLASSES_H__
45
46 struct ehca_module;
47 struct ehca_qp;
48 struct ehca_cq;
49 struct ehca_eq;
50 struct ehca_mr;
51 struct ehca_mw;
52 struct ehca_pd;
53 struct ehca_av;
54
55 #include <linux/wait.h>
56 #include <linux/mutex.h>
57
58 #include <rdma/ib_verbs.h>
59 #include <rdma/ib_user_verbs.h>
60
61 #ifdef CONFIG_PPC64
62 #include "ehca_classes_pSeries.h"
63 #endif
64 #include "ipz_pt_fn.h"
65 #include "ehca_qes.h"
66 #include "ehca_irq.h"
67
68 #define EHCA_EQE_CACHE_SIZE 20
69 #define EHCA_MAX_NUM_QUEUES 0xffff
70
71 struct ehca_eqe_cache_entry {
72         struct ehca_eqe *eqe;
73         struct ehca_cq *cq;
74 };
75
76 struct ehca_eq {
77         u32 length;
78         struct ipz_queue ipz_queue;
79         struct ipz_eq_handle ipz_eq_handle;
80         struct work_struct work;
81         struct h_galpas galpas;
82         int is_initialized;
83         struct ehca_pfeq pf;
84         spinlock_t spinlock;
85         struct tasklet_struct interrupt_task;
86         u32 ist;
87         spinlock_t irq_spinlock;
88         struct ehca_eqe_cache_entry eqe_cache[EHCA_EQE_CACHE_SIZE];
89 };
90
91 struct ehca_sma_attr {
92         u16 lid, lmc, sm_sl, sm_lid;
93         u16 pkey_tbl_len, pkeys[16];
94 };
95
96 struct ehca_sport {
97         struct ib_cq *ibcq_aqp1;
98         struct ib_qp *ibqp_sqp[2];
99         /* lock to serialze modify_qp() calls for sqp in normal
100          * and irq path (when event PORT_ACTIVE is received first time)
101          */
102         spinlock_t mod_sqp_lock;
103         enum ib_port_state port_state;
104         struct ehca_sma_attr saved_attr;
105         u32 pma_qp_nr;
106 };
107
108 #define HCA_CAP_MR_PGSIZE_4K  0x80000000
109 #define HCA_CAP_MR_PGSIZE_64K 0x40000000
110 #define HCA_CAP_MR_PGSIZE_1M  0x20000000
111 #define HCA_CAP_MR_PGSIZE_16M 0x10000000
112
113 struct ehca_shca {
114         struct ib_device ib_device;
115         struct of_device *ofdev;
116         u8 num_ports;
117         int hw_level;
118         struct list_head shca_list;
119         struct ipz_adapter_handle ipz_hca_handle;
120         struct ehca_sport sport[2];
121         struct ehca_eq eq;
122         struct ehca_eq neq;
123         struct ehca_mr *maxmr;
124         struct ehca_pd *pd;
125         struct h_galpas galpas;
126         struct mutex modify_mutex;
127         u64 hca_cap;
128         /* MR pgsize: bit 0-3 means 4K, 64K, 1M, 16M respectively */
129         u32 hca_cap_mr_pgsize;
130         int max_mtu;
131         atomic_t num_cqs;
132         atomic_t num_qps;
133 };
134
135 struct ehca_pd {
136         struct ib_pd ib_pd;
137         struct ipz_pd fw_pd;
138         /* small queue mgmt */
139         struct mutex lock;
140         struct list_head free[2];
141         struct list_head full[2];
142 };
143
144 enum ehca_ext_qp_type {
145         EQPT_NORMAL    = 0,
146         EQPT_LLQP      = 1,
147         EQPT_SRQBASE   = 2,
148         EQPT_SRQ       = 3,
149 };
150
151 /* struct to cache modify_qp()'s parms for GSI/SMI qp */
152 struct ehca_mod_qp_parm {
153         int mask;
154         struct ib_qp_attr attr;
155 };
156
157 #define EHCA_MOD_QP_PARM_MAX 4
158
159 #define QMAP_IDX_MASK 0xFFFFULL
160
161 /* struct for tracking if cqes have been reported to the application */
162 struct ehca_qmap_entry {
163         u16 app_wr_id;
164         u16 reported;
165 };
166
167 struct ehca_qp {
168         union {
169                 struct ib_qp ib_qp;
170                 struct ib_srq ib_srq;
171         };
172         u32 qp_type;
173         enum ehca_ext_qp_type ext_type;
174         enum ib_qp_state state;
175         struct ipz_queue ipz_squeue;
176         struct ehca_qmap_entry *sq_map;
177         struct ipz_queue ipz_rqueue;
178         struct h_galpas galpas;
179         u32 qkey;
180         u32 real_qp_num;
181         u32 token;
182         spinlock_t spinlock_s;
183         spinlock_t spinlock_r;
184         u32 sq_max_inline_data_size;
185         struct ipz_qp_handle ipz_qp_handle;
186         struct ehca_pfqp pf;
187         struct ib_qp_init_attr init_attr;
188         struct ehca_cq *send_cq;
189         struct ehca_cq *recv_cq;
190         unsigned int sqerr_purgeflag;
191         struct hlist_node list_entries;
192         /* array to cache modify_qp()'s parms for GSI/SMI qp */
193         struct ehca_mod_qp_parm *mod_qp_parm;
194         int mod_qp_parm_idx;
195         /* mmap counter for resources mapped into user space */
196         u32 mm_count_squeue;
197         u32 mm_count_rqueue;
198         u32 mm_count_galpa;
199         /* unsolicited ack circumvention */
200         int unsol_ack_circ;
201         int mtu_shift;
202         u32 message_count;
203         u32 packet_count;
204         atomic_t nr_events; /* events seen */
205         wait_queue_head_t wait_completion;
206         int mig_armed;
207 };
208
209 #define IS_SRQ(qp) (qp->ext_type == EQPT_SRQ)
210 #define HAS_SQ(qp) (qp->ext_type != EQPT_SRQ)
211 #define HAS_RQ(qp) (qp->ext_type != EQPT_SRQBASE)
212
213 /* must be power of 2 */
214 #define QP_HASHTAB_LEN 8
215
216 struct ehca_cq {
217         struct ib_cq ib_cq;
218         struct ipz_queue ipz_queue;
219         struct h_galpas galpas;
220         spinlock_t spinlock;
221         u32 cq_number;
222         u32 token;
223         u32 nr_of_entries;
224         struct ipz_cq_handle ipz_cq_handle;
225         struct ehca_pfcq pf;
226         spinlock_t cb_lock;
227         struct hlist_head qp_hashtab[QP_HASHTAB_LEN];
228         struct list_head entry;
229         u32 nr_callbacks;   /* #events assigned to cpu by scaling code */
230         atomic_t nr_events; /* #events seen */
231         wait_queue_head_t wait_completion;
232         spinlock_t task_lock;
233         /* mmap counter for resources mapped into user space */
234         u32 mm_count_queue;
235         u32 mm_count_galpa;
236 };
237
238 enum ehca_mr_flag {
239         EHCA_MR_FLAG_FMR = 0x80000000,   /* FMR, created with ehca_alloc_fmr */
240         EHCA_MR_FLAG_MAXMR = 0x40000000, /* max-MR                           */
241 };
242
243 struct ehca_mr {
244         union {
245                 struct ib_mr ib_mr;     /* must always be first in ehca_mr */
246                 struct ib_fmr ib_fmr;   /* must always be first in ehca_mr */
247         } ib;
248         struct ib_umem *umem;
249         spinlock_t mrlock;
250
251         enum ehca_mr_flag flags;
252         u32 num_kpages;         /* number of kernel pages */
253         u32 num_hwpages;        /* number of hw pages to form MR */
254         u64 hwpage_size;        /* hw page size used for this MR */
255         int acl;                /* ACL (stored here for usage in reregister) */
256         u64 *start;             /* virtual start address (stored here for */
257                                 /* usage in reregister) */
258         u64 size;               /* size (stored here for usage in reregister) */
259         u32 fmr_page_size;      /* page size for FMR */
260         u32 fmr_max_pages;      /* max pages for FMR */
261         u32 fmr_max_maps;       /* max outstanding maps for FMR */
262         u32 fmr_map_cnt;        /* map counter for FMR */
263         /* fw specific data */
264         struct ipz_mrmw_handle ipz_mr_handle;   /* MR handle for h-calls */
265         struct h_galpas galpas;
266 };
267
268 struct ehca_mw {
269         struct ib_mw ib_mw;     /* gen2 mw, must always be first in ehca_mw */
270         spinlock_t mwlock;
271
272         u8 never_bound;         /* indication MW was never bound */
273         struct ipz_mrmw_handle ipz_mw_handle;   /* MW handle for h-calls */
274         struct h_galpas galpas;
275 };
276
277 enum ehca_mr_pgi_type {
278         EHCA_MR_PGI_PHYS   = 1,  /* type of ehca_reg_phys_mr,
279                                   * ehca_rereg_phys_mr,
280                                   * ehca_reg_internal_maxmr */
281         EHCA_MR_PGI_USER   = 2,  /* type of ehca_reg_user_mr */
282         EHCA_MR_PGI_FMR    = 3   /* type of ehca_map_phys_fmr */
283 };
284
285 struct ehca_mr_pginfo {
286         enum ehca_mr_pgi_type type;
287         u64 num_kpages;
288         u64 kpage_cnt;
289         u64 hwpage_size;     /* hw page size used for this MR */
290         u64 num_hwpages;     /* number of hw pages */
291         u64 hwpage_cnt;      /* counter for hw pages */
292         u64 next_hwpage;     /* next hw page in buffer/chunk/listelem */
293
294         union {
295                 struct { /* type EHCA_MR_PGI_PHYS section */
296                         int num_phys_buf;
297                         struct ib_phys_buf *phys_buf_array;
298                         u64 next_buf;
299                 } phy;
300                 struct { /* type EHCA_MR_PGI_USER section */
301                         struct ib_umem *region;
302                         struct ib_umem_chunk *next_chunk;
303                         u64 next_nmap;
304                 } usr;
305                 struct { /* type EHCA_MR_PGI_FMR section */
306                         u64 fmr_pgsize;
307                         u64 *page_list;
308                         u64 next_listelem;
309                 } fmr;
310         } u;
311 };
312
313 /* output parameters for MR/FMR hipz calls */
314 struct ehca_mr_hipzout_parms {
315         struct ipz_mrmw_handle handle;
316         u32 lkey;
317         u32 rkey;
318         u64 len;
319         u64 vaddr;
320         u32 acl;
321 };
322
323 /* output parameters for MW hipz calls */
324 struct ehca_mw_hipzout_parms {
325         struct ipz_mrmw_handle handle;
326         u32 rkey;
327 };
328
329 struct ehca_av {
330         struct ib_ah ib_ah;
331         struct ehca_ud_av av;
332 };
333
334 struct ehca_ucontext {
335         struct ib_ucontext ib_ucontext;
336 };
337
338 int ehca_init_pd_cache(void);
339 void ehca_cleanup_pd_cache(void);
340 int ehca_init_cq_cache(void);
341 void ehca_cleanup_cq_cache(void);
342 int ehca_init_qp_cache(void);
343 void ehca_cleanup_qp_cache(void);
344 int ehca_init_av_cache(void);
345 void ehca_cleanup_av_cache(void);
346 int ehca_init_mrmw_cache(void);
347 void ehca_cleanup_mrmw_cache(void);
348 int ehca_init_small_qp_cache(void);
349 void ehca_cleanup_small_qp_cache(void);
350
351 extern rwlock_t ehca_qp_idr_lock;
352 extern rwlock_t ehca_cq_idr_lock;
353 extern struct idr ehca_qp_idr;
354 extern struct idr ehca_cq_idr;
355
356 extern int ehca_static_rate;
357 extern int ehca_port_act_time;
358 extern int ehca_use_hp_mr;
359 extern int ehca_scaling_code;
360 extern int ehca_lock_hcalls;
361 extern int ehca_nr_ports;
362 extern int ehca_max_cq;
363 extern int ehca_max_qp;
364
365 struct ipzu_queue_resp {
366         u32 qe_size;      /* queue entry size */
367         u32 act_nr_of_sg;
368         u32 queue_length; /* queue length allocated in bytes */
369         u32 pagesize;
370         u32 toggle_state;
371         u32 offset; /* save offset within a page for small_qp */
372 };
373
374 struct ehca_create_cq_resp {
375         u32 cq_number;
376         u32 token;
377         struct ipzu_queue_resp ipz_queue;
378         u32 fw_handle_ofs;
379         u32 dummy;
380 };
381
382 struct ehca_create_qp_resp {
383         u32 qp_num;
384         u32 token;
385         u32 qp_type;
386         u32 ext_type;
387         u32 qkey;
388         /* qp_num assigned by ehca: sqp0/1 may have got different numbers */
389         u32 real_qp_num;
390         u32 fw_handle_ofs;
391         u32 dummy;
392         struct ipzu_queue_resp ipz_squeue;
393         struct ipzu_queue_resp ipz_rqueue;
394 };
395
396 struct ehca_alloc_cq_parms {
397         u32 nr_cqe;
398         u32 act_nr_of_entries;
399         u32 act_pages;
400         struct ipz_eq_handle eq_handle;
401 };
402
403 enum ehca_service_type {
404         ST_RC  = 0,
405         ST_UC  = 1,
406         ST_RD  = 2,
407         ST_UD  = 3,
408 };
409
410 enum ehca_ll_comp_flags {
411         LLQP_SEND_COMP = 0x20,
412         LLQP_RECV_COMP = 0x40,
413         LLQP_COMP_MASK = 0x60,
414 };
415
416 struct ehca_alloc_queue_parms {
417         /* input parameters */
418         int max_wr;
419         int max_sge;
420         int page_size;
421         int is_small;
422
423         /* output parameters */
424         u16 act_nr_wqes;
425         u8  act_nr_sges;
426         u32 queue_size; /* bytes for small queues, pages otherwise */
427 };
428
429 struct ehca_alloc_qp_parms {
430         struct ehca_alloc_queue_parms squeue;
431         struct ehca_alloc_queue_parms rqueue;
432
433         /* input parameters */
434         enum ehca_service_type servicetype;
435         int qp_storage;
436         int sigtype;
437         enum ehca_ext_qp_type ext_type;
438         enum ehca_ll_comp_flags ll_comp_flags;
439         int ud_av_l_key_ctl;
440
441         u32 token;
442         struct ipz_eq_handle eq_handle;
443         struct ipz_pd pd;
444         struct ipz_cq_handle send_cq_handle, recv_cq_handle;
445
446         u32 srq_qpn, srq_token, srq_limit;
447
448         /* output parameters */
449         u32 real_qp_num;
450         struct ipz_qp_handle qp_handle;
451         struct h_galpas galpas;
452 };
453
454 int ehca_cq_assign_qp(struct ehca_cq *cq, struct ehca_qp *qp);
455 int ehca_cq_unassign_qp(struct ehca_cq *cq, unsigned int qp_num);
456 struct ehca_qp *ehca_cq_get_qp(struct ehca_cq *cq, int qp_num);
457
458 #endif