[FEAT NET1222] ib_uverbs: Allow explicit mmio trigger
[opensuse:kernel.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, 2007 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
39 #if !defined(IB_VERBS_H)
40 #define IB_VERBS_H
41
42 #include <linux/types.h>
43 #include <linux/device.h>
44 #include <linux/mm.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/kref.h>
47 #include <linux/list.h>
48 #include <linux/rwsem.h>
49 #include <linux/scatterlist.h>
50 #include <linux/workqueue.h>
51
52 #include <asm/atomic.h>
53 #include <asm/uaccess.h>
54 #include <linux/rbtree.h>
55 #include <linux/mutex.h>
56
57 extern struct workqueue_struct *ib_wq;
58
59 union ib_gid {
60         u8      raw[16];
61         struct {
62                 __be64  subnet_prefix;
63                 __be64  interface_id;
64         } global;
65 };
66
67 enum rdma_node_type {
68         /* IB values map to NodeInfo:NodeType. */
69         RDMA_NODE_IB_CA         = 1,
70         RDMA_NODE_IB_SWITCH,
71         RDMA_NODE_IB_ROUTER,
72         RDMA_NODE_RNIC
73 };
74
75 enum rdma_transport_type {
76         RDMA_TRANSPORT_IB,
77         RDMA_TRANSPORT_IWARP
78 };
79
80 enum rdma_transport_type
81 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
82
83 enum rdma_link_layer {
84         IB_LINK_LAYER_UNSPECIFIED,
85         IB_LINK_LAYER_INFINIBAND,
86         IB_LINK_LAYER_ETHERNET,
87 };
88
89 enum ib_device_cap_flags {
90         IB_DEVICE_RESIZE_MAX_WR         = 1,
91         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
92         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
93         IB_DEVICE_RAW_MULTI             = (1<<3),
94         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
95         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
96         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
97         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
98         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
99         IB_DEVICE_INIT_TYPE             = (1<<9),
100         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
101         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
102         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
103         IB_DEVICE_SRQ_RESIZE            = (1<<13),
104         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
105         IB_DEVICE_LOCAL_DMA_LKEY        = (1<<15),
106         IB_DEVICE_RESERVED              = (1<<16), /* old SEND_W_INV */
107         IB_DEVICE_MEM_WINDOW            = (1<<17),
108         /*
109          * Devices should set IB_DEVICE_UD_IP_SUM if they support
110          * insertion of UDP and TCP checksum on outgoing UD IPoIB
111          * messages and can verify the validity of checksum for
112          * incoming messages.  Setting this flag implies that the
113          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
114          */
115         IB_DEVICE_UD_IP_CSUM            = (1<<18),
116         IB_DEVICE_UD_TSO                = (1<<19),
117         IB_DEVICE_XRC                   = (1<<20),
118         IB_DEVICE_MEM_MGT_EXTENSIONS    = (1<<21),
119         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK = (1<<22),
120 };
121
122 enum ib_atomic_cap {
123         IB_ATOMIC_NONE,
124         IB_ATOMIC_HCA,
125         IB_ATOMIC_GLOB
126 };
127
128 struct ib_device_attr {
129         u64                     fw_ver;
130         __be64                  sys_image_guid;
131         u64                     max_mr_size;
132         u64                     page_size_cap;
133         u32                     vendor_id;
134         u32                     vendor_part_id;
135         u32                     hw_ver;
136         int                     max_qp;
137         int                     max_qp_wr;
138         int                     device_cap_flags;
139         int                     max_sge;
140         int                     max_sge_rd;
141         int                     max_cq;
142         int                     max_cqe;
143         int                     max_mr;
144         int                     max_pd;
145         int                     max_qp_rd_atom;
146         int                     max_ee_rd_atom;
147         int                     max_res_rd_atom;
148         int                     max_qp_init_rd_atom;
149         int                     max_ee_init_rd_atom;
150         enum ib_atomic_cap      atomic_cap;
151         enum ib_atomic_cap      masked_atomic_cap;
152         int                     max_ee;
153         int                     max_rdd;
154         int                     max_mw;
155         int                     max_raw_ipv6_qp;
156         int                     max_raw_ethy_qp;
157         int                     max_mcast_grp;
158         int                     max_mcast_qp_attach;
159         int                     max_total_mcast_qp_attach;
160         int                     max_ah;
161         int                     max_fmr;
162         int                     max_map_per_fmr;
163         int                     max_srq;
164         int                     max_srq_wr;
165         int                     max_srq_sge;
166         unsigned int            max_fast_reg_page_list_len;
167         u16                     max_pkeys;
168         u8                      local_ca_ack_delay;
169 };
170
171 enum ib_mtu {
172         IB_MTU_256  = 1,
173         IB_MTU_512  = 2,
174         IB_MTU_1024 = 3,
175         IB_MTU_2048 = 4,
176         IB_MTU_4096 = 5
177 };
178
179 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
180 {
181         switch (mtu) {
182         case IB_MTU_256:  return  256;
183         case IB_MTU_512:  return  512;
184         case IB_MTU_1024: return 1024;
185         case IB_MTU_2048: return 2048;
186         case IB_MTU_4096: return 4096;
187         default:          return -1;
188         }
189 }
190
191 enum ib_port_state {
192         IB_PORT_NOP             = 0,
193         IB_PORT_DOWN            = 1,
194         IB_PORT_INIT            = 2,
195         IB_PORT_ARMED           = 3,
196         IB_PORT_ACTIVE          = 4,
197         IB_PORT_ACTIVE_DEFER    = 5
198 };
199
200 enum ib_port_cap_flags {
201         IB_PORT_SM                              = 1 <<  1,
202         IB_PORT_NOTICE_SUP                      = 1 <<  2,
203         IB_PORT_TRAP_SUP                        = 1 <<  3,
204         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
205         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
206         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
207         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
208         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
209         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
210         IB_PORT_SM_DISABLED                     = 1 << 10,
211         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
212         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
213         IB_PORT_EXTENDED_SPEEDS_SUP             = 1 << 14,
214         IB_PORT_CM_SUP                          = 1 << 16,
215         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
216         IB_PORT_REINIT_SUP                      = 1 << 18,
217         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
218         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
219         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
220         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
221         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
222         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
223         IB_PORT_CLIENT_REG_SUP                  = 1 << 25
224 };
225
226 enum ib_port_width {
227         IB_WIDTH_1X     = 1,
228         IB_WIDTH_4X     = 2,
229         IB_WIDTH_8X     = 4,
230         IB_WIDTH_12X    = 8
231 };
232
233 static inline int ib_width_enum_to_int(enum ib_port_width width)
234 {
235         switch (width) {
236         case IB_WIDTH_1X:  return  1;
237         case IB_WIDTH_4X:  return  4;
238         case IB_WIDTH_8X:  return  8;
239         case IB_WIDTH_12X: return 12;
240         default:          return -1;
241         }
242 }
243
244 enum ib_port_speed {
245         IB_SPEED_SDR    = 1,
246         IB_SPEED_DDR    = 2,
247         IB_SPEED_QDR    = 4,
248         IB_SPEED_FDR10  = 8,
249         IB_SPEED_FDR    = 16,
250         IB_SPEED_EDR    = 32
251 };
252
253 struct ib_protocol_stats {
254         /* TBD... */
255 };
256
257 struct iw_protocol_stats {
258         u64     ipInReceives;
259         u64     ipInHdrErrors;
260         u64     ipInTooBigErrors;
261         u64     ipInNoRoutes;
262         u64     ipInAddrErrors;
263         u64     ipInUnknownProtos;
264         u64     ipInTruncatedPkts;
265         u64     ipInDiscards;
266         u64     ipInDelivers;
267         u64     ipOutForwDatagrams;
268         u64     ipOutRequests;
269         u64     ipOutDiscards;
270         u64     ipOutNoRoutes;
271         u64     ipReasmTimeout;
272         u64     ipReasmReqds;
273         u64     ipReasmOKs;
274         u64     ipReasmFails;
275         u64     ipFragOKs;
276         u64     ipFragFails;
277         u64     ipFragCreates;
278         u64     ipInMcastPkts;
279         u64     ipOutMcastPkts;
280         u64     ipInBcastPkts;
281         u64     ipOutBcastPkts;
282
283         u64     tcpRtoAlgorithm;
284         u64     tcpRtoMin;
285         u64     tcpRtoMax;
286         u64     tcpMaxConn;
287         u64     tcpActiveOpens;
288         u64     tcpPassiveOpens;
289         u64     tcpAttemptFails;
290         u64     tcpEstabResets;
291         u64     tcpCurrEstab;
292         u64     tcpInSegs;
293         u64     tcpOutSegs;
294         u64     tcpRetransSegs;
295         u64     tcpInErrs;
296         u64     tcpOutRsts;
297 };
298
299 union rdma_protocol_stats {
300         struct ib_protocol_stats        ib;
301         struct iw_protocol_stats        iw;
302 };
303
304 struct ib_port_attr {
305         enum ib_port_state      state;
306         enum ib_mtu             max_mtu;
307         enum ib_mtu             active_mtu;
308         int                     gid_tbl_len;
309         u32                     port_cap_flags;
310         u32                     max_msg_sz;
311         u32                     bad_pkey_cntr;
312         u32                     qkey_viol_cntr;
313         u16                     pkey_tbl_len;
314         u16                     lid;
315         u16                     sm_lid;
316         u8                      lmc;
317         u8                      max_vl_num;
318         u8                      sm_sl;
319         u8                      subnet_timeout;
320         u8                      init_type_reply;
321         u8                      active_width;
322         u8                      active_speed;
323         u8                      phys_state;
324 };
325
326 enum ib_device_modify_flags {
327         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
328         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
329 };
330
331 struct ib_device_modify {
332         u64     sys_image_guid;
333         char    node_desc[64];
334 };
335
336 enum ib_port_modify_flags {
337         IB_PORT_SHUTDOWN                = 1,
338         IB_PORT_INIT_TYPE               = (1<<2),
339         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
340 };
341
342 struct ib_port_modify {
343         u32     set_port_cap_mask;
344         u32     clr_port_cap_mask;
345         u8      init_type;
346 };
347
348 enum ib_event_type {
349         IB_EVENT_CQ_ERR,
350         IB_EVENT_QP_FATAL,
351         IB_EVENT_QP_REQ_ERR,
352         IB_EVENT_QP_ACCESS_ERR,
353         IB_EVENT_COMM_EST,
354         IB_EVENT_SQ_DRAINED,
355         IB_EVENT_PATH_MIG,
356         IB_EVENT_PATH_MIG_ERR,
357         IB_EVENT_DEVICE_FATAL,
358         IB_EVENT_PORT_ACTIVE,
359         IB_EVENT_PORT_ERR,
360         IB_EVENT_LID_CHANGE,
361         IB_EVENT_PKEY_CHANGE,
362         IB_EVENT_SM_CHANGE,
363         IB_EVENT_SRQ_ERR,
364         IB_EVENT_SRQ_LIMIT_REACHED,
365         IB_EVENT_QP_LAST_WQE_REACHED,
366         IB_EVENT_CLIENT_REREGISTER,
367         IB_EVENT_GID_CHANGE,
368 };
369
370 enum ib_event_flags {
371         IB_XRC_QP_EVENT_FLAG = 0x80000000,
372 };
373
374 struct ib_event {
375         struct ib_device        *device;
376         union {
377                 struct ib_cq    *cq;
378                 struct ib_qp    *qp;
379                 struct ib_srq   *srq;
380                 u8              port_num;
381                 u32             xrc_qp_num;
382         } element;
383         enum ib_event_type      event;
384 };
385
386 struct ib_event_handler {
387         struct ib_device *device;
388         void            (*handler)(struct ib_event_handler *, struct ib_event *);
389         struct list_head  list;
390 };
391
392 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
393         do {                                                    \
394                 (_ptr)->device  = _device;                      \
395                 (_ptr)->handler = _handler;                     \
396                 INIT_LIST_HEAD(&(_ptr)->list);                  \
397         } while (0)
398
399 struct ib_global_route {
400         union ib_gid    dgid;
401         u32             flow_label;
402         u8              sgid_index;
403         u8              hop_limit;
404         u8              traffic_class;
405 };
406
407 struct ib_grh {
408         __be32          version_tclass_flow;
409         __be16          paylen;
410         u8              next_hdr;
411         u8              hop_limit;
412         union ib_gid    sgid;
413         union ib_gid    dgid;
414 };
415
416 enum {
417         IB_MULTICAST_QPN = 0xffffff
418 };
419
420 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
421
422 enum ib_ah_flags {
423         IB_AH_GRH       = 1
424 };
425
426 enum ib_rate {
427         IB_RATE_PORT_CURRENT = 0,
428         IB_RATE_2_5_GBPS = 2,
429         IB_RATE_5_GBPS   = 5,
430         IB_RATE_10_GBPS  = 3,
431         IB_RATE_20_GBPS  = 6,
432         IB_RATE_30_GBPS  = 4,
433         IB_RATE_40_GBPS  = 7,
434         IB_RATE_60_GBPS  = 8,
435         IB_RATE_80_GBPS  = 9,
436         IB_RATE_120_GBPS = 10,
437         IB_RATE_14_GBPS  = 11,
438         IB_RATE_56_GBPS  = 12,
439         IB_RATE_112_GBPS = 13,
440         IB_RATE_168_GBPS = 14,
441         IB_RATE_25_GBPS  = 15,
442         IB_RATE_100_GBPS = 16,
443         IB_RATE_200_GBPS = 17,
444         IB_RATE_300_GBPS = 18
445 };
446
447 /**
448  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
449  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
450  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
451  * @rate: rate to convert.
452  */
453 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
454
455 /**
456  * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
457  * For example, IB_RATE_2_5_GBPS will be converted to 2500.
458  * @rate: rate to convert.
459  */
460 int ib_rate_to_mbps(enum ib_rate rate) __attribute_const__;
461
462 /**
463  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
464  * enum.
465  * @mult: multiple to convert.
466  */
467 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
468
469 struct ib_ah_attr {
470         struct ib_global_route  grh;
471         u16                     dlid;
472         u8                      sl;
473         u8                      src_path_bits;
474         u8                      static_rate;
475         u8                      ah_flags;
476         u8                      port_num;
477 };
478
479 enum ib_wc_status {
480         IB_WC_SUCCESS,
481         IB_WC_LOC_LEN_ERR,
482         IB_WC_LOC_QP_OP_ERR,
483         IB_WC_LOC_EEC_OP_ERR,
484         IB_WC_LOC_PROT_ERR,
485         IB_WC_WR_FLUSH_ERR,
486         IB_WC_MW_BIND_ERR,
487         IB_WC_BAD_RESP_ERR,
488         IB_WC_LOC_ACCESS_ERR,
489         IB_WC_REM_INV_REQ_ERR,
490         IB_WC_REM_ACCESS_ERR,
491         IB_WC_REM_OP_ERR,
492         IB_WC_RETRY_EXC_ERR,
493         IB_WC_RNR_RETRY_EXC_ERR,
494         IB_WC_LOC_RDD_VIOL_ERR,
495         IB_WC_REM_INV_RD_REQ_ERR,
496         IB_WC_REM_ABORT_ERR,
497         IB_WC_INV_EECN_ERR,
498         IB_WC_INV_EEC_STATE_ERR,
499         IB_WC_FATAL_ERR,
500         IB_WC_RESP_TIMEOUT_ERR,
501         IB_WC_GENERAL_ERR
502 };
503
504 enum ib_wc_opcode {
505         IB_WC_SEND,
506         IB_WC_RDMA_WRITE,
507         IB_WC_RDMA_READ,
508         IB_WC_COMP_SWAP,
509         IB_WC_FETCH_ADD,
510         IB_WC_BIND_MW,
511         IB_WC_LSO,
512         IB_WC_LOCAL_INV,
513         IB_WC_FAST_REG_MR,
514         IB_WC_MASKED_COMP_SWAP,
515         IB_WC_MASKED_FETCH_ADD,
516 /*
517  * Set value of IB_WC_RECV so consumers can test if a completion is a
518  * receive by testing (opcode & IB_WC_RECV).
519  */
520         IB_WC_RECV                      = 1 << 7,
521         IB_WC_RECV_RDMA_WITH_IMM
522 };
523
524 enum ib_wc_flags {
525         IB_WC_GRH               = 1,
526         IB_WC_WITH_IMM          = (1<<1),
527         IB_WC_WITH_INVALIDATE   = (1<<2),
528 };
529
530 struct ib_wc {
531         u64                     wr_id;
532         enum ib_wc_status       status;
533         enum ib_wc_opcode       opcode;
534         u32                     vendor_err;
535         u32                     byte_len;
536         struct ib_qp           *qp;
537         union {
538                 __be32          imm_data;
539                 u32             invalidate_rkey;
540         } ex;
541         u32                     src_qp;
542         int                     wc_flags;
543         u16                     pkey_index;
544         u16                     slid;
545         u8                      sl;
546         u8                      dlid_path_bits;
547         u8                      port_num;       /* valid only for DR SMPs on switches */
548         int                     csum_ok;
549 };
550
551 enum ib_cq_notify_flags {
552         IB_CQ_SOLICITED                 = 1 << 0,
553         IB_CQ_NEXT_COMP                 = 1 << 1,
554         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
555         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
556 };
557
558 enum ib_srq_attr_mask {
559         IB_SRQ_MAX_WR   = 1 << 0,
560         IB_SRQ_LIMIT    = 1 << 1,
561 };
562
563 struct ib_srq_attr {
564         u32     max_wr;
565         u32     max_sge;
566         u32     srq_limit;
567 };
568
569 struct ib_srq_init_attr {
570         void                  (*event_handler)(struct ib_event *, void *);
571         void                   *srq_context;
572         struct ib_srq_attr      attr;
573 };
574
575 struct ib_qp_cap {
576         u32     max_send_wr;
577         u32     max_recv_wr;
578         u32     max_send_sge;
579         u32     max_recv_sge;
580         u32     max_inline_data;
581 };
582
583 enum ib_sig_type {
584         IB_SIGNAL_ALL_WR,
585         IB_SIGNAL_REQ_WR
586 };
587
588 enum ib_qp_type {
589         /*
590          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
591          * here (and in that order) since the MAD layer uses them as
592          * indices into a 2-entry table.
593          */
594         IB_QPT_SMI,
595         IB_QPT_GSI,
596
597         IB_QPT_RC,
598         IB_QPT_UC,
599         IB_QPT_UD,
600         IB_QPT_XRC,
601         IB_QPT_RAW_IPV6,
602         IB_QPT_RAW_ETHERTYPE,
603         IB_QPT_RAW_PACKET = 8,
604         IB_QPT_MAX
605 };
606
607 enum ib_qp_create_flags {
608         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
609         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
610         IB_QP_CREATE_USE_GFP_NOFS               = 1 << 2,
611 };
612
613 struct ib_qp_init_attr {
614         void                  (*event_handler)(struct ib_event *, void *);
615         void                   *qp_context;
616         struct ib_cq           *send_cq;
617         struct ib_cq           *recv_cq;
618         struct ib_srq          *srq;
619         struct ib_qp_cap        cap;
620         enum ib_sig_type        sq_sig_type;
621         enum ib_qp_type         qp_type;
622         enum ib_qp_create_flags create_flags;
623         struct ib_xrcd         *xrc_domain; /* XRC qp's only */
624         u8                      port_num; /* special QP types only */
625 };
626
627 enum ib_rnr_timeout {
628         IB_RNR_TIMER_655_36 =  0,
629         IB_RNR_TIMER_000_01 =  1,
630         IB_RNR_TIMER_000_02 =  2,
631         IB_RNR_TIMER_000_03 =  3,
632         IB_RNR_TIMER_000_04 =  4,
633         IB_RNR_TIMER_000_06 =  5,
634         IB_RNR_TIMER_000_08 =  6,
635         IB_RNR_TIMER_000_12 =  7,
636         IB_RNR_TIMER_000_16 =  8,
637         IB_RNR_TIMER_000_24 =  9,
638         IB_RNR_TIMER_000_32 = 10,
639         IB_RNR_TIMER_000_48 = 11,
640         IB_RNR_TIMER_000_64 = 12,
641         IB_RNR_TIMER_000_96 = 13,
642         IB_RNR_TIMER_001_28 = 14,
643         IB_RNR_TIMER_001_92 = 15,
644         IB_RNR_TIMER_002_56 = 16,
645         IB_RNR_TIMER_003_84 = 17,
646         IB_RNR_TIMER_005_12 = 18,
647         IB_RNR_TIMER_007_68 = 19,
648         IB_RNR_TIMER_010_24 = 20,
649         IB_RNR_TIMER_015_36 = 21,
650         IB_RNR_TIMER_020_48 = 22,
651         IB_RNR_TIMER_030_72 = 23,
652         IB_RNR_TIMER_040_96 = 24,
653         IB_RNR_TIMER_061_44 = 25,
654         IB_RNR_TIMER_081_92 = 26,
655         IB_RNR_TIMER_122_88 = 27,
656         IB_RNR_TIMER_163_84 = 28,
657         IB_RNR_TIMER_245_76 = 29,
658         IB_RNR_TIMER_327_68 = 30,
659         IB_RNR_TIMER_491_52 = 31
660 };
661
662 enum ib_qp_attr_mask {
663         IB_QP_STATE                     = 1,
664         IB_QP_CUR_STATE                 = (1<<1),
665         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
666         IB_QP_ACCESS_FLAGS              = (1<<3),
667         IB_QP_PKEY_INDEX                = (1<<4),
668         IB_QP_PORT                      = (1<<5),
669         IB_QP_QKEY                      = (1<<6),
670         IB_QP_AV                        = (1<<7),
671         IB_QP_PATH_MTU                  = (1<<8),
672         IB_QP_TIMEOUT                   = (1<<9),
673         IB_QP_RETRY_CNT                 = (1<<10),
674         IB_QP_RNR_RETRY                 = (1<<11),
675         IB_QP_RQ_PSN                    = (1<<12),
676         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
677         IB_QP_ALT_PATH                  = (1<<14),
678         IB_QP_MIN_RNR_TIMER             = (1<<15),
679         IB_QP_SQ_PSN                    = (1<<16),
680         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
681         IB_QP_PATH_MIG_STATE            = (1<<18),
682         IB_QP_CAP                       = (1<<19),
683         IB_QP_DEST_QPN                  = (1<<20)
684 };
685
686 enum ib_qp_state {
687         IB_QPS_RESET,
688         IB_QPS_INIT,
689         IB_QPS_RTR,
690         IB_QPS_RTS,
691         IB_QPS_SQD,
692         IB_QPS_SQE,
693         IB_QPS_ERR
694 };
695
696 enum ib_mig_state {
697         IB_MIG_MIGRATED,
698         IB_MIG_REARM,
699         IB_MIG_ARMED
700 };
701
702 struct ib_qp_attr {
703         enum ib_qp_state        qp_state;
704         enum ib_qp_state        cur_qp_state;
705         enum ib_mtu             path_mtu;
706         enum ib_mig_state       path_mig_state;
707         u32                     qkey;
708         u32                     rq_psn;
709         u32                     sq_psn;
710         u32                     dest_qp_num;
711         int                     qp_access_flags;
712         struct ib_qp_cap        cap;
713         struct ib_ah_attr       ah_attr;
714         struct ib_ah_attr       alt_ah_attr;
715         u16                     pkey_index;
716         u16                     alt_pkey_index;
717         u8                      en_sqd_async_notify;
718         u8                      sq_draining;
719         u8                      max_rd_atomic;
720         u8                      max_dest_rd_atomic;
721         u8                      min_rnr_timer;
722         u8                      port_num;
723         u8                      timeout;
724         u8                      retry_cnt;
725         u8                      rnr_retry;
726         u8                      alt_port_num;
727         u8                      alt_timeout;
728 };
729
730 enum ib_wr_opcode {
731         IB_WR_RDMA_WRITE,
732         IB_WR_RDMA_WRITE_WITH_IMM,
733         IB_WR_SEND,
734         IB_WR_SEND_WITH_IMM,
735         IB_WR_RDMA_READ,
736         IB_WR_ATOMIC_CMP_AND_SWP,
737         IB_WR_ATOMIC_FETCH_AND_ADD,
738         IB_WR_LSO,
739         IB_WR_SEND_WITH_INV,
740         IB_WR_RDMA_READ_WITH_INV,
741         IB_WR_LOCAL_INV,
742         IB_WR_FAST_REG_MR,
743         IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
744         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
745 };
746
747 enum ib_send_flags {
748         IB_SEND_FENCE           = 1,
749         IB_SEND_SIGNALED        = (1<<1),
750         IB_SEND_SOLICITED       = (1<<2),
751         IB_SEND_INLINE          = (1<<3),
752         IB_SEND_IP_CSUM         = (1<<4)
753 };
754
755 struct ib_sge {
756         u64     addr;
757         u32     length;
758         u32     lkey;
759 };
760
761 struct ib_fast_reg_page_list {
762         struct ib_device       *device;
763         u64                    *page_list;
764         unsigned int            max_page_list_len;
765 };
766
767 struct ib_send_wr {
768         struct ib_send_wr      *next;
769         u64                     wr_id;
770         struct ib_sge          *sg_list;
771         int                     num_sge;
772         enum ib_wr_opcode       opcode;
773         int                     send_flags;
774         union {
775                 __be32          imm_data;
776                 u32             invalidate_rkey;
777         } ex;
778         union {
779                 struct {
780                         u64     remote_addr;
781                         u32     rkey;
782                 } rdma;
783                 struct {
784                         u64     remote_addr;
785                         u64     compare_add;
786                         u64     swap;
787                         u64     compare_add_mask;
788                         u64     swap_mask;
789                         u32     rkey;
790                 } atomic;
791                 struct {
792                         struct ib_ah *ah;
793                         void   *header;
794                         int     hlen;
795                         int     mss;
796                         u32     remote_qpn;
797                         u32     remote_qkey;
798                         u16     pkey_index; /* valid for GSI only */
799                         u8      port_num;   /* valid for DR SMPs on switch only */
800                 } ud;
801                 struct {
802                         u64                             iova_start;
803                         struct ib_fast_reg_page_list   *page_list;
804                         unsigned int                    page_shift;
805                         unsigned int                    page_list_len;
806                         u32                             length;
807                         int                             access_flags;
808                         u32                             rkey;
809                 } fast_reg;
810         } wr;
811         u32                     xrc_remote_srq_num; /* valid for XRC sends only */
812 };
813
814 struct ib_recv_wr {
815         struct ib_recv_wr      *next;
816         u64                     wr_id;
817         struct ib_sge          *sg_list;
818         int                     num_sge;
819 };
820
821 enum ib_access_flags {
822         IB_ACCESS_LOCAL_WRITE   = 1,
823         IB_ACCESS_REMOTE_WRITE  = (1<<1),
824         IB_ACCESS_REMOTE_READ   = (1<<2),
825         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
826         IB_ACCESS_MW_BIND       = (1<<4)
827 };
828
829 struct ib_phys_buf {
830         u64      addr;
831         u64      size;
832 };
833
834 struct ib_mr_attr {
835         struct ib_pd    *pd;
836         u64             device_virt_addr;
837         u64             size;
838         int             mr_access_flags;
839         u32             lkey;
840         u32             rkey;
841 };
842
843 enum ib_mr_rereg_flags {
844         IB_MR_REREG_TRANS       = 1,
845         IB_MR_REREG_PD          = (1<<1),
846         IB_MR_REREG_ACCESS      = (1<<2)
847 };
848
849 struct ib_mw_bind {
850         struct ib_mr   *mr;
851         u64             wr_id;
852         u64             addr;
853         u32             length;
854         int             send_flags;
855         int             mw_access_flags;
856 };
857
858 struct ib_fmr_attr {
859         int     max_pages;
860         int     max_maps;
861         u8      page_shift;
862 };
863
864 struct ib_ucontext {
865         struct ib_device       *device;
866         struct list_head        pd_list;
867         struct list_head        mr_list;
868         struct list_head        mw_list;
869         struct list_head        cq_list;
870         struct list_head        qp_list;
871         struct list_head        srq_list;
872         struct list_head        ah_list;
873         struct list_head        xrc_domain_list;
874         int                     closing;
875 };
876
877 struct ib_uobject {
878         u64                     user_handle;    /* handle given to us by userspace */
879         struct ib_ucontext     *context;        /* associated user context */
880         void                   *object;         /* containing object */
881         struct list_head        list;           /* link to context's list */
882         int                     id;             /* index into kernel idr */
883         struct kref             ref;
884         struct rw_semaphore     mutex;          /* protects .live */
885         int                     live;
886 };
887
888 struct ib_udata {
889         void __user *inbuf;
890         void __user *outbuf;
891         size_t       inlen;
892         size_t       outlen;
893 };
894
895 struct ib_uxrc_rcv_object {
896         struct list_head        list;           /* link to context's list */
897         u32                     qp_num;
898         u32                     domain_handle;
899 };
900
901 struct ib_pd {
902         struct ib_device       *device;
903         struct ib_uobject      *uobject;
904         atomic_t                usecnt; /* count all resources */
905 };
906
907 struct ib_xrcd {
908         struct ib_device       *device;
909         struct ib_uobject      *uobject;
910         struct inode           *inode;
911         struct rb_node          node;
912         atomic_t                usecnt; /* count all resources */
913 };
914
915
916 struct ib_ah {
917         struct ib_device        *device;
918         struct ib_pd            *pd;
919         struct ib_uobject       *uobject;
920 };
921
922 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
923
924 struct ib_cq {
925         struct ib_device       *device;
926         struct ib_uobject      *uobject;
927         ib_comp_handler         comp_handler;
928         void                  (*event_handler)(struct ib_event *, void *);
929         void                   *cq_context;
930         int                     cqe;
931         atomic_t                usecnt; /* count number of work queues */
932 };
933
934 struct ib_srq {
935         struct ib_device       *device;
936         struct ib_pd           *pd;
937         struct ib_cq           *xrc_cq;
938         struct ib_xrcd         *xrcd;
939         struct ib_uobject      *uobject;
940         void                  (*event_handler)(struct ib_event *, void *);
941         void                   *srq_context;
942         atomic_t                usecnt;
943         u32                     xrc_srq_num;
944 };
945
946 struct ib_qp {
947         struct ib_device       *device;
948         struct ib_pd           *pd;
949         struct ib_cq           *send_cq;
950         struct ib_cq           *recv_cq;
951         struct ib_srq          *srq;
952         struct ib_uobject      *uobject;
953         void                  (*event_handler)(struct ib_event *, void *);
954         void                   *qp_context;
955         u32                     qp_num;
956         enum ib_qp_type         qp_type;
957         struct ib_xrcd         *xrcd;  /* XRC QPs only */
958 };
959
960 struct ib_mr {
961         struct ib_device  *device;
962         struct ib_pd      *pd;
963         struct ib_uobject *uobject;
964         u32                lkey;
965         u32                rkey;
966         atomic_t           usecnt; /* count number of MWs */
967 };
968
969 struct ib_mw {
970         struct ib_device        *device;
971         struct ib_pd            *pd;
972         struct ib_uobject       *uobject;
973         u32                     rkey;
974 };
975
976 struct ib_fmr {
977         struct ib_device        *device;
978         struct ib_pd            *pd;
979         struct list_head        list;
980         u32                     lkey;
981         u32                     rkey;
982 };
983
984 struct ib_mad;
985 struct ib_grh;
986
987 enum ib_process_mad_flags {
988         IB_MAD_IGNORE_MKEY      = 1,
989         IB_MAD_IGNORE_BKEY      = 2,
990         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
991 };
992
993 enum ib_mad_result {
994         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
995         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
996         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
997         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
998 };
999
1000 #define IB_DEVICE_NAME_MAX 64
1001
1002 struct ib_cache {
1003         rwlock_t                lock;
1004         struct ib_event_handler event_handler;
1005         struct ib_pkey_cache  **pkey_cache;
1006         struct ib_gid_cache   **gid_cache;
1007         u8                     *lmc_cache;
1008 };
1009
1010 struct ib_dma_mapping_ops {
1011         int             (*mapping_error)(struct ib_device *dev,
1012                                          u64 dma_addr);
1013         u64             (*map_single)(struct ib_device *dev,
1014                                       void *ptr, size_t size,
1015                                       enum dma_data_direction direction);
1016         void            (*unmap_single)(struct ib_device *dev,
1017                                         u64 addr, size_t size,
1018                                         enum dma_data_direction direction);
1019         u64             (*map_page)(struct ib_device *dev,
1020                                     struct page *page, unsigned long offset,
1021                                     size_t size,
1022                                     enum dma_data_direction direction);
1023         void            (*unmap_page)(struct ib_device *dev,
1024                                       u64 addr, size_t size,
1025                                       enum dma_data_direction direction);
1026         int             (*map_sg)(struct ib_device *dev,
1027                                   struct scatterlist *sg, int nents,
1028                                   enum dma_data_direction direction);
1029         void            (*unmap_sg)(struct ib_device *dev,
1030                                     struct scatterlist *sg, int nents,
1031                                     enum dma_data_direction direction);
1032         u64             (*dma_address)(struct ib_device *dev,
1033                                        struct scatterlist *sg);
1034         unsigned int    (*dma_len)(struct ib_device *dev,
1035                                    struct scatterlist *sg);
1036         void            (*sync_single_for_cpu)(struct ib_device *dev,
1037                                                u64 dma_handle,
1038                                                size_t size,
1039                                                enum dma_data_direction dir);
1040         void            (*sync_single_for_device)(struct ib_device *dev,
1041                                                   u64 dma_handle,
1042                                                   size_t size,
1043                                                   enum dma_data_direction dir);
1044         void            *(*alloc_coherent)(struct ib_device *dev,
1045                                            size_t size,
1046                                            u64 *dma_handle,
1047                                            gfp_t flag);
1048         void            (*free_coherent)(struct ib_device *dev,
1049                                          size_t size, void *cpu_addr,
1050                                          u64 dma_handle);
1051 };
1052
1053 struct iw_cm_verbs;
1054
1055 struct ib_device {
1056         struct device                *dma_device;
1057
1058         char                          name[IB_DEVICE_NAME_MAX];
1059
1060         struct list_head              event_handler_list;
1061         spinlock_t                    event_handler_lock;
1062
1063         spinlock_t                    client_data_lock;
1064         struct list_head              core_list;
1065         struct list_head              client_data_list;
1066
1067         struct ib_cache               cache;
1068         int                          *pkey_tbl_len;
1069         int                          *gid_tbl_len;
1070
1071         int                           num_comp_vectors;
1072
1073         struct iw_cm_verbs           *iwcm;
1074
1075         int                        (*get_protocol_stats)(struct ib_device *device,
1076                                                          union rdma_protocol_stats *stats);
1077         int                        (*query_device)(struct ib_device *device,
1078                                                    struct ib_device_attr *device_attr);
1079         int                        (*query_port)(struct ib_device *device,
1080                                                  u8 port_num,
1081                                                  struct ib_port_attr *port_attr);
1082         enum rdma_link_layer       (*get_link_layer)(struct ib_device *device,
1083                                                      u8 port_num);
1084         int                        (*query_gid)(struct ib_device *device,
1085                                                 u8 port_num, int index,
1086                                                 union ib_gid *gid);
1087         int                        (*query_pkey)(struct ib_device *device,
1088                                                  u8 port_num, u16 index, u16 *pkey);
1089         int                        (*modify_device)(struct ib_device *device,
1090                                                     int device_modify_mask,
1091                                                     struct ib_device_modify *device_modify);
1092         int                        (*modify_port)(struct ib_device *device,
1093                                                   u8 port_num, int port_modify_mask,
1094                                                   struct ib_port_modify *port_modify);
1095         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
1096                                                      struct ib_udata *udata);
1097         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
1098         int                        (*mmap)(struct ib_ucontext *context,
1099                                            struct vm_area_struct *vma);
1100         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
1101                                                struct ib_ucontext *context,
1102                                                struct ib_udata *udata);
1103         int                        (*dealloc_pd)(struct ib_pd *pd);
1104         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
1105                                                 struct ib_ah_attr *ah_attr);
1106         int                        (*modify_ah)(struct ib_ah *ah,
1107                                                 struct ib_ah_attr *ah_attr);
1108         int                        (*query_ah)(struct ib_ah *ah,
1109                                                struct ib_ah_attr *ah_attr);
1110         int                        (*destroy_ah)(struct ib_ah *ah);
1111         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
1112                                                  struct ib_srq_init_attr *srq_init_attr,
1113                                                  struct ib_udata *udata);
1114         int                        (*modify_srq)(struct ib_srq *srq,
1115                                                  struct ib_srq_attr *srq_attr,
1116                                                  enum ib_srq_attr_mask srq_attr_mask,
1117                                                  struct ib_udata *udata);
1118         int                        (*query_srq)(struct ib_srq *srq,
1119                                                 struct ib_srq_attr *srq_attr);
1120         int                        (*destroy_srq)(struct ib_srq *srq);
1121         int                        (*post_srq_recv)(struct ib_srq *srq,
1122                                                     struct ib_recv_wr *recv_wr,
1123                                                     struct ib_recv_wr **bad_recv_wr);
1124         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
1125                                                 struct ib_qp_init_attr *qp_init_attr,
1126                                                 struct ib_udata *udata);
1127         int                        (*modify_qp)(struct ib_qp *qp,
1128                                                 struct ib_qp_attr *qp_attr,
1129                                                 int qp_attr_mask,
1130                                                 struct ib_udata *udata);
1131         int                        (*query_qp)(struct ib_qp *qp,
1132                                                struct ib_qp_attr *qp_attr,
1133                                                int qp_attr_mask,
1134                                                struct ib_qp_init_attr *qp_init_attr);
1135         int                        (*destroy_qp)(struct ib_qp *qp);
1136         int                        (*post_send)(struct ib_qp *qp,
1137                                                 struct ib_send_wr *send_wr,
1138                                                 struct ib_send_wr **bad_send_wr);
1139         int                        (*post_recv)(struct ib_qp *qp,
1140                                                 struct ib_recv_wr *recv_wr,
1141                                                 struct ib_recv_wr **bad_recv_wr);
1142         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
1143                                                 int comp_vector,
1144                                                 struct ib_ucontext *context,
1145                                                 struct ib_udata *udata);
1146         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1147                                                 u16 cq_period);
1148         int                        (*destroy_cq)(struct ib_cq *cq);
1149         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
1150                                                 struct ib_udata *udata);
1151         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
1152                                               struct ib_wc *wc);
1153         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1154         int                        (*req_notify_cq)(struct ib_cq *cq,
1155                                                     enum ib_cq_notify_flags flags);
1156         int                        (*req_ncomp_notif)(struct ib_cq *cq,
1157                                                       int wc_cnt);
1158         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
1159                                                  int mr_access_flags);
1160         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
1161                                                   struct ib_phys_buf *phys_buf_array,
1162                                                   int num_phys_buf,
1163                                                   int mr_access_flags,
1164                                                   u64 *iova_start);
1165         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1166                                                   u64 start, u64 length,
1167                                                   u64 virt_addr,
1168                                                   int mr_access_flags,
1169                                                   struct ib_udata *udata);
1170         int                        (*query_mr)(struct ib_mr *mr,
1171                                                struct ib_mr_attr *mr_attr);
1172         int                        (*dereg_mr)(struct ib_mr *mr);
1173         struct ib_mr *             (*alloc_fast_reg_mr)(struct ib_pd *pd,
1174                                                int max_page_list_len);
1175         struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1176                                                                    int page_list_len);
1177         void                       (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1178         int                        (*rereg_phys_mr)(struct ib_mr *mr,
1179                                                     int mr_rereg_mask,
1180                                                     struct ib_pd *pd,
1181                                                     struct ib_phys_buf *phys_buf_array,
1182                                                     int num_phys_buf,
1183                                                     int mr_access_flags,
1184                                                     u64 *iova_start);
1185         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
1186         int                        (*bind_mw)(struct ib_qp *qp,
1187                                               struct ib_mw *mw,
1188                                               struct ib_mw_bind *mw_bind);
1189         int                        (*dealloc_mw)(struct ib_mw *mw);
1190         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1191                                                 int mr_access_flags,
1192                                                 struct ib_fmr_attr *fmr_attr);
1193         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1194                                                    u64 *page_list, int list_len,
1195                                                    u64 iova);
1196         int                        (*unmap_fmr)(struct list_head *fmr_list);
1197         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1198         int                        (*attach_mcast)(struct ib_qp *qp,
1199                                                    union ib_gid *gid,
1200                                                    u16 lid);
1201         int                        (*detach_mcast)(struct ib_qp *qp,
1202                                                    union ib_gid *gid,
1203                                                    u16 lid);
1204         int                        (*process_mad)(struct ib_device *device,
1205                                                   int process_mad_flags,
1206                                                   u8 port_num,
1207                                                   struct ib_wc *in_wc,
1208                                                   struct ib_grh *in_grh,
1209                                                   struct ib_mad *in_mad,
1210                                                   struct ib_mad *out_mad);
1211         struct ib_srq *            (*create_xrc_srq)(struct ib_pd *pd,
1212                                                      struct ib_cq *xrc_cq,
1213                                                      struct ib_xrcd *xrcd,
1214                                                      struct ib_srq_init_attr *srq_init_attr,
1215                                                      struct ib_udata *udata);
1216         struct ib_xrcd *           (*alloc_xrcd)(struct ib_device *device,
1217                                                  struct ib_ucontext *context,
1218                                                  struct ib_udata *udata);
1219         int                        (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1220         int                        (*create_xrc_rcv_qp)(struct ib_qp_init_attr *init_attr,
1221                                                         u32 *qp_num);
1222         int                        (*modify_xrc_rcv_qp)(struct ib_xrcd *xrcd,
1223                                                         u32 qp_num,
1224                                                         struct ib_qp_attr *attr,
1225                                                         int attr_mask);
1226         int                        (*query_xrc_rcv_qp)(struct ib_xrcd *xrcd,
1227                                                        u32 qp_num,
1228                                                        struct ib_qp_attr *attr,
1229                                                        int attr_mask,
1230                                                        struct ib_qp_init_attr *init_attr);
1231         int                        (*reg_xrc_rcv_qp)(struct ib_xrcd *xrcd,
1232                                                      void *context,
1233                                                      u32 qp_num);
1234         int                        (*unreg_xrc_rcv_qp)(struct ib_xrcd *xrcd,
1235                                                        void *context,
1236                                                        u32 qp_num);
1237         int                     (*kwrite_mmio32)(struct ib_ucontext *ibcontext,
1238                                                 u64 offset,
1239                                                 u32 value);
1240         int                     (*kwrite_mmio64)(struct ib_ucontext *ibcontext,
1241                                                 u64 offset,
1242                                                 u64 value);
1243
1244         struct ib_dma_mapping_ops   *dma_ops;
1245
1246         struct module               *owner;
1247         struct device                dev;
1248         struct kobject               *ports_parent;
1249         struct list_head             port_list;
1250
1251         enum {
1252                 IB_DEV_UNINITIALIZED,
1253                 IB_DEV_REGISTERED,
1254                 IB_DEV_UNREGISTERED
1255         }                            reg_state;
1256
1257         int                          uverbs_abi_ver;
1258         u64                          uverbs_cmd_mask;
1259
1260         char                         node_desc[64];
1261         __be64                       node_guid;
1262         u32                          local_dma_lkey;
1263         u8                           node_type;
1264         u8                           phys_port_cnt;
1265         struct rb_root               ib_uverbs_xrcd_table;
1266         struct mutex                 xrcd_table_mutex;
1267 };
1268
1269 struct ib_client {
1270         char  *name;
1271         void (*add)   (struct ib_device *);
1272         void (*remove)(struct ib_device *);
1273
1274         struct list_head list;
1275 };
1276
1277 struct ib_device *ib_alloc_device(size_t size);
1278 void ib_dealloc_device(struct ib_device *device);
1279
1280 int ib_register_device(struct ib_device *device,
1281                        int (*port_callback)(struct ib_device *,
1282                                             u8, struct kobject *));
1283 void ib_unregister_device(struct ib_device *device);
1284
1285 int ib_register_client   (struct ib_client *client);
1286 void ib_unregister_client(struct ib_client *client);
1287
1288 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1289 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1290                          void *data);
1291
1292 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1293 {
1294         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1295 }
1296
1297 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1298 {
1299         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1300 }
1301
1302 /**
1303  * ib_modify_qp_is_ok - Check that the supplied attribute mask
1304  * contains all required attributes and no attributes not allowed for
1305  * the given QP state transition.
1306  * @cur_state: Current QP state
1307  * @next_state: Next QP state
1308  * @type: QP type
1309  * @mask: Mask of supplied QP attributes
1310  *
1311  * This function is a helper function that a low-level driver's
1312  * modify_qp method can use to validate the consumer's input.  It
1313  * checks that cur_state and next_state are valid QP states, that a
1314  * transition from cur_state to next_state is allowed by the IB spec,
1315  * and that the attribute mask supplied is allowed for the transition.
1316  */
1317 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1318                        enum ib_qp_type type, enum ib_qp_attr_mask mask);
1319
1320 int ib_register_event_handler  (struct ib_event_handler *event_handler);
1321 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1322 void ib_dispatch_event(struct ib_event *event);
1323
1324 int ib_query_device(struct ib_device *device,
1325                     struct ib_device_attr *device_attr);
1326
1327 int ib_query_port(struct ib_device *device,
1328                   u8 port_num, struct ib_port_attr *port_attr);
1329
1330 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1331                                                u8 port_num);
1332
1333 int ib_query_gid(struct ib_device *device,
1334                  u8 port_num, int index, union ib_gid *gid);
1335
1336 int ib_query_pkey(struct ib_device *device,
1337                   u8 port_num, u16 index, u16 *pkey);
1338
1339 int ib_modify_device(struct ib_device *device,
1340                      int device_modify_mask,
1341                      struct ib_device_modify *device_modify);
1342
1343 int ib_modify_port(struct ib_device *device,
1344                    u8 port_num, int port_modify_mask,
1345                    struct ib_port_modify *port_modify);
1346
1347 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1348                 u8 *port_num, u16 *index);
1349
1350 int ib_find_pkey(struct ib_device *device,
1351                  u8 port_num, u16 pkey, u16 *index);
1352
1353 /**
1354  * ib_alloc_pd - Allocates an unused protection domain.
1355  * @device: The device on which to allocate the protection domain.
1356  *
1357  * A protection domain object provides an association between QPs, shared
1358  * receive queues, address handles, memory regions, and memory windows.
1359  */
1360 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1361
1362 /**
1363  * ib_dealloc_pd - Deallocates a protection domain.
1364  * @pd: The protection domain to deallocate.
1365  */
1366 int ib_dealloc_pd(struct ib_pd *pd);
1367
1368 /**
1369  * ib_create_ah - Creates an address handle for the given address vector.
1370  * @pd: The protection domain associated with the address handle.
1371  * @ah_attr: The attributes of the address vector.
1372  *
1373  * The address handle is used to reference a local or global destination
1374  * in all UD QP post sends.
1375  */
1376 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1377
1378 /**
1379  * ib_init_ah_from_wc - Initializes address handle attributes from a
1380  *   work completion.
1381  * @device: Device on which the received message arrived.
1382  * @port_num: Port on which the received message arrived.
1383  * @wc: Work completion associated with the received message.
1384  * @grh: References the received global route header.  This parameter is
1385  *   ignored unless the work completion indicates that the GRH is valid.
1386  * @ah_attr: Returned attributes that can be used when creating an address
1387  *   handle for replying to the message.
1388  */
1389 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1390                        struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1391
1392 /**
1393  * ib_create_ah_from_wc - Creates an address handle associated with the
1394  *   sender of the specified work completion.
1395  * @pd: The protection domain associated with the address handle.
1396  * @wc: Work completion information associated with a received message.
1397  * @grh: References the received global route header.  This parameter is
1398  *   ignored unless the work completion indicates that the GRH is valid.
1399  * @port_num: The outbound port number to associate with the address.
1400  *
1401  * The address handle is used to reference a local or global destination
1402  * in all UD QP post sends.
1403  */
1404 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1405                                    struct ib_grh *grh, u8 port_num);
1406
1407 /**
1408  * ib_modify_ah - Modifies the address vector associated with an address
1409  *   handle.
1410  * @ah: The address handle to modify.
1411  * @ah_attr: The new address vector attributes to associate with the
1412  *   address handle.
1413  */
1414 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1415
1416 /**
1417  * ib_query_ah - Queries the address vector associated with an address
1418  *   handle.
1419  * @ah: The address handle to query.
1420  * @ah_attr: The address vector attributes associated with the address
1421  *   handle.
1422  */
1423 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1424
1425 /**
1426  * ib_destroy_ah - Destroys an address handle.
1427  * @ah: The address handle to destroy.
1428  */
1429 int ib_destroy_ah(struct ib_ah *ah);
1430
1431 /**
1432  * ib_create_xrc_srq - Creates an XRC SRQ associated with the specified
1433  *   protection domain, cq, and xrc domain.
1434  * @pd: The protection domain associated with the SRQ.
1435  * @xrc_cq: The cq to be associated with the XRC SRQ.
1436  * @xrcd: The XRC domain to be associated with the XRC SRQ.
1437  * @srq_init_attr: A list of initial attributes required to create the
1438  *   XRC SRQ.  If XRC SRQ creation succeeds, then the attributes are updated
1439  *   to the actual capabilities of the created XRC SRQ.
1440  *
1441  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1442  * requested size of the XRC SRQ, and set to the actual values allocated
1443  * on return.  If ib_create_xrc_srq() succeeds, then max_wr and max_sge
1444  * will always be at least as large as the requested values.
1445  */
1446 struct ib_srq *ib_create_xrc_srq(struct ib_pd *pd,
1447                                  struct ib_cq *xrc_cq,
1448                                  struct ib_xrcd *xrcd,
1449                                  struct ib_srq_init_attr *srq_init_attr);
1450
1451 /**
1452  * ib_create_srq - Creates an SRQ associated with the specified
1453  *   protection domain.
1454  * @pd: The protection domain associated with the SRQ.
1455  * @srq_init_attr: A list of initial attributes required to create the
1456  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
1457  *   the actual capabilities of the created SRQ.
1458  *
1459  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1460  * requested size of the SRQ, and set to the actual values allocated
1461  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
1462  * will always be at least as large as the requested values.
1463  */
1464 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1465                              struct ib_srq_init_attr *srq_init_attr);
1466
1467 /**
1468  * ib_modify_srq - Modifies the attributes for the specified SRQ.
1469  * @srq: The SRQ to modify.
1470  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
1471  *   the current values of selected SRQ attributes are returned.
1472  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1473  *   are being modified.
1474  *
1475  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1476  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1477  * the number of receives queued drops below the limit.
1478  */
1479 int ib_modify_srq(struct ib_srq *srq,
1480                   struct ib_srq_attr *srq_attr,
1481                   enum ib_srq_attr_mask srq_attr_mask);
1482
1483 /**
1484  * ib_query_srq - Returns the attribute list and current values for the
1485  *   specified SRQ.
1486  * @srq: The SRQ to query.
1487  * @srq_attr: The attributes of the specified SRQ.
1488  */
1489 int ib_query_srq(struct ib_srq *srq,
1490                  struct ib_srq_attr *srq_attr);
1491
1492 /**
1493  * ib_destroy_srq - Destroys the specified SRQ.
1494  * @srq: The SRQ to destroy.
1495  */
1496 int ib_destroy_srq(struct ib_srq *srq);
1497
1498 /**
1499  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1500  * @srq: The SRQ to post the work request on.
1501  * @recv_wr: A list of work requests to post on the receive queue.
1502  * @bad_recv_wr: On an immediate failure, this parameter will reference
1503  *   the work request that failed to be posted on the QP.
1504  */
1505 static inline int ib_post_srq_recv(struct ib_srq *srq,
1506                                    struct ib_recv_wr *recv_wr,
1507                                    struct ib_recv_wr **bad_recv_wr)
1508 {
1509         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1510 }
1511
1512 /**
1513  * ib_create_qp - Creates a QP associated with the specified protection
1514  *   domain.
1515  * @pd: The protection domain associated with the QP.
1516  * @qp_init_attr: A list of initial attributes required to create the
1517  *   QP.  If QP creation succeeds, then the attributes are updated to
1518  *   the actual capabilities of the created QP.
1519  */
1520 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1521                            struct ib_qp_init_attr *qp_init_attr);
1522
1523 /**
1524  * ib_modify_qp - Modifies the attributes for the specified QP and then
1525  *   transitions the QP to the given state.
1526  * @qp: The QP to modify.
1527  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1528  *   the current values of selected QP attributes are returned.
1529  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1530  *   are being modified.
1531  */
1532 int ib_modify_qp(struct ib_qp *qp,
1533                  struct ib_qp_attr *qp_attr,
1534                  int qp_attr_mask);
1535
1536 /**
1537  * ib_query_qp - Returns the attribute list and current values for the
1538  *   specified QP.
1539  * @qp: The QP to query.
1540  * @qp_attr: The attributes of the specified QP.
1541  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1542  * @qp_init_attr: Additional attributes of the selected QP.
1543  *
1544  * The qp_attr_mask may be used to limit the query to gathering only the
1545  * selected attributes.
1546  */
1547 int ib_query_qp(struct ib_qp *qp,
1548                 struct ib_qp_attr *qp_attr,
1549                 int qp_attr_mask,
1550                 struct ib_qp_init_attr *qp_init_attr);
1551
1552 /**
1553  * ib_destroy_qp - Destroys the specified QP.
1554  * @qp: The QP to destroy.
1555  */
1556 int ib_destroy_qp(struct ib_qp *qp);
1557
1558 /**
1559  * ib_post_send - Posts a list of work requests to the send queue of
1560  *   the specified QP.
1561  * @qp: The QP to post the work request on.
1562  * @send_wr: A list of work requests to post on the send queue.
1563  * @bad_send_wr: On an immediate failure, this parameter will reference
1564  *   the work request that failed to be posted on the QP.
1565  *
1566  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1567  * error is returned, the QP state shall not be affected,
1568  * ib_post_send() will return an immediate error after queueing any
1569  * earlier work requests in the list.
1570  */
1571 static inline int ib_post_send(struct ib_qp *qp,
1572                                struct ib_send_wr *send_wr,
1573                                struct ib_send_wr **bad_send_wr)
1574 {
1575         return qp->device->post_send(qp, send_wr, bad_send_wr);
1576 }
1577
1578 /**
1579  * ib_post_recv - Posts a list of work requests to the receive queue of
1580  *   the specified QP.
1581  * @qp: The QP to post the work request on.
1582  * @recv_wr: A list of work requests to post on the receive queue.
1583  * @bad_recv_wr: On an immediate failure, this parameter will reference
1584  *   the work request that failed to be posted on the QP.
1585  */
1586 static inline int ib_post_recv(struct ib_qp *qp,
1587                                struct ib_recv_wr *recv_wr,
1588                                struct ib_recv_wr **bad_recv_wr)
1589 {
1590         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1591 }
1592
1593 /**
1594  * ib_create_cq - Creates a CQ on the specified device.
1595  * @device: The device on which to create the CQ.
1596  * @comp_handler: A user-specified callback that is invoked when a
1597  *   completion event occurs on the CQ.
1598  * @event_handler: A user-specified callback that is invoked when an
1599  *   asynchronous event not associated with a completion occurs on the CQ.
1600  * @cq_context: Context associated with the CQ returned to the user via
1601  *   the associated completion and event handlers.
1602  * @cqe: The minimum size of the CQ.
1603  * @comp_vector - Completion vector used to signal completion events.
1604  *     Must be >= 0 and < context->num_comp_vectors.
1605  *
1606  * Users can examine the cq structure to determine the actual CQ size.
1607  */
1608 struct ib_cq *ib_create_cq(struct ib_device *device,
1609                            ib_comp_handler comp_handler,
1610                            void (*event_handler)(struct ib_event *, void *),
1611                            void *cq_context, int cqe, int comp_vector);
1612
1613 /**
1614  * ib_resize_cq - Modifies the capacity of the CQ.
1615  * @cq: The CQ to resize.
1616  * @cqe: The minimum size of the CQ.
1617  *
1618  * Users can examine the cq structure to determine the actual CQ size.
1619  */
1620 int ib_resize_cq(struct ib_cq *cq, int cqe);
1621
1622 /**
1623  * ib_modify_cq - Modifies moderation params of the CQ
1624  * @cq: The CQ to modify.
1625  * @cq_count: number of CQEs that will trigger an event
1626  * @cq_period: max period of time in usec before triggering an event
1627  *
1628  */
1629 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1630
1631 /**
1632  * ib_destroy_cq - Destroys the specified CQ.
1633  * @cq: The CQ to destroy.
1634  */
1635 int ib_destroy_cq(struct ib_cq *cq);
1636
1637 /**
1638  * ib_poll_cq - poll a CQ for completion(s)
1639  * @cq:the CQ being polled
1640  * @num_entries:maximum number of completions to return
1641  * @wc:array of at least @num_entries &struct ib_wc where completions
1642  *   will be returned
1643  *
1644  * Poll a CQ for (possibly multiple) completions.  If the return value
1645  * is < 0, an error occurred.  If the return value is >= 0, it is the
1646  * number of completions returned.  If the return value is
1647  * non-negative and < num_entries, then the CQ was emptied.
1648  */
1649 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1650                              struct ib_wc *wc)
1651 {
1652         return cq->device->poll_cq(cq, num_entries, wc);
1653 }
1654
1655 /**
1656  * ib_peek_cq - Returns the number of unreaped completions currently
1657  *   on the specified CQ.
1658  * @cq: The CQ to peek.
1659  * @wc_cnt: A minimum number of unreaped completions to check for.
1660  *
1661  * If the number of unreaped completions is greater than or equal to wc_cnt,
1662  * this function returns wc_cnt, otherwise, it returns the actual number of
1663  * unreaped completions.
1664  */
1665 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1666
1667 /**
1668  * ib_req_notify_cq - Request completion notification on a CQ.
1669  * @cq: The CQ to generate an event for.
1670  * @flags:
1671  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1672  *   to request an event on the next solicited event or next work
1673  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1674  *   may also be |ed in to request a hint about missed events, as
1675  *   described below.
1676  *
1677  * Return Value:
1678  *    < 0 means an error occurred while requesting notification
1679  *   == 0 means notification was requested successfully, and if
1680  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1681  *        were missed and it is safe to wait for another event.  In
1682  *        this case is it guaranteed that any work completions added
1683  *        to the CQ since the last CQ poll will trigger a completion
1684  *        notification event.
1685  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1686  *        in.  It means that the consumer must poll the CQ again to
1687  *        make sure it is empty to avoid missing an event because of a
1688  *        race between requesting notification and an entry being
1689  *        added to the CQ.  This return value means it is possible
1690  *        (but not guaranteed) that a work completion has been added
1691  *        to the CQ since the last poll without triggering a
1692  *        completion notification event.
1693  */
1694 static inline int ib_req_notify_cq(struct ib_cq *cq,
1695                                    enum ib_cq_notify_flags flags)
1696 {
1697         return cq->device->req_notify_cq(cq, flags);
1698 }
1699
1700 /**
1701  * ib_req_ncomp_notif - Request completion notification when there are
1702  *   at least the specified number of unreaped completions on the CQ.
1703  * @cq: The CQ to generate an event for.
1704  * @wc_cnt: The number of unreaped completions that should be on the
1705  *   CQ before an event is generated.
1706  */
1707 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1708 {
1709         return cq->device->req_ncomp_notif ?
1710                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1711                 -ENOSYS;
1712 }
1713
1714 /**
1715  * ib_get_dma_mr - Returns a memory region for system memory that is
1716  *   usable for DMA.
1717  * @pd: The protection domain associated with the memory region.
1718  * @mr_access_flags: Specifies the memory access rights.
1719  *
1720  * Note that the ib_dma_*() functions defined below must be used
1721  * to create/destroy addresses used with the Lkey or Rkey returned
1722  * by ib_get_dma_mr().
1723  */
1724 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1725
1726 /**
1727  * ib_dma_mapping_error - check a DMA addr for error
1728  * @dev: The device for which the dma_addr was created
1729  * @dma_addr: The DMA address to check
1730  */
1731 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1732 {
1733         if (dev->dma_ops)
1734                 return dev->dma_ops->mapping_error(dev, dma_addr);
1735         return dma_mapping_error(dev->dma_device, dma_addr);
1736 }
1737
1738 /**
1739  * ib_dma_map_single - Map a kernel virtual address to DMA address
1740  * @dev: The device for which the dma_addr is to be created
1741  * @cpu_addr: The kernel virtual address
1742  * @size: The size of the region in bytes
1743  * @direction: The direction of the DMA
1744  */
1745 static inline u64 ib_dma_map_single(struct ib_device *dev,
1746                                     void *cpu_addr, size_t size,
1747                                     enum dma_data_direction direction)
1748 {
1749         if (dev->dma_ops)
1750                 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1751         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1752 }
1753
1754 /**
1755  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1756  * @dev: The device for which the DMA address was created
1757  * @addr: The DMA address
1758  * @size: The size of the region in bytes
1759  * @direction: The direction of the DMA
1760  */
1761 static inline void ib_dma_unmap_single(struct ib_device *dev,
1762                                        u64 addr, size_t size,
1763                                        enum dma_data_direction direction)
1764 {
1765         if (dev->dma_ops)
1766                 dev->dma_ops->unmap_single(dev, addr, size, direction);
1767         else
1768                 dma_unmap_single(dev->dma_device, addr, size, direction);
1769 }
1770
1771 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1772                                           void *cpu_addr, size_t size,
1773                                           enum dma_data_direction direction,
1774                                           struct dma_attrs *attrs)
1775 {
1776         return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1777                                     direction, attrs);
1778 }
1779
1780 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1781                                              u64 addr, size_t size,
1782                                              enum dma_data_direction direction,
1783                                              struct dma_attrs *attrs)
1784 {
1785         return dma_unmap_single_attrs(dev->dma_device, addr, size,
1786                                       direction, attrs);
1787 }
1788
1789 /**
1790  * ib_dma_map_page - Map a physical page to DMA address
1791  * @dev: The device for which the dma_addr is to be created
1792  * @page: The page to be mapped
1793  * @offset: The offset within the page
1794  * @size: The size of the region in bytes
1795  * @direction: The direction of the DMA
1796  */
1797 static inline u64 ib_dma_map_page(struct ib_device *dev,
1798                                   struct page *page,
1799                                   unsigned long offset,
1800                                   size_t size,
1801                                          enum dma_data_direction direction)
1802 {
1803         if (dev->dma_ops)
1804                 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1805         return dma_map_page(dev->dma_device, page, offset, size, direction);
1806 }
1807
1808 /**
1809  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1810  * @dev: The device for which the DMA address was created
1811  * @addr: The DMA address
1812  * @size: The size of the region in bytes
1813  * @direction: The direction of the DMA
1814  */
1815 static inline void ib_dma_unmap_page(struct ib_device *dev,
1816                                      u64 addr, size_t size,
1817                                      enum dma_data_direction direction)
1818 {
1819         if (dev->dma_ops)
1820                 dev->dma_ops->unmap_page(dev, addr, size, direction);
1821         else
1822                 dma_unmap_page(dev->dma_device, addr, size, direction);
1823 }
1824
1825 /**
1826  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1827  * @dev: The device for which the DMA addresses are to be created
1828  * @sg: The array of scatter/gather entries
1829  * @nents: The number of scatter/gather entries
1830  * @direction: The direction of the DMA
1831  */
1832 static inline int ib_dma_map_sg(struct ib_device *dev,
1833                                 struct scatterlist *sg, int nents,
1834                                 enum dma_data_direction direction)
1835 {
1836         if (dev->dma_ops)
1837                 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1838         return dma_map_sg(dev->dma_device, sg, nents, direction);
1839 }
1840
1841 /**
1842  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1843  * @dev: The device for which the DMA addresses were created
1844  * @sg: The array of scatter/gather entries
1845  * @nents: The number of scatter/gather entries
1846  * @direction: The direction of the DMA
1847  */
1848 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1849                                    struct scatterlist *sg, int nents,
1850                                    enum dma_data_direction direction)
1851 {
1852         if (dev->dma_ops)
1853                 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1854         else
1855                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1856 }
1857
1858 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1859                                       struct scatterlist *sg, int nents,
1860                                       enum dma_data_direction direction,
1861                                       struct dma_attrs *attrs)
1862 {
1863         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1864 }
1865
1866 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1867                                          struct scatterlist *sg, int nents,
1868                                          enum dma_data_direction direction,
1869                                          struct dma_attrs *attrs)
1870 {
1871         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1872 }
1873 /**
1874  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1875  * @dev: The device for which the DMA addresses were created
1876  * @sg: The scatter/gather entry
1877  */
1878 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1879                                     struct scatterlist *sg)
1880 {
1881         if (dev->dma_ops)
1882                 return dev->dma_ops->dma_address(dev, sg);
1883         return sg_dma_address(sg);
1884 }
1885
1886 /**
1887  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1888  * @dev: The device for which the DMA addresses were created
1889  * @sg: The scatter/gather entry
1890  */
1891 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1892                                          struct scatterlist *sg)
1893 {
1894         if (dev->dma_ops)
1895                 return dev->dma_ops->dma_len(dev, sg);
1896         return sg_dma_len(sg);
1897 }
1898
1899 /**
1900  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1901  * @dev: The device for which the DMA address was created
1902  * @addr: The DMA address
1903  * @size: The size of the region in bytes
1904  * @dir: The direction of the DMA
1905  */
1906 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1907                                               u64 addr,
1908                                               size_t size,
1909                                               enum dma_data_direction dir)
1910 {
1911         if (dev->dma_ops)
1912                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1913         else
1914                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1915 }
1916
1917 /**
1918  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1919  * @dev: The device for which the DMA address was created
1920  * @addr: The DMA address
1921  * @size: The size of the region in bytes
1922  * @dir: The direction of the DMA
1923  */
1924 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1925                                                  u64 addr,
1926                                                  size_t size,
1927                                                  enum dma_data_direction dir)
1928 {
1929         if (dev->dma_ops)
1930                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1931         else
1932                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1933 }
1934
1935 /**
1936  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1937  * @dev: The device for which the DMA address is requested
1938  * @size: The size of the region to allocate in bytes
1939  * @dma_handle: A pointer for returning the DMA address of the region
1940  * @flag: memory allocator flags
1941  */
1942 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1943                                            size_t size,
1944                                            u64 *dma_handle,
1945                                            gfp_t flag)
1946 {
1947         if (dev->dma_ops)
1948                 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1949         else {
1950                 dma_addr_t handle;
1951                 void *ret;
1952
1953                 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1954                 *dma_handle = handle;
1955                 return ret;
1956         }
1957 }
1958
1959 /**
1960  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1961  * @dev: The device for which the DMA addresses were allocated
1962  * @size: The size of the region
1963  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1964  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1965  */
1966 static inline void ib_dma_free_coherent(struct ib_device *dev,
1967                                         size_t size, void *cpu_addr,
1968                                         u64 dma_handle)
1969 {
1970         if (dev->dma_ops)
1971                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1972         else
1973                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1974 }
1975
1976 /**
1977  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1978  *   by an HCA.
1979  * @pd: The protection domain associated assigned to the registered region.
1980  * @phys_buf_array: Specifies a list of physical buffers to use in the
1981  *   memory region.
1982  * @num_phys_buf: Specifies the size of the phys_buf_array.
1983  * @mr_access_flags: Specifies the memory access rights.
1984  * @iova_start: The offset of the region's starting I/O virtual address.
1985  */
1986 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1987                              struct ib_phys_buf *phys_buf_array,
1988                              int num_phys_buf,
1989                              int mr_access_flags,
1990                              u64 *iova_start);
1991
1992 /**
1993  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1994  *   Conceptually, this call performs the functions deregister memory region
1995  *   followed by register physical memory region.  Where possible,
1996  *   resources are reused instead of deallocated and reallocated.
1997  * @mr: The memory region to modify.
1998  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1999  *   properties of the memory region are being modified.
2000  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
2001  *   the new protection domain to associated with the memory region,
2002  *   otherwise, this parameter is ignored.
2003  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2004  *   field specifies a list of physical buffers to use in the new
2005  *   translation, otherwise, this parameter is ignored.
2006  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2007  *   field specifies the size of the phys_buf_array, otherwise, this
2008  *   parameter is ignored.
2009  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
2010  *   field specifies the new memory access rights, otherwise, this
2011  *   parameter is ignored.
2012  * @iova_start: The offset of the region's starting I/O virtual address.
2013  */
2014 int ib_rereg_phys_mr(struct ib_mr *mr,
2015                      int mr_rereg_mask,
2016                      struct ib_pd *pd,
2017                      struct ib_phys_buf *phys_buf_array,
2018                      int num_phys_buf,
2019                      int mr_access_flags,
2020                      u64 *iova_start);
2021
2022 /**
2023  * ib_query_mr - Retrieves information about a specific memory region.
2024  * @mr: The memory region to retrieve information about.
2025  * @mr_attr: The attributes of the specified memory region.
2026  */
2027 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
2028
2029 /**
2030  * ib_dereg_mr - Deregisters a memory region and removes it from the
2031  *   HCA translation table.
2032  * @mr: The memory region to deregister.
2033  */
2034 int ib_dereg_mr(struct ib_mr *mr);
2035
2036 /**
2037  * ib_alloc_fast_reg_mr - Allocates memory region usable with the
2038  *   IB_WR_FAST_REG_MR send work request.
2039  * @pd: The protection domain associated with the region.
2040  * @max_page_list_len: requested max physical buffer list length to be
2041  *   used with fast register work requests for this MR.
2042  */
2043 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
2044
2045 /**
2046  * ib_alloc_fast_reg_page_list - Allocates a page list array
2047  * @device - ib device pointer.
2048  * @page_list_len - size of the page list array to be allocated.
2049  *
2050  * This allocates and returns a struct ib_fast_reg_page_list * and a
2051  * page_list array that is at least page_list_len in size.  The actual
2052  * size is returned in max_page_list_len.  The caller is responsible
2053  * for initializing the contents of the page_list array before posting
2054  * a send work request with the IB_WC_FAST_REG_MR opcode.
2055  *
2056  * The page_list array entries must be translated using one of the
2057  * ib_dma_*() functions just like the addresses passed to
2058  * ib_map_phys_fmr().  Once the ib_post_send() is issued, the struct
2059  * ib_fast_reg_page_list must not be modified by the caller until the
2060  * IB_WC_FAST_REG_MR work request completes.
2061  */
2062 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2063                                 struct ib_device *device, int page_list_len);
2064
2065 /**
2066  * ib_free_fast_reg_page_list - Deallocates a previously allocated
2067  *   page list array.
2068  * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2069  */
2070 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2071
2072 /**
2073  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2074  *   R_Key and L_Key.
2075  * @mr - struct ib_mr pointer to be updated.
2076  * @newkey - new key to be used.
2077  */
2078 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2079 {
2080         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2081         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2082 }
2083
2084 /**
2085  * ib_alloc_mw - Allocates a memory window.
2086  * @pd: The protection domain associated with the memory window.
2087  */
2088 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
2089
2090 /**
2091  * ib_bind_mw - Posts a work request to the send queue of the specified
2092  *   QP, which binds the memory window to the given address range and
2093  *   remote access attributes.
2094  * @qp: QP to post the bind work request on.
2095  * @mw: The memory window to bind.
2096  * @mw_bind: Specifies information about the memory window, including
2097  *   its address range, remote access rights, and associated memory region.
2098  */
2099 static inline int ib_bind_mw(struct ib_qp *qp,
2100                              struct ib_mw *mw,
2101                              struct ib_mw_bind *mw_bind)
2102 {
2103         /* XXX reference counting in corresponding MR? */
2104         return mw->device->bind_mw ?
2105                 mw->device->bind_mw(qp, mw, mw_bind) :
2106                 -ENOSYS;
2107 }
2108
2109 /**
2110  * ib_dealloc_mw - Deallocates a memory window.
2111  * @mw: The memory window to deallocate.
2112  */
2113 int ib_dealloc_mw(struct ib_mw *mw);
2114
2115 /**
2116  * ib_alloc_fmr - Allocates a unmapped fast memory region.
2117  * @pd: The protection domain associated with the unmapped region.
2118  * @mr_access_flags: Specifies the memory access rights.
2119  * @fmr_attr: Attributes of the unmapped region.
2120  *
2121  * A fast memory region must be mapped before it can be used as part of
2122  * a work request.
2123  */
2124 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2125                             int mr_access_flags,
2126                             struct ib_fmr_attr *fmr_attr);
2127
2128 /**
2129  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2130  * @fmr: The fast memory region to associate with the pages.
2131  * @page_list: An array of physical pages to map to the fast memory region.
2132  * @list_len: The number of pages in page_list.
2133  * @iova: The I/O virtual address to use with the mapped region.
2134  */
2135 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2136                                   u64 *page_list, int list_len,
2137                                   u64 iova)
2138 {
2139         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2140 }
2141
2142 /**
2143  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2144  * @fmr_list: A linked list of fast memory regions to unmap.
2145  */
2146 int ib_unmap_fmr(struct list_head *fmr_list);
2147
2148 /**
2149  * ib_dealloc_fmr - Deallocates a fast memory region.
2150  * @fmr: The fast memory region to deallocate.
2151  */
2152 int ib_dealloc_fmr(struct ib_fmr *fmr);
2153
2154 /**
2155  * ib_attach_mcast - Attaches the specified QP to a multicast group.
2156  * @qp: QP to attach to the multicast group.  The QP must be type
2157  *   IB_QPT_UD.
2158  * @gid: Multicast group GID.
2159  * @lid: Multicast group LID in host byte order.
2160  *
2161  * In order to send and receive multicast packets, subnet
2162  * administration must have created the multicast group and configured
2163  * the fabric appropriately.  The port associated with the specified
2164  * QP must also be a member of the multicast group.
2165  */
2166 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2167
2168 /**
2169  * ib_detach_mcast - Detaches the specified QP from a multicast group.
2170  * @qp: QP to detach from the multicast group.
2171  * @gid: Multicast group GID.
2172  * @lid: Multicast group LID in host byte order.
2173  */
2174 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2175
2176
2177 /**
2178  * ib_dealloc_xrcd - Deallocates an extended reliably connected domain.
2179  * @xrcd: The xrc domain to deallocate.
2180  */
2181 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2182
2183 /**
2184  * ib_alloc_xrcd - Allocates an extended reliably connected domain.
2185  * @device: The device on which to allocate the xrcd.
2186  */
2187 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2188
2189 #endif /* IB_VERBS_H */