drivers/infiniband/include/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 Cisco Systems.  All rights reserved.
   8  *
   9  * This software is available to you under a choice of one of two
  10  * licenses.  You may choose to be licensed under the terms of the GNU
  11  * General Public License (GPL) Version 2, available from the file
  12  * COPYING in the main directory of this source tree, or the
  13  * OpenIB.org BSD license below:
  14  *
  15  *     Redistribution and use in source and binary forms, with or
  16  *     without modification, are permitted provided that the following
  17  *     conditions are met:
  18  *
  19  *      - Redistributions of source code must retain the above
  20  *        copyright notice, this list of conditions and the following
  21  *        disclaimer.
  22  *
  23  *      - Redistributions in binary form must reproduce the above
  24  *        copyright notice, this list of conditions and the following
  25  *        disclaimer in the documentation and/or other materials
  26  *        provided with the distribution.
  27  *
  28  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  29  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  31  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  32  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  33  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  34  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  35  * SOFTWARE.
  36  *
  37  * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
  38  */
  39
  40 #if !defined(IB_VERBS_H)
  41 #define IB_VERBS_H
  42
  43 #include <linux/types.h>
  44 #include <linux/device.h>
  45
  46 #include <asm/atomic.h>
  47 #include <asm/scatterlist.h>
  48 #include <asm/uaccess.h>
  49
  50 union ib_gid {
  51         u8      raw[16];
  52         struct {
  53                 u64     subnet_prefix;
  54                 u64     interface_id;
  55         } global;
  56 };
  57
  58 enum ib_node_type {
  59         IB_NODE_CA      = 1,
  60         IB_NODE_SWITCH,
  61         IB_NODE_ROUTER
  62 };
  63
  64 enum ib_device_cap_flags {
  65         IB_DEVICE_RESIZE_MAX_WR         = 1,
  66         IB_DEVICE_BAD_PKEY_CNTR         = (1<<1),
  67         IB_DEVICE_BAD_QKEY_CNTR         = (1<<2),
  68         IB_DEVICE_RAW_MULTI             = (1<<3),
  69         IB_DEVICE_AUTO_PATH_MIG         = (1<<4),
  70         IB_DEVICE_CHANGE_PHY_PORT       = (1<<5),
  71         IB_DEVICE_UD_AV_PORT_ENFORCE    = (1<<6),
  72         IB_DEVICE_CURR_QP_STATE_MOD     = (1<<7),
  73         IB_DEVICE_SHUTDOWN_PORT         = (1<<8),
  74         IB_DEVICE_INIT_TYPE             = (1<<9),
  75         IB_DEVICE_PORT_ACTIVE_EVENT     = (1<<10),
  76         IB_DEVICE_SYS_IMAGE_GUID        = (1<<11),
  77         IB_DEVICE_RC_RNR_NAK_GEN        = (1<<12),
  78         IB_DEVICE_SRQ_RESIZE            = (1<<13),
  79         IB_DEVICE_N_NOTIFY_CQ           = (1<<14),
  80 };
  81
  82 enum ib_atomic_cap {
  83         IB_ATOMIC_NONE,
  84         IB_ATOMIC_HCA,
  85         IB_ATOMIC_GLOB
  86 };
  87
  88 struct ib_device_attr {
  89         u64                     fw_ver;
  90         u64                     node_guid;
  91         u64                     sys_image_guid;
  92         u64                     max_mr_size;
  93         u64                     page_size_cap;
  94         u32                     vendor_id;
  95         u32                     vendor_part_id;
  96         u32                     hw_ver;
  97         int                     max_qp;
  98         int                     max_qp_wr;
  99         int                     device_cap_flags;
 100         int                     max_sge;
 101         int                     max_sge_rd;
 102         int                     max_cq;
 103         int                     max_cqe;
 104         int                     max_mr;
 105         int                     max_pd;
 106         int                     max_qp_rd_atom;
 107         int                     max_ee_rd_atom;
 108         int                     max_res_rd_atom;
 109         int                     max_qp_init_rd_atom;
 110         int                     max_ee_init_rd_atom;
 111         enum ib_atomic_cap      atomic_cap;
 112         int                     max_ee;
 113         int                     max_rdd;
 114         int                     max_mw;
 115         int                     max_raw_ipv6_qp;
 116         int                     max_raw_ethy_qp;
 117         int                     max_mcast_grp;
 118         int                     max_mcast_qp_attach;
 119         int                     max_total_mcast_qp_attach;
 120         int                     max_ah;
 121         int                     max_fmr;
 122         int                     max_map_per_fmr;
 123         int                     max_srq;
 124         int                     max_srq_wr;
 125         int                     max_srq_sge;
 126         u16                     max_pkeys;
 127         u8                      local_ca_ack_delay;
 128 };
 129
 130 enum ib_mtu {
 131         IB_MTU_256  = 1,
 132         IB_MTU_512  = 2,
 133         IB_MTU_1024 = 3,
 134         IB_MTU_2048 = 4,
 135         IB_MTU_4096 = 5
 136 };
 137
 138 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
 139 {
 140         switch (mtu) {
 141         case IB_MTU_256:  return  256;
 142         case IB_MTU_512:  return  512;
 143         case IB_MTU_1024: return 1024;
 144         case IB_MTU_2048: return 2048;
 145         case IB_MTU_4096: return 4096;
 146         default:          return -1;
 147         }
 148 }
 149
 150 enum ib_port_state {
 151         IB_PORT_NOP             = 0,
 152         IB_PORT_DOWN            = 1,
 153         IB_PORT_INIT            = 2,
 154         IB_PORT_ARMED           = 3,
 155         IB_PORT_ACTIVE          = 4,
 156         IB_PORT_ACTIVE_DEFER    = 5
 157 };
 158
 159 enum ib_port_cap_flags {
 160         IB_PORT_SM                              = 1 <<  1,
 161         IB_PORT_NOTICE_SUP                      = 1 <<  2,
 162         IB_PORT_TRAP_SUP                        = 1 <<  3,
 163         IB_PORT_OPT_IPD_SUP                     = 1 <<  4,
 164         IB_PORT_AUTO_MIGR_SUP                   = 1 <<  5,
 165         IB_PORT_SL_MAP_SUP                      = 1 <<  6,
 166         IB_PORT_MKEY_NVRAM                      = 1 <<  7,
 167         IB_PORT_PKEY_NVRAM                      = 1 <<  8,
 168         IB_PORT_LED_INFO_SUP                    = 1 <<  9,
 169         IB_PORT_SM_DISABLED                     = 1 << 10,
 170         IB_PORT_SYS_IMAGE_GUID_SUP              = 1 << 11,
 171         IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP       = 1 << 12,
 172         IB_PORT_CM_SUP                          = 1 << 16,
 173         IB_PORT_SNMP_TUNNEL_SUP                 = 1 << 17,
 174         IB_PORT_REINIT_SUP                      = 1 << 18,
 175         IB_PORT_DEVICE_MGMT_SUP                 = 1 << 19,
 176         IB_PORT_VENDOR_CLASS_SUP                = 1 << 20,
 177         IB_PORT_DR_NOTICE_SUP                   = 1 << 21,
 178         IB_PORT_CAP_MASK_NOTICE_SUP             = 1 << 22,
 179         IB_PORT_BOOT_MGMT_SUP                   = 1 << 23,
 180         IB_PORT_LINK_LATENCY_SUP                = 1 << 24,
 181         IB_PORT_CLIENT_REG_SUP                  = 1 << 25
 182 };
 183
 184 enum ib_port_width {
 185         IB_WIDTH_1X     = 1,
 186         IB_WIDTH_4X     = 2,
 187         IB_WIDTH_8X     = 4,
 188         IB_WIDTH_12X    = 8
 189 };
 190
 191 static inline int ib_width_enum_to_int(enum ib_port_width width)
 192 {
 193         switch (width) {
 194         case IB_WIDTH_1X:  return  1;
 195         case IB_WIDTH_4X:  return  4;
 196         case IB_WIDTH_8X:  return  8;
 197         case IB_WIDTH_12X: return 12;
 198         default:          return -1;
 199         }
 200 }
 201
 202 struct ib_port_attr {
 203         enum ib_port_state      state;
 204         enum ib_mtu             max_mtu;
 205         enum ib_mtu             active_mtu;
 206         int                     gid_tbl_len;
 207         u32                     port_cap_flags;
 208         u32                     max_msg_sz;
 209         u32                     bad_pkey_cntr;
 210         u32                     qkey_viol_cntr;
 211         u16                     pkey_tbl_len;
 212         u16                     lid;
 213         u16                     sm_lid;
 214         u8                      lmc;
 215         u8                      max_vl_num;
 216         u8                      sm_sl;
 217         u8                      subnet_timeout;
 218         u8                      init_type_reply;
 219         u8                      active_width;
 220         u8                      active_speed;
 221         u8                      phys_state;
 222 };
 223
 224 enum ib_device_modify_flags {
 225         IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1
 226 };
 227
 228 struct ib_device_modify {
 229         u64     sys_image_guid;
 230 };
 231
 232 enum ib_port_modify_flags {
 233         IB_PORT_SHUTDOWN                = 1,
 234         IB_PORT_INIT_TYPE               = (1<<2),
 235         IB_PORT_RESET_QKEY_CNTR         = (1<<3)
 236 };
 237
 238 struct ib_port_modify {
 239         u32     set_port_cap_mask;
 240         u32     clr_port_cap_mask;
 241         u8      init_type;
 242 };
 243
 244 enum ib_event_type {
 245         IB_EVENT_CQ_ERR,
 246         IB_EVENT_QP_FATAL,
 247         IB_EVENT_QP_REQ_ERR,
 248         IB_EVENT_QP_ACCESS_ERR,
 249         IB_EVENT_COMM_EST,
 250         IB_EVENT_SQ_DRAINED,
 251         IB_EVENT_PATH_MIG,
 252         IB_EVENT_PATH_MIG_ERR,
 253         IB_EVENT_DEVICE_FATAL,
 254         IB_EVENT_PORT_ACTIVE,
 255         IB_EVENT_PORT_ERR,
 256         IB_EVENT_LID_CHANGE,
 257         IB_EVENT_PKEY_CHANGE,
 258         IB_EVENT_SM_CHANGE
 259 };
 260
 261 struct ib_event {
 262         struct ib_device        *device;
 263         union {
 264                 struct ib_cq    *cq;
 265                 struct ib_qp    *qp;
 266                 u8              port_num;
 267         } element;
 268         enum ib_event_type      event;
 269 };
 270
 271 struct ib_event_handler {
 272         struct ib_device *device;
 273         void            (*handler)(struct ib_event_handler *, struct ib_event *);
 274         struct list_head  list;
 275 };
 276
 277 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler)          \
 278         do {                                                    \
 279                 (_ptr)->device  = _device;                      \
 280                 (_ptr)->handler = _handler;                     \
 281                 INIT_LIST_HEAD(&(_ptr)->list);                  \
 282         } while (0)
 283
 284 struct ib_global_route {
 285         union ib_gid    dgid;
 286         u32             flow_label;
 287         u8              sgid_index;
 288         u8              hop_limit;
 289         u8              traffic_class;
 290 };
 291
 292 enum {
 293         IB_MULTICAST_QPN = 0xffffff
 294 };
 295
 296 enum ib_ah_flags {
 297         IB_AH_GRH       = 1
 298 };
 299
 300 struct ib_ah_attr {
 301         struct ib_global_route  grh;
 302         u16                     dlid;
 303         u8                      sl;
 304         u8                      src_path_bits;
 305         u8                      static_rate;
 306         u8                      ah_flags;
 307         u8                      port_num;
 308 };
 309
 310 enum ib_wc_status {
 311         IB_WC_SUCCESS,
 312         IB_WC_LOC_LEN_ERR,
 313         IB_WC_LOC_QP_OP_ERR,
 314         IB_WC_LOC_EEC_OP_ERR,
 315         IB_WC_LOC_PROT_ERR,
 316         IB_WC_WR_FLUSH_ERR,
 317         IB_WC_MW_BIND_ERR,
 318         IB_WC_BAD_RESP_ERR,
 319         IB_WC_LOC_ACCESS_ERR,
 320         IB_WC_REM_INV_REQ_ERR,
 321         IB_WC_REM_ACCESS_ERR,
 322         IB_WC_REM_OP_ERR,
 323         IB_WC_RETRY_EXC_ERR,
 324         IB_WC_RNR_RETRY_EXC_ERR,
 325         IB_WC_LOC_RDD_VIOL_ERR,
 326         IB_WC_REM_INV_RD_REQ_ERR,
 327         IB_WC_REM_ABORT_ERR,
 328         IB_WC_INV_EECN_ERR,
 329         IB_WC_INV_EEC_STATE_ERR,
 330         IB_WC_FATAL_ERR,
 331         IB_WC_RESP_TIMEOUT_ERR,
 332         IB_WC_GENERAL_ERR
 333 };
 334
 335 enum ib_wc_opcode {
 336         IB_WC_SEND,
 337         IB_WC_RDMA_WRITE,
 338         IB_WC_RDMA_READ,
 339         IB_WC_COMP_SWAP,
 340         IB_WC_FETCH_ADD,
 341         IB_WC_BIND_MW,
 342 /*
 343  * Set value of IB_WC_RECV so consumers can test if a completion is a
 344  * receive by testing (opcode & IB_WC_RECV).
 345  */
 346         IB_WC_RECV                      = 1 << 7,
 347         IB_WC_RECV_RDMA_WITH_IMM
 348 };
 349
 350 enum ib_wc_flags {
 351         IB_WC_GRH               = 1,
 352         IB_WC_WITH_IMM          = (1<<1)
 353 };
 354
 355 struct ib_wc {
 356         u64                     wr_id;
 357         enum ib_wc_status       status;
 358         enum ib_wc_opcode       opcode;
 359         u32                     vendor_err;
 360         u32                     byte_len;
 361         __be32                  imm_data;
 362         u32                     qp_num;
 363         u32                     src_qp;
 364         int                     wc_flags;
 365         u16                     pkey_index;
 366         u16                     slid;
 367         u8                      sl;
 368         u8                      dlid_path_bits;
 369         u8                      port_num;       /* valid only for DR SMPs on switches */
 370 };
 371
 372 enum ib_cq_notify {
 373         IB_CQ_SOLICITED,
 374         IB_CQ_NEXT_COMP
 375 };
 376
 377 struct ib_qp_cap {
 378         u32     max_send_wr;
 379         u32     max_recv_wr;
 380         u32     max_send_sge;
 381         u32     max_recv_sge;
 382         u32     max_inline_data;
 383 };
 384
 385 enum ib_sig_type {
 386         IB_SIGNAL_ALL_WR,
 387         IB_SIGNAL_REQ_WR
 388 };
 389
 390 enum ib_qp_type {
 391         /*
 392          * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
 393          * here (and in that order) since the MAD layer uses them as
 394          * indices into a 2-entry table.
 395          */
 396         IB_QPT_SMI,
 397         IB_QPT_GSI,
 398
 399         IB_QPT_RC,
 400         IB_QPT_UC,
 401         IB_QPT_UD,
 402         IB_QPT_RAW_IPV6,
 403         IB_QPT_RAW_ETY
 404 };
 405
 406 struct ib_qp_init_attr {
 407         void                  (*event_handler)(struct ib_event *, void *);
 408         void                   *qp_context;
 409         struct ib_cq           *send_cq;
 410         struct ib_cq           *recv_cq;
 411         struct ib_srq          *srq;
 412         struct ib_qp_cap        cap;
 413         enum ib_sig_type        sq_sig_type;
 414         enum ib_qp_type         qp_type;
 415         u8                      port_num; /* special QP types only */
 416 };
 417
 418 enum ib_rnr_timeout {
 419         IB_RNR_TIMER_655_36 =  0,
 420         IB_RNR_TIMER_000_01 =  1,
 421         IB_RNR_TIMER_000_02 =  2,
 422         IB_RNR_TIMER_000_03 =  3,
 423         IB_RNR_TIMER_000_04 =  4,
 424         IB_RNR_TIMER_000_06 =  5,
 425         IB_RNR_TIMER_000_08 =  6,
 426         IB_RNR_TIMER_000_12 =  7,
 427         IB_RNR_TIMER_000_16 =  8,
 428         IB_RNR_TIMER_000_24 =  9,
 429         IB_RNR_TIMER_000_32 = 10,
 430         IB_RNR_TIMER_000_48 = 11,
 431         IB_RNR_TIMER_000_64 = 12,
 432         IB_RNR_TIMER_000_96 = 13,
 433         IB_RNR_TIMER_001_28 = 14,
 434         IB_RNR_TIMER_001_92 = 15,
 435         IB_RNR_TIMER_002_56 = 16,
 436         IB_RNR_TIMER_003_84 = 17,
 437         IB_RNR_TIMER_005_12 = 18,
 438         IB_RNR_TIMER_007_68 = 19,
 439         IB_RNR_TIMER_010_24 = 20,
 440         IB_RNR_TIMER_015_36 = 21,
 441         IB_RNR_TIMER_020_48 = 22,
 442         IB_RNR_TIMER_030_72 = 23,
 443         IB_RNR_TIMER_040_96 = 24,
 444         IB_RNR_TIMER_061_44 = 25,
 445         IB_RNR_TIMER_081_92 = 26,
 446         IB_RNR_TIMER_122_88 = 27,
 447         IB_RNR_TIMER_163_84 = 28,
 448         IB_RNR_TIMER_245_76 = 29,
 449         IB_RNR_TIMER_327_68 = 30,
 450         IB_RNR_TIMER_491_52 = 31
 451 };
 452
 453 enum ib_qp_attr_mask {
 454         IB_QP_STATE                     = 1,
 455         IB_QP_CUR_STATE                 = (1<<1),
 456         IB_QP_EN_SQD_ASYNC_NOTIFY       = (1<<2),
 457         IB_QP_ACCESS_FLAGS              = (1<<3),
 458         IB_QP_PKEY_INDEX                = (1<<4),
 459         IB_QP_PORT                      = (1<<5),
 460         IB_QP_QKEY                      = (1<<6),
 461         IB_QP_AV                        = (1<<7),
 462         IB_QP_PATH_MTU                  = (1<<8),
 463         IB_QP_TIMEOUT                   = (1<<9),
 464         IB_QP_RETRY_CNT                 = (1<<10),
 465         IB_QP_RNR_RETRY                 = (1<<11),
 466         IB_QP_RQ_PSN                    = (1<<12),
 467         IB_QP_MAX_QP_RD_ATOMIC          = (1<<13),
 468         IB_QP_ALT_PATH                  = (1<<14),
 469         IB_QP_MIN_RNR_TIMER             = (1<<15),
 470         IB_QP_SQ_PSN                    = (1<<16),
 471         IB_QP_MAX_DEST_RD_ATOMIC        = (1<<17),
 472         IB_QP_PATH_MIG_STATE            = (1<<18),
 473         IB_QP_CAP                       = (1<<19),
 474         IB_QP_DEST_QPN                  = (1<<20)
 475 };
 476
 477 enum ib_qp_state {
 478         IB_QPS_RESET,
 479         IB_QPS_INIT,
 480         IB_QPS_RTR,
 481         IB_QPS_RTS,
 482         IB_QPS_SQD,
 483         IB_QPS_SQE,
 484         IB_QPS_ERR
 485 };
 486
 487 enum ib_mig_state {
 488         IB_MIG_MIGRATED,
 489         IB_MIG_REARM,
 490         IB_MIG_ARMED
 491 };
 492
 493 struct ib_qp_attr {
 494         enum ib_qp_state        qp_state;
 495         enum ib_qp_state        cur_qp_state;
 496         enum ib_mtu             path_mtu;
 497         enum ib_mig_state       path_mig_state;
 498         u32                     qkey;
 499         u32                     rq_psn;
 500         u32                     sq_psn;
 501         u32                     dest_qp_num;
 502         int                     qp_access_flags;
 503         struct ib_qp_cap        cap;
 504         struct ib_ah_attr       ah_attr;
 505         struct ib_ah_attr       alt_ah_attr;
 506         u16                     pkey_index;
 507         u16                     alt_pkey_index;
 508         u8                      en_sqd_async_notify;
 509         u8                      sq_draining;
 510         u8                      max_rd_atomic;
 511         u8                      max_dest_rd_atomic;
 512         u8                      min_rnr_timer;
 513         u8                      port_num;
 514         u8                      timeout;
 515         u8                      retry_cnt;
 516         u8                      rnr_retry;
 517         u8                      alt_port_num;
 518         u8                      alt_timeout;
 519 };
 520
 521 enum ib_wr_opcode {
 522         IB_WR_RDMA_WRITE,
 523         IB_WR_RDMA_WRITE_WITH_IMM,
 524         IB_WR_SEND,
 525         IB_WR_SEND_WITH_IMM,
 526         IB_WR_RDMA_READ,
 527         IB_WR_ATOMIC_CMP_AND_SWP,
 528         IB_WR_ATOMIC_FETCH_AND_ADD
 529 };
 530
 531 enum ib_send_flags {
 532         IB_SEND_FENCE           = 1,
 533         IB_SEND_SIGNALED        = (1<<1),
 534         IB_SEND_SOLICITED       = (1<<2),
 535         IB_SEND_INLINE          = (1<<3)
 536 };
 537
 538 struct ib_sge {
 539         u64     addr;
 540         u32     length;
 541         u32     lkey;
 542 };
 543
 544 struct ib_send_wr {
 545         struct ib_send_wr      *next;
 546         u64                     wr_id;
 547         struct ib_sge          *sg_list;
 548         int                     num_sge;
 549         enum ib_wr_opcode       opcode;
 550         int                     send_flags;
 551         __be32                  imm_data;
 552         union {
 553                 struct {
 554                         u64     remote_addr;
 555                         u32     rkey;
 556                 } rdma;
 557                 struct {
 558                         u64     remote_addr;
 559                         u64     compare_add;
 560                         u64     swap;
 561                         u32     rkey;
 562                 } atomic;
 563                 struct {
 564                         struct ib_ah *ah;
 565                         struct ib_mad_hdr *mad_hdr;
 566                         u32     remote_qpn;
 567                         u32     remote_qkey;
 568                         int     timeout_ms; /* valid for MADs only */
 569                         u16     pkey_index; /* valid for GSI only */
 570                         u8      port_num;   /* valid for DR SMPs on switch only */
 571                 } ud;
 572         } wr;
 573 };
 574
 575 struct ib_recv_wr {
 576         struct ib_recv_wr      *next;
 577         u64                     wr_id;
 578         struct ib_sge          *sg_list;
 579         int                     num_sge;
 580 };
 581
 582 enum ib_access_flags {
 583         IB_ACCESS_LOCAL_WRITE   = 1,
 584         IB_ACCESS_REMOTE_WRITE  = (1<<1),
 585         IB_ACCESS_REMOTE_READ   = (1<<2),
 586         IB_ACCESS_REMOTE_ATOMIC = (1<<3),
 587         IB_ACCESS_MW_BIND       = (1<<4)
 588 };
 589
 590 struct ib_phys_buf {
 591         u64      addr;
 592         u64      size;
 593 };
 594
 595 struct ib_mr_attr {
 596         struct ib_pd    *pd;
 597         u64             device_virt_addr;
 598         u64             size;
 599         int             mr_access_flags;
 600         u32             lkey;
 601         u32             rkey;
 602 };
 603
 604 enum ib_mr_rereg_flags {
 605         IB_MR_REREG_TRANS       = 1,
 606         IB_MR_REREG_PD          = (1<<1),
 607         IB_MR_REREG_ACCESS      = (1<<2)
 608 };
 609
 610 struct ib_mw_bind {
 611         struct ib_mr   *mr;
 612         u64             wr_id;
 613         u64             addr;
 614         u32             length;
 615         int             send_flags;
 616         int             mw_access_flags;
 617 };
 618
 619 struct ib_fmr_attr {
 620         int     max_pages;
 621         int     max_maps;
 622         u8      page_size;
 623 };
 624
 625 struct ib_ucontext {
 626         struct ib_device       *device;
 627         struct list_head        pd_list;
 628         struct list_head        mr_list;
 629         struct list_head        mw_list;
 630         struct list_head        cq_list;
 631         struct list_head        qp_list;
 632         struct list_head        srq_list;
 633         struct list_head        ah_list;
 634         spinlock_t              lock;
 635 };
 636
 637 struct ib_uobject {
 638         u64                     user_handle;    /* handle given to us by userspace */
 639         struct ib_ucontext     *context;        /* associated user context */
 640         struct list_head        list;           /* link to context's list */
 641         u32                     id;             /* index into kernel idr */
 642 };
 643
 644 struct ib_umem {
 645         unsigned long           user_base;
 646         unsigned long           virt_base;
 647         size_t                  length;
 648         int                     offset;
 649         int                     page_size;
 650         int                     writable;
 651         struct list_head        chunk_list;
 652 };
 653
 654 struct ib_umem_chunk {
 655         struct list_head        list;
 656         int                     nents;
 657         int                     nmap;
 658         struct scatterlist      page_list[0];
 659 };
 660
 661 struct ib_udata {
 662         void __user *inbuf;
 663         void __user *outbuf;
 664         size_t       inlen;
 665         size_t       outlen;
 666 };
 667
 668 #define IB_UMEM_MAX_PAGE_CHUNK                                          \
 669         ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) /      \
 670          ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] -        \
 671           (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
 672
 673 struct ib_umem_object {
 674         struct ib_uobject       uobject;
 675         struct ib_umem          umem;
 676 };
 677
 678 struct ib_pd {
 679         struct ib_device       *device;
 680         struct ib_uobject      *uobject;
 681         atomic_t                usecnt; /* count all resources */
 682 };
 683
 684 struct ib_ah {
 685         struct ib_device        *device;
 686         struct ib_pd            *pd;
 687         struct ib_uobject       *uobject;
 688 };
 689
 690 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
 691
 692 struct ib_cq {
 693         struct ib_device       *device;
 694         struct ib_uobject      *uobject;
 695         ib_comp_handler         comp_handler;
 696         void                  (*event_handler)(struct ib_event *, void *);
 697         void *                  cq_context;
 698         int                     cqe;
 699         atomic_t                usecnt; /* count number of work queues */
 700 };
 701
 702 struct ib_srq {
 703         struct ib_device        *device;
 704         struct ib_uobject       *uobject;
 705         struct ib_pd            *pd;
 706         void                    *srq_context;
 707         atomic_t                usecnt;
 708 };
 709
 710 struct ib_qp {
 711         struct ib_device       *device;
 712         struct ib_pd           *pd;
 713         struct ib_cq           *send_cq;
 714         struct ib_cq           *recv_cq;
 715         struct ib_srq          *srq;
 716         struct ib_uobject      *uobject;
 717         void                  (*event_handler)(struct ib_event *, void *);
 718         void                   *qp_context;
 719         u32                     qp_num;
 720         enum ib_qp_type         qp_type;
 721 };
 722
 723 struct ib_mr {
 724         struct ib_device  *device;
 725         struct ib_pd      *pd;
 726         struct ib_uobject *uobject;
 727         u32                lkey;
 728         u32                rkey;
 729         atomic_t           usecnt; /* count number of MWs */
 730 };
 731
 732 struct ib_mw {
 733         struct ib_device        *device;
 734         struct ib_pd            *pd;
 735         struct ib_uobject       *uobject;
 736         u32                     rkey;
 737 };
 738
 739 struct ib_fmr {
 740         struct ib_device        *device;
 741         struct ib_pd            *pd;
 742         struct list_head        list;
 743         u32                     lkey;
 744         u32                     rkey;
 745 };
 746
 747 struct ib_mad;
 748 struct ib_grh;
 749
 750 enum ib_process_mad_flags {
 751         IB_MAD_IGNORE_MKEY      = 1,
 752         IB_MAD_IGNORE_BKEY      = 2,
 753         IB_MAD_IGNORE_ALL       = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
 754 };
 755
 756 enum ib_mad_result {
 757         IB_MAD_RESULT_FAILURE  = 0,      /* (!SUCCESS is the important flag) */
 758         IB_MAD_RESULT_SUCCESS  = 1 << 0, /* MAD was successfully processed   */
 759         IB_MAD_RESULT_REPLY    = 1 << 1, /* Reply packet needs to be sent    */
 760         IB_MAD_RESULT_CONSUMED = 1 << 2  /* Packet consumed: stop processing */
 761 };
 762
 763 #define IB_DEVICE_NAME_MAX 64
 764
 765 struct ib_cache {
 766         rwlock_t                lock;
 767         struct ib_event_handler event_handler;
 768         struct ib_pkey_cache  **pkey_cache;
 769         struct ib_gid_cache   **gid_cache;
 770 };
 771
 772 struct ib_device {
 773         struct device                *dma_device;
 774
 775         char                          name[IB_DEVICE_NAME_MAX];
 776
 777         struct list_head              event_handler_list;
 778         spinlock_t                    event_handler_lock;
 779
 780         struct list_head              core_list;
 781         struct list_head              client_data_list;
 782         spinlock_t                    client_data_lock;
 783
 784         struct ib_cache               cache;
 785
 786         u32                           flags;
 787
 788         int                        (*query_device)(struct ib_device *device,
 789                                                    struct ib_device_attr *device_attr);
 790         int                        (*query_port)(struct ib_device *device,
 791                                                  u8 port_num,
 792                                                  struct ib_port_attr *port_attr);
 793         int                        (*query_gid)(struct ib_device *device,
 794                                                 u8 port_num, int index,
 795                                                 union ib_gid *gid);
 796         int                        (*query_pkey)(struct ib_device *device,
 797                                                  u8 port_num, u16 index, u16 *pkey);
 798         int                        (*modify_device)(struct ib_device *device,
 799                                                     int device_modify_mask,
 800                                                     struct ib_device_modify *device_modify);
 801         int                        (*modify_port)(struct ib_device *device,
 802                                                   u8 port_num, int port_modify_mask,
 803                                                   struct ib_port_modify *port_modify);
 804         struct ib_ucontext *       (*alloc_ucontext)(struct ib_device *device,
 805                                                      struct ib_udata *udata);
 806         int                        (*dealloc_ucontext)(struct ib_ucontext *context);
 807         int                        (*mmap)(struct ib_ucontext *context,
 808                                            struct vm_area_struct *vma);
 809         struct ib_pd *             (*alloc_pd)(struct ib_device *device,
 810                                                struct ib_ucontext *context,
 811                                                struct ib_udata *udata);
 812         int                        (*dealloc_pd)(struct ib_pd *pd);
 813         struct ib_ah *             (*create_ah)(struct ib_pd *pd,
 814                                                 struct ib_ah_attr *ah_attr);
 815         int                        (*modify_ah)(struct ib_ah *ah,
 816                                                 struct ib_ah_attr *ah_attr);
 817         int                        (*query_ah)(struct ib_ah *ah,
 818                                                struct ib_ah_attr *ah_attr);
 819         int                        (*destroy_ah)(struct ib_ah *ah);
 820         struct ib_qp *             (*create_qp)(struct ib_pd *pd,
 821                                                 struct ib_qp_init_attr *qp_init_attr,
 822                                                 struct ib_udata *udata);
 823         int                        (*modify_qp)(struct ib_qp *qp,
 824                                                 struct ib_qp_attr *qp_attr,
 825                                                 int qp_attr_mask);
 826         int                        (*query_qp)(struct ib_qp *qp,
 827                                                struct ib_qp_attr *qp_attr,
 828                                                int qp_attr_mask,
 829                                                struct ib_qp_init_attr *qp_init_attr);
 830         int                        (*destroy_qp)(struct ib_qp *qp);
 831         int                        (*post_send)(struct ib_qp *qp,
 832                                                 struct ib_send_wr *send_wr,
 833                                                 struct ib_send_wr **bad_send_wr);
 834         int                        (*post_recv)(struct ib_qp *qp,
 835                                                 struct ib_recv_wr *recv_wr,
 836                                                 struct ib_recv_wr **bad_recv_wr);
 837         struct ib_cq *             (*create_cq)(struct ib_device *device, int cqe,
 838                                                 struct ib_ucontext *context,
 839                                                 struct ib_udata *udata);
 840         int                        (*destroy_cq)(struct ib_cq *cq);
 841         int                        (*resize_cq)(struct ib_cq *cq, int *cqe);
 842         int                        (*poll_cq)(struct ib_cq *cq, int num_entries,
 843                                               struct ib_wc *wc);
 844         int                        (*peek_cq)(struct ib_cq *cq, int wc_cnt);
 845         int                        (*req_notify_cq)(struct ib_cq *cq,
 846                                                     enum ib_cq_notify cq_notify);
 847         int                        (*req_ncomp_notif)(struct ib_cq *cq,
 848                                                       int wc_cnt);
 849         struct ib_mr *             (*get_dma_mr)(struct ib_pd *pd,
 850                                                  int mr_access_flags);
 851         struct ib_mr *             (*reg_phys_mr)(struct ib_pd *pd,
 852                                                   struct ib_phys_buf *phys_buf_array,
 853                                                   int num_phys_buf,
 854                                                   int mr_access_flags,
 855                                                   u64 *iova_start);
 856         struct ib_mr *             (*reg_user_mr)(struct ib_pd *pd,
 857                                                   struct ib_umem *region,
 858                                                   int mr_access_flags,
 859                                                   struct ib_udata *udata);
 860         int                        (*query_mr)(struct ib_mr *mr,
 861                                                struct ib_mr_attr *mr_attr);
 862         int                        (*dereg_mr)(struct ib_mr *mr);
 863         int                        (*rereg_phys_mr)(struct ib_mr *mr,
 864                                                     int mr_rereg_mask,
 865                                                     struct ib_pd *pd,
 866                                                     struct ib_phys_buf *phys_buf_array,
 867                                                     int num_phys_buf,
 868                                                     int mr_access_flags,
 869                                                     u64 *iova_start);
 870         struct ib_mw *             (*alloc_mw)(struct ib_pd *pd);
 871         int                        (*bind_mw)(struct ib_qp *qp,
 872                                               struct ib_mw *mw,
 873                                               struct ib_mw_bind *mw_bind);
 874         int                        (*dealloc_mw)(struct ib_mw *mw);
 875         struct ib_fmr *            (*alloc_fmr)(struct ib_pd *pd,
 876                                                 int mr_access_flags,
 877                                                 struct ib_fmr_attr *fmr_attr);
 878         int                        (*map_phys_fmr)(struct ib_fmr *fmr,
 879                                                    u64 *page_list, int list_len,
 880                                                    u64 iova);
 881         int                        (*unmap_fmr)(struct list_head *fmr_list);
 882         int                        (*dealloc_fmr)(struct ib_fmr *fmr);
 883         int                        (*attach_mcast)(struct ib_qp *qp,
 884                                                    union ib_gid *gid,
 885                                                    u16 lid);
 886         int                        (*detach_mcast)(struct ib_qp *qp,
 887                                                    union ib_gid *gid,
 888                                                    u16 lid);
 889         int                        (*process_mad)(struct ib_device *device,
 890                                                   int process_mad_flags,
 891                                                   u8 port_num,
 892                                                   struct ib_wc *in_wc,
 893                                                   struct ib_grh *in_grh,
 894                                                   struct ib_mad *in_mad,
 895                                                   struct ib_mad *out_mad);
 896
 897         struct module               *owner;
 898         struct class_device          class_dev;
 899         struct kobject               ports_parent;
 900         struct list_head             port_list;
 901
 902         enum {
 903                 IB_DEV_UNINITIALIZED,
 904                 IB_DEV_REGISTERED,
 905                 IB_DEV_UNREGISTERED
 906         }                            reg_state;
 907
 908         u8                           node_type;
 909         u8                           phys_port_cnt;
 910 };
 911
 912 struct ib_client {
 913         char  *name;
 914         void (*add)   (struct ib_device *);
 915         void (*remove)(struct ib_device *);
 916
 917         struct list_head list;
 918 };
 919
 920 struct ib_device *ib_alloc_device(size_t size);
 921 void ib_dealloc_device(struct ib_device *device);
 922
 923 int ib_register_device   (struct ib_device *device);
 924 void ib_unregister_device(struct ib_device *device);
 925
 926 int ib_register_client   (struct ib_client *client);
 927 void ib_unregister_client(struct ib_client *client);
 928
 929 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
 930 void  ib_set_client_data(struct ib_device *device, struct ib_client *client,
 931                          void *data);
 932
 933 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
 934 {
 935         return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
 936 }
 937
 938 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
 939 {
 940         return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
 941 }
 942
 943 int ib_register_event_handler  (struct ib_event_handler *event_handler);
 944 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
 945 void ib_dispatch_event(struct ib_event *event);
 946
 947 int ib_query_device(struct ib_device *device,
 948                     struct ib_device_attr *device_attr);
 949
 950 int ib_query_port(struct ib_device *device,
 951                   u8 port_num, struct ib_port_attr *port_attr);
 952
 953 int ib_query_gid(struct ib_device *device,
 954                  u8 port_num, int index, union ib_gid *gid);
 955
 956 int ib_query_pkey(struct ib_device *device,
 957                   u8 port_num, u16 index, u16 *pkey);
 958
 959 int ib_modify_device(struct ib_device *device,
 960                      int device_modify_mask,
 961                      struct ib_device_modify *device_modify);
 962
 963 int ib_modify_port(struct ib_device *device,
 964                    u8 port_num, int port_modify_mask,
 965                    struct ib_port_modify *port_modify);
 966
 967 /**
 968  * ib_alloc_pd - Allocates an unused protection domain.
 969  * @device: The device on which to allocate the protection domain.
 970  *
 971  * A protection domain object provides an association between QPs, shared
 972  * receive queues, address handles, memory regions, and memory windows.
 973  */
 974 struct ib_pd *ib_alloc_pd(struct ib_device *device);
 975
 976 /**
 977  * ib_dealloc_pd - Deallocates a protection domain.
 978  * @pd: The protection domain to deallocate.
 979  */
 980 int ib_dealloc_pd(struct ib_pd *pd);
 981
 982 /**
 983  * ib_create_ah - Creates an address handle for the given address vector.
 984  * @pd: The protection domain associated with the address handle.
 985  * @ah_attr: The attributes of the address vector.
 986  *
 987  * The address handle is used to reference a local or global destination
 988  * in all UD QP post sends.
 989  */
 990 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
 991
 992 /**
 993  * ib_modify_ah - Modifies the address vector associated with an address
 994  *   handle.
 995  * @ah: The address handle to modify.
 996  * @ah_attr: The new address vector attributes to associate with the
 997  *   address handle.
 998  */
 999 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1000
1001 /**
1002  * ib_query_ah - Queries the address vector associated with an address
1003  *   handle.
1004  * @ah: The address handle to query.
1005  * @ah_attr: The address vector attributes associated with the address
1006  *   handle.
1007  */
1008 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1009
1010 /**
1011  * ib_destroy_ah - Destroys an address handle.
1012  * @ah: The address handle to destroy.
1013  */
1014 int ib_destroy_ah(struct ib_ah *ah);
1015
1016 /**
1017  * ib_create_qp - Creates a QP associated with the specified protection
1018  *   domain.
1019  * @pd: The protection domain associated with the QP.
1020  * @qp_init_attr: A list of initial attributes required to create the QP.
1021  */
1022 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1023                            struct ib_qp_init_attr *qp_init_attr);
1024
1025 /**
1026  * ib_modify_qp - Modifies the attributes for the specified QP and then
1027  *   transitions the QP to the given state.
1028  * @qp: The QP to modify.
1029  * @qp_attr: On input, specifies the QP attributes to modify.  On output,
1030  *   the current values of selected QP attributes are returned.
1031  * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1032  *   are being modified.
1033  */
1034 int ib_modify_qp(struct ib_qp *qp,
1035                  struct ib_qp_attr *qp_attr,
1036                  int qp_attr_mask);
1037
1038 /**
1039  * ib_query_qp - Returns the attribute list and current values for the
1040  *   specified QP.
1041  * @qp: The QP to query.
1042  * @qp_attr: The attributes of the specified QP.
1043  * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1044  * @qp_init_attr: Additional attributes of the selected QP.
1045  *
1046  * The qp_attr_mask may be used to limit the query to gathering only the
1047  * selected attributes.
1048  */
1049 int ib_query_qp(struct ib_qp *qp,
1050                 struct ib_qp_attr *qp_attr,
1051                 int qp_attr_mask,
1052                 struct ib_qp_init_attr *qp_init_attr);
1053
1054 /**
1055  * ib_destroy_qp - Destroys the specified QP.
1056  * @qp: The QP to destroy.
1057  */
1058 int ib_destroy_qp(struct ib_qp *qp);
1059
1060 /**
1061  * ib_post_send - Posts a list of work requests to the send queue of
1062  *   the specified QP.
1063  * @qp: The QP to post the work request on.
1064  * @send_wr: A list of work requests to post on the send queue.
1065  * @bad_send_wr: On an immediate failure, this parameter will reference
1066  *   the work request that failed to be posted on the QP.
1067  */
1068 static inline int ib_post_send(struct ib_qp *qp,
1069                                struct ib_send_wr *send_wr,
1070                                struct ib_send_wr **bad_send_wr)
1071 {
1072         return qp->device->post_send(qp, send_wr, bad_send_wr);
1073 }
1074
1075 /**
1076  * ib_post_recv - Posts a list of work requests to the receive queue of
1077  *   the specified QP.
1078  * @qp: The QP to post the work request on.
1079  * @recv_wr: A list of work requests to post on the receive queue.
1080  * @bad_recv_wr: On an immediate failure, this parameter will reference
1081  *   the work request that failed to be posted on the QP.
1082  */
1083 static inline int ib_post_recv(struct ib_qp *qp,
1084                                struct ib_recv_wr *recv_wr,
1085                                struct ib_recv_wr **bad_recv_wr)
1086 {
1087         return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1088 }
1089
1090 /**
1091  * ib_create_cq - Creates a CQ on the specified device.
1092  * @device: The device on which to create the CQ.
1093  * @comp_handler: A user-specified callback that is invoked when a
1094  *   completion event occurs on the CQ.
1095  * @event_handler: A user-specified callback that is invoked when an
1096  *   asynchronous event not associated with a completion occurs on the CQ.
1097  * @cq_context: Context associated with the CQ returned to the user via
1098  *   the associated completion and event handlers.
1099  * @cqe: The minimum size of the CQ.
1100  *
1101  * Users can examine the cq structure to determine the actual CQ size.
1102  */
1103 struct ib_cq *ib_create_cq(struct ib_device *device,
1104                            ib_comp_handler comp_handler,
1105                            void (*event_handler)(struct ib_event *, void *),
1106                            void *cq_context, int cqe);
1107
1108 /**
1109  * ib_resize_cq - Modifies the capacity of the CQ.
1110  * @cq: The CQ to resize.
1111  * @cqe: The minimum size of the CQ.
1112  *
1113  * Users can examine the cq structure to determine the actual CQ size.
1114  */
1115 int ib_resize_cq(struct ib_cq *cq, int cqe);
1116
1117 /**
1118  * ib_destroy_cq - Destroys the specified CQ.
1119  * @cq: The CQ to destroy.
1120  */
1121 int ib_destroy_cq(struct ib_cq *cq);
1122
1123 /**
1124  * ib_poll_cq - poll a CQ for completion(s)
1125  * @cq:the CQ being polled
1126  * @num_entries:maximum number of completions to return
1127  * @wc:array of at least @num_entries &struct ib_wc where completions
1128  *   will be returned
1129  *
1130  * Poll a CQ for (possibly multiple) completions.  If the return value
1131  * is < 0, an error occurred.  If the return value is >= 0, it is the
1132  * number of completions returned.  If the return value is
1133  * non-negative and < num_entries, then the CQ was emptied.
1134  */
1135 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1136                              struct ib_wc *wc)
1137 {
1138         return cq->device->poll_cq(cq, num_entries, wc);
1139 }
1140
1141 /**
1142  * ib_peek_cq - Returns the number of unreaped completions currently
1143  *   on the specified CQ.
1144  * @cq: The CQ to peek.
1145  * @wc_cnt: A minimum number of unreaped completions to check for.
1146  *
1147  * If the number of unreaped completions is greater than or equal to wc_cnt,
1148  * this function returns wc_cnt, otherwise, it returns the actual number of
1149  * unreaped completions.
1150  */
1151 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1152
1153 /**
1154  * ib_req_notify_cq - Request completion notification on a CQ.
1155  * @cq: The CQ to generate an event for.
1156  * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
1157  *   occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
1158  *   notification will occur on the next completion.
1159  */
1160 static inline int ib_req_notify_cq(struct ib_cq *cq,
1161                                    enum ib_cq_notify cq_notify)
1162 {
1163         return cq->device->req_notify_cq(cq, cq_notify);
1164 }
1165
1166 /**
1167  * ib_req_ncomp_notif - Request completion notification when there are
1168  *   at least the specified number of unreaped completions on the CQ.
1169  * @cq: The CQ to generate an event for.
1170  * @wc_cnt: The number of unreaped completions that should be on the
1171  *   CQ before an event is generated.
1172  */
1173 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1174 {
1175         return cq->device->req_ncomp_notif ?
1176                 cq->device->req_ncomp_notif(cq, wc_cnt) :
1177                 -ENOSYS;
1178 }
1179
1180 /**
1181  * ib_get_dma_mr - Returns a memory region for system memory that is
1182  *   usable for DMA.
1183  * @pd: The protection domain associated with the memory region.
1184  * @mr_access_flags: Specifies the memory access rights.
1185  */
1186 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1187
1188 /**
1189  * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1190  *   by an HCA.
1191  * @pd: The protection domain associated assigned to the registered region.
1192  * @phys_buf_array: Specifies a list of physical buffers to use in the
1193  *   memory region.
1194  * @num_phys_buf: Specifies the size of the phys_buf_array.
1195  * @mr_access_flags: Specifies the memory access rights.
1196  * @iova_start: The offset of the region's starting I/O virtual address.
1197  */
1198 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1199                              struct ib_phys_buf *phys_buf_array,
1200                              int num_phys_buf,
1201                              int mr_access_flags,
1202                              u64 *iova_start);
1203
1204 /**
1205  * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1206  *   Conceptually, this call performs the functions deregister memory region
1207  *   followed by register physical memory region.  Where possible,
1208  *   resources are reused instead of deallocated and reallocated.
1209  * @mr: The memory region to modify.
1210  * @mr_rereg_mask: A bit-mask used to indicate which of the following
1211  *   properties of the memory region are being modified.
1212  * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1213  *   the new protection domain to associated with the memory region,
1214  *   otherwise, this parameter is ignored.
1215  * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1216  *   field specifies a list of physical buffers to use in the new
1217  *   translation, otherwise, this parameter is ignored.
1218  * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1219  *   field specifies the size of the phys_buf_array, otherwise, this
1220  *   parameter is ignored.
1221  * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1222  *   field specifies the new memory access rights, otherwise, this
1223  *   parameter is ignored.
1224  * @iova_start: The offset of the region's starting I/O virtual address.
1225  */
1226 int ib_rereg_phys_mr(struct ib_mr *mr,
1227                      int mr_rereg_mask,
1228                      struct ib_pd *pd,
1229                      struct ib_phys_buf *phys_buf_array,
1230                      int num_phys_buf,
1231                      int mr_access_flags,
1232                      u64 *iova_start);
1233
1234 /**
1235  * ib_query_mr - Retrieves information about a specific memory region.
1236  * @mr: The memory region to retrieve information about.
1237  * @mr_attr: The attributes of the specified memory region.
1238  */
1239 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1240
1241 /**
1242  * ib_dereg_mr - Deregisters a memory region and removes it from the
1243  *   HCA translation table.
1244  * @mr: The memory region to deregister.
1245  */
1246 int ib_dereg_mr(struct ib_mr *mr);
1247
1248 /**
1249  * ib_alloc_mw - Allocates a memory window.
1250  * @pd: The protection domain associated with the memory window.
1251  */
1252 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1253
1254 /**
1255  * ib_bind_mw - Posts a work request to the send queue of the specified
1256  *   QP, which binds the memory window to the given address range and
1257  *   remote access attributes.
1258  * @qp: QP to post the bind work request on.
1259  * @mw: The memory window to bind.
1260  * @mw_bind: Specifies information about the memory window, including
1261  *   its address range, remote access rights, and associated memory region.
1262  */
1263 static inline int ib_bind_mw(struct ib_qp *qp,
1264                              struct ib_mw *mw,
1265                              struct ib_mw_bind *mw_bind)
1266 {
1267         /* XXX reference counting in corresponding MR? */
1268         return mw->device->bind_mw ?
1269                 mw->device->bind_mw(qp, mw, mw_bind) :
1270                 -ENOSYS;
1271 }
1272
1273 /**
1274  * ib_dealloc_mw - Deallocates a memory window.
1275  * @mw: The memory window to deallocate.
1276  */
1277 int ib_dealloc_mw(struct ib_mw *mw);
1278
1279 /**
1280  * ib_alloc_fmr - Allocates a unmapped fast memory region.
1281  * @pd: The protection domain associated with the unmapped region.
1282  * @mr_access_flags: Specifies the memory access rights.
1283  * @fmr_attr: Attributes of the unmapped region.
1284  *
1285  * A fast memory region must be mapped before it can be used as part of
1286  * a work request.
1287  */
1288 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1289                             int mr_access_flags,
1290                             struct ib_fmr_attr *fmr_attr);
1291
1292 /**
1293  * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1294  * @fmr: The fast memory region to associate with the pages.
1295  * @page_list: An array of physical pages to map to the fast memory region.
1296  * @list_len: The number of pages in page_list.
1297  * @iova: The I/O virtual address to use with the mapped region.
1298  */
1299 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1300                                   u64 *page_list, int list_len,
1301                                   u64 iova)
1302 {
1303         return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1304 }
1305
1306 /**
1307  * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1308  * @fmr_list: A linked list of fast memory regions to unmap.
1309  */
1310 int ib_unmap_fmr(struct list_head *fmr_list);
1311
1312 /**
1313  * ib_dealloc_fmr - Deallocates a fast memory region.
1314  * @fmr: The fast memory region to deallocate.
1315  */
1316 int ib_dealloc_fmr(struct ib_fmr *fmr);
1317
1318 /**
1319  * ib_attach_mcast - Attaches the specified QP to a multicast group.
1320  * @qp: QP to attach to the multicast group.  The QP must be type
1321  *   IB_QPT_UD.
1322  * @gid: Multicast group GID.
1323  * @lid: Multicast group LID in host byte order.
1324  *
1325  * In order to send and receive multicast packets, subnet
1326  * administration must have created the multicast group and configured
1327  * the fabric appropriately.  The port associated with the specified
1328  * QP must also be a member of the multicast group.
1329  */
1330 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1331
1332 /**
1333  * ib_detach_mcast - Detaches the specified QP from a multicast group.
1334  * @qp: QP to detach from the multicast group.
1335  * @gid: Multicast group GID.
1336  * @lid: Multicast group LID in host byte order.
1337  */
1338 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1339
1340 #endif /* IB_VERBS_H */