include/rdma/ib_verbs.h

   1 /*
   2  * Copyright (c) 2004 Mellanox Technologies Ltd.  All rights reserved.
   3  * Copyright (c) 2004 Infinicon Corporation.  All rights reserved.
   4  * Copyright (c) 2004 Intel Corporation.  All rights reserved.
   5  * Copyright (c) 2004 Topspin Corporation.  All rights reserved.
   6  * Copyright (c) 2004 Voltaire Corporation.  All rights reserved.
   7  * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
   8  * Copyright (c) 2005, 2006, 2007 Cisco Systems.  All rights reserved.
   9  *
  10  * This software is available to you under a choice of one of two
  11  * licenses.  You may choose to be licensed under the terms of the GNU
  12  * General Public License (GPL) Version 2, available from the file
  13  * COPYING in the main directory of this source tree, or the
  14  * OpenIB.org BSD license below:
  15  *
  16  *     Redistribution and use in source and binary forms, with or
  17  *     without modification, are permitted provided that the following
  18  *     conditions are met:
  19  *
  20  *      - Redistributions of source code must retain the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer.
  23  *
  24  *      - Redistributions in binary form must reproduce the above
  25  *        copyright notice, this list of conditions and the following
  26  *        disclaimer in the documentation and/or other materials
  27  *        provided with the distribution.
  28  *
  29  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  30  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  31  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  32  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  33  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  34  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  35  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  36  * SOFTWARE.
  37  */
  38
  39 #if !defined(IB_VERBS_H)
  40 #define IB_VERBS_H
  41
  42 #include <linux/types.h>
  43 #include <linux/device.h>
  44 #include <linux/mm.h>
  45 #include <linux/dma-mapping.h>
  46 #include <linux/kref.h>
  47 #include <linux/list.h>
  48 #include <linux/rwsem.h>
  49 #include <linux/scatterlist.h>
  50 #include <linux/workqueue.h>
  51 #include <uapi/linux/if_ether.h>
  52
  53 #include <linux/atomic.h>
  54 #include <linux/mmu_notifier.h>
  55 #include <asm/uaccess.h>
  56
  57 extern struct workqueue_struct *ib_wq;
  58
  59 union ib_gid {
  60         u8      raw[16];
  61         struct {
  62                 __be64  subnet_prefix;
  63                 __be64  interface_id;
  64         } global;
  65 };
  66
  67 enum rdma_node_type {
  68         /* IB values map to NodeInfo:NodeType. */
  69         RDMA_NODE_IB_CA         = 1,
  70         RDMA_NODE_IB_SWITCH,
  71         RDMA_NODE_IB_ROUTER,
  72         RDMA_NODE_RNIC,
  73         RDMA_NODE_USNIC,
  74         RDMA_NODE_USNIC_UDP,
  75 };
  76
  77 enum rdma_transport_type {
  78         RDMA_TRANSPORT_IB,
  79         RDMA_TRANSPORT_IWARP,
  80         RDMA_TRANSPORT_USNIC,
  81         RDMA_TRANSPORT_USNIC_UDP
  82 };
  83
  84 __attribute_const__ enum rdma_transport_type
  85 rdma_node_get_transport(enum rdma_node_type node_type);
  86
  87 enum rdma_link_layer {
  88         IB_LINK_LAYER_UNSPECIFIED,
  89         IB_LINK_LAYER_INFINIBAND,
  90         IB_LINK_LAYER_ETHERNET,
  91 };
  92
  93 enum ib_device_cap_flags {
  94         IB_DEVICE_RESIZE_MAX_WR         = 1,
  95         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
  96         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
  97         IB_DEVICE_RAW_MULTI             = (1<<3),
  98         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
  99         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
 100         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
 101         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
 102         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
 103         IB_DEVICE_INIT_TYPE             = (1<<9),
 104         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
 105         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
 106         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
 107         IB_DEVICE_SRQ_RESIZE            = (1<<13),
 108         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
 109         IB_DEVICE_LOCAL_DMA_LKEY        = (1<<15),
 110         IB_DEVICE_RESERVED              = (1<<16), /* old SEND_W_INV */
 111         IB_DEVICE_MEM_WINDOW            = (1<<17),
 112         /*
 113          * Devices should set IB_DEVICE_UD_IP_SUM if they support
 114          * insertion of UDP and TCP checksum on outgoing UD IPoIB
 115          * messages and can verify the validity of checksum for
 116          * incoming messages.  Setting this flag implies that the
 117          * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
 118          */
 119         IB_DEVICE_UD_IP_CSUM            = (1<<18),
 120         IB_DEVICE_UD_TSO                = (1<<19),
 121         IB_DEVICE_XRC                   = (1<<20),
 122         IB_DEVICE_MEM_MGT_EXTENSIONS    = (1<<21),
 123         IB_DEVICE_BLOCK_MULTICAST_LOOPBACK = (1<<22),
 124         IB_DEVICE_MEM_WINDOW_TYPE_2A    = (1<<23),
 125         IB_DEVICE_MEM_WINDOW_TYPE_2B    = (1<<24),
 126         IB_DEVICE_MANAGED_FLOW_STEERING = (1<<29),
 127         IB_DEVICE_SIGNATURE_HANDOVER    = (1<<30),
 128         IB_DEVICE_ON_DEMAND_PAGING      = (1<<31),
 129 };
 130
 131 enum ib_signature_prot_cap {
 132         IB_PROT_T10DIF_TYPE_1 = 1,
 133         IB_PROT_T10DIF_TYPE_2 = 1 << 1,
 134         IB_PROT_T10DIF_TYPE_3 = 1 << 2,
 135 };
 136
 137 enum ib_signature_guard_cap {
 138         IB_GUARD_T10DIF_CRC     = 1,
 139         IB_GUARD_T10DIF_CSUM    = 1 << 1,
 140 };
 141
 142 enum ib_atomic_cap {
 143         IB_ATOMIC_NONE,
 144         IB_ATOMIC_HCA,
 145         IB_ATOMIC_GLOB
 146 };
 147
 148 enum ib_odp_general_cap_bits {
 149         IB_ODP_SUPPORT = 1 << 0,
 150 };
 151
 152 enum ib_odp_transport_cap_bits {
 153         IB_ODP_SUPPORT_SEND     = 1 << 0,
 154         IB_ODP_SUPPORT_RECV     = 1 << 1,
 155         IB_ODP_SUPPORT_WRITE    = 1 << 2,
 156         IB_ODP_SUPPORT_READ     = 1 << 3,
 157         IB_ODP_SUPPORT_ATOMIC   = 1 << 4,
 158 };
 159
 160 struct ib_odp_caps {
 161         uint64_t general_caps;
 162         struct {
 163                 uint32_t  rc_odp_caps;
 164                 uint32_t  uc_odp_caps;
 165                 uint32_t  ud_odp_caps;
 166         } per_transport_caps;
 167 };
 168
 169 struct ib_device_attr {
 170         u64                     fw_ver;
 171         __be64                  sys_image_guid;
 172         u64                     max_mr_size;
 173         u64                     page_size_cap;
 174         u32                     vendor_id;
 175         u32                     vendor_part_id;
 176         u32                     hw_ver;
 177         int                     max_qp;
 178         int                     max_qp_wr;
 179         int                     device_cap_flags;
 180         int                     max_sge;
 181         int                     max_sge_rd;
 182         int                     max_cq;
 183         int                     max_cqe;
 184         int                     max_mr;
 185         int                     max_pd;
 186         int                     max_qp_rd_atom;
 187         int                     max_ee_rd_atom;
 188         int                     max_res_rd_atom;
 189         int                     max_qp_init_rd_atom;
 190         int                     max_ee_init_rd_atom;
 191         enum ib_atomic_cap      atomic_cap;
 192         enum ib_atomic_cap      masked_atomic_cap;
 193         int                     max_ee;
 194         int                     max_rdd;
 195         int                     max_mw;
 196         int                     max_raw_ipv6_qp;
 197         int                     max_raw_ethy_qp;
 198         int                     max_mcast_grp;
 199         int                     max_mcast_qp_attach;
 200         int                     max_total_mcast_qp_attach;
 201         int                     max_ah;
 202         int                     max_fmr;
 203         int                     max_map_per_fmr;
 204         int                     max_srq;
 205         int                     max_srq_wr;
 206         int                     max_srq_sge;
 207         unsigned int            max_fast_reg_page_list_len;
 208         u16                     max_pkeys;
 209         u8                      local_ca_ack_delay;
 210         int                     sig_prot_cap;
 211         int                     sig_guard_cap;
 212         struct ib_odp_caps      odp_caps;
 213 };
 214
 215 enum ib_mtu {
 216         IB_MTU_256  = 1,
 217         IB_MTU_512  = 2,
 218         IB_MTU_1024 = 3,
 219         IB_MTU_2048 = 4,
 220         IB_MTU_4096 = 5
 221 };
 222
 223 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 224 {
 225         switch (mtu) {
 226         case IB_MTU_256:  return  256;
 227         case IB_MTU_512:  return  512;
 228         case IB_MTU_1024: return 1024;
 229         case IB_MTU_2048: return 2048;
 230         case IB_MTU_4096: return 4096;
 231         default:          return -1;
 232         }
 233 }
 234
 235 enum ib_port_state {
 236         IB_PORT_NOP             = 0,
 237         IB_PORT_DOWN            = 1,
 238         IB_PORT_INIT            = 2,
 239         IB_PORT_ARMED           = 3,
 240         IB_PORT_ACTIVE          = 4,
 241         IB_PORT_ACTIVE_DEFER    = 5
 242 };
 243
 244 enum ib_port_cap_flags {
 245         IB_PORT_SM                              = 1 <<  1,
 246         IB_PORT_NOTICE_SUP                      = 1 <<  2,
 247         IB_PORT_TRAP_SUP                        = 1 <<  3,
 248         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
 249         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
 250         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
 251         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
 252         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
 253         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
 254         IB_PORT_SM_DISABLED                     = 1 << 10,
 255         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
 256         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
 257         IB_PORT_EXTENDED_SPEEDS_SUP             = 1 << 14,
 258         IB_PORT_CM_SUP                          = 1 << 16,
 259         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
 260         IB_PORT_REINIT_SUP                      = 1 << 18,
 261         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
 262         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
 263         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
 264         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
 265         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
 266         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
 267         IB_PORT_CLIENT_REG_SUP                  = 1 << 25,
 268         IB_PORT_IP_BASED_GIDS                   = 1 << 26
 269 };
 270
 271 enum ib_port_width {
 272         IB_WIDTH_1X     = 1,
 273         IB_WIDTH_4X     = 2,
 274         IB_WIDTH_8X     = 4,
 275         IB_WIDTH_12X    = 8
 276 };
 277
 278 static inline int ib_width_enum_to_int(enum ib_port_width width)
 279 {
 280         switch (width) {
 281         case IB_WIDTH_1X:  return  1;
 282         case IB_WIDTH_4X:  return  4;
 283         case IB_WIDTH_8X:  return  8;
 284         case IB_WIDTH_12X: return 12;
 285         default:          return -1;
 286         }
 287 }
 288
 289 enum ib_port_speed {
 290         IB_SPEED_SDR    = 1,
 291         IB_SPEED_DDR    = 2,
 292         IB_SPEED_QDR    = 4,
 293         IB_SPEED_FDR10  = 8,
 294         IB_SPEED_FDR    = 16,
 295         IB_SPEED_EDR    = 32
 296 };
 297
 298 struct ib_protocol_stats {
 299         /* TBD... */
 300 };
 301
 302 struct iw_protocol_stats {
 303         u64     ipInReceives;
 304         u64     ipInHdrErrors;
 305         u64     ipInTooBigErrors;
 306         u64     ipInNoRoutes;
 307         u64     ipInAddrErrors;
 308         u64     ipInUnknownProtos;
 309         u64     ipInTruncatedPkts;
 310         u64     ipInDiscards;
 311         u64     ipInDelivers;
 312         u64     ipOutForwDatagrams;
 313         u64     ipOutRequests;
 314         u64     ipOutDiscards;
 315         u64     ipOutNoRoutes;
 316         u64     ipReasmTimeout;
 317         u64     ipReasmReqds;
 318         u64     ipReasmOKs;
 319         u64     ipReasmFails;
 320         u64     ipFragOKs;
 321         u64     ipFragFails;
 322         u64     ipFragCreates;
 323         u64     ipInMcastPkts;
 324         u64     ipOutMcastPkts;
 325         u64     ipInBcastPkts;
 326         u64     ipOutBcastPkts;
 327
 328         u64     tcpRtoAlgorithm;
 329         u64     tcpRtoMin;
 330         u64     tcpRtoMax;
 331         u64     tcpMaxConn;
 332         u64     tcpActiveOpens;
 333         u64     tcpPassiveOpens;
 334         u64     tcpAttemptFails;
 335         u64     tcpEstabResets;
 336         u64     tcpCurrEstab;
 337         u64     tcpInSegs;
 338         u64     tcpOutSegs;
 339         u64     tcpRetransSegs;
 340         u64     tcpInErrs;
 341         u64     tcpOutRsts;
 342 };
 343
 344 union rdma_protocol_stats {
 345         struct ib_protocol_stats        ib;
 346         struct iw_protocol_stats        iw;
 347 };
 348
 349 struct ib_port_attr {
 350         enum ib_port_state      state;
 351         enum ib_mtu             max_mtu;
 352         enum ib_mtu             active_mtu;
 353         int                     gid_tbl_len;
 354         u32                     port_cap_flags;
 355         u32                     max_msg_sz;
 356         u32                     bad_pkey_cntr;
 357         u32                     qkey_viol_cntr;
 358         u16                     pkey_tbl_len;
 359         u16                     lid;
 360         u16                     sm_lid;
 361         u8                      lmc;
 362         u8                      max_vl_num;
 363         u8                      sm_sl;
 364         u8                      subnet_timeout;
 365         u8                      init_type_reply;
 366         u8                      active_width;
 367         u8                      active_speed;
 368         u8                      phys_state;
 369 };
 370
 371 enum ib_device_modify_flags {
 372         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
 373         IB_DEVICE_MODIFY_NODE_DESC      = 1 << 1
 374 };
 375
 376 struct ib_device_modify {
 377         u64     sys_image_guid;
 378         char    node_desc[64];
 379 };
 380
 381 enum ib_port_modify_flags {
 382         IB_PORT_SHUTDOWN                = 1,
 383         IB_PORT_INIT_TYPE               = (1<<2),
 384         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
 385 };
 386
 387 struct ib_port_modify {
 388         u32     set_port_cap_mask;
 389         u32     clr_port_cap_mask;
 390         u8      init_type;
 391 };
 392
 393 enum ib_event_type {
 394         IB_EVENT_CQ_ERR,
 395         IB_EVENT_QP_FATAL,
 396         IB_EVENT_QP_REQ_ERR,
 397         IB_EVENT_QP_ACCESS_ERR,
 398         IB_EVENT_COMM_EST,
 399         IB_EVENT_SQ_DRAINED,
 400         IB_EVENT_PATH_MIG,
 401         IB_EVENT_PATH_MIG_ERR,
 402         IB_EVENT_DEVICE_FATAL,
 403         IB_EVENT_PORT_ACTIVE,
 404         IB_EVENT_PORT_ERR,
 405         IB_EVENT_LID_CHANGE,
 406         IB_EVENT_PKEY_CHANGE,
 407         IB_EVENT_SM_CHANGE,
 408         IB_EVENT_SRQ_ERR,
 409         IB_EVENT_SRQ_LIMIT_REACHED,
 410         IB_EVENT_QP_LAST_WQE_REACHED,
 411         IB_EVENT_CLIENT_REREGISTER,
 412         IB_EVENT_GID_CHANGE,
 413 };
 414
 415 __attribute_const__ const char *ib_event_msg(enum ib_event_type event);
 416
 417 struct ib_event {
 418         struct ib_device        *device;
 419         union {
 420                 struct ib_cq    *cq;
 421                 struct ib_qp    *qp;
 422                 struct ib_srq   *srq;
 423                 u8              port_num;
 424         } element;
 425         enum ib_event_type      event;
 426 };
 427
 428 struct ib_event_handler {
 429         struct ib_device *device;
 430         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 431         struct list_head  list;
 432 };
 433
 434 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 435         do {                                                    \
 436                 (_ptr)->device  = _device;                      \
 437                 (_ptr)->handler = _handler;                     \
 438                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 439         } while (0)
 440
 441 struct ib_global_route {
 442         union ib_gid    dgid;
 443         u32             flow_label;
 444         u8              sgid_index;
 445         u8              hop_limit;
 446         u8              traffic_class;
 447 };
 448
 449 struct ib_grh {
 450         __be32          version_tclass_flow;
 451         __be16          paylen;
 452         u8              next_hdr;
 453         u8              hop_limit;
 454         union ib_gid    sgid;
 455         union ib_gid    dgid;
 456 };
 457
 458 enum {
 459         IB_MULTICAST_QPN = 0xffffff
 460 };
 461
 462 #define IB_LID_PERMISSIVE       cpu_to_be16(0xFFFF)
 463
 464 enum ib_ah_flags {
 465         IB_AH_GRH       = 1
 466 };
 467
 468 enum ib_rate {
 469         IB_RATE_PORT_CURRENT = 0,
 470         IB_RATE_2_5_GBPS = 2,
 471         IB_RATE_5_GBPS   = 5,
 472         IB_RATE_10_GBPS  = 3,
 473         IB_RATE_20_GBPS  = 6,
 474         IB_RATE_30_GBPS  = 4,
 475         IB_RATE_40_GBPS  = 7,
 476         IB_RATE_60_GBPS  = 8,
 477         IB_RATE_80_GBPS  = 9,
 478         IB_RATE_120_GBPS = 10,
 479         IB_RATE_14_GBPS  = 11,
 480         IB_RATE_56_GBPS  = 12,
 481         IB_RATE_112_GBPS = 13,
 482         IB_RATE_168_GBPS = 14,
 483         IB_RATE_25_GBPS  = 15,
 484         IB_RATE_100_GBPS = 16,
 485         IB_RATE_200_GBPS = 17,
 486         IB_RATE_300_GBPS = 18
 487 };
 488
 489 /**
 490  * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
 491  * base rate of 2.5 Gbit/sec.  For example, IB_RATE_5_GBPS will be
 492  * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
 493  * @rate: rate to convert.
 494  */
 495 __attribute_const__ int ib_rate_to_mult(enum ib_rate rate);
 496
 497 /**
 498  * ib_rate_to_mbps - Convert the IB rate enum to Mbps.
 499  * For example, IB_RATE_2_5_GBPS will be converted to 2500.
 500  * @rate: rate to convert.
 501  */
 502 __attribute_const__ int ib_rate_to_mbps(enum ib_rate rate);
 503
 504 enum ib_mr_create_flags {
 505         IB_MR_SIGNATURE_EN = 1,
 506 };
 507
 508 /**
 509  * ib_mr_init_attr - Memory region init attributes passed to routine
 510  *     ib_create_mr.
 511  * @max_reg_descriptors: max number of registration descriptors that
 512  *     may be used with registration work requests.
 513  * @flags: MR creation flags bit mask.
 514  */
 515 struct ib_mr_init_attr {
 516         int         max_reg_descriptors;
 517         u32         flags;
 518 };
 519
 520 /**
 521  * Signature types
 522  * IB_SIG_TYPE_NONE: Unprotected.
 523  * IB_SIG_TYPE_T10_DIF: Type T10-DIF
 524  */
 525 enum ib_signature_type {
 526         IB_SIG_TYPE_NONE,
 527         IB_SIG_TYPE_T10_DIF,
 528 };
 529
 530 /**
 531  * Signature T10-DIF block-guard types
 532  * IB_T10DIF_CRC: Corresponds to T10-PI mandated CRC checksum rules.
 533  * IB_T10DIF_CSUM: Corresponds to IP checksum rules.
 534  */
 535 enum ib_t10_dif_bg_type {
 536         IB_T10DIF_CRC,
 537         IB_T10DIF_CSUM
 538 };
 539
 540 /**
 541  * struct ib_t10_dif_domain - Parameters specific for T10-DIF
 542  *     domain.
 543  * @bg_type: T10-DIF block guard type (CRC|CSUM)
 544  * @pi_interval: protection information interval.
 545  * @bg: seed of guard computation.
 546  * @app_tag: application tag of guard block
 547  * @ref_tag: initial guard block reference tag.
 548  * @ref_remap: Indicate wethear the reftag increments each block
 549  * @app_escape: Indicate to skip block check if apptag=0xffff
 550  * @ref_escape: Indicate to skip block check if reftag=0xffffffff
 551  * @apptag_check_mask: check bitmask of application tag.
 552  */
 553 struct ib_t10_dif_domain {
 554         enum ib_t10_dif_bg_type bg_type;
 555         u16                     pi_interval;
 556         u16                     bg;
 557         u16                     app_tag;
 558         u32                     ref_tag;
 559         bool                    ref_remap;
 560         bool                    app_escape;
 561         bool                    ref_escape;
 562         u16                     apptag_check_mask;
 563 };
 564
 565 /**
 566  * struct ib_sig_domain - Parameters for signature domain
 567  * @sig_type: specific signauture type
 568  * @sig: union of all signature domain attributes that may
 569  *     be used to set domain layout.
 570  */
 571 struct ib_sig_domain {
 572         enum ib_signature_type sig_type;
 573         union {
 574                 struct ib_t10_dif_domain dif;
 575         } sig;
 576 };
 577
 578 /**
 579  * struct ib_sig_attrs - Parameters for signature handover operation
 580  * @check_mask: bitmask for signature byte check (8 bytes)
 581  * @mem: memory domain layout desciptor.
 582  * @wire: wire domain layout desciptor.
 583  */
 584 struct ib_sig_attrs {
 585         u8                      check_mask;
 586         struct ib_sig_domain    mem;
 587         struct ib_sig_domain    wire;
 588 };
 589
 590 enum ib_sig_err_type {
 591         IB_SIG_BAD_GUARD,
 592         IB_SIG_BAD_REFTAG,
 593         IB_SIG_BAD_APPTAG,
 594 };
 595
 596 /**
 597  * struct ib_sig_err - signature error descriptor
 598  */
 599 struct ib_sig_err {
 600         enum ib_sig_err_type    err_type;
 601         u32                     expected;
 602         u32                     actual;
 603         u64                     sig_err_offset;
 604         u32                     key;
 605 };
 606
 607 enum ib_mr_status_check {
 608         IB_MR_CHECK_SIG_STATUS = 1,
 609 };
 610
 611 /**
 612  * struct ib_mr_status - Memory region status container
 613  *
 614  * @fail_status: Bitmask of MR checks status. For each
 615  *     failed check a corresponding status bit is set.
 616  * @sig_err: Additional info for IB_MR_CEHCK_SIG_STATUS
 617  *     failure.
 618  */
 619 struct ib_mr_status {
 620         u32                 fail_status;
 621         struct ib_sig_err   sig_err;
 622 };
 623
 624 /**
 625  * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
 626  * enum.
 627  * @mult: multiple to convert.
 628  */
 629 __attribute_const__ enum ib_rate mult_to_ib_rate(int mult);
 630
 631 struct ib_ah_attr {
 632         struct ib_global_route  grh;
 633         u16                     dlid;
 634         u8                      sl;
 635         u8                      src_path_bits;
 636         u8                      static_rate;
 637         u8                      ah_flags;
 638         u8                      port_num;
 639         u8                      dmac[ETH_ALEN];
 640         u16                     vlan_id;
 641 };
 642
 643 enum ib_wc_status {
 644         IB_WC_SUCCESS,
 645         IB_WC_LOC_LEN_ERR,
 646         IB_WC_LOC_QP_OP_ERR,
 647         IB_WC_LOC_EEC_OP_ERR,
 648         IB_WC_LOC_PROT_ERR,
 649         IB_WC_WR_FLUSH_ERR,
 650         IB_WC_MW_BIND_ERR,
 651         IB_WC_BAD_RESP_ERR,
 652         IB_WC_LOC_ACCESS_ERR,
 653         IB_WC_REM_INV_REQ_ERR,
 654         IB_WC_REM_ACCESS_ERR,
 655         IB_WC_REM_OP_ERR,
 656         IB_WC_RETRY_EXC_ERR,
 657         IB_WC_RNR_RETRY_EXC_ERR,
 658         IB_WC_LOC_RDD_VIOL_ERR,
 659         IB_WC_REM_INV_RD_REQ_ERR,
 660         IB_WC_REM_ABORT_ERR,
 661         IB_WC_INV_EECN_ERR,
 662         IB_WC_INV_EEC_STATE_ERR,
 663         IB_WC_FATAL_ERR,
 664         IB_WC_RESP_TIMEOUT_ERR,
 665         IB_WC_GENERAL_ERR
 666 };
 667
 668 __attribute_const__ const char *ib_wc_status_msg(enum ib_wc_status status);
 669
 670 enum ib_wc_opcode {
 671         IB_WC_SEND,
 672         IB_WC_RDMA_WRITE,
 673         IB_WC_RDMA_READ,
 674         IB_WC_COMP_SWAP,
 675         IB_WC_FETCH_ADD,
 676         IB_WC_BIND_MW,
 677         IB_WC_LSO,
 678         IB_WC_LOCAL_INV,
 679         IB_WC_FAST_REG_MR,
 680         IB_WC_MASKED_COMP_SWAP,
 681         IB_WC_MASKED_FETCH_ADD,
 682 /*
 683  * Set value of IB_WC_RECV so consumers can test if a completion is a
 684  * receive by testing (opcode & IB_WC_RECV).
 685  */
 686         IB_WC_RECV                      = 1 << 7,
 687         IB_WC_RECV_RDMA_WITH_IMM
 688 };
 689
 690 enum ib_wc_flags {
 691         IB_WC_GRH               = 1,
 692         IB_WC_WITH_IMM          = (1<<1),
 693         IB_WC_WITH_INVALIDATE   = (1<<2),
 694         IB_WC_IP_CSUM_OK        = (1<<3),
 695         IB_WC_WITH_SMAC         = (1<<4),
 696         IB_WC_WITH_VLAN         = (1<<5),
 697 };
 698
 699 struct ib_wc {
 700         u64                     wr_id;
 701         enum ib_wc_status       status;
 702         enum ib_wc_opcode       opcode;
 703         u32                     vendor_err;
 704         u32                     byte_len;
 705         struct ib_qp           *qp;
 706         union {
 707                 __be32          imm_data;
 708                 u32             invalidate_rkey;
 709         } ex;
 710         u32                     src_qp;
 711         int                     wc_flags;
 712         u16                     pkey_index;
 713         u16                     slid;
 714         u8                      sl;
 715         u8                      dlid_path_bits;
 716         u8                      port_num;       /* valid only for DR SMPs on switches */
 717         u8                      smac[ETH_ALEN];
 718         u16                     vlan_id;
 719 };
 720
 721 enum ib_cq_notify_flags {
 722         IB_CQ_SOLICITED                 = 1 << 0,
 723         IB_CQ_NEXT_COMP                 = 1 << 1,
 724         IB_CQ_SOLICITED_MASK            = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
 725         IB_CQ_REPORT_MISSED_EVENTS      = 1 << 2,
 726 };
 727
 728 enum ib_srq_type {
 729         IB_SRQT_BASIC,
 730         IB_SRQT_XRC
 731 };
 732
 733 enum ib_srq_attr_mask {
 734         IB_SRQ_MAX_WR   = 1 << 0,
 735         IB_SRQ_LIMIT    = 1 << 1,
 736 };
 737
 738 struct ib_srq_attr {
 739         u32     max_wr;
 740         u32     max_sge;
 741         u32     srq_limit;
 742 };
 743
 744 struct ib_srq_init_attr {
 745         void                  (*event_handler)(struct ib_event *, void *);
 746         void                   *srq_context;
 747         struct ib_srq_attr      attr;
 748         enum ib_srq_type        srq_type;
 749
 750         union {
 751                 struct {
 752                         struct ib_xrcd *xrcd;
 753                         struct ib_cq   *cq;
 754                 } xrc;
 755         } ext;
 756 };
 757
 758 struct ib_qp_cap {
 759         u32     max_send_wr;
 760         u32     max_recv_wr;
 761         u32     max_send_sge;
 762         u32     max_recv_sge;
 763         u32     max_inline_data;
 764 };
 765
 766 enum ib_sig_type {
 767         IB_SIGNAL_ALL_WR,
 768         IB_SIGNAL_REQ_WR
 769 };
 770
 771 enum ib_qp_type {
 772         /*
 773          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
 774          * here (and in that order) since the MAD layer uses them as
 775          * indices into a 2-entry table.
 776          */
 777         IB_QPT_SMI,
 778         IB_QPT_GSI,
 779
 780         IB_QPT_RC,
 781         IB_QPT_UC,
 782         IB_QPT_UD,
 783         IB_QPT_RAW_IPV6,
 784         IB_QPT_RAW_ETHERTYPE,
 785         IB_QPT_RAW_PACKET = 8,
 786         IB_QPT_XRC_INI = 9,
 787         IB_QPT_XRC_TGT,
 788         IB_QPT_MAX,
 789         /* Reserve a range for qp types internal to the low level driver.
 790          * These qp types will not be visible at the IB core layer, so the
 791          * IB_QPT_MAX usages should not be affected in the core layer
 792          */
 793         IB_QPT_RESERVED1 = 0x1000,
 794         IB_QPT_RESERVED2,
 795         IB_QPT_RESERVED3,
 796         IB_QPT_RESERVED4,
 797         IB_QPT_RESERVED5,
 798         IB_QPT_RESERVED6,
 799         IB_QPT_RESERVED7,
 800         IB_QPT_RESERVED8,
 801         IB_QPT_RESERVED9,
 802         IB_QPT_RESERVED10,
 803 };
 804
 805 enum ib_qp_create_flags {
 806         IB_QP_CREATE_IPOIB_UD_LSO               = 1 << 0,
 807         IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK   = 1 << 1,
 808         IB_QP_CREATE_NETIF_QP                   = 1 << 5,
 809         IB_QP_CREATE_SIGNATURE_EN               = 1 << 6,
 810         IB_QP_CREATE_USE_GFP_NOIO               = 1 << 7,
 811         /* reserve bits 26-31 for low level drivers' internal use */
 812         IB_QP_CREATE_RESERVED_START             = 1 << 26,
 813         IB_QP_CREATE_RESERVED_END               = 1 << 31,
 814 };
 815
 816
 817 /*
 818  * Note: users may not call ib_close_qp or ib_destroy_qp from the event_handler
 819  * callback to destroy the passed in QP.
 820  */
 821
 822 struct ib_qp_init_attr {
 823         void                  (*event_handler)(struct ib_event *, void *);
 824         void                   *qp_context;
 825         struct ib_cq           *send_cq;
 826         struct ib_cq           *recv_cq;
 827         struct ib_srq          *srq;
 828         struct ib_xrcd         *xrcd;     /* XRC TGT QPs only */
 829         struct ib_qp_cap        cap;
 830         enum ib_sig_type        sq_sig_type;
 831         enum ib_qp_type         qp_type;
 832         enum ib_qp_create_flags create_flags;
 833         u8                      port_num; /* special QP types only */
 834 };
 835
 836 struct ib_qp_open_attr {
 837         void                  (*event_handler)(struct ib_event *, void *);
 838         void                   *qp_context;
 839         u32                     qp_num;
 840         enum ib_qp_type         qp_type;
 841 };
 842
 843 enum ib_rnr_timeout {
 844         IB_RNR_TIMER_655_36 =  0,
 845         IB_RNR_TIMER_000_01 =  1,
 846         IB_RNR_TIMER_000_02 =  2,
 847         IB_RNR_TIMER_000_03 =  3,
 848         IB_RNR_TIMER_000_04 =  4,
 849         IB_RNR_TIMER_000_06 =  5,
 850         IB_RNR_TIMER_000_08 =  6,
 851         IB_RNR_TIMER_000_12 =  7,
 852         IB_RNR_TIMER_000_16 =  8,
 853         IB_RNR_TIMER_000_24 =  9,
 854         IB_RNR_TIMER_000_32 = 10,
 855         IB_RNR_TIMER_000_48 = 11,
 856         IB_RNR_TIMER_000_64 = 12,
 857         IB_RNR_TIMER_000_96 = 13,
 858         IB_RNR_TIMER_001_28 = 14,
 859         IB_RNR_TIMER_001_92 = 15,
 860         IB_RNR_TIMER_002_56 = 16,
 861         IB_RNR_TIMER_003_84 = 17,
 862         IB_RNR_TIMER_005_12 = 18,
 863         IB_RNR_TIMER_007_68 = 19,
 864         IB_RNR_TIMER_010_24 = 20,
 865         IB_RNR_TIMER_015_36 = 21,
 866         IB_RNR_TIMER_020_48 = 22,
 867         IB_RNR_TIMER_030_72 = 23,
 868         IB_RNR_TIMER_040_96 = 24,
 869         IB_RNR_TIMER_061_44 = 25,
 870         IB_RNR_TIMER_081_92 = 26,
 871         IB_RNR_TIMER_122_88 = 27,
 872         IB_RNR_TIMER_163_84 = 28,
 873         IB_RNR_TIMER_245_76 = 29,
 874         IB_RNR_TIMER_327_68 = 30,
 875         IB_RNR_TIMER_491_52 = 31
 876 };
 877
 878 enum ib_qp_attr_mask {
 879         IB_QP_STATE                     = 1,
 880         IB_QP_CUR_STATE                 = (1<<1),
 881         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
 882         IB_QP_ACCESS_FLAGS              = (1<<3),
 883         IB_QP_PKEY_INDEX                = (1<<4),
 884         IB_QP_PORT                      = (1<<5),
 885         IB_QP_QKEY                      = (1<<6),
 886         IB_QP_AV                        = (1<<7),
 887         IB_QP_PATH_MTU                  = (1<<8),
 888         IB_QP_TIMEOUT                   = (1<<9),
 889         IB_QP_RETRY_CNT                 = (1<<10),
 890         IB_QP_RNR_RETRY                 = (1<<11),
 891         IB_QP_RQ_PSN                    = (1<<12),
 892         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
 893         IB_QP_ALT_PATH                  = (1<<14),
 894         IB_QP_MIN_RNR_TIMER             = (1<<15),
 895         IB_QP_SQ_PSN                    = (1<<16),
 896         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
 897         IB_QP_PATH_MIG_STATE            = (1<<18),
 898         IB_QP_CAP                       = (1<<19),
 899         IB_QP_DEST_QPN                  = (1<<20),
 900         IB_QP_SMAC                      = (1<<21),
 901         IB_QP_ALT_SMAC                  = (1<<22),
 902         IB_QP_VID                       = (1<<23),
 903         IB_QP_ALT_VID                   = (1<<24),
 904 };
 905
 906 enum ib_qp_state {
 907         IB_QPS_RESET,
 908         IB_QPS_INIT,
 909         IB_QPS_RTR,
 910         IB_QPS_RTS,
 911         IB_QPS_SQD,
 912         IB_QPS_SQE,
 913         IB_QPS_ERR
 914 };
 915
 916 enum ib_mig_state {
 917         IB_MIG_MIGRATED,
 918         IB_MIG_REARM,
 919         IB_MIG_ARMED
 920 };
 921
 922 enum ib_mw_type {
 923         IB_MW_TYPE_1 = 1,
 924         IB_MW_TYPE_2 = 2
 925 };
 926
 927 struct ib_qp_attr {
 928         enum ib_qp_state        qp_state;
 929         enum ib_qp_state        cur_qp_state;
 930         enum ib_mtu             path_mtu;
 931         enum ib_mig_state       path_mig_state;
 932         u32                     qkey;
 933         u32                     rq_psn;
 934         u32                     sq_psn;
 935         u32                     dest_qp_num;
 936         int                     qp_access_flags;
 937         struct ib_qp_cap        cap;
 938         struct ib_ah_attr       ah_attr;
 939         struct ib_ah_attr       alt_ah_attr;
 940         u16                     pkey_index;
 941         u16                     alt_pkey_index;
 942         u8                      en_sqd_async_notify;
 943         u8                      sq_draining;
 944         u8                      max_rd_atomic;
 945         u8                      max_dest_rd_atomic;
 946         u8                      min_rnr_timer;
 947         u8                      port_num;
 948         u8                      timeout;
 949         u8                      retry_cnt;
 950         u8                      rnr_retry;
 951         u8                      alt_port_num;
 952         u8                      alt_timeout;
 953         u8                      smac[ETH_ALEN];
 954         u8                      alt_smac[ETH_ALEN];
 955         u16                     vlan_id;
 956         u16                     alt_vlan_id;
 957 };
 958
 959 enum ib_wr_opcode {
 960         IB_WR_RDMA_WRITE,
 961         IB_WR_RDMA_WRITE_WITH_IMM,
 962         IB_WR_SEND,
 963         IB_WR_SEND_WITH_IMM,
 964         IB_WR_RDMA_READ,
 965         IB_WR_ATOMIC_CMP_AND_SWP,
 966         IB_WR_ATOMIC_FETCH_AND_ADD,
 967         IB_WR_LSO,
 968         IB_WR_SEND_WITH_INV,
 969         IB_WR_RDMA_READ_WITH_INV,
 970         IB_WR_LOCAL_INV,
 971         IB_WR_FAST_REG_MR,
 972         IB_WR_MASKED_ATOMIC_CMP_AND_SWP,
 973         IB_WR_MASKED_ATOMIC_FETCH_AND_ADD,
 974         IB_WR_BIND_MW,
 975         IB_WR_REG_SIG_MR,
 976         /* reserve values for low level drivers' internal use.
 977          * These values will not be used at all in the ib core layer.
 978          */
 979         IB_WR_RESERVED1 = 0xf0,
 980         IB_WR_RESERVED2,
 981         IB_WR_RESERVED3,
 982         IB_WR_RESERVED4,
 983         IB_WR_RESERVED5,
 984         IB_WR_RESERVED6,
 985         IB_WR_RESERVED7,
 986         IB_WR_RESERVED8,
 987         IB_WR_RESERVED9,
 988         IB_WR_RESERVED10,
 989 };
 990
 991 enum ib_send_flags {
 992         IB_SEND_FENCE           = 1,
 993         IB_SEND_SIGNALED        = (1<<1),
 994         IB_SEND_SOLICITED       = (1<<2),
 995         IB_SEND_INLINE          = (1<<3),
 996         IB_SEND_IP_CSUM         = (1<<4),
 997
 998         /* reserve bits 26-31 for low level drivers' internal use */
 999         IB_SEND_RESERVED_START  = (1 << 26),
1000         IB_SEND_RESERVED_END    = (1 << 31),
1001 };
1002
1003 struct ib_sge {
1004         u64     addr;
1005         u32     length;
1006         u32     lkey;
1007 };
1008
1009 struct ib_fast_reg_page_list {
1010         struct ib_device       *device;
1011         u64                    *page_list;
1012         unsigned int            max_page_list_len;
1013 };
1014
1015 /**
1016  * struct ib_mw_bind_info - Parameters for a memory window bind operation.
1017  * @mr: A memory region to bind the memory window to.
1018  * @addr: The address where the memory window should begin.
1019  * @length: The length of the memory window, in bytes.
1020  * @mw_access_flags: Access flags from enum ib_access_flags for the window.
1021  *
1022  * This struct contains the shared parameters for type 1 and type 2
1023  * memory window bind operations.
1024  */
1025 struct ib_mw_bind_info {
1026         struct ib_mr   *mr;
1027         u64             addr;
1028         u64             length;
1029         int             mw_access_flags;
1030 };
1031
1032 struct ib_send_wr {
1033         struct ib_send_wr      *next;
1034         u64                     wr_id;
1035         struct ib_sge          *sg_list;
1036         int                     num_sge;
1037         enum ib_wr_opcode       opcode;
1038         int                     send_flags;
1039         union {
1040                 __be32          imm_data;
1041                 u32             invalidate_rkey;
1042         } ex;
1043         union {
1044                 struct {
1045                         u64     remote_addr;
1046                         u32     rkey;
1047                 } rdma;
1048                 struct {
1049                         u64     remote_addr;
1050                         u64     compare_add;
1051                         u64     swap;
1052                         u64     compare_add_mask;
1053                         u64     swap_mask;
1054                         u32     rkey;
1055                 } atomic;
1056                 struct {
1057                         struct ib_ah *ah;
1058                         void   *header;
1059                         int     hlen;
1060                         int     mss;
1061                         u32     remote_qpn;
1062                         u32     remote_qkey;
1063                         u16     pkey_index; /* valid for GSI only */
1064                         u8      port_num;   /* valid for DR SMPs on switch only */
1065                 } ud;
1066                 struct {
1067                         u64                             iova_start;
1068                         struct ib_fast_reg_page_list   *page_list;
1069                         unsigned int                    page_shift;
1070                         unsigned int                    page_list_len;
1071                         u32                             length;
1072                         int                             access_flags;
1073                         u32                             rkey;
1074                 } fast_reg;
1075                 struct {
1076                         struct ib_mw            *mw;
1077                         /* The new rkey for the memory window. */
1078                         u32                      rkey;
1079                         struct ib_mw_bind_info   bind_info;
1080                 } bind_mw;
1081                 struct {
1082                         struct ib_sig_attrs    *sig_attrs;
1083                         struct ib_mr           *sig_mr;
1084                         int                     access_flags;
1085                         struct ib_sge          *prot;
1086                 } sig_handover;
1087         } wr;
1088         u32                     xrc_remote_srq_num;     /* XRC TGT QPs only */
1089 };
1090
1091 struct ib_recv_wr {
1092         struct ib_recv_wr      *next;
1093         u64                     wr_id;
1094         struct ib_sge          *sg_list;
1095         int                     num_sge;
1096 };
1097
1098 enum ib_access_flags {
1099         IB_ACCESS_LOCAL_WRITE   = 1,
1100         IB_ACCESS_REMOTE_WRITE  = (1<<1),
1101         IB_ACCESS_REMOTE_READ   = (1<<2),
1102         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
1103         IB_ACCESS_MW_BIND       = (1<<4),
1104         IB_ZERO_BASED           = (1<<5),
1105         IB_ACCESS_ON_DEMAND     = (1<<6),
1106 };
1107
1108 struct ib_phys_buf {
1109         u64      addr;
1110         u64      size;
1111 };
1112
1113 struct ib_mr_attr {
1114         struct ib_pd    *pd;
1115         u64             device_virt_addr;
1116         u64             size;
1117         int             mr_access_flags;
1118         u32             lkey;
1119         u32             rkey;
1120 };
1121
1122 enum ib_mr_rereg_flags {
1123         IB_MR_REREG_TRANS       = 1,
1124         IB_MR_REREG_PD          = (1<<1),
1125         IB_MR_REREG_ACCESS      = (1<<2),
1126         IB_MR_REREG_SUPPORTED   = ((IB_MR_REREG_ACCESS << 1) - 1)
1127 };
1128
1129 /**
1130  * struct ib_mw_bind - Parameters for a type 1 memory window bind operation.
1131  * @wr_id:      Work request id.
1132  * @send_flags: Flags from ib_send_flags enum.
1133  * @bind_info:  More parameters of the bind operation.
1134  */
1135 struct ib_mw_bind {
1136         u64                    wr_id;
1137         int                    send_flags;
1138         struct ib_mw_bind_info bind_info;
1139 };
1140
1141 struct ib_fmr_attr {
1142         int     max_pages;
1143         int     max_maps;
1144         u8      page_shift;
1145 };
1146
1147 struct ib_umem;
1148
1149 struct ib_ucontext {
1150         struct ib_device       *device;
1151         struct list_head        pd_list;
1152         struct list_head        mr_list;
1153         struct list_head        mw_list;
1154         struct list_head        cq_list;
1155         struct list_head        qp_list;
1156         struct list_head        srq_list;
1157         struct list_head        ah_list;
1158         struct list_head        xrcd_list;
1159         struct list_head        rule_list;
1160         int                     closing;
1161
1162         struct pid             *tgid;
1163 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
1164         struct rb_root      umem_tree;
1165         /*
1166          * Protects .umem_rbroot and tree, as well as odp_mrs_count and
1167          * mmu notifiers registration.
1168          */
1169         struct rw_semaphore     umem_rwsem;
1170         void (*invalidate_range)(struct ib_umem *umem,
1171                                  unsigned long start, unsigned long end);
1172
1173         struct mmu_notifier     mn;
1174         atomic_t                notifier_count;
1175         /* A list of umems that don't have private mmu notifier counters yet. */
1176         struct list_head        no_private_counters;
1177         int                     odp_mrs_count;
1178 #endif
1179 };
1180
1181 struct ib_uobject {
1182         u64                     user_handle;    /* handle given to us by userspace */
1183         struct ib_ucontext     *context;        /* associated user context */
1184         void                   *object;         /* containing object */
1185         struct list_head        list;           /* link to context's list */
1186         int                     id;             /* index into kernel idr */
1187         struct kref             ref;
1188         struct rw_semaphore     mutex;          /* protects .live */
1189         int                     live;
1190 };
1191
1192 struct ib_udata {
1193         const void __user *inbuf;
1194         void __user *outbuf;
1195         size_t       inlen;
1196         size_t       outlen;
1197 };
1198
1199 struct ib_pd {
1200         struct ib_device       *device;
1201         struct ib_uobject      *uobject;
1202         atomic_t                usecnt; /* count all resources */
1203 };
1204
1205 struct ib_xrcd {
1206         struct ib_device       *device;
1207         atomic_t                usecnt; /* count all exposed resources */
1208         struct inode           *inode;
1209
1210         struct mutex            tgt_qp_mutex;
1211         struct list_head        tgt_qp_list;
1212 };
1213
1214 struct ib_ah {
1215         struct ib_device        *device;
1216         struct ib_pd            *pd;
1217         struct ib_uobject       *uobject;
1218 };
1219
1220 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
1221
1222 struct ib_cq {
1223         struct ib_device       *device;
1224         struct ib_uobject      *uobject;
1225         ib_comp_handler         comp_handler;
1226         void                  (*event_handler)(struct ib_event *, void *);
1227         void                   *cq_context;
1228         int                     cqe;
1229         atomic_t                usecnt; /* count number of work queues */
1230 };
1231
1232 struct ib_srq {
1233         struct ib_device       *device;
1234         struct ib_pd           *pd;
1235         struct ib_uobject      *uobject;
1236         void                  (*event_handler)(struct ib_event *, void *);
1237         void                   *srq_context;
1238         enum ib_srq_type        srq_type;
1239         atomic_t                usecnt;
1240
1241         union {
1242                 struct {
1243                         struct ib_xrcd *xrcd;
1244                         struct ib_cq   *cq;
1245                         u32             srq_num;
1246                 } xrc;
1247         } ext;
1248 };
1249
1250 struct ib_qp {
1251         struct ib_device       *device;
1252         struct ib_pd           *pd;
1253         struct ib_cq           *send_cq;
1254         struct ib_cq           *recv_cq;
1255         struct ib_srq          *srq;
1256         struct ib_xrcd         *xrcd; /* XRC TGT QPs only */
1257         struct list_head        xrcd_list;
1258         /* count times opened, mcast attaches, flow attaches */
1259         atomic_t                usecnt;
1260         struct list_head        open_list;
1261         struct ib_qp           *real_qp;
1262         struct ib_uobject      *uobject;
1263         void                  (*event_handler)(struct ib_event *, void *);
1264         void                   *qp_context;
1265         u32                     qp_num;
1266         enum ib_qp_type         qp_type;
1267 };
1268
1269 struct ib_mr {
1270         struct ib_device  *device;
1271         struct ib_pd      *pd;
1272         struct ib_uobject *uobject;
1273         u32                lkey;
1274         u32                rkey;
1275         atomic_t           usecnt; /* count number of MWs */
1276 };
1277
1278 struct ib_mw {
1279         struct ib_device        *device;
1280         struct ib_pd            *pd;
1281         struct ib_uobject       *uobject;
1282         u32                     rkey;
1283         enum ib_mw_type         type;
1284 };
1285
1286 struct ib_fmr {
1287         struct ib_device        *device;
1288         struct ib_pd            *pd;
1289         struct list_head        list;
1290         u32                     lkey;
1291         u32                     rkey;
1292 };
1293
1294 /* Supported steering options */
1295 enum ib_flow_attr_type {
1296         /* steering according to rule specifications */
1297         IB_FLOW_ATTR_NORMAL             = 0x0,
1298         /* default unicast and multicast rule -
1299          * receive all Eth traffic which isn't steered to any QP
1300          */
1301         IB_FLOW_ATTR_ALL_DEFAULT        = 0x1,
1302         /* default multicast rule -
1303          * receive all Eth multicast traffic which isn't steered to any QP
1304          */
1305         IB_FLOW_ATTR_MC_DEFAULT         = 0x2,
1306         /* sniffer rule - receive all port traffic */
1307         IB_FLOW_ATTR_SNIFFER            = 0x3
1308 };
1309
1310 /* Supported steering header types */
1311 enum ib_flow_spec_type {
1312         /* L2 headers*/
1313         IB_FLOW_SPEC_ETH        = 0x20,
1314         IB_FLOW_SPEC_IB         = 0x22,
1315         /* L3 header*/
1316         IB_FLOW_SPEC_IPV4       = 0x30,
1317         /* L4 headers*/
1318         IB_FLOW_SPEC_TCP        = 0x40,
1319         IB_FLOW_SPEC_UDP        = 0x41
1320 };
1321 #define IB_FLOW_SPEC_LAYER_MASK 0xF0
1322 #define IB_FLOW_SPEC_SUPPORT_LAYERS 4
1323
1324 /* Flow steering rule priority is set according to it's domain.
1325  * Lower domain value means higher priority.
1326  */
1327 enum ib_flow_domain {
1328         IB_FLOW_DOMAIN_USER,
1329         IB_FLOW_DOMAIN_ETHTOOL,
1330         IB_FLOW_DOMAIN_RFS,
1331         IB_FLOW_DOMAIN_NIC,
1332         IB_FLOW_DOMAIN_NUM /* Must be last */
1333 };
1334
1335 struct ib_flow_eth_filter {
1336         u8      dst_mac[6];
1337         u8      src_mac[6];
1338         __be16  ether_type;
1339         __be16  vlan_tag;
1340 };
1341
1342 struct ib_flow_spec_eth {
1343         enum ib_flow_spec_type    type;
1344         u16                       size;
1345         struct ib_flow_eth_filter val;
1346         struct ib_flow_eth_filter mask;
1347 };
1348
1349 struct ib_flow_ib_filter {
1350         __be16 dlid;
1351         __u8   sl;
1352 };
1353
1354 struct ib_flow_spec_ib {
1355         enum ib_flow_spec_type   type;
1356         u16                      size;
1357         struct ib_flow_ib_filter val;
1358         struct ib_flow_ib_filter mask;
1359 };
1360
1361 struct ib_flow_ipv4_filter {
1362         __be32  src_ip;
1363         __be32  dst_ip;
1364 };
1365
1366 struct ib_flow_spec_ipv4 {
1367         enum ib_flow_spec_type     type;
1368         u16                        size;
1369         struct ib_flow_ipv4_filter val;
1370         struct ib_flow_ipv4_filter mask;
1371 };
1372
1373 struct ib_flow_tcp_udp_filter {
1374         __be16  dst_port;
1375         __be16  src_port;
1376 };
1377
1378 struct ib_flow_spec_tcp_udp {
1379         enum ib_flow_spec_type        type;
1380         u16                           size;
1381         struct ib_flow_tcp_udp_filter val;
1382         struct ib_flow_tcp_udp_filter mask;
1383 };
1384
1385 union ib_flow_spec {
1386         struct {
1387                 enum ib_flow_spec_type  type;
1388                 u16                     size;
1389         };
1390         struct ib_flow_spec_eth         eth;
1391         struct ib_flow_spec_ib          ib;
1392         struct ib_flow_spec_ipv4        ipv4;
1393         struct ib_flow_spec_tcp_udp     tcp_udp;
1394 };
1395
1396 struct ib_flow_attr {
1397         enum ib_flow_attr_type type;
1398         u16          size;
1399         u16          priority;
1400         u32          flags;
1401         u8           num_of_specs;
1402         u8           port;
1403         /* Following are the optional layers according to user request
1404          * struct ib_flow_spec_xxx
1405          * struct ib_flow_spec_yyy
1406          */
1407 };
1408
1409 struct ib_flow {
1410         struct ib_qp            *qp;
1411         struct ib_uobject       *uobject;
1412 };
1413
1414 struct ib_mad;
1415 struct ib_grh;
1416
1417 enum ib_process_mad_flags {
1418         IB_MAD_IGNORE_MKEY      = 1,
1419         IB_MAD_IGNORE_BKEY      = 2,
1420         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
1421 };
1422
1423 enum ib_mad_result {
1424         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
1425         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
1426         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
1427         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
1428 };
1429
1430 #define IB_DEVICE_NAME_MAX 64
1431
1432 struct ib_cache {
1433         rwlock_t                lock;
1434         struct ib_event_handler event_handler;
1435         struct ib_pkey_cache  **pkey_cache;
1436         struct ib_gid_cache   **gid_cache;
1437         u8                     *lmc_cache;
1438 };
1439
1440 struct ib_dma_mapping_ops {
1441         int             (*mapping_error)(struct ib_device *dev,
1442                                          u64 dma_addr);
1443         u64             (*map_single)(struct ib_device *dev,
1444                                       void *ptr, size_t size,
1445                                       enum dma_data_direction direction);
1446         void            (*unmap_single)(struct ib_device *dev,
1447                                         u64 addr, size_t size,
1448                                         enum dma_data_direction direction);
1449         u64             (*map_page)(struct ib_device *dev,
1450                                     struct page *page, unsigned long offset,
1451                                     size_t size,
1452                                     enum dma_data_direction direction);
1453         void            (*unmap_page)(struct ib_device *dev,
1454                                       u64 addr, size_t size,
1455                                       enum dma_data_direction direction);
1456         int             (*map_sg)(struct ib_device *dev,
1457                                   struct scatterlist *sg, int nents,
1458                                   enum dma_data_direction direction);
1459         void            (*unmap_sg)(struct ib_device *dev,
1460                                     struct scatterlist *sg, int nents,
1461                                     enum dma_data_direction direction);
1462         void            (*sync_single_for_cpu)(struct ib_device *dev,
1463                                                u64 dma_handle,
1464                                                size_t size,
1465                                                enum dma_data_direction dir);
1466         void            (*sync_single_for_device)(struct ib_device *dev,
1467                                                   u64 dma_handle,
1468                                                   size_t size,
1469                                                   enum dma_data_direction dir);
1470         void            *(*alloc_coherent)(struct ib_device *dev,
1471                                            size_t size,
1472                                            u64 *dma_handle,
1473                                            gfp_t flag);
1474         void            (*free_coherent)(struct ib_device *dev,
1475                                          size_t size, void *cpu_addr,
1476                                          u64 dma_handle);
1477 };
1478
1479 struct iw_cm_verbs;
1480
1481 struct ib_device {
1482         struct device                *dma_device;
1483
1484         char                          name[IB_DEVICE_NAME_MAX];
1485
1486         struct list_head              event_handler_list;
1487         spinlock_t                    event_handler_lock;
1488
1489         spinlock_t                    client_data_lock;
1490         struct list_head              core_list;
1491         struct list_head              client_data_list;
1492
1493         struct ib_cache               cache;
1494         int                          *pkey_tbl_len;
1495         int                          *gid_tbl_len;
1496
1497         int                           num_comp_vectors;
1498
1499         struct iw_cm_verbs           *iwcm;
1500
1501         int                        (*get_protocol_stats)(struct ib_device *device,
1502                                                          union rdma_protocol_stats *stats);
1503         int                        (*query_device)(struct ib_device *device,
1504                                                    struct ib_device_attr *device_attr);
1505         int                        (*query_port)(struct ib_device *device,
1506                                                  u8 port_num,
1507                                                  struct ib_port_attr *port_attr);
1508         enum rdma_link_layer       (*get_link_layer)(struct ib_device *device,
1509                                                      u8 port_num);
1510         int                        (*query_gid)(struct ib_device *device,
1511                                                 u8 port_num, int index,
1512                                                 union ib_gid *gid);
1513         int                        (*query_pkey)(struct ib_device *device,
1514                                                  u8 port_num, u16 index, u16 *pkey);
1515         int                        (*modify_device)(struct ib_device *device,
1516                                                     int device_modify_mask,
1517                                                     struct ib_device_modify *device_modify);
1518         int                        (*modify_port)(struct ib_device *device,
1519                                                   u8 port_num, int port_modify_mask,
1520                                                   struct ib_port_modify *port_modify);
1521         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
1522                                                      struct ib_udata *udata);
1523         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
1524         int                        (*mmap)(struct ib_ucontext *context,
1525                                            struct vm_area_struct *vma);
1526         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
1527                                                struct ib_ucontext *context,
1528                                                struct ib_udata *udata);
1529         int                        (*dealloc_pd)(struct ib_pd *pd);
1530         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
1531                                                 struct ib_ah_attr *ah_attr);
1532         int                        (*modify_ah)(struct ib_ah *ah,
1533                                                 struct ib_ah_attr *ah_attr);
1534         int                        (*query_ah)(struct ib_ah *ah,
1535                                                struct ib_ah_attr *ah_attr);
1536         int                        (*destroy_ah)(struct ib_ah *ah);
1537         struct ib_srq *            (*create_srq)(struct ib_pd *pd,
1538                                                  struct ib_srq_init_attr *srq_init_attr,
1539                                                  struct ib_udata *udata);
1540         int                        (*modify_srq)(struct ib_srq *srq,
1541                                                  struct ib_srq_attr *srq_attr,
1542                                                  enum ib_srq_attr_mask srq_attr_mask,
1543                                                  struct ib_udata *udata);
1544         int                        (*query_srq)(struct ib_srq *srq,
1545                                                 struct ib_srq_attr *srq_attr);
1546         int                        (*destroy_srq)(struct ib_srq *srq);
1547         int                        (*post_srq_recv)(struct ib_srq *srq,
1548                                                     struct ib_recv_wr *recv_wr,
1549                                                     struct ib_recv_wr **bad_recv_wr);
1550         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
1551                                                 struct ib_qp_init_attr *qp_init_attr,
1552                                                 struct ib_udata *udata);
1553         int                        (*modify_qp)(struct ib_qp *qp,
1554                                                 struct ib_qp_attr *qp_attr,
1555                                                 int qp_attr_mask,
1556                                                 struct ib_udata *udata);
1557         int                        (*query_qp)(struct ib_qp *qp,
1558                                                struct ib_qp_attr *qp_attr,
1559                                                int qp_attr_mask,
1560                                                struct ib_qp_init_attr *qp_init_attr);
1561         int                        (*destroy_qp)(struct ib_qp *qp);
1562         int                        (*post_send)(struct ib_qp *qp,
1563                                                 struct ib_send_wr *send_wr,
1564                                                 struct ib_send_wr **bad_send_wr);
1565         int                        (*post_recv)(struct ib_qp *qp,
1566                                                 struct ib_recv_wr *recv_wr,
1567                                                 struct ib_recv_wr **bad_recv_wr);
1568         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
1569                                                 int comp_vector,
1570                                                 struct ib_ucontext *context,
1571                                                 struct ib_udata *udata);
1572         int                        (*modify_cq)(struct ib_cq *cq, u16 cq_count,
1573                                                 u16 cq_period);
1574         int                        (*destroy_cq)(struct ib_cq *cq);
1575         int                        (*resize_cq)(struct ib_cq *cq, int cqe,
1576                                                 struct ib_udata *udata);
1577         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
1578                                               struct ib_wc *wc);
1579         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
1580         int                        (*req_notify_cq)(struct ib_cq *cq,
1581                                                     enum ib_cq_notify_flags flags);
1582         int                        (*req_ncomp_notif)(struct ib_cq *cq,
1583                                                       int wc_cnt);
1584         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
1585                                                  int mr_access_flags);
1586         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
1587                                                   struct ib_phys_buf *phys_buf_array,
1588                                                   int num_phys_buf,
1589                                                   int mr_access_flags,
1590                                                   u64 *iova_start);
1591         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
1592                                                   u64 start, u64 length,
1593                                                   u64 virt_addr,
1594                                                   int mr_access_flags,
1595                                                   struct ib_udata *udata);
1596         int                        (*rereg_user_mr)(struct ib_mr *mr,
1597                                                     int flags,
1598                                                     u64 start, u64 length,
1599                                                     u64 virt_addr,
1600                                                     int mr_access_flags,
1601                                                     struct ib_pd *pd,
1602                                                     struct ib_udata *udata);
1603         int                        (*query_mr)(struct ib_mr *mr,
1604                                                struct ib_mr_attr *mr_attr);
1605         int                        (*dereg_mr)(struct ib_mr *mr);
1606         int                        (*destroy_mr)(struct ib_mr *mr);
1607         struct ib_mr *             (*create_mr)(struct ib_pd *pd,
1608                                                 struct ib_mr_init_attr *mr_init_attr);
1609         struct ib_mr *             (*alloc_fast_reg_mr)(struct ib_pd *pd,
1610                                                int max_page_list_len);
1611         struct ib_fast_reg_page_list * (*alloc_fast_reg_page_list)(struct ib_device *device,
1612                                                                    int page_list_len);
1613         void                       (*free_fast_reg_page_list)(struct ib_fast_reg_page_list *page_list);
1614         int                        (*rereg_phys_mr)(struct ib_mr *mr,
1615                                                     int mr_rereg_mask,
1616                                                     struct ib_pd *pd,
1617                                                     struct ib_phys_buf *phys_buf_array,
1618                                                     int num_phys_buf,
1619                                                     int mr_access_flags,
1620                                                     u64 *iova_start);
1621         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd,
1622                                                enum ib_mw_type type);
1623         int                        (*bind_mw)(struct ib_qp *qp,
1624                                               struct ib_mw *mw,
1625                                               struct ib_mw_bind *mw_bind);
1626         int                        (*dealloc_mw)(struct ib_mw *mw);
1627         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
1628                                                 int mr_access_flags,
1629                                                 struct ib_fmr_attr *fmr_attr);
1630         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
1631                                                    u64 *page_list, int list_len,
1632                                                    u64 iova);
1633         int                        (*unmap_fmr)(struct list_head *fmr_list);
1634         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
1635         int                        (*attach_mcast)(struct ib_qp *qp,
1636                                                    union ib_gid *gid,
1637                                                    u16 lid);
1638         int                        (*detach_mcast)(struct ib_qp *qp,
1639                                                    union ib_gid *gid,
1640                                                    u16 lid);
1641         int                        (*process_mad)(struct ib_device *device,
1642                                                   int process_mad_flags,
1643                                                   u8 port_num,
1644                                                   struct ib_wc *in_wc,
1645                                                   struct ib_grh *in_grh,
1646                                                   struct ib_mad *in_mad,
1647                                                   struct ib_mad *out_mad);
1648         struct ib_xrcd *           (*alloc_xrcd)(struct ib_device *device,
1649                                                  struct ib_ucontext *ucontext,
1650                                                  struct ib_udata *udata);
1651         int                        (*dealloc_xrcd)(struct ib_xrcd *xrcd);
1652         struct ib_flow *           (*create_flow)(struct ib_qp *qp,
1653                                                   struct ib_flow_attr
1654                                                   *flow_attr,
1655                                                   int domain);
1656         int                        (*destroy_flow)(struct ib_flow *flow_id);
1657         int                        (*check_mr_status)(struct ib_mr *mr, u32 check_mask,
1658                                                       struct ib_mr_status *mr_status);
1659
1660         struct ib_dma_mapping_ops   *dma_ops;
1661
1662         struct module               *owner;
1663         struct device                dev;
1664         struct kobject               *ports_parent;
1665         struct list_head             port_list;
1666
1667         enum {
1668                 IB_DEV_UNINITIALIZED,
1669                 IB_DEV_REGISTERED,
1670                 IB_DEV_UNREGISTERED
1671         }                            reg_state;
1672
1673         int                          uverbs_abi_ver;
1674         u64                          uverbs_cmd_mask;
1675         u64                          uverbs_ex_cmd_mask;
1676
1677         char                         node_desc[64];
1678         __be64                       node_guid;
1679         u32                          local_dma_lkey;
1680         u8                           node_type;
1681         u8                           phys_port_cnt;
1682 };
1683
1684 struct ib_client {
1685         char  *name;
1686         void (*add)   (struct ib_device *);
1687         void (*remove)(struct ib_device *);
1688
1689         struct list_head list;
1690 };
1691
1692 struct ib_device *ib_alloc_device(size_t size);
1693 void ib_dealloc_device(struct ib_device *device);
1694
1695 int ib_register_device(struct ib_device *device,
1696                        int (*port_callback)(struct ib_device *,
1697                                             u8, struct kobject *));
1698 void ib_unregister_device(struct ib_device *device);
1699
1700 int ib_register_client   (struct ib_client *client);
1701 void ib_unregister_client(struct ib_client *client);
1702
1703 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1704 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
1705                          void *data);
1706
1707 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1708 {
1709         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1710 }
1711
1712 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1713 {
1714         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1715 }
1716
1717 /**
1718  * ib_modify_qp_is_ok - Check that the supplied attribute mask
1719  * contains all required attributes and no attributes not allowed for
1720  * the given QP state transition.
1721  * @cur_state: Current QP state
1722  * @next_state: Next QP state
1723  * @type: QP type
1724  * @mask: Mask of supplied QP attributes
1725  * @ll : link layer of port
1726  *
1727  * This function is a helper function that a low-level driver's
1728  * modify_qp method can use to validate the consumer's input.  It
1729  * checks that cur_state and next_state are valid QP states, that a
1730  * transition from cur_state to next_state is allowed by the IB spec,
1731  * and that the attribute mask supplied is allowed for the transition.
1732  */
1733 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1734                        enum ib_qp_type type, enum ib_qp_attr_mask mask,
1735                        enum rdma_link_layer ll);
1736
1737 int ib_register_event_handler  (struct ib_event_handler *event_handler);
1738 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1739 void ib_dispatch_event(struct ib_event *event);
1740
1741 int ib_query_device(struct ib_device *device,
1742                     struct ib_device_attr *device_attr);
1743
1744 int ib_query_port(struct ib_device *device,
1745                   u8 port_num, struct ib_port_attr *port_attr);
1746
1747 enum rdma_link_layer rdma_port_get_link_layer(struct ib_device *device,
1748                                                u8 port_num);
1749
1750 int ib_query_gid(struct ib_device *device,
1751                  u8 port_num, int index, union ib_gid *gid);
1752
1753 int ib_query_pkey(struct ib_device *device,
1754                   u8 port_num, u16 index, u16 *pkey);
1755
1756 int ib_modify_device(struct ib_device *device,
1757                      int device_modify_mask,
1758                      struct ib_device_modify *device_modify);
1759
1760 int ib_modify_port(struct ib_device *device,
1761                    u8 port_num, int port_modify_mask,
1762                    struct ib_port_modify *port_modify);
1763
1764 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1765                 u8 *port_num, u16 *index);
1766
1767 int ib_find_pkey(struct ib_device *device,
1768                  u8 port_num, u16 pkey, u16 *index);
1769
1770 /**
1771  * ib_alloc_pd - Allocates an unused protection domain.
1772  * @device: The device on which to allocate the protection domain.
1773  *
1774  * A protection domain object provides an association between QPs, shared
1775  * receive queues, address handles, memory regions, and memory windows.
1776  */
1777 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1778
1779 /**
1780  * ib_dealloc_pd - Deallocates a protection domain.
1781  * @pd: The protection domain to deallocate.
1782  */
1783 int ib_dealloc_pd(struct ib_pd *pd);
1784
1785 /**
1786  * ib_create_ah - Creates an address handle for the given address vector.
1787  * @pd: The protection domain associated with the address handle.
1788  * @ah_attr: The attributes of the address vector.
1789  *
1790  * The address handle is used to reference a local or global destination
1791  * in all UD QP post sends.
1792  */
1793 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1794
1795 /**
1796  * ib_init_ah_from_wc - Initializes address handle attributes from a
1797  *   work completion.
1798  * @device: Device on which the received message arrived.
1799  * @port_num: Port on which the received message arrived.
1800  * @wc: Work completion associated with the received message.
1801  * @grh: References the received global route header.  This parameter is
1802  *   ignored unless the work completion indicates that the GRH is valid.
1803  * @ah_attr: Returned attributes that can be used when creating an address
1804  *   handle for replying to the message.
1805  */
1806 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1807                        struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1808
1809 /**
1810  * ib_create_ah_from_wc - Creates an address handle associated with the
1811  *   sender of the specified work completion.
1812  * @pd: The protection domain associated with the address handle.
1813  * @wc: Work completion information associated with a received message.
1814  * @grh: References the received global route header.  This parameter is
1815  *   ignored unless the work completion indicates that the GRH is valid.
1816  * @port_num: The outbound port number to associate with the address.
1817  *
1818  * The address handle is used to reference a local or global destination
1819  * in all UD QP post sends.
1820  */
1821 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1822                                    struct ib_grh *grh, u8 port_num);
1823
1824 /**
1825  * ib_modify_ah - Modifies the address vector associated with an address
1826  *   handle.
1827  * @ah: The address handle to modify.
1828  * @ah_attr: The new address vector attributes to associate with the
1829  *   address handle.
1830  */
1831 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1832
1833 /**
1834  * ib_query_ah - Queries the address vector associated with an address
1835  *   handle.
1836  * @ah: The address handle to query.
1837  * @ah_attr: The address vector attributes associated with the address
1838  *   handle.
1839  */
1840 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1841
1842 /**
1843  * ib_destroy_ah - Destroys an address handle.
1844  * @ah: The address handle to destroy.
1845  */
1846 int ib_destroy_ah(struct ib_ah *ah);
1847
1848 /**
1849  * ib_create_srq - Creates a SRQ associated with the specified protection
1850  *   domain.
1851  * @pd: The protection domain associated with the SRQ.
1852  * @srq_init_attr: A list of initial attributes required to create the
1853  *   SRQ.  If SRQ creation succeeds, then the attributes are updated to
1854  *   the actual capabilities of the created SRQ.
1855  *
1856  * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1857  * requested size of the SRQ, and set to the actual values allocated
1858  * on return.  If ib_create_srq() succeeds, then max_wr and max_sge
1859  * will always be at least as large as the requested values.
1860  */
1861 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1862                              struct ib_srq_init_attr *srq_init_attr);
1863
1864 /**
1865  * ib_modify_srq - Modifies the attributes for the specified SRQ.
1866  * @srq: The SRQ to modify.
1867  * @srq_attr: On input, specifies the SRQ attributes to modify.  On output,
1868  *   the current values of selected SRQ attributes are returned.
1869  * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1870  *   are being modified.
1871  *
1872  * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1873  * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1874  * the number of receives queued drops below the limit.
1875  */
1876 int ib_modify_srq(struct ib_srq *srq,
1877                   struct ib_srq_attr *srq_attr,
1878                   enum ib_srq_attr_mask srq_attr_mask);
1879
1880 /**
1881  * ib_query_srq - Returns the attribute list and current values for the
1882  *   specified SRQ.
1883  * @srq: The SRQ to query.
1884  * @srq_attr: The attributes of the specified SRQ.
1885  */
1886 int ib_query_srq(struct ib_srq *srq,
1887                  struct ib_srq_attr *srq_attr);
1888
1889 /**
1890  * ib_destroy_srq - Destroys the specified SRQ.
1891  * @srq: The SRQ to destroy.
1892  */
1893 int ib_destroy_srq(struct ib_srq *srq);
1894
1895 /**
1896  * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1897  * @srq: The SRQ to post the work request on.
1898  * @recv_wr: A list of work requests to post on the receive queue.
1899  * @bad_recv_wr: On an immediate failure, this parameter will reference
1900  *   the work request that failed to be posted on the QP.
1901  */
1902 static inline int ib_post_srq_recv(struct ib_srq *srq,
1903                                    struct ib_recv_wr *recv_wr,
1904                                    struct ib_recv_wr **bad_recv_wr)
1905 {
1906         return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1907 }
1908
1909 /**
1910  * ib_create_qp - Creates a QP associated with the specified protection
1911  *   domain.
1912  * @pd: The protection domain associated with the QP.
1913  * @qp_init_attr: A list of initial attributes required to create the
1914  *   QP.  If QP creation succeeds, then the attributes are updated to
1915  *   the actual capabilities of the created QP.
1916  */
1917 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1918                            struct ib_qp_init_attr *qp_init_attr);
1919
1920 /**
1921  * ib_modify_qp - Modifies the attributes for the specified QP and then
1922  *   transitions the QP to the given state.
1923  * @qp: The QP to modify.
1924  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1925  *   the current values of selected QP attributes are returned.
1926  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1927  *   are being modified.
1928  */
1929 int ib_modify_qp(struct ib_qp *qp,
1930                  struct ib_qp_attr *qp_attr,
1931                  int qp_attr_mask);
1932
1933 /**
1934  * ib_query_qp - Returns the attribute list and current values for the
1935  *   specified QP.
1936  * @qp: The QP to query.
1937  * @qp_attr: The attributes of the specified QP.
1938  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1939  * @qp_init_attr: Additional attributes of the selected QP.
1940  *
1941  * The qp_attr_mask may be used to limit the query to gathering only the
1942  * selected attributes.
1943  */
1944 int ib_query_qp(struct ib_qp *qp,
1945                 struct ib_qp_attr *qp_attr,
1946                 int qp_attr_mask,
1947                 struct ib_qp_init_attr *qp_init_attr);
1948
1949 /**
1950  * ib_destroy_qp - Destroys the specified QP.
1951  * @qp: The QP to destroy.
1952  */
1953 int ib_destroy_qp(struct ib_qp *qp);
1954
1955 /**
1956  * ib_open_qp - Obtain a reference to an existing sharable QP.
1957  * @xrcd - XRC domain
1958  * @qp_open_attr: Attributes identifying the QP to open.
1959  *
1960  * Returns a reference to a sharable QP.
1961  */
1962 struct ib_qp *ib_open_qp(struct ib_xrcd *xrcd,
1963                          struct ib_qp_open_attr *qp_open_attr);
1964
1965 /**
1966  * ib_close_qp - Release an external reference to a QP.
1967  * @qp: The QP handle to release
1968  *
1969  * The opened QP handle is released by the caller.  The underlying
1970  * shared QP is not destroyed until all internal references are released.
1971  */
1972 int ib_close_qp(struct ib_qp *qp);
1973
1974 /**
1975  * ib_post_send - Posts a list of work requests to the send queue of
1976  *   the specified QP.
1977  * @qp: The QP to post the work request on.
1978  * @send_wr: A list of work requests to post on the send queue.
1979  * @bad_send_wr: On an immediate failure, this parameter will reference
1980  *   the work request that failed to be posted on the QP.
1981  *
1982  * While IBA Vol. 1 section 11.4.1.1 specifies that if an immediate
1983  * error is returned, the QP state shall not be affected,
1984  * ib_post_send() will return an immediate error after queueing any
1985  * earlier work requests in the list.
1986  */
1987 static inline int ib_post_send(struct ib_qp *qp,
1988                                struct ib_send_wr *send_wr,
1989                                struct ib_send_wr **bad_send_wr)
1990 {
1991         return qp->device->post_send(qp, send_wr, bad_send_wr);
1992 }
1993
1994 /**
1995  * ib_post_recv - Posts a list of work requests to the receive queue of
1996  *   the specified QP.
1997  * @qp: The QP to post the work request on.
1998  * @recv_wr: A list of work requests to post on the receive queue.
1999  * @bad_recv_wr: On an immediate failure, this parameter will reference
2000  *   the work request that failed to be posted on the QP.
2001  */
2002 static inline int ib_post_recv(struct ib_qp *qp,
2003                                struct ib_recv_wr *recv_wr,
2004                                struct ib_recv_wr **bad_recv_wr)
2005 {
2006         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
2007 }
2008
2009 /**
2010  * ib_create_cq - Creates a CQ on the specified device.
2011  * @device: The device on which to create the CQ.
2012  * @comp_handler: A user-specified callback that is invoked when a
2013  *   completion event occurs on the CQ.
2014  * @event_handler: A user-specified callback that is invoked when an
2015  *   asynchronous event not associated with a completion occurs on the CQ.
2016  * @cq_context: Context associated with the CQ returned to the user via
2017  *   the associated completion and event handlers.
2018  * @cqe: The minimum size of the CQ.
2019  * @comp_vector - Completion vector used to signal completion events.
2020  *     Must be >= 0 and < context->num_comp_vectors.
2021  *
2022  * Users can examine the cq structure to determine the actual CQ size.
2023  */
2024 struct ib_cq *ib_create_cq(struct ib_device *device,
2025                            ib_comp_handler comp_handler,
2026                            void (*event_handler)(struct ib_event *, void *),
2027                            void *cq_context, int cqe, int comp_vector);
2028
2029 /**
2030  * ib_resize_cq - Modifies the capacity of the CQ.
2031  * @cq: The CQ to resize.
2032  * @cqe: The minimum size of the CQ.
2033  *
2034  * Users can examine the cq structure to determine the actual CQ size.
2035  */
2036 int ib_resize_cq(struct ib_cq *cq, int cqe);
2037
2038 /**
2039  * ib_modify_cq - Modifies moderation params of the CQ
2040  * @cq: The CQ to modify.
2041  * @cq_count: number of CQEs that will trigger an event
2042  * @cq_period: max period of time in usec before triggering an event
2043  *
2044  */
2045 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
2046
2047 /**
2048  * ib_destroy_cq - Destroys the specified CQ.
2049  * @cq: The CQ to destroy.
2050  */
2051 int ib_destroy_cq(struct ib_cq *cq);
2052
2053 /**
2054  * ib_poll_cq - poll a CQ for completion(s)
2055  * @cq:the CQ being polled
2056  * @num_entries:maximum number of completions to return
2057  * @wc:array of at least @num_entries &struct ib_wc where completions
2058  *   will be returned
2059  *
2060  * Poll a CQ for (possibly multiple) completions.  If the return value
2061  * is < 0, an error occurred.  If the return value is >= 0, it is the
2062  * number of completions returned.  If the return value is
2063  * non-negative and < num_entries, then the CQ was emptied.
2064  */
2065 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
2066                              struct ib_wc *wc)
2067 {
2068         return cq->device->poll_cq(cq, num_entries, wc);
2069 }
2070
2071 /**
2072  * ib_peek_cq - Returns the number of unreaped completions currently
2073  *   on the specified CQ.
2074  * @cq: The CQ to peek.
2075  * @wc_cnt: A minimum number of unreaped completions to check for.
2076  *
2077  * If the number of unreaped completions is greater than or equal to wc_cnt,
2078  * this function returns wc_cnt, otherwise, it returns the actual number of
2079  * unreaped completions.
2080  */
2081 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
2082
2083 /**
2084  * ib_req_notify_cq - Request completion notification on a CQ.
2085  * @cq: The CQ to generate an event for.
2086  * @flags:
2087  *   Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
2088  *   to request an event on the next solicited event or next work
2089  *   completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
2090  *   may also be |ed in to request a hint about missed events, as
2091  *   described below.
2092  *
2093  * Return Value:
2094  *    < 0 means an error occurred while requesting notification
2095  *   == 0 means notification was requested successfully, and if
2096  *        IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
2097  *        were missed and it is safe to wait for another event.  In
2098  *        this case is it guaranteed that any work completions added
2099  *        to the CQ since the last CQ poll will trigger a completion
2100  *        notification event.
2101  *    > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
2102  *        in.  It means that the consumer must poll the CQ again to
2103  *        make sure it is empty to avoid missing an event because of a
2104  *        race between requesting notification and an entry being
2105  *        added to the CQ.  This return value means it is possible
2106  *        (but not guaranteed) that a work completion has been added
2107  *        to the CQ since the last poll without triggering a
2108  *        completion notification event.
2109  */
2110 static inline int ib_req_notify_cq(struct ib_cq *cq,
2111                                    enum ib_cq_notify_flags flags)
2112 {
2113         return cq->device->req_notify_cq(cq, flags);
2114 }
2115
2116 /**
2117  * ib_req_ncomp_notif - Request completion notification when there are
2118  *   at least the specified number of unreaped completions on the CQ.
2119  * @cq: The CQ to generate an event for.
2120  * @wc_cnt: The number of unreaped completions that should be on the
2121  *   CQ before an event is generated.
2122  */
2123 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
2124 {
2125         return cq->device->req_ncomp_notif ?
2126                 cq->device->req_ncomp_notif(cq, wc_cnt) :
2127                 -ENOSYS;
2128 }
2129
2130 /**
2131  * ib_get_dma_mr - Returns a memory region for system memory that is
2132  *   usable for DMA.
2133  * @pd: The protection domain associated with the memory region.
2134  * @mr_access_flags: Specifies the memory access rights.
2135  *
2136  * Note that the ib_dma_*() functions defined below must be used
2137  * to create/destroy addresses used with the Lkey or Rkey returned
2138  * by ib_get_dma_mr().
2139  */
2140 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
2141
2142 /**
2143  * ib_dma_mapping_error - check a DMA addr for error
2144  * @dev: The device for which the dma_addr was created
2145  * @dma_addr: The DMA address to check
2146  */
2147 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
2148 {
2149         if (dev->dma_ops)
2150                 return dev->dma_ops->mapping_error(dev, dma_addr);
2151         return dma_mapping_error(dev->dma_device, dma_addr);
2152 }
2153
2154 /**
2155  * ib_dma_map_single - Map a kernel virtual address to DMA address
2156  * @dev: The device for which the dma_addr is to be created
2157  * @cpu_addr: The kernel virtual address
2158  * @size: The size of the region in bytes
2159  * @direction: The direction of the DMA
2160  */
2161 static inline u64 ib_dma_map_single(struct ib_device *dev,
2162                                     void *cpu_addr, size_t size,
2163                                     enum dma_data_direction direction)
2164 {
2165         if (dev->dma_ops)
2166                 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
2167         return dma_map_single(dev->dma_device, cpu_addr, size, direction);
2168 }
2169
2170 /**
2171  * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
2172  * @dev: The device for which the DMA address was created
2173  * @addr: The DMA address
2174  * @size: The size of the region in bytes
2175  * @direction: The direction of the DMA
2176  */
2177 static inline void ib_dma_unmap_single(struct ib_device *dev,
2178                                        u64 addr, size_t size,
2179                                        enum dma_data_direction direction)
2180 {
2181         if (dev->dma_ops)
2182                 dev->dma_ops->unmap_single(dev, addr, size, direction);
2183         else
2184                 dma_unmap_single(dev->dma_device, addr, size, direction);
2185 }
2186
2187 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
2188                                           void *cpu_addr, size_t size,
2189                                           enum dma_data_direction direction,
2190                                           struct dma_attrs *attrs)
2191 {
2192         return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
2193                                     direction, attrs);
2194 }
2195
2196 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
2197                                              u64 addr, size_t size,
2198                                              enum dma_data_direction direction,
2199                                              struct dma_attrs *attrs)
2200 {
2201         return dma_unmap_single_attrs(dev->dma_device, addr, size,
2202                                       direction, attrs);
2203 }
2204
2205 /**
2206  * ib_dma_map_page - Map a physical page to DMA address
2207  * @dev: The device for which the dma_addr is to be created
2208  * @page: The page to be mapped
2209  * @offset: The offset within the page
2210  * @size: The size of the region in bytes
2211  * @direction: The direction of the DMA
2212  */
2213 static inline u64 ib_dma_map_page(struct ib_device *dev,
2214                                   struct page *page,
2215                                   unsigned long offset,
2216                                   size_t size,
2217                                          enum dma_data_direction direction)
2218 {
2219         if (dev->dma_ops)
2220                 return dev->dma_ops->map_page(dev, page, offset, size, direction);
2221         return dma_map_page(dev->dma_device, page, offset, size, direction);
2222 }
2223
2224 /**
2225  * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
2226  * @dev: The device for which the DMA address was created
2227  * @addr: The DMA address
2228  * @size: The size of the region in bytes
2229  * @direction: The direction of the DMA
2230  */
2231 static inline void ib_dma_unmap_page(struct ib_device *dev,
2232                                      u64 addr, size_t size,
2233                                      enum dma_data_direction direction)
2234 {
2235         if (dev->dma_ops)
2236                 dev->dma_ops->unmap_page(dev, addr, size, direction);
2237         else
2238                 dma_unmap_page(dev->dma_device, addr, size, direction);
2239 }
2240
2241 /**
2242  * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
2243  * @dev: The device for which the DMA addresses are to be created
2244  * @sg: The array of scatter/gather entries
2245  * @nents: The number of scatter/gather entries
2246  * @direction: The direction of the DMA
2247  */
2248 static inline int ib_dma_map_sg(struct ib_device *dev,
2249                                 struct scatterlist *sg, int nents,
2250                                 enum dma_data_direction direction)
2251 {
2252         if (dev->dma_ops)
2253                 return dev->dma_ops->map_sg(dev, sg, nents, direction);
2254         return dma_map_sg(dev->dma_device, sg, nents, direction);
2255 }
2256
2257 /**
2258  * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
2259  * @dev: The device for which the DMA addresses were created
2260  * @sg: The array of scatter/gather entries
2261  * @nents: The number of scatter/gather entries
2262  * @direction: The direction of the DMA
2263  */
2264 static inline void ib_dma_unmap_sg(struct ib_device *dev,
2265                                    struct scatterlist *sg, int nents,
2266                                    enum dma_data_direction direction)
2267 {
2268         if (dev->dma_ops)
2269                 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
2270         else
2271                 dma_unmap_sg(dev->dma_device, sg, nents, direction);
2272 }
2273
2274 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
2275                                       struct scatterlist *sg, int nents,
2276                                       enum dma_data_direction direction,
2277                                       struct dma_attrs *attrs)
2278 {
2279         return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
2280 }
2281
2282 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
2283                                          struct scatterlist *sg, int nents,
2284                                          enum dma_data_direction direction,
2285                                          struct dma_attrs *attrs)
2286 {
2287         dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
2288 }
2289 /**
2290  * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
2291  * @dev: The device for which the DMA addresses were created
2292  * @sg: The scatter/gather entry
2293  *
2294  * Note: this function is obsolete. To do: change all occurrences of
2295  * ib_sg_dma_address() into sg_dma_address().
2296  */
2297 static inline u64 ib_sg_dma_address(struct ib_device *dev,
2298                                     struct scatterlist *sg)
2299 {
2300         return sg_dma_address(sg);
2301 }
2302
2303 /**
2304  * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
2305  * @dev: The device for which the DMA addresses were created
2306  * @sg: The scatter/gather entry
2307  *
2308  * Note: this function is obsolete. To do: change all occurrences of
2309  * ib_sg_dma_len() into sg_dma_len().
2310  */
2311 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
2312                                          struct scatterlist *sg)
2313 {
2314         return sg_dma_len(sg);
2315 }
2316
2317 /**
2318  * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
2319  * @dev: The device for which the DMA address was created
2320  * @addr: The DMA address
2321  * @size: The size of the region in bytes
2322  * @dir: The direction of the DMA
2323  */
2324 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
2325                                               u64 addr,
2326                                               size_t size,
2327                                               enum dma_data_direction dir)
2328 {
2329         if (dev->dma_ops)
2330                 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
2331         else
2332                 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
2333 }
2334
2335 /**
2336  * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
2337  * @dev: The device for which the DMA address was created
2338  * @addr: The DMA address
2339  * @size: The size of the region in bytes
2340  * @dir: The direction of the DMA
2341  */
2342 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
2343                                                  u64 addr,
2344                                                  size_t size,
2345                                                  enum dma_data_direction dir)
2346 {
2347         if (dev->dma_ops)
2348                 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
2349         else
2350                 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
2351 }
2352
2353 /**
2354  * ib_dma_alloc_coherent - Allocate memory and map it for DMA
2355  * @dev: The device for which the DMA address is requested
2356  * @size: The size of the region to allocate in bytes
2357  * @dma_handle: A pointer for returning the DMA address of the region
2358  * @flag: memory allocator flags
2359  */
2360 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
2361                                            size_t size,
2362                                            u64 *dma_handle,
2363                                            gfp_t flag)
2364 {
2365         if (dev->dma_ops)
2366                 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
2367         else {
2368                 dma_addr_t handle;
2369                 void *ret;
2370
2371                 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
2372                 *dma_handle = handle;
2373                 return ret;
2374         }
2375 }
2376
2377 /**
2378  * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
2379  * @dev: The device for which the DMA addresses were allocated
2380  * @size: The size of the region
2381  * @cpu_addr: the address returned by ib_dma_alloc_coherent()
2382  * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
2383  */
2384 static inline void ib_dma_free_coherent(struct ib_device *dev,
2385                                         size_t size, void *cpu_addr,
2386                                         u64 dma_handle)
2387 {
2388         if (dev->dma_ops)
2389                 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
2390         else
2391                 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
2392 }
2393
2394 /**
2395  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
2396  *   by an HCA.
2397  * @pd: The protection domain associated assigned to the registered region.
2398  * @phys_buf_array: Specifies a list of physical buffers to use in the
2399  *   memory region.
2400  * @num_phys_buf: Specifies the size of the phys_buf_array.
2401  * @mr_access_flags: Specifies the memory access rights.
2402  * @iova_start: The offset of the region's starting I/O virtual address.
2403  */
2404 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
2405                              struct ib_phys_buf *phys_buf_array,
2406                              int num_phys_buf,
2407                              int mr_access_flags,
2408                              u64 *iova_start);
2409
2410 /**
2411  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
2412  *   Conceptually, this call performs the functions deregister memory region
2413  *   followed by register physical memory region.  Where possible,
2414  *   resources are reused instead of deallocated and reallocated.
2415  * @mr: The memory region to modify.
2416  * @mr_rereg_mask: A bit-mask used to indicate which of the following
2417  *   properties of the memory region are being modified.
2418  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
2419  *   the new protection domain to associated with the memory region,
2420  *   otherwise, this parameter is ignored.
2421  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2422  *   field specifies a list of physical buffers to use in the new
2423  *   translation, otherwise, this parameter is ignored.
2424  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
2425  *   field specifies the size of the phys_buf_array, otherwise, this
2426  *   parameter is ignored.
2427  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
2428  *   field specifies the new memory access rights, otherwise, this
2429  *   parameter is ignored.
2430  * @iova_start: The offset of the region's starting I/O virtual address.
2431  */
2432 int ib_rereg_phys_mr(struct ib_mr *mr,
2433                      int mr_rereg_mask,
2434                      struct ib_pd *pd,
2435                      struct ib_phys_buf *phys_buf_array,
2436                      int num_phys_buf,
2437                      int mr_access_flags,
2438                      u64 *iova_start);
2439
2440 /**
2441  * ib_query_mr - Retrieves information about a specific memory region.
2442  * @mr: The memory region to retrieve information about.
2443  * @mr_attr: The attributes of the specified memory region.
2444  */
2445 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
2446
2447 /**
2448  * ib_dereg_mr - Deregisters a memory region and removes it from the
2449  *   HCA translation table.
2450  * @mr: The memory region to deregister.
2451  *
2452  * This function can fail, if the memory region has memory windows bound to it.
2453  */
2454 int ib_dereg_mr(struct ib_mr *mr);
2455
2456
2457 /**
2458  * ib_create_mr - Allocates a memory region that may be used for
2459  *     signature handover operations.
2460  * @pd: The protection domain associated with the region.
2461  * @mr_init_attr: memory region init attributes.
2462  */
2463 struct ib_mr *ib_create_mr(struct ib_pd *pd,
2464                            struct ib_mr_init_attr *mr_init_attr);
2465
2466 /**
2467  * ib_destroy_mr - Destroys a memory region that was created using
2468  *     ib_create_mr and removes it from HW translation tables.
2469  * @mr: The memory region to destroy.
2470  *
2471  * This function can fail, if the memory region has memory windows bound to it.
2472  */
2473 int ib_destroy_mr(struct ib_mr *mr);
2474
2475 /**
2476  * ib_alloc_fast_reg_mr - Allocates memory region usable with the
2477  *   IB_WR_FAST_REG_MR send work request.
2478  * @pd: The protection domain associated with the region.
2479  * @max_page_list_len: requested max physical buffer list length to be
2480  *   used with fast register work requests for this MR.
2481  */
2482 struct ib_mr *ib_alloc_fast_reg_mr(struct ib_pd *pd, int max_page_list_len);
2483
2484 /**
2485  * ib_alloc_fast_reg_page_list - Allocates a page list array
2486  * @device - ib device pointer.
2487  * @page_list_len - size of the page list array to be allocated.
2488  *
2489  * This allocates and returns a struct ib_fast_reg_page_list * and a
2490  * page_list array that is at least page_list_len in size.  The actual
2491  * size is returned in max_page_list_len.  The caller is responsible
2492  * for initializing the contents of the page_list array before posting
2493  * a send work request with the IB_WC_FAST_REG_MR opcode.
2494  *
2495  * The page_list array entries must be translated using one of the
2496  * ib_dma_*() functions just like the addresses passed to
2497  * ib_map_phys_fmr().  Once the ib_post_send() is issued, the struct
2498  * ib_fast_reg_page_list must not be modified by the caller until the
2499  * IB_WC_FAST_REG_MR work request completes.
2500  */
2501 struct ib_fast_reg_page_list *ib_alloc_fast_reg_page_list(
2502                                 struct ib_device *device, int page_list_len);
2503
2504 /**
2505  * ib_free_fast_reg_page_list - Deallocates a previously allocated
2506  *   page list array.
2507  * @page_list - struct ib_fast_reg_page_list pointer to be deallocated.
2508  */
2509 void ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
2510
2511 /**
2512  * ib_update_fast_reg_key - updates the key portion of the fast_reg MR
2513  *   R_Key and L_Key.
2514  * @mr - struct ib_mr pointer to be updated.
2515  * @newkey - new key to be used.
2516  */
2517 static inline void ib_update_fast_reg_key(struct ib_mr *mr, u8 newkey)
2518 {
2519         mr->lkey = (mr->lkey & 0xffffff00) | newkey;
2520         mr->rkey = (mr->rkey & 0xffffff00) | newkey;
2521 }
2522
2523 /**
2524  * ib_inc_rkey - increments the key portion of the given rkey. Can be used
2525  * for calculating a new rkey for type 2 memory windows.
2526  * @rkey - the rkey to increment.
2527  */
2528 static inline u32 ib_inc_rkey(u32 rkey)
2529 {
2530         const u32 mask = 0x000000ff;
2531         return ((rkey + 1) & mask) | (rkey & ~mask);
2532 }
2533
2534 /**
2535  * ib_alloc_mw - Allocates a memory window.
2536  * @pd: The protection domain associated with the memory window.
2537  * @type: The type of the memory window (1 or 2).
2538  */
2539 struct ib_mw *ib_alloc_mw(struct ib_pd *pd, enum ib_mw_type type);
2540
2541 /**
2542  * ib_bind_mw - Posts a work request to the send queue of the specified
2543  *   QP, which binds the memory window to the given address range and
2544  *   remote access attributes.
2545  * @qp: QP to post the bind work request on.
2546  * @mw: The memory window to bind.
2547  * @mw_bind: Specifies information about the memory window, including
2548  *   its address range, remote access rights, and associated memory region.
2549  *
2550  * If there is no immediate error, the function will update the rkey member
2551  * of the mw parameter to its new value. The bind operation can still fail
2552  * asynchronously.
2553  */
2554 static inline int ib_bind_mw(struct ib_qp *qp,
2555                              struct ib_mw *mw,
2556                              struct ib_mw_bind *mw_bind)
2557 {
2558         /* XXX reference counting in corresponding MR? */
2559         return mw->device->bind_mw ?
2560                 mw->device->bind_mw(qp, mw, mw_bind) :
2561                 -ENOSYS;
2562 }
2563
2564 /**
2565  * ib_dealloc_mw - Deallocates a memory window.
2566  * @mw: The memory window to deallocate.
2567  */
2568 int ib_dealloc_mw(struct ib_mw *mw);
2569
2570 /**
2571  * ib_alloc_fmr - Allocates a unmapped fast memory region.
2572  * @pd: The protection domain associated with the unmapped region.
2573  * @mr_access_flags: Specifies the memory access rights.
2574  * @fmr_attr: Attributes of the unmapped region.
2575  *
2576  * A fast memory region must be mapped before it can be used as part of
2577  * a work request.
2578  */
2579 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
2580                             int mr_access_flags,
2581                             struct ib_fmr_attr *fmr_attr);
2582
2583 /**
2584  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
2585  * @fmr: The fast memory region to associate with the pages.
2586  * @page_list: An array of physical pages to map to the fast memory region.
2587  * @list_len: The number of pages in page_list.
2588  * @iova: The I/O virtual address to use with the mapped region.
2589  */
2590 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
2591                                   u64 *page_list, int list_len,
2592                                   u64 iova)
2593 {
2594         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
2595 }
2596
2597 /**
2598  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
2599  * @fmr_list: A linked list of fast memory regions to unmap.
2600  */
2601 int ib_unmap_fmr(struct list_head *fmr_list);
2602
2603 /**
2604  * ib_dealloc_fmr - Deallocates a fast memory region.
2605  * @fmr: The fast memory region to deallocate.
2606  */
2607 int ib_dealloc_fmr(struct ib_fmr *fmr);
2608
2609 /**
2610  * ib_attach_mcast - Attaches the specified QP to a multicast group.
2611  * @qp: QP to attach to the multicast group.  The QP must be type
2612  *   IB_QPT_UD.
2613  * @gid: Multicast group GID.
2614  * @lid: Multicast group LID in host byte order.
2615  *
2616  * In order to send and receive multicast packets, subnet
2617  * administration must have created the multicast group and configured
2618  * the fabric appropriately.  The port associated with the specified
2619  * QP must also be a member of the multicast group.
2620  */
2621 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2622
2623 /**
2624  * ib_detach_mcast - Detaches the specified QP from a multicast group.
2625  * @qp: QP to detach from the multicast group.
2626  * @gid: Multicast group GID.
2627  * @lid: Multicast group LID in host byte order.
2628  */
2629 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
2630
2631 /**
2632  * ib_alloc_xrcd - Allocates an XRC domain.
2633  * @device: The device on which to allocate the XRC domain.
2634  */
2635 struct ib_xrcd *ib_alloc_xrcd(struct ib_device *device);
2636
2637 /**
2638  * ib_dealloc_xrcd - Deallocates an XRC domain.
2639  * @xrcd: The XRC domain to deallocate.
2640  */
2641 int ib_dealloc_xrcd(struct ib_xrcd *xrcd);
2642
2643 struct ib_flow *ib_create_flow(struct ib_qp *qp,
2644                                struct ib_flow_attr *flow_attr, int domain);
2645 int ib_destroy_flow(struct ib_flow *flow_id);
2646
2647 static inline int ib_check_mr_access(int flags)
2648 {
2649         /*
2650          * Local write permission is required if remote write or
2651          * remote atomic permission is also requested.
2652          */
2653         if (flags & (IB_ACCESS_REMOTE_ATOMIC | IB_ACCESS_REMOTE_WRITE) &&
2654             !(flags & IB_ACCESS_LOCAL_WRITE))
2655                 return -EINVAL;
2656
2657         return 0;
2658 }
2659
2660 /**
2661  * ib_check_mr_status: lightweight check of MR status.
2662  *     This routine may provide status checks on a selected
2663  *     ib_mr. first use is for signature status check.
2664  *
2665  * @mr: A memory region.
2666  * @check_mask: Bitmask of which checks to perform from
2667  *     ib_mr_status_check enumeration.
2668  * @mr_status: The container of relevant status checks.
2669  *     failed checks will be indicated in the status bitmask
2670  *     and the relevant info shall be in the error item.
2671  */
2672 int ib_check_mr_status(struct ib_mr *mr, u32 check_mask,
2673                        struct ib_mr_status *mr_status);
2674
2675 #endif /* IB_VERBS_H */