2 * Copyright (c) 2004 Mellanox Technologies Ltd. All rights reserved.
3 * Copyright (c) 2004 Infinicon Corporation. All rights reserved.
4 * Copyright (c) 2004 Intel Corporation. All rights reserved.
5 * Copyright (c) 2004 Topspin Corporation. All rights reserved.
6 * Copyright (c) 2004 Voltaire Corporation. All rights reserved.
7 * Copyright (c) 2005 Sun Microsystems, Inc. All rights reserved.
8 * Copyright (c) 2005, 2006, 2007 Cisco Systems. All rights reserved.
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
39 #if !defined(IB_VERBS_H)
42 #include <linux/types.h>
43 #include <linux/device.h>
45 #include <linux/dma-mapping.h>
46 #include <linux/kref.h>
47 #include <linux/list.h>
48 #include <linux/rwsem.h>
49 #include <linux/scatterlist.h>
51 #include <asm/atomic.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_RESERVED = (1<<16), /* old SEND_W_INV */
96 IB_DEVICE_MEM_WINDOW = (1<<17),
98 * Devices should set IB_DEVICE_UD_IP_SUM if they support
99 * insertion of UDP and TCP checksum on outgoing UD IPoIB
100 * messages and can verify the validity of checksum for
101 * incoming messages. Setting this flag implies that the
102 * IPoIB driver may set NETIF_F_IP_CSUM for datagram mode.
104 IB_DEVICE_UD_IP_CSUM = (1<<18),
105 IB_DEVICE_UD_TSO = (1<<19),
114 struct ib_device_attr {
116 __be64 sys_image_guid;
124 int device_cap_flags;
134 int max_qp_init_rd_atom;
135 int max_ee_init_rd_atom;
136 enum ib_atomic_cap atomic_cap;
143 int max_mcast_qp_attach;
144 int max_total_mcast_qp_attach;
152 u8 local_ca_ack_delay;
163 static inline int ib_mtu_enum_to_int(enum ib_mtu mtu)
166 case IB_MTU_256: return 256;
167 case IB_MTU_512: return 512;
168 case IB_MTU_1024: return 1024;
169 case IB_MTU_2048: return 2048;
170 case IB_MTU_4096: return 4096;
181 IB_PORT_ACTIVE_DEFER = 5
184 enum ib_port_cap_flags {
186 IB_PORT_NOTICE_SUP = 1 << 2,
187 IB_PORT_TRAP_SUP = 1 << 3,
188 IB_PORT_OPT_IPD_SUP = 1 << 4,
189 IB_PORT_AUTO_MIGR_SUP = 1 << 5,
190 IB_PORT_SL_MAP_SUP = 1 << 6,
191 IB_PORT_MKEY_NVRAM = 1 << 7,
192 IB_PORT_PKEY_NVRAM = 1 << 8,
193 IB_PORT_LED_INFO_SUP = 1 << 9,
194 IB_PORT_SM_DISABLED = 1 << 10,
195 IB_PORT_SYS_IMAGE_GUID_SUP = 1 << 11,
196 IB_PORT_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
197 IB_PORT_CM_SUP = 1 << 16,
198 IB_PORT_SNMP_TUNNEL_SUP = 1 << 17,
199 IB_PORT_REINIT_SUP = 1 << 18,
200 IB_PORT_DEVICE_MGMT_SUP = 1 << 19,
201 IB_PORT_VENDOR_CLASS_SUP = 1 << 20,
202 IB_PORT_DR_NOTICE_SUP = 1 << 21,
203 IB_PORT_CAP_MASK_NOTICE_SUP = 1 << 22,
204 IB_PORT_BOOT_MGMT_SUP = 1 << 23,
205 IB_PORT_LINK_LATENCY_SUP = 1 << 24,
206 IB_PORT_CLIENT_REG_SUP = 1 << 25
216 static inline int ib_width_enum_to_int(enum ib_port_width width)
219 case IB_WIDTH_1X: return 1;
220 case IB_WIDTH_4X: return 4;
221 case IB_WIDTH_8X: return 8;
222 case IB_WIDTH_12X: return 12;
227 struct ib_port_attr {
228 enum ib_port_state state;
230 enum ib_mtu active_mtu;
249 enum ib_device_modify_flags {
250 IB_DEVICE_MODIFY_SYS_IMAGE_GUID = 1 << 0,
251 IB_DEVICE_MODIFY_NODE_DESC = 1 << 1
254 struct ib_device_modify {
259 enum ib_port_modify_flags {
260 IB_PORT_SHUTDOWN = 1,
261 IB_PORT_INIT_TYPE = (1<<2),
262 IB_PORT_RESET_QKEY_CNTR = (1<<3)
265 struct ib_port_modify {
266 u32 set_port_cap_mask;
267 u32 clr_port_cap_mask;
275 IB_EVENT_QP_ACCESS_ERR,
279 IB_EVENT_PATH_MIG_ERR,
280 IB_EVENT_DEVICE_FATAL,
281 IB_EVENT_PORT_ACTIVE,
284 IB_EVENT_PKEY_CHANGE,
287 IB_EVENT_SRQ_LIMIT_REACHED,
288 IB_EVENT_QP_LAST_WQE_REACHED,
289 IB_EVENT_CLIENT_REREGISTER
293 struct ib_device *device;
300 enum ib_event_type event;
303 struct ib_event_handler {
304 struct ib_device *device;
305 void (*handler)(struct ib_event_handler *, struct ib_event *);
306 struct list_head list;
309 #define INIT_IB_EVENT_HANDLER(_ptr, _device, _handler) \
311 (_ptr)->device = _device; \
312 (_ptr)->handler = _handler; \
313 INIT_LIST_HEAD(&(_ptr)->list); \
316 struct ib_global_route {
325 __be32 version_tclass_flow;
334 IB_MULTICAST_QPN = 0xffffff
337 #define IB_LID_PERMISSIVE __constant_htons(0xFFFF)
344 IB_RATE_PORT_CURRENT = 0,
345 IB_RATE_2_5_GBPS = 2,
353 IB_RATE_120_GBPS = 10
357 * ib_rate_to_mult - Convert the IB rate enum to a multiple of the
358 * base rate of 2.5 Gbit/sec. For example, IB_RATE_5_GBPS will be
359 * converted to 2, since 5 Gbit/sec is 2 * 2.5 Gbit/sec.
360 * @rate: rate to convert.
362 int ib_rate_to_mult(enum ib_rate rate) __attribute_const__;
365 * mult_to_ib_rate - Convert a multiple of 2.5 Gbit/sec to an IB rate
367 * @mult: multiple to convert.
369 enum ib_rate mult_to_ib_rate(int mult) __attribute_const__;
372 struct ib_global_route grh;
385 IB_WC_LOC_EEC_OP_ERR,
390 IB_WC_LOC_ACCESS_ERR,
391 IB_WC_REM_INV_REQ_ERR,
392 IB_WC_REM_ACCESS_ERR,
395 IB_WC_RNR_RETRY_EXC_ERR,
396 IB_WC_LOC_RDD_VIOL_ERR,
397 IB_WC_REM_INV_RD_REQ_ERR,
400 IB_WC_INV_EEC_STATE_ERR,
402 IB_WC_RESP_TIMEOUT_ERR,
415 * Set value of IB_WC_RECV so consumers can test if a completion is a
416 * receive by testing (opcode & IB_WC_RECV).
419 IB_WC_RECV_RDMA_WITH_IMM
424 IB_WC_WITH_IMM = (1<<1)
429 enum ib_wc_status status;
430 enum ib_wc_opcode opcode;
441 u8 port_num; /* valid only for DR SMPs on switches */
445 enum ib_cq_notify_flags {
446 IB_CQ_SOLICITED = 1 << 0,
447 IB_CQ_NEXT_COMP = 1 << 1,
448 IB_CQ_SOLICITED_MASK = IB_CQ_SOLICITED | IB_CQ_NEXT_COMP,
449 IB_CQ_REPORT_MISSED_EVENTS = 1 << 2,
452 enum ib_srq_attr_mask {
453 IB_SRQ_MAX_WR = 1 << 0,
454 IB_SRQ_LIMIT = 1 << 1,
463 struct ib_srq_init_attr {
464 void (*event_handler)(struct ib_event *, void *);
466 struct ib_srq_attr attr;
484 * IB_QPT_SMI and IB_QPT_GSI have to be the first two entries
485 * here (and in that order) since the MAD layer uses them as
486 * indices into a 2-entry table.
498 enum ib_qp_create_flags {
499 IB_QP_CREATE_IPOIB_UD_LSO = 1 << 0,
502 struct ib_qp_init_attr {
503 void (*event_handler)(struct ib_event *, void *);
505 struct ib_cq *send_cq;
506 struct ib_cq *recv_cq;
508 struct ib_qp_cap cap;
509 enum ib_sig_type sq_sig_type;
510 enum ib_qp_type qp_type;
511 enum ib_qp_create_flags create_flags;
512 u8 port_num; /* special QP types only */
515 enum ib_rnr_timeout {
516 IB_RNR_TIMER_655_36 = 0,
517 IB_RNR_TIMER_000_01 = 1,
518 IB_RNR_TIMER_000_02 = 2,
519 IB_RNR_TIMER_000_03 = 3,
520 IB_RNR_TIMER_000_04 = 4,
521 IB_RNR_TIMER_000_06 = 5,
522 IB_RNR_TIMER_000_08 = 6,
523 IB_RNR_TIMER_000_12 = 7,
524 IB_RNR_TIMER_000_16 = 8,
525 IB_RNR_TIMER_000_24 = 9,
526 IB_RNR_TIMER_000_32 = 10,
527 IB_RNR_TIMER_000_48 = 11,
528 IB_RNR_TIMER_000_64 = 12,
529 IB_RNR_TIMER_000_96 = 13,
530 IB_RNR_TIMER_001_28 = 14,
531 IB_RNR_TIMER_001_92 = 15,
532 IB_RNR_TIMER_002_56 = 16,
533 IB_RNR_TIMER_003_84 = 17,
534 IB_RNR_TIMER_005_12 = 18,
535 IB_RNR_TIMER_007_68 = 19,
536 IB_RNR_TIMER_010_24 = 20,
537 IB_RNR_TIMER_015_36 = 21,
538 IB_RNR_TIMER_020_48 = 22,
539 IB_RNR_TIMER_030_72 = 23,
540 IB_RNR_TIMER_040_96 = 24,
541 IB_RNR_TIMER_061_44 = 25,
542 IB_RNR_TIMER_081_92 = 26,
543 IB_RNR_TIMER_122_88 = 27,
544 IB_RNR_TIMER_163_84 = 28,
545 IB_RNR_TIMER_245_76 = 29,
546 IB_RNR_TIMER_327_68 = 30,
547 IB_RNR_TIMER_491_52 = 31
550 enum ib_qp_attr_mask {
552 IB_QP_CUR_STATE = (1<<1),
553 IB_QP_EN_SQD_ASYNC_NOTIFY = (1<<2),
554 IB_QP_ACCESS_FLAGS = (1<<3),
555 IB_QP_PKEY_INDEX = (1<<4),
559 IB_QP_PATH_MTU = (1<<8),
560 IB_QP_TIMEOUT = (1<<9),
561 IB_QP_RETRY_CNT = (1<<10),
562 IB_QP_RNR_RETRY = (1<<11),
563 IB_QP_RQ_PSN = (1<<12),
564 IB_QP_MAX_QP_RD_ATOMIC = (1<<13),
565 IB_QP_ALT_PATH = (1<<14),
566 IB_QP_MIN_RNR_TIMER = (1<<15),
567 IB_QP_SQ_PSN = (1<<16),
568 IB_QP_MAX_DEST_RD_ATOMIC = (1<<17),
569 IB_QP_PATH_MIG_STATE = (1<<18),
571 IB_QP_DEST_QPN = (1<<20)
591 enum ib_qp_state qp_state;
592 enum ib_qp_state cur_qp_state;
593 enum ib_mtu path_mtu;
594 enum ib_mig_state path_mig_state;
600 struct ib_qp_cap cap;
601 struct ib_ah_attr ah_attr;
602 struct ib_ah_attr alt_ah_attr;
605 u8 en_sqd_async_notify;
608 u8 max_dest_rd_atomic;
620 IB_WR_RDMA_WRITE_WITH_IMM,
624 IB_WR_ATOMIC_CMP_AND_SWP,
625 IB_WR_ATOMIC_FETCH_AND_ADD,
632 IB_SEND_SIGNALED = (1<<1),
633 IB_SEND_SOLICITED = (1<<2),
634 IB_SEND_INLINE = (1<<3),
635 IB_SEND_IP_CSUM = (1<<4)
645 struct ib_send_wr *next;
647 struct ib_sge *sg_list;
649 enum ib_wr_opcode opcode;
673 u16 pkey_index; /* valid for GSI only */
674 u8 port_num; /* valid for DR SMPs on switch only */
680 struct ib_recv_wr *next;
682 struct ib_sge *sg_list;
686 enum ib_access_flags {
687 IB_ACCESS_LOCAL_WRITE = 1,
688 IB_ACCESS_REMOTE_WRITE = (1<<1),
689 IB_ACCESS_REMOTE_READ = (1<<2),
690 IB_ACCESS_REMOTE_ATOMIC = (1<<3),
691 IB_ACCESS_MW_BIND = (1<<4)
701 u64 device_virt_addr;
708 enum ib_mr_rereg_flags {
709 IB_MR_REREG_TRANS = 1,
710 IB_MR_REREG_PD = (1<<1),
711 IB_MR_REREG_ACCESS = (1<<2)
730 struct ib_device *device;
731 struct list_head pd_list;
732 struct list_head mr_list;
733 struct list_head mw_list;
734 struct list_head cq_list;
735 struct list_head qp_list;
736 struct list_head srq_list;
737 struct list_head ah_list;
742 u64 user_handle; /* handle given to us by userspace */
743 struct ib_ucontext *context; /* associated user context */
744 void *object; /* containing object */
745 struct list_head list; /* link to context's list */
746 int id; /* index into kernel idr */
748 struct rw_semaphore mutex; /* protects .live */
760 struct ib_device *device;
761 struct ib_uobject *uobject;
762 atomic_t usecnt; /* count all resources */
766 struct ib_device *device;
768 struct ib_uobject *uobject;
771 typedef void (*ib_comp_handler)(struct ib_cq *cq, void *cq_context);
774 struct ib_device *device;
775 struct ib_uobject *uobject;
776 ib_comp_handler comp_handler;
777 void (*event_handler)(struct ib_event *, void *);
780 atomic_t usecnt; /* count number of work queues */
784 struct ib_device *device;
786 struct ib_uobject *uobject;
787 void (*event_handler)(struct ib_event *, void *);
793 struct ib_device *device;
795 struct ib_cq *send_cq;
796 struct ib_cq *recv_cq;
798 struct ib_uobject *uobject;
799 void (*event_handler)(struct ib_event *, void *);
802 enum ib_qp_type qp_type;
806 struct ib_device *device;
808 struct ib_uobject *uobject;
811 atomic_t usecnt; /* count number of MWs */
815 struct ib_device *device;
817 struct ib_uobject *uobject;
822 struct ib_device *device;
824 struct list_head list;
832 enum ib_process_mad_flags {
833 IB_MAD_IGNORE_MKEY = 1,
834 IB_MAD_IGNORE_BKEY = 2,
835 IB_MAD_IGNORE_ALL = IB_MAD_IGNORE_MKEY | IB_MAD_IGNORE_BKEY
839 IB_MAD_RESULT_FAILURE = 0, /* (!SUCCESS is the important flag) */
840 IB_MAD_RESULT_SUCCESS = 1 << 0, /* MAD was successfully processed */
841 IB_MAD_RESULT_REPLY = 1 << 1, /* Reply packet needs to be sent */
842 IB_MAD_RESULT_CONSUMED = 1 << 2 /* Packet consumed: stop processing */
845 #define IB_DEVICE_NAME_MAX 64
849 struct ib_event_handler event_handler;
850 struct ib_pkey_cache **pkey_cache;
851 struct ib_gid_cache **gid_cache;
855 struct ib_dma_mapping_ops {
856 int (*mapping_error)(struct ib_device *dev,
858 u64 (*map_single)(struct ib_device *dev,
859 void *ptr, size_t size,
860 enum dma_data_direction direction);
861 void (*unmap_single)(struct ib_device *dev,
862 u64 addr, size_t size,
863 enum dma_data_direction direction);
864 u64 (*map_page)(struct ib_device *dev,
865 struct page *page, unsigned long offset,
867 enum dma_data_direction direction);
868 void (*unmap_page)(struct ib_device *dev,
869 u64 addr, size_t size,
870 enum dma_data_direction direction);
871 int (*map_sg)(struct ib_device *dev,
872 struct scatterlist *sg, int nents,
873 enum dma_data_direction direction);
874 void (*unmap_sg)(struct ib_device *dev,
875 struct scatterlist *sg, int nents,
876 enum dma_data_direction direction);
877 u64 (*dma_address)(struct ib_device *dev,
878 struct scatterlist *sg);
879 unsigned int (*dma_len)(struct ib_device *dev,
880 struct scatterlist *sg);
881 void (*sync_single_for_cpu)(struct ib_device *dev,
884 enum dma_data_direction dir);
885 void (*sync_single_for_device)(struct ib_device *dev,
888 enum dma_data_direction dir);
889 void *(*alloc_coherent)(struct ib_device *dev,
893 void (*free_coherent)(struct ib_device *dev,
894 size_t size, void *cpu_addr,
901 struct device *dma_device;
903 char name[IB_DEVICE_NAME_MAX];
905 struct list_head event_handler_list;
906 spinlock_t event_handler_lock;
908 struct list_head core_list;
909 struct list_head client_data_list;
910 spinlock_t client_data_lock;
912 struct ib_cache cache;
916 int num_comp_vectors;
918 struct iw_cm_verbs *iwcm;
920 int (*query_device)(struct ib_device *device,
921 struct ib_device_attr *device_attr);
922 int (*query_port)(struct ib_device *device,
924 struct ib_port_attr *port_attr);
925 int (*query_gid)(struct ib_device *device,
926 u8 port_num, int index,
928 int (*query_pkey)(struct ib_device *device,
929 u8 port_num, u16 index, u16 *pkey);
930 int (*modify_device)(struct ib_device *device,
931 int device_modify_mask,
932 struct ib_device_modify *device_modify);
933 int (*modify_port)(struct ib_device *device,
934 u8 port_num, int port_modify_mask,
935 struct ib_port_modify *port_modify);
936 struct ib_ucontext * (*alloc_ucontext)(struct ib_device *device,
937 struct ib_udata *udata);
938 int (*dealloc_ucontext)(struct ib_ucontext *context);
939 int (*mmap)(struct ib_ucontext *context,
940 struct vm_area_struct *vma);
941 struct ib_pd * (*alloc_pd)(struct ib_device *device,
942 struct ib_ucontext *context,
943 struct ib_udata *udata);
944 int (*dealloc_pd)(struct ib_pd *pd);
945 struct ib_ah * (*create_ah)(struct ib_pd *pd,
946 struct ib_ah_attr *ah_attr);
947 int (*modify_ah)(struct ib_ah *ah,
948 struct ib_ah_attr *ah_attr);
949 int (*query_ah)(struct ib_ah *ah,
950 struct ib_ah_attr *ah_attr);
951 int (*destroy_ah)(struct ib_ah *ah);
952 struct ib_srq * (*create_srq)(struct ib_pd *pd,
953 struct ib_srq_init_attr *srq_init_attr,
954 struct ib_udata *udata);
955 int (*modify_srq)(struct ib_srq *srq,
956 struct ib_srq_attr *srq_attr,
957 enum ib_srq_attr_mask srq_attr_mask,
958 struct ib_udata *udata);
959 int (*query_srq)(struct ib_srq *srq,
960 struct ib_srq_attr *srq_attr);
961 int (*destroy_srq)(struct ib_srq *srq);
962 int (*post_srq_recv)(struct ib_srq *srq,
963 struct ib_recv_wr *recv_wr,
964 struct ib_recv_wr **bad_recv_wr);
965 struct ib_qp * (*create_qp)(struct ib_pd *pd,
966 struct ib_qp_init_attr *qp_init_attr,
967 struct ib_udata *udata);
968 int (*modify_qp)(struct ib_qp *qp,
969 struct ib_qp_attr *qp_attr,
971 struct ib_udata *udata);
972 int (*query_qp)(struct ib_qp *qp,
973 struct ib_qp_attr *qp_attr,
975 struct ib_qp_init_attr *qp_init_attr);
976 int (*destroy_qp)(struct ib_qp *qp);
977 int (*post_send)(struct ib_qp *qp,
978 struct ib_send_wr *send_wr,
979 struct ib_send_wr **bad_send_wr);
980 int (*post_recv)(struct ib_qp *qp,
981 struct ib_recv_wr *recv_wr,
982 struct ib_recv_wr **bad_recv_wr);
983 struct ib_cq * (*create_cq)(struct ib_device *device, int cqe,
985 struct ib_ucontext *context,
986 struct ib_udata *udata);
987 int (*modify_cq)(struct ib_cq *cq, u16 cq_count,
989 int (*destroy_cq)(struct ib_cq *cq);
990 int (*resize_cq)(struct ib_cq *cq, int cqe,
991 struct ib_udata *udata);
992 int (*poll_cq)(struct ib_cq *cq, int num_entries,
994 int (*peek_cq)(struct ib_cq *cq, int wc_cnt);
995 int (*req_notify_cq)(struct ib_cq *cq,
996 enum ib_cq_notify_flags flags);
997 int (*req_ncomp_notif)(struct ib_cq *cq,
999 struct ib_mr * (*get_dma_mr)(struct ib_pd *pd,
1000 int mr_access_flags);
1001 struct ib_mr * (*reg_phys_mr)(struct ib_pd *pd,
1002 struct ib_phys_buf *phys_buf_array,
1004 int mr_access_flags,
1006 struct ib_mr * (*reg_user_mr)(struct ib_pd *pd,
1007 u64 start, u64 length,
1009 int mr_access_flags,
1010 struct ib_udata *udata);
1011 int (*query_mr)(struct ib_mr *mr,
1012 struct ib_mr_attr *mr_attr);
1013 int (*dereg_mr)(struct ib_mr *mr);
1014 int (*rereg_phys_mr)(struct ib_mr *mr,
1017 struct ib_phys_buf *phys_buf_array,
1019 int mr_access_flags,
1021 struct ib_mw * (*alloc_mw)(struct ib_pd *pd);
1022 int (*bind_mw)(struct ib_qp *qp,
1024 struct ib_mw_bind *mw_bind);
1025 int (*dealloc_mw)(struct ib_mw *mw);
1026 struct ib_fmr * (*alloc_fmr)(struct ib_pd *pd,
1027 int mr_access_flags,
1028 struct ib_fmr_attr *fmr_attr);
1029 int (*map_phys_fmr)(struct ib_fmr *fmr,
1030 u64 *page_list, int list_len,
1032 int (*unmap_fmr)(struct list_head *fmr_list);
1033 int (*dealloc_fmr)(struct ib_fmr *fmr);
1034 int (*attach_mcast)(struct ib_qp *qp,
1037 int (*detach_mcast)(struct ib_qp *qp,
1040 int (*process_mad)(struct ib_device *device,
1041 int process_mad_flags,
1043 struct ib_wc *in_wc,
1044 struct ib_grh *in_grh,
1045 struct ib_mad *in_mad,
1046 struct ib_mad *out_mad);
1048 struct ib_dma_mapping_ops *dma_ops;
1050 struct module *owner;
1052 struct kobject *ports_parent;
1053 struct list_head port_list;
1056 IB_DEV_UNINITIALIZED,
1061 u64 uverbs_cmd_mask;
1072 void (*add) (struct ib_device *);
1073 void (*remove)(struct ib_device *);
1075 struct list_head list;
1078 struct ib_device *ib_alloc_device(size_t size);
1079 void ib_dealloc_device(struct ib_device *device);
1081 int ib_register_device (struct ib_device *device);
1082 void ib_unregister_device(struct ib_device *device);
1084 int ib_register_client (struct ib_client *client);
1085 void ib_unregister_client(struct ib_client *client);
1087 void *ib_get_client_data(struct ib_device *device, struct ib_client *client);
1088 void ib_set_client_data(struct ib_device *device, struct ib_client *client,
1091 static inline int ib_copy_from_udata(void *dest, struct ib_udata *udata, size_t len)
1093 return copy_from_user(dest, udata->inbuf, len) ? -EFAULT : 0;
1096 static inline int ib_copy_to_udata(struct ib_udata *udata, void *src, size_t len)
1098 return copy_to_user(udata->outbuf, src, len) ? -EFAULT : 0;
1102 * ib_modify_qp_is_ok - Check that the supplied attribute mask
1103 * contains all required attributes and no attributes not allowed for
1104 * the given QP state transition.
1105 * @cur_state: Current QP state
1106 * @next_state: Next QP state
1108 * @mask: Mask of supplied QP attributes
1110 * This function is a helper function that a low-level driver's
1111 * modify_qp method can use to validate the consumer's input. It
1112 * checks that cur_state and next_state are valid QP states, that a
1113 * transition from cur_state to next_state is allowed by the IB spec,
1114 * and that the attribute mask supplied is allowed for the transition.
1116 int ib_modify_qp_is_ok(enum ib_qp_state cur_state, enum ib_qp_state next_state,
1117 enum ib_qp_type type, enum ib_qp_attr_mask mask);
1119 int ib_register_event_handler (struct ib_event_handler *event_handler);
1120 int ib_unregister_event_handler(struct ib_event_handler *event_handler);
1121 void ib_dispatch_event(struct ib_event *event);
1123 int ib_query_device(struct ib_device *device,
1124 struct ib_device_attr *device_attr);
1126 int ib_query_port(struct ib_device *device,
1127 u8 port_num, struct ib_port_attr *port_attr);
1129 int ib_query_gid(struct ib_device *device,
1130 u8 port_num, int index, union ib_gid *gid);
1132 int ib_query_pkey(struct ib_device *device,
1133 u8 port_num, u16 index, u16 *pkey);
1135 int ib_modify_device(struct ib_device *device,
1136 int device_modify_mask,
1137 struct ib_device_modify *device_modify);
1139 int ib_modify_port(struct ib_device *device,
1140 u8 port_num, int port_modify_mask,
1141 struct ib_port_modify *port_modify);
1143 int ib_find_gid(struct ib_device *device, union ib_gid *gid,
1144 u8 *port_num, u16 *index);
1146 int ib_find_pkey(struct ib_device *device,
1147 u8 port_num, u16 pkey, u16 *index);
1150 * ib_alloc_pd - Allocates an unused protection domain.
1151 * @device: The device on which to allocate the protection domain.
1153 * A protection domain object provides an association between QPs, shared
1154 * receive queues, address handles, memory regions, and memory windows.
1156 struct ib_pd *ib_alloc_pd(struct ib_device *device);
1159 * ib_dealloc_pd - Deallocates a protection domain.
1160 * @pd: The protection domain to deallocate.
1162 int ib_dealloc_pd(struct ib_pd *pd);
1165 * ib_create_ah - Creates an address handle for the given address vector.
1166 * @pd: The protection domain associated with the address handle.
1167 * @ah_attr: The attributes of the address vector.
1169 * The address handle is used to reference a local or global destination
1170 * in all UD QP post sends.
1172 struct ib_ah *ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
1175 * ib_init_ah_from_wc - Initializes address handle attributes from a
1177 * @device: Device on which the received message arrived.
1178 * @port_num: Port on which the received message arrived.
1179 * @wc: Work completion associated with the received message.
1180 * @grh: References the received global route header. This parameter is
1181 * ignored unless the work completion indicates that the GRH is valid.
1182 * @ah_attr: Returned attributes that can be used when creating an address
1183 * handle for replying to the message.
1185 int ib_init_ah_from_wc(struct ib_device *device, u8 port_num, struct ib_wc *wc,
1186 struct ib_grh *grh, struct ib_ah_attr *ah_attr);
1189 * ib_create_ah_from_wc - Creates an address handle associated with the
1190 * sender of the specified work completion.
1191 * @pd: The protection domain associated with the address handle.
1192 * @wc: Work completion information associated with a received message.
1193 * @grh: References the received global route header. This parameter is
1194 * ignored unless the work completion indicates that the GRH is valid.
1195 * @port_num: The outbound port number to associate with the address.
1197 * The address handle is used to reference a local or global destination
1198 * in all UD QP post sends.
1200 struct ib_ah *ib_create_ah_from_wc(struct ib_pd *pd, struct ib_wc *wc,
1201 struct ib_grh *grh, u8 port_num);
1204 * ib_modify_ah - Modifies the address vector associated with an address
1206 * @ah: The address handle to modify.
1207 * @ah_attr: The new address vector attributes to associate with the
1210 int ib_modify_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1213 * ib_query_ah - Queries the address vector associated with an address
1215 * @ah: The address handle to query.
1216 * @ah_attr: The address vector attributes associated with the address
1219 int ib_query_ah(struct ib_ah *ah, struct ib_ah_attr *ah_attr);
1222 * ib_destroy_ah - Destroys an address handle.
1223 * @ah: The address handle to destroy.
1225 int ib_destroy_ah(struct ib_ah *ah);
1228 * ib_create_srq - Creates a SRQ associated with the specified protection
1230 * @pd: The protection domain associated with the SRQ.
1231 * @srq_init_attr: A list of initial attributes required to create the
1232 * SRQ. If SRQ creation succeeds, then the attributes are updated to
1233 * the actual capabilities of the created SRQ.
1235 * srq_attr->max_wr and srq_attr->max_sge are read the determine the
1236 * requested size of the SRQ, and set to the actual values allocated
1237 * on return. If ib_create_srq() succeeds, then max_wr and max_sge
1238 * will always be at least as large as the requested values.
1240 struct ib_srq *ib_create_srq(struct ib_pd *pd,
1241 struct ib_srq_init_attr *srq_init_attr);
1244 * ib_modify_srq - Modifies the attributes for the specified SRQ.
1245 * @srq: The SRQ to modify.
1246 * @srq_attr: On input, specifies the SRQ attributes to modify. On output,
1247 * the current values of selected SRQ attributes are returned.
1248 * @srq_attr_mask: A bit-mask used to specify which attributes of the SRQ
1249 * are being modified.
1251 * The mask may contain IB_SRQ_MAX_WR to resize the SRQ and/or
1252 * IB_SRQ_LIMIT to set the SRQ's limit and request notification when
1253 * the number of receives queued drops below the limit.
1255 int ib_modify_srq(struct ib_srq *srq,
1256 struct ib_srq_attr *srq_attr,
1257 enum ib_srq_attr_mask srq_attr_mask);
1260 * ib_query_srq - Returns the attribute list and current values for the
1262 * @srq: The SRQ to query.
1263 * @srq_attr: The attributes of the specified SRQ.
1265 int ib_query_srq(struct ib_srq *srq,
1266 struct ib_srq_attr *srq_attr);
1269 * ib_destroy_srq - Destroys the specified SRQ.
1270 * @srq: The SRQ to destroy.
1272 int ib_destroy_srq(struct ib_srq *srq);
1275 * ib_post_srq_recv - Posts a list of work requests to the specified SRQ.
1276 * @srq: The SRQ to post the work request on.
1277 * @recv_wr: A list of work requests to post on the receive queue.
1278 * @bad_recv_wr: On an immediate failure, this parameter will reference
1279 * the work request that failed to be posted on the QP.
1281 static inline int ib_post_srq_recv(struct ib_srq *srq,
1282 struct ib_recv_wr *recv_wr,
1283 struct ib_recv_wr **bad_recv_wr)
1285 return srq->device->post_srq_recv(srq, recv_wr, bad_recv_wr);
1289 * ib_create_qp - Creates a QP associated with the specified protection
1291 * @pd: The protection domain associated with the QP.
1292 * @qp_init_attr: A list of initial attributes required to create the
1293 * QP. If QP creation succeeds, then the attributes are updated to
1294 * the actual capabilities of the created QP.
1296 struct ib_qp *ib_create_qp(struct ib_pd *pd,
1297 struct ib_qp_init_attr *qp_init_attr);
1300 * ib_modify_qp - Modifies the attributes for the specified QP and then
1301 * transitions the QP to the given state.
1302 * @qp: The QP to modify.
1303 * @qp_attr: On input, specifies the QP attributes to modify. On output,
1304 * the current values of selected QP attributes are returned.
1305 * @qp_attr_mask: A bit-mask used to specify which attributes of the QP
1306 * are being modified.
1308 int ib_modify_qp(struct ib_qp *qp,
1309 struct ib_qp_attr *qp_attr,
1313 * ib_query_qp - Returns the attribute list and current values for the
1315 * @qp: The QP to query.
1316 * @qp_attr: The attributes of the specified QP.
1317 * @qp_attr_mask: A bit-mask used to select specific attributes to query.
1318 * @qp_init_attr: Additional attributes of the selected QP.
1320 * The qp_attr_mask may be used to limit the query to gathering only the
1321 * selected attributes.
1323 int ib_query_qp(struct ib_qp *qp,
1324 struct ib_qp_attr *qp_attr,
1326 struct ib_qp_init_attr *qp_init_attr);
1329 * ib_destroy_qp - Destroys the specified QP.
1330 * @qp: The QP to destroy.
1332 int ib_destroy_qp(struct ib_qp *qp);
1335 * ib_post_send - Posts a list of work requests to the send queue of
1337 * @qp: The QP to post the work request on.
1338 * @send_wr: A list of work requests to post on the send queue.
1339 * @bad_send_wr: On an immediate failure, this parameter will reference
1340 * the work request that failed to be posted on the QP.
1342 static inline int ib_post_send(struct ib_qp *qp,
1343 struct ib_send_wr *send_wr,
1344 struct ib_send_wr **bad_send_wr)
1346 return qp->device->post_send(qp, send_wr, bad_send_wr);
1350 * ib_post_recv - Posts a list of work requests to the receive queue of
1352 * @qp: The QP to post the work request on.
1353 * @recv_wr: A list of work requests to post on the receive queue.
1354 * @bad_recv_wr: On an immediate failure, this parameter will reference
1355 * the work request that failed to be posted on the QP.
1357 static inline int ib_post_recv(struct ib_qp *qp,
1358 struct ib_recv_wr *recv_wr,
1359 struct ib_recv_wr **bad_recv_wr)
1361 return qp->device->post_recv(qp, recv_wr, bad_recv_wr);
1365 * ib_create_cq - Creates a CQ on the specified device.
1366 * @device: The device on which to create the CQ.
1367 * @comp_handler: A user-specified callback that is invoked when a
1368 * completion event occurs on the CQ.
1369 * @event_handler: A user-specified callback that is invoked when an
1370 * asynchronous event not associated with a completion occurs on the CQ.
1371 * @cq_context: Context associated with the CQ returned to the user via
1372 * the associated completion and event handlers.
1373 * @cqe: The minimum size of the CQ.
1374 * @comp_vector - Completion vector used to signal completion events.
1375 * Must be >= 0 and < context->num_comp_vectors.
1377 * Users can examine the cq structure to determine the actual CQ size.
1379 struct ib_cq *ib_create_cq(struct ib_device *device,
1380 ib_comp_handler comp_handler,
1381 void (*event_handler)(struct ib_event *, void *),
1382 void *cq_context, int cqe, int comp_vector);
1385 * ib_resize_cq - Modifies the capacity of the CQ.
1386 * @cq: The CQ to resize.
1387 * @cqe: The minimum size of the CQ.
1389 * Users can examine the cq structure to determine the actual CQ size.
1391 int ib_resize_cq(struct ib_cq *cq, int cqe);
1394 * ib_modify_cq - Modifies moderation params of the CQ
1395 * @cq: The CQ to modify.
1396 * @cq_count: number of CQEs that will trigger an event
1397 * @cq_period: max period of time in usec before triggering an event
1400 int ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
1403 * ib_destroy_cq - Destroys the specified CQ.
1404 * @cq: The CQ to destroy.
1406 int ib_destroy_cq(struct ib_cq *cq);
1409 * ib_poll_cq - poll a CQ for completion(s)
1410 * @cq:the CQ being polled
1411 * @num_entries:maximum number of completions to return
1412 * @wc:array of at least @num_entries &struct ib_wc where completions
1415 * Poll a CQ for (possibly multiple) completions. If the return value
1416 * is < 0, an error occurred. If the return value is >= 0, it is the
1417 * number of completions returned. If the return value is
1418 * non-negative and < num_entries, then the CQ was emptied.
1420 static inline int ib_poll_cq(struct ib_cq *cq, int num_entries,
1423 return cq->device->poll_cq(cq, num_entries, wc);
1427 * ib_peek_cq - Returns the number of unreaped completions currently
1428 * on the specified CQ.
1429 * @cq: The CQ to peek.
1430 * @wc_cnt: A minimum number of unreaped completions to check for.
1432 * If the number of unreaped completions is greater than or equal to wc_cnt,
1433 * this function returns wc_cnt, otherwise, it returns the actual number of
1434 * unreaped completions.
1436 int ib_peek_cq(struct ib_cq *cq, int wc_cnt);
1439 * ib_req_notify_cq - Request completion notification on a CQ.
1440 * @cq: The CQ to generate an event for.
1442 * Must contain exactly one of %IB_CQ_SOLICITED or %IB_CQ_NEXT_COMP
1443 * to request an event on the next solicited event or next work
1444 * completion at any type, respectively. %IB_CQ_REPORT_MISSED_EVENTS
1445 * may also be |ed in to request a hint about missed events, as
1449 * < 0 means an error occurred while requesting notification
1450 * == 0 means notification was requested successfully, and if
1451 * IB_CQ_REPORT_MISSED_EVENTS was passed in, then no events
1452 * were missed and it is safe to wait for another event. In
1453 * this case is it guaranteed that any work completions added
1454 * to the CQ since the last CQ poll will trigger a completion
1455 * notification event.
1456 * > 0 is only returned if IB_CQ_REPORT_MISSED_EVENTS was passed
1457 * in. It means that the consumer must poll the CQ again to
1458 * make sure it is empty to avoid missing an event because of a
1459 * race between requesting notification and an entry being
1460 * added to the CQ. This return value means it is possible
1461 * (but not guaranteed) that a work completion has been added
1462 * to the CQ since the last poll without triggering a
1463 * completion notification event.
1465 static inline int ib_req_notify_cq(struct ib_cq *cq,
1466 enum ib_cq_notify_flags flags)
1468 return cq->device->req_notify_cq(cq, flags);
1472 * ib_req_ncomp_notif - Request completion notification when there are
1473 * at least the specified number of unreaped completions on the CQ.
1474 * @cq: The CQ to generate an event for.
1475 * @wc_cnt: The number of unreaped completions that should be on the
1476 * CQ before an event is generated.
1478 static inline int ib_req_ncomp_notif(struct ib_cq *cq, int wc_cnt)
1480 return cq->device->req_ncomp_notif ?
1481 cq->device->req_ncomp_notif(cq, wc_cnt) :
1486 * ib_get_dma_mr - Returns a memory region for system memory that is
1488 * @pd: The protection domain associated with the memory region.
1489 * @mr_access_flags: Specifies the memory access rights.
1491 * Note that the ib_dma_*() functions defined below must be used
1492 * to create/destroy addresses used with the Lkey or Rkey returned
1493 * by ib_get_dma_mr().
1495 struct ib_mr *ib_get_dma_mr(struct ib_pd *pd, int mr_access_flags);
1498 * ib_dma_mapping_error - check a DMA addr for error
1499 * @dev: The device for which the dma_addr was created
1500 * @dma_addr: The DMA address to check
1502 static inline int ib_dma_mapping_error(struct ib_device *dev, u64 dma_addr)
1505 return dev->dma_ops->mapping_error(dev, dma_addr);
1506 return dma_mapping_error(dma_addr);
1510 * ib_dma_map_single - Map a kernel virtual address to DMA address
1511 * @dev: The device for which the dma_addr is to be created
1512 * @cpu_addr: The kernel virtual address
1513 * @size: The size of the region in bytes
1514 * @direction: The direction of the DMA
1516 static inline u64 ib_dma_map_single(struct ib_device *dev,
1517 void *cpu_addr, size_t size,
1518 enum dma_data_direction direction)
1521 return dev->dma_ops->map_single(dev, cpu_addr, size, direction);
1522 return dma_map_single(dev->dma_device, cpu_addr, size, direction);
1526 * ib_dma_unmap_single - Destroy a mapping created by ib_dma_map_single()
1527 * @dev: The device for which the DMA address was created
1528 * @addr: The DMA address
1529 * @size: The size of the region in bytes
1530 * @direction: The direction of the DMA
1532 static inline void ib_dma_unmap_single(struct ib_device *dev,
1533 u64 addr, size_t size,
1534 enum dma_data_direction direction)
1537 dev->dma_ops->unmap_single(dev, addr, size, direction);
1539 dma_unmap_single(dev->dma_device, addr, size, direction);
1542 static inline u64 ib_dma_map_single_attrs(struct ib_device *dev,
1543 void *cpu_addr, size_t size,
1544 enum dma_data_direction direction,
1545 struct dma_attrs *attrs)
1547 return dma_map_single_attrs(dev->dma_device, cpu_addr, size,
1551 static inline void ib_dma_unmap_single_attrs(struct ib_device *dev,
1552 u64 addr, size_t size,
1553 enum dma_data_direction direction,
1554 struct dma_attrs *attrs)
1556 return dma_unmap_single_attrs(dev->dma_device, addr, size,
1561 * ib_dma_map_page - Map a physical page to DMA address
1562 * @dev: The device for which the dma_addr is to be created
1563 * @page: The page to be mapped
1564 * @offset: The offset within the page
1565 * @size: The size of the region in bytes
1566 * @direction: The direction of the DMA
1568 static inline u64 ib_dma_map_page(struct ib_device *dev,
1570 unsigned long offset,
1572 enum dma_data_direction direction)
1575 return dev->dma_ops->map_page(dev, page, offset, size, direction);
1576 return dma_map_page(dev->dma_device, page, offset, size, direction);
1580 * ib_dma_unmap_page - Destroy a mapping created by ib_dma_map_page()
1581 * @dev: The device for which the DMA address was created
1582 * @addr: The DMA address
1583 * @size: The size of the region in bytes
1584 * @direction: The direction of the DMA
1586 static inline void ib_dma_unmap_page(struct ib_device *dev,
1587 u64 addr, size_t size,
1588 enum dma_data_direction direction)
1591 dev->dma_ops->unmap_page(dev, addr, size, direction);
1593 dma_unmap_page(dev->dma_device, addr, size, direction);
1597 * ib_dma_map_sg - Map a scatter/gather list to DMA addresses
1598 * @dev: The device for which the DMA addresses are to be created
1599 * @sg: The array of scatter/gather entries
1600 * @nents: The number of scatter/gather entries
1601 * @direction: The direction of the DMA
1603 static inline int ib_dma_map_sg(struct ib_device *dev,
1604 struct scatterlist *sg, int nents,
1605 enum dma_data_direction direction)
1608 return dev->dma_ops->map_sg(dev, sg, nents, direction);
1609 return dma_map_sg(dev->dma_device, sg, nents, direction);
1613 * ib_dma_unmap_sg - Unmap a scatter/gather list of DMA addresses
1614 * @dev: The device for which the DMA addresses were created
1615 * @sg: The array of scatter/gather entries
1616 * @nents: The number of scatter/gather entries
1617 * @direction: The direction of the DMA
1619 static inline void ib_dma_unmap_sg(struct ib_device *dev,
1620 struct scatterlist *sg, int nents,
1621 enum dma_data_direction direction)
1624 dev->dma_ops->unmap_sg(dev, sg, nents, direction);
1626 dma_unmap_sg(dev->dma_device, sg, nents, direction);
1629 static inline int ib_dma_map_sg_attrs(struct ib_device *dev,
1630 struct scatterlist *sg, int nents,
1631 enum dma_data_direction direction,
1632 struct dma_attrs *attrs)
1634 return dma_map_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1637 static inline void ib_dma_unmap_sg_attrs(struct ib_device *dev,
1638 struct scatterlist *sg, int nents,
1639 enum dma_data_direction direction,
1640 struct dma_attrs *attrs)
1642 dma_unmap_sg_attrs(dev->dma_device, sg, nents, direction, attrs);
1645 * ib_sg_dma_address - Return the DMA address from a scatter/gather entry
1646 * @dev: The device for which the DMA addresses were created
1647 * @sg: The scatter/gather entry
1649 static inline u64 ib_sg_dma_address(struct ib_device *dev,
1650 struct scatterlist *sg)
1653 return dev->dma_ops->dma_address(dev, sg);
1654 return sg_dma_address(sg);
1658 * ib_sg_dma_len - Return the DMA length from a scatter/gather entry
1659 * @dev: The device for which the DMA addresses were created
1660 * @sg: The scatter/gather entry
1662 static inline unsigned int ib_sg_dma_len(struct ib_device *dev,
1663 struct scatterlist *sg)
1666 return dev->dma_ops->dma_len(dev, sg);
1667 return sg_dma_len(sg);
1671 * ib_dma_sync_single_for_cpu - Prepare DMA region to be accessed by CPU
1672 * @dev: The device for which the DMA address was created
1673 * @addr: The DMA address
1674 * @size: The size of the region in bytes
1675 * @dir: The direction of the DMA
1677 static inline void ib_dma_sync_single_for_cpu(struct ib_device *dev,
1680 enum dma_data_direction dir)
1683 dev->dma_ops->sync_single_for_cpu(dev, addr, size, dir);
1685 dma_sync_single_for_cpu(dev->dma_device, addr, size, dir);
1689 * ib_dma_sync_single_for_device - Prepare DMA region to be accessed by device
1690 * @dev: The device for which the DMA address was created
1691 * @addr: The DMA address
1692 * @size: The size of the region in bytes
1693 * @dir: The direction of the DMA
1695 static inline void ib_dma_sync_single_for_device(struct ib_device *dev,
1698 enum dma_data_direction dir)
1701 dev->dma_ops->sync_single_for_device(dev, addr, size, dir);
1703 dma_sync_single_for_device(dev->dma_device, addr, size, dir);
1707 * ib_dma_alloc_coherent - Allocate memory and map it for DMA
1708 * @dev: The device for which the DMA address is requested
1709 * @size: The size of the region to allocate in bytes
1710 * @dma_handle: A pointer for returning the DMA address of the region
1711 * @flag: memory allocator flags
1713 static inline void *ib_dma_alloc_coherent(struct ib_device *dev,
1719 return dev->dma_ops->alloc_coherent(dev, size, dma_handle, flag);
1724 ret = dma_alloc_coherent(dev->dma_device, size, &handle, flag);
1725 *dma_handle = handle;
1731 * ib_dma_free_coherent - Free memory allocated by ib_dma_alloc_coherent()
1732 * @dev: The device for which the DMA addresses were allocated
1733 * @size: The size of the region
1734 * @cpu_addr: the address returned by ib_dma_alloc_coherent()
1735 * @dma_handle: the DMA address returned by ib_dma_alloc_coherent()
1737 static inline void ib_dma_free_coherent(struct ib_device *dev,
1738 size_t size, void *cpu_addr,
1742 dev->dma_ops->free_coherent(dev, size, cpu_addr, dma_handle);
1744 dma_free_coherent(dev->dma_device, size, cpu_addr, dma_handle);
1748 * ib_reg_phys_mr - Prepares a virtually addressed memory region for use
1750 * @pd: The protection domain associated assigned to the registered region.
1751 * @phys_buf_array: Specifies a list of physical buffers to use in the
1753 * @num_phys_buf: Specifies the size of the phys_buf_array.
1754 * @mr_access_flags: Specifies the memory access rights.
1755 * @iova_start: The offset of the region's starting I/O virtual address.
1757 struct ib_mr *ib_reg_phys_mr(struct ib_pd *pd,
1758 struct ib_phys_buf *phys_buf_array,
1760 int mr_access_flags,
1764 * ib_rereg_phys_mr - Modifies the attributes of an existing memory region.
1765 * Conceptually, this call performs the functions deregister memory region
1766 * followed by register physical memory region. Where possible,
1767 * resources are reused instead of deallocated and reallocated.
1768 * @mr: The memory region to modify.
1769 * @mr_rereg_mask: A bit-mask used to indicate which of the following
1770 * properties of the memory region are being modified.
1771 * @pd: If %IB_MR_REREG_PD is set in mr_rereg_mask, this field specifies
1772 * the new protection domain to associated with the memory region,
1773 * otherwise, this parameter is ignored.
1774 * @phys_buf_array: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1775 * field specifies a list of physical buffers to use in the new
1776 * translation, otherwise, this parameter is ignored.
1777 * @num_phys_buf: If %IB_MR_REREG_TRANS is set in mr_rereg_mask, this
1778 * field specifies the size of the phys_buf_array, otherwise, this
1779 * parameter is ignored.
1780 * @mr_access_flags: If %IB_MR_REREG_ACCESS is set in mr_rereg_mask, this
1781 * field specifies the new memory access rights, otherwise, this
1782 * parameter is ignored.
1783 * @iova_start: The offset of the region's starting I/O virtual address.
1785 int ib_rereg_phys_mr(struct ib_mr *mr,
1788 struct ib_phys_buf *phys_buf_array,
1790 int mr_access_flags,
1794 * ib_query_mr - Retrieves information about a specific memory region.
1795 * @mr: The memory region to retrieve information about.
1796 * @mr_attr: The attributes of the specified memory region.
1798 int ib_query_mr(struct ib_mr *mr, struct ib_mr_attr *mr_attr);
1801 * ib_dereg_mr - Deregisters a memory region and removes it from the
1802 * HCA translation table.
1803 * @mr: The memory region to deregister.
1805 int ib_dereg_mr(struct ib_mr *mr);
1808 * ib_alloc_mw - Allocates a memory window.
1809 * @pd: The protection domain associated with the memory window.
1811 struct ib_mw *ib_alloc_mw(struct ib_pd *pd);
1814 * ib_bind_mw - Posts a work request to the send queue of the specified
1815 * QP, which binds the memory window to the given address range and
1816 * remote access attributes.
1817 * @qp: QP to post the bind work request on.
1818 * @mw: The memory window to bind.
1819 * @mw_bind: Specifies information about the memory window, including
1820 * its address range, remote access rights, and associated memory region.
1822 static inline int ib_bind_mw(struct ib_qp *qp,
1824 struct ib_mw_bind *mw_bind)
1826 /* XXX reference counting in corresponding MR? */
1827 return mw->device->bind_mw ?
1828 mw->device->bind_mw(qp, mw, mw_bind) :
1833 * ib_dealloc_mw - Deallocates a memory window.
1834 * @mw: The memory window to deallocate.
1836 int ib_dealloc_mw(struct ib_mw *mw);
1839 * ib_alloc_fmr - Allocates a unmapped fast memory region.
1840 * @pd: The protection domain associated with the unmapped region.
1841 * @mr_access_flags: Specifies the memory access rights.
1842 * @fmr_attr: Attributes of the unmapped region.
1844 * A fast memory region must be mapped before it can be used as part of
1847 struct ib_fmr *ib_alloc_fmr(struct ib_pd *pd,
1848 int mr_access_flags,
1849 struct ib_fmr_attr *fmr_attr);
1852 * ib_map_phys_fmr - Maps a list of physical pages to a fast memory region.
1853 * @fmr: The fast memory region to associate with the pages.
1854 * @page_list: An array of physical pages to map to the fast memory region.
1855 * @list_len: The number of pages in page_list.
1856 * @iova: The I/O virtual address to use with the mapped region.
1858 static inline int ib_map_phys_fmr(struct ib_fmr *fmr,
1859 u64 *page_list, int list_len,
1862 return fmr->device->map_phys_fmr(fmr, page_list, list_len, iova);
1866 * ib_unmap_fmr - Removes the mapping from a list of fast memory regions.
1867 * @fmr_list: A linked list of fast memory regions to unmap.
1869 int ib_unmap_fmr(struct list_head *fmr_list);
1872 * ib_dealloc_fmr - Deallocates a fast memory region.
1873 * @fmr: The fast memory region to deallocate.
1875 int ib_dealloc_fmr(struct ib_fmr *fmr);
1878 * ib_attach_mcast - Attaches the specified QP to a multicast group.
1879 * @qp: QP to attach to the multicast group. The QP must be type
1881 * @gid: Multicast group GID.
1882 * @lid: Multicast group LID in host byte order.
1884 * In order to send and receive multicast packets, subnet
1885 * administration must have created the multicast group and configured
1886 * the fabric appropriately. The port associated with the specified
1887 * QP must also be a member of the multicast group.
1889 int ib_attach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1892 * ib_detach_mcast - Detaches the specified QP from a multicast group.
1893 * @qp: QP to detach from the multicast group.
1894 * @gid: Multicast group GID.
1895 * @lid: Multicast group LID in host byte order.
1897 int ib_detach_mcast(struct ib_qp *qp, union ib_gid *gid, u16 lid);
1899 #endif /* IB_VERBS_H */