IB/core: add a simple MR pool
[cascardo/linux.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 #include <linux/socket.h>
52 #include <linux/irq_poll.h>
53 #include <uapi/linux/if_ether.h>
54 #include <net/ipv6.h>
55 #include <net/ip.h>
56 #include <linux/string.h>
57 #include <linux/slab.h>
58
59 #include <linux/if_link.h>
60 #include <linux/atomic.h>
61 #include <linux/mmu_notifier.h>
62 #include <asm/uaccess.h>
63
64 extern struct workqueue_struct *ib_wq;
65 extern struct workqueue_struct *ib_comp_wq;
66
67 union ib_gid {
68         u8      raw[16];
69         struct {
70                 __be64  subnet_prefix;
71                 __be64  interface_id;
72         } global;
73 };
74
75 extern union ib_gid zgid;
76
77 enum ib_gid_type {
78         /* If link layer is Ethernet, this is RoCE V1 */
79         IB_GID_TYPE_IB        = 0,
80         IB_GID_TYPE_ROCE      = 0,
81         IB_GID_TYPE_ROCE_UDP_ENCAP = 1,
82         IB_GID_TYPE_SIZE
83 };
84
85 #define ROCE_V2_UDP_DPORT      4791
86 struct ib_gid_attr {
87         enum ib_gid_type        gid_type;
88         struct net_device       *ndev;
89 };
90
91 enum rdma_node_type {
92         /* IB values map to NodeInfo:NodeType. */
93         RDMA_NODE_IB_CA         = 1,
94         RDMA_NODE_IB_SWITCH,
95         RDMA_NODE_IB_ROUTER,
96         RDMA_NODE_RNIC,
97         RDMA_NODE_USNIC,
98         RDMA_NODE_USNIC_UDP,
99 };
100
101 enum {
102         /* set the local administered indication */
103         IB_SA_WELL_KNOWN_GUID   = BIT_ULL(57) | 2,
104 };
105
106 enum rdma_transport_type {
107         RDMA_TRANSPORT_IB,
108         RDMA_TRANSPORT_IWARP,
109         RDMA_TRANSPORT_USNIC,
110         RDMA_TRANSPORT_USNIC_UDP
111 };
112
113 enum rdma_protocol_type {
114         RDMA_PROTOCOL_IB,
115         RDMA_PROTOCOL_IBOE,
116         RDMA_PROTOCOL_IWARP,
117         RDMA_PROTOCOL_USNIC_UDP
118 };
119
120 __attribute_const__ enum rdma_transport_type
121 rdma_node_get_transport(enum rdma_node_type node_type);
122
123 enum rdma_network_type {
124         RDMA_NETWORK_IB,
125         RDMA_NETWORK_ROCE_V1 = RDMA_NETWORK_IB,
126         RDMA_NETWORK_IPV4,
127         RDMA_NETWORK_IPV6
128 };
129
130 static inline enum ib_gid_type ib_network_to_gid_type(enum rdma_network_type network_type)
131 {
132         if (network_type == RDMA_NETWORK_IPV4 ||
133             network_type == RDMA_NETWORK_IPV6)
134                 return IB_GID_TYPE_ROCE_UDP_ENCAP;
135
136         /* IB_GID_TYPE_IB same as RDMA_NETWORK_ROCE_V1 */
137         return IB_GID_TYPE_IB;
138 }
139
140 static inline enum rdma_network_type ib_gid_to_network_type(enum ib_gid_type gid_type,
141                                                             union ib_gid *gid)
142 {
143         if (gid_type == IB_GID_TYPE_IB)
144                 return RDMA_NETWORK_IB;
145
146         if (ipv6_addr_v4mapped((struct in6_addr *)gid))
147                 return RDMA_NETWORK_IPV4;
148         else
149                 return RDMA_NETWORK_IPV6;
150 }
151
152 enum rdma_link_layer {
153         IB_LINK_LAYER_UNSPECIFIED,
154         IB_LINK_LAYER_INFINIBAND,
155         IB_LINK_LAYER_ETHERNET,
156 };
157
158 enum ib_device_cap_flags {
159         IB_DEVICE_RESIZE_MAX_WR                 = (1 << 0),
160         IB_DEVICE_BAD_PKEY_CNTR                 = (1 << 1),
161         IB_DEVICE_BAD_QKEY_CNTR                 = (1 << 2),
162         IB_DEVICE_RAW_MULTI                     = (1 << 3),
163         IB_DEVICE_AUTO_PATH_MIG                 = (1 << 4),
164         IB_DEVICE_CHANGE_PHY_PORT               = (1 << 5),
165         IB_DEVICE_UD_AV_PORT_ENFORCE            = (1 << 6),
166         IB_DEVICE_CURR_QP_STATE_MOD             = (1 << 7),
167         IB_DEVICE_SHUTDOWN_PORT                 = (1 << 8),
168         IB_DEVICE_INIT_TYPE                     = (1 << 9),
169         IB_DEVICE_PORT_ACTIVE_EVENT             = (1 << 10),
170         IB_DEVICE_SYS_IMAGE_GUID                = (1 << 11),
171         IB_DEVICE_RC_RNR_NAK_GEN                = (1 << 12),
172         IB_DEVICE_SRQ_RESIZE                    = (1 << 13),
173         IB_DEVICE_N_NOTIFY_CQ                   = (1 << 14),
174
175         /*
176          * This device supports a per-device lkey or stag that can be
177          * used without performing a memory registration for the local
178          * memory.  Note that ULPs should never check this flag, but
179          * instead of use the local_dma_lkey flag in the ib_pd structure,
180          * which will always contain a usable lkey.
181          */
182         IB_DEVICE_LOCAL_DMA_LKEY                = (1 << 15),
183         IB_DEVICE_RESERVED /* old SEND_W_INV */ = (1 << 16),
184         IB_DEVICE_MEM_WINDOW                    = (1 << 17),
185         /*
186          * Devices should set IB_DEVICE_UD_IP_SUM if they support
187          * insertion of UDP and TCP checksum on outgoing UD IPoIB
188          * messages and can verify the validity of checksum for
189          * incoming messages.  Setting this flag implies that the
190          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
191          */
192         IB_DEVICE_UD_IP_CSUM                    = (1 << 18),
193         IB_DEVICE_UD_TSO                        = (1 << 19),
194         IB_DEVICE_XRC                           = (1 << 20),
195
196         /*
197          * This device supports the IB "base memory management extension",
198          * which includes support for fast registrations (IB_WR_REG_MR,
199          * IB_WR_LOCAL_INV and IB_WR_SEND_WITH_INV verbs).  This flag should
200          * also be set by any iWarp device which must support FRs to comply
201          * to the iWarp verbs spec.  iWarp devices also support the
202          * IB_WR_RDMA_READ_WITH_INV verb for RDMA READs that invalidate the
203          * stag.
204          */
205         IB_DEVICE_MEM_MGT_EXTENSIONS            = (1 << 21),
206         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK      = (1 << 22),
207         IB_DEVICE_MEM_WINDOW_TYPE_2A            = (1 << 23),
208         IB_DEVICE_MEM_WINDOW_TYPE_2B            = (1 << 24),
209         IB_DEVICE_RC_IP_CSUM                    = (1 << 25),
210         IB_DEVICE_RAW_IP_CSUM                   = (1 << 26),
211         /*
212          * Devices should set IB_DEVICE_CROSS_CHANNEL if they
213          * support execution of WQEs that involve synchronization
214          * of I/O operations with single completion queue managed
215          * by hardware.
216          */
217         IB_DEVICE_CROSS_CHANNEL         = (1 << 27),
218         IB_DEVICE_MANAGED_FLOW_STEERING         = (1 << 29),
219         IB_DEVICE_SIGNATURE_HANDOVER            = (1 << 30),
220         IB_DEVICE_ON_DEMAND_PAGING              = (1 << 31),
221         IB_DEVICE_SG_GAPS_REG                   = (1ULL << 32),
222         IB_DEVICE_VIRTUAL_FUNCTION              = ((u64)1 << 33),
223 };
224
225 enum ib_signature_prot_cap {
226         IB_PROT_T10DIF_TYPE_1 = 1,
227         IB_PROT_T10DIF_TYPE_2 = 1 << 1,
228         IB_PROT_T10DIF_TYPE_3 = 1 << 2,
229 };
230
231 enum ib_signature_guard_cap {
232         IB_GUARD_T10DIF_CRC     = 1,
233         IB_GUARD_T10DIF_CSUM    = 1 << 1,
234 };
235
236 enum ib_atomic_cap {
237         IB_ATOMIC_NONE,
238         IB_ATOMIC_HCA,
239         IB_ATOMIC_GLOB
240 };
241
242 enum ib_odp_general_cap_bits {
243         IB_ODP_SUPPORT = 1 << 0,
244 };
245
246 enum ib_odp_transport_cap_bits {
247         IB_ODP_SUPPORT_SEND     = 1 << 0,
248         IB_ODP_SUPPORT_RECV     = 1 << 1,
249         IB_ODP_SUPPORT_WRITE    = 1 << 2,
250         IB_ODP_SUPPORT_READ     = 1 << 3,
251         IB_ODP_SUPPORT_ATOMIC   = 1 << 4,
252 };
253
254 struct ib_odp_caps {
255         uint64_t general_caps;
256         struct {
257                 uint32_t  rc_odp_caps;
258                 uint32_t  uc_odp_caps;
259                 uint32_t  ud_odp_caps;
260         } per_transport_caps;
261 };
262
263 enum ib_cq_creation_flags {
264         IB_CQ_FLAGS_TIMESTAMP_COMPLETION   = 1 << 0,
265         IB_CQ_FLAGS_IGNORE_OVERRUN         = 1 << 1,
266 };
267
268 struct ib_cq_init_attr {
269         unsigned int    cqe;
270         int             comp_vector;
271         u32             flags;
272 };
273
274 struct ib_device_attr {
275         u64                     fw_ver;
276         __be64                  sys_image_guid;
277         u64                     max_mr_size;
278         u64                     page_size_cap;
279         u32                     vendor_id;
280         u32                     vendor_part_id;
281         u32                     hw_ver;
282         int                     max_qp;
283         int                     max_qp_wr;
284         u64                     device_cap_flags;
285         int                     max_sge;
286         int                     max_sge_rd;
287         int                     max_cq;
288         int                     max_cqe;
289         int                     max_mr;
290         int                     max_pd;
291         int                     max_qp_rd_atom;
292         int                     max_ee_rd_atom;
293         int                     max_res_rd_atom;
294         int                     max_qp_init_rd_atom;
295         int                     max_ee_init_rd_atom;
296         enum ib_atomic_cap      atomic_cap;
297         enum ib_atomic_cap      masked_atomic_cap;
298         int                     max_ee;
299         int                     max_rdd;
300         int                     max_mw;
301         int                     max_raw_ipv6_qp;
302         int                     max_raw_ethy_qp;
303         int                     max_mcast_grp;
304         int                     max_mcast_qp_attach;
305         int                     max_total_mcast_qp_attach;
306         int                     max_ah;
307         int                     max_fmr;
308         int                     max_map_per_fmr;
309         int                     max_srq;
310         int                     max_srq_wr;
311         int                     max_srq_sge;
312         unsigned int            max_fast_reg_page_list_len;
313         u16                     max_pkeys;
314         u8                      local_ca_ack_delay;
315         int                     sig_prot_cap;
316         int                     sig_guard_cap;
317         struct ib_odp_caps      odp_caps;
318         uint64_t                timestamp_mask;
319         uint64_t                hca_core_clock; /* in KHZ */
320 };
321
322 enum ib_mtu {
323         IB_MTU_256  = 1,
324         IB_MTU_512  = 2,
325         IB_MTU_1024 = 3,
326         IB_MTU_2048 = 4,
327         IB_MTU_4096 = 5
328 };
329
330 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
331 {
332         switch (mtu) {
333         case IB_MTU_256:  return  256;
334         case IB_MTU_512:  return  512;
335         case IB_MTU_1024: return 1024;
336         case IB_MTU_2048: return 2048;
337         case IB_MTU_4096: return 4096;
338         default:          return -1;
339         }
340 }
341
342 enum ib_port_state {
343         IB_PORT_NOP             = 0,
344         IB_PORT_DOWN            = 1,
345         IB_PORT_INIT            = 2,
346         IB_PORT_ARMED           = 3,
347         IB_PORT_ACTIVE          = 4,
348         IB_PORT_ACTIVE_DEFER    = 5
349 };
350
351 enum ib_port_cap_flags {
352         IB_PORT_SM                              = 1 <<  1,
353         IB_PORT_NOTICE_SUP                      = 1 <<  2,
354         IB_PORT_TRAP_SUP                        = 1 <<  3,
355         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
356         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
357         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
358         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
359         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
360         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
361         IB_PORT_SM_DISABLED                     = 1 << 10,
362         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
363         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
364         IB_PORT_EXTENDED_SPEEDS_SUP             = 1 << 14,
365         IB_PORT_CM_SUP                          = 1 << 16,
366         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
367         IB_PORT_REINIT_SUP                      = 1 << 18,
368         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
369         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
370         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
371         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
372         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
373         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
374         IB_PORT_CLIENT_REG_SUP                  = 1 << 25,
375         IB_PORT_IP_BASED_GIDS                   = 1 << 26,
376 };
377
378 enum ib_port_width {
379         IB_WIDTH_1X     = 1,
380         IB_WIDTH_4X     = 2,
381         IB_WIDTH_8X     = 4,
382         IB_WIDTH_12X    = 8
383 };
384
385 static inline int ib_width_enum_to_int(enum ib_port_width width)
386 {
387         switch (width) {
388         case IB_WIDTH_1X:  return  1;
389         case IB_WIDTH_4X:  return  4;
390         case IB_WIDTH_8X:  return  8;
391         case IB_WIDTH_12X: return 12;
392         default:          return -1;
393         }
394 }
395
396 enum ib_port_speed {
397         IB_SPEED_SDR    = 1,
398         IB_SPEED_DDR    = 2,
399         IB_SPEED_QDR    = 4,
400         IB_SPEED_FDR10  = 8,
401         IB_SPEED_FDR    = 16,
402         IB_SPEED_EDR    = 32
403 };
404
405 struct ib_protocol_stats {
406         /* TBD... */
407 };
408
409 struct iw_protocol_stats {
410         u64     ipInReceives;
411         u64     ipInHdrErrors;
412         u64     ipInTooBigErrors;
413         u64     ipInNoRoutes;
414         u64     ipInAddrErrors;
415         u64     ipInUnknownProtos;
416         u64     ipInTruncatedPkts;
417         u64     ipInDiscards;
418         u64     ipInDelivers;
419         u64     ipOutForwDatagrams;
420         u64     ipOutRequests;
421         u64     ipOutDiscards;
422         u64     ipOutNoRoutes;
423         u64     ipReasmTimeout;
424         u64     ipReasmReqds;
425         u64     ipReasmOKs;
426         u64     ipReasmFails;
427         u64     ipFragOKs;
428         u64     ipFragFails;
429         u64     ipFragCreates;
430         u64     ipInMcastPkts;
431         u64     ipOutMcastPkts;
432         u64     ipInBcastPkts;
433         u64     ipOutBcastPkts;
434
435         u64     tcpRtoAlgorithm;
436         u64     tcpRtoMin;
437         u64     tcpRtoMax;
438         u64     tcpMaxConn;
439         u64     tcpActiveOpens;
440         u64     tcpPassiveOpens;
441         u64     tcpAttemptFails;
442         u64     tcpEstabResets;
443         u64     tcpCurrEstab;
444         u64     tcpInSegs;
445         u64     tcpOutSegs;
446         u64     tcpRetransSegs;
447         u64     tcpInErrs;
448         u64     tcpOutRsts;
449 };
450
451 union rdma_protocol_stats {
452         struct ib_protocol_stats        ib;
453         struct iw_protocol_stats        iw;
454 };
455
456 /* Define bits for the various functionality this port needs to be supported by
457  * the core.
458  */
459 /* Management                           0x00000FFF */
460 #define RDMA_CORE_CAP_IB_MAD            0x00000001
461 #define RDMA_CORE_CAP_IB_SMI            0x00000002
462 #define RDMA_CORE_CAP_IB_CM             0x00000004
463 #define RDMA_CORE_CAP_IW_CM             0x00000008
464 #define RDMA_CORE_CAP_IB_SA             0x00000010
465 #define RDMA_CORE_CAP_OPA_MAD           0x00000020
466
467 /* Address format                       0x000FF000 */
468 #define RDMA_CORE_CAP_AF_IB             0x00001000
469 #define RDMA_CORE_CAP_ETH_AH            0x00002000
470
471 /* Protocol                             0xFFF00000 */
472 #define RDMA_CORE_CAP_PROT_IB           0x00100000
473 #define RDMA_CORE_CAP_PROT_ROCE         0x00200000
474 #define RDMA_CORE_CAP_PROT_IWARP        0x00400000
475 #define RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP 0x00800000
476
477 #define RDMA_CORE_PORT_IBA_IB          (RDMA_CORE_CAP_PROT_IB  \
478                                         | RDMA_CORE_CAP_IB_MAD \
479                                         | RDMA_CORE_CAP_IB_SMI \
480                                         | RDMA_CORE_CAP_IB_CM  \
481                                         | RDMA_CORE_CAP_IB_SA  \
482                                         | RDMA_CORE_CAP_AF_IB)
483 #define RDMA_CORE_PORT_IBA_ROCE        (RDMA_CORE_CAP_PROT_ROCE \
484                                         | RDMA_CORE_CAP_IB_MAD  \
485                                         | RDMA_CORE_CAP_IB_CM   \
486                                         | RDMA_CORE_CAP_AF_IB   \
487                                         | RDMA_CORE_CAP_ETH_AH)
488 #define RDMA_CORE_PORT_IBA_ROCE_UDP_ENCAP                       \
489                                         (RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP \
490                                         | RDMA_CORE_CAP_IB_MAD  \
491                                         | RDMA_CORE_CAP_IB_CM   \
492                                         | RDMA_CORE_CAP_AF_IB   \
493                                         | RDMA_CORE_CAP_ETH_AH)
494 #define RDMA_CORE_PORT_IWARP           (RDMA_CORE_CAP_PROT_IWARP \
495                                         | RDMA_CORE_CAP_IW_CM)
496 #define RDMA_CORE_PORT_INTEL_OPA       (RDMA_CORE_PORT_IBA_IB  \
497                                         | RDMA_CORE_CAP_OPA_MAD)
498
499 struct ib_port_attr {
500         u64                     subnet_prefix;
501         enum ib_port_state      state;
502         enum ib_mtu             max_mtu;
503         enum ib_mtu             active_mtu;
504         int                     gid_tbl_len;
505         u32                     port_cap_flags;
506         u32                     max_msg_sz;
507         u32                     bad_pkey_cntr;
508         u32                     qkey_viol_cntr;
509         u16                     pkey_tbl_len;
510         u16                     lid;
511         u16                     sm_lid;
512         u8                      lmc;
513         u8                      max_vl_num;
514         u8                      sm_sl;
515         u8                      subnet_timeout;
516         u8                      init_type_reply;
517         u8                      active_width;
518         u8                      active_speed;
519         u8                      phys_state;
520         bool                    grh_required;
521 };
522
523 enum ib_device_modify_flags {
524         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
525         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
526 };
527
528 struct ib_device_modify {
529         u64     sys_image_guid;
530         char    node_desc[64];
531 };
532
533 enum ib_port_modify_flags {
534         IB_PORT_SHUTDOWN                = 1,
535         IB_PORT_INIT_TYPE               = (1<<2),
536         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
537 };
538
539 struct ib_port_modify {
540         u32     set_port_cap_mask;
541         u32     clr_port_cap_mask;
542         u8      init_type;
543 };
544
545 enum ib_event_type {
546         IB_EVENT_CQ_ERR,
547         IB_EVENT_QP_FATAL,
548         IB_EVENT_QP_REQ_ERR,
549         IB_EVENT_QP_ACCESS_ERR,
550         IB_EVENT_COMM_EST,
551         IB_EVENT_SQ_DRAINED,
552         IB_EVENT_PATH_MIG,
553         IB_EVENT_PATH_MIG_ERR,
554         IB_EVENT_DEVICE_FATAL,
555         IB_EVENT_PORT_ACTIVE,
556         IB_EVENT_PORT_ERR,
557         IB_EVENT_LID_CHANGE,
558         IB_EVENT_PKEY_CHANGE,
559         IB_EVENT_SM_CHANGE,
560         IB_EVENT_SRQ_ERR,
561         IB_EVENT_SRQ_LIMIT_REACHED,
562         IB_EVENT_QP_LAST_WQE_REACHED,
563         IB_EVENT_CLIENT_REREGISTER,
564         IB_EVENT_GID_CHANGE,
565 };
566
567 const char *__attribute_const__ ib_event_msg(enum ib_event_type event);
568
569 struct ib_event {
570         struct ib_device        *device;
571         union {
572                 struct ib_cq    *cq;
573                 struct ib_qp    *qp;
574                 struct ib_srq   *srq;
575                 u8              port_num;
576         } element;
577         enum ib_event_type      event;
578 };
579
580 struct ib_event_handler {
581         struct ib_device *device;
582         void            (*handler)(struct ib_event_handler *, struct ib_event *);
583         struct list_head  list;
584 };
585
586 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
587         do {                                                    \
588                 (_ptr)->device  = _device;                      \
589                 (_ptr)->handler = _handler;                     \
590                 INIT_LIST_HEAD(&(_ptr)->list);                  \
591         } while (0)
592
593 struct ib_global_route {
594         union ib_gid    dgid;
595         u32             flow_label;
596         u8              sgid_index;
597         u8              hop_limit;
598         u8              traffic_class;
599 };
600
601 struct ib_grh {
602         __be32          version_tclass_flow;
603         __be16          paylen;
604         u8              next_hdr;
605         u8              hop_limit;
606         union ib_gid    sgid;
607         union ib_gid    dgid;
608 };
609
610 union rdma_network_hdr {
611         struct ib_grh ibgrh;
612         struct {
613                 /* The IB spec states that if it's IPv4, the header
614                  * is located in the last 20 bytes of the header.
615                  */
616                 u8              reserved[20];
617                 struct iphdr    roce4grh;
618         };
619 };
620
621 enum {
622         IB_MULTICAST_QPN = 0xffffff
623 };
624
625 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
626 #define IB_MULTICAST_LID_BASE   cpu_to_be16(0xC000)
627
628 enum ib_ah_flags {
629         IB_AH_GRH       = 1
630 };
631
632 enum ib_rate {
633         IB_RATE_PORT_CURRENT = 0,
634         IB_RATE_2_5_GBPS = 2,
635         IB_RATE_5_GBPS   = 5,
636         IB_RATE_10_GBPS  = 3,
637         IB_RATE_20_GBPS  = 6,
638         IB_RATE_30_GBPS  = 4,
639         IB_RATE_40_GBPS  = 7,
640         IB_RATE_60_GBPS  = 8,
641         IB_RATE_80_GBPS  = 9,
642         IB_RATE_120_GBPS = 10,
643         IB_RATE_14_GBPS  = 11,
644         IB_RATE_56_GBPS  = 12,
645         IB_RATE_112_GBPS = 13,
646         IB_RATE_168_GBPS = 14,
647         IB_RATE_25_GBPS  = 15,
648         IB_RATE_100_GBPS = 16,
649         IB_RATE_200_GBPS = 17,
650         IB_RATE_300_GBPS = 18
651 };
652
653 /**
654  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
655  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
656  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
657  * @rate: rate to convert.
658  */
659 __attribute_const__ int ib_rate_to_mult(enum ib_rate rate);
660
661 /**
662  * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
663  * For example, IB_RATE_2_5_GBPS will be converted to 2500.
664  * @rate: rate to convert.
665  */
666 __attribute_const__ int ib_rate_to_mbps(enum ib_rate rate);
667
668
669 /**
670  * enum ib_mr_type - memory region type
671  * @IB_MR_TYPE_MEM_REG:       memory region that is used for
672  *                            normal registration
673  * @IB_MR_TYPE_SIGNATURE:     memory region that is used for
674  *                            signature operations (data-integrity
675  *                            capable regions)
676  * @IB_MR_TYPE_SG_GAPS:       memory region that is capable to
677  *                            register any arbitrary sg lists (without
678  *                            the normal mr constraints - see
679  *                            ib_map_mr_sg)
680  */
681 enum ib_mr_type {
682         IB_MR_TYPE_MEM_REG,
683         IB_MR_TYPE_SIGNATURE,
684         IB_MR_TYPE_SG_GAPS,
685 };
686
687 /**
688  * Signature types
689  * IB_SIG_TYPE_NONE: Unprotected.
690  * IB_SIG_TYPE_T10_DIF: Type T10-DIF
691  */
692 enum ib_signature_type {
693         IB_SIG_TYPE_NONE,
694         IB_SIG_TYPE_T10_DIF,
695 };
696
697 /**
698  * Signature T10-DIF block-guard types
699  * IB_T10DIF_CRC: Corresponds to T10-PI mandated CRC checksum rules.
700  * IB_T10DIF_CSUM: Corresponds to IP checksum rules.
701  */
702 enum ib_t10_dif_bg_type {
703         IB_T10DIF_CRC,
704         IB_T10DIF_CSUM
705 };
706
707 /**
708  * struct ib_t10_dif_domain - Parameters specific for T10-DIF
709  *     domain.
710  * @bg_type: T10-DIF block guard type (CRC|CSUM)
711  * @pi_interval: protection information interval.
712  * @bg: seed of guard computation.
713  * @app_tag: application tag of guard block
714  * @ref_tag: initial guard block reference tag.
715  * @ref_remap: Indicate wethear the reftag increments each block
716  * @app_escape: Indicate to skip block check if apptag=0xffff
717  * @ref_escape: Indicate to skip block check if reftag=0xffffffff
718  * @apptag_check_mask: check bitmask of application tag.
719  */
720 struct ib_t10_dif_domain {
721         enum ib_t10_dif_bg_type bg_type;
722         u16                     pi_interval;
723         u16                     bg;
724         u16                     app_tag;
725         u32                     ref_tag;
726         bool                    ref_remap;
727         bool                    app_escape;
728         bool                    ref_escape;
729         u16                     apptag_check_mask;
730 };
731
732 /**
733  * struct ib_sig_domain - Parameters for signature domain
734  * @sig_type: specific signauture type
735  * @sig: union of all signature domain attributes that may
736  *     be used to set domain layout.
737  */
738 struct ib_sig_domain {
739         enum ib_signature_type sig_type;
740         union {
741                 struct ib_t10_dif_domain dif;
742         } sig;
743 };
744
745 /**
746  * struct ib_sig_attrs - Parameters for signature handover operation
747  * @check_mask: bitmask for signature byte check (8 bytes)
748  * @mem: memory domain layout desciptor.
749  * @wire: wire domain layout desciptor.
750  */
751 struct ib_sig_attrs {
752         u8                      check_mask;
753         struct ib_sig_domain    mem;
754         struct ib_sig_domain    wire;
755 };
756
757 enum ib_sig_err_type {
758         IB_SIG_BAD_GUARD,
759         IB_SIG_BAD_REFTAG,
760         IB_SIG_BAD_APPTAG,
761 };
762
763 /**
764  * struct ib_sig_err - signature error descriptor
765  */
766 struct ib_sig_err {
767         enum ib_sig_err_type    err_type;
768         u32                     expected;
769         u32                     actual;
770         u64                     sig_err_offset;
771         u32                     key;
772 };
773
774 enum ib_mr_status_check {
775         IB_MR_CHECK_SIG_STATUS = 1,
776 };
777
778 /**
779  * struct ib_mr_status - Memory region status container
780  *
781  * @fail_status: Bitmask of MR checks status. For each
782  *     failed check a corresponding status bit is set.
783  * @sig_err: Additional info for IB_MR_CEHCK_SIG_STATUS
784  *     failure.
785  */
786 struct ib_mr_status {
787         u32                 fail_status;
788         struct ib_sig_err   sig_err;
789 };
790
791 /**
792  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
793  * enum.
794  * @mult: multiple to convert.
795  */
796 __attribute_const__ enum ib_rate mult_to_ib_rate(int mult);
797
798 struct ib_ah_attr {
799         struct ib_global_route  grh;
800         u16                     dlid;
801         u8                      sl;
802         u8                      src_path_bits;
803         u8                      static_rate;
804         u8                      ah_flags;
805         u8                      port_num;
806         u8                      dmac[ETH_ALEN];
807 };
808
809 enum ib_wc_status {
810         IB_WC_SUCCESS,
811         IB_WC_LOC_LEN_ERR,
812         IB_WC_LOC_QP_OP_ERR,
813         IB_WC_LOC_EEC_OP_ERR,
814         IB_WC_LOC_PROT_ERR,
815         IB_WC_WR_FLUSH_ERR,
816         IB_WC_MW_BIND_ERR,
817         IB_WC_BAD_RESP_ERR,
818         IB_WC_LOC_ACCESS_ERR,
819         IB_WC_REM_INV_REQ_ERR,
820         IB_WC_REM_ACCESS_ERR,
821         IB_WC_REM_OP_ERR,
822         IB_WC_RETRY_EXC_ERR,
823         IB_WC_RNR_RETRY_EXC_ERR,
824         IB_WC_LOC_RDD_VIOL_ERR,
825         IB_WC_REM_INV_RD_REQ_ERR,
826         IB_WC_REM_ABORT_ERR,
827         IB_WC_INV_EECN_ERR,
828         IB_WC_INV_EEC_STATE_ERR,
829         IB_WC_FATAL_ERR,
830         IB_WC_RESP_TIMEOUT_ERR,
831         IB_WC_GENERAL_ERR
832 };
833
834 const char *__attribute_const__ ib_wc_status_msg(enum ib_wc_status status);
835
836 enum ib_wc_opcode {
837         IB_WC_SEND,
838         IB_WC_RDMA_WRITE,
839         IB_WC_RDMA_READ,
840         IB_WC_COMP_SWAP,
841         IB_WC_FETCH_ADD,
842         IB_WC_LSO,
843         IB_WC_LOCAL_INV,
844         IB_WC_REG_MR,
845         IB_WC_MASKED_COMP_SWAP,
846         IB_WC_MASKED_FETCH_ADD,
847 /*
848  * Set value of IB_WC_RECV so consumers can test if a completion is a
849  * receive by testing (opcode & IB_WC_RECV).
850  */
851         IB_WC_RECV                      = 1 << 7,
852         IB_WC_RECV_RDMA_WITH_IMM
853 };
854
855 enum ib_wc_flags {
856         IB_WC_GRH               = 1,
857         IB_WC_WITH_IMM          = (1<<1),
858         IB_WC_WITH_INVALIDATE   = (1<<2),
859         IB_WC_IP_CSUM_OK        = (1<<3),
860         IB_WC_WITH_SMAC         = (1<<4),
861         IB_WC_WITH_VLAN         = (1<<5),
862         IB_WC_WITH_NETWORK_HDR_TYPE     = (1<<6),
863 };
864
865 struct ib_wc {
866         union {
867                 u64             wr_id;
868                 struct ib_cqe   *wr_cqe;
869         };
870         enum ib_wc_status       status;
871         enum ib_wc_opcode       opcode;
872         u32                     vendor_err;
873         u32                     byte_len;
874         struct ib_qp           *qp;
875         union {
876                 __be32          imm_data;
877                 u32             invalidate_rkey;
878         } ex;
879         u32                     src_qp;
880         int                     wc_flags;
881         u16                     pkey_index;
882         u16                     slid;
883         u8                      sl;
884         u8                      dlid_path_bits;
885         u8                      port_num;       /* valid only for DR SMPs on switches */
886         u8                      smac[ETH_ALEN];
887         u16                     vlan_id;
888         u8                      network_hdr_type;
889 };
890
891 enum ib_cq_notify_flags {
892         IB_CQ_SOLICITED                 = 1 << 0,
893         IB_CQ_NEXT_COMP                 = 1 << 1,
894         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
895         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
896 };
897
898 enum ib_srq_type {
899         IB_SRQT_BASIC,
900         IB_SRQT_XRC
901 };
902
903 enum ib_srq_attr_mask {
904         IB_SRQ_MAX_WR   = 1 << 0,
905         IB_SRQ_LIMIT    = 1 << 1,
906 };
907
908 struct ib_srq_attr {
909         u32     max_wr;
910         u32     max_sge;
911         u32     srq_limit;
912 };
913
914 struct ib_srq_init_attr {
915         void                  (*event_handler)(struct ib_event *, void *);
916         void                   *srq_context;
917         struct ib_srq_attr      attr;
918         enum ib_srq_type        srq_type;
919
920         union {
921                 struct {
922                         struct ib_xrcd *xrcd;
923                         struct ib_cq   *cq;
924                 } xrc;
925         } ext;
926 };
927
928 struct ib_qp_cap {
929         u32     max_send_wr;
930         u32     max_recv_wr;
931         u32     max_send_sge;
932         u32     max_recv_sge;
933         u32     max_inline_data;
934 };
935
936 enum ib_sig_type {
937         IB_SIGNAL_ALL_WR,
938         IB_SIGNAL_REQ_WR
939 };
940
941 enum ib_qp_type {
942         /*
943          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
944          * here (and in that order) since the MAD layer uses them as
945          * indices into a 2-entry table.
946          */
947         IB_QPT_SMI,
948         IB_QPT_GSI,
949
950         IB_QPT_RC,
951         IB_QPT_UC,
952         IB_QPT_UD,
953         IB_QPT_RAW_IPV6,
954         IB_QPT_RAW_ETHERTYPE,
955         IB_QPT_RAW_PACKET = 8,
956         IB_QPT_XRC_INI = 9,
957         IB_QPT_XRC_TGT,
958         IB_QPT_MAX,
959         /* Reserve a range for qp types internal to the low level driver.
960          * These qp types will not be visible at the IB core layer, so the
961          * IB_QPT_MAX usages should not be affected in the core layer
962          */
963         IB_QPT_RESERVED1 = 0x1000,
964         IB_QPT_RESERVED2,
965         IB_QPT_RESERVED3,
966         IB_QPT_RESERVED4,
967         IB_QPT_RESERVED5,
968         IB_QPT_RESERVED6,
969         IB_QPT_RESERVED7,
970         IB_QPT_RESERVED8,
971         IB_QPT_RESERVED9,
972         IB_QPT_RESERVED10,
973 };
974
975 enum ib_qp_create_flags {
976         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
977         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
978         IB_QP_CREATE_CROSS_CHANNEL              = 1 << 2,
979         IB_QP_CREATE_MANAGED_SEND               = 1 << 3,
980         IB_QP_CREATE_MANAGED_RECV               = 1 << 4,
981         IB_QP_CREATE_NETIF_QP                   = 1 << 5,
982         IB_QP_CREATE_SIGNATURE_EN               = 1 << 6,
983         IB_QP_CREATE_USE_GFP_NOIO               = 1 << 7,
984         /* reserve bits 26-31 for low level drivers' internal use */
985         IB_QP_CREATE_RESERVED_START             = 1 << 26,
986         IB_QP_CREATE_RESERVED_END               = 1 << 31,
987 };
988
989 /*
990  * Note: users may not call ib_close_qp or ib_destroy_qp from the event_handler
991  * callback to destroy the passed in QP.
992  */
993
994 struct ib_qp_init_attr {
995         void                  (*event_handler)(struct ib_event *, void *);
996         void                   *qp_context;
997         struct ib_cq           *send_cq;
998         struct ib_cq           *recv_cq;
999         struct ib_srq          *srq;
1000         struct ib_xrcd         *xrcd;     /* XRC TGT QPs only */
1001         struct ib_qp_cap        cap;
1002         enum ib_sig_type        sq_sig_type;
1003         enum ib_qp_type         qp_type;
1004         enum ib_qp_create_flags create_flags;
1005         u8                      port_num; /* special QP types only */
1006 };
1007
1008 struct ib_qp_open_attr {
1009         void                  (*event_handler)(struct ib_event *, void *);
1010         void                   *qp_context;
1011         u32                     qp_num;
1012         enum ib_qp_type         qp_type;
1013 };
1014
1015 enum ib_rnr_timeout {
1016         IB_RNR_TIMER_655_36 =  0,
1017         IB_RNR_TIMER_000_01 =  1,
1018         IB_RNR_TIMER_000_02 =  2,
1019         IB_RNR_TIMER_000_03 =  3,
1020         IB_RNR_TIMER_000_04 =  4,
1021         IB_RNR_TIMER_000_06 =  5,
1022         IB_RNR_TIMER_000_08 =  6,
1023         IB_RNR_TIMER_000_12 =  7,
1024         IB_RNR_TIMER_000_16 =  8,
1025         IB_RNR_TIMER_000_24 =  9,
1026         IB_RNR_TIMER_000_32 = 10,
1027         IB_RNR_TIMER_000_48 = 11,
1028         IB_RNR_TIMER_000_64 = 12,
1029         IB_RNR_TIMER_000_96 = 13,
1030         IB_RNR_TIMER_001_28 = 14,
1031         IB_RNR_TIMER_001_92 = 15,
1032         IB_RNR_TIMER_002_56 = 16,
1033         IB_RNR_TIMER_003_84 = 17,
1034         IB_RNR_TIMER_005_12 = 18,
1035         IB_RNR_TIMER_007_68 = 19,
1036         IB_RNR_TIMER_010_24 = 20,
1037         IB_RNR_TIMER_015_36 = 21,
1038         IB_RNR_TIMER_020_48 = 22,
1039         IB_RNR_TIMER_030_72 = 23,
1040         IB_RNR_TIMER_040_96 = 24,
1041         IB_RNR_TIMER_061_44 = 25,
1042         IB_RNR_TIMER_081_92 = 26,
1043         IB_RNR_TIMER_122_88 = 27,
1044         IB_RNR_TIMER_163_84 = 28,
1045         IB_RNR_TIMER_245_76 = 29,
1046         IB_RNR_TIMER_327_68 = 30,
1047         IB_RNR_TIMER_491_52 = 31
1048 };
1049
1050 enum ib_qp_attr_mask {
1051         IB_QP_STATE                     = 1,
1052         IB_QP_CUR_STATE                 = (1<<1),
1053         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
1054         IB_QP_ACCESS_FLAGS              = (1<<3),
1055         IB_QP_PKEY_INDEX                = (1<<4),
1056         IB_QP_PORT                      = (1<<5),
1057         IB_QP_QKEY                      = (1<<6),
1058         IB_QP_AV                        = (1<<7),
1059         IB_QP_PATH_MTU                  = (1<<8),
1060         IB_QP_TIMEOUT                   = (1<<9),
1061         IB_QP_RETRY_CNT                 = (1<<10),
1062         IB_QP_RNR_RETRY                 = (1<<11),
1063         IB_QP_RQ_PSN                    = (1<<12),
1064         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
1065         IB_QP_ALT_PATH                  = (1<<14),
1066         IB_QP_MIN_RNR_TIMER             = (1<<15),
1067         IB_QP_SQ_PSN                    = (1<<16),
1068         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
1069         IB_QP_PATH_MIG_STATE            = (1<<18),
1070         IB_QP_CAP                       = (1<<19),
1071         IB_QP_DEST_QPN                  = (1<<20),
1072         IB_QP_RESERVED1                 = (1<<21),
1073         IB_QP_RESERVED2                 = (1<<22),
1074         IB_QP_RESERVED3                 = (1<<23),
1075         IB_QP_RESERVED4                 = (1<<24),
1076 };
1077
1078 enum ib_qp_state {
1079         IB_QPS_RESET,
1080         IB_QPS_INIT,
1081         IB_QPS_RTR,
1082         IB_QPS_RTS,
1083         IB_QPS_SQD,
1084         IB_QPS_SQE,
1085         IB_QPS_ERR
1086 };
1087
1088 enum ib_mig_state {
1089         IB_MIG_MIGRATED,
1090         IB_MIG_REARM,
1091         IB_MIG_ARMED
1092 };
1093
1094 enum ib_mw_type {
1095         IB_MW_TYPE_1 = 1,
1096         IB_MW_TYPE_2 = 2
1097 };
1098
1099 struct ib_qp_attr {
1100         enum ib_qp_state        qp_state;
1101         enum ib_qp_state        cur_qp_state;
1102         enum ib_mtu             path_mtu;
1103         enum ib_mig_state       path_mig_state;
1104         u32                     qkey;
1105         u32                     rq_psn;
1106         u32                     sq_psn;
1107         u32                     dest_qp_num;
1108         int                     qp_access_flags;
1109         struct ib_qp_cap        cap;
1110         struct ib_ah_attr       ah_attr;
1111         struct ib_ah_attr       alt_ah_attr;
1112         u16                     pkey_index;
1113         u16                     alt_pkey_index;
1114         u8                      en_sqd_async_notify;
1115         u8                      sq_draining;
1116         u8                      max_rd_atomic;
1117         u8                      max_dest_rd_atomic;
1118         u8                      min_rnr_timer;
1119         u8                      port_num;
1120         u8                      timeout;
1121         u8                      retry_cnt;
1122         u8                      rnr_retry;
1123         u8                      alt_port_num;
1124         u8                      alt_timeout;
1125 };
1126
1127 enum ib_wr_opcode {
1128         IB_WR_RDMA_WRITE,
1129         IB_WR_RDMA_WRITE_WITH_IMM,
1130         IB_WR_SEND,
1131         IB_WR_SEND_WITH_IMM,
1132         IB_WR_RDMA_READ,
1133         IB_WR_ATOMIC_CMP_AND_SWP,
1134         IB_WR_ATOMIC_FETCH_AND_ADD,
1135         IB_WR_LSO,
1136         IB_WR_SEND_WITH_INV,
1137         IB_WR_RDMA_READ_WITH_INV,
1138         IB_WR_LOCAL_INV,
1139         IB_WR_REG_MR,
1140         IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
1141         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
1142         IB_WR_REG_SIG_MR,
1143         /* reserve values for low level drivers' internal use.
1144          * These values will not be used at all in the ib core layer.
1145          */
1146         IB_WR_RESERVED1 = 0xf0,
1147         IB_WR_RESERVED2,
1148         IB_WR_RESERVED3,
1149         IB_WR_RESERVED4,
1150         IB_WR_RESERVED5,
1151         IB_WR_RESERVED6,
1152         IB_WR_RESERVED7,
1153         IB_WR_RESERVED8,
1154         IB_WR_RESERVED9,
1155         IB_WR_RESERVED10,
1156 };
1157
1158 enum ib_send_flags {
1159         IB_SEND_FENCE           = 1,
1160         IB_SEND_SIGNALED        = (1<<1),
1161         IB_SEND_SOLICITED       = (1<<2),
1162         IB_SEND_INLINE          = (1<<3),
1163         IB_SEND_IP_CSUM         = (1<<4),
1164
1165         /* reserve bits 26-31 for low level drivers' internal use */
1166         IB_SEND_RESERVED_START  = (1 << 26),
1167         IB_SEND_RESERVED_END    = (1 << 31),
1168 };
1169
1170 struct ib_sge {
1171         u64     addr;
1172         u32     length;
1173         u32     lkey;
1174 };
1175
1176 struct ib_cqe {
1177         void (*done)(struct ib_cq *cq, struct ib_wc *wc);
1178 };
1179
1180 struct ib_send_wr {
1181         struct ib_send_wr      *next;
1182         union {
1183                 u64             wr_id;
1184                 struct ib_cqe   *wr_cqe;
1185         };
1186         struct ib_sge          *sg_list;
1187         int                     num_sge;
1188         enum ib_wr_opcode       opcode;
1189         int                     send_flags;
1190         union {
1191                 __be32          imm_data;
1192                 u32             invalidate_rkey;
1193         } ex;
1194 };
1195
1196 struct ib_rdma_wr {
1197         struct ib_send_wr       wr;
1198         u64                     remote_addr;
1199         u32                     rkey;
1200 };
1201
1202 static inline struct ib_rdma_wr *rdma_wr(struct ib_send_wr *wr)
1203 {
1204         return container_of(wr, struct ib_rdma_wr, wr);
1205 }
1206
1207 struct ib_atomic_wr {
1208         struct ib_send_wr       wr;
1209         u64                     remote_addr;
1210         u64                     compare_add;
1211         u64                     swap;
1212         u64                     compare_add_mask;
1213         u64                     swap_mask;
1214         u32                     rkey;
1215 };
1216
1217 static inline struct ib_atomic_wr *atomic_wr(struct ib_send_wr *wr)
1218 {
1219         return container_of(wr, struct ib_atomic_wr, wr);
1220 }
1221
1222 struct ib_ud_wr {
1223         struct ib_send_wr       wr;
1224         struct ib_ah            *ah;
1225         void                    *header;
1226         int                     hlen;
1227         int                     mss;
1228         u32                     remote_qpn;
1229         u32                     remote_qkey;
1230         u16                     pkey_index; /* valid for GSI only */
1231         u8                      port_num;   /* valid for DR SMPs on switch only */
1232 };
1233
1234 static inline struct ib_ud_wr *ud_wr(struct ib_send_wr *wr)
1235 {
1236         return container_of(wr, struct ib_ud_wr, wr);
1237 }
1238
1239 struct ib_reg_wr {
1240         struct ib_send_wr       wr;
1241         struct ib_mr            *mr;
1242         u32                     key;
1243         int                     access;
1244 };
1245
1246 static inline struct ib_reg_wr *reg_wr(struct ib_send_wr *wr)
1247 {
1248         return container_of(wr, struct ib_reg_wr, wr);
1249 }
1250
1251 struct ib_sig_handover_wr {
1252         struct ib_send_wr       wr;
1253         struct ib_sig_attrs    *sig_attrs;
1254         struct ib_mr           *sig_mr;
1255         int                     access_flags;
1256         struct ib_sge          *prot;
1257 };
1258
1259 static inline struct ib_sig_handover_wr *sig_handover_wr(struct ib_send_wr *wr)
1260 {
1261         return container_of(wr, struct ib_sig_handover_wr, wr);
1262 }
1263
1264 struct ib_recv_wr {
1265         struct ib_recv_wr      *next;
1266         union {
1267                 u64             wr_id;
1268                 struct ib_cqe   *wr_cqe;
1269         };
1270         struct ib_sge          *sg_list;
1271         int                     num_sge;
1272 };
1273
1274 enum ib_access_flags {
1275         IB_ACCESS_LOCAL_WRITE   = 1,
1276         IB_ACCESS_REMOTE_WRITE  = (1<<1),
1277         IB_ACCESS_REMOTE_READ   = (1<<2),
1278         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
1279         IB_ACCESS_MW_BIND       = (1<<4),
1280         IB_ZERO_BASED           = (1<<5),
1281         IB_ACCESS_ON_DEMAND     = (1<<6),
1282 };
1283
1284 /*
1285  * XXX: these are apparently used for ->rereg_user_mr, no idea why they
1286  * are hidden here instead of a uapi header!
1287  */
1288 enum ib_mr_rereg_flags {
1289         IB_MR_REREG_TRANS       = 1,
1290         IB_MR_REREG_PD          = (1<<1),
1291         IB_MR_REREG_ACCESS      = (1<<2),
1292         IB_MR_REREG_SUPPORTED   = ((IB_MR_REREG_ACCESS << 1) - 1)
1293 };
1294
1295 struct ib_fmr_attr {
1296         int     max_pages;
1297         int     max_maps;
1298         u8      page_shift;
1299 };
1300
1301 struct ib_umem;
1302
1303 struct ib_ucontext {
1304         struct ib_device       *device;
1305         struct list_head        pd_list;
1306         struct list_head        mr_list;
1307         struct list_head        mw_list;
1308         struct list_head        cq_list;
1309         struct list_head        qp_list;
1310         struct list_head        srq_list;
1311         struct list_head        ah_list;
1312         struct list_head        xrcd_list;
1313         struct list_head        rule_list;
1314         int                     closing;
1315
1316         struct pid             *tgid;
1317 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
1318         struct rb_root      umem_tree;
1319         /*
1320          * Protects .umem_rbroot and tree, as well as odp_mrs_count and
1321          * mmu notifiers registration.
1322          */
1323         struct rw_semaphore     umem_rwsem;
1324         void (*invalidate_range)(struct ib_umem *umem,
1325                                  unsigned long start, unsigned long end);
1326
1327         struct mmu_notifier     mn;
1328         atomic_t                notifier_count;
1329         /* A list of umems that don't have private mmu notifier counters yet. */
1330         struct list_head        no_private_counters;
1331         int                     odp_mrs_count;
1332 #endif
1333 };
1334
1335 struct ib_uobject {
1336         u64                     user_handle;    /* handle given to us by userspace */
1337         struct ib_ucontext     *context;        /* associated user context */
1338         void                   *object;         /* containing object */
1339         struct list_head        list;           /* link to context's list */
1340         int                     id;             /* index into kernel idr */
1341         struct kref             ref;
1342         struct rw_semaphore     mutex;          /* protects .live */
1343         struct rcu_head         rcu;            /* kfree_rcu() overhead */
1344         int                     live;
1345 };
1346
1347 struct ib_udata {
1348         const void __user *inbuf;
1349         void __user *outbuf;
1350         size_t       inlen;
1351         size_t       outlen;
1352 };
1353
1354 struct ib_pd {
1355         u32                     local_dma_lkey;
1356         struct ib_device       *device;
1357         struct ib_uobject      *uobject;
1358         atomic_t                usecnt; /* count all resources */
1359         struct ib_mr           *local_mr;
1360 };
1361
1362 struct ib_xrcd {
1363         struct ib_device       *device;
1364         atomic_t                usecnt; /* count all exposed resources */
1365         struct inode           *inode;
1366
1367         struct mutex            tgt_qp_mutex;
1368         struct list_head        tgt_qp_list;
1369 };
1370
1371 struct ib_ah {
1372         struct ib_device        *device;
1373         struct ib_pd            *pd;
1374         struct ib_uobject       *uobject;
1375 };
1376
1377 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
1378
1379 enum ib_poll_context {
1380         IB_POLL_DIRECT,         /* caller context, no hw completions */
1381         IB_POLL_SOFTIRQ,        /* poll from softirq context */
1382         IB_POLL_WORKQUEUE,      /* poll from workqueue */
1383 };
1384
1385 struct ib_cq {
1386         struct ib_device       *device;
1387         struct ib_uobject      *uobject;
1388         ib_comp_handler         comp_handler;
1389         void                  (*event_handler)(struct ib_event *, void *);
1390         void                   *cq_context;
1391         int                     cqe;
1392         atomic_t                usecnt; /* count number of work queues */
1393         enum ib_poll_context    poll_ctx;
1394         struct ib_wc            *wc;
1395         union {
1396                 struct irq_poll         iop;
1397                 struct work_struct      work;
1398         };
1399 };
1400
1401 struct ib_srq {
1402         struct ib_device       *device;
1403         struct ib_pd           *pd;
1404         struct ib_uobject      *uobject;
1405         void                  (*event_handler)(struct ib_event *, void *);
1406         void                   *srq_context;
1407         enum ib_srq_type        srq_type;
1408         atomic_t                usecnt;
1409
1410         union {
1411                 struct {
1412                         struct ib_xrcd *xrcd;
1413                         struct ib_cq   *cq;
1414                         u32             srq_num;
1415                 } xrc;
1416         } ext;
1417 };
1418
1419 struct ib_qp {
1420         struct ib_device       *device;
1421         struct ib_pd           *pd;
1422         struct ib_cq           *send_cq;
1423         struct ib_cq           *recv_cq;
1424         spinlock_t              mr_lock;
1425         int                     mrs_used;
1426         struct ib_srq          *srq;
1427         struct ib_xrcd         *xrcd; /* XRC TGT QPs only */
1428         struct list_head        xrcd_list;
1429
1430         /* count times opened, mcast attaches, flow attaches */
1431         atomic_t                usecnt;
1432         struct list_head        open_list;
1433         struct ib_qp           *real_qp;
1434         struct ib_uobject      *uobject;
1435         void                  (*event_handler)(struct ib_event *, void *);
1436         void                   *qp_context;
1437         u32                     qp_num;
1438         enum ib_qp_type         qp_type;
1439 };
1440
1441 struct ib_mr {
1442         struct ib_device  *device;
1443         struct ib_pd      *pd;
1444         u32                lkey;
1445         u32                rkey;
1446         u64                iova;
1447         u32                length;
1448         unsigned int       page_size;
1449         union {
1450                 struct ib_uobject       *uobject;       /* user */
1451                 struct list_head        qp_entry;       /* FR */
1452         };
1453 };
1454
1455 struct ib_mw {
1456         struct ib_device        *device;
1457         struct ib_pd            *pd;
1458         struct ib_uobject       *uobject;
1459         u32                     rkey;
1460         enum ib_mw_type         type;
1461 };
1462
1463 struct ib_fmr {
1464         struct ib_device        *device;
1465         struct ib_pd            *pd;
1466         struct list_head        list;
1467         u32                     lkey;
1468         u32                     rkey;
1469 };
1470
1471 /* Supported steering options */
1472 enum ib_flow_attr_type {
1473         /* steering according to rule specifications */
1474         IB_FLOW_ATTR_NORMAL             = 0x0,
1475         /* default unicast and multicast rule -
1476          * receive all Eth traffic which isn't steered to any QP
1477          */
1478         IB_FLOW_ATTR_ALL_DEFAULT        = 0x1,
1479         /* default multicast rule -
1480          * receive all Eth multicast traffic which isn't steered to any QP
1481          */
1482         IB_FLOW_ATTR_MC_DEFAULT         = 0x2,
1483         /* sniffer rule - receive all port traffic */
1484         IB_FLOW_ATTR_SNIFFER            = 0x3
1485 };
1486
1487 /* Supported steering header types */
1488 enum ib_flow_spec_type {
1489         /* L2 headers*/
1490         IB_FLOW_SPEC_ETH        = 0x20,
1491         IB_FLOW_SPEC_IB         = 0x22,
1492         /* L3 header*/
1493         IB_FLOW_SPEC_IPV4       = 0x30,
1494         /* L4 headers*/
1495         IB_FLOW_SPEC_TCP        = 0x40,
1496         IB_FLOW_SPEC_UDP        = 0x41
1497 };
1498 #define IB_FLOW_SPEC_LAYER_MASK 0xF0
1499 #define IB_FLOW_SPEC_SUPPORT_LAYERS 4
1500
1501 /* Flow steering rule priority is set according to it's domain.
1502  * Lower domain value means higher priority.
1503  */
1504 enum ib_flow_domain {
1505         IB_FLOW_DOMAIN_USER,
1506         IB_FLOW_DOMAIN_ETHTOOL,
1507         IB_FLOW_DOMAIN_RFS,
1508         IB_FLOW_DOMAIN_NIC,
1509         IB_FLOW_DOMAIN_NUM /* Must be last */
1510 };
1511
1512 enum ib_flow_flags {
1513         IB_FLOW_ATTR_FLAGS_DONT_TRAP = 1UL << 1, /* Continue match, no steal */
1514         IB_FLOW_ATTR_FLAGS_RESERVED  = 1UL << 2  /* Must be last */
1515 };
1516
1517 struct ib_flow_eth_filter {
1518         u8      dst_mac[6];
1519         u8      src_mac[6];
1520         __be16  ether_type;
1521         __be16  vlan_tag;
1522 };
1523
1524 struct ib_flow_spec_eth {
1525         enum ib_flow_spec_type    type;
1526         u16                       size;
1527         struct ib_flow_eth_filter val;
1528         struct ib_flow_eth_filter mask;
1529 };
1530
1531 struct ib_flow_ib_filter {
1532         __be16 dlid;
1533         __u8   sl;
1534 };
1535
1536 struct ib_flow_spec_ib {
1537         enum ib_flow_spec_type   type;
1538         u16                      size;
1539         struct ib_flow_ib_filter val;
1540         struct ib_flow_ib_filter mask;
1541 };
1542
1543 struct ib_flow_ipv4_filter {
1544         __be32  src_ip;
1545         __be32  dst_ip;
1546 };
1547
1548 struct ib_flow_spec_ipv4 {
1549         enum ib_flow_spec_type     type;
1550         u16                        size;
1551         struct ib_flow_ipv4_filter val;
1552         struct ib_flow_ipv4_filter mask;
1553 };
1554
1555 struct ib_flow_tcp_udp_filter {
1556         __be16  dst_port;
1557         __be16  src_port;
1558 };
1559
1560 struct ib_flow_spec_tcp_udp {
1561         enum ib_flow_spec_type        type;
1562         u16                           size;
1563         struct ib_flow_tcp_udp_filter val;
1564         struct ib_flow_tcp_udp_filter mask;
1565 };
1566
1567 union ib_flow_spec {
1568         struct {
1569                 enum ib_flow_spec_type  type;
1570                 u16                     size;
1571         };
1572         struct ib_flow_spec_eth         eth;
1573         struct ib_flow_spec_ib          ib;
1574         struct ib_flow_spec_ipv4        ipv4;
1575         struct ib_flow_spec_tcp_udp     tcp_udp;
1576 };
1577
1578 struct ib_flow_attr {
1579         enum ib_flow_attr_type type;
1580         u16          size;
1581         u16          priority;
1582         u32          flags;
1583         u8           num_of_specs;
1584         u8           port;
1585         /* Following are the optional layers according to user request
1586          * struct ib_flow_spec_xxx
1587          * struct ib_flow_spec_yyy
1588          */
1589 };
1590
1591 struct ib_flow {
1592         struct ib_qp            *qp;
1593         struct ib_uobject       *uobject;
1594 };
1595
1596 struct ib_mad_hdr;
1597 struct ib_grh;
1598
1599 enum ib_process_mad_flags {
1600         IB_MAD_IGNORE_MKEY      = 1,
1601         IB_MAD_IGNORE_BKEY      = 2,
1602         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
1603 };
1604
1605 enum ib_mad_result {
1606         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
1607         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
1608         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
1609         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
1610 };
1611
1612 #define IB_DEVICE_NAME_MAX 64
1613
1614 struct ib_cache {
1615         rwlock_t                lock;
1616         struct ib_event_handler event_handler;
1617         struct ib_pkey_cache  **pkey_cache;
1618         struct ib_gid_table   **gid_cache;
1619         u8                     *lmc_cache;
1620 };
1621
1622 struct ib_dma_mapping_ops {
1623         int             (*mapping_error)(struct ib_device *dev,
1624                                          u64 dma_addr);
1625         u64             (*map_single)(struct ib_device *dev,
1626                                       void *ptr, size_t size,
1627                                       enum dma_data_direction direction);
1628         void            (*unmap_single)(struct ib_device *dev,
1629                                         u64 addr, size_t size,
1630                                         enum dma_data_direction direction);
1631         u64             (*map_page)(struct ib_device *dev,
1632                                     struct page *page, unsigned long offset,
1633                                     size_t size,
1634                                     enum dma_data_direction direction);
1635         void            (*unmap_page)(struct ib_device *dev,
1636                                       u64 addr, size_t size,
1637                                       enum dma_data_direction direction);
1638         int             (*map_sg)(struct ib_device *dev,
1639                                   struct scatterlist *sg, int nents,
1640                                   enum dma_data_direction direction);
1641         void            (*unmap_sg)(struct ib_device *dev,
1642                                     struct scatterlist *sg, int nents,
1643                                     enum dma_data_direction direction);
1644         void            (*sync_single_for_cpu)(struct ib_device *dev,
1645                                                u64 dma_handle,
1646                                                size_t size,
1647                                                enum dma_data_direction dir);
1648         void            (*sync_single_for_device)(struct ib_device *dev,
1649                                                   u64 dma_handle,
1650                                                   size_t size,
1651                                                   enum dma_data_direction dir);
1652         void            *(*alloc_coherent)(struct ib_device *dev,
1653                                            size_t size,
1654                                            u64 *dma_handle,
1655                                            gfp_t flag);
1656         void            (*free_coherent)(struct ib_device *dev,
1657                                          size_t size, void *cpu_addr,
1658                                          u64 dma_handle);
1659 };
1660
1661 struct iw_cm_verbs;
1662
1663 struct ib_port_immutable {
1664         int                           pkey_tbl_len;
1665         int                           gid_tbl_len;
1666         u32                           core_cap_flags;
1667         u32                           max_mad_size;
1668 };
1669
1670 struct ib_device {
1671         struct device                *dma_device;
1672
1673         char                          name[IB_DEVICE_NAME_MAX];
1674
1675         struct list_head              event_handler_list;
1676         spinlock_t                    event_handler_lock;
1677
1678         spinlock_t                    client_data_lock;
1679         struct list_head              core_list;
1680         /* Access to the client_data_list is protected by the client_data_lock
1681          * spinlock and the lists_rwsem read-write semaphore */
1682         struct list_head              client_data_list;
1683
1684         struct ib_cache               cache;
1685         /**
1686          * port_immutable is indexed by port number
1687          */
1688         struct ib_port_immutable     *port_immutable;
1689
1690         int                           num_comp_vectors;
1691
1692         struct iw_cm_verbs           *iwcm;
1693
1694         int                        (*get_protocol_stats)(struct ib_device *device,
1695                                                          union rdma_protocol_stats *stats);
1696         int                        (*query_device)(struct ib_device *device,
1697                                                    struct ib_device_attr *device_attr,
1698                                                    struct ib_udata *udata);
1699         int                        (*query_port)(struct ib_device *device,
1700                                                  u8 port_num,
1701                                                  struct ib_port_attr *port_attr);
1702         enum rdma_link_layer       (*get_link_layer)(struct ib_device *device,
1703                                                      u8 port_num);
1704         /* When calling get_netdev, the HW vendor's driver should return the
1705          * net device of device @device at port @port_num or NULL if such
1706          * a net device doesn't exist. The vendor driver should call dev_hold
1707          * on this net device. The HW vendor's device driver must guarantee
1708          * that this function returns NULL before the net device reaches
1709          * NETDEV_UNREGISTER_FINAL state.
1710          */
1711         struct net_device         *(*get_netdev)(struct ib_device *device,
1712                                                  u8 port_num);
1713         int                        (*query_gid)(struct ib_device *device,
1714                                                 u8 port_num, int index,
1715                                                 union ib_gid *gid);
1716         /* When calling add_gid, the HW vendor's driver should
1717          * add the gid of device @device at gid index @index of
1718          * port @port_num to be @gid. Meta-info of that gid (for example,
1719          * the network device related to this gid is available
1720          * at @attr. @context allows the HW vendor driver to store extra
1721          * information together with a GID entry. The HW vendor may allocate
1722          * memory to contain this information and store it in @context when a
1723          * new GID entry is written to. Params are consistent until the next
1724          * call of add_gid or delete_gid. The function should return 0 on
1725          * success or error otherwise. The function could be called
1726          * concurrently for different ports. This function is only called
1727          * when roce_gid_table is used.
1728          */
1729         int                        (*add_gid)(struct ib_device *device,
1730                                               u8 port_num,
1731                                               unsigned int index,
1732                                               const union ib_gid *gid,
1733                                               const struct ib_gid_attr *attr,
1734                                               void **context);
1735         /* When calling del_gid, the HW vendor's driver should delete the
1736          * gid of device @device at gid index @index of port @port_num.
1737          * Upon the deletion of a GID entry, the HW vendor must free any
1738          * allocated memory. The caller will clear @context afterwards.
1739          * This function is only called when roce_gid_table is used.
1740          */
1741         int                        (*del_gid)(struct ib_device *device,
1742                                               u8 port_num,
1743                                               unsigned int index,
1744                                               void **context);
1745         int                        (*query_pkey)(struct ib_device *device,
1746                                                  u8 port_num, u16 index, u16 *pkey);
1747         int                        (*modify_device)(struct ib_device *device,
1748                                                     int device_modify_mask,
1749                                                     struct ib_device_modify *device_modify);
1750         int                        (*modify_port)(struct ib_device *device,
1751                                                   u8 port_num, int port_modify_mask,
1752                                                   struct ib_port_modify *port_modify);
1753         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
1754                                                      struct ib_udata *udata);
1755         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
1756         int                        (*mmap)(struct ib_ucontext *context,
1757                                            struct vm_area_struct *vma);
1758         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
1759                                                struct ib_ucontext *context,
1760                                                struct ib_udata *udata);
1761         int                        (*dealloc_pd)(struct ib_pd *pd);
1762         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
1763                                                 struct ib_ah_attr *ah_attr);
1764         int                        (*modify_ah)(struct ib_ah *ah,
1765                                                 struct ib_ah_attr *ah_attr);
1766         int                        (*query_ah)(struct ib_ah *ah,
1767                                                struct ib_ah_attr *ah_attr);
1768         int                        (*destroy_ah)(struct ib_ah *ah);
1769         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
1770                                                  struct ib_srq_init_attr *srq_init_attr,
1771                                                  struct ib_udata *udata);
1772         int                        (*modify_srq)(struct ib_srq *srq,
1773                                                  struct ib_srq_attr *srq_attr,
1774                                                  enum ib_srq_attr_mask srq_attr_mask,
1775                                                  struct ib_udata *udata);
1776         int                        (*query_srq)(struct ib_srq *srq,
1777                                                 struct ib_srq_attr *srq_attr);
1778         int                        (*destroy_srq)(struct ib_srq *srq);
1779         int                        (*post_srq_recv)(struct ib_srq *srq,
1780                                                     struct ib_recv_wr *recv_wr,
1781                                                     struct ib_recv_wr **bad_recv_wr);
1782         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
1783                                                 struct ib_qp_init_attr *qp_init_attr,
1784                                                 struct ib_udata *udata);
1785         int                        (*modify_qp)(struct ib_qp *qp,
1786                                                 struct ib_qp_attr *qp_attr,
1787                                                 int qp_attr_mask,
1788                                                 struct ib_udata *udata);
1789         int                        (*query_qp)(struct ib_qp *qp,
1790                                                struct ib_qp_attr *qp_attr,
1791                                                int qp_attr_mask,
1792                                                struct ib_qp_init_attr *qp_init_attr);
1793         int                        (*destroy_qp)(struct ib_qp *qp);
1794         int                        (*post_send)(struct ib_qp *qp,
1795                                                 struct ib_send_wr *send_wr,
1796                                                 struct ib_send_wr **bad_send_wr);
1797         int                        (*post_recv)(struct ib_qp *qp,
1798                                                 struct ib_recv_wr *recv_wr,
1799                                                 struct ib_recv_wr **bad_recv_wr);
1800         struct ib_cq *             (*create_cq)(struct ib_device *device,
1801                                                 const struct ib_cq_init_attr *attr,
1802                                                 struct ib_ucontext *context,
1803                                                 struct ib_udata *udata);
1804         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1805                                                 u16 cq_period);
1806         int                        (*destroy_cq)(struct ib_cq *cq);
1807         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
1808                                                 struct ib_udata *udata);
1809         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
1810                                               struct ib_wc *wc);
1811         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1812         int                        (*req_notify_cq)(struct ib_cq *cq,
1813                                                     enum ib_cq_notify_flags flags);
1814         int                        (*req_ncomp_notif)(struct ib_cq *cq,
1815                                                       int wc_cnt);
1816         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
1817                                                  int mr_access_flags);
1818         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1819                                                   u64 start, u64 length,
1820                                                   u64 virt_addr,
1821                                                   int mr_access_flags,
1822                                                   struct ib_udata *udata);
1823         int                        (*rereg_user_mr)(struct ib_mr *mr,
1824                                                     int flags,
1825                                                     u64 start, u64 length,
1826                                                     u64 virt_addr,
1827                                                     int mr_access_flags,
1828                                                     struct ib_pd *pd,
1829                                                     struct ib_udata *udata);
1830         int                        (*dereg_mr)(struct ib_mr *mr);
1831         struct ib_mr *             (*alloc_mr)(struct ib_pd *pd,
1832                                                enum ib_mr_type mr_type,
1833                                                u32 max_num_sg);
1834         int                        (*map_mr_sg)(struct ib_mr *mr,
1835                                                 struct scatterlist *sg,
1836                                                 int sg_nents,
1837                                                 unsigned sg_offset);
1838         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd,
1839                                                enum ib_mw_type type,
1840                                                struct ib_udata *udata);
1841         int                        (*dealloc_mw)(struct ib_mw *mw);
1842         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1843                                                 int mr_access_flags,
1844                                                 struct ib_fmr_attr *fmr_attr);
1845         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1846                                                    u64 *page_list, int list_len,
1847                                                    u64 iova);
1848         int                        (*unmap_fmr)(struct list_head *fmr_list);
1849         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1850         int                        (*attach_mcast)(struct ib_qp *qp,
1851                                                    union ib_gid *gid,
1852                                                    u16 lid);
1853         int                        (*detach_mcast)(struct ib_qp *qp,
1854                                                    union ib_gid *gid,
1855                                                    u16 lid);
1856         int                        (*process_mad)(struct ib_device *device,
1857                                                   int process_mad_flags,
1858                                                   u8 port_num,
1859                                                   const struct ib_wc *in_wc,
1860                                                   const struct ib_grh *in_grh,
1861                                                   const struct ib_mad_hdr *in_mad,
1862                                                   size_t in_mad_size,
1863                                                   struct ib_mad_hdr *out_mad,
1864                                                   size_t *out_mad_size,
1865                                                   u16 *out_mad_pkey_index);
1866         struct ib_xrcd *           (*alloc_xrcd)(struct ib_device *device,
1867                                                  struct ib_ucontext *ucontext,
1868                                                  struct ib_udata *udata);
1869         int                        (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1870         struct ib_flow *           (*create_flow)(struct ib_qp *qp,
1871                                                   struct ib_flow_attr
1872                                                   *flow_attr,
1873                                                   int domain);
1874         int                        (*destroy_flow)(struct ib_flow *flow_id);
1875         int                        (*check_mr_status)(struct ib_mr *mr, u32 check_mask,
1876                                                       struct ib_mr_status *mr_status);
1877         void                       (*disassociate_ucontext)(struct ib_ucontext *ibcontext);
1878         void                       (*drain_rq)(struct ib_qp *qp);
1879         void                       (*drain_sq)(struct ib_qp *qp);
1880         int                        (*set_vf_link_state)(struct ib_device *device, int vf, u8 port,
1881                                                         int state);
1882         int                        (*get_vf_config)(struct ib_device *device, int vf, u8 port,
1883                                                    struct ifla_vf_info *ivf);
1884         int                        (*get_vf_stats)(struct ib_device *device, int vf, u8 port,
1885                                                    struct ifla_vf_stats *stats);
1886         int                        (*set_vf_guid)(struct ib_device *device, int vf, u8 port, u64 guid,
1887                                                   int type);
1888
1889         struct ib_dma_mapping_ops   *dma_ops;
1890
1891         struct module               *owner;
1892         struct device                dev;
1893         struct kobject               *ports_parent;
1894         struct list_head             port_list;
1895
1896         enum {
1897                 IB_DEV_UNINITIALIZED,
1898                 IB_DEV_REGISTERED,
1899                 IB_DEV_UNREGISTERED
1900         }                            reg_state;
1901
1902         int                          uverbs_abi_ver;
1903         u64                          uverbs_cmd_mask;
1904         u64                          uverbs_ex_cmd_mask;
1905
1906         char                         node_desc[64];
1907         __be64                       node_guid;
1908         u32                          local_dma_lkey;
1909         u16                          is_switch:1;
1910         u8                           node_type;
1911         u8                           phys_port_cnt;
1912         struct ib_device_attr        attrs;
1913
1914         /**
1915          * The following mandatory functions are used only at device
1916          * registration.  Keep functions such as these at the end of this
1917          * structure to avoid cache line misses when accessing struct ib_device
1918          * in fast paths.
1919          */
1920         int (*get_port_immutable)(struct ib_device *, u8, struct ib_port_immutable *);
1921 };
1922
1923 struct ib_client {
1924         char  *name;
1925         void (*add)   (struct ib_device *);
1926         void (*remove)(struct ib_device *, void *client_data);
1927
1928         /* Returns the net_dev belonging to this ib_client and matching the
1929          * given parameters.
1930          * @dev:         An RDMA device that the net_dev use for communication.
1931          * @port:        A physical port number on the RDMA device.
1932          * @pkey:        P_Key that the net_dev uses if applicable.
1933          * @gid:         A GID that the net_dev uses to communicate.
1934          * @addr:        An IP address the net_dev is configured with.
1935          * @client_data: The device's client data set by ib_set_client_data().
1936          *
1937          * An ib_client that implements a net_dev on top of RDMA devices
1938          * (such as IP over IB) should implement this callback, allowing the
1939          * rdma_cm module to find the right net_dev for a given request.
1940          *
1941          * The caller is responsible for calling dev_put on the returned
1942          * netdev. */
1943         struct net_device *(*get_net_dev_by_params)(
1944                         struct ib_device *dev,
1945                         u8 port,
1946                         u16 pkey,
1947                         const union ib_gid *gid,
1948                         const struct sockaddr *addr,
1949                         void *client_data);
1950         struct list_head list;
1951 };
1952
1953 struct ib_device *ib_alloc_device(size_t size);
1954 void ib_dealloc_device(struct ib_device *device);
1955
1956 int ib_register_device(struct ib_device *device,
1957                        int (*port_callback)(struct ib_device *,
1958                                             u8, struct kobject *));
1959 void ib_unregister_device(struct ib_device *device);
1960
1961 int ib_register_client   (struct ib_client *client);
1962 void ib_unregister_client(struct ib_client *client);
1963
1964 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1965 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1966                          void *data);
1967
1968 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1969 {
1970         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1971 }
1972
1973 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1974 {
1975         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1976 }
1977
1978 static inline bool ib_is_udata_cleared(struct ib_udata *udata,
1979                                        size_t offset,
1980                                        size_t len)
1981 {
1982         const void __user *p = udata->inbuf + offset;
1983         bool ret = false;
1984         u8 *buf;
1985
1986         if (len > USHRT_MAX)
1987                 return false;
1988
1989         buf = kmalloc(len, GFP_KERNEL);
1990         if (!buf)
1991                 return false;
1992
1993         if (copy_from_user(buf, p, len))
1994                 goto free;
1995
1996         ret = !memchr_inv(buf, 0, len);
1997
1998 free:
1999         kfree(buf);
2000         return ret;
2001 }
2002
2003 /**
2004  * ib_modify_qp_is_ok - Check that the supplied attribute mask
2005  * contains all required attributes and no attributes not allowed for
2006  * the given QP state transition.
2007  * @cur_state: Current QP state
2008  * @next_state: Next QP state
2009  * @type: QP type
2010  * @mask: Mask of supplied QP attributes
2011  * @ll : link layer of port
2012  *
2013  * This function is a helper function that a low-level driver's
2014  * modify_qp method can use to validate the consumer's input.  It
2015  * checks that cur_state and next_state are valid QP states, that a
2016  * transition from cur_state to next_state is allowed by the IB spec,
2017  * and that the attribute mask supplied is allowed for the transition.
2018  */
2019 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
2020                        enum ib_qp_type type, enum ib_qp_attr_mask mask,
2021                        enum rdma_link_layer ll);
2022
2023 int ib_register_event_handler  (struct ib_event_handler *event_handler);
2024 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
2025 void ib_dispatch_event(struct ib_event *event);
2026
2027 int ib_query_port(struct ib_device *device,
2028                   u8 port_num, struct ib_port_attr *port_attr);
2029
2030 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
2031                                                u8 port_num);
2032
2033 /**
2034  * rdma_cap_ib_switch - Check if the device is IB switch
2035  * @device: Device to check
2036  *
2037  * Device driver is responsible for setting is_switch bit on
2038  * in ib_device structure at init time.
2039  *
2040  * Return: true if the device is IB switch.
2041  */
2042 static inline bool rdma_cap_ib_switch(const struct ib_device *device)
2043 {
2044         return device->is_switch;
2045 }
2046
2047 /**
2048  * rdma_start_port - Return the first valid port number for the device
2049  * specified
2050  *
2051  * @device: Device to be checked
2052  *
2053  * Return start port number
2054  */
2055 static inline u8 rdma_start_port(const struct ib_device *device)
2056 {
2057         return rdma_cap_ib_switch(device) ? 0 : 1;
2058 }
2059
2060 /**
2061  * rdma_end_port - Return the last valid port number for the device
2062  * specified
2063  *
2064  * @device: Device to be checked
2065  *
2066  * Return last port number
2067  */
2068 static inline u8 rdma_end_port(const struct ib_device *device)
2069 {
2070         return rdma_cap_ib_switch(device) ? 0 : device->phys_port_cnt;
2071 }
2072
2073 static inline bool rdma_protocol_ib(const struct ib_device *device, u8 port_num)
2074 {
2075         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_IB;
2076 }
2077
2078 static inline bool rdma_protocol_roce(const struct ib_device *device, u8 port_num)
2079 {
2080         return device->port_immutable[port_num].core_cap_flags &
2081                 (RDMA_CORE_CAP_PROT_ROCE | RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP);
2082 }
2083
2084 static inline bool rdma_protocol_roce_udp_encap(const struct ib_device *device, u8 port_num)
2085 {
2086         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP;
2087 }
2088
2089 static inline bool rdma_protocol_roce_eth_encap(const struct ib_device *device, u8 port_num)
2090 {
2091         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_ROCE;
2092 }
2093
2094 static inline bool rdma_protocol_iwarp(const struct ib_device *device, u8 port_num)
2095 {
2096         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_PROT_IWARP;
2097 }
2098
2099 static inline bool rdma_ib_or_roce(const struct ib_device *device, u8 port_num)
2100 {
2101         return rdma_protocol_ib(device, port_num) ||
2102                 rdma_protocol_roce(device, port_num);
2103 }
2104
2105 /**
2106  * rdma_cap_ib_mad - Check if the port of a device supports Infiniband
2107  * Management Datagrams.
2108  * @device: Device to check
2109  * @port_num: Port number to check
2110  *
2111  * Management Datagrams (MAD) are a required part of the InfiniBand
2112  * specification and are supported on all InfiniBand devices.  A slightly
2113  * extended version are also supported on OPA interfaces.
2114  *
2115  * Return: true if the port supports sending/receiving of MAD packets.
2116  */
2117 static inline bool rdma_cap_ib_mad(const struct ib_device *device, u8 port_num)
2118 {
2119         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_MAD;
2120 }
2121
2122 /**
2123  * rdma_cap_opa_mad - Check if the port of device provides support for OPA
2124  * Management Datagrams.
2125  * @device: Device to check
2126  * @port_num: Port number to check
2127  *
2128  * Intel OmniPath devices extend and/or replace the InfiniBand Management
2129  * datagrams with their own versions.  These OPA MADs share many but not all of
2130  * the characteristics of InfiniBand MADs.
2131  *
2132  * OPA MADs differ in the following ways:
2133  *
2134  *    1) MADs are variable size up to 2K
2135  *       IBTA defined MADs remain fixed at 256 bytes
2136  *    2) OPA SMPs must carry valid PKeys
2137  *    3) OPA SMP packets are a different format
2138  *
2139  * Return: true if the port supports OPA MAD packet formats.
2140  */
2141 static inline bool rdma_cap_opa_mad(struct ib_device *device, u8 port_num)
2142 {
2143         return (device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_OPA_MAD)
2144                 == RDMA_CORE_CAP_OPA_MAD;
2145 }
2146
2147 /**
2148  * rdma_cap_ib_smi - Check if the port of a device provides an Infiniband
2149  * Subnet Management Agent (SMA) on the Subnet Management Interface (SMI).
2150  * @device: Device to check
2151  * @port_num: Port number to check
2152  *
2153  * Each InfiniBand node is required to provide a Subnet Management Agent
2154  * that the subnet manager can access.  Prior to the fabric being fully
2155  * configured by the subnet manager, the SMA is accessed via a well known
2156  * interface called the Subnet Management Interface (SMI).  This interface
2157  * uses directed route packets to communicate with the SM to get around the
2158  * chicken and egg problem of the SM needing to know what's on the fabric
2159  * in order to configure the fabric, and needing to configure the fabric in
2160  * order to send packets to the devices on the fabric.  These directed
2161  * route packets do not need the fabric fully configured in order to reach
2162  * their destination.  The SMI is the only method allowed to send
2163  * directed route packets on an InfiniBand fabric.
2164  *
2165  * Return: true if the port provides an SMI.
2166  */
2167 static inline bool rdma_cap_ib_smi(const struct ib_device *device, u8 port_num)
2168 {
2169         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_SMI;
2170 }
2171
2172 /**
2173  * rdma_cap_ib_cm - Check if the port of device has the capability Infiniband
2174  * Communication Manager.
2175  * @device: Device to check
2176  * @port_num: Port number to check
2177  *
2178  * The InfiniBand Communication Manager is one of many pre-defined General
2179  * Service Agents (GSA) that are accessed via the General Service
2180  * Interface (GSI).  It's role is to facilitate establishment of connections
2181  * between nodes as well as other management related tasks for established
2182  * connections.
2183  *
2184  * Return: true if the port supports an IB CM (this does not guarantee that
2185  * a CM is actually running however).
2186  */
2187 static inline bool rdma_cap_ib_cm(const struct ib_device *device, u8 port_num)
2188 {
2189         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_CM;
2190 }
2191
2192 /**
2193  * rdma_cap_iw_cm - Check if the port of device has the capability IWARP
2194  * Communication Manager.
2195  * @device: Device to check
2196  * @port_num: Port number to check
2197  *
2198  * Similar to above, but specific to iWARP connections which have a different
2199  * managment protocol than InfiniBand.
2200  *
2201  * Return: true if the port supports an iWARP CM (this does not guarantee that
2202  * a CM is actually running however).
2203  */
2204 static inline bool rdma_cap_iw_cm(const struct ib_device *device, u8 port_num)
2205 {
2206         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IW_CM;
2207 }
2208
2209 /**
2210  * rdma_cap_ib_sa - Check if the port of device has the capability Infiniband
2211  * Subnet Administration.
2212  * @device: Device to check
2213  * @port_num: Port number to check
2214  *
2215  * An InfiniBand Subnet Administration (SA) service is a pre-defined General
2216  * Service Agent (GSA) provided by the Subnet Manager (SM).  On InfiniBand
2217  * fabrics, devices should resolve routes to other hosts by contacting the
2218  * SA to query the proper route.
2219  *
2220  * Return: true if the port should act as a client to the fabric Subnet
2221  * Administration interface.  This does not imply that the SA service is
2222  * running locally.
2223  */
2224 static inline bool rdma_cap_ib_sa(const struct ib_device *device, u8 port_num)
2225 {
2226         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_IB_SA;
2227 }
2228
2229 /**
2230  * rdma_cap_ib_mcast - Check if the port of device has the capability Infiniband
2231  * Multicast.
2232  * @device: Device to check
2233  * @port_num: Port number to check
2234  *
2235  * InfiniBand multicast registration is more complex than normal IPv4 or
2236  * IPv6 multicast registration.  Each Host Channel Adapter must register
2237  * with the Subnet Manager when it wishes to join a multicast group.  It
2238  * should do so only once regardless of how many queue pairs it subscribes
2239  * to this group.  And it should leave the group only after all queue pairs
2240  * attached to the group have been detached.
2241  *
2242  * Return: true if the port must undertake the additional adminstrative
2243  * overhead of registering/unregistering with the SM and tracking of the
2244  * total number of queue pairs attached to the multicast group.
2245  */
2246 static inline bool rdma_cap_ib_mcast(const struct ib_device *device, u8 port_num)
2247 {
2248         return rdma_cap_ib_sa(device, port_num);
2249 }
2250
2251 /**
2252  * rdma_cap_af_ib - Check if the port of device has the capability
2253  * Native Infiniband Address.
2254  * @device: Device to check
2255  * @port_num: Port number to check
2256  *
2257  * InfiniBand addressing uses a port's GUID + Subnet Prefix to make a default
2258  * GID.  RoCE uses a different mechanism, but still generates a GID via
2259  * a prescribed mechanism and port specific data.
2260  *
2261  * Return: true if the port uses a GID address to identify devices on the
2262  * network.
2263  */
2264 static inline bool rdma_cap_af_ib(const struct ib_device *device, u8 port_num)
2265 {
2266         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_AF_IB;
2267 }
2268
2269 /**
2270  * rdma_cap_eth_ah - Check if the port of device has the capability
2271  * Ethernet Address Handle.
2272  * @device: Device to check
2273  * @port_num: Port number to check
2274  *
2275  * RoCE is InfiniBand over Ethernet, and it uses a well defined technique
2276  * to fabricate GIDs over Ethernet/IP specific addresses native to the
2277  * port.  Normally, packet headers are generated by the sending host
2278  * adapter, but when sending connectionless datagrams, we must manually
2279  * inject the proper headers for the fabric we are communicating over.
2280  *
2281  * Return: true if we are running as a RoCE port and must force the
2282  * addition of a Global Route Header built from our Ethernet Address
2283  * Handle into our header list for connectionless packets.
2284  */
2285 static inline bool rdma_cap_eth_ah(const struct ib_device *device, u8 port_num)
2286 {
2287         return device->port_immutable[port_num].core_cap_flags & RDMA_CORE_CAP_ETH_AH;
2288 }
2289
2290 /**
2291  * rdma_max_mad_size - Return the max MAD size required by this RDMA Port.
2292  *
2293  * @device: Device
2294  * @port_num: Port number
2295  *
2296  * This MAD size includes the MAD headers and MAD payload.  No other headers
2297  * are included.
2298  *
2299  * Return the max MAD size required by the Port.  Will return 0 if the port
2300  * does not support MADs
2301  */
2302 static inline size_t rdma_max_mad_size(const struct ib_device *device, u8 port_num)
2303 {
2304         return device->port_immutable[port_num].max_mad_size;
2305 }
2306
2307 /**
2308  * rdma_cap_roce_gid_table - Check if the port of device uses roce_gid_table
2309  * @device: Device to check
2310  * @port_num: Port number to check
2311  *
2312  * RoCE GID table mechanism manages the various GIDs for a device.
2313  *
2314  * NOTE: if allocating the port's GID table has failed, this call will still
2315  * return true, but any RoCE GID table API will fail.
2316  *
2317  * Return: true if the port uses RoCE GID table mechanism in order to manage
2318  * its GIDs.
2319  */
2320 static inline bool rdma_cap_roce_gid_table(const struct ib_device *device,
2321                                            u8 port_num)
2322 {
2323         return rdma_protocol_roce(device, port_num) &&
2324                 device->add_gid && device->del_gid;
2325 }
2326
2327 /*
2328  * Check if the device supports READ W/ INVALIDATE.
2329  */
2330 static inline bool rdma_cap_read_inv(struct ib_device *dev, u32 port_num)
2331 {
2332         /*
2333          * iWarp drivers must support READ W/ INVALIDATE.  No other protocol
2334          * has support for it yet.
2335          */
2336         return rdma_protocol_iwarp(dev, port_num);
2337 }
2338
2339 int ib_query_gid(struct ib_device *device,
2340                  u8 port_num, int index, union ib_gid *gid,
2341                  struct ib_gid_attr *attr);
2342
2343 int ib_set_vf_link_state(struct ib_device *device, int vf, u8 port,
2344                          int state);
2345 int ib_get_vf_config(struct ib_device *device, int vf, u8 port,
2346                      struct ifla_vf_info *info);
2347 int ib_get_vf_stats(struct ib_device *device, int vf, u8 port,
2348                     struct ifla_vf_stats *stats);
2349 int ib_set_vf_guid(struct ib_device *device, int vf, u8 port, u64 guid,
2350                    int type);
2351
2352 int ib_query_pkey(struct ib_device *device,
2353                   u8 port_num, u16 index, u16 *pkey);
2354
2355 int ib_modify_device(struct ib_device *device,
2356                      int device_modify_mask,
2357                      struct ib_device_modify *device_modify);
2358
2359 int ib_modify_port(struct ib_device *device,
2360                    u8 port_num, int port_modify_mask,
2361                    struct ib_port_modify *port_modify);
2362
2363 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
2364                 enum ib_gid_type gid_type, struct net_device *ndev,
2365                 u8 *port_num, u16 *index);
2366
2367 int ib_find_pkey(struct ib_device *device,
2368                  u8 port_num, u16 pkey, u16 *index);
2369
2370 struct ib_pd *ib_alloc_pd(struct ib_device *device);
2371
2372 void ib_dealloc_pd(struct ib_pd *pd);
2373
2374 /**
2375  * ib_create_ah - Creates an address handle for the given address vector.
2376  * @pd: The protection domain associated with the address handle.
2377  * @ah_attr: The attributes of the address vector.
2378  *
2379  * The address handle is used to reference a local or global destination
2380  * in all UD QP post sends.
2381  */
2382 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
2383
2384 /**
2385  * ib_init_ah_from_wc - Initializes address handle attributes from a
2386  *   work completion.
2387  * @device: Device on which the received message arrived.
2388  * @port_num: Port on which the received message arrived.
2389  * @wc: Work completion associated with the received message.
2390  * @grh: References the received global route header.  This parameter is
2391  *   ignored unless the work completion indicates that the GRH is valid.
2392  * @ah_attr: Returned attributes that can be used when creating an address
2393  *   handle for replying to the message.
2394  */
2395 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num,
2396                        const struct ib_wc *wc, const struct ib_grh *grh,
2397                        struct ib_ah_attr *ah_attr);
2398
2399 /**
2400  * ib_create_ah_from_wc - Creates an address handle associated with the
2401  *   sender of the specified work completion.
2402  * @pd: The protection domain associated with the address handle.
2403  * @wc: Work completion information associated with a received message.
2404  * @grh: References the received global route header.  This parameter is
2405  *   ignored unless the work completion indicates that the GRH is valid.
2406  * @port_num: The outbound port number to associate with the address.
2407  *
2408  * The address handle is used to reference a local or global destination
2409  * in all UD QP post sends.
2410  */
2411 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, const struct ib_wc *wc,
2412                                    const struct ib_grh *grh, u8 port_num);
2413
2414 /**
2415  * ib_modify_ah - Modifies the address vector associated with an address
2416  *   handle.
2417  * @ah: The address handle to modify.
2418  * @ah_attr: The new address vector attributes to associate with the
2419  *   address handle.
2420  */
2421 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
2422
2423 /**
2424  * ib_query_ah - Queries the address vector associated with an address
2425  *   handle.
2426  * @ah: The address handle to query.
2427  * @ah_attr: The address vector attributes associated with the address
2428  *   handle.
2429  */
2430 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
2431
2432 /**
2433  * ib_destroy_ah - Destroys an address handle.
2434  * @ah: The address handle to destroy.
2435  */
2436 int ib_destroy_ah(struct ib_ah *ah);
2437
2438 /**
2439  * ib_create_srq - Creates a SRQ associated with the specified protection
2440  *   domain.
2441  * @pd: The protection domain associated with the SRQ.
2442  * @srq_init_attr: A list of initial attributes required to create the
2443  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
2444  *   the actual capabilities of the created SRQ.
2445  *
2446  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
2447  * requested size of the SRQ, and set to the actual values allocated
2448  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
2449  * will always be at least as large as the requested values.
2450  */
2451 struct ib_srq *ib_create_srq(struct ib_pd *pd,
2452                              struct ib_srq_init_attr *srq_init_attr);
2453
2454 /**
2455  * ib_modify_srq - Modifies the attributes for the specified SRQ.
2456  * @srq: The SRQ to modify.
2457  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
2458  *   the current values of selected SRQ attributes are returned.
2459  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
2460  *   are being modified.
2461  *
2462  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
2463  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
2464  * the number of receives queued drops below the limit.
2465  */
2466 int ib_modify_srq(struct ib_srq *srq,
2467                   struct ib_srq_attr *srq_attr,
2468                   enum ib_srq_attr_mask srq_attr_mask);
2469
2470 /**
2471  * ib_query_srq - Returns the attribute list and current values for the
2472  *   specified SRQ.
2473  * @srq: The SRQ to query.
2474  * @srq_attr: The attributes of the specified SRQ.
2475  */
2476 int ib_query_srq(struct ib_srq *srq,
2477                  struct ib_srq_attr *srq_attr);
2478
2479 /**
2480  * ib_destroy_srq - Destroys the specified SRQ.
2481  * @srq: The SRQ to destroy.
2482  */
2483 int ib_destroy_srq(struct ib_srq *srq);
2484
2485 /**
2486  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
2487  * @srq: The SRQ to post the work request on.
2488  * @recv_wr: A list of work requests to post on the receive queue.
2489  * @bad_recv_wr: On an immediate failure, this parameter will reference
2490  *   the work request that failed to be posted on the QP.
2491  */
2492 static inline int ib_post_srq_recv(struct ib_srq *srq,
2493                                    struct ib_recv_wr *recv_wr,
2494                                    struct ib_recv_wr **bad_recv_wr)
2495 {
2496         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
2497 }
2498
2499 /**
2500  * ib_create_qp - Creates a QP associated with the specified protection
2501  *   domain.
2502  * @pd: The protection domain associated with the QP.
2503  * @qp_init_attr: A list of initial attributes required to create the
2504  *   QP.  If QP creation succeeds, then the attributes are updated to
2505  *   the actual capabilities of the created QP.
2506  */
2507 struct ib_qp *ib_create_qp(struct ib_pd *pd,
2508                            struct ib_qp_init_attr *qp_init_attr);
2509
2510 /**
2511  * ib_modify_qp - Modifies the attributes for the specified QP and then
2512  *   transitions the QP to the given state.
2513  * @qp: The QP to modify.
2514  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
2515  *   the current values of selected QP attributes are returned.
2516  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
2517  *   are being modified.
2518  */
2519 int ib_modify_qp(struct ib_qp *qp,
2520                  struct ib_qp_attr *qp_attr,
2521                  int qp_attr_mask);
2522
2523 /**
2524  * ib_query_qp - Returns the attribute list and current values for the
2525  *   specified QP.
2526  * @qp: The QP to query.
2527  * @qp_attr: The attributes of the specified QP.
2528  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
2529  * @qp_init_attr: Additional attributes of the selected QP.
2530  *
2531  * The qp_attr_mask may be used to limit the query to gathering only the
2532  * selected attributes.
2533  */
2534 int ib_query_qp(struct ib_qp *qp,
2535                 struct ib_qp_attr *qp_attr,
2536                 int qp_attr_mask,
2537                 struct ib_qp_init_attr *qp_init_attr);
2538
2539 /**
2540  * ib_destroy_qp - Destroys the specified QP.
2541  * @qp: The QP to destroy.
2542  */
2543 int ib_destroy_qp(struct ib_qp *qp);
2544
2545 /**
2546  * ib_open_qp - Obtain a reference to an existing sharable QP.
2547  * @xrcd - XRC domain
2548  * @qp_open_attr: Attributes identifying the QP to open.
2549  *
2550  * Returns a reference to a sharable QP.
2551  */
2552 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
2553                          struct ib_qp_open_attr *qp_open_attr);
2554
2555 /**
2556  * ib_close_qp - Release an external reference to a QP.
2557  * @qp: The QP handle to release
2558  *
2559  * The opened QP handle is released by the caller.  The underlying
2560  * shared QP is not destroyed until all internal references are released.
2561  */
2562 int ib_close_qp(struct ib_qp *qp);
2563
2564 /**
2565  * ib_post_send - Posts a list of work requests to the send queue of
2566  *   the specified QP.
2567  * @qp: The QP to post the work request on.
2568  * @send_wr: A list of work requests to post on the send queue.
2569  * @bad_send_wr: On an immediate failure, this parameter will reference
2570  *   the work request that failed to be posted on the QP.
2571  *
2572  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
2573  * error is returned, the QP state shall not be affected,
2574  * ib_post_send() will return an immediate error after queueing any
2575  * earlier work requests in the list.
2576  */
2577 static inline int ib_post_send(struct ib_qp *qp,
2578                                struct ib_send_wr *send_wr,
2579                                struct ib_send_wr **bad_send_wr)
2580 {
2581         return qp->device->post_send(qp, send_wr, bad_send_wr);
2582 }
2583
2584 /**
2585  * ib_post_recv - Posts a list of work requests to the receive queue of
2586  *   the specified QP.
2587  * @qp: The QP to post the work request on.
2588  * @recv_wr: A list of work requests to post on the receive queue.
2589  * @bad_recv_wr: On an immediate failure, this parameter will reference
2590  *   the work request that failed to be posted on the QP.
2591  */
2592 static inline int ib_post_recv(struct ib_qp *qp,
2593                                struct ib_recv_wr *recv_wr,
2594                                struct ib_recv_wr **bad_recv_wr)
2595 {
2596         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
2597 }
2598
2599 struct ib_cq *ib_alloc_cq(struct ib_device *dev, void *private,
2600                 int nr_cqe, int comp_vector, enum ib_poll_context poll_ctx);
2601 void ib_free_cq(struct ib_cq *cq);
2602 int ib_process_cq_direct(struct ib_cq *cq, int budget);
2603
2604 /**
2605  * ib_create_cq - Creates a CQ on the specified device.
2606  * @device: The device on which to create the CQ.
2607  * @comp_handler: A user-specified callback that is invoked when a
2608  *   completion event occurs on the CQ.
2609  * @event_handler: A user-specified callback that is invoked when an
2610  *   asynchronous event not associated with a completion occurs on the CQ.
2611  * @cq_context: Context associated with the CQ returned to the user via
2612  *   the associated completion and event handlers.
2613  * @cq_attr: The attributes the CQ should be created upon.
2614  *
2615  * Users can examine the cq structure to determine the actual CQ size.
2616  */
2617 struct ib_cq *ib_create_cq(struct ib_device *device,
2618                            ib_comp_handler comp_handler,
2619                            void (*event_handler)(struct ib_event *, void *),
2620                            void *cq_context,
2621                            const struct ib_cq_init_attr *cq_attr);
2622
2623 /**
2624  * ib_resize_cq - Modifies the capacity of the CQ.
2625  * @cq: The CQ to resize.
2626  * @cqe: The minimum size of the CQ.
2627  *
2628  * Users can examine the cq structure to determine the actual CQ size.
2629  */
2630 int ib_resize_cq(struct ib_cq *cq, int cqe);
2631
2632 /**
2633  * ib_modify_cq - Modifies moderation params of the CQ
2634  * @cq: The CQ to modify.
2635  * @cq_count: number of CQEs that will trigger an event
2636  * @cq_period: max period of time in usec before triggering an event
2637  *
2638  */
2639 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
2640
2641 /**
2642  * ib_destroy_cq - Destroys the specified CQ.
2643  * @cq: The CQ to destroy.
2644  */
2645 int ib_destroy_cq(struct ib_cq *cq);
2646
2647 /**
2648  * ib_poll_cq - poll a CQ for completion(s)
2649  * @cq:the CQ being polled
2650  * @num_entries:maximum number of completions to return
2651  * @wc:array of at least @num_entries &struct ib_wc where completions
2652  *   will be returned
2653  *
2654  * Poll a CQ for (possibly multiple) completions.  If the return value
2655  * is < 0, an error occurred.  If the return value is >= 0, it is the
2656  * number of completions returned.  If the return value is
2657  * non-negative and < num_entries, then the CQ was emptied.
2658  */
2659 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
2660                              struct ib_wc *wc)
2661 {
2662         return cq->device->poll_cq(cq, num_entries, wc);
2663 }
2664
2665 /**
2666  * ib_peek_cq - Returns the number of unreaped completions currently
2667  *   on the specified CQ.
2668  * @cq: The CQ to peek.
2669  * @wc_cnt: A minimum number of unreaped completions to check for.
2670  *
2671  * If the number of unreaped completions is greater than or equal to wc_cnt,
2672  * this function returns wc_cnt, otherwise, it returns the actual number of
2673  * unreaped completions.
2674  */
2675 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
2676
2677 /**
2678  * ib_req_notify_cq - Request completion notification on a CQ.
2679  * @cq: The CQ to generate an event for.
2680  * @flags:
2681  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
2682  *   to request an event on the next solicited event or next work
2683  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
2684  *   may also be |ed in to request a hint about missed events, as
2685  *   described below.
2686  *
2687  * Return Value:
2688  *    < 0 means an error occurred while requesting notification
2689  *   == 0 means notification was requested successfully, and if
2690  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
2691  *        were missed and it is safe to wait for another event.  In
2692  *        this case is it guaranteed that any work completions added
2693  *        to the CQ since the last CQ poll will trigger a completion
2694  *        notification event.
2695  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
2696  *        in.  It means that the consumer must poll the CQ again to
2697  *        make sure it is empty to avoid missing an event because of a
2698  *        race between requesting notification and an entry being
2699  *        added to the CQ.  This return value means it is possible
2700  *        (but not guaranteed) that a work completion has been added
2701  *        to the CQ since the last poll without triggering a
2702  *        completion notification event.
2703  */
2704 static inline int ib_req_notify_cq(struct ib_cq *cq,
2705                                    enum ib_cq_notify_flags flags)
2706 {
2707         return cq->device->req_notify_cq(cq, flags);
2708 }
2709
2710 /**
2711  * ib_req_ncomp_notif - Request completion notification when there are
2712  *   at least the specified number of unreaped completions on the CQ.
2713  * @cq: The CQ to generate an event for.
2714  * @wc_cnt: The number of unreaped completions that should be on the
2715  *   CQ before an event is generated.
2716  */
2717 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
2718 {
2719         return cq->device->req_ncomp_notif ?
2720                 cq->device->req_ncomp_notif(cq, wc_cnt) :
2721                 -ENOSYS;
2722 }
2723
2724 /**
2725  * ib_get_dma_mr - Returns a memory region for system memory that is
2726  *   usable for DMA.
2727  * @pd: The protection domain associated with the memory region.
2728  * @mr_access_flags: Specifies the memory access rights.
2729  *
2730  * Note that the ib_dma_*() functions defined below must be used
2731  * to create/destroy addresses used with the Lkey or Rkey returned
2732  * by ib_get_dma_mr().
2733  */
2734 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
2735
2736 /**
2737  * ib_dma_mapping_error - check a DMA addr for error
2738  * @dev: The device for which the dma_addr was created
2739  * @dma_addr: The DMA address to check
2740  */
2741 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
2742 {
2743         if (dev->dma_ops)
2744                 return dev->dma_ops->mapping_error(dev, dma_addr);
2745         return dma_mapping_error(dev->dma_device, dma_addr);
2746 }
2747
2748 /**
2749  * ib_dma_map_single - Map a kernel virtual address to DMA address
2750  * @dev: The device for which the dma_addr is to be created
2751  * @cpu_addr: The kernel virtual address
2752  * @size: The size of the region in bytes
2753  * @direction: The direction of the DMA
2754  */
2755 static inline u64 ib_dma_map_single(struct ib_device *dev,
2756                                     void *cpu_addr, size_t size,
2757                                     enum dma_data_direction direction)
2758 {
2759         if (dev->dma_ops)
2760                 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
2761         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
2762 }
2763
2764 /**
2765  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
2766  * @dev: The device for which the DMA address was created
2767  * @addr: The DMA address
2768  * @size: The size of the region in bytes
2769  * @direction: The direction of the DMA
2770  */
2771 static inline void ib_dma_unmap_single(struct ib_device *dev,
2772                                        u64 addr, size_t size,
2773                                        enum dma_data_direction direction)
2774 {
2775         if (dev->dma_ops)
2776                 dev->dma_ops->unmap_single(dev, addr, size, direction);
2777         else
2778                 dma_unmap_single(dev->dma_device, addr, size, direction);
2779 }
2780
2781 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
2782                                           void *cpu_addr, size_t size,
2783                                           enum dma_data_direction direction,
2784                                           struct dma_attrs *attrs)
2785 {
2786         return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
2787                                     direction, attrs);
2788 }
2789
2790 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
2791                                              u64 addr, size_t size,
2792                                              enum dma_data_direction direction,
2793                                              struct dma_attrs *attrs)
2794 {
2795         return dma_unmap_single_attrs(dev->dma_device, addr, size,
2796                                       direction, attrs);
2797 }
2798
2799 /**
2800  * ib_dma_map_page - Map a physical page to DMA address
2801  * @dev: The device for which the dma_addr is to be created
2802  * @page: The page to be mapped
2803  * @offset: The offset within the page
2804  * @size: The size of the region in bytes
2805  * @direction: The direction of the DMA
2806  */
2807 static inline u64 ib_dma_map_page(struct ib_device *dev,
2808                                   struct page *page,
2809                                   unsigned long offset,
2810                                   size_t size,
2811                                          enum dma_data_direction direction)
2812 {
2813         if (dev->dma_ops)
2814                 return dev->dma_ops->map_page(dev, page, offset, size, direction);
2815         return dma_map_page(dev->dma_device, page, offset, size, direction);
2816 }
2817
2818 /**
2819  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
2820  * @dev: The device for which the DMA address was created
2821  * @addr: The DMA address
2822  * @size: The size of the region in bytes
2823  * @direction: The direction of the DMA
2824  */
2825 static inline void ib_dma_unmap_page(struct ib_device *dev,
2826                                      u64 addr, size_t size,
2827                                      enum dma_data_direction direction)
2828 {
2829         if (dev->dma_ops)
2830                 dev->dma_ops->unmap_page(dev, addr, size, direction);
2831         else
2832                 dma_unmap_page(dev->dma_device, addr, size, direction);
2833 }
2834
2835 /**
2836  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
2837  * @dev: The device for which the DMA addresses are to be created
2838  * @sg: The array of scatter/gather entries
2839  * @nents: The number of scatter/gather entries
2840  * @direction: The direction of the DMA
2841  */
2842 static inline int ib_dma_map_sg(struct ib_device *dev,
2843                                 struct scatterlist *sg, int nents,
2844                                 enum dma_data_direction direction)
2845 {
2846         if (dev->dma_ops)
2847                 return dev->dma_ops->map_sg(dev, sg, nents, direction);
2848         return dma_map_sg(dev->dma_device, sg, nents, direction);
2849 }
2850
2851 /**
2852  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
2853  * @dev: The device for which the DMA addresses were created
2854  * @sg: The array of scatter/gather entries
2855  * @nents: The number of scatter/gather entries
2856  * @direction: The direction of the DMA
2857  */
2858 static inline void ib_dma_unmap_sg(struct ib_device *dev,
2859                                    struct scatterlist *sg, int nents,
2860                                    enum dma_data_direction direction)
2861 {
2862         if (dev->dma_ops)
2863                 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
2864         else
2865                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
2866 }
2867
2868 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
2869                                       struct scatterlist *sg, int nents,
2870                                       enum dma_data_direction direction,
2871                                       struct dma_attrs *attrs)
2872 {
2873         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
2874 }
2875
2876 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
2877                                          struct scatterlist *sg, int nents,
2878                                          enum dma_data_direction direction,
2879                                          struct dma_attrs *attrs)
2880 {
2881         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
2882 }
2883 /**
2884  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
2885  * @dev: The device for which the DMA addresses were created
2886  * @sg: The scatter/gather entry
2887  *
2888  * Note: this function is obsolete. To do: change all occurrences of
2889  * ib_sg_dma_address() into sg_dma_address().
2890  */
2891 static inline u64 ib_sg_dma_address(struct ib_device *dev,
2892                                     struct scatterlist *sg)
2893 {
2894         return sg_dma_address(sg);
2895 }
2896
2897 /**
2898  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
2899  * @dev: The device for which the DMA addresses were created
2900  * @sg: The scatter/gather entry
2901  *
2902  * Note: this function is obsolete. To do: change all occurrences of
2903  * ib_sg_dma_len() into sg_dma_len().
2904  */
2905 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
2906                                          struct scatterlist *sg)
2907 {
2908         return sg_dma_len(sg);
2909 }
2910
2911 /**
2912  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
2913  * @dev: The device for which the DMA address was created
2914  * @addr: The DMA address
2915  * @size: The size of the region in bytes
2916  * @dir: The direction of the DMA
2917  */
2918 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
2919                                               u64 addr,
2920                                               size_t size,
2921                                               enum dma_data_direction dir)
2922 {
2923         if (dev->dma_ops)
2924                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
2925         else
2926                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
2927 }
2928
2929 /**
2930  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
2931  * @dev: The device for which the DMA address was created
2932  * @addr: The DMA address
2933  * @size: The size of the region in bytes
2934  * @dir: The direction of the DMA
2935  */
2936 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
2937                                                  u64 addr,
2938                                                  size_t size,
2939                                                  enum dma_data_direction dir)
2940 {
2941         if (dev->dma_ops)
2942                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
2943         else
2944                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
2945 }
2946
2947 /**
2948  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
2949  * @dev: The device for which the DMA address is requested
2950  * @size: The size of the region to allocate in bytes
2951  * @dma_handle: A pointer for returning the DMA address of the region
2952  * @flag: memory allocator flags
2953  */
2954 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
2955                                            size_t size,
2956                                            u64 *dma_handle,
2957                                            gfp_t flag)
2958 {
2959         if (dev->dma_ops)
2960                 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
2961         else {
2962                 dma_addr_t handle;
2963                 void *ret;
2964
2965                 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
2966                 *dma_handle = handle;
2967                 return ret;
2968         }
2969 }
2970
2971 /**
2972  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
2973  * @dev: The device for which the DMA addresses were allocated
2974  * @size: The size of the region
2975  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
2976  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
2977  */
2978 static inline void ib_dma_free_coherent(struct ib_device *dev,
2979                                         size_t size, void *cpu_addr,
2980                                         u64 dma_handle)
2981 {
2982         if (dev->dma_ops)
2983                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
2984         else
2985                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
2986 }
2987
2988 /**
2989  * ib_dereg_mr - Deregisters a memory region and removes it from the
2990  *   HCA translation table.
2991  * @mr: The memory region to deregister.
2992  *
2993  * This function can fail, if the memory region has memory windows bound to it.
2994  */
2995 int ib_dereg_mr(struct ib_mr *mr);
2996
2997 struct ib_mr *ib_alloc_mr(struct ib_pd *pd,
2998                           enum ib_mr_type mr_type,
2999                           u32 max_num_sg);
3000
3001 /**
3002  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
3003  *   R_Key and L_Key.
3004  * @mr - struct ib_mr pointer to be updated.
3005  * @newkey - new key to be used.
3006  */
3007 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
3008 {
3009         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
3010         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
3011 }
3012
3013 /**
3014  * ib_inc_rkey - increments the key portion of the given rkey. Can be used
3015  * for calculating a new rkey for type 2 memory windows.
3016  * @rkey - the rkey to increment.
3017  */
3018 static inline u32 ib_inc_rkey(u32 rkey)
3019 {
3020         const u32 mask = 0x000000ff;
3021         return ((rkey + 1) & mask) | (rkey & ~mask);
3022 }
3023
3024 /**
3025  * ib_alloc_fmr - Allocates a unmapped fast memory region.
3026  * @pd: The protection domain associated with the unmapped region.
3027  * @mr_access_flags: Specifies the memory access rights.
3028  * @fmr_attr: Attributes of the unmapped region.
3029  *
3030  * A fast memory region must be mapped before it can be used as part of
3031  * a work request.
3032  */
3033 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
3034                             int mr_access_flags,
3035                             struct ib_fmr_attr *fmr_attr);
3036
3037 /**
3038  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
3039  * @fmr: The fast memory region to associate with the pages.
3040  * @page_list: An array of physical pages to map to the fast memory region.
3041  * @list_len: The number of pages in page_list.
3042  * @iova: The I/O virtual address to use with the mapped region.
3043  */
3044 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
3045                                   u64 *page_list, int list_len,
3046                                   u64 iova)
3047 {
3048         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
3049 }
3050
3051 /**
3052  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
3053  * @fmr_list: A linked list of fast memory regions to unmap.
3054  */
3055 int ib_unmap_fmr(struct list_head *fmr_list);
3056
3057 /**
3058  * ib_dealloc_fmr - Deallocates a fast memory region.
3059  * @fmr: The fast memory region to deallocate.
3060  */
3061 int ib_dealloc_fmr(struct ib_fmr *fmr);
3062
3063 /**
3064  * ib_attach_mcast - Attaches the specified QP to a multicast group.
3065  * @qp: QP to attach to the multicast group.  The QP must be type
3066  *   IB_QPT_UD.
3067  * @gid: Multicast group GID.
3068  * @lid: Multicast group LID in host byte order.
3069  *
3070  * In order to send and receive multicast packets, subnet
3071  * administration must have created the multicast group and configured
3072  * the fabric appropriately.  The port associated with the specified
3073  * QP must also be a member of the multicast group.
3074  */
3075 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
3076
3077 /**
3078  * ib_detach_mcast - Detaches the specified QP from a multicast group.
3079  * @qp: QP to detach from the multicast group.
3080  * @gid: Multicast group GID.
3081  * @lid: Multicast group LID in host byte order.
3082  */
3083 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
3084
3085 /**
3086  * ib_alloc_xrcd - Allocates an XRC domain.
3087  * @device: The device on which to allocate the XRC domain.
3088  */
3089 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
3090
3091 /**
3092  * ib_dealloc_xrcd - Deallocates an XRC domain.
3093  * @xrcd: The XRC domain to deallocate.
3094  */
3095 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
3096
3097 struct ib_flow *ib_create_flow(struct ib_qp *qp,
3098                                struct ib_flow_attr *flow_attr, int domain);
3099 int ib_destroy_flow(struct ib_flow *flow_id);
3100
3101 static inline int ib_check_mr_access(int flags)
3102 {
3103         /*
3104          * Local write permission is required if remote write or
3105          * remote atomic permission is also requested.
3106          */
3107         if (flags & (IB_ACCESS_REMOTE_ATOMIC | IB_ACCESS_REMOTE_WRITE) &&
3108             !(flags & IB_ACCESS_LOCAL_WRITE))
3109                 return -EINVAL;
3110
3111         return 0;
3112 }
3113
3114 /**
3115  * ib_check_mr_status: lightweight check of MR status.
3116  *     This routine may provide status checks on a selected
3117  *     ib_mr. first use is for signature status check.
3118  *
3119  * @mr: A memory region.
3120  * @check_mask: Bitmask of which checks to perform from
3121  *     ib_mr_status_check enumeration.
3122  * @mr_status: The container of relevant status checks.
3123  *     failed checks will be indicated in the status bitmask
3124  *     and the relevant info shall be in the error item.
3125  */
3126 int ib_check_mr_status(struct ib_mr *mr, u32 check_mask,
3127                        struct ib_mr_status *mr_status);
3128
3129 struct net_device *ib_get_net_dev_by_params(struct ib_device *dev, u8 port,
3130                                             u16 pkey, const union ib_gid *gid,
3131                                             const struct sockaddr *addr);
3132
3133 int ib_map_mr_sg(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
3134                 unsigned int sg_offset, unsigned int page_size);
3135
3136 static inline int
3137 ib_map_mr_sg_zbva(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
3138                 unsigned int sg_offset, unsigned int page_size)
3139 {
3140         int n;
3141
3142         n = ib_map_mr_sg(mr, sg, sg_nents, sg_offset, page_size);
3143         mr->iova = 0;
3144
3145         return n;
3146 }
3147
3148 int ib_sg_to_pages(struct ib_mr *mr, struct scatterlist *sgl, int sg_nents,
3149                 unsigned int sg_offset, int (*set_page)(struct ib_mr *, u64));
3150
3151 void ib_drain_rq(struct ib_qp *qp);
3152 void ib_drain_sq(struct ib_qp *qp);
3153 void ib_drain_qp(struct ib_qp *qp);
3154 #endif /* IB_VERBS_H */