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/dma-mapping.h>
  45 #include <linux/kref.h>
  46 #include <linux/list.h>
  47 #include <linux/rwsem.h>
  48 #include <linux/workqueue.h>
  49 #include <linux/irq_poll.h>
  50 #include <uapi/linux/if_ether.h>
  51 #include <net/ipv6.h>
  52 #include <net/ip.h>
  53 #include <linux/string.h>
  54 #include <linux/slab.h>
  55 #include <linux/netdevice.h>
  56 #include <linux/refcount.h>
  57 #include <linux/if_link.h>
  58 #include <linux/atomic.h>
  59 #include <linux/mmu_notifier.h>
  60 #include <linux/uaccess.h>
  61 #include <linux/cgroup_rdma.h>
  62 #include <linux/irqflags.h>
  63 #include <linux/preempt.h>
  64 #include <linux/dim.h>
  65 #include <uapi/rdma/ib_user_verbs.h>
  66 #include <rdma/rdma_counter.h>
  67 #include <rdma/restrack.h>
  68 #include <rdma/signature.h>
  69 #include <uapi/rdma/rdma_user_ioctl.h>
  70 #include <uapi/rdma/ib_user_ioctl_verbs.h>
  71
  72 #define IB_FW_VERSION_NAME_MAX  ETHTOOL_FWVERS_LEN
  73
  74 struct ib_umem_odp;
  75 struct ib_uqp_object;
  76 struct ib_usrq_object;
  77 struct ib_uwq_object;
  78
  79 extern struct workqueue_struct *ib_wq;
  80 extern struct workqueue_struct *ib_comp_wq;
  81 extern struct workqueue_struct *ib_comp_unbound_wq;
  82
  83 struct ib_ucq_object;
  84
  85 __printf(3, 4) __cold
  86 void ibdev_printk(const char *level, const struct ib_device *ibdev,
  87                   const char *format, ...);
  88 __printf(2, 3) __cold
  89 void ibdev_emerg(const struct ib_device *ibdev, const char *format, ...);
  90 __printf(2, 3) __cold
  91 void ibdev_alert(const struct ib_device *ibdev, const char *format, ...);
  92 __printf(2, 3) __cold
  93 void ibdev_crit(const struct ib_device *ibdev, const char *format, ...);
  94 __printf(2, 3) __cold
  95 void ibdev_err(const struct ib_device *ibdev, const char *format, ...);
  96 __printf(2, 3) __cold
  97 void ibdev_warn(const struct ib_device *ibdev, const char *format, ...);
  98 __printf(2, 3) __cold
  99 void ibdev_notice(const struct ib_device *ibdev, const char *format, ...);
 100 __printf(2, 3) __cold
 101 void ibdev_info(const struct ib_device *ibdev, const char *format, ...);
 102
 103 #if defined(CONFIG_DYNAMIC_DEBUG)
 104 #define ibdev_dbg(__dev, format, args...)                       \
 105         dynamic_ibdev_dbg(__dev, format, ##args)
 106 #else
 107 __printf(2, 3) __cold
 108 static inline
 109 void ibdev_dbg(const struct ib_device *ibdev, const char *format, ...) {}
 110 #endif
 111
 112 #define ibdev_level_ratelimited(ibdev_level, ibdev, fmt, ...)           \
 113 do {                                                                    \
 114         static DEFINE_RATELIMIT_STATE(_rs,                              \
 115                                       DEFAULT_RATELIMIT_INTERVAL,       \
 116                                       DEFAULT_RATELIMIT_BURST);         \
 117         if (__ratelimit(&_rs))                                          \
 118                 ibdev_level(ibdev, fmt, ##__VA_ARGS__);                 \
 119 } while (0)
 120
 121 #define ibdev_emerg_ratelimited(ibdev, fmt, ...) \
 122         ibdev_level_ratelimited(ibdev_emerg, ibdev, fmt, ##__VA_ARGS__)
 123 #define ibdev_alert_ratelimited(ibdev, fmt, ...) \
 124         ibdev_level_ratelimited(ibdev_alert, ibdev, fmt, ##__VA_ARGS__)
 125 #define ibdev_crit_ratelimited(ibdev, fmt, ...) \
 126         ibdev_level_ratelimited(ibdev_crit, ibdev, fmt, ##__VA_ARGS__)
 127 #define ibdev_err_ratelimited(ibdev, fmt, ...) \
 128         ibdev_level_ratelimited(ibdev_err, ibdev, fmt, ##__VA_ARGS__)
 129 #define ibdev_warn_ratelimited(ibdev, fmt, ...) \
 130         ibdev_level_ratelimited(ibdev_warn, ibdev, fmt, ##__VA_ARGS__)
 131 #define ibdev_notice_ratelimited(ibdev, fmt, ...) \
 132         ibdev_level_ratelimited(ibdev_notice, ibdev, fmt, ##__VA_ARGS__)
 133 #define ibdev_info_ratelimited(ibdev, fmt, ...) \
 134         ibdev_level_ratelimited(ibdev_info, ibdev, fmt, ##__VA_ARGS__)
 135
 136 #if defined(CONFIG_DYNAMIC_DEBUG)
 137 /* descriptor check is first to prevent flooding with "callbacks suppressed" */
 138 #define ibdev_dbg_ratelimited(ibdev, fmt, ...)                          \
 139 do {                                                                    \
 140         static DEFINE_RATELIMIT_STATE(_rs,                              \
 141                                       DEFAULT_RATELIMIT_INTERVAL,       \
 142                                       DEFAULT_RATELIMIT_BURST);         \
 143         DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);                 \
 144         if (DYNAMIC_DEBUG_BRANCH(descriptor) && __ratelimit(&_rs))      \
 145                 __dynamic_ibdev_dbg(&descriptor, ibdev, fmt,            \
 146                                     ##__VA_ARGS__);                     \
 147 } while (0)
 148 #else
 149 __printf(2, 3) __cold
 150 static inline
 151 void ibdev_dbg_ratelimited(const struct ib_device *ibdev, const char *format, ...) {}
 152 #endif
 153
 154 union ib_gid {
 155         u8      raw[16];
 156         struct {
 157                 __be64  subnet_prefix;
 158                 __be64  interface_id;
 159         } global;
 160 };
 161
 162 extern union ib_gid zgid;
 163
 164 enum ib_gid_type {
 165         /* If link layer is Ethernet, this is RoCE V1 */
 166         IB_GID_TYPE_IB        = 0,
 167         IB_GID_TYPE_ROCE      = 0,
 168         IB_GID_TYPE_ROCE_UDP_ENCAP = 1,
 169         IB_GID_TYPE_SIZE
 170 };
 171
 172 #define ROCE_V2_UDP_DPORT      4791
 173 struct ib_gid_attr {
 174         struct net_device __rcu *ndev;
 175         struct ib_device        *device;
 176         union ib_gid            gid;
 177         enum ib_gid_type        gid_type;
 178         u16                     index;
 179         u8                      port_num;
 180 };
 181
 182 enum {
 183         /* set the local administered indication */
 184         IB_SA_WELL_KNOWN_GUID   = BIT_ULL(57) | 2,
 185 };
 186
 187 enum rdma_transport_type {
 188         RDMA_TRANSPORT_IB,
 189         RDMA_TRANSPORT_IWARP,
 190         RDMA_TRANSPORT_USNIC,
 191         RDMA_TRANSPORT_USNIC_UDP,
 192         RDMA_TRANSPORT_UNSPECIFIED,
 193 };
 194
 195 enum rdma_protocol_type {
 196         RDMA_PROTOCOL_IB,
 197         RDMA_PROTOCOL_IBOE,
 198         RDMA_PROTOCOL_IWARP,
 199         RDMA_PROTOCOL_USNIC_UDP
 200 };
 201
 202 __attribute_const__ enum rdma_transport_type
 203 rdma_node_get_transport(unsigned int node_type);
 204
 205 enum rdma_network_type {
 206         RDMA_NETWORK_IB,
 207         RDMA_NETWORK_ROCE_V1 = RDMA_NETWORK_IB,
 208         RDMA_NETWORK_IPV4,
 209         RDMA_NETWORK_IPV6
 210 };
 211
 212 static inline enum ib_gid_type ib_network_to_gid_type(enum rdma_network_type network_type)
 213 {
 214         if (network_type == RDMA_NETWORK_IPV4 ||
 215             network_type == RDMA_NETWORK_IPV6)
 216                 return IB_GID_TYPE_ROCE_UDP_ENCAP;
 217
 218         /* IB_GID_TYPE_IB same as RDMA_NETWORK_ROCE_V1 */
 219         return IB_GID_TYPE_IB;
 220 }
 221
 222 static inline enum rdma_network_type
 223 rdma_gid_attr_network_type(const struct ib_gid_attr *attr)
 224 {
 225         if (attr->gid_type == IB_GID_TYPE_IB)
 226                 return RDMA_NETWORK_IB;
 227
 228         if (ipv6_addr_v4mapped((struct in6_addr *)&attr->gid))
 229                 return RDMA_NETWORK_IPV4;
 230         else
 231                 return RDMA_NETWORK_IPV6;
 232 }
 233
 234 enum rdma_link_layer {
 235         IB_LINK_LAYER_UNSPECIFIED,
 236         IB_LINK_LAYER_INFINIBAND,
 237         IB_LINK_LAYER_ETHERNET,
 238 };
 239
 240 enum ib_device_cap_flags {
 241         IB_DEVICE_RESIZE_MAX_WR                 = (1 << 0),
 242         IB_DEVICE_BAD_PKEY_CNTR                 = (1 << 1),
 243         IB_DEVICE_BAD_QKEY_CNTR                 = (1 << 2),
 244         IB_DEVICE_RAW_MULTI                     = (1 << 3),
 245         IB_DEVICE_AUTO_PATH_MIG                 = (1 << 4),
 246         IB_DEVICE_CHANGE_PHY_PORT               = (1 << 5),
 247         IB_DEVICE_UD_AV_PORT_ENFORCE            = (1 << 6),
 248         IB_DEVICE_CURR_QP_STATE_MOD             = (1 << 7),
 249         IB_DEVICE_SHUTDOWN_PORT                 = (1 << 8),
 250         /* Not in use, former INIT_TYPE         = (1 << 9),*/
 251         IB_DEVICE_PORT_ACTIVE_EVENT             = (1 << 10),
 252         IB_DEVICE_SYS_IMAGE_GUID                = (1 << 11),
 253         IB_DEVICE_RC_RNR_NAK_GEN                = (1 << 12),
 254         IB_DEVICE_SRQ_RESIZE                    = (1 << 13),
 255         IB_DEVICE_N_NOTIFY_CQ                   = (1 << 14),
 256
 257         /*
 258          * This device supports a per-device lkey or stag that can be
 259          * used without performing a memory registration for the local
 260          * memory.  Note that ULPs should never check this flag, but
 261          * instead of use the local_dma_lkey flag in the ib_pd structure,
 262          * which will always contain a usable lkey.
 263          */
 264         IB_DEVICE_LOCAL_DMA_LKEY                = (1 << 15),
 265         /* Reserved, old SEND_W_INV             = (1 << 16),*/
 266         IB_DEVICE_MEM_WINDOW                    = (1 << 17),
 267         /*
 268          * Devices should set IB_DEVICE_UD_IP_SUM if they support
 269          * insertion of UDP and TCP checksum on outgoing UD IPoIB
 270          * messages and can verify the validity of checksum for
 271          * incoming messages.  Setting this flag implies that the
 272          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
 273          */
 274         IB_DEVICE_UD_IP_CSUM                    = (1 << 18),
 275         IB_DEVICE_UD_TSO                        = (1 << 19),
 276         IB_DEVICE_XRC                           = (1 << 20),
 277
 278         /*
 279          * This device supports the IB "base memory management extension",
 280          * which includes support for fast registrations (IB_WR_REG_MR,
 281          * IB_WR_LOCAL_INV and IB_WR_SEND_WITH_INV verbs).  This flag should
 282          * also be set by any iWarp device which must support FRs to comply
 283          * to the iWarp verbs spec.  iWarp devices also support the
 284          * IB_WR_RDMA_READ_WITH_INV verb for RDMA READs that invalidate the
 285          * stag.
 286          */
 287         IB_DEVICE_MEM_MGT_EXTENSIONS            = (1 << 21),
 288         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK      = (1 << 22),
 289         IB_DEVICE_MEM_WINDOW_TYPE_2A            = (1 << 23),
 290         IB_DEVICE_MEM_WINDOW_TYPE_2B            = (1 << 24),
 291         IB_DEVICE_RC_IP_CSUM                    = (1 << 25),
 292         /* Deprecated. Please use IB_RAW_PACKET_CAP_IP_CSUM. */
 293         IB_DEVICE_RAW_IP_CSUM                   = (1 << 26),
 294         /*
 295          * Devices should set IB_DEVICE_CROSS_CHANNEL if they
 296          * support execution of WQEs that involve synchronization
 297          * of I/O operations with single completion queue managed
 298          * by hardware.
 299          */
 300         IB_DEVICE_CROSS_CHANNEL                 = (1 << 27),
 301         IB_DEVICE_MANAGED_FLOW_STEERING         = (1 << 29),
 302         IB_DEVICE_INTEGRITY_HANDOVER            = (1 << 30),
 303         IB_DEVICE_ON_DEMAND_PAGING              = (1ULL << 31),
 304         IB_DEVICE_SG_GAPS_REG                   = (1ULL << 32),
 305         IB_DEVICE_VIRTUAL_FUNCTION              = (1ULL << 33),
 306         /* Deprecated. Please use IB_RAW_PACKET_CAP_SCATTER_FCS. */
 307         IB_DEVICE_RAW_SCATTER_FCS               = (1ULL << 34),
 308         IB_DEVICE_RDMA_NETDEV_OPA_VNIC          = (1ULL << 35),
 309         /* The device supports padding incoming writes to cacheline. */
 310         IB_DEVICE_PCI_WRITE_END_PADDING         = (1ULL << 36),
 311         IB_DEVICE_ALLOW_USER_UNREG              = (1ULL << 37),
 312 };
 313
 314 enum ib_atomic_cap {
 315         IB_ATOMIC_NONE,
 316         IB_ATOMIC_HCA,
 317         IB_ATOMIC_GLOB
 318 };
 319
 320 enum ib_odp_general_cap_bits {
 321         IB_ODP_SUPPORT          = 1 << 0,
 322         IB_ODP_SUPPORT_IMPLICIT = 1 << 1,
 323 };
 324
 325 enum ib_odp_transport_cap_bits {
 326         IB_ODP_SUPPORT_SEND     = 1 << 0,
 327         IB_ODP_SUPPORT_RECV     = 1 << 1,
 328         IB_ODP_SUPPORT_WRITE    = 1 << 2,
 329         IB_ODP_SUPPORT_READ     = 1 << 3,
 330         IB_ODP_SUPPORT_ATOMIC   = 1 << 4,
 331         IB_ODP_SUPPORT_SRQ_RECV = 1 << 5,
 332 };
 333
 334 struct ib_odp_caps {
 335         uint64_t general_caps;
 336         struct {
 337                 uint32_t  rc_odp_caps;
 338                 uint32_t  uc_odp_caps;
 339                 uint32_t  ud_odp_caps;
 340                 uint32_t  xrc_odp_caps;
 341         } per_transport_caps;
 342 };
 343
 344 struct ib_rss_caps {
 345         /* Corresponding bit will be set if qp type from
 346          * 'enum ib_qp_type' is supported, e.g.
 347          * supported_qpts |= 1 << IB_QPT_UD
 348          */
 349         u32 supported_qpts;
 350         u32 max_rwq_indirection_tables;
 351         u32 max_rwq_indirection_table_size;
 352 };
 353
 354 enum ib_tm_cap_flags {
 355         /*  Support tag matching with rendezvous offload for RC transport */
 356         IB_TM_CAP_RNDV_RC = 1 << 0,
 357 };
 358
 359 struct ib_tm_caps {
 360         /* Max size of RNDV header */
 361         u32 max_rndv_hdr_size;
 362         /* Max number of entries in tag matching list */
 363         u32 max_num_tags;
 364         /* From enum ib_tm_cap_flags */
 365         u32 flags;
 366         /* Max number of outstanding list operations */
 367         u32 max_ops;
 368         /* Max number of SGE in tag matching entry */
 369         u32 max_sge;
 370 };
 371
 372 struct ib_cq_init_attr {
 373         unsigned int    cqe;
 374         u32             comp_vector;
 375         u32             flags;
 376 };
 377
 378 enum ib_cq_attr_mask {
 379         IB_CQ_MODERATE = 1 << 0,
 380 };
 381
 382 struct ib_cq_caps {
 383         u16     max_cq_moderation_count;
 384         u16     max_cq_moderation_period;
 385 };
 386
 387 struct ib_dm_mr_attr {
 388         u64             length;
 389         u64             offset;
 390         u32             access_flags;
 391 };
 392
 393 struct ib_dm_alloc_attr {
 394         u64     length;
 395         u32     alignment;
 396         u32     flags;
 397 };
 398
 399 struct ib_device_attr {
 400         u64                     fw_ver;
 401         __be64                  sys_image_guid;
 402         u64                     max_mr_size;
 403         u64                     page_size_cap;
 404         u32                     vendor_id;
 405         u32                     vendor_part_id;
 406         u32                     hw_ver;
 407         int                     max_qp;
 408         int                     max_qp_wr;
 409         u64                     device_cap_flags;
 410         int                     max_send_sge;
 411         int                     max_recv_sge;
 412         int                     max_sge_rd;
 413         int                     max_cq;
 414         int                     max_cqe;
 415         int                     max_mr;
 416         int                     max_pd;
 417         int                     max_qp_rd_atom;
 418         int                     max_ee_rd_atom;
 419         int                     max_res_rd_atom;
 420         int                     max_qp_init_rd_atom;
 421         int                     max_ee_init_rd_atom;
 422         enum ib_atomic_cap      atomic_cap;
 423         enum ib_atomic_cap      masked_atomic_cap;
 424         int                     max_ee;
 425         int                     max_rdd;
 426         int                     max_mw;
 427         int                     max_raw_ipv6_qp;
 428         int                     max_raw_ethy_qp;
 429         int                     max_mcast_grp;
 430         int                     max_mcast_qp_attach;
 431         int                     max_total_mcast_qp_attach;
 432         int                     max_ah;
 433         int                     max_fmr;
 434         int                     max_map_per_fmr;
 435         int                     max_srq;
 436         int                     max_srq_wr;
 437         int                     max_srq_sge;
 438         unsigned int            max_fast_reg_page_list_len;
 439         unsigned int            max_pi_fast_reg_page_list_len;
 440         u16                     max_pkeys;
 441         u8                      local_ca_ack_delay;
 442         int                     sig_prot_cap;
 443         int                     sig_guard_cap;
 444         struct ib_odp_caps      odp_caps;
 445         uint64_t                timestamp_mask;
 446         uint64_t                hca_core_clock; /* in KHZ */
 447         struct ib_rss_caps      rss_caps;
 448         u32                     max_wq_type_rq;
 449         u32                     raw_packet_caps; /* Use ib_raw_packet_caps enum */
 450         struct ib_tm_caps       tm_caps;
 451         struct ib_cq_caps       cq_caps;
 452         u64                     max_dm_size;
 453         /* Max entries for sgl for optimized performance per READ */
 454         u32                     max_sgl_rd;
 455 };
 456
 457 enum ib_mtu {
 458         IB_MTU_256  = 1,
 459         IB_MTU_512  = 2,
 460         IB_MTU_1024 = 3,
 461         IB_MTU_2048 = 4,
 462         IB_MTU_4096 = 5
 463 };
 464
 465 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 466 {
 467         switch (mtu) {
 468         case IB_MTU_256:  return  256;
 469         case IB_MTU_512:  return  512;
 470         case IB_MTU_1024: return 1024;
 471         case IB_MTU_2048: return 2048;
 472         case IB_MTU_4096: return 4096;
 473         default:          return -1;
 474         }
 475 }
 476
 477 static inline enum ib_mtu ib_mtu_int_to_enum(int mtu)
 478 {
 479         if (mtu >= 4096)
 480                 return IB_MTU_4096;
 481         else if (mtu >= 2048)
 482                 return IB_MTU_2048;
 483         else if (mtu >= 1024)
 484                 return IB_MTU_1024;
 485         else if (mtu >= 512)
 486                 return IB_MTU_512;
 487         else
 488                 return IB_MTU_256;
 489 }
 490
 491 enum ib_port_state {
 492         IB_PORT_NOP             = 0,
 493         IB_PORT_DOWN            = 1,
 494         IB_PORT_INIT            = 2,
 495         IB_PORT_ARMED           = 3,
 496         IB_PORT_ACTIVE          = 4,
 497         IB_PORT_ACTIVE_DEFER    = 5
 498 };
 499
 500 enum ib_port_phys_state {
 501         IB_PORT_PHYS_STATE_SLEEP = 1,
 502         IB_PORT_PHYS_STATE_POLLING = 2,
 503         IB_PORT_PHYS_STATE_DISABLED = 3,
 504         IB_PORT_PHYS_STATE_PORT_CONFIGURATION_TRAINING = 4,
 505         IB_PORT_PHYS_STATE_LINK_UP = 5,
 506         IB_PORT_PHYS_STATE_LINK_ERROR_RECOVERY = 6,
 507         IB_PORT_PHYS_STATE_PHY_TEST = 7,
 508 };
 509
 510 enum ib_port_width {
 511         IB_WIDTH_1X     = 1,
 512         IB_WIDTH_2X     = 16,
 513         IB_WIDTH_4X     = 2,
 514         IB_WIDTH_8X     = 4,
 515         IB_WIDTH_12X    = 8
 516 };
 517
 518 static inline int ib_width_enum_to_int(enum ib_port_width width)
 519 {
 520         switch (width) {
 521         case IB_WIDTH_1X:  return  1;
 522         case IB_WIDTH_2X:  return  2;
 523         case IB_WIDTH_4X:  return  4;
 524         case IB_WIDTH_8X:  return  8;
 525         case IB_WIDTH_12X: return 12;
 526         default:          return -1;
 527         }
 528 }
 529
 530 enum ib_port_speed {
 531         IB_SPEED_SDR    = 1,
 532         IB_SPEED_DDR    = 2,
 533         IB_SPEED_QDR    = 4,
 534         IB_SPEED_FDR10  = 8,
 535         IB_SPEED_FDR    = 16,
 536         IB_SPEED_EDR    = 32,
 537         IB_SPEED_HDR    = 64
 538 };
 539
 540 /**
 541  * struct rdma_hw_stats
 542  * @lock - Mutex to protect parallel write access to lifespan and values
 543  *    of counters, which are 64bits and not guaranteeed to be written
 544  *    atomicaly on 32bits systems.
 545  * @timestamp - Used by the core code to track when the last update was
 546  * @lifespan - Used by the core code to determine how old the counters
 547  *   should be before being updated again.  Stored in jiffies, defaults
 548  *   to 10 milliseconds, drivers can override the default be specifying
 549  *   their own value during their allocation routine.
 550  * @name - Array of pointers to static names used for the counters in
 551  *   directory.
 552  * @num_counters - How many hardware counters there are.  If name is
 553  *   shorter than this number, a kernel oops will result.  Driver authors
 554  *   are encouraged to leave BUILD_BUG_ON(ARRAY_SIZE(@name) < num_counters)
 555  *   in their code to prevent this.
 556  * @value - Array of u64 counters that are accessed by the sysfs code and
 557  *   filled in by the drivers get_stats routine
 558  */
 559 struct rdma_hw_stats {
 560         struct mutex    lock; /* Protect lifespan and values[] */
 561         unsigned long   timestamp;
 562         unsigned long   lifespan;
 563         const char * const *names;
 564         int             num_counters;
 565         u64             value[];
 566 };
 567
 568 #define RDMA_HW_STATS_DEFAULT_LIFESPAN 10
 569 /**
 570  * rdma_alloc_hw_stats_struct - Helper function to allocate dynamic struct
 571  *   for drivers.
 572  * @names - Array of static const char *
 573  * @num_counters - How many elements in array
 574  * @lifespan - How many milliseconds between updates
 575  */
 576 static inline struct rdma_hw_stats *rdma_alloc_hw_stats_struct(
 577                 const char * const *names, int num_counters,
 578                 unsigned long lifespan)
 579 {
 580         struct rdma_hw_stats *stats;
 581
 582         stats = kzalloc(sizeof(*stats) + num_counters * sizeof(u64),
 583                         GFP_KERNEL);
 584         if (!stats)
 585                 return NULL;
 586         stats->names = names;
 587         stats->num_counters = num_counters;
 588         stats->lifespan = msecs_to_jiffies(lifespan);
 589
 590         return stats;
 591 }
 592
 593
 594 /* Define bits for the various functionality this port needs to be supported by
 595  * the core.
 596  */
 597 /* Management                           0x00000FFF */
 598 #define RDMA_CORE_CAP_IB_MAD            0x00000001
 599 #define RDMA_CORE_CAP_IB_SMI            0x00000002
 600 #define RDMA_CORE_CAP_IB_CM             0x00000004
 601 #define RDMA_CORE_CAP_IW_CM             0x00000008
 602 #define RDMA_CORE_CAP_IB_SA             0x00000010
 603 #define RDMA_CORE_CAP_OPA_MAD           0x00000020
 604
 605 /* Address format                       0x000FF000 */
 606 #define RDMA_CORE_CAP_AF_IB             0x00001000
 607 #define RDMA_CORE_CAP_ETH_AH            0x00002000
 608 #define RDMA_CORE_CAP_OPA_AH            0x00004000
 609 #define RDMA_CORE_CAP_IB_GRH_REQUIRED   0x00008000
 610
 611 /* Protocol                             0xFFF00000 */
 612 #define RDMA_CORE_CAP_PROT_IB           0x00100000
 613 #define RDMA_CORE_CAP_PROT_ROCE         0x00200000
 614 #define RDMA_CORE_CAP_PROT_IWARP        0x00400000
 615 #define RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP 0x00800000
 616 #define RDMA_CORE_CAP_PROT_RAW_PACKET   0x01000000
 617 #define RDMA_CORE_CAP_PROT_USNIC        0x02000000
 618
 619 #define RDMA_CORE_PORT_IB_GRH_REQUIRED (RDMA_CORE_CAP_IB_GRH_REQUIRED \
 620                                         | RDMA_CORE_CAP_PROT_ROCE     \
 621                                         | RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP)
 622
 623 #define RDMA_CORE_PORT_IBA_IB          (RDMA_CORE_CAP_PROT_IB  \
 624                                         | RDMA_CORE_CAP_IB_MAD \
 625                                         | RDMA_CORE_CAP_IB_SMI \
 626                                         | RDMA_CORE_CAP_IB_CM  \
 627                                         | RDMA_CORE_CAP_IB_SA  \
 628                                         | RDMA_CORE_CAP_AF_IB)
 629 #define RDMA_CORE_PORT_IBA_ROCE        (RDMA_CORE_CAP_PROT_ROCE \
 630                                         | RDMA_CORE_CAP_IB_MAD  \
 631                                         | RDMA_CORE_CAP_IB_CM   \
 632                                         | RDMA_CORE_CAP_AF_IB   \
 633                                         | RDMA_CORE_CAP_ETH_AH)
 634 #define RDMA_CORE_PORT_IBA_ROCE_UDP_ENCAP                       \
 635                                         (RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP \
 636                                         | RDMA_CORE_CAP_IB_MAD  \
 637                                         | RDMA_CORE_CAP_IB_CM   \
 638                                         | RDMA_CORE_CAP_AF_IB   \
 639                                         | RDMA_CORE_CAP_ETH_AH)
 640 #define RDMA_CORE_PORT_IWARP           (RDMA_CORE_CAP_PROT_IWARP \
 641                                         | RDMA_CORE_CAP_IW_CM)
 642 #define RDMA_CORE_PORT_INTEL_OPA       (RDMA_CORE_PORT_IBA_IB  \
 643                                         | RDMA_CORE_CAP_OPA_MAD)
 644
 645 #define RDMA_CORE_PORT_RAW_PACKET       (RDMA_CORE_CAP_PROT_RAW_PACKET)
 646
 647 #define RDMA_CORE_PORT_USNIC            (RDMA_CORE_CAP_PROT_USNIC)
 648
 649 struct ib_port_attr {
 650         u64                     subnet_prefix;
 651         enum ib_port_state      state;
 652         enum ib_mtu             max_mtu;
 653         enum ib_mtu             active_mtu;
 654         int                     gid_tbl_len;
 655         unsigned int            ip_gids:1;
 656         /* This is the value from PortInfo CapabilityMask, defined by IBA */
 657         u32                     port_cap_flags;
 658         u32                     max_msg_sz;
 659         u32                     bad_pkey_cntr;
 660         u32                     qkey_viol_cntr;
 661         u16                     pkey_tbl_len;
 662         u32                     sm_lid;
 663         u32                     lid;
 664         u8                      lmc;
 665         u8                      max_vl_num;
 666         u8                      sm_sl;
 667         u8                      subnet_timeout;
 668         u8                      init_type_reply;
 669         u8                      active_width;
 670         u8                      active_speed;
 671         u8                      phys_state;
 672         u16                     port_cap_flags2;
 673 };
 674
 675 enum ib_device_modify_flags {
 676         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
 677         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
 678 };
 679
 680 #define IB_DEVICE_NODE_DESC_MAX 64
 681
 682 struct ib_device_modify {
 683         u64     sys_image_guid;
 684         char    node_desc[IB_DEVICE_NODE_DESC_MAX];
 685 };
 686
 687 enum ib_port_modify_flags {
 688         IB_PORT_SHUTDOWN                = 1,
 689         IB_PORT_INIT_TYPE               = (1<<2),
 690         IB_PORT_RESET_QKEY_CNTR         = (1<<3),
 691         IB_PORT_OPA_MASK_CHG            = (1<<4)
 692 };
 693
 694 struct ib_port_modify {
 695         u32     set_port_cap_mask;
 696         u32     clr_port_cap_mask;
 697         u8      init_type;
 698 };
 699
 700 enum ib_event_type {
 701         IB_EVENT_CQ_ERR,
 702         IB_EVENT_QP_FATAL,
 703         IB_EVENT_QP_REQ_ERR,
 704         IB_EVENT_QP_ACCESS_ERR,
 705         IB_EVENT_COMM_EST,
 706         IB_EVENT_SQ_DRAINED,
 707         IB_EVENT_PATH_MIG,
 708         IB_EVENT_PATH_MIG_ERR,
 709         IB_EVENT_DEVICE_FATAL,
 710         IB_EVENT_PORT_ACTIVE,
 711         IB_EVENT_PORT_ERR,
 712         IB_EVENT_LID_CHANGE,
 713         IB_EVENT_PKEY_CHANGE,
 714         IB_EVENT_SM_CHANGE,
 715         IB_EVENT_SRQ_ERR,
 716         IB_EVENT_SRQ_LIMIT_REACHED,
 717         IB_EVENT_QP_LAST_WQE_REACHED,
 718         IB_EVENT_CLIENT_REREGISTER,
 719         IB_EVENT_GID_CHANGE,
 720         IB_EVENT_WQ_FATAL,
 721 };
 722
 723 const char *__attribute_const__ ib_event_msg(enum ib_event_type event);
 724
 725 struct ib_event {
 726         struct ib_device        *device;
 727         union {
 728                 struct ib_cq    *cq;
 729                 struct ib_qp    *qp;
 730                 struct ib_srq   *srq;
 731                 struct ib_wq    *wq;
 732                 u8              port_num;
 733         } element;
 734         enum ib_event_type      event;
 735 };
 736
 737 struct ib_event_handler {
 738         struct ib_device *device;
 739         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 740         struct list_head  list;
 741 };
 742
 743 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 744         do {                                                    \
 745                 (_ptr)->device  = _device;                      \
 746                 (_ptr)->handler = _handler;                     \
 747                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 748         } while (0)
 749
 750 struct ib_global_route {
 751         const struct ib_gid_attr *sgid_attr;
 752         union ib_gid    dgid;
 753         u32             flow_label;
 754         u8              sgid_index;
 755         u8              hop_limit;
 756         u8              traffic_class;
 757 };
 758
 759 struct ib_grh {
 760         __be32          version_tclass_flow;
 761         __be16          paylen;
 762         u8              next_hdr;
 763         u8              hop_limit;
 764         union ib_gid    sgid;
 765         union ib_gid    dgid;
 766 };
 767
 768 union rdma_network_hdr {
 769         struct ib_grh ibgrh;
 770         struct {
 771                 /* The IB spec states that if it's IPv4, the header
 772                  * is located in the last 20 bytes of the header.
 773                  */
 774                 u8              reserved[20];
 775                 struct iphdr    roce4grh;
 776         };
 777 };
 778
 779 #define IB_QPN_MASK             0xFFFFFF
 780
 781 enum {
 782         IB_MULTICAST_QPN = 0xffffff
 783 };
 784
 785 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
 786 #define IB_MULTICAST_LID_BASE   cpu_to_be16(0xC000)
 787
 788 enum ib_ah_flags {
 789         IB_AH_GRH       = 1
 790 };
 791
 792 enum ib_rate {
 793         IB_RATE_PORT_CURRENT = 0,
 794         IB_RATE_2_5_GBPS = 2,
 795         IB_RATE_5_GBPS   = 5,
 796         IB_RATE_10_GBPS  = 3,
 797         IB_RATE_20_GBPS  = 6,
 798         IB_RATE_30_GBPS  = 4,
 799         IB_RATE_40_GBPS  = 7,
 800         IB_RATE_60_GBPS  = 8,
 801         IB_RATE_80_GBPS  = 9,
 802         IB_RATE_120_GBPS = 10,
 803         IB_RATE_14_GBPS  = 11,
 804         IB_RATE_56_GBPS  = 12,
 805         IB_RATE_112_GBPS = 13,
 806         IB_RATE_168_GBPS = 14,
 807         IB_RATE_25_GBPS  = 15,
 808         IB_RATE_100_GBPS = 16,
 809         IB_RATE_200_GBPS = 17,
 810         IB_RATE_300_GBPS = 18,
 811         IB_RATE_28_GBPS  = 19,
 812         IB_RATE_50_GBPS  = 20,
 813         IB_RATE_400_GBPS = 21,
 814         IB_RATE_600_GBPS = 22,
 815 };
 816
 817 /**
 818  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
 819  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
 820  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
 821  * @rate: rate to convert.
 822  */
 823 __attribute_const__ int ib_rate_to_mult(enum ib_rate rate);
 824
 825 /**
 826  * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
 827  * For example, IB_RATE_2_5_GBPS will be converted to 2500.
 828  * @rate: rate to convert.
 829  */
 830 __attribute_const__ int ib_rate_to_mbps(enum ib_rate rate);
 831
 832
 833 /**
 834  * enum ib_mr_type - memory region type
 835  * @IB_MR_TYPE_MEM_REG:       memory region that is used for
 836  *                            normal registration
 837  * @IB_MR_TYPE_SG_GAPS:       memory region that is capable to
 838  *                            register any arbitrary sg lists (without
 839  *                            the normal mr constraints - see
 840  *                            ib_map_mr_sg)
 841  * @IB_MR_TYPE_DM:            memory region that is used for device
 842  *                            memory registration
 843  * @IB_MR_TYPE_USER:          memory region that is used for the user-space
 844  *                            application
 845  * @IB_MR_TYPE_DMA:           memory region that is used for DMA operations
 846  *                            without address translations (VA=PA)
 847  * @IB_MR_TYPE_INTEGRITY:     memory region that is used for
 848  *                            data integrity operations
 849  */
 850 enum ib_mr_type {
 851         IB_MR_TYPE_MEM_REG,
 852         IB_MR_TYPE_SG_GAPS,
 853         IB_MR_TYPE_DM,
 854         IB_MR_TYPE_USER,
 855         IB_MR_TYPE_DMA,
 856         IB_MR_TYPE_INTEGRITY,
 857 };
 858
 859 enum ib_mr_status_check {
 860         IB_MR_CHECK_SIG_STATUS = 1,
 861 };
 862
 863 /**
 864  * struct ib_mr_status - Memory region status container
 865  *
 866  * @fail_status: Bitmask of MR checks status. For each
 867  *     failed check a corresponding status bit is set.
 868  * @sig_err: Additional info for IB_MR_CEHCK_SIG_STATUS
 869  *     failure.
 870  */
 871 struct ib_mr_status {
 872         u32                 fail_status;
 873         struct ib_sig_err   sig_err;
 874 };
 875
 876 /**
 877  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
 878  * enum.
 879  * @mult: multiple to convert.
 880  */
 881 __attribute_const__ enum ib_rate mult_to_ib_rate(int mult);
 882
 883 enum rdma_ah_attr_type {
 884         RDMA_AH_ATTR_TYPE_UNDEFINED,
 885         RDMA_AH_ATTR_TYPE_IB,
 886         RDMA_AH_ATTR_TYPE_ROCE,
 887         RDMA_AH_ATTR_TYPE_OPA,
 888 };
 889
 890 struct ib_ah_attr {
 891         u16                     dlid;
 892         u8                      src_path_bits;
 893 };
 894
 895 struct roce_ah_attr {
 896         u8                      dmac[ETH_ALEN];
 897 };
 898
 899 struct opa_ah_attr {
 900         u32                     dlid;
 901         u8                      src_path_bits;
 902         bool                    make_grd;
 903 };
 904
 905 struct rdma_ah_attr {
 906         struct ib_global_route  grh;
 907         u8                      sl;
 908         u8                      static_rate;
 909         u8                      port_num;
 910         u8                      ah_flags;
 911         enum rdma_ah_attr_type type;
 912         union {
 913                 struct ib_ah_attr ib;
 914                 struct roce_ah_attr roce;
 915                 struct opa_ah_attr opa;
 916         };
 917 };
 918
 919 enum ib_wc_status {
 920         IB_WC_SUCCESS,
 921         IB_WC_LOC_LEN_ERR,
 922         IB_WC_LOC_QP_OP_ERR,
 923         IB_WC_LOC_EEC_OP_ERR,
 924         IB_WC_LOC_PROT_ERR,
 925         IB_WC_WR_FLUSH_ERR,
 926         IB_WC_MW_BIND_ERR,
 927         IB_WC_BAD_RESP_ERR,
 928         IB_WC_LOC_ACCESS_ERR,
 929         IB_WC_REM_INV_REQ_ERR,
 930         IB_WC_REM_ACCESS_ERR,
 931         IB_WC_REM_OP_ERR,
 932         IB_WC_RETRY_EXC_ERR,
 933         IB_WC_RNR_RETRY_EXC_ERR,
 934         IB_WC_LOC_RDD_VIOL_ERR,
 935         IB_WC_REM_INV_RD_REQ_ERR,
 936         IB_WC_REM_ABORT_ERR,
 937         IB_WC_INV_EECN_ERR,
 938         IB_WC_INV_EEC_STATE_ERR,
 939         IB_WC_FATAL_ERR,
 940         IB_WC_RESP_TIMEOUT_ERR,
 941         IB_WC_GENERAL_ERR
 942 };
 943
 944 const char *__attribute_const__ ib_wc_status_msg(enum ib_wc_status status);
 945
 946 enum ib_wc_opcode {
 947         IB_WC_SEND,
 948         IB_WC_RDMA_WRITE,
 949         IB_WC_RDMA_READ,
 950         IB_WC_COMP_SWAP,
 951         IB_WC_FETCH_ADD,
 952         IB_WC_LSO,
 953         IB_WC_LOCAL_INV,
 954         IB_WC_REG_MR,
 955         IB_WC_MASKED_COMP_SWAP,
 956         IB_WC_MASKED_FETCH_ADD,
 957 /*
 958  * Set value of IB_WC_RECV so consumers can test if a completion is a
 959  * receive by testing (opcode & IB_WC_RECV).
 960  */
 961         IB_WC_RECV                      = 1 << 7,
 962         IB_WC_RECV_RDMA_WITH_IMM
 963 };
 964
 965 enum ib_wc_flags {
 966         IB_WC_GRH               = 1,
 967         IB_WC_WITH_IMM          = (1<<1),
 968         IB_WC_WITH_INVALIDATE   = (1<<2),
 969         IB_WC_IP_CSUM_OK        = (1<<3),
 970         IB_WC_WITH_SMAC         = (1<<4),
 971         IB_WC_WITH_VLAN         = (1<<5),
 972         IB_WC_WITH_NETWORK_HDR_TYPE     = (1<<6),
 973 };
 974
 975 struct ib_wc {
 976         union {
 977                 u64             wr_id;
 978                 struct ib_cqe   *wr_cqe;
 979         };
 980         enum ib_wc_status       status;
 981         enum ib_wc_opcode       opcode;
 982         u32                     vendor_err;
 983         u32                     byte_len;
 984         struct ib_qp           *qp;
 985         union {
 986                 __be32          imm_data;
 987                 u32             invalidate_rkey;
 988         } ex;
 989         u32                     src_qp;
 990         u32                     slid;
 991         int                     wc_flags;
 992         u16                     pkey_index;
 993         u8                      sl;
 994         u8                      dlid_path_bits;
 995         u8                      port_num;       /* valid only for DR SMPs on switches */
 996         u8                      smac[ETH_ALEN];
 997         u16                     vlan_id;
 998         u8                      network_hdr_type;
 999 };
1000
1001 enum ib_cq_notify_flags {
1002         IB_CQ_SOLICITED                 = 1 << 0,
1003         IB_CQ_NEXT_COMP                 = 1 << 1,
1004         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
1005         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
1006 };
1007
1008 enum ib_srq_type {
1009         IB_SRQT_BASIC,
1010         IB_SRQT_XRC,
1011         IB_SRQT_TM,
1012 };
1013
1014 static inline bool ib_srq_has_cq(enum ib_srq_type srq_type)
1015 {
1016         return srq_type == IB_SRQT_XRC ||
1017                srq_type == IB_SRQT_TM;
1018 }
1019
1020 enum ib_srq_attr_mask {
1021         IB_SRQ_MAX_WR   = 1 << 0,
1022         IB_SRQ_LIMIT    = 1 << 1,
1023 };
1024
1025 struct ib_srq_attr {
1026         u32     max_wr;
1027         u32     max_sge;
1028         u32     srq_limit;
1029 };
1030
1031 struct ib_srq_init_attr {
1032         void                  (*event_handler)(struct ib_event *, void *);
1033         void                   *srq_context;
1034         struct ib_srq_attr      attr;
1035         enum ib_srq_type        srq_type;
1036
1037         struct {
1038                 struct ib_cq   *cq;
1039                 union {
1040                         struct {
1041                                 struct ib_xrcd *xrcd;
1042                         } xrc;
1043
1044                         struct {
1045                                 u32             max_num_tags;
1046                         } tag_matching;
1047                 };
1048         } ext;
1049 };
1050
1051 struct ib_qp_cap {
1052         u32     max_send_wr;
1053         u32     max_recv_wr;
1054         u32     max_send_sge;
1055         u32     max_recv_sge;
1056         u32     max_inline_data;
1057
1058         /*
1059          * Maximum number of rdma_rw_ctx structures in flight at a time.
1060          * ib_create_qp() will calculate the right amount of neededed WRs
1061          * and MRs based on this.
1062          */
1063         u32     max_rdma_ctxs;
1064 };
1065
1066 enum ib_sig_type {
1067         IB_SIGNAL_ALL_WR,
1068         IB_SIGNAL_REQ_WR
1069 };
1070
1071 enum ib_qp_type {
1072         /*
1073          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
1074          * here (and in that order) since the MAD layer uses them as
1075          * indices into a 2-entry table.
1076          */
1077         IB_QPT_SMI,
1078         IB_QPT_GSI,
1079
1080         IB_QPT_RC,
1081         IB_QPT_UC,
1082         IB_QPT_UD,
1083         IB_QPT_RAW_IPV6,
1084         IB_QPT_RAW_ETHERTYPE,
1085         IB_QPT_RAW_PACKET = 8,
1086         IB_QPT_XRC_INI = 9,
1087         IB_QPT_XRC_TGT,
1088         IB_QPT_MAX,
1089         IB_QPT_DRIVER = 0xFF,
1090         /* Reserve a range for qp types internal to the low level driver.
1091          * These qp types will not be visible at the IB core layer, so the
1092          * IB_QPT_MAX usages should not be affected in the core layer
1093          */
1094         IB_QPT_RESERVED1 = 0x1000,
1095         IB_QPT_RESERVED2,
1096         IB_QPT_RESERVED3,
1097         IB_QPT_RESERVED4,
1098         IB_QPT_RESERVED5,
1099         IB_QPT_RESERVED6,
1100         IB_QPT_RESERVED7,
1101         IB_QPT_RESERVED8,
1102         IB_QPT_RESERVED9,
1103         IB_QPT_RESERVED10,
1104 };
1105
1106 enum ib_qp_create_flags {
1107         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
1108         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
1109         IB_QP_CREATE_CROSS_CHANNEL              = 1 << 2,
1110         IB_QP_CREATE_MANAGED_SEND               = 1 << 3,
1111         IB_QP_CREATE_MANAGED_RECV               = 1 << 4,
1112         IB_QP_CREATE_NETIF_QP                   = 1 << 5,
1113         IB_QP_CREATE_INTEGRITY_EN               = 1 << 6,
1114         /* FREE                                 = 1 << 7, */
1115         IB_QP_CREATE_SCATTER_FCS                = 1 << 8,
1116         IB_QP_CREATE_CVLAN_STRIPPING            = 1 << 9,
1117         IB_QP_CREATE_SOURCE_QPN                 = 1 << 10,
1118         IB_QP_CREATE_PCI_WRITE_END_PADDING      = 1 << 11,
1119         /* reserve bits 26-31 for low level drivers' internal use */
1120         IB_QP_CREATE_RESERVED_START             = 1 << 26,
1121         IB_QP_CREATE_RESERVED_END               = 1 << 31,
1122 };
1123
1124 /*
1125  * Note: users may not call ib_close_qp or ib_destroy_qp from the event_handler
1126  * callback to destroy the passed in QP.
1127  */
1128
1129 struct ib_qp_init_attr {
1130         /* Consumer's event_handler callback must not block */
1131         void                  (*event_handler)(struct ib_event *, void *);
1132
1133         void                   *qp_context;
1134         struct ib_cq           *send_cq;
1135         struct ib_cq           *recv_cq;
1136         struct ib_srq          *srq;
1137         struct ib_xrcd         *xrcd;     /* XRC TGT QPs only */
1138         struct ib_qp_cap        cap;
1139         enum ib_sig_type        sq_sig_type;
1140         enum ib_qp_type         qp_type;
1141         u32                     create_flags;
1142
1143         /*
1144          * Only needed for special QP types, or when using the RW API.
1145          */
1146         u8                      port_num;
1147         struct ib_rwq_ind_table *rwq_ind_tbl;
1148         u32                     source_qpn;
1149 };
1150
1151 struct ib_qp_open_attr {
1152         void                  (*event_handler)(struct ib_event *, void *);
1153         void                   *qp_context;
1154         u32                     qp_num;
1155         enum ib_qp_type         qp_type;
1156 };
1157
1158 enum ib_rnr_timeout {
1159         IB_RNR_TIMER_655_36 =  0,
1160         IB_RNR_TIMER_000_01 =  1,
1161         IB_RNR_TIMER_000_02 =  2,
1162         IB_RNR_TIMER_000_03 =  3,
1163         IB_RNR_TIMER_000_04 =  4,
1164         IB_RNR_TIMER_000_06 =  5,
1165         IB_RNR_TIMER_000_08 =  6,
1166         IB_RNR_TIMER_000_12 =  7,
1167         IB_RNR_TIMER_000_16 =  8,
1168         IB_RNR_TIMER_000_24 =  9,
1169         IB_RNR_TIMER_000_32 = 10,
1170         IB_RNR_TIMER_000_48 = 11,
1171         IB_RNR_TIMER_000_64 = 12,
1172         IB_RNR_TIMER_000_96 = 13,
1173         IB_RNR_TIMER_001_28 = 14,
1174         IB_RNR_TIMER_001_92 = 15,
1175         IB_RNR_TIMER_002_56 = 16,
1176         IB_RNR_TIMER_003_84 = 17,
1177         IB_RNR_TIMER_005_12 = 18,
1178         IB_RNR_TIMER_007_68 = 19,
1179         IB_RNR_TIMER_010_24 = 20,
1180         IB_RNR_TIMER_015_36 = 21,
1181         IB_RNR_TIMER_020_48 = 22,
1182         IB_RNR_TIMER_030_72 = 23,
1183         IB_RNR_TIMER_040_96 = 24,
1184         IB_RNR_TIMER_061_44 = 25,
1185         IB_RNR_TIMER_081_92 = 26,
1186         IB_RNR_TIMER_122_88 = 27,
1187         IB_RNR_TIMER_163_84 = 28,
1188         IB_RNR_TIMER_245_76 = 29,
1189         IB_RNR_TIMER_327_68 = 30,
1190         IB_RNR_TIMER_491_52 = 31
1191 };
1192
1193 enum ib_qp_attr_mask {
1194         IB_QP_STATE                     = 1,
1195         IB_QP_CUR_STATE                 = (1<<1),
1196         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
1197         IB_QP_ACCESS_FLAGS              = (1<<3),
1198         IB_QP_PKEY_INDEX                = (1<<4),
1199         IB_QP_PORT                      = (1<<5),
1200         IB_QP_QKEY                      = (1<<6),
1201         IB_QP_AV                        = (1<<7),
1202         IB_QP_PATH_MTU                  = (1<<8),
1203         IB_QP_TIMEOUT                   = (1<<9),
1204         IB_QP_RETRY_CNT                 = (1<<10),
1205         IB_QP_RNR_RETRY                 = (1<<11),
1206         IB_QP_RQ_PSN                    = (1<<12),
1207         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
1208         IB_QP_ALT_PATH                  = (1<<14),
1209         IB_QP_MIN_RNR_TIMER             = (1<<15),
1210         IB_QP_SQ_PSN                    = (1<<16),
1211         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
1212         IB_QP_PATH_MIG_STATE            = (1<<18),
1213         IB_QP_CAP                       = (1<<19),
1214         IB_QP_DEST_QPN                  = (1<<20),
1215         IB_QP_RESERVED1                 = (1<<21),
1216         IB_QP_RESERVED2                 = (1<<22),
1217         IB_QP_RESERVED3                 = (1<<23),
1218         IB_QP_RESERVED4                 = (1<<24),
1219         IB_QP_RATE_LIMIT                = (1<<25),
1220 };
1221
1222 enum ib_qp_state {
1223         IB_QPS_RESET,
1224         IB_QPS_INIT,
1225         IB_QPS_RTR,
1226         IB_QPS_RTS,
1227         IB_QPS_SQD,
1228         IB_QPS_SQE,
1229         IB_QPS_ERR
1230 };
1231
1232 enum ib_mig_state {
1233         IB_MIG_MIGRATED,
1234         IB_MIG_REARM,
1235         IB_MIG_ARMED
1236 };
1237
1238 enum ib_mw_type {
1239         IB_MW_TYPE_1 = 1,
1240         IB_MW_TYPE_2 = 2
1241 };
1242
1243 struct ib_qp_attr {
1244         enum ib_qp_state        qp_state;
1245         enum ib_qp_state        cur_qp_state;
1246         enum ib_mtu             path_mtu;
1247         enum ib_mig_state       path_mig_state;
1248         u32                     qkey;
1249         u32                     rq_psn;
1250         u32                     sq_psn;
1251         u32                     dest_qp_num;
1252         int                     qp_access_flags;
1253         struct ib_qp_cap        cap;
1254         struct rdma_ah_attr     ah_attr;
1255         struct rdma_ah_attr     alt_ah_attr;
1256         u16                     pkey_index;
1257         u16                     alt_pkey_index;
1258         u8                      en_sqd_async_notify;
1259         u8                      sq_draining;
1260         u8                      max_rd_atomic;
1261         u8                      max_dest_rd_atomic;
1262         u8                      min_rnr_timer;
1263         u8                      port_num;
1264         u8                      timeout;
1265         u8                      retry_cnt;
1266         u8                      rnr_retry;
1267         u8                      alt_port_num;
1268         u8                      alt_timeout;
1269         u32                     rate_limit;
1270 };
1271
1272 enum ib_wr_opcode {
1273         /* These are shared with userspace */
1274         IB_WR_RDMA_WRITE = IB_UVERBS_WR_RDMA_WRITE,
1275         IB_WR_RDMA_WRITE_WITH_IMM = IB_UVERBS_WR_RDMA_WRITE_WITH_IMM,
1276         IB_WR_SEND = IB_UVERBS_WR_SEND,
1277         IB_WR_SEND_WITH_IMM = IB_UVERBS_WR_SEND_WITH_IMM,
1278         IB_WR_RDMA_READ = IB_UVERBS_WR_RDMA_READ,
1279         IB_WR_ATOMIC_CMP_AND_SWP = IB_UVERBS_WR_ATOMIC_CMP_AND_SWP,
1280         IB_WR_ATOMIC_FETCH_AND_ADD = IB_UVERBS_WR_ATOMIC_FETCH_AND_ADD,
1281         IB_WR_LSO = IB_UVERBS_WR_TSO,
1282         IB_WR_SEND_WITH_INV = IB_UVERBS_WR_SEND_WITH_INV,
1283         IB_WR_RDMA_READ_WITH_INV = IB_UVERBS_WR_RDMA_READ_WITH_INV,
1284         IB_WR_LOCAL_INV = IB_UVERBS_WR_LOCAL_INV,
1285         IB_WR_MASKED_ATOMIC_CMP_AND_SWP =
1286                 IB_UVERBS_WR_MASKED_ATOMIC_CMP_AND_SWP,
1287         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD =
1288                 IB_UVERBS_WR_MASKED_ATOMIC_FETCH_AND_ADD,
1289
1290         /* These are kernel only and can not be issued by userspace */
1291         IB_WR_REG_MR = 0x20,
1292         IB_WR_REG_MR_INTEGRITY,
1293
1294         /* reserve values for low level drivers' internal use.
1295          * These values will not be used at all in the ib core layer.
1296          */
1297         IB_WR_RESERVED1 = 0xf0,
1298         IB_WR_RESERVED2,
1299         IB_WR_RESERVED3,
1300         IB_WR_RESERVED4,
1301         IB_WR_RESERVED5,
1302         IB_WR_RESERVED6,
1303         IB_WR_RESERVED7,
1304         IB_WR_RESERVED8,
1305         IB_WR_RESERVED9,
1306         IB_WR_RESERVED10,
1307 };
1308
1309 enum ib_send_flags {
1310         IB_SEND_FENCE           = 1,
1311         IB_SEND_SIGNALED        = (1<<1),
1312         IB_SEND_SOLICITED       = (1<<2),
1313         IB_SEND_INLINE          = (1<<3),
1314         IB_SEND_IP_CSUM         = (1<<4),
1315
1316         /* reserve bits 26-31 for low level drivers' internal use */
1317         IB_SEND_RESERVED_START  = (1 << 26),
1318         IB_SEND_RESERVED_END    = (1 << 31),
1319 };
1320
1321 struct ib_sge {
1322         u64     addr;
1323         u32     length;
1324         u32     lkey;
1325 };
1326
1327 struct ib_cqe {
1328         void (*done)(struct ib_cq *cq, struct ib_wc *wc);
1329 };
1330
1331 struct ib_send_wr {
1332         struct ib_send_wr      *next;
1333         union {
1334                 u64             wr_id;
1335                 struct ib_cqe   *wr_cqe;
1336         };
1337         struct ib_sge          *sg_list;
1338         int                     num_sge;
1339         enum ib_wr_opcode       opcode;
1340         int                     send_flags;
1341         union {
1342                 __be32          imm_data;
1343                 u32             invalidate_rkey;
1344         } ex;
1345 };
1346
1347 struct ib_rdma_wr {
1348         struct ib_send_wr       wr;
1349         u64                     remote_addr;
1350         u32                     rkey;
1351 };
1352
1353 static inline const struct ib_rdma_wr *rdma_wr(const struct ib_send_wr *wr)
1354 {
1355         return container_of(wr, struct ib_rdma_wr, wr);
1356 }
1357
1358 struct ib_atomic_wr {
1359         struct ib_send_wr       wr;
1360         u64                     remote_addr;
1361         u64                     compare_add;
1362         u64                     swap;
1363         u64                     compare_add_mask;
1364         u64                     swap_mask;
1365         u32                     rkey;
1366 };
1367
1368 static inline const struct ib_atomic_wr *atomic_wr(const struct ib_send_wr *wr)
1369 {
1370         return container_of(wr, struct ib_atomic_wr, wr);
1371 }
1372
1373 struct ib_ud_wr {
1374         struct ib_send_wr       wr;
1375         struct ib_ah            *ah;
1376         void                    *header;
1377         int                     hlen;
1378         int                     mss;
1379         u32                     remote_qpn;
1380         u32                     remote_qkey;
1381         u16                     pkey_index; /* valid for GSI only */
1382         u8                      port_num;   /* valid for DR SMPs on switch only */
1383 };
1384
1385 static inline const struct ib_ud_wr *ud_wr(const struct ib_send_wr *wr)
1386 {
1387         return container_of(wr, struct ib_ud_wr, wr);
1388 }
1389
1390 struct ib_reg_wr {
1391         struct ib_send_wr       wr;
1392         struct ib_mr            *mr;
1393         u32                     key;
1394         int                     access;
1395 };
1396
1397 static inline const struct ib_reg_wr *reg_wr(const struct ib_send_wr *wr)
1398 {
1399         return container_of(wr, struct ib_reg_wr, wr);
1400 }
1401
1402 struct ib_recv_wr {
1403         struct ib_recv_wr      *next;
1404         union {
1405                 u64             wr_id;
1406                 struct ib_cqe   *wr_cqe;
1407         };
1408         struct ib_sge          *sg_list;
1409         int                     num_sge;
1410 };
1411
1412 enum ib_access_flags {
1413         IB_ACCESS_LOCAL_WRITE = IB_UVERBS_ACCESS_LOCAL_WRITE,
1414         IB_ACCESS_REMOTE_WRITE = IB_UVERBS_ACCESS_REMOTE_WRITE,
1415         IB_ACCESS_REMOTE_READ = IB_UVERBS_ACCESS_REMOTE_READ,
1416         IB_ACCESS_REMOTE_ATOMIC = IB_UVERBS_ACCESS_REMOTE_ATOMIC,
1417         IB_ACCESS_MW_BIND = IB_UVERBS_ACCESS_MW_BIND,
1418         IB_ZERO_BASED = IB_UVERBS_ACCESS_ZERO_BASED,
1419         IB_ACCESS_ON_DEMAND = IB_UVERBS_ACCESS_ON_DEMAND,
1420         IB_ACCESS_HUGETLB = IB_UVERBS_ACCESS_HUGETLB,
1421
1422         IB_ACCESS_SUPPORTED = ((IB_ACCESS_HUGETLB << 1) - 1)
1423 };
1424
1425 /*
1426  * XXX: these are apparently used for ->rereg_user_mr, no idea why they
1427  * are hidden here instead of a uapi header!
1428  */
1429 enum ib_mr_rereg_flags {
1430         IB_MR_REREG_TRANS       = 1,
1431         IB_MR_REREG_PD          = (1<<1),
1432         IB_MR_REREG_ACCESS      = (1<<2),
1433         IB_MR_REREG_SUPPORTED   = ((IB_MR_REREG_ACCESS << 1) - 1)
1434 };
1435
1436 struct ib_fmr_attr {
1437         int     max_pages;
1438         int     max_maps;
1439         u8      page_shift;
1440 };
1441
1442 struct ib_umem;
1443
1444 enum rdma_remove_reason {
1445         /*
1446          * Userspace requested uobject deletion or initial try
1447          * to remove uobject via cleanup. Call could fail
1448          */
1449         RDMA_REMOVE_DESTROY,
1450         /* Context deletion. This call should delete the actual object itself */
1451         RDMA_REMOVE_CLOSE,
1452         /* Driver is being hot-unplugged. This call should delete the actual object itself */
1453         RDMA_REMOVE_DRIVER_REMOVE,
1454         /* uobj is being cleaned-up before being committed */
1455         RDMA_REMOVE_ABORT,
1456 };
1457
1458 struct ib_rdmacg_object {
1459 #ifdef CONFIG_CGROUP_RDMA
1460         struct rdma_cgroup      *cg;            /* owner rdma cgroup */
1461 #endif
1462 };
1463
1464 struct ib_ucontext {
1465         struct ib_device       *device;
1466         struct ib_uverbs_file  *ufile;
1467         /*
1468          * 'closing' can be read by the driver only during a destroy callback,
1469          * it is set when we are closing the file descriptor and indicates
1470          * that mm_sem may be locked.
1471          */
1472         bool closing;
1473
1474         bool cleanup_retryable;
1475
1476         struct ib_rdmacg_object cg_obj;
1477         /*
1478          * Implementation details of the RDMA core, don't use in drivers:
1479          */
1480         struct rdma_restrack_entry res;
1481         struct xarray mmap_xa;
1482 };
1483
1484 struct ib_uobject {
1485         u64                     user_handle;    /* handle given to us by userspace */
1486         /* ufile & ucontext owning this object */
1487         struct ib_uverbs_file  *ufile;
1488         /* FIXME, save memory: ufile->context == context */
1489         struct ib_ucontext     *context;        /* associated user context */
1490         void                   *object;         /* containing object */
1491         struct list_head        list;           /* link to context's list */
1492         struct ib_rdmacg_object cg_obj;         /* rdmacg object */
1493         int                     id;             /* index into kernel idr */
1494         struct kref             ref;
1495         atomic_t                usecnt;         /* protects exclusive access */
1496         struct rcu_head         rcu;            /* kfree_rcu() overhead */
1497
1498         const struct uverbs_api_object *uapi_object;
1499 };
1500
1501 struct ib_udata {
1502         const void __user *inbuf;
1503         void __user *outbuf;
1504         size_t       inlen;
1505         size_t       outlen;
1506 };
1507
1508 struct ib_pd {
1509         u32                     local_dma_lkey;
1510         u32                     flags;
1511         struct ib_device       *device;
1512         struct ib_uobject      *uobject;
1513         atomic_t                usecnt; /* count all resources */
1514
1515         u32                     unsafe_global_rkey;
1516
1517         /*
1518          * Implementation details of the RDMA core, don't use in drivers:
1519          */
1520         struct ib_mr           *__internal_mr;
1521         struct rdma_restrack_entry res;
1522 };
1523
1524 struct ib_xrcd {
1525         struct ib_device       *device;
1526         atomic_t                usecnt; /* count all exposed resources */
1527         struct inode           *inode;
1528
1529         struct mutex            tgt_qp_mutex;
1530         struct list_head        tgt_qp_list;
1531 };
1532
1533 struct ib_ah {
1534         struct ib_device        *device;
1535         struct ib_pd            *pd;
1536         struct ib_uobject       *uobject;
1537         const struct ib_gid_attr *sgid_attr;
1538         enum rdma_ah_attr_type  type;
1539 };
1540
1541 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
1542
1543 enum ib_poll_context {
1544         IB_POLL_DIRECT,            /* caller context, no hw completions */
1545         IB_POLL_SOFTIRQ,           /* poll from softirq context */
1546         IB_POLL_WORKQUEUE,         /* poll from workqueue */
1547         IB_POLL_UNBOUND_WORKQUEUE, /* poll from unbound workqueue */
1548 };
1549
1550 struct ib_cq {
1551         struct ib_device       *device;
1552         struct ib_ucq_object   *uobject;
1553         ib_comp_handler         comp_handler;
1554         void                  (*event_handler)(struct ib_event *, void *);
1555         void                   *cq_context;
1556         int                     cqe;
1557         atomic_t                usecnt; /* count number of work queues */
1558         enum ib_poll_context    poll_ctx;
1559         struct ib_wc            *wc;
1560         union {
1561                 struct irq_poll         iop;
1562                 struct work_struct      work;
1563         };
1564         struct workqueue_struct *comp_wq;
1565         struct dim *dim;
1566
1567         /* updated only by trace points */
1568         ktime_t timestamp;
1569         bool interrupt;
1570
1571         /*
1572          * Implementation details of the RDMA core, don't use in drivers:
1573          */
1574         struct rdma_restrack_entry res;
1575 };
1576
1577 struct ib_srq {
1578         struct ib_device       *device;
1579         struct ib_pd           *pd;
1580         struct ib_usrq_object  *uobject;
1581         void                  (*event_handler)(struct ib_event *, void *);
1582         void                   *srq_context;
1583         enum ib_srq_type        srq_type;
1584         atomic_t                usecnt;
1585
1586         struct {
1587                 struct ib_cq   *cq;
1588                 union {
1589                         struct {
1590                                 struct ib_xrcd *xrcd;
1591                                 u32             srq_num;
1592                         } xrc;
1593                 };
1594         } ext;
1595 };
1596
1597 enum ib_raw_packet_caps {
1598         /* Strip cvlan from incoming packet and report it in the matching work
1599          * completion is supported.
1600          */
1601         IB_RAW_PACKET_CAP_CVLAN_STRIPPING       = (1 << 0),
1602         /* Scatter FCS field of an incoming packet to host memory is supported.
1603          */
1604         IB_RAW_PACKET_CAP_SCATTER_FCS           = (1 << 1),
1605         /* Checksum offloads are supported (for both send and receive). */
1606         IB_RAW_PACKET_CAP_IP_CSUM               = (1 << 2),
1607         /* When a packet is received for an RQ with no receive WQEs, the
1608          * packet processing is delayed.
1609          */
1610         IB_RAW_PACKET_CAP_DELAY_DROP            = (1 << 3),
1611 };
1612
1613 enum ib_wq_type {
1614         IB_WQT_RQ
1615 };
1616
1617 enum ib_wq_state {
1618         IB_WQS_RESET,
1619         IB_WQS_RDY,
1620         IB_WQS_ERR
1621 };
1622
1623 struct ib_wq {
1624         struct ib_device       *device;
1625         struct ib_uwq_object   *uobject;
1626         void                *wq_context;
1627         void                (*event_handler)(struct ib_event *, void *);
1628         struct ib_pd           *pd;
1629         struct ib_cq           *cq;
1630         u32             wq_num;
1631         enum ib_wq_state       state;
1632         enum ib_wq_type wq_type;
1633         atomic_t                usecnt;
1634 };
1635
1636 enum ib_wq_flags {
1637         IB_WQ_FLAGS_CVLAN_STRIPPING     = 1 << 0,
1638         IB_WQ_FLAGS_SCATTER_FCS         = 1 << 1,
1639         IB_WQ_FLAGS_DELAY_DROP          = 1 << 2,
1640         IB_WQ_FLAGS_PCI_WRITE_END_PADDING = 1 << 3,
1641 };
1642
1643 struct ib_wq_init_attr {
1644         void                   *wq_context;
1645         enum ib_wq_type wq_type;
1646         u32             max_wr;
1647         u32             max_sge;
1648         struct  ib_cq          *cq;
1649         void                (*event_handler)(struct ib_event *, void *);
1650         u32             create_flags; /* Use enum ib_wq_flags */
1651 };
1652
1653 enum ib_wq_attr_mask {
1654         IB_WQ_STATE             = 1 << 0,
1655         IB_WQ_CUR_STATE         = 1 << 1,
1656         IB_WQ_FLAGS             = 1 << 2,
1657 };
1658
1659 struct ib_wq_attr {
1660         enum    ib_wq_state     wq_state;
1661         enum    ib_wq_state     curr_wq_state;
1662         u32                     flags; /* Use enum ib_wq_flags */
1663         u32                     flags_mask; /* Use enum ib_wq_flags */
1664 };
1665
1666 struct ib_rwq_ind_table {
1667         struct ib_device        *device;
1668         struct ib_uobject      *uobject;
1669         atomic_t                usecnt;
1670         u32             ind_tbl_num;
1671         u32             log_ind_tbl_size;
1672         struct ib_wq    **ind_tbl;
1673 };
1674
1675 struct ib_rwq_ind_table_init_attr {
1676         u32             log_ind_tbl_size;
1677         /* Each entry is a pointer to Receive Work Queue */
1678         struct ib_wq    **ind_tbl;
1679 };
1680
1681 enum port_pkey_state {
1682         IB_PORT_PKEY_NOT_VALID = 0,
1683         IB_PORT_PKEY_VALID = 1,
1684         IB_PORT_PKEY_LISTED = 2,
1685 };
1686
1687 struct ib_qp_security;
1688
1689 struct ib_port_pkey {
1690         enum port_pkey_state    state;
1691         u16                     pkey_index;
1692         u8                      port_num;
1693         struct list_head        qp_list;
1694         struct list_head        to_error_list;
1695         struct ib_qp_security  *sec;
1696 };
1697
1698 struct ib_ports_pkeys {
1699         struct ib_port_pkey     main;
1700         struct ib_port_pkey     alt;
1701 };
1702
1703 struct ib_qp_security {
1704         struct ib_qp           *qp;
1705         struct ib_device       *dev;
1706         /* Hold this mutex when changing port and pkey settings. */
1707         struct mutex            mutex;
1708         struct ib_ports_pkeys  *ports_pkeys;
1709         /* A list of all open shared QP handles.  Required to enforce security
1710          * properly for all users of a shared QP.
1711          */
1712         struct list_head        shared_qp_list;
1713         void                   *security;
1714         bool                    destroying;
1715         atomic_t                error_list_count;
1716         struct completion       error_complete;
1717         int                     error_comps_pending;
1718 };
1719
1720 /*
1721  * @max_write_sge: Maximum SGE elements per RDMA WRITE request.
1722  * @max_read_sge:  Maximum SGE elements per RDMA READ request.
1723  */
1724 struct ib_qp {
1725         struct ib_device       *device;
1726         struct ib_pd           *pd;
1727         struct ib_cq           *send_cq;
1728         struct ib_cq           *recv_cq;
1729         spinlock_t              mr_lock;
1730         int                     mrs_used;
1731         struct list_head        rdma_mrs;
1732         struct list_head        sig_mrs;
1733         struct ib_srq          *srq;
1734         struct ib_xrcd         *xrcd; /* XRC TGT QPs only */
1735         struct list_head        xrcd_list;
1736
1737         /* count times opened, mcast attaches, flow attaches */
1738         atomic_t                usecnt;
1739         struct list_head        open_list;
1740         struct ib_qp           *real_qp;
1741         struct ib_uqp_object   *uobject;
1742         void                  (*event_handler)(struct ib_event *, void *);
1743         void                   *qp_context;
1744         /* sgid_attrs associated with the AV's */
1745         const struct ib_gid_attr *av_sgid_attr;
1746         const struct ib_gid_attr *alt_path_sgid_attr;
1747         u32                     qp_num;
1748         u32                     max_write_sge;
1749         u32                     max_read_sge;
1750         enum ib_qp_type         qp_type;
1751         struct ib_rwq_ind_table *rwq_ind_tbl;
1752         struct ib_qp_security  *qp_sec;
1753         u8                      port;
1754
1755         bool                    integrity_en;
1756         /*
1757          * Implementation details of the RDMA core, don't use in drivers:
1758          */
1759         struct rdma_restrack_entry     res;
1760
1761         /* The counter the qp is bind to */
1762         struct rdma_counter    *counter;
1763 };
1764
1765 struct ib_dm {
1766         struct ib_device  *device;
1767         u32                length;
1768         u32                flags;
1769         struct ib_uobject *uobject;
1770         atomic_t           usecnt;
1771 };
1772
1773 struct ib_mr {
1774         struct ib_device  *device;
1775         struct ib_pd      *pd;
1776         u32                lkey;
1777         u32                rkey;
1778         u64                iova;
1779         u64                length;
1780         unsigned int       page_size;
1781         enum ib_mr_type    type;
1782         bool               need_inval;
1783         union {
1784                 struct ib_uobject       *uobject;       /* user */
1785                 struct list_head        qp_entry;       /* FR */
1786         };
1787
1788         struct ib_dm      *dm;
1789         struct ib_sig_attrs *sig_attrs; /* only for IB_MR_TYPE_INTEGRITY MRs */
1790         /*
1791          * Implementation details of the RDMA core, don't use in drivers:
1792          */
1793         struct rdma_restrack_entry res;
1794 };
1795
1796 struct ib_mw {
1797         struct ib_device        *device;
1798         struct ib_pd            *pd;
1799         struct ib_uobject       *uobject;
1800         u32                     rkey;
1801         enum ib_mw_type         type;
1802 };
1803
1804 struct ib_fmr {
1805         struct ib_device        *device;
1806         struct ib_pd            *pd;
1807         struct list_head        list;
1808         u32                     lkey;
1809         u32                     rkey;
1810 };
1811
1812 /* Supported steering options */
1813 enum ib_flow_attr_type {
1814         /* steering according to rule specifications */
1815         IB_FLOW_ATTR_NORMAL             = 0x0,
1816         /* default unicast and multicast rule -
1817          * receive all Eth traffic which isn't steered to any QP
1818          */
1819         IB_FLOW_ATTR_ALL_DEFAULT        = 0x1,
1820         /* default multicast rule -
1821          * receive all Eth multicast traffic which isn't steered to any QP
1822          */
1823         IB_FLOW_ATTR_MC_DEFAULT         = 0x2,
1824         /* sniffer rule - receive all port traffic */
1825         IB_FLOW_ATTR_SNIFFER            = 0x3
1826 };
1827
1828 /* Supported steering header types */
1829 enum ib_flow_spec_type {
1830         /* L2 headers*/
1831         IB_FLOW_SPEC_ETH                = 0x20,
1832         IB_FLOW_SPEC_IB                 = 0x22,
1833         /* L3 header*/
1834         IB_FLOW_SPEC_IPV4               = 0x30,
1835         IB_FLOW_SPEC_IPV6               = 0x31,
1836         IB_FLOW_SPEC_ESP                = 0x34,
1837         /* L4 headers*/
1838         IB_FLOW_SPEC_TCP                = 0x40,
1839         IB_FLOW_SPEC_UDP                = 0x41,
1840         IB_FLOW_SPEC_VXLAN_TUNNEL       = 0x50,
1841         IB_FLOW_SPEC_GRE                = 0x51,
1842         IB_FLOW_SPEC_MPLS               = 0x60,
1843         IB_FLOW_SPEC_INNER              = 0x100,
1844         /* Actions */
1845         IB_FLOW_SPEC_ACTION_TAG         = 0x1000,
1846         IB_FLOW_SPEC_ACTION_DROP        = 0x1001,
1847         IB_FLOW_SPEC_ACTION_HANDLE      = 0x1002,
1848         IB_FLOW_SPEC_ACTION_COUNT       = 0x1003,
1849 };
1850 #define IB_FLOW_SPEC_LAYER_MASK 0xF0
1851 #define IB_FLOW_SPEC_SUPPORT_LAYERS 10
1852
1853 /* Flow steering rule priority is set according to it's domain.
1854  * Lower domain value means higher priority.
1855  */
1856 enum ib_flow_domain {
1857         IB_FLOW_DOMAIN_USER,
1858         IB_FLOW_DOMAIN_ETHTOOL,
1859         IB_FLOW_DOMAIN_RFS,
1860         IB_FLOW_DOMAIN_NIC,
1861         IB_FLOW_DOMAIN_NUM /* Must be last */
1862 };
1863
1864 enum ib_flow_flags {
1865         IB_FLOW_ATTR_FLAGS_DONT_TRAP = 1UL << 1, /* Continue match, no steal */
1866         IB_FLOW_ATTR_FLAGS_EGRESS = 1UL << 2, /* Egress flow */
1867         IB_FLOW_ATTR_FLAGS_RESERVED  = 1UL << 3  /* Must be last */
1868 };
1869
1870 struct ib_flow_eth_filter {
1871         u8      dst_mac[6];
1872         u8      src_mac[6];
1873         __be16  ether_type;
1874         __be16  vlan_tag;
1875         /* Must be last */
1876         u8      real_sz[0];
1877 };
1878
1879 struct ib_flow_spec_eth {
1880         u32                       type;
1881         u16                       size;
1882         struct ib_flow_eth_filter val;
1883         struct ib_flow_eth_filter mask;
1884 };
1885
1886 struct ib_flow_ib_filter {
1887         __be16 dlid;
1888         __u8   sl;
1889         /* Must be last */
1890         u8      real_sz[0];
1891 };
1892
1893 struct ib_flow_spec_ib {
1894         u32                      type;
1895         u16                      size;
1896         struct ib_flow_ib_filter val;
1897         struct ib_flow_ib_filter mask;
1898 };
1899
1900 /* IPv4 header flags */
1901 enum ib_ipv4_flags {
1902         IB_IPV4_DONT_FRAG = 0x2, /* Don't enable packet fragmentation */
1903         IB_IPV4_MORE_FRAG = 0X4  /* For All fragmented packets except the
1904                                     last have this flag set */
1905 };
1906
1907 struct ib_flow_ipv4_filter {
1908         __be32  src_ip;
1909         __be32  dst_ip;
1910         u8      proto;
1911         u8      tos;
1912         u8      ttl;
1913         u8      flags;
1914         /* Must be last */
1915         u8      real_sz[0];
1916 };
1917
1918 struct ib_flow_spec_ipv4 {
1919         u32                        type;
1920         u16                        size;
1921         struct ib_flow_ipv4_filter val;
1922         struct ib_flow_ipv4_filter mask;
1923 };
1924
1925 struct ib_flow_ipv6_filter {
1926         u8      src_ip[16];
1927         u8      dst_ip[16];
1928         __be32  flow_label;
1929         u8      next_hdr;
1930         u8      traffic_class;
1931         u8      hop_limit;
1932         /* Must be last */
1933         u8      real_sz[0];
1934 };
1935
1936 struct ib_flow_spec_ipv6 {
1937         u32                        type;
1938         u16                        size;
1939         struct ib_flow_ipv6_filter val;
1940         struct ib_flow_ipv6_filter mask;
1941 };
1942
1943 struct ib_flow_tcp_udp_filter {
1944         __be16  dst_port;
1945         __be16  src_port;
1946         /* Must be last */
1947         u8      real_sz[0];
1948 };
1949
1950 struct ib_flow_spec_tcp_udp {
1951         u32                           type;
1952         u16                           size;
1953         struct ib_flow_tcp_udp_filter val;
1954         struct ib_flow_tcp_udp_filter mask;
1955 };
1956
1957 struct ib_flow_tunnel_filter {
1958         __be32  tunnel_id;
1959         u8      real_sz[0];
1960 };
1961
1962 /* ib_flow_spec_tunnel describes the Vxlan tunnel
1963  * the tunnel_id from val has the vni value
1964  */
1965 struct ib_flow_spec_tunnel {
1966         u32                           type;
1967         u16                           size;
1968         struct ib_flow_tunnel_filter  val;
1969         struct ib_flow_tunnel_filter  mask;
1970 };
1971
1972 struct ib_flow_esp_filter {
1973         __be32  spi;
1974         __be32  seq;
1975         /* Must be last */
1976         u8      real_sz[0];
1977 };
1978
1979 struct ib_flow_spec_esp {
1980         u32                           type;
1981         u16                           size;
1982         struct ib_flow_esp_filter     val;
1983         struct ib_flow_esp_filter     mask;
1984 };
1985
1986 struct ib_flow_gre_filter {
1987         __be16 c_ks_res0_ver;
1988         __be16 protocol;
1989         __be32 key;
1990         /* Must be last */
1991         u8      real_sz[0];
1992 };
1993
1994 struct ib_flow_spec_gre {
1995         u32                           type;
1996         u16                           size;
1997         struct ib_flow_gre_filter     val;
1998         struct ib_flow_gre_filter     mask;
1999 };
2000
2001 struct ib_flow_mpls_filter {
2002         __be32 tag;
2003         /* Must be last */
2004         u8      real_sz[0];
2005 };
2006
2007 struct ib_flow_spec_mpls {
2008         u32                           type;
2009         u16                           size;
2010         struct ib_flow_mpls_filter     val;
2011         struct ib_flow_mpls_filter     mask;
2012 };
2013
2014 struct ib_flow_spec_action_tag {
2015         enum ib_flow_spec_type        type;
2016         u16                           size;
2017         u32                           tag_id;
2018 };
2019
2020 struct ib_flow_spec_action_drop {
2021         enum ib_flow_spec_type        type;
2022         u16                           size;
2023 };
2024
2025 struct ib_flow_spec_action_handle {
2026         enum ib_flow_spec_type        type;
2027         u16                           size;
2028         struct ib_flow_action        *act;
2029 };
2030
2031 enum ib_counters_description {
2032         IB_COUNTER_PACKETS,
2033         IB_COUNTER_BYTES,
2034 };
2035
2036 struct ib_flow_spec_action_count {
2037         enum ib_flow_spec_type type;
2038         u16 size;
2039         struct ib_counters *counters;
2040 };
2041
2042 union ib_flow_spec {
2043         struct {
2044                 u32                     type;
2045                 u16                     size;
2046         };
2047         struct ib_flow_spec_eth         eth;
2048         struct ib_flow_spec_ib          ib;
2049         struct ib_flow_spec_ipv4        ipv4;
2050         struct ib_flow_spec_tcp_udp     tcp_udp;
2051         struct ib_flow_spec_ipv6        ipv6;
2052         struct ib_flow_spec_tunnel      tunnel;
2053         struct ib_flow_spec_esp         esp;
2054         struct ib_flow_spec_gre         gre;
2055         struct ib_flow_spec_mpls        mpls;
2056         struct ib_flow_spec_action_tag  flow_tag;
2057         struct ib_flow_spec_action_drop drop;
2058         struct ib_flow_spec_action_handle action;
2059         struct ib_flow_spec_action_count flow_count;
2060 };
2061
2062 struct ib_flow_attr {
2063         enum ib_flow_attr_type type;
2064         u16          size;
2065         u16          priority;
2066         u32          flags;
2067         u8           num_of_specs;
2068         u8           port;
2069         union ib_flow_spec flows[];
2070 };
2071
2072 struct ib_flow {
2073         struct ib_qp            *qp;
2074         struct ib_device        *device;
2075         struct ib_uobject       *uobject;
2076 };
2077
2078 enum ib_flow_action_type {
2079         IB_FLOW_ACTION_UNSPECIFIED,
2080         IB_FLOW_ACTION_ESP = 1,
2081 };
2082
2083 struct ib_flow_action_attrs_esp_keymats {
2084         enum ib_uverbs_flow_action_esp_keymat                   protocol;
2085         union {
2086                 struct ib_uverbs_flow_action_esp_keymat_aes_gcm aes_gcm;
2087         } keymat;
2088 };
2089
2090 struct ib_flow_action_attrs_esp_replays {
2091         enum ib_uverbs_flow_action_esp_replay                   protocol;
2092         union {
2093                 struct ib_uverbs_flow_action_esp_replay_bmp     bmp;
2094         } replay;
2095 };
2096
2097 enum ib_flow_action_attrs_esp_flags {
2098         /* All user-space flags at the top: Use enum ib_uverbs_flow_action_esp_flags
2099          * This is done in order to share the same flags between user-space and
2100          * kernel and spare an unnecessary translation.
2101          */
2102
2103         /* Kernel flags */
2104         IB_FLOW_ACTION_ESP_FLAGS_ESN_TRIGGERED  = 1ULL << 32,
2105         IB_FLOW_ACTION_ESP_FLAGS_MOD_ESP_ATTRS  = 1ULL << 33,
2106 };
2107
2108 struct ib_flow_spec_list {
2109         struct ib_flow_spec_list        *next;
2110         union ib_flow_spec              spec;
2111 };
2112
2113 struct ib_flow_action_attrs_esp {
2114         struct ib_flow_action_attrs_esp_keymats         *keymat;
2115         struct ib_flow_action_attrs_esp_replays         *replay;
2116         struct ib_flow_spec_list                        *encap;
2117         /* Used only if IB_FLOW_ACTION_ESP_FLAGS_ESN_TRIGGERED is enabled.
2118          * Value of 0 is a valid value.
2119          */
2120         u32                                             esn;
2121         u32                                             spi;
2122         u32                                             seq;
2123         u32                                             tfc_pad;
2124         /* Use enum ib_flow_action_attrs_esp_flags */
2125         u64                                             flags;
2126         u64                                             hard_limit_pkts;
2127 };
2128
2129 struct ib_flow_action {
2130         struct ib_device                *device;
2131         struct ib_uobject               *uobject;
2132         enum ib_flow_action_type        type;
2133         atomic_t                        usecnt;
2134 };
2135
2136 struct ib_mad;
2137 struct ib_grh;
2138
2139 enum ib_process_mad_flags {
2140         IB_MAD_IGNORE_MKEY      = 1,
2141         IB_MAD_IGNORE_BKEY      = 2,
2142         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
2143 };
2144
2145 enum ib_mad_result {
2146         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
2147         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
2148         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
2149         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
2150 };
2151
2152 struct ib_port_cache {
2153         u64                   subnet_prefix;
2154         struct ib_pkey_cache  *pkey;
2155         struct ib_gid_table   *gid;
2156         u8                     lmc;
2157         enum ib_port_state     port_state;
2158 };
2159
2160 struct ib_port_immutable {
2161         int                           pkey_tbl_len;
2162         int                           gid_tbl_len;
2163         u32                           core_cap_flags;
2164         u32                           max_mad_size;
2165 };
2166
2167 struct ib_port_data {
2168         struct ib_device *ib_dev;
2169
2170         struct ib_port_immutable immutable;
2171
2172         spinlock_t pkey_list_lock;
2173         struct list_head pkey_list;
2174
2175         struct ib_port_cache cache;
2176
2177         spinlock_t netdev_lock;
2178         struct net_device __rcu *netdev;
2179         struct hlist_node ndev_hash_link;
2180         struct rdma_port_counter port_counter;
2181         struct rdma_hw_stats *hw_stats;
2182 };
2183
2184 /* rdma netdev type - specifies protocol type */
2185 enum rdma_netdev_t {
2186         RDMA_NETDEV_OPA_VNIC,
2187         RDMA_NETDEV_IPOIB,
2188 };
2189
2190 /**
2191  * struct rdma_netdev - rdma netdev
2192  * For cases where netstack interfacing is required.
2193  */
2194 struct rdma_netdev {
2195         void              *clnt_priv;
2196         struct ib_device  *hca;
2197         u8                 port_num;
2198
2199         /*
2200          * cleanup function must be specified.
2201          * FIXME: This is only used for OPA_VNIC and that usage should be
2202          * removed too.
2203          */
2204         void (*free_rdma_netdev)(struct net_device *netdev);
2205
2206         /* control functions */
2207         void (*set_id)(struct net_device *netdev, int id);
2208         /* send packet */
2209         int (*send)(struct net_device *dev, struct sk_buff *skb,
2210                     struct ib_ah *address, u32 dqpn);
2211         /* multicast */
2212         int (*attach_mcast)(struct net_device *dev, struct ib_device *hca,
2213                             union ib_gid *gid, u16 mlid,
2214                             int set_qkey, u32 qkey);
2215         int (*detach_mcast)(struct net_device *dev, struct ib_device *hca,
2216                             union ib_gid *gid, u16 mlid);
2217 };
2218
2219 struct rdma_netdev_alloc_params {
2220         size_t sizeof_priv;
2221         unsigned int txqs;
2222         unsigned int rxqs;
2223         void *param;
2224
2225         int (*initialize_rdma_netdev)(struct ib_device *device, u8 port_num,
2226                                       struct net_device *netdev, void *param);
2227 };
2228
2229 struct ib_odp_counters {
2230         atomic64_t faults;
2231         atomic64_t invalidations;
2232 };
2233
2234 struct ib_counters {
2235         struct ib_device        *device;
2236         struct ib_uobject       *uobject;
2237         /* num of objects attached */
2238         atomic_t        usecnt;
2239 };
2240
2241 struct ib_counters_read_attr {
2242         u64     *counters_buff;
2243         u32     ncounters;
2244         u32     flags; /* use enum ib_read_counters_flags */
2245 };
2246
2247 struct uverbs_attr_bundle;
2248 struct iw_cm_id;
2249 struct iw_cm_conn_param;
2250
2251 #define INIT_RDMA_OBJ_SIZE(ib_struct, drv_struct, member)                      \
2252         .size_##ib_struct =                                                    \
2253                 (sizeof(struct drv_struct) +                                   \
2254                  BUILD_BUG_ON_ZERO(offsetof(struct drv_struct, member)) +      \
2255                  BUILD_BUG_ON_ZERO(                                            \
2256                          !__same_type(((struct drv_struct *)NULL)->member,     \
2257                                       struct ib_struct)))
2258
2259 #define rdma_zalloc_drv_obj_gfp(ib_dev, ib_type, gfp)                         \
2260         ((struct ib_type *)kzalloc(ib_dev->ops.size_##ib_type, gfp))
2261
2262 #define rdma_zalloc_drv_obj(ib_dev, ib_type)                                   \
2263         rdma_zalloc_drv_obj_gfp(ib_dev, ib_type, GFP_KERNEL)
2264
2265 #define DECLARE_RDMA_OBJ_SIZE(ib_struct) size_t size_##ib_struct
2266
2267 struct rdma_user_mmap_entry {
2268         struct kref ref;
2269         struct ib_ucontext *ucontext;
2270         unsigned long start_pgoff;
2271         size_t npages;
2272         bool driver_removed;
2273 };
2274
2275 /* Return the offset (in bytes) the user should pass to libc's mmap() */
2276 static inline u64
2277 rdma_user_mmap_get_offset(const struct rdma_user_mmap_entry *entry)
2278 {
2279         return (u64)entry->start_pgoff << PAGE_SHIFT;
2280 }
2281
2282 /**
2283  * struct ib_device_ops - InfiniBand device operations
2284  * This structure defines all the InfiniBand device operations, providers will
2285  * need to define the supported operations, otherwise they will be set to null.
2286  */
2287 struct ib_device_ops {
2288         struct module *owner;
2289         enum rdma_driver_id driver_id;
2290         u32 uverbs_abi_ver;
2291         unsigned int uverbs_no_driver_id_binding:1;
2292
2293         int (*post_send)(struct ib_qp *qp, const struct ib_send_wr *send_wr,
2294                          const struct ib_send_wr **bad_send_wr);
2295         int (*post_recv)(struct ib_qp *qp, const struct ib_recv_wr *recv_wr,
2296                          const struct ib_recv_wr **bad_recv_wr);
2297         void (*drain_rq)(struct ib_qp *qp);
2298         void (*drain_sq)(struct ib_qp *qp);
2299         int (*poll_cq)(struct ib_cq *cq, int num_entries, struct ib_wc *wc);
2300         int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
2301         int (*req_notify_cq)(struct ib_cq *cq, enum ib_cq_notify_flags flags);
2302         int (*req_ncomp_notif)(struct ib_cq *cq, int wc_cnt);
2303         int (*post_srq_recv)(struct ib_srq *srq,
2304                              const struct ib_recv_wr *recv_wr,
2305                              const struct ib_recv_wr **bad_recv_wr);
2306         int (*process_mad)(struct ib_device *device, int process_mad_flags,
2307                            u8 port_num, const struct ib_wc *in_wc,
2308                            const struct ib_grh *in_grh,
2309                            const struct ib_mad *in_mad, struct ib_mad *out_mad,
2310                            size_t *out_mad_size, u16 *out_mad_pkey_index);
2311         int (*query_device)(struct ib_device *device,
2312                             struct ib_device_attr *device_attr,
2313                             struct ib_udata *udata);
2314         int (*modify_device)(struct ib_device *device, int device_modify_mask,
2315                              struct ib_device_modify *device_modify);
2316         void (*get_dev_fw_str)(struct ib_device *device, char *str);
2317         const struct cpumask *(*get_vector_affinity)(struct ib_device *ibdev,
2318                                                      int comp_vector);
2319         int (*query_port)(struct ib_device *device, u8 port_num,
2320                           struct ib_port_attr *port_attr);
2321         int (*modify_port)(struct ib_device *device, u8 port_num,
2322                            int port_modify_mask,
2323                            struct ib_port_modify *port_modify);
2324         /**
2325          * The following mandatory functions are used only at device
2326          * registration.  Keep functions such as these at the end of this
2327          * structure to avoid cache line misses when accessing struct ib_device
2328          * in fast paths.
2329          */
2330         int (*get_port_immutable)(struct ib_device *device, u8 port_num,
2331                                   struct ib_port_immutable *immutable);
2332         enum rdma_link_layer (*get_link_layer)(struct ib_device *device,
2333                                                u8 port_num);
2334         /**
2335          * When calling get_netdev, the HW vendor's driver should return the
2336          * net device of device @device at port @port_num or NULL if such
2337          * a net device doesn't exist. The vendor driver should call dev_hold
2338          * on this net device. The HW vendor's device driver must guarantee
2339          * that this function returns NULL before the net device has finished
2340          * NETDEV_UNREGISTER state.
2341          */
2342         struct net_device *(*get_netdev)(struct ib_device *device, u8 port_num);
2343         /**
2344          * rdma netdev operation
2345          *
2346          * Driver implementing alloc_rdma_netdev or rdma_netdev_get_params
2347          * must return -EOPNOTSUPP if it doesn't support the specified type.
2348          */
2349         struct net_device *(*alloc_rdma_netdev)(
2350                 struct ib_device *device, u8 port_num, enum rdma_netdev_t type,
2351                 const char *name, unsigned char name_assign_type,
2352                 void (*setup)(struct net_device *));
2353
2354         int (*rdma_netdev_get_params)(struct ib_device *device, u8 port_num,
2355                                       enum rdma_netdev_t type,
2356                                       struct rdma_netdev_alloc_params *params);
2357         /**
2358          * query_gid should be return GID value for @device, when @port_num
2359          * link layer is either IB or iWarp. It is no-op if @port_num port
2360          * is RoCE link layer.
2361          */
2362         int (*query_gid)(struct ib_device *device, u8 port_num, int index,
2363                          union ib_gid *gid);
2364         /**
2365          * When calling add_gid, the HW vendor's driver should add the gid
2366          * of device of port at gid index available at @attr. Meta-info of
2367          * that gid (for example, the network device related to this gid) is
2368          * available at @attr. @context allows the HW vendor driver to store
2369          * extra information together with a GID entry. The HW vendor driver may
2370          * allocate memory to contain this information and store it in @context
2371          * when a new GID entry is written to. Params are consistent until the
2372          * next call of add_gid or delete_gid. The function should return 0 on
2373          * success or error otherwise. The function could be called
2374          * concurrently for different ports. This function is only called when
2375          * roce_gid_table is used.
2376          */
2377         int (*add_gid)(const struct ib_gid_attr *attr, void **context);
2378         /**
2379          * When calling del_gid, the HW vendor's driver should delete the
2380          * gid of device @device at gid index gid_index of port port_num
2381          * available in @attr.
2382          * Upon the deletion of a GID entry, the HW vendor must free any
2383          * allocated memory. The caller will clear @context afterwards.
2384          * This function is only called when roce_gid_table is used.
2385          */
2386         int (*del_gid)(const struct ib_gid_attr *attr, void **context);
2387         int (*query_pkey)(struct ib_device *device, u8 port_num, u16 index,
2388                           u16 *pkey);
2389         int (*alloc_ucontext)(struct ib_ucontext *context,
2390                               struct ib_udata *udata);
2391         void (*dealloc_ucontext)(struct ib_ucontext *context);
2392         int (*mmap)(struct ib_ucontext *context, struct vm_area_struct *vma);
2393         /**
2394          * This will be called once refcount of an entry in mmap_xa reaches
2395          * zero. The type of the memory that was mapped may differ between
2396          * entries and is opaque to the rdma_user_mmap interface.
2397          * Therefore needs to be implemented by the driver in mmap_free.
2398          */
2399         void (*mmap_free)(struct rdma_user_mmap_entry *entry);
2400         void (*disassociate_ucontext)(struct ib_ucontext *ibcontext);
2401         int (*alloc_pd)(struct ib_pd *pd, struct ib_udata *udata);
2402         void (*dealloc_pd)(struct ib_pd *pd, struct ib_udata *udata);
2403         int (*create_ah)(struct ib_ah *ah, struct rdma_ah_attr *ah_attr,
2404                          u32 flags, struct ib_udata *udata);
2405         int (*modify_ah)(struct ib_ah *ah, struct rdma_ah_attr *ah_attr);
2406         int (*query_ah)(struct ib_ah *ah, struct rdma_ah_attr *ah_attr);
2407         void (*destroy_ah)(struct ib_ah *ah, u32 flags);
2408         int (*create_srq)(struct ib_srq *srq,
2409                           struct ib_srq_init_attr *srq_init_attr,
2410                           struct ib_udata *udata);
2411         int (*modify_srq)(struct ib_srq *srq, struct ib_srq_attr *srq_attr,
2412                           enum ib_srq_attr_mask srq_attr_mask,
2413                           struct ib_udata *udata);
2414         int (*query_srq)(struct ib_srq *srq, struct ib_srq_attr *srq_attr);
2415         void (*destroy_srq)(struct ib_srq *srq, struct ib_udata *udata);
2416         struct ib_qp *(*create_qp)(struct ib_pd *pd,
2417                                    struct ib_qp_init_attr *qp_init_attr,
2418                                    struct ib_udata *udata);
2419         int (*modify_qp)(struct ib_qp *qp, struct ib_qp_attr *qp_attr,
2420                          int qp_attr_mask, struct ib_udata *udata);
2421         int (*query_qp)(struct ib_qp *qp, struct ib_qp_attr *qp_attr,
2422                         int qp_attr_mask, struct ib_qp_init_attr *qp_init_attr);
2423         int (*destroy_qp)(struct ib_qp *qp, struct ib_udata *udata);
2424         int (*create_cq)(struct ib_cq *cq, const struct ib_cq_init_attr *attr,
2425                          struct ib_udata *udata);
2426         int (*modify_cq)(struct ib_cq *cq, u16 cq_count, u16 cq_period);
2427         void (*destroy_cq)(struct ib_cq *cq, struct ib_udata *udata);
2428         int (*resize_cq)(struct ib_cq *cq, int cqe, struct ib_udata *udata);
2429         struct ib_mr *(*get_dma_mr)(struct ib_pd *pd, int mr_access_flags);
2430         struct ib_mr *(*reg_user_mr)(struct ib_pd *pd, u64 start, u64 length,
2431                                      u64 virt_addr, int mr_access_flags,
2432                                      struct ib_udata *udata);
2433         int (*rereg_user_mr)(struct ib_mr *mr, int flags, u64 start, u64 length,
2434                              u64 virt_addr, int mr_access_flags,
2435                              struct ib_pd *pd, struct ib_udata *udata);
2436         int (*dereg_mr)(struct ib_mr *mr, struct ib_udata *udata);
2437         struct ib_mr *(*alloc_mr)(struct ib_pd *pd, enum ib_mr_type mr_type,
2438                                   u32 max_num_sg, struct ib_udata *udata);
2439         struct ib_mr *(*alloc_mr_integrity)(struct ib_pd *pd,
2440                                             u32 max_num_data_sg,
2441                                             u32 max_num_meta_sg);
2442         int (*advise_mr)(struct ib_pd *pd,
2443                          enum ib_uverbs_advise_mr_advice advice, u32 flags,
2444                          struct ib_sge *sg_list, u32 num_sge,
2445                          struct uverbs_attr_bundle *attrs);
2446         int (*map_mr_sg)(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
2447                          unsigned int *sg_offset);
2448         int (*check_mr_status)(struct ib_mr *mr, u32 check_mask,
2449                                struct ib_mr_status *mr_status);
2450         struct ib_mw *(*alloc_mw)(struct ib_pd *pd, enum ib_mw_type type,
2451                                   struct ib_udata *udata);
2452         int (*dealloc_mw)(struct ib_mw *mw);
2453         struct ib_fmr *(*alloc_fmr)(struct ib_pd *pd, int mr_access_flags,
2454                                     struct ib_fmr_attr *fmr_attr);
2455         int (*map_phys_fmr)(struct ib_fmr *fmr, u64 *page_list, int list_len,
2456                             u64 iova);
2457         int (*unmap_fmr)(struct list_head *fmr_list);
2458         int (*dealloc_fmr)(struct ib_fmr *fmr);
2459         int (*attach_mcast)(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2460         int (*detach_mcast)(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2461         struct ib_xrcd *(*alloc_xrcd)(struct ib_device *device,
2462                                       struct ib_udata *udata);
2463         int (*dealloc_xrcd)(struct ib_xrcd *xrcd, struct ib_udata *udata);
2464         struct ib_flow *(*create_flow)(struct ib_qp *qp,
2465                                        struct ib_flow_attr *flow_attr,
2466                                        int domain, struct ib_udata *udata);
2467         int (*destroy_flow)(struct ib_flow *flow_id);
2468         struct ib_flow_action *(*create_flow_action_esp)(
2469                 struct ib_device *device,
2470                 const struct ib_flow_action_attrs_esp *attr,
2471                 struct uverbs_attr_bundle *attrs);
2472         int (*destroy_flow_action)(struct ib_flow_action *action);
2473         int (*modify_flow_action_esp)(
2474                 struct ib_flow_action *action,
2475                 const struct ib_flow_action_attrs_esp *attr,
2476                 struct uverbs_attr_bundle *attrs);
2477         int (*set_vf_link_state)(struct ib_device *device, int vf, u8 port,
2478                                  int state);
2479         int (*get_vf_config)(struct ib_device *device, int vf, u8 port,
2480                              struct ifla_vf_info *ivf);
2481         int (*get_vf_stats)(struct ib_device *device, int vf, u8 port,
2482                             struct ifla_vf_stats *stats);
2483         int (*get_vf_guid)(struct ib_device *device, int vf, u8 port,
2484                             struct ifla_vf_guid *node_guid,
2485                             struct ifla_vf_guid *port_guid);
2486         int (*set_vf_guid)(struct ib_device *device, int vf, u8 port, u64 guid,
2487                            int type);
2488         struct ib_wq *(*create_wq)(struct ib_pd *pd,
2489                                    struct ib_wq_init_attr *init_attr,
2490                                    struct ib_udata *udata);
2491         void (*destroy_wq)(struct ib_wq *wq, struct ib_udata *udata);
2492         int (*modify_wq)(struct ib_wq *wq, struct ib_wq_attr *attr,
2493                          u32 wq_attr_mask, struct ib_udata *udata);
2494         struct ib_rwq_ind_table *(*create_rwq_ind_table)(
2495                 struct ib_device *device,
2496                 struct ib_rwq_ind_table_init_attr *init_attr,
2497                 struct ib_udata *udata);
2498         int (*destroy_rwq_ind_table)(struct ib_rwq_ind_table *wq_ind_table);
2499         struct ib_dm *(*alloc_dm)(struct ib_device *device,
2500                                   struct ib_ucontext *context,
2501                                   struct ib_dm_alloc_attr *attr,
2502                                   struct uverbs_attr_bundle *attrs);
2503         int (*dealloc_dm)(struct ib_dm *dm, struct uverbs_attr_bundle *attrs);
2504         struct ib_mr *(*reg_dm_mr)(struct ib_pd *pd, struct ib_dm *dm,
2505                                    struct ib_dm_mr_attr *attr,
2506                                    struct uverbs_attr_bundle *attrs);
2507         struct ib_counters *(*create_counters)(
2508                 struct ib_device *device, struct uverbs_attr_bundle *attrs);
2509         int (*destroy_counters)(struct ib_counters *counters);
2510         int (*read_counters)(struct ib_counters *counters,
2511                              struct ib_counters_read_attr *counters_read_attr,
2512                              struct uverbs_attr_bundle *attrs);
2513         int (*map_mr_sg_pi)(struct ib_mr *mr, struct scatterlist *data_sg,
2514                             int data_sg_nents, unsigned int *data_sg_offset,
2515                             struct scatterlist *meta_sg, int meta_sg_nents,
2516                             unsigned int *meta_sg_offset);
2517
2518         /**
2519          * alloc_hw_stats - Allocate a struct rdma_hw_stats and fill in the
2520          *   driver initialized data.  The struct is kfree()'ed by the sysfs
2521          *   core when the device is removed.  A lifespan of -1 in the return
2522          *   struct tells the core to set a default lifespan.
2523          */
2524         struct rdma_hw_stats *(*alloc_hw_stats)(struct ib_device *device,
2525                                                 u8 port_num);
2526         /**
2527          * get_hw_stats - Fill in the counter value(s) in the stats struct.
2528          * @index - The index in the value array we wish to have updated, or
2529          *   num_counters if we want all stats updated
2530          * Return codes -
2531          *   < 0 - Error, no counters updated
2532          *   index - Updated the single counter pointed to by index
2533          *   num_counters - Updated all counters (will reset the timestamp
2534          *     and prevent further calls for lifespan milliseconds)
2535          * Drivers are allowed to update all counters in leiu of just the
2536          *   one given in index at their option
2537          */
2538         int (*get_hw_stats)(struct ib_device *device,
2539                             struct rdma_hw_stats *stats, u8 port, int index);
2540         /*
2541          * This function is called once for each port when a ib device is
2542          * registered.
2543          */
2544         int (*init_port)(struct ib_device *device, u8 port_num,
2545                          struct kobject *port_sysfs);
2546         /**
2547          * Allows rdma drivers to add their own restrack attributes.
2548          */
2549         int (*fill_res_entry)(struct sk_buff *msg,
2550                               struct rdma_restrack_entry *entry);
2551
2552         /* Device lifecycle callbacks */
2553         /*
2554          * Called after the device becomes registered, before clients are
2555          * attached
2556          */
2557         int (*enable_driver)(struct ib_device *dev);
2558         /*
2559          * This is called as part of ib_dealloc_device().
2560          */
2561         void (*dealloc_driver)(struct ib_device *dev);
2562
2563         /* iWarp CM callbacks */
2564         void (*iw_add_ref)(struct ib_qp *qp);
2565         void (*iw_rem_ref)(struct ib_qp *qp);
2566         struct ib_qp *(*iw_get_qp)(struct ib_device *device, int qpn);
2567         int (*iw_connect)(struct iw_cm_id *cm_id,
2568                           struct iw_cm_conn_param *conn_param);
2569         int (*iw_accept)(struct iw_cm_id *cm_id,
2570                          struct iw_cm_conn_param *conn_param);
2571         int (*iw_reject)(struct iw_cm_id *cm_id, const void *pdata,
2572                          u8 pdata_len);
2573         int (*iw_create_listen)(struct iw_cm_id *cm_id, int backlog);
2574         int (*iw_destroy_listen)(struct iw_cm_id *cm_id);
2575         /**
2576          * counter_bind_qp - Bind a QP to a counter.
2577          * @counter - The counter to be bound. If counter->id is zero then
2578          *   the driver needs to allocate a new counter and set counter->id
2579          */
2580         int (*counter_bind_qp)(struct rdma_counter *counter, struct ib_qp *qp);
2581         /**
2582          * counter_unbind_qp - Unbind the qp from the dynamically-allocated
2583          *   counter and bind it onto the default one
2584          */
2585         int (*counter_unbind_qp)(struct ib_qp *qp);
2586         /**
2587          * counter_dealloc -De-allocate the hw counter
2588          */
2589         int (*counter_dealloc)(struct rdma_counter *counter);
2590         /**
2591          * counter_alloc_stats - Allocate a struct rdma_hw_stats and fill in
2592          * the driver initialized data.
2593          */
2594         struct rdma_hw_stats *(*counter_alloc_stats)(
2595                 struct rdma_counter *counter);
2596         /**
2597          * counter_update_stats - Query the stats value of this counter
2598          */
2599         int (*counter_update_stats)(struct rdma_counter *counter);
2600
2601         /**
2602          * Allows rdma drivers to add their own restrack attributes
2603          * dumped via 'rdma stat' iproute2 command.
2604          */
2605         int (*fill_stat_entry)(struct sk_buff *msg,
2606                                struct rdma_restrack_entry *entry);
2607
2608         DECLARE_RDMA_OBJ_SIZE(ib_ah);
2609         DECLARE_RDMA_OBJ_SIZE(ib_cq);
2610         DECLARE_RDMA_OBJ_SIZE(ib_pd);
2611         DECLARE_RDMA_OBJ_SIZE(ib_srq);
2612         DECLARE_RDMA_OBJ_SIZE(ib_ucontext);
2613 };
2614
2615 struct ib_core_device {
2616         /* device must be the first element in structure until,
2617          * union of ib_core_device and device exists in ib_device.
2618          */
2619         struct device dev;
2620         possible_net_t rdma_net;
2621         struct kobject *ports_kobj;
2622         struct list_head port_list;
2623         struct ib_device *owner; /* reach back to owner ib_device */
2624 };
2625
2626 struct rdma_restrack_root;
2627 struct ib_device {
2628         /* Do not access @dma_device directly from ULP nor from HW drivers. */
2629         struct device                *dma_device;
2630         struct ib_device_ops         ops;
2631         char                          name[IB_DEVICE_NAME_MAX];
2632         struct rcu_head rcu_head;
2633
2634         struct list_head              event_handler_list;
2635         /* Protects event_handler_list */
2636         struct rw_semaphore event_handler_rwsem;
2637
2638         /* Protects QP's event_handler calls and open_qp list */
2639         spinlock_t qp_open_list_lock;
2640
2641         struct rw_semaphore           client_data_rwsem;
2642         struct xarray                 client_data;
2643         struct mutex                  unregistration_lock;
2644
2645         /* Synchronize GID, Pkey cache entries, subnet prefix, LMC */
2646         rwlock_t cache_lock;
2647         /**
2648          * port_data is indexed by port number
2649          */
2650         struct ib_port_data *port_data;
2651
2652         int                           num_comp_vectors;
2653
2654         union {
2655                 struct device           dev;
2656                 struct ib_core_device   coredev;
2657         };
2658
2659         /* First group for device attributes,
2660          * Second group for driver provided attributes (optional).
2661          * It is NULL terminated array.
2662          */
2663         const struct attribute_group    *groups[3];
2664
2665         u64                          uverbs_cmd_mask;
2666         u64                          uverbs_ex_cmd_mask;
2667
2668         char                         node_desc[IB_DEVICE_NODE_DESC_MAX];
2669         __be64                       node_guid;
2670         u32                          local_dma_lkey;
2671         u16                          is_switch:1;
2672         /* Indicates kernel verbs support, should not be used in drivers */
2673         u16                          kverbs_provider:1;
2674         /* CQ adaptive moderation (RDMA DIM) */
2675         u16                          use_cq_dim:1;
2676         u8                           node_type;
2677         u8                           phys_port_cnt;
2678         struct ib_device_attr        attrs;
2679         struct attribute_group       *hw_stats_ag;
2680         struct rdma_hw_stats         *hw_stats;
2681
2682 #ifdef CONFIG_CGROUP_RDMA
2683         struct rdmacg_device         cg_device;
2684 #endif
2685
2686         u32                          index;
2687         struct rdma_restrack_root *res;
2688
2689         const struct uapi_definition   *driver_def;
2690
2691         /*
2692          * Positive refcount indicates that the device is currently
2693          * registered and cannot be unregistered.
2694          */
2695         refcount_t refcount;
2696         struct completion unreg_completion;
2697         struct work_struct unregistration_work;
2698
2699         const struct rdma_link_ops *link_ops;
2700
2701         /* Protects compat_devs xarray modifications */
2702         struct mutex compat_devs_mutex;
2703         /* Maintains compat devices for each net namespace */
2704         struct xarray compat_devs;
2705
2706         /* Used by iWarp CM */
2707         char iw_ifname[IFNAMSIZ];
2708         u32 iw_driver_flags;
2709 };
2710
2711 struct ib_client_nl_info;
2712 struct ib_client {
2713         const char *name;
2714         void (*add)   (struct ib_device *);
2715         void (*remove)(struct ib_device *, void *client_data);
2716         void (*rename)(struct ib_device *dev, void *client_data);
2717         int (*get_nl_info)(struct ib_device *ibdev, void *client_data,
2718                            struct ib_client_nl_info *res);
2719         int (*get_global_nl_info)(struct ib_client_nl_info *res);
2720
2721         /* Returns the net_dev belonging to this ib_client and matching the
2722          * given parameters.
2723          * @dev:         An RDMA device that the net_dev use for communication.
2724          * @port:        A physical port number on the RDMA device.
2725          * @pkey:        P_Key that the net_dev uses if applicable.
2726          * @gid:         A GID that the net_dev uses to communicate.
2727          * @addr:        An IP address the net_dev is configured with.
2728          * @client_data: The device's client data set by ib_set_client_data().
2729          *
2730          * An ib_client that implements a net_dev on top of RDMA devices
2731          * (such as IP over IB) should implement this callback, allowing the
2732          * rdma_cm module to find the right net_dev for a given request.
2733          *
2734          * The caller is responsible for calling dev_put on the returned
2735          * netdev. */
2736         struct net_device *(*get_net_dev_by_params)(
2737                         struct ib_device *dev,
2738                         u8 port,
2739                         u16 pkey,
2740                         const union ib_gid *gid,
2741                         const struct sockaddr *addr,
2742                         void *client_data);
2743
2744         refcount_t uses;
2745         struct completion uses_zero;
2746         u32 client_id;
2747
2748         /* kverbs are not required by the client */
2749         u8 no_kverbs_req:1;
2750 };
2751
2752 /*
2753  * IB block DMA iterator
2754  *
2755  * Iterates the DMA-mapped SGL in contiguous memory blocks aligned
2756  * to a HW supported page size.
2757  */
2758 struct ib_block_iter {
2759         /* internal states */
2760         struct scatterlist *__sg;       /* sg holding the current aligned block */
2761         dma_addr_t __dma_addr;          /* unaligned DMA address of this block */
2762         unsigned int __sg_nents;        /* number of SG entries */
2763         unsigned int __sg_advance;      /* number of bytes to advance in sg in next step */
2764         unsigned int __pg_bit;          /* alignment of current block */
2765 };
2766
2767 struct ib_device *_ib_alloc_device(size_t size);
2768 #define ib_alloc_device(drv_struct, member)                                    \
2769         container_of(_ib_alloc_device(sizeof(struct drv_struct) +              \
2770                                       BUILD_BUG_ON_ZERO(offsetof(              \
2771                                               struct drv_struct, member))),    \
2772                      struct drv_struct, member)
2773
2774 void ib_dealloc_device(struct ib_device *device);
2775
2776 void ib_get_device_fw_str(struct ib_device *device, char *str);
2777
2778 int ib_register_device(struct ib_device *device, const char *name);
2779 void ib_unregister_device(struct ib_device *device);
2780 void ib_unregister_driver(enum rdma_driver_id driver_id);
2781 void ib_unregister_device_and_put(struct ib_device *device);
2782 void ib_unregister_device_queued(struct ib_device *ib_dev);
2783
2784 int ib_register_client   (struct ib_client *client);
2785 void ib_unregister_client(struct ib_client *client);
2786
2787 void __rdma_block_iter_start(struct ib_block_iter *biter,
2788                              struct scatterlist *sglist,
2789                              unsigned int nents,
2790                              unsigned long pgsz);
2791 bool __rdma_block_iter_next(struct ib_block_iter *biter);
2792
2793 /**
2794  * rdma_block_iter_dma_address - get the aligned dma address of the current
2795  * block held by the block iterator.
2796  * @biter: block iterator holding the memory block
2797  */
2798 static inline dma_addr_t
2799 rdma_block_iter_dma_address(struct ib_block_iter *biter)
2800 {
2801         return biter->__dma_addr & ~(BIT_ULL(biter->__pg_bit) - 1);
2802 }
2803
2804 /**
2805  * rdma_for_each_block - iterate over contiguous memory blocks of the sg list
2806  * @sglist: sglist to iterate over
2807  * @biter: block iterator holding the memory block
2808  * @nents: maximum number of sg entries to iterate over
2809  * @pgsz: best HW supported page size to use
2810  *
2811  * Callers may use rdma_block_iter_dma_address() to get each
2812  * blocks aligned DMA address.
2813  */
2814 #define rdma_for_each_block(sglist, biter, nents, pgsz)         \
2815         for (__rdma_block_iter_start(biter, sglist, nents,      \
2816                                      pgsz);                     \
2817              __rdma_block_iter_next(biter);)
2818
2819 /**
2820  * ib_get_client_data - Get IB client context
2821  * @device:Device to get context for
2822  * @client:Client to get context for
2823  *
2824  * ib_get_client_data() returns the client context data set with
2825  * ib_set_client_data(). This can only be called while the client is
2826  * registered to the device, once the ib_client remove() callback returns this
2827  * cannot be called.
2828  */
2829 static inline void *ib_get_client_data(struct ib_device *device,
2830                                        struct ib_client *client)
2831 {
2832         return xa_load(&device->client_data, client->client_id);
2833 }
2834 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
2835                          void *data);
2836 void ib_set_device_ops(struct ib_device *device,
2837                        const struct ib_device_ops *ops);
2838
2839 int rdma_user_mmap_io(struct ib_ucontext *ucontext, struct vm_area_struct *vma,
2840                       unsigned long pfn, unsigned long size, pgprot_t prot,
2841                       struct rdma_user_mmap_entry *entry);
2842 int rdma_user_mmap_entry_insert(struct ib_ucontext *ucontext,
2843                                 struct rdma_user_mmap_entry *entry,
2844                                 size_t length);
2845 int rdma_user_mmap_entry_insert_range(struct ib_ucontext *ucontext,
2846                                       struct rdma_user_mmap_entry *entry,
2847                                       size_t length, u32 min_pgoff,
2848                                       u32 max_pgoff);
2849
2850 struct rdma_user_mmap_entry *
2851 rdma_user_mmap_entry_get_pgoff(struct ib_ucontext *ucontext,
2852                                unsigned long pgoff);
2853 struct rdma_user_mmap_entry *
2854 rdma_user_mmap_entry_get(struct ib_ucontext *ucontext,
2855                          struct vm_area_struct *vma);
2856 void rdma_user_mmap_entry_put(struct rdma_user_mmap_entry *entry);
2857
2858 void rdma_user_mmap_entry_remove(struct rdma_user_mmap_entry *entry);
2859
2860 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
2861 {
2862         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
2863 }
2864
2865 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
2866 {
2867         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
2868 }
2869
2870 static inline bool ib_is_buffer_cleared(const void __user *p,
2871                                         size_t len)
2872 {
2873         bool ret;
2874         u8 *buf;
2875
2876         if (len > USHRT_MAX)
2877                 return false;
2878
2879         buf = memdup_user(p, len);
2880         if (IS_ERR(buf))
2881                 return false;
2882
2883         ret = !memchr_inv(buf, 0, len);
2884         kfree(buf);
2885         return ret;
2886 }
2887
2888 static inline bool ib_is_udata_cleared(struct ib_udata *udata,
2889                                        size_t offset,
2890                                        size_t len)
2891 {
2892         return ib_is_buffer_cleared(udata->inbuf + offset, len);
2893 }
2894
2895 /**
2896  * ib_is_destroy_retryable - Check whether the uobject destruction
2897  * is retryable.
2898  * @ret: The initial destruction return code
2899  * @why: remove reason
2900  * @uobj: The uobject that is destroyed
2901  *
2902  * This function is a helper function that IB layer and low-level drivers
2903  * can use to consider whether the destruction of the given uobject is
2904  * retry-able.
2905  * It checks the original return code, if it wasn't success the destruction
2906  * is retryable according to the ucontext state (i.e. cleanup_retryable) and
2907  * the remove reason. (i.e. why).
2908  * Must be called with the object locked for destroy.
2909  */
2910 static inline bool ib_is_destroy_retryable(int ret, enum rdma_remove_reason why,
2911                                            struct ib_uobject *uobj)
2912 {
2913         return ret && (why == RDMA_REMOVE_DESTROY ||
2914                        uobj->context->cleanup_retryable);
2915 }
2916
2917 /**
2918  * ib_destroy_usecnt - Called during destruction to check the usecnt
2919  * @usecnt: The usecnt atomic
2920  * @why: remove reason
2921  * @uobj: The uobject that is destroyed
2922  *
2923  * Non-zero usecnts will block destruction unless destruction was triggered by
2924  * a ucontext cleanup.
2925  */
2926 static inline int ib_destroy_usecnt(atomic_t *usecnt,
2927                                     enum rdma_remove_reason why,
2928                                     struct ib_uobject *uobj)
2929 {
2930         if (atomic_read(usecnt) && ib_is_destroy_retryable(-EBUSY, why, uobj))
2931                 return -EBUSY;
2932         return 0;
2933 }
2934
2935 /**
2936  * ib_modify_qp_is_ok - Check that the supplied attribute mask
2937  * contains all required attributes and no attributes not allowed for
2938  * the given QP state transition.
2939  * @cur_state: Current QP state
2940  * @next_state: Next QP state
2941  * @type: QP type
2942  * @mask: Mask of supplied QP attributes
2943  *
2944  * This function is a helper function that a low-level driver's
2945  * modify_qp method can use to validate the consumer's input.  It
2946  * checks that cur_state and next_state are valid QP states, that a
2947  * transition from cur_state to next_state is allowed by the IB spec,
2948  * and that the attribute mask supplied is allowed for the transition.
2949  */
2950 bool ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
2951                         enum ib_qp_type type, enum ib_qp_attr_mask mask);
2952
2953 void ib_register_event_handler(struct ib_event_handler *event_handler);
2954 void ib_unregister_event_handler(struct ib_event_handler *event_handler);
2955 void ib_dispatch_event(const struct ib_event *event);
2956
2957 int ib_query_port(struct ib_device *device,
2958                   u8 port_num, struct ib_port_attr *port_attr);
2959
2960 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
2961                                                u8 port_num);
2962
2963 /**
2964  * rdma_cap_ib_switch - Check if the device is IB switch
2965  * @device: Device to check
2966  *
2967  * Device driver is responsible for setting is_switch bit on
2968  * in ib_device structure at init time.
2969  *
2970  * Return: true if the device is IB switch.
2971  */
2972 static inline bool rdma_cap_ib_switch(const struct ib_device *device)
2973 {
2974         return device->is_switch;
2975 }
2976
2977 /**
2978  * rdma_start_port - Return the first valid port number for the device
2979  * specified
2980  *
2981  * @device: Device to be checked
2982  *
2983  * Return start port number
2984  */
2985 static inline u8 rdma_start_port(const struct ib_device *device)
2986 {
2987         return rdma_cap_ib_switch(device) ? 0 : 1;
2988 }
2989
2990 /**
2991  * rdma_for_each_port - Iterate over all valid port numbers of the IB device
2992  * @device - The struct ib_device * to iterate over
2993  * @iter - The unsigned int to store the port number
2994  */
2995 #define rdma_for_each_port(device, iter)                                       \
2996         for (iter = rdma_start_port(device + BUILD_BUG_ON_ZERO(!__same_type(   \
2997                                                      unsigned int, iter)));    \
2998              iter <= rdma_end_port(device); (iter)++)
2999
3000 /**
3001  * rdma_end_port - Return the last valid port number for the device
3002  * specified
3003  *
3004  * @device: Device to be checked
3005  *
3006  * Return last port number
3007  */
3008 static inline u8 rdma_end_port(const struct ib_device *device)
3009 {
3010         return rdma_cap_ib_switch(device) ? 0 : device->phys_port_cnt;
3011 }
3012
3013 static inline int rdma_is_port_valid(const struct ib_device *device,
3014                                      unsigned int port)
3015 {
3016         return (port >= rdma_start_port(device) &&
3017                 port <= rdma_end_port(device));
3018 }
3019
3020 static inline bool rdma_is_grh_required(const struct ib_device *device,
3021                                         u8 port_num)
3022 {
3023         return device->port_data[port_num].immutable.core_cap_flags &
3024                RDMA_CORE_PORT_IB_GRH_REQUIRED;
3025 }
3026
3027 static inline bool rdma_protocol_ib(const struct ib_device *device, u8 port_num)
3028 {
3029         return device->port_data[port_num].immutable.core_cap_flags &
3030                RDMA_CORE_CAP_PROT_IB;
3031 }
3032
3033 static inline bool rdma_protocol_roce(const struct ib_device *device, u8 port_num)
3034 {
3035         return device->port_data[port_num].immutable.core_cap_flags &
3036                (RDMA_CORE_CAP_PROT_ROCE | RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP);
3037 }
3038
3039 static inline bool rdma_protocol_roce_udp_encap(const struct ib_device *device, u8 port_num)
3040 {
3041         return device->port_data[port_num].immutable.core_cap_flags &
3042                RDMA_CORE_CAP_PROT_ROCE_UDP_ENCAP;
3043 }
3044
3045 static inline bool rdma_protocol_roce_eth_encap(const struct ib_device *device, u8 port_num)
3046 {
3047         return device->port_data[port_num].immutable.core_cap_flags &
3048                RDMA_CORE_CAP_PROT_ROCE;
3049 }
3050
3051 static inline bool rdma_protocol_iwarp(const struct ib_device *device, u8 port_num)
3052 {
3053         return device->port_data[port_num].immutable.core_cap_flags &
3054                RDMA_CORE_CAP_PROT_IWARP;
3055 }
3056
3057 static inline bool rdma_ib_or_roce(const struct ib_device *device, u8 port_num)
3058 {
3059         return rdma_protocol_ib(device, port_num) ||
3060                 rdma_protocol_roce(device, port_num);
3061 }
3062
3063 static inline bool rdma_protocol_raw_packet(const struct ib_device *device, u8 port_num)
3064 {
3065         return device->port_data[port_num].immutable.core_cap_flags &
3066                RDMA_CORE_CAP_PROT_RAW_PACKET;
3067 }
3068
3069 static inline bool rdma_protocol_usnic(const struct ib_device *device, u8 port_num)
3070 {
3071         return device->port_data[port_num].immutable.core_cap_flags &
3072                RDMA_CORE_CAP_PROT_USNIC;
3073 }
3074
3075 /**
3076  * rdma_cap_ib_mad - Check if the port of a device supports Infiniband
3077  * Management Datagrams.
3078  * @device: Device to check
3079  * @port_num: Port number to check
3080  *
3081  * Management Datagrams (MAD) are a required part of the InfiniBand
3082  * specification and are supported on all InfiniBand devices.  A slightly
3083  * extended version are also supported on OPA interfaces.
3084  *
3085  * Return: true if the port supports sending/receiving of MAD packets.
3086  */
3087 static inline bool rdma_cap_ib_mad(const struct ib_device *device, u8 port_num)
3088 {
3089         return device->port_data[port_num].immutable.core_cap_flags &
3090                RDMA_CORE_CAP_IB_MAD;
3091 }
3092
3093 /**
3094  * rdma_cap_opa_mad - Check if the port of device provides support for OPA
3095  * Management Datagrams.
3096  * @device: Device to check
3097  * @port_num: Port number to check
3098  *
3099  * Intel OmniPath devices extend and/or replace the InfiniBand Management
3100  * datagrams with their own versions.  These OPA MADs share many but not all of
3101  * the characteristics of InfiniBand MADs.
3102  *
3103  * OPA MADs differ in the following ways:
3104  *
3105  *    1) MADs are variable size up to 2K
3106  *       IBTA defined MADs remain fixed at 256 bytes
3107  *    2) OPA SMPs must carry valid PKeys
3108  *    3) OPA SMP packets are a different format
3109  *
3110  * Return: true if the port supports OPA MAD packet formats.
3111  */
3112 static inline bool rdma_cap_opa_mad(struct ib_device *device, u8 port_num)
3113 {
3114         return device->port_data[port_num].immutable.core_cap_flags &
3115                 RDMA_CORE_CAP_OPA_MAD;
3116 }
3117
3118 /**
3119  * rdma_cap_ib_smi - Check if the port of a device provides an Infiniband
3120  * Subnet Management Agent (SMA) on the Subnet Management Interface (SMI).
3121  * @device: Device to check
3122  * @port_num: Port number to check
3123  *
3124  * Each InfiniBand node is required to provide a Subnet Management Agent
3125  * that the subnet manager can access.  Prior to the fabric being fully
3126  * configured by the subnet manager, the SMA is accessed via a well known
3127  * interface called the Subnet Management Interface (SMI).  This interface
3128  * uses directed route packets to communicate with the SM to get around the
3129  * chicken and egg problem of the SM needing to know what's on the fabric
3130  * in order to configure the fabric, and needing to configure the fabric in
3131  * order to send packets to the devices on the fabric.  These directed
3132  * route packets do not need the fabric fully configured in order to reach
3133  * their destination.  The SMI is the only method allowed to send
3134  * directed route packets on an InfiniBand fabric.
3135  *
3136  * Return: true if the port provides an SMI.
3137  */
3138 static inline bool rdma_cap_ib_smi(const struct ib_device *device, u8 port_num)
3139 {
3140         return device->port_data[port_num].immutable.core_cap_flags &
3141                RDMA_CORE_CAP_IB_SMI;
3142 }
3143
3144 /**
3145  * rdma_cap_ib_cm - Check if the port of device has the capability Infiniband
3146  * Communication Manager.
3147  * @device: Device to check
3148  * @port_num: Port number to check
3149  *
3150  * The InfiniBand Communication Manager is one of many pre-defined General
3151  * Service Agents (GSA) that are accessed via the General Service
3152  * Interface (GSI).  It's role is to facilitate establishment of connections
3153  * between nodes as well as other management related tasks for established
3154  * connections.
3155  *
3156  * Return: true if the port supports an IB CM (this does not guarantee that
3157  * a CM is actually running however).
3158  */
3159 static inline bool rdma_cap_ib_cm(const struct ib_device *device, u8 port_num)
3160 {
3161         return device->port_data[port_num].immutable.core_cap_flags &
3162                RDMA_CORE_CAP_IB_CM;
3163 }
3164
3165 /**
3166  * rdma_cap_iw_cm - Check if the port of device has the capability IWARP
3167  * Communication Manager.
3168  * @device: Device to check
3169  * @port_num: Port number to check
3170  *
3171  * Similar to above, but specific to iWARP connections which have a different
3172  * managment protocol than InfiniBand.
3173  *
3174  * Return: true if the port supports an iWARP CM (this does not guarantee that
3175  * a CM is actually running however).
3176  */
3177 static inline bool rdma_cap_iw_cm(const struct ib_device *device, u8 port_num)
3178 {
3179         return device->port_data[port_num].immutable.core_cap_flags &
3180                RDMA_CORE_CAP_IW_CM;
3181 }
3182
3183 /**
3184  * rdma_cap_ib_sa - Check if the port of device has the capability Infiniband
3185  * Subnet Administration.
3186  * @device: Device to check
3187  * @port_num: Port number to check
3188  *
3189  * An InfiniBand Subnet Administration (SA) service is a pre-defined General
3190  * Service Agent (GSA) provided by the Subnet Manager (SM).  On InfiniBand
3191  * fabrics, devices should resolve routes to other hosts by contacting the
3192  * SA to query the proper route.
3193  *
3194  * Return: true if the port should act as a client to the fabric Subnet
3195  * Administration interface.  This does not imply that the SA service is
3196  * running locally.
3197  */
3198 static inline bool rdma_cap_ib_sa(const struct ib_device *device, u8 port_num)
3199 {
3200         return device->port_data[port_num].immutable.core_cap_flags &
3201                RDMA_CORE_CAP_IB_SA;
3202 }
3203
3204 /**
3205  * rdma_cap_ib_mcast - Check if the port of device has the capability Infiniband
3206  * Multicast.
3207  * @device: Device to check
3208  * @port_num: Port number to check
3209  *
3210  * InfiniBand multicast registration is more complex than normal IPv4 or
3211  * IPv6 multicast registration.  Each Host Channel Adapter must register
3212  * with the Subnet Manager when it wishes to join a multicast group.  It
3213  * should do so only once regardless of how many queue pairs it subscribes
3214  * to this group.  And it should leave the group only after all queue pairs
3215  * attached to the group have been detached.
3216  *
3217  * Return: true if the port must undertake the additional adminstrative
3218  * overhead of registering/unregistering with the SM and tracking of the
3219  * total number of queue pairs attached to the multicast group.
3220  */
3221 static inline bool rdma_cap_ib_mcast(const struct ib_device *device, u8 port_num)
3222 {
3223         return rdma_cap_ib_sa(device, port_num);
3224 }
3225
3226 /**
3227  * rdma_cap_af_ib - Check if the port of device has the capability
3228  * Native Infiniband Address.
3229  * @device: Device to check
3230  * @port_num: Port number to check
3231  *
3232  * InfiniBand addressing uses a port's GUID + Subnet Prefix to make a default
3233  * GID.  RoCE uses a different mechanism, but still generates a GID via
3234  * a prescribed mechanism and port specific data.
3235  *
3236  * Return: true if the port uses a GID address to identify devices on the
3237  * network.
3238  */
3239 static inline bool rdma_cap_af_ib(const struct ib_device *device, u8 port_num)
3240 {
3241         return device->port_data[port_num].immutable.core_cap_flags &
3242                RDMA_CORE_CAP_AF_IB;
3243 }
3244
3245 /**
3246  * rdma_cap_eth_ah - Check if the port of device has the capability
3247  * Ethernet Address Handle.
3248  * @device: Device to check
3249  * @port_num: Port number to check
3250  *
3251  * RoCE is InfiniBand over Ethernet, and it uses a well defined technique
3252  * to fabricate GIDs over Ethernet/IP specific addresses native to the
3253  * port.  Normally, packet headers are generated by the sending host
3254  * adapter, but when sending connectionless datagrams, we must manually
3255  * inject the proper headers for the fabric we are communicating over.
3256  *
3257  * Return: true if we are running as a RoCE port and must force the
3258  * addition of a Global Route Header built from our Ethernet Address
3259  * Handle into our header list for connectionless packets.
3260  */
3261 static inline bool rdma_cap_eth_ah(const struct ib_device *device, u8 port_num)
3262 {
3263         return device->port_data[port_num].immutable.core_cap_flags &
3264                RDMA_CORE_CAP_ETH_AH;
3265 }
3266
3267 /**
3268  * rdma_cap_opa_ah - Check if the port of device supports
3269  * OPA Address handles
3270  * @device: Device to check
3271  * @port_num: Port number to check
3272  *
3273  * Return: true if we are running on an OPA device which supports
3274  * the extended OPA addressing.
3275  */
3276 static inline bool rdma_cap_opa_ah(struct ib_device *device, u8 port_num)
3277 {
3278         return (device->port_data[port_num].immutable.core_cap_flags &
3279                 RDMA_CORE_CAP_OPA_AH) == RDMA_CORE_CAP_OPA_AH;
3280 }
3281
3282 /**
3283  * rdma_max_mad_size - Return the max MAD size required by this RDMA Port.
3284  *
3285  * @device: Device
3286  * @port_num: Port number
3287  *
3288  * This MAD size includes the MAD headers and MAD payload.  No other headers
3289  * are included.
3290  *
3291  * Return the max MAD size required by the Port.  Will return 0 if the port
3292  * does not support MADs
3293  */
3294 static inline size_t rdma_max_mad_size(const struct ib_device *device, u8 port_num)
3295 {
3296         return device->port_data[port_num].immutable.max_mad_size;
3297 }
3298
3299 /**
3300  * rdma_cap_roce_gid_table - Check if the port of device uses roce_gid_table
3301  * @device: Device to check
3302  * @port_num: Port number to check
3303  *
3304  * RoCE GID table mechanism manages the various GIDs for a device.
3305  *
3306  * NOTE: if allocating the port's GID table has failed, this call will still
3307  * return true, but any RoCE GID table API will fail.
3308  *
3309  * Return: true if the port uses RoCE GID table mechanism in order to manage
3310  * its GIDs.
3311  */
3312 static inline bool rdma_cap_roce_gid_table(const struct ib_device *device,
3313                                            u8 port_num)
3314 {
3315         return rdma_protocol_roce(device, port_num) &&
3316                 device->ops.add_gid && device->ops.del_gid;
3317 }
3318
3319 /*
3320  * Check if the device supports READ W/ INVALIDATE.
3321  */
3322 static inline bool rdma_cap_read_inv(struct ib_device *dev, u32 port_num)
3323 {
3324         /*
3325          * iWarp drivers must support READ W/ INVALIDATE.  No other protocol
3326          * has support for it yet.
3327          */
3328         return rdma_protocol_iwarp(dev, port_num);
3329 }
3330
3331 /**
3332  * rdma_find_pg_bit - Find page bit given address and HW supported page sizes
3333  *
3334  * @addr: address
3335  * @pgsz_bitmap: bitmap of HW supported page sizes
3336  */
3337 static inline unsigned int rdma_find_pg_bit(unsigned long addr,
3338                                             unsigned long pgsz_bitmap)
3339 {
3340         unsigned long align;
3341         unsigned long pgsz;
3342
3343         align = addr & -addr;
3344
3345         /* Find page bit such that addr is aligned to the highest supported
3346          * HW page size
3347          */
3348         pgsz = pgsz_bitmap & ~(-align << 1);
3349         if (!pgsz)
3350                 return __ffs(pgsz_bitmap);
3351
3352         return __fls(pgsz);
3353 }
3354
3355 int ib_set_vf_link_state(struct ib_device *device, int vf, u8 port,
3356                          int state);
3357 int ib_get_vf_config(struct ib_device *device, int vf, u8 port,
3358                      struct ifla_vf_info *info);
3359 int ib_get_vf_stats(struct ib_device *device, int vf, u8 port,
3360                     struct ifla_vf_stats *stats);
3361 int ib_get_vf_guid(struct ib_device *device, int vf, u8 port,
3362                     struct ifla_vf_guid *node_guid,
3363                     struct ifla_vf_guid *port_guid);
3364 int ib_set_vf_guid(struct ib_device *device, int vf, u8 port, u64 guid,
3365                    int type);
3366
3367 int ib_query_pkey(struct ib_device *device,
3368                   u8 port_num, u16 index, u16 *pkey);
3369
3370 int ib_modify_device(struct ib_device *device,
3371                      int device_modify_mask,
3372                      struct ib_device_modify *device_modify);
3373
3374 int ib_modify_port(struct ib_device *device,
3375                    u8 port_num, int port_modify_mask,
3376                    struct ib_port_modify *port_modify);
3377
3378 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
3379                 u8 *port_num, u16 *index);
3380
3381 int ib_find_pkey(struct ib_device *device,
3382                  u8 port_num, u16 pkey, u16 *index);
3383
3384 enum ib_pd_flags {
3385         /*
3386          * Create a memory registration for all memory in the system and place
3387          * the rkey for it into pd->unsafe_global_rkey.  This can be used by
3388          * ULPs to avoid the overhead of dynamic MRs.
3389          *
3390          * This flag is generally considered unsafe and must only be used in
3391          * extremly trusted environments.  Every use of it will log a warning
3392          * in the kernel log.
3393          */
3394         IB_PD_UNSAFE_GLOBAL_RKEY        = 0x01,
3395 };
3396
3397 struct ib_pd *__ib_alloc_pd(struct ib_device *device, unsigned int flags,
3398                 const char *caller);
3399
3400 #define ib_alloc_pd(device, flags) \
3401         __ib_alloc_pd((device), (flags), KBUILD_MODNAME)
3402
3403 /**
3404  * ib_dealloc_pd_user - Deallocate kernel/user PD
3405  * @pd: The protection domain
3406  * @udata: Valid user data or NULL for kernel objects
3407  */
3408 void ib_dealloc_pd_user(struct ib_pd *pd, struct ib_udata *udata);
3409
3410 /**
3411  * ib_dealloc_pd - Deallocate kernel PD
3412  * @pd: The protection domain
3413  *
3414  * NOTE: for user PD use ib_dealloc_pd_user with valid udata!
3415  */
3416 static inline void ib_dealloc_pd(struct ib_pd *pd)
3417 {
3418         ib_dealloc_pd_user(pd, NULL);
3419 }
3420
3421 enum rdma_create_ah_flags {
3422         /* In a sleepable context */
3423         RDMA_CREATE_AH_SLEEPABLE = BIT(0),
3424 };
3425
3426 /**
3427  * rdma_create_ah - Creates an address handle for the given address vector.
3428  * @pd: The protection domain associated with the address handle.
3429  * @ah_attr: The attributes of the address vector.
3430  * @flags: Create address handle flags (see enum rdma_create_ah_flags).
3431  *
3432  * The address handle is used to reference a local or global destination
3433  * in all UD QP post sends.
3434  */
3435 struct ib_ah *rdma_create_ah(struct ib_pd *pd, struct rdma_ah_attr *ah_attr,
3436                              u32 flags);
3437
3438 /**
3439  * rdma_create_user_ah - Creates an address handle for the given address vector.
3440  * It resolves destination mac address for ah attribute of RoCE type.
3441  * @pd: The protection domain associated with the address handle.
3442  * @ah_attr: The attributes of the address vector.
3443  * @udata: pointer to user's input output buffer information need by
3444  *         provider driver.
3445  *
3446  * It returns 0 on success and returns appropriate error code on error.
3447  * The address handle is used to reference a local or global destination
3448  * in all UD QP post sends.
3449  */
3450 struct ib_ah *rdma_create_user_ah(struct ib_pd *pd,
3451                                   struct rdma_ah_attr *ah_attr,
3452                                   struct ib_udata *udata);
3453 /**
3454  * ib_get_gids_from_rdma_hdr - Get sgid and dgid from GRH or IPv4 header
3455  *   work completion.
3456  * @hdr: the L3 header to parse
3457  * @net_type: type of header to parse
3458  * @sgid: place to store source gid
3459  * @dgid: place to store destination gid
3460  */
3461 int ib_get_gids_from_rdma_hdr(const union rdma_network_hdr *hdr,
3462                               enum rdma_network_type net_type,
3463                               union ib_gid *sgid, union ib_gid *dgid);
3464
3465 /**
3466  * ib_get_rdma_header_version - Get the header version
3467  * @hdr: the L3 header to parse
3468  */
3469 int ib_get_rdma_header_version(const union rdma_network_hdr *hdr);
3470
3471 /**
3472  * ib_init_ah_attr_from_wc - Initializes address handle attributes from a
3473  *   work completion.
3474  * @device: Device on which the received message arrived.
3475  * @port_num: Port on which the received message arrived.
3476  * @wc: Work completion associated with the received message.
3477  * @grh: References the received global route header.  This parameter is
3478  *   ignored unless the work completion indicates that the GRH is valid.
3479  * @ah_attr: Returned attributes that can be used when creating an address
3480  *   handle for replying to the message.
3481  * When ib_init_ah_attr_from_wc() returns success,
3482  * (a) for IB link layer it optionally contains a reference to SGID attribute
3483  * when GRH is present for IB link layer.
3484  * (b) for RoCE link layer it contains a reference to SGID attribute.
3485  * User must invoke rdma_cleanup_ah_attr_gid_attr() to release reference to SGID
3486  * attributes which are initialized using ib_init_ah_attr_from_wc().
3487  *
3488  */
3489 int ib_init_ah_attr_from_wc(struct ib_device *device, u8 port_num,
3490                             const struct ib_wc *wc, const struct ib_grh *grh,
3491                             struct rdma_ah_attr *ah_attr);
3492
3493 /**
3494  * ib_create_ah_from_wc - Creates an address handle associated with the
3495  *   sender of the specified work completion.
3496  * @pd: The protection domain associated with the address handle.
3497  * @wc: Work completion information associated with a received message.
3498  * @grh: References the received global route header.  This parameter is
3499  *   ignored unless the work completion indicates that the GRH is valid.
3500  * @port_num: The outbound port number to associate with the address.
3501  *
3502  * The address handle is used to reference a local or global destination
3503  * in all UD QP post sends.
3504  */
3505 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, const struct ib_wc *wc,
3506                                    const struct ib_grh *grh, u8 port_num);
3507
3508 /**
3509  * rdma_modify_ah - Modifies the address vector associated with an address
3510  *   handle.
3511  * @ah: The address handle to modify.
3512  * @ah_attr: The new address vector attributes to associate with the
3513  *   address handle.
3514  */
3515 int rdma_modify_ah(struct ib_ah *ah, struct rdma_ah_attr *ah_attr);
3516
3517 /**
3518  * rdma_query_ah - Queries the address vector associated with an address
3519  *   handle.
3520  * @ah: The address handle to query.
3521  * @ah_attr: The address vector attributes associated with the address
3522  *   handle.
3523  */
3524 int rdma_query_ah(struct ib_ah *ah, struct rdma_ah_attr *ah_attr);
3525
3526 enum rdma_destroy_ah_flags {
3527         /* In a sleepable context */
3528         RDMA_DESTROY_AH_SLEEPABLE = BIT(0),
3529 };
3530
3531 /**
3532  * rdma_destroy_ah_user - Destroys an address handle.
3533  * @ah: The address handle to destroy.
3534  * @flags: Destroy address handle flags (see enum rdma_destroy_ah_flags).
3535  * @udata: Valid user data or NULL for kernel objects
3536  */
3537 int rdma_destroy_ah_user(struct ib_ah *ah, u32 flags, struct ib_udata *udata);
3538
3539 /**
3540  * rdma_destroy_ah - Destroys an kernel address handle.
3541  * @ah: The address handle to destroy.
3542  * @flags: Destroy address handle flags (see enum rdma_destroy_ah_flags).
3543  *
3544  * NOTE: for user ah use rdma_destroy_ah_user with valid udata!
3545  */
3546 static inline int rdma_destroy_ah(struct ib_ah *ah, u32 flags)
3547 {
3548         return rdma_destroy_ah_user(ah, flags, NULL);
3549 }
3550
3551 /**
3552  * ib_create_srq - Creates a SRQ associated with the specified protection
3553  *   domain.
3554  * @pd: The protection domain associated with the SRQ.
3555  * @srq_init_attr: A list of initial attributes required to create the
3556  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
3557  *   the actual capabilities of the created SRQ.
3558  *
3559  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
3560  * requested size of the SRQ, and set to the actual values allocated
3561  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
3562  * will always be at least as large as the requested values.
3563  */
3564 struct ib_srq *ib_create_srq(struct ib_pd *pd,
3565                              struct ib_srq_init_attr *srq_init_attr);
3566
3567 /**
3568  * ib_modify_srq - Modifies the attributes for the specified SRQ.
3569  * @srq: The SRQ to modify.
3570  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
3571  *   the current values of selected SRQ attributes are returned.
3572  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
3573  *   are being modified.
3574  *
3575  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
3576  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
3577  * the number of receives queued drops below the limit.
3578  */
3579 int ib_modify_srq(struct ib_srq *srq,
3580                   struct ib_srq_attr *srq_attr,
3581                   enum ib_srq_attr_mask srq_attr_mask);
3582
3583 /**
3584  * ib_query_srq - Returns the attribute list and current values for the
3585  *   specified SRQ.
3586  * @srq: The SRQ to query.
3587  * @srq_attr: The attributes of the specified SRQ.
3588  */
3589 int ib_query_srq(struct ib_srq *srq,
3590                  struct ib_srq_attr *srq_attr);
3591
3592 /**
3593  * ib_destroy_srq_user - Destroys the specified SRQ.
3594  * @srq: The SRQ to destroy.
3595  * @udata: Valid user data or NULL for kernel objects
3596  */
3597 int ib_destroy_srq_user(struct ib_srq *srq, struct ib_udata *udata);
3598
3599 /**
3600  * ib_destroy_srq - Destroys the specified kernel SRQ.
3601  * @srq: The SRQ to destroy.
3602  *
3603  * NOTE: for user srq use ib_destroy_srq_user with valid udata!
3604  */
3605 static inline int ib_destroy_srq(struct ib_srq *srq)
3606 {
3607         return ib_destroy_srq_user(srq, NULL);
3608 }
3609
3610 /**
3611  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
3612  * @srq: The SRQ to post the work request on.
3613  * @recv_wr: A list of work requests to post on the receive queue.
3614  * @bad_recv_wr: On an immediate failure, this parameter will reference
3615  *   the work request that failed to be posted on the QP.
3616  */
3617 static inline int ib_post_srq_recv(struct ib_srq *srq,
3618                                    const struct ib_recv_wr *recv_wr,
3619                                    const struct ib_recv_wr **bad_recv_wr)
3620 {
3621         const struct ib_recv_wr *dummy;
3622
3623         return srq->device->ops.post_srq_recv(srq, recv_wr,
3624                                               bad_recv_wr ? : &dummy);
3625 }
3626
3627 /**
3628  * ib_create_qp_user - Creates a QP associated with the specified protection
3629  *   domain.
3630  * @pd: The protection domain associated with the QP.
3631  * @qp_init_attr: A list of initial attributes required to create the
3632  *   QP.  If QP creation succeeds, then the attributes are updated to
3633  *   the actual capabilities of the created QP.
3634  * @udata: Valid user data or NULL for kernel objects
3635  */
3636 struct ib_qp *ib_create_qp_user(struct ib_pd *pd,
3637                                 struct ib_qp_init_attr *qp_init_attr,
3638                                 struct ib_udata *udata);
3639
3640 /**
3641  * ib_create_qp - Creates a kernel QP associated with the specified protection
3642  *   domain.
3643  * @pd: The protection domain associated with the QP.
3644  * @qp_init_attr: A list of initial attributes required to create the
3645  *   QP.  If QP creation succeeds, then the attributes are updated to
3646  *   the actual capabilities of the created QP.
3647  * @udata: Valid user data or NULL for kernel objects
3648  *
3649  * NOTE: for user qp use ib_create_qp_user with valid udata!
3650  */
3651 static inline struct ib_qp *ib_create_qp(struct ib_pd *pd,
3652                                          struct ib_qp_init_attr *qp_init_attr)
3653 {
3654         return ib_create_qp_user(pd, qp_init_attr, NULL);
3655 }
3656
3657 /**
3658  * ib_modify_qp_with_udata - Modifies the attributes for the specified QP.
3659  * @qp: The QP to modify.
3660  * @attr: On input, specifies the QP attributes to modify.  On output,
3661  *   the current values of selected QP attributes are returned.
3662  * @attr_mask: A bit-mask used to specify which attributes of the QP
3663  *   are being modified.
3664  * @udata: pointer to user's input output buffer information
3665  *   are being modified.
3666  * It returns 0 on success and returns appropriate error code on error.
3667  */
3668 int ib_modify_qp_with_udata(struct ib_qp *qp,
3669                             struct ib_qp_attr *attr,
3670                             int attr_mask,
3671                             struct ib_udata *udata);
3672
3673 /**
3674  * ib_modify_qp - Modifies the attributes for the specified QP and then
3675  *   transitions the QP to the given state.
3676  * @qp: The QP to modify.
3677  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
3678  *   the current values of selected QP attributes are returned.
3679  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
3680  *   are being modified.
3681  */
3682 int ib_modify_qp(struct ib_qp *qp,
3683                  struct ib_qp_attr *qp_attr,
3684                  int qp_attr_mask);
3685
3686 /**
3687  * ib_query_qp - Returns the attribute list and current values for the
3688  *   specified QP.
3689  * @qp: The QP to query.
3690  * @qp_attr: The attributes of the specified QP.
3691  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
3692  * @qp_init_attr: Additional attributes of the selected QP.
3693  *
3694  * The qp_attr_mask may be used to limit the query to gathering only the
3695  * selected attributes.
3696  */
3697 int ib_query_qp(struct ib_qp *qp,
3698                 struct ib_qp_attr *qp_attr,
3699                 int qp_attr_mask,
3700                 struct ib_qp_init_attr *qp_init_attr);
3701
3702 /**
3703  * ib_destroy_qp - Destroys the specified QP.
3704  * @qp: The QP to destroy.
3705  * @udata: Valid udata or NULL for kernel objects
3706  */
3707 int ib_destroy_qp_user(struct ib_qp *qp, struct ib_udata *udata);
3708
3709 /**
3710  * ib_destroy_qp - Destroys the specified kernel QP.
3711  * @qp: The QP to destroy.
3712  *
3713  * NOTE: for user qp use ib_destroy_qp_user with valid udata!
3714  */
3715 static inline int ib_destroy_qp(struct ib_qp *qp)
3716 {
3717         return ib_destroy_qp_user(qp, NULL);
3718 }
3719
3720 /**
3721  * ib_open_qp - Obtain a reference to an existing sharable QP.
3722  * @xrcd - XRC domain
3723  * @qp_open_attr: Attributes identifying the QP to open.
3724  *
3725  * Returns a reference to a sharable QP.
3726  */
3727 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
3728                          struct ib_qp_open_attr *qp_open_attr);
3729
3730 /**
3731  * ib_close_qp - Release an external reference to a QP.
3732  * @qp: The QP handle to release
3733  *
3734  * The opened QP handle is released by the caller.  The underlying
3735  * shared QP is not destroyed until all internal references are released.
3736  */
3737 int ib_close_qp(struct ib_qp *qp);
3738
3739 /**
3740  * ib_post_send - Posts a list of work requests to the send queue of
3741  *   the specified QP.
3742  * @qp: The QP to post the work request on.
3743  * @send_wr: A list of work requests to post on the send queue.
3744  * @bad_send_wr: On an immediate failure, this parameter will reference
3745  *   the work request that failed to be posted on the QP.
3746  *
3747  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
3748  * error is returned, the QP state shall not be affected,
3749  * ib_post_send() will return an immediate error after queueing any
3750  * earlier work requests in the list.
3751  */
3752 static inline int ib_post_send(struct ib_qp *qp,
3753                                const struct ib_send_wr *send_wr,
3754                                const struct ib_send_wr **bad_send_wr)
3755 {
3756         const struct ib_send_wr *dummy;
3757
3758         return qp->device->ops.post_send(qp, send_wr, bad_send_wr ? : &dummy);
3759 }
3760
3761 /**
3762  * ib_post_recv - Posts a list of work requests to the receive queue of
3763  *   the specified QP.
3764  * @qp: The QP to post the work request on.
3765  * @recv_wr: A list of work requests to post on the receive queue.
3766  * @bad_recv_wr: On an immediate failure, this parameter will reference
3767  *   the work request that failed to be posted on the QP.
3768  */
3769 static inline int ib_post_recv(struct ib_qp *qp,
3770                                const struct ib_recv_wr *recv_wr,
3771                                const struct ib_recv_wr **bad_recv_wr)
3772 {
3773         const struct ib_recv_wr *dummy;
3774
3775         return qp->device->ops.post_recv(qp, recv_wr, bad_recv_wr ? : &dummy);
3776 }
3777
3778 struct ib_cq *__ib_alloc_cq_user(struct ib_device *dev, void *private,
3779                                  int nr_cqe, int comp_vector,
3780                                  enum ib_poll_context poll_ctx,
3781                                  const char *caller, struct ib_udata *udata);
3782
3783 /**
3784  * ib_alloc_cq_user: Allocate kernel/user CQ
3785  * @dev: The IB device
3786  * @private: Private data attached to the CQE
3787  * @nr_cqe: Number of CQEs in the CQ
3788  * @comp_vector: Completion vector used for the IRQs
3789  * @poll_ctx: Context used for polling the CQ
3790  * @udata: Valid user data or NULL for kernel objects
3791  */
3792 static inline struct ib_cq *ib_alloc_cq_user(struct ib_device *dev,
3793                                              void *private, int nr_cqe,
3794                                              int comp_vector,
3795                                              enum ib_poll_context poll_ctx,
3796                                              struct ib_udata *udata)
3797 {
3798         return __ib_alloc_cq_user(dev, private, nr_cqe, comp_vector, poll_ctx,
3799                                   KBUILD_MODNAME, udata);
3800 }
3801
3802 /**
3803  * ib_alloc_cq: Allocate kernel CQ
3804  * @dev: The IB device
3805  * @private: Private data attached to the CQE
3806  * @nr_cqe: Number of CQEs in the CQ
3807  * @comp_vector: Completion vector used for the IRQs
3808  * @poll_ctx: Context used for polling the CQ
3809  *
3810  * NOTE: for user cq use ib_alloc_cq_user with valid udata!
3811  */
3812 static inline struct ib_cq *ib_alloc_cq(struct ib_device *dev, void *private,
3813                                         int nr_cqe, int comp_vector,
3814                                         enum ib_poll_context poll_ctx)
3815 {
3816         return ib_alloc_cq_user(dev, private, nr_cqe, comp_vector, poll_ctx,
3817                                 NULL);
3818 }
3819
3820 struct ib_cq *__ib_alloc_cq_any(struct ib_device *dev, void *private,
3821                                 int nr_cqe, enum ib_poll_context poll_ctx,
3822                                 const char *caller);
3823
3824 /**
3825  * ib_alloc_cq_any: Allocate kernel CQ
3826  * @dev: The IB device
3827  * @private: Private data attached to the CQE
3828  * @nr_cqe: Number of CQEs in the CQ
3829  * @poll_ctx: Context used for polling the CQ
3830  */
3831 static inline struct ib_cq *ib_alloc_cq_any(struct ib_device *dev,
3832                                             void *private, int nr_cqe,
3833                                             enum ib_poll_context poll_ctx)
3834 {
3835         return __ib_alloc_cq_any(dev, private, nr_cqe, poll_ctx,
3836                                  KBUILD_MODNAME);
3837 }
3838
3839 /**
3840  * ib_free_cq_user - Free kernel/user CQ
3841  * @cq: The CQ to free
3842  * @udata: Valid user data or NULL for kernel objects
3843  */
3844 void ib_free_cq_user(struct ib_cq *cq, struct ib_udata *udata);
3845
3846 /**
3847  * ib_free_cq - Free kernel CQ
3848  * @cq: The CQ to free
3849  *
3850  * NOTE: for user cq use ib_free_cq_user with valid udata!
3851  */
3852 static inline void ib_free_cq(struct ib_cq *cq)
3853 {
3854         ib_free_cq_user(cq, NULL);
3855 }
3856
3857 int ib_process_cq_direct(struct ib_cq *cq, int budget);
3858
3859 /**
3860  * ib_create_cq - Creates a CQ on the specified device.
3861  * @device: The device on which to create the CQ.
3862  * @comp_handler: A user-specified callback that is invoked when a
3863  *   completion event occurs on the CQ.
3864  * @event_handler: A user-specified callback that is invoked when an
3865  *   asynchronous event not associated with a completion occurs on the CQ.
3866  * @cq_context: Context associated with the CQ returned to the user via
3867  *   the associated completion and event handlers.
3868  * @cq_attr: The attributes the CQ should be created upon.
3869  *
3870  * Users can examine the cq structure to determine the actual CQ size.
3871  */
3872 struct ib_cq *__ib_create_cq(struct ib_device *device,
3873                              ib_comp_handler comp_handler,
3874                              void (*event_handler)(struct ib_event *, void *),
3875                              void *cq_context,
3876                              const struct ib_cq_init_attr *cq_attr,
3877                              const char *caller);
3878 #define ib_create_cq(device, cmp_hndlr, evt_hndlr, cq_ctxt, cq_attr) \
3879         __ib_create_cq((device), (cmp_hndlr), (evt_hndlr), (cq_ctxt), (cq_attr), KBUILD_MODNAME)
3880
3881 /**
3882  * ib_resize_cq - Modifies the capacity of the CQ.
3883  * @cq: The CQ to resize.
3884  * @cqe: The minimum size of the CQ.
3885  *
3886  * Users can examine the cq structure to determine the actual CQ size.
3887  */
3888 int ib_resize_cq(struct ib_cq *cq, int cqe);
3889
3890 /**
3891  * rdma_set_cq_moderation - Modifies moderation params of the CQ
3892  * @cq: The CQ to modify.
3893  * @cq_count: number of CQEs that will trigger an event
3894  * @cq_period: max period of time in usec before triggering an event
3895  *
3896  */
3897 int rdma_set_cq_moderation(struct ib_cq *cq, u16 cq_count, u16 cq_period);
3898
3899 /**
3900  * ib_destroy_cq_user - Destroys the specified CQ.
3901  * @cq: The CQ to destroy.
3902  * @udata: Valid user data or NULL for kernel objects
3903  */
3904 int ib_destroy_cq_user(struct ib_cq *cq, struct ib_udata *udata);
3905
3906 /**
3907  * ib_destroy_cq - Destroys the specified kernel CQ.
3908  * @cq: The CQ to destroy.
3909  *
3910  * NOTE: for user cq use ib_destroy_cq_user with valid udata!
3911  */
3912 static inline void ib_destroy_cq(struct ib_cq *cq)
3913 {
3914         ib_destroy_cq_user(cq, NULL);
3915 }
3916
3917 /**
3918  * ib_poll_cq - poll a CQ for completion(s)
3919  * @cq:the CQ being polled
3920  * @num_entries:maximum number of completions to return
3921  * @wc:array of at least @num_entries &struct ib_wc where completions
3922  *   will be returned
3923  *
3924  * Poll a CQ for (possibly multiple) completions.  If the return value
3925  * is < 0, an error occurred.  If the return value is >= 0, it is the
3926  * number of completions returned.  If the return value is
3927  * non-negative and < num_entries, then the CQ was emptied.
3928  */
3929 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
3930                              struct ib_wc *wc)
3931 {
3932         return cq->device->ops.poll_cq(cq, num_entries, wc);
3933 }
3934
3935 /**
3936  * ib_req_notify_cq - Request completion notification on a CQ.
3937  * @cq: The CQ to generate an event for.
3938  * @flags:
3939  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
3940  *   to request an event on the next solicited event or next work
3941  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
3942  *   may also be |ed in to request a hint about missed events, as
3943  *   described below.
3944  *
3945  * Return Value:
3946  *    < 0 means an error occurred while requesting notification
3947  *   == 0 means notification was requested successfully, and if
3948  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
3949  *        were missed and it is safe to wait for another event.  In
3950  *        this case is it guaranteed that any work completions added
3951  *        to the CQ since the last CQ poll will trigger a completion
3952  *        notification event.
3953  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
3954  *        in.  It means that the consumer must poll the CQ again to
3955  *        make sure it is empty to avoid missing an event because of a
3956  *        race between requesting notification and an entry being
3957  *        added to the CQ.  This return value means it is possible
3958  *        (but not guaranteed) that a work completion has been added
3959  *        to the CQ since the last poll without triggering a
3960  *        completion notification event.
3961  */
3962 static inline int ib_req_notify_cq(struct ib_cq *cq,
3963                                    enum ib_cq_notify_flags flags)
3964 {
3965         return cq->device->ops.req_notify_cq(cq, flags);
3966 }
3967
3968 /**
3969  * ib_req_ncomp_notif - Request completion notification when there are
3970  *   at least the specified number of unreaped completions on the CQ.
3971  * @cq: The CQ to generate an event for.
3972  * @wc_cnt: The number of unreaped completions that should be on the
3973  *   CQ before an event is generated.
3974  */
3975 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
3976 {
3977         return cq->device->ops.req_ncomp_notif ?
3978                 cq->device->ops.req_ncomp_notif(cq, wc_cnt) :
3979                 -ENOSYS;
3980 }
3981
3982 /**
3983  * ib_dma_mapping_error - check a DMA addr for error
3984  * @dev: The device for which the dma_addr was created
3985  * @dma_addr: The DMA address to check
3986  */
3987 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
3988 {
3989         return dma_mapping_error(dev->dma_device, dma_addr);
3990 }
3991
3992 /**
3993  * ib_dma_map_single - Map a kernel virtual address to DMA address
3994  * @dev: The device for which the dma_addr is to be created
3995  * @cpu_addr: The kernel virtual address
3996  * @size: The size of the region in bytes
3997  * @direction: The direction of the DMA
3998  */
3999 static inline u64 ib_dma_map_single(struct ib_device *dev,
4000                                     void *cpu_addr, size_t size,
4001                                     enum dma_data_direction direction)
4002 {
4003         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
4004 }
4005
4006 /**
4007  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
4008  * @dev: The device for which the DMA address was created
4009  * @addr: The DMA address
4010  * @size: The size of the region in bytes
4011  * @direction: The direction of the DMA
4012  */
4013 static inline void ib_dma_unmap_single(struct ib_device *dev,
4014                                        u64 addr, size_t size,
4015                                        enum dma_data_direction direction)
4016 {
4017         dma_unmap_single(dev->dma_device, addr, size, direction);
4018 }
4019
4020 /**
4021  * ib_dma_map_page - Map a physical page to DMA address
4022  * @dev: The device for which the dma_addr is to be created
4023  * @page: The page to be mapped
4024  * @offset: The offset within the page
4025  * @size: The size of the region in bytes
4026  * @direction: The direction of the DMA
4027  */
4028 static inline u64 ib_dma_map_page(struct ib_device *dev,
4029                                   struct page *page,
4030                                   unsigned long offset,
4031                                   size_t size,
4032                                          enum dma_data_direction direction)
4033 {
4034         return dma_map_page(dev->dma_device, page, offset, size, direction);
4035 }
4036
4037 /**
4038  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
4039  * @dev: The device for which the DMA address was created
4040  * @addr: The DMA address
4041  * @size: The size of the region in bytes
4042  * @direction: The direction of the DMA
4043  */
4044 static inline void ib_dma_unmap_page(struct ib_device *dev,
4045                                      u64 addr, size_t size,
4046                                      enum dma_data_direction direction)
4047 {
4048         dma_unmap_page(dev->dma_device, addr, size, direction);
4049 }
4050
4051 /**
4052  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
4053  * @dev: The device for which the DMA addresses are to be created
4054  * @sg: The array of scatter/gather entries
4055  * @nents: The number of scatter/gather entries
4056  * @direction: The direction of the DMA
4057  */
4058 static inline int ib_dma_map_sg(struct ib_device *dev,
4059                                 struct scatterlist *sg, int nents,
4060                                 enum dma_data_direction direction)
4061 {
4062         return dma_map_sg(dev->dma_device, sg, nents, direction);
4063 }
4064
4065 /**
4066  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
4067  * @dev: The device for which the DMA addresses were created
4068  * @sg: The array of scatter/gather entries
4069  * @nents: The number of scatter/gather entries
4070  * @direction: The direction of the DMA
4071  */
4072 static inline void ib_dma_unmap_sg(struct ib_device *dev,
4073                                    struct scatterlist *sg, int nents,
4074                                    enum dma_data_direction direction)
4075 {
4076         dma_unmap_sg(dev->dma_device, sg, nents, direction);
4077 }
4078
4079 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
4080                                       struct scatterlist *sg, int nents,
4081                                       enum dma_data_direction direction,
4082                                       unsigned long dma_attrs)
4083 {
4084         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction,
4085                                 dma_attrs);
4086 }
4087
4088 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
4089                                          struct scatterlist *sg, int nents,
4090                                          enum dma_data_direction direction,
4091                                          unsigned long dma_attrs)
4092 {
4093         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, dma_attrs);
4094 }
4095
4096 /**
4097  * ib_dma_max_seg_size - Return the size limit of a single DMA transfer
4098  * @dev: The device to query
4099  *
4100  * The returned value represents a size in bytes.
4101  */
4102 static inline unsigned int ib_dma_max_seg_size(struct ib_device *dev)
4103 {
4104         return dma_get_max_seg_size(dev->dma_device);
4105 }
4106
4107 /**
4108  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
4109  * @dev: The device for which the DMA address was created
4110  * @addr: The DMA address
4111  * @size: The size of the region in bytes
4112  * @dir: The direction of the DMA
4113  */
4114 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
4115                                               u64 addr,
4116                                               size_t size,
4117                                               enum dma_data_direction dir)
4118 {
4119         dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
4120 }
4121
4122 /**
4123  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
4124  * @dev: The device for which the DMA address was created
4125  * @addr: The DMA address
4126  * @size: The size of the region in bytes
4127  * @dir: The direction of the DMA
4128  */
4129 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
4130                                                  u64 addr,
4131                                                  size_t size,
4132                                                  enum dma_data_direction dir)
4133 {
4134         dma_sync_single_for_device(dev->dma_device, addr, size, dir);
4135 }
4136
4137 /**
4138  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
4139  * @dev: The device for which the DMA address is requested
4140  * @size: The size of the region to allocate in bytes
4141  * @dma_handle: A pointer for returning the DMA address of the region
4142  * @flag: memory allocator flags
4143  */
4144 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
4145                                            size_t size,
4146                                            dma_addr_t *dma_handle,
4147                                            gfp_t flag)
4148 {
4149         return dma_alloc_coherent(dev->dma_device, size, dma_handle, flag);
4150 }
4151
4152 /**
4153  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
4154  * @dev: The device for which the DMA addresses were allocated
4155  * @size: The size of the region
4156  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
4157  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
4158  */
4159 static inline void ib_dma_free_coherent(struct ib_device *dev,
4160                                         size_t size, void *cpu_addr,
4161                                         dma_addr_t dma_handle)
4162 {
4163         dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
4164 }
4165
4166 /**
4167  * ib_dereg_mr_user - Deregisters a memory region and removes it from the
4168  *   HCA translation table.
4169  * @mr: The memory region to deregister.
4170  * @udata: Valid user data or NULL for kernel object
4171  *
4172  * This function can fail, if the memory region has memory windows bound to it.
4173  */
4174 int ib_dereg_mr_user(struct ib_mr *mr, struct ib_udata *udata);
4175
4176 /**
4177  * ib_dereg_mr - Deregisters a kernel memory region and removes it from the
4178  *   HCA translation table.
4179  * @mr: The memory region to deregister.
4180  *
4181  * This function can fail, if the memory region has memory windows bound to it.
4182  *
4183  * NOTE: for user mr use ib_dereg_mr_user with valid udata!
4184  */
4185 static inline int ib_dereg_mr(struct ib_mr *mr)
4186 {
4187         return ib_dereg_mr_user(mr, NULL);
4188 }
4189
4190 struct ib_mr *ib_alloc_mr_user(struct ib_pd *pd, enum ib_mr_type mr_type,
4191                                u32 max_num_sg, struct ib_udata *udata);
4192
4193 static inline struct ib_mr *ib_alloc_mr(struct ib_pd *pd,
4194                                         enum ib_mr_type mr_type, u32 max_num_sg)
4195 {
4196         return ib_alloc_mr_user(pd, mr_type, max_num_sg, NULL);
4197 }
4198
4199 struct ib_mr *ib_alloc_mr_integrity(struct ib_pd *pd,
4200                                     u32 max_num_data_sg,
4201                                     u32 max_num_meta_sg);
4202
4203 /**
4204  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
4205  *   R_Key and L_Key.
4206  * @mr - struct ib_mr pointer to be updated.
4207  * @newkey - new key to be used.
4208  */
4209 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
4210 {
4211         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
4212         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
4213 }
4214
4215 /**
4216  * ib_inc_rkey - increments the key portion of the given rkey. Can be used
4217  * for calculating a new rkey for type 2 memory windows.
4218  * @rkey - the rkey to increment.
4219  */
4220 static inline u32 ib_inc_rkey(u32 rkey)
4221 {
4222         const u32 mask = 0x000000ff;
4223         return ((rkey + 1) & mask) | (rkey & ~mask);
4224 }
4225
4226 /**
4227  * ib_alloc_fmr - Allocates a unmapped fast memory region.
4228  * @pd: The protection domain associated with the unmapped region.
4229  * @mr_access_flags: Specifies the memory access rights.
4230  * @fmr_attr: Attributes of the unmapped region.
4231  *
4232  * A fast memory region must be mapped before it can be used as part of
4233  * a work request.
4234  */
4235 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
4236                             int mr_access_flags,
4237                             struct ib_fmr_attr *fmr_attr);
4238
4239 /**
4240  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
4241  * @fmr: The fast memory region to associate with the pages.
4242  * @page_list: An array of physical pages to map to the fast memory region.
4243  * @list_len: The number of pages in page_list.
4244  * @iova: The I/O virtual address to use with the mapped region.
4245  */
4246 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
4247                                   u64 *page_list, int list_len,
4248                                   u64 iova)
4249 {
4250         return fmr->device->ops.map_phys_fmr(fmr, page_list, list_len, iova);
4251 }
4252
4253 /**
4254  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
4255  * @fmr_list: A linked list of fast memory regions to unmap.
4256  */
4257 int ib_unmap_fmr(struct list_head *fmr_list);
4258
4259 /**
4260  * ib_dealloc_fmr - Deallocates a fast memory region.
4261  * @fmr: The fast memory region to deallocate.
4262  */
4263 int ib_dealloc_fmr(struct ib_fmr *fmr);
4264
4265 /**
4266  * ib_attach_mcast - Attaches the specified QP to a multicast group.
4267  * @qp: QP to attach to the multicast group.  The QP must be type
4268  *   IB_QPT_UD.
4269  * @gid: Multicast group GID.
4270  * @lid: Multicast group LID in host byte order.
4271  *
4272  * In order to send and receive multicast packets, subnet
4273  * administration must have created the multicast group and configured
4274  * the fabric appropriately.  The port associated with the specified
4275  * QP must also be a member of the multicast group.
4276  */
4277 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
4278
4279 /**
4280  * ib_detach_mcast - Detaches the specified QP from a multicast group.
4281  * @qp: QP to detach from the multicast group.
4282  * @gid: Multicast group GID.
4283  * @lid: Multicast group LID in host byte order.
4284  */
4285 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
4286
4287 /**
4288  * ib_alloc_xrcd - Allocates an XRC domain.
4289  * @device: The device on which to allocate the XRC domain.
4290  * @caller: Module name for kernel consumers
4291  */
4292 struct ib_xrcd *__ib_alloc_xrcd(struct ib_device *device, const char *caller);
4293 #define ib_alloc_xrcd(device) \
4294         __ib_alloc_xrcd((device), KBUILD_MODNAME)
4295
4296 /**
4297  * ib_dealloc_xrcd - Deallocates an XRC domain.
4298  * @xrcd: The XRC domain to deallocate.
4299  * @udata: Valid user data or NULL for kernel object
4300  */
4301 int ib_dealloc_xrcd(struct ib_xrcd *xrcd, struct ib_udata *udata);
4302
4303 static inline int ib_check_mr_access(int flags)
4304 {
4305         /*
4306          * Local write permission is required if remote write or
4307          * remote atomic permission is also requested.
4308          */
4309         if (flags & (IB_ACCESS_REMOTE_ATOMIC | IB_ACCESS_REMOTE_WRITE) &&
4310             !(flags & IB_ACCESS_LOCAL_WRITE))
4311                 return -EINVAL;
4312
4313         return 0;
4314 }
4315
4316 static inline bool ib_access_writable(int access_flags)
4317 {
4318         /*
4319          * We have writable memory backing the MR if any of the following
4320          * access flags are set.  "Local write" and "remote write" obviously
4321          * require write access.  "Remote atomic" can do things like fetch and
4322          * add, which will modify memory, and "MW bind" can change permissions
4323          * by binding a window.
4324          */
4325         return access_flags &
4326                 (IB_ACCESS_LOCAL_WRITE   | IB_ACCESS_REMOTE_WRITE |
4327                  IB_ACCESS_REMOTE_ATOMIC | IB_ACCESS_MW_BIND);
4328 }
4329
4330 /**
4331  * ib_check_mr_status: lightweight check of MR status.
4332  *     This routine may provide status checks on a selected
4333  *     ib_mr. first use is for signature status check.
4334  *
4335  * @mr: A memory region.
4336  * @check_mask: Bitmask of which checks to perform from
4337  *     ib_mr_status_check enumeration.
4338  * @mr_status: The container of relevant status checks.
4339  *     failed checks will be indicated in the status bitmask
4340  *     and the relevant info shall be in the error item.
4341  */
4342 int ib_check_mr_status(struct ib_mr *mr, u32 check_mask,
4343                        struct ib_mr_status *mr_status);
4344
4345 /**
4346  * ib_device_try_get: Hold a registration lock
4347  * device: The device to lock
4348  *
4349  * A device under an active registration lock cannot become unregistered. It
4350  * is only possible to obtain a registration lock on a device that is fully
4351  * registered, otherwise this function returns false.
4352  *
4353  * The registration lock is only necessary for actions which require the
4354  * device to still be registered. Uses that only require the device pointer to
4355  * be valid should use get_device(&ibdev->dev) to hold the memory.
4356  *
4357  */
4358 static inline bool ib_device_try_get(struct ib_device *dev)
4359 {
4360         return refcount_inc_not_zero(&dev->refcount);
4361 }
4362
4363 void ib_device_put(struct ib_device *device);
4364 struct ib_device *ib_device_get_by_netdev(struct net_device *ndev,
4365                                           enum rdma_driver_id driver_id);
4366 struct ib_device *ib_device_get_by_name(const char *name,
4367                                         enum rdma_driver_id driver_id);
4368 struct net_device *ib_get_net_dev_by_params(struct ib_device *dev, u8 port,
4369                                             u16 pkey, const union ib_gid *gid,
4370                                             const struct sockaddr *addr);
4371 int ib_device_set_netdev(struct ib_device *ib_dev, struct net_device *ndev,
4372                          unsigned int port);
4373 struct net_device *ib_device_netdev(struct ib_device *dev, u8 port);
4374
4375 struct ib_wq *ib_create_wq(struct ib_pd *pd,
4376                            struct ib_wq_init_attr *init_attr);
4377 int ib_destroy_wq(struct ib_wq *wq, struct ib_udata *udata);
4378 int ib_modify_wq(struct ib_wq *wq, struct ib_wq_attr *attr,
4379                  u32 wq_attr_mask);
4380 struct ib_rwq_ind_table *ib_create_rwq_ind_table(struct ib_device *device,
4381                                                  struct ib_rwq_ind_table_init_attr*
4382                                                  wq_ind_table_init_attr);
4383 int ib_destroy_rwq_ind_table(struct ib_rwq_ind_table *wq_ind_table);
4384
4385 int ib_map_mr_sg(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
4386                  unsigned int *sg_offset, unsigned int page_size);
4387 int ib_map_mr_sg_pi(struct ib_mr *mr, struct scatterlist *data_sg,
4388                     int data_sg_nents, unsigned int *data_sg_offset,
4389                     struct scatterlist *meta_sg, int meta_sg_nents,
4390                     unsigned int *meta_sg_offset, unsigned int page_size);
4391
4392 static inline int
4393 ib_map_mr_sg_zbva(struct ib_mr *mr, struct scatterlist *sg, int sg_nents,
4394                   unsigned int *sg_offset, unsigned int page_size)
4395 {
4396         int n;
4397
4398         n = ib_map_mr_sg(mr, sg, sg_nents, sg_offset, page_size);
4399         mr->iova = 0;
4400
4401         return n;
4402 }
4403
4404 int ib_sg_to_pages(struct ib_mr *mr, struct scatterlist *sgl, int sg_nents,
4405                 unsigned int *sg_offset, int (*set_page)(struct ib_mr *, u64));
4406
4407 void ib_drain_rq(struct ib_qp *qp);
4408 void ib_drain_sq(struct ib_qp *qp);
4409 void ib_drain_qp(struct ib_qp *qp);
4410
4411 int ib_get_eth_speed(struct ib_device *dev, u8 port_num, u8 *speed, u8 *width);
4412
4413 static inline u8 *rdma_ah_retrieve_dmac(struct rdma_ah_attr *attr)
4414 {
4415         if (attr->type == RDMA_AH_ATTR_TYPE_ROCE)
4416                 return attr->roce.dmac;
4417         return NULL;
4418 }
4419
4420 static inline void rdma_ah_set_dlid(struct rdma_ah_attr *attr, u32 dlid)
4421 {
4422         if (attr->type == RDMA_AH_ATTR_TYPE_IB)
4423                 attr->ib.dlid = (u16)dlid;
4424         else if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4425                 attr->opa.dlid = dlid;
4426 }
4427
4428 static inline u32 rdma_ah_get_dlid(const struct rdma_ah_attr *attr)
4429 {
4430         if (attr->type == RDMA_AH_ATTR_TYPE_IB)
4431                 return attr->ib.dlid;
4432         else if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4433                 return attr->opa.dlid;
4434         return 0;
4435 }
4436
4437 static inline void rdma_ah_set_sl(struct rdma_ah_attr *attr, u8 sl)
4438 {
4439         attr->sl = sl;
4440 }
4441
4442 static inline u8 rdma_ah_get_sl(const struct rdma_ah_attr *attr)
4443 {
4444         return attr->sl;
4445 }
4446
4447 static inline void rdma_ah_set_path_bits(struct rdma_ah_attr *attr,
4448                                          u8 src_path_bits)
4449 {
4450         if (attr->type == RDMA_AH_ATTR_TYPE_IB)
4451                 attr->ib.src_path_bits = src_path_bits;
4452         else if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4453                 attr->opa.src_path_bits = src_path_bits;
4454 }
4455
4456 static inline u8 rdma_ah_get_path_bits(const struct rdma_ah_attr *attr)
4457 {
4458         if (attr->type == RDMA_AH_ATTR_TYPE_IB)
4459                 return attr->ib.src_path_bits;
4460         else if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4461                 return attr->opa.src_path_bits;
4462         return 0;
4463 }
4464
4465 static inline void rdma_ah_set_make_grd(struct rdma_ah_attr *attr,
4466                                         bool make_grd)
4467 {
4468         if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4469                 attr->opa.make_grd = make_grd;
4470 }
4471
4472 static inline bool rdma_ah_get_make_grd(const struct rdma_ah_attr *attr)
4473 {
4474         if (attr->type == RDMA_AH_ATTR_TYPE_OPA)
4475                 return attr->opa.make_grd;
4476         return false;
4477 }
4478
4479 static inline void rdma_ah_set_port_num(struct rdma_ah_attr *attr, u8 port_num)
4480 {
4481         attr->port_num = port_num;
4482 }
4483
4484 static inline u8 rdma_ah_get_port_num(const struct rdma_ah_attr *attr)
4485 {
4486         return attr->port_num;
4487 }
4488
4489 static inline void rdma_ah_set_static_rate(struct rdma_ah_attr *attr,
4490                                            u8 static_rate)
4491 {
4492         attr->static_rate = static_rate;
4493 }
4494
4495 static inline u8 rdma_ah_get_static_rate(const struct rdma_ah_attr *attr)
4496 {
4497         return attr->static_rate;
4498 }
4499
4500 static inline void rdma_ah_set_ah_flags(struct rdma_ah_attr *attr,
4501                                         enum ib_ah_flags flag)
4502 {
4503         attr->ah_flags = flag;
4504 }
4505
4506 static inline enum ib_ah_flags
4507                 rdma_ah_get_ah_flags(const struct rdma_ah_attr *attr)
4508 {
4509         return attr->ah_flags;
4510 }
4511
4512 static inline const struct ib_global_route
4513                 *rdma_ah_read_grh(const struct rdma_ah_attr *attr)
4514 {
4515         return &attr->grh;
4516 }
4517
4518 /*To retrieve and modify the grh */
4519 static inline struct ib_global_route
4520                 *rdma_ah_retrieve_grh(struct rdma_ah_attr *attr)
4521 {
4522         return &attr->grh;
4523 }
4524
4525 static inline void rdma_ah_set_dgid_raw(struct rdma_ah_attr *attr, void *dgid)
4526 {
4527         struct ib_global_route *grh = rdma_ah_retrieve_grh(attr);
4528
4529         memcpy(grh->dgid.raw, dgid, sizeof(grh->dgid));
4530 }
4531
4532 static inline void rdma_ah_set_subnet_prefix(struct rdma_ah_attr *attr,
4533                                              __be64 prefix)
4534 {
4535         struct ib_global_route *grh = rdma_ah_retrieve_grh(attr);
4536
4537         grh->dgid.global.subnet_prefix = prefix;
4538 }
4539
4540 static inline void rdma_ah_set_interface_id(struct rdma_ah_attr *attr,
4541                                             __be64 if_id)
4542 {
4543         struct ib_global_route *grh = rdma_ah_retrieve_grh(attr);
4544
4545         grh->dgid.global.interface_id = if_id;
4546 }
4547
4548 static inline void rdma_ah_set_grh(struct rdma_ah_attr *attr,
4549                                    union ib_gid *dgid, u32 flow_label,
4550                                    u8 sgid_index, u8 hop_limit,
4551                                    u8 traffic_class)
4552 {
4553         struct ib_global_route *grh = rdma_ah_retrieve_grh(attr);
4554
4555         attr->ah_flags = IB_AH_GRH;
4556         if (dgid)
4557                 grh->dgid = *dgid;
4558         grh->flow_label = flow_label;
4559         grh->sgid_index = sgid_index;
4560         grh->hop_limit = hop_limit;
4561         grh->traffic_class = traffic_class;
4562         grh->sgid_attr = NULL;
4563 }
4564
4565 void rdma_destroy_ah_attr(struct rdma_ah_attr *ah_attr);
4566 void rdma_move_grh_sgid_attr(struct rdma_ah_attr *attr, union ib_gid *dgid,
4567                              u32 flow_label, u8 hop_limit, u8 traffic_class,
4568                              const struct ib_gid_attr *sgid_attr);
4569 void rdma_copy_ah_attr(struct rdma_ah_attr *dest,
4570                        const struct rdma_ah_attr *src);
4571 void rdma_replace_ah_attr(struct rdma_ah_attr *old,
4572                           const struct rdma_ah_attr *new);
4573 void rdma_move_ah_attr(struct rdma_ah_attr *dest, struct rdma_ah_attr *src);
4574
4575 /**
4576  * rdma_ah_find_type - Return address handle type.
4577  *
4578  * @dev: Device to be checked
4579  * @port_num: Port number
4580  */
4581 static inline enum rdma_ah_attr_type rdma_ah_find_type(struct ib_device *dev,
4582                                                        u8 port_num)
4583 {
4584         if (rdma_protocol_roce(dev, port_num))
4585                 return RDMA_AH_ATTR_TYPE_ROCE;
4586         if (rdma_protocol_ib(dev, port_num)) {
4587                 if (rdma_cap_opa_ah(dev, port_num))
4588                         return RDMA_AH_ATTR_TYPE_OPA;
4589                 return RDMA_AH_ATTR_TYPE_IB;
4590         }
4591
4592         return RDMA_AH_ATTR_TYPE_UNDEFINED;
4593 }
4594
4595 /**
4596  * ib_lid_cpu16 - Return lid in 16bit CPU encoding.
4597  *     In the current implementation the only way to get
4598  *     get the 32bit lid is from other sources for OPA.
4599  *     For IB, lids will always be 16bits so cast the
4600  *     value accordingly.
4601  *
4602  * @lid: A 32bit LID
4603  */
4604 static inline u16 ib_lid_cpu16(u32 lid)
4605 {
4606         WARN_ON_ONCE(lid & 0xFFFF0000);
4607         return (u16)lid;
4608 }
4609
4610 /**
4611  * ib_lid_be16 - Return lid in 16bit BE encoding.
4612  *
4613  * @lid: A 32bit LID
4614  */
4615 static inline __be16 ib_lid_be16(u32 lid)
4616 {
4617         WARN_ON_ONCE(lid & 0xFFFF0000);
4618         return cpu_to_be16((u16)lid);
4619 }
4620
4621 /**
4622  * ib_get_vector_affinity - Get the affinity mappings of a given completion
4623  *   vector
4624  * @device:         the rdma device
4625  * @comp_vector:    index of completion vector
4626  *
4627  * Returns NULL on failure, otherwise a corresponding cpu map of the
4628  * completion vector (returns all-cpus map if the device driver doesn't
4629  * implement get_vector_affinity).
4630  */
4631 static inline const struct cpumask *
4632 ib_get_vector_affinity(struct ib_device *device, int comp_vector)
4633 {
4634         if (comp_vector < 0 || comp_vector >= device->num_comp_vectors ||
4635             !device->ops.get_vector_affinity)
4636                 return NULL;
4637
4638         return device->ops.get_vector_affinity(device, comp_vector);
4639
4640 }
4641
4642 /**
4643  * rdma_roce_rescan_device - Rescan all of the network devices in the system
4644  * and add their gids, as needed, to the relevant RoCE devices.
4645  *
4646  * @device:         the rdma device
4647  */
4648 void rdma_roce_rescan_device(struct ib_device *ibdev);
4649
4650 struct ib_ucontext *ib_uverbs_get_ucontext_file(struct ib_uverbs_file *ufile);
4651
4652 int uverbs_destroy_def_handler(struct uverbs_attr_bundle *attrs);
4653
4654 struct net_device *rdma_alloc_netdev(struct ib_device *device, u8 port_num,
4655                                      enum rdma_netdev_t type, const char *name,
4656                                      unsigned char name_assign_type,
4657                                      void (*setup)(struct net_device *));
4658
4659 int rdma_init_netdev(struct ib_device *device, u8 port_num,
4660                      enum rdma_netdev_t type, const char *name,
4661                      unsigned char name_assign_type,
4662                      void (*setup)(struct net_device *),
4663                      struct net_device *netdev);
4664
4665 /**
4666  * rdma_set_device_sysfs_group - Set device attributes group to have
4667  *                               driver specific sysfs entries at
4668  *                               for infiniband class.
4669  *
4670  * @device:     device pointer for which attributes to be created
4671  * @group:      Pointer to group which should be added when device
4672  *              is registered with sysfs.
4673  * rdma_set_device_sysfs_group() allows existing drivers to expose one
4674  * group per device to have sysfs attributes.
4675  *
4676  * NOTE: New drivers should not make use of this API; instead new device
4677  * parameter should be exposed via netlink command. This API and mechanism
4678  * exist only for existing drivers.
4679  */
4680 static inline void
4681 rdma_set_device_sysfs_group(struct ib_device *dev,
4682                             const struct attribute_group *group)
4683 {
4684         dev->groups[1] = group;
4685 }
4686
4687 /**
4688  * rdma_device_to_ibdev - Get ib_device pointer from device pointer
4689  *
4690  * @device:     device pointer for which ib_device pointer to retrieve
4691  *
4692  * rdma_device_to_ibdev() retrieves ib_device pointer from device.
4693  *
4694  */
4695 static inline struct ib_device *rdma_device_to_ibdev(struct device *device)
4696 {
4697         struct ib_core_device *coredev =
4698                 container_of(device, struct ib_core_device, dev);
4699
4700         return coredev->owner;
4701 }
4702
4703 /**
4704  * rdma_device_to_drv_device - Helper macro to reach back to driver's
4705  *                             ib_device holder structure from device pointer.
4706  *
4707  * NOTE: New drivers should not make use of this API; This API is only for
4708  * existing drivers who have exposed sysfs entries using
4709  * rdma_set_device_sysfs_group().
4710  */
4711 #define rdma_device_to_drv_device(dev, drv_dev_struct, ibdev_member)           \
4712         container_of(rdma_device_to_ibdev(dev), drv_dev_struct, ibdev_member)
4713
4714 bool rdma_dev_access_netns(const struct ib_device *device,
4715                            const struct net *net);
4716 #endif /* IB_VERBS_H */