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