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 Cisco Systems. All rights reserved.
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:
16 * Redistribution and use in source and binary forms, with or
17 * without modification, are permitted provided that the following
20 * - Redistributions of source code must retain the above
21 * copyright notice, this list of conditions and the following
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.
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
38 * $Id: ib_verbs.h 1349 2004-12-16 21:09:43Z roland $
41 #if !defined(IB_VERBS_H)
44 #include <linux/types.h>
45 #include <linux/device.h>
47 #include <linux/dma-mapping.h>
48 #include <linux/kref.h>
50 #include <asm/atomic.h>
51 #include <asm/scatterlist.h>
52 #include <asm/uaccess.h>
63 /* IB values map to NodeInfo:NodeType. */
70 enum rdma_transport_type {
75 enum rdma_transport_type
76 rdma_node_get_transport(enum rdma_node_type node_type) __attribute_const__;
78 enum ib_device_cap_flags {
79 IB_DEVICE_RESIZE_MAX_WR = 1,
80 IB_DEVICE_BAD_PKEY_CNTR = (1<<1),
81 IB_DEVICE_BAD_QKEY_CNTR = (1<<2),
82 IB_DEVICE_RAW_MULTI = (1<<3),
83 IB_DEVICE_AUTO_PATH_MIG = (1<<4),
84 IB_DEVICE_CHANGE_PHY_PORT = (1<<5),
85 IB_DEVICE_UD_AV_PORT_ENFORCE = (1<<6),
86 IB_DEVICE_CURR_QP_STATE_MOD = (1<<7),
87 IB_DEVICE_SHUTDOWN_PORT = (1<<8),
88 IB_DEVICE_INIT_TYPE = (1<<9),
89 IB_DEVICE_PORT_ACTIVE_EVENT = (1<<10),
90 IB_DEVICE_SYS_IMAGE_GUID = (1<<11),
91 IB_DEVICE_RC_RNR_NAK_GEN = (1<<12),
92 IB_DEVICE_SRQ_RESIZE = (1<<13),
93 IB_DEVICE_N_NOTIFY_CQ = (1<<14),
94 IB_DEVICE_ZERO_STAG = (1<<15),
95 IB_DEVICE_SEND_W_INV = (1<<16),
96 IB_DEVICE_MEM_WINDOW = (1<<17)
105 struct ib_device_attr {
107 __be64 sys_image_guid;
115 int device_cap_flags;
125 int max_qp_init_rd_atom;
126 int max_ee_init_rd_atom;
127 enum ib_atomic_cap atomic_cap;
134 int max_mcast_qp_attach;
135 int max_total_mcast_qp_attach;
143 u8 local_ca_ack_delay;
154 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
157 case IB_MTU_256: return 256;
158 case IB_MTU_512: return 512;
159 case IB_MTU_1024: return 1024;
160 case IB_MTU_2048: return 2048;
161 case IB_MTU_4096: return 4096;
172 IB_PORT_ACTIVE_DEFER = 5
175 enum ib_port_cap_flags {
177 IB_PORT_NOTICE_SUP = 1 << 2,
178 IB_PORT_TRAP_SUP = 1 << 3,
179 IB_PORT_OPT_IPD_SUP = 1 << 4,
180 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
181 IB_PORT_SL_MAP_SUP = 1 << 6,
182 IB_PORT_MKEY_NVRAM = 1 << 7,
183 IB_PORT_PKEY_NVRAM = 1 << 8,
184 IB_PORT_LED_INFO_SUP = 1 << 9,
185 IB_PORT_SM_DISABLED = 1 << 10,
186 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
187 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
188 IB_PORT_CM_SUP = 1 << 16,
189 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
190 IB_PORT_REINIT_SUP = 1 << 18,
191 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
192 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
193 IB_PORT_DR_NOTICE_SUP = 1 << 21,
194 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
195 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
196 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
197 IB_PORT_CLIENT_REG_SUP = 1 << 25
207 static inline int ib_width_enum_to_int(enum ib_port_width width)
210 case IB_WIDTH_1X: return 1;
211 case IB_WIDTH_4X: return 4;
212 case IB_WIDTH_8X: return 8;
213 case IB_WIDTH_12X: return 12;
218 struct ib_port_attr {
219 enum ib_port_state state;
221 enum ib_mtu active_mtu;
240 enum ib_device_modify_flags {
241 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
242 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
245 struct ib_device_modify {
250 enum ib_port_modify_flags {
251 IB_PORT_SHUTDOWN = 1,
252 IB_PORT_INIT_TYPE = (1<<2),
253 IB_PORT_RESET_QKEY_CNTR = (1<<3)
256 struct ib_port_modify {
257 u32 set_port_cap_mask;
258 u32 clr_port_cap_mask;
266 IB_EVENT_QP_ACCESS_ERR,
270 IB_EVENT_PATH_MIG_ERR,
271 IB_EVENT_DEVICE_FATAL,
272 IB_EVENT_PORT_ACTIVE,
275 IB_EVENT_PKEY_CHANGE,
278 IB_EVENT_SRQ_LIMIT_REACHED,
279 IB_EVENT_QP_LAST_WQE_REACHED,
280 IB_EVENT_CLIENT_REREGISTER
284 struct ib_device *device;
291 enum ib_event_type event;
294 struct ib_event_handler {
295 struct ib_device *device;
296 void (*handler)(struct ib_event_handler *, struct ib_event *);
297 struct list_head list;
300 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
302 (_ptr)->device = _device; \
303 (_ptr)->handler = _handler; \
304 INIT_LIST_HEAD(&(_ptr)->list); \
307 struct ib_global_route {
316 __be32 version_tclass_flow;
325 IB_MULTICAST_QPN = 0xffffff
328 #define IB_LID_PERMISSIVE __constant_htons(0xFFFF)
335 IB_RATE_PORT_CURRENT = 0,
336 IB_RATE_2_5_GBPS = 2,
344 IB_RATE_120_GBPS = 10
348 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
349 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
350 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
351 * @rate: rate to convert.
353 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
356 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
358 * @mult: multiple to convert.
360 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
363 struct ib_global_route grh;
376 IB_WC_LOC_EEC_OP_ERR,
381 IB_WC_LOC_ACCESS_ERR,
382 IB_WC_REM_INV_REQ_ERR,
383 IB_WC_REM_ACCESS_ERR,
386 IB_WC_RNR_RETRY_EXC_ERR,
387 IB_WC_LOC_RDD_VIOL_ERR,
388 IB_WC_REM_INV_RD_REQ_ERR,
391 IB_WC_INV_EEC_STATE_ERR,
393 IB_WC_RESP_TIMEOUT_ERR,
405 * Set value of IB_WC_RECV so consumers can test if a completion is a
406 * receive by testing (opcode & IB_WC_RECV).
409 IB_WC_RECV_RDMA_WITH_IMM
414 IB_WC_WITH_IMM = (1<<1)
419 enum ib_wc_status status;
420 enum ib_wc_opcode opcode;
431 u8 port_num; /* valid only for DR SMPs on switches */
439 enum ib_srq_attr_mask {
440 IB_SRQ_MAX_WR = 1 << 0,
441 IB_SRQ_LIMIT = 1 << 1,
450 struct ib_srq_init_attr {
451 void (*event_handler)(struct ib_event *, void *);
453 struct ib_srq_attr attr;
471 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
472 * here (and in that order) since the MAD layer uses them as
473 * indices into a 2-entry table.
485 struct ib_qp_init_attr {
486 void (*event_handler)(struct ib_event *, void *);
488 struct ib_cq *send_cq;
489 struct ib_cq *recv_cq;
491 struct ib_qp_cap cap;
492 enum ib_sig_type sq_sig_type;
493 enum ib_qp_type qp_type;
494 u8 port_num; /* special QP types only */
497 enum ib_rnr_timeout {
498 IB_RNR_TIMER_655_36 = 0,
499 IB_RNR_TIMER_000_01 = 1,
500 IB_RNR_TIMER_000_02 = 2,
501 IB_RNR_TIMER_000_03 = 3,
502 IB_RNR_TIMER_000_04 = 4,
503 IB_RNR_TIMER_000_06 = 5,
504 IB_RNR_TIMER_000_08 = 6,
505 IB_RNR_TIMER_000_12 = 7,
506 IB_RNR_TIMER_000_16 = 8,
507 IB_RNR_TIMER_000_24 = 9,
508 IB_RNR_TIMER_000_32 = 10,
509 IB_RNR_TIMER_000_48 = 11,
510 IB_RNR_TIMER_000_64 = 12,
511 IB_RNR_TIMER_000_96 = 13,
512 IB_RNR_TIMER_001_28 = 14,
513 IB_RNR_TIMER_001_92 = 15,
514 IB_RNR_TIMER_002_56 = 16,
515 IB_RNR_TIMER_003_84 = 17,
516 IB_RNR_TIMER_005_12 = 18,
517 IB_RNR_TIMER_007_68 = 19,
518 IB_RNR_TIMER_010_24 = 20,
519 IB_RNR_TIMER_015_36 = 21,
520 IB_RNR_TIMER_020_48 = 22,
521 IB_RNR_TIMER_030_72 = 23,
522 IB_RNR_TIMER_040_96 = 24,
523 IB_RNR_TIMER_061_44 = 25,
524 IB_RNR_TIMER_081_92 = 26,
525 IB_RNR_TIMER_122_88 = 27,
526 IB_RNR_TIMER_163_84 = 28,
527 IB_RNR_TIMER_245_76 = 29,
528 IB_RNR_TIMER_327_68 = 30,
529 IB_RNR_TIMER_491_52 = 31
532 enum ib_qp_attr_mask {
534 IB_QP_CUR_STATE = (1<<1),
535 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
536 IB_QP_ACCESS_FLAGS = (1<<3),
537 IB_QP_PKEY_INDEX = (1<<4),
541 IB_QP_PATH_MTU = (1<<8),
542 IB_QP_TIMEOUT = (1<<9),
543 IB_QP_RETRY_CNT = (1<<10),
544 IB_QP_RNR_RETRY = (1<<11),
545 IB_QP_RQ_PSN = (1<<12),
546 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
547 IB_QP_ALT_PATH = (1<<14),
548 IB_QP_MIN_RNR_TIMER = (1<<15),
549 IB_QP_SQ_PSN = (1<<16),
550 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
551 IB_QP_PATH_MIG_STATE = (1<<18),
553 IB_QP_DEST_QPN = (1<<20)
573 enum ib_qp_state qp_state;
574 enum ib_qp_state cur_qp_state;
575 enum ib_mtu path_mtu;
576 enum ib_mig_state path_mig_state;
582 struct ib_qp_cap cap;
583 struct ib_ah_attr ah_attr;
584 struct ib_ah_attr alt_ah_attr;
587 u8 en_sqd_async_notify;
590 u8 max_dest_rd_atomic;
602 IB_WR_RDMA_WRITE_WITH_IMM,
606 IB_WR_ATOMIC_CMP_AND_SWP,
607 IB_WR_ATOMIC_FETCH_AND_ADD
612 IB_SEND_SIGNALED = (1<<1),
613 IB_SEND_SOLICITED = (1<<2),
614 IB_SEND_INLINE = (1<<3)
624 struct ib_send_wr *next;
626 struct ib_sge *sg_list;
628 enum ib_wr_opcode opcode;
646 u16 pkey_index; /* valid for GSI only */
647 u8 port_num; /* valid for DR SMPs on switch only */
653 struct ib_recv_wr *next;
655 struct ib_sge *sg_list;
659 enum ib_access_flags {
660 IB_ACCESS_LOCAL_WRITE = 1,
661 IB_ACCESS_REMOTE_WRITE = (1<<1),
662 IB_ACCESS_REMOTE_READ = (1<<2),
663 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
664 IB_ACCESS_MW_BIND = (1<<4)
674 u64 device_virt_addr;
681 enum ib_mr_rereg_flags {
682 IB_MR_REREG_TRANS = 1,
683 IB_MR_REREG_PD = (1<<1),
684 IB_MR_REREG_ACCESS = (1<<2)
703 struct ib_device *device;
704 struct list_head pd_list;
705 struct list_head mr_list;
706 struct list_head mw_list;
707 struct list_head cq_list;
708 struct list_head qp_list;
709 struct list_head srq_list;
710 struct list_head ah_list;
714 u64 user_handle; /* handle given to us by userspace */
715 struct ib_ucontext *context; /* associated user context */
716 void *object; /* containing object */
717 struct list_head list; /* link to context's list */
718 u32 id; /* index into kernel idr */
720 struct rw_semaphore mutex; /* protects .live */
725 unsigned long user_base;
726 unsigned long virt_base;
731 struct list_head chunk_list;
734 struct ib_umem_chunk {
735 struct list_head list;
738 struct scatterlist page_list[0];
748 #define IB_UMEM_MAX_PAGE_CHUNK \
749 ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) / \
750 ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] - \
751 (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
753 struct ib_umem_object {
754 struct ib_uobject uobject;
759 struct ib_device *device;
760 struct ib_uobject *uobject;
761 atomic_t usecnt; /* count all resources */
765 struct ib_device *device;
767 struct ib_uobject *uobject;
770 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
773 struct ib_device *device;
774 struct ib_uobject *uobject;
775 ib_comp_handler comp_handler;
776 void (*event_handler)(struct ib_event *, void *);
779 atomic_t usecnt; /* count number of work queues */
783 struct ib_device *device;
785 struct ib_uobject *uobject;
786 void (*event_handler)(struct ib_event *, void *);
792 struct ib_device *device;
794 struct ib_cq *send_cq;
795 struct ib_cq *recv_cq;
797 struct ib_uobject *uobject;
798 void (*event_handler)(struct ib_event *, void *);
801 enum ib_qp_type qp_type;
805 struct ib_device *device;
807 struct ib_uobject *uobject;
810 atomic_t usecnt; /* count number of MWs */
814 struct ib_device *device;
816 struct ib_uobject *uobject;
821 struct ib_device *device;
823 struct list_head list;
831 enum ib_process_mad_flags {
832 IB_MAD_IGNORE_MKEY = 1,
833 IB_MAD_IGNORE_BKEY = 2,
834 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
838 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
839 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
840 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
841 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
844 #define IB_DEVICE_NAME_MAX 64
848 struct ib_event_handler event_handler;
849 struct ib_pkey_cache **pkey_cache;
850 struct ib_gid_cache **gid_cache;
854 struct ib_dma_mapping_ops {
855 int (*mapping_error)(struct ib_device *dev,
857 u64 (*map_single)(struct ib_device *dev,
858 void *ptr, size_t size,
859 enum dma_data_direction direction);
860 void (*unmap_single)(struct ib_device *dev,
861 u64 addr, size_t size,
862 enum dma_data_direction direction);
863 u64 (*map_page)(struct ib_device *dev,
864 struct page *page, unsigned long offset,
866 enum dma_data_direction direction);
867 void (*unmap_page)(struct ib_device *dev,
868 u64 addr, size_t size,
869 enum dma_data_direction direction);
870 int (*map_sg)(struct ib_device *dev,
871 struct scatterlist *sg, int nents,
872 enum dma_data_direction direction);
873 void (*unmap_sg)(struct ib_device *dev,
874 struct scatterlist *sg, int nents,
875 enum dma_data_direction direction);
876 u64 (*dma_address)(struct ib_device *dev,
877 struct scatterlist *sg);
878 unsigned int (*dma_len)(struct ib_device *dev,
879 struct scatterlist *sg);
880 void (*sync_single_for_cpu)(struct ib_device *dev,
883 enum dma_data_direction dir);
884 void (*sync_single_for_device)(struct ib_device *dev,
887 enum dma_data_direction dir);
888 void *(*alloc_coherent)(struct ib_device *dev,
892 void (*free_coherent)(struct ib_device *dev,
893 size_t size, void *cpu_addr,
900 struct device *dma_device;
902 char name[IB_DEVICE_NAME_MAX];
904 struct list_head event_handler_list;
905 spinlock_t event_handler_lock;
907 struct list_head core_list;
908 struct list_head client_data_list;
909 spinlock_t client_data_lock;
911 struct ib_cache cache;
915 int num_comp_vectors;
917 struct iw_cm_verbs *iwcm;
919 int (*query_device)(struct ib_device *device,
920 struct ib_device_attr *device_attr);
921 int (*query_port)(struct ib_device *device,
923 struct ib_port_attr *port_attr);
924 int (*query_gid)(struct ib_device *device,
925 u8 port_num, int index,
927 int (*query_pkey)(struct ib_device *device,
928 u8 port_num, u16 index, u16 *pkey);
929 int (*modify_device)(struct ib_device *device,
930 int device_modify_mask,
931 struct ib_device_modify *device_modify);
932 int (*modify_port)(struct ib_device *device,
933 u8 port_num, int port_modify_mask,
934 struct ib_port_modify *port_modify);
935 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
936 struct ib_udata *udata);
937 int (*dealloc_ucontext)(struct ib_ucontext *context);
938 int (*mmap)(struct ib_ucontext *context,
939 struct vm_area_struct *vma);
940 struct ib_pd * (*alloc_pd)(struct ib_device *device,
941 struct ib_ucontext *context,
942 struct ib_udata *udata);
943 int (*dealloc_pd)(struct ib_pd *pd);
944 struct ib_ah * (*create_ah)(struct ib_pd *pd,
945 struct ib_ah_attr *ah_attr);
946 int (*modify_ah)(struct ib_ah *ah,
947 struct ib_ah_attr *ah_attr);
948 int (*query_ah)(struct ib_ah *ah,
949 struct ib_ah_attr *ah_attr);
950 int (*destroy_ah)(struct ib_ah *ah);
951 struct ib_srq * (*create_srq)(struct ib_pd *pd,
952 struct ib_srq_init_attr *srq_init_attr,
953 struct ib_udata *udata);
954 int (*modify_srq)(struct ib_srq *srq,
955 struct ib_srq_attr *srq_attr,
956 enum ib_srq_attr_mask srq_attr_mask,
957 struct ib_udata *udata);
958 int (*query_srq)(struct ib_srq *srq,
959 struct ib_srq_attr *srq_attr);
960 int (*destroy_srq)(struct ib_srq *srq);
961 int (*post_srq_recv)(struct ib_srq *srq,
962 struct ib_recv_wr *recv_wr,
963 struct ib_recv_wr **bad_recv_wr);
964 struct ib_qp * (*create_qp)(struct ib_pd *pd,
965 struct ib_qp_init_attr *qp_init_attr,
966 struct ib_udata *udata);
967 int (*modify_qp)(struct ib_qp *qp,
968 struct ib_qp_attr *qp_attr,
970 struct ib_udata *udata);
971 int (*query_qp)(struct ib_qp *qp,
972 struct ib_qp_attr *qp_attr,
974 struct ib_qp_init_attr *qp_init_attr);
975 int (*destroy_qp)(struct ib_qp *qp);
976 int (*post_send)(struct ib_qp *qp,
977 struct ib_send_wr *send_wr,
978 struct ib_send_wr **bad_send_wr);
979 int (*post_recv)(struct ib_qp *qp,
980 struct ib_recv_wr *recv_wr,
981 struct ib_recv_wr **bad_recv_wr);
982 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
984 struct ib_ucontext *context,
985 struct ib_udata *udata);
986 int (*destroy_cq)(struct ib_cq *cq);
987 int (*resize_cq)(struct ib_cq *cq, int cqe,
988 struct ib_udata *udata);
989 int (*poll_cq)(struct ib_cq *cq, int num_entries,
991 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
992 int (*req_notify_cq)(struct ib_cq *cq,
993 enum ib_cq_notify cq_notify);
994 int (*req_ncomp_notif)(struct ib_cq *cq,
996 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
997 int mr_access_flags);
998 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
999 struct ib_phys_buf *phys_buf_array,
1001 int mr_access_flags,
1003 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
1004 struct ib_umem *region,
1005 int mr_access_flags,
1006 struct ib_udata *udata);
1007 int (*query_mr)(struct ib_mr *mr,
1008 struct ib_mr_attr *mr_attr);
1009 int (*dereg_mr)(struct ib_mr *mr);
1010 int (*rereg_phys_mr)(struct ib_mr *mr,
1013 struct ib_phys_buf *phys_buf_array,
1015 int mr_access_flags,
1017 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1018 int (*bind_mw)(struct ib_qp *qp,
1020 struct ib_mw_bind *mw_bind);
1021 int (*dealloc_mw)(struct ib_mw *mw);
1022 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1023 int mr_access_flags,
1024 struct ib_fmr_attr *fmr_attr);
1025 int (*map_phys_fmr)(struct ib_fmr *fmr,
1026 u64 *page_list, int list_len,
1028 int (*unmap_fmr)(struct list_head *fmr_list);
1029 int (*dealloc_fmr)(struct ib_fmr *fmr);
1030 int (*attach_mcast)(struct ib_qp *qp,
1033 int (*detach_mcast)(struct ib_qp *qp,
1036 int (*process_mad)(struct ib_device *device,
1037 int process_mad_flags,
1039 struct ib_wc *in_wc,
1040 struct ib_grh *in_grh,
1041 struct ib_mad *in_mad,
1042 struct ib_mad *out_mad);
1044 struct ib_dma_mapping_ops *dma_ops;
1046 struct module *owner;
1047 struct class_device class_dev;
1048 struct kobject ports_parent;
1049 struct list_head port_list;
1052 IB_DEV_UNINITIALIZED,
1057 u64 uverbs_cmd_mask;
1068 void (*add) (struct ib_device *);
1069 void (*remove)(struct ib_device *);
1071 struct list_head list;
1074 struct ib_device *ib_alloc_device(size_t size);
1075 void ib_dealloc_device(struct ib_device *device);
1077 int ib_register_device (struct ib_device *device);
1078 void ib_unregister_device(struct ib_device *device);
1080 int ib_register_client (struct ib_client *client);
1081 void ib_unregister_client(struct ib_client *client);
1083 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1084 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1087 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1089 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1092 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1094 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1098 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1099 * contains all required attributes and no attributes not allowed for
1100 * the given QP state transition.
1101 * @cur_state: Current QP state
1102 * @next_state: Next QP state
1104 * @mask: Mask of supplied QP attributes
1106 * This function is a helper function that a low-level driver's
1107 * modify_qp method can use to validate the consumer's input. It
1108 * checks that cur_state and next_state are valid QP states, that a
1109 * transition from cur_state to next_state is allowed by the IB spec,
1110 * and that the attribute mask supplied is allowed for the transition.
1112 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1113 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1115 int ib_register_event_handler (struct ib_event_handler *event_handler);
1116 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1117 void ib_dispatch_event(struct ib_event *event);
1119 int ib_query_device(struct ib_device *device,
1120 struct ib_device_attr *device_attr);
1122 int ib_query_port(struct ib_device *device,
1123 u8 port_num, struct ib_port_attr *port_attr);
1125 int ib_query_gid(struct ib_device *device,
1126 u8 port_num, int index, union ib_gid *gid);
1128 int ib_query_pkey(struct ib_device *device,
1129 u8 port_num, u16 index, u16 *pkey);
1131 int ib_modify_device(struct ib_device *device,
1132 int device_modify_mask,
1133 struct ib_device_modify *device_modify);
1135 int ib_modify_port(struct ib_device *device,
1136 u8 port_num, int port_modify_mask,
1137 struct ib_port_modify *port_modify);
1140 * ib_alloc_pd - Allocates an unused protection domain.
1141 * @device: The device on which to allocate the protection domain.
1143 * A protection domain object provides an association between QPs, shared
1144 * receive queues, address handles, memory regions, and memory windows.
1146 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1149 * ib_dealloc_pd - Deallocates a protection domain.
1150 * @pd: The protection domain to deallocate.
1152 int ib_dealloc_pd(struct ib_pd *pd);
1155 * ib_create_ah - Creates an address handle for the given address vector.
1156 * @pd: The protection domain associated with the address handle.
1157 * @ah_attr: The attributes of the address vector.
1159 * The address handle is used to reference a local or global destination
1160 * in all UD QP post sends.
1162 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1165 * ib_init_ah_from_wc - Initializes address handle attributes from a
1167 * @device: Device on which the received message arrived.
1168 * @port_num: Port on which the received message arrived.
1169 * @wc: Work completion associated with the received message.
1170 * @grh: References the received global route header. This parameter is
1171 * ignored unless the work completion indicates that the GRH is valid.
1172 * @ah_attr: Returned attributes that can be used when creating an address
1173 * handle for replying to the message.
1175 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1176 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1179 * ib_create_ah_from_wc - Creates an address handle associated with the
1180 * sender of the specified work completion.
1181 * @pd: The protection domain associated with the address handle.
1182 * @wc: Work completion information associated with a received message.
1183 * @grh: References the received global route header. This parameter is
1184 * ignored unless the work completion indicates that the GRH is valid.
1185 * @port_num: The outbound port number to associate with the address.
1187 * The address handle is used to reference a local or global destination
1188 * in all UD QP post sends.
1190 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1191 struct ib_grh *grh, u8 port_num);
1194 * ib_modify_ah - Modifies the address vector associated with an address
1196 * @ah: The address handle to modify.
1197 * @ah_attr: The new address vector attributes to associate with the
1200 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1203 * ib_query_ah - Queries the address vector associated with an address
1205 * @ah: The address handle to query.
1206 * @ah_attr: The address vector attributes associated with the address
1209 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1212 * ib_destroy_ah - Destroys an address handle.
1213 * @ah: The address handle to destroy.
1215 int ib_destroy_ah(struct ib_ah *ah);
1218 * ib_create_srq - Creates a SRQ associated with the specified protection
1220 * @pd: The protection domain associated with the SRQ.
1221 * @srq_init_attr: A list of initial attributes required to create the
1222 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1223 * the actual capabilities of the created SRQ.
1225 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1226 * requested size of the SRQ, and set to the actual values allocated
1227 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1228 * will always be at least as large as the requested values.
1230 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1231 struct ib_srq_init_attr *srq_init_attr);
1234 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1235 * @srq: The SRQ to modify.
1236 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1237 * the current values of selected SRQ attributes are returned.
1238 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1239 * are being modified.
1241 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1242 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1243 * the number of receives queued drops below the limit.
1245 int ib_modify_srq(struct ib_srq *srq,
1246 struct ib_srq_attr *srq_attr,
1247 enum ib_srq_attr_mask srq_attr_mask);
1250 * ib_query_srq - Returns the attribute list and current values for the
1252 * @srq: The SRQ to query.
1253 * @srq_attr: The attributes of the specified SRQ.
1255 int ib_query_srq(struct ib_srq *srq,
1256 struct ib_srq_attr *srq_attr);
1259 * ib_destroy_srq - Destroys the specified SRQ.
1260 * @srq: The SRQ to destroy.
1262 int ib_destroy_srq(struct ib_srq *srq);
1265 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1266 * @srq: The SRQ to post the work request on.
1267 * @recv_wr: A list of work requests to post on the receive queue.
1268 * @bad_recv_wr: On an immediate failure, this parameter will reference
1269 * the work request that failed to be posted on the QP.
1271 static inline int ib_post_srq_recv(struct ib_srq *srq,
1272 struct ib_recv_wr *recv_wr,
1273 struct ib_recv_wr **bad_recv_wr)
1275 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1279 * ib_create_qp - Creates a QP associated with the specified protection
1281 * @pd: The protection domain associated with the QP.
1282 * @qp_init_attr: A list of initial attributes required to create the
1283 * QP. If QP creation succeeds, then the attributes are updated to
1284 * the actual capabilities of the created QP.
1286 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1287 struct ib_qp_init_attr *qp_init_attr);
1290 * ib_modify_qp - Modifies the attributes for the specified QP and then
1291 * transitions the QP to the given state.
1292 * @qp: The QP to modify.
1293 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1294 * the current values of selected QP attributes are returned.
1295 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1296 * are being modified.
1298 int ib_modify_qp(struct ib_qp *qp,
1299 struct ib_qp_attr *qp_attr,
1303 * ib_query_qp - Returns the attribute list and current values for the
1305 * @qp: The QP to query.
1306 * @qp_attr: The attributes of the specified QP.
1307 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1308 * @qp_init_attr: Additional attributes of the selected QP.
1310 * The qp_attr_mask may be used to limit the query to gathering only the
1311 * selected attributes.
1313 int ib_query_qp(struct ib_qp *qp,
1314 struct ib_qp_attr *qp_attr,
1316 struct ib_qp_init_attr *qp_init_attr);
1319 * ib_destroy_qp - Destroys the specified QP.
1320 * @qp: The QP to destroy.
1322 int ib_destroy_qp(struct ib_qp *qp);
1325 * ib_post_send - Posts a list of work requests to the send queue of
1327 * @qp: The QP to post the work request on.
1328 * @send_wr: A list of work requests to post on the send queue.
1329 * @bad_send_wr: On an immediate failure, this parameter will reference
1330 * the work request that failed to be posted on the QP.
1332 static inline int ib_post_send(struct ib_qp *qp,
1333 struct ib_send_wr *send_wr,
1334 struct ib_send_wr **bad_send_wr)
1336 return qp->device->post_send(qp, send_wr, bad_send_wr);
1340 * ib_post_recv - Posts a list of work requests to the receive queue of
1342 * @qp: The QP to post the work request on.
1343 * @recv_wr: A list of work requests to post on the receive queue.
1344 * @bad_recv_wr: On an immediate failure, this parameter will reference
1345 * the work request that failed to be posted on the QP.
1347 static inline int ib_post_recv(struct ib_qp *qp,
1348 struct ib_recv_wr *recv_wr,
1349 struct ib_recv_wr **bad_recv_wr)
1351 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1355 * ib_create_cq - Creates a CQ on the specified device.
1356 * @device: The device on which to create the CQ.
1357 * @comp_handler: A user-specified callback that is invoked when a
1358 * completion event occurs on the CQ.
1359 * @event_handler: A user-specified callback that is invoked when an
1360 * asynchronous event not associated with a completion occurs on the CQ.
1361 * @cq_context: Context associated with the CQ returned to the user via
1362 * the associated completion and event handlers.
1363 * @cqe: The minimum size of the CQ.
1364 * @comp_vector - Completion vector used to signal completion events.
1365 * Must be >= 0 and < context->num_comp_vectors.
1367 * Users can examine the cq structure to determine the actual CQ size.
1369 struct ib_cq *ib_create_cq(struct ib_device *device,
1370 ib_comp_handler comp_handler,
1371 void (*event_handler)(struct ib_event *, void *),
1372 void *cq_context, int cqe, int comp_vector);
1375 * ib_resize_cq - Modifies the capacity of the CQ.
1376 * @cq: The CQ to resize.
1377 * @cqe: The minimum size of the CQ.
1379 * Users can examine the cq structure to determine the actual CQ size.
1381 int ib_resize_cq(struct ib_cq *cq, int cqe);
1384 * ib_destroy_cq - Destroys the specified CQ.
1385 * @cq: The CQ to destroy.
1387 int ib_destroy_cq(struct ib_cq *cq);
1390 * ib_poll_cq - poll a CQ for completion(s)
1391 * @cq:the CQ being polled
1392 * @num_entries:maximum number of completions to return
1393 * @wc:array of at least @num_entries &struct ib_wc where completions
1396 * Poll a CQ for (possibly multiple) completions. If the return value
1397 * is < 0, an error occurred. If the return value is >= 0, it is the
1398 * number of completions returned. If the return value is
1399 * non-negative and < num_entries, then the CQ was emptied.
1401 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1404 return cq->device->poll_cq(cq, num_entries, wc);
1408 * ib_peek_cq - Returns the number of unreaped completions currently
1409 * on the specified CQ.
1410 * @cq: The CQ to peek.
1411 * @wc_cnt: A minimum number of unreaped completions to check for.
1413 * If the number of unreaped completions is greater than or equal to wc_cnt,
1414 * this function returns wc_cnt, otherwise, it returns the actual number of
1415 * unreaped completions.
1417 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1420 * ib_req_notify_cq - Request completion notification on a CQ.
1421 * @cq: The CQ to generate an event for.
1422 * @cq_notify: If set to %IB_CQ_SOLICITED, completion notification will
1423 * occur on the next solicited event. If set to %IB_CQ_NEXT_COMP,
1424 * notification will occur on the next completion.
1426 static inline int ib_req_notify_cq(struct ib_cq *cq,
1427 enum ib_cq_notify cq_notify)
1429 return cq->device->req_notify_cq(cq, cq_notify);
1433 * ib_req_ncomp_notif - Request completion notification when there are
1434 * at least the specified number of unreaped completions on the CQ.
1435 * @cq: The CQ to generate an event for.
1436 * @wc_cnt: The number of unreaped completions that should be on the
1437 * CQ before an event is generated.
1439 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1441 return cq->device->req_ncomp_notif ?
1442 cq->device->req_ncomp_notif(cq, wc_cnt) :
1447 * ib_get_dma_mr - Returns a memory region for system memory that is
1449 * @pd: The protection domain associated with the memory region.
1450 * @mr_access_flags: Specifies the memory access rights.
1452 * Note that the ib_dma_*() functions defined below must be used
1453 * to create/destroy addresses used with the Lkey or Rkey returned
1454 * by ib_get_dma_mr().
1456 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1459 * ib_dma_mapping_error - check a DMA addr for error
1460 * @dev: The device for which the dma_addr was created
1461 * @dma_addr: The DMA address to check
1463 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1466 return dev->dma_ops->mapping_error(dev, dma_addr);
1467 return dma_mapping_error(dma_addr);
1471 * ib_dma_map_single - Map a kernel virtual address to DMA address
1472 * @dev: The device for which the dma_addr is to be created
1473 * @cpu_addr: The kernel virtual address
1474 * @size: The size of the region in bytes
1475 * @direction: The direction of the DMA
1477 static inline u64 ib_dma_map_single(struct ib_device *dev,
1478 void *cpu_addr, size_t size,
1479 enum dma_data_direction direction)
1482 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1483 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1487 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1488 * @dev: The device for which the DMA address was created
1489 * @addr: The DMA address
1490 * @size: The size of the region in bytes
1491 * @direction: The direction of the DMA
1493 static inline void ib_dma_unmap_single(struct ib_device *dev,
1494 u64 addr, size_t size,
1495 enum dma_data_direction direction)
1498 dev->dma_ops->unmap_single(dev, addr, size, direction);
1500 dma_unmap_single(dev->dma_device, addr, size, direction);
1504 * ib_dma_map_page - Map a physical page to DMA address
1505 * @dev: The device for which the dma_addr is to be created
1506 * @page: The page to be mapped
1507 * @offset: The offset within the page
1508 * @size: The size of the region in bytes
1509 * @direction: The direction of the DMA
1511 static inline u64 ib_dma_map_page(struct ib_device *dev,
1513 unsigned long offset,
1515 enum dma_data_direction direction)
1518 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1519 return dma_map_page(dev->dma_device, page, offset, size, direction);
1523 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1524 * @dev: The device for which the DMA address was created
1525 * @addr: The DMA address
1526 * @size: The size of the region in bytes
1527 * @direction: The direction of the DMA
1529 static inline void ib_dma_unmap_page(struct ib_device *dev,
1530 u64 addr, size_t size,
1531 enum dma_data_direction direction)
1534 dev->dma_ops->unmap_page(dev, addr, size, direction);
1536 dma_unmap_page(dev->dma_device, addr, size, direction);
1540 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1541 * @dev: The device for which the DMA addresses are to be created
1542 * @sg: The array of scatter/gather entries
1543 * @nents: The number of scatter/gather entries
1544 * @direction: The direction of the DMA
1546 static inline int ib_dma_map_sg(struct ib_device *dev,
1547 struct scatterlist *sg, int nents,
1548 enum dma_data_direction direction)
1551 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1552 return dma_map_sg(dev->dma_device, sg, nents, direction);
1556 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1557 * @dev: The device for which the DMA addresses were created
1558 * @sg: The array of scatter/gather entries
1559 * @nents: The number of scatter/gather entries
1560 * @direction: The direction of the DMA
1562 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1563 struct scatterlist *sg, int nents,
1564 enum dma_data_direction direction)
1567 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1569 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1573 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1574 * @dev: The device for which the DMA addresses were created
1575 * @sg: The scatter/gather entry
1577 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1578 struct scatterlist *sg)
1581 return dev->dma_ops->dma_address(dev, sg);
1582 return sg_dma_address(sg);
1586 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1587 * @dev: The device for which the DMA addresses were created
1588 * @sg: The scatter/gather entry
1590 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1591 struct scatterlist *sg)
1594 return dev->dma_ops->dma_len(dev, sg);
1595 return sg_dma_len(sg);
1599 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1600 * @dev: The device for which the DMA address was created
1601 * @addr: The DMA address
1602 * @size: The size of the region in bytes
1603 * @dir: The direction of the DMA
1605 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1608 enum dma_data_direction dir)
1611 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1613 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1617 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1618 * @dev: The device for which the DMA address was created
1619 * @addr: The DMA address
1620 * @size: The size of the region in bytes
1621 * @dir: The direction of the DMA
1623 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1626 enum dma_data_direction dir)
1629 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1631 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1635 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1636 * @dev: The device for which the DMA address is requested
1637 * @size: The size of the region to allocate in bytes
1638 * @dma_handle: A pointer for returning the DMA address of the region
1639 * @flag: memory allocator flags
1641 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1647 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1652 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1653 *dma_handle = handle;
1659 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1660 * @dev: The device for which the DMA addresses were allocated
1661 * @size: The size of the region
1662 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1663 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1665 static inline void ib_dma_free_coherent(struct ib_device *dev,
1666 size_t size, void *cpu_addr,
1670 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1672 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1676 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1678 * @pd: The protection domain associated assigned to the registered region.
1679 * @phys_buf_array: Specifies a list of physical buffers to use in the
1681 * @num_phys_buf: Specifies the size of the phys_buf_array.
1682 * @mr_access_flags: Specifies the memory access rights.
1683 * @iova_start: The offset of the region's starting I/O virtual address.
1685 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1686 struct ib_phys_buf *phys_buf_array,
1688 int mr_access_flags,
1692 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1693 * Conceptually, this call performs the functions deregister memory region
1694 * followed by register physical memory region. Where possible,
1695 * resources are reused instead of deallocated and reallocated.
1696 * @mr: The memory region to modify.
1697 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1698 * properties of the memory region are being modified.
1699 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1700 * the new protection domain to associated with the memory region,
1701 * otherwise, this parameter is ignored.
1702 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1703 * field specifies a list of physical buffers to use in the new
1704 * translation, otherwise, this parameter is ignored.
1705 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1706 * field specifies the size of the phys_buf_array, otherwise, this
1707 * parameter is ignored.
1708 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1709 * field specifies the new memory access rights, otherwise, this
1710 * parameter is ignored.
1711 * @iova_start: The offset of the region's starting I/O virtual address.
1713 int ib_rereg_phys_mr(struct ib_mr *mr,
1716 struct ib_phys_buf *phys_buf_array,
1718 int mr_access_flags,
1722 * ib_query_mr - Retrieves information about a specific memory region.
1723 * @mr: The memory region to retrieve information about.
1724 * @mr_attr: The attributes of the specified memory region.
1726 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1729 * ib_dereg_mr - Deregisters a memory region and removes it from the
1730 * HCA translation table.
1731 * @mr: The memory region to deregister.
1733 int ib_dereg_mr(struct ib_mr *mr);
1736 * ib_alloc_mw - Allocates a memory window.
1737 * @pd: The protection domain associated with the memory window.
1739 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1742 * ib_bind_mw - Posts a work request to the send queue of the specified
1743 * QP, which binds the memory window to the given address range and
1744 * remote access attributes.
1745 * @qp: QP to post the bind work request on.
1746 * @mw: The memory window to bind.
1747 * @mw_bind: Specifies information about the memory window, including
1748 * its address range, remote access rights, and associated memory region.
1750 static inline int ib_bind_mw(struct ib_qp *qp,
1752 struct ib_mw_bind *mw_bind)
1754 /* XXX reference counting in corresponding MR? */
1755 return mw->device->bind_mw ?
1756 mw->device->bind_mw(qp, mw, mw_bind) :
1761 * ib_dealloc_mw - Deallocates a memory window.
1762 * @mw: The memory window to deallocate.
1764 int ib_dealloc_mw(struct ib_mw *mw);
1767 * ib_alloc_fmr - Allocates a unmapped fast memory region.
1768 * @pd: The protection domain associated with the unmapped region.
1769 * @mr_access_flags: Specifies the memory access rights.
1770 * @fmr_attr: Attributes of the unmapped region.
1772 * A fast memory region must be mapped before it can be used as part of
1775 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1776 int mr_access_flags,
1777 struct ib_fmr_attr *fmr_attr);
1780 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1781 * @fmr: The fast memory region to associate with the pages.
1782 * @page_list: An array of physical pages to map to the fast memory region.
1783 * @list_len: The number of pages in page_list.
1784 * @iova: The I/O virtual address to use with the mapped region.
1786 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1787 u64 *page_list, int list_len,
1790 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1794 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1795 * @fmr_list: A linked list of fast memory regions to unmap.
1797 int ib_unmap_fmr(struct list_head *fmr_list);
1800 * ib_dealloc_fmr - Deallocates a fast memory region.
1801 * @fmr: The fast memory region to deallocate.
1803 int ib_dealloc_fmr(struct ib_fmr *fmr);
1806 * ib_attach_mcast - Attaches the specified QP to a multicast group.
1807 * @qp: QP to attach to the multicast group. The QP must be type
1809 * @gid: Multicast group GID.
1810 * @lid: Multicast group LID in host byte order.
1812 * In order to send and receive multicast packets, subnet
1813 * administration must have created the multicast group and configured
1814 * the fabric appropriately. The port associated with the specified
1815 * QP must also be a member of the multicast group.
1817 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1820 * ib_detach_mcast - Detaches the specified QP from a multicast group.
1821 * @qp: QP to detach from the multicast group.
1822 * @gid: Multicast group GID.
1823 * @lid: Multicast group LID in host byte order.
1825 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1827 #endif /* IB_VERBS_H */