IB: Add DMA mapping functions to allow device drivers to interpose
[linux-2.6.git] / include / rdma / ib_verbs.h
1 /*
2  * Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
3  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
4  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
5  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
6  * Copyright (c) 2004 Voltaire Corporation.  All rights reserved.
7  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
8  * Copyright (c) 2005, 2006 Cisco Systems.  All rights reserved.
9  *
10  * This software is available to you under a choice of one of two
11  * licenses.  You may choose to be licensed under the terms of the GNU
12  * General Public License (GPL) Version 2, available from the file
13  * COPYING in the main directory of this source tree, or the
14  * OpenIB.org BSD license below:
15  *
16  *     Redistribution and use in source and binary forms, with or
17  *     without modification, are permitted provided that the following
18  *     conditions are met:
19  *
20  *      - Redistributions of source code must retain the above
21  *        copyright notice, this list of conditions and the following
22  *        disclaimer.
23  *
24  *      - Redistributions in binary form must reproduce the above
25  *        copyright notice, this list of conditions and the following
26  *        disclaimer in the documentation and/or other materials
27  *        provided with the distribution.
28  *
29  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
30  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
31  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
32  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
33  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
34  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
35  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
36  * SOFTWARE.
37  *
38  * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
39  */
40
41 #if !defined(IB_VERBS_H)
42 #define IB_VERBS_H
43
44 #include <linux/types.h>
45 #include <linux/device.h>
46 #include <linux/mm.h>
47 #include <linux/dma-mapping.h>
48
49 #include <asm/atomic.h>
50 #include <asm/scatterlist.h>
51 #include <asm/uaccess.h>
52
53 union ib_gid {
54         u8      raw[16];
55         struct {
56                 __be64  subnet_prefix;
57                 __be64  interface_id;
58         } global;
59 };
60
61 enum rdma_node_type {
62         /* IB values map to NodeInfo:NodeType. */
63         RDMA_NODE_IB_CA         = 1,
64         RDMA_NODE_IB_SWITCH,
65         RDMA_NODE_IB_ROUTER,
66         RDMA_NODE_RNIC
67 };
68
69 enum rdma_transport_type {
70         RDMA_TRANSPORT_IB,
71         RDMA_TRANSPORT_IWARP
72 };
73
74 enum rdma_transport_type
75 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
76
77 enum ib_device_cap_flags {
78         IB_DEVICE_RESIZE_MAX_WR         = 1,
79         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
80         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
81         IB_DEVICE_RAW_MULTI             = (1<<3),
82         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
83         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
84         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
85         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
86         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
87         IB_DEVICE_INIT_TYPE             = (1<<9),
88         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
89         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
90         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
91         IB_DEVICE_SRQ_RESIZE            = (1<<13),
92         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
93         IB_DEVICE_ZERO_STAG             = (1<<15),
94         IB_DEVICE_SEND_W_INV            = (1<<16),
95         IB_DEVICE_MEM_WINDOW            = (1<<17)
96 };
97
98 enum ib_atomic_cap {
99         IB_ATOMIC_NONE,
100         IB_ATOMIC_HCA,
101         IB_ATOMIC_GLOB
102 };
103
104 struct ib_device_attr {
105         u64                     fw_ver;
106         __be64                  sys_image_guid;
107         u64                     max_mr_size;
108         u64                     page_size_cap;
109         u32                     vendor_id;
110         u32                     vendor_part_id;
111         u32                     hw_ver;
112         int                     max_qp;
113         int                     max_qp_wr;
114         int                     device_cap_flags;
115         int                     max_sge;
116         int                     max_sge_rd;
117         int                     max_cq;
118         int                     max_cqe;
119         int                     max_mr;
120         int                     max_pd;
121         int                     max_qp_rd_atom;
122         int                     max_ee_rd_atom;
123         int                     max_res_rd_atom;
124         int                     max_qp_init_rd_atom;
125         int                     max_ee_init_rd_atom;
126         enum ib_atomic_cap      atomic_cap;
127         int                     max_ee;
128         int                     max_rdd;
129         int                     max_mw;
130         int                     max_raw_ipv6_qp;
131         int                     max_raw_ethy_qp;
132         int                     max_mcast_grp;
133         int                     max_mcast_qp_attach;
134         int                     max_total_mcast_qp_attach;
135         int                     max_ah;
136         int                     max_fmr;
137         int                     max_map_per_fmr;
138         int                     max_srq;
139         int                     max_srq_wr;
140         int                     max_srq_sge;
141         u16                     max_pkeys;
142         u8                      local_ca_ack_delay;
143 };
144
145 enum ib_mtu {
146         IB_MTU_256  = 1,
147         IB_MTU_512  = 2,
148         IB_MTU_1024 = 3,
149         IB_MTU_2048 = 4,
150         IB_MTU_4096 = 5
151 };
152
153 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
154 {
155         switch (mtu) {
156         case IB_MTU_256:  return  256;
157         case IB_MTU_512:  return  512;
158         case IB_MTU_1024: return 1024;
159         case IB_MTU_2048: return 2048;
160         case IB_MTU_4096: return 4096;
161         default:          return -1;
162         }
163 }
164
165 enum ib_port_state {
166         IB_PORT_NOP             = 0,
167         IB_PORT_DOWN            = 1,
168         IB_PORT_INIT            = 2,
169         IB_PORT_ARMED           = 3,
170         IB_PORT_ACTIVE          = 4,
171         IB_PORT_ACTIVE_DEFER    = 5
172 };
173
174 enum ib_port_cap_flags {
175         IB_PORT_SM                              = 1 <<  1,
176         IB_PORT_NOTICE_SUP                      = 1 <<  2,
177         IB_PORT_TRAP_SUP                        = 1 <<  3,
178         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
179         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
180         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
181         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
182         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
183         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
184         IB_PORT_SM_DISABLED                     = 1 << 10,
185         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
186         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
187         IB_PORT_CM_SUP                          = 1 << 16,
188         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
189         IB_PORT_REINIT_SUP                      = 1 << 18,
190         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
191         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
192         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
193         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
194         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
195         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
196         IB_PORT_CLIENT_REG_SUP                  = 1 << 25
197 };
198
199 enum ib_port_width {
200         IB_WIDTH_1X     = 1,
201         IB_WIDTH_4X     = 2,
202         IB_WIDTH_8X     = 4,
203         IB_WIDTH_12X    = 8
204 };
205
206 static inline int ib_width_enum_to_int(enum ib_port_width width)
207 {
208         switch (width) {
209         case IB_WIDTH_1X:  return  1;
210         case IB_WIDTH_4X:  return  4;
211         case IB_WIDTH_8X:  return  8;
212         case IB_WIDTH_12X: return 12;
213         default:          return -1;
214         }
215 }
216
217 struct ib_port_attr {
218         enum ib_port_state      state;
219         enum ib_mtu             max_mtu;
220         enum ib_mtu             active_mtu;
221         int                     gid_tbl_len;
222         u32                     port_cap_flags;
223         u32                     max_msg_sz;
224         u32                     bad_pkey_cntr;
225         u32                     qkey_viol_cntr;
226         u16                     pkey_tbl_len;
227         u16                     lid;
228         u16                     sm_lid;
229         u8                      lmc;
230         u8                      max_vl_num;
231         u8                      sm_sl;
232         u8                      subnet_timeout;
233         u8                      init_type_reply;
234         u8                      active_width;
235         u8                      active_speed;
236         u8                      phys_state;
237 };
238
239 enum ib_device_modify_flags {
240         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
241         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
242 };
243
244 struct ib_device_modify {
245         u64     sys_image_guid;
246         char    node_desc[64];
247 };
248
249 enum ib_port_modify_flags {
250         IB_PORT_SHUTDOWN                = 1,
251         IB_PORT_INIT_TYPE               = (1<<2),
252         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
253 };
254
255 struct ib_port_modify {
256         u32     set_port_cap_mask;
257         u32     clr_port_cap_mask;
258         u8      init_type;
259 };
260
261 enum ib_event_type {
262         IB_EVENT_CQ_ERR,
263         IB_EVENT_QP_FATAL,
264         IB_EVENT_QP_REQ_ERR,
265         IB_EVENT_QP_ACCESS_ERR,
266         IB_EVENT_COMM_EST,
267         IB_EVENT_SQ_DRAINED,
268         IB_EVENT_PATH_MIG,
269         IB_EVENT_PATH_MIG_ERR,
270         IB_EVENT_DEVICE_FATAL,
271         IB_EVENT_PORT_ACTIVE,
272         IB_EVENT_PORT_ERR,
273         IB_EVENT_LID_CHANGE,
274         IB_EVENT_PKEY_CHANGE,
275         IB_EVENT_SM_CHANGE,
276         IB_EVENT_SRQ_ERR,
277         IB_EVENT_SRQ_LIMIT_REACHED,
278         IB_EVENT_QP_LAST_WQE_REACHED,
279         IB_EVENT_CLIENT_REREGISTER
280 };
281
282 struct ib_event {
283         struct ib_device        *device;
284         union {
285                 struct ib_cq    *cq;
286                 struct ib_qp    *qp;
287                 struct ib_srq   *srq;
288                 u8              port_num;
289         } element;
290         enum ib_event_type      event;
291 };
292
293 struct ib_event_handler {
294         struct ib_device *device;
295         void            (*handler)(struct ib_event_handler *, struct ib_event *);
296         struct list_head  list;
297 };
298
299 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
300         do {                                                    \
301                 (_ptr)->device  = _device;                      \
302                 (_ptr)->handler = _handler;                     \
303                 INIT_LIST_HEAD(&(_ptr)->list);                  \
304         } while (0)
305
306 struct ib_global_route {
307         union ib_gid    dgid;
308         u32             flow_label;
309         u8              sgid_index;
310         u8              hop_limit;
311         u8              traffic_class;
312 };
313
314 struct ib_grh {
315         __be32          version_tclass_flow;
316         __be16          paylen;
317         u8              next_hdr;
318         u8              hop_limit;
319         union ib_gid    sgid;
320         union ib_gid    dgid;
321 };
322
323 enum {
324         IB_MULTICAST_QPN = 0xffffff
325 };
326
327 #define IB_LID_PERMISSIVE       __constant_htons(0xFFFF)
328
329 enum ib_ah_flags {
330         IB_AH_GRH       = 1
331 };
332
333 enum ib_rate {
334         IB_RATE_PORT_CURRENT = 0,
335         IB_RATE_2_5_GBPS = 2,
336         IB_RATE_5_GBPS   = 5,
337         IB_RATE_10_GBPS  = 3,
338         IB_RATE_20_GBPS  = 6,
339         IB_RATE_30_GBPS  = 4,
340         IB_RATE_40_GBPS  = 7,
341         IB_RATE_60_GBPS  = 8,
342         IB_RATE_80_GBPS  = 9,
343         IB_RATE_120_GBPS = 10
344 };
345
346 /**
347  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
348  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
349  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
350  * @rate: rate to convert.
351  */
352 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
353
354 /**
355  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
356  * enum.
357  * @mult: multiple to convert.
358  */
359 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
360
361 struct ib_ah_attr {
362         struct ib_global_route  grh;
363         u16                     dlid;
364         u8                      sl;
365         u8                      src_path_bits;
366         u8                      static_rate;
367         u8                      ah_flags;
368         u8                      port_num;
369 };
370
371 enum ib_wc_status {
372         IB_WC_SUCCESS,
373         IB_WC_LOC_LEN_ERR,
374         IB_WC_LOC_QP_OP_ERR,
375         IB_WC_LOC_EEC_OP_ERR,
376         IB_WC_LOC_PROT_ERR,
377         IB_WC_WR_FLUSH_ERR,
378         IB_WC_MW_BIND_ERR,
379         IB_WC_BAD_RESP_ERR,
380         IB_WC_LOC_ACCESS_ERR,
381         IB_WC_REM_INV_REQ_ERR,
382         IB_WC_REM_ACCESS_ERR,
383         IB_WC_REM_OP_ERR,
384         IB_WC_RETRY_EXC_ERR,
385         IB_WC_RNR_RETRY_EXC_ERR,
386         IB_WC_LOC_RDD_VIOL_ERR,
387         IB_WC_REM_INV_RD_REQ_ERR,
388         IB_WC_REM_ABORT_ERR,
389         IB_WC_INV_EECN_ERR,
390         IB_WC_INV_EEC_STATE_ERR,
391         IB_WC_FATAL_ERR,
392         IB_WC_RESP_TIMEOUT_ERR,
393         IB_WC_GENERAL_ERR
394 };
395
396 enum ib_wc_opcode {
397         IB_WC_SEND,
398         IB_WC_RDMA_WRITE,
399         IB_WC_RDMA_READ,
400         IB_WC_COMP_SWAP,
401         IB_WC_FETCH_ADD,
402         IB_WC_BIND_MW,
403 /*
404  * Set value of IB_WC_RECV so consumers can test if a completion is a
405  * receive by testing (opcode & IB_WC_RECV).
406  */
407         IB_WC_RECV                      = 1 << 7,
408         IB_WC_RECV_RDMA_WITH_IMM
409 };
410
411 enum ib_wc_flags {
412         IB_WC_GRH               = 1,
413         IB_WC_WITH_IMM          = (1<<1)
414 };
415
416 struct ib_wc {
417         u64                     wr_id;
418         enum ib_wc_status       status;
419         enum ib_wc_opcode       opcode;
420         u32                     vendor_err;
421         u32                     byte_len;
422         __be32                  imm_data;
423         u32                     qp_num;
424         u32                     src_qp;
425         int                     wc_flags;
426         u16                     pkey_index;
427         u16                     slid;
428         u8                      sl;
429         u8                      dlid_path_bits;
430         u8                      port_num;       /* valid only for DR SMPs on switches */
431 };
432
433 enum ib_cq_notify {
434         IB_CQ_SOLICITED,
435         IB_CQ_NEXT_COMP
436 };
437
438 enum ib_srq_attr_mask {
439         IB_SRQ_MAX_WR   = 1 << 0,
440         IB_SRQ_LIMIT    = 1 << 1,
441 };
442
443 struct ib_srq_attr {
444         u32     max_wr;
445         u32     max_sge;
446         u32     srq_limit;
447 };
448
449 struct ib_srq_init_attr {
450         void                  (*event_handler)(struct ib_event *, void *);
451         void                   *srq_context;
452         struct ib_srq_attr      attr;
453 };
454
455 struct ib_qp_cap {
456         u32     max_send_wr;
457         u32     max_recv_wr;
458         u32     max_send_sge;
459         u32     max_recv_sge;
460         u32     max_inline_data;
461 };
462
463 enum ib_sig_type {
464         IB_SIGNAL_ALL_WR,
465         IB_SIGNAL_REQ_WR
466 };
467
468 enum ib_qp_type {
469         /*
470          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
471          * here (and in that order) since the MAD layer uses them as
472          * indices into a 2-entry table.
473          */
474         IB_QPT_SMI,
475         IB_QPT_GSI,
476
477         IB_QPT_RC,
478         IB_QPT_UC,
479         IB_QPT_UD,
480         IB_QPT_RAW_IPV6,
481         IB_QPT_RAW_ETY
482 };
483
484 struct ib_qp_init_attr {
485         void                  (*event_handler)(struct ib_event *, void *);
486         void                   *qp_context;
487         struct ib_cq           *send_cq;
488         struct ib_cq           *recv_cq;
489         struct ib_srq          *srq;
490         struct ib_qp_cap        cap;
491         enum ib_sig_type        sq_sig_type;
492         enum ib_qp_type         qp_type;
493         u8                      port_num; /* special QP types only */
494 };
495
496 enum ib_rnr_timeout {
497         IB_RNR_TIMER_655_36 =  0,
498         IB_RNR_TIMER_000_01 =  1,
499         IB_RNR_TIMER_000_02 =  2,
500         IB_RNR_TIMER_000_03 =  3,
501         IB_RNR_TIMER_000_04 =  4,
502         IB_RNR_TIMER_000_06 =  5,
503         IB_RNR_TIMER_000_08 =  6,
504         IB_RNR_TIMER_000_12 =  7,
505         IB_RNR_TIMER_000_16 =  8,
506         IB_RNR_TIMER_000_24 =  9,
507         IB_RNR_TIMER_000_32 = 10,
508         IB_RNR_TIMER_000_48 = 11,
509         IB_RNR_TIMER_000_64 = 12,
510         IB_RNR_TIMER_000_96 = 13,
511         IB_RNR_TIMER_001_28 = 14,
512         IB_RNR_TIMER_001_92 = 15,
513         IB_RNR_TIMER_002_56 = 16,
514         IB_RNR_TIMER_003_84 = 17,
515         IB_RNR_TIMER_005_12 = 18,
516         IB_RNR_TIMER_007_68 = 19,
517         IB_RNR_TIMER_010_24 = 20,
518         IB_RNR_TIMER_015_36 = 21,
519         IB_RNR_TIMER_020_48 = 22,
520         IB_RNR_TIMER_030_72 = 23,
521         IB_RNR_TIMER_040_96 = 24,
522         IB_RNR_TIMER_061_44 = 25,
523         IB_RNR_TIMER_081_92 = 26,
524         IB_RNR_TIMER_122_88 = 27,
525         IB_RNR_TIMER_163_84 = 28,
526         IB_RNR_TIMER_245_76 = 29,
527         IB_RNR_TIMER_327_68 = 30,
528         IB_RNR_TIMER_491_52 = 31
529 };
530
531 enum ib_qp_attr_mask {
532         IB_QP_STATE                     = 1,
533         IB_QP_CUR_STATE                 = (1<<1),
534         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
535         IB_QP_ACCESS_FLAGS              = (1<<3),
536         IB_QP_PKEY_INDEX                = (1<<4),
537         IB_QP_PORT                      = (1<<5),
538         IB_QP_QKEY                      = (1<<6),
539         IB_QP_AV                        = (1<<7),
540         IB_QP_PATH_MTU                  = (1<<8),
541         IB_QP_TIMEOUT                   = (1<<9),
542         IB_QP_RETRY_CNT                 = (1<<10),
543         IB_QP_RNR_RETRY                 = (1<<11),
544         IB_QP_RQ_PSN                    = (1<<12),
545         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
546         IB_QP_ALT_PATH                  = (1<<14),
547         IB_QP_MIN_RNR_TIMER             = (1<<15),
548         IB_QP_SQ_PSN                    = (1<<16),
549         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
550         IB_QP_PATH_MIG_STATE            = (1<<18),
551         IB_QP_CAP                       = (1<<19),
552         IB_QP_DEST_QPN                  = (1<<20)
553 };
554
555 enum ib_qp_state {
556         IB_QPS_RESET,
557         IB_QPS_INIT,
558         IB_QPS_RTR,
559         IB_QPS_RTS,
560         IB_QPS_SQD,
561         IB_QPS_SQE,
562         IB_QPS_ERR
563 };
564
565 enum ib_mig_state {
566         IB_MIG_MIGRATED,
567         IB_MIG_REARM,
568         IB_MIG_ARMED
569 };
570
571 struct ib_qp_attr {
572         enum ib_qp_state        qp_state;
573         enum ib_qp_state        cur_qp_state;
574         enum ib_mtu             path_mtu;
575         enum ib_mig_state       path_mig_state;
576         u32                     qkey;
577         u32                     rq_psn;
578         u32                     sq_psn;
579         u32                     dest_qp_num;
580         int                     qp_access_flags;
581         struct ib_qp_cap        cap;
582         struct ib_ah_attr       ah_attr;
583         struct ib_ah_attr       alt_ah_attr;
584         u16                     pkey_index;
585         u16                     alt_pkey_index;
586         u8                      en_sqd_async_notify;
587         u8                      sq_draining;
588         u8                      max_rd_atomic;
589         u8                      max_dest_rd_atomic;
590         u8                      min_rnr_timer;
591         u8                      port_num;
592         u8                      timeout;
593         u8                      retry_cnt;
594         u8                      rnr_retry;
595         u8                      alt_port_num;
596         u8                      alt_timeout;
597 };
598
599 enum ib_wr_opcode {
600         IB_WR_RDMA_WRITE,
601         IB_WR_RDMA_WRITE_WITH_IMM,
602         IB_WR_SEND,
603         IB_WR_SEND_WITH_IMM,
604         IB_WR_RDMA_READ,
605         IB_WR_ATOMIC_CMP_AND_SWP,
606         IB_WR_ATOMIC_FETCH_AND_ADD
607 };
608
609 enum ib_send_flags {
610         IB_SEND_FENCE           = 1,
611         IB_SEND_SIGNALED        = (1<<1),
612         IB_SEND_SOLICITED       = (1<<2),
613         IB_SEND_INLINE          = (1<<3)
614 };
615
616 struct ib_sge {
617         u64     addr;
618         u32     length;
619         u32     lkey;
620 };
621
622 struct ib_send_wr {
623         struct ib_send_wr      *next;
624         u64                     wr_id;
625         struct ib_sge          *sg_list;
626         int                     num_sge;
627         enum ib_wr_opcode       opcode;
628         int                     send_flags;
629         __be32                  imm_data;
630         union {
631                 struct {
632                         u64     remote_addr;
633                         u32     rkey;
634                 } rdma;
635                 struct {
636                         u64     remote_addr;
637                         u64     compare_add;
638                         u64     swap;
639                         u32     rkey;
640                 } atomic;
641                 struct {
642                         struct ib_ah *ah;
643                         u32     remote_qpn;
644                         u32     remote_qkey;
645                         u16     pkey_index; /* valid for GSI only */
646                         u8      port_num;   /* valid for DR SMPs on switch only */
647                 } ud;
648         } wr;
649 };
650
651 struct ib_recv_wr {
652         struct ib_recv_wr      *next;
653         u64                     wr_id;
654         struct ib_sge          *sg_list;
655         int                     num_sge;
656 };
657
658 enum ib_access_flags {
659         IB_ACCESS_LOCAL_WRITE   = 1,
660         IB_ACCESS_REMOTE_WRITE  = (1<<1),
661         IB_ACCESS_REMOTE_READ   = (1<<2),
662         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
663         IB_ACCESS_MW_BIND       = (1<<4)
664 };
665
666 struct ib_phys_buf {
667         u64      addr;
668         u64      size;
669 };
670
671 struct ib_mr_attr {
672         struct ib_pd    *pd;
673         u64             device_virt_addr;
674         u64             size;
675         int             mr_access_flags;
676         u32             lkey;
677         u32             rkey;
678 };
679
680 enum ib_mr_rereg_flags {
681         IB_MR_REREG_TRANS       = 1,
682         IB_MR_REREG_PD          = (1<<1),
683         IB_MR_REREG_ACCESS      = (1<<2)
684 };
685
686 struct ib_mw_bind {
687         struct ib_mr   *mr;
688         u64             wr_id;
689         u64             addr;
690         u32             length;
691         int             send_flags;
692         int             mw_access_flags;
693 };
694
695 struct ib_fmr_attr {
696         int     max_pages;
697         int     max_maps;
698         u8      page_shift;
699 };
700
701 struct ib_ucontext {
702         struct ib_device       *device;
703         struct list_head        pd_list;
704         struct list_head        mr_list;
705         struct list_head        mw_list;
706         struct list_head        cq_list;
707         struct list_head        qp_list;
708         struct list_head        srq_list;
709         struct list_head        ah_list;
710 };
711
712 struct ib_uobject {
713         u64                     user_handle;    /* handle given to us by userspace */
714         struct ib_ucontext     *context;        /* associated user context */
715         void                   *object;         /* containing object */
716         struct list_head        list;           /* link to context's list */
717         u32                     id;             /* index into kernel idr */
718         struct kref             ref;
719         struct rw_semaphore     mutex;          /* protects .live */
720         int                     live;
721 };
722
723 struct ib_umem {
724         unsigned long           user_base;
725         unsigned long           virt_base;
726         size_t                  length;
727         int                     offset;
728         int                     page_size;
729         int                     writable;
730         struct list_head        chunk_list;
731 };
732
733 struct ib_umem_chunk {
734         struct list_head        list;
735         int                     nents;
736         int                     nmap;
737         struct scatterlist      page_list[0];
738 };
739
740 struct ib_udata {
741         void __user *inbuf;
742         void __user *outbuf;
743         size_t       inlen;
744         size_t       outlen;
745 };
746
747 #define IB_UMEM_MAX_PAGE_CHUNK                                          \
748         ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) /      \
749          ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] -        \
750           (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
751
752 struct ib_umem_object {
753         struct ib_uobject       uobject;
754         struct ib_umem          umem;
755 };
756
757 struct ib_pd {
758         struct ib_device       *device;
759         struct ib_uobject      *uobject;
760         atomic_t                usecnt; /* count all resources */
761 };
762
763 struct ib_ah {
764         struct ib_device        *device;
765         struct ib_pd            *pd;
766         struct ib_uobject       *uobject;
767 };
768
769 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
770
771 struct ib_cq {
772         struct ib_device       *device;
773         struct ib_uobject      *uobject;
774         ib_comp_handler         comp_handler;
775         void                  (*event_handler)(struct ib_event *, void *);
776         void *                  cq_context;
777         int                     cqe;
778         atomic_t                usecnt; /* count number of work queues */
779 };
780
781 struct ib_srq {
782         struct ib_device       *device;
783         struct ib_pd           *pd;
784         struct ib_uobject      *uobject;
785         void                  (*event_handler)(struct ib_event *, void *);
786         void                   *srq_context;
787         atomic_t                usecnt;
788 };
789
790 struct ib_qp {
791         struct ib_device       *device;
792         struct ib_pd           *pd;
793         struct ib_cq           *send_cq;
794         struct ib_cq           *recv_cq;
795         struct ib_srq          *srq;
796         struct ib_uobject      *uobject;
797         void                  (*event_handler)(struct ib_event *, void *);
798         void                   *qp_context;
799         u32                     qp_num;
800         enum ib_qp_type         qp_type;
801 };
802
803 struct ib_mr {
804         struct ib_device  *device;
805         struct ib_pd      *pd;
806         struct ib_uobject *uobject;
807         u32                lkey;
808         u32                rkey;
809         atomic_t           usecnt; /* count number of MWs */
810 };
811
812 struct ib_mw {
813         struct ib_device        *device;
814         struct ib_pd            *pd;
815         struct ib_uobject       *uobject;
816         u32                     rkey;
817 };
818
819 struct ib_fmr {
820         struct ib_device        *device;
821         struct ib_pd            *pd;
822         struct list_head        list;
823         u32                     lkey;
824         u32                     rkey;
825 };
826
827 struct ib_mad;
828 struct ib_grh;
829
830 enum ib_process_mad_flags {
831         IB_MAD_IGNORE_MKEY      = 1,
832         IB_MAD_IGNORE_BKEY      = 2,
833         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
834 };
835
836 enum ib_mad_result {
837         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
838         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
839         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
840         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
841 };
842
843 #define IB_DEVICE_NAME_MAX 64
844
845 struct ib_cache {
846         rwlock_t                lock;
847         struct ib_event_handler event_handler;
848         struct ib_pkey_cache  **pkey_cache;
849         struct ib_gid_cache   **gid_cache;
850         u8                     *lmc_cache;
851 };
852
853 struct ib_dma_mapping_ops {
854         int             (*mapping_error)(struct ib_device *dev,
855                                          u64 dma_addr);
856         u64             (*map_single)(struct ib_device *dev,
857                                       void *ptr, size_t size,
858                                       enum dma_data_direction direction);
859         void            (*unmap_single)(struct ib_device *dev,
860                                         u64 addr, size_t size,
861                                         enum dma_data_direction direction);
862         u64             (*map_page)(struct ib_device *dev,
863                                     struct page *page, unsigned long offset,
864                                     size_t size,
865                                     enum dma_data_direction direction);
866         void            (*unmap_page)(struct ib_device *dev,
867                                       u64 addr, size_t size,
868                                       enum dma_data_direction direction);
869         int             (*map_sg)(struct ib_device *dev,
870                                   struct scatterlist *sg, int nents,
871                                   enum dma_data_direction direction);
872         void            (*unmap_sg)(struct ib_device *dev,
873                                     struct scatterlist *sg, int nents,
874                                     enum dma_data_direction direction);
875         u64             (*dma_address)(struct ib_device *dev,
876                                        struct scatterlist *sg);
877         unsigned int    (*dma_len)(struct ib_device *dev,
878                                    struct scatterlist *sg);
879         void            (*sync_single_for_cpu)(struct ib_device *dev,
880                                                u64 dma_handle,
881                                                size_t size,
882                                                enum dma_data_direction dir);
883         void            (*sync_single_for_device)(struct ib_device *dev,
884                                                   u64 dma_handle,
885                                                   size_t size,
886                                                   enum dma_data_direction dir);
887         void            *(*alloc_coherent)(struct ib_device *dev,
888                                            size_t size,
889                                            u64 *dma_handle,
890                                            gfp_t flag);
891         void            (*free_coherent)(struct ib_device *dev,
892                                          size_t size, void *cpu_addr,
893                                          u64 dma_handle);
894 };
895
896 struct iw_cm_verbs;
897
898 struct ib_device {
899         struct device                *dma_device;
900
901         char                          name[IB_DEVICE_NAME_MAX];
902
903         struct list_head              event_handler_list;
904         spinlock_t                    event_handler_lock;
905
906         struct list_head              core_list;
907         struct list_head              client_data_list;
908         spinlock_t                    client_data_lock;
909
910         struct ib_cache               cache;
911
912         u32                           flags;
913
914         struct iw_cm_verbs           *iwcm;
915
916         int                        (*query_device)(struct ib_device *device,
917                                                    struct ib_device_attr *device_attr);
918         int                        (*query_port)(struct ib_device *device,
919                                                  u8 port_num,
920                                                  struct ib_port_attr *port_attr);
921         int                        (*query_gid)(struct ib_device *device,
922                                                 u8 port_num, int index,
923                                                 union ib_gid *gid);
924         int                        (*query_pkey)(struct ib_device *device,
925                                                  u8 port_num, u16 index, u16 *pkey);
926         int                        (*modify_device)(struct ib_device *device,
927                                                     int device_modify_mask,
928                                                     struct ib_device_modify *device_modify);
929         int                        (*modify_port)(struct ib_device *device,
930                                                   u8 port_num, int port_modify_mask,
931                                                   struct ib_port_modify *port_modify);
932         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
933                                                      struct ib_udata *udata);
934         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
935         int                        (*mmap)(struct ib_ucontext *context,
936                                            struct vm_area_struct *vma);
937         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
938                                                struct ib_ucontext *context,
939                                                struct ib_udata *udata);
940         int                        (*dealloc_pd)(struct ib_pd *pd);
941         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
942                                                 struct ib_ah_attr *ah_attr);
943         int                        (*modify_ah)(struct ib_ah *ah,
944                                                 struct ib_ah_attr *ah_attr);
945         int                        (*query_ah)(struct ib_ah *ah,
946                                                struct ib_ah_attr *ah_attr);
947         int                        (*destroy_ah)(struct ib_ah *ah);
948         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
949                                                  struct ib_srq_init_attr *srq_init_attr,
950                                                  struct ib_udata *udata);
951         int                        (*modify_srq)(struct ib_srq *srq,
952                                                  struct ib_srq_attr *srq_attr,
953                                                  enum ib_srq_attr_mask srq_attr_mask,
954                                                  struct ib_udata *udata);
955         int                        (*query_srq)(struct ib_srq *srq,
956                                                 struct ib_srq_attr *srq_attr);
957         int                        (*destroy_srq)(struct ib_srq *srq);
958         int                        (*post_srq_recv)(struct ib_srq *srq,
959                                                     struct ib_recv_wr *recv_wr,
960                                                     struct ib_recv_wr **bad_recv_wr);
961         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
962                                                 struct ib_qp_init_attr *qp_init_attr,
963                                                 struct ib_udata *udata);
964         int                        (*modify_qp)(struct ib_qp *qp,
965                                                 struct ib_qp_attr *qp_attr,
966                                                 int qp_attr_mask,
967                                                 struct ib_udata *udata);
968         int                        (*query_qp)(struct ib_qp *qp,
969                                                struct ib_qp_attr *qp_attr,
970                                                int qp_attr_mask,
971                                                struct ib_qp_init_attr *qp_init_attr);
972         int                        (*destroy_qp)(struct ib_qp *qp);
973         int                        (*post_send)(struct ib_qp *qp,
974                                                 struct ib_send_wr *send_wr,
975                                                 struct ib_send_wr **bad_send_wr);
976         int                        (*post_recv)(struct ib_qp *qp,
977                                                 struct ib_recv_wr *recv_wr,
978                                                 struct ib_recv_wr **bad_recv_wr);
979         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
980                                                 struct ib_ucontext *context,
981                                                 struct ib_udata *udata);
982         int                        (*destroy_cq)(struct ib_cq *cq);
983         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
984                                                 struct ib_udata *udata);
985         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
986                                               struct ib_wc *wc);
987         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
988         int                        (*req_notify_cq)(struct ib_cq *cq,
989                                                     enum ib_cq_notify cq_notify);
990         int                        (*req_ncomp_notif)(struct ib_cq *cq,
991                                                       int wc_cnt);
992         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
993                                                  int mr_access_flags);
994         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
995                                                   struct ib_phys_buf *phys_buf_array,
996                                                   int num_phys_buf,
997                                                   int mr_access_flags,
998                                                   u64 *iova_start);
999         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1000                                                   struct ib_umem *region,
1001                                                   int mr_access_flags,
1002                                                   struct ib_udata *udata);
1003         int                        (*query_mr)(struct ib_mr *mr,
1004                                                struct ib_mr_attr *mr_attr);
1005         int                        (*dereg_mr)(struct ib_mr *mr);
1006         int                        (*rereg_phys_mr)(struct ib_mr *mr,
1007                                                     int mr_rereg_mask,
1008                                                     struct ib_pd *pd,
1009                                                     struct ib_phys_buf *phys_buf_array,
1010                                                     int num_phys_buf,
1011                                                     int mr_access_flags,
1012                                                     u64 *iova_start);
1013         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
1014         int                        (*bind_mw)(struct ib_qp *qp,
1015                                               struct ib_mw *mw,
1016                                               struct ib_mw_bind *mw_bind);
1017         int                        (*dealloc_mw)(struct ib_mw *mw);
1018         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1019                                                 int mr_access_flags,
1020                                                 struct ib_fmr_attr *fmr_attr);
1021         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1022                                                    u64 *page_list, int list_len,
1023                                                    u64 iova);
1024         int                        (*unmap_fmr)(struct list_head *fmr_list);
1025         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1026         int                        (*attach_mcast)(struct ib_qp *qp,
1027                                                    union ib_gid *gid,
1028                                                    u16 lid);
1029         int                        (*detach_mcast)(struct ib_qp *qp,
1030                                                    union ib_gid *gid,
1031                                                    u16 lid);
1032         int                        (*process_mad)(struct ib_device *device,
1033                                                   int process_mad_flags,
1034                                                   u8 port_num,
1035                                                   struct ib_wc *in_wc,
1036                                                   struct ib_grh *in_grh,
1037                                                   struct ib_mad *in_mad,
1038                                                   struct ib_mad *out_mad);
1039
1040         struct ib_dma_mapping_ops   *dma_ops;
1041
1042         struct module               *owner;
1043         struct class_device          class_dev;
1044         struct kobject               ports_parent;
1045         struct list_head             port_list;
1046
1047         enum {
1048                 IB_DEV_UNINITIALIZED,
1049                 IB_DEV_REGISTERED,
1050                 IB_DEV_UNREGISTERED
1051         }                            reg_state;
1052
1053         u64                          uverbs_cmd_mask;
1054         int                          uverbs_abi_ver;
1055
1056         char                         node_desc[64];
1057         __be64                       node_guid;
1058         u8                           node_type;
1059         u8                           phys_port_cnt;
1060 };
1061
1062 struct ib_client {
1063         char  *name;
1064         void (*add)   (struct ib_device *);
1065         void (*remove)(struct ib_device *);
1066
1067         struct list_head list;
1068 };
1069
1070 struct ib_device *ib_alloc_device(size_t size);
1071 void ib_dealloc_device(struct ib_device *device);
1072
1073 int ib_register_device   (struct ib_device *device);
1074 void ib_unregister_device(struct ib_device *device);
1075
1076 int ib_register_client   (struct ib_client *client);
1077 void ib_unregister_client(struct ib_client *client);
1078
1079 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1080 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1081                          void *data);
1082
1083 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1084 {
1085         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1086 }
1087
1088 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1089 {
1090         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1091 }
1092
1093 /**
1094  * ib_modify_qp_is_ok - Check that the supplied attribute mask
1095  * contains all required attributes and no attributes not allowed for
1096  * the given QP state transition.
1097  * @cur_state: Current QP state
1098  * @next_state: Next QP state
1099  * @type: QP type
1100  * @mask: Mask of supplied QP attributes
1101  *
1102  * This function is a helper function that a low-level driver's
1103  * modify_qp method can use to validate the consumer's input.  It
1104  * checks that cur_state and next_state are valid QP states, that a
1105  * transition from cur_state to next_state is allowed by the IB spec,
1106  * and that the attribute mask supplied is allowed for the transition.
1107  */
1108 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1109                        enum ib_qp_type type, enum ib_qp_attr_mask mask);
1110
1111 int ib_register_event_handler  (struct ib_event_handler *event_handler);
1112 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1113 void ib_dispatch_event(struct ib_event *event);
1114
1115 int ib_query_device(struct ib_device *device,
1116                     struct ib_device_attr *device_attr);
1117
1118 int ib_query_port(struct ib_device *device,
1119                   u8 port_num, struct ib_port_attr *port_attr);
1120
1121 int ib_query_gid(struct ib_device *device,
1122                  u8 port_num, int index, union ib_gid *gid);
1123
1124 int ib_query_pkey(struct ib_device *device,
1125                   u8 port_num, u16 index, u16 *pkey);
1126
1127 int ib_modify_device(struct ib_device *device,
1128                      int device_modify_mask,
1129                      struct ib_device_modify *device_modify);
1130
1131 int ib_modify_port(struct ib_device *device,
1132                    u8 port_num, int port_modify_mask,
1133                    struct ib_port_modify *port_modify);
1134
1135 /**
1136  * ib_alloc_pd - Allocates an unused protection domain.
1137  * @device: The device on which to allocate the protection domain.
1138  *
1139  * A protection domain object provides an association between QPs, shared
1140  * receive queues, address handles, memory regions, and memory windows.
1141  */
1142 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1143
1144 /**
1145  * ib_dealloc_pd - Deallocates a protection domain.
1146  * @pd: The protection domain to deallocate.
1147  */
1148 int ib_dealloc_pd(struct ib_pd *pd);
1149
1150 /**
1151  * ib_create_ah - Creates an address handle for the given address vector.
1152  * @pd: The protection domain associated with the address handle.
1153  * @ah_attr: The attributes of the address vector.
1154  *
1155  * The address handle is used to reference a local or global destination
1156  * in all UD QP post sends.
1157  */
1158 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1159
1160 /**
1161  * ib_init_ah_from_wc - Initializes address handle attributes from a
1162  *   work completion.
1163  * @device: Device on which the received message arrived.
1164  * @port_num: Port on which the received message arrived.
1165  * @wc: Work completion associated with the received message.
1166  * @grh: References the received global route header.  This parameter is
1167  *   ignored unless the work completion indicates that the GRH is valid.
1168  * @ah_attr: Returned attributes that can be used when creating an address
1169  *   handle for replying to the message.
1170  */
1171 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1172                        struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1173
1174 /**
1175  * ib_create_ah_from_wc - Creates an address handle associated with the
1176  *   sender of the specified work completion.
1177  * @pd: The protection domain associated with the address handle.
1178  * @wc: Work completion information associated with a received message.
1179  * @grh: References the received global route header.  This parameter is
1180  *   ignored unless the work completion indicates that the GRH is valid.
1181  * @port_num: The outbound port number to associate with the address.
1182  *
1183  * The address handle is used to reference a local or global destination
1184  * in all UD QP post sends.
1185  */
1186 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1187                                    struct ib_grh *grh, u8 port_num);
1188
1189 /**
1190  * ib_modify_ah - Modifies the address vector associated with an address
1191  *   handle.
1192  * @ah: The address handle to modify.
1193  * @ah_attr: The new address vector attributes to associate with the
1194  *   address handle.
1195  */
1196 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1197
1198 /**
1199  * ib_query_ah - Queries the address vector associated with an address
1200  *   handle.
1201  * @ah: The address handle to query.
1202  * @ah_attr: The address vector attributes associated with the address
1203  *   handle.
1204  */
1205 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1206
1207 /**
1208  * ib_destroy_ah - Destroys an address handle.
1209  * @ah: The address handle to destroy.
1210  */
1211 int ib_destroy_ah(struct ib_ah *ah);
1212
1213 /**
1214  * ib_create_srq - Creates a SRQ associated with the specified protection
1215  *   domain.
1216  * @pd: The protection domain associated with the SRQ.
1217  * @srq_init_attr: A list of initial attributes required to create the
1218  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
1219  *   the actual capabilities of the created SRQ.
1220  *
1221  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1222  * requested size of the SRQ, and set to the actual values allocated
1223  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
1224  * will always be at least as large as the requested values.
1225  */
1226 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1227                              struct ib_srq_init_attr *srq_init_attr);
1228
1229 /**
1230  * ib_modify_srq - Modifies the attributes for the specified SRQ.
1231  * @srq: The SRQ to modify.
1232  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
1233  *   the current values of selected SRQ attributes are returned.
1234  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1235  *   are being modified.
1236  *
1237  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1238  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1239  * the number of receives queued drops below the limit.
1240  */
1241 int ib_modify_srq(struct ib_srq *srq,
1242                   struct ib_srq_attr *srq_attr,
1243                   enum ib_srq_attr_mask srq_attr_mask);
1244
1245 /**
1246  * ib_query_srq - Returns the attribute list and current values for the
1247  *   specified SRQ.
1248  * @srq: The SRQ to query.
1249  * @srq_attr: The attributes of the specified SRQ.
1250  */
1251 int ib_query_srq(struct ib_srq *srq,
1252                  struct ib_srq_attr *srq_attr);
1253
1254 /**
1255  * ib_destroy_srq - Destroys the specified SRQ.
1256  * @srq: The SRQ to destroy.
1257  */
1258 int ib_destroy_srq(struct ib_srq *srq);
1259
1260 /**
1261  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1262  * @srq: The SRQ to post the work request on.
1263  * @recv_wr: A list of work requests to post on the receive queue.
1264  * @bad_recv_wr: On an immediate failure, this parameter will reference
1265  *   the work request that failed to be posted on the QP.
1266  */
1267 static inline int ib_post_srq_recv(struct ib_srq *srq,
1268                                    struct ib_recv_wr *recv_wr,
1269                                    struct ib_recv_wr **bad_recv_wr)
1270 {
1271         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1272 }
1273
1274 /**
1275  * ib_create_qp - Creates a QP associated with the specified protection
1276  *   domain.
1277  * @pd: The protection domain associated with the QP.
1278  * @qp_init_attr: A list of initial attributes required to create the
1279  *   QP.  If QP creation succeeds, then the attributes are updated to
1280  *   the actual capabilities of the created QP.
1281  */
1282 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1283                            struct ib_qp_init_attr *qp_init_attr);
1284
1285 /**
1286  * ib_modify_qp - Modifies the attributes for the specified QP and then
1287  *   transitions the QP to the given state.
1288  * @qp: The QP to modify.
1289  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1290  *   the current values of selected QP attributes are returned.
1291  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1292  *   are being modified.
1293  */
1294 int ib_modify_qp(struct ib_qp *qp,
1295                  struct ib_qp_attr *qp_attr,
1296                  int qp_attr_mask);
1297
1298 /**
1299  * ib_query_qp - Returns the attribute list and current values for the
1300  *   specified QP.
1301  * @qp: The QP to query.
1302  * @qp_attr: The attributes of the specified QP.
1303  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1304  * @qp_init_attr: Additional attributes of the selected QP.
1305  *
1306  * The qp_attr_mask may be used to limit the query to gathering only the
1307  * selected attributes.
1308  */
1309 int ib_query_qp(struct ib_qp *qp,
1310                 struct ib_qp_attr *qp_attr,
1311                 int qp_attr_mask,
1312                 struct ib_qp_init_attr *qp_init_attr);
1313
1314 /**
1315  * ib_destroy_qp - Destroys the specified QP.
1316  * @qp: The QP to destroy.
1317  */
1318 int ib_destroy_qp(struct ib_qp *qp);
1319
1320 /**
1321  * ib_post_send - Posts a list of work requests to the send queue of
1322  *   the specified QP.
1323  * @qp: The QP to post the work request on.
1324  * @send_wr: A list of work requests to post on the send queue.
1325  * @bad_send_wr: On an immediate failure, this parameter will reference
1326  *   the work request that failed to be posted on the QP.
1327  */
1328 static inline int ib_post_send(struct ib_qp *qp,
1329                                struct ib_send_wr *send_wr,
1330                                struct ib_send_wr **bad_send_wr)
1331 {
1332         return qp->device->post_send(qp, send_wr, bad_send_wr);
1333 }
1334
1335 /**
1336  * ib_post_recv - Posts a list of work requests to the receive queue of
1337  *   the specified QP.
1338  * @qp: The QP to post the work request on.
1339  * @recv_wr: A list of work requests to post on the receive queue.
1340  * @bad_recv_wr: On an immediate failure, this parameter will reference
1341  *   the work request that failed to be posted on the QP.
1342  */
1343 static inline int ib_post_recv(struct ib_qp *qp,
1344                                struct ib_recv_wr *recv_wr,
1345                                struct ib_recv_wr **bad_recv_wr)
1346 {
1347         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1348 }
1349
1350 /**
1351  * ib_create_cq - Creates a CQ on the specified device.
1352  * @device: The device on which to create the CQ.
1353  * @comp_handler: A user-specified callback that is invoked when a
1354  *   completion event occurs on the CQ.
1355  * @event_handler: A user-specified callback that is invoked when an
1356  *   asynchronous event not associated with a completion occurs on the CQ.
1357  * @cq_context: Context associated with the CQ returned to the user via
1358  *   the associated completion and event handlers.
1359  * @cqe: The minimum size of the CQ.
1360  *
1361  * Users can examine the cq structure to determine the actual CQ size.
1362  */
1363 struct ib_cq *ib_create_cq(struct ib_device *device,
1364                            ib_comp_handler comp_handler,
1365                            void (*event_handler)(struct ib_event *, void *),
1366                            void *cq_context, int cqe);
1367
1368 /**
1369  * ib_resize_cq - Modifies the capacity of the CQ.
1370  * @cq: The CQ to resize.
1371  * @cqe: The minimum size of the CQ.
1372  *
1373  * Users can examine the cq structure to determine the actual CQ size.
1374  */
1375 int ib_resize_cq(struct ib_cq *cq, int cqe);
1376
1377 /**
1378  * ib_destroy_cq - Destroys the specified CQ.
1379  * @cq: The CQ to destroy.
1380  */
1381 int ib_destroy_cq(struct ib_cq *cq);
1382
1383 /**
1384  * ib_poll_cq - poll a CQ for completion(s)
1385  * @cq:the CQ being polled
1386  * @num_entries:maximum number of completions to return
1387  * @wc:array of at least @num_entries &struct ib_wc where completions
1388  *   will be returned
1389  *
1390  * Poll a CQ for (possibly multiple) completions.  If the return value
1391  * is < 0, an error occurred.  If the return value is >= 0, it is the
1392  * number of completions returned.  If the return value is
1393  * non-negative and < num_entries, then the CQ was emptied.
1394  */
1395 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1396                              struct ib_wc *wc)
1397 {
1398         return cq->device->poll_cq(cq, num_entries, wc);
1399 }
1400
1401 /**
1402  * ib_peek_cq - Returns the number of unreaped completions currently
1403  *   on the specified CQ.
1404  * @cq: The CQ to peek.
1405  * @wc_cnt: A minimum number of unreaped completions to check for.
1406  *
1407  * If the number of unreaped completions is greater than or equal to wc_cnt,
1408  * this function returns wc_cnt, otherwise, it returns the actual number of
1409  * unreaped completions.
1410  */
1411 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1412
1413 /**
1414  * ib_req_notify_cq - Request completion notification on a CQ.
1415  * @cq: The CQ to generate an event for.
1416  * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
1417  *   occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
1418  *   notification will occur on the next completion.
1419  */
1420 static inline int ib_req_notify_cq(struct ib_cq *cq,
1421                                    enum ib_cq_notify cq_notify)
1422 {
1423         return cq->device->req_notify_cq(cq, cq_notify);
1424 }
1425
1426 /**
1427  * ib_req_ncomp_notif - Request completion notification when there are
1428  *   at least the specified number of unreaped completions on the CQ.
1429  * @cq: The CQ to generate an event for.
1430  * @wc_cnt: The number of unreaped completions that should be on the
1431  *   CQ before an event is generated.
1432  */
1433 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1434 {
1435         return cq->device->req_ncomp_notif ?
1436                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1437                 -ENOSYS;
1438 }
1439
1440 /**
1441  * ib_get_dma_mr - Returns a memory region for system memory that is
1442  *   usable for DMA.
1443  * @pd: The protection domain associated with the memory region.
1444  * @mr_access_flags: Specifies the memory access rights.
1445  *
1446  * Note that the ib_dma_*() functions defined below must be used
1447  * to create/destroy addresses used with the Lkey or Rkey returned
1448  * by ib_get_dma_mr().
1449  */
1450 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1451
1452 /**
1453  * ib_dma_mapping_error - check a DMA addr for error
1454  * @dev: The device for which the dma_addr was created
1455  * @dma_addr: The DMA address to check
1456  */
1457 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1458 {
1459         return dev->dma_ops ?
1460                 dev->dma_ops->mapping_error(dev, dma_addr) :
1461                 dma_mapping_error(dma_addr);
1462 }
1463
1464 /**
1465  * ib_dma_map_single - Map a kernel virtual address to DMA address
1466  * @dev: The device for which the dma_addr is to be created
1467  * @cpu_addr: The kernel virtual address
1468  * @size: The size of the region in bytes
1469  * @direction: The direction of the DMA
1470  */
1471 static inline u64 ib_dma_map_single(struct ib_device *dev,
1472                                     void *cpu_addr, size_t size,
1473                                     enum dma_data_direction direction)
1474 {
1475         return dev->dma_ops ?
1476                 dev->dma_ops->map_single(dev, cpu_addr, size, direction) :
1477                 dma_map_single(dev->dma_device, cpu_addr, size, direction);
1478 }
1479
1480 /**
1481  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1482  * @dev: The device for which the DMA address was created
1483  * @addr: The DMA address
1484  * @size: The size of the region in bytes
1485  * @direction: The direction of the DMA
1486  */
1487 static inline void ib_dma_unmap_single(struct ib_device *dev,
1488                                        u64 addr, size_t size,
1489                                        enum dma_data_direction direction)
1490 {
1491         dev->dma_ops ?
1492                 dev->dma_ops->unmap_single(dev, addr, size, direction) :
1493                 dma_unmap_single(dev->dma_device, addr, size, direction);
1494 }
1495
1496 /**
1497  * ib_dma_map_page - Map a physical page to DMA address
1498  * @dev: The device for which the dma_addr is to be created
1499  * @page: The page to be mapped
1500  * @offset: The offset within the page
1501  * @size: The size of the region in bytes
1502  * @direction: The direction of the DMA
1503  */
1504 static inline u64 ib_dma_map_page(struct ib_device *dev,
1505                                   struct page *page,
1506                                   unsigned long offset,
1507                                   size_t size,
1508                                          enum dma_data_direction direction)
1509 {
1510         return dev->dma_ops ?
1511                 dev->dma_ops->map_page(dev, page, offset, size, direction) :
1512                 dma_map_page(dev->dma_device, page, offset, size, direction);
1513 }
1514
1515 /**
1516  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1517  * @dev: The device for which the DMA address was created
1518  * @addr: The DMA address
1519  * @size: The size of the region in bytes
1520  * @direction: The direction of the DMA
1521  */
1522 static inline void ib_dma_unmap_page(struct ib_device *dev,
1523                                      u64 addr, size_t size,
1524                                      enum dma_data_direction direction)
1525 {
1526         dev->dma_ops ?
1527                 dev->dma_ops->unmap_page(dev, addr, size, direction) :
1528                 dma_unmap_page(dev->dma_device, addr, size, direction);
1529 }
1530
1531 /**
1532  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1533  * @dev: The device for which the DMA addresses are to be created
1534  * @sg: The array of scatter/gather entries
1535  * @nents: The number of scatter/gather entries
1536  * @direction: The direction of the DMA
1537  */
1538 static inline int ib_dma_map_sg(struct ib_device *dev,
1539                                 struct scatterlist *sg, int nents,
1540                                 enum dma_data_direction direction)
1541 {
1542         return dev->dma_ops ?
1543                 dev->dma_ops->map_sg(dev, sg, nents, direction) :
1544                 dma_map_sg(dev->dma_device, sg, nents, direction);
1545 }
1546
1547 /**
1548  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1549  * @dev: The device for which the DMA addresses were created
1550  * @sg: The array of scatter/gather entries
1551  * @nents: The number of scatter/gather entries
1552  * @direction: The direction of the DMA
1553  */
1554 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1555                                    struct scatterlist *sg, int nents,
1556                                    enum dma_data_direction direction)
1557 {
1558         dev->dma_ops ?
1559                 dev->dma_ops->unmap_sg(dev, sg, nents, direction) :
1560                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1561 }
1562
1563 /**
1564  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1565  * @dev: The device for which the DMA addresses were created
1566  * @sg: The scatter/gather entry
1567  */
1568 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1569                                     struct scatterlist *sg)
1570 {
1571         return dev->dma_ops ?
1572                 dev->dma_ops->dma_address(dev, sg) : sg_dma_address(sg);
1573 }
1574
1575 /**
1576  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1577  * @dev: The device for which the DMA addresses were created
1578  * @sg: The scatter/gather entry
1579  */
1580 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1581                                          struct scatterlist *sg)
1582 {
1583         return dev->dma_ops ?
1584                 dev->dma_ops->dma_len(dev, sg) : sg_dma_len(sg);
1585 }
1586
1587 /**
1588  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1589  * @dev: The device for which the DMA address was created
1590  * @addr: The DMA address
1591  * @size: The size of the region in bytes
1592  * @dir: The direction of the DMA
1593  */
1594 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1595                                               u64 addr,
1596                                               size_t size,
1597                                               enum dma_data_direction dir)
1598 {
1599         dev->dma_ops ?
1600                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir) :
1601                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1602 }
1603
1604 /**
1605  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1606  * @dev: The device for which the DMA address was created
1607  * @addr: The DMA address
1608  * @size: The size of the region in bytes
1609  * @dir: The direction of the DMA
1610  */
1611 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1612                                                  u64 addr,
1613                                                  size_t size,
1614                                                  enum dma_data_direction dir)
1615 {
1616         dev->dma_ops ?
1617                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir) :
1618                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1619 }
1620
1621 /**
1622  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1623  * @dev: The device for which the DMA address is requested
1624  * @size: The size of the region to allocate in bytes
1625  * @dma_handle: A pointer for returning the DMA address of the region
1626  * @flag: memory allocator flags
1627  */
1628 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1629                                            size_t size,
1630                                            u64 *dma_handle,
1631                                            gfp_t flag)
1632 {
1633         return dev->dma_ops ?
1634                 dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag) :
1635                 dma_alloc_coherent(dev->dma_device, size, dma_handle, flag);
1636 }
1637
1638 /**
1639  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1640  * @dev: The device for which the DMA addresses were allocated
1641  * @size: The size of the region
1642  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1643  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1644  */
1645 static inline void ib_dma_free_coherent(struct ib_device *dev,
1646                                         size_t size, void *cpu_addr,
1647                                         u64 dma_handle)
1648 {
1649         dev->dma_ops ?
1650                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle) :
1651                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1652 }
1653
1654 /**
1655  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1656  *   by an HCA.
1657  * @pd: The protection domain associated assigned to the registered region.
1658  * @phys_buf_array: Specifies a list of physical buffers to use in the
1659  *   memory region.
1660  * @num_phys_buf: Specifies the size of the phys_buf_array.
1661  * @mr_access_flags: Specifies the memory access rights.
1662  * @iova_start: The offset of the region's starting I/O virtual address.
1663  */
1664 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1665                              struct ib_phys_buf *phys_buf_array,
1666                              int num_phys_buf,
1667                              int mr_access_flags,
1668                              u64 *iova_start);
1669
1670 /**
1671  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1672  *   Conceptually, this call performs the functions deregister memory region
1673  *   followed by register physical memory region.  Where possible,
1674  *   resources are reused instead of deallocated and reallocated.
1675  * @mr: The memory region to modify.
1676  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1677  *   properties of the memory region are being modified.
1678  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1679  *   the new protection domain to associated with the memory region,
1680  *   otherwise, this parameter is ignored.
1681  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1682  *   field specifies a list of physical buffers to use in the new
1683  *   translation, otherwise, this parameter is ignored.
1684  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1685  *   field specifies the size of the phys_buf_array, otherwise, this
1686  *   parameter is ignored.
1687  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1688  *   field specifies the new memory access rights, otherwise, this
1689  *   parameter is ignored.
1690  * @iova_start: The offset of the region's starting I/O virtual address.
1691  */
1692 int ib_rereg_phys_mr(struct ib_mr *mr,
1693                      int mr_rereg_mask,
1694                      struct ib_pd *pd,
1695                      struct ib_phys_buf *phys_buf_array,
1696                      int num_phys_buf,
1697                      int mr_access_flags,
1698                      u64 *iova_start);
1699
1700 /**
1701  * ib_query_mr - Retrieves information about a specific memory region.
1702  * @mr: The memory region to retrieve information about.
1703  * @mr_attr: The attributes of the specified memory region.
1704  */
1705 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1706
1707 /**
1708  * ib_dereg_mr - Deregisters a memory region and removes it from the
1709  *   HCA translation table.
1710  * @mr: The memory region to deregister.
1711  */
1712 int ib_dereg_mr(struct ib_mr *mr);
1713
1714 /**
1715  * ib_alloc_mw - Allocates a memory window.
1716  * @pd: The protection domain associated with the memory window.
1717  */
1718 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1719
1720 /**
1721  * ib_bind_mw - Posts a work request to the send queue of the specified
1722  *   QP, which binds the memory window to the given address range and
1723  *   remote access attributes.
1724  * @qp: QP to post the bind work request on.
1725  * @mw: The memory window to bind.
1726  * @mw_bind: Specifies information about the memory window, including
1727  *   its address range, remote access rights, and associated memory region.
1728  */
1729 static inline int ib_bind_mw(struct ib_qp *qp,
1730                              struct ib_mw *mw,
1731                              struct ib_mw_bind *mw_bind)
1732 {
1733         /* XXX reference counting in corresponding MR? */
1734         return mw->device->bind_mw ?
1735                 mw->device->bind_mw(qp, mw, mw_bind) :
1736                 -ENOSYS;
1737 }
1738
1739 /**
1740  * ib_dealloc_mw - Deallocates a memory window.
1741  * @mw: The memory window to deallocate.
1742  */
1743 int ib_dealloc_mw(struct ib_mw *mw);
1744
1745 /**
1746  * ib_alloc_fmr - Allocates a unmapped fast memory region.
1747  * @pd: The protection domain associated with the unmapped region.
1748  * @mr_access_flags: Specifies the memory access rights.
1749  * @fmr_attr: Attributes of the unmapped region.
1750  *
1751  * A fast memory region must be mapped before it can be used as part of
1752  * a work request.
1753  */
1754 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1755                             int mr_access_flags,
1756                             struct ib_fmr_attr *fmr_attr);
1757
1758 /**
1759  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1760  * @fmr: The fast memory region to associate with the pages.
1761  * @page_list: An array of physical pages to map to the fast memory region.
1762  * @list_len: The number of pages in page_list.
1763  * @iova: The I/O virtual address to use with the mapped region.
1764  */
1765 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1766                                   u64 *page_list, int list_len,
1767                                   u64 iova)
1768 {
1769         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1770 }
1771
1772 /**
1773  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1774  * @fmr_list: A linked list of fast memory regions to unmap.
1775  */
1776 int ib_unmap_fmr(struct list_head *fmr_list);
1777
1778 /**
1779  * ib_dealloc_fmr - Deallocates a fast memory region.
1780  * @fmr: The fast memory region to deallocate.
1781  */
1782 int ib_dealloc_fmr(struct ib_fmr *fmr);
1783
1784 /**
1785  * ib_attach_mcast - Attaches the specified QP to a multicast group.
1786  * @qp: QP to attach to the multicast group.  The QP must be type
1787  *   IB_QPT_UD.
1788  * @gid: Multicast group GID.
1789  * @lid: Multicast group LID in host byte order.
1790  *
1791  * In order to send and receive multicast packets, subnet
1792  * administration must have created the multicast group and configured
1793  * the fabric appropriately.  The port associated with the specified
1794  * QP must also be a member of the multicast group.
1795  */
1796 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1797
1798 /**
1799  * ib_detach_mcast - Detaches the specified QP from a multicast group.
1800  * @qp: QP to detach from the multicast group.
1801  * @gid: Multicast group GID.
1802  * @lid: Multicast group LID in host byte order.
1803  */
1804 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1805
1806 #endif /* IB_VERBS_H */